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
4159 , (except on Windows, where
4163 named pipes are special objects located in
4164 \begin_inset Flex CharStyle:Code
4167 \begin_layout Plain Layout
4179 ) and have the names
4180 \begin_inset Quotes eld
4184 \begin_inset Flex CharStyle:Code
4187 \begin_layout Plain Layout
4194 \begin_inset Quotes erd
4198 \begin_inset Quotes eld
4202 \begin_inset Flex CharStyle:Code
4205 \begin_layout Plain Layout
4212 \begin_inset Quotes erd
4216 External programs write into
4217 \begin_inset Flex CharStyle:Code
4220 \begin_layout Plain Layout
4226 and read back data from
4227 \begin_inset Flex CharStyle:Code
4230 \begin_layout Plain Layout
4237 The stem of the pipe names can be defined in the
4238 \begin_inset Flex CharStyle:MenuItem
4241 \begin_layout Plain Layout
4242 Tools\SpecialChar \menuseparator
4249 \begin_inset Flex CharStyle:Code
4252 \begin_layout Plain Layout
4253 "/home/myhome/lyxpipe"
4259 \begin_inset Flex CharStyle:Code
4262 \begin_layout Plain Layout
4281 configure this manually in order for the server to start.
4284 \begin_layout Standard
4286 \begin_inset Flex CharStyle:Code
4289 \begin_layout Plain Layout
4296 \begin_inset Flex CharStyle:Code
4299 \begin_layout Plain Layout
4305 ' to create the pipes.
4306 If one of the pipes already exists, LyX will assume that another LyX process
4307 is already running and will not start the server.
4308 On POSIX (Unix like) systems, if for some other reason, an unused
4309 \begin_inset Quotes eld
4313 \begin_inset Quotes erd
4316 pipe is left in existence when LyX closes, then LyX will try to delete
4318 If this fails for some reason, you will need to delete the pipes manually
4319 and then restart LyX.
4320 On Windows, pipes are deleted by the OS on program termination or crash,
4322 \begin_inset Quotes eld
4326 \begin_inset Quotes erd
4329 pipes should not be possible.
4332 \begin_layout Standard
4333 To have several LyX processes with servers at the same time, you have to
4334 use different configurations, perhaps by using separate user directories,
4336 \begin_inset Flex CharStyle:Code
4339 \begin_layout Plain Layout
4345 file, for each process.
4348 \begin_layout Standard
4349 If you are developing a client program, you might find it useful to enable
4350 debugging information from the LyX server.
4351 Do this by starting LyX as
4352 \begin_inset Flex CharStyle:Code
4355 \begin_layout Plain Layout
4364 \begin_layout Standard
4365 You can find a complete example client written in C in the source distribution
4367 \begin_inset Flex CharStyle:Code
4370 \begin_layout Plain Layout
4371 development/lyxserver/server_monitor.c
4379 \begin_layout Standard
4380 Another useful tool is command-line based client you will find in
4381 \begin_inset Flex CharStyle:Code
4384 \begin_layout Plain Layout
4385 src/client/lyxclient
4393 \begin_layout Section
4394 Normal communication
4397 \begin_layout Standard
4398 To issue a LyX call, the client writes a line of ASCII text into the input
4400 This line has the following format:
4417 \begin_layout Description
4418 clientname is a name that the client can choose arbitrarily.
4419 Its only use is that LyX will echo it if it sends an answer—so a client
4420 can dispatch results from different requesters.
4423 \begin_layout Description
4424 function is the function you want LyX to perform.
4425 It is the same as the commands you'd use in the minibuffer.
4428 \begin_layout Description
4429 argument is an optional argument which is meaningful only to some functions
4431 \begin_inset Quotes eld
4435 \begin_inset Quotes erd
4438 LFUN will insert the argument as text at the cursor position).
4441 \begin_layout Standard
4442 The answer from LyX will arrive in the output pipe and be of the form
4459 \begin_layout Standard
4468 are just echoed from the command request, while
4472 is more or less useful information filled according to how the command
4473 execution worked out.
4474 Some commands, such as
4475 \begin_inset Quotes eld
4479 \begin_inset Quotes erd
4482 , will return information about the internal state of LyX, while other will
4483 return an empty data-response.
4484 This means that the command execution went fine.
4487 \begin_layout Standard
4488 In case of errors, the response from LyX will have this form
4505 \begin_layout Standard
4510 should contain an explanation of why the command failed.
4513 \begin_layout Standard
4517 \begin_layout LyX-Code
4518 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
4519 \begin_inset Newline newline
4522 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
4523 \begin_inset Newline newline
4526 read a <~/.lyxpipe.out
4527 \begin_inset Newline newline
4533 \begin_layout Section
4537 \begin_layout Standard
4538 LyX can notify clients of events going on asynchronously.
4539 Currently it will only do this if the user binds a key sequence with the
4541 \begin_inset Quotes eld
4545 \begin_inset Quotes erd
4549 The format of the string LyX sends is as follows:
4553 \begin_inset Flex CharStyle:Code
4556 \begin_layout Plain Layout
4567 \begin_layout Standard
4572 is the printed representation of the key sequence that was actually typed
4576 \begin_layout Standard
4577 This mechanism can be used to extend LyX's command set and implement macros.
4578 Bind some key sequence to
4579 \begin_inset Quotes eld
4583 \begin_inset Quotes erd
4587 Then start a client that listens on the output pipe, dispatches the command
4588 according to the sequence, and starts a function that may use LyX calls
4589 and LyX requests to issue a command or a series of commands to LyX.
4592 \begin_layout Section
4593 The simple LyX Server Protocol
4596 \begin_layout Standard
4597 LyX implements a simple protocol that can be used for session management.
4598 All messages are of the form
4611 \begin_layout Standard
4617 \begin_inset Quotes eld
4621 \begin_inset Quotes erd
4625 \begin_inset Quotes eld
4629 \begin_inset Quotes erd
4634 \begin_inset Quotes eld
4638 \begin_inset Quotes erd
4641 is received from a client, LyX will report back to inform the client that
4642 it's listening to it's messages, while
4643 \begin_inset Quotes eld
4647 \begin_inset Quotes erd
4650 sent from LyX will inform clients that LyX is closing.
4653 \begin_layout Section
4654 Reverse DVI/PDF search
4657 \begin_layout Standard
4658 Some DVI/PDF viewers
4662 \begin_layout Plain Layout
4663 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
4664 Skim on Mac OSX and SumatraPDF on Windows.
4673 facility (also called
4678 This means that you can tell LyX to put the cursor to a specific line in
4679 the document by clicking at the respective position in the DVI/PDF output.
4680 To achieve this, the viewer must be able to communicate with LyX.
4681 This is done via the LyX server either by using the named pipe (
4685 ), or the UNIX domain socket (
4689 ) that LyX creates in its temporary directory (this is the way the
4690 \begin_inset Flex CharStyle:Code
4693 \begin_layout Plain Layout
4699 program communicates with LyX).
4700 In some cases, you need a helper script that mediates between the viewer
4701 and LyX, in others, the viewer can communicate with LyX directly.
4702 This depends on the selected viewer and on your operating system.
4703 The same applies to the way viewers need to be configured and the way the
4704 reverse search is actually performed.
4705 In what follows, we will thus describe how to setup reverse search for
4707 Before we turn to this, though, we will explain what needs to be done generally
4708 to enable reverse search in the DVI/PDF output.
4711 \begin_layout Subsection
4712 Enabling reverse search
4715 \begin_layout Standard
4716 LaTeX provides several different methods for reverse search.
4717 Some are built-in in the
4718 \begin_inset Flex CharStyle:Code
4721 \begin_layout Plain Layout
4727 program, some are provided by external packages.
4728 Your choice depends on whether your LaTeX distribution already provides
4729 a given method (the built-in methods are rather new) and whether your viewer
4731 The available methods are described in the following.
4734 \begin_layout Subsubsection*
4735 Built-in DVI-search via src-specials (DVI only)
4738 \begin_layout Standard
4739 This method provides the DVI file with the necessary information for reverse
4741 It is available in LaTeX since quite some time (any somewhat recent LaTeX
4742 distribution should include it), and it works reliably.
4743 To enable it, change the
4744 \begin_inset Flex CharStyle:MenuItem
4747 \begin_layout Plain Layout
4752 \begin_layout Plain Layout
4765 \begin_inset Flex CharStyle:MenuItem
4768 \begin_layout Plain Layout
4773 \begin_layout Plain Layout
4780 eX (plain)->DraftDVI
4786 \begin_inset Flex CharStyle:MenuItem
4789 \begin_layout Plain Layout
4790 Preferences\SpecialChar \menuseparator
4791 File Handling\SpecialChar \menuseparator
4798 \begin_inset Flex CharStyle:Code
4801 \begin_layout Plain Layout
4802 latex -src-specials $$i
4808 If this doesn't work, check if your TeX engine needs different options
4809 (the syntax might differ in some distributions).
4812 \begin_layout Subsubsection*
4813 External Packages (PDFSync and scrltx)
4816 \begin_layout Standard
4825 provide reverse search facility for PDF output (via pdflatex) and DVI output,
4827 In order to enable it, load the packages in the LyX preamble:
4830 \begin_layout Itemize
4831 \begin_inset Flex CharStyle:Code
4834 \begin_layout Plain Layout
4842 for reverse PDF search,
4845 \begin_layout Itemize
4847 \begin_inset Flex CharStyle:Code
4850 \begin_layout Plain Layout
4853 usepackage[active]{srcltx}
4858 for reverse DVI search.
4861 \begin_layout Standard
4862 If you want to be able to perform both DVI and PDF reverse searches, you
4863 can also insert in the preamble the following lines
4866 \begin_layout LyX-Code
4870 \begin_inset Newline newline
4876 \begin_inset Newline newline
4882 \begin_inset Newline newline
4888 \begin_inset Newline newline
4893 usepackage[active]{srcltx}
4894 \begin_inset Newline newline
4902 \begin_layout Standard
4903 This way, you can preview the file as either DVI or PDF (pdflatex) and the
4904 right package will be used.
4907 \begin_layout Standard
4908 Note that PDFSync might affect the output layout of your document.
4909 It is therefore advised to disable PDFsync for final documents.
4912 \begin_layout Subsubsection*
4913 Built-in reverse search via SyncTeX (DVI and PDF)
4916 \begin_layout Standard
4918 \begin_inset Flex CharStyle:Code
4921 \begin_layout Plain Layout
4927 have built-in support for both PDF and DVI reverse search.
4932 facility is basically the result of the integration of the PDFSync package
4933 to the pdftex program and its merge with the
4938 You need at least TeXLive 2008 or a recent MikTeX distribution in order
4940 Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
4941 already provide SyncTeX support.
4944 \begin_layout Standard
4945 To enable SyncTeX for DVI output, change the
4946 \begin_inset Flex CharStyle:MenuItem
4949 \begin_layout Plain Layout
4954 \begin_layout Plain Layout
4967 \begin_inset Flex CharStyle:MenuItem
4970 \begin_layout Plain Layout
4975 \begin_layout Plain Layout
4982 eX (plain) -> DraftDVI
4988 \begin_inset Flex CharStyle:MenuItem
4991 \begin_layout Plain Layout
4992 Preferences\SpecialChar \menuseparator
4993 File Handling\SpecialChar \menuseparator
5000 \begin_inset Flex CharStyle:Code
5003 \begin_layout Plain Layout
5004 latex -synctex=1 $$i
5009 , and for PDF output, change the
5010 \begin_inset Flex CharStyle:MenuItem
5013 \begin_layout Plain Layout
5018 \begin_layout Plain Layout
5025 eX (pdflatex) -> PDF (pdflatex)
5031 \begin_inset Flex CharStyle:Code
5034 \begin_layout Plain Layout
5035 pdflatex -synctex=1 $$i
5041 Check the documentation of your viewer whether the viewer needs to be configure
5042 d for the use with SyncTeX.
5046 \begin_layout Plain Layout
5048 \begin_inset Flex CharStyle:Code
5051 \begin_layout Plain Layout
5057 option enables gzip compression.
5058 If your viewer does not support it, you should instead use
5059 \begin_inset Flex CharStyle:Code
5062 \begin_layout Plain Layout
5076 \begin_layout Subsection
5077 Configuring and using specific viewers
5080 \begin_layout Subsubsection*
5081 Xdvi (all platforms)
5084 \begin_layout Standard
5086 \begin_inset Flex CharStyle:Code
5089 \begin_layout Plain Layout
5095 , you don't need to do anything else for performing a reverse DVI search,
5096 as LyX already provides the necessary hooks for automatically using the
5098 \begin_inset Flex CharStyle:Code
5101 \begin_layout Plain Layout
5108 Just setup your document as described above (reverse search is triggered
5109 by Ctrl-click or Alt-click on Mac OSX, respectively).
5112 \begin_layout Standard
5113 However, if for whatever reason you want to use the named pipe instead of
5114 the socket for communicating with LyX, simply change the DVI viewer in
5116 \begin_inset Flex CharStyle:MenuItem
5119 \begin_layout Plain Layout
5120 Preferences\SpecialChar \menuseparator
5121 File Handling\SpecialChar \menuseparator
5131 \begin_layout Plain Layout
5132 On Mac OSX you have to use
5133 \begin_inset Flex CharStyle:Code
5136 \begin_layout Plain Layout
5137 DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
5148 \begin_inset Flex CharStyle:Code
5151 \begin_layout Plain Layout
5152 xdvi -editor 'lyxeditor.sh %f %l'
5158 \begin_inset Flex CharStyle:Code
5161 \begin_layout Plain Layout
5167 is a suitable script.
5168 For example, a minimal shell script is the following one:
5171 \begin_layout LyX-Code
5173 \begin_inset Newline newline
5176 LYXPIPE="/path/to/lyxpipe"
5177 \begin_inset Newline newline
5180 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
5181 \begin_inset Newline newline
5184 echo "$COMMAND" > "${LYXPIPE}".in || exit
5185 \begin_inset Newline newline
5188 read < "${LYXPIPE}".out || exit
5191 \begin_layout Standard
5193 \begin_inset Flex CharStyle:Code
5196 \begin_layout Plain Layout
5206 \begin_layout Plain Layout
5213 XServer pipe path specified in
5214 \begin_inset Flex CharStyle:MenuItem
5217 \begin_layout Plain Layout
5218 Preferences\SpecialChar \menuseparator
5228 \begin_layout Plain Layout
5230 \begin_inset Flex CharStyle:Code
5233 \begin_layout Plain Layout
5239 folder of a source distribution you can find a
5240 \begin_inset Flex CharStyle:Code
5243 \begin_layout Plain Layout
5249 script which is able to locate the
5253 based on your preferences.
5261 \begin_layout Subsubsection*
5265 \begin_layout Standard
5267 \begin_inset Flex CharStyle:Code
5270 \begin_layout Plain Layout
5271 /Applications/MacDviX_Folder/calleditor.script
5276 , add the following lines:
5279 \begin_layout LyX-Code
5284 \begin_layout Plain Layout
5291 X.app/Contents/MacOS/lyxeditor "$2" $1
5292 \begin_inset Newline newline
5298 \begin_layout Standard
5299 Modify the lines accordingly if you install LyX somewhere else than in the
5300 Applications folder.
5303 \begin_layout Standard
5304 Reverse search is triggered by Alt-click (OPTION-click).
5307 \begin_layout Subsubsection*
5311 \begin_layout Standard
5313 \begin_inset Flex CharStyle:Code
5316 \begin_layout Plain Layout
5317 open -a Skim.app $$i
5322 to the viewer setting in
5323 \begin_inset Flex CharStyle:MenuItem
5326 \begin_layout Plain Layout
5327 Preferences\SpecialChar \menuseparator
5328 File Handling\SpecialChar \menuseparator
5329 File formats\SpecialChar \menuseparator
5336 \begin_inset Flex CharStyle:MenuItem
5339 \begin_layout Plain Layout
5340 Skim\SpecialChar \menuseparator
5341 Preferences\SpecialChar \menuseparator
5351 \begin_layout Plain Layout
5361 \begin_layout Standard
5362 Reverse search is triggered by COMMAND-SHIFT-click
5365 \begin_layout Subsubsection*
5369 \begin_layout Standard
5371 \begin_inset Flex CharStyle:MenuItem
5374 \begin_layout Plain Layout
5375 Settings\SpecialChar \menuseparator
5376 Configure Okular\SpecialChar \ldots{}
5377 \SpecialChar \menuseparator
5384 \begin_inset Quotes eld
5388 \begin_inset Quotes erd
5392 \begin_inset Flex CharStyle:Code
5395 \begin_layout Plain Layout
5404 \begin_layout Standard
5405 Reverse search is triggered by SHIFT-click.
5408 \begin_layout Subsubsection*
5412 \begin_layout Standard
5413 Launch yap, choose its
5414 \begin_inset Flex CharStyle:MenuItem
5417 \begin_layout Plain Layout
5418 View\SpecialChar \menuseparator
5425 \begin_inset Quotes eld
5429 \begin_inset Quotes erd
5434 \begin_inset Quotes eld
5437 New\SpecialChar \ldots{}
5439 \begin_inset Quotes erd
5442 button and, in the window that opens, enter
5443 \begin_inset Quotes eld
5447 \begin_inset Quotes erd
5450 (or any other name you like) in the
5451 \begin_inset Quotes eld
5455 \begin_inset Quotes erd
5459 Now click on the button labeled
5460 \begin_inset Quotes eld
5463 \SpecialChar \ldots{}
5465 \begin_inset Quotes erd
5468 to open a file dialog and navigate to the directory containing the batch
5470 \begin_inset Flex CharStyle:Code
5473 \begin_layout Plain Layout
5481 \begin_inset Flex CharStyle:Code
5484 \begin_layout Plain Layout
5490 and then specify the program arguments as
5491 \begin_inset Flex CharStyle:Code
5494 \begin_layout Plain Layout
5502 \begin_inset Flex CharStyle:Code
5505 \begin_layout Plain Layout
5511 wrapper is used for communicating with LyX through the
5518 \begin_layout LyX-Code
5520 \begin_inset Newline newline
5523 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
5532 \begin_inset Newline newline
5546 \begin_layout Standard
5547 Make sure that the LyXServer pipe path you specified in LyX is
5548 \begin_inset Flex CharStyle:Code
5551 \begin_layout Plain Layout
5565 , otherwise change the
5566 \begin_inset Flex CharStyle:Code
5569 \begin_layout Plain Layout
5575 wrapper accordingly.
5578 \begin_layout Standard
5579 In yap, reverse search is triggered by double-click.
5582 \begin_layout Subsubsection*
5583 SumatraPDF (Windows)
5586 \begin_layout Standard
5587 In order to use SumatraPDF for inverse search, enter
5588 \begin_inset Flex CharStyle:Code
5591 \begin_layout Plain Layout
5592 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
5597 in the viewer setting in
5598 \begin_inset Flex CharStyle:MenuItem
5601 \begin_layout Plain Layout
5602 Preferences\SpecialChar \menuseparator
5603 File Handling\SpecialChar \menuseparator
5604 File formats\SpecialChar \menuseparator
5611 \begin_inset Flex CharStyle:Code
5614 \begin_layout Plain Layout
5620 is the previous wrapper.
5621 If SumatraPDF.exe is not in your command PATH, use its full file name.
5624 \begin_layout Standard
5625 Reverse search is triggered by double-click.
5628 \begin_layout Subsubsection*
5632 \begin_layout Standard
5633 First of all, make sure that yap is your default DVI viewer in the Windows
5634 environment, then launch it, choose its
5635 \begin_inset Flex CharStyle:MenuItem
5638 \begin_layout Plain Layout
5639 View\SpecialChar \menuseparator
5646 \begin_inset Quotes eld
5650 \begin_inset Quotes erd
5655 \begin_inset Quotes eld
5658 New\SpecialChar \ldots{}
5660 \begin_inset Quotes erd
5663 button and, in the window that opens, enter
5664 \begin_inset Quotes eld
5668 \begin_inset Quotes erd
5671 (or any other name you like) in the
5672 \begin_inset Quotes eld
5676 \begin_inset Quotes erd
5680 Now click on the button labeled
5681 \begin_inset Quotes eld
5684 \SpecialChar \ldots{}
5686 \begin_inset Quotes erd
5689 to open a file dialog and navigate to the directory containing the
5690 \begin_inset Flex CharStyle:Code
5693 \begin_layout Plain Layout
5699 program (which is installed by default on Cygwin along with the LyX executable).
5701 \begin_inset Flex CharStyle:Code
5704 \begin_layout Plain Layout
5710 and then specify the program arguments as
5711 \begin_inset Flex CharStyle:Code
5714 \begin_layout Plain Layout
5721 In this way, you will be using the
5725 for communicating with LyX.
5726 If, for whatever reason, you want to use the
5731 \begin_inset Flex CharStyle:Code
5734 \begin_layout Plain Layout
5740 option and be sure to specify the LyXServer pipe path in the LyX preferences.
5743 \begin_layout Standard
5744 In yap, reverse search is triggered by double-click.
5747 \begin_layout Subsubsection*
5751 \begin_layout Standard
5752 In order to use SumatraPDF for inverse search, enter
5753 \begin_inset Flex CharStyle:Code
5756 \begin_layout Plain Layout
5762 in the viewer setting in
5763 \begin_inset Flex CharStyle:MenuItem
5766 \begin_layout Plain Layout
5767 Preferences\SpecialChar \menuseparator
5768 File Handling\SpecialChar \menuseparator
5769 File formats\SpecialChar \menuseparator
5776 \begin_inset Flex CharStyle:Code
5779 \begin_layout Plain Layout
5785 is the following script (to be placed in your command PATH,
5786 \begin_inset Flex CharStyle:Code
5789 \begin_layout Plain Layout
5795 being the best choice):
5798 \begin_layout LyX-Code
5800 \begin_inset Newline newline
5804 \begin_inset Newline newline
5807 SumatraPDF -inverse-search "lyxeditor -g %f %l" $(basename $1)
5810 \begin_layout Standard
5811 This wrapper script is needed because SumatraPDF is a native Windows application
5812 and does not understand the posix paths used by the Cygwin version of LyX.
5813 If SumatraPDF.exe is not in your command PATH, use its full posix path in
5816 \begin_inset Flex CharStyle:Code
5819 \begin_layout Plain Layout
5825 enables communication via the
5831 \begin_inset Flex CharStyle:Code
5834 \begin_layout Plain Layout
5840 option if you want to use the
5844 , and be sure to specify the LyXServer pipe path in the LyX preferences.
5847 \begin_layout Standard
5848 Reverse search is triggered by double-click.
5851 \begin_layout Chapter
5852 Special Document Classes
5855 \begin_layout Section
5859 \begin_layout Standard
5865 \begin_layout Subsection
5869 \begin_layout Standard
5870 This section describes how LyX can be used to write articles for submission
5871 to the scientific journal
5873 Astronomy and Astrophysics
5875 (www.edpsciences.fr/aa/
5876 \begin_inset Flex URL
5879 \begin_layout Plain Layout
5881 http://www.edpsciences.fr/aa/
5886 ) using Version 5.01 of the document class
5891 This package can be downloaded from the ftp site
5894 \begin_layout Standard
5895 \begin_inset VSpace medskip
5901 \begin_layout Standard
5903 \begin_inset Flex URL
5906 \begin_layout Plain Layout
5908 ftp://ftp.edpsciences.org/pub/aa/readme.html
5916 \begin_layout Standard
5917 \begin_inset VSpace medskip
5923 \begin_layout Standard
5924 A manual comes together with that package, and this text is not meant to
5925 replace the original manual but merely a short guide how to realize the
5926 correct form of your paper.
5930 \begin_layout Standard
5931 Please note that the publisher of the journal was changed from Springer
5932 to EDP Sciences starting January 1, 2001.
5933 That change implicated also some slight changes of the style files, namely
5934 the removal of the thesaurus command.
5935 The LyX class aa supports the newest version of these style files, V 5.01.
5936 If you have an older version installed, please upgrade.
5937 For compatibility, the old (version 4) layout has been kept as
5942 Please refer to the comments in
5944 LyXDir/layouts/aapaper.layout
5949 \begin_layout Subsection
5953 \begin_layout Standard
5954 It is recommended you start from the example template distributed with LyX.
5955 If you are not using a template, note the following settings:
5958 \begin_layout Itemize
5965 Document\SpecialChar \menuseparator
5968 dialog (OK, that one was obvious).
5971 \begin_layout Itemize
5972 Don't change the option
5975 \begin_inset space ~
5985 The whole layout is done by the macros, you shouldn't change anything.
5988 \begin_layout Subsection
5992 \begin_layout Standard
5993 First thing to enter is the header information.
5994 It consists of seven entries, of which some are optional.
5998 \begin_layout Itemize
6006 \begin_layout Itemize
6014 \begin_layout Itemize
6022 \begin_layout Itemize
6030 \begin_layout Itemize
6035 : [optional] if more than one author: whom to contact for offprint requests.
6038 \begin_layout Itemize
6043 : [optional] mail address for contacts.
6046 \begin_layout Itemize
6054 Received: <date>; Accepted <date>
6057 \begin_layout Standard
6058 There is no need to issue the
6064 command, this is done automatically by LyX when the header is finished.
6065 Although the order of the single header entries doesn't matter it is advised
6066 to keep the above sequence, just to get the best optics and meets the layout
6067 of the real document.
6070 \begin_layout Standard
6071 If you want to place footnotes in the header block, e.
6072 \begin_inset space \thinspace{}
6076 \begin_inset space \space{}
6079 to state your present address, just use the standard footnote via the menu
6082 Insert\SpecialChar \menuseparator
6086 LyX will automagically use the term
6095 \begin_layout Standard
6096 In addition to these topics, the macros use three additional LaTeX commands
6097 that have no counterpart in LyX:
6100 \begin_layout Itemize
6107 to separate different names for more than one author and institute, respectivel
6111 \begin_layout Itemize
6118 to mark corresponding author/institute pairs.
6119 The institutes are numbered sequentially as they appear in the
6123 field, so you have to put a marker to each author.
6126 \begin_layout Itemize
6133 to supply an email address for fast contact.
6136 \begin_layout Standard
6137 In all cases, the appropriate command has to be entered in LyX and marked
6143 \begin_layout Subsection
6147 \begin_layout Standard
6148 The abstract should immediately follow the header block.
6149 With version 5 the abstract environment was changed to a command, and there
6150 is now a resctriction to only one paragraph.
6151 In addition, it should contain an entry with the keywords.
6152 This is not yet implemented for LyX, therefore you have to enter the LaTeX
6159 by hand and mark it as LaTeX code.
6160 Refer to the example paper.
6163 \begin_layout Subsection
6164 Supported environments
6167 \begin_layout Standard
6168 The A&A paper layout supports the following environments for structuring
6172 \begin_layout Itemize
6178 \begin_layout Itemize
6184 \begin_layout Itemize
6190 \begin_layout Itemize
6196 \begin_layout Itemize
6202 \begin_layout Itemize
6208 \begin_layout Itemize
6214 \begin_layout Itemize
6220 \begin_layout Itemize
6226 \begin_layout Itemize
6232 \begin_layout Itemize
6238 \begin_layout Itemize
6244 \begin_layout Subsection
6245 Commands not supported by LyX
6248 \begin_layout Standard
6249 Some commands are not yet supported by the
6254 Some have already been mentioned.
6255 For the sake of completeness, they are listed all together here:
6258 \begin_layout Itemize
6266 \begin_layout Itemize
6274 \begin_layout Itemize
6282 \begin_layout Itemize
6290 \begin_layout Itemize
6298 \begin_layout Itemize
6306 \begin_layout Itemize
6314 \begin_layout Itemize
6322 \begin_layout Standard
6323 If you want to use any of these commands, you have to enter them yourself.
6326 Do not forget to mark them as LaTeX code!
6329 \begin_layout Subsection
6330 Figure and Table Floats
6333 \begin_layout Standard
6334 LyX provides support for the necessary float environments
6336 figure, figure*, table
6342 , therefore we won't tell much about it here.
6346 \begin_inset space ~
6352 Just remember that tables should be left-aligned.
6353 For that, select the table and change the alignment in
6355 Edit\SpecialChar \menuseparator
6357 \begin_inset space ~
6363 \begin_layout Standard
6364 There is only one special thing: the figures with caption besides the figure.
6365 To create such a figure, you have to do the following:
6368 \begin_layout Enumerate
6369 Create a wide figure float:
6371 Insert\SpecialChar \menuseparator
6372 Float\SpecialChar \menuseparator
6375 , then right click in the figure and select
6381 \begin_inset space ~
6389 \begin_layout Enumerate
6390 Enter your caption text.
6393 \begin_layout Enumerate
6398 to move the cursor above the caption.
6401 \begin_layout Enumerate
6405 \begin_layout Enumerate
6406 Position the cursor behind the figure and insert a horizontal fill:
6408 Insert\SpecialChar \menuseparator
6410 \begin_inset space ~
6413 Character\SpecialChar \menuseparator
6415 \begin_inset space ~
6423 \begin_layout Enumerate
6424 Switch to LaTeX mode:
6427 \begin_inset space ~
6435 \begin_layout Enumerate
6445 Do not close the brace!
6448 \begin_layout Enumerate
6449 Position the cursor behind the caption text, switch to LaTeX mode and insert
6453 \begin_inset space ~
6465 \begin_layout Standard
6466 Also, refer to the figures in the example paper.
6469 \begin_layout Subsection
6473 \begin_layout Standard
6474 For submission, the paper has to be formated in a special double-spacing
6476 For this purpose, you have to give the option
6480 to the documentclass.
6481 This must be done using the extra class options field in the
6483 Document\SpecialChar \menuseparator
6487 Just enter the string
6494 \begin_layout Subsection
6498 \begin_layout Standard
6503 directory contains an example paper written with LyX.
6504 It is the example paper from the original macro package, translated to
6506 Use it for inspiration, and compare the original LaTeX code with LyX way
6510 \begin_layout Section
6514 \begin_layout Standard
6520 \begin_layout Subsection
6524 \begin_layout Standard
6525 AASTeX is a set of macros produced by the American Astronomical Society
6526 to facilitate electronic manuscript submission to the three journals they
6527 publish: the Astrophysical Journal (including the Letters and Supplement),
6528 the Astronomical Journal, and the Publications of the Astronomical Society
6530 LyX has proven to be an excellent tool for generating these documents,
6531 especially given its equation, citation, and figure handling capabilities.
6532 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
6533 is the version described here, or higher.
6534 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
6535 incompatible with LyX.
6536 The AASTeX package may be downloaded from the AASTeX Web site
6539 \begin_layout Standard
6540 \begin_inset VSpace medskip
6546 \begin_layout Standard
6548 \begin_inset Flex URL
6551 \begin_layout Plain Layout
6553 http://www.journals.uchicago.edu/AAS/AASTeX
6561 \begin_layout Standard
6562 \begin_inset VSpace medskip
6568 \begin_layout Standard
6569 A complete user guide is contained in that package and you should familiarize
6570 yourself with it thoroughly before embarking on writing a paper in LyX.
6571 LyX will not reduce the need to figure out all the AASTeX commands, it
6572 will only reduce the drudgery of typing everything in.
6573 It is your responsibility to ensure that the final exported LaTeX document
6574 conforms completely to the requirements of the journal to which you are
6575 submitting your paper.
6578 \begin_layout Subsection
6579 Starting a New Paper
6582 \begin_layout Standard
6583 I strongly suggest that you start with the AASTeX template file.
6586 File\SpecialChar \menuseparator
6593 , enter the new file name, then choose the
6598 This will show the most common fields found in a manuscript.
6599 Simply overwrite the existing text (including the brackets,
6603 ) with the correct information.
6604 Many of the AASTeX commands and environments can be implemented directly
6605 in LyX, but some cannot: most noticeably
6617 , which should stick out like a sore thumb if you actually just opened the
6619 For commands such as these, the LaTeX code must be entered directly and
6621 Such commands are referred to as TeX code, or Evil Red Text.
6622 I tried to minimize the amount of TeX code needed in an AASTeX document,
6623 but there is still a bit more required than any of us would like.
6626 \begin_layout Subsection
6627 Finishing Your Paper
6630 \begin_layout Standard
6631 When the paper is finished to your satisfaction and previews/prints correctly,
6633 \begin_inset Quotes eld
6637 \begin_inset Quotes erd
6640 actions which need to be done before you submit it to the journals.
6644 \begin_layout Enumerate
6645 Export your paper as a LaTeX file (
6647 File\SpecialChar \menuseparator
6648 Export\SpecialChar \menuseparator
6655 \begin_layout Enumerate
6660 file with your favorite text editor
6664 \begin_layout Enumerate
6665 remove the comment lines before the
6674 \begin_layout Enumerate
6679 usepackage...{fontenc}
6681 line if it appears (usually just after
6696 \begin_layout Enumerate
6697 remove everything between (and including) the
6709 commands, except for any commands you specifically put into the LaTeX preamble
6710 (which should appear immediately after the
6711 \begin_inset Quotes eld
6714 User specified LaTeX commands
6715 \begin_inset Quotes erd
6726 \begin_layout Enumerate
6727 Run the resulting file through LaTeX to make sure it still processes correctly.
6730 \begin_layout Enumerate
6731 Reread the journal requirements to make sure your filenames and formats
6735 \begin_layout Enumerate
6739 \begin_layout Subsection
6740 Comments On Specific Commands
6743 \begin_layout Standard
6744 I will not describe the detailed usage of the individual AASTeX commands:
6745 the AASTeX User Guide (
6749 ) gives a good description of each.
6750 Thus it's probably easiest for me to go down the list as found in the guide
6751 and offer comments where necessary.
6752 So let's begin \SpecialChar \ldots{}
6756 \begin_layout Subsubsection
6757 Things that work as expected
6760 \begin_layout Standard
6764 \begin_layout Plain Layout
6776 \begin_layout Standard
6777 Because they work as you might expect, I simply list them and the section
6878 begin{thebibliography}
6886 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6887 graphicx figure commands (2.14.1),
6911 (2.15.4, amongst other places),
6938 \begin_layout Standard
6939 The following style options also work correctly:
6960 Simply put them in the
6966 Layout\SpecialChar \menuseparator
6972 \begin_layout Standard
6976 \begin_layout Plain Layout
6988 \begin_layout Subsubsection
6989 Things that work, but require more comment
6992 \begin_layout Standard
6993 The following items work, but require a little more discussion:
6996 \begin_layout Itemize
6997 These items are reserved for use by the journal editors, but you can put
6998 them into the LaTeX preamble if you feel compelled to do so:
7031 \begin_layout Itemize
7032 These items may be placed in the LaTeX preamble, and are included as blanks
7033 in the template file:
7054 \begin_layout Itemize
7061 (2.3) – can only be used
7062 \begin_inset Quotes eld
7066 \begin_inset Quotes erd
7069 , not in the middle of a paragraph.
7070 Use TeX code if you need to embed it.
7073 \begin_layout Itemize
7080 (2.3) – will have extra {} after it.
7081 This should not cause an error.
7084 \begin_layout Itemize
7091 (2.6) – can only be used
7092 \begin_inset Quotes eld
7096 \begin_inset Quotes erd
7099 , not in the middle of a paragraph.
7100 Use TeX code if you need to embed it.
7103 \begin_layout Itemize
7110 (2.8) – can't insert a cross-reference tag, you must type the tag name by
7114 \begin_layout Itemize
7121 (2.8) – same as for
7128 \begin_layout Itemize
7135 (2.9) – will have extra {} after it.
7136 This should not cause an error.
7139 \begin_layout Itemize
7146 (2.11) – will have extra {} after it.
7147 This should not cause an error.
7150 \begin_layout Itemize
7157 (2.14.2) – you can insert an optional filename argument by placing the cursor
7158 at the beginning of the text and selecting
7160 Insert\SpecialChar \menuseparator
7165 \begin_inset Quotes eld
7169 \begin_inset Quotes erd
7172 inserts an optional argument of the type needed by
7179 Hopefully it will be renamed someday.
7182 \begin_layout Itemize
7189 (2.17.1) – same as
7195 for the catalog ID optional parameter
7198 \begin_layout Itemize
7205 (2.17.1) – same as
7211 for the catalog ID optional parameter
7214 \begin_layout Subsubsection
7215 Things not implemented, use TeX code
7218 \begin_layout Standard
7222 \begin_layout Plain Layout
7234 \begin_layout Standard
7257 setcounter{equation}
7259 (2.12), Journal name abbreviations (2.13.4),
7295 (2.15.4, insert it as the first element in the lefthand cell after where
7297 Don't use any of LyX's rules in the table),
7309 (2.15.5), much of Misc (2.17, except
7360 \begin_layout Standard
7364 \begin_layout Plain Layout
7376 \begin_layout Subsubsection
7377 Things that cannot be implemented
7380 \begin_layout Standard
7381 \SpecialChar \ldots{}
7382 at least in any meaningful sort of way, so I suggest ignoring them.
7383 They are the references environment (2.13.3), and the deluxetable environment
7385 If you really, really need to use deluxetable, I suggest editing it in
7386 a separate file with a text editor, then using
7388 Insert\SpecialChar \menuseparator
7390 \begin_inset space ~
7395 to include it in your LyX document.
7400 file to see an example of this.
7403 \begin_layout Subsection
7404 FAQs, Tips, Tricks, and Other Ruminations
7407 \begin_layout Subsubsection
7408 Getting LyX and AASTeX to cooperate
7411 \begin_layout Standard
7412 It can be a bit tricky to get LyX to recognize a new layout and document
7414 When all else fails, do this:
7417 \begin_layout Enumerate
7418 Make certain that LaTeX can find AASTeX.
7419 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
7420 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
7427 \begin_layout Enumerate
7439 \begin_layout Enumerate
7442 Tools\SpecialChar \menuseparator
7445 in LyX, then restart LyX.
7448 \begin_layout Enumerate
7449 Open a regular new file, not from a template.
7450 Does AASTeX appear in the class list in
7452 Document\SpecialChar \menuseparator
7458 \begin_layout Standard
7459 If you get a warning from an existing AASTeX document about not being able
7460 to find the AASTeX layout or a message about
7461 \begin_inset Quotes eld
7464 You should not mix title layouts with normal ones
7465 \begin_inset Quotes erd
7468 , things haven't been installed correctly.
7471 \begin_layout Subsubsection
7472 LaTeX error processing a table
7475 \begin_layout Standard
7476 LyX, by default, attempts to center the table caption/title.
7477 This seems to produce a bad interaction in AASTeX so you should click somewhere
7478 in the caption/title, then select
7480 Edit\SpecialChar \menuseparator
7482 \begin_inset space ~
7496 This took care of it for me.
7499 \begin_layout Subsubsection
7503 \begin_layout Standard
7504 A couple of things: 1) I have noticed some funny spacing in the reference
7505 entries in the text.
7506 When you enter the bibliography item data, make sure their is
7510 space between the last author and the parenthesis setting off the year;
7514 \begin_inset space \thinspace{}
7518 \begin_inset space \space{}
7532 2) Entering the references at all is not obvious.
7533 The easiest thing is to start typing your first reference at the end of
7534 the document, then mark it as type
7539 That will put a small gray box in front of what you just typed.
7540 Click on the box to fill in the rest of the information.
7541 For new references, go to the end of an existing reference and press return.
7542 That will create a new line with its own box, etc.
7545 \begin_layout Subsubsection
7549 \begin_layout Standard
7550 Even though AASTeX provides its own figure commands (
7556 , for example), I much prefer LaTeX's standard figure commands (with the
7565 \begin_inset space ~
7568 commands as TeX code into a Figure Float box if you desire, but I never
7569 have much luck getting the layout right.
7570 With the standard graphics, LyX will insert a
7574 usepackage{graphicx}
7576 command into the LaTeX preamble and handle the figures in the standard
7577 LaTeX2e way, interspersing the figures in the text.
7578 I believe ApJ accepts figures exactly this way now; AJ might still use
7580 \begin_inset Quotes eld
7583 stack everything at the end
7584 \begin_inset Quotes erd
7590 \begin_layout Subsubsection
7591 Things I could have done, but didn't
7594 \begin_layout Standard
7596 \begin_inset Quotes eld
7600 \begin_inset Quotes erd
7603 things I could have implemented, but chose not to.
7604 For instance, I saw no point in double-spacing the text in the LyX window,
7605 even though it is double-spaced in the paper manuscript.
7606 Also, I chose not to make separate layouts for the preprint and preprint2
7608 Since I assume you will spend most of your time in the plain manuscript
7609 mode anyway, I decided not to chew up more disk space with this.
7613 \begin_layout Subsection
7617 \begin_layout Standard
7618 Your mileage may vary.
7619 I've now had papers published by both ApJ and AJ that have had 98% of the
7620 effort done in LyX; the last 2% was the LaTeX post-processing and a few
7622 I have had no trouble with the submission process, and I'm sure the journals
7623 were never aware that there might be a difference.
7624 So, go forth and publish!
7627 \begin_layout Section
7631 \begin_layout Standard
7634 David Johnson; updated by Richard Heck
7637 \begin_layout Standard
7638 \begin_inset VSpace bigskip
7644 \begin_layout Standard
7646 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
7647 papers to be submitted to American Mathematical Society publications.
7648 The layouts are not tailored to a specific journal, but easily can be.
7649 You should refer to the AMS documentation for specific instructions for
7650 each journal (usually it will entail only changing a single line in the
7652 That documentation is available on the Web at
7653 \begin_inset Flex URL
7656 \begin_layout Plain Layout
7664 \begin_inset Flex URL
7667 \begin_layout Plain Layout
7669 ftp://ftp.ams.org/pub/tex/amslatex/
7675 These layouts are appropriate, and useful, for any mathematical writing.
7679 \begin_layout Standard
7680 There are two basic AMS LaTeX layouts:
7683 \begin_layout Itemize
7684 amsart: The standard AMS article format.
7687 \begin_layout Itemize
7688 amsbook: the standard AMS book (really, monograph) format.
7692 \begin_layout Standard
7693 The layouts themselves contain only the minimum necessary to use the AMS
7695 They do not, in particular, contain any of the `theorem' environments used
7696 for setting theorems, lemmas, and the like.
7697 These are contained, instead, in the
7698 \begin_inset Flex CharStyle:Code
7701 \begin_layout Plain Layout
7707 module, which is loaded by default when when you select one of the AMS
7709 (It can also be used with other classes and can be removed, if you would
7710 rather use something else.) Less commonly used environments are in the
7711 \begin_inset Flex CharStyle:Code
7714 \begin_layout Plain Layout
7715 Theorems (AMS-Extended)
7720 module, which must be loaded manually.
7723 \begin_layout Standard
7724 By default, theorems and the like are numbered consecutively throughout
7725 the document, but this may be modified by loading the module
7726 \begin_inset Flex CharStyle:Code
7729 \begin_layout Plain Layout
7730 Theorems (Order by Section)
7735 or, if you are using
7736 \begin_inset Flex CharStyle:Code
7739 \begin_layout Plain Layout
7746 \begin_inset Flex CharStyle:Code
7749 \begin_layout Plain Layout
7750 Theorems (Order by Chapter)
7756 These will number the results as
7757 \begin_inset Formula $n.m$
7760 , where the first number refers to the section (or chapter) and the second
7761 refers to the total number of results so far in that section (or chapter).
7762 Many environments are also available unnumbered.
7763 These are indicated by an asterisk at the end.
7764 If you happen to want
7768 unnumbered results, the the module
7769 \begin_inset Flex CharStyle:Code
7772 \begin_layout Plain Layout
7778 provides that option.
7781 \begin_layout Standard
7782 Note that these modules do not
7786 to be used with the AMS classes.
7787 It is perfectly possible to use the
7788 \begin_inset Flex CharStyle:Code
7791 \begin_layout Plain Layout
7797 module, and the others mentioned, with other classes, such as
7798 \begin_inset Flex CharStyle:Code
7801 \begin_layout Plain Layout
7808 \begin_inset Flex CharStyle:Code
7811 \begin_layout Plain Layout
7818 \begin_inset Flex CharStyle:Code
7821 \begin_layout Plain Layout
7830 \begin_layout Subsection
7831 What these layouts provide
7834 \begin_layout Standard
7835 There is a long list of included environments provided by these layouts.
7836 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
7837 variety of `theorem' environments.
7838 However, the AMS recommends the environments that are available in LyX.
7842 \begin_layout Standard
7843 The following environments—as well as the standard environments, such as
7845 \begin_inset Flex CharStyle:Noun
7848 \begin_layout Plain Layout
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:Code
7898 \begin_layout Plain Layout
7905 \begin_inset Flex CharStyle:Code
7908 \begin_layout Plain Layout
7917 \begin_layout Description
7918 Address This should be the author's permanent address.
7921 \begin_layout Description
7923 \begin_inset space ~
7926 Address This should be the author's temporary address at the time of submission,
7927 if different from the Address.
7930 \begin_layout Description
7931 Email Author's e-mail address
7934 \begin_layout Description
7935 URL Author's Web address, if desired.
7938 \begin_layout Description
7939 Keywords Key words or phrases used to identify specific topics discussed
7943 \begin_layout Description
7944 Subjectclass These refer to the AMS Subject Classifications, published and
7947 Mathematical Reviews
7950 These are also available online at the AMS cites listed above.
7953 \begin_layout Description
7957 \begin_layout Description
7961 \begin_layout Description
7965 \begin_layout Standard
7966 The following environments are provided by both the
7967 \begin_inset Flex CharStyle:Code
7970 \begin_layout Plain Layout
7977 \begin_inset Flex CharStyle:Code
7980 \begin_layout Plain Layout
7986 modules, in the latter case in both starred (unnumbered) and unstarred
7987 (numbered) versions.
7988 These same environments are provided only in the starred versions by the
7990 \begin_inset Flex CharStyle:Code
7993 \begin_layout Plain Layout
8002 \begin_layout Theorem
8003 This is typically used for the statements of major results.
8007 \begin_layout Corollary*
8008 This is used for statements which follow fairly directly from previous statement
8010 Again, these can be major results.
8015 These are smaller results needed to prove other statements.
8018 \begin_layout Proposition
8019 These are less major results which (hopefully) add to the general theory
8023 \begin_layout Conjecture
8024 These are statements provided without justification, which the author does
8025 not know how to prove, but which seem to be true (to the author, at least).
8028 \begin_layout Definition*
8029 Guess what this is for.
8030 The font is different for this environment than for the previous ones.
8034 \begin_layout Example*
8035 Used for examples illustrating proven results.
8038 \begin_layout Problem
8039 It's not really known what this is for.
8040 You should figure it out.
8043 \begin_layout Exercise*
8044 Write a description for this one.
8047 \begin_layout Remark
8048 This environment is also a type of theorem, usually a lesser sort of observation.
8051 \begin_layout Claim*
8052 Often used in the course of giving a proof of a larger result.
8056 Generally, these are used to break up long arguments, using specific instances
8062 The numbering scheme for cases is on its own, not together with other numbered
8068 At the end of this environment, a QED symbol (usually a square, but it can
8069 vary with different styles) is placed.
8070 If you want to have other environments within this one—for example, Case
8071 environments—and have the QED symbol appear only after them, then the other
8072 environments need to be nested within the proof environment.
8075 Nesting Environments
8081 for information on nesting.
8084 \begin_layout Standard
8085 And these environments are provided by
8086 \begin_inset Flex CharStyle:Code
8089 \begin_layout Plain Layout
8090 Theorems (AMS-Extended)
8098 \begin_layout Criterion*
8099 A required condition.
8102 \begin_layout Algorithm*
8103 A general procedure to be used.
8106 \begin_layout Axiom*
8107 This is a property or statement taken as true within the system being discussed.
8110 \begin_layout Condition*
8111 Sometimes used to state a condition assumed within the present context of
8116 Similar to a Remark.
8119 \begin_layout Notation*
8120 Used for the explanation of, yes, notation.
8123 \begin_layout Summary
8124 Do we really need to tell you?
8127 \begin_layout Acknowledgement*
8131 \begin_layout Conclusion*
8132 Sometimes used at the end of a long train of argument.
8136 Used in a way similar to Proposition, though perhaps lower on the scale.
8139 \begin_layout Standard
8140 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
8142 They need to be available on your system in order to use these environments.
8145 \begin_layout Section
8153 \begin_layout Standard
8159 \begin_layout Subsection
8163 \begin_layout Standard
8164 These are the layout files for some of the journals of the American Geophysical
8166 It is assumed that you have both the AGU's own class files and AGUplus
8167 installed (everything to be found at
8168 \begin_inset Flex URL
8171 \begin_layout Plain Layout
8173 ftp://ftp.agu.org/journals/latex/journals
8181 \begin_layout Subsection
8185 \begin_layout Standard
8195 They are still called this in the LyX GUI, though their LaTeX equivalents
8196 in the AGU classes are
8207 \begin_layout Standard
8208 Newly defined styles are
8245 These are mostly manuscript attributes and defined in the AGU class documentati
8249 \begin_layout Standard
8250 I suspect this is still badly incomplete.
8253 \begin_layout Subsection
8257 \begin_layout Standard
8274 \begin_layout Subsection
8278 \begin_layout Itemize
8281 Journal of Geophysical Research
8290 \begin_layout Standard
8291 Add your own, it isn't so hard! Look at the
8302 \begin_layout Subsection
8303 Bugs and things to remember
8306 \begin_layout Standard
8307 In order to use the new layouts, you must remember to do the following for
8311 \begin_layout Enumerate
8317 This can be done in the
8319 Layout\SpecialChar \menuseparator
8324 Document\SpecialChar \menuseparator
8328 (AGU articles are always in English, right? So
8335 \begin_layout Enumerate
8345 (Yes, this is a bug.)
8348 \begin_layout Enumerate
8349 Make sure you use the
8353 bibliography style, by entering
8357 into the second field of the BibTeX inset.
8358 None of the standard styles will do.
8361 \begin_layout Section
8365 \begin_layout Standard
8371 \begin_layout Subsection
8375 \begin_layout Standard
8376 Broadway is for writing plays.
8377 The format is more decorative than Hollywood, and much less standardized.
8378 This format should be suitable for workshops.
8381 \begin_layout Subsection
8385 \begin_layout Standard
8386 The same as in Hollywood.
8389 \begin_layout Subsection
8393 \begin_layout Standard
8398 names as labels then cross-reference the label to insert the name.
8399 The cross-reference dialog will show the current cast of characters.
8402 \begin_layout Subsection
8403 Paper size and Margins
8406 \begin_layout Standard
8407 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
8410 \begin_layout Subsection
8414 \begin_layout Standard
8415 The following environments are available.
8416 You can use broadway.bind to get the bind keys shown at the right.
8419 \begin_layout Itemize
8423 \begin_inset Newline newline
8428 You should not have to use this, but it is here for anything that does not
8432 \begin_layout Itemize
8436 \begin_inset space \hfill{}
8440 \begin_inset Newline newline
8445 Used to describe stage setting and the action.
8446 First use of speaker names in all CAPs.
8449 \begin_layout Itemize
8453 \begin_inset space \hfill{}
8457 \begin_inset Newline newline
8462 Automatically numbered.
8463 On screen it will be arabic, but will print as Roman.
8466 \begin_layout Itemize
8470 \begin_inset space \hfill{}
8474 \begin_inset Newline newline
8484 It is just centered text.
8487 \begin_layout Itemize
8491 \begin_inset space \hfill{}
8495 \begin_inset Newline newline
8500 Not automatically numbered.
8501 You supply the number.
8502 This is because I couldn't figure out how.
8505 \begin_layout Itemize
8509 \begin_inset space \hfill{}
8513 \begin_inset Newline newline
8518 A special case of Narrative to describe the setting and action as the curtain
8522 \begin_layout Itemize
8526 \begin_inset space \hfill{}
8530 \begin_inset Newline newline
8535 The speaker's (actor's) title, centered in all CAPS.
8538 \begin_layout Itemize
8542 \begin_inset space \hfill{}
8546 \begin_inset Newline newline
8551 Instructions to the speaker.
8552 The parentheses are automatically inserted.
8553 The ( will appear on screen, but both will be in the printed play.
8554 This environment is only used within
8561 \begin_layout Itemize
8565 \begin_inset space \hfill{}
8569 \begin_inset Newline newline
8574 What the Speaker says.
8577 \begin_layout Itemize
8581 \begin_inset space \hfill{}
8585 \begin_inset Newline newline
8590 The curtain comes down.
8593 \begin_layout Itemize
8597 \begin_inset space \hfill{}
8603 \begin_layout Itemize
8607 \begin_inset space \hfill{}
8613 \begin_layout Itemize
8617 \begin_inset space \hfill{}
8623 \begin_layout Standard
8627 \begin_layout Section
8631 \begin_layout Standard
8636 can be used to type letters according to German conventions.
8637 A template file is included in
8639 .../lyx/share/templates
8641 for you to use as a starting point.
8644 \begin_layout Section
8652 \begin_layout Standard
8658 \begin_layout Subsection
8662 \begin_layout Standard
8663 This is the layout file for the European Geophysical Society journals.
8668 can be downloaded from the web site of the EGS under
8669 \begin_inset Flex URL
8672 \begin_layout Plain Layout
8682 \begin_layout Subsection
8686 \begin_layout Standard
8689 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
8697 The current layout file is unfortunately very unmodular and would benefit
8698 from using the various
8705 \begin_layout Section
8709 \begin_layout Standard
8715 \begin_layout Standard
8716 Elsevier Science Publishers B.V.
8717 provides a standard LaTeX document class (
8721 ) for submitting articles to their various journals.
8722 The style file can be downloaded directly from their web site:
8723 \begin_inset Flex URL
8726 \begin_layout Plain Layout
8728 http://authors.elsevier.com/
8734 Instructions are supplied along with the class file, which details the
8735 requirements of the publishers.
8736 LyX includes package that allows for the use of this class, by a layout
8737 and a template file.
8738 Installation of the class file is the same as for any other LaTeX package;
8739 instructions are provided in the Elsevier documentation.
8742 \begin_layout Standard
8752 As the Elsevier class file is based mainly on the standard article class,
8753 most of the normal functionality is provided.
8754 The Elsevier class defines a number of mathematical environments, which
8755 are similar to the AMS environments.
8756 These commands are all described in the Elsevier documentation, and are
8760 \begin_layout Standard
8761 The easiest way to use the Elsevier style is to base documents on the included
8763 It is best not to use options such as fancy headings or the geometry package,
8764 as elements such as these are defined by Elsevier in their style file.
8765 Ideally, no extra packages except those mentioned in the Elsevier documentation
8767 Essentially, Elsevier require as
8768 \begin_inset Quotes eld
8772 \begin_inset Quotes erd
8775 a LaTeX file as possible, as their intention is to take the supplied file
8776 and replace the class file with one for the particular journal to which
8777 the paper has been submitted.
8778 This also means that not too much time should be spent on the formating
8780 When it comes to be published, this will change anyway.
8781 The rest of the usage for this layout is substantially the same as for
8782 the normal article class.
8783 For details of what Elsevier do and don't allow, refer to their documentation.
8786 \begin_layout Section
8792 \begin_inset CommandInset label
8801 \begin_layout Standard
8807 \begin_layout Subsection
8811 \begin_layout Standard
8812 This section describes how to use LyX to make slides for overhead projectors.
8813 There are two document classes that can do this: the default slides class
8819 This section documents the latter.
8822 \begin_layout Standard
8823 I'm going to say this again, nice and clear, so that there's no misunderstanding
8827 \begin_layout Standard
8828 \begin_inset VSpace bigskip
8834 \begin_layout Standard
8838 This section documents the class
8839 \begin_inset Quotes eld
8847 \begin_inset Quotes erd
8855 \begin_layout Standard
8856 \begin_inset VSpace bigskip
8862 \begin_layout Standard
8863 If you're looking for the documentation for
8864 \begin_inset Quotes eld
8872 \begin_inset Quotes erd
8876 \begin_inset space ~
8880 \begin_inset CommandInset ref
8882 reference "sec:slitex"
8887 If your machine doesn't have the
8892 \begin_inset Quotes eld
8900 \begin_inset Quotes erd
8903 ] installed, you'll probably have to use the default
8907 class, which isn't quite as good as
8912 \begin_layout Standard
8917 class is designed for use with version 2.1 of the
8921 LaTeX class file which is now an integral part of LaTeX2e.
8924 \begin_layout Subsection
8928 \begin_layout Standard
8929 Obviously, to use this document class, you need to select
8930 \begin_inset Quotes eld
8938 \begin_inset Quotes erd
8948 \begin_inset space ~
8954 There are some settings in the
8957 \begin_inset space ~
8962 dialog that you should know about that are specific to this class:
8965 \begin_layout Itemize
8966 Don't change the options
8977 \begin_inset space ~
8983 They're ignored by the
8990 \begin_layout Itemize
8991 The default font size is 20
8992 \begin_inset space \thinspace{}
8995 pt with the other options being 17
8996 \begin_inset space \thinspace{}
9000 \begin_inset space \thinspace{}
9004 \begin_inset space \thinspace{}
9010 \begin_layout Itemize
9019 but all math equations are still typeset in the usual roman font.
9022 \begin_layout Itemize
9027 supports A4 and Letter paper sizes as well as a special size for working
9029 \begin_inset space \thinspace{}
9033 It doesn't support A5, B5, legal or executive paper sizes.
9036 \begin_layout Itemize
9037 Don't bother changing the
9041 settings because they are ignored anyway.
9042 All floats appear where they are defined in the text.
9045 \begin_layout Itemize
9050 setting behaves a bit differently for this class.
9055 provides extensive footer and header capabilities including a user-defined
9058 \begin_inset space ~
9062 \begin_inset CommandInset ref
9064 reference "sec:foilfoot"
9069 The title page is treated differently to all other pages in the document
9078 has the logo centered at the bottom of the page (if one is defined).
9079 The possible page style choices and what they do are as follows:
9083 \begin_layout Labeling
9084 \labelwidthstring MMMMMMM
9091 The final output contains no page numbers, or other headers or footers
9092 (except footnotes of course).
9096 \begin_layout Labeling
9097 \labelwidthstring MMMMMMM
9104 The final output contains page numbers centered at the bottom of the page.
9105 No other headings or footers (other than footnotes).
9108 \begin_layout Labeling
9109 \labelwidthstring MMMMMMM
9114 Page numbers in lower right corner.
9115 Additional headers and footers are also shown.
9116 This is also the default.
9119 \begin_layout Labeling
9120 \labelwidthstring MMMMMMM
9125 Gives you access to the
9129 package although its use with
9133 is discouraged by the writer of the
9137 package because of some potential page layout clashes.
9141 \begin_layout Subsubsection
9145 \begin_layout Standard
9146 The following options may be used in the extra class options in the
9148 Document\SpecialChar \menuseparator
9154 \begin_layout Labeling
9155 \labelwidthstring MMMMMMx
9160 This sets up the page layout for 7.33
9161 \begin_inset space \thinspace{}
9165 \begin_inset space \thinspace{}
9168 in paper, which is about the same aspect ratio as a 35
9169 \begin_inset space \thinspace{}
9172 mm slide, making it a bit easier to work with this medium.
9175 \begin_layout Labeling
9176 \labelwidthstring MMMMMMx
9181 Places a rule across the page below the header on every page except the
9185 \begin_layout Labeling
9186 \labelwidthstring MMMMMMx
9191 Places a rule across the page above the footer on every page except the
9195 \begin_layout Labeling
9196 \labelwidthstring MMMMMMx
9201 This is automatically set each time you create a new
9210 to use the dvips driver to rotate those pages that are set as landscape
9214 \begin_layout Labeling
9215 \labelwidthstring MMMMMMx
9220 Simply changes the page dimensions to those of a landscape page but doesn't
9222 Thus if you use this option you need to use an external program to rotate
9223 each page or feed your paper through your printer as landscape.
9224 Note that this option effectively reverses the roles of the
9232 environments (don't worry these are described in the next section).
9235 \begin_layout Labeling
9236 \labelwidthstring MMMMMMx
9241 Equation numbers on the left.
9244 \begin_layout Labeling
9245 \labelwidthstring MMMMMMx
9250 Flush-left equations.
9253 \begin_layout Subsection
9254 Supported Environments
9257 \begin_layout Standard
9258 Most of the environments commonly supported in other classes are also supported
9264 There are several additional environments provided by
9268 as well as a couple added by LyX.
9269 The following environments are shared with other classes:
9272 \begin_layout Standard
9276 \begin_layout Plain Layout
9288 \begin_layout Itemize
9294 \begin_layout Itemize
9300 \begin_layout Itemize
9306 \begin_layout Itemize
9312 \begin_layout Itemize
9318 \begin_layout Itemize
9324 \begin_layout Itemize
9330 \begin_layout Itemize
9336 \begin_layout Itemize
9342 \begin_layout Itemize
9348 \begin_layout Itemize
9354 \begin_layout Itemize
9360 \begin_layout Itemize
9366 \begin_layout Itemize
9372 \begin_layout Itemize
9378 \begin_layout Itemize
9384 \begin_layout Itemize
9390 \begin_layout Itemize
9396 \begin_layout Standard
9400 \begin_layout Plain Layout
9412 \begin_layout Standard
9413 That is, all the major environments apart from the sectioning environments.
9414 Since foils are essentially self-contained sections, with a title and body,
9419 provides specific commands for starting new foils and these are:
9422 \begin_layout Itemize
9428 \begin_layout Itemize
9434 \begin_layout Standard
9435 LyX also provides slightly modified versions of these two environments called:
9438 \begin_layout Itemize
9444 \begin_layout Itemize
9450 \begin_layout Standard
9451 and the differences will be explained in the next section.
9454 \begin_layout Standard
9455 Since foils are often used in presenting ideas or new theorems and such
9460 also provides a comprehensive box of goodies for presenting them:
9463 \begin_layout Standard
9467 \begin_layout Plain Layout
9479 \begin_layout Itemize
9485 \begin_layout Itemize
9491 \begin_layout Itemize
9497 \begin_layout Itemize
9503 \begin_layout Itemize
9509 \begin_layout Itemize
9515 \begin_layout Itemize
9521 \begin_layout Itemize
9527 \begin_layout Itemize
9533 \begin_layout Itemize
9539 \begin_layout Itemize
9545 \begin_layout Standard
9549 \begin_layout Plain Layout
9561 \begin_layout Standard
9562 The starred versions are unnumbered while the unstarred versions are numbered.
9563 There are also two list environments added by LyX and these are:
9566 \begin_layout Itemize
9572 \begin_layout Itemize
9578 \begin_layout Standard
9583 provides some powerful header and footer capabilities that are best set
9584 in the preamble although they may be set at any point in a document.
9585 If you want to change these settings in your document the best place to
9586 do so is at the very top of a foil, i.
9587 \begin_inset space \thinspace{}
9593 \begin_inset space \space{}
9598 straight after the foilhead.
9601 \begin_layout Standard
9602 For this purpose, the following command styles are provided [
9609 \begin_layout Standard
9613 \begin_layout Plain Layout
9625 \begin_layout Itemize
9629 \begin_inset space ~
9635 \begin_layout Itemize
9641 \begin_layout Itemize
9645 \begin_inset space ~
9651 \begin_layout Itemize
9655 \begin_inset space ~
9661 \begin_layout Itemize
9665 \begin_inset space ~
9672 \begin_layout Standard
9673 \begin_inset space ~
9680 \begin_layout Standard
9684 \begin_layout Plain Layout
9696 \begin_layout Standard
9697 There are also a few commands provided by
9701 that aren't directly supported by LyX but I'll tell you what they do and
9702 how to use them in section
9703 \begin_inset space ~
9707 \begin_inset CommandInset ref
9709 reference "sec:unsuppfoils"
9716 \begin_layout Subsection
9717 Building a Set of Foils
9720 \begin_layout Standard
9721 This section will give a simple introduction to using the different environments
9722 to build a set of foils.
9723 If you want to see an example set of foils, take a look at the
9727 file you find in LyX's
9734 \begin_layout Subsubsection
9735 Give It a Title Page
9738 \begin_layout Standard
9739 Unlike other classes that provide
9759 creates the title on a page of its own.
9760 If you leave out the
9764 environment LaTeX will substitute the current date (every time you regenerate
9768 \begin_layout Subsubsection
9772 \begin_layout Standard
9773 As I mentioned earlier, there are four ways of starting a new foil.
9774 For portrait foils you should use
9783 The difference between these two environments is the amount of space between
9784 the title of the foil (the foilhead) and the body of the foil.
9787 \begin_layout Standard
9788 Landscape foils are generated using the
9797 Again the only difference is the spacing between foilhead and body.
9798 Both of the short versions have 0.5 inches less separation between the foilhead
9803 \begin_layout Standard
9804 One problem with the support for landscape foils is the requirement that
9809 driver to generate the PostScript output otherwise the foils won't be rotated.
9810 It is possible to get landscape foils even if you haven't got the
9814 driver provided you can feed your foils sideways through your printer ;-)
9817 \begin_layout Subsubsection
9818 Theorems, Lemmas, Proofs and more
9821 \begin_layout Standard
9822 Due to a small bug in LyX you can't have two of the same type of these environme
9823 nts directly following each other.
9824 They must be separated by something.
9825 If you try, you will just be extending the previous environment as if you
9826 had merged the two environments together.
9827 So, how do you get around this problem? The simplest option is to insert
9828 some text between the two environments or add a
9832 environment between the two with just a
9833 \begin_inset Quotes eld
9841 \begin_inset Quotes erd
9845 This will force LyX to produce two separate environments and hence the
9846 correct LaTeX output.
9847 An example is provided in the example file included with the LyX distribution.
9848 Remember, this problem only occurs if you are trying to place two of the
9849 same type of theorem-like environments one directly after the other.
9852 \begin_layout Subsubsection
9856 \begin_layout Standard
9857 You get all the commonly supported list styles found in other classes as
9858 well as two new ones.
9859 I'll only describe the new ones here.
9860 If you want to find out more about the other list environments check out
9866 If you intend to use itemized lists you might also want to read about the
9870 \begin_inset space ~
9874 \begin_inset space ~
9879 dialog described above in section
9880 \begin_inset space ~
9884 \begin_inset CommandInset ref
9886 reference "sec:bullet"
9893 \begin_layout Standard
9894 The two new list styles,
9902 , are designed to make it easier for you to create lists of do's and don'ts
9903 or right and wrong by providing dedicated environments that use a tick
9904 or a cross as the label of the list.
9905 These lists are in fact dedicated variants of the
9910 They do however require that you have the
9917 \begin_layout Subsubsection
9921 \begin_layout Standard
9926 redefines the floating tables and figures so that they appear exactly where
9927 they are in the text rather than pushing them to the top of the page or
9928 to some user specified location.
9929 In fact if you change the float placement settings they are simply ignored.
9932 \begin_layout Subsubsection
9933 Page Headers and Footers
9934 \begin_inset CommandInset label
9943 \begin_layout Standard
9947 \begin_inset space ~
9956 are two commands used to control the left-footer text string.
9957 The first is meant to allow you to include a graphic logo on your foils
9959 \begin_inset Quotes eld
9967 \begin_inset Quotes erd
9971 While the second is meant to provide a classification for the audience,
9975 \begin_inset space \thinspace{}
9981 \begin_inset space \space{}
9985 It is empty by default.
9988 \begin_layout Standard
9989 The remaining page corners can be filled by
9992 \begin_inset space ~
9997 (which defaults to page numbers),
10000 \begin_inset space ~
10008 \begin_inset space ~
10016 \begin_layout Subsection
10022 \begin_inset CommandInset label
10024 name "sec:unsuppfoils"
10031 \begin_layout Standard
10032 All the commands mentioned below need to be set in a
10040 within another environment.
10043 \begin_layout Subsubsection
10047 \begin_layout Standard
10048 All lengths are adjusted using the
10071 should be replaced by the name given to the length you want to change and
10076 is the length value.
10077 All lengths should be specified in units of length such as inches (
10089 ) or relative to some document or font-based length such as
10099 \begin_layout Standard
10100 It's possible to change the spacing between a foilhead and the body of the
10101 foil by adjusting the length specified by
10108 For example, to make
10113 \begin_inset space \space{}
10116 in closer to their bodies put the following in the preamble:
10122 foilheadskip}{-0.5in}
10125 \begin_layout Standard
10126 The spacings around floats can be adjusted by setting these lengths:
10129 \begin_layout Labeling
10130 \labelwidthstring MMMMMMMMMMM
10137 Separation between the text and the top of the float
10140 \begin_layout Labeling
10141 \labelwidthstring MMMMMMMMMMM
10148 Separation between the float and the caption
10151 \begin_layout Labeling
10152 \labelwidthstring MMMMMMMMMMM
10159 Separation between the caption and the following text
10162 \begin_layout Labeling
10163 \labelwidthstring MMMMMMMMMMM
10170 You can make the captions narrower than the surrounding text by adjusting
10172 Best done relative to
10181 \begin_layout Standard
10182 There are also several title page related lengths that you may find useful
10183 if you have a long title or several authors:
10186 \begin_layout Labeling
10187 \labelwidthstring MMMMMMMMMMM
10194 Separation from headers to
10199 \begin_layout Labeling
10200 \labelwidthstring MMMMMMMMMMM
10218 \begin_layout Labeling
10219 \labelwidthstring MMMMMMMMMMM
10233 \begin_layout Labeling
10234 \labelwidthstring MMMMMMMMMMM
10250 \begin_layout Labeling
10251 \labelwidthstring MMMMMMMMMMM
10267 \begin_layout Standard
10268 The last length related command affects all the list environments.
10279 a list environment then all the vertical spacing between the list items
10281 Note that this is a command not a length so it doesn't require
10287 like the stuff mentioned above.
10290 \begin_layout Subsubsection
10291 Headers and Footers
10294 \begin_layout Standard
10307 commands control whether the logo in the
10311 definition appear on a given page.
10318 in the preamble then none of the foils will have the logo on them.
10319 If you don't want the logo on a particular page place the
10325 directly after the foilhead of that page and the
10331 directly after the next foilhead.
10334 \begin_layout Standard
10335 If you decide to use the
10339 page style setting in the
10342 \begin_inset space ~
10347 dialog you should probably add
10357 to your preamble so headers and footers on landscape pages are correctly
10358 placed when rotated.
10359 This is due to some clashes between the page layouts provided by the
10370 \begin_layout Section
10371 Hollywood (Hollywood spec scripts)
10374 \begin_layout Standard
10380 \begin_layout Subsection
10384 \begin_layout Standard
10385 Getting the format of a Hollywood script right is a
10386 \begin_inset Quotes eld
10390 \begin_inset Quotes erd
10393 It is designed to make the readers focus on content and to be easy and
10394 familiar for the actors to read.
10395 Each page of a script should be one minute of film.
10396 Nothing goes in a script that you cannot see or hear on screen.
10397 The courier 12 pt font should be used throughout.
10401 \begin_layout Subsection
10405 \begin_layout Standard
10406 Speakers' lines should NEVER break in mid-sentence.
10407 If a speaker's lines continue over a page break, repeat the
10411 title followed by (Cont'd).
10414 \begin_layout Subsection
10418 \begin_layout Standard
10423 names as labels then cross-reference the label to insert the name.
10424 The cross-reference dialog will show the current cast of characters.
10425 You can use this to insert the speaker name in narratives also.
10428 \begin_layout Subsection
10429 Paper size and Margins
10432 \begin_layout Standard
10433 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10436 \begin_layout Subsection
10440 \begin_layout Standard
10441 The following environments are available.
10442 You can use hollywood.bind to get the bind keys shown at the right.
10445 \begin_layout Itemize
10449 \begin_inset Newline newline
10454 Used where nothing else works.
10458 \begin_layout Itemize
10464 \begin_inset space \hfill{}
10472 \begin_inset Newline newline
10475 Usually followed by something like
10476 \begin_inset Quotes eld
10479 on Sally waking up.
10480 \begin_inset Quotes erd
10486 \begin_layout Itemize
10490 \begin_inset space \hfill{}
10494 \begin_inset Newline newline
10499 Introduces a new INTERIOR camera set-up.
10500 Always followed by DAY or NIGHT, or something similar to define the lighting
10502 Everthing on this line in CAPS.
10505 \begin_layout Itemize
10509 \begin_inset space \hfill{}
10513 \begin_inset Newline newline
10518 Introduces a new EXTERIOR camera set-up.
10519 Everthing on this line in CAPS.
10522 \begin_layout Itemize
10526 \begin_inset space \hfill{}
10530 \begin_inset Newline newline
10535 The character speaking.
10538 \begin_layout Itemize
10542 \begin_inset space \hfill{}
10546 \begin_inset Newline newline
10551 Instructions to the speaker.
10552 The () are automatically inserted, but only the ( will show in LyX.
10553 Both will be printed.
10556 \begin_layout Itemize
10560 \begin_inset space \hfill{}
10564 \begin_inset Newline newline
10576 \begin_layout Itemize
10580 \begin_inset space \hfill{}
10584 \begin_inset Newline newline
10589 Camera movement instruction.
10591 \begin_inset space \thinspace{}
10595 \begin_inset space \space{}
10601 \begin_layout Itemize
10605 \begin_inset space \hfill{}
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 Subsection
10645 \begin_layout Itemize
10646 (O.S) — off screen
10649 \begin_layout Itemize
10650 (V.0) — voice over
10653 \begin_layout Itemize
10655 \begin_inset space \thinspace{}
10662 \begin_layout Itemize
10667 \begin_layout Itemize
10668 PAN — camera movement
10671 \begin_layout Itemize
10672 INSERT — cut to close-up of
10675 \begin_layout Section
10679 \begin_layout Standard
10682 Panayotis Papasotiriou
10685 \begin_layout Subsection
10689 \begin_layout Standard
10690 The ijmpc package is a set of macros that facilitates electronic manuscript
10693 International Journal of Modern Physics C
10696 Similarly, the ijmpd package is for creating manuscripts to be submitted
10699 International Journal of Modern Physics D
10702 Both journals are published by World Scientific.
10703 The corresponding document classes are named
10712 These files, together with instructions for the authors, can be downloaded
10714 \begin_inset Flex URL
10717 \begin_layout Plain Layout
10719 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
10725 \begin_inset Flex URL
10728 \begin_layout Plain Layout
10730 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
10736 Both packages are modified versions of the standard
10737 \begin_inset Quotes eld
10741 \begin_inset Quotes erd
10744 package, and they are almost (but not exactly) identical.
10745 Most of their features are supported by LyX.
10746 I have used LyX successfully to write articles submitted to both journals
10747 without any problem.
10750 \begin_layout Subsection
10754 \begin_layout Standard
10755 As usual, the easiest way to write a paper is to start with a template.
10758 File\SpecialChar \menuseparator
10777 This will give an (almost) empty document that includes the most common
10778 fields found in a manuscript.
10779 Simply overwrite the existing text (including the brackets,
10784 You should keep in mind the following remarks.
10787 \begin_layout Enumerate
10788 LyX won't let you change the font size and the page style of the document,
10789 because such modifications are not allowed by both packages.
10792 \begin_layout Enumerate
10793 The language of the document should not be changed.
10794 Before previewing your paper, be sure that the babel package is not used.
10795 To do this, click on
10797 Tools\SpecialChar \menuseparator
10808 checkbox in the language settings, and click on
10816 , if you wish to make this change permanent).
10819 \begin_layout Enumerate
10821 \begin_inset Quotes eld
10825 \begin_inset Quotes erd
10828 style must be used to define keywords.
10831 \begin_layout Enumerate
10832 The ijmpc package provides a style named
10833 \begin_inset Quotes eld
10836 Classification Codes
10837 \begin_inset Quotes erd
10840 , which can be used to define classification codes, such as PACS numbers.
10841 Note that this facility is not supported by the ijmpd package.
10844 \begin_layout Enumerate
10845 Several new environments are available:
10846 \begin_inset Quotes eld
10850 \begin_inset Quotes erd
10854 \begin_inset Quotes eld
10858 \begin_inset Quotes erd
10862 \begin_inset Quotes eld
10866 \begin_inset Quotes erd
10870 \begin_inset Quotes eld
10874 \begin_inset Quotes erd
10878 \begin_inset Quotes eld
10882 \begin_inset Quotes erd
10886 \begin_inset Quotes eld
10890 \begin_inset Quotes erd
10894 \begin_inset Quotes eld
10898 \begin_inset Quotes erd
10902 \begin_inset Quotes eld
10906 \begin_inset Quotes erd
10910 \begin_inset Quotes eld
10914 \begin_inset Quotes erd
10918 \begin_inset Quotes eld
10922 \begin_inset Quotes erd
10926 \begin_inset Quotes eld
10930 \begin_inset Quotes erd
10934 \begin_inset Quotes eld
10938 \begin_inset Quotes erd
10942 \begin_inset Quotes eld
10946 \begin_inset Quotes erd
10950 \begin_inset Quotes eld
10954 \begin_inset Quotes erd
10958 Their use is more or less obvious.
10959 LyX supports all these environments; it will use the proper label, text
10960 style, and numbering scheme for each of them.
10963 \begin_layout Enumerate
10964 Both packages use basic citations; the natbib package should not be used.
10965 In LyX, citation references are shown as usual; in the output, citations
10966 are shown as superscripts.
10967 If you want to use a citation as normal text, you should use the
10972 \begin_inset space \thinspace{}
10976 \begin_inset space \space{}
10980 \begin_inset Quotes eld
10984 \begin_inset space \space{}
10994 \begin_inset Quotes erd
11000 \begin_layout Enumerate
11002 \begin_inset Quotes eld
11006 \begin_inset Quotes erd
11009 section in both packages.
11010 To put acknowledgments, just use the
11011 \begin_inset Quotes eld
11015 \begin_inset Quotes erd
11021 \begin_layout Enumerate
11022 Appendices may be added to the paper,
11026 the Acknowledgments and
11031 LyX provides a special environment, called
11032 \begin_inset Quotes eld
11036 \begin_inset Quotes erd
11039 which marks the beginning of the appendices.
11040 This environment should be left blank; it just sends a LaTeX command, but
11041 nothing is really printed.
11043 \begin_inset Quotes eld
11047 \begin_inset Quotes erd
11050 is printed with blue letters, as a signal that all sections after that
11051 point are appendices.
11052 To write an appendix, use the
11053 \begin_inset Quotes eld
11057 \begin_inset Quotes erd
11061 LyX will number each appendix with capital letters, as required by both
11064 \begin_inset Quotes eld
11068 \begin_inset Quotes erd
11075 be present before the first appendix; if not, all appendices will be numbered
11076 as normal sections in the output.
11079 \begin_layout Enumerate
11080 The ijmpc and the ijmpd packages use the
11084 command to implement table captions.
11085 As a result, a table created by LyX is printed correctly, but its caption
11087 However, you can use some TeX code to overpass this problem, so that captions
11088 are printed as expected.
11089 To do so, create a float table as usual, remove the caption, and replace
11090 it with the TeX code
11100 (sic); you must also the TeX code
11104 immediately after the tabular material.
11105 Study the example table included in the template files to see how this
11106 trick is implemented.
11107 Alternatively, If you need table captions, you should implement the whole
11112 file, then include this file to the LyX document (
11114 Insert\SpecialChar \menuseparator
11115 File\SpecialChar \menuseparator
11117 \begin_inset space ~
11123 Details on how to create a table float can be found in the files
11131 , included in the corresponding packages.
11134 \begin_layout Subsection
11135 Preparing a paper for submission
11138 \begin_layout Standard
11139 Before you submit your paper you must export the LyX document as a LaTeX
11142 File\SpecialChar \menuseparator
11143 Export\SpecialChar \menuseparator
11150 \begin_layout Plain Layout
11151 Actually you have the choice between LaTeX (plain) and pdflatex.
11152 If you intend to use pdflatex to prepare the paper, you should use the
11153 pdflatex option so that included graphics are converted to PDF format,
11154 ready for use by pdflatex.
11159 , then make the following changes to the resulting
11166 \begin_layout Enumerate
11167 Remove the comment lines before the
11176 \begin_layout Enumerate
11177 Remove everything between (and including) the
11189 commands, except for any commands you specifically put into the LaTeX preamble.
11192 \begin_layout Standard
11197 file should be saved and processed through LaTeX as many times as necessary.
11198 You may also want to check the resulting
11205 \begin_layout Subsection
11209 \begin_layout Standard
11210 The use of TeX code is reduced to two commands, which must be placed at
11211 the top of the document.
11212 If you started writing your paper by using the
11220 template, the TeX code needed is already in its place; you usually don't
11222 You may only modify the first TeX code to specify the information printed
11223 to the top of odd and even pages (authors' names and short paper's title,
11225 This TeX code must have the form
11229 markboth{Authors' Names}{Short Paper's Title}
11234 \begin_layout Section
11238 \begin_layout Standard
11244 \begin_layout Subsection
11248 \begin_layout Standard
11249 The iopart package provides a document class to create electronic manuscript
11250 submission to the journals published by the Institute of Physics.
11251 Instructions for the authors how to create a paper using the iopart class
11252 can be downloaded together with the iopart package from the site
11253 \begin_inset Flex URL
11256 \begin_layout Plain Layout
11258 ftp://ftp.iop.org/pub/journals/latex2e
11266 \begin_layout Subsection
11270 \begin_layout Standard
11271 The easiest way to write a paper is to start with the file
11275 that is available in LyX's examples files folder.
11276 Open this file, save it under a new name, and start writing.
11277 The example file explains how to use the special text environments.
11278 Here are the most important advices:
11281 \begin_layout Itemize
11282 To be able to compile your document to a PDF, PS, or DVI, assure that the
11285 Use AMS math package
11287 in the document settings under
11294 \begin_layout Itemize
11297 The title environment defines the kind of your paper.
11298 So use one of the following environments for the title:
11302 \begin_layout Itemize
11311 \begin_layout Itemize
11320 \begin_layout Itemize
11326 for a Topical review
11329 \begin_layout Itemize
11338 \begin_layout Itemize
11347 \begin_layout Itemize
11353 for a Paper (same as Title)
11356 \begin_layout Itemize
11362 for a Preliminary communication
11365 \begin_layout Itemize
11371 for a Rapid communication
11374 \begin_layout Itemize
11380 for a Letter to the editor
11384 \begin_layout Itemize
11387 All title environments except of
11391 can have an optional short title.
11394 \begin_layout Itemize
11395 There is a general title environment
11399 which is not directly supported by the LyX.
11400 This can be used as TeX code when your document doesn't fit into one of
11401 the other title types.
11404 \begin_layout Standard
11405 For more informations like hints for special table and formula formatting,
11406 look at the IOP author guidelines.
11409 \begin_layout Section
11413 \begin_layout Standard
11416 Panayotis Papasotiriou
11419 \begin_layout Subsection
11423 \begin_layout Standard
11424 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
11425 that facilitates electronic manuscript submission to the journals they
11427 Most known of them (at least in my domain of interest) are
11429 Astrophysics and Space Science
11435 , but there are many others (see a complete list at
11436 \begin_inset Flex URL
11439 \begin_layout Plain Layout
11441 http://www.wkap.nl/jrnllist.htm/JRNLHOME
11447 The Kluwer package may be downloaded from the site
11448 \begin_inset Flex URL
11451 \begin_layout Plain Layout
11453 http://www.wkap.nl/kaphtml.htm/STYLEFILES
11459 A complete user guide is contained in that package (but it can also be
11460 downloaded separately).
11463 \begin_layout Standard
11464 LyX supports many features of the package but not everything.
11465 However, the TeX code needed is reduced to some
11466 \begin_inset Quotes eld
11470 \begin_inset Quotes erd
11473 commands of the package (see
11474 \begin_inset space ~
11478 \begin_inset CommandInset ref
11480 reference "subsec:kluwer_peculiarities"
11485 I have recently used LyX to write an article submitted to the
11487 Astrophysics and Space Science
11489 without any problem.
11492 \begin_layout Subsection
11496 \begin_layout Standard
11497 The easiest way to write a paper is to start with the Kluwer template file.
11500 File\SpecialChar \menuseparator
11512 This will give an (almost) empty document that includes the most common
11513 fields found in a manuscript and a short description of their use.
11514 As in most templates, simply overwrite the existing text (including the
11519 ) with the correct information.
11522 \begin_layout Subsection
11523 Preparing a paper for submission
11526 \begin_layout Standard
11527 As in the AASTeX package, before you submit your paper to a journal you
11529 \begin_inset Quotes eld
11533 \begin_inset Quotes erd
11539 \begin_layout Enumerate
11540 Export your paper as a LaTeX file.
11541 To do this, click on
11543 File\SpecialChar \menuseparator
11544 Export\SpecialChar \menuseparator
11551 \begin_layout Enumerate
11556 file with a text editor and make the following changes
11560 \begin_layout Enumerate
11561 remove the comment lines before the
11570 \begin_layout Enumerate
11571 remove everything between (and including) the
11583 commands, except for any commands you specifically put into the LaTeX preamble.
11586 \begin_layout Standard
11595 \begin_layout Enumerate
11600 file through LaTeX as many times as necessary (usually up to three).
11603 \begin_layout Enumerate
11609 \begin_inset space \thinspace{}
11613 \begin_inset space \space{}
11620 , and check if everything is OK (it should, if you didn't make any mistake).
11623 \begin_layout Subsection
11624 \begin_inset Quotes eld
11628 \begin_inset Quotes erd
11631 of the Kluwer package
11632 \begin_inset CommandInset label
11634 name "subsec:kluwer_peculiarities"
11641 \begin_layout Standard
11642 The Kluwer package has the following
11643 \begin_inset Quotes eld
11647 \begin_inset Quotes erd
11653 \begin_layout Enumerate
11654 It is possible to write multiple articles in the same LaTeX file
11658 \begin_layout Plain Layout
11659 I can't imagine any good reason to do this.
11665 Each article must be included in the environment
11666 \begin_inset Quotes eld
11670 \begin_inset Quotes erd
11674 Unfortunately, this environment cannot be omitted, even if you write just
11676 Therefore, each article starts with the command
11682 and, obviously, ends with the command
11689 Although this can be implemented in LyX, I didn't included it, since it
11690 looks ugly and can confuse the novice user.
11691 Therefore, you need to enter them directly and mark them as LaTeX code
11693 \begin_inset Quotes eld
11697 \begin_inset Quotes erd
11703 \begin_layout Enumerate
11704 Information given at the beginning of the article (i.
11705 \begin_inset space \thinspace{}
11709 \begin_inset space \space{}
11712 title, subtitle, author, institution, running title, running author, abstract
11713 and keywords) must be included in an environment called
11714 \begin_inset Quotes eld
11718 \begin_inset Quotes erd
11722 This is not implemented in LyX, so you must enter title, subtitle etc.
11723 \begin_inset space ~
11726 between two TeX code lines (
11741 \begin_layout Enumerate
11742 According to the user manual, the label of each bibliography item must be
11766 \begin_layout Standard
11771 template takes care of all these
11772 \begin_inset Quotes eld
11776 \begin_inset Quotes erd
11780 If you start a new paper using this template you don't need to do anything
11785 \begin_layout Enumerate
11786 don't delete the TeX code included in the template, and
11789 \begin_layout Enumerate
11790 copy the example bibliography item included in the template and modify it
11791 as necessary to enter new bibliography items.
11794 \begin_layout Section
11798 \begin_layout Standard
11804 \begin_layout Subsection
11808 \begin_layout Standard
11809 The LyX document classes
11811 article (koma-script)
11815 report (koma-script)
11833 correspond to the LaTeX document classes
11850 \begin_inset space ~
11853 of the Koma-Script family.
11854 They are replacements for the standard document classes
11870 , resp., and fit better to European typography conventions in a number of
11874 \begin_layout Itemize
11875 Standard character size is 11pt in
11877 article (koma-script)
11881 report (koma-script)
11889 letter (koma-script)
11894 \begin_layout Itemize
11895 Headings, labels of the description environment, and a number of elements
11898 letter (koma-script)
11900 document class are set in a bold sans serif font.
11904 \begin_layout Plain Layout
11905 There is a big difference between the bold sans serif old cm fonts and new
11906 ec fonts, especially in the appearance of headings.
11907 In comparison, the ec bold sans serif fonts look a bit thin.
11908 Here the LaTeX package
11916 helps to produce the
11917 \begin_inset Quotes eld
11921 \begin_inset Quotes erd
11924 appearance when using the ec fonts.
11929 The numbering of chapter headings is made in the same way as the numbering
11930 of section headings, that is without the extra line
11931 \begin_inset Quotes eld
11934 Chapter\SpecialChar \ldots{}
11936 \begin_inset Quotes erd
11940 In addition, the appearance of the headings can be modified by using a
11941 number of options (in LyX to be entered in the field
11944 \begin_inset space ~
11951 Layout\SpecialChar \menuseparator
11955 A detailed German description of these options can be found in the Koma-Script
11963 \begin_layout Itemize
11964 The main means in the Koma-Script document classes to design the type area
11973 (in LyX to be entered in the extra class options field in the dialog
11975 Document\SpecialChar \menuseparator
11979 They make a clearer modification of page margins possible as do the options
11982 Document\SpecialChar \menuseparator
11986 A detailed German description of these and other type area options can
11987 be found in the Koma-Script documentation
11994 \begin_layout Itemize
11995 The LaTeX document classes of the Koma-Script family define a number of
11996 additional commands.
11997 Those part of it which makes sense in LyX is implemented in corresponding
12001 \begin_layout Standard
12002 A detailed German description of the LaTeX document classes of the Koma-Script
12003 family can be found in the Koma-Script documentation
12011 \begin_layout Plain Layout
12012 There is an English translation
12016 , but it is not a complete one.
12021 The following sections describe only those aspects, which are relevant
12025 \begin_layout Subsection
12026 article (koma-script), report (koma-script), and book (koma-script)
12029 \begin_layout Standard
12030 The document classes
12032 article (koma-script)
12036 report (koma-script)
12046 are implemented in the layout files
12059 They contain all the paragraph types of the corresponding standard document
12072 , resp., partly modified, with the exception of the LyX specific
12076 -type, which is replaced by the new
12080 -type having the same functionality.
12085 -Type there is a number of new paragraph types added.
12092 letter (koma-script)
12097 \begin_layout Itemize
12106 : are equivalents to
12114 , resp., additionally inserting an entry in the table of contents.
12123 are not contained in
12125 article (koma-script)
12130 \begin_layout Itemize
12139 : behave exactly as
12147 , resp., additionally clearing running heads.
12152 is not contained in
12154 article (koma-script)
12160 \begin_layout Plain Layout
12173 report (koma-script)
12175 , but since this is identical to
12179 , is has not been implemented in LyX.
12187 \begin_layout Itemize
12192 : generates a heading directly above the following paragraph in the standard
12193 character size without affecting the structure of the document.
12196 \begin_layout Itemize
12205 are special captions which respect the different space settings needed
12206 for captions placed above or below an element (if you follow strict typographic
12207 rules, you might want to place table captions always above the table).
12208 You can also use the class option
12212 , which will switch
12225 You need at least Koma-Script version 2.8q to use this.
12228 \begin_layout Itemize
12233 : can be used to set a bonmot, e.
12234 \begin_inset space \thinspace{}
12238 \begin_inset space \space{}
12241 at the beginning of a chapter.
12242 If you use the optional argument (
12244 Insert\SpecialChar \menuseparator
12246 \begin_inset space ~
12251 ), you can insert the dictum's author there.
12252 Dictum and author are separated by a line.
12253 You need at least Koma-Script version 2.8q to use this.
12258 is not contained in
12260 article (koma-script)
12265 \begin_layout Standard
12266 The following types, together with the standard types
12278 , form the title area of the document.
12279 They must be entered ahead of the first
12280 \begin_inset Quotes eld
12284 \begin_inset Quotes erd
12291 \begin_layout Plain Layout
12292 The corresponding LaTeX commands must appear before the
12303 When such a type is used more than once, the latter usage overwrites the
12304 former one, that means, for every type only the latest usage is valid.
12305 The order of the different types however has, like
12317 , no effect on the appearance of the produced document.
12320 \begin_layout Itemize
12325 : produces a centered paragraph above the ordinary title (
12337 ) for the subject of the document.
12340 \begin_layout Itemize
12345 : produces a centered paragraph below the ordinary title (
12357 ) for the publishers' name.
12360 \begin_layout Itemize
12367 report (koma-script)
12373 produces a centered paragraph on its own page behind the title page, or
12376 article (koma-script)
12378 produces a centered paragraph below the ordinary title (
12394 ) for a dedication.
12397 \begin_layout Itemize
12402 : produces a left aligned paragraph above the ordinary title (
12418 ) for a document`s head.
12421 \begin_layout Itemize
12426 : produces in a double-sided print in
12428 report (koma-script)
12434 a left-aligned paragraph at the top of the title page`s back or has no
12435 effect in a single-sided print or in
12437 article (koma-script)
12442 \begin_layout Itemize
12447 : produces in a double-sided print in
12449 report (koma-script)
12455 a left-aligned paragraph at the bottom of the title page`s back or has
12456 no effect in a single-sided print or in
12458 article (koma-script)
12463 \begin_layout Itemize
12468 : produces a special
12469 \begin_inset Quotes eld
12473 \begin_inset Quotes erd
12476 page ahead of the actual document containing a paragraph without special
12480 \begin_layout Standard
12481 The layout files for the document classes
12483 article (koma-script)
12487 report (koma-script)
12493 do include the file
12498 This is thought of as a place to define your own types.
12503 in your personal layout directory and edit the file!
12506 \begin_layout Subsection
12507 letter (koma-script)
12510 \begin_layout Standard
12514 \begin_layout Plain Layout
12526 \begin_layout Standard
12530 letter (koma-script)
12532 is implemented in the layout file
12537 It contains all the paragraph types of the corresponding standard document
12542 , partly modified, with the exception of the LyX specific types
12554 type, which is replaced by the new
12559 In addition, it contains, in contrast to the standard document class, the
12577 Furthermore, there are a number of new letter specific types.
12580 \begin_layout Standard
12584 \begin_layout Plain Layout
12596 \begin_layout Standard
12597 The appearance of the letter produced by this document class can be controlled
12598 by a number of LaTeX commands, which you can put in the LaTeX preamble.
12602 \begin_layout Plain Layout
12603 For example, the standard appearance of the letter`s heading, consisting
12604 of name and address, is quite self-willed.
12606 \begin_inset Quotes eld
12610 \begin_inset Quotes erd
12613 heading is produced by the following LaTeX commands in the preamble:
12616 \begin_layout LyX-Code
12626 \begin_layout LyX-Code
12642 \begin_layout LyX-Code
12652 \begin_layout LyX-Code
12672 A detailed German description of such LaTeX commands can be found in the
12673 Koma-Script documentation
12678 With it, the letter's author can produce his personal letter layout.
12681 \begin_layout Standard
12690 define the beginning of the letter and must be used in every letter.
12691 To emphasize them in the LyX document class, they are marked with the letter
12701 \begin_inset space ~
12704 in the left margin.
12705 It is possible to write any number of letters in one file.
12710 type produces a new letter using the same addressee and a
12714 type produces a new addressee.
12731 are ordinary paragraph types and can also be used several times in one
12732 and the same letter.
12735 \begin_layout Itemize
12740 : produces a paragraph for the addressee and implicitly defines the beginning
12744 \begin_layout Itemize
12749 : produces a paragraph for the form of address and implicitly produces a
12753 \begin_layout Itemize
12758 : produces a paragraph for a close.
12761 \begin_layout Itemize
12766 : produces a paragraph for a postscript.
12769 \begin_layout Itemize
12774 : produces a paragraph for a distribution list.
12777 \begin_layout Itemize
12782 : produces a paragraph for enclosures.
12785 \begin_layout Standard
12826 are input types provided with a label to enter information, which will
12827 be processed by the document class.
12831 \begin_layout Plain Layout
12832 It could be seen as a matter of inconsequence, that the types
12840 described above are not such input types as well.
12841 Because of the special meaning of those types, however, I have implemented
12842 them as ordinary paragraph types with a one letter mark in the left margin.
12843 Moreover, it would affect my feeling of symmetry, if the
12851 type had such a serious different appearance.
12856 The types must be used ahead of the corresponding
12863 \begin_layout Standard
12864 An implementation of these types in a WYSIWYG fashion does not seem to make
12865 sense, because the real appearance of the produced letter does not only
12866 depend on the usage of the particular type, but also on other factors.
12867 For example, a signature entered in the
12871 type will in the standard behavior appear in the produced letter only,
12872 when in the same letter also a
12877 The entered value of the
12881 type will in the standard behavior not appear in the produced letter at
12883 The possibility to design the letter`s heading freely is already indicated
12884 in a footnote above.
12887 \begin_layout Standard
12888 The input types can also be used as empty paragraphs.
12889 This makes sense e.
12890 \begin_inset space \thinspace{}
12894 \begin_inset space \space{}
12906 type is not used at all, in the standard behavior the value of the
12910 type is used as signature, whereas if an empty
12914 type is used, no signature value is defined.
12917 \begin_layout Standard
12918 By using the input types it is possible to write a letter template, containing
12919 filled input types with your personal dates (name, address, etc.) and empty
12920 input types for other dates you want to enter.
12923 \begin_layout Itemize
12928 : sender's name, in the standard behavior appears as a centered paragraph
12929 in small caps in the letter`s heading.
12932 \begin_layout Itemize
12937 : sender's signature, in the standard behavior appears below the
12946 type is used, the value of the
12950 type appears instead.
12953 \begin_layout Itemize
12958 : sender's address, in the standard behavior appears in a centered paragraph
12959 in the letter`s heading below the sender's name.
12962 \begin_layout Itemize
12967 : sender's telephone number, in the standard behavior only sets the LaTeX
12977 \begin_layout Itemize
12982 : place of the letter`s making.
12985 \begin_layout Itemize
12990 : date of the letter`s making.
12999 , in the standard behavior, produce the place and the date in a right-aligned
13000 line below the addressee's field.
13005 type is used, neither place nor date appear, independent of the value of
13015 type is used, the date of the letter `s production is used.
13018 \begin_layout Itemize
13023 : sender`s back address, in the standard behavior appears above the addressee's
13024 field in a small sans serif font.
13027 \begin_layout Itemize
13032 : special mail information, in the standard behavior appears underlined
13033 above the addressee's field below the back address.
13036 \begin_layout Itemize
13041 : additional information, in the standard behavior appears on right side
13042 below the addressee`s field.
13045 \begin_layout Itemize
13050 : the letter's title, in the standard behavior appears in a big, bold, sans
13051 serif font above the subject.
13054 \begin_layout Itemize
13059 : the letter's subject, in the standard behavior appears in a bold font
13067 \begin_layout Standard
13088 produce a business letter like line above the
13092 line containing the fields
13093 \begin_inset Quotes eld
13097 \begin_inset Quotes erd
13101 \begin_inset Quotes eld
13105 \begin_inset Quotes erd
13109 \begin_inset Quotes eld
13113 \begin_inset Quotes erd
13117 \begin_inset Quotes eld
13121 \begin_inset Quotes erd
13125 \begin_inset Quotes eld
13129 \begin_inset Quotes erd
13133 \begin_inset Quotes eld
13137 \begin_inset Quotes erd
13141 For the date field, the value of the
13147 \begin_inset Quotes eld
13150 business letter types
13151 \begin_inset Quotes erd
13154 is used, the value of the
13158 type however does not appear, but only the LaTeX variable
13165 The ordinary output of place and date in a right-aligned line below the
13166 addressee`s field is suppressed.
13167 The types are implemented as input types provided with a label and must
13168 be used ahead of the corresponding
13175 \begin_layout Itemize
13183 \begin_layout Itemize
13191 \begin_layout Itemize
13199 \begin_layout Itemize
13207 \begin_layout Itemize
13215 \begin_layout Subsection
13216 The new letter class: letter (koma-script v.2)
13219 \begin_layout Standard
13222 Jürgen Spitzmüller
13225 \begin_layout Standard
13226 \begin_inset VSpace medskip
13232 \begin_layout Standard
13234 Koma-Script version 2.8 has introduced a new letter class
13238 which supersedes the now unsupported
13243 It has — on the LaTeX side — a completely new interface and is not compatible
13244 with the old class.
13245 Therefore, LyX supports both, though it is recommended to use the new class.
13248 \begin_layout Standard
13249 This class covers the same functionality as
13251 letter (koma-script),
13254 The basic items are
13258 (receiver's address, same as
13262 in the old layout),
13275 will start a new letter (i.
13276 \begin_inset space \thinspace{}
13280 \begin_inset space \space{}
13283 you can write several letters per document).
13284 New elements are sender's
13300 and the possibility to use a
13306 Insert\SpecialChar \menuseparator
13312 \begin_layout Standard
13313 The biggest improvement is, though, that the letter's layout is configurable
13314 at almost any needs.
13315 This can be done via the preamble or with a special style file (Letter
13316 Class Option, extension
13320 ), that will be read in as a class option.
13324 \begin_layout Plain Layout
13325 The KOMA package comes with some default
13330 There is, for instance, a
13334 file that follows german typesetting rules, or a
13338 that provides the default layout of the old
13343 The latter can be loaded with the class option
13352 ayout\SpecialChar \menuseparator
13357 ocument\SpecialChar \menuseparator
13369 template that is included in LyX for examples.
13370 A detailed description is to be found in the Koma-Script documentation
13378 \begin_layout Subsection
13382 \begin_layout Standard
13383 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
13387 \begin_layout Itemize
13388 The chapter number of a
13392 type appears on a line of its own above the chapter heading instead of
13393 appearing in the same line ahead of it.
13394 The cause for that is the LyX internal behavior for the labeltype
13398 in the layout file.
13401 \begin_layout Itemize
13402 The headings of the types
13410 are only put in the
13411 \begin_inset Quotes eld
13415 \begin_inset Quotes erd
13418 LaTeX table of contents, but not in the LyX table of contents (
13420 Document\SpecialChar \menuseparator
13422 \begin_inset space ~
13426 \begin_inset space ~
13434 \begin_layout Itemize
13435 The paragraphs in a
13439 document class appear in a skip separation mode, not indented.
13440 This is the standard behavior, no special LaTeX commands are needed for
13444 Document\SpecialChar \menuseparator
13447 dialog the corresponding radio button indicates
13456 value always has the effect that extra LaTeX commands are inserted in the
13457 document to produce the gap, which is not what is wanted in this case.
13460 \begin_layout Section
13461 Latex8 (IEEE Conference Papers)
13464 \begin_layout Standard
13470 \begin_layout Subsection
13474 \begin_layout Standard
13475 Since this class is specifically for writing submissions to IEEE sponsored
13476 conferences I strongly recommend that you get a copy of their Authors Kit.
13481 package and associated bibliography style file is included in the kit.
13482 The Authors Kit is usually sent out by email once your initial submission
13484 There is a lot of useful information in the Authors Kit explaining formatting
13485 restrictions and so on and I will assume you have read this since that
13486 means I don't have to repeat it all here.
13489 \begin_layout Subsection
13493 \begin_layout Standard
13494 [AR\SpecialChar \@.
13498 \begin_layout Subsection
13499 Supported Environments
13502 \begin_layout Itemize
13508 \begin_layout Itemize
13514 \begin_layout Itemize
13520 \begin_layout Itemize
13526 \begin_layout Itemize
13532 \begin_layout Itemize
13538 \begin_layout Itemize
13544 \begin_layout Itemize
13550 \begin_layout Itemize
13556 \begin_layout Subsection
13557 Differences Between Screen and Paper
13560 \begin_layout Standard
13561 There are slight differences in appearance mainly with the presentation
13562 of section counters.
13563 On screen the trailing period of the section counter is missing but it
13564 will appear in the output so don't let this worry you.
13567 \begin_layout Section
13571 \begin_layout Standard
13574 Jürgen Spitzmüller
13577 \begin_layout Subsection
13581 \begin_layout Standard
13582 Memoir is a very powerful and constantly evolving class.
13583 It has been designed with regard to fictional and non-fictional literature.
13584 Its aim is to let the user have maximum control over the typesetting of
13586 Memoir is based on the standard book class, but it can also emulate the
13587 article class (see below).
13590 \begin_layout Standard
13591 Peter Wilson, the developer of Memoir, is known as the author of lots of
13592 useful packages in the LaTeX world.
13593 Most of them have been merged with Memoir.
13594 Therefore, it is much easier to layout the table of contents, appendices,
13595 chapter designs and such.
13596 LyX, though, does not support all of these goodies natively.
13597 Some of them might be added to forthcoming releases
13601 \begin_layout Plain Layout
13602 You are invited to send suggestions to
13603 \begin_inset Flex URL
13606 \begin_layout Plain Layout
13608 lyx-devel@lists.lyx.org
13618 , lots will probably never, due to the limitations of LyX's framework.
13619 Of course you can still use all features with the help of some native LaTeX
13624 \begin_layout Plain Layout
13629 \begin_layout Plain Layout
13639 \begin_inset space ~
13643 \begin_inset CommandInset ref
13645 reference "sec:Inserting-TeX-Code"
13655 In this section, we can only list those features which are natively supported
13657 For detailed descriptions (and for the rest of features) we are recommending
13658 to have a look at the detailed manual of the Memoir class
13662 \begin_layout Plain Layout
13667 \begin_layout Plain Layout
13677 \begin_inset Flex URL
13680 \begin_layout Plain Layout
13682 CTAN:/macros/latex/memoir/memman.pdf
13692 , which is not only a user guide for the class, but also both a comprehensive
13693 description on good typesetting and a superb example for good typesetting
13697 \begin_layout Subsection
13698 Basic features and restrictions
13701 \begin_layout Standard
13702 Memoir supports basically all features of the standard book classes.
13703 There are, however, some differences, as follows:
13706 \begin_layout Description
13708 \begin_inset space ~
13711 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
13714 \begin_layout Description
13716 \begin_inset space ~
13719 style: The fancy page style is not supported, due to a command clash between
13720 Memoir and the fancyhdr package (they are both defining a command with
13721 the same name, which confuses LaTeX).
13722 Instead, Memoir comes with a bunch of own page styles (see
13724 Layout\SpecialChar \menuseparator
13725 Document\SpecialChar \menuseparator
13727 \begin_inset space ~
13733 If you want to use these for the chapter pages, you have to use the command
13740 in the main text or in preamble (e.
13741 \begin_inset space \thinspace{}
13745 \begin_inset space \space{}
13752 chapterstyle{companion}
13757 \begin_layout Description
13758 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
13759 an optional argument in the standard classes.
13760 With this, you can specify an alternative version of the title for the
13761 table of contents and the headers (for instance, if the title is too long).
13762 In LyX, you can do this via
13764 Insert\SpecialChar \menuseparator
13766 \begin_inset space ~
13771 at the beginning of a chapter/section.
13772 Memoir features a second optional argument and thus separates the table
13773 of contents from the header.
13774 You can define three variants of a title with this: one for the main text,
13775 one for the table of contents, and one for the headers.
13776 Simply insert two optional arguments if you need this feature, the first
13777 one containing the short title for the Table of Contents, the second one
13778 containing an alternative short title for the headers.
13781 \begin_layout Description
13782 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
13783 of contents, the list of figures and the list of table start a new page
13785 Memoir does not follow this route.
13786 You have to insert a page break yourself, if you want to have one.
13789 \begin_layout Description
13790 Titlepage: For some unknown reason, Memoir uses pagination on the title
13791 page (in the standard classes, title pages are
13792 \begin_inset Quotes eld
13796 \begin_inset Quotes erd
13800 \begin_inset space \thinspace{}
13804 \begin_inset space \space{}
13808 If you want an empty title page, type
13812 aliaspagestyle{title}{empty}
13817 \begin_layout Description
13818 Article: With the class option
13824 Layout\SpecialChar \menuseparator
13825 Document\SpecialChar \menuseparator
13827 \begin_inset space ~
13832 ), you can emulate article style.
13833 That is, counters (footnotes, figures, tables etc.) will not be reset on
13834 new chapters, chapters don't start a new page (but are—in contrary to
13835 \begin_inset Quotes eld
13839 \begin_inset Quotes erd
13842 article classes—still allowed), parts, though, use their own page, as in
13846 \begin_layout Description
13847 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
13848 font commands, which have been used in the old LaTeX version 2.09 (e.
13849 \begin_inset space \thinspace{}
13853 \begin_inset space \space{}
13869 It produces an error and stops LaTeX whenever such a command appears.
13874 reallows the commands and spits out warnings instead (which does at least
13876 Since a lot of packages and particularly BibTeX style files are still using
13877 those commands, we have decided to use this option by default.
13880 \begin_layout Subsection
13884 \begin_layout Standard
13885 We will only describe the features supported by LyX (which is not much currently
13887 Please consult the Memoir manual
13891 \begin_layout Plain Layout
13896 \begin_layout Plain Layout
13906 \begin_inset Flex URL
13909 \begin_layout Plain Layout
13911 CTAN:/macros/latex/memoir/memman.pdf
13924 \begin_layout Description
13925 Abstract: You may wonder why an abstract is an extra feature.
13926 Well, it is in book class.
13927 Usually books don't have abstracts.
13928 Memoir, however, has.
13929 You can use it wherever and how often you like.
13932 \begin_layout Description
13933 Chapterprecis: You may know this from belletristic: The contents of a chapter
13934 is shortly described below the title and also in the table of contents
13936 \begin_inset space \thinspace{}
13940 \begin_inset space \space{}
13945 Our hero arrives in Troia; he loses some friends; he finds others
13948 Chapterprecis does exactly this.
13949 It is therefore only sensible below a chapter.
13952 \begin_layout Description
13953 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
13954 The epigraph environment provides an elegant way of typesetting such a
13956 The motto itself (text) and its author (source) are divided by a short
13958 Unfortunately, we have to fool LyX a bit here again, since the environment
13959 needs two arguments (text and source).
13960 In this case, we have to use curly brackets (in TeX mode) between the two
13971 <author of the slogan>.
13974 \begin_layout Description
13975 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
13976 complex figurative poems).
13977 LyX can only support a few of them.
13978 One is poemtitle, which is a centered title for poems, which will also
13979 be added to the table of contents (verse is the standard environment for
13981 Memoir has some enhanced versions of verse, but you need to use TeX code,
13982 because they have to be nested inside regular verse environments, which
13983 is not possible with LyX).
13986 \begin_layout Description
13987 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
13990 \begin_layout Section
13991 Article (mwart), book (mwbk) and report (mwrep)
13992 \begin_inset OptArg
13995 \begin_layout Plain Layout
14008 \begin_layout Standard
14014 \begin_layout Standard
14015 The LyX document classes
14031 correspond to the LaTeX document classes
14044 They are replacements for the standard document classes
14056 , resp., and fit better to Polish typography conventions in a number of points.
14060 \begin_layout Standard
14064 \begin_layout Itemize
14065 Unnumbered titles (with star, e.
14066 \begin_inset space \thinspace{}
14070 \begin_inset space \space{}
14077 ) are added into table of contents,
14080 \begin_layout Itemize
14081 Additional page styles:
14085 \begin_layout Description
14086 uheadings header with separated lines,
14089 \begin_layout Description
14090 myheadings custom header, contents headers via commands:
14105 \begin_layout Description
14106 myuheadings custom header with separated lines,
14109 \begin_layout Description
14110 outer page number is placed on outer side of page
14114 \begin_layout Itemize
14119 \begin_layout Description
14120 rmheadings serif titles — default,
14123 \begin_layout Description
14124 sfheadings sansserif titles,
14127 \begin_layout Description
14128 authortitle on title page first placed is author next title — default,
14131 \begin_layout Description
14132 titleauthor on title page first placed is title next author,
14135 \begin_layout Description
14136 withmarginpar reserve place on page for margins.
14140 \begin_layout Section
14144 \begin_layout Standard
14149 provides an alternative to the standard
14154 It provides similar functionality, but you might prefer this layout with
14155 sans serif sections, headings, and more.
14158 \begin_layout Section
14162 \begin_layout Standard
14168 \begin_layout Standard
14169 \begin_inset VSpace bigskip
14175 \begin_layout Standard
14180 \begin_inset space ~
14185 textclass works with the American Physical Sociey's RevTeX 4.0 (the
14186 \begin_inset Formula $\beta$
14189 release of May, 1999) class.
14192 \begin_layout Standard
14197 textclass, which works with RevTeX 3.1.
14198 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
14199 That means that it doesn't interact very well with LyX, which requires
14200 LaTeX2e, although it has been kludged to work.
14201 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
14205 \begin_inset space ~
14210 textclass should also be pretty easy to use.
14213 \begin_layout Standard
14214 These documents are supposed to be used in
14218 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14219 macros, and assume you'll know what to put in the preamble if necessary.
14222 \begin_layout Subsection
14226 \begin_layout Standard
14227 All you need to do is install RevTeX 4, as described in the package's README
14229 The package can be found at The RevTeX 4 Web Site
14230 \begin_inset Flex URL
14233 \begin_layout Plain Layout
14235 http://publish.aps.org/revtex4/
14241 Install it somewhere that LaTeX can see it.
14242 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14244 \begin_inset space \thinspace{}
14248 \begin_inset space \space{}
14251 not the directory where you installed the class file.) Then, if you reconfigure
14252 LyX, it will find the class file and let you use the RevTeX4 textclass.
14255 \begin_layout Standard
14256 Probably the easiest way to get started is either to import a RevTeX 4 document
14264 \begin_inset space ~
14269 template, found in the templates directory.
14272 \begin_layout Subsection
14276 \begin_layout Standard
14277 Optional arguments to
14284 \begin_inset Quotes eld
14288 \begin_inset Quotes erd
14292 \begin_inset Quotes eld
14296 \begin_inset Quotes erd
14306 \begin_inset space ~
14314 \begin_inset space ~
14320 Remember that in RevTeX, at least one optional argument is required!
14323 \begin_layout Standard
14324 Other preamble matter, like
14331 \begin_inset space ~
14337 \begin_inset space ~
14342 dialog, also as usual.
14345 \begin_layout Subsection
14349 \begin_layout Standard
14350 The layouts basically correspond to the commands in RevTeX4.0.
14351 For example, the Email layout corresponds to
14358 Note that (at least as of RevTeX 4.0 Beta), the
14366 layouts are exactly equivalent, so you shouldn't need to use both.
14370 \begin_layout Plain Layout
14371 In case you're curious, both were included so that
14375 would be able to translate both
14395 \begin_layout Subsection
14399 \begin_layout Standard
14400 There are a couple of important unique aspects of RevTeX 4 which might cause
14401 bugs that will be even more confusing in LyX.
14404 \begin_layout Standard
14422 The LyX equivalent is that there is a separate Thanks layout.
14427 write footnotes in the
14431 layout, or weird things may happen.
14432 See the RevTeX 4 documentation for more details.
14435 \begin_layout Standard
14439 \begin_inset space ~
14447 \begin_inset space ~
14456 layouts must be placed
14464 layout and the corresponding
14481 , the LaTeX won't compile.
14484 \begin_layout Subsection
14488 \begin_layout Standard
14489 The main problem with this layout is that you can't use the optional arguments
14490 to layouts like Email and Title.
14491 (The problem is not unique to this layout; you can't use optional arguments
14492 to the Section layouts either.) This means that after you export that file
14493 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14494 need to edit the LaTeX file with a text editor to add the optional arguments
14496 \begin_inset space \thinspace{}
14500 \begin_inset space \space{}
14503 the running title for the page headers.
14504 Lacking these layouts makes the
14510 (and the equivalent
14516 ) useless, so the corresponding layouts don't exist, and will have to be
14521 \begin_layout Plain Layout
14526 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14527 has not been updated yet to take advantage of it.
14535 \begin_layout Section
14536 Springer Journals (
14543 \begin_layout Standard
14549 \begin_layout Subsection
14553 \begin_layout Standard
14554 These are the layout files for some of the journal formats used by Springer
14555 Verlag and listed on
14556 \begin_inset Flex URL
14559 \begin_layout Plain Layout
14561 http://www.springer.de/author/tex/help-journals.html
14566 , where you should also go to fetch the class files (yes, these are LaTeX2e
14568 It is a modular system: the things common to all journals are implemented
14573 , which journal-specific layout files (such as, e.
14574 \begin_inset space \thinspace{}
14578 \begin_inset space \space{}
14585 for Journal of Geodesy) can include.
14588 \begin_layout Standard
14589 This means that implementing support for any other Springer journal on this
14590 list is as simple as writing your own
14598 file following the outline given in
14606 \begin_layout Standard
14607 It is reasonably well tested only for the Journal of Geodesy.
14616 come with the standard LyX distribution.
14617 Install the relevant class file (downloaded from Springer) in a proper
14618 directory, reconfigure LaTeX (in the teTeX case by running
14622 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
14623 and it should work.
14626 \begin_layout Subsection
14630 \begin_layout Standard
14631 A large number of theorem-like styles —
14637 \SpecialChar \ldots{}
14643 \begin_layout Standard
14646 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
14647 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
14650 See the Springer class file documentation for details.
14653 \begin_layout Subsection
14657 \begin_layout Itemize
14669 \begin_layout Itemize
14672 Probability Theory and Related Fields
14678 — Jean-Marc Lasgouttes
14681 \begin_layout Standard
14682 Add your own, it isn't so hard!
14685 \begin_layout Subsection
14689 \begin_layout Standard
14690 These files are partly based on the older
14694 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
14695 file from Springer.
14700 layout, are now defunct.
14701 Jean-Marc Lasgouttes helped out big in making me find my way around the
14702 LyX layout file mechanism.
14705 \begin_layout Subsection
14709 \begin_layout Standard
14711 But probably less than in the old hacked-LaTeX
14718 \begin_layout Standard
14720 \begin_inset space \thinspace{}
14723 g.: does not display the number for theorem-like layouts, just #.
14726 \begin_layout Section
14732 \begin_inset CommandInset label
14741 \begin_layout Standard
14749 \begin_layout Subsection
14753 \begin_layout Standard
14754 This section describes how to use LyX to make slides for overhead projectors.
14755 There are two document classes that can do this: the default slides class
14761 This section documents the former.
14764 \begin_layout Standard
14765 I'm going to say this again, nice and clear, so that there's no misunderstanding
14769 \begin_layout Standard
14770 \begin_inset VSpace bigskip
14776 \begin_layout Standard
14780 This section documents the class
14781 \begin_inset Quotes eld
14789 \begin_inset Quotes erd
14797 \begin_layout Standard
14798 \begin_inset VSpace bigskip
14804 \begin_layout Standard
14805 If you're looking for the documentation for
14806 \begin_inset Quotes eld
14814 \begin_inset Quotes erd
14817 , check out section
14818 \begin_inset space ~
14822 \begin_inset CommandInset ref
14824 reference "sec:foiltex"
14834 \begin_inset Quotes eld
14842 \begin_inset Quotes erd
14845 ] is actually somewhat better than the default
14853 \begin_layout Plain Layout
14854 \SpecialChar \ldots{}
14855 or so I've been told repeatedly by its advocates.
14856 Having never used it, I have no idea if this claim is true or not.
14861 which this section documents.
14864 \begin_layout Standard
14865 This class is the LaTeX2e improvement of the old
14870 Every LaTeX2e distribution includes this class [which I'll just refer to
14872 \begin_inset Quotes eld
14880 \begin_inset Quotes erd
14883 from now on], so you're bound to have it.
14884 As I noted earlier, there are other classes, such as
14888 , which also produce slides for overhead projectors and do a better job
14890 However, there are some things which
14894 can do which the others can't, such as generate overlays.
14895 Read on to learn more!
14898 \begin_layout Subsection
14900 \begin_inset CommandInset label
14902 name "sec:slidesetup"
14909 \begin_layout Standard
14910 Obviously, to use this document class, you need to select
14911 \begin_inset Quotes eld
14919 \begin_inset Quotes erd
14922 from the class list in the
14924 Document\SpecialChar \menuseparator
14928 There are some other special things you should know about this class:
14931 \begin_layout Itemize
14932 Don't bother changing the options
14937 They're not supported by the
14944 \begin_layout Itemize
14948 \begin_inset space ~
14953 behaves a bit differently for this class.
14954 The possible choices and what they do are as follows:
14958 \begin_layout Description
14963 The final output contains page numbers in the lower right corner.
14966 \begin_layout Description
14975 , but also prints out any time markers you've put in.
14976 This is the default.
14979 \begin_layout Description
14984 The final output contains no page numbers, time markers, or alignment markers.
14988 \begin_layout Itemize
14993 class has an extra option:
14999 \begin_inset Quotes eld
15007 \begin_inset Quotes erd
15010 in the extra class options.
15014 \begin_layout Standard
15015 Using this options allows you to add time markers to
15021 \begin_inset space ~
15025 \begin_inset CommandInset ref
15027 reference "sec:slideNote"
15035 \begin_layout Standard
15036 You can also use the template file
15037 \begin_inset Quotes eld
15045 \begin_inset Quotes erd
15048 to automatically set up a document to use the
15054 File\SpecialChar \menuseparator
15056 \begin_inset space ~
15060 \begin_inset space ~
15065 to open your new document].
15066 The template file also contains some examples of the special paragraph
15067 environments used by this class.
15068 I'll describe those next.
15071 \begin_layout Subsection
15072 Paragraph Environments
15075 \begin_layout Subsubsection
15076 Supported Environments
15079 \begin_layout Standard
15080 The first thing you'll notice when you start up a new
15084 document is the font size and type: it's the equivalent of the size
15085 \begin_inset Quotes eld
15093 \begin_inset Quotes erd
15099 \begin_inset space ~
15105 This is also what's used in the output.
15107 \begin_inset Quotes eld
15111 \begin_inset Quotes erd
15114 to remind you that this is a slide.
15115 Your final slides will use a larger font; ergo, you'll have less space.
15116 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
15119 \begin_layout Standard
15120 The next thing that becomes obvious is the changes to the paragraph environment
15121 pull-down box [at the far-left end of the toolbar].
15122 Most of the paragraph environments you're used to seeing are missing.
15123 There are also five new ones.
15128 class itself only supports certain paragraph environments:
15131 \begin_layout Itemize
15137 \begin_layout Itemize
15143 \begin_layout Itemize
15149 \begin_layout Itemize
15155 \begin_layout Itemize
15161 \begin_layout Itemize
15167 \begin_layout Itemize
15173 \begin_layout Itemize
15179 \begin_layout Itemize
15185 \begin_layout Itemize
15191 \begin_layout Itemize
15197 \begin_layout Standard
15198 All of the other standard environments, including the section-heading environmen
15199 ts, aren't used in the
15206 \begin_layout Standard
15207 On the other hand, you'll notice the following new environments:
15210 \begin_layout Itemize
15216 \begin_layout Itemize
15222 \begin_layout Itemize
15228 \begin_layout Itemize
15234 \begin_layout Itemize
15240 \begin_layout Standard
15241 These five are kind of quirky, due to a
15242 \begin_inset Quotes eld
15246 \begin_inset Quotes erd
15250 You see, LyX doesn't permit you to nest any other paragraph environment
15251 into an empty environment.
15252 Now, that's fine and dandy, but it means that you wouldn't be able to start
15253 a slide with anything except plain text.
15254 To deal with this, I've performed a little
15255 \begin_inset Quotes eld
15259 \begin_inset Quotes erd
15265 \begin_layout Subsubsection
15266 Quirks of the New Environments
15267 \begin_inset CommandInset label
15269 name "sec:slideQuirk"
15276 \begin_layout Standard
15277 All five of the new paragraph environments are somewhat quirky due to inherent
15278 limitiations in the current version of LyX.
15279 As I just mentioned, LyX forbids environments that begin with another environme
15281 To get around this, the
15285 environment isn't a paragraph environment as described in the
15293 \begin_layout Standard
15294 You should consider
15307 \begin_inset Quotes eld
15310 pseudo-environments.
15311 \begin_inset Quotes erd
15314 They look like a section heading or a
15315 \begin_inset Quotes eld
15323 \begin_inset Quotes erd
15326 but really begin a [and, if necessary, end the previous] paragraph environment.
15336 \begin_inset Quotes eld
15340 \begin_inset Quotes erd
15343 These two perform some action.
15346 \begin_layout Standard
15347 A common feature of all five environments,
15367 , is a rather long-ish label.
15368 The text following this label — ordinarily the contents of the paragraph
15369 environment — is utterly irrelevant for
15390 LyX completely ignores it.
15391 In fact, you can leave these five environments completely empty.
15395 \begin_layout Standard
15400 to put any text after the rather long-ish label, you might want to.
15401 This could be a short description of the contents of the
15406 In that case, enter in your descriptive comment and hit
15410 as you normally would.
15413 \begin_layout Standard
15414 If, on the other hand, you don't want to enter in any descriptive text,
15415 you'll hit another LyX quirk.
15416 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
15417 environment until you put something in the old one.
15421 \begin_layout Itemize
15422 Start entering the text that will
15450 \begin_layout Itemize
15451 Now move to the beginning of that paragraph.
15455 \begin_layout Itemize
15464 \begin_layout Itemize
15465 Finally, change this new, empty paragraph to a
15489 \begin_layout Standard
15490 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
15494 \begin_layout Subsection
15495 Making a Presentation with
15508 \begin_layout Subsubsection
15516 \begin_layout Standard
15517 If you're expecting this section to teach you how to actually make a presentatio
15518 n, you'll be sorely disappointed.
15519 Naturally, I'll describe all of the ways the
15523 class can assist you in preparing the materials for a presentation.
15524 Filling in the contents, however, is up to you.
15529 the LyX philosophy.]
15532 \begin_layout Standard
15537 environment [in the manner described in section
15538 \begin_inset space ~
15542 \begin_inset CommandInset ref
15544 reference "sec:slideQuirk"
15548 ] tells LyX to begin a new slide [duh].
15549 The label for this environment/
15550 \begin_inset Quotes erd
15554 \begin_inset Quotes erd
15558 \begin_inset Quotes eld
15562 \begin_inset Quotes erd
15565 in cool blue, followed by the label,
15566 \begin_inset Quotes eld
15570 \begin_inset Quotes erd
15574 Any text or paragraph environments that follow this one go on the new slide.
15578 \begin_layout Standard
15579 Slides are probably the only time you'll need to forcibly end pages in LyX
15580 (this can be specified in the
15585 In fact, you'll want to, once you finish entering the contents of one slide.
15586 If you've entered more text than can physically fit on a slide, the extra
15587 overflows onto a new slide.
15588 I don't recommend doing this, however, since the overflow slide won't have
15589 any page number on it.
15590 Furthermore, it may interfere with any
15594 you've made to accompany the oversized
15601 \begin_layout Standard
15610 environments work the same way as the
15615 They both create an
15616 \begin_inset Quotes eld
15620 \begin_inset Quotes erd
15623 followed by a label [
15624 \begin_inset Quotes eld
15628 \begin_inset Quotes erd
15632 \begin_inset Quotes eld
15636 \begin_inset Quotes erd
15640 The color is a stunning magenta instead of blue, and the
15641 \begin_inset Quotes eld
15645 \begin_inset Quotes erd
15648 will look different, in style and in length.
15649 The label fonts of all three also differ from one another.
15652 \begin_layout Standard
15657 , if the contents of a
15665 exceed the physical size of a slide or sheet of paper, the extra will overflow
15667 Again, you should avoid this.
15668 It defeats the whole purpose of
15679 \begin_layout Subsubsection
15689 \begin_layout Standard
15694 is a slide that sits atop another slide.
15695 Perhaps you wish to discuss a figure on the main
15699 before displaying the text associated with it.
15700 One way to accomplish this is tape a flap of dark paper over the part of
15705 you want to display later.
15706 This method fails, however, if you wish to overlap one graph with another,
15708 You would then have to fumble while speaking to align the two separate,
15713 s to align the two graphs.
15718 environment in both cases makes life much easier.
15721 \begin_layout Standard
15726 receives the page number of its
15727 \begin_inset Quotes eld
15731 \begin_inset Quotes erd
15739 \begin_inset Quotes eld
15747 \begin_inset Quotes erd
15754 \begin_layout Plain Layout
15755 Presumably, mutliple
15760 \begin_inset Quotes eld
15768 \begin_inset Quotes erd
15772 \begin_inset Quotes eld
15780 \begin_inset Quotes erd
15784 \begin_inset Quotes eld
15792 \begin_inset Quotes erd
15796 \begin_inset space ~
15799 appended to the page number of the parent
15809 Clearly, you want the contents of both the
15817 to each fit on a single physical slide! You should probably consider an
15823 \begin_inset Quotes eld
15827 \begin_inset Quotes erd
15839 class provides a visual cue for this: the label at the start of an
15843 is shorter than that at the start of a
15848 Lastly, when you generate printable output, you'll find alignment markers
15849 in all four corners of both the
15853 page and its parent
15858 These will assist you in lining up the two physical slides.
15861 \begin_layout Standard
15862 The major problem in overlaying two slides is aligning the contents of the
15863 two transparencies.
15864 How much space should you leave for that graph on the second slide? Worse
15865 still, what if you want a graph and a sentence on second slide, but there
15866 is text on the main transparency that goes in between them? You could try
15867 and insert vertical space of the right size.
15868 The better way is to use
15879 \begin_layout Standard
15880 As their names imply,
15888 are two command-like paragraph environments that make all subsequent text
15889 invisible and visible, respectively.
15891 \begin_inset space ~
15895 \begin_inset CommandInset ref
15897 reference "sec:slideQuirk"
15901 that you don't place anything
15905 these two environments, however.
15910 , it inserts a centered, sky-blue label into the page reading
15911 \begin_inset Quotes eld
15914 <Invisible Text Follows>
15915 \begin_inset Quotes erd
15919 For paragraphs following this label, the parts of the
15927 ; it doesn't matter which] where they would be contain instead blank space.
15931 \begin_layout Standard
15936 , the corresponding centered label is
15937 \begin_inset Quotes eld
15940 <Visible Text Follows>
15941 \begin_inset Quotes erd
15945 Paragraphs following this label behave normally.
15946 Note that the beginning of a new
15958 automatically shuts off an
15963 It's therefore not necessary to use
15974 \begin_layout Standard
15975 By now, it should be obvious how to create overlay transparencies using
15976 the proper combination of
15995 \begin_layout Enumerate
16000 , including everything that will appear on it, whether on the main slide
16008 \begin_layout Enumerate
16009 Before each figure or paragraph that will appear only on the
16018 If necessary, insert a
16022 environment after the
16029 \begin_layout Enumerate
16034 immediately following the
16041 \begin_layout Enumerate
16042 Copy the contents of this
16053 \begin_layout Enumerate
16058 , change all of the
16069 \begin_layout Standard
16071 You've just made an
16078 \begin_layout Standard
16079 There's one problem with the way I've designed the LyX
16083 class: you can't make text in the middle of a paragraph invisible, nor
16084 make text in the middle of an invisible paragraph visible again.
16085 To accomplish this feat, you'll need to use some inlined LaTeX codes.
16089 \begin_layout Plain Layout
16090 The commands of interest are:
16093 \begin_layout Itemize
16098 invisible \SpecialChar \ldots{}
16102 \begin_layout Itemize
16107 visible \SpecialChar \ldots{}
16111 \begin_layout Plain Layout
16112 \SpecialChar \ldots{}
16113 and need to be marked as TeX.
16115 \begin_inset Quotes eld
16119 \begin_inset Quotes erd
16122 you wish to change goes in between the brackets [and after the
16135 If you don't know how to mark text as TeX, see the appropriate section
16148 \begin_layout Subsubsection
16158 \begin_inset CommandInset label
16160 name "sec:slideNote"
16167 \begin_layout Standard
16176 is associated with a
16177 \begin_inset Quotes eld
16181 \begin_inset Quotes erd
16193 class provides visual cues.
16198 is shorter than that of a
16202 [yet longer than that of an
16206 ] and, like the label of an
16210 is shockingly magenta.
16211 Additionally, the printed
16215 has the page number of its
16216 \begin_inset Quotes eld
16220 \begin_inset Quotes erd
16228 \begin_inset Quotes eld
16236 \begin_inset Quotes erd
16240 \begin_inset Quotes eld
16248 \begin_inset Quotes erd
16252 \begin_inset Quotes eld
16260 \begin_inset Quotes erd
16264 You can have multiple
16268 s associated with a single
16280 , you'll probably want to break up long
16284 s so that they fit on a single sheet of paper.
16287 \begin_layout Standard
16292 is obvious: it contains anything additional you might want to say about
16298 It could also be used as a sheet of reminders for a particular
16303 In the case of the latter, you might want to make use of time markers.
16309 \begin_inset Quotes eld
16313 \begin_inset Quotes erd
16316 support for time markers, a
16321 So, you'll have to resort to using the LaTeX codes.
16324 \begin_layout Standard
16325 To use time markers, you'll need to specify the extra class option
16326 \begin_inset Quotes eld
16334 \begin_inset Quotes erd
16338 \begin_inset space ~
16342 \begin_inset CommandInset ref
16344 reference "sec:slidesetup"
16349 This option turns on timing marks, which will appear in the lower-left-hand
16355 To set what appears in the time marker, you use the LaTeX commands
16356 \begin_inset Quotes eld
16366 \begin_inset Quotes erd
16370 \begin_inset Quotes eld
16380 \begin_inset Quotes erd
16384 The arguments of both commands are time measured in seconds.
16386 \begin_inset Quotes eld
16396 \begin_inset Quotes erd
16399 sets the time marker to a given time.
16401 \begin_inset Quotes eld
16411 \begin_inset Quotes erd
16414 increments the time marker by the specified amount.
16415 Using time markers and
16419 s in this fashion, you can remind yourself how much time to spend on a particula
16427 \begin_layout Standard
16428 There's one last feature to describe.
16429 Clearly, you'd like to print out all of your
16437 s on transparencies while printing all of your
16454 with which it is associated.
16455 What's a person to do?
16458 \begin_layout Standard
16459 Luckily, there are two LaTeX commands that allow you to select what to print
16461 Both must be placed into the preamble of your document.
16463 \begin_inset Quotes eld
16475 \begin_inset Quotes erd
16478 will cause the output to contain only the
16487 Correspondingly, the command
16488 \begin_inset Quotes eld
16500 \begin_inset Quotes erd
16503 prevents the output of anything but
16508 I'd advise placing both commands in the preamble and initially comment
16510 You can then preview your entire presentation as you write.
16511 When you're done writing, you can then uncomment one of the two to select
16512 what you want to print.
16513 I like to uncomment
16514 \begin_inset Quotes eld
16526 \begin_inset Quotes erd
16529 , print to a file with
16530 \begin_inset Quotes eld
16538 \begin_inset Quotes erd
16541 in its name, comment it back out, then uncomment
16542 \begin_inset Quotes eld
16554 \begin_inset Quotes erd
16558 \begin_inset Quotes eld
16566 \begin_inset Quotes erd
16570 I can then send either file to a printer, loading transparencies or plain
16571 paper as appropriate.
16574 \begin_layout Standard
16575 You can also provide other arguments to the
16576 \begin_inset Quotes eld
16586 \begin_inset Quotes erd
16590 \begin_inset Quotes eld
16600 \begin_inset Quotes erd
16604 See a good LaTeX book for details.
16607 \begin_layout Subsection
16612 Class Template File
16615 \begin_layout Standard
16616 I have also provided a template file,
16617 \begin_inset Quotes eld
16625 \begin_inset Quotes erd
16633 To use it, begin your new presentation with
16638 ile\SpecialChar \menuseparator
16640 \begin_inset space ~
16644 \begin_inset space ~
16654 Your new LyX presentation file will contain an example
16675 additionally contain an example of the use of
16684 Lastly, the preamble will contain:
16687 \begin_layout LyX-Code
16688 % Uncomment to print out only slides and overlays
16691 \begin_layout LyX-Code
16695 \begin_layout LyX-Code
16701 \begin_inset Newline newline
16707 \begin_layout LyX-Code
16708 % Uncomment to print out only notes
16711 \begin_layout LyX-Code
16715 \begin_layout LyX-Code
16723 \begin_layout Standard
16724 One final thing: I created this class to support the LaTeX2e
16725 \begin_inset Quotes eld
16733 \begin_inset Quotes erd
16736 class, one of the built-in LaTeX2e classes.
16737 Neither I nor the rest of the LyX Team endorse or oppose the use of this
16738 built-in slide class.
16739 It's here if you want it or need it.
16740 There exist other LaTeX2e classes for creating presentations, such as the
16746 \begin_inset space ~
16750 \begin_inset CommandInset ref
16752 reference "sec:foiltex"
16757 \begin_inset Quotes eld
16765 \begin_inset Quotes erd
16768 package [present on some TeX distributions].
16769 The latter is not yet supported under LyX.
16773 \begin_layout Plain Layout
16774 Perhaps you can take on the task\SpecialChar \ldots{}
16780 I know nothing about these other classes.
16781 Try them out to see what sort of alternative they provide.
16784 \begin_layout Chapter
16785 LyX Features needing Extra Software
16788 \begin_layout Section
16792 \begin_layout Standard
16798 \begin_layout Subsection
16802 \begin_layout Standard
16811 \begin_layout Plain Layout
16816 is not yet available when you are using the LaTeX distribution MiKTeX.
16821 , you'll find in the
16828 \begin_inset space ~
16839 \begin_inset CommandInset href
16841 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
16848 \begin_layout Standard
16853 package is a program that was written by
16854 \begin_inset Flex CharStyle:Noun
16857 \begin_layout Plain Layout
16859 \begin_inset space ~
16867 in frustration because some constructs in LaTeX are sometimes non-intuitive,
16868 and easy to forget.
16869 The program runs over your LaTeX file, checks the integrity of the file,
16870 and flags some common errors.
16871 In other technical words, it is
16878 \begin_layout Standard
16879 Well, what is a syntax checker doing in LyX which is supposed to produce
16880 correct LaTeX anyways? The answer is simple: Just as
16884 not only checks the
16888 of C programs, but also does
16892 checks for type-errors,
16896 catches some common
16900 errors, in addition to the syntactical ones.
16905 is capable of detecting several common errors, such as
16908 \begin_layout Itemize
16909 Ellipsis detection:
16910 \begin_inset Newline newline
16913 Use \SpecialChar \ldots{}
16917 \begin_layout Itemize
16918 No space in front of/after parenthesis:
16919 \begin_inset Newline newline
16925 \begin_layout Itemize
16926 Enforcement of normal space after common abbreviations:
16927 \begin_inset Newline newline
16931 \begin_inset space \thinspace{}
16935 \begin_inset space \space{}
16938 is too wide spacing.
16941 \begin_layout Itemize
16942 Enforcement of end-of-sentence space when the last sentence ends with a
16944 \begin_inset Newline newline
16948 And this is wrong spacing.
16951 \begin_layout Itemize
16952 Space in front of labels and similar commands:
16953 \begin_inset Newline newline
16956 The label should stick right up to the text to avoid falling to a wrong
16959 \begin_inset CommandInset label
16969 \begin_layout Plain Layout
16970 This footnote is in danger of falling off to a wrong page
16975 The label is separated too much.
16978 \begin_layout Itemize
16979 Space in front of references, instead of hard spaces:
16980 \begin_inset Newline newline
16983 In you are in bad luck, the text will break right between the referenced
16984 text and reference number, and that's a pity.
16986 \begin_inset CommandInset ref
16988 reference "sec:chktex"
16995 \begin_layout Itemize
16997 \begin_inset Quotes eld
17001 \begin_inset Quotes erd
17005 \begin_inset Formula $\times$
17009 \begin_inset Newline newline
17012 2x2 looks cheap compared to
17013 \begin_inset Formula $2\times2$
17019 \begin_layout Standard
17020 and more \SpecialChar \ldots{}
17021 It is an invaluable tool when you are
17022 \begin_inset Quotes eld
17026 \begin_inset Quotes erd
17029 your document before printing, and you should run it right after the obligatory
17030 spelling check, and before you go fine tuning the typesetting.
17033 \begin_layout Subsection
17037 \begin_layout Standard
17038 If you have the program installed, usage is as simple as choosing
17040 Tools\SpecialChar \menuseparator
17042 \begin_inset space ~
17048 This will make LyX generate a LaTeX file of your document, start
17052 to check it, and then make LyX insert
17053 \begin_inset Quotes eld
17057 \begin_inset Quotes erd
17060 with the warnings from
17064 , if there were any.
17065 The warnings will be placed close to the point of the mistake, and you
17066 can quickly find them by using the
17068 Navigate\SpecialChar \menuseparator
17071 menu item, or the shortcut key
17080 Open the error boxes by clicking on them with the mouse, or use the shortcut
17089 bindings, or the corresponding
17098 Read the warning and correct the mistake, if it is a mistake.
17099 If you have trouble understanding what the warning is about, you can safely
17101 Remember that there is a hidden layer between the document on screen and
17102 the technical details in invoking
17106 , and this gap can make some warnings seem arcane or just right down plain
17110 \begin_layout Standard
17111 This document is an excellent testing bed for the feature, and it should
17112 provide quite a few warnings for you to fiddle with.
17113 Since computers are only so smart, expect most of the warnings to be false
17117 \begin_layout Subsection
17118 How to fine tune it
17121 \begin_layout Standard
17122 Sometimes, you'll find that
17126 makes more noise than suits your mood.
17127 Then you can choose not to use it, wait until your mood changes, or try
17132 to get better along with you.
17133 Another choice in the most desperate situations is to use
17135 View\SpecialChar \menuseparator
17137 \begin_inset space ~
17141 \begin_inset space ~
17145 \begin_inset space ~
17150 , which will get rid of all warnings instantly.
17153 \begin_layout Standard
17162 very configurable and extensible, you shouldn't expect to solve all problems
17168 Since LyX has to generate a somewhat special LaTeX file to be able to match
17169 the line numbers from the
17177 \begin_layout Plain Layout
17178 You can inspect the specific output from
17184 Edit\SpecialChar \menuseparator
17186 \begin_inset space ~
17190 \begin_inset space ~
17204 to the internal document structure, some of the warnings will not seen
17205 to appear correctly.
17206 There are two things you can do about this:
17209 \begin_layout Itemize
17214 invocation command line in
17230 installation configuration file (usually with the file
17235 See below to learn what warnings can be enabled and disabled on the command
17240 \begin_layout Itemize
17241 Export your document as a raw LaTeX file using
17243 File\SpecialChar \menuseparator
17244 Export\SpecialChar \menuseparator
17252 Invoked in this way, it can be a hassle to find the corresponding place
17253 in the document inside LyX, but with a little patience, you should be able
17257 \begin_layout Standard
17258 Here follows the warning messages that can be enabled and disabled in
17267 to disable a warning, and
17271 to enable a warning.
17272 The emphasized entries are disabled by default, because the default is
17275 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
17280 \begin_layout Standard
17281 Notice that you should only use the options that enable and disable warnings,
17282 because LyX relies on some of the other command line parameters to be set
17283 in a specific way to have a chance to communicate with
17290 \begin_layout Enumerate
17294 Command terminated with space.
17297 \begin_layout Enumerate
17300 Non-breaking space (
17301 \begin_inset Quotes eld
17309 \begin_inset Quotes erd
17312 ) should have been used.
17315 \begin_layout Enumerate
17319 You should enclose the previous parenthesis with
17320 \begin_inset Quotes eld
17328 \begin_inset Quotes erd
17334 \begin_layout Enumerate
17337 Italic correction (
17338 \begin_inset Quotes eld
17348 \begin_inset Quotes erd
17351 ) found in non-italic buffer.
17354 \begin_layout Enumerate
17357 Italic correction (
17358 \begin_inset Quotes eld
17368 \begin_inset Quotes erd
17371 ) found more than once.
17374 \begin_layout Enumerate
17378 No italic correction (
17379 \begin_inset Quotes eld
17389 \begin_inset Quotes erd
17395 \begin_layout Enumerate
17399 \begin_inset Quotes eld
17407 \begin_inset Quotes erd
17411 \begin_inset Quotes eld
17419 \begin_inset Quotes erd
17425 \begin_layout Enumerate
17428 Wrong length of dash may have been used.
17431 \begin_layout Enumerate
17435 \begin_inset Quotes eld
17443 \begin_inset Quotes erd
17447 \begin_inset Quotes eld
17455 \begin_inset Quotes erd
17461 \begin_layout Enumerate
17465 \begin_inset Quotes eld
17473 \begin_inset Quotes erd
17479 \begin_layout Enumerate
17483 \begin_inset Quotes eld
17491 \begin_inset Quotes erd
17494 to achieve an ellipsis.
17497 \begin_layout Enumerate
17500 Inter-word spacing (
17501 \begin_inset Quotes eld
17511 \begin_inset Quotes eld
17514 ) should perhaps be used.
17517 \begin_layout Enumerate
17520 Inter-sentence spacing (
17521 \begin_inset Quotes eld
17531 \begin_inset Quotes erd
17534 ) should perhaps be used.
17537 \begin_layout Enumerate
17540 Could not find argument for command.
17543 \begin_layout Enumerate
17547 \begin_inset Quotes eld
17555 \begin_inset Quotes erd
17561 \begin_layout Enumerate
17564 Math mode still on at end of LaTeX file.
17567 \begin_layout Enumerate
17571 \begin_inset Quotes eld
17579 \begin_inset Quotes erd
17582 doesn't match the number of
17583 \begin_inset Quotes eld
17591 \begin_inset Quotes erd
17597 \begin_layout Enumerate
17600 You should use either
17603 \begin_inset Quotes eld
17611 \begin_inset Quotes erd
17616 as an alternative to
17617 \begin_inset Quotes eld
17625 \begin_inset Quotes erd
17631 \begin_layout Enumerate
17638 " (ASCII 39) instead of "
17645 \begin_layout Enumerate
17648 User-specified pattern found.
17651 \begin_layout Enumerate
17654 This command might not be intended.
17657 \begin_layout Enumerate
17664 \begin_layout Enumerate
17682 \begin_layout Enumerate
17685 Delete this space to maintain correct page references.
17688 \begin_layout Enumerate
17692 You might wish to put this between a pair of
17693 \begin_inset Quotes eld
17701 \begin_inset Quotes erd
17707 \begin_layout Enumerate
17710 You ought to remove spaces in front of punctuation.
17713 \begin_layout Enumerate
17716 Could not execute LaTeX command.
17719 \begin_layout Enumerate
17728 in front of small punctuation.
17731 \begin_layout Enumerate
17739 may look prettier here.
17742 \begin_layout Enumerate
17746 Multiple spaces detected in output.
17749 \begin_layout Enumerate
17752 This text may be ignored.
17755 \begin_layout Enumerate
17761 \begin_inset Quotes eld
17766 to begin quotation, not
17773 \begin_layout Enumerate
17780 to end quotation, not
17783 \begin_inset Quotes eld
17791 \begin_layout Enumerate
17797 \begin_layout Enumerate
17800 You should perhaps use
17801 \begin_inset Quotes eld
17809 \begin_inset Quotes erd
17815 \begin_layout Enumerate
17818 You should put a space in front of/after parenthesis.
17821 \begin_layout Enumerate
17824 You should avoid spaces in front of/after parenthesis.
17827 \begin_layout Enumerate
17831 You should not use punctuation in front of/after quotes.
17834 \begin_layout Enumerate
17837 Double space found.
17840 \begin_layout Enumerate
17843 You should put punctuation outside inner/inside display math mode.
17846 \begin_layout Enumerate
17849 You ought to not use primitive TeX in LaTeX code.
17852 \begin_layout Enumerate
17855 You should remove spaces in front of
17856 \begin_inset Quotes eld
17864 \begin_inset Quotes erd
17870 \begin_layout Enumerate
17873 \begin_inset Quotes eld
17881 \begin_inset Quotes erd
17884 is normally not followed by
17885 \begin_inset Quotes eld
17893 \begin_inset Quotes erd
17899 \begin_layout Standard
17900 In later versions of LyX, we hope to provide a more complete interface to
17901 this tool (and it's smaller cousin
17905 ) to exploit the full power of it.
17906 But it's not exactly useless as it is now: go try it on one of your existing
17907 documents of a certain length and be surprised.
17910 \begin_layout Section
17911 Version Control in LyX
17914 \begin_layout Standard
17917 Lars Gullik Bjønnes,
17924 \begin_layout Subsection
17928 \begin_layout Standard
17929 A friend of mine wanted to try LyX for a group project.
17930 When he didn't find support for version control or file locking, he dropped
17932 This angered me a bit, so I thought that I should at least make support
17933 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
17934 This has now been done.
17935 LyX now supports some of the most basic RCS commands.
17936 If you need to something a bit more sophisticated you will have to do that
17937 manually in an xterm.
17940 \begin_layout Standard
17941 Before you begin to use the version control features in LyX, you should
17943 \begin_inset Quotes eld
17947 \begin_inset Quotes erd
17950 (a man file, read it with
17955 This file describes all the basic features of RCS.
17956 You should especially notice the comment about a RCS directory, and the
17957 notion of a master RCS file (the file ending in
17964 \begin_layout Standard
17965 Later basic CVS/SVN support was added.
17966 You should be familiar with CVS/SVN usage before start using it under LyX.
17967 Most of the log messages are not currently displayed after operations -
17968 you can check them in terminal window if unsure.
17971 \begin_layout Standard
17972 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
17973 package—no guarantees are made for older versions.
17976 \begin_layout Standard
17977 For introducing your own external commands consult vc-command in the manual
17981 \begin_layout Subsection
17982 RCS commands in LyX
17985 \begin_layout Standard
17986 The following sections describe the RCS commands supported by LyX.
17987 You can find them in the
17989 File\SpecialChar \menuseparator
17991 \begin_inset space ~
17997 LyX was tested against RCS 5.7.
18000 \begin_layout Subsubsection
18006 \begin_layout Standard
18007 If your document is not under revision control, this is the only item shown
18009 And if it is under revision control, the
18013 item is not visible.
18017 \begin_layout Standard
18018 This command registers your document with RCS (unless you are under the
18019 directory managed by CVS)\SpecialChar \@.
18020 You are asked interactively to supply an initial
18021 description of the document.
18022 The document is now set in Read-Only mode and you have to
18025 \begin_inset space ~
18029 \begin_inset space ~
18033 \begin_inset space ~
18038 , before making any changes to it.
18039 A document under revision control has a
18040 \begin_inset Quotes eld
18043 [RCS:<version> <locker>]
18044 \begin_inset Quotes erd
18047 item tagged to the filename in the minibuffer.
18050 \begin_layout Standard
18051 RCS command that is run:
18053 ci -q -u -i -t-"<initial description>" <file-name>
18056 \begin_layout Standard
18061 to understand the switches.
18065 \begin_layout Subsubsection
18071 \begin_layout Standard
18072 When you are finished editing a file, you check in your changes.
18073 When you do this, you are asked for a description of the changes.
18074 This is stored in the history log.
18075 The version number is bumped, your changes are applied to the master RCS
18076 file, the document is unlocked and set to Read-Only mode.
18080 \begin_layout Standard
18083 ci -q -u -m"<description>" <file-name>
18086 \begin_layout Subsubsection
18092 \begin_layout Standard
18093 By doing this you lock the document so that only you can edit it.
18094 This will also make the document Read-Write only for you.
18095 You will usually continue editing for a while and when you are finished
18096 you check in your changes.
18097 The status line is changed to reflect that you have locked the file.
18101 \begin_layout Standard
18104 co -q -l <file-name>
18107 \begin_layout Subsubsection
18110 Revert To Repository Version
18113 \begin_layout Standard
18114 This will discard all changes made to the document since the last check
18116 You get a warning before changes are discarded.
18119 \begin_layout Standard
18122 co -f -u<version> <file-name>
18125 \begin_layout Subsubsection
18131 \begin_layout Standard
18132 This makes as if the last check in never happened.
18133 No changes are made to the document loaded into LyX, but the last version
18134 is removed from the master RCS file.
18138 \begin_layout Standard
18141 rcs -o<version> <file-name>
18144 \begin_layout Subsubsection
18150 \begin_layout Standard
18151 This show the complete history of the RCS document.
18156 is shown in a browser.
18164 \begin_layout Subsection
18165 CVS commands in LyX
18168 \begin_layout Standard
18169 CVS is now partially supported by LyX.
18170 You can find the commands in the
18172 File\SpecialChar \menuseparator
18174 \begin_inset space ~
18182 \begin_layout Subsubsection
18188 \begin_layout Standard
18189 If your document is not under revision control, this is the only item shown
18191 And if it is under revision control, the
18198 item is not visible.
18202 \begin_layout Standard
18203 This command registers in CVS your document ONLY in case you have already
18204 the documents directory under CVS control (in particular
18209 This means you have to checkout the archive by yourself.
18213 \begin_layout Standard
18214 Then you are asked interactively to supply an initial description of the
18216 Don't forget that registered file is not yet commited.
18219 \begin_layout Standard
18220 CVS command that is run:
18223 \begin_inset Quotes erd
18227 \begin_inset Quotes eld
18231 \begin_inset Quotes erd
18237 \begin_layout Standard
18242 to understand the switches.
18246 \begin_layout Subsubsection
18252 \begin_layout Standard
18253 When you are finished editing a file, you commit your changes.
18254 When you do this, you are asked for a description of the changes.
18255 After that changes are commited.
18258 \begin_layout Standard
18261 cvs -q commit -m"<description>" "<file-name>"
18264 \begin_layout Subsubsection
18267 Revert To Repository Version
18270 \begin_layout Standard
18271 This will discard all changes made to the document since the last check
18273 You get a warning before changes are discarded.
18274 Firstly the file is deleted, secondly CVS update command is run.
18277 \begin_layout Standard
18281 \begin_inset Quotes eld
18285 \begin_inset Quotes erd
18291 \begin_layout Subsubsection
18297 \begin_layout Standard
18298 This show the complete history of the CVS document.
18302 \begin_inset Quotes eld
18306 \begin_inset Quotes erd
18311 is shown in a browser.
18314 \begin_layout Subsection
18315 SVN commands in LyX
18318 \begin_layout Standard
18319 SVN is now partially supported by LyX.
18320 You can find the commands in the
18322 File\SpecialChar \menuseparator
18324 \begin_inset space ~
18330 Please note that if you use password protected access to repository via
18331 ssh, you will be asked in terminal window.
18332 LyX was tested against SVN 1.5 and 1.6
18336 \begin_layout Plain Layout
18337 Most of the commands will work with 1.4 too, see
18338 \begin_inset CommandInset ref
18340 reference "sub:SVN-Repo-Update"
18352 \begin_layout Subsubsection
18358 \begin_layout Standard
18359 If your document is not under revision control, this is the only item shown
18361 And if it is under revision control, the
18368 item is not visible.
18372 \begin_layout Standard
18373 This command registers in SVN your document ONLY in case you have already
18374 the documents directory under SVN control (in particular
18379 This means you have to checkout the archive by yourself.
18383 \begin_layout Standard
18384 Then you are asked interactively to supply an initial description of the
18386 Don't forget that registered file is not yet commited.
18389 \begin_layout Standard
18390 SVN command that is run:
18393 \begin_inset Quotes eld
18397 \begin_inset Quotes erd
18403 \begin_layout Standard
18408 to understand the switches.
18412 \begin_layout Subsubsection
18418 \begin_layout Standard
18419 When you are finished editing a file, you commit your changes.
18420 When you do this, you are asked for a description of the changes.
18421 After that changes are commited.
18424 \begin_layout Standard
18429 \begin_layout Plain Layout
18430 In case locking is not enabled.
18432 \begin_inset CommandInset ref
18434 reference "subsec:SVN-File-Locking"
18445 svn commit -q -m"<description>" <file-name>
18448 \begin_layout Subsubsection
18454 \begin_layout Standard
18455 Updates the changes of this file from the repository.
18456 Be sure you understand SVN merging and conflicts resolving before using
18457 this function, because all conflicts has to be resolved manually by you!
18460 \begin_layout Standard
18465 \begin_layout Plain Layout
18474 \begin_inset Quotes eld
18478 \begin_inset Quotes erd
18484 \begin_layout Subsubsection
18487 Revert To Repository Version
18490 \begin_layout Standard
18491 This will discard all changes made to the document since the last check
18493 You get a warning before changes are discarded.
18497 \begin_layout Standard
18501 \begin_inset Quotes eld
18505 \begin_inset Quotes erd
18511 \begin_layout Subsubsection
18512 \begin_inset CommandInset label
18514 name "sub:SVN-Repo-Update"
18518 Update of the local directory checkout from repository
18522 \begin_layout Plain Layout
18523 Note that this command will work only with subversion
18524 \begin_inset Formula $\geqq1.5$
18535 \begin_layout Standard
18536 All the commands above have one shortcomming - they deal with the current
18538 Once your document contains pictures, includes external
18539 \begin_inset Flex CharStyle:Code
18542 \begin_layout Plain Layout
18548 files and so on administration becomes more complicated.
18549 LyX now supports updating the whole tree in which resides the document
18553 \begin_layout Plain Layout
18554 One need to organize the files structure so that all external files are
18555 in the same directory or subdirectories of the document.
18562 This become especially useful once you cooperate with people which neither
18563 know about subversion management nor they have ambition to commit additional
18564 material to the repository.
18568 \begin_layout Standard
18569 \begin_inset Flex CharStyle:Code
18572 \begin_layout Plain Layout
18573 Update local directory from repository
18578 command updates the whole directory and in case of merge conflicts local
18579 version of the files are left, so no unintended data loss occurs.
18580 If local changes are detected user is warned before update starts.
18583 \begin_layout Labeling
18584 \labelwidthstring 00.00.0000
18586 \begin_inset space ~
18590 \begin_inset space ~
18594 \begin_inset Newline newline
18598 \begin_inset Flex CharStyle:Code
18601 \begin_layout Plain Layout
18607 (Ask if changes are detected.)
18608 \begin_inset Newline newline
18612 \begin_inset Flex CharStyle:Code
18615 \begin_layout Plain Layout
18616 svn update --accept mine-full $path
18624 \begin_layout Standard
18626 \begin_inset Flex CharStyle:Code
18629 \begin_layout Plain Layout
18635 stands for the path to the document.
18638 \begin_layout Subsubsection
18644 \begin_layout Standard
18645 This show the complete history of the SVN document.
18649 \begin_inset Quotes eld
18653 \begin_inset Quotes erd
18658 is shown in a browser.
18661 \begin_layout Subsubsection
18663 \begin_inset CommandInset label
18665 name "subsec:SVN-File-Locking"
18672 \begin_layout Standard
18673 The file exchange through various revision control systems brings the problem
18674 of merge conflicts in case two different users try to edit the same (parts
18676 When such conflict happens it needs manual resolving and one reasonable
18677 alternative is to provide some kind of locking mechanism, which guarantees
18678 that only one user is allowed to edit file at the given time.
18681 \begin_layout Standard
18682 SVN has two mechanisms to provide such kind of mutual exclusivity for file
18683 access - locks and automatical setting of write permissions (see sec.
18685 \begin_inset CommandInset ref
18687 reference "subsec:Automatical-Locking-Property"
18692 \begin_inset Flex CharStyle:Code
18695 \begin_layout Plain Layout
18705 \begin_layout Plain Layout
18706 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
18712 In a case this property is detected for a given document LyX starts to
18713 use SVN locks for document editing automatically and the whole check-in/out
18714 mechanism switches to the same regimen as for RCS.
18715 This in particular means there are two different modes how file is used
18719 \begin_layout Itemize
18721 The loaded file is in the read-only mode.
18722 For editation on needs to check-out.
18727 consists of update from repository and gaining write lock.
18728 If the lock is not possible to obtain, we remain in unlocked state.
18731 \begin_layout Itemize
18733 The loaded file is in the 'normal' edit mode.
18734 No other user is allowed to edit the file.
18739 consists of commiting changes and releasing write-lock.
18740 If no changes have been made to the document, no commit will be produced
18744 \begin_layout Plain Layout
18745 Don't be puzzled by the fact that you will be asked for commit message anyway.
18750 and only the write-lock will be released.
18753 \begin_layout Standard
18757 \begin_layout Labeling
18758 \labelwidthstring 00.00.0000
18761 svn commit -q -m"<description>" "<file-name>"
18762 \begin_inset Newline newline
18765 svn unlock "<file-name>"
18768 \begin_layout Labeling
18769 \labelwidthstring 00.00.0000
18772 svn update "<file-name>"
18773 \begin_inset Newline newline
18776 svn lock "<file-name>"
18779 \begin_layout Subsubsection
18782 \begin_inset CommandInset label
18784 name "subsec:Automatical-Locking-Property"
18790 Automatical Locking Property
18793 \begin_layout Standard
18794 The above mentioned automatical setting of write permissions of the .lyx
18795 file can be set through
18800 ile\SpecialChar \menuseparator
18806 \begin_inset space ~
18809 Control\SpecialChar \menuseparator
18814 oggle locking property
18817 This command is active only when the file is not locked on the svn server
18819 you need to check-out before proceeding).
18822 \begin_layout Labeling
18823 \labelwidthstring 00.00.0000
18825 \begin_inset space ~
18831 \begin_layout Labeling
18832 \labelwidthstring 00.00.0000
18835 svn propset svn:needs-lock ON "<file-name>"
18838 \begin_layout Labeling
18839 \labelwidthstring 00.00.0000
18842 svn propdel svn:needs-lock "<file-name>"
18845 \begin_layout Subsubsection
18846 Revision Information in Documents
18849 \begin_layout Standard
18850 Currently there is no way how to provide such kind of information directly
18852 There are possibilities how to activate it with the help of svn features,
18853 but each has its own drawbacks.
18856 \begin_layout Standard
18857 One possibility is to use svn keywords
18861 \begin_layout Plain Layout
18862 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
18868 In short -- you set file keywords property (e.g.
18871 svn propset svn:keywords 'Rev' file.lyx
18873 ) and then paste keyword ERT
18877 \begin_layout Plain Layout
18878 This is an easy way how to ensure that LyX won't break the line in the middle
18884 tag in your document (e.g.
18889 \begin_layout Plain Layout
18897 This way svn client will automatically substitute revision number (e.g.
18902 \begin_layout Plain Layout
18909 ) after each update and commit.
18910 There are more problems with this approach.
18911 Firstly, the '$' character is used in TeX world for math equations, so
18912 any occurence of math formula
18913 \begin_inset Formula $Rev$
18917 \begin_inset Formula $Rev:59$
18920 in your LyX document.
18921 Similarly for other keywords like Id, Date, Author, etc.
18922 Secondly svn output is dependent on your locales, so its very easy that
18923 svn would produce some problematic strings once Date is used.
18924 Thirdly you get the whole 'Rev: 59' string in your document instead of
18926 Until subversion implements user's custom keywords it will be hard to use
18927 this approach reliably or let LyX to support it directly .
18930 \begin_layout Standard
18931 The second possibility would be to write your own external-material template
18933 \begin_inset Flex CharStyle:Code
18936 \begin_layout Plain Layout
18942 utility or parses the output of
18943 \begin_inset Flex CharStyle:Code
18946 \begin_layout Plain Layout
18952 command and returns the result back, when typeseting the document.
18955 \begin_layout Subsection
18956 SVN and Windows Environment
18959 \begin_layout Quote
18960 My inclination is to say that if the user cannot figure out the command
18961 line operations on their own fairly quickly, they would be well advised
18962 to use TortoiseSVN.
18968 \begin_layout Subsubsection
18972 \begin_layout Standard
18973 In addition to installing LyX, and having access to a Subversion repository,
18974 the user will need to install the Subversion client program.
18975 A Windows installer for the client program is available from
18976 \begin_inset CommandInset href
18979 target "http://www.collab.net/nonav/downloads/subversion/"
18984 The user may also want to install
18985 \begin_inset CommandInset href
18988 target "http://tortoisesvn.tigris.org/"
18992 , which integrates Subversion operations into the context (rightclick) menu
18993 of Windows Explorer.
18994 Operations done outside LyX will typically be more convenient using the
18995 Explorer context menu.
18996 Note that TortoiseSVN is not a replacement for the client program, which
18997 is what LyX itself will use.
19000 \begin_layout Subsubsection
19001 Bringing a document under Subversion control
19004 \begin_layout Standard
19005 Before a LyX document can be brought under version control in Subversion,
19006 its parent directory needs to be under version control.
19007 If the document is being added to a project already in the repository,
19008 this is accomplished by checking the project out to the directory where
19009 the new document will be placed.
19010 If the project itself is not yet under version control (for instance, if
19011 this document starts a new project), the directory must be imported into
19013 This is done outside LyX.
19014 Both import and checkout are easily accomplished from the Explorer context
19015 menu using TortoiseSVN, or alternatively can be done using the command
19016 line client at a DOS prompt.
19017 The procedure for importing the project using TortoiseSVN is described
19018 below, assuming an existing repository and a new project being started
19026 For information on using the Subversion client program, run
19033 \begin_layout Enumerate
19040 in Windows Explorer, right click it, and select
19042 TortoiseSVN > Repo-browser
19045 If necessary, adjust the URL for the repository, then click OK.
19048 \begin_layout Enumerate
19049 Right click the level of the repository under which you want to place the
19050 new project folder (typically the top level) and click
19052 Create folder\SpecialChar \ldots{}
19055 Supply a name for the project folder and click OK.
19056 Add a message for the log file if desired, then click OK again.
19057 The new project folder should appear in the repository.
19058 Finally, click OK again to exit the repository browser.
19061 \begin_layout Enumerate
19062 Once again right click
19068 , this time selecting SVN Checkout\SpecialChar \ldots{}
19069 Select the URL of the project folder
19070 you just created in the repository, and set the checkout directory to
19078 You will be warned about a non-empty folder; click OK to proceed.
19079 You should now have a
19090 \begin_layout Enumerate
19091 Create or open your document in LyX and click
19096 ile\SpecialChar \menuseparator
19102 \begin_inset space ~
19105 Control\SpecialChar \menuseparator
19113 Add a log message and click OK to commit the document to version control.
19116 \begin_layout Standard
19117 From this point onward, you should have full functionality in the
19122 ile\SpecialChar \menuseparator
19128 \begin_inset space ~
19134 You also have the option of checking the document in and out, viewing its
19136 using the TortoiseSVN context menu in Windows Explorer or the Subversion
19137 client program from a command prompt.
19140 \begin_layout Subsection
19144 \begin_layout Standard
19145 With the recent addition of the vc-command function LyX power users are
19146 allowed to create their own commands for revision control.
19149 \begin_layout Standard
19150 As an example you can see how two TortoiseSVN commands could be integrated
19154 \begin_layout Description
19156 \begin_inset Flex CharStyle:Code
19159 \begin_layout Plain Layout
19160 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
19168 \begin_layout Description
19170 \begin_inset Flex CharStyle:Code
19173 \begin_layout Plain Layout
19174 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
19182 \begin_layout Section
19183 Literate Programming
19186 \begin_layout Standard
19191 (kayvan@sylvan.com)
19195 original documentation written by
19197 Edmar Wienskoski Jr.
19200 (edmar-w-jr@technologist.com)
19203 \begin_layout Subsection
19207 \begin_layout Standard
19208 The main purpose of this documentation is to show you how to use LyX for
19209 literate programming.
19210 Where it is assumed that you are familiar with this programming technique,
19212 \begin_inset Quotes eld
19216 \begin_inset Quotes erd
19220 \begin_inset Quotes eld
19224 \begin_inset Quotes erd
19228 If that is not the case, please follow the web links provided in the following
19230 There is a lot of good documentation out there covering old development
19231 history to the latest tools tips.
19234 \begin_layout Standard
19235 It is also assumed that you are familiar with LyX itself to a point that
19236 you are comfortable changing your LyX preferences, and X resources file.
19237 If that is not the case please refer to other LyX documentation to cover
19238 your specific needs.
19241 \begin_layout Subsection
19242 Literate Programming
19245 \begin_layout Standard
19246 From the Literate Programming FAQ:
19249 \begin_layout Quotation
19250 Literate programming is the combination of documentation and source together
19251 in a fashion suited for reading by human beings.
19252 In fact, literate programs should be enjoyable reading, even inviting!
19253 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
19254 and documentation in a single file.
19255 Literate programming tools then parse the file to produce either readable
19256 documentation or compilable source.
19257 The WEB style of literate programming was created by D.
19258 \begin_inset space \thinspace{}
19262 Knuth during the development of his TeX typesetting software.
19266 \begin_layout Standard
19267 Another excerpt says:
19270 \begin_layout Quotation
19273 How is literate programming different from verbose commenting?
19276 \begin_layout Quotation
19277 There are three distinguishing characteristics.
19278 In order of importance, they are:
19282 \begin_layout Itemize
19283 flexible order of elaboration
19286 \begin_layout Itemize
19287 automatic support for browsing
19290 \begin_layout Itemize
19291 typeset documentation, especially diagrams and mathematics
19295 \begin_layout Standard
19296 Now that I sparked your curiosity, take a look in the references.
19299 \begin_layout Subsubsection
19303 \begin_layout Standard
19304 The complete Literate Programming FAQ can be found at:
19307 \begin_layout Quote
19308 Literate Programming FAQ
19309 \begin_inset Flex URL
19312 \begin_layout Plain Layout
19314 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
19322 \begin_layout Standard
19323 The FAQ lists 23 (twenty three!) different literate programming tools.
19324 Where some are specialized or
19325 \begin_inset Quotes eld
19329 \begin_inset Quotes erd
19332 for particular programming languages, while other have general scope.
19337 for my own use for several reasons:
19340 \begin_layout Itemize
19341 It can generate the documentation either in LaTeX or HTML.
19344 \begin_layout Itemize
19345 It has a open architecture, i.
19346 \begin_inset space \thinspace{}
19350 \begin_inset space \space{}
19353 it is easy to plug in new filters and to perform special processing that
19358 \begin_layout Itemize
19359 There is a good selection of filters available already (the HTML is one
19363 \begin_layout Itemize
19367 \begin_layout Standard
19368 The Noweb web page can be found at:
19371 \begin_layout Quote
19373 \begin_inset Flex URL
19376 \begin_layout Plain Layout
19378 http://www.cs.virginia.edu/~nr/noweb/
19386 \begin_layout Standard
19387 Starting from there you can reach many other interesting links and even
19388 some literate program examples.
19391 \begin_layout Subsection
19392 LyX and Literate Programming
19395 \begin_layout Standard
19396 The LyX support for Literate Programming is provided by using the generic
19397 LyX converters mechanism.
19398 This support is provided in a
19399 \begin_inset Quotes eld
19403 \begin_inset Quotes erd
19407 \begin_inset space \thinspace{}
19411 \begin_inset space \space{}
19414 you will be able to use this new LyX feature with some other literate programmin
19415 g tool of your choice by just changing your LyX preferences.
19418 \begin_layout Subsubsection
19419 Generating documents and code (weaving and tangling)
19422 \begin_layout Paragraph
19423 Selecting the document class
19426 \begin_layout Standard
19427 If you have installed Noweb and LyX successfully, whenever you open a new
19428 document or try to change the document class of an existing one, you will
19429 find that there are three new document classes available:
19432 \begin_layout Itemize
19436 \begin_layout Itemize
19440 \begin_layout Itemize
19444 \begin_layout Standard
19445 You must select one of them to create your literate documents from.
19449 \begin_layout Standard
19450 Note that literate documents are not limited to these three classes.
19451 New classes can be generated from other styles like letter or in combination
19452 with other class variations like Article (AMS).
19453 If you have special needs that cannot be covered by one of the existing
19454 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
19455 will arrange to insert a new entry, or teach you how to do it.
19459 \begin_layout Plain Layout
19460 It is very simple, it involves the creation of a file with four lines, and
19461 re-running of the auto configuration.
19466 Moreover, if you use a literate tool other than Noweb you may need to create
19467 a new set of document classes for it.
19470 \begin_layout Paragraph
19474 \begin_layout Standard
19475 LyX enables you to write code with a layout named
19483 \begin_layout Plain Layout
19484 The equivalent Noweb term is
19485 \begin_inset Quotes eld
19489 \begin_inset Quotes erd
19493 For historical reasons, I got used to the term
19494 \begin_inset Quotes eld
19498 \begin_inset Quotes erd
19501 introduced by other literate tool named Nuweb, which I used for many years
19502 before rendering myself to Noweb.
19507 Noweb delimits scraps like this:
19510 \begin_layout LyX-Code
19514 \begin_layout LyX-Code
19518 \begin_layout LyX-Code
19522 \begin_layout LyX-Code
19526 \begin_layout LyX-Code
19530 \begin_layout Standard
19531 The problem is that whatever is written in between the << and the
19535 must be taken literally, i.
19536 \begin_inset space \thinspace{}
19540 \begin_inset space \space{}
19543 LyX should be prevented from making any special interpretation of what has
19545 This is handled by a special layout named Scrap, that works like a normal
19546 paragraph but has a free spacing capability.
19549 \begin_layout Standard
19550 The down side of the Scrap paragraph layout is that consecutive paragraphs
19551 of code will be spaced with one empty line in the source code and also
19552 in the printed documentation.
19553 The work around is to enter each line of code within a single Scrap, with
19554 a newline (ctrl-return).
19555 The example above will look like this:
19559 \begin_layout Plain Layout
19560 If you have a printed version of this document you will not see any difference
19561 between the previous example and this one.
19569 \begin_layout LyX-Code
19571 \begin_inset Newline newline
19575 \begin_inset Newline newline
19579 \begin_inset Newline newline
19583 \begin_inset Newline newline
19589 \begin_layout Standard
19590 This layout works fine.
19591 The only real inconvenience is that you have to type ctrl-return instead
19596 \begin_layout Plain Layout
19597 It is in my list of
19598 \begin_inset Quotes eld
19602 \begin_inset Quotes erd
19613 \begin_layout Standard
19614 As a special note, you can also use the
19615 \begin_inset Quotes eld
19619 \begin_inset Quotes erd
19622 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
19626 \begin_layout LyX-Code
19628 \begin_inset Newline newline
19631 def some_function(args):
19632 \begin_inset Newline newline
19635 "This is the doc string for this function."
19636 \begin_inset Newline newline
19639 print "My args: ", args
19642 \begin_layout LyX-Code
19643 @ %def some_function
19646 \begin_layout Standard
19647 For an example of this usage and the resulting cross-reference output, look
19648 at the Literate python program in
19650 LIBDIR/examples/listerrors.lyx
19652 which should make this all clear.
19655 \begin_layout Paragraph
19656 Generating the documentation
19659 \begin_layout Standard
19660 At this point you already have a new document file with a proper document
19661 class, and with some code and text on it.
19662 How do I print it? The answer is simple, you select
19664 View\SpecialChar \menuseparator
19668 Just like you would do for a plain document.
19669 No special procedure is required.
19672 \begin_layout Standard
19673 To help orientate you, I will now explain what happens inside LyX:
19676 \begin_layout Enumerate
19679 Update\SpecialChar \menuseparator
19682 menu option is chosen, a LaTeX file is generated.
19687 \begin_layout Standard
19688 If the document is of any literate class the generated file will be named
19689 with an extension name defined by the
19690 \begin_inset Quotes eld
19694 \begin_inset Quotes erd
19697 format (defined in the Preferences panel), otherwise the file will have
19706 \begin_layout Enumerate
19707 Note that the only difference so far is in the name of the file, no special
19708 processing is required by LyX.
19709 Given that you formatted the code using the Scrap layout that, by itself,
19710 takes care of the business.
19713 \begin_layout Enumerate
19714 If the document is of any literate class LyX will then use the internal
19715 LyX to Noweb converter, followed by the Noweb to LaTeX converter
19719 \begin_layout Plain Layout
19720 The converters are defined in the
19722 Tools\SpecialChar \menuseparator
19726 \begin_inset Quotes eld
19730 \begin_inset Quotes erd
19742 manual for general information about converters.
19747 to generate the LaTeX file.
19751 \begin_layout Standard
19752 Otherwise it will just skip this step.
19756 \begin_layout Enumerate
19757 Finally, LaTeX is invoked and the regular post processing continues as in
19761 \begin_layout Standard
19762 Independence from a particular
19763 \begin_inset Quotes eld
19767 \begin_inset Quotes erd
19770 is easily achieved by changing the commands that are run by the various
19774 \begin_layout Paragraph
19775 Generating the code
19778 \begin_layout Standard
19779 When the build menu option is chosen or the corresponding button in the
19780 toolbar is pressed, a LaTeX file is generated just like step 1 above.
19781 Next, LyX invokes the
19786 This converter needs to be defined by the user and is not installed by
19787 default, though the Program format is.
19788 This converter (like any other converter) will have two parts:
19791 \begin_layout Enumerate
19792 The converter program itself.
19793 This program performs the conversion from the one format to the other (in
19794 this case, from the Noweb format to the Program pseudo-format).
19797 \begin_layout Enumerate
19798 The error log parser.
19799 This is a program whose sole purpose is to rewrite error messages in a
19800 format that LyX understands.
19801 This makes it possible for LyX to place error boxes in the right places
19802 in the file buffer.
19805 \begin_layout Standard
19806 The first part, the
19807 \begin_inset Quotes eld
19811 \begin_inset Quotes erd
19814 setting, should be set to
19815 \begin_inset Quotes eld
19823 \begin_inset Quotes erd
19827 This basically means that LyX will call
19828 \begin_inset Quotes eld
19832 \begin_inset Quotes erd
19835 (a program or script) with the name of the Noweb file (normally a file
19836 in the LyX temp directory).
19840 \begin_layout Standard
19841 This is an implementation of
19842 \begin_inset Quotes eld
19846 \begin_inset Quotes erd
19849 that you can place in a directory on your path:
19852 \begin_layout LyX-Code
19856 \begin_layout LyX-Code
19860 \begin_layout LyX-Code
19861 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
19864 \begin_layout Standard
19865 The next part of the converter setting is the
19866 \begin_inset Quotes eld
19870 \begin_inset Quotes erd
19873 which is to be set to
19874 \begin_inset Quotes eld
19879 parselog=listerrors
19882 \begin_inset Quotes erd
19886 This will run any errors that are generated by the
19887 \begin_inset Quotes eld
19891 \begin_inset Quotes erd
19894 process through the
19895 \begin_inset Quotes eld
19899 \begin_inset Quotes erd
19905 \begin_layout Standard
19906 The converter code looks in
19914 then on the path for the
19915 \begin_inset Quotes eld
19919 \begin_inset Quotes erd
19925 \begin_layout Standard
19926 The build will normally take place in LyX's temporary directory, so the
19927 files produced by the conversion will be in that directory.
19928 LyX will copy out what it regards as the `main' file, but the
19932 conversion may produce several files, and so most of these would then be
19933 deleted when LyX was closed.
19934 The present solution is to use a `copier',
19938 \begin_layout Plain Layout
19947 manual for information on these.
19956 script in its default mode, so that the entire contents of the temporary
19957 directory is copied.
19958 More will get copied than is needed, to be sure, but nothing will be lost.
19959 If, however, you know what extensions the generated files will have, this
19960 can be improved by using the
19969 This option takes a comma-separated list of extensions to copy.
19970 So, for example, if the conversion will generate only files with the extensions
19979 , then the correct definition would be:
19982 \begin_layout LyX-Code
19983 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
19986 \begin_layout Standard
19987 The result will be that only files with these two extensions will be copied
19991 \begin_layout Paragraph
19992 Build instructions in the document
19995 \begin_layout Standard
19996 The last piece of the integration between LyX and noweb is the
19997 \begin_inset Quotes eld
20001 \begin_inset Quotes erd
20005 Generally, the instructions for building your program should be embedded
20006 in a scrap of its own.
20008 \begin_inset Quotes eld
20012 \begin_inset Quotes erd
20015 above uses the notangle command to look for this scrap (called
20016 \begin_inset Quotes eld
20020 \begin_inset Quotes erd
20023 ) and runs its contents through
20024 \begin_inset Quotes eld
20028 \begin_inset Quotes erd
20034 \begin_layout Standard
20035 Typically, such a scrap would look something like this:
20038 \begin_layout LyX-Code
20040 \begin_inset Newline newline
20044 \begin_inset Newline newline
20048 \begin_inset Newline newline
20051 if [ -z "${NOWEB_SOURCE}" ]
20052 \begin_inset Newline newline
20056 \begin_inset Newline newline
20059 NOWEB_SOURCE=myfile.nw
20060 \begin_inset Newline newline
20064 \begin_inset Newline newline
20068 code to extract files ...]
20069 \begin_inset Newline newline
20073 code to compile files ...]
20074 \begin_inset Newline newline
20080 \begin_layout Standard
20083 LIBDIR/examples/listerrors.lyx
20087 LIBDIR/examples/Literate.lyx
20089 which implement two versions of the
20090 \begin_inset Quotes eld
20094 \begin_inset Quotes erd
20097 program for some illustrations of how all of these pieces go together or
20100 LIBDIR/examples/noweb2lyx.lyx.
20103 Interestingly, these three files show off the language-indepence of the
20104 LyX literate programming support since they are written in Python, C and
20108 \begin_layout Subsubsection
20112 \begin_layout Standard
20113 All the Literate Programming support is configured by the
20115 Tools\SpecialChar \menuseparator
20119 \begin_inset Quotes eld
20123 \begin_inset Quotes erd
20127 The important parts are:
20130 \begin_layout Description
20132 \begin_inset space ~
20136 \begin_inset Quotes eld
20140 \begin_inset Quotes erd
20144 \begin_inset space ~
20147 format Set up via the Formats tab, this is where the Noweb-specific pieces
20157 , the file extension is set to
20162 This tells LyX to create a file with a
20166 extension in the first step of the conversion process.
20169 \begin_layout Description
20171 \begin_inset space ~
20179 \begin_inset space ~
20182 format This is an empty format whose sole purpose is to be the endpoint
20183 of a conversion (which then allows us to set up a converter for it).
20186 \begin_layout Description
20195 This converter performs the
20196 \begin_inset Quotes eld
20200 \begin_inset Quotes erd
20203 of the literate document.
20204 For Noweb, it is set to
20205 \begin_inset Quotes eld
20210 noweave -delay -index $$i > $$o
20213 \begin_inset Quotes erd
20219 \begin_layout Description
20229 \begin_inset Quotes eld
20233 \begin_inset Quotes erd
20237 As stated above, the Converter is set to
20238 \begin_inset Quotes eld
20246 \begin_inset Quotes erd
20249 , with Flags set to
20250 \begin_inset Quotes eld
20255 originaldir,parselog=listerrors
20258 \begin_inset Quotes erd
20264 \begin_layout Subsubsection
20268 \begin_layout Standard
20269 There is also a new function implemented in the LyX server, the
20270 \begin_inset Quotes eld
20273 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
20277 \begin_layout Standard
20278 When debugging code with ddd/gdb, it is possible to invoke a text editor
20279 at the current execution position with a single key stroke.
20280 The default ddd configuration for that is shift-ctrl-V.
20281 It happens that you can define the editor command line invocation in ddd
20284 Edit\SpecialChar \menuseparator
20285 Preferences\SpecialChar \menuseparator
20288 dialog and changing the "Edit Sources" entry.
20291 \begin_layout Standard
20292 I take advantage of the new created LyX server function and this ddd feature,
20294 \begin_inset Quotes eld
20298 \begin_inset Quotes erd
20304 \begin_layout LyX-Code
20305 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
20308 \begin_layout Standard
20309 With this, whenever you are using ddd and find a point in the program that
20310 you want to edit, you just press shift-ctrl-V (in the ddd window), and
20311 ddd you forward this information to LyX through the LyX server and then
20312 the LyX window will show the same file with the cursor at the same position
20313 ddd was pointing to.
20314 No more guessing or long scrolling to locate a point in the program back
20318 \begin_layout Standard
20319 Note however that you must enable the LyX server to get this feature working
20320 (it is disabled by default).
20321 You can enable it in
20333 ) by entering in the
20338 \begin_inset Quotes eld
20343 /home/<your-home-directory>/.lyx/lyxpipe
20346 \begin_inset Quotes erd
20352 \begin_layout Standard
20353 Read the LyX server documentation in the
20355 Customization Manual
20357 for further information.
20360 \begin_layout Subsubsection
20364 \begin_layout Standard
20365 There are six new buttons that can be added to your LyX toolbar.
20366 Five of these buttons are short cuts to layout styles:
20387 The last one is a short cut to the
20388 \begin_inset Quotes eld
20392 \begin_inset Quotes erd
20399 \begin_layout Standard
20400 LyX has a range of buttons that are available for tool bar customization.
20401 In my toolbar I like to combine the six short cuts above with two more:
20406 \SpecialChar \menuseparator
20411 \SpecialChar \menuseparator
20418 View\SpecialChar \menuseparator
20422 Here is how it looks like:
20425 \begin_layout LyX-Code
20429 \begin_layout LyX-Code
20433 \begin_layout LyX-Code
20434 Icon "layout Standard"
20437 \begin_layout LyX-Code
20438 Icon "layout Section"
20441 \begin_layout LyX-Code
20442 Icon "layout LaTeX"
20445 \begin_layout LyX-Code
20446 Icon "layout LyX-Code"
20449 \begin_layout LyX-Code
20450 Icon "layout Scrap"
20453 \begin_layout LyX-Code
20457 \begin_layout LyX-Code
20461 \begin_layout LyX-Code
20462 Icon "buffer-typeset"
20465 \begin_layout LyX-Code
20466 Icon "build-program"
20469 \begin_layout LyX-Code
20473 \begin_layout LyX-Code
20477 \begin_layout LyX-Code
20481 \begin_layout LyX-Code
20485 \begin_layout LyX-Code
20489 \begin_layout Subsubsection
20490 Colors customization
20493 \begin_layout Standard
20494 There are a number of colors in LyX that can be customized in
20499 One of the things that bothers people is the LaTeX font color.
20500 The default color is red, since the scraps uses LaTeX font, and there is
20501 a lot of scraps in literate documents, you may get tired of seeing everything
20503 You can change it by going to the tabs
20512 \begin_layout Standard
20513 The next thing is the visible presence of the newline character in the screen.
20514 You can choose the color of this particular character and make it blend
20516 I recommend you choosing a color that is close to the background but not
20517 equal, that way you still can see it is there, but it is not bothering
20522 \begin_layout Chapter
20523 Secrets of the LaTeX Masters
20524 \begin_inset CommandInset label
20533 \begin_layout Standard
20534 Though LyX is a powerful tool, it cannot hope to support everything that
20535 can be done with pure TeX/LaTeX.
20536 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
20537 as long as you are not afraid to use that
20538 \begin_inset Quotes eld
20542 \begin_inset Quotes erd
20545 button on the toolbar or add things to the LaTeX preamble.
20546 This section lists some tips, tricks, and otherwise cool ideas to give
20547 your document that extra little flair.
20550 Do try this at home
20552 , just start with something a little smaller and less important than your
20556 \begin_layout Standard
20557 Most ideas in this section require less common files in your LaTeX installation.
20558 If you have a system like teTeX, most will already be available.
20559 A few, however, will need to be downloaded from one of the CTAN archives.
20560 Often, there are several ways to do something, or several LaTeX style files
20561 which do the same thing.
20562 We do not endorse one choice over another, we simply claim that we have
20563 done a particular task with a particular file.
20564 Put on your wizard hat, keep an eye out for dragons, and let us begin.
20567 \begin_layout Section
20571 \begin_layout Standard
20574 Lars Gullik Bjønnes
20577 \begin_layout Subsection
20581 \begin_layout Standard
20582 The aim for this chapter
20586 \begin_layout Plain Layout
20587 Editor's note: Lars' original chapter was a masterful description of how
20593 However, it was too long to flow smoothly in this document.
20594 I have therefore chosen to excerpt the most important sections here (sorry,
20595 Lars); you can read the original chapter (and more of the story!) in the
20598 examples/multicol.lyx
20606 is to show how the LaTeX package
20610 can be used in a LyX document.
20611 As LyX doesn't support the
20615 package natively yet, we have to use some small hacks.
20616 By reading this section it should be obvious how to do this.
20619 \begin_layout Subsection
20623 \begin_layout Standard
20628 package allows switching between one and multicolumn format on the same
20630 Footnotes are handled correctly (for the most part), but will be placed
20631 at the bottom of the page and not under each column.
20632 LaTeX's float mechanism, however, is partly disabled in the current implementat
20634 At the moment only page-wide floats can be used within the scope of the
20638 \begin_layout Subsection
20642 \begin_layout Subsubsection
20646 \begin_layout Standard
20647 If you want to have two columns in your text, you have use LaTeX mode to
20652 begin{multicols}{2}
20654 at the point where you want the two column layout to start, and then
20660 where you want it to end.
20664 \begin_layout Standard
20668 \begin_layout Plain Layout
20672 begin{multicols}{2}
20680 \begin_layout Standard
20685 The Adventure of the Empty House
20688 \begin_inset Newline newline
20693 Sir Arthur Conan Doyle
20696 \begin_layout Standard
20699 It was in the spring of the year 1894 that all London was interested, and
20700 the fashionable world dismayed, by the murder of the Honourable Ronald
20701 Adair under most unusual and inexplicable circumstances.
20702 The public has already learned those particulars of the crime which came
20703 out in the police investigation, but a good deal was suppressed upon that
20704 occasion, since the case for the prosecution was so overwhelmingly strong
20705 that it was not necessary to bring forward all the facts.
20706 Only now, at the end of nearly ten years, am I allowed to supply those
20707 missing links which make up the whole of that remarkable chain.
20708 The crime was of interest in itself, but that interest was as nothing to
20709 me compared to the inconceivable sequel, which afforded me the greatest
20710 shock and surprise of any event in my adventurous life.
20711 Even now, after this long interval, I find myself thrilling as I think
20712 of it, and feeling once more that sudden flood of joy, amazement, and increduli
20713 ty which utterly submerged my mind.
20714 Let me say to that public, which has shown some interest in those glimpses
20715 which I have occasionally given them of the thoughts and actions of a very
20716 remarkable man, that they are not to blame me if I have not shared my knowledge
20717 with them, for I should have considered it my first duty to do so, had
20718 I not been barred by a positive prohibition from his own lips, which was
20719 only withdrawn upon the third of last month.
20722 \begin_layout Standard
20726 \begin_layout Plain Layout
20738 \begin_layout Subsubsection
20742 \begin_layout Standard
20743 The same pattern is used when you want more than two columns:
20746 \begin_layout Standard
20750 \begin_layout Plain Layout
20754 begin{multicols}{3}
20762 \begin_layout Standard
20765 It can be imagined that my close intimacy with Sherlock Holmes had interested
20766 me deeply in crime, and that after his disappearance I never failed to
20767 read with care the various problems which came before the public.
20768 And I even attempted, more than once, for my own private satisfaction,
20769 to employ his methods in their solution, though with indifferent success.
20770 There was none, however, which appealed to me like this tragedy of Ronald
20772 As I read the evidence at the inquest, which led up to a verdict of willful
20773 murder against some person or persons unknown, I realized more clearly
20774 than I had ever done the loss which the community had sustained by the
20775 death of Sherlock Holmes.
20776 There were points about this strange business which would, I was sure,
20777 have specially appealed to him, and the efforts of the police would have
20778 been supplemented, or more probably anticipated, by the trained observation
20779 and the alert mind of the first criminal agent in Europe.
20780 All day, as I drove upon my round, I turned over the case in my mind and
20781 found no explanation which appeared to me to be adequate.
20782 At the risk of telling a twice-told tale, I will recapitulate the facts
20783 as they were known to the public at the conclusion of the inquest.
20786 \begin_layout Standard
20790 \begin_layout Plain Layout
20802 \begin_layout Standard
20803 You can have more than 3 columns if you want to, but that might not be very
20804 pleasant for the eye.
20807 \begin_layout Subsubsection
20808 Columns inside columns
20811 \begin_layout Standard
20812 You can even have columns inside columns:
20815 \begin_layout Standard
20819 \begin_layout Plain Layout
20823 begin{multicols}{2}
20831 \begin_layout Standard
20834 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
20835 at that time governor of one of the Australian colonies.
20836 Adair's mother had returned from Australia to undergo the operation for
20837 cataract, and she, her son Ronald, and her daughter Hilda were living together
20841 \begin_layout Standard
20845 \begin_layout Plain Layout
20849 begin{multicols}{2}
20857 \begin_layout Standard
20860 The youth moved in the best society–had, so far as was known, no enemies
20861 and no particular vices.
20862 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
20863 had been broken off by mutual consent some months before, and there was
20864 no sign that it had left any very profound feeling behind it.
20865 For the rest {sic} the man's life moved in a narrow and conventional circle,
20866 for his habits were quiet and his nature unemotional.
20867 Yet it was upon this easy-going young aristocrat that death came, in most
20868 strange and unexpected form, between the hours of ten and eleven-twenty
20869 on the night of March 30, 1894.
20872 \begin_layout Standard
20876 \begin_layout Plain Layout
20888 \begin_layout Standard
20891 Ronald Adair was fond of cards–playing continually, but never for such stakes
20893 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
20894 It was shown that, after dinner on the day of his death, he had played
20895 a rubber of whist at the latter club.
20896 He had also played there in the afternoon.
20901 The evidence of those who had played with him– Mr.
20902 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
20903 and that there was a fairly equal fall of the cards.
20904 Adair might have lost five pounds, but not more.
20905 His fortune was a considerable one, and such a loss could not in any way
20907 He had played nearly every day at one club or other, but he was a cautious
20908 player, and usually rose a winner.
20909 It came out in evidence that, in partnership with Colonel Moran, he had
20910 actually won as much as four hundred and twenty pounds in a sitting, some
20911 weeks before, from Godfrey Milner and Lord Balmoral.
20912 So much for his recent history as it came out at the inquest.
20915 \begin_layout Standard
20919 \begin_layout Plain Layout
20931 \begin_layout Standard
20932 Please do read the file
20934 examples/multicol.lyx
20936 for more advanced examples including column and header spacing, vertical
20937 separator lines, and more.
20940 \begin_layout Section
20945 Paragraph Environment
20946 \begin_inset OptArg
20949 \begin_layout Plain Layout
20950 Numbering in Enumerate
20958 \begin_layout Standard
20964 \begin_layout Standard
20965 \begin_inset VSpace bigskip
20971 \begin_layout Standard
20973 The default numbering for the
20977 paragraph environment begins with Arabic numbers and ends with uppercase
20979 Suppose, however, you wanted a different type of numbering scheme.
20980 Here's a quickie example of how to change the numbering scheme:
20983 \begin_layout LyX-Code
20993 \begin_layout LyX-Code
21003 \begin_layout LyX-Code
21013 \begin_layout LyX-Code
21023 \begin_layout Standard
21024 \SpecialChar \ldots{}
21025 which changes the numbering scheme to uppercase Roman numerals, uppercase
21026 letters, Arabic numbers, and lowercase letter.
21029 \begin_layout Standard
21030 Additionally, the previous example also adds a little bit extra to the numbering
21032 For example, the first level label actually looks like:
21033 \begin_inset Quotes eld
21037 \begin_inset Quotes erd
21041 For ease of reading, we'll describe what the numbering schemes look like
21042 using a notation something like this: <
21043 \begin_inset Quotes eld
21047 \begin_inset Quotes erd
21051 \begin_inset space ~
21055 \begin_inset Quotes erd
21059 \begin_inset Quotes erd
21063 \begin_inset space ~
21067 \begin_inset Quotes erd
21071 \begin_inset Quotes erd
21075 \begin_inset space ~
21079 \begin_inset Quotes eld
21083 \begin_inset Quotes erd
21090 \begin_layout Standard
21091 As you can see in the example, there is a label command for each nesting
21098 \SpecialChar \ldots{}
21105 , as well as a counter,
21109 \SpecialChar \ldots{}
21115 There are also five
21116 \begin_inset Quotes eld
21120 \begin_inset Quotes erd
21153 , each of which take one counter as an argument.
21154 You can add characters before or after these, but there's no need to add
21158 \begin_layout Standard
21159 You can get really fancy with these.
21163 \begin_layout LyX-Code
21177 \begin_layout LyX-Code
21189 \begin_layout LyX-Code
21199 \begin_layout LyX-Code
21209 \begin_layout Standard
21210 produces the somewhat out of hand numbering scheme: <
21211 \begin_inset Quotes eld
21215 \begin_inset Quotes erd
21219 \begin_inset space ~
21223 \begin_inset Quotes erd
21227 \begin_inset Quotes erd
21231 \begin_inset space ~
21235 \begin_inset Quotes erd
21239 \begin_inset Quotes erd
21243 \begin_inset space ~
21247 \begin_inset Quotes eld
21251 \begin_inset Quotes erd
21258 \begin_layout Standard
21262 \begin_layout Section
21266 \begin_layout Standard
21272 \begin_layout Standard
21273 \begin_inset VSpace bigskip
21279 \begin_layout Standard
21284 \begin_layout Plain Layout
21290 tmpfont}{cmr17 scaled 2500}{
21302 \begin_layout Standard
21307 \begin_layout Plain Layout
21318 hose of you who like the style of old books probably also like
21319 \begin_inset Quotes eld
21323 \begin_inset Quotes erd
21326 —those large capital letters which begin each new chapter or section.
21327 Implementing them with plain LyX/LaTeX is straightforward (assuming you
21328 know some plain TeX!) but does require a lot of work and many iterations,
21329 as you can see by all the ugly TeX-mode stuff at the beginning of this
21333 \begin_layout Standard
21337 \begin_layout Plain Layout
21343 bigdrop{-1em}{3}{ptmri}{T}+
21348 here is a much easier way of doing this, of course.
21357 ) package from CTAN allows a simple way to add such letters to your documents.
21358 Since this package is not a standard part of teTeX, I can't demonstrate
21359 it within this document, but if you copy this paragraph to a new document,
21361 \begin_inset Quotes eld
21371 \begin_inset Quotes erd
21374 and the pluses from the TeX code at the beginning of the paragraph, and
21379 usepackage{dropcaps}
21381 to your LaTeX preamble, you will get a nice Times Roman Italic
21382 \begin_inset Quotes eld
21386 \begin_inset Quotes erd
21389 , whose height is three lines of text and which protrudes 1 em into the
21391 (Make certain you have copied
21392 \begin_inset Quotes eld
21400 \begin_inset Quotes erd
21403 into a directory where TeX can see it.) The first argument is the amount
21404 of indentation; in this case the negative sign moves it into the margin.
21405 The second argument is the height of the letter in number of lines of text.
21406 The third argument is the font name: virtually anything which has a tfm
21407 file should work (wade through the
21409 .../texmf/fonts/tfm
21411 directory for possibilities).
21412 My personal favorite is
21413 \begin_inset Quotes eld
21421 \begin_inset Quotes erd
21424 , a fancy German font specifically designed for dropped capitals.
21425 The fourth argument is the letter (or letters) to be dropped.
21430 package also offers the
21436 command, as well as a slightly simplified
21445 \begin_layout Section
21446 Non-standard Paragraph Shapes
21449 \begin_layout Standard
21455 \begin_layout Standard
21456 \begin_inset VSpace bigskip
21462 \begin_layout Standard
21466 \begin_layout Plain Layout
21478 \begin_layout Standard
21482 \begin_layout Plain Layout
21491 \begin_layout Plain Layout
21505 \begin_layout Standard
21510 \begin_layout Plain Layout
21521 \begin_layout Plain Layout
21530 \begin_layout Plain Layout
21539 \begin_layout Plain Layout
21548 \begin_layout Plain Layout
21557 \begin_layout Plain Layout
21566 \begin_layout Plain Layout
21575 \begin_layout Plain Layout
21584 \begin_layout Plain Layout
21593 \begin_layout Plain Layout
21602 \begin_layout Plain Layout
21611 \begin_layout Plain Layout
21620 \begin_layout Plain Layout
21629 \begin_layout Plain Layout
21638 \begin_layout Plain Layout
21647 \begin_layout Plain Layout
21656 \begin_layout Plain Layout
21665 \begin_layout Plain Layout
21674 \begin_layout Plain Layout
21683 \begin_layout Plain Layout
21689 There are times when the tyranny of rectangular paragraphs must be overthrown.
21690 In such situations, a call to the delightful plain TeX command
21697 As you can see, completely arbitrary shapes can be laid out with a suitable
21698 set of linelength definitions.
21699 While this parshape may look a bit silly and useless, one could conceive
21700 of situations such as finely tuned dropped capitals, word wrapping around
21701 non-rectangular graphics, etc.
21702 which will benefit from such handcrafting.
21705 \begin_layout Standard
21706 \begin_inset VSpace bigskip
21712 \begin_layout Standard
21717 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
21724 is the number of lines of text which define the paragraph.
21725 If there turn out to be fewer lines, the shape is truncated; if there are
21726 more, the excess lines have the same dimensions as the last line of the
21736 entries specify the indentation of the line from the left margin, and the
21737 length of the line as measured from that point.
21738 The shape applies only to the current paragraph; everything is reset to
21739 normal for the next paragraph.
21742 \begin_layout Standard
21746 \begin_layout Plain Layout
21758 \begin_layout Section
21762 \begin_layout Standard
21763 As you can see, the examples in this section range from the useful to the
21765 While I don't expect that anyone will ever need the paragraph shape demonstrate
21766 d in the last section, the important point is that you can do almost anything
21767 you want in LyX if you are willing to figure out how to do it in TeX and
21769 TeX is a fantastically powerful typesetting system and all that power is
21770 available to you since LyX uses it as its backend.