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}}
73 \font_typewriter default
74 \font_default_family default
82 \default_output_format default
83 \bibtex_command default
84 \index_command default
88 \pdf_title "LyX's Extended manual"
89 \pdf_author "LyX Team"
90 \pdf_subject "LyX's extended documentation"
91 \pdf_keywords "LyX, Documentation, Extended"
93 \pdf_bookmarksnumbered true
94 \pdf_bookmarksopen false
95 \pdf_bookmarksopenlevel 1
100 \pdf_pdfusetitle false
101 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
109 \paperorientation portrait
112 \paragraph_separation indent
114 \quotes_language english
117 \paperpagestyle headings
118 \tracking_changes false
119 \output_changes false
127 Additional LyX Features
135 \begin_layout Plain Layout
137 Principal maintainer of this file is
142 If you have comments or error corrections, please send them to the LyX
143 Documentation mailing list,
144 \begin_inset Flex CharStyle:Code
147 \begin_layout Plain Layout
149 <lyx-docs@lists.lyx.org>
162 \begin_layout Standard
163 \begin_inset CommandInset toc
164 LatexCommand tableofcontents
171 \begin_layout Chapter
175 \begin_layout Standard
176 This manual is essentially Part II of the
178 User's Guide\SpecialChar \@.
181 The reason for separating this document out is simple: the
185 is already quite lengthy, and it contains information on all of the basic
186 features one needs to know in order to prepare most documents.
187 However, the LyX Team has worked to LyX extensible through various configuratio
188 n files and external packages.
189 That means that if you want to support the Fizzwizzle LaTeX package, you
190 can create a layout file (or module) for it without having to alter LyX
192 We've already had contributions of several new features this way.
193 This is the place where all of those get documented.
196 \begin_layout Standard
197 This manual also documents some special features, like fax support, version
198 control, and SGML support, which require additional software to work properly.
199 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
200 spruce up your documents by directly using the powerful features of LaTeX.
205 only WYSIWYM and will only ever interface to some, not all, LaTeX features.
208 \begin_layout Standard
209 If you haven't read the
213 yet, you are definitely in the wrong manual.
218 is the first place to go, since it describes the notation and format of
220 You should also be thoroughly familiar with the
224 and all of the basic features of LyX before attempting to read this one.
227 \begin_layout Standard
228 Since all the topics in this manual depend heavily on LyX's interaction
229 with LaTeX, this first chapter covers the inner workings of LyX and how
230 to direct LyX to generate exactly the LaTeX code you want.
231 It is obviously for more seasoned LyX users.
234 \begin_layout Chapter
238 \begin_layout Section
242 \begin_layout Standard
243 This chapter is for both TeX-nicians and the LaTeX-curious.
244 In it, we'll explain how LyX and LaTeX work together to produce printable
246 This is the only place in any of the manuals where we assume you know something
250 \begin_layout Standard
251 At one time, LyX was called a
252 \begin_inset Quotes eld
255 WYSIWYM frontend to LaTeX,
256 \begin_inset Quotes erd
259 but that's no longer true.
260 There are frontends to LaTeX out there.
264 \begin_layout Plain Layout
265 Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
266 There are also the LaTeX modes for vi and emacs, of course.
271 These are basically text editors with the ability to run LaTeX and mark
272 any errors in the file you're editing.
281 run LaTeX, and it also indicates errors in the file, it also does much,
283 For one thing, you don't need to know LaTeX to use LyX effectively.
284 And LyX has added its own extensions to LaTeX.
285 Try the following sometime: select
286 \begin_inset Flex CharStyle:MenuItem
289 \begin_layout Plain Layout
290 Export\SpecialChar \menuseparator
297 \begin_inset Flex CharStyle:MenuItem
300 \begin_layout Plain Layout
307 \begin_inset Flex CharStyle:MenuItem
310 \begin_layout Plain Layout
311 View\SpecialChar \menuseparator
317 ), then look at the preamble of the resulting
318 \begin_inset Flex CharStyle:Code
321 \begin_layout Plain Layout
328 You'll notice a variety of new macros defined specifically by LyX.
329 These macros are defined automatically, according to the features you use
333 \begin_layout Standard
334 There are several commands that automatically invoke LaTeX.
338 \begin_layout Itemize
339 \begin_inset Flex CharStyle:MenuItem
342 \begin_layout Plain Layout
343 View\SpecialChar \menuseparator
352 \begin_layout Itemize
353 \begin_inset Flex CharStyle:MenuItem
356 \begin_layout Plain Layout
357 View\SpecialChar \menuseparator
358 Update\SpecialChar \menuseparator
367 \begin_layout Itemize
368 \begin_inset Flex CharStyle:MenuItem
371 \begin_layout Plain Layout
372 File\SpecialChar \menuseparator
381 \begin_layout Itemize
382 \begin_inset Flex CharStyle:MenuItem
385 \begin_layout Plain Layout
386 File\SpecialChar \menuseparator
395 \begin_layout Standard
396 They will only invoke LaTeX if the file has changed since the last time
401 \begin_layout Standard
402 When LyX runs LaTeX on the file you're editing, it performs these steps:
405 \begin_layout Enumerate
406 Convert the document to LaTeX and save to a file with the extension
407 \begin_inset Flex CharStyle:Code
410 \begin_layout Plain Layout
417 \begin_inset Flex CharStyle:Code
420 \begin_layout Plain Layout
429 \begin_layout Enumerate
431 \begin_inset Flex CharStyle:Code
434 \begin_layout Plain Layout
440 file (maybe several times), and run any other commands (such as
441 \begin_inset Flex CharStyle:Code
444 \begin_layout Plain Layout
451 \begin_inset Flex CharStyle:Code
454 \begin_layout Plain Layout
460 ) needed to compile the LaTeX file.
463 \begin_layout Enumerate
464 If there are any errors, show the error log.
467 \begin_layout Standard
468 If you've run LaTeX using
469 \begin_inset Flex CharStyle:MenuItem
472 \begin_layout Plain Layout
475 \SpecialChar \menuseparator
483 , LyX then runs a DVI viewer to display the DVI-file.
485 \begin_inset Flex CharStyle:MenuItem
488 \begin_layout Plain Layout
491 \SpecialChar \menuseparator
499 , LyX performs further steps:
502 \begin_layout Itemize
504 \begin_inset Flex CharStyle:Code
507 \begin_layout Plain Layout
513 to convert the DVI file to PostScript.
516 \begin_layout Itemize
517 Run a PostScript viewer, such as
518 \begin_inset Flex CharStyle:Code
521 \begin_layout Plain Layout
527 , to display the PostScript file.
530 \begin_layout Standard
531 LyX does similar things when viewing, or exporting, other formats.
534 \begin_layout Section
535 Translating LaTeX files into LyX
538 \begin_layout Standard
539 You can import a LaTeX file into LyX by using the
540 \begin_inset Flex CharStyle:MenuItem
543 \begin_layout Plain Layout
544 File\SpecialChar \menuseparator
545 Import\SpecialChar \menuseparator
552 This will call a program named
553 \begin_inset Flex CharStyle:Code
556 \begin_layout Plain Layout
562 which will create a file
563 \begin_inset Flex CharStyle:Code
566 \begin_layout Plain Layout
573 \begin_inset Flex CharStyle:Code
576 \begin_layout Plain Layout
583 LyX will then open that file.
587 \begin_layout Plain Layout
588 \begin_inset Flex CharStyle:Code
591 \begin_layout Plain Layout
597 can also be run from the command line, of course.
605 \begin_layout Standard
606 \begin_inset Flex CharStyle:Code
609 \begin_layout Plain Layout
615 will translate most legal LaTeX, but not everything.
616 It will put things it doesn't understand into TeX code, so after translating
618 \begin_inset Flex CharStyle:Code
621 \begin_layout Plain Layout
627 , you can look for TeX code and hand-edit it until it looks right.
630 \begin_layout Standard
631 If you don't know what TeX code is, read the next section.
634 \begin_layout Section
635 \begin_inset CommandInset label
637 name "sec:Inserting-TeX-Code"
641 Inserting TeX Code into LyX Documents
644 \begin_layout Standard
645 Anything you can do in LaTeX you can do in LyX, for a very simple reason:
646 You can always insert TeX code into any LyX document.
647 LyX cannot, and will never be able to, display every possible LaTeX construct.
648 If ever you need to insert LaTeX commands into your LyX document, you can
650 \begin_inset Flex CharStyle:Code
653 \begin_layout Plain Layout
659 box, which you can insert into your document with
660 \begin_inset Flex CharStyle:MenuItem
663 \begin_layout Plain Layout
664 Insert\SpecialChar \menuseparator
673 \begin_layout Standard
674 Here's an example of inserting LaTeX commands in a LyX document.
675 The code looks like this:
678 \begin_layout LyX-Code
682 \begin_inset Newline newline
688 \begin_inset Newline newline
691 This is an example for a minipage environment.
693 \begin_inset Newline newline
696 can put nearly everything in it, even (non-floating)
697 \begin_inset Newline newline
702 \begin_inset Newline newline
708 \begin_inset Newline newline
712 \begin_inset Newline newline
718 \begin_inset Newline newline
724 \begin_inset Newline newline
730 \begin_inset Newline newline
735 \begin_inset Newline newline
741 \begin_inset Newline newline
747 \begin_inset Newline newline
753 \begin_inset Newline newline
761 \begin_layout LyX-Code
765 \begin_layout Standard
767 \begin_inset Flex CharStyle:Code
770 \begin_layout Plain Layout
776 box containing this text is directly after this paragraph.
777 Those of you reading the manual in LyX will only see the TeX code inset.
778 Those reading a printed version of the manuals will see the actual results:
781 \begin_layout Standard
785 \begin_layout Plain Layout
792 \begin_layout Plain Layout
799 \begin_layout Plain Layout
801 This is an example for a minipage environment.
802 You can put nearly everything in it, even (non-floating) figures and tables.
806 \begin_layout Plain Layout
813 \begin_layout Plain Layout
818 \begin_layout Plain Layout
825 \begin_layout Plain Layout
832 \begin_layout Plain Layout
839 \begin_layout Plain Layout
845 \begin_layout Plain Layout
852 \begin_layout Plain Layout
859 \begin_layout Plain Layout
866 \begin_layout Plain Layout
878 \begin_layout Standard
879 In addition to using TeX code, you can also create a separate file containing
880 some complex LaTeX structure and then use
881 \begin_inset Flex CharStyle:MenuItem
884 \begin_layout Plain Layout
885 Insert\SpecialChar \menuseparator
895 to include your file (you should select the type
896 \begin_inset Flex CharStyle:Code
899 \begin_layout Plain Layout
906 We recommend that you only do this if you have a
907 \begin_inset Flex CharStyle:Code
910 \begin_layout Plain Layout
921 Otherwise, you'll have a big job tracking down LaTeX errors.
924 \begin_layout Standard
925 There are a few last points to emphasize:
928 \begin_layout Itemize
933 check if your LaTeX code is correct.
936 \begin_layout Itemize
937 Beware reinventing the wheel.
940 \begin_layout Standard
941 On that last point, LyX does have quite a few features tucked into it, and
943 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
944 feature before you decide you have to do it by hand.
945 Moreover, there are numerous LaTeX packages out there to do all sorts of
946 things, from labels to envelopes to fancy multipage tables.
948 \begin_inset CommandInset href
951 target "http://www.ctan.org/"
955 for details, and see chapter
956 \begin_inset CommandInset ref
958 reference "cha:secrets"
965 \begin_layout Standard
966 If you do need to do some wild and fancy things within your document, be
967 sure to check out a good LaTeX book for assistance.
968 There are a number of them listed in the bibliography of the
975 \begin_layout Section
976 LyX and the LaTeX Preamble
979 \begin_layout Subsection
980 About the LaTeX Preamble
983 \begin_layout Standard
984 If you already know LaTeX, there is no need to explain here what the preamble
986 If you don't, the following will give you some ideas—we recommend again
987 that you consult a LaTeX book for further information.
988 In any case, you should read the points below, because they explain what
989 you can do and what you don't need to do in the LaTeX preamble of a LyX
993 \begin_layout Standard
994 The LaTeX preamble comes at the very beginning of a document,
1002 \begin_layout Itemize
1003 Declare the document class.
1005 \begin_inset Newline newline
1008 LyX already does this for you.
1009 If you're a seasoned LaTeX-nician, and you have a custom document class
1010 you want to use, check out the
1012 Customization Manual
1014 for information on how to make LyX interface to it.
1017 \begin_layout Itemize
1018 Declare the usage of packages.
1020 \begin_inset Newline newline
1023 LaTeX packages provide special commands, which are only available within
1024 a document when the package has been declared in the preamble.
1025 For example, the package
1026 \begin_inset Flex CharStyle:Code
1029 \begin_layout Plain Layout
1035 forces all paragraphs to be indented.
1036 There are other packages for labels, envelopes, margins, etc.
1040 \begin_layout Itemize
1041 Set counters, variables, lengths and widths.
1043 \begin_inset Newline newline
1046 There are several LaTeX counters and variables which
1050 be set globally from within the preamble in order to have the desired effect.
1051 (There are variables which you can set and reset inside the document, too.)
1052 Margins are a good example of something which must be set in the preamble.
1053 Another example is the label format for lists.
1054 You can actually set these just about anywhere, but it's best to do it
1055 just once, inside the preamble.
1058 \begin_layout Itemize
1059 Declare user defined commands (with
1060 \begin_inset Flex CharStyle:Code
1063 \begin_layout Plain Layout
1072 \begin_inset Flex CharStyle:Code
1075 \begin_layout Plain Layout
1084 \begin_inset Newline newline
1087 These are abbreviations for LaTeX commands which appear very often inside
1089 Although the preamble is a good place to declare such commands, they
1093 be declared anywhere (before they are used for the first time, of course).
1094 This can be useful if there is a lot of raw LaTeX code in your document,
1095 which normally should not be the case.
1098 \begin_layout Standard
1099 LyX adds its own set of definitions to the preamble of the
1100 \begin_inset Flex CharStyle:Code
1103 \begin_layout Plain Layout
1110 This makes LaTeX files generated by LyX portable.
1113 \begin_layout Subsection
1114 Changing the Preamble
1117 \begin_layout Standard
1118 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1119 can't change them without patching LyX itself.
1120 You can, however, add your own stuff to the preamble by selecting
1121 \begin_inset Flex CharStyle:MenuItem
1124 \begin_layout Plain Layout
1126 \begin_inset space ~
1135 \begin_inset Flex CharStyle:MenuItem
1138 \begin_layout Plain Layout
1139 Document\SpecialChar \menuseparator
1146 LyX adds anything in the
1147 \begin_inset Flex CharStyle:MenuItem
1150 \begin_layout Plain Layout
1156 dialog to its own built-in preamble.
1157 Before adding your own declarations in the preamble, you should make sure
1158 that LyX doesn't already support what you want to do.
1159 (Remember what we said about reinventing the wheel?) Also,
1161 make sure your preamble code is correct
1164 LyX doesn't check it for you.
1165 If there is an error, you're likely to get an error like
1166 \begin_inset Quotes eld
1170 \begin_inset Flex CharStyle:Code
1173 \begin_layout Plain Layout
1182 \begin_inset Quotes erd
1186 If you see this error, check your preamble.
1189 \begin_layout Subsection
1193 \begin_layout Standard
1194 Here are some examples of what you can add to a preamble, and what they
1198 \begin_layout Subsubsection
1202 \begin_layout Standard
1203 There are two variables under LaTeX that control page position:
1204 \begin_inset Flex CharStyle:Code
1207 \begin_layout Plain Layout
1216 \begin_inset Flex CharStyle:Code
1219 \begin_layout Plain Layout
1228 Their names should be self-explanatory.
1229 These variables are useful if you think for a moment about computer labels.
1230 Sometimes, the size of a print medium and the area of the medium that you
1231 can actually print on aren't the same.
1233 \begin_inset Flex CharStyle:Code
1236 \begin_layout Plain Layout
1245 \begin_inset Flex CharStyle:Code
1248 \begin_layout Plain Layout
1259 \begin_layout Standard
1260 The default values for
1261 \begin_inset Flex CharStyle:Code
1264 \begin_layout Plain Layout
1273 \begin_inset Flex CharStyle:Code
1276 \begin_layout Plain Layout
1285 \begin_inset space \thinspace{}
1289 \begin_inset space \thinspace{}
1293 \begin_inset space \space{}
1296 the page isn't shifted.
1297 Unfortunately, some DVI drivers always seem to shift the page.
1298 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1299 If you're using LyX on a system that you don't personally maintain, and
1300 your sysadmin is a doofus,
1301 \begin_inset Flex CharStyle:Code
1304 \begin_layout Plain Layout
1313 \begin_inset Flex CharStyle:Code
1316 \begin_layout Plain Layout
1325 Suppose you're left and top margins are always 0.5
1326 \begin_inset space \thinspace{}
1330 You can add this to the preamble:
1333 \begin_layout LyX-Code
1341 \begin_layout LyX-Code
1349 \begin_layout Standard
1350 and your margins should now be correct.
1353 \begin_layout Subsubsection
1357 \begin_layout Standard
1358 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1359 There's a rather nice package, available at your nearest CTAN archive,
1360 for printing sheets of labels:
1361 \begin_inset Flex CharStyle:Code
1364 \begin_layout Plain Layout
1371 Now, your system may not have this package installed by default.
1372 We leave that up to you to check.
1373 You'll also want to read the documentation for it; we're not going to do
1375 Since this is an example, however, we'll give you an example of how you
1379 \begin_layout Standard
1380 First, make sure you're using the
1381 \begin_inset Flex CharStyle:Code
1384 \begin_layout Plain Layout
1391 Next, you need to put the following in your preamble:
1394 \begin_layout LyX-Code
1400 \begin_layout LyX-Code
1406 \begin_layout LyX-Code
1412 \begin_layout LyX-Code
1418 \begin_layout LyX-Code
1424 \begin_layout LyX-Code
1430 \begin_layout LyX-Code
1436 \begin_layout Standard
1437 This sets things up for Avery label sheets, stock #5360.
1438 You're now ready to print labels, but you'll need to insert LaTeX code,
1439 placing the commands
1440 \begin_inset Flex CharStyle:Code
1443 \begin_layout Plain Layout
1452 \begin_inset Flex CharStyle:Code
1455 \begin_layout Plain Layout
1463 around each label text.
1464 This and other special features of
1465 \begin_inset Flex CharStyle:Code
1468 \begin_layout Plain Layout
1474 are explained in its documentation.
1477 \begin_layout Standard
1478 Someday, someone may write a LyX layout file to support this package directly.
1479 Maybe that someone is you.
1482 \begin_layout Subsubsection
1483 Example #3: Paragraph Indentation
1486 \begin_layout Standard
1487 Americans are trained to indent the first line of
1492 As with all of their other weird quirks, most Americans will whine and
1493 moan until they can have their way and indent the first line of all paragraphs.
1502 \begin_layout Standard
1503 Of course, this behavior isn't standard typography.
1504 In books, you typically only indent the first line of a paragraph
1508 it follows another one.
1509 The idea behind indenting the first line of a paragraph is to distinguish
1510 neighboring paragraphs from one another.
1511 If there is no previous paragraph—for example, if it follows a figure or
1512 is the first paragraph in a section—then there is no need for indentation.
1516 \begin_layout Standard
1517 If you're a typical American (we're still joking!), though, you don't care
1518 about such esoteric things; you want your indentation! Add this to the
1522 \begin_layout LyX-Code
1525 usepackage{indentfirst}
1528 \begin_layout Standard
1529 If your TeX distribution isn't braindead, you'll have this package, and
1530 all of your paragraphs will get the indentation the Founding Fathers intended
1534 \begin_layout Subsubsection
1535 Example #4: This Document
1538 \begin_layout Standard
1539 You can also check out the preamble of this document to get an idea of some
1540 of the advanced things you can do.
1541 Also, there are more examples and an assortment of LaTeX
1542 \begin_inset Quotes eld
1546 \begin_inset Quotes erd
1550 \begin_inset space ~
1554 \begin_inset CommandInset ref
1556 reference "cha:secrets"
1564 \begin_layout Section
1565 LyX and LaTeX Errors
1568 \begin_layout Standard
1569 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1571 It then uses the logfile from the LaTeX run to do a post-mortem.
1572 After analyzing the logfile,LyX displays a dialog listing the errors.
1573 Clicking on any one of them will take you to the position in your LyX file
1574 where the error occurred.
1578 \begin_layout Plain Layout
1580 Analyzing the logfile is a tough job, and LyX doesn't always go to the
1582 There are also cases where LaTeX reports the error on one line, but the
1583 actual error is earlier.
1584 This is not unlike forgetting a closing brace in a program: You'll get
1585 an error, but only later.
1593 \begin_layout Standard
1594 Some folks also like to look at the log file directly: It is available from
1596 \begin_inset Flex CharStyle:MenuItem
1599 \begin_layout Plain Layout
1602 \SpecialChar \menuseparator
1606 \begin_inset space ~
1615 There are some fairly common error messages and warnings.
1616 We'll cover those here.
1617 You should look at a good LaTeX book for a complete listing.
1620 \begin_layout Itemize
1621 \begin_inset Flex CharStyle:Code
1624 \begin_layout Plain Layout
1631 \begin_inset Newline newline
1634 Anything beginning with these words is a warning message for the purpose
1636 \begin_inset Quotes eld
1640 \begin_inset Quotes erd
1643 the LaTeX code itself.
1644 You'll get messages like this if you added or changed cross-references
1645 or bibliography entries, in which case, LaTeX is trying to tell you that
1646 you need to make another run.
1647 You can by-and-large ignore these.
1650 \begin_layout Itemize
1651 \begin_inset Flex CharStyle:Code
1654 \begin_layout Plain Layout
1661 \begin_inset Newline newline
1664 Another warning message, this time about fonts which LaTeX couldn't find.
1665 The rest of the message will often say something about a replacement font
1667 You can safely ignore these, too.
1670 \begin_layout Itemize
1671 \begin_inset Flex CharStyle:Code
1674 \begin_layout Plain Layout
1683 \begin_inset Newline newline
1691 They are warnings about lines that were too long and run past the right
1693 Almost always, this is unnoticeable in the final output.
1694 (It can be just a point or two.) Or, only one or two characters extend past
1696 LaTeX seems to generate at least one of these messages for just about any
1698 \begin_inset Newline newline
1701 You can ignore these messages.
1702 Your eyes will tell you if there's a problem with something that's too
1703 wide; just look at the output.
1707 \begin_layout Plain Layout
1708 You can also enable the `draft' option in
1709 \begin_inset Flex CharStyle:MenuItem
1712 \begin_layout Plain Layout
1715 \SpecialChar \menuseparator
1723 , and then LaTeX will draw a black box in the margin of lines that are overfull.
1731 \begin_layout Itemize
1732 \begin_inset Flex CharStyle:Code
1735 \begin_layout Plain Layout
1744 \begin_inset Newline newline
1747 Not quite as common as its cousin.
1748 LaTeX seems to like to print lines that are a bit too wide as opposed to
1749 ones that are a bit too narrow.
1750 We have no idea why.
1753 \begin_layout Itemize
1754 \begin_inset Flex CharStyle:Code
1757 \begin_layout Plain Layout
1766 \begin_inset Flex CharStyle:Code
1769 \begin_layout Plain Layout
1778 \begin_inset Newline newline
1781 Warnings about troubles breaking the page.
1782 Once again, just look at the output.
1783 Your eyes will tell you where something has gone wrong.
1786 \begin_layout Itemize
1787 \begin_inset Flex CharStyle:Code
1790 \begin_layout Plain Layout
1792 \begin_inset Quotes els
1796 \begin_inset Quotes ers
1805 \begin_inset Newline newline
1809 \begin_inset Quotes eld
1813 \begin_inset Quotes erd
1816 isn't installed on this system.
1817 This usually appears because some package your document needs isn't installed.
1818 If you didn't touch the preamble or didn't use the
1819 \begin_inset Flex CharStyle:Code
1822 \begin_layout Plain Layout
1830 command, then one of the packages LyX tried to load is missing.
1832 \begin_inset Flex CharStyle:MenuItem
1835 \begin_layout Plain Layout
1836 Help\SpecialChar \menuseparator
1842 to get a list of packages that LyX knows about.
1843 This file is updated whenever you reconfigure LyX (using
1844 \begin_inset Flex CharStyle:MenuItem
1847 \begin_layout Plain Layout
1848 Tools\SpecialChar \menuseparator
1854 ) and tells you which packages have been detected and what they do.
1855 \begin_inset Newline newline
1859 \begin_inset Flex CharStyle:Code
1862 \begin_layout Plain Layout
1870 command and the package in question isn't installed, then you'll need to
1871 install it yourself.
1874 \begin_layout Itemize
1875 \begin_inset Flex CharStyle:Code
1878 \begin_layout Plain Layout
1879 LaTeX Error: Unknown option
1885 \begin_inset Newline newline
1888 Error messages beginning with this are trying to tell you that you specified
1889 a bad or undefined option to a package.
1890 Check the package's documentation.
1893 \begin_layout Itemize
1894 \begin_inset Flex CharStyle:Code
1897 \begin_layout Plain Layout
1898 Undefined control sequence
1904 \begin_inset Newline newline
1907 If you've inserted LaTeX code into your document, but made a typo, you'll
1909 You may have forgotten to load a package.
1910 In any case, this error message usually means that you used an undefined
1915 \begin_layout Standard
1916 There are other error and warning messages.
1917 Some are self-explanatory.
1918 These are usually LaTeX messages.
1919 Others are downright cryptic.
1920 These are usually TeX error messages, and we really have
1924 what they mean or how to decipher them.
1928 \begin_layout Standard
1929 There's a general sequence you should follow if you get error messages:
1932 \begin_layout Enumerate
1933 Look at the LaTeX code you inserted for typos.
1936 \begin_layout Enumerate
1937 If there are no typos, check that you used the command(s) correctly.
1940 \begin_layout Enumerate
1941 If you get a bunch of error boxes piled up at the very top of the document—and
1942 especially if you see a
1943 \begin_inset Quotes eld
1947 \begin_inset Flex CharStyle:Code
1950 \begin_layout Plain Layout
1959 \begin_inset Quotes erd
1962 error—it means that there are errors in the preamble.
1963 Start debugging your preamble.
1966 \begin_layout Enumerate
1967 If you didn't add anything to the preamble and didn't add any LaTeX code
1968 to the document, the first suspect is your LaTeX distribution itself.
1969 Check for missing packages and install them.
1972 \begin_layout Enumerate
1973 Okay, so there are no missing packages.
1974 Did you use any of the fine-tuning options in LyX? Specifically, did you
1979 any of them, like trying to manually insert lots of
1980 \begin_inset Flex CharStyle:Code
1983 \begin_layout Plain Layout
1985 \begin_inset space ~
1994 \begin_inset Flex CharStyle:Code
1997 \begin_layout Plain Layout
2004 \begin_inset Flex CharStyle:Code
2007 \begin_layout Plain Layout
2013 ? Did you try to kludge something together with these instead of using the
2014 appropriate paragraph environment?
2017 \begin_layout Enumerate
2018 All right, you didn't use any of the fine-tuning options, you played by
2020 Did you try to pull a fancy maneuver? Did you do something funky inside
2021 a table or an equation, like inserting a graphic into a table cell?
2024 \begin_layout Enumerate
2025 Do you have long sections of text where LaTeX cannot find a place to break
2026 a line? By default, LaTeX is rather strict about how much extra inter-word
2027 spacing it will add in order to break a line.
2028 Preferably, you should rework the paragraph to avoid the problem.
2029 If this isn't an option, you can wrap your text in
2030 \begin_inset Flex CharStyle:Code
2033 \begin_layout Plain Layout
2041 to make LaTeX's line breaking more, well, sloppy.
2044 \begin_layout Enumerate
2045 Did you go overboard with the nesting? LyX (currently) doesn't check to
2046 make sure you're in the limits for nesting environments.
2047 If you nested a bunch of environments to the
2048 \begin_inset Formula $17^{\mathrm{th}}$
2051 level, that's the problem.
2052 (The limit in LaTeX is five.)
2055 \begin_layout Enumerate
2056 Okay, you didn't get any error messages, but your output looks awful.
2057 If you have a table or figure that's too wide or long for the page, you
2062 \begin_layout Enumerate
2063 rescale the figure so it fits.
2066 \begin_layout Enumerate
2067 trim down the table so it fits.
2071 \begin_layout Enumerate
2072 If something else is wrong with the output, and you didn't try to pull anything
2073 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2076 \begin_layout Standard
2077 If all this doesn't help—well, then
2081 you might have found a bug in LyX\SpecialChar \ldots{}
2085 \begin_layout Chapter
2089 \begin_layout Section
2090 Customizing Bibliographies with BibTeX
2093 \begin_layout Standard
2094 The basics how to use BibTeX are explained in section
2096 Bibliography databases (BibTeX)
2103 The following subsections explain special bibliography features supported
2107 \begin_layout Subsection
2108 Alternative Citation Styles
2111 \begin_layout Standard
2112 Standard BibTeX uses numbers (e.
2113 \begin_inset space \thinspace{}
2117 \begin_inset space \space{}
2121 \begin_inset Quotes eld
2125 \begin_inset Quotes erd
2128 ) to refer to a cited work.
2129 However, in many scientific disciplines, other citation styles are in use.
2130 The most common one is the author-year style (e.
2131 \begin_inset space \thinspace{}
2135 \begin_inset space \space{}
2139 \begin_inset Quotes eld
2143 \begin_inset Quotes erd
2147 LyX supports two packages that provide this style,
2148 \begin_inset Flex CharStyle:Code
2151 \begin_layout Plain Layout
2158 \begin_inset Flex CharStyle:Code
2161 \begin_layout Plain Layout
2168 Both packages have their pros and cons, which cannot be listed in detail.
2169 If you only want to have simple author-year (or author-numerical) style,
2170 or if you want to use one of the countless style files for
2171 \begin_inset Flex CharStyle:Code
2174 \begin_layout Plain Layout
2180 , than the established
2181 \begin_inset Flex CharStyle:Code
2184 \begin_layout Plain Layout
2190 package is probably your choice.
2191 If you need special features like short title references, ibidem etc., you
2193 \begin_inset Flex CharStyle:Code
2196 \begin_layout Plain Layout
2205 \begin_layout Standard
2206 The handling of both packages in LyX is basically the same.
2208 \begin_inset Flex CharStyle:MenuItem
2211 \begin_layout Plain Layout
2212 Document\SpecialChar \menuseparator
2219 \begin_inset Flex CharStyle:MenuItem
2222 \begin_layout Plain Layout
2229 \begin_inset Flex CharStyle:MenuItem
2232 \begin_layout Plain Layout
2239 \begin_inset Flex CharStyle:MenuItem
2242 \begin_layout Plain Layout
2249 With both packages, you will get some extra features in the citation dialog
2250 and you can select the style of the reference (
2251 \begin_inset Quotes eld
2255 \begin_inset Quotes erd
2259 \begin_inset Quotes eld
2263 \begin_inset Quotes erd
2267 \begin_inset Quotes eld
2271 \begin_inset Quotes erd
2275 \begin_inset Quotes eld
2279 \begin_inset Quotes erd
2283 Note that both packages need specifically designed style files.
2284 They both ship their own, but there are lots of additional style files,
2285 and there is even an interactive style file builder
2289 \begin_layout Plain Layout
2291 \begin_inset Flex URL
2294 \begin_layout Plain Layout
2296 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2307 \begin_inset Flex CharStyle:Code
2310 \begin_layout Plain Layout
2319 \begin_layout Subsection
2320 Sectioned Bibliographies
2323 \begin_layout Standard
2324 Sometimes you might need to divide your bibliography into several sections.
2325 If you are for instance a historian, the possibility to separate sources
2326 and scientific works is most likely a
2327 \begin_inset Quotes eld
2331 \begin_inset Quotes erd
2335 Unfortunately, BibTeX itself does not allow you to do this.
2336 But with the help of some LaTeX packages, BibTeX can be extended to fit
2340 \begin_layout Standard
2341 LyX provides native support for one of these packages,
2349 \begin_layout Plain Layout
2351 \begin_inset Flex URL
2354 \begin_layout Plain Layout
2356 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2366 The advantage of this package (compared to other packages like
2370 ) is that you don't need to define new citation commands.
2371 Instead, you need to prepare different bibliographic databases which include
2372 the entries for the different sections of the bibliography.
2373 For example: If you want to divide your bibliography into the sections
2375 \begin_inset Quotes eld
2379 \begin_inset Quotes erd
2383 \begin_inset Quotes eld
2387 \begin_inset Quotes erd
2390 , you first need to create two bibliographic databases, e.
2391 \begin_inset space \thinspace{}
2395 \begin_inset space \space{}
2399 \begin_inset Flex CharStyle:Code
2402 \begin_layout Plain Layout
2409 \begin_inset Flex CharStyle:Code
2412 \begin_layout Plain Layout
2422 \begin_layout Standard
2424 \begin_inset Flex CharStyle:MenuItem
2427 \begin_layout Plain Layout
2428 Document\SpecialChar \menuseparator
2435 \begin_inset Flex CharStyle:MenuItem
2438 \begin_layout Plain Layout
2445 \begin_inset Flex CharStyle:MenuItem
2448 \begin_layout Plain Layout
2449 Sectioned bibliography
2455 Now you can insert multiple BibTeX bibliographies, one for each section
2456 of your bibliography.
2457 Returning to our example: Insert the BibTeX bibliography
2458 \begin_inset Flex CharStyle:Code
2461 \begin_layout Plain Layout
2467 and a second one for the database
2468 \begin_inset Flex CharStyle:Code
2471 \begin_layout Plain Layout
2478 You are free to use the same or different styles for each section.
2479 Additionally, you can chose if the bibliography section should contain
2481 \begin_inset Quotes eld
2484 all cited references
2485 \begin_inset Quotes erd
2488 of the specified database(s) (which is the default),
2489 \begin_inset Quotes eld
2492 all uncited references
2493 \begin_inset Quotes erd
2497 \begin_inset Quotes eld
2501 \begin_inset Quotes erd
2505 This might be useful if you would like to separate your bibliography into
2507 \begin_inset Quotes eld
2511 \begin_inset Quotes erd
2515 \begin_inset Quotes eld
2519 \begin_inset Quotes erd
2523 \begin_inset Quotes eld
2527 \begin_inset Quotes erd
2531 The titles for the sections can be added as ordinary sections or subsections.
2533 \begin_inset Flex CharStyle:Code
2536 \begin_layout Plain Layout
2542 removes the bibliography title, you have manually re-add that, too (as
2543 a chapter* or section*, for instance).
2546 \begin_layout Subsection
2547 Multiple Bibliographies
2550 \begin_layout Standard
2551 Multiple bibliographies, e.
2552 \begin_inset space \thinspace{}
2556 \begin_inset space \space{}
2559 a bibliography for each section or chapter of the document, are not supported
2562 \begin_inset Flex CharStyle:Code
2565 \begin_layout Plain Layout
2571 package, which is used for the creation of sectioned bibliographies in
2572 LyX (see the previous section), provides an easy way to solve this task,
2573 if you are willing to use some
2574 \begin_inset Flex CharStyle:MenuItem
2577 \begin_layout Plain Layout
2584 \begin_inset space ~
2588 \begin_inset CommandInset ref
2590 reference "sec:Inserting-TeX-Code"
2598 \begin_layout Plain Layout
2599 An alternative approach is to use the
2600 \begin_inset Flex CharStyle:Code
2603 \begin_layout Plain Layout
2610 \begin_inset Flex CharStyle:Code
2613 \begin_layout Plain Layout
2619 package, respectively.
2627 \begin_layout Standard
2629 \begin_inset Flex CharStyle:MenuItem
2632 \begin_layout Plain Layout
2633 Document\SpecialChar \menuseparator
2640 \begin_inset Flex CharStyle:MenuItem
2643 \begin_layout Plain Layout
2650 \begin_inset Flex CharStyle:MenuItem
2653 \begin_layout Plain Layout
2654 Sectioned bibliography
2660 In the document, you have to enclose the sections, which shall contain
2661 their own bibliography (including the BibTeX bibliography itself), between
2663 \begin_inset Flex CharStyle:Code
2666 \begin_layout Plain Layout
2675 \begin_inset Flex CharStyle:Code
2678 \begin_layout Plain Layout
2686 (those commands have to be inserted as TeX code).
2687 The bibliography will contain all references which have been cited in the
2689 \begin_inset Flex CharStyle:Code
2692 \begin_layout Plain Layout
2703 If you are using this approach, then every citation reference has to be
2705 \begin_inset Flex CharStyle:Code
2708 \begin_layout Plain Layout
2716 \begin_inset Flex CharStyle:Code
2719 \begin_layout Plain Layout
2728 \begin_layout Section
2732 \begin_layout Subsection
2736 \begin_layout Standard
2737 When you are working on a large file with many sections, it is often convenient
2738 to break up the document into several files, or perhaps you have something
2739 where a table may change from time to time, but the preceding text does
2741 In these cases, you should seriously consider using multipart documents.
2742 For example, scientific papers often have five major sections: the introduction
2743 , observations, results, discussion, and conclusion.
2744 Each of these could be its own separate LyX file, with one
2745 \begin_inset Quotes eld
2749 \begin_inset Quotes erd
2752 file which contains the title, authors, abstract, references, etc., plus
2753 the five included files.
2754 It is important to note that each of these files is a full LyX file which
2755 can be formatted and printed on its own, as well as included in a master
2757 Each of these files must have the same document class, however—don't attempt
2758 to mix book classes with article classes.
2759 You may also include LaTeX files; however, these files must not have their
2761 \begin_inset space \thinspace{}
2765 \begin_inset space \space{}
2768 everything up to and including the
2769 \begin_inset Flex CharStyle:Code
2772 \begin_layout Plain Layout
2781 \begin_inset Flex CharStyle:Code
2784 \begin_layout Plain Layout
2792 line must be deleted) or else errors will be generated when you try to
2796 \begin_layout Standard
2797 LyX allows you to include files quite easily with
2798 \begin_inset Flex CharStyle:MenuItem
2801 \begin_layout Plain Layout
2802 Insert\SpecialChar \menuseparator
2804 \begin_inset space ~
2813 When you click on this selection a small box is inserted into the file
2814 at the current cursor location.
2815 Clicking on the box raises a dialog which allows you to select the file
2816 to be included, and the method of its inclusion.
2820 \begin_layout Standard
2821 The file selection box should by now be obvious.
2822 The three inclusion methods are
2823 \begin_inset Quotes eld
2827 \begin_inset Quotes erd
2831 \begin_inset Quotes eld
2835 \begin_inset Quotes erd
2839 \begin_inset Quotes eld
2843 \begin_inset Quotes erd
2847 The difference between
2848 \begin_inset Quotes eld
2852 \begin_inset Quotes erd
2856 \begin_inset Quotes eld
2860 \begin_inset Quotes erd
2863 is really only meaningful to LaTeXperts, but the practical difference is
2864 that files which are
2865 \begin_inset Quotes eld
2869 \begin_inset Quotes erd
2872 are typeset beginning on a new page, while files which are
2873 \begin_inset Quotes eld
2877 \begin_inset Quotes erd
2880 are typeset starting on the current page.
2883 \begin_layout Standard
2884 Generally, the master file is converted into a full LaTeX file before typesettin
2885 g, while the included files are converted to LaTeX files which do not have
2886 all the preamble information.
2889 \begin_layout Standard
2891 \begin_inset Quotes eld
2895 \begin_inset Quotes erd
2898 included file allows you to include a file typeset exactly as it appears
2900 \begin_inset space \thinspace{}
2904 \begin_inset space \space{}
2908 \begin_inset Flex CharStyle:Code
2911 \begin_layout Plain Layout
2917 mode, with the characters set in a fixed-width typewriter font.
2918 Normally, spaces in this file are invisible, though two consecutive spaces
2919 are conserved, unlike LyX's normal treatment of spaces.
2920 However, setting the
2921 \begin_inset Flex CharStyle:MenuItem
2924 \begin_layout Plain Layout
2926 \begin_inset space ~
2930 \begin_inset space ~
2934 \begin_inset space ~
2942 checkbox typesets a mark to unambiguously define the presence of a space.
2946 \begin_layout Subsection
2947 Cross-References Between Files
2950 \begin_layout Standard
2951 \begin_inset Box Shadowbox
2960 height_special "totalheight"
2963 \begin_layout Plain Layout
2964 This section is somewhat out of date.
2965 Need to describe default master documents and how children are opened when
2975 \begin_layout Standard
2976 It is possible to set up cross-references between the different files.
2977 First, open all the files in question: let's call them A and B in a two
2978 file example, where B is included in A.
2979 Let's say you insert a label in A, then want to reference it in B.
2980 Open the cross-reference dialog in whilst in document B, and you can select
2982 \begin_inset Quotes eld
2986 \begin_inset Quotes erd
2992 \begin_layout Subsection
2993 Bibliography Lists in all Subdocuments
2996 \begin_layout Standard
2997 \begin_inset Box Frameless
3006 height_special "totalheight"
3009 \begin_layout Plain Layout
3010 This section also needs updating.
3011 There is now material about this on the wiki, and it could be copied here.
3019 \begin_layout Standard
3020 Copy the bibliography list with all entries to all subdocuments and transform
3022 This way LyX will find the
3023 \begin_inset Flex CharStyle:Code
3026 \begin_layout Plain Layout
3032 -files and you can easily insert references without making the bibliography
3036 \begin_layout Standard
3037 As the bibliography list is in a comment, LaTeX won't use use it and the
3038 references will look like this: [?], instead of like this: [1].
3039 One solution is to use the LaTeX-package
3040 \begin_inset Flex CharStyle:Code
3043 \begin_layout Plain Layout
3049 that will only include comments by processing the files separately.
3050 To do this, add in the LaTeX preamble of every subdocument the following:
3053 \begin_layout LyX-Code
3059 \begin_layout LyX-Code
3062 includecomment{comment}
3065 \begin_layout Standard
3067 \begin_inset Flex URL
3070 \begin_layout Plain Layout
3072 http://wiki.lyx.org/FAQ/Unsorted#toc31
3080 \begin_layout Section
3081 Fancy Headers and Footers
3084 \begin_layout Standard
3085 The default page layout is rather plain; for an
3086 \begin_inset Flex CharStyle:Code
3089 \begin_layout Plain Layout
3095 document class, all you get is a centered page number at the bottom of
3097 This document uses KOMA-script's book class, so it appears to be a bit
3099 But to really put on a show, you need to set the document page style to
3101 \begin_inset Quotes eld
3105 \begin_inset Quotes erd
3108 , as mentioned in the
3113 This section describes the LaTeX code you need to insert in your LaTeX
3114 preamble in order to get the desired effects.
3117 \begin_layout Standard
3118 For more information on fancy headers, see the
3119 \begin_inset Flex CharStyle:Code
3122 \begin_layout Plain Layout
3128 package documentation.
3129 This can be found in the file
3130 \begin_inset Flex CharStyle:Code
3133 \begin_layout Plain Layout
3139 , which should have been installed with your LaTeX distribution, or
3140 \begin_inset CommandInset href
3143 target "http://www.ctan.org/tex-archive/macros/latex/contrib/fancyhdr/"
3150 \begin_layout Standard
3151 The page header is divided into three fields, not surprisingly labeled
3152 \begin_inset Quotes eld
3156 \begin_inset Quotes erd
3160 \begin_inset Quotes eld
3164 \begin_inset Quotes erd
3168 \begin_inset Quotes eld
3172 \begin_inset Quotes erd
3176 The footer is also divided into these three fields.
3177 The LaTeX commands to set these fields in the simplest manner are
3178 \begin_inset Flex CharStyle:Code
3181 \begin_layout Plain Layout
3190 \begin_inset Flex CharStyle:Code
3193 \begin_layout Plain Layout
3202 \begin_inset Flex CharStyle:Code
3205 \begin_layout Plain Layout
3214 \begin_inset Flex CharStyle:Code
3217 \begin_layout Plain Layout
3226 Suppose you wish to put your name in the upper left hand corner of each
3228 Simply insert the following command in the preamble:
3231 \begin_layout Standard
3240 \begin_layout Standard
3241 You will now see your name in the upper left.
3242 If a field has a default entry that you would like to get rid of (often
3243 the page number appears in the central footer, simply include a command
3244 with a blank argument, e.
3245 \begin_inset space \thinspace{}
3251 \begin_layout Standard
3259 \begin_layout Standard
3260 Let's get really fancy: lets put the section number with the word
3261 \begin_inset Quotes eld
3265 \begin_inset Quotes erd
3269 \begin_inset space \thinspace{}
3273 \begin_inset space \space{}
3276 Section 3) in the upper left, the page number (e.
3277 \begin_inset space \thinspace{}
3281 \begin_inset space \space{}
3284 Page 4) in the upper right, your name in the lower left, and the date in
3286 The following commands should now appear in the preamble:
3289 \begin_layout Standard
3299 \begin_layout Standard
3307 \begin_layout Standard
3317 \begin_layout Standard
3326 \begin_layout Standard
3334 \begin_layout Standard
3344 \begin_layout Standard
3346 \begin_inset Flex CharStyle:Code
3349 \begin_layout Plain Layout
3358 \begin_inset Flex CharStyle:Code
3361 \begin_layout Plain Layout
3369 access LaTeX's section and page counters, and so print out the current
3370 section and page numbers.
3372 \begin_inset Flex CharStyle:Code
3375 \begin_layout Plain Layout
3383 simply prints out today's date.
3386 \begin_layout Standard
3387 The thicknesses of the horizontal rules drawn beneath the header and above
3388 the footer can also be modified.
3389 If you don't want one of the rules, set its thickness to 0.
3390 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3396 \begin_inset Flex CharStyle:Code
3399 \begin_layout Plain Layout
3404 headrulewidth}{0.4pt}
3410 \begin_inset Flex CharStyle:Code
3413 \begin_layout Plain Layout
3418 footrulewidth}{0.4pt}
3423 to set the thicknesses.
3426 \begin_layout Standard
3427 You can switch the header/footer settings on and off for individual pages
3429 \begin_inset Flex CharStyle:Code
3432 \begin_layout Plain Layout
3435 thispagestyle{empty}
3441 \begin_inset Flex CharStyle:Code
3444 \begin_layout Plain Layout
3447 thispagestyle{plain}
3453 \begin_inset Flex CharStyle:Code
3456 \begin_layout Plain Layout
3459 thispagestyle{fancy}
3465 Simply insert them in the text on the page you want changed and mark them
3467 In fact, title pages are marked as plain by default, while following pages
3468 are marked fancy when using the global fancy setting.
3471 \begin_layout Standard
3472 As a final example, it is possible to include an image in the header or
3474 Suppose you want to put a company logo in the upper lefthand corner.
3475 You might try something like
3478 \begin_layout Standard
3487 includegraphics{logo.eps}}}
3490 \begin_layout Standard
3492 (you may need to preface this with
3493 \begin_inset Flex CharStyle:Code
3496 \begin_layout Plain Layout
3500 usepackage{graphics}
3505 if you don't include graphics elsewhere in your document).
3508 \begin_layout Section
3509 Itemize Bullet Selection
3510 \begin_inset CommandInset label
3519 \begin_layout Standard
3525 \begin_layout Subsection
3529 \begin_layout Standard
3530 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3531 Using this dialog you can easily specify what bullet shape to use at each
3532 level of an itemized list.
3533 These settings are document-wide so you won't be able to specify different
3534 sets of bullets for different paragraphs.
3538 \begin_layout Plain Layout
3539 Well, actually you can but you'll have to do it by hand.
3547 \begin_layout Subsection
3551 \begin_layout Standard
3552 Open the dialog by selecting the
3553 \begin_inset Flex CharStyle:MenuItem
3556 \begin_layout Plain Layout
3557 Document\SpecialChar \menuseparator
3563 menu item and then select the
3564 \begin_inset Flex CharStyle:MenuItem
3567 \begin_layout Plain Layout
3576 \begin_layout Standard
3577 The dialog provides you with a table of bullet shapes.
3578 A column of buttons on the left of the table provides access to the six
3579 different panels of bullet shapes.
3580 The row of buttons across the top is used to select which bullet depth
3582 A text entry under the table shows the currently selected bullet shape's
3583 LaTeX equivalent and this can be edited if desired.
3584 If you do modify the text you will also need to specify any needed packages
3585 in the LaTeX preamble.
3588 \begin_layout Standard
3589 The six panels are divided up by the packages they require.
3590 The following table shows the mappings from button name to LaTeX packages.
3593 \begin_layout Standard
3595 \begin_inset Tabular
3596 <lyxtabular version="3" rows="7" columns="2">
3597 <features tabularvalignment="middle">
3598 <column alignment="center" valignment="top" width="0pt">
3599 <column alignment="center" valignment="top" width="0pt">
3601 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3604 \begin_layout Plain Layout
3619 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3622 \begin_layout Plain Layout
3639 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3642 \begin_layout Plain Layout
3657 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3660 \begin_layout Plain Layout
3676 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3679 \begin_layout Plain Layout
3694 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3697 \begin_layout Plain Layout
3714 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3717 \begin_layout Plain Layout
3732 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3735 \begin_layout Plain Layout
3752 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3755 \begin_layout Plain Layout
3770 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3773 \begin_layout Plain Layout
3790 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3793 \begin_layout Plain Layout
3808 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3811 \begin_layout Plain Layout
3828 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3831 \begin_layout Plain Layout
3846 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3849 \begin_layout Plain Layout
3872 \begin_layout Standard
3873 LyX doesn't stop you using bullets from packages you don't have.
3874 If you get errors from LaTeX when you try to view or print the file, then
3875 it is likely you are missing a package.
3879 \begin_layout Plain Layout
3880 LyX doesn't restrict your use since you may be editing locally and exporting
3889 \begin_layout Subsection
3893 \begin_layout Standard
3894 Select which bullet depth you want to change then select the bullet shape
3896 Any changes will not be visible in LyX, but are visible when viewing the
3900 \begin_layout Standard
3901 You can reset a bullet shape to the default simply by clicking your right
3902 mouse button on the appropriate bullet depth button.
3906 \begin_layout Plain Layout
3911 want to have multiple sets of paragraphs with different sets of bullets
3912 in each, then you're going to have to get your hands dirty with TeX code.
3913 The bullet selection dialog can help though because it provides you with
3914 the LaTeX code for a wide range of bullet shapes.
3915 To make your own custom paragraphs you have the following options:
3918 \begin_layout Plain Layout
3922 \begin_layout Plain Layout
3938 \begin_layout Plain Layout
3942 \begin_layout Plain Layout
3964 \begin_layout Itemize
3965 Use the LaTeX command
3966 \begin_inset Flex CharStyle:Code
3969 \begin_layout Plain Layout
3977 to specify a new bullet shape for a given depth.
3978 You'll also need to save the current bullet shape so you can restore it
3980 In this itemized list the following LaTeX code was used to change the bullet
3981 used for the first depth.
3985 \begin_layout LyX-Code
3995 \begin_layout LyX-Code
4012 \begin_layout Itemize
4013 Note that the itemize depth is specified in Roman numerals as part of the
4023 \begin_layout Itemize
4027 \begin_layout Plain Layout
4040 Specify each individual entry by starting each item with the bullet shape
4041 enclosed in square brackets and set as
4042 \begin_inset Flex CharStyle:MenuItem
4045 \begin_layout Plain Layout
4052 For example, this item was started with
4053 \begin_inset Flex CharStyle:Code
4056 \begin_layout Plain Layout
4071 \begin_layout Plain Layout
4075 \begin_layout Plain Layout
4091 \begin_layout Plain Layout
4092 You'll also need to revert the labelitem back to its previous setting for
4093 the global bullet shape settings to remain in effect.
4094 The way used here was:
4097 \begin_layout LyX-Code
4112 \begin_layout Chapter
4116 \begin_layout Section
4120 \begin_layout Standard
4121 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
4122 and retrieve information about the LyX internal state.
4123 This is only intended for advanced users, but they should find it useful.
4124 It is by writing to the LyX server, for example, that bibliography managers,
4125 such as JabRef, are able to
4126 \begin_inset Quotes eld
4130 \begin_inset Quotes erd
4136 \begin_layout Standard
4137 Please note that, at present,
4139 the server does not work natively on Windows
4145 \begin_layout Plain Layout
4146 There is no reason it cannot do so.
4147 But none of the developers on Windows have yet implemented this functionality
4153 but it does work with Cygwin versions of LyX.
4156 \begin_layout Section
4157 Starting the LyX Server
4160 \begin_layout Standard
4161 The LyX server works through the use of a pair of named pipes.
4162 These are usually located in
4163 \begin_inset Flex CharStyle:Code
4166 \begin_layout Plain Layout
4173 \begin_inset Quotes eld
4177 \begin_inset Flex CharStyle:Code
4180 \begin_layout Plain Layout
4187 \begin_inset Quotes erd
4191 \begin_inset Quotes eld
4195 \begin_inset Flex CharStyle:Code
4198 \begin_layout Plain Layout
4205 \begin_inset Quotes erd
4209 External programs write into
4210 \begin_inset Flex CharStyle:Code
4213 \begin_layout Plain Layout
4219 and read back data from
4220 \begin_inset Flex CharStyle:Code
4223 \begin_layout Plain Layout
4230 The stem of the pipe names can be defined in the
4231 \begin_inset Flex CharStyle:MenuItem
4234 \begin_layout Plain Layout
4235 Tools\SpecialChar \menuseparator
4242 \begin_inset Flex CharStyle:Code
4245 \begin_layout Plain Layout
4246 "/home/myhome/lyxpipe"
4256 configure this manually in order for the server to start.
4259 \begin_layout Standard
4261 \begin_inset Flex CharStyle:Code
4264 \begin_layout Plain Layout
4271 \begin_inset Flex CharStyle:Code
4274 \begin_layout Plain Layout
4280 ' to create the pipes.
4281 If one of the pipes already exists, LyX will assume that another LyX process
4282 is already running and will not start the server.
4283 If for some other reason, an unused
4284 \begin_inset Quotes eld
4288 \begin_inset Quotes erd
4291 pipe is left in existence when LyX closes, then LyX will try to delete
4293 If this fails for some reason, you will need to delete the pipes manually
4294 and then restart LyX.
4297 \begin_layout Standard
4298 To have several LyX processes with servers at the same time, you have to
4299 use different configurations, perhaps by using separate user directories,
4301 \begin_inset Flex CharStyle:Code
4304 \begin_layout Plain Layout
4310 file, for each process.
4313 \begin_layout Standard
4314 If you are developing a client program, you might find it useful to enable
4315 debugging information from the LyX server.
4316 Do this by starting LyX as
4317 \begin_inset Flex CharStyle:Code
4320 \begin_layout Plain Layout
4329 \begin_layout Standard
4330 You can find a complete example client written in C in the source distribution
4332 \begin_inset Flex CharStyle:Code
4335 \begin_layout Plain Layout
4336 development/lyxserver/server_monitor.c
4344 \begin_layout Standard
4345 Another useful tool is command-line based client you will find in
4346 \begin_inset Flex CharStyle:Code
4349 \begin_layout Plain Layout
4350 src/client/lyxclient
4358 \begin_layout Section
4359 Normal communication
4362 \begin_layout Standard
4363 To issue a LyX call, the client writes a line of ASCII text into the input
4365 This line has the following format:
4382 \begin_layout Description
4383 clientname is a name that the client can choose arbitrarily.
4384 Its only use is that LyX will echo it if it sends an answer—so a client
4385 can dispatch results from different requesters.
4388 \begin_layout Description
4389 function is the function you want LyX to perform.
4390 It is the same as the commands you'd use in the minibuffer.
4393 \begin_layout Description
4394 argument is an optional argument which is meaningful only to some functions
4396 \begin_inset Quotes eld
4400 \begin_inset Quotes erd
4403 LFUN will insert the argument as text at the cursor position).
4406 \begin_layout Standard
4407 The answer from LyX will arrive in the output pipe and be of the form
4424 \begin_layout Standard
4433 are just echoed from the command request, while
4437 is more or less useful information filled according to how the command
4438 execution worked out.
4439 Some commands, such as
4440 \begin_inset Quotes eld
4444 \begin_inset Quotes erd
4447 , will return information about the internal state of LyX, while other will
4448 return an empty data-response.
4449 This means that the command execution went fine.
4452 \begin_layout Standard
4453 In case of errors, the response from LyX will have this form
4470 \begin_layout Standard
4475 should contain an explanation of why the command failed.
4478 \begin_layout Standard
4482 \begin_layout LyX-Code
4483 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
4484 \begin_inset Newline newline
4487 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
4488 \begin_inset Newline newline
4491 read a <~/.lyxpipe.out
4492 \begin_inset Newline newline
4498 \begin_layout Section
4502 \begin_layout Standard
4503 LyX can notify clients of events going on asynchronously.
4504 Currently it will only do this if the user binds a key sequence with the
4506 \begin_inset Quotes eld
4510 \begin_inset Quotes erd
4514 The format of the string LyX sends is as follows:
4518 \begin_inset Flex CharStyle:Code
4521 \begin_layout Plain Layout
4532 \begin_layout Standard
4537 is the printed representation of the key sequence that was actually typed
4541 \begin_layout Standard
4542 This mechanism can be used to extend LyX's command set and implement macros.
4543 Bind some key sequence to
4544 \begin_inset Quotes eld
4548 \begin_inset Quotes erd
4552 Then start a client that listens on the output pipe, dispatches the command
4553 according to the sequence, and starts a function that may use LyX calls
4554 and LyX requests to issue a command or a series of commands to LyX.
4557 \begin_layout Section
4558 The simple LyX Server Protocol
4561 \begin_layout Standard
4562 LyX implements a simple protocol that can be used for session management.
4563 All messages are of the form
4576 \begin_layout Standard
4582 \begin_inset Quotes eld
4586 \begin_inset Quotes erd
4590 \begin_inset Quotes eld
4594 \begin_inset Quotes erd
4599 \begin_inset Quotes eld
4603 \begin_inset Quotes erd
4606 is received from a client, LyX will report back to inform the client that
4607 it's listening to it's messages, while
4608 \begin_inset Quotes eld
4612 \begin_inset Quotes erd
4615 sent from LyX will inform clients that LyX is closing.
4618 \begin_layout Section
4619 Reverse DVI/PDF search
4622 \begin_layout Standard
4623 Some DVI/PDF viewers
4627 \begin_layout Plain Layout
4628 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
4629 Skim on Mac OSX and SumatraPDF on Windows.
4638 facility (also called
4643 This means that you can tell LyX to put the cursor to a specific line in
4644 the document by clicking at the respective position in the DVI/PDF output.
4645 To achieve this, the viewer must be able to communicate with LyX.
4646 This is done via the LyX server either by using the named pipe (
4650 ), or the UNIX domain socket (
4654 ) that LyX creates in its temporary directory (this is the way the
4655 \begin_inset Flex CharStyle:Code
4658 \begin_layout Plain Layout
4664 program communicates with LyX).
4665 In some cases, you need a helper script that mediates between the viewer
4666 and LyX, in others, the viewer can communicate with LyX directly.
4667 This depends on the selected viewer and on your operating system.
4668 The same applies to the way viewers need to be configured and the way the
4669 reverse search is actually performed.
4670 In what follows, we will thus describe how to setup reverse search for
4672 Before we turn to this, though, we will explain what needs to be done generally
4673 to enable reverse search in the DVI/PDF output.
4676 \begin_layout Subsection
4677 Enabling reverse search
4680 \begin_layout Standard
4681 LaTeX provides several different methods for reverse search.
4682 Some are built-in in the
4683 \begin_inset Flex CharStyle:Code
4686 \begin_layout Plain Layout
4692 program, some are provided by external packages.
4693 Your choice depends on whether your LaTeX distribution already provides
4694 a given method (the built-in methods are rather new) and whether your viewer
4696 The available methods are described in the following.
4699 \begin_layout Subsubsection*
4700 Built-in DVI-search via src-specials (DVI only)
4703 \begin_layout Standard
4704 This method provides the DVI file with the necessary information for reverse
4706 It is available in LaTeX since quite some time (any somewhat recent LaTeX
4707 distribution should include it), and it works reliably.
4708 To enable it, change the
4709 \begin_inset Flex CharStyle:MenuItem
4712 \begin_layout Plain Layout
4717 \begin_layout Plain Layout
4730 \begin_inset Flex CharStyle:MenuItem
4733 \begin_layout Plain Layout
4738 \begin_layout Plain Layout
4745 eX (plain)->DraftDVI
4751 \begin_inset Flex CharStyle:MenuItem
4754 \begin_layout Plain Layout
4755 Preferences\SpecialChar \menuseparator
4756 File Handling\SpecialChar \menuseparator
4763 \begin_inset Flex CharStyle:Code
4766 \begin_layout Plain Layout
4767 latex -src-specials $$i
4773 If this doesn't work, check if your TeX engine needs different options
4774 (the syntax might differ in some distributions).
4777 \begin_layout Subsubsection*
4778 External Packages (PDFSync and scrltx)
4781 \begin_layout Standard
4790 provide reverse search facility for PDF output (via pdflatex) and DVI output,
4792 In order to enable it, load the packages in the LyX preamble:
4795 \begin_layout Itemize
4796 \begin_inset Flex CharStyle:Code
4799 \begin_layout Plain Layout
4807 for reverse PDF search,
4810 \begin_layout Itemize
4812 \begin_inset Flex CharStyle:Code
4815 \begin_layout Plain Layout
4818 usepackage[active]{srcltx}
4823 for reverse DVI search.
4826 \begin_layout Standard
4827 If you want to be able to perform both DVI and PDF reverse searches, you
4828 can also insert in the preamble the following lines
4831 \begin_layout LyX-Code
4835 \begin_inset Newline newline
4841 \begin_inset Newline newline
4847 \begin_inset Newline newline
4853 \begin_inset Newline newline
4858 usepackage[active]{srcltx}
4859 \begin_inset Newline newline
4867 \begin_layout Standard
4868 This way, you can preview the file as either DVI or PDF (pdflatex) and the
4869 right package will be used.
4872 \begin_layout Standard
4873 Note that PDFSync might affect the output layout of your document.
4874 It is therefore advised to disable PDFsync for final documents.
4877 \begin_layout Subsubsection*
4878 Built-in reverse search via SyncTeX (DVI and PDF)
4881 \begin_layout Standard
4883 \begin_inset Flex CharStyle:Code
4886 \begin_layout Plain Layout
4892 have built-in support for both PDF and DVI reverse search.
4897 facility is basically the result of the integration of the PDFSync package
4898 to the pdftex program and its merge with the
4903 You need at least TeXLive 2008 or a recent MikTeX distribution in order
4905 Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
4906 already provide SyncTeX support.
4909 \begin_layout Standard
4910 To enable SyncTeX for DVI output, change the
4911 \begin_inset Flex CharStyle:MenuItem
4914 \begin_layout Plain Layout
4919 \begin_layout Plain Layout
4932 \begin_inset Flex CharStyle:MenuItem
4935 \begin_layout Plain Layout
4940 \begin_layout Plain Layout
4947 eX (plain) -> DraftDVI
4953 \begin_inset Flex CharStyle:MenuItem
4956 \begin_layout Plain Layout
4957 Preferences\SpecialChar \menuseparator
4958 File Handling\SpecialChar \menuseparator
4965 \begin_inset Flex CharStyle:Code
4968 \begin_layout Plain Layout
4969 latex -synctex=1 $$i
4974 , and for PDF output, change the
4975 \begin_inset Flex CharStyle:MenuItem
4978 \begin_layout Plain Layout
4983 \begin_layout Plain Layout
4990 eX (pdflatex) -> PDF (pdflatex)
4996 \begin_inset Flex CharStyle:Code
4999 \begin_layout Plain Layout
5000 pdflatex -synctex=1 $$i
5006 Check the documentation of your viewer whether the viewer needs to be configure
5007 d for the use with SyncTeX.
5011 \begin_layout Plain Layout
5013 \begin_inset Flex CharStyle:Code
5016 \begin_layout Plain Layout
5022 option enables gzip compression.
5023 If your viewer does not support it, you should instead use
5024 \begin_inset Flex CharStyle:Code
5027 \begin_layout Plain Layout
5041 \begin_layout Subsection
5042 Configuring and using specific viewers
5045 \begin_layout Subsubsection*
5046 Xdvi (all platforms)
5049 \begin_layout Standard
5051 \begin_inset Flex CharStyle:Code
5054 \begin_layout Plain Layout
5060 , you don't need to do anything else for performing a reverse DVI search,
5061 as LyX already provides the necessary hooks for automatically using the
5063 \begin_inset Flex CharStyle:Code
5066 \begin_layout Plain Layout
5073 Just setup your document as described above (reverse search is triggered
5074 by Ctrl-click or Alt-click on Mac OSX, respectively).
5077 \begin_layout Standard
5078 However, if for whatever reason you want to use the named pipe instead of
5079 the socket for communicating with LyX, simply change the DVI viewer in
5081 \begin_inset Flex CharStyle:MenuItem
5084 \begin_layout Plain Layout
5085 Preferences\SpecialChar \menuseparator
5086 File Handling\SpecialChar \menuseparator
5096 \begin_layout Plain Layout
5097 On Mac OSX you have to use
5098 \begin_inset Flex CharStyle:Code
5101 \begin_layout Plain Layout
5102 DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
5113 \begin_inset Flex CharStyle:Code
5116 \begin_layout Plain Layout
5117 xdvi -editor 'lyxeditor.sh %f %l'
5123 \begin_inset Flex CharStyle:Code
5126 \begin_layout Plain Layout
5132 is a suitable script.
5133 For example, a minimal shell script is the following one:
5136 \begin_layout LyX-Code
5138 \begin_inset Newline newline
5141 LYXPIPE="/path/to/lyxpipe"
5142 \begin_inset Newline newline
5145 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
5146 \begin_inset Newline newline
5149 echo "$COMMAND" > "${LYXPIPE}".in || exit
5150 \begin_inset Newline newline
5153 read < "${LYXPIPE}".out || exit
5156 \begin_layout Standard
5158 \begin_inset Flex CharStyle:Code
5161 \begin_layout Plain Layout
5171 \begin_layout Plain Layout
5178 XServer pipe path specified in
5179 \begin_inset Flex CharStyle:MenuItem
5182 \begin_layout Plain Layout
5183 Preferences\SpecialChar \menuseparator
5193 \begin_layout Plain Layout
5195 \begin_inset Flex CharStyle:Code
5198 \begin_layout Plain Layout
5204 folder of a source distribution you can find a
5205 \begin_inset Flex CharStyle:Code
5208 \begin_layout Plain Layout
5214 script which is able to locate the
5218 based on your preferences.
5226 \begin_layout Subsubsection*
5230 \begin_layout Standard
5232 \begin_inset Flex CharStyle:Code
5235 \begin_layout Plain Layout
5236 /Applications/MacDviX_Folder/calleditor.script
5241 , add the following lines:
5244 \begin_layout LyX-Code
5249 \begin_layout Plain Layout
5256 X.app/Contents/MacOS/lyxeditor "$2" $1
5257 \begin_inset Newline newline
5263 \begin_layout Standard
5264 Modify the lines accordingly if you install LyX somewhere else than in the
5265 Applications folder.
5268 \begin_layout Standard
5269 Reverse search is triggered by Alt-click (OPTION-click).
5272 \begin_layout Subsubsection*
5276 \begin_layout Standard
5278 \begin_inset Flex CharStyle:Code
5281 \begin_layout Plain Layout
5282 open -a Skim.app $$i
5287 to the viewer setting in
5288 \begin_inset Flex CharStyle:MenuItem
5291 \begin_layout Plain Layout
5292 Preferences\SpecialChar \menuseparator
5293 File Handling\SpecialChar \menuseparator
5294 File formats\SpecialChar \menuseparator
5301 \begin_inset Flex CharStyle:MenuItem
5304 \begin_layout Plain Layout
5305 Skim\SpecialChar \menuseparator
5306 Preferences\SpecialChar \menuseparator
5316 \begin_layout Plain Layout
5326 \begin_layout Standard
5327 Reverse search is triggered by COMMAND-SHIFT-click
5330 \begin_layout Subsubsection*
5334 \begin_layout Standard
5336 \begin_inset Flex CharStyle:MenuItem
5339 \begin_layout Plain Layout
5340 Settings\SpecialChar \menuseparator
5341 Configure Okular\SpecialChar \ldots{}
5342 \SpecialChar \menuseparator
5349 \begin_inset Quotes eld
5353 \begin_inset Quotes erd
5357 \begin_inset Flex CharStyle:Code
5360 \begin_layout Plain Layout
5369 \begin_layout Standard
5370 Reverse search is triggered by SHIFT-click.
5373 \begin_layout Subsubsection*
5377 \begin_layout Standard
5378 Launch yap, choose its
5379 \begin_inset Flex CharStyle:MenuItem
5382 \begin_layout Plain Layout
5383 View\SpecialChar \menuseparator
5390 \begin_inset Quotes eld
5394 \begin_inset Quotes erd
5399 \begin_inset Quotes eld
5402 New\SpecialChar \ldots{}
5404 \begin_inset Quotes erd
5407 button and, in the window that opens, enter
5408 \begin_inset Quotes eld
5412 \begin_inset Quotes erd
5415 (or any other name you like) in the
5416 \begin_inset Quotes eld
5420 \begin_inset Quotes erd
5424 Now click on the button labeled
5425 \begin_inset Quotes eld
5428 \SpecialChar \ldots{}
5430 \begin_inset Quotes erd
5433 to open a file dialog and navigate to the directory containing the batch
5435 \begin_inset Flex CharStyle:Code
5438 \begin_layout Plain Layout
5446 \begin_inset Flex CharStyle:Code
5449 \begin_layout Plain Layout
5455 and then specify the program arguments as
5456 \begin_inset Flex CharStyle:Code
5459 \begin_layout Plain Layout
5465 if you want to use the shell script above, or as
5466 \begin_inset Flex CharStyle:Code
5469 \begin_layout Plain Layout
5475 if you want to use the
5476 \begin_inset Flex CharStyle:Code
5479 \begin_layout Plain Layout
5486 Since yap is a native Windows application, the filename it provides should
5487 be converted to POSIX style before being passed to
5488 \begin_inset Flex CharStyle:Code
5491 \begin_layout Plain Layout
5498 \begin_inset Flex CharStyle:Code
5501 \begin_layout Plain Layout
5507 , and this is the purpose of the
5508 \begin_inset Flex CharStyle:Code
5511 \begin_layout Plain Layout
5517 wrapper, which is as follows:
5520 \begin_layout LyX-Code
5522 \begin_inset Newline newline
5525 if "%1" == "-g" goto lyxclient
5526 \begin_inset Newline newline
5529 bash -c 'lyxeditor.sh $(cygpath -a "%1") %2'
5530 \begin_inset Newline newline
5534 \begin_inset Newline newline
5538 \begin_inset Newline newline
5541 bash -c 'lyxclient %1 $(cygpath -a "%2") %3'
5544 \begin_layout Standard
5545 You have to make sure that both
5546 \begin_inset Flex CharStyle:Code
5549 \begin_layout Plain Layout
5556 \begin_inset Flex CharStyle:Code
5559 \begin_layout Plain Layout
5565 are in the command PATH, otherwise you have to use their full posix path
5566 in the above batch file.
5569 \begin_layout Standard
5570 In yap, reverse search is triggered by double-click.
5573 \begin_layout Subsubsection*
5577 \begin_layout Standard
5578 In SumatraPDF, you can set the name of the program that communicates with
5579 LyX by simply launching SumatraPDF as
5580 \begin_inset Flex CharStyle:Code
5583 \begin_layout Plain Layout
5584 SumatraPDF -inverse-search "lyxeditor.bat -g %f %l"
5590 The program will remember the setting and using the
5591 \begin_inset Flex CharStyle:Code
5594 \begin_layout Plain Layout
5600 option will not be needed from now on
5604 \begin_layout Plain Layout
5605 It has been reported that SumatraPDF is not able to remember the settings
5606 if it is installed in the Program Files system folder.
5607 This problem can be avoided by installing it somewhere else, for example
5609 \begin_inset Flex CharStyle:Code
5612 \begin_layout Plain Layout
5623 (in this way you will be using the lyxsocket; omit the
5624 \begin_inset Flex CharStyle:Code
5627 \begin_layout Plain Layout
5633 option if you want to use the lyxpipe and be sure that the
5634 \begin_inset Flex CharStyle:Code
5637 \begin_layout Plain Layout
5643 script is in your command PATH).
5644 If SumatraPDF is not your default PDF viewer, you should enter
5645 \begin_inset Flex CharStyle:Code
5648 \begin_layout Plain Layout
5654 in the viewer setting in
5655 \begin_inset Flex CharStyle:MenuItem
5658 \begin_layout Plain Layout
5659 Preferences\SpecialChar \menuseparator
5660 File Handling\SpecialChar \menuseparator
5661 File formats\SpecialChar \menuseparator
5668 \begin_inset Flex CharStyle:Code
5671 \begin_layout Plain Layout
5677 is the following script (to be placed in your command PATH,
5678 \begin_inset Flex CharStyle:Code
5681 \begin_layout Plain Layout
5687 being the best choice):
5690 \begin_layout LyX-Code
5692 \begin_inset Newline newline
5696 \begin_inset Newline newline
5699 SumatraPDF.exe $(basename $1)
5702 \begin_layout Standard
5703 This is needed because SumatraPDF is a native Windows application and does
5704 not understand the posix paths used by the Cygwin version of LyX.
5707 \begin_layout Standard
5708 Reverse search is triggered by double-click.
5711 \begin_layout Chapter
5712 Special Document Classes
5715 \begin_layout Section
5719 \begin_layout Standard
5725 \begin_layout Subsection
5729 \begin_layout Standard
5730 This section describes how LyX can be used to write articles for submission
5731 to the scientific journal
5733 Astronomy and Astrophysics
5735 (www.edpsciences.fr/aa/
5736 \begin_inset Flex URL
5739 \begin_layout Plain Layout
5741 http://www.edpsciences.fr/aa/
5746 ) using Version 5.01 of the document class
5751 This package can be downloaded from the ftp site
5754 \begin_layout Standard
5755 \begin_inset VSpace medskip
5761 \begin_layout Standard
5763 \begin_inset Flex URL
5766 \begin_layout Plain Layout
5768 ftp://ftp.edpsciences.org/pub/aa/readme.html
5776 \begin_layout Standard
5777 \begin_inset VSpace medskip
5783 \begin_layout Standard
5784 A manual comes together with that package, and this text is not meant to
5785 replace the original manual but merely a short guide how to realize the
5786 correct form of your paper.
5790 \begin_layout Standard
5791 Please note that the publisher of the journal was changed from Springer
5792 to EDP Sciences starting January 1, 2001.
5793 That change implicated also some slight changes of the style files, namely
5794 the removal of the thesaurus command.
5795 The LyX class aa supports the newest version of these style files, V 5.01.
5796 If you have an older version installed, please upgrade.
5797 For compatibility, the old (version 4) layout has been kept as
5802 Please refer to the comments in
5804 LyXDir/layouts/aapaper.layout
5809 \begin_layout Subsection
5813 \begin_layout Standard
5814 It is recommended you start from the example template distributed with LyX.
5815 If you are not using a template, note the following settings:
5818 \begin_layout Itemize
5825 Document\SpecialChar \menuseparator
5828 dialog (OK, that one was obvious).
5831 \begin_layout Itemize
5832 Don't change the option
5835 \begin_inset space ~
5845 The whole layout is done by the macros, you shouldn't change anything.
5848 \begin_layout Subsection
5852 \begin_layout Standard
5853 First thing to enter is the header information.
5854 It consists of seven entries, of which some are optional.
5858 \begin_layout Itemize
5866 \begin_layout Itemize
5874 \begin_layout Itemize
5882 \begin_layout Itemize
5890 \begin_layout Itemize
5895 : [optional] if more than one author: whom to contact for offprint requests.
5898 \begin_layout Itemize
5903 : [optional] mail address for contacts.
5906 \begin_layout Itemize
5914 Received: <date>; Accepted <date>
5917 \begin_layout Standard
5918 There is no need to issue the
5924 command, this is done automatically by LyX when the header is finished.
5925 Although the order of the single header entries doesn't matter it is advised
5926 to keep the above sequence, just to get the best optics and meets the layout
5927 of the real document.
5930 \begin_layout Standard
5931 If you want to place footnotes in the header block, e.
5932 \begin_inset space \thinspace{}
5936 \begin_inset space \space{}
5939 to state your present address, just use the standard footnote via the menu
5942 Insert\SpecialChar \menuseparator
5946 LyX will automagically use the term
5955 \begin_layout Standard
5956 In addition to these topics, the macros use three additional LaTeX commands
5957 that have no counterpart in LyX:
5960 \begin_layout Itemize
5967 to separate different names for more than one author and institute, respectivel
5971 \begin_layout Itemize
5978 to mark corresponding author/institute pairs.
5979 The institutes are numbered sequentially as they appear in the
5983 field, so you have to put a marker to each author.
5986 \begin_layout Itemize
5993 to supply an email address for fast contact.
5996 \begin_layout Standard
5997 In all cases, the appropriate command has to be entered in LyX and marked
6003 \begin_layout Subsection
6007 \begin_layout Standard
6008 The abstract should immediately follow the header block.
6009 With version 5 the abstract environment was changed to a command, and there
6010 is now a resctriction to only one paragraph.
6011 In addition, it should contain an entry with the keywords.
6012 This is not yet implemented for LyX, therefore you have to enter the LaTeX
6019 by hand and mark it as LaTeX code.
6020 Refer to the example paper.
6023 \begin_layout Subsection
6024 Supported environments
6027 \begin_layout Standard
6028 The A&A paper layout supports the following environments for structuring
6032 \begin_layout Itemize
6038 \begin_layout Itemize
6044 \begin_layout Itemize
6050 \begin_layout Itemize
6056 \begin_layout Itemize
6062 \begin_layout Itemize
6068 \begin_layout Itemize
6074 \begin_layout Itemize
6080 \begin_layout Itemize
6086 \begin_layout Itemize
6092 \begin_layout Itemize
6098 \begin_layout Itemize
6104 \begin_layout Subsection
6105 Commands not supported by LyX
6108 \begin_layout Standard
6109 Some commands are not yet supported by the
6114 Some have already been mentioned.
6115 For the sake of completeness, they are listed all together here:
6118 \begin_layout Itemize
6126 \begin_layout Itemize
6134 \begin_layout Itemize
6142 \begin_layout Itemize
6150 \begin_layout Itemize
6158 \begin_layout Itemize
6166 \begin_layout Itemize
6174 \begin_layout Itemize
6182 \begin_layout Standard
6183 If you want to use any of these commands, you have to enter them yourself.
6186 Do not forget to mark them as LaTeX code!
6189 \begin_layout Subsection
6190 Figure and Table Floats
6193 \begin_layout Standard
6194 LyX provides support for the necessary float environments
6196 figure, figure*, table
6202 , therefore we won't tell much about it here.
6206 \begin_inset space ~
6212 Just remember that tables should be left-aligned.
6213 For that, select the table and change the alignment in
6215 Edit\SpecialChar \menuseparator
6217 \begin_inset space ~
6223 \begin_layout Standard
6224 There is only one special thing: the figures with caption besides the figure.
6225 To create such a figure, you have to do the following:
6228 \begin_layout Enumerate
6229 Create a wide figure float:
6231 Insert\SpecialChar \menuseparator
6232 Float\SpecialChar \menuseparator
6235 , then right click in the figure and select
6241 \begin_inset space ~
6249 \begin_layout Enumerate
6250 Enter your caption text.
6253 \begin_layout Enumerate
6258 to move the cursor above the caption.
6261 \begin_layout Enumerate
6265 \begin_layout Enumerate
6266 Position the cursor behind the figure and insert a horizontal fill:
6268 Insert\SpecialChar \menuseparator
6270 \begin_inset space ~
6273 Character\SpecialChar \menuseparator
6275 \begin_inset space ~
6283 \begin_layout Enumerate
6284 Switch to LaTeX mode:
6287 \begin_inset space ~
6295 \begin_layout Enumerate
6305 Do not close the brace!
6308 \begin_layout Enumerate
6309 Position the cursor behind the caption text, switch to LaTeX mode and insert
6313 \begin_inset space ~
6325 \begin_layout Standard
6326 Also, refer to the figures in the example paper.
6329 \begin_layout Subsection
6333 \begin_layout Standard
6334 For submission, the paper has to be formated in a special double-spacing
6336 For this purpose, you have to give the option
6340 to the documentclass.
6341 This must be done using the extra class options field in the
6343 Document\SpecialChar \menuseparator
6347 Just enter the string
6354 \begin_layout Subsection
6358 \begin_layout Standard
6363 directory contains an example paper written with LyX.
6364 It is the example paper from the original macro package, translated to
6366 Use it for inspiration, and compare the original LaTeX code with LyX way
6370 \begin_layout Section
6374 \begin_layout Standard
6380 \begin_layout Subsection
6384 \begin_layout Standard
6385 AASTeX is a set of macros produced by the American Astronomical Society
6386 to facilitate electronic manuscript submission to the three journals they
6387 publish: the Astrophysical Journal (including the Letters and Supplement),
6388 the Astronomical Journal, and the Publications of the Astronomical Society
6390 LyX has proven to be an excellent tool for generating these documents,
6391 especially given its equation, citation, and figure handling capabilities.
6392 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
6393 is the version described here, or higher.
6394 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
6395 incompatible with LyX.
6396 The AASTeX package may be downloaded from the AASTeX Web site
6399 \begin_layout Standard
6400 \begin_inset VSpace medskip
6406 \begin_layout Standard
6408 \begin_inset Flex URL
6411 \begin_layout Plain Layout
6413 http://www.journals.uchicago.edu/AAS/AASTeX
6421 \begin_layout Standard
6422 \begin_inset VSpace medskip
6428 \begin_layout Standard
6429 A complete user guide is contained in that package and you should familiarize
6430 yourself with it thoroughly before embarking on writing a paper in LyX.
6431 LyX will not reduce the need to figure out all the AASTeX commands, it
6432 will only reduce the drudgery of typing everything in.
6433 It is your responsibility to ensure that the final exported LaTeX document
6434 conforms completely to the requirements of the journal to which you are
6435 submitting your paper.
6438 \begin_layout Subsection
6439 Starting a New Paper
6442 \begin_layout Standard
6443 I strongly suggest that you start with the AASTeX template file.
6446 File\SpecialChar \menuseparator
6453 , enter the new file name, then choose the
6458 This will show the most common fields found in a manuscript.
6459 Simply overwrite the existing text (including the brackets,
6463 ) with the correct information.
6464 Many of the AASTeX commands and environments can be implemented directly
6465 in LyX, but some cannot: most noticeably
6477 , which should stick out like a sore thumb if you actually just opened the
6479 For commands such as these, the LaTeX code must be entered directly and
6481 Such commands are referred to as TeX code, or Evil Red Text.
6482 I tried to minimize the amount of TeX code needed in an AASTeX document,
6483 but there is still a bit more required than any of us would like.
6486 \begin_layout Subsection
6487 Finishing Your Paper
6490 \begin_layout Standard
6491 When the paper is finished to your satisfaction and previews/prints correctly,
6493 \begin_inset Quotes eld
6497 \begin_inset Quotes erd
6500 actions which need to be done before you submit it to the journals.
6504 \begin_layout Enumerate
6505 Export your paper as a LaTeX file (
6507 File\SpecialChar \menuseparator
6508 Export\SpecialChar \menuseparator
6515 \begin_layout Enumerate
6520 file with your favorite text editor
6524 \begin_layout Enumerate
6525 remove the comment lines before the
6534 \begin_layout Enumerate
6539 usepackage...{fontenc}
6541 line if it appears (usually just after
6556 \begin_layout Enumerate
6557 remove everything between (and including) the
6569 commands, except for any commands you specifically put into the LaTeX preamble
6570 (which should appear immediately after the
6571 \begin_inset Quotes eld
6574 User specified LaTeX commands
6575 \begin_inset Quotes erd
6586 \begin_layout Enumerate
6587 Run the resulting file through LaTeX to make sure it still processes correctly.
6590 \begin_layout Enumerate
6591 Reread the journal requirements to make sure your filenames and formats
6595 \begin_layout Enumerate
6599 \begin_layout Subsection
6600 Comments On Specific Commands
6603 \begin_layout Standard
6604 I will not describe the detailed usage of the individual AASTeX commands:
6605 the AASTeX User Guide (
6609 ) gives a good description of each.
6610 Thus it's probably easiest for me to go down the list as found in the guide
6611 and offer comments where necessary.
6612 So let's begin \SpecialChar \ldots{}
6616 \begin_layout Subsubsection
6617 Things that work as expected
6620 \begin_layout Standard
6624 \begin_layout Plain Layout
6636 \begin_layout Standard
6637 Because they work as you might expect, I simply list them and the section
6738 begin{thebibliography}
6746 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6747 graphicx figure commands (2.14.1),
6771 (2.15.4, amongst other places),
6798 \begin_layout Standard
6799 The following style options also work correctly:
6820 Simply put them in the
6826 Layout\SpecialChar \menuseparator
6832 \begin_layout Standard
6836 \begin_layout Plain Layout
6848 \begin_layout Subsubsection
6849 Things that work, but require more comment
6852 \begin_layout Standard
6853 The following items work, but require a little more discussion:
6856 \begin_layout Itemize
6857 These items are reserved for use by the journal editors, but you can put
6858 them into the LaTeX preamble if you feel compelled to do so:
6891 \begin_layout Itemize
6892 These items may be placed in the LaTeX preamble, and are included as blanks
6893 in the template file:
6914 \begin_layout Itemize
6921 (2.3) – can only be used
6922 \begin_inset Quotes eld
6926 \begin_inset Quotes erd
6929 , not in the middle of a paragraph.
6930 Use TeX code if you need to embed it.
6933 \begin_layout Itemize
6940 (2.3) – will have extra {} after it.
6941 This should not cause an error.
6944 \begin_layout Itemize
6951 (2.6) – can only be used
6952 \begin_inset Quotes eld
6956 \begin_inset Quotes erd
6959 , not in the middle of a paragraph.
6960 Use TeX code if you need to embed it.
6963 \begin_layout Itemize
6970 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6974 \begin_layout Itemize
6981 (2.8) – same as for
6988 \begin_layout Itemize
6995 (2.9) – will have extra {} after it.
6996 This should not cause an error.
6999 \begin_layout Itemize
7006 (2.11) – will have extra {} after it.
7007 This should not cause an error.
7010 \begin_layout Itemize
7017 (2.14.2) – you can insert an optional filename argument by placing the cursor
7018 at the beginning of the text and selecting
7020 Insert\SpecialChar \menuseparator
7025 \begin_inset Quotes eld
7029 \begin_inset Quotes erd
7032 inserts an optional argument of the type needed by
7039 Hopefully it will be renamed someday.
7042 \begin_layout Itemize
7049 (2.17.1) – same as
7055 for the catalog ID optional parameter
7058 \begin_layout Itemize
7065 (2.17.1) – same as
7071 for the catalog ID optional parameter
7074 \begin_layout Subsubsection
7075 Things not implemented, use TeX code
7078 \begin_layout Standard
7082 \begin_layout Plain Layout
7094 \begin_layout Standard
7117 setcounter{equation}
7119 (2.12), Journal name abbreviations (2.13.4),
7155 (2.15.4, insert it as the first element in the lefthand cell after where
7157 Don't use any of LyX's rules in the table),
7169 (2.15.5), much of Misc (2.17, except
7220 \begin_layout Standard
7224 \begin_layout Plain Layout
7236 \begin_layout Subsubsection
7237 Things that cannot be implemented
7240 \begin_layout Standard
7241 \SpecialChar \ldots{}
7242 at least in any meaningful sort of way, so I suggest ignoring them.
7243 They are the references environment (2.13.3), and the deluxetable environment
7245 If you really, really need to use deluxetable, I suggest editing it in
7246 a separate file with a text editor, then using
7248 Insert\SpecialChar \menuseparator
7250 \begin_inset space ~
7255 to include it in your LyX document.
7260 file to see an example of this.
7263 \begin_layout Subsection
7264 FAQs, Tips, Tricks, and Other Ruminations
7267 \begin_layout Subsubsection
7268 Getting LyX and AASTeX to cooperate
7271 \begin_layout Standard
7272 It can be a bit tricky to get LyX to recognize a new layout and document
7274 When all else fails, do this:
7277 \begin_layout Enumerate
7278 Make certain that LaTeX can find AASTeX.
7279 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
7280 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
7287 \begin_layout Enumerate
7299 \begin_layout Enumerate
7302 Tools\SpecialChar \menuseparator
7305 in LyX, then restart LyX.
7308 \begin_layout Enumerate
7309 Open a regular new file, not from a template.
7310 Does AASTeX appear in the class list in
7312 Document\SpecialChar \menuseparator
7318 \begin_layout Standard
7319 If you get a warning from an existing AASTeX document about not being able
7320 to find the AASTeX layout or a message about
7321 \begin_inset Quotes eld
7324 You should not mix title layouts with normal ones
7325 \begin_inset Quotes erd
7328 , things haven't been installed correctly.
7331 \begin_layout Subsubsection
7332 LaTeX error processing a table
7335 \begin_layout Standard
7336 LyX, by default, attempts to center the table caption/title.
7337 This seems to produce a bad interaction in AASTeX so you should click somewhere
7338 in the caption/title, then select
7340 Edit\SpecialChar \menuseparator
7342 \begin_inset space ~
7356 This took care of it for me.
7359 \begin_layout Subsubsection
7363 \begin_layout Standard
7364 A couple of things: 1) I have noticed some funny spacing in the reference
7365 entries in the text.
7366 When you enter the bibliography item data, make sure their is
7370 space between the last author and the parenthesis setting off the year;
7374 \begin_inset space \thinspace{}
7378 \begin_inset space \space{}
7392 2) Entering the references at all is not obvious.
7393 The easiest thing is to start typing your first reference at the end of
7394 the document, then mark it as type
7399 That will put a small gray box in front of what you just typed.
7400 Click on the box to fill in the rest of the information.
7401 For new references, go to the end of an existing reference and press return.
7402 That will create a new line with its own box, etc.
7405 \begin_layout Subsubsection
7409 \begin_layout Standard
7410 Even though AASTeX provides its own figure commands (
7416 , for example), I much prefer LaTeX's standard figure commands (with the
7425 \begin_inset space ~
7428 commands as TeX code into a Figure Float box if you desire, but I never
7429 have much luck getting the layout right.
7430 With the standard graphics, LyX will insert a
7434 usepackage{graphicx}
7436 command into the LaTeX preamble and handle the figures in the standard
7437 LaTeX2e way, interspersing the figures in the text.
7438 I believe ApJ accepts figures exactly this way now; AJ might still use
7440 \begin_inset Quotes eld
7443 stack everything at the end
7444 \begin_inset Quotes erd
7450 \begin_layout Subsubsection
7451 Things I could have done, but didn't
7454 \begin_layout Standard
7456 \begin_inset Quotes eld
7460 \begin_inset Quotes erd
7463 things I could have implemented, but chose not to.
7464 For instance, I saw no point in double-spacing the text in the LyX window,
7465 even though it is double-spaced in the paper manuscript.
7466 Also, I chose not to make separate layouts for the preprint and preprint2
7468 Since I assume you will spend most of your time in the plain manuscript
7469 mode anyway, I decided not to chew up more disk space with this.
7473 \begin_layout Subsection
7477 \begin_layout Standard
7478 Your mileage may vary.
7479 I've now had papers published by both ApJ and AJ that have had 98% of the
7480 effort done in LyX; the last 2% was the LaTeX post-processing and a few
7482 I have had no trouble with the submission process, and I'm sure the journals
7483 were never aware that there might be a difference.
7484 So, go forth and publish!
7487 \begin_layout Section
7491 \begin_layout Standard
7494 David Johnson; updated by Richard Heck
7497 \begin_layout Standard
7498 \begin_inset VSpace bigskip
7504 \begin_layout Standard
7506 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
7507 papers to be submitted to American Mathematical Society publications.
7508 The layouts are not tailored to a specific journal, but easily can be.
7509 You should refer to the AMS documentation for specific instructions for
7510 each journal (usually it will entail only changing a single line in the
7512 That documentation is available on the Web at
7513 \begin_inset Flex URL
7516 \begin_layout Plain Layout
7524 \begin_inset Flex URL
7527 \begin_layout Plain Layout
7529 ftp://ftp.ams.org/pub/tex/amslatex/
7535 These layouts are appropriate, and useful, for any mathematical writing.
7539 \begin_layout Standard
7540 There are two basic AMS LaTeX layouts:
7543 \begin_layout Itemize
7544 amsart: The standard AMS article format.
7547 \begin_layout Itemize
7548 amsbook: the standard AMS book (really, monograph) format.
7552 \begin_layout Standard
7553 The layouts themselves contain only the minimum necessary to use the AMS
7555 They do not, in particular, contain any of the `theorem' environments used
7556 for setting theorems, lemmas, and the like.
7557 These are contained, instead, in the
7558 \begin_inset Flex CharStyle:Code
7561 \begin_layout Plain Layout
7567 module, which is loaded by default when when you select one of the AMS
7569 (It can also be used with other classes and can be removed, if you would
7570 rather use something else.) Less commonly used environments are in the
7571 \begin_inset Flex CharStyle:Code
7574 \begin_layout Plain Layout
7575 Theorems (AMS-Extended)
7580 module, which must be loaded manually.
7583 \begin_layout Standard
7584 By default, theorems and the like are numbered consecutively throughout
7585 the document, but this may be modified by loading the module
7586 \begin_inset Flex CharStyle:Code
7589 \begin_layout Plain Layout
7590 Theorems (Order by Section)
7595 or, if you are using
7596 \begin_inset Flex CharStyle:Code
7599 \begin_layout Plain Layout
7606 \begin_inset Flex CharStyle:Code
7609 \begin_layout Plain Layout
7610 Theorems (Order by Chapter)
7616 These will number the results as
7617 \begin_inset Formula $n.m$
7620 , where the first number refers to the section (or chapter) and the second
7621 refers to the total number of results so far in that section (or chapter).
7622 Many environments are also available unnumbered.
7623 These are indicated by an asterisk at the end.
7624 If you happen to want
7628 unnumbered results, the the module
7629 \begin_inset Flex CharStyle:Code
7632 \begin_layout Plain Layout
7638 provides that option.
7641 \begin_layout Standard
7642 Note that these modules do not
7646 to be used with the AMS classes.
7647 It is perfectly possible to use the
7648 \begin_inset Flex CharStyle:Code
7651 \begin_layout Plain Layout
7657 module, and the others mentioned, with other classes, such as
7658 \begin_inset Flex CharStyle:Code
7661 \begin_layout Plain Layout
7668 \begin_inset Flex CharStyle:Code
7671 \begin_layout Plain Layout
7678 \begin_inset Flex CharStyle:Code
7681 \begin_layout Plain Layout
7690 \begin_layout Subsection
7691 What these layouts provide
7694 \begin_layout Standard
7695 There is a long list of included environments provided by these layouts.
7696 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
7697 variety of `theorem' environments.
7698 However, the AMS recommends the environments that are available in LyX.
7702 \begin_layout Standard
7703 The following environments—as well as the standard environments, such as
7705 \begin_inset Flex CharStyle:Noun
7708 \begin_layout Plain Layout
7715 \begin_inset Flex CharStyle:Noun
7718 \begin_layout Plain Layout
7725 \begin_inset Flex CharStyle:Noun
7728 \begin_layout Plain Layout
7735 \begin_inset Flex CharStyle:Noun
7738 \begin_layout Plain Layout
7745 \begin_inset Flex CharStyle:Noun
7748 \begin_layout Plain Layout
7755 \begin_inset Flex CharStyle:Code
7758 \begin_layout Plain Layout
7765 \begin_inset Flex CharStyle:Code
7768 \begin_layout Plain Layout
7777 \begin_layout Description
7778 Address This should be the author's permanent address.
7781 \begin_layout Description
7783 \begin_inset space ~
7786 Address This should be the author's temporary address at the time of submission,
7787 if different from the Address.
7790 \begin_layout Description
7791 Email Author's e-mail address
7794 \begin_layout Description
7795 URL Author's Web address, if desired.
7798 \begin_layout Description
7799 Keywords Key words or phrases used to identify specific topics discussed
7803 \begin_layout Description
7804 Subjectclass These refer to the AMS Subject Classifications, published and
7807 Mathematical Reviews
7810 These are also available online at the AMS cites listed above.
7813 \begin_layout Description
7817 \begin_layout Description
7821 \begin_layout Description
7825 \begin_layout Standard
7826 The following environments are provided by both the
7827 \begin_inset Flex CharStyle:Code
7830 \begin_layout Plain Layout
7837 \begin_inset Flex CharStyle:Code
7840 \begin_layout Plain Layout
7846 modules, in the latter case in both starred (unnumbered) and unstarred
7847 (numbered) versions.
7848 These same environments are provided only in the starred versions by the
7850 \begin_inset Flex CharStyle:Code
7853 \begin_layout Plain Layout
7862 \begin_layout Theorem
7863 This is typically used for the statements of major results.
7867 \begin_layout Corollary*
7868 This is used for statements which follow fairly directly from previous statement
7870 Again, these can be major results.
7875 These are smaller results needed to prove other statements.
7878 \begin_layout Proposition
7879 These are less major results which (hopefully) add to the general theory
7883 \begin_layout Conjecture
7884 These are statements provided without justification, which the author does
7885 not know how to prove, but which seem to be true (to the author, at least).
7888 \begin_layout Definition*
7889 Guess what this is for.
7890 The font is different for this environment than for the previous ones.
7894 \begin_layout Example*
7895 Used for examples illustrating proven results.
7898 \begin_layout Problem
7899 It's not really known what this is for.
7900 You should figure it out.
7903 \begin_layout Exercise*
7904 Write a description for this one.
7907 \begin_layout Remark
7908 This environment is also a type of theorem, usually a lesser sort of observation.
7911 \begin_layout Claim*
7912 Often used in the course of giving a proof of a larger result.
7916 Generally, these are used to break up long arguments, using specific instances
7922 The numbering scheme for cases is on its own, not together with other numbered
7928 At the end of this environment, a QED symbol (usually a square, but it can
7929 vary with different styles) is placed.
7930 If you want to have other environments within this one—for example, Case
7931 environments—and have the QED symbol appear only after them, then the other
7932 environments need to be nested within the proof environment.
7935 Nesting Environments
7941 for information on nesting.
7944 \begin_layout Standard
7945 And these environments are provided by
7946 \begin_inset Flex CharStyle:Code
7949 \begin_layout Plain Layout
7950 Theorems (AMS-Extended)
7958 \begin_layout Criterion*
7959 A required condition.
7962 \begin_layout Algorithm*
7963 A general procedure to be used.
7966 \begin_layout Axiom*
7967 This is a property or statement taken as true within the system being discussed.
7970 \begin_layout Condition*
7971 Sometimes used to state a condition assumed within the present context of
7976 Similar to a Remark.
7979 \begin_layout Notation*
7980 Used for the explanation of, yes, notation.
7983 \begin_layout Summary
7984 Do we really need to tell you?
7987 \begin_layout Acknowledgement*
7991 \begin_layout Conclusion*
7992 Sometimes used at the end of a long train of argument.
7996 Used in a way similar to Proposition, though perhaps lower on the scale.
7999 \begin_layout Standard
8000 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
8002 They need to be available on your system in order to use these environments.
8005 \begin_layout Section
8013 \begin_layout Standard
8019 \begin_layout Subsection
8023 \begin_layout Standard
8024 These are the layout files for some of the journals of the American Geophysical
8026 It is assumed that you have both the AGU's own class files and AGUplus
8027 installed (everything to be found at
8028 \begin_inset Flex URL
8031 \begin_layout Plain Layout
8033 ftp://ftp.agu.org/journals/latex/journals
8041 \begin_layout Subsection
8045 \begin_layout Standard
8055 They are still called this in the LyX GUI, though their LaTeX equivalents
8056 in the AGU classes are
8067 \begin_layout Standard
8068 Newly defined styles are
8105 These are mostly manuscript attributes and defined in the AGU class documentati
8109 \begin_layout Standard
8110 I suspect this is still badly incomplete.
8113 \begin_layout Subsection
8117 \begin_layout Standard
8134 \begin_layout Subsection
8138 \begin_layout Itemize
8141 Journal of Geophysical Research
8150 \begin_layout Standard
8151 Add your own, it isn't so hard! Look at the
8162 \begin_layout Subsection
8163 Bugs and things to remember
8166 \begin_layout Standard
8167 In order to use the new layouts, you must remember to do the following for
8171 \begin_layout Enumerate
8177 This can be done in the
8179 Layout\SpecialChar \menuseparator
8184 Document\SpecialChar \menuseparator
8188 (AGU articles are always in English, right? So
8195 \begin_layout Enumerate
8205 (Yes, this is a bug.)
8208 \begin_layout Enumerate
8209 Make sure you use the
8213 bibliography style, by entering
8217 into the second field of the BibTeX inset.
8218 None of the standard styles will do.
8221 \begin_layout Section
8225 \begin_layout Standard
8231 \begin_layout Subsection
8235 \begin_layout Standard
8236 Broadway is for writing plays.
8237 The format is more decorative than Hollywood, and much less standardized.
8238 This format should be suitable for workshops.
8241 \begin_layout Subsection
8245 \begin_layout Standard
8246 The same as in Hollywood.
8249 \begin_layout Subsection
8253 \begin_layout Standard
8258 names as labels then cross-reference the label to insert the name.
8259 The cross-reference dialog will show the current cast of characters.
8262 \begin_layout Subsection
8263 Paper size and Margins
8266 \begin_layout Standard
8267 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
8270 \begin_layout Subsection
8274 \begin_layout Standard
8275 The following environments are available.
8276 You can use broadway.bind to get the bind keys shown at the right.
8279 \begin_layout Itemize
8283 \begin_inset Newline newline
8288 You should not have to use this, but it is here for anything that does not
8292 \begin_layout Itemize
8296 \begin_inset space \hfill{}
8300 \begin_inset Newline newline
8305 Used to describe stage setting and the action.
8306 First use of speaker names in all CAPs.
8309 \begin_layout Itemize
8313 \begin_inset space \hfill{}
8317 \begin_inset Newline newline
8322 Automatically numbered.
8323 On screen it will be arabic, but will print as Roman.
8326 \begin_layout Itemize
8330 \begin_inset space \hfill{}
8334 \begin_inset Newline newline
8344 It is just centered text.
8347 \begin_layout Itemize
8351 \begin_inset space \hfill{}
8355 \begin_inset Newline newline
8360 Not automatically numbered.
8361 You supply the number.
8362 This is because I couldn't figure out how.
8365 \begin_layout Itemize
8369 \begin_inset space \hfill{}
8373 \begin_inset Newline newline
8378 A special case of Narrative to describe the setting and action as the curtain
8382 \begin_layout Itemize
8386 \begin_inset space \hfill{}
8390 \begin_inset Newline newline
8395 The speaker's (actor's) title, centered in all CAPS.
8398 \begin_layout Itemize
8402 \begin_inset space \hfill{}
8406 \begin_inset Newline newline
8411 Instructions to the speaker.
8412 The parentheses are automatically inserted.
8413 The ( will appear on screen, but both will be in the printed play.
8414 This environment is only used within
8421 \begin_layout Itemize
8425 \begin_inset space \hfill{}
8429 \begin_inset Newline newline
8434 What the Speaker says.
8437 \begin_layout Itemize
8441 \begin_inset space \hfill{}
8445 \begin_inset Newline newline
8450 The curtain comes down.
8453 \begin_layout Itemize
8457 \begin_inset space \hfill{}
8463 \begin_layout Itemize
8467 \begin_inset space \hfill{}
8473 \begin_layout Itemize
8477 \begin_inset space \hfill{}
8483 \begin_layout Standard
8487 \begin_layout Section
8491 \begin_layout Standard
8496 can be used to type letters according to German conventions.
8497 A template file is included in
8499 .../lyx/share/templates
8501 for you to use as a starting point.
8504 \begin_layout Section
8512 \begin_layout Standard
8518 \begin_layout Subsection
8522 \begin_layout Standard
8523 This is the layout file for the European Geophysical Society journals.
8528 can be downloaded from the web site of the EGS under
8529 \begin_inset Flex URL
8532 \begin_layout Plain Layout
8542 \begin_layout Subsection
8546 \begin_layout Standard
8549 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
8557 The current layout file is unfortunately very unmodular and would benefit
8558 from using the various
8565 \begin_layout Section
8569 \begin_layout Standard
8575 \begin_layout Standard
8576 Elsevier Science Publishers B.V.
8577 provides a standard LaTeX document class (
8581 ) for submitting articles to their various journals.
8582 The style file can be downloaded directly from their web site:
8583 \begin_inset Flex URL
8586 \begin_layout Plain Layout
8588 http://authors.elsevier.com/
8594 Instructions are supplied along with the class file, which details the
8595 requirements of the publishers.
8596 LyX includes package that allows for the use of this class, by a layout
8597 and a template file.
8598 Installation of the class file is the same as for any other LaTeX package;
8599 instructions are provided in the Elsevier documentation.
8602 \begin_layout Standard
8612 As the Elsevier class file is based mainly on the standard article class,
8613 most of the normal functionality is provided.
8614 The Elsevier class defines a number of mathematical environments, which
8615 are similar to the AMS environments.
8616 These commands are all described in the Elsevier documentation, and are
8620 \begin_layout Standard
8621 The easiest way to use the Elsevier style is to base documents on the included
8623 It is best not to use options such as fancy headings or the geometry package,
8624 as elements such as these are defined by Elsevier in their style file.
8625 Ideally, no extra packages except those mentioned in the Elsevier documentation
8627 Essentially, Elsevier require as
8628 \begin_inset Quotes eld
8632 \begin_inset Quotes erd
8635 a LaTeX file as possible, as their intention is to take the supplied file
8636 and replace the class file with one for the particular journal to which
8637 the paper has been submitted.
8638 This also means that not too much time should be spent on the formating
8640 When it comes to be published, this will change anyway.
8641 The rest of the usage for this layout is substantially the same as for
8642 the normal article class.
8643 For details of what Elsevier do and don't allow, refer to their documentation.
8646 \begin_layout Section
8652 \begin_inset CommandInset label
8661 \begin_layout Standard
8667 \begin_layout Subsection
8671 \begin_layout Standard
8672 This section describes how to use LyX to make slides for overhead projectors.
8673 There are two document classes that can do this: the default slides class
8679 This section documents the latter.
8682 \begin_layout Standard
8683 I'm going to say this again, nice and clear, so that there's no misunderstanding
8687 \begin_layout Standard
8688 \begin_inset VSpace bigskip
8694 \begin_layout Standard
8698 This section documents the class
8699 \begin_inset Quotes eld
8707 \begin_inset Quotes erd
8715 \begin_layout Standard
8716 \begin_inset VSpace bigskip
8722 \begin_layout Standard
8723 If you're looking for the documentation for
8724 \begin_inset Quotes eld
8732 \begin_inset Quotes erd
8736 \begin_inset space ~
8740 \begin_inset CommandInset ref
8742 reference "sec:slitex"
8747 If your machine doesn't have the
8752 \begin_inset Quotes eld
8760 \begin_inset Quotes erd
8763 ] installed, you'll probably have to use the default
8767 class, which isn't quite as good as
8772 \begin_layout Standard
8777 class is designed for use with version 2.1 of the
8781 LaTeX class file which is now an integral part of LaTeX2e.
8784 \begin_layout Subsection
8788 \begin_layout Standard
8789 Obviously, to use this document class, you need to select
8790 \begin_inset Quotes eld
8798 \begin_inset Quotes erd
8808 \begin_inset space ~
8814 There are some settings in the
8817 \begin_inset space ~
8822 dialog that you should know about that are specific to this class:
8825 \begin_layout Itemize
8826 Don't change the options
8837 \begin_inset space ~
8843 They're ignored by the
8850 \begin_layout Itemize
8851 The default font size is 20
8852 \begin_inset space \thinspace{}
8855 pt with the other options being 17
8856 \begin_inset space \thinspace{}
8860 \begin_inset space \thinspace{}
8864 \begin_inset space \thinspace{}
8870 \begin_layout Itemize
8879 but all math equations are still typeset in the usual roman font.
8882 \begin_layout Itemize
8887 supports A4 and Letter paper sizes as well as a special size for working
8889 \begin_inset space \thinspace{}
8893 It doesn't support A5, B5, legal or executive paper sizes.
8896 \begin_layout Itemize
8897 Don't bother changing the
8901 settings because they are ignored anyway.
8902 All floats appear where they are defined in the text.
8905 \begin_layout Itemize
8910 setting behaves a bit differently for this class.
8915 provides extensive footer and header capabilities including a user-defined
8918 \begin_inset space ~
8922 \begin_inset CommandInset ref
8924 reference "sec:foilfoot"
8929 The title page is treated differently to all other pages in the document
8938 has the logo centered at the bottom of the page (if one is defined).
8939 The possible page style choices and what they do are as follows:
8943 \begin_layout Labeling
8944 \labelwidthstring MMMMMMM
8951 The final output contains no page numbers, or other headers or footers
8952 (except footnotes of course).
8956 \begin_layout Labeling
8957 \labelwidthstring MMMMMMM
8964 The final output contains page numbers centered at the bottom of the page.
8965 No other headings or footers (other than footnotes).
8968 \begin_layout Labeling
8969 \labelwidthstring MMMMMMM
8974 Page numbers in lower right corner.
8975 Additional headers and footers are also shown.
8976 This is also the default.
8979 \begin_layout Labeling
8980 \labelwidthstring MMMMMMM
8985 Gives you access to the
8989 package although its use with
8993 is discouraged by the writer of the
8997 package because of some potential page layout clashes.
9001 \begin_layout Subsubsection
9005 \begin_layout Standard
9006 The following options may be used in the extra class options in the
9008 Document\SpecialChar \menuseparator
9014 \begin_layout Labeling
9015 \labelwidthstring MMMMMMx
9020 This sets up the page layout for 7.33
9021 \begin_inset space \thinspace{}
9025 \begin_inset space \thinspace{}
9028 in paper, which is about the same aspect ratio as a 35
9029 \begin_inset space \thinspace{}
9032 mm slide, making it a bit easier to work with this medium.
9035 \begin_layout Labeling
9036 \labelwidthstring MMMMMMx
9041 Places a rule across the page below the header on every page except the
9045 \begin_layout Labeling
9046 \labelwidthstring MMMMMMx
9051 Places a rule across the page above the footer on every page except the
9055 \begin_layout Labeling
9056 \labelwidthstring MMMMMMx
9061 This is automatically set each time you create a new
9070 to use the dvips driver to rotate those pages that are set as landscape
9074 \begin_layout Labeling
9075 \labelwidthstring MMMMMMx
9080 Simply changes the page dimensions to those of a landscape page but doesn't
9082 Thus if you use this option you need to use an external program to rotate
9083 each page or feed your paper through your printer as landscape.
9084 Note that this option effectively reverses the roles of the
9092 environments (don't worry these are described in the next section).
9095 \begin_layout Labeling
9096 \labelwidthstring MMMMMMx
9101 Equation numbers on the left.
9104 \begin_layout Labeling
9105 \labelwidthstring MMMMMMx
9110 Flush-left equations.
9113 \begin_layout Subsection
9114 Supported Environments
9117 \begin_layout Standard
9118 Most of the environments commonly supported in other classes are also supported
9124 There are several additional environments provided by
9128 as well as a couple added by LyX.
9129 The following environments are shared with other classes:
9132 \begin_layout Standard
9136 \begin_layout Plain Layout
9148 \begin_layout Itemize
9154 \begin_layout Itemize
9160 \begin_layout Itemize
9166 \begin_layout Itemize
9172 \begin_layout Itemize
9178 \begin_layout Itemize
9184 \begin_layout Itemize
9190 \begin_layout Itemize
9196 \begin_layout Itemize
9202 \begin_layout Itemize
9208 \begin_layout Itemize
9214 \begin_layout Itemize
9220 \begin_layout Itemize
9226 \begin_layout Itemize
9232 \begin_layout Itemize
9238 \begin_layout Itemize
9244 \begin_layout Itemize
9250 \begin_layout Itemize
9256 \begin_layout Standard
9260 \begin_layout Plain Layout
9272 \begin_layout Standard
9273 That is, all the major environments apart from the sectioning environments.
9274 Since foils are essentially self-contained sections, with a title and body,
9279 provides specific commands for starting new foils and these are:
9282 \begin_layout Itemize
9288 \begin_layout Itemize
9294 \begin_layout Standard
9295 LyX also provides slightly modified versions of these two environments called:
9298 \begin_layout Itemize
9304 \begin_layout Itemize
9310 \begin_layout Standard
9311 and the differences will be explained in the next section.
9314 \begin_layout Standard
9315 Since foils are often used in presenting ideas or new theorems and such
9320 also provides a comprehensive box of goodies for presenting them:
9323 \begin_layout Standard
9327 \begin_layout Plain Layout
9339 \begin_layout Itemize
9345 \begin_layout Itemize
9351 \begin_layout Itemize
9357 \begin_layout Itemize
9363 \begin_layout Itemize
9369 \begin_layout Itemize
9375 \begin_layout Itemize
9381 \begin_layout Itemize
9387 \begin_layout Itemize
9393 \begin_layout Itemize
9399 \begin_layout Itemize
9405 \begin_layout Standard
9409 \begin_layout Plain Layout
9421 \begin_layout Standard
9422 The starred versions are unnumbered while the unstarred versions are numbered.
9423 There are also two list environments added by LyX and these are:
9426 \begin_layout Itemize
9432 \begin_layout Itemize
9438 \begin_layout Standard
9443 provides some powerful header and footer capabilities that are best set
9444 in the preamble although they may be set at any point in a document.
9445 If you want to change these settings in your document the best place to
9446 do so is at the very top of a foil, i.
9447 \begin_inset space \thinspace{}
9453 \begin_inset space \space{}
9458 straight after the foilhead.
9461 \begin_layout Standard
9462 For this purpose, the following command styles are provided [
9469 \begin_layout Standard
9473 \begin_layout Plain Layout
9485 \begin_layout Itemize
9489 \begin_inset space ~
9495 \begin_layout Itemize
9501 \begin_layout Itemize
9505 \begin_inset space ~
9511 \begin_layout Itemize
9515 \begin_inset space ~
9521 \begin_layout Itemize
9525 \begin_inset space ~
9532 \begin_layout Standard
9533 \begin_inset space ~
9540 \begin_layout Standard
9544 \begin_layout Plain Layout
9556 \begin_layout Standard
9557 There are also a few commands provided by
9561 that aren't directly supported by LyX but I'll tell you what they do and
9562 how to use them in section
9563 \begin_inset space ~
9567 \begin_inset CommandInset ref
9569 reference "sec:unsuppfoils"
9576 \begin_layout Subsection
9577 Building a Set of Foils
9580 \begin_layout Standard
9581 This section will give a simple introduction to using the different environments
9582 to build a set of foils.
9583 If you want to see an example set of foils, take a look at the
9587 file you find in LyX's
9594 \begin_layout Subsubsection
9595 Give It a Title Page
9598 \begin_layout Standard
9599 Unlike other classes that provide
9619 creates the title on a page of its own.
9620 If you leave out the
9624 environment LaTeX will substitute the current date (every time you regenerate
9628 \begin_layout Subsubsection
9632 \begin_layout Standard
9633 As I mentioned earlier, there are four ways of starting a new foil.
9634 For portrait foils you should use
9643 The difference between these two environments is the amount of space between
9644 the title of the foil (the foilhead) and the body of the foil.
9647 \begin_layout Standard
9648 Landscape foils are generated using the
9657 Again the only difference is the spacing between foilhead and body.
9658 Both of the short versions have 0.5 inches less separation between the foilhead
9663 \begin_layout Standard
9664 One problem with the support for landscape foils is the requirement that
9669 driver to generate the PostScript output otherwise the foils won't be rotated.
9670 It is possible to get landscape foils even if you haven't got the
9674 driver provided you can feed your foils sideways through your printer ;-)
9677 \begin_layout Subsubsection
9678 Theorems, Lemmas, Proofs and more
9681 \begin_layout Standard
9682 Due to a small bug in LyX you can't have two of the same type of these environme
9683 nts directly following each other.
9684 They must be separated by something.
9685 If you try, you will just be extending the previous environment as if you
9686 had merged the two environments together.
9687 So, how do you get around this problem? The simplest option is to insert
9688 some text between the two environments or add a
9692 environment between the two with just a
9693 \begin_inset Quotes eld
9701 \begin_inset Quotes erd
9705 This will force LyX to produce two separate environments and hence the
9706 correct LaTeX output.
9707 An example is provided in the example file included with the LyX distribution.
9708 Remember, this problem only occurs if you are trying to place two of the
9709 same type of theorem-like environments one directly after the other.
9712 \begin_layout Subsubsection
9716 \begin_layout Standard
9717 You get all the commonly supported list styles found in other classes as
9718 well as two new ones.
9719 I'll only describe the new ones here.
9720 If you want to find out more about the other list environments check out
9726 If you intend to use itemized lists you might also want to read about the
9730 \begin_inset space ~
9734 \begin_inset space ~
9739 dialog described above in section
9740 \begin_inset space ~
9744 \begin_inset CommandInset ref
9746 reference "sec:bullet"
9753 \begin_layout Standard
9754 The two new list styles,
9762 , are designed to make it easier for you to create lists of do's and don'ts
9763 or right and wrong by providing dedicated environments that use a tick
9764 or a cross as the label of the list.
9765 These lists are in fact dedicated variants of the
9770 They do however require that you have the
9777 \begin_layout Subsubsection
9781 \begin_layout Standard
9786 redefines the floating tables and figures so that they appear exactly where
9787 they are in the text rather than pushing them to the top of the page or
9788 to some user specified location.
9789 In fact if you change the float placement settings they are simply ignored.
9792 \begin_layout Subsubsection
9793 Page Headers and Footers
9794 \begin_inset CommandInset label
9803 \begin_layout Standard
9807 \begin_inset space ~
9816 are two commands used to control the left-footer text string.
9817 The first is meant to allow you to include a graphic logo on your foils
9819 \begin_inset Quotes eld
9827 \begin_inset Quotes erd
9831 While the second is meant to provide a classification for the audience,
9835 \begin_inset space \thinspace{}
9841 \begin_inset space \space{}
9845 It is empty by default.
9848 \begin_layout Standard
9849 The remaining page corners can be filled by
9852 \begin_inset space ~
9857 (which defaults to page numbers),
9860 \begin_inset space ~
9868 \begin_inset space ~
9876 \begin_layout Subsection
9882 \begin_inset CommandInset label
9884 name "sec:unsuppfoils"
9891 \begin_layout Standard
9892 All the commands mentioned below need to be set in a
9900 within another environment.
9903 \begin_layout Subsubsection
9907 \begin_layout Standard
9908 All lengths are adjusted using the
9931 should be replaced by the name given to the length you want to change and
9936 is the length value.
9937 All lengths should be specified in units of length such as inches (
9949 ) or relative to some document or font-based length such as
9959 \begin_layout Standard
9960 It's possible to change the spacing between a foilhead and the body of the
9961 foil by adjusting the length specified by
9968 For example, to make
9973 \begin_inset space \space{}
9976 in closer to their bodies put the following in the preamble:
9982 foilheadskip}{-0.5in}
9985 \begin_layout Standard
9986 The spacings around floats can be adjusted by setting these lengths:
9989 \begin_layout Labeling
9990 \labelwidthstring MMMMMMMMMMM
9997 Separation between the text and the top of the float
10000 \begin_layout Labeling
10001 \labelwidthstring MMMMMMMMMMM
10008 Separation between the float and the caption
10011 \begin_layout Labeling
10012 \labelwidthstring MMMMMMMMMMM
10019 Separation between the caption and the following text
10022 \begin_layout Labeling
10023 \labelwidthstring MMMMMMMMMMM
10030 You can make the captions narrower than the surrounding text by adjusting
10032 Best done relative to
10041 \begin_layout Standard
10042 There are also several title page related lengths that you may find useful
10043 if you have a long title or several authors:
10046 \begin_layout Labeling
10047 \labelwidthstring MMMMMMMMMMM
10054 Separation from headers to
10059 \begin_layout Labeling
10060 \labelwidthstring MMMMMMMMMMM
10078 \begin_layout Labeling
10079 \labelwidthstring MMMMMMMMMMM
10093 \begin_layout Labeling
10094 \labelwidthstring MMMMMMMMMMM
10110 \begin_layout Labeling
10111 \labelwidthstring MMMMMMMMMMM
10127 \begin_layout Standard
10128 The last length related command affects all the list environments.
10139 a list environment then all the vertical spacing between the list items
10141 Note that this is a command not a length so it doesn't require
10147 like the stuff mentioned above.
10150 \begin_layout Subsubsection
10151 Headers and Footers
10154 \begin_layout Standard
10167 commands control whether the logo in the
10171 definition appear on a given page.
10178 in the preamble then none of the foils will have the logo on them.
10179 If you don't want the logo on a particular page place the
10185 directly after the foilhead of that page and the
10191 directly after the next foilhead.
10194 \begin_layout Standard
10195 If you decide to use the
10199 page style setting in the
10202 \begin_inset space ~
10207 dialog you should probably add
10217 to your preamble so headers and footers on landscape pages are correctly
10218 placed when rotated.
10219 This is due to some clashes between the page layouts provided by the
10230 \begin_layout Section
10231 Hollywood (Hollywood spec scripts)
10234 \begin_layout Standard
10240 \begin_layout Subsection
10244 \begin_layout Standard
10245 Getting the format of a Hollywood script right is a
10246 \begin_inset Quotes eld
10250 \begin_inset Quotes erd
10253 It is designed to make the readers focus on content and to be easy and
10254 familiar for the actors to read.
10255 Each page of a script should be one minute of film.
10256 Nothing goes in a script that you cannot see or hear on screen.
10257 The courier 12 pt font should be used throughout.
10261 \begin_layout Subsection
10265 \begin_layout Standard
10266 Speakers' lines should NEVER break in mid-sentence.
10267 If a speaker's lines continue over a page break, repeat the
10271 title followed by (Cont'd).
10274 \begin_layout Subsection
10278 \begin_layout Standard
10283 names as labels then cross-reference the label to insert the name.
10284 The cross-reference dialog will show the current cast of characters.
10285 You can use this to insert the speaker name in narratives also.
10288 \begin_layout Subsection
10289 Paper size and Margins
10292 \begin_layout Standard
10293 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10296 \begin_layout Subsection
10300 \begin_layout Standard
10301 The following environments are available.
10302 You can use hollywood.bind to get the bind keys shown at the right.
10305 \begin_layout Itemize
10309 \begin_inset Newline newline
10314 Used where nothing else works.
10318 \begin_layout Itemize
10324 \begin_inset space \hfill{}
10332 \begin_inset Newline newline
10335 Usually followed by something like
10336 \begin_inset Quotes eld
10339 on Sally waking up.
10340 \begin_inset Quotes erd
10346 \begin_layout Itemize
10350 \begin_inset space \hfill{}
10354 \begin_inset Newline newline
10359 Introduces a new INTERIOR camera set-up.
10360 Always followed by DAY or NIGHT, or something similar to define the lighting
10362 Everthing on this line in CAPS.
10365 \begin_layout Itemize
10369 \begin_inset space \hfill{}
10373 \begin_inset Newline newline
10378 Introduces a new EXTERIOR camera set-up.
10379 Everthing on this line in CAPS.
10382 \begin_layout Itemize
10386 \begin_inset space \hfill{}
10390 \begin_inset Newline newline
10395 The character speaking.
10398 \begin_layout Itemize
10402 \begin_inset space \hfill{}
10406 \begin_inset Newline newline
10411 Instructions to the speaker.
10412 The () are automatically inserted, but only the ( will show in LyX.
10413 Both will be printed.
10416 \begin_layout Itemize
10420 \begin_inset space \hfill{}
10424 \begin_inset Newline newline
10436 \begin_layout Itemize
10440 \begin_inset space \hfill{}
10444 \begin_inset Newline newline
10449 Camera movement instruction.
10451 \begin_inset space \thinspace{}
10455 \begin_inset space \space{}
10461 \begin_layout Itemize
10465 \begin_inset space \hfill{}
10471 \begin_layout Itemize
10475 \begin_inset space \hfill{}
10481 \begin_layout Itemize
10485 \begin_inset space \hfill{}
10491 \begin_layout Itemize
10495 \begin_inset space \hfill{}
10501 \begin_layout Subsection
10505 \begin_layout Itemize
10506 (O.S) — off screen
10509 \begin_layout Itemize
10510 (V.0) — voice over
10513 \begin_layout Itemize
10515 \begin_inset space \thinspace{}
10522 \begin_layout Itemize
10527 \begin_layout Itemize
10528 PAN — camera movement
10531 \begin_layout Itemize
10532 INSERT — cut to close-up of
10535 \begin_layout Section
10539 \begin_layout Standard
10542 Panayotis Papasotiriou
10545 \begin_layout Subsection
10549 \begin_layout Standard
10550 The ijmpc package is a set of macros that facilitates electronic manuscript
10553 International Journal of Modern Physics C
10556 Similarly, the ijmpd package is for creating manuscripts to be submitted
10559 International Journal of Modern Physics D
10562 Both journals are published by World Scientific.
10563 The corresponding document classes are named
10572 These files, together with instructions for the authors, can be downloaded
10574 \begin_inset Flex URL
10577 \begin_layout Plain Layout
10579 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
10585 \begin_inset Flex URL
10588 \begin_layout Plain Layout
10590 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
10596 Both packages are modified versions of the standard
10597 \begin_inset Quotes eld
10601 \begin_inset Quotes erd
10604 package, and they are almost (but not exactly) identical.
10605 Most of their features are supported by LyX.
10606 I have used LyX successfully to write articles submitted to both journals
10607 without any problem.
10610 \begin_layout Subsection
10614 \begin_layout Standard
10615 As usual, the easiest way to write a paper is to start with a template.
10618 File\SpecialChar \menuseparator
10637 This will give an (almost) empty document that includes the most common
10638 fields found in a manuscript.
10639 Simply overwrite the existing text (including the brackets,
10644 You should keep in mind the following remarks.
10647 \begin_layout Enumerate
10648 LyX won't let you change the font size and the page style of the document,
10649 because such modifications are not allowed by both packages.
10652 \begin_layout Enumerate
10653 The language of the document should not be changed.
10654 Before previewing your paper, be sure that the babel package is not used.
10655 To do this, click on
10657 Tools\SpecialChar \menuseparator
10668 checkbox in the language settings, and click on
10676 , if you wish to make this change permanent).
10679 \begin_layout Enumerate
10681 \begin_inset Quotes eld
10685 \begin_inset Quotes erd
10688 style must be used to define keywords.
10691 \begin_layout Enumerate
10692 The ijmpc package provides a style named
10693 \begin_inset Quotes eld
10696 Classification Codes
10697 \begin_inset Quotes erd
10700 , which can be used to define classification codes, such as PACS numbers.
10701 Note that this facility is not supported by the ijmpd package.
10704 \begin_layout Enumerate
10705 Several new environments are available:
10706 \begin_inset Quotes eld
10710 \begin_inset Quotes erd
10714 \begin_inset Quotes eld
10718 \begin_inset Quotes erd
10722 \begin_inset Quotes eld
10726 \begin_inset Quotes erd
10730 \begin_inset Quotes eld
10734 \begin_inset Quotes erd
10738 \begin_inset Quotes eld
10742 \begin_inset Quotes erd
10746 \begin_inset Quotes eld
10750 \begin_inset Quotes erd
10754 \begin_inset Quotes eld
10758 \begin_inset Quotes erd
10762 \begin_inset Quotes eld
10766 \begin_inset Quotes erd
10770 \begin_inset Quotes eld
10774 \begin_inset Quotes erd
10778 \begin_inset Quotes eld
10782 \begin_inset Quotes erd
10786 \begin_inset Quotes eld
10790 \begin_inset Quotes erd
10794 \begin_inset Quotes eld
10798 \begin_inset Quotes erd
10802 \begin_inset Quotes eld
10806 \begin_inset Quotes erd
10810 \begin_inset Quotes eld
10814 \begin_inset Quotes erd
10818 Their use is more or less obvious.
10819 LyX supports all these environments; it will use the proper label, text
10820 style, and numbering scheme for each of them.
10823 \begin_layout Enumerate
10824 Both packages use basic citations; the natbib package should not be used.
10825 In LyX, citation references are shown as usual; in the output, citations
10826 are shown as superscripts.
10827 If you want to use a citation as normal text, you should use the
10832 \begin_inset space \thinspace{}
10836 \begin_inset space \space{}
10840 \begin_inset Quotes eld
10844 \begin_inset space \space{}
10854 \begin_inset Quotes erd
10860 \begin_layout Enumerate
10862 \begin_inset Quotes eld
10866 \begin_inset Quotes erd
10869 section in both packages.
10870 To put acknowledgments, just use the
10871 \begin_inset Quotes eld
10875 \begin_inset Quotes erd
10881 \begin_layout Enumerate
10882 Appendices may be added to the paper,
10886 the Acknowledgments and
10891 LyX provides a special environment, called
10892 \begin_inset Quotes eld
10896 \begin_inset Quotes erd
10899 which marks the beginning of the appendices.
10900 This environment should be left blank; it just sends a LaTeX command, but
10901 nothing is really printed.
10903 \begin_inset Quotes eld
10907 \begin_inset Quotes erd
10910 is printed with blue letters, as a signal that all sections after that
10911 point are appendices.
10912 To write an appendix, use the
10913 \begin_inset Quotes eld
10917 \begin_inset Quotes erd
10921 LyX will number each appendix with capital letters, as required by both
10924 \begin_inset Quotes eld
10928 \begin_inset Quotes erd
10935 be present before the first appendix; if not, all appendices will be numbered
10936 as normal sections in the output.
10939 \begin_layout Enumerate
10940 The ijmpc and the ijmpd packages use the
10944 command to implement table captions.
10945 As a result, a table created by LyX is printed correctly, but its caption
10947 However, you can use some TeX code to overpass this problem, so that captions
10948 are printed as expected.
10949 To do so, create a float table as usual, remove the caption, and replace
10950 it with the TeX code
10960 (sic); you must also the TeX code
10964 immediately after the tabular material.
10965 Study the example table included in the template files to see how this
10966 trick is implemented.
10967 Alternatively, If you need table captions, you should implement the whole
10972 file, then include this file to the LyX document (
10974 Insert\SpecialChar \menuseparator
10975 File\SpecialChar \menuseparator
10977 \begin_inset space ~
10983 Details on how to create a table float can be found in the files
10991 , included in the corresponding packages.
10994 \begin_layout Subsection
10995 Preparing a paper for submission
10998 \begin_layout Standard
10999 Before you submit your paper you must export the LyX document as a LaTeX
11002 File\SpecialChar \menuseparator
11003 Export\SpecialChar \menuseparator
11010 \begin_layout Plain Layout
11011 Actually you have the choice between LaTeX (plain) and pdflatex.
11012 If you intend to use pdflatex to prepare the paper, you should use the
11013 pdflatex option so that included graphics are converted to PDF format,
11014 ready for use by pdflatex.
11019 , then make the following changes to the resulting
11026 \begin_layout Enumerate
11027 Remove the comment lines before the
11036 \begin_layout Enumerate
11037 Remove everything between (and including) the
11049 commands, except for any commands you specifically put into the LaTeX preamble.
11052 \begin_layout Standard
11057 file should be saved and processed through LaTeX as many times as necessary.
11058 You may also want to check the resulting
11065 \begin_layout Subsection
11069 \begin_layout Standard
11070 The use of TeX code is reduced to two commands, which must be placed at
11071 the top of the document.
11072 If you started writing your paper by using the
11080 template, the TeX code needed is already in its place; you usually don't
11082 You may only modify the first TeX code to specify the information printed
11083 to the top of odd and even pages (authors' names and short paper's title,
11085 This TeX code must have the form
11089 markboth{Authors' Names}{Short Paper's Title}
11094 \begin_layout Section
11098 \begin_layout Standard
11104 \begin_layout Subsection
11108 \begin_layout Standard
11109 The iopart package provides a document class to create electronic manuscript
11110 submission to the journals published by the Institute of Physics.
11111 Instructions for the authors how to create a paper using the iopart class
11112 can be downloaded together with the iopart package from the site
11113 \begin_inset Flex URL
11116 \begin_layout Plain Layout
11118 ftp://ftp.iop.org/pub/journals/latex2e
11126 \begin_layout Subsection
11130 \begin_layout Standard
11131 The easiest way to write a paper is to start with the file
11135 that is available in LyX's examples files folder.
11136 Open this file, save it under a new name, and start writing.
11137 The example file explains how to use the special text environments.
11138 Here are the most important advices:
11141 \begin_layout Itemize
11142 To be able to compile your document to a PDF, PS, or DVI, assure that the
11145 Use AMS math package
11147 in the document settings under
11154 \begin_layout Itemize
11157 The title environment defines the kind of your paper.
11158 So use one of the following environments for the title:
11162 \begin_layout Itemize
11171 \begin_layout Itemize
11180 \begin_layout Itemize
11186 for a Topical review
11189 \begin_layout Itemize
11198 \begin_layout Itemize
11207 \begin_layout Itemize
11213 for a Paper (same as Title)
11216 \begin_layout Itemize
11222 for a Preliminary communication
11225 \begin_layout Itemize
11231 for a Rapid communication
11234 \begin_layout Itemize
11240 for a Letter to the editor
11244 \begin_layout Itemize
11247 All title environments except of
11251 can have an optional short title.
11254 \begin_layout Itemize
11255 There is a general title environment
11259 which is not directly supported by the LyX.
11260 This can be used as TeX code when your document doesn't fit into one of
11261 the other title types.
11264 \begin_layout Standard
11265 For more informations like hints for special table and formula formatting,
11266 look at the IOP author guidelines.
11269 \begin_layout Section
11273 \begin_layout Standard
11276 Panayotis Papasotiriou
11279 \begin_layout Subsection
11283 \begin_layout Standard
11284 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
11285 that facilitates electronic manuscript submission to the journals they
11287 Most known of them (at least in my domain of interest) are
11289 Astrophysics and Space Science
11295 , but there are many others (see a complete list at
11296 \begin_inset Flex URL
11299 \begin_layout Plain Layout
11301 http://www.wkap.nl/jrnllist.htm/JRNLHOME
11307 The Kluwer package may be downloaded from the site
11308 \begin_inset Flex URL
11311 \begin_layout Plain Layout
11313 http://www.wkap.nl/kaphtml.htm/STYLEFILES
11319 A complete user guide is contained in that package (but it can also be
11320 downloaded separately).
11323 \begin_layout Standard
11324 LyX supports many features of the package but not everything.
11325 However, the TeX code needed is reduced to some
11326 \begin_inset Quotes eld
11330 \begin_inset Quotes erd
11333 commands of the package (see
11334 \begin_inset space ~
11338 \begin_inset CommandInset ref
11340 reference "subsec:kluwer_peculiarities"
11345 I have recently used LyX to write an article submitted to the
11347 Astrophysics and Space Science
11349 without any problem.
11352 \begin_layout Subsection
11356 \begin_layout Standard
11357 The easiest way to write a paper is to start with the Kluwer template file.
11360 File\SpecialChar \menuseparator
11372 This will give an (almost) empty document that includes the most common
11373 fields found in a manuscript and a short description of their use.
11374 As in most templates, simply overwrite the existing text (including the
11379 ) with the correct information.
11382 \begin_layout Subsection
11383 Preparing a paper for submission
11386 \begin_layout Standard
11387 As in the AASTeX package, before you submit your paper to a journal you
11389 \begin_inset Quotes eld
11393 \begin_inset Quotes erd
11399 \begin_layout Enumerate
11400 Export your paper as a LaTeX file.
11401 To do this, click on
11403 File\SpecialChar \menuseparator
11404 Export\SpecialChar \menuseparator
11411 \begin_layout Enumerate
11416 file with a text editor and make the following changes
11420 \begin_layout Enumerate
11421 remove the comment lines before the
11430 \begin_layout Enumerate
11431 remove everything between (and including) the
11443 commands, except for any commands you specifically put into the LaTeX preamble.
11446 \begin_layout Standard
11455 \begin_layout Enumerate
11460 file through LaTeX as many times as necessary (usually up to three).
11463 \begin_layout Enumerate
11469 \begin_inset space \thinspace{}
11473 \begin_inset space \space{}
11480 , and check if everything is OK (it should, if you didn't make any mistake).
11483 \begin_layout Subsection
11484 \begin_inset Quotes eld
11488 \begin_inset Quotes erd
11491 of the Kluwer package
11492 \begin_inset CommandInset label
11494 name "subsec:kluwer_peculiarities"
11501 \begin_layout Standard
11502 The Kluwer package has the following
11503 \begin_inset Quotes eld
11507 \begin_inset Quotes erd
11513 \begin_layout Enumerate
11514 It is possible to write multiple articles in the same LaTeX file
11518 \begin_layout Plain Layout
11519 I can't imagine any good reason to do this.
11525 Each article must be included in the environment
11526 \begin_inset Quotes eld
11530 \begin_inset Quotes erd
11534 Unfortunately, this environment cannot be omitted, even if you write just
11536 Therefore, each article starts with the command
11542 and, obviously, ends with the command
11549 Although this can be implemented in LyX, I didn't included it, since it
11550 looks ugly and can confuse the novice user.
11551 Therefore, you need to enter them directly and mark them as LaTeX code
11553 \begin_inset Quotes eld
11557 \begin_inset Quotes erd
11563 \begin_layout Enumerate
11564 Information given at the beginning of the article (i.
11565 \begin_inset space \thinspace{}
11569 \begin_inset space \space{}
11572 title, subtitle, author, institution, running title, running author, abstract
11573 and keywords) must be included in an environment called
11574 \begin_inset Quotes eld
11578 \begin_inset Quotes erd
11582 This is not implemented in LyX, so you must enter title, subtitle etc.
11583 \begin_inset space ~
11586 between two TeX code lines (
11601 \begin_layout Enumerate
11602 According to the user manual, the label of each bibliography item must be
11626 \begin_layout Standard
11631 template takes care of all these
11632 \begin_inset Quotes eld
11636 \begin_inset Quotes erd
11640 If you start a new paper using this template you don't need to do anything
11645 \begin_layout Enumerate
11646 don't delete the TeX code included in the template, and
11649 \begin_layout Enumerate
11650 copy the example bibliography item included in the template and modify it
11651 as necessary to enter new bibliography items.
11654 \begin_layout Section
11658 \begin_layout Standard
11664 \begin_layout Subsection
11668 \begin_layout Standard
11669 The LyX document classes
11671 article (koma-script)
11675 report (koma-script)
11693 correspond to the LaTeX document classes
11710 \begin_inset space ~
11713 of the Koma-Script family.
11714 They are replacements for the standard document classes
11730 , resp., and fit better to European typography conventions in a number of
11734 \begin_layout Itemize
11735 Standard character size is 11pt in
11737 article (koma-script)
11741 report (koma-script)
11749 letter (koma-script)
11754 \begin_layout Itemize
11755 Headings, labels of the description environment, and a number of elements
11758 letter (koma-script)
11760 document class are set in a bold sans serif font.
11764 \begin_layout Plain Layout
11765 There is a big difference between the bold sans serif old cm fonts and new
11766 ec fonts, especially in the appearance of headings.
11767 In comparison, the ec bold sans serif fonts look a bit thin.
11768 Here the LaTeX package
11776 helps to produce the
11777 \begin_inset Quotes eld
11781 \begin_inset Quotes erd
11784 appearance when using the ec fonts.
11789 The numbering of chapter headings is made in the same way as the numbering
11790 of section headings, that is without the extra line
11791 \begin_inset Quotes eld
11794 Chapter\SpecialChar \ldots{}
11796 \begin_inset Quotes erd
11800 In addition, the appearance of the headings can be modified by using a
11801 number of options (in LyX to be entered in the field
11804 \begin_inset space ~
11811 Layout\SpecialChar \menuseparator
11815 A detailed German description of these options can be found in the Koma-Script
11823 \begin_layout Itemize
11824 The main means in the Koma-Script document classes to design the type area
11833 (in LyX to be entered in the extra class options field in the dialog
11835 Document\SpecialChar \menuseparator
11839 They make a clearer modification of page margins possible as do the options
11842 Document\SpecialChar \menuseparator
11846 A detailed German description of these and other type area options can
11847 be found in the Koma-Script documentation
11854 \begin_layout Itemize
11855 The LaTeX document classes of the Koma-Script family define a number of
11856 additional commands.
11857 Those part of it which makes sense in LyX is implemented in corresponding
11861 \begin_layout Standard
11862 A detailed German description of the LaTeX document classes of the Koma-Script
11863 family can be found in the Koma-Script documentation
11871 \begin_layout Plain Layout
11872 There is an English translation
11876 , but it is not a complete one.
11881 The following sections describe only those aspects, which are relevant
11885 \begin_layout Subsection
11886 article (koma-script), report (koma-script), and book (koma-script)
11889 \begin_layout Standard
11890 The document classes
11892 article (koma-script)
11896 report (koma-script)
11906 are implemented in the layout files
11919 They contain all the paragraph types of the corresponding standard document
11932 , resp., partly modified, with the exception of the LyX specific
11936 -type, which is replaced by the new
11940 -type having the same functionality.
11945 -Type there is a number of new paragraph types added.
11952 letter (koma-script)
11957 \begin_layout Itemize
11966 : are equivalents to
11974 , resp., additionally inserting an entry in the table of contents.
11983 are not contained in
11985 article (koma-script)
11990 \begin_layout Itemize
11999 : behave exactly as
12007 , resp., additionally clearing running heads.
12012 is not contained in
12014 article (koma-script)
12020 \begin_layout Plain Layout
12033 report (koma-script)
12035 , but since this is identical to
12039 , is has not been implemented in LyX.
12047 \begin_layout Itemize
12052 : generates a heading directly above the following paragraph in the standard
12053 character size without affecting the structure of the document.
12056 \begin_layout Itemize
12065 are special captions which respect the different space settings needed
12066 for captions placed above or below an element (if you follow strict typographic
12067 rules, you might want to place table captions always above the table).
12068 You can also use the class option
12072 , which will switch
12085 You need at least Koma-Script version 2.8q to use this.
12088 \begin_layout Itemize
12093 : can be used to set a bonmot, e.
12094 \begin_inset space \thinspace{}
12098 \begin_inset space \space{}
12101 at the beginning of a chapter.
12102 If you use the optional argument (
12104 Insert\SpecialChar \menuseparator
12106 \begin_inset space ~
12111 ), you can insert the dictum's author there.
12112 Dictum and author are separated by a line.
12113 You need at least Koma-Script version 2.8q to use this.
12118 is not contained in
12120 article (koma-script)
12125 \begin_layout Standard
12126 The following types, together with the standard types
12138 , form the title area of the document.
12139 They must be entered ahead of the first
12140 \begin_inset Quotes eld
12144 \begin_inset Quotes erd
12151 \begin_layout Plain Layout
12152 The corresponding LaTeX commands must appear before the
12163 When such a type is used more than once, the latter usage overwrites the
12164 former one, that means, for every type only the latest usage is valid.
12165 The order of the different types however has, like
12177 , no effect on the appearance of the produced document.
12180 \begin_layout Itemize
12185 : produces a centered paragraph above the ordinary title (
12197 ) for the subject of the document.
12200 \begin_layout Itemize
12205 : produces a centered paragraph below the ordinary title (
12217 ) for the publishers' name.
12220 \begin_layout Itemize
12227 report (koma-script)
12233 produces a centered paragraph on its own page behind the title page, or
12236 article (koma-script)
12238 produces a centered paragraph below the ordinary title (
12254 ) for a dedication.
12257 \begin_layout Itemize
12262 : produces a left aligned paragraph above the ordinary title (
12278 ) for a document`s head.
12281 \begin_layout Itemize
12286 : produces in a double-sided print in
12288 report (koma-script)
12294 a left-aligned paragraph at the top of the title page`s back or has no
12295 effect in a single-sided print or in
12297 article (koma-script)
12302 \begin_layout Itemize
12307 : produces in a double-sided print in
12309 report (koma-script)
12315 a left-aligned paragraph at the bottom of the title page`s back or has
12316 no effect in a single-sided print or in
12318 article (koma-script)
12323 \begin_layout Itemize
12328 : produces a special
12329 \begin_inset Quotes eld
12333 \begin_inset Quotes erd
12336 page ahead of the actual document containing a paragraph without special
12340 \begin_layout Standard
12341 The layout files for the document classes
12343 article (koma-script)
12347 report (koma-script)
12353 do include the file
12358 This is thought of as a place to define your own types.
12363 in your personal layout directory and edit the file!
12366 \begin_layout Subsection
12367 letter (koma-script)
12370 \begin_layout Standard
12374 \begin_layout Plain Layout
12386 \begin_layout Standard
12390 letter (koma-script)
12392 is implemented in the layout file
12397 It contains all the paragraph types of the corresponding standard document
12402 , partly modified, with the exception of the LyX specific types
12414 type, which is replaced by the new
12419 In addition, it contains, in contrast to the standard document class, the
12437 Furthermore, there are a number of new letter specific types.
12440 \begin_layout Standard
12444 \begin_layout Plain Layout
12456 \begin_layout Standard
12457 The appearance of the letter produced by this document class can be controlled
12458 by a number of LaTeX commands, which you can put in the LaTeX preamble.
12462 \begin_layout Plain Layout
12463 For example, the standard appearance of the letter`s heading, consisting
12464 of name and address, is quite self-willed.
12466 \begin_inset Quotes eld
12470 \begin_inset Quotes erd
12473 heading is produced by the following LaTeX commands in the preamble:
12476 \begin_layout LyX-Code
12486 \begin_layout LyX-Code
12502 \begin_layout LyX-Code
12512 \begin_layout LyX-Code
12532 A detailed German description of such LaTeX commands can be found in the
12533 Koma-Script documentation
12538 With it, the letter's author can produce his personal letter layout.
12541 \begin_layout Standard
12550 define the beginning of the letter and must be used in every letter.
12551 To emphasize them in the LyX document class, they are marked with the letter
12561 \begin_inset space ~
12564 in the left margin.
12565 It is possible to write any number of letters in one file.
12570 type produces a new letter using the same addressee and a
12574 type produces a new addressee.
12591 are ordinary paragraph types and can also be used several times in one
12592 and the same letter.
12595 \begin_layout Itemize
12600 : produces a paragraph for the addressee and implicitly defines the beginning
12604 \begin_layout Itemize
12609 : produces a paragraph for the form of address and implicitly produces a
12613 \begin_layout Itemize
12618 : produces a paragraph for a close.
12621 \begin_layout Itemize
12626 : produces a paragraph for a postscript.
12629 \begin_layout Itemize
12634 : produces a paragraph for a distribution list.
12637 \begin_layout Itemize
12642 : produces a paragraph for enclosures.
12645 \begin_layout Standard
12686 are input types provided with a label to enter information, which will
12687 be processed by the document class.
12691 \begin_layout Plain Layout
12692 It could be seen as a matter of inconsequence, that the types
12700 described above are not such input types as well.
12701 Because of the special meaning of those types, however, I have implemented
12702 them as ordinary paragraph types with a one letter mark in the left margin.
12703 Moreover, it would affect my feeling of symmetry, if the
12711 type had such a serious different appearance.
12716 The types must be used ahead of the corresponding
12723 \begin_layout Standard
12724 An implementation of these types in a WYSIWYG fashion does not seem to make
12725 sense, because the real appearance of the produced letter does not only
12726 depend on the usage of the particular type, but also on other factors.
12727 For example, a signature entered in the
12731 type will in the standard behavior appear in the produced letter only,
12732 when in the same letter also a
12737 The entered value of the
12741 type will in the standard behavior not appear in the produced letter at
12743 The possibility to design the letter`s heading freely is already indicated
12744 in a footnote above.
12747 \begin_layout Standard
12748 The input types can also be used as empty paragraphs.
12749 This makes sense e.
12750 \begin_inset space \thinspace{}
12754 \begin_inset space \space{}
12766 type is not used at all, in the standard behavior the value of the
12770 type is used as signature, whereas if an empty
12774 type is used, no signature value is defined.
12777 \begin_layout Standard
12778 By using the input types it is possible to write a letter template, containing
12779 filled input types with your personal dates (name, address, etc.) and empty
12780 input types for other dates you want to enter.
12783 \begin_layout Itemize
12788 : sender's name, in the standard behavior appears as a centered paragraph
12789 in small caps in the letter`s heading.
12792 \begin_layout Itemize
12797 : sender's signature, in the standard behavior appears below the
12806 type is used, the value of the
12810 type appears instead.
12813 \begin_layout Itemize
12818 : sender's address, in the standard behavior appears in a centered paragraph
12819 in the letter`s heading below the sender's name.
12822 \begin_layout Itemize
12827 : sender's telephone number, in the standard behavior only sets the LaTeX
12837 \begin_layout Itemize
12842 : place of the letter`s making.
12845 \begin_layout Itemize
12850 : date of the letter`s making.
12859 , in the standard behavior, produce the place and the date in a right-aligned
12860 line below the addressee's field.
12865 type is used, neither place nor date appear, independent of the value of
12875 type is used, the date of the letter `s production is used.
12878 \begin_layout Itemize
12883 : sender`s back address, in the standard behavior appears above the addressee's
12884 field in a small sans serif font.
12887 \begin_layout Itemize
12892 : special mail information, in the standard behavior appears underlined
12893 above the addressee's field below the back address.
12896 \begin_layout Itemize
12901 : additional information, in the standard behavior appears on right side
12902 below the addressee`s field.
12905 \begin_layout Itemize
12910 : the letter's title, in the standard behavior appears in a big, bold, sans
12911 serif font above the subject.
12914 \begin_layout Itemize
12919 : the letter's subject, in the standard behavior appears in a bold font
12927 \begin_layout Standard
12948 produce a business letter like line above the
12952 line containing the fields
12953 \begin_inset Quotes eld
12957 \begin_inset Quotes erd
12961 \begin_inset Quotes eld
12965 \begin_inset Quotes erd
12969 \begin_inset Quotes eld
12973 \begin_inset Quotes erd
12977 \begin_inset Quotes eld
12981 \begin_inset Quotes erd
12985 \begin_inset Quotes eld
12989 \begin_inset Quotes erd
12993 \begin_inset Quotes eld
12997 \begin_inset Quotes erd
13001 For the date field, the value of the
13007 \begin_inset Quotes eld
13010 business letter types
13011 \begin_inset Quotes erd
13014 is used, the value of the
13018 type however does not appear, but only the LaTeX variable
13025 The ordinary output of place and date in a right-aligned line below the
13026 addressee`s field is suppressed.
13027 The types are implemented as input types provided with a label and must
13028 be used ahead of the corresponding
13035 \begin_layout Itemize
13043 \begin_layout Itemize
13051 \begin_layout Itemize
13059 \begin_layout Itemize
13067 \begin_layout Itemize
13075 \begin_layout Subsection
13076 The new letter class: letter (koma-script v.2)
13079 \begin_layout Standard
13082 Jürgen Spitzmüller
13085 \begin_layout Standard
13086 \begin_inset VSpace medskip
13092 \begin_layout Standard
13094 Koma-Script version 2.8 has introduced a new letter class
13098 which supersedes the now unsupported
13103 It has — on the LaTeX side — a completely new interface and is not compatible
13104 with the old class.
13105 Therefore, LyX supports both, though it is recommended to use the new class.
13108 \begin_layout Standard
13109 This class covers the same functionality as
13111 letter (koma-script),
13114 The basic items are
13118 (receiver's address, same as
13122 in the old layout),
13135 will start a new letter (i.
13136 \begin_inset space \thinspace{}
13140 \begin_inset space \space{}
13143 you can write several letters per document).
13144 New elements are sender's
13160 and the possibility to use a
13166 Insert\SpecialChar \menuseparator
13172 \begin_layout Standard
13173 The biggest improvement is, though, that the letter's layout is configurable
13174 at almost any needs.
13175 This can be done via the preamble or with a special style file (Letter
13176 Class Option, extension
13180 ), that will be read in as a class option.
13184 \begin_layout Plain Layout
13185 The KOMA package comes with some default
13190 There is, for instance, a
13194 file that follows german typesetting rules, or a
13198 that provides the default layout of the old
13203 The latter can be loaded with the class option
13212 ayout\SpecialChar \menuseparator
13217 ocument\SpecialChar \menuseparator
13229 template that is included in LyX for examples.
13230 A detailed description is to be found in the Koma-Script documentation
13238 \begin_layout Subsection
13242 \begin_layout Standard
13243 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
13247 \begin_layout Itemize
13248 The chapter number of a
13252 type appears on a line of its own above the chapter heading instead of
13253 appearing in the same line ahead of it.
13254 The cause for that is the LyX internal behavior for the labeltype
13258 in the layout file.
13261 \begin_layout Itemize
13262 The headings of the types
13270 are only put in the
13271 \begin_inset Quotes eld
13275 \begin_inset Quotes erd
13278 LaTeX table of contents, but not in the LyX table of contents (
13280 Document\SpecialChar \menuseparator
13282 \begin_inset space ~
13286 \begin_inset space ~
13294 \begin_layout Itemize
13295 The paragraphs in a
13299 document class appear in a skip separation mode, not indented.
13300 This is the standard behavior, no special LaTeX commands are needed for
13304 Document\SpecialChar \menuseparator
13307 dialog the corresponding radio button indicates
13316 value always has the effect that extra LaTeX commands are inserted in the
13317 document to produce the gap, which is not what is wanted in this case.
13320 \begin_layout Section
13321 Latex8 (IEEE Conference Papers)
13324 \begin_layout Standard
13330 \begin_layout Subsection
13334 \begin_layout Standard
13335 Since this class is specifically for writing submissions to IEEE sponsored
13336 conferences I strongly recommend that you get a copy of their Authors Kit.
13341 package and associated bibliography style file is included in the kit.
13342 The Authors Kit is usually sent out by email once your initial submission
13344 There is a lot of useful information in the Authors Kit explaining formatting
13345 restrictions and so on and I will assume you have read this since that
13346 means I don't have to repeat it all here.
13349 \begin_layout Subsection
13353 \begin_layout Standard
13354 [AR\SpecialChar \@.
13358 \begin_layout Subsection
13359 Supported Environments
13362 \begin_layout Itemize
13368 \begin_layout Itemize
13374 \begin_layout Itemize
13380 \begin_layout Itemize
13386 \begin_layout Itemize
13392 \begin_layout Itemize
13398 \begin_layout Itemize
13404 \begin_layout Itemize
13410 \begin_layout Itemize
13416 \begin_layout Subsection
13417 Differences Between Screen and Paper
13420 \begin_layout Standard
13421 There are slight differences in appearance mainly with the presentation
13422 of section counters.
13423 On screen the trailing period of the section counter is missing but it
13424 will appear in the output so don't let this worry you.
13427 \begin_layout Section
13431 \begin_layout Standard
13434 Jürgen Spitzmüller
13437 \begin_layout Subsection
13441 \begin_layout Standard
13442 Memoir is a very powerful and constantly evolving class.
13443 It has been designed with regard to fictional and non-fictional literature.
13444 Its aim is to let the user have maximum control over the typesetting of
13446 Memoir is based on the standard book class, but it can also emulate the
13447 article class (see below).
13450 \begin_layout Standard
13451 Peter Wilson, the developer of Memoir, is known as the author of lots of
13452 useful packages in the LaTeX world.
13453 Most of them have been merged with Memoir.
13454 Therefore, it is much easier to layout the table of contents, appendices,
13455 chapter designs and such.
13456 LyX, though, does not support all of these goodies natively.
13457 Some of them might be added to forthcoming releases
13461 \begin_layout Plain Layout
13462 You are invited to send suggestions to
13463 \begin_inset Flex URL
13466 \begin_layout Plain Layout
13468 lyx-devel@lists.lyx.org
13478 , lots will probably never, due to the limitations of LyX's framework.
13479 Of course you can still use all features with the help of some native LaTeX
13484 \begin_layout Plain Layout
13489 \begin_layout Plain Layout
13499 \begin_inset space ~
13503 \begin_inset CommandInset ref
13505 reference "sec:Inserting-TeX-Code"
13515 In this section, we can only list those features which are natively supported
13517 For detailed descriptions (and for the rest of features) we are recommending
13518 to have a look at the detailed manual of the Memoir class
13522 \begin_layout Plain Layout
13527 \begin_layout Plain Layout
13537 \begin_inset Flex URL
13540 \begin_layout Plain Layout
13542 CTAN:/macros/latex/memoir/memman.pdf
13552 , which is not only a user guide for the class, but also both a comprehensive
13553 description on good typesetting and a superb example for good typesetting
13557 \begin_layout Subsection
13558 Basic features and restrictions
13561 \begin_layout Standard
13562 Memoir supports basically all features of the standard book classes.
13563 There are, however, some differences, as follows:
13566 \begin_layout Description
13568 \begin_inset space ~
13571 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
13574 \begin_layout Description
13576 \begin_inset space ~
13579 style: The fancy page style is not supported, due to a command clash between
13580 Memoir and the fancyhdr package (they are both defining a command with
13581 the same name, which confuses LaTeX).
13582 Instead, Memoir comes with a bunch of own page styles (see
13584 Layout\SpecialChar \menuseparator
13585 Document\SpecialChar \menuseparator
13587 \begin_inset space ~
13593 If you want to use these for the chapter pages, you have to use the command
13600 in the main text or in preamble (e.
13601 \begin_inset space \thinspace{}
13605 \begin_inset space \space{}
13612 chapterstyle{companion}
13617 \begin_layout Description
13618 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
13619 an optional argument in the standard classes.
13620 With this, you can specify an alternative version of the title for the
13621 table of contents and the headers (for instance, if the title is too long).
13622 In LyX, you can do this via
13624 Insert\SpecialChar \menuseparator
13626 \begin_inset space ~
13631 at the beginning of a chapter/section.
13632 Memoir features a second optional argument and thus separates the table
13633 of contents from the header.
13634 You can define three variants of a title with this: one for the main text,
13635 one for the table of contents, and one for the headers.
13636 Simply insert two optional arguments if you need this feature, the first
13637 one containing the short title for the Table of Contents, the second one
13638 containing an alternative short title for the headers.
13641 \begin_layout Description
13642 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
13643 of contents, the list of figures and the list of table start a new page
13645 Memoir does not follow this route.
13646 You have to insert a page break yourself, if you want to have one.
13649 \begin_layout Description
13650 Titlepage: For some unknown reason, Memoir uses pagination on the title
13651 page (in the standard classes, title pages are
13652 \begin_inset Quotes eld
13656 \begin_inset Quotes erd
13660 \begin_inset space \thinspace{}
13664 \begin_inset space \space{}
13668 If you want an empty title page, type
13672 aliaspagestyle{title}{empty}
13677 \begin_layout Description
13678 Article: With the class option
13684 Layout\SpecialChar \menuseparator
13685 Document\SpecialChar \menuseparator
13687 \begin_inset space ~
13692 ), you can emulate article style.
13693 That is, counters (footnotes, figures, tables etc.) will not be reset on
13694 new chapters, chapters don't start a new page (but are—in contrary to
13695 \begin_inset Quotes eld
13699 \begin_inset Quotes erd
13702 article classes—still allowed), parts, though, use their own page, as in
13706 \begin_layout Description
13707 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
13708 font commands, which have been used in the old LaTeX version 2.09 (e.
13709 \begin_inset space \thinspace{}
13713 \begin_inset space \space{}
13729 It produces an error and stops LaTeX whenever such a command appears.
13734 reallows the commands and spits out warnings instead (which does at least
13736 Since a lot of packages and particularly BibTeX style files are still using
13737 those commands, we have decided to use this option by default.
13740 \begin_layout Subsection
13744 \begin_layout Standard
13745 We will only describe the features supported by LyX (which is not much currently
13747 Please consult the Memoir manual
13751 \begin_layout Plain Layout
13756 \begin_layout Plain Layout
13766 \begin_inset Flex URL
13769 \begin_layout Plain Layout
13771 CTAN:/macros/latex/memoir/memman.pdf
13784 \begin_layout Description
13785 Abstract: You may wonder why an abstract is an extra feature.
13786 Well, it is in book class.
13787 Usually books don't have abstracts.
13788 Memoir, however, has.
13789 You can use it wherever and how often you like.
13792 \begin_layout Description
13793 Chapterprecis: You may know this from belletristic: The contents of a chapter
13794 is shortly described below the title and also in the table of contents
13796 \begin_inset space \thinspace{}
13800 \begin_inset space \space{}
13805 Our hero arrives in Troia; he loses some friends; he finds others
13808 Chapterprecis does exactly this.
13809 It is therefore only sensible below a chapter.
13812 \begin_layout Description
13813 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
13814 The epigraph environment provides an elegant way of typesetting such a
13816 The motto itself (text) and its author (source) are divided by a short
13818 Unfortunately, we have to fool LyX a bit here again, since the environment
13819 needs two arguments (text and source).
13820 In this case, we have to use curly brackets (in TeX mode) between the two
13831 <author of the slogan>.
13834 \begin_layout Description
13835 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
13836 complex figurative poems).
13837 LyX can only support a few of them.
13838 One is poemtitle, which is a centered title for poems, which will also
13839 be added to the table of contents (verse is the standard environment for
13841 Memoir has some enhanced versions of verse, but you need to use TeX code,
13842 because they have to be nested inside regular verse environments, which
13843 is not possible with LyX).
13846 \begin_layout Description
13847 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
13850 \begin_layout Section
13851 Article (mwart), book (mwbk) and report (mwrep)
13852 \begin_inset OptArg
13855 \begin_layout Plain Layout
13868 \begin_layout Standard
13874 \begin_layout Standard
13875 The LyX document classes
13891 correspond to the LaTeX document classes
13904 They are replacements for the standard document classes
13916 , resp., and fit better to Polish typography conventions in a number of points.
13920 \begin_layout Standard
13924 \begin_layout Itemize
13925 Unnumbered titles (with star, e.
13926 \begin_inset space \thinspace{}
13930 \begin_inset space \space{}
13937 ) are added into table of contents,
13940 \begin_layout Itemize
13941 Additional page styles:
13945 \begin_layout Description
13946 uheadings header with separated lines,
13949 \begin_layout Description
13950 myheadings custom header, contents headers via commands:
13965 \begin_layout Description
13966 myuheadings custom header with separated lines,
13969 \begin_layout Description
13970 outer page number is placed on outer side of page
13974 \begin_layout Itemize
13979 \begin_layout Description
13980 rmheadings serif titles — default,
13983 \begin_layout Description
13984 sfheadings sansserif titles,
13987 \begin_layout Description
13988 authortitle on title page first placed is author next title — default,
13991 \begin_layout Description
13992 titleauthor on title page first placed is title next author,
13995 \begin_layout Description
13996 withmarginpar reserve place on page for margins.
14000 \begin_layout Section
14004 \begin_layout Standard
14009 provides an alternative to the standard
14014 It provides similar functionality, but you might prefer this layout with
14015 sans serif sections, headings, and more.
14018 \begin_layout Section
14022 \begin_layout Standard
14028 \begin_layout Standard
14029 \begin_inset VSpace bigskip
14035 \begin_layout Standard
14040 \begin_inset space ~
14045 textclass works with the American Physical Sociey's RevTeX 4.0 (the
14046 \begin_inset Formula $\beta$
14049 release of May, 1999) class.
14052 \begin_layout Standard
14057 textclass, which works with RevTeX 3.1.
14058 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
14059 That means that it doesn't interact very well with LyX, which requires
14060 LaTeX2e, although it has been kludged to work.
14061 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
14065 \begin_inset space ~
14070 textclass should also be pretty easy to use.
14073 \begin_layout Standard
14074 These documents are supposed to be used in
14078 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14079 macros, and assume you'll know what to put in the preamble if necessary.
14082 \begin_layout Subsection
14086 \begin_layout Standard
14087 All you need to do is install RevTeX 4, as described in the package's README
14089 The package can be found at The RevTeX 4 Web Site
14090 \begin_inset Flex URL
14093 \begin_layout Plain Layout
14095 http://publish.aps.org/revtex4/
14101 Install it somewhere that LaTeX can see it.
14102 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14104 \begin_inset space \thinspace{}
14108 \begin_inset space \space{}
14111 not the directory where you installed the class file.) Then, if you reconfigure
14112 LyX, it will find the class file and let you use the RevTeX4 textclass.
14115 \begin_layout Standard
14116 Probably the easiest way to get started is either to import a RevTeX 4 document
14124 \begin_inset space ~
14129 template, found in the templates directory.
14132 \begin_layout Subsection
14136 \begin_layout Standard
14137 Optional arguments to
14144 \begin_inset Quotes eld
14148 \begin_inset Quotes erd
14152 \begin_inset Quotes eld
14156 \begin_inset Quotes erd
14166 \begin_inset space ~
14174 \begin_inset space ~
14180 Remember that in RevTeX, at least one optional argument is required!
14183 \begin_layout Standard
14184 Other preamble matter, like
14191 \begin_inset space ~
14197 \begin_inset space ~
14202 dialog, also as usual.
14205 \begin_layout Subsection
14209 \begin_layout Standard
14210 The layouts basically correspond to the commands in RevTeX4.0.
14211 For example, the Email layout corresponds to
14218 Note that (at least as of RevTeX 4.0 Beta), the
14226 layouts are exactly equivalent, so you shouldn't need to use both.
14230 \begin_layout Plain Layout
14231 In case you're curious, both were included so that
14235 would be able to translate both
14255 \begin_layout Subsection
14259 \begin_layout Standard
14260 There are a couple of important unique aspects of RevTeX 4 which might cause
14261 bugs that will be even more confusing in LyX.
14264 \begin_layout Standard
14282 The LyX equivalent is that there is a separate Thanks layout.
14287 write footnotes in the
14291 layout, or weird things may happen.
14292 See the RevTeX 4 documentation for more details.
14295 \begin_layout Standard
14299 \begin_inset space ~
14307 \begin_inset space ~
14316 layouts must be placed
14324 layout and the corresponding
14341 , the LaTeX won't compile.
14344 \begin_layout Subsection
14348 \begin_layout Standard
14349 The main problem with this layout is that you can't use the optional arguments
14350 to layouts like Email and Title.
14351 (The problem is not unique to this layout; you can't use optional arguments
14352 to the Section layouts either.) This means that after you export that file
14353 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14354 need to edit the LaTeX file with a text editor to add the optional arguments
14356 \begin_inset space \thinspace{}
14360 \begin_inset space \space{}
14363 the running title for the page headers.
14364 Lacking these layouts makes the
14370 (and the equivalent
14376 ) useless, so the corresponding layouts don't exist, and will have to be
14381 \begin_layout Plain Layout
14386 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14387 has not been updated yet to take advantage of it.
14395 \begin_layout Section
14396 Springer Journals (
14403 \begin_layout Standard
14409 \begin_layout Subsection
14413 \begin_layout Standard
14414 These are the layout files for some of the journal formats used by Springer
14415 Verlag and listed on
14416 \begin_inset Flex URL
14419 \begin_layout Plain Layout
14421 http://www.springer.de/author/tex/help-journals.html
14426 , where you should also go to fetch the class files (yes, these are LaTeX2e
14428 It is a modular system: the things common to all journals are implemented
14433 , which journal-specific layout files (such as, e.
14434 \begin_inset space \thinspace{}
14438 \begin_inset space \space{}
14445 for Journal of Geodesy) can include.
14448 \begin_layout Standard
14449 This means that implementing support for any other Springer journal on this
14450 list is as simple as writing your own
14458 file following the outline given in
14466 \begin_layout Standard
14467 It is reasonably well tested only for the Journal of Geodesy.
14476 come with the standard LyX distribution.
14477 Install the relevant class file (downloaded from Springer) in a proper
14478 directory, reconfigure LaTeX (in the teTeX case by running
14482 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
14483 and it should work.
14486 \begin_layout Subsection
14490 \begin_layout Standard
14491 A large number of theorem-like styles —
14497 \SpecialChar \ldots{}
14503 \begin_layout Standard
14506 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
14507 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
14510 See the Springer class file documentation for details.
14513 \begin_layout Subsection
14517 \begin_layout Itemize
14529 \begin_layout Itemize
14532 Probability Theory and Related Fields
14538 — Jean-Marc Lasgouttes
14541 \begin_layout Standard
14542 Add your own, it isn't so hard!
14545 \begin_layout Subsection
14549 \begin_layout Standard
14550 These files are partly based on the older
14554 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
14555 file from Springer.
14560 layout, are now defunct.
14561 Jean-Marc Lasgouttes helped out big in making me find my way around the
14562 LyX layout file mechanism.
14565 \begin_layout Subsection
14569 \begin_layout Standard
14571 But probably less than in the old hacked-LaTeX
14578 \begin_layout Standard
14580 \begin_inset space \thinspace{}
14583 g.: does not display the number for theorem-like layouts, just #.
14586 \begin_layout Section
14592 \begin_inset CommandInset label
14601 \begin_layout Standard
14609 \begin_layout Subsection
14613 \begin_layout Standard
14614 This section describes how to use LyX to make slides for overhead projectors.
14615 There are two document classes that can do this: the default slides class
14621 This section documents the former.
14624 \begin_layout Standard
14625 I'm going to say this again, nice and clear, so that there's no misunderstanding
14629 \begin_layout Standard
14630 \begin_inset VSpace bigskip
14636 \begin_layout Standard
14640 This section documents the class
14641 \begin_inset Quotes eld
14649 \begin_inset Quotes erd
14657 \begin_layout Standard
14658 \begin_inset VSpace bigskip
14664 \begin_layout Standard
14665 If you're looking for the documentation for
14666 \begin_inset Quotes eld
14674 \begin_inset Quotes erd
14677 , check out section
14678 \begin_inset space ~
14682 \begin_inset CommandInset ref
14684 reference "sec:foiltex"
14694 \begin_inset Quotes eld
14702 \begin_inset Quotes erd
14705 ] is actually somewhat better than the default
14713 \begin_layout Plain Layout
14714 \SpecialChar \ldots{}
14715 or so I've been told repeatedly by its advocates.
14716 Having never used it, I have no idea if this claim is true or not.
14721 which this section documents.
14724 \begin_layout Standard
14725 This class is the LaTeX2e improvement of the old
14730 Every LaTeX2e distribution includes this class [which I'll just refer to
14732 \begin_inset Quotes eld
14740 \begin_inset Quotes erd
14743 from now on], so you're bound to have it.
14744 As I noted earlier, there are other classes, such as
14748 , which also produce slides for overhead projectors and do a better job
14750 However, there are some things which
14754 can do which the others can't, such as generate overlays.
14755 Read on to learn more!
14758 \begin_layout Subsection
14760 \begin_inset CommandInset label
14762 name "sec:slidesetup"
14769 \begin_layout Standard
14770 Obviously, to use this document class, you need to select
14771 \begin_inset Quotes eld
14779 \begin_inset Quotes erd
14782 from the class list in the
14784 Document\SpecialChar \menuseparator
14788 There are some other special things you should know about this class:
14791 \begin_layout Itemize
14792 Don't bother changing the options
14797 They're not supported by the
14804 \begin_layout Itemize
14808 \begin_inset space ~
14813 behaves a bit differently for this class.
14814 The possible choices and what they do are as follows:
14818 \begin_layout Description
14823 The final output contains page numbers in the lower right corner.
14826 \begin_layout Description
14835 , but also prints out any time markers you've put in.
14836 This is the default.
14839 \begin_layout Description
14844 The final output contains no page numbers, time markers, or alignment markers.
14848 \begin_layout Itemize
14853 class has an extra option:
14859 \begin_inset Quotes eld
14867 \begin_inset Quotes erd
14870 in the extra class options.
14874 \begin_layout Standard
14875 Using this options allows you to add time markers to
14881 \begin_inset space ~
14885 \begin_inset CommandInset ref
14887 reference "sec:slideNote"
14895 \begin_layout Standard
14896 You can also use the template file
14897 \begin_inset Quotes eld
14905 \begin_inset Quotes erd
14908 to automatically set up a document to use the
14914 File\SpecialChar \menuseparator
14916 \begin_inset space ~
14920 \begin_inset space ~
14925 to open your new document].
14926 The template file also contains some examples of the special paragraph
14927 environments used by this class.
14928 I'll describe those next.
14931 \begin_layout Subsection
14932 Paragraph Environments
14935 \begin_layout Subsubsection
14936 Supported Environments
14939 \begin_layout Standard
14940 The first thing you'll notice when you start up a new
14944 document is the font size and type: it's the equivalent of the size
14945 \begin_inset Quotes eld
14953 \begin_inset Quotes erd
14959 \begin_inset space ~
14965 This is also what's used in the output.
14967 \begin_inset Quotes eld
14971 \begin_inset Quotes erd
14974 to remind you that this is a slide.
14975 Your final slides will use a larger font; ergo, you'll have less space.
14976 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
14979 \begin_layout Standard
14980 The next thing that becomes obvious is the changes to the paragraph environment
14981 pull-down box [at the far-left end of the toolbar].
14982 Most of the paragraph environments you're used to seeing are missing.
14983 There are also five new ones.
14988 class itself only supports certain paragraph environments:
14991 \begin_layout Itemize
14997 \begin_layout Itemize
15003 \begin_layout Itemize
15009 \begin_layout Itemize
15015 \begin_layout Itemize
15021 \begin_layout Itemize
15027 \begin_layout Itemize
15033 \begin_layout Itemize
15039 \begin_layout Itemize
15045 \begin_layout Itemize
15051 \begin_layout Itemize
15057 \begin_layout Standard
15058 All of the other standard environments, including the section-heading environmen
15059 ts, aren't used in the
15066 \begin_layout Standard
15067 On the other hand, you'll notice the following new environments:
15070 \begin_layout Itemize
15076 \begin_layout Itemize
15082 \begin_layout Itemize
15088 \begin_layout Itemize
15094 \begin_layout Itemize
15100 \begin_layout Standard
15101 These five are kind of quirky, due to a
15102 \begin_inset Quotes eld
15106 \begin_inset Quotes erd
15110 You see, LyX doesn't permit you to nest any other paragraph environment
15111 into an empty environment.
15112 Now, that's fine and dandy, but it means that you wouldn't be able to start
15113 a slide with anything except plain text.
15114 To deal with this, I've performed a little
15115 \begin_inset Quotes eld
15119 \begin_inset Quotes erd
15125 \begin_layout Subsubsection
15126 Quirks of the New Environments
15127 \begin_inset CommandInset label
15129 name "sec:slideQuirk"
15136 \begin_layout Standard
15137 All five of the new paragraph environments are somewhat quirky due to inherent
15138 limitiations in the current version of LyX.
15139 As I just mentioned, LyX forbids environments that begin with another environme
15141 To get around this, the
15145 environment isn't a paragraph environment as described in the
15153 \begin_layout Standard
15154 You should consider
15167 \begin_inset Quotes eld
15170 pseudo-environments.
15171 \begin_inset Quotes erd
15174 They look like a section heading or a
15175 \begin_inset Quotes eld
15183 \begin_inset Quotes erd
15186 but really begin a [and, if necessary, end the previous] paragraph environment.
15196 \begin_inset Quotes eld
15200 \begin_inset Quotes erd
15203 These two perform some action.
15206 \begin_layout Standard
15207 A common feature of all five environments,
15227 , is a rather long-ish label.
15228 The text following this label — ordinarily the contents of the paragraph
15229 environment — is utterly irrelevant for
15250 LyX completely ignores it.
15251 In fact, you can leave these five environments completely empty.
15255 \begin_layout Standard
15260 to put any text after the rather long-ish label, you might want to.
15261 This could be a short description of the contents of the
15266 In that case, enter in your descriptive comment and hit
15270 as you normally would.
15273 \begin_layout Standard
15274 If, on the other hand, you don't want to enter in any descriptive text,
15275 you'll hit another LyX quirk.
15276 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
15277 environment until you put something in the old one.
15281 \begin_layout Itemize
15282 Start entering the text that will
15310 \begin_layout Itemize
15311 Now move to the beginning of that paragraph.
15315 \begin_layout Itemize
15324 \begin_layout Itemize
15325 Finally, change this new, empty paragraph to a
15349 \begin_layout Standard
15350 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
15354 \begin_layout Subsection
15355 Making a Presentation with
15368 \begin_layout Subsubsection
15376 \begin_layout Standard
15377 If you're expecting this section to teach you how to actually make a presentatio
15378 n, you'll be sorely disappointed.
15379 Naturally, I'll describe all of the ways the
15383 class can assist you in preparing the materials for a presentation.
15384 Filling in the contents, however, is up to you.
15389 the LyX philosophy.]
15392 \begin_layout Standard
15397 environment [in the manner described in section
15398 \begin_inset space ~
15402 \begin_inset CommandInset ref
15404 reference "sec:slideQuirk"
15408 ] tells LyX to begin a new slide [duh].
15409 The label for this environment/
15410 \begin_inset Quotes erd
15414 \begin_inset Quotes erd
15418 \begin_inset Quotes eld
15422 \begin_inset Quotes erd
15425 in cool blue, followed by the label,
15426 \begin_inset Quotes eld
15430 \begin_inset Quotes erd
15434 Any text or paragraph environments that follow this one go on the new slide.
15438 \begin_layout Standard
15439 Slides are probably the only time you'll need to forcibly end pages in LyX
15440 (this can be specified in the
15445 In fact, you'll want to, once you finish entering the contents of one slide.
15446 If you've entered more text than can physically fit on a slide, the extra
15447 overflows onto a new slide.
15448 I don't recommend doing this, however, since the overflow slide won't have
15449 any page number on it.
15450 Furthermore, it may interfere with any
15454 you've made to accompany the oversized
15461 \begin_layout Standard
15470 environments work the same way as the
15475 They both create an
15476 \begin_inset Quotes eld
15480 \begin_inset Quotes erd
15483 followed by a label [
15484 \begin_inset Quotes eld
15488 \begin_inset Quotes erd
15492 \begin_inset Quotes eld
15496 \begin_inset Quotes erd
15500 The color is a stunning magenta instead of blue, and the
15501 \begin_inset Quotes eld
15505 \begin_inset Quotes erd
15508 will look different, in style and in length.
15509 The label fonts of all three also differ from one another.
15512 \begin_layout Standard
15517 , if the contents of a
15525 exceed the physical size of a slide or sheet of paper, the extra will overflow
15527 Again, you should avoid this.
15528 It defeats the whole purpose of
15539 \begin_layout Subsubsection
15549 \begin_layout Standard
15554 is a slide that sits atop another slide.
15555 Perhaps you wish to discuss a figure on the main
15559 before displaying the text associated with it.
15560 One way to accomplish this is tape a flap of dark paper over the part of
15565 you want to display later.
15566 This method fails, however, if you wish to overlap one graph with another,
15568 You would then have to fumble while speaking to align the two separate,
15573 s to align the two graphs.
15578 environment in both cases makes life much easier.
15581 \begin_layout Standard
15586 receives the page number of its
15587 \begin_inset Quotes eld
15591 \begin_inset Quotes erd
15599 \begin_inset Quotes eld
15607 \begin_inset Quotes erd
15614 \begin_layout Plain Layout
15615 Presumably, mutliple
15620 \begin_inset Quotes eld
15628 \begin_inset Quotes erd
15632 \begin_inset Quotes eld
15640 \begin_inset Quotes erd
15644 \begin_inset Quotes eld
15652 \begin_inset Quotes erd
15656 \begin_inset space ~
15659 appended to the page number of the parent
15669 Clearly, you want the contents of both the
15677 to each fit on a single physical slide! You should probably consider an
15683 \begin_inset Quotes eld
15687 \begin_inset Quotes erd
15699 class provides a visual cue for this: the label at the start of an
15703 is shorter than that at the start of a
15708 Lastly, when you generate printable output, you'll find alignment markers
15709 in all four corners of both the
15713 page and its parent
15718 These will assist you in lining up the two physical slides.
15721 \begin_layout Standard
15722 The major problem in overlaying two slides is aligning the contents of the
15723 two transparencies.
15724 How much space should you leave for that graph on the second slide? Worse
15725 still, what if you want a graph and a sentence on second slide, but there
15726 is text on the main transparency that goes in between them? You could try
15727 and insert vertical space of the right size.
15728 The better way is to use
15739 \begin_layout Standard
15740 As their names imply,
15748 are two command-like paragraph environments that make all subsequent text
15749 invisible and visible, respectively.
15751 \begin_inset space ~
15755 \begin_inset CommandInset ref
15757 reference "sec:slideQuirk"
15761 that you don't place anything
15765 these two environments, however.
15770 , it inserts a centered, sky-blue label into the page reading
15771 \begin_inset Quotes eld
15774 <Invisible Text Follows>
15775 \begin_inset Quotes erd
15779 For paragraphs following this label, the parts of the
15787 ; it doesn't matter which] where they would be contain instead blank space.
15791 \begin_layout Standard
15796 , the corresponding centered label is
15797 \begin_inset Quotes eld
15800 <Visible Text Follows>
15801 \begin_inset Quotes erd
15805 Paragraphs following this label behave normally.
15806 Note that the beginning of a new
15818 automatically shuts off an
15823 It's therefore not necessary to use
15834 \begin_layout Standard
15835 By now, it should be obvious how to create overlay transparencies using
15836 the proper combination of
15855 \begin_layout Enumerate
15860 , including everything that will appear on it, whether on the main slide
15868 \begin_layout Enumerate
15869 Before each figure or paragraph that will appear only on the
15878 If necessary, insert a
15882 environment after the
15889 \begin_layout Enumerate
15894 immediately following the
15901 \begin_layout Enumerate
15902 Copy the contents of this
15913 \begin_layout Enumerate
15918 , change all of the
15929 \begin_layout Standard
15931 You've just made an
15938 \begin_layout Standard
15939 There's one problem with the way I've designed the LyX
15943 class: you can't make text in the middle of a paragraph invisible, nor
15944 make text in the middle of an invisible paragraph visible again.
15945 To accomplish this feat, you'll need to use some inlined LaTeX codes.
15949 \begin_layout Plain Layout
15950 The commands of interest are:
15953 \begin_layout Itemize
15958 invisible \SpecialChar \ldots{}
15962 \begin_layout Itemize
15967 visible \SpecialChar \ldots{}
15971 \begin_layout Plain Layout
15972 \SpecialChar \ldots{}
15973 and need to be marked as TeX.
15975 \begin_inset Quotes eld
15979 \begin_inset Quotes erd
15982 you wish to change goes in between the brackets [and after the
15995 If you don't know how to mark text as TeX, see the appropriate section
16008 \begin_layout Subsubsection
16018 \begin_inset CommandInset label
16020 name "sec:slideNote"
16027 \begin_layout Standard
16036 is associated with a
16037 \begin_inset Quotes eld
16041 \begin_inset Quotes erd
16053 class provides visual cues.
16058 is shorter than that of a
16062 [yet longer than that of an
16066 ] and, like the label of an
16070 is shockingly magenta.
16071 Additionally, the printed
16075 has the page number of its
16076 \begin_inset Quotes eld
16080 \begin_inset Quotes erd
16088 \begin_inset Quotes eld
16096 \begin_inset Quotes erd
16100 \begin_inset Quotes eld
16108 \begin_inset Quotes erd
16112 \begin_inset Quotes eld
16120 \begin_inset Quotes erd
16124 You can have multiple
16128 s associated with a single
16140 , you'll probably want to break up long
16144 s so that they fit on a single sheet of paper.
16147 \begin_layout Standard
16152 is obvious: it contains anything additional you might want to say about
16158 It could also be used as a sheet of reminders for a particular
16163 In the case of the latter, you might want to make use of time markers.
16169 \begin_inset Quotes eld
16173 \begin_inset Quotes erd
16176 support for time markers, a
16181 So, you'll have to resort to using the LaTeX codes.
16184 \begin_layout Standard
16185 To use time markers, you'll need to specify the extra class option
16186 \begin_inset Quotes eld
16194 \begin_inset Quotes erd
16198 \begin_inset space ~
16202 \begin_inset CommandInset ref
16204 reference "sec:slidesetup"
16209 This option turns on timing marks, which will appear in the lower-left-hand
16215 To set what appears in the time marker, you use the LaTeX commands
16216 \begin_inset Quotes eld
16226 \begin_inset Quotes erd
16230 \begin_inset Quotes eld
16240 \begin_inset Quotes erd
16244 The arguments of both commands are time measured in seconds.
16246 \begin_inset Quotes eld
16256 \begin_inset Quotes erd
16259 sets the time marker to a given time.
16261 \begin_inset Quotes eld
16271 \begin_inset Quotes erd
16274 increments the time marker by the specified amount.
16275 Using time markers and
16279 s in this fashion, you can remind yourself how much time to spend on a particula
16287 \begin_layout Standard
16288 There's one last feature to describe.
16289 Clearly, you'd like to print out all of your
16297 s on transparencies while printing all of your
16314 with which it is associated.
16315 What's a person to do?
16318 \begin_layout Standard
16319 Luckily, there are two LaTeX commands that allow you to select what to print
16321 Both must be placed into the preamble of your document.
16323 \begin_inset Quotes eld
16335 \begin_inset Quotes erd
16338 will cause the output to contain only the
16347 Correspondingly, the command
16348 \begin_inset Quotes eld
16360 \begin_inset Quotes erd
16363 prevents the output of anything but
16368 I'd advise placing both commands in the preamble and initially comment
16370 You can then preview your entire presentation as you write.
16371 When you're done writing, you can then uncomment one of the two to select
16372 what you want to print.
16373 I like to uncomment
16374 \begin_inset Quotes eld
16386 \begin_inset Quotes erd
16389 , print to a file with
16390 \begin_inset Quotes eld
16398 \begin_inset Quotes erd
16401 in its name, comment it back out, then uncomment
16402 \begin_inset Quotes eld
16414 \begin_inset Quotes erd
16418 \begin_inset Quotes eld
16426 \begin_inset Quotes erd
16430 I can then send either file to a printer, loading transparencies or plain
16431 paper as appropriate.
16434 \begin_layout Standard
16435 You can also provide other arguments to the
16436 \begin_inset Quotes eld
16446 \begin_inset Quotes erd
16450 \begin_inset Quotes eld
16460 \begin_inset Quotes erd
16464 See a good LaTeX book for details.
16467 \begin_layout Subsection
16472 Class Template File
16475 \begin_layout Standard
16476 I have also provided a template file,
16477 \begin_inset Quotes eld
16485 \begin_inset Quotes erd
16493 To use it, begin your new presentation with
16498 ile\SpecialChar \menuseparator
16500 \begin_inset space ~
16504 \begin_inset space ~
16514 Your new LyX presentation file will contain an example
16535 additionally contain an example of the use of
16544 Lastly, the preamble will contain:
16547 \begin_layout LyX-Code
16548 % Uncomment to print out only slides and overlays
16551 \begin_layout LyX-Code
16555 \begin_layout LyX-Code
16561 \begin_inset Newline newline
16567 \begin_layout LyX-Code
16568 % Uncomment to print out only notes
16571 \begin_layout LyX-Code
16575 \begin_layout LyX-Code
16583 \begin_layout Standard
16584 One final thing: I created this class to support the LaTeX2e
16585 \begin_inset Quotes eld
16593 \begin_inset Quotes erd
16596 class, one of the built-in LaTeX2e classes.
16597 Neither I nor the rest of the LyX Team endorse or oppose the use of this
16598 built-in slide class.
16599 It's here if you want it or need it.
16600 There exist other LaTeX2e classes for creating presentations, such as the
16606 \begin_inset space ~
16610 \begin_inset CommandInset ref
16612 reference "sec:foiltex"
16617 \begin_inset Quotes eld
16625 \begin_inset Quotes erd
16628 package [present on some TeX distributions].
16629 The latter is not yet supported under LyX.
16633 \begin_layout Plain Layout
16634 Perhaps you can take on the task\SpecialChar \ldots{}
16640 I know nothing about these other classes.
16641 Try them out to see what sort of alternative they provide.
16644 \begin_layout Chapter
16645 LyX Features needing Extra Software
16648 \begin_layout Section
16652 \begin_layout Standard
16658 \begin_layout Subsection
16662 \begin_layout Standard
16671 \begin_layout Plain Layout
16676 is not yet available when you are using the LaTeX distribution MiKTeX.
16681 , you'll find in the
16688 \begin_inset space ~
16699 \begin_inset CommandInset href
16701 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
16708 \begin_layout Standard
16713 package is a program that was written by
16714 \begin_inset Flex CharStyle:Noun
16717 \begin_layout Plain Layout
16719 \begin_inset space ~
16727 in frustration because some constructs in LaTeX are sometimes non-intuitive,
16728 and easy to forget.
16729 The program runs over your LaTeX file, checks the integrity of the file,
16730 and flags some common errors.
16731 In other technical words, it is
16738 \begin_layout Standard
16739 Well, what is a syntax checker doing in LyX which is supposed to produce
16740 correct LaTeX anyways? The answer is simple: Just as
16744 not only checks the
16748 of C programs, but also does
16752 checks for type-errors,
16756 catches some common
16760 errors, in addition to the syntactical ones.
16765 is capable of detecting several common errors, such as
16768 \begin_layout Itemize
16769 Ellipsis detection:
16770 \begin_inset Newline newline
16773 Use \SpecialChar \ldots{}
16777 \begin_layout Itemize
16778 No space in front of/after parenthesis:
16779 \begin_inset Newline newline
16785 \begin_layout Itemize
16786 Enforcement of normal space after common abbreviations:
16787 \begin_inset Newline newline
16791 \begin_inset space \thinspace{}
16795 \begin_inset space \space{}
16798 is too wide spacing.
16801 \begin_layout Itemize
16802 Enforcement of end-of-sentence space when the last sentence ends with a
16804 \begin_inset Newline newline
16808 And this is wrong spacing.
16811 \begin_layout Itemize
16812 Space in front of labels and similar commands:
16813 \begin_inset Newline newline
16816 The label should stick right up to the text to avoid falling to a wrong
16819 \begin_inset CommandInset label
16829 \begin_layout Plain Layout
16830 This footnote is in danger of falling off to a wrong page
16835 The label is separated too much.
16838 \begin_layout Itemize
16839 Space in front of references, instead of hard spaces:
16840 \begin_inset Newline newline
16843 In you are in bad luck, the text will break right between the referenced
16844 text and reference number, and that's a pity.
16846 \begin_inset CommandInset ref
16848 reference "sec:chktex"
16855 \begin_layout Itemize
16857 \begin_inset Quotes eld
16861 \begin_inset Quotes erd
16865 \begin_inset Formula $\times$
16869 \begin_inset Newline newline
16872 2x2 looks cheap compared to
16873 \begin_inset Formula $2\times2$
16879 \begin_layout Standard
16880 and more \SpecialChar \ldots{}
16881 It is an invaluable tool when you are
16882 \begin_inset Quotes eld
16886 \begin_inset Quotes erd
16889 your document before printing, and you should run it right after the obligatory
16890 spelling check, and before you go fine tuning the typesetting.
16893 \begin_layout Subsection
16897 \begin_layout Standard
16898 If you have the program installed, usage is as simple as choosing
16900 Tools\SpecialChar \menuseparator
16902 \begin_inset space ~
16908 This will make LyX generate a LaTeX file of your document, start
16912 to check it, and then make LyX insert
16913 \begin_inset Quotes eld
16917 \begin_inset Quotes erd
16920 with the warnings from
16924 , if there were any.
16925 The warnings will be placed close to the point of the mistake, and you
16926 can quickly find them by using the
16928 Navigate\SpecialChar \menuseparator
16931 menu item, or the shortcut key
16940 Open the error boxes by clicking on them with the mouse, or use the shortcut
16949 bindings, or the corresponding
16958 Read the warning and correct the mistake, if it is a mistake.
16959 If you have trouble understanding what the warning is about, you can safely
16961 Remember that there is a hidden layer between the document on screen and
16962 the technical details in invoking
16966 , and this gap can make some warnings seem arcane or just right down plain
16970 \begin_layout Standard
16971 This document is an excellent testing bed for the feature, and it should
16972 provide quite a few warnings for you to fiddle with.
16973 Since computers are only so smart, expect most of the warnings to be false
16977 \begin_layout Subsection
16978 How to fine tune it
16981 \begin_layout Standard
16982 Sometimes, you'll find that
16986 makes more noise than suits your mood.
16987 Then you can choose not to use it, wait until your mood changes, or try
16992 to get better along with you.
16993 Another choice in the most desperate situations is to use
16995 View\SpecialChar \menuseparator
16997 \begin_inset space ~
17001 \begin_inset space ~
17005 \begin_inset space ~
17010 , which will get rid of all warnings instantly.
17013 \begin_layout Standard
17022 very configurable and extensible, you shouldn't expect to solve all problems
17028 Since LyX has to generate a somewhat special LaTeX file to be able to match
17029 the line numbers from the
17037 \begin_layout Plain Layout
17038 You can inspect the specific output from
17044 Edit\SpecialChar \menuseparator
17046 \begin_inset space ~
17050 \begin_inset space ~
17064 to the internal document structure, some of the warnings will not seen
17065 to appear correctly.
17066 There are two things you can do about this:
17069 \begin_layout Itemize
17074 invocation command line in
17090 installation configuration file (usually with the file
17095 See below to learn what warnings can be enabled and disabled on the command
17100 \begin_layout Itemize
17101 Export your document as a raw LaTeX file using
17103 File\SpecialChar \menuseparator
17104 Export\SpecialChar \menuseparator
17112 Invoked in this way, it can be a hassle to find the corresponding place
17113 in the document inside LyX, but with a little patience, you should be able
17117 \begin_layout Standard
17118 Here follows the warning messages that can be enabled and disabled in
17127 to disable a warning, and
17131 to enable a warning.
17132 The emphasized entries are disabled by default, because the default is
17135 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
17140 \begin_layout Standard
17141 Notice that you should only use the options that enable and disable warnings,
17142 because LyX relies on some of the other command line parameters to be set
17143 in a specific way to have a chance to communicate with
17150 \begin_layout Enumerate
17154 Command terminated with space.
17157 \begin_layout Enumerate
17160 Non-breaking space (
17161 \begin_inset Quotes eld
17169 \begin_inset Quotes erd
17172 ) should have been used.
17175 \begin_layout Enumerate
17179 You should enclose the previous parenthesis with
17180 \begin_inset Quotes eld
17188 \begin_inset Quotes erd
17194 \begin_layout Enumerate
17197 Italic correction (
17198 \begin_inset Quotes eld
17208 \begin_inset Quotes erd
17211 ) found in non-italic buffer.
17214 \begin_layout Enumerate
17217 Italic correction (
17218 \begin_inset Quotes eld
17228 \begin_inset Quotes erd
17231 ) found more than once.
17234 \begin_layout Enumerate
17238 No italic correction (
17239 \begin_inset Quotes eld
17249 \begin_inset Quotes erd
17255 \begin_layout Enumerate
17259 \begin_inset Quotes eld
17267 \begin_inset Quotes erd
17271 \begin_inset Quotes eld
17279 \begin_inset Quotes erd
17285 \begin_layout Enumerate
17288 Wrong length of dash may have been used.
17291 \begin_layout Enumerate
17295 \begin_inset Quotes eld
17303 \begin_inset Quotes erd
17307 \begin_inset Quotes eld
17315 \begin_inset Quotes erd
17321 \begin_layout Enumerate
17325 \begin_inset Quotes eld
17333 \begin_inset Quotes erd
17339 \begin_layout Enumerate
17343 \begin_inset Quotes eld
17351 \begin_inset Quotes erd
17354 to achieve an ellipsis.
17357 \begin_layout Enumerate
17360 Inter-word spacing (
17361 \begin_inset Quotes eld
17371 \begin_inset Quotes eld
17374 ) should perhaps be used.
17377 \begin_layout Enumerate
17380 Inter-sentence spacing (
17381 \begin_inset Quotes eld
17391 \begin_inset Quotes erd
17394 ) should perhaps be used.
17397 \begin_layout Enumerate
17400 Could not find argument for command.
17403 \begin_layout Enumerate
17407 \begin_inset Quotes eld
17415 \begin_inset Quotes erd
17421 \begin_layout Enumerate
17424 Math mode still on at end of LaTeX file.
17427 \begin_layout Enumerate
17431 \begin_inset Quotes eld
17439 \begin_inset Quotes erd
17442 doesn't match the number of
17443 \begin_inset Quotes eld
17451 \begin_inset Quotes erd
17457 \begin_layout Enumerate
17460 You should use either
17463 \begin_inset Quotes eld
17471 \begin_inset Quotes erd
17476 as an alternative to
17477 \begin_inset Quotes eld
17485 \begin_inset Quotes erd
17491 \begin_layout Enumerate
17498 " (ASCII 39) instead of "
17505 \begin_layout Enumerate
17508 User-specified pattern found.
17511 \begin_layout Enumerate
17514 This command might not be intended.
17517 \begin_layout Enumerate
17524 \begin_layout Enumerate
17542 \begin_layout Enumerate
17545 Delete this space to maintain correct page references.
17548 \begin_layout Enumerate
17552 You might wish to put this between a pair of
17553 \begin_inset Quotes eld
17561 \begin_inset Quotes erd
17567 \begin_layout Enumerate
17570 You ought to remove spaces in front of punctuation.
17573 \begin_layout Enumerate
17576 Could not execute LaTeX command.
17579 \begin_layout Enumerate
17588 in front of small punctuation.
17591 \begin_layout Enumerate
17599 may look prettier here.
17602 \begin_layout Enumerate
17606 Multiple spaces detected in output.
17609 \begin_layout Enumerate
17612 This text may be ignored.
17615 \begin_layout Enumerate
17621 \begin_inset Quotes eld
17626 to begin quotation, not
17633 \begin_layout Enumerate
17640 to end quotation, not
17643 \begin_inset Quotes eld
17651 \begin_layout Enumerate
17657 \begin_layout Enumerate
17660 You should perhaps use
17661 \begin_inset Quotes eld
17669 \begin_inset Quotes erd
17675 \begin_layout Enumerate
17678 You should put a space in front of/after parenthesis.
17681 \begin_layout Enumerate
17684 You should avoid spaces in front of/after parenthesis.
17687 \begin_layout Enumerate
17691 You should not use punctuation in front of/after quotes.
17694 \begin_layout Enumerate
17697 Double space found.
17700 \begin_layout Enumerate
17703 You should put punctuation outside inner/inside display math mode.
17706 \begin_layout Enumerate
17709 You ought to not use primitive TeX in LaTeX code.
17712 \begin_layout Enumerate
17715 You should remove spaces in front of
17716 \begin_inset Quotes eld
17724 \begin_inset Quotes erd
17730 \begin_layout Enumerate
17733 \begin_inset Quotes eld
17741 \begin_inset Quotes erd
17744 is normally not followed by
17745 \begin_inset Quotes eld
17753 \begin_inset Quotes erd
17759 \begin_layout Standard
17760 In later versions of LyX, we hope to provide a more complete interface to
17761 this tool (and it's smaller cousin
17765 ) to exploit the full power of it.
17766 But it's not exactly useless as it is now: go try it on one of your existing
17767 documents of a certain length and be surprised.
17770 \begin_layout Section
17771 Version Control in LyX
17774 \begin_layout Standard
17777 Lars Gullik Bjønnes,
17784 \begin_layout Subsection
17788 \begin_layout Standard
17789 A friend of mine wanted to try LyX for a group project.
17790 When he didn't find support for version control or file locking, he dropped
17792 This angered me a bit, so I thought that I should at least make support
17793 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
17794 This has now been done.
17795 LyX now supports some of the most basic RCS commands.
17796 If you need to something a bit more sophisticated you will have to do that
17797 manually in an xterm.
17800 \begin_layout Standard
17801 Before you begin to use the version control features in LyX, you should
17803 \begin_inset Quotes eld
17807 \begin_inset Quotes erd
17810 (a man file, read it with
17815 This file describes all the basic features of RCS.
17816 You should especially notice the comment about a RCS directory, and the
17817 notion of a master RCS file (the file ending in
17824 \begin_layout Standard
17825 Later basic CVS/SVN support was added.
17826 You should be familiar with CVS/SVN usage before start using it under LyX.
17827 Most of the log messages are not currently displayed after operations -
17828 you can check them in terminal window if unsure.
17831 \begin_layout Standard
17832 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
17833 package—no guarantees are made for older versions.
17836 \begin_layout Standard
17837 For introducing your own external commands consult vc-command in the manual
17841 \begin_layout Subsection
17842 RCS commands in LyX
17845 \begin_layout Standard
17846 The following sections describe the RCS commands supported by LyX.
17847 You can find them in the
17849 File\SpecialChar \menuseparator
17851 \begin_inset space ~
17857 LyX was tested against RCS 5.7.
17860 \begin_layout Subsubsection
17866 \begin_layout Standard
17867 If your document is not under revision control, this is the only item shown
17869 And if it is under revision control, the
17873 item is not visible.
17877 \begin_layout Standard
17878 This command registers your document with RCS (unless you are under the
17879 directory managed by CVS)\SpecialChar \@.
17880 You are asked interactively to supply an initial
17881 description of the document.
17882 The document is now set in Read-Only mode and you have to
17885 \begin_inset space ~
17889 \begin_inset space ~
17893 \begin_inset space ~
17898 , before making any changes to it.
17899 A document under revision control has a
17900 \begin_inset Quotes eld
17903 [RCS:<version> <locker>]
17904 \begin_inset Quotes erd
17907 item tagged to the filename in the minibuffer.
17910 \begin_layout Standard
17911 RCS command that is run:
17913 ci -q -u -i -t-"<initial description>" <file-name>
17916 \begin_layout Standard
17921 to understand the switches.
17925 \begin_layout Subsubsection
17931 \begin_layout Standard
17932 When you are finished editing a file, you check in your changes.
17933 When you do this, you are asked for a description of the changes.
17934 This is stored in the history log.
17935 The version number is bumped, your changes are applied to the master RCS
17936 file, the document is unlocked and set to Read-Only mode.
17940 \begin_layout Standard
17943 ci -q -u -m"<description>" <file-name>
17946 \begin_layout Subsubsection
17952 \begin_layout Standard
17953 By doing this you lock the document so that only you can edit it.
17954 This will also make the document Read-Write only for you.
17955 You will usually continue editing for a while and when you are finished
17956 you check in your changes.
17957 The status line is changed to reflect that you have locked the file.
17961 \begin_layout Standard
17964 co -q -l <file-name>
17967 \begin_layout Subsubsection
17970 Revert To Repository Version
17973 \begin_layout Standard
17974 This will discard all changes made to the document since the last check
17976 You get a warning before changes are discarded.
17979 \begin_layout Standard
17982 co -f -u<version> <file-name>
17985 \begin_layout Subsubsection
17991 \begin_layout Standard
17992 This makes as if the last check in never happened.
17993 No changes are made to the document loaded into LyX, but the last version
17994 is removed from the master RCS file.
17998 \begin_layout Standard
18001 rcs -o<version> <file-name>
18004 \begin_layout Subsubsection
18010 \begin_layout Standard
18011 This show the complete history of the RCS document.
18016 is shown in a browser.
18024 \begin_layout Subsection
18025 CVS commands in LyX
18028 \begin_layout Standard
18029 CVS is now partially supported by LyX.
18030 You can find the commands in the
18032 File\SpecialChar \menuseparator
18034 \begin_inset space ~
18042 \begin_layout Subsubsection
18048 \begin_layout Standard
18049 If your document is not under revision control, this is the only item shown
18051 And if it is under revision control, the
18058 item is not visible.
18062 \begin_layout Standard
18063 This command registers in CVS your document ONLY in case you have already
18064 the documents directory under CVS control (in particular
18069 This means you have to checkout the archive by yourself.
18073 \begin_layout Standard
18074 Then you are asked interactively to supply an initial description of the
18076 Don't forget that registered file is not yet commited.
18079 \begin_layout Standard
18080 CVS command that is run:
18083 \begin_inset Quotes erd
18087 \begin_inset Quotes eld
18091 \begin_inset Quotes erd
18097 \begin_layout Standard
18102 to understand the switches.
18106 \begin_layout Subsubsection
18112 \begin_layout Standard
18113 When you are finished editing a file, you commit your changes.
18114 When you do this, you are asked for a description of the changes.
18115 After that changes are commited.
18118 \begin_layout Standard
18121 cvs -q commit -m"<description>" "<file-name>"
18124 \begin_layout Subsubsection
18127 Revert To Repository Version
18130 \begin_layout Standard
18131 This will discard all changes made to the document since the last check
18133 You get a warning before changes are discarded.
18134 Firstly the file is deleted, secondly CVS update command is run.
18137 \begin_layout Standard
18141 \begin_inset Quotes eld
18145 \begin_inset Quotes erd
18151 \begin_layout Subsubsection
18157 \begin_layout Standard
18158 This show the complete history of the CVS document.
18162 \begin_inset Quotes eld
18166 \begin_inset Quotes erd
18171 is shown in a browser.
18174 \begin_layout Subsection
18175 SVN commands in LyX
18178 \begin_layout Standard
18179 SVN is now partially supported by LyX.
18180 You can find the commands in the
18182 File\SpecialChar \menuseparator
18184 \begin_inset space ~
18190 Please note that if you use password protected access to repository via
18191 ssh, you will be asked in terminal window.
18192 LyX was tested against SVN 1.4 and 1.5.
18195 \begin_layout Subsubsection
18201 \begin_layout Standard
18202 If your document is not under revision control, this is the only item shown
18204 And if it is under revision control, the
18211 item is not visible.
18215 \begin_layout Standard
18216 This command registers in SVN your document ONLY in case you have already
18217 the documents directory under SVN control (in particular
18222 This means you have to checkout the archive by yourself.
18226 \begin_layout Standard
18227 Then you are asked interactively to supply an initial description of the
18229 Don't forget that registered file is not yet commited.
18232 \begin_layout Standard
18233 SVN command that is run:
18236 \begin_inset Quotes eld
18240 \begin_inset Quotes erd
18246 \begin_layout Standard
18251 to understand the switches.
18255 \begin_layout Subsubsection
18261 \begin_layout Standard
18262 When you are finished editing a file, you commit your changes.
18263 When you do this, you are asked for a description of the changes.
18264 After that changes are commited.
18267 \begin_layout Standard
18272 \begin_layout Plain Layout
18273 In case locking is not enabled.
18275 \begin_inset CommandInset ref
18277 reference "subsec:SVN-File-Locking"
18288 svn commit -q -m"<description>" <file-name>
18291 \begin_layout Subsubsection
18297 \begin_layout Standard
18298 Updates the changes of this file from the repository.
18299 Be sure you understand SVN merging and conflicts resolving before using
18300 this function, because all conflicts has to be done manually by you!
18303 \begin_layout Standard
18308 \begin_layout Plain Layout
18317 \begin_inset Quotes eld
18321 \begin_inset Quotes erd
18327 \begin_layout Subsubsection
18330 Revert To Repository Version
18333 \begin_layout Standard
18334 This will discard all changes made to the document since the last check
18336 You get a warning before changes are discarded.
18340 \begin_layout Standard
18344 \begin_inset Quotes eld
18348 \begin_inset Quotes erd
18354 \begin_layout Subsubsection
18360 \begin_layout Standard
18361 This show the complete history of the SVN document.
18365 \begin_inset Quotes eld
18369 \begin_inset Quotes erd
18374 is shown in a browser.
18377 \begin_layout Subsubsection
18379 \begin_inset CommandInset label
18381 name "subsec:SVN-File-Locking"
18388 \begin_layout Standard
18389 The file exchange through various revision control systems brings the problem
18390 of merge conflicts in case two different users try to edit the same (parts
18392 When such conflict happens it needs manual resolving and one reasonable
18393 alternative is to provide some kind of locking mechanism, which guarantees
18394 that only one user is allowed to edit file at the given time.
18397 \begin_layout Standard
18398 SVN has two mechanisms to provide such kind of mutual exclusivity for file
18399 access - locks and automatical setting of write permissions (see sec.
18401 \begin_inset CommandInset ref
18403 reference "subsec:Automatical-Locking-Property"
18408 \begin_inset Flex CharStyle:Code
18411 \begin_layout Plain Layout
18421 \begin_layout Plain Layout
18422 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
18428 In a case this property is detected for a given document LyX starts to
18429 use SVN locks for document editing automatically and the whole check-in/out
18430 mechanism switches to the same regimen as for RCS.
18431 This in particular means there are two different modes how file is used
18435 \begin_layout Itemize
18437 The loaded file is in the read-only mode.
18438 For editation on needs to check-out.
18443 consists of update from repository and gaining write lock.
18444 If the lock is not possible to obtain, we remain in unlocked state.
18447 \begin_layout Itemize
18449 The loaded file is in the 'normal' edit mode.
18450 No other user is allowed to edit the file.
18455 consists of commiting changes and releasing write-lock.
18456 If no changes have been made to the document, no commit will be produced
18460 \begin_layout Plain Layout
18461 Don't be puzzled by the fact that you will be asked for commit message anyway.
18466 and only the write-lock will be released.
18469 \begin_layout Standard
18473 \begin_layout Labeling
18474 \labelwidthstring 00.00.0000
18477 svn commit -q -m"<description>" "<file-name>"
18478 \begin_inset Newline newline
18481 svn unlock "<file-name>"
18484 \begin_layout Labeling
18485 \labelwidthstring 00.00.0000
18488 svn update "<file-name>"
18489 \begin_inset Newline newline
18492 svn lock "<file-name>"
18495 \begin_layout Subsubsection
18498 \begin_inset CommandInset label
18500 name "subsec:Automatical-Locking-Property"
18506 Automatical Locking Property
18509 \begin_layout Standard
18510 The above mentioned automatical setting of write permissions of the .lyx
18511 file can be set through
18516 ile\SpecialChar \menuseparator
18522 \begin_inset space ~
18525 Control\SpecialChar \menuseparator
18530 oggle locking property
18533 This command is active only when the file is not locked on the svn server
18535 you need to check-out before proceeding).
18538 \begin_layout Labeling
18539 \labelwidthstring 00.00.0000
18541 \begin_inset space ~
18547 \begin_layout Labeling
18548 \labelwidthstring 00.00.0000
18551 svn propset svn:needs-lock ON "<file-name>"
18554 \begin_layout Labeling
18555 \labelwidthstring 00.00.0000
18558 svn propdel svn:needs-lock "<file-name>"
18561 \begin_layout Subsection
18562 SVN and Windows Environment
18565 \begin_layout Quote
18566 My inclination is to say that if the user cannot figure out the command
18567 line operations on their own fairly quickly, they would be well advised
18568 to use TortoiseSVN.
18574 \begin_layout Subsubsection
18578 \begin_layout Standard
18579 In addition to installing LyX, and having access to a Subversion repository,
18580 the user will need to install the Subversion client program.
18581 A Windows installer for the client program is available from
18582 \begin_inset CommandInset href
18585 target "http://www.collab.net/nonav/downloads/subversion/"
18590 The user may also want to install
18591 \begin_inset CommandInset href
18594 target "http://tortoisesvn.tigris.org/"
18598 , which integrates Subversion operations into the context (rightclick) menu
18599 of Windows Explorer.
18600 Operations done outside LyX will typically be more convenient using the
18601 Explorer context menu.
18602 Note that TortoiseSVN is not a replacement for the client program, which
18603 is what LyX itself will use.
18606 \begin_layout Subsubsection
18607 Bringing a document under Subversion control
18610 \begin_layout Standard
18611 Before a LyX document can be brought under version control in Subversion,
18612 its parent directory needs to be under version control.
18613 If the document is being added to a project already in the repository,
18614 this is accomplished by checking the project out to the directory where
18615 the new document will be placed.
18616 If the project itself is not yet under version control (for instance, if
18617 this document starts a new project), the directory must be imported into
18619 This is done outside LyX.
18620 Both import and checkout are easily accomplished from the Explorer context
18621 menu using TortoiseSVN, or alternatively can be done using the command
18622 line client at a DOS prompt.
18623 The procedure for importing the project using TortoiseSVN is described
18624 below, assuming an existing repository and a new project being started
18632 For information on using the Subversion client program, run
18639 \begin_layout Enumerate
18646 in Windows Explorer, right click it, and select
18648 TortoiseSVN > Repo-browser
18651 If necessary, adjust the URL for the repository, then click OK.
18654 \begin_layout Enumerate
18655 Right click the level of the repository under which you want to place the
18656 new project folder (typically the top level) and click
18658 Create folder\SpecialChar \ldots{}
18661 Supply a name for the project folder and click OK.
18662 Add a message for the log file if desired, then click OK again.
18663 The new project folder should appear in the repository.
18664 Finally, click OK again to exit the repository browser.
18667 \begin_layout Enumerate
18668 Once again right click
18674 , this time selecting SVN Checkout\SpecialChar \ldots{}
18675 Select the URL of the project folder
18676 you just created in the repository, and set the checkout directory to
18684 You will be warned about a non-empty folder; click OK to proceed.
18685 You should now have a
18696 \begin_layout Enumerate
18697 Create or open your document in LyX and click
18702 ile\SpecialChar \menuseparator
18708 \begin_inset space ~
18711 Control\SpecialChar \menuseparator
18719 Add a log message and click OK to commit the document to version control.
18722 \begin_layout Standard
18723 From this point onward, you should have full functionality in the
18728 ile\SpecialChar \menuseparator
18734 \begin_inset space ~
18740 You also have the option of checking the document in and out, viewing its
18742 using the TortoiseSVN context menu in Windows Explorer or the Subversion
18743 client program from a command prompt.
18746 \begin_layout Subsection
18750 \begin_layout Standard
18751 With the recent addition of the vc-command function LyX power users are
18752 allowed to create their own commands for revision control.
18755 \begin_layout Standard
18756 As an example you can see how two TortoiseSVN commands could be integrated
18760 \begin_layout Description
18762 \begin_inset Flex CharStyle:Code
18765 \begin_layout Plain Layout
18766 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
18774 \begin_layout Description
18776 \begin_inset Flex CharStyle:Code
18779 \begin_layout Plain Layout
18780 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
18788 \begin_layout Section
18789 Literate Programming
18792 \begin_layout Standard
18797 (kayvan@sylvan.com)
18801 original documentation written by
18803 Edmar Wienskoski Jr.
18806 (edmar-w-jr@technologist.com)
18809 \begin_layout Subsection
18813 \begin_layout Standard
18814 The main purpose of this documentation is to show you how to use LyX for
18815 literate programming.
18816 Where it is assumed that you are familiar with this programming technique,
18818 \begin_inset Quotes eld
18822 \begin_inset Quotes erd
18826 \begin_inset Quotes eld
18830 \begin_inset Quotes erd
18834 If that is not the case, please follow the web links provided in the following
18836 There is a lot of good documentation out there covering old development
18837 history to the latest tools tips.
18840 \begin_layout Standard
18841 It is also assumed that you are familiar with LyX itself to a point that
18842 you are comfortable changing your LyX preferences, and X resources file.
18843 If that is not the case please refer to other LyX documentation to cover
18844 your specific needs.
18847 \begin_layout Subsection
18848 Literate Programming
18851 \begin_layout Standard
18852 From the Literate Programming FAQ:
18855 \begin_layout Quotation
18856 Literate programming is the combination of documentation and source together
18857 in a fashion suited for reading by human beings.
18858 In fact, literate programs should be enjoyable reading, even inviting!
18859 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
18860 and documentation in a single file.
18861 Literate programming tools then parse the file to produce either readable
18862 documentation or compilable source.
18863 The WEB style of literate programming was created by D.
18864 \begin_inset space \thinspace{}
18868 Knuth during the development of his TeX typesetting software.
18872 \begin_layout Standard
18873 Another excerpt says:
18876 \begin_layout Quotation
18879 How is literate programming different from verbose commenting?
18882 \begin_layout Quotation
18883 There are three distinguishing characteristics.
18884 In order of importance, they are:
18888 \begin_layout Itemize
18889 flexible order of elaboration
18892 \begin_layout Itemize
18893 automatic support for browsing
18896 \begin_layout Itemize
18897 typeset documentation, especially diagrams and mathematics
18901 \begin_layout Standard
18902 Now that I sparked your curiosity, take a look in the references.
18905 \begin_layout Subsubsection
18909 \begin_layout Standard
18910 The complete Literate Programming FAQ can be found at:
18913 \begin_layout Quote
18914 Literate Programming FAQ
18915 \begin_inset Flex URL
18918 \begin_layout Plain Layout
18920 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
18928 \begin_layout Standard
18929 The FAQ lists 23 (twenty three!) different literate programming tools.
18930 Where some are specialized or
18931 \begin_inset Quotes eld
18935 \begin_inset Quotes erd
18938 for particular programming languages, while other have general scope.
18943 for my own use for several reasons:
18946 \begin_layout Itemize
18947 It can generate the documentation either in LaTeX or HTML.
18950 \begin_layout Itemize
18951 It has a open architecture, i.
18952 \begin_inset space \thinspace{}
18956 \begin_inset space \space{}
18959 it is easy to plug in new filters and to perform special processing that
18964 \begin_layout Itemize
18965 There is a good selection of filters available already (the HTML is one
18969 \begin_layout Itemize
18973 \begin_layout Standard
18974 The Noweb web page can be found at:
18977 \begin_layout Quote
18979 \begin_inset Flex URL
18982 \begin_layout Plain Layout
18984 http://www.cs.virginia.edu/~nr/noweb/
18992 \begin_layout Standard
18993 Starting from there you can reach many other interesting links and even
18994 some literate program examples.
18997 \begin_layout Subsection
18998 LyX and Literate Programming
19001 \begin_layout Standard
19002 The LyX support for Literate Programming is provided by using the generic
19003 LyX converters mechanism.
19004 This support is provided in a
19005 \begin_inset Quotes eld
19009 \begin_inset Quotes erd
19013 \begin_inset space \thinspace{}
19017 \begin_inset space \space{}
19020 you will be able to use this new LyX feature with some other literate programmin
19021 g tool of your choice by just changing your LyX preferences.
19024 \begin_layout Subsubsection
19025 Generating documents and code (weaving and tangling)
19028 \begin_layout Paragraph
19029 Selecting the document class
19032 \begin_layout Standard
19033 If you have installed Noweb and LyX successfully, whenever you open a new
19034 document or try to change the document class of an existing one, you will
19035 find that there are three new document classes available:
19038 \begin_layout Itemize
19042 \begin_layout Itemize
19046 \begin_layout Itemize
19050 \begin_layout Standard
19051 You must select one of them to create your literate documents from.
19055 \begin_layout Standard
19056 Note that literate documents are not limited to these three classes.
19057 New classes can be generated from other styles like letter or in combination
19058 with other class variations like Article (AMS).
19059 If you have special needs that cannot be covered by one of the existing
19060 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
19061 will arrange to insert a new entry, or teach you how to do it.
19065 \begin_layout Plain Layout
19066 It is very simple, it involves the creation of a file with four lines, and
19067 re-running of the auto configuration.
19072 Moreover, if you use a literate tool other than Noweb you may need to create
19073 a new set of document classes for it.
19076 \begin_layout Paragraph
19080 \begin_layout Standard
19081 LyX enables you to write code with a layout named
19089 \begin_layout Plain Layout
19090 The equivalent Noweb term is
19091 \begin_inset Quotes eld
19095 \begin_inset Quotes erd
19099 For historical reasons, I got used to the term
19100 \begin_inset Quotes eld
19104 \begin_inset Quotes erd
19107 introduced by other literate tool named Nuweb, which I used for many years
19108 before rendering myself to Noweb.
19113 Noweb delimits scraps like this:
19116 \begin_layout LyX-Code
19120 \begin_layout LyX-Code
19124 \begin_layout LyX-Code
19128 \begin_layout LyX-Code
19132 \begin_layout LyX-Code
19136 \begin_layout Standard
19137 The problem is that whatever is written in between the << and the
19141 must be taken literally, i.
19142 \begin_inset space \thinspace{}
19146 \begin_inset space \space{}
19149 LyX should be prevented from making any special interpretation of what has
19151 This is handled by a special layout named Scrap, that works like a normal
19152 paragraph but has a free spacing capability.
19155 \begin_layout Standard
19156 The down side of the Scrap paragraph layout is that consecutive paragraphs
19157 of code will be spaced with one empty line in the source code and also
19158 in the printed documentation.
19159 The work around is to enter each line of code within a single Scrap, with
19160 a newline (ctrl-return).
19161 The example above will look like this:
19165 \begin_layout Plain Layout
19166 If you have a printed version of this document you will not see any difference
19167 between the previous example and this one.
19175 \begin_layout LyX-Code
19177 \begin_inset Newline newline
19181 \begin_inset Newline newline
19185 \begin_inset Newline newline
19189 \begin_inset Newline newline
19195 \begin_layout Standard
19196 This layout works fine.
19197 The only real inconvenience is that you have to type ctrl-return instead
19202 \begin_layout Plain Layout
19203 It is in my list of
19204 \begin_inset Quotes eld
19208 \begin_inset Quotes erd
19219 \begin_layout Standard
19220 As a special note, you can also use the
19221 \begin_inset Quotes eld
19225 \begin_inset Quotes erd
19228 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
19232 \begin_layout LyX-Code
19234 \begin_inset Newline newline
19237 def some_function(args):
19238 \begin_inset Newline newline
19241 "This is the doc string for this function."
19242 \begin_inset Newline newline
19245 print "My args: ", args
19248 \begin_layout LyX-Code
19249 @ %def some_function
19252 \begin_layout Standard
19253 For an example of this usage and the resulting cross-reference output, look
19254 at the Literate python program in
19256 LIBDIR/examples/listerrors.lyx
19258 which should make this all clear.
19261 \begin_layout Paragraph
19262 Generating the documentation
19265 \begin_layout Standard
19266 At this point you already have a new document file with a proper document
19267 class, and with some code and text on it.
19268 How do I print it? The answer is simple, you select
19270 View\SpecialChar \menuseparator
19274 Just like you would do for a plain document.
19275 No special procedure is required.
19278 \begin_layout Standard
19279 To help orientate you, I will now explain what happens inside LyX:
19282 \begin_layout Enumerate
19285 Update\SpecialChar \menuseparator
19288 menu option is chosen, a LaTeX file is generated.
19293 \begin_layout Standard
19294 If the document is of any literate class the generated file will be named
19295 with an extension name defined by the
19296 \begin_inset Quotes eld
19300 \begin_inset Quotes erd
19303 format (defined in the Preferences panel), otherwise the file will have
19312 \begin_layout Enumerate
19313 Note that the only difference so far is in the name of the file, no special
19314 processing is required by LyX.
19315 Given that you formatted the code using the Scrap layout that, by itself,
19316 takes care of the business.
19319 \begin_layout Enumerate
19320 If the document is of any literate class LyX will then use the internal
19321 LyX to Noweb converter, followed by the Noweb to LaTeX converter
19325 \begin_layout Plain Layout
19326 The converters are defined in the
19328 Tools\SpecialChar \menuseparator
19332 \begin_inset Quotes eld
19336 \begin_inset Quotes erd
19348 manual for general information about converters.
19353 to generate the LaTeX file.
19357 \begin_layout Standard
19358 Otherwise it will just skip this step.
19362 \begin_layout Enumerate
19363 Finally, LaTeX is invoked and the regular post processing continues as in
19367 \begin_layout Standard
19368 Independence from a particular
19369 \begin_inset Quotes eld
19373 \begin_inset Quotes erd
19376 is easily achieved by changing the commands that are run by the various
19380 \begin_layout Paragraph
19381 Generating the code
19384 \begin_layout Standard
19385 When the build menu option is chosen or the corresponding button in the
19386 toolbar is pressed, a LaTeX file is generated just like step 1 above.
19387 Next, LyX invokes the
19392 This converter needs to be defined by the user and is not installed by
19393 default, though the Program format is.
19394 This converter (like any other converter) will have two parts:
19397 \begin_layout Enumerate
19398 The converter program itself.
19399 This program performs the conversion from the one format to the other (in
19400 this case, from the Noweb format to the Program pseudo-format).
19403 \begin_layout Enumerate
19404 The error log parser.
19405 This is a program whose sole purpose is to rewrite error messages in a
19406 format that LyX understands.
19407 This makes it possible for LyX to place error boxes in the right places
19408 in the file buffer.
19411 \begin_layout Standard
19412 The first part, the
19413 \begin_inset Quotes eld
19417 \begin_inset Quotes erd
19420 setting, should be set to
19421 \begin_inset Quotes eld
19429 \begin_inset Quotes erd
19433 This basically means that LyX will call
19434 \begin_inset Quotes eld
19438 \begin_inset Quotes erd
19441 (a program or script) with the name of the Noweb file (normally a file
19442 in the LyX temp directory).
19446 \begin_layout Standard
19447 This is an implementation of
19448 \begin_inset Quotes eld
19452 \begin_inset Quotes erd
19455 that you can place in a directory on your path:
19458 \begin_layout LyX-Code
19462 \begin_layout LyX-Code
19466 \begin_layout LyX-Code
19467 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
19470 \begin_layout Standard
19471 The next part of the converter setting is the
19472 \begin_inset Quotes eld
19476 \begin_inset Quotes erd
19479 which is to be set to
19480 \begin_inset Quotes eld
19485 parselog=listerrors
19488 \begin_inset Quotes erd
19492 This will run any errors that are generated by the
19493 \begin_inset Quotes eld
19497 \begin_inset Quotes erd
19500 process through the
19501 \begin_inset Quotes eld
19505 \begin_inset Quotes erd
19511 \begin_layout Standard
19512 The converter code looks in
19520 then on the path for the
19521 \begin_inset Quotes eld
19525 \begin_inset Quotes erd
19531 \begin_layout Standard
19532 The build will normally take place in LyX's temporary directory, so the
19533 files produced by the conversion will be in that directory.
19534 LyX will copy out what it regards as the `main' file, but the
19538 conversion may produce several files, and so most of these would then be
19539 deleted when LyX was closed.
19540 The present solution is to use a `copier',
19544 \begin_layout Plain Layout
19553 manual for information on these.
19562 script in its default mode, so that the entire contents of the temporary
19563 directory is copied.
19564 More will get copied than is needed, to be sure, but nothing will be lost.
19565 If, however, you know what extensions the generated files will have, this
19566 can be improved by using the
19575 This option takes a comma-separated list of extensions to copy.
19576 So, for example, if the conversion will generate only files with the extensions
19585 , then the correct definition would be:
19588 \begin_layout LyX-Code
19589 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
19592 \begin_layout Standard
19593 The result will be that only files with these two extensions will be copied
19597 \begin_layout Paragraph
19598 Build instructions in the document
19601 \begin_layout Standard
19602 The last piece of the integration between LyX and noweb is the
19603 \begin_inset Quotes eld
19607 \begin_inset Quotes erd
19611 Generally, the instructions for building your program should be embedded
19612 in a scrap of its own.
19614 \begin_inset Quotes eld
19618 \begin_inset Quotes erd
19621 above uses the notangle command to look for this scrap (called
19622 \begin_inset Quotes eld
19626 \begin_inset Quotes erd
19629 ) and runs its contents through
19630 \begin_inset Quotes eld
19634 \begin_inset Quotes erd
19640 \begin_layout Standard
19641 Typically, such a scrap would look something like this:
19644 \begin_layout LyX-Code
19646 \begin_inset Newline newline
19650 \begin_inset Newline newline
19654 \begin_inset Newline newline
19657 if [ -z "${NOWEB_SOURCE}" ]
19658 \begin_inset Newline newline
19662 \begin_inset Newline newline
19665 NOWEB_SOURCE=myfile.nw
19666 \begin_inset Newline newline
19670 \begin_inset Newline newline
19674 code to extract files ...]
19675 \begin_inset Newline newline
19679 code to compile files ...]
19680 \begin_inset Newline newline
19686 \begin_layout Standard
19689 LIBDIR/examples/listerrors.lyx
19693 LIBDIR/examples/Literate.lyx
19695 which implement two versions of the
19696 \begin_inset Quotes eld
19700 \begin_inset Quotes erd
19703 program for some illustrations of how all of these pieces go together or
19706 LIBDIR/examples/noweb2lyx.lyx.
19709 Interestingly, these three files show off the language-indepence of the
19710 LyX literate programming support since they are written in Python, C and
19714 \begin_layout Subsubsection
19718 \begin_layout Standard
19719 All the Literate Programming support is configured by the
19721 Tools\SpecialChar \menuseparator
19725 \begin_inset Quotes eld
19729 \begin_inset Quotes erd
19733 The important parts are:
19736 \begin_layout Description
19738 \begin_inset space ~
19742 \begin_inset Quotes eld
19746 \begin_inset Quotes erd
19750 \begin_inset space ~
19753 format Set up via the Formats tab, this is where the Noweb-specific pieces
19763 , the file extension is set to
19768 This tells LyX to create a file with a
19772 extension in the first step of the conversion process.
19775 \begin_layout Description
19777 \begin_inset space ~
19785 \begin_inset space ~
19788 format This is an empty format whose sole purpose is to be the endpoint
19789 of a conversion (which then allows us to set up a converter for it).
19792 \begin_layout Description
19801 This converter performs the
19802 \begin_inset Quotes eld
19806 \begin_inset Quotes erd
19809 of the literate document.
19810 For Noweb, it is set to
19811 \begin_inset Quotes eld
19816 noweave -delay -index $$i > $$o
19819 \begin_inset Quotes erd
19825 \begin_layout Description
19835 \begin_inset Quotes eld
19839 \begin_inset Quotes erd
19843 As stated above, the Converter is set to
19844 \begin_inset Quotes eld
19852 \begin_inset Quotes erd
19855 , with Flags set to
19856 \begin_inset Quotes eld
19861 originaldir,parselog=listerrors
19864 \begin_inset Quotes erd
19870 \begin_layout Subsubsection
19874 \begin_layout Standard
19875 There is also a new function implemented in the LyX server, the
19876 \begin_inset Quotes eld
19879 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
19883 \begin_layout Standard
19884 When debugging code with ddd/gdb, it is possible to invoke a text editor
19885 at the current execution position with a single key stroke.
19886 The default ddd configuration for that is shift-ctrl-V.
19887 It happens that you can define the editor command line invocation in ddd
19890 Edit\SpecialChar \menuseparator
19891 Preferences\SpecialChar \menuseparator
19894 dialog and changing the "Edit Sources" entry.
19897 \begin_layout Standard
19898 I take advantage of the new created LyX server function and this ddd feature,
19900 \begin_inset Quotes eld
19904 \begin_inset Quotes erd
19910 \begin_layout LyX-Code
19911 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
19914 \begin_layout Standard
19915 With this, whenever you are using ddd and find a point in the program that
19916 you want to edit, you just press shift-ctrl-V (in the ddd window), and
19917 ddd you forward this information to LyX through the LyX server and then
19918 the LyX window will show the same file with the cursor at the same position
19919 ddd was pointing to.
19920 No more guessing or long scrolling to locate a point in the program back
19924 \begin_layout Standard
19925 Note however that you must enable the LyX server to get this feature working
19926 (it is disabled by default).
19927 You can enable it in
19939 ) by entering in the
19944 \begin_inset Quotes eld
19949 /home/<your-home-directory>/.lyx/lyxpipe
19952 \begin_inset Quotes erd
19958 \begin_layout Standard
19959 Read the LyX server documentation in the
19961 Customization Manual
19963 for further information.
19966 \begin_layout Subsubsection
19970 \begin_layout Standard
19971 There are six new buttons that can be added to your LyX toolbar.
19972 Five of these buttons are short cuts to layout styles:
19993 The last one is a short cut to the
19994 \begin_inset Quotes eld
19998 \begin_inset Quotes erd
20005 \begin_layout Standard
20006 LyX has a range of buttons that are available for tool bar customization.
20007 In my toolbar I like to combine the six short cuts above with two more:
20012 \SpecialChar \menuseparator
20017 \SpecialChar \menuseparator
20024 View\SpecialChar \menuseparator
20028 Here is how it looks like:
20031 \begin_layout LyX-Code
20035 \begin_layout LyX-Code
20039 \begin_layout LyX-Code
20040 Icon "layout Standard"
20043 \begin_layout LyX-Code
20044 Icon "layout Section"
20047 \begin_layout LyX-Code
20048 Icon "layout LaTeX"
20051 \begin_layout LyX-Code
20052 Icon "layout LyX-Code"
20055 \begin_layout LyX-Code
20056 Icon "layout Scrap"
20059 \begin_layout LyX-Code
20063 \begin_layout LyX-Code
20067 \begin_layout LyX-Code
20068 Icon "buffer-typeset"
20071 \begin_layout LyX-Code
20072 Icon "build-program"
20075 \begin_layout LyX-Code
20079 \begin_layout LyX-Code
20083 \begin_layout LyX-Code
20087 \begin_layout LyX-Code
20091 \begin_layout LyX-Code
20095 \begin_layout Subsubsection
20096 Colors customization
20099 \begin_layout Standard
20100 There are a number of colors in LyX that can be customized in
20105 One of the things that bothers people is the LaTeX font color.
20106 The default color is red, since the scraps uses LaTeX font, and there is
20107 a lot of scraps in literate documents, you may get tired of seeing everything
20109 You can change it by going to the tabs
20118 \begin_layout Standard
20119 The next thing is the visible presence of the newline character in the screen.
20120 You can choose the color of this particular character and make it blend
20122 I recommend you choosing a color that is close to the background but not
20123 equal, that way you still can see it is there, but it is not bothering
20128 \begin_layout Chapter
20129 Secrets of the LaTeX Masters
20130 \begin_inset CommandInset label
20139 \begin_layout Standard
20140 Though LyX is a powerful tool, it cannot hope to support everything that
20141 can be done with pure TeX/LaTeX.
20142 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
20143 as long as you are not afraid to use that
20144 \begin_inset Quotes eld
20148 \begin_inset Quotes erd
20151 button on the toolbar or add things to the LaTeX preamble.
20152 This section lists some tips, tricks, and otherwise cool ideas to give
20153 your document that extra little flair.
20156 Do try this at home
20158 , just start with something a little smaller and less important than your
20162 \begin_layout Standard
20163 Most ideas in this section require less common files in your LaTeX installation.
20164 If you have a system like teTeX, most will already be available.
20165 A few, however, will need to be downloaded from one of the CTAN archives.
20166 Often, there are several ways to do something, or several LaTeX style files
20167 which do the same thing.
20168 We do not endorse one choice over another, we simply claim that we have
20169 done a particular task with a particular file.
20170 Put on your wizard hat, keep an eye out for dragons, and let us begin.
20173 \begin_layout Section
20177 \begin_layout Standard
20180 Lars Gullik Bjønnes
20183 \begin_layout Subsection
20187 \begin_layout Standard
20188 The aim for this chapter
20192 \begin_layout Plain Layout
20193 Editor's note: Lars' original chapter was a masterful description of how
20199 However, it was too long to flow smoothly in this document.
20200 I have therefore chosen to excerpt the most important sections here (sorry,
20201 Lars); you can read the original chapter (and more of the story!) in the
20204 examples/multicol.lyx
20212 is to show how the LaTeX package
20216 can be used in a LyX document.
20217 As LyX doesn't support the
20221 package natively yet, we have to use some small hacks.
20222 By reading this section it should be obvious how to do this.
20225 \begin_layout Subsection
20229 \begin_layout Standard
20234 package allows switching between one and multicolumn format on the same
20236 Footnotes are handled correctly (for the most part), but will be placed
20237 at the bottom of the page and not under each column.
20238 LaTeX's float mechanism, however, is partly disabled in the current implementat
20240 At the moment only page-wide floats can be used within the scope of the
20244 \begin_layout Subsection
20248 \begin_layout Subsubsection
20252 \begin_layout Standard
20253 If you want to have two columns in your text, you have use LaTeX mode to
20258 begin{multicols}{2}
20260 at the point where you want the two column layout to start, and then
20266 where you want it to end.
20270 \begin_layout Standard
20274 \begin_layout Plain Layout
20278 begin{multicols}{2}
20286 \begin_layout Standard
20291 The Adventure of the Empty House
20294 \begin_inset Newline newline
20299 Sir Arthur Conan Doyle
20302 \begin_layout Standard
20305 It was in the spring of the year 1894 that all London was interested, and
20306 the fashionable world dismayed, by the murder of the Honourable Ronald
20307 Adair under most unusual and inexplicable circumstances.
20308 The public has already learned those particulars of the crime which came
20309 out in the police investigation, but a good deal was suppressed upon that
20310 occasion, since the case for the prosecution was so overwhelmingly strong
20311 that it was not necessary to bring forward all the facts.
20312 Only now, at the end of nearly ten years, am I allowed to supply those
20313 missing links which make up the whole of that remarkable chain.
20314 The crime was of interest in itself, but that interest was as nothing to
20315 me compared to the inconceivable sequel, which afforded me the greatest
20316 shock and surprise of any event in my adventurous life.
20317 Even now, after this long interval, I find myself thrilling as I think
20318 of it, and feeling once more that sudden flood of joy, amazement, and increduli
20319 ty which utterly submerged my mind.
20320 Let me say to that public, which has shown some interest in those glimpses
20321 which I have occasionally given them of the thoughts and actions of a very
20322 remarkable man, that they are not to blame me if I have not shared my knowledge
20323 with them, for I should have considered it my first duty to do so, had
20324 I not been barred by a positive prohibition from his own lips, which was
20325 only withdrawn upon the third of last month.
20328 \begin_layout Standard
20332 \begin_layout Plain Layout
20344 \begin_layout Subsubsection
20348 \begin_layout Standard
20349 The same pattern is used when you want more than two columns:
20352 \begin_layout Standard
20356 \begin_layout Plain Layout
20360 begin{multicols}{3}
20368 \begin_layout Standard
20371 It can be imagined that my close intimacy with Sherlock Holmes had interested
20372 me deeply in crime, and that after his disappearance I never failed to
20373 read with care the various problems which came before the public.
20374 And I even attempted, more than once, for my own private satisfaction,
20375 to employ his methods in their solution, though with indifferent success.
20376 There was none, however, which appealed to me like this tragedy of Ronald
20378 As I read the evidence at the inquest, which led up to a verdict of willful
20379 murder against some person or persons unknown, I realized more clearly
20380 than I had ever done the loss which the community had sustained by the
20381 death of Sherlock Holmes.
20382 There were points about this strange business which would, I was sure,
20383 have specially appealed to him, and the efforts of the police would have
20384 been supplemented, or more probably anticipated, by the trained observation
20385 and the alert mind of the first criminal agent in Europe.
20386 All day, as I drove upon my round, I turned over the case in my mind and
20387 found no explanation which appeared to me to be adequate.
20388 At the risk of telling a twice-told tale, I will recapitulate the facts
20389 as they were known to the public at the conclusion of the inquest.
20392 \begin_layout Standard
20396 \begin_layout Plain Layout
20408 \begin_layout Standard
20409 You can have more than 3 columns if you want to, but that might not be very
20410 pleasant for the eye.
20413 \begin_layout Subsubsection
20414 Columns inside columns
20417 \begin_layout Standard
20418 You can even have columns inside columns:
20421 \begin_layout Standard
20425 \begin_layout Plain Layout
20429 begin{multicols}{2}
20437 \begin_layout Standard
20440 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
20441 at that time governor of one of the Australian colonies.
20442 Adair's mother had returned from Australia to undergo the operation for
20443 cataract, and she, her son Ronald, and her daughter Hilda were living together
20447 \begin_layout Standard
20451 \begin_layout Plain Layout
20455 begin{multicols}{2}
20463 \begin_layout Standard
20466 The youth moved in the best society–had, so far as was known, no enemies
20467 and no particular vices.
20468 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
20469 had been broken off by mutual consent some months before, and there was
20470 no sign that it had left any very profound feeling behind it.
20471 For the rest {sic} the man's life moved in a narrow and conventional circle,
20472 for his habits were quiet and his nature unemotional.
20473 Yet it was upon this easy-going young aristocrat that death came, in most
20474 strange and unexpected form, between the hours of ten and eleven-twenty
20475 on the night of March 30, 1894.
20478 \begin_layout Standard
20482 \begin_layout Plain Layout
20494 \begin_layout Standard
20497 Ronald Adair was fond of cards–playing continually, but never for such stakes
20499 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
20500 It was shown that, after dinner on the day of his death, he had played
20501 a rubber of whist at the latter club.
20502 He had also played there in the afternoon.
20507 The evidence of those who had played with him– Mr.
20508 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
20509 and that there was a fairly equal fall of the cards.
20510 Adair might have lost five pounds, but not more.
20511 His fortune was a considerable one, and such a loss could not in any way
20513 He had played nearly every day at one club or other, but he was a cautious
20514 player, and usually rose a winner.
20515 It came out in evidence that, in partnership with Colonel Moran, he had
20516 actually won as much as four hundred and twenty pounds in a sitting, some
20517 weeks before, from Godfrey Milner and Lord Balmoral.
20518 So much for his recent history as it came out at the inquest.
20521 \begin_layout Standard
20525 \begin_layout Plain Layout
20537 \begin_layout Standard
20538 Please do read the file
20540 examples/multicol.lyx
20542 for more advanced examples including column and header spacing, vertical
20543 separator lines, and more.
20546 \begin_layout Section
20551 Paragraph Environment
20552 \begin_inset OptArg
20555 \begin_layout Plain Layout
20556 Numbering in Enumerate
20564 \begin_layout Standard
20570 \begin_layout Standard
20571 \begin_inset VSpace bigskip
20577 \begin_layout Standard
20579 The default numbering for the
20583 paragraph environment begins with Arabic numbers and ends with uppercase
20585 Suppose, however, you wanted a different type of numbering scheme.
20586 Here's a quickie example of how to change the numbering scheme:
20589 \begin_layout LyX-Code
20599 \begin_layout LyX-Code
20609 \begin_layout LyX-Code
20619 \begin_layout LyX-Code
20629 \begin_layout Standard
20630 \SpecialChar \ldots{}
20631 which changes the numbering scheme to uppercase Roman numerals, uppercase
20632 letters, Arabic numbers, and lowercase letter.
20635 \begin_layout Standard
20636 Additionally, the previous example also adds a little bit extra to the numbering
20638 For example, the first level label actually looks like:
20639 \begin_inset Quotes eld
20643 \begin_inset Quotes erd
20647 For ease of reading, we'll describe what the numbering schemes look like
20648 using a notation something like this: <
20649 \begin_inset Quotes eld
20653 \begin_inset Quotes erd
20657 \begin_inset space ~
20661 \begin_inset Quotes erd
20665 \begin_inset Quotes erd
20669 \begin_inset space ~
20673 \begin_inset Quotes erd
20677 \begin_inset Quotes erd
20681 \begin_inset space ~
20685 \begin_inset Quotes eld
20689 \begin_inset Quotes erd
20696 \begin_layout Standard
20697 As you can see in the example, there is a label command for each nesting
20704 \SpecialChar \ldots{}
20711 , as well as a counter,
20715 \SpecialChar \ldots{}
20721 There are also five
20722 \begin_inset Quotes eld
20726 \begin_inset Quotes erd
20759 , each of which take one counter as an argument.
20760 You can add characters before or after these, but there's no need to add
20764 \begin_layout Standard
20765 You can get really fancy with these.
20769 \begin_layout LyX-Code
20783 \begin_layout LyX-Code
20795 \begin_layout LyX-Code
20805 \begin_layout LyX-Code
20815 \begin_layout Standard
20816 produces the somewhat out of hand numbering scheme: <
20817 \begin_inset Quotes eld
20821 \begin_inset Quotes erd
20825 \begin_inset space ~
20829 \begin_inset Quotes erd
20833 \begin_inset Quotes erd
20837 \begin_inset space ~
20841 \begin_inset Quotes erd
20845 \begin_inset Quotes erd
20849 \begin_inset space ~
20853 \begin_inset Quotes eld
20857 \begin_inset Quotes erd
20864 \begin_layout Standard
20868 \begin_layout Section
20872 \begin_layout Standard
20878 \begin_layout Standard
20879 \begin_inset VSpace bigskip
20885 \begin_layout Standard
20890 \begin_layout Plain Layout
20896 tmpfont}{cmr17 scaled 2500}{
20908 \begin_layout Standard
20913 \begin_layout Plain Layout
20924 hose of you who like the style of old books probably also like
20925 \begin_inset Quotes eld
20929 \begin_inset Quotes erd
20932 —those large capital letters which begin each new chapter or section.
20933 Implementing them with plain LyX/LaTeX is straightforward (assuming you
20934 know some plain TeX!) but does require a lot of work and many iterations,
20935 as you can see by all the ugly TeX-mode stuff at the beginning of this
20939 \begin_layout Standard
20943 \begin_layout Plain Layout
20949 bigdrop{-1em}{3}{ptmri}{T}+
20954 here is a much easier way of doing this, of course.
20963 ) package from CTAN allows a simple way to add such letters to your documents.
20964 Since this package is not a standard part of teTeX, I can't demonstrate
20965 it within this document, but if you copy this paragraph to a new document,
20967 \begin_inset Quotes eld
20977 \begin_inset Quotes erd
20980 and the pluses from the TeX code at the beginning of the paragraph, and
20985 usepackage{dropcaps}
20987 to your LaTeX preamble, you will get a nice Times Roman Italic
20988 \begin_inset Quotes eld
20992 \begin_inset Quotes erd
20995 , whose height is three lines of text and which protrudes 1 em into the
20997 (Make certain you have copied
20998 \begin_inset Quotes eld
21006 \begin_inset Quotes erd
21009 into a directory where TeX can see it.) The first argument is the amount
21010 of indentation; in this case the negative sign moves it into the margin.
21011 The second argument is the height of the letter in number of lines of text.
21012 The third argument is the font name: virtually anything which has a tfm
21013 file should work (wade through the
21015 .../texmf/fonts/tfm
21017 directory for possibilities).
21018 My personal favorite is
21019 \begin_inset Quotes eld
21027 \begin_inset Quotes erd
21030 , a fancy German font specifically designed for dropped capitals.
21031 The fourth argument is the letter (or letters) to be dropped.
21036 package also offers the
21042 command, as well as a slightly simplified
21051 \begin_layout Section
21052 Non-standard Paragraph Shapes
21055 \begin_layout Standard
21061 \begin_layout Standard
21062 \begin_inset VSpace bigskip
21068 \begin_layout Standard
21072 \begin_layout Plain Layout
21084 \begin_layout Standard
21088 \begin_layout Plain Layout
21097 \begin_layout Plain Layout
21111 \begin_layout Standard
21116 \begin_layout Plain Layout
21127 \begin_layout Plain Layout
21136 \begin_layout Plain Layout
21145 \begin_layout Plain Layout
21154 \begin_layout Plain Layout
21163 \begin_layout Plain Layout
21172 \begin_layout Plain Layout
21181 \begin_layout Plain Layout
21190 \begin_layout Plain Layout
21199 \begin_layout Plain Layout
21208 \begin_layout Plain Layout
21217 \begin_layout Plain Layout
21226 \begin_layout Plain Layout
21235 \begin_layout Plain Layout
21244 \begin_layout Plain Layout
21253 \begin_layout Plain Layout
21262 \begin_layout Plain Layout
21271 \begin_layout Plain Layout
21280 \begin_layout Plain Layout
21289 \begin_layout Plain Layout
21295 There are times when the tyranny of rectangular paragraphs must be overthrown.
21296 In such situations, a call to the delightful plain TeX command
21303 As you can see, completely arbitrary shapes can be laid out with a suitable
21304 set of linelength definitions.
21305 While this parshape may look a bit silly and useless, one could conceive
21306 of situations such as finely tuned dropped capitals, word wrapping around
21307 non-rectangular graphics, etc.
21308 which will benefit from such handcrafting.
21311 \begin_layout Standard
21312 \begin_inset VSpace bigskip
21318 \begin_layout Standard
21323 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
21330 is the number of lines of text which define the paragraph.
21331 If there turn out to be fewer lines, the shape is truncated; if there are
21332 more, the excess lines have the same dimensions as the last line of the
21342 entries specify the indentation of the line from the left margin, and the
21343 length of the line as measured from that point.
21344 The shape applies only to the current paragraph; everything is reset to
21345 normal for the next paragraph.
21348 \begin_layout Standard
21352 \begin_layout Plain Layout
21364 \begin_layout Section
21368 \begin_layout Standard
21369 As you can see, the examples in this section range from the useful to the
21371 While I don't expect that anyone will ever need the paragraph shape demonstrate
21372 d in the last section, the important point is that you can do almost anything
21373 you want in LyX if you are willing to figure out how to do it in TeX and
21375 TeX is a fantastically powerful typesetting system and all that power is
21376 available to you since LyX uses it as its backend.