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 Currently, only Skim on Mac OSX and SumatraPDF on Windows offer the reverse
4634 provide the reverse search feature (also called
4638 ), allowing the cursor in LyX to automatically jump to the point corresponding
4639 to a given position in the previewed DVI or PDF file.
4640 A program or script will be called by the viewer when initiating a reverse
4642 The way the search is triggered depends on the viewer (for example,
4643 \begin_inset Flex CharStyle:Code
4646 \begin_layout Plain Layout
4652 uses Ctrl-click (Alt-click on Mac OSX),
4653 \begin_inset Flex CharStyle:Code
4656 \begin_layout Plain Layout
4663 \begin_inset Flex CharStyle:Code
4666 \begin_layout Plain Layout
4672 use double-click, whereas
4673 \begin_inset Flex CharStyle:Code
4676 \begin_layout Plain Layout
4682 uses COMMAND-SHIFT-click), but in general the program is called with two
4683 arguments, a filename and a line number, and, in turn, it should pass this
4684 info to a running instance of LyX.
4685 This can be done through the LyX server either by using the named pipe
4686 (lyxpipe), or the unix domain socket (lyxsocket) that lyx creates in its
4687 temporary directory (this is the way the
4688 \begin_inset Flex CharStyle:Code
4691 \begin_layout Plain Layout
4697 program communicates with LyX).
4700 \begin_layout Standard
4701 The reverse search feature can be enabled in LyX as follows:
4704 \begin_layout Itemize
4705 The DVI or PDF file should be complemented by suitable info produced either
4706 by using appropriate options when calling the LaTeX compiler (method 1,
4707 DVI only), or by using an appropriate package (method 2, both DVI and PDF).
4711 \begin_layout Description
4713 \begin_inset space ~
4717 \begin_inset space ~
4721 \begin_inset space ~
4724 only) If you use recent texlive or miktex distributions, change the
4725 \begin_inset Flex CharStyle:MenuItem
4728 \begin_layout Plain Layout
4733 \begin_layout Plain Layout
4746 \begin_inset Flex CharStyle:MenuItem
4749 \begin_layout Plain Layout
4754 \begin_layout Plain Layout
4761 eX (plain)->DraftDVI
4767 \begin_inset Flex CharStyle:MenuItem
4770 \begin_layout Plain Layout
4771 Preferences\SpecialChar \menuseparator
4772 File Handling\SpecialChar \menuseparator
4779 \begin_inset Flex CharStyle:Code
4782 \begin_layout Plain Layout
4783 latex -src-specials $$i
4788 , otherwise check what is the appropriate option for your TeX engine.
4791 \begin_layout Description
4793 \begin_inset space ~
4796 2 Insert in the preamble of the LyX file
4797 \begin_inset Flex CharStyle:Code
4800 \begin_layout Plain Layout
4808 for reverse PDF search, or (as an alternative to redefining the converters)
4810 \begin_inset Flex CharStyle:Code
4813 \begin_layout Plain Layout
4816 usepackage[active]{srcltx}
4821 for reverse DVI search.
4822 If you want to be able to perform both DVI and PDF reverse searches, you
4823 can also insert in the preamble the following lines
4827 \begin_layout LyX-Code
4831 \begin_inset Newline newline
4837 \begin_inset Newline newline
4843 \begin_inset Newline newline
4849 \begin_inset Newline newline
4854 usepackage[active]{srcltx}
4855 \begin_inset Newline newline
4863 \begin_layout Standard
4864 In this way, you can preview the file as either DVI or PDF (pdflatex) and
4865 the right package will be used.
4870 \begin_layout Itemize
4872 \begin_inset Flex CharStyle:Code
4875 \begin_layout Plain Layout
4881 , you don't need to do anything else for performing a reverse DVI search,
4882 as LyX already provides the necessary hooks for automatically using the
4884 \begin_inset Flex CharStyle:Code
4887 \begin_layout Plain Layout
4894 However, if for whatever reason you want to use the named pipe instead
4895 of the socket for communicating with LyX, simply change the DVI viewer
4897 \begin_inset Flex CharStyle:MenuItem
4900 \begin_layout Plain Layout
4901 Preferences\SpecialChar \menuseparator
4902 File Handling\SpecialChar \menuseparator
4912 \begin_layout Plain Layout
4913 On Mac OSX you have to use
4914 \begin_inset Flex CharStyle:Code
4917 \begin_layout Plain Layout
4918 DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
4929 \begin_inset Flex CharStyle:Code
4932 \begin_layout Plain Layout
4933 xdvi -editor 'lyxeditor.sh %f %l'
4939 \begin_inset Flex CharStyle:Code
4942 \begin_layout Plain Layout
4948 is a suitable script.
4949 For example, a minimal shell script is the following one:
4953 \begin_layout LyX-Code
4955 \begin_inset Newline newline
4958 LYXPIPE="/path/to/lyxpipe"
4959 \begin_inset Newline newline
4962 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
4963 \begin_inset Newline newline
4966 echo "$COMMAND" > "${LYXPIPE}".in || exit
4967 \begin_inset Newline newline
4970 read < "${LYXPIPE}".out || exit
4973 \begin_layout Standard
4975 \begin_inset Flex CharStyle:Code
4978 \begin_layout Plain Layout
4984 is the LyXServer pipe path specified in
4985 \begin_inset Flex CharStyle:MenuItem
4988 \begin_layout Plain Layout
4989 Preferences\SpecialChar \menuseparator
4999 \begin_layout Itemize
5000 If you use Mac OSX and MacDviX as a DVI viewer, add at the end of
5001 \begin_inset Newline newline
5005 \begin_inset Flex CharStyle:Code
5008 \begin_layout Plain Layout
5009 /Applications/MacDviX_Folder/calleditor.script
5014 the following lines:
5018 \begin_layout LyX-Code
5023 \begin_layout Plain Layout
5030 X.app/Contents/MacOS/lyxeditor "$2" $1
5031 \begin_inset Newline newline
5037 \begin_layout Standard
5038 (Modify as needed if you install LyX somewhere other than the Applications
5043 \begin_layout Itemize
5044 If you use Mac OSX and Skim as a PDF viewer, you should enter
5045 \begin_inset Flex CharStyle:Code
5048 \begin_layout Plain Layout
5049 open -a Skim.app $$i
5054 in the viewer setting in
5055 \begin_inset Flex CharStyle:MenuItem
5058 \begin_layout Plain Layout
5059 Preferences\SpecialChar \menuseparator
5060 File Handling\SpecialChar \menuseparator
5061 File formats\SpecialChar \menuseparator
5068 \begin_inset Flex CharStyle:MenuItem
5071 \begin_layout Plain Layout
5072 Skim\SpecialChar \menuseparator
5073 Preferences\SpecialChar \menuseparator
5083 \begin_layout Plain Layout
5093 \begin_layout Itemize
5094 If you use the Cygwin version of LyX and yap as a DVI viewer, you should
5095 set the name of the program that communicates with LyX directly in yap
5097 Launch yap, choose its
5098 \begin_inset Flex CharStyle:MenuItem
5101 \begin_layout Plain Layout
5102 View\SpecialChar \menuseparator
5108 menu and select the "Inverse DVI Search" tab.
5109 Click on the "New..." button and, in the window which opens, enter "LyX Editor"
5110 (or any other name you like) in the "Name:" field.
5111 Now click on the button labeled "..." to open a filedialog and navigate to
5112 the directory containing the batch file
5113 \begin_inset Flex CharStyle:Code
5116 \begin_layout Plain Layout
5124 \begin_inset Flex CharStyle:Code
5127 \begin_layout Plain Layout
5133 and then specify the program arguments as
5134 \begin_inset Flex CharStyle:Code
5137 \begin_layout Plain Layout
5143 if you want to use the shell script above, or as
5144 \begin_inset Flex CharStyle:Code
5147 \begin_layout Plain Layout
5153 if you want to use the
5154 \begin_inset Flex CharStyle:Code
5157 \begin_layout Plain Layout
5164 As yap is a native Windows application, the filename it provides should
5165 be converted to posix style before being passed to
5166 \begin_inset Flex CharStyle:Code
5169 \begin_layout Plain Layout
5176 \begin_inset Flex CharStyle:Code
5179 \begin_layout Plain Layout
5185 , and this is the purpose of the
5186 \begin_inset Flex CharStyle:Code
5189 \begin_layout Plain Layout
5195 wrapper, which is as follows:
5199 \begin_layout LyX-Code
5201 \begin_inset Newline newline
5204 if "%1" == "-g" goto lyxclient
5205 \begin_inset Newline newline
5208 bash -c 'lyxeditor.sh $(cygpath -a "%1") %2'
5209 \begin_inset Newline newline
5213 \begin_inset Newline newline
5217 \begin_inset Newline newline
5220 bash -c 'lyxclient %1 $(cygpath -a "%2") %3'
5223 \begin_layout Standard
5224 You have to make sure that both
5225 \begin_inset Flex CharStyle:Code
5228 \begin_layout Plain Layout
5235 \begin_inset Flex CharStyle:Code
5238 \begin_layout Plain Layout
5244 are in the command PATH, otherwise you have to use their full posix path
5245 in the above batch file.
5249 \begin_layout Itemize
5250 If you use the Cygwin version of LyX and SumatraPDF as a PDF viewer, you
5251 can set the name of the program that communicates with LyX by simply launching
5253 \begin_inset Flex CharStyle:Code
5256 \begin_layout Plain Layout
5257 SumatraPDF -inverse-search "lyxeditor.bat -g %f %l"
5263 The program will remember the setting and using the
5264 \begin_inset Flex CharStyle:Code
5267 \begin_layout Plain Layout
5273 option will not be needed from now on (in this way you will be using the
5275 \begin_inset Flex CharStyle:Code
5278 \begin_layout Plain Layout
5284 option if you want to use the lyxpipe and be sure that the
5285 \begin_inset Flex CharStyle:Code
5288 \begin_layout Plain Layout
5294 script is in your command PATH).
5295 If SumatraPDF is not your default PDF viewer, you should enter
5296 \begin_inset Flex CharStyle:Code
5299 \begin_layout Plain Layout
5305 in the viewer setting in
5306 \begin_inset Flex CharStyle:MenuItem
5309 \begin_layout Plain Layout
5310 Preferences\SpecialChar \menuseparator
5311 File Handling\SpecialChar \menuseparator
5312 File formats\SpecialChar \menuseparator
5319 \begin_inset Flex CharStyle:Code
5322 \begin_layout Plain Layout
5328 is the following script (to be placed in your command PATH, /usr/local/bin
5329 being the best choice):
5333 \begin_layout LyX-Code
5335 \begin_inset Newline newline
5339 \begin_inset Newline newline
5342 SumatraPDF.exe $(basename $1)
5345 \begin_layout Standard
5346 This is needed because SumatraPDF is a native Windows application and does
5347 not understand the posix paths used by the Cygwin version of LyX.
5351 \begin_layout Standard
5352 If you did no mistakes and the DVI or PDF files are produced as previously
5353 described, whenever you Ctrl-click (Alt-click on Mac) in xdvi, double-click
5354 in yap and SumatraPDF, or COMMAND-SHIFT-click in Skim, the cursor in LyX
5355 should jump to the desired location.
5358 \begin_layout Chapter
5359 Special Document Classes
5362 \begin_layout Section
5366 \begin_layout Standard
5372 \begin_layout Subsection
5376 \begin_layout Standard
5377 This section describes how LyX can be used to write articles for submission
5378 to the scientific journal
5380 Astronomy and Astrophysics
5382 (www.edpsciences.fr/aa/
5383 \begin_inset Flex URL
5386 \begin_layout Plain Layout
5388 http://www.edpsciences.fr/aa/
5393 ) using Version 5.01 of the document class
5398 This package can be downloaded from the ftp site
5401 \begin_layout Standard
5402 \begin_inset VSpace medskip
5408 \begin_layout Standard
5410 \begin_inset Flex URL
5413 \begin_layout Plain Layout
5415 ftp://ftp.edpsciences.org/pub/aa/readme.html
5423 \begin_layout Standard
5424 \begin_inset VSpace medskip
5430 \begin_layout Standard
5431 A manual comes together with that package, and this text is not meant to
5432 replace the original manual but merely a short guide how to realize the
5433 correct form of your paper.
5437 \begin_layout Standard
5438 Please note that the publisher of the journal was changed from Springer
5439 to EDP Sciences starting January 1, 2001.
5440 That change implicated also some slight changes of the style files, namely
5441 the removal of the thesaurus command.
5442 The LyX class aa supports the newest version of these style files, V 5.01.
5443 If you have an older version installed, please upgrade.
5444 For compatibility, the old (version 4) layout has been kept as
5449 Please refer to the comments in
5451 LyXDir/layouts/aapaper.layout
5456 \begin_layout Subsection
5460 \begin_layout Standard
5461 It is recommended you start from the example template distributed with LyX.
5462 If you are not using a template, note the following settings:
5465 \begin_layout Itemize
5472 Document\SpecialChar \menuseparator
5475 dialog (OK, that one was obvious).
5478 \begin_layout Itemize
5479 Don't change the option
5482 \begin_inset space ~
5492 The whole layout is done by the macros, you shouldn't change anything.
5495 \begin_layout Subsection
5499 \begin_layout Standard
5500 First thing to enter is the header information.
5501 It consists of seven entries, of which some are optional.
5505 \begin_layout Itemize
5513 \begin_layout Itemize
5521 \begin_layout Itemize
5529 \begin_layout Itemize
5537 \begin_layout Itemize
5542 : [optional] if more than one author: whom to contact for offprint requests.
5545 \begin_layout Itemize
5550 : [optional] mail address for contacts.
5553 \begin_layout Itemize
5561 Received: <date>; Accepted <date>
5564 \begin_layout Standard
5565 There is no need to issue the
5571 command, this is done automatically by LyX when the header is finished.
5572 Although the order of the single header entries doesn't matter it is advised
5573 to keep the above sequence, just to get the best optics and meets the layout
5574 of the real document.
5577 \begin_layout Standard
5578 If you want to place footnotes in the header block, e.
5579 \begin_inset space \thinspace{}
5583 \begin_inset space \space{}
5586 to state your present address, just use the standard footnote via the menu
5589 Insert\SpecialChar \menuseparator
5593 LyX will automagically use the term
5602 \begin_layout Standard
5603 In addition to these topics, the macros use three additional LaTeX commands
5604 that have no counterpart in LyX:
5607 \begin_layout Itemize
5614 to separate different names for more than one author and institute, respectivel
5618 \begin_layout Itemize
5625 to mark corresponding author/institute pairs.
5626 The institutes are numbered sequentially as they appear in the
5630 field, so you have to put a marker to each author.
5633 \begin_layout Itemize
5640 to supply an email address for fast contact.
5643 \begin_layout Standard
5644 In all cases, the appropriate command has to be entered in LyX and marked
5650 \begin_layout Subsection
5654 \begin_layout Standard
5655 The abstract should immediately follow the header block.
5656 With version 5 the abstract environment was changed to a command, and there
5657 is now a resctriction to only one paragraph.
5658 In addition, it should contain an entry with the keywords.
5659 This is not yet implemented for LyX, therefore you have to enter the LaTeX
5666 by hand and mark it as LaTeX code.
5667 Refer to the example paper.
5670 \begin_layout Subsection
5671 Supported environments
5674 \begin_layout Standard
5675 The A&A paper layout supports the following environments for structuring
5679 \begin_layout Itemize
5685 \begin_layout Itemize
5691 \begin_layout Itemize
5697 \begin_layout Itemize
5703 \begin_layout Itemize
5709 \begin_layout Itemize
5715 \begin_layout Itemize
5721 \begin_layout Itemize
5727 \begin_layout Itemize
5733 \begin_layout Itemize
5739 \begin_layout Itemize
5745 \begin_layout Itemize
5751 \begin_layout Subsection
5752 Commands not supported by LyX
5755 \begin_layout Standard
5756 Some commands are not yet supported by the
5761 Some have already been mentioned.
5762 For the sake of completeness, they are listed all together here:
5765 \begin_layout Itemize
5773 \begin_layout Itemize
5781 \begin_layout Itemize
5789 \begin_layout Itemize
5797 \begin_layout Itemize
5805 \begin_layout Itemize
5813 \begin_layout Itemize
5821 \begin_layout Itemize
5829 \begin_layout Standard
5830 If you want to use any of these commands, you have to enter them yourself.
5833 Do not forget to mark them as LaTeX code!
5836 \begin_layout Subsection
5837 Figure and Table Floats
5840 \begin_layout Standard
5841 LyX provides support for the necessary float environments
5843 figure, figure*, table
5849 , therefore we won't tell much about it here.
5853 \begin_inset space ~
5859 Just remember that tables should be left-aligned.
5860 For that, select the table and change the alignment in
5862 Edit\SpecialChar \menuseparator
5864 \begin_inset space ~
5870 \begin_layout Standard
5871 There is only one special thing: the figures with caption besides the figure.
5872 To create such a figure, you have to do the following:
5875 \begin_layout Enumerate
5876 Create a wide figure float:
5878 Insert\SpecialChar \menuseparator
5879 Float\SpecialChar \menuseparator
5882 , then right click in the figure and select
5888 \begin_inset space ~
5896 \begin_layout Enumerate
5897 Enter your caption text.
5900 \begin_layout Enumerate
5905 to move the cursor above the caption.
5908 \begin_layout Enumerate
5912 \begin_layout Enumerate
5913 Position the cursor behind the figure and insert a horizontal fill:
5915 Insert\SpecialChar \menuseparator
5917 \begin_inset space ~
5920 Character\SpecialChar \menuseparator
5922 \begin_inset space ~
5930 \begin_layout Enumerate
5931 Switch to LaTeX mode:
5934 \begin_inset space ~
5942 \begin_layout Enumerate
5952 Do not close the brace!
5955 \begin_layout Enumerate
5956 Position the cursor behind the caption text, switch to LaTeX mode and insert
5960 \begin_inset space ~
5972 \begin_layout Standard
5973 Also, refer to the figures in the example paper.
5976 \begin_layout Subsection
5980 \begin_layout Standard
5981 For submission, the paper has to be formated in a special double-spacing
5983 For this purpose, you have to give the option
5987 to the documentclass.
5988 This must be done using the extra class options field in the
5990 Document\SpecialChar \menuseparator
5994 Just enter the string
6001 \begin_layout Subsection
6005 \begin_layout Standard
6010 directory contains an example paper written with LyX.
6011 It is the example paper from the original macro package, translated to
6013 Use it for inspiration, and compare the original LaTeX code with LyX way
6017 \begin_layout Section
6021 \begin_layout Standard
6027 \begin_layout Subsection
6031 \begin_layout Standard
6032 AASTeX is a set of macros produced by the American Astronomical Society
6033 to facilitate electronic manuscript submission to the three journals they
6034 publish: the Astrophysical Journal (including the Letters and Supplement),
6035 the Astronomical Journal, and the Publications of the Astronomical Society
6037 LyX has proven to be an excellent tool for generating these documents,
6038 especially given its equation, citation, and figure handling capabilities.
6039 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
6040 is the version described here, or higher.
6041 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
6042 incompatible with LyX.
6043 The AASTeX package may be downloaded from the AASTeX Web site
6046 \begin_layout Standard
6047 \begin_inset VSpace medskip
6053 \begin_layout Standard
6055 \begin_inset Flex URL
6058 \begin_layout Plain Layout
6060 http://www.journals.uchicago.edu/AAS/AASTeX
6068 \begin_layout Standard
6069 \begin_inset VSpace medskip
6075 \begin_layout Standard
6076 A complete user guide is contained in that package and you should familiarize
6077 yourself with it thoroughly before embarking on writing a paper in LyX.
6078 LyX will not reduce the need to figure out all the AASTeX commands, it
6079 will only reduce the drudgery of typing everything in.
6080 It is your responsibility to ensure that the final exported LaTeX document
6081 conforms completely to the requirements of the journal to which you are
6082 submitting your paper.
6085 \begin_layout Subsection
6086 Starting a New Paper
6089 \begin_layout Standard
6090 I strongly suggest that you start with the AASTeX template file.
6093 File\SpecialChar \menuseparator
6100 , enter the new file name, then choose the
6105 This will show the most common fields found in a manuscript.
6106 Simply overwrite the existing text (including the brackets,
6110 ) with the correct information.
6111 Many of the AASTeX commands and environments can be implemented directly
6112 in LyX, but some cannot: most noticeably
6124 , which should stick out like a sore thumb if you actually just opened the
6126 For commands such as these, the LaTeX code must be entered directly and
6128 Such commands are referred to as TeX code, or Evil Red Text.
6129 I tried to minimize the amount of TeX code needed in an AASTeX document,
6130 but there is still a bit more required than any of us would like.
6133 \begin_layout Subsection
6134 Finishing Your Paper
6137 \begin_layout Standard
6138 When the paper is finished to your satisfaction and previews/prints correctly,
6140 \begin_inset Quotes eld
6144 \begin_inset Quotes erd
6147 actions which need to be done before you submit it to the journals.
6151 \begin_layout Enumerate
6152 Export your paper as a LaTeX file (
6154 File\SpecialChar \menuseparator
6155 Export\SpecialChar \menuseparator
6162 \begin_layout Enumerate
6167 file with your favorite text editor
6171 \begin_layout Enumerate
6172 remove the comment lines before the
6181 \begin_layout Enumerate
6186 usepackage...{fontenc}
6188 line if it appears (usually just after
6203 \begin_layout Enumerate
6204 remove everything between (and including) the
6216 commands, except for any commands you specifically put into the LaTeX preamble
6217 (which should appear immediately after the
6218 \begin_inset Quotes eld
6221 User specified LaTeX commands
6222 \begin_inset Quotes erd
6233 \begin_layout Enumerate
6234 Run the resulting file through LaTeX to make sure it still processes correctly.
6237 \begin_layout Enumerate
6238 Reread the journal requirements to make sure your filenames and formats
6242 \begin_layout Enumerate
6246 \begin_layout Subsection
6247 Comments On Specific Commands
6250 \begin_layout Standard
6251 I will not describe the detailed usage of the individual AASTeX commands:
6252 the AASTeX User Guide (
6256 ) gives a good description of each.
6257 Thus it's probably easiest for me to go down the list as found in the guide
6258 and offer comments where necessary.
6259 So let's begin \SpecialChar \ldots{}
6263 \begin_layout Subsubsection
6264 Things that work as expected
6267 \begin_layout Standard
6271 \begin_layout Plain Layout
6283 \begin_layout Standard
6284 Because they work as you might expect, I simply list them and the section
6385 begin{thebibliography}
6393 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6394 graphicx figure commands (2.14.1),
6418 (2.15.4, amongst other places),
6445 \begin_layout Standard
6446 The following style options also work correctly:
6467 Simply put them in the
6473 Layout\SpecialChar \menuseparator
6479 \begin_layout Standard
6483 \begin_layout Plain Layout
6495 \begin_layout Subsubsection
6496 Things that work, but require more comment
6499 \begin_layout Standard
6500 The following items work, but require a little more discussion:
6503 \begin_layout Itemize
6504 These items are reserved for use by the journal editors, but you can put
6505 them into the LaTeX preamble if you feel compelled to do so:
6538 \begin_layout Itemize
6539 These items may be placed in the LaTeX preamble, and are included as blanks
6540 in the template file:
6561 \begin_layout Itemize
6568 (2.3) – can only be used
6569 \begin_inset Quotes eld
6573 \begin_inset Quotes erd
6576 , not in the middle of a paragraph.
6577 Use TeX code if you need to embed it.
6580 \begin_layout Itemize
6587 (2.3) – will have extra {} after it.
6588 This should not cause an error.
6591 \begin_layout Itemize
6598 (2.6) – can only be used
6599 \begin_inset Quotes eld
6603 \begin_inset Quotes erd
6606 , not in the middle of a paragraph.
6607 Use TeX code if you need to embed it.
6610 \begin_layout Itemize
6617 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6621 \begin_layout Itemize
6628 (2.8) – same as for
6635 \begin_layout Itemize
6642 (2.9) – will have extra {} after it.
6643 This should not cause an error.
6646 \begin_layout Itemize
6653 (2.11) – will have extra {} after it.
6654 This should not cause an error.
6657 \begin_layout Itemize
6664 (2.14.2) – you can insert an optional filename argument by placing the cursor
6665 at the beginning of the text and selecting
6667 Insert\SpecialChar \menuseparator
6672 \begin_inset Quotes eld
6676 \begin_inset Quotes erd
6679 inserts an optional argument of the type needed by
6686 Hopefully it will be renamed someday.
6689 \begin_layout Itemize
6696 (2.17.1) – same as
6702 for the catalog ID optional parameter
6705 \begin_layout Itemize
6712 (2.17.1) – same as
6718 for the catalog ID optional parameter
6721 \begin_layout Subsubsection
6722 Things not implemented, use TeX code
6725 \begin_layout Standard
6729 \begin_layout Plain Layout
6741 \begin_layout Standard
6764 setcounter{equation}
6766 (2.12), Journal name abbreviations (2.13.4),
6802 (2.15.4, insert it as the first element in the lefthand cell after where
6804 Don't use any of LyX's rules in the table),
6816 (2.15.5), much of Misc (2.17, except
6867 \begin_layout Standard
6871 \begin_layout Plain Layout
6883 \begin_layout Subsubsection
6884 Things that cannot be implemented
6887 \begin_layout Standard
6888 \SpecialChar \ldots{}
6889 at least in any meaningful sort of way, so I suggest ignoring them.
6890 They are the references environment (2.13.3), and the deluxetable environment
6892 If you really, really need to use deluxetable, I suggest editing it in
6893 a separate file with a text editor, then using
6895 Insert\SpecialChar \menuseparator
6897 \begin_inset space ~
6902 to include it in your LyX document.
6907 file to see an example of this.
6910 \begin_layout Subsection
6911 FAQs, Tips, Tricks, and Other Ruminations
6914 \begin_layout Subsubsection
6915 Getting LyX and AASTeX to cooperate
6918 \begin_layout Standard
6919 It can be a bit tricky to get LyX to recognize a new layout and document
6921 When all else fails, do this:
6924 \begin_layout Enumerate
6925 Make certain that LaTeX can find AASTeX.
6926 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6927 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6934 \begin_layout Enumerate
6946 \begin_layout Enumerate
6949 Tools\SpecialChar \menuseparator
6952 in LyX, then restart LyX.
6955 \begin_layout Enumerate
6956 Open a regular new file, not from a template.
6957 Does AASTeX appear in the class list in
6959 Document\SpecialChar \menuseparator
6965 \begin_layout Standard
6966 If you get a warning from an existing AASTeX document about not being able
6967 to find the AASTeX layout or a message about
6968 \begin_inset Quotes eld
6971 You should not mix title layouts with normal ones
6972 \begin_inset Quotes erd
6975 , things haven't been installed correctly.
6978 \begin_layout Subsubsection
6979 LaTeX error processing a table
6982 \begin_layout Standard
6983 LyX, by default, attempts to center the table caption/title.
6984 This seems to produce a bad interaction in AASTeX so you should click somewhere
6985 in the caption/title, then select
6987 Edit\SpecialChar \menuseparator
6989 \begin_inset space ~
7003 This took care of it for me.
7006 \begin_layout Subsubsection
7010 \begin_layout Standard
7011 A couple of things: 1) I have noticed some funny spacing in the reference
7012 entries in the text.
7013 When you enter the bibliography item data, make sure their is
7017 space between the last author and the parenthesis setting off the year;
7021 \begin_inset space \thinspace{}
7025 \begin_inset space \space{}
7039 2) Entering the references at all is not obvious.
7040 The easiest thing is to start typing your first reference at the end of
7041 the document, then mark it as type
7046 That will put a small gray box in front of what you just typed.
7047 Click on the box to fill in the rest of the information.
7048 For new references, go to the end of an existing reference and press return.
7049 That will create a new line with its own box, etc.
7052 \begin_layout Subsubsection
7056 \begin_layout Standard
7057 Even though AASTeX provides its own figure commands (
7063 , for example), I much prefer LaTeX's standard figure commands (with the
7072 \begin_inset space ~
7075 commands as TeX code into a Figure Float box if you desire, but I never
7076 have much luck getting the layout right.
7077 With the standard graphics, LyX will insert a
7081 usepackage{graphicx}
7083 command into the LaTeX preamble and handle the figures in the standard
7084 LaTeX2e way, interspersing the figures in the text.
7085 I believe ApJ accepts figures exactly this way now; AJ might still use
7087 \begin_inset Quotes eld
7090 stack everything at the end
7091 \begin_inset Quotes erd
7097 \begin_layout Subsubsection
7098 Things I could have done, but didn't
7101 \begin_layout Standard
7103 \begin_inset Quotes eld
7107 \begin_inset Quotes erd
7110 things I could have implemented, but chose not to.
7111 For instance, I saw no point in double-spacing the text in the LyX window,
7112 even though it is double-spaced in the paper manuscript.
7113 Also, I chose not to make separate layouts for the preprint and preprint2
7115 Since I assume you will spend most of your time in the plain manuscript
7116 mode anyway, I decided not to chew up more disk space with this.
7120 \begin_layout Subsection
7124 \begin_layout Standard
7125 Your mileage may vary.
7126 I've now had papers published by both ApJ and AJ that have had 98% of the
7127 effort done in LyX; the last 2% was the LaTeX post-processing and a few
7129 I have had no trouble with the submission process, and I'm sure the journals
7130 were never aware that there might be a difference.
7131 So, go forth and publish!
7134 \begin_layout Section
7138 \begin_layout Standard
7141 David Johnson; updated by Richard Heck
7144 \begin_layout Standard
7145 \begin_inset VSpace bigskip
7151 \begin_layout Standard
7153 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
7154 papers to be submitted to American Mathematical Society publications.
7155 The layouts are not tailored to a specific journal, but easily can be.
7156 You should refer to the AMS documentation for specific instructions for
7157 each journal (usually it will entail only changing a single line in the
7159 That documentation is available on the Web at
7160 \begin_inset Flex URL
7163 \begin_layout Plain Layout
7171 \begin_inset Flex URL
7174 \begin_layout Plain Layout
7176 ftp://ftp.ams.org/pub/tex/amslatex/
7182 These layouts are appropriate, and useful, for any mathematical writing.
7186 \begin_layout Standard
7187 There are two basic AMS LaTeX layouts:
7190 \begin_layout Itemize
7191 amsart: The standard AMS article format.
7194 \begin_layout Itemize
7195 amsbook: the standard AMS book (really, monograph) format.
7199 \begin_layout Standard
7200 The layouts themselves contain only the minimum necessary to use the AMS
7202 They do not, in particular, contain any of the `theorem' environments used
7203 for setting theorems, lemmas, and the like.
7204 These are contained, instead, in the
7205 \begin_inset Flex CharStyle:Code
7208 \begin_layout Plain Layout
7214 module, which is loaded by default when when you select one of the AMS
7216 (It can also be used with other classes and can be removed, if you would
7217 rather use something else.) Less commonly used environments are in the
7218 \begin_inset Flex CharStyle:Code
7221 \begin_layout Plain Layout
7222 Theorems (AMS-Extended)
7227 module, which must be loaded manually.
7230 \begin_layout Standard
7231 By default, theorems and the like are numbered consecutively throughout
7232 the document, but this may be modified by loading the module
7233 \begin_inset Flex CharStyle:Code
7236 \begin_layout Plain Layout
7237 Theorems (Order by Section)
7242 or, if you are using
7243 \begin_inset Flex CharStyle:Code
7246 \begin_layout Plain Layout
7253 \begin_inset Flex CharStyle:Code
7256 \begin_layout Plain Layout
7257 Theorems (Order by Chapter)
7263 These will number the results as
7264 \begin_inset Formula $n.m$
7267 , where the first number refers to the section (or chapter) and the second
7268 refers to the total number of results so far in that section (or chapter).
7269 Many environments are also available unnumbered.
7270 These are indicated by an asterisk at the end.
7271 If you happen to want
7275 unnumbered results, the the module
7276 \begin_inset Flex CharStyle:Code
7279 \begin_layout Plain Layout
7285 provides that option.
7288 \begin_layout Standard
7289 Note that these modules do not
7293 to be used with the AMS classes.
7294 It is perfectly possible to use the
7295 \begin_inset Flex CharStyle:Code
7298 \begin_layout Plain Layout
7304 module, and the others mentioned, with other classes, such as
7305 \begin_inset Flex CharStyle:Code
7308 \begin_layout Plain Layout
7315 \begin_inset Flex CharStyle:Code
7318 \begin_layout Plain Layout
7325 \begin_inset Flex CharStyle:Code
7328 \begin_layout Plain Layout
7337 \begin_layout Subsection
7338 What these layouts provide
7341 \begin_layout Standard
7342 There is a long list of included environments provided by these layouts.
7343 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
7344 variety of `theorem' environments.
7345 However, the AMS recommends the environments that are available in LyX.
7349 \begin_layout Standard
7350 The following environments—as well as the standard environments, such as
7352 \begin_inset Flex CharStyle:Noun
7355 \begin_layout Plain Layout
7362 \begin_inset Flex CharStyle:Noun
7365 \begin_layout Plain Layout
7372 \begin_inset Flex CharStyle:Noun
7375 \begin_layout Plain Layout
7382 \begin_inset Flex CharStyle:Noun
7385 \begin_layout Plain Layout
7392 \begin_inset Flex CharStyle:Noun
7395 \begin_layout Plain Layout
7402 \begin_inset Flex CharStyle:Code
7405 \begin_layout Plain Layout
7412 \begin_inset Flex CharStyle:Code
7415 \begin_layout Plain Layout
7424 \begin_layout Description
7425 Address This should be the author's permanent address.
7428 \begin_layout Description
7430 \begin_inset space ~
7433 Address This should be the author's temporary address at the time of submission,
7434 if different from the Address.
7437 \begin_layout Description
7438 Email Author's e-mail address
7441 \begin_layout Description
7442 URL Author's Web address, if desired.
7445 \begin_layout Description
7446 Keywords Key words or phrases used to identify specific topics discussed
7450 \begin_layout Description
7451 Subjectclass These refer to the AMS Subject Classifications, published and
7454 Mathematical Reviews
7457 These are also available online at the AMS cites listed above.
7460 \begin_layout Description
7464 \begin_layout Description
7468 \begin_layout Description
7472 \begin_layout Standard
7473 The following environments are provided by both the
7474 \begin_inset Flex CharStyle:Code
7477 \begin_layout Plain Layout
7484 \begin_inset Flex CharStyle:Code
7487 \begin_layout Plain Layout
7493 modules, in the latter case in both starred (unnumbered) and unstarred
7494 (numbered) versions.
7495 These same environments are provided only in the starred versions by the
7497 \begin_inset Flex CharStyle:Code
7500 \begin_layout Plain Layout
7509 \begin_layout Theorem
7510 This is typically used for the statements of major results.
7514 \begin_layout Corollary*
7515 This is used for statements which follow fairly directly from previous statement
7517 Again, these can be major results.
7522 These are smaller results needed to prove other statements.
7525 \begin_layout Proposition
7526 These are less major results which (hopefully) add to the general theory
7530 \begin_layout Conjecture
7531 These are statements provided without justification, which the author does
7532 not know how to prove, but which seem to be true (to the author, at least).
7535 \begin_layout Definition*
7536 Guess what this is for.
7537 The font is different for this environment than for the previous ones.
7541 \begin_layout Example*
7542 Used for examples illustrating proven results.
7545 \begin_layout Problem
7546 It's not really known what this is for.
7547 You should figure it out.
7550 \begin_layout Exercise*
7551 Write a description for this one.
7554 \begin_layout Remark
7555 This environment is also a type of theorem, usually a lesser sort of observation.
7558 \begin_layout Claim*
7559 Often used in the course of giving a proof of a larger result.
7563 Generally, these are used to break up long arguments, using specific instances
7569 The numbering scheme for cases is on its own, not together with other numbered
7575 At the end of this environment, a QED symbol (usually a square, but it can
7576 vary with different styles) is placed.
7577 If you want to have other environments within this one—for example, Case
7578 environments—and have the QED symbol appear only after them, then the other
7579 environments need to be nested within the proof environment.
7582 Nesting Environments
7588 for information on nesting.
7591 \begin_layout Standard
7592 And these environments are provided by
7593 \begin_inset Flex CharStyle:Code
7596 \begin_layout Plain Layout
7597 Theorems (AMS-Extended)
7605 \begin_layout Criterion*
7606 A required condition.
7609 \begin_layout Algorithm*
7610 A general procedure to be used.
7613 \begin_layout Axiom*
7614 This is a property or statement taken as true within the system being discussed.
7617 \begin_layout Condition*
7618 Sometimes used to state a condition assumed within the present context of
7623 Similar to a Remark.
7626 \begin_layout Notation*
7627 Used for the explanation of, yes, notation.
7630 \begin_layout Summary
7631 Do we really need to tell you?
7634 \begin_layout Acknowledgement*
7638 \begin_layout Conclusion*
7639 Sometimes used at the end of a long train of argument.
7643 Used in a way similar to Proposition, though perhaps lower on the scale.
7646 \begin_layout Standard
7647 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
7649 They need to be available on your system in order to use these environments.
7652 \begin_layout Section
7660 \begin_layout Standard
7666 \begin_layout Subsection
7670 \begin_layout Standard
7671 These are the layout files for some of the journals of the American Geophysical
7673 It is assumed that you have both the AGU's own class files and AGUplus
7674 installed (everything to be found at
7675 \begin_inset Flex URL
7678 \begin_layout Plain Layout
7680 ftp://ftp.agu.org/journals/latex/journals
7688 \begin_layout Subsection
7692 \begin_layout Standard
7702 They are still called this in the LyX GUI, though their LaTeX equivalents
7703 in the AGU classes are
7714 \begin_layout Standard
7715 Newly defined styles are
7752 These are mostly manuscript attributes and defined in the AGU class documentati
7756 \begin_layout Standard
7757 I suspect this is still badly incomplete.
7760 \begin_layout Subsection
7764 \begin_layout Standard
7781 \begin_layout Subsection
7785 \begin_layout Itemize
7788 Journal of Geophysical Research
7797 \begin_layout Standard
7798 Add your own, it isn't so hard! Look at the
7809 \begin_layout Subsection
7810 Bugs and things to remember
7813 \begin_layout Standard
7814 In order to use the new layouts, you must remember to do the following for
7818 \begin_layout Enumerate
7824 This can be done in the
7826 Layout\SpecialChar \menuseparator
7831 Document\SpecialChar \menuseparator
7835 (AGU articles are always in English, right? So
7842 \begin_layout Enumerate
7852 (Yes, this is a bug.)
7855 \begin_layout Enumerate
7856 Make sure you use the
7860 bibliography style, by entering
7864 into the second field of the BibTeX inset.
7865 None of the standard styles will do.
7868 \begin_layout Section
7872 \begin_layout Standard
7878 \begin_layout Subsection
7882 \begin_layout Standard
7883 Broadway is for writing plays.
7884 The format is more decorative than Hollywood, and much less standardized.
7885 This format should be suitable for workshops.
7888 \begin_layout Subsection
7892 \begin_layout Standard
7893 The same as in Hollywood.
7896 \begin_layout Subsection
7900 \begin_layout Standard
7905 names as labels then cross-reference the label to insert the name.
7906 The cross-reference dialog will show the current cast of characters.
7909 \begin_layout Subsection
7910 Paper size and Margins
7913 \begin_layout Standard
7914 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
7917 \begin_layout Subsection
7921 \begin_layout Standard
7922 The following environments are available.
7923 You can use broadway.bind to get the bind keys shown at the right.
7926 \begin_layout Itemize
7930 \begin_inset Newline newline
7935 You should not have to use this, but it is here for anything that does not
7939 \begin_layout Itemize
7943 \begin_inset space \hfill{}
7947 \begin_inset Newline newline
7952 Used to describe stage setting and the action.
7953 First use of speaker names in all CAPs.
7956 \begin_layout Itemize
7960 \begin_inset space \hfill{}
7964 \begin_inset Newline newline
7969 Automatically numbered.
7970 On screen it will be arabic, but will print as Roman.
7973 \begin_layout Itemize
7977 \begin_inset space \hfill{}
7981 \begin_inset Newline newline
7991 It is just centered text.
7994 \begin_layout Itemize
7998 \begin_inset space \hfill{}
8002 \begin_inset Newline newline
8007 Not automatically numbered.
8008 You supply the number.
8009 This is because I couldn't figure out how.
8012 \begin_layout Itemize
8016 \begin_inset space \hfill{}
8020 \begin_inset Newline newline
8025 A special case of Narrative to describe the setting and action as the curtain
8029 \begin_layout Itemize
8033 \begin_inset space \hfill{}
8037 \begin_inset Newline newline
8042 The speaker's (actor's) title, centered in all CAPS.
8045 \begin_layout Itemize
8049 \begin_inset space \hfill{}
8053 \begin_inset Newline newline
8058 Instructions to the speaker.
8059 The parentheses are automatically inserted.
8060 The ( will appear on screen, but both will be in the printed play.
8061 This environment is only used within
8068 \begin_layout Itemize
8072 \begin_inset space \hfill{}
8076 \begin_inset Newline newline
8081 What the Speaker says.
8084 \begin_layout Itemize
8088 \begin_inset space \hfill{}
8092 \begin_inset Newline newline
8097 The curtain comes down.
8100 \begin_layout Itemize
8104 \begin_inset space \hfill{}
8110 \begin_layout Itemize
8114 \begin_inset space \hfill{}
8120 \begin_layout Itemize
8124 \begin_inset space \hfill{}
8130 \begin_layout Standard
8134 \begin_layout Section
8138 \begin_layout Standard
8143 can be used to type letters according to German conventions.
8144 A template file is included in
8146 .../lyx/share/templates
8148 for you to use as a starting point.
8151 \begin_layout Section
8159 \begin_layout Standard
8165 \begin_layout Subsection
8169 \begin_layout Standard
8170 This is the layout file for the European Geophysical Society journals.
8175 can be downloaded from the web site of the EGS under
8176 \begin_inset Flex URL
8179 \begin_layout Plain Layout
8189 \begin_layout Subsection
8193 \begin_layout Standard
8196 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
8204 The current layout file is unfortunately very unmodular and would benefit
8205 from using the various
8212 \begin_layout Section
8216 \begin_layout Standard
8222 \begin_layout Standard
8223 Elsevier Science Publishers B.V.
8224 provides a standard LaTeX document class (
8228 ) for submitting articles to their various journals.
8229 The style file can be downloaded directly from their web site:
8230 \begin_inset Flex URL
8233 \begin_layout Plain Layout
8235 http://authors.elsevier.com/
8241 Instructions are supplied along with the class file, which details the
8242 requirements of the publishers.
8243 LyX includes package that allows for the use of this class, by a layout
8244 and a template file.
8245 Installation of the class file is the same as for any other LaTeX package;
8246 instructions are provided in the Elsevier documentation.
8249 \begin_layout Standard
8259 As the Elsevier class file is based mainly on the standard article class,
8260 most of the normal functionality is provided.
8261 The Elsevier class defines a number of mathematical environments, which
8262 are similar to the AMS environments.
8263 These commands are all described in the Elsevier documentation, and are
8267 \begin_layout Standard
8268 The easiest way to use the Elsevier style is to base documents on the included
8270 It is best not to use options such as fancy headings or the geometry package,
8271 as elements such as these are defined by Elsevier in their style file.
8272 Ideally, no extra packages except those mentioned in the Elsevier documentation
8274 Essentially, Elsevier require as
8275 \begin_inset Quotes eld
8279 \begin_inset Quotes erd
8282 a LaTeX file as possible, as their intention is to take the supplied file
8283 and replace the class file with one for the particular journal to which
8284 the paper has been submitted.
8285 This also means that not too much time should be spent on the formating
8287 When it comes to be published, this will change anyway.
8288 The rest of the usage for this layout is substantially the same as for
8289 the normal article class.
8290 For details of what Elsevier do and don't allow, refer to their documentation.
8293 \begin_layout Section
8302 \begin_inset CommandInset label
8311 \begin_layout Standard
8317 \begin_layout Subsection
8321 \begin_layout Standard
8322 This section describes how to use LyX to make slides for overhead projectors.
8323 There are two document classes that can do this: the default slides class
8329 This section documents the latter.
8332 \begin_layout Standard
8333 I'm going to say this again, nice and clear, so that there's no misunderstanding
8337 \begin_layout Standard
8338 \begin_inset VSpace bigskip
8344 \begin_layout Standard
8348 This section documents the class
8349 \begin_inset Quotes eld
8357 \begin_inset Quotes erd
8365 \begin_layout Standard
8366 \begin_inset VSpace bigskip
8372 \begin_layout Standard
8373 If you're looking for the documentation for
8374 \begin_inset Quotes eld
8382 \begin_inset Quotes erd
8386 \begin_inset space ~
8390 \begin_inset CommandInset ref
8392 reference "sec:slitex"
8397 If your machine doesn't have the
8402 \begin_inset Quotes eld
8410 \begin_inset Quotes erd
8413 ] installed, you'll probably have to use the default
8417 class, which isn't quite as good as
8422 \begin_layout Standard
8427 class is designed for use with version 2.1 of the
8431 LaTeX class file which is now an integral part of LaTeX2e.
8434 \begin_layout Subsection
8438 \begin_layout Standard
8439 Obviously, to use this document class, you need to select
8440 \begin_inset Quotes eld
8448 \begin_inset Quotes erd
8458 \begin_inset space ~
8464 There are some settings in the
8467 \begin_inset space ~
8472 dialog that you should know about that are specific to this class:
8475 \begin_layout Itemize
8476 Don't change the options
8487 \begin_inset space ~
8493 They're ignored by the
8500 \begin_layout Itemize
8501 The default font size is 20
8502 \begin_inset space \thinspace{}
8505 pt with the other options being 17
8506 \begin_inset space \thinspace{}
8510 \begin_inset space \thinspace{}
8514 \begin_inset space \thinspace{}
8520 \begin_layout Itemize
8529 but all math equations are still typeset in the usual roman font.
8532 \begin_layout Itemize
8537 TeX supports A4 and Letter paper sizes as well as a special size for working
8539 \begin_inset space \thinspace{}
8543 It doesn't support A5, B5, legal or executive paper sizes.
8546 \begin_layout Itemize
8547 Don't bother changing the
8551 settings because they are ignored anyway.
8552 All floats appear where they are defined in the text.
8555 \begin_layout Itemize
8560 setting behaves a bit differently for this class.
8565 TeX provides extensive footer and header capabilities including a user-defined
8568 \begin_inset space ~
8572 \begin_inset CommandInset ref
8574 reference "sec:foilfoot"
8579 The title page is treated differently to all other pages in the document
8588 has the logo centered at the bottom of the page (if one is defined).
8589 The possible page style choices and what they do are as follows:
8593 \begin_layout Labeling
8594 \labelwidthstring MMMMMMM
8601 The final output contains no page numbers, or other headers or footers
8602 (except footnotes of course).
8606 \begin_layout Labeling
8607 \labelwidthstring MMMMMMM
8614 The final output contains page numbers centered at the bottom of the page.
8615 No other headings or footers (other than footnotes).
8618 \begin_layout Labeling
8619 \labelwidthstring MMMMMMM
8624 Page numbers in lower right corner.
8625 Additional headers and footers are also shown.
8626 This is also the default.
8629 \begin_layout Labeling
8630 \labelwidthstring MMMMMMM
8635 Gives you access to the
8639 package although its use with
8643 TeX is discouraged by the writer of the
8647 TeX package because of some potential page layout clashes.
8651 \begin_layout Subsubsection
8655 \begin_layout Standard
8656 The following options may be used in the extra class options in the
8658 Document\SpecialChar \menuseparator
8664 \begin_layout Labeling
8665 \labelwidthstring MMMMMMx
8670 This sets up the page layout for 7.33
8671 \begin_inset space \thinspace{}
8675 \begin_inset space \thinspace{}
8678 in paper, which is about the same aspect ratio as a 35
8679 \begin_inset space \thinspace{}
8682 mm slide, making it a bit easier to work with this medium.
8685 \begin_layout Labeling
8686 \labelwidthstring MMMMMMx
8691 Places a rule across the page below the header on every page except the
8695 \begin_layout Labeling
8696 \labelwidthstring MMMMMMx
8701 Places a rule across the page above the footer on every page except the
8705 \begin_layout Labeling
8706 \labelwidthstring MMMMMMx
8711 This is automatically set each time you create a new
8720 TeX to use the dvips driver to rotate those pages that are set as landscape
8724 \begin_layout Labeling
8725 \labelwidthstring MMMMMMx
8730 Simply changes the page dimensions to those of a landscape page but doesn't
8732 Thus if you use this option you need to use an external program to rotate
8733 each page or feed your paper through your printer as landscape.
8734 Note that this option effectively reverses the roles of the
8742 environments (don't worry these are described in the next section).
8745 \begin_layout Labeling
8746 \labelwidthstring MMMMMMx
8751 Equation numbers on the left.
8754 \begin_layout Labeling
8755 \labelwidthstring MMMMMMx
8760 Flush-left equations.
8763 \begin_layout Subsection
8764 Supported Environments
8767 \begin_layout Standard
8768 Most of the environments commonly supported in other classes are also supported
8774 There are several additional environments provided by
8778 TeX as well as a couple added by LyX.
8779 The following environments are shared with other classes:
8782 \begin_layout Standard
8786 \begin_layout Plain Layout
8798 \begin_layout Itemize
8804 \begin_layout Itemize
8810 \begin_layout Itemize
8816 \begin_layout Itemize
8822 \begin_layout Itemize
8828 \begin_layout Itemize
8834 \begin_layout Itemize
8840 \begin_layout Itemize
8846 \begin_layout Itemize
8852 \begin_layout Itemize
8858 \begin_layout Itemize
8864 \begin_layout Itemize
8870 \begin_layout Itemize
8876 \begin_layout Itemize
8882 \begin_layout Itemize
8888 \begin_layout Itemize
8894 \begin_layout Itemize
8900 \begin_layout Itemize
8906 \begin_layout Standard
8910 \begin_layout Plain Layout
8922 \begin_layout Standard
8923 That is, all the major environments apart from the sectioning environments.
8924 Since foils are essentially self-contained sections, with a title and body,
8929 TeX provides specific commands for starting new foils and these are:
8932 \begin_layout Itemize
8938 \begin_layout Itemize
8944 \begin_layout Standard
8945 LyX also provides slightly modified versions of these two environments called:
8948 \begin_layout Itemize
8954 \begin_layout Itemize
8960 \begin_layout Standard
8961 and the differences will be explained in the next section.
8964 \begin_layout Standard
8965 Since foils are often used in presenting ideas or new theorems and such
8970 TeX also provides a comprehensive box of goodies for presenting them:
8973 \begin_layout Standard
8977 \begin_layout Plain Layout
8989 \begin_layout Itemize
8995 \begin_layout Itemize
9001 \begin_layout Itemize
9007 \begin_layout Itemize
9013 \begin_layout Itemize
9019 \begin_layout Itemize
9025 \begin_layout Itemize
9031 \begin_layout Itemize
9037 \begin_layout Itemize
9043 \begin_layout Itemize
9049 \begin_layout Itemize
9055 \begin_layout Standard
9059 \begin_layout Plain Layout
9071 \begin_layout Standard
9072 The starred versions are unnumbered while the unstarred versions are numbered.
9073 There are also two list environments added by LyX and these are:
9076 \begin_layout Itemize
9082 \begin_layout Itemize
9088 \begin_layout Standard
9093 TeX provides some powerful header and footer capabilities that are best
9094 set in the preamble although they may be set at any point in a document.
9095 If you want to change these settings in your document the best place to
9096 do so is at the very top of a foil, i.
9097 \begin_inset space \thinspace{}
9103 \begin_inset space \space{}
9108 straight after the foilhead.
9111 \begin_layout Standard
9112 For this purpose, the following command styles are provided [
9119 \begin_layout Standard
9123 \begin_layout Plain Layout
9135 \begin_layout Itemize
9139 \begin_inset space ~
9145 \begin_layout Itemize
9151 \begin_layout Itemize
9155 \begin_inset space ~
9161 \begin_layout Itemize
9165 \begin_inset space ~
9171 \begin_layout Itemize
9175 \begin_inset space ~
9182 \begin_layout Standard
9183 \begin_inset space ~
9190 \begin_layout Standard
9194 \begin_layout Plain Layout
9206 \begin_layout Standard
9207 There are also a few commands provided by
9211 TeX that aren't directly supported by LyX but I'll tell you what they do
9212 and how to use them in section
9213 \begin_inset space ~
9217 \begin_inset CommandInset ref
9219 reference "sec:unsuppfoils"
9226 \begin_layout Subsection
9227 Building a Set of Foils
9230 \begin_layout Standard
9231 This section will give a simple introduction to using the different environments
9232 to build a set of foils.
9233 If you want to see an example set of foils, take a look at the
9237 file you find in LyX's
9244 \begin_layout Subsubsection
9245 Give It a Title Page
9248 \begin_layout Standard
9249 Unlike other classes that provide
9269 creates the title on a page of its own.
9270 If you leave out the
9274 environment LaTeX will substitute the current date (every time you regenerate
9278 \begin_layout Subsubsection
9282 \begin_layout Standard
9283 As I mentioned earlier, there are four ways of starting a new foil.
9284 For portrait foils you should use
9293 The difference between these two environments is the amount of space between
9294 the title of the foil (the foilhead) and the body of the foil.
9297 \begin_layout Standard
9298 Landscape foils are generated using the
9307 Again the only difference is the spacing between foilhead and body.
9308 Both of the short versions have 0.5 inches less separation between the foilhead
9313 \begin_layout Standard
9314 One problem with the support for landscape foils is the requirement that
9319 driver to generate the PostScript output otherwise the foils won't be rotated.
9320 It is possible to get landscape foils even if you haven't got the
9324 driver provided you can feed your foils sideways through your printer ;-)
9327 \begin_layout Subsubsection
9328 Theorems, Lemmas, Proofs and more
9331 \begin_layout Standard
9332 Due to a small bug in LyX you can't have two of the same type of these environme
9333 nts directly following each other.
9334 They must be separated by something.
9335 If you try, you will just be extending the previous environment as if you
9336 had merged the two environments together.
9337 So, how do you get around this problem? The simplest option is to insert
9338 some text between the two environments or add a
9342 environment between the two with just a
9343 \begin_inset Quotes eld
9351 \begin_inset Quotes erd
9355 This will force LyX to produce two separate environments and hence the
9356 correct LaTeX output.
9357 An example is provided in the example file included with the LyX distribution.
9358 Remember, this problem only occurs if you are trying to place two of the
9359 same type of theorem-like environments one directly after the other.
9362 \begin_layout Subsubsection
9366 \begin_layout Standard
9367 You get all the commonly supported list styles found in other classes as
9368 well as two new ones.
9369 I'll only describe the new ones here.
9370 If you want to find out more about the other list environments check out
9376 If you intend to use itemized lists you might also want to read about the
9380 \begin_inset space ~
9384 \begin_inset space ~
9389 dialog described above in section
9390 \begin_inset space ~
9394 \begin_inset CommandInset ref
9396 reference "sec:bullet"
9403 \begin_layout Standard
9404 The two new list styles,
9412 , are designed to make it easier for you to create lists of do's and don'ts
9413 or right and wrong by providing dedicated environments that use a tick
9414 or a cross as the label of the list.
9415 These lists are in fact dedicated variants of the
9420 They do however require that you have the
9427 \begin_layout Subsubsection
9431 \begin_layout Standard
9436 TeX redefines the floating tables and figures so that they appear exactly
9437 where they are in the text rather than pushing them to the top of the page
9438 or to some user specified location.
9439 In fact if you change the float placement settings they are simply ignored.
9442 \begin_layout Subsubsection
9443 Page Headers and Footers
9444 \begin_inset CommandInset label
9453 \begin_layout Standard
9457 \begin_inset space ~
9466 are two commands used to control the left-footer text string.
9467 The first is meant to allow you to include a graphic logo on your foils
9469 \begin_inset Quotes eld
9477 \begin_inset Quotes erd
9481 While the second is meant to provide a classification for the audience,
9485 \begin_inset space \thinspace{}
9491 \begin_inset space \space{}
9495 It is empty by default.
9498 \begin_layout Standard
9499 The remaining page corners can be filled by
9502 \begin_inset space ~
9507 (which defaults to page numbers),
9510 \begin_inset space ~
9518 \begin_inset space ~
9526 \begin_layout Subsection
9532 \begin_inset CommandInset label
9534 name "sec:unsuppfoils"
9541 \begin_layout Standard
9542 All the commands mentioned below need to be set in a
9550 within another environment.
9553 \begin_layout Subsubsection
9557 \begin_layout Standard
9558 All lengths are adjusted using the
9581 should be replaced by the name given to the length you want to change and
9586 is the length value.
9587 All lengths should be specified in units of length such as inches (
9599 ) or relative to some document or font-based length such as
9609 \begin_layout Standard
9610 It's possible to change the spacing between a foilhead and the body of the
9611 foil by adjusting the length specified by
9618 For example, to make
9623 \begin_inset space \space{}
9626 in closer to their bodies put the following in the preamble:
9632 foilheadskip}{-0.5in}
9635 \begin_layout Standard
9636 The spacings around floats can be adjusted by setting these lengths:
9639 \begin_layout Labeling
9640 \labelwidthstring MMMMMMMMMMM
9647 Separation between the text and the top of the float
9650 \begin_layout Labeling
9651 \labelwidthstring MMMMMMMMMMM
9658 Separation between the float and the caption
9661 \begin_layout Labeling
9662 \labelwidthstring MMMMMMMMMMM
9669 Separation between the caption and the following text
9672 \begin_layout Labeling
9673 \labelwidthstring MMMMMMMMMMM
9680 You can make the captions narrower than the surrounding text by adjusting
9682 Best done relative to
9691 \begin_layout Standard
9692 There are also several title page related lengths that you may find useful
9693 if you have a long title or several authors:
9696 \begin_layout Labeling
9697 \labelwidthstring MMMMMMMMMMM
9704 Separation from headers to
9709 \begin_layout Labeling
9710 \labelwidthstring MMMMMMMMMMM
9728 \begin_layout Labeling
9729 \labelwidthstring MMMMMMMMMMM
9743 \begin_layout Labeling
9744 \labelwidthstring MMMMMMMMMMM
9760 \begin_layout Labeling
9761 \labelwidthstring MMMMMMMMMMM
9777 \begin_layout Standard
9778 The last length related command affects all the list environments.
9789 a list environment then all the vertical spacing between the list items
9791 Note that this is a command not a length so it doesn't require
9797 like the stuff mentioned above.
9800 \begin_layout Subsubsection
9804 \begin_layout Standard
9817 commands control whether the logo in the
9821 definition appear on a given page.
9828 in the preamble then none of the foils will have the logo on them.
9829 If you don't want the logo on a particular page place the
9835 directly after the foilhead of that page and the
9841 directly after the next foilhead.
9844 \begin_layout Standard
9845 If you decide to use the
9849 page style setting in the
9852 \begin_inset space ~
9857 dialog you should probably add
9867 to your preamble so headers and footers on landscape pages are correctly
9868 placed when rotated.
9869 This is due to some clashes between the page layouts provided by the
9880 \begin_layout Section
9881 Hollywood (Hollywood spec scripts)
9884 \begin_layout Standard
9890 \begin_layout Subsection
9894 \begin_layout Standard
9895 Getting the format of a Hollywood script right is a
9896 \begin_inset Quotes eld
9900 \begin_inset Quotes erd
9903 It is designed to make the readers focus on content and to be easy and
9904 familiar for the actors to read.
9905 Each page of a script should be one minute of film.
9906 Nothing goes in a script that you cannot see or hear on screen.
9907 The courier 12 pt font should be used throughout.
9911 \begin_layout Subsection
9915 \begin_layout Standard
9916 Speakers' lines should NEVER break in mid-sentence.
9917 If a speaker's lines continue over a page break, repeat the
9921 title followed by (Cont'd).
9924 \begin_layout Subsection
9928 \begin_layout Standard
9933 names as labels then cross-reference the label to insert the name.
9934 The cross-reference dialog will show the current cast of characters.
9935 You can use this to insert the speaker name in narratives also.
9938 \begin_layout Subsection
9939 Paper size and Margins
9942 \begin_layout Standard
9943 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
9946 \begin_layout Subsection
9950 \begin_layout Standard
9951 The following environments are available.
9952 You can use hollywood.bind to get the bind keys shown at the right.
9955 \begin_layout Itemize
9959 \begin_inset Newline newline
9964 Used where nothing else works.
9968 \begin_layout Itemize
9974 \begin_inset space \hfill{}
9982 \begin_inset Newline newline
9985 Usually followed by something like
9986 \begin_inset Quotes eld
9990 \begin_inset Quotes erd
9996 \begin_layout Itemize
10000 \begin_inset space \hfill{}
10004 \begin_inset Newline newline
10009 Introduces a new INTERIOR camera set-up.
10010 Always followed by DAY or NIGHT, or something similar to define the lighting
10012 Everthing on this line in CAPS.
10015 \begin_layout Itemize
10019 \begin_inset space \hfill{}
10023 \begin_inset Newline newline
10028 Introduces a new EXTERIOR camera set-up.
10029 Everthing on this line in CAPS.
10032 \begin_layout Itemize
10036 \begin_inset space \hfill{}
10040 \begin_inset Newline newline
10045 The character speaking.
10048 \begin_layout Itemize
10052 \begin_inset space \hfill{}
10056 \begin_inset Newline newline
10061 Instructions to the speaker.
10062 The () are automatically inserted, but only the ( will show in LyX.
10063 Both will be printed.
10066 \begin_layout Itemize
10070 \begin_inset space \hfill{}
10074 \begin_inset Newline newline
10086 \begin_layout Itemize
10090 \begin_inset space \hfill{}
10094 \begin_inset Newline newline
10099 Camera movement instruction.
10101 \begin_inset space \thinspace{}
10105 \begin_inset space \space{}
10111 \begin_layout Itemize
10115 \begin_inset space \hfill{}
10121 \begin_layout Itemize
10125 \begin_inset space \hfill{}
10131 \begin_layout Itemize
10135 \begin_inset space \hfill{}
10141 \begin_layout Itemize
10145 \begin_inset space \hfill{}
10151 \begin_layout Subsection
10155 \begin_layout Itemize
10156 (O.S) — off screen
10159 \begin_layout Itemize
10160 (V.0) — voice over
10163 \begin_layout Itemize
10165 \begin_inset space \thinspace{}
10172 \begin_layout Itemize
10177 \begin_layout Itemize
10178 PAN — camera movement
10181 \begin_layout Itemize
10182 INSERT — cut to close-up of
10185 \begin_layout Section
10189 \begin_layout Standard
10192 Panayotis Papasotiriou
10195 \begin_layout Subsection
10199 \begin_layout Standard
10200 The ijmpc package is a set of macros that facilitates electronic manuscript
10203 International Journal of Modern Physics C
10206 Similarly, the ijmpd package is for creating manuscripts to be submitted
10209 International Journal of Modern Physics D
10212 Both journals are published by World Scientific.
10213 The corresponding document classes are named
10222 These files, together with instructions for the authors, can be downloaded
10224 \begin_inset Flex URL
10227 \begin_layout Plain Layout
10229 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
10235 \begin_inset Flex URL
10238 \begin_layout Plain Layout
10240 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
10246 Both packages are modified versions of the standard
10247 \begin_inset Quotes eld
10251 \begin_inset Quotes erd
10254 package, and they are almost (but not exactly) identical.
10255 Most of their features are supported by LyX.
10256 I have used LyX successfully to write articles submitted to both journals
10257 without any problem.
10260 \begin_layout Subsection
10264 \begin_layout Standard
10265 As usual, the easiest way to write a paper is to start with a template.
10268 File\SpecialChar \menuseparator
10287 This will give an (almost) empty document that includes the most common
10288 fields found in a manuscript.
10289 Simply overwrite the existing text (including the brackets,
10294 You should keep in mind the following remarks.
10297 \begin_layout Enumerate
10298 LyX won't let you change the font size and the page style of the document,
10299 because such modifications are not allowed by both packages.
10302 \begin_layout Enumerate
10303 The language of the document should not be changed.
10304 Before previewing your paper, be sure that the babel package is not used.
10305 To do this, click on
10307 Tools\SpecialChar \menuseparator
10318 checkbox in the language settings, and click on
10326 , if you wish to make this change permanent).
10329 \begin_layout Enumerate
10331 \begin_inset Quotes eld
10335 \begin_inset Quotes erd
10338 style must be used to define keywords.
10341 \begin_layout Enumerate
10342 The ijmpc package provides a style named
10343 \begin_inset Quotes eld
10346 Classification Codes
10347 \begin_inset Quotes erd
10350 , which can be used to define classification codes, such as PACS numbers.
10351 Note that this facility is not supported by the ijmpd package.
10354 \begin_layout Enumerate
10355 Several new environments are available:
10356 \begin_inset Quotes eld
10360 \begin_inset Quotes erd
10364 \begin_inset Quotes eld
10368 \begin_inset Quotes erd
10372 \begin_inset Quotes eld
10376 \begin_inset Quotes erd
10380 \begin_inset Quotes eld
10384 \begin_inset Quotes erd
10388 \begin_inset Quotes eld
10392 \begin_inset Quotes erd
10396 \begin_inset Quotes eld
10400 \begin_inset Quotes erd
10404 \begin_inset Quotes eld
10408 \begin_inset Quotes erd
10412 \begin_inset Quotes eld
10416 \begin_inset Quotes erd
10420 \begin_inset Quotes eld
10424 \begin_inset Quotes erd
10428 \begin_inset Quotes eld
10432 \begin_inset Quotes erd
10436 \begin_inset Quotes eld
10440 \begin_inset Quotes erd
10444 \begin_inset Quotes eld
10448 \begin_inset Quotes erd
10452 \begin_inset Quotes eld
10456 \begin_inset Quotes erd
10460 \begin_inset Quotes eld
10464 \begin_inset Quotes erd
10468 Their use is more or less obvious.
10469 LyX supports all these environments; it will use the proper label, text
10470 style, and numbering scheme for each of them.
10473 \begin_layout Enumerate
10474 Both packages use basic citations; the natbib package should not be used.
10475 In LyX, citation references are shown as usual; in the output, citations
10476 are shown as superscripts.
10477 If you want to use a citation as normal text, you should use the
10482 \begin_inset space \thinspace{}
10486 \begin_inset space \space{}
10490 \begin_inset Quotes eld
10494 \begin_inset space \space{}
10504 \begin_inset Quotes erd
10510 \begin_layout Enumerate
10512 \begin_inset Quotes eld
10516 \begin_inset Quotes erd
10519 section in both packages.
10520 To put acknowledgments, just use the
10521 \begin_inset Quotes eld
10525 \begin_inset Quotes erd
10531 \begin_layout Enumerate
10532 Appendices may be added to the paper,
10536 the Acknowledgments and
10541 LyX provides a special environment, called
10542 \begin_inset Quotes eld
10546 \begin_inset Quotes erd
10549 which marks the beginning of the appendices.
10550 This environment should be left blank; it just sends a LaTeX command, but
10551 nothing is really printed.
10553 \begin_inset Quotes eld
10557 \begin_inset Quotes erd
10560 is printed with blue letters, as a signal that all sections after that
10561 point are appendices.
10562 To write an appendix, use the
10563 \begin_inset Quotes eld
10567 \begin_inset Quotes erd
10571 LyX will number each appendix with capital letters, as required by both
10574 \begin_inset Quotes eld
10578 \begin_inset Quotes erd
10585 be present before the first appendix; if not, all appendices will be numbered
10586 as normal sections in the output.
10589 \begin_layout Enumerate
10590 The ijmpc and the ijmpd packages use the
10594 command to implement table captions.
10595 As a result, a table created by LyX is printed correctly, but its caption
10597 However, you can use some TeX code to overpass this problem, so that captions
10598 are printed as expected.
10599 To do so, create a float table as usual, remove the caption, and replace
10600 it with the TeX code
10610 (sic); you must also the TeX code
10614 immediately after the tabular material.
10615 Study the example table included in the template files to see how this
10616 trick is implemented.
10617 Alternatively, If you need table captions, you should implement the whole
10622 file, then include this file to the LyX document (
10624 Insert\SpecialChar \menuseparator
10625 File\SpecialChar \menuseparator
10627 \begin_inset space ~
10633 Details on how to create a table float can be found in the files
10641 , included in the corresponding packages.
10644 \begin_layout Subsection
10645 Preparing a paper for submission
10648 \begin_layout Standard
10649 Before you submit your paper you must export the LyX document as a LaTeX
10652 File\SpecialChar \menuseparator
10653 Export\SpecialChar \menuseparator
10664 \begin_layout Plain Layout
10665 Actually you have the choice between LaTeX (plain) and pdflatex.
10666 If you intend to use pdflatex to prepare the paper, you should use the
10667 pdflatex option so that included graphics are converted to PDF format,
10668 ready for use by pdflatex.
10673 , then make the following changes to the resulting
10680 \begin_layout Enumerate
10681 Remove the comment lines before the
10690 \begin_layout Enumerate
10691 Remove everything between (and including) the
10703 commands, except for any commands you specifically put into the LaTeX preamble.
10706 \begin_layout Standard
10711 file should be saved and processed through LaTeX as many times as necessary.
10712 You may also want to check the resulting
10719 \begin_layout Subsection
10723 \begin_layout Standard
10724 The use of TeX code is reduced to two commands, which must be placed at
10725 the top of the document.
10726 If you started writing your paper by using the
10734 template, the TeX code needed is already in its place; you usually don't
10736 You may only modify the first TeX code to specify the information printed
10737 to the top of odd and even pages (authors' names and short paper's title,
10739 This TeX code must have the form
10743 markboth{Authors' Names}{Short Paper's Title}
10748 \begin_layout Section
10752 \begin_layout Standard
10758 \begin_layout Subsection
10762 \begin_layout Standard
10763 The iopart package provides a document class to create electronic manuscript
10764 submission to the journals published by the Institute of Physics.
10765 Instructions for the authors how to create a paper using the iopart class
10766 can be downloaded together with the iopart package from the site
10767 \begin_inset Flex URL
10770 \begin_layout Plain Layout
10772 ftp://ftp.iop.org/pub/journals/latex2e
10780 \begin_layout Subsection
10784 \begin_layout Standard
10785 The easiest way to write a paper is to start with the file
10789 that is available in LyX's examples files folder.
10790 Open this file, save it under a new name, and start writing.
10791 The example file explains how to use the special text environments.
10792 Here are the most important advices:
10795 \begin_layout Itemize
10796 To be able to compile your document to a PDF, PS, or DVI, assure that the
10799 Use AMS math package
10801 in the document settings under
10808 \begin_layout Itemize
10811 The title environment defines the kind of your paper.
10812 So use one of the following environments for the title:
10816 \begin_layout Itemize
10825 \begin_layout Itemize
10834 \begin_layout Itemize
10840 for a Topical review
10843 \begin_layout Itemize
10852 \begin_layout Itemize
10861 \begin_layout Itemize
10867 for a Paper (same as Title)
10870 \begin_layout Itemize
10876 for a Preliminary communication
10879 \begin_layout Itemize
10885 for a Rapid communication
10888 \begin_layout Itemize
10894 for a Letter to the editor
10898 \begin_layout Itemize
10901 All title environments except of
10905 can have an optional short title.
10908 \begin_layout Itemize
10909 There is a general title environment
10913 which is not directly supported by the LyX.
10914 This can be used as TeX code when your document doesn't fit into one of
10915 the other title types.
10918 \begin_layout Standard
10919 For more informations like hints for special table and formula formatting,
10920 look at the IOP author guidelines.
10923 \begin_layout Section
10927 \begin_layout Standard
10930 Panayotis Papasotiriou
10933 \begin_layout Subsection
10937 \begin_layout Standard
10938 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
10939 that facilitates electronic manuscript submission to the journals they
10941 Most known of them (at least in my domain of interest) are
10943 Astrophysics and Space Science
10949 , but there are many others (see a complete list at
10950 \begin_inset Flex URL
10953 \begin_layout Plain Layout
10955 http://www.wkap.nl/jrnllist.htm/JRNLHOME
10961 The Kluwer package may be downloaded from the site
10962 \begin_inset Flex URL
10965 \begin_layout Plain Layout
10967 http://www.wkap.nl/kaphtml.htm/STYLEFILES
10973 A complete user guide is contained in that package (but it can also be
10974 downloaded separately).
10977 \begin_layout Standard
10978 LyX supports many features of the package but not everything.
10979 However, the TeX code needed is reduced to some
10980 \begin_inset Quotes eld
10984 \begin_inset Quotes erd
10987 commands of the package (see
10988 \begin_inset space ~
10992 \begin_inset CommandInset ref
10994 reference "subsec:kluwer_peculiarities"
10999 I have recently used LyX to write an article submitted to the
11001 Astrophysics and Space Science
11003 without any problem.
11006 \begin_layout Subsection
11010 \begin_layout Standard
11011 The easiest way to write a paper is to start with the Kluwer template file.
11014 File\SpecialChar \menuseparator
11026 This will give an (almost) empty document that includes the most common
11027 fields found in a manuscript and a short description of their use.
11028 As in most templates, simply overwrite the existing text (including the
11033 ) with the correct information.
11036 \begin_layout Subsection
11037 Preparing a paper for submission
11040 \begin_layout Standard
11041 As in the AASTeX package, before you submit your paper to a journal you
11043 \begin_inset Quotes eld
11047 \begin_inset Quotes erd
11053 \begin_layout Enumerate
11054 Export your paper as a LaTeX file.
11055 To do this, click on
11057 File\SpecialChar \menuseparator
11058 Export\SpecialChar \menuseparator
11065 \begin_layout Enumerate
11070 file with a text editor and make the following changes
11074 \begin_layout Enumerate
11075 remove the comment lines before the
11084 \begin_layout Enumerate
11085 remove everything between (and including) the
11097 commands, except for any commands you specifically put into the LaTeX preamble.
11100 \begin_layout Standard
11109 \begin_layout Enumerate
11114 file through LaTeX as many times as necessary (usually up to three).
11117 \begin_layout Enumerate
11123 \begin_inset space \thinspace{}
11127 \begin_inset space \space{}
11134 , and check if everything is OK (it should, if you didn't make any mistake).
11137 \begin_layout Subsection
11138 \begin_inset Quotes eld
11142 \begin_inset Quotes erd
11145 of the Kluwer package
11146 \begin_inset CommandInset label
11148 name "subsec:kluwer_peculiarities"
11155 \begin_layout Standard
11156 The Kluwer package has the following
11157 \begin_inset Quotes eld
11161 \begin_inset Quotes erd
11167 \begin_layout Enumerate
11168 It is possible to write multiple articles in the same LaTeX file
11172 \begin_layout Plain Layout
11173 I can't imagine any good reason to do this.
11179 Each article must be included in the environment
11180 \begin_inset Quotes eld
11184 \begin_inset Quotes erd
11188 Unfortunately, this environment cannot be omitted, even if you write just
11190 Therefore, each article starts with the command
11196 and, obviously, ends with the command
11203 Although this can be implemented in LyX, I didn't included it, since it
11204 looks ugly and can confuse the novice user.
11205 Therefore, you need to enter them directly and mark them as LaTeX code
11207 \begin_inset Quotes eld
11211 \begin_inset Quotes erd
11217 \begin_layout Enumerate
11218 Information given at the beginning of the article (i.
11219 \begin_inset space \thinspace{}
11223 \begin_inset space \space{}
11226 title, subtitle, author, institution, running title, running author, abstract
11227 and keywords) must be included in an environment called
11228 \begin_inset Quotes eld
11232 \begin_inset Quotes erd
11236 This is not implemented in LyX, so you must enter title, subtitle etc.
11237 \begin_inset space ~
11240 between two TeX code lines (
11255 \begin_layout Enumerate
11256 According to the user manual, the label of each bibliography item must be
11280 \begin_layout Standard
11285 template takes care of all these
11286 \begin_inset Quotes eld
11290 \begin_inset Quotes erd
11294 If you start a new paper using this template you don't need to do anything
11299 \begin_layout Enumerate
11300 don't delete the TeX code included in the template, and
11303 \begin_layout Enumerate
11304 copy the example bibliography item included in the template and modify it
11305 as necessary to enter new bibliography items.
11308 \begin_layout Section
11312 \begin_layout Standard
11318 \begin_layout Subsection
11322 \begin_layout Standard
11323 The LyX document classes
11325 article (koma-script)
11329 report (koma-script)
11347 correspond to the LaTeX document classes
11364 \begin_inset space ~
11367 of the Koma-Script family.
11368 They are replacements for the standard document classes
11384 , resp., and fit better to European typography conventions in a number of
11388 \begin_layout Itemize
11389 Standard character size is 11pt in
11391 article (koma-script)
11395 report (koma-script)
11403 letter (koma-script)
11408 \begin_layout Itemize
11409 Headings, labels of the description environment, and a number of elements
11412 letter (koma-script)
11414 document class are set in a bold sans serif font.
11418 \begin_layout Plain Layout
11419 There is a big difference between the bold sans serif old cm fonts and new
11420 ec fonts, especially in the appearance of headings.
11421 In comparison, the ec bold sans serif fonts look a bit thin.
11422 Here the LaTeX package
11430 helps to produce the
11431 \begin_inset Quotes eld
11435 \begin_inset Quotes erd
11438 appearance when using the ec fonts.
11443 The numbering of chapter headings is made in the same way as the numbering
11444 of section headings, that is without the extra line
11445 \begin_inset Quotes eld
11448 Chapter\SpecialChar \ldots{}
11450 \begin_inset Quotes erd
11454 In addition, the appearance of the headings can be modified by using a
11455 number of options (in LyX to be entered in the field
11458 \begin_inset space ~
11465 Layout\SpecialChar \menuseparator
11469 A detailed German description of these options can be found in the Koma-Script
11477 \begin_layout Itemize
11478 The main means in the Koma-Script document classes to design the type area
11487 (in LyX to be entered in the extra class options field in the dialog
11489 Document\SpecialChar \menuseparator
11493 They make a clearer modification of page margins possible as do the options
11496 Document\SpecialChar \menuseparator
11500 A detailed German description of these and other type area options can
11501 be found in the Koma-Script documentation
11508 \begin_layout Itemize
11509 The LaTeX document classes of the Koma-Script family define a number of
11510 additional commands.
11511 Those part of it which makes sense in LyX is implemented in corresponding
11515 \begin_layout Standard
11516 A detailed German description of the LaTeX document classes of the Koma-Script
11517 family can be found in the Koma-Script documentation
11525 \begin_layout Plain Layout
11526 There is an English translation
11530 , but it is not a complete one.
11535 The following sections describe only those aspects, which are relevant
11539 \begin_layout Subsection
11540 article (koma-script), report (koma-script), and book (koma-script)
11543 \begin_layout Standard
11544 The document classes
11546 article (koma-script)
11550 report (koma-script)
11560 are implemented in the layout files
11573 They contain all the paragraph types of the corresponding standard document
11586 , resp., partly modified, with the exception of the LyX specific
11590 -type, which is replaced by the new
11594 -type having the same functionality.
11599 -Type there is a number of new paragraph types added.
11606 letter (koma-script)
11611 \begin_layout Itemize
11620 : are equivalents to
11628 , resp., additionally inserting an entry in the table of contents.
11637 are not contained in
11639 article (koma-script)
11644 \begin_layout Itemize
11653 : behave exactly as
11661 , resp., additionally clearing running heads.
11666 is not contained in
11668 article (koma-script)
11674 \begin_layout Plain Layout
11687 report (koma-script)
11689 , but since this is identical to
11693 , is has not been implemented in LyX.
11701 \begin_layout Itemize
11706 : generates a heading directly above the following paragraph in the standard
11707 character size without affecting the structure of the document.
11710 \begin_layout Itemize
11719 are special captions which respect the different space settings needed
11720 for captions placed above or below an element (if you follow strict typographic
11721 rules, you might want to place table captions always above the table).
11722 You can also use the class option
11726 , which will switch
11739 You need at least Koma-Script version 2.8q to use this.
11742 \begin_layout Itemize
11747 : can be used to set a bonmot, e.
11748 \begin_inset space \thinspace{}
11752 \begin_inset space \space{}
11755 at the beginning of a chapter.
11756 If you use the optional argument (
11758 Insert\SpecialChar \menuseparator
11760 \begin_inset space ~
11765 ), you can insert the dictum's author there.
11766 Dictum and author are separated by a line.
11767 You need at least Koma-Script version 2.8q to use this.
11772 is not contained in
11774 article (koma-script)
11779 \begin_layout Standard
11780 The following types, together with the standard types
11792 , form the title area of the document.
11793 They must be entered ahead of the first
11794 \begin_inset Quotes eld
11798 \begin_inset Quotes erd
11805 \begin_layout Plain Layout
11806 The corresponding LaTeX commands must appear before the
11817 When such a type is used more than once, the latter usage overwrites the
11818 former one, that means, for every type only the latest usage is valid.
11819 The order of the different types however has, like
11831 , no effect on the appearance of the produced document.
11834 \begin_layout Itemize
11839 : produces a centered paragraph above the ordinary title (
11851 ) for the subject of the document.
11854 \begin_layout Itemize
11859 : produces a centered paragraph below the ordinary title (
11871 ) for the publishers' name.
11874 \begin_layout Itemize
11881 report (koma-script)
11887 produces a centered paragraph on its own page behind the title page, or
11890 article (koma-script)
11892 produces a centered paragraph below the ordinary title (
11908 ) for a dedication.
11911 \begin_layout Itemize
11916 : produces a left aligned paragraph above the ordinary title (
11932 ) for a document`s head.
11935 \begin_layout Itemize
11940 : produces in a double-sided print in
11942 report (koma-script)
11948 a left-aligned paragraph at the top of the title page`s back or has no
11949 effect in a single-sided print or in
11951 article (koma-script)
11956 \begin_layout Itemize
11961 : produces in a double-sided print in
11963 report (koma-script)
11969 a left-aligned paragraph at the bottom of the title page`s back or has
11970 no effect in a single-sided print or in
11972 article (koma-script)
11977 \begin_layout Itemize
11982 : produces a special
11983 \begin_inset Quotes eld
11987 \begin_inset Quotes erd
11990 page ahead of the actual document containing a paragraph without special
11994 \begin_layout Standard
11995 The layout files for the document classes
11997 article (koma-script)
12001 report (koma-script)
12007 do include the file
12012 This is thought of as a place to define your own types.
12017 in your personal layout directory and edit the file!
12020 \begin_layout Subsection
12021 letter (koma-script)
12024 \begin_layout Standard
12028 \begin_layout Plain Layout
12040 \begin_layout Standard
12044 letter (koma-script)
12046 is implemented in the layout file
12051 It contains all the paragraph types of the corresponding standard document
12056 , partly modified, with the exception of the LyX specific types
12068 type, which is replaced by the new
12073 In addition, it contains, in contrast to the standard document class, the
12091 Furthermore, there are a number of new letter specific types.
12094 \begin_layout Standard
12098 \begin_layout Plain Layout
12110 \begin_layout Standard
12111 The appearance of the letter produced by this document class can be controlled
12112 by a number of LaTeX commands, which you can put in the LaTeX preamble.
12116 \begin_layout Plain Layout
12117 For example, the standard appearance of the letter`s heading, consisting
12118 of name and address, is quite self-willed.
12120 \begin_inset Quotes eld
12124 \begin_inset Quotes erd
12127 heading is produced by the following LaTeX commands in the preamble:
12130 \begin_layout LyX-Code
12140 \begin_layout LyX-Code
12156 \begin_layout LyX-Code
12166 \begin_layout LyX-Code
12186 A detailed German description of such LaTeX commands can be found in the
12187 Koma-Script documentation
12192 With it, the letter's author can produce his personal letter layout.
12195 \begin_layout Standard
12204 define the beginning of the letter and must be used in every letter.
12205 To emphasize them in the LyX document class, they are marked with the letter
12215 \begin_inset space ~
12218 in the left margin.
12219 It is possible to write any number of letters in one file.
12224 type produces a new letter using the same addressee and a
12228 type produces a new addressee.
12245 are ordinary paragraph types and can also be used several times in one
12246 and the same letter.
12249 \begin_layout Itemize
12254 : produces a paragraph for the addressee and implicitly defines the beginning
12258 \begin_layout Itemize
12263 : produces a paragraph for the form of address and implicitly produces a
12267 \begin_layout Itemize
12272 : produces a paragraph for a close.
12275 \begin_layout Itemize
12280 : produces a paragraph for a postscript.
12283 \begin_layout Itemize
12288 : produces a paragraph for a distribution list.
12291 \begin_layout Itemize
12296 : produces a paragraph for enclosures.
12299 \begin_layout Standard
12340 are input types provided with a label to enter information, which will
12341 be processed by the document class.
12345 \begin_layout Plain Layout
12346 It could be seen as a matter of inconsequence, that the types
12354 described above are not such input types as well.
12355 Because of the special meaning of those types, however, I have implemented
12356 them as ordinary paragraph types with a one letter mark in the left margin.
12357 Moreover, it would affect my feeling of symmetry, if the
12365 type had such a serious different appearance.
12370 The types must be used ahead of the corresponding
12377 \begin_layout Standard
12378 An implementation of these types in a WYSIWYG fashion does not seem to make
12379 sense, because the real appearance of the produced letter does not only
12380 depend on the usage of the particular type, but also on other factors.
12381 For example, a signature entered in the
12385 type will in the standard behavior appear in the produced letter only,
12386 when in the same letter also a
12391 The entered value of the
12395 type will in the standard behavior not appear in the produced letter at
12397 The possibility to design the letter`s heading freely is already indicated
12398 in a footnote above.
12401 \begin_layout Standard
12402 The input types can also be used as empty paragraphs.
12403 This makes sense e.
12404 \begin_inset space \thinspace{}
12408 \begin_inset space \space{}
12420 type is not used at all, in the standard behavior the value of the
12424 type is used as signature, whereas if an empty
12428 type is used, no signature value is defined.
12431 \begin_layout Standard
12432 By using the input types it is possible to write a letter template, containing
12433 filled input types with your personal dates (name, address, etc.) and empty
12434 input types for other dates you want to enter.
12437 \begin_layout Itemize
12442 : sender's name, in the standard behavior appears as a centered paragraph
12443 in small caps in the letter`s heading.
12446 \begin_layout Itemize
12451 : sender's signature, in the standard behavior appears below the
12460 type is used, the value of the
12464 type appears instead.
12467 \begin_layout Itemize
12472 : sender's address, in the standard behavior appears in a centered paragraph
12473 in the letter`s heading below the sender's name.
12476 \begin_layout Itemize
12481 : sender's telephone number, in the standard behavior only sets the LaTeX
12491 \begin_layout Itemize
12496 : place of the letter`s making.
12499 \begin_layout Itemize
12504 : date of the letter`s making.
12513 , in the standard behavior, produce the place and the date in a right-aligned
12514 line below the addressee's field.
12519 type is used, neither place nor date appear, independent of the value of
12529 type is used, the date of the letter `s production is used.
12532 \begin_layout Itemize
12537 : sender`s back address, in the standard behavior appears above the addressee's
12538 field in a small sans serif font.
12541 \begin_layout Itemize
12546 : special mail information, in the standard behavior appears underlined
12547 above the addressee's field below the back address.
12550 \begin_layout Itemize
12555 : additional information, in the standard behavior appears on right side
12556 below the addressee`s field.
12559 \begin_layout Itemize
12564 : the letter's title, in the standard behavior appears in a big, bold, sans
12565 serif font above the subject.
12568 \begin_layout Itemize
12573 : the letter's subject, in the standard behavior appears in a bold font
12581 \begin_layout Standard
12602 produce a business letter like line above the
12606 line containing the fields
12607 \begin_inset Quotes eld
12611 \begin_inset Quotes erd
12615 \begin_inset Quotes eld
12619 \begin_inset Quotes erd
12623 \begin_inset Quotes eld
12627 \begin_inset Quotes erd
12631 \begin_inset Quotes eld
12635 \begin_inset Quotes erd
12639 \begin_inset Quotes eld
12643 \begin_inset Quotes erd
12647 \begin_inset Quotes eld
12651 \begin_inset Quotes erd
12655 For the date field, the value of the
12661 \begin_inset Quotes eld
12664 business letter types
12665 \begin_inset Quotes erd
12668 is used, the value of the
12672 type however does not appear, but only the LaTeX variable
12679 The ordinary output of place and date in a right-aligned line below the
12680 addressee`s field is suppressed.
12681 The types are implemented as input types provided with a label and must
12682 be used ahead of the corresponding
12689 \begin_layout Itemize
12697 \begin_layout Itemize
12705 \begin_layout Itemize
12713 \begin_layout Itemize
12721 \begin_layout Itemize
12729 \begin_layout Subsection
12730 The new letter class: letter (koma-script v.2)
12733 \begin_layout Standard
12736 Jürgen Spitzmüller
12739 \begin_layout Standard
12740 \begin_inset VSpace medskip
12746 \begin_layout Standard
12748 Koma-Script version 2.8 has introduced a new letter class
12752 which supersedes the now unsupported
12757 It has — on the LaTeX side — a completely new interface and is not compatible
12758 with the old class.
12759 Therefore, LyX supports both, though it is recommended to use the new class.
12762 \begin_layout Standard
12763 This class covers the same functionality as
12765 letter (koma-script),
12768 The basic items are
12772 (receiver's address, same as
12776 in the old layout),
12789 will start a new letter (i.
12790 \begin_inset space \thinspace{}
12794 \begin_inset space \space{}
12797 you can write several letters per document).
12798 New elements are sender's
12814 and the possibility to use a
12820 Insert\SpecialChar \menuseparator
12826 \begin_layout Standard
12827 The biggest improvement is, though, that the letter's layout is configurable
12828 at almost any needs.
12829 This can be done via the preamble or with a special style file (Letter
12830 Class Option, extension
12834 ), that will be read in as a class option.
12838 \begin_layout Plain Layout
12839 The KOMA package comes with some default
12844 There is, for instance, a
12848 file that follows german typesetting rules, or a
12852 that provides the default layout of the old
12857 The latter can be loaded with the class option
12866 ayout\SpecialChar \menuseparator
12871 ocument\SpecialChar \menuseparator
12883 template that is included in LyX for examples.
12884 A detailed description is to be found in the Koma-Script documentation
12892 \begin_layout Subsection
12896 \begin_layout Standard
12897 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
12901 \begin_layout Itemize
12902 The chapter number of a
12906 type appears on a line of its own above the chapter heading instead of
12907 appearing in the same line ahead of it.
12908 The cause for that is the LyX internal behavior for the labeltype
12912 in the layout file.
12915 \begin_layout Itemize
12916 The headings of the types
12924 are only put in the
12925 \begin_inset Quotes eld
12929 \begin_inset Quotes erd
12932 LaTeX table of contents, but not in the LyX table of contents (
12934 Document\SpecialChar \menuseparator
12936 \begin_inset space ~
12940 \begin_inset space ~
12948 \begin_layout Itemize
12949 The paragraphs in a
12953 document class appear in a skip separation mode, not indented.
12954 This is the standard behavior, no special LaTeX commands are needed for
12958 Document\SpecialChar \menuseparator
12961 dialog the corresponding radio button indicates
12970 value always has the effect that extra LaTeX commands are inserted in the
12971 document to produce the gap, which is not what is wanted in this case.
12974 \begin_layout Section
12975 Latex8 (IEEE Conference Papers)
12978 \begin_layout Standard
12984 \begin_layout Subsection
12988 \begin_layout Standard
12989 Since this class is specifically for writing submissions to IEEE sponsored
12990 conferences I strongly recommend that you get a copy of their Authors Kit.
12995 package and associated bibliography style file is included in the kit.
12996 The Authors Kit is usually sent out by email once your initial submission
12998 There is a lot of useful information in the Authors Kit explaining formatting
12999 restrictions and so on and I will assume you have read this since that
13000 means I don't have to repeat it all here.
13003 \begin_layout Subsection
13007 \begin_layout Standard
13008 [AR\SpecialChar \@.
13012 \begin_layout Subsection
13013 Supported Environments
13016 \begin_layout Itemize
13022 \begin_layout Itemize
13028 \begin_layout Itemize
13034 \begin_layout Itemize
13040 \begin_layout Itemize
13046 \begin_layout Itemize
13052 \begin_layout Itemize
13058 \begin_layout Itemize
13064 \begin_layout Itemize
13070 \begin_layout Subsection
13071 Differences Between Screen and Paper
13074 \begin_layout Standard
13075 There are slight differences in appearance mainly with the presentation
13076 of section counters.
13077 On screen the trailing period of the section counter is missing but it
13078 will appear in the output so don't let this worry you.
13081 \begin_layout Section
13085 \begin_layout Standard
13088 Jürgen Spitzmüller
13091 \begin_layout Subsection
13095 \begin_layout Standard
13096 Memoir is a very powerful and constantly evolving class.
13097 It has been designed with regard to fictional and non-fictional literature.
13098 Its aim is to let the user have maximum control over the typesetting of
13100 Memoir is based on the standard book class, but it can also emulate the
13101 article class (see below).
13104 \begin_layout Standard
13105 Peter Wilson, the developer of Memoir, is known as the author of lots of
13106 useful packages in the LaTeX world.
13107 Most of them have been merged with Memoir.
13108 Therefore, it is much easier to layout the table of contents, appendices,
13109 chapter designs and such.
13110 LyX, though, does not support all of these goodies natively.
13111 Some of them might be added to forthcoming releases
13115 \begin_layout Plain Layout
13116 You are invited to send suggestions to
13117 \begin_inset Flex URL
13120 \begin_layout Plain Layout
13122 lyx-devel@lists.lyx.org
13132 , lots will probably never, due to the limitations of LyX's framework.
13133 Of course you can still use all features with the help of some native LaTeX
13138 \begin_layout Plain Layout
13143 \begin_layout Plain Layout
13153 \begin_inset space ~
13157 \begin_inset CommandInset ref
13159 reference "sec:Inserting-TeX-Code"
13169 In this section, we can only list those features which are natively supported
13171 For detailed descriptions (and for the rest of features) we are recommending
13172 to have a look at the detailed manual of the Memoir class
13176 \begin_layout Plain Layout
13181 \begin_layout Plain Layout
13191 \begin_inset Flex URL
13194 \begin_layout Plain Layout
13196 CTAN:/macros/latex/memoir/memman.pdf
13206 , which is not only a user guide for the class, but also both a comprehensive
13207 description on good typesetting and a superb example for good typesetting
13211 \begin_layout Subsection
13212 Basic features and restrictions
13215 \begin_layout Standard
13216 Memoir supports basically all features of the standard book classes.
13217 There are, however, some differences, as follows:
13220 \begin_layout Description
13222 \begin_inset space ~
13225 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
13228 \begin_layout Description
13230 \begin_inset space ~
13233 style: The fancy page style is not supported, due to a command clash between
13234 Memoir and the fancyhdr package (they are both defining a command with
13235 the same name, which confuses LaTeX).
13236 Instead, Memoir comes with a bunch of own page styles (see
13238 Layout\SpecialChar \menuseparator
13239 Document\SpecialChar \menuseparator
13241 \begin_inset space ~
13247 If you want to use these for the chapter pages, you have to use the command
13254 in the main text or in preamble (e.
13255 \begin_inset space \thinspace{}
13259 \begin_inset space \space{}
13266 chapterstyle{companion}
13271 \begin_layout Description
13272 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
13273 an optional argument in the standard classes.
13274 With this, you can specify an alternative version of the title for the
13275 table of contents and the headers (for instance, if the title is too long).
13276 In LyX, you can do this via
13278 Insert\SpecialChar \menuseparator
13280 \begin_inset space ~
13285 at the beginning of a chapter/section.
13286 Memoir features a second optional argument and thus separates the table
13287 of contents from the header.
13288 You can define three variants of a title with this: one for the main text,
13289 one for the table of contents, and one for the headers.
13290 Simply insert two optional arguments if you need this feature, the first
13291 one containing the short title for the Table of Contents, the second one
13292 containing an alternative short title for the headers.
13295 \begin_layout Description
13296 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
13297 of contents, the list of figures and the list of table start a new page
13299 Memoir does not follow this route.
13300 You have to insert a page break yourself, if you want to have one.
13303 \begin_layout Description
13304 Titlepage: For some unknown reason, Memoir uses pagination on the title
13305 page (in the standard classes, title pages are
13306 \begin_inset Quotes eld
13310 \begin_inset Quotes erd
13314 \begin_inset space \thinspace{}
13318 \begin_inset space \space{}
13322 If you want an empty title page, type
13326 aliaspagestyle{title}{empty}
13331 \begin_layout Description
13332 Article: With the class option
13338 Layout\SpecialChar \menuseparator
13339 Document\SpecialChar \menuseparator
13341 \begin_inset space ~
13346 ), you can emulate article style.
13347 That is, counters (footnotes, figures, tables etc.) will not be reset on
13348 new chapters, chapters don't start a new page (but are—in contrary to
13349 \begin_inset Quotes eld
13353 \begin_inset Quotes erd
13356 article classes—still allowed), parts, though, use their own page, as in
13360 \begin_layout Description
13361 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
13362 font commands, which have been used in the old LaTeX version 2.09 (e.
13363 \begin_inset space \thinspace{}
13367 \begin_inset space \space{}
13383 It produces an error and stops LaTeX whenever such a command appears.
13388 reallows the commands and spits out warnings instead (which does at least
13390 Since a lot of packages and particularly BibTeX style files are still using
13391 those commands, we have decided to use this option by default.
13394 \begin_layout Subsection
13398 \begin_layout Standard
13399 We will only describe the features supported by LyX (which is not much currently
13401 Please consult the Memoir manual
13405 \begin_layout Plain Layout
13410 \begin_layout Plain Layout
13420 \begin_inset Flex URL
13423 \begin_layout Plain Layout
13425 CTAN:/macros/latex/memoir/memman.pdf
13438 \begin_layout Description
13439 Abstract: You may wonder why an abstract is an extra feature.
13440 Well, it is in book class.
13441 Usually books don't have abstracts.
13442 Memoir, however, has.
13443 You can use it wherever and how often you like.
13446 \begin_layout Description
13447 Chapterprecis: You may know this from belletristic: The contents of a chapter
13448 is shortly described below the title and also in the table of contents
13450 \begin_inset space \thinspace{}
13454 \begin_inset space \space{}
13459 Our hero arrives in Troia; he loses some friends; he finds others
13462 Chapterprecis does exactly this.
13463 It is therefore only sensible below a chapter.
13466 \begin_layout Description
13467 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
13468 The epigraph environment provides an elegant way of typesetting such a
13470 The motto itself (text) and its author (source) are divided by a short
13472 Unfortunately, we have to fool LyX a bit here again, since the environment
13473 needs two arguments (text and source).
13474 In this case, we have to use curly brackets (in TeX mode) between the two
13485 <author of the slogan>.
13488 \begin_layout Description
13489 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
13490 complex figurative poems).
13491 LyX can only support a few of them.
13492 One is poemtitle, which is a centered title for poems, which will also
13493 be added to the table of contents (verse is the standard environment for
13495 Memoir has some enhanced versions of verse, but you need to use TeX code,
13496 because they have to be nested inside regular verse environments, which
13497 is not possible with LyX).
13500 \begin_layout Description
13501 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
13504 \begin_layout Section
13505 Article (mwart), book (mwbk) and report (mwrep)
13506 \begin_inset OptArg
13509 \begin_layout Plain Layout
13522 \begin_layout Standard
13528 \begin_layout Standard
13529 The LyX document classes
13545 correspond to the LaTeX document classes
13558 They are replacements for the standard document classes
13570 , resp., and fit better to Polish typography conventions in a number of points.
13574 \begin_layout Standard
13578 \begin_layout Itemize
13579 Unnumbered titles (with star, e.
13580 \begin_inset space \thinspace{}
13584 \begin_inset space \space{}
13591 ) are added into table of contents,
13594 \begin_layout Itemize
13595 Additional page styles:
13599 \begin_layout Description
13600 uheadings header with separated lines,
13603 \begin_layout Description
13604 myheadings custom header, contents headers via commands:
13619 \begin_layout Description
13620 myuheadings custom header with separated lines,
13623 \begin_layout Description
13624 outer page number is placed on outer side of page
13628 \begin_layout Itemize
13633 \begin_layout Description
13634 rmheadings serif titles — default,
13637 \begin_layout Description
13638 sfheadings sansserif titles,
13641 \begin_layout Description
13642 authortitle on title page first placed is author next title — default,
13645 \begin_layout Description
13646 titleauthor on title page first placed is title next author,
13649 \begin_layout Description
13650 withmarginpar reserve place on page for margins.
13654 \begin_layout Section
13658 \begin_layout Standard
13663 provides an alternative to the standard
13668 It provides similar functionality, but you might prefer this layout with
13669 sans serif sections, headings, and more.
13672 \begin_layout Section
13676 \begin_layout Standard
13682 \begin_layout Standard
13683 \begin_inset VSpace bigskip
13689 \begin_layout Standard
13694 \begin_inset space ~
13699 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13700 \begin_inset Formula $\beta$
13703 release of May, 1999) class.
13706 \begin_layout Standard
13711 textclass, which works with RevTeX 3.1.
13712 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13713 That means that it doesn't interact very well with LyX, which requires
13714 LaTeX2e, although it has been kludged to work.
13715 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13719 \begin_inset space ~
13724 textclass should also be pretty easy to use.
13727 \begin_layout Standard
13728 These documents are supposed to be used in
13732 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13733 macros, and assume you'll know what to put in the preamble if necessary.
13736 \begin_layout Subsection
13740 \begin_layout Standard
13741 All you need to do is install RevTeX 4, as described in the package's README
13743 The package can be found at The RevTeX 4 Web Site
13744 \begin_inset Flex URL
13747 \begin_layout Plain Layout
13749 http://publish.aps.org/revtex4/
13755 Install it somewhere that LaTeX can see it.
13756 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13758 \begin_inset space \thinspace{}
13762 \begin_inset space \space{}
13765 not the directory where you installed the class file.) Then, if you reconfigure
13766 LyX, it will find the class file and let you use the RevTeX4 textclass.
13769 \begin_layout Standard
13770 Probably the easiest way to get started is either to import a RevTeX 4 document
13778 \begin_inset space ~
13783 template, found in the templates directory.
13786 \begin_layout Subsection
13790 \begin_layout Standard
13791 Optional arguments to
13798 \begin_inset Quotes eld
13802 \begin_inset Quotes erd
13806 \begin_inset Quotes eld
13810 \begin_inset Quotes erd
13820 \begin_inset space ~
13828 \begin_inset space ~
13834 Remember that in RevTeX, at least one optional argument is required!
13837 \begin_layout Standard
13838 Other preamble matter, like
13845 \begin_inset space ~
13855 \begin_inset space ~
13860 dialog, also as usual.
13863 \begin_layout Subsection
13867 \begin_layout Standard
13868 The layouts basically correspond to the commands in RevTeX4.0.
13869 For example, the Email layout corresponds to
13876 Note that (at least as of RevTeX 4.0 Beta), the
13884 layouts are exactly equivalent, so you shouldn't need to use both.
13888 \begin_layout Plain Layout
13889 In case you're curious, both were included so that
13893 would be able to translate both
13913 \begin_layout Subsection
13917 \begin_layout Standard
13918 There are a couple of important unique aspects of RevTeX 4 which might cause
13919 bugs that will be even more confusing in LyX.
13922 \begin_layout Standard
13940 The LyX equivalent is that there is a separate Thanks layout.
13945 write footnotes in the
13949 layout, or weird things may happen.
13950 See the RevTeX 4 documentation for more details.
13953 \begin_layout Standard
13957 \begin_inset space ~
13965 \begin_inset space ~
13974 layouts must be placed
13982 layout and the corresponding
13999 , the LaTeX won't compile.
14002 \begin_layout Subsection
14006 \begin_layout Standard
14007 The main problem with this layout is that you can't use the optional arguments
14008 to layouts like Email and Title.
14009 (The problem is not unique to this layout; you can't use optional arguments
14010 to the Section layouts either.) This means that after you export that file
14011 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14012 need to edit the LaTeX file with a text editor to add the optional arguments
14014 \begin_inset space \thinspace{}
14018 \begin_inset space \space{}
14021 the running title for the page headers.
14022 Lacking these layouts makes the
14028 (and the equivalent
14034 ) useless, so the corresponding layouts don't exist, and will have to be
14039 \begin_layout Plain Layout
14044 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14045 has not been updated yet to take advantage of it.
14053 \begin_layout Section
14054 Springer Journals (
14061 \begin_layout Standard
14067 \begin_layout Subsection
14071 \begin_layout Standard
14072 These are the layout files for some of the journal formats used by Springer
14073 Verlag and listed on
14074 \begin_inset Flex URL
14077 \begin_layout Plain Layout
14079 http://www.springer.de/author/tex/help-journals.html
14084 , where you should also go to fetch the class files (yes, these are LaTeX2e
14086 It is a modular system: the things common to all journals are implemented
14091 , which journal-specific layout files (such as, e.
14092 \begin_inset space \thinspace{}
14096 \begin_inset space \space{}
14103 for Journal of Geodesy) can include.
14106 \begin_layout Standard
14107 This means that implementing support for any other Springer journal on this
14108 list is as simple as writing your own
14116 file following the outline given in
14124 \begin_layout Standard
14125 It is reasonably well tested only for the Journal of Geodesy.
14134 come with the standard LyX distribution.
14135 Install the relevant class file (downloaded from Springer) in a proper
14136 directory, reconfigure LaTeX (in the teTeX case by running
14140 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
14141 and it should work.
14144 \begin_layout Subsection
14148 \begin_layout Standard
14149 A large number of theorem-like styles —
14155 \SpecialChar \ldots{}
14161 \begin_layout Standard
14164 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
14165 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
14168 See the Springer class file documentation for details.
14171 \begin_layout Subsection
14175 \begin_layout Itemize
14187 \begin_layout Itemize
14190 Probability Theory and Related Fields
14196 — Jean-Marc Lasgouttes
14199 \begin_layout Standard
14200 Add your own, it isn't so hard!
14203 \begin_layout Subsection
14207 \begin_layout Standard
14208 These files are partly based on the older
14212 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
14213 file from Springer.
14218 layout, are now defunct.
14219 Jean-Marc Lasgouttes helped out big in making me find my way around the
14220 LyX layout file mechanism.
14223 \begin_layout Subsection
14227 \begin_layout Standard
14229 But probably less than in the old hacked-LaTeX
14236 \begin_layout Standard
14238 \begin_inset space \thinspace{}
14241 g.: does not display the number for theorem-like layouts, just #.
14244 \begin_layout Section
14250 \begin_inset CommandInset label
14259 \begin_layout Standard
14267 \begin_layout Subsection
14271 \begin_layout Standard
14272 This section describes how to use LyX to make slides for overhead projectors.
14273 There are two document classes that can do this: the default slides class
14279 This section documents the former.
14282 \begin_layout Standard
14283 I'm going to say this again, nice and clear, so that there's no misunderstanding
14287 \begin_layout Standard
14288 \begin_inset VSpace bigskip
14294 \begin_layout Standard
14298 This section documents the class
14299 \begin_inset Quotes eld
14307 \begin_inset Quotes erd
14315 \begin_layout Standard
14316 \begin_inset VSpace bigskip
14322 \begin_layout Standard
14323 If you're looking for the documentation for
14324 \begin_inset Quotes eld
14332 \begin_inset Quotes erd
14335 , check out section
14336 \begin_inset space ~
14340 \begin_inset CommandInset ref
14342 reference "sec:foiltex"
14352 \begin_inset Quotes eld
14360 \begin_inset Quotes erd
14363 ] is actually somewhat better than the default
14371 \begin_layout Plain Layout
14372 \SpecialChar \ldots{}
14373 or so I've been told repeatedly by its advocates.
14374 Having never used it, I have no idea if this claim is true or not.
14379 which this section documents.
14382 \begin_layout Standard
14383 This class is the LaTeX2e improvement of the old
14388 Every LaTeX2e distribution includes this class [which I'll just refer to
14390 \begin_inset Quotes eld
14398 \begin_inset Quotes erd
14401 from now on], so you're bound to have it.
14402 As I noted earlier, there are other classes, such as
14406 , which also produce slides for overhead projectors and do a better job
14408 However, there are some things which
14412 can do which the others can't, such as generate overlays.
14413 Read on to learn more!
14416 \begin_layout Subsection
14418 \begin_inset CommandInset label
14420 name "sec:slidesetup"
14427 \begin_layout Standard
14428 Obviously, to use this document class, you need to select
14429 \begin_inset Quotes eld
14437 \begin_inset Quotes erd
14440 from the class list in the
14442 Document\SpecialChar \menuseparator
14446 There are some other special things you should know about this class:
14449 \begin_layout Itemize
14450 Don't bother changing the options
14455 They're not supported by the
14462 \begin_layout Itemize
14466 \begin_inset space ~
14471 behaves a bit differently for this class.
14472 The possible choices and what they do are as follows:
14476 \begin_layout Description
14481 The final output contains page numbers in the lower right corner.
14484 \begin_layout Description
14493 , but also prints out any time markers you've put in.
14494 This is the default.
14497 \begin_layout Description
14502 The final output contains no page numbers, time markers, or alignment markers.
14506 \begin_layout Itemize
14511 class has an extra option:
14517 \begin_inset Quotes eld
14525 \begin_inset Quotes erd
14528 in the extra class options.
14532 \begin_layout Standard
14533 Using this options allows you to add time markers to
14539 \begin_inset space ~
14543 \begin_inset CommandInset ref
14545 reference "sec:slideNote"
14553 \begin_layout Standard
14554 You can also use the template file
14555 \begin_inset Quotes eld
14563 \begin_inset Quotes erd
14566 to automatically set up a document to use the
14572 File\SpecialChar \menuseparator
14574 \begin_inset space ~
14578 \begin_inset space ~
14583 to open your new document].
14584 The template file also contains some examples of the special paragraph
14585 environments used by this class.
14586 I'll describe those next.
14589 \begin_layout Subsection
14590 Paragraph Environments
14593 \begin_layout Subsubsection
14594 Supported Environments
14597 \begin_layout Standard
14598 The first thing you'll notice when you start up a new
14602 document is the font size and type: it's the equivalent of the size
14603 \begin_inset Quotes eld
14611 \begin_inset Quotes erd
14617 \begin_inset space ~
14623 This is also what's used in the output.
14625 \begin_inset Quotes eld
14629 \begin_inset Quotes erd
14632 to remind you that this is a slide.
14633 Your final slides will use a larger font; ergo, you'll have less space.
14634 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
14637 \begin_layout Standard
14638 The next thing that becomes obvious is the changes to the paragraph environment
14639 pull-down box [at the far-left end of the toolbar].
14640 Most of the paragraph environments you're used to seeing are missing.
14641 There are also five new ones.
14646 class itself only supports certain paragraph environments:
14649 \begin_layout Itemize
14655 \begin_layout Itemize
14661 \begin_layout Itemize
14667 \begin_layout Itemize
14673 \begin_layout Itemize
14679 \begin_layout Itemize
14685 \begin_layout Itemize
14691 \begin_layout Itemize
14697 \begin_layout Itemize
14703 \begin_layout Itemize
14709 \begin_layout Itemize
14715 \begin_layout Standard
14716 All of the other standard environments, including the section-heading environmen
14717 ts, aren't used in the
14724 \begin_layout Standard
14725 On the other hand, you'll notice the following new environments:
14728 \begin_layout Itemize
14734 \begin_layout Itemize
14740 \begin_layout Itemize
14746 \begin_layout Itemize
14752 \begin_layout Itemize
14758 \begin_layout Standard
14759 These five are kind of quirky, due to a
14760 \begin_inset Quotes eld
14764 \begin_inset Quotes erd
14768 You see, LyX doesn't permit you to nest any other paragraph environment
14769 into an empty environment.
14770 Now, that's fine and dandy, but it means that you wouldn't be able to start
14771 a slide with anything except plain text.
14772 To deal with this, I've performed a little
14773 \begin_inset Quotes eld
14777 \begin_inset Quotes erd
14783 \begin_layout Subsubsection
14784 Quirks of the New Environments
14785 \begin_inset CommandInset label
14787 name "sec:slideQuirk"
14794 \begin_layout Standard
14795 All five of the new paragraph environments are somewhat quirky due to inherent
14796 limitiations in the current version of LyX.
14797 As I just mentioned, LyX forbids environments that begin with another environme
14799 To get around this, the
14803 environment isn't a paragraph environment as described in the
14811 \begin_layout Standard
14812 You should consider
14825 \begin_inset Quotes eld
14828 pseudo-environments.
14829 \begin_inset Quotes erd
14832 They look like a section heading or a
14833 \begin_inset Quotes eld
14841 \begin_inset Quotes erd
14844 but really begin a [and, if necessary, end the previous] paragraph environment.
14854 \begin_inset Quotes eld
14858 \begin_inset Quotes erd
14861 These two perform some action.
14864 \begin_layout Standard
14865 A common feature of all five environments,
14885 , is a rather long-ish label.
14886 The text following this label — ordinarily the contents of the paragraph
14887 environment — is utterly irrelevant for
14908 LyX completely ignores it.
14909 In fact, you can leave these five environments completely empty.
14913 \begin_layout Standard
14918 to put any text after the rather long-ish label, you might want to.
14919 This could be a short description of the contents of the
14924 In that case, enter in your descriptive comment and hit
14928 as you normally would.
14931 \begin_layout Standard
14932 If, on the other hand, you don't want to enter in any descriptive text,
14933 you'll hit another LyX quirk.
14934 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
14935 environment until you put something in the old one.
14939 \begin_layout Itemize
14940 Start entering the text that will
14968 \begin_layout Itemize
14969 Now move to the beginning of that paragraph.
14973 \begin_layout Itemize
14982 \begin_layout Itemize
14983 Finally, change this new, empty paragraph to a
15007 \begin_layout Standard
15008 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
15012 \begin_layout Subsection
15013 Making a Presentation with
15026 \begin_layout Subsubsection
15034 \begin_layout Standard
15035 If you're expecting this section to teach you how to actually make a presentatio
15036 n, you'll be sorely disappointed.
15037 Naturally, I'll describe all of the ways the
15041 class can assist you in preparing the materials for a presentation.
15042 Filling in the contents, however, is up to you.
15047 the LyX philosophy.]
15050 \begin_layout Standard
15055 environment [in the manner described in section
15056 \begin_inset space ~
15060 \begin_inset CommandInset ref
15062 reference "sec:slideQuirk"
15066 ] tells LyX to begin a new slide [duh].
15067 The label for this environment/
15068 \begin_inset Quotes erd
15072 \begin_inset Quotes erd
15076 \begin_inset Quotes eld
15080 \begin_inset Quotes erd
15083 in cool blue, followed by the label,
15084 \begin_inset Quotes eld
15088 \begin_inset Quotes erd
15092 Any text or paragraph environments that follow this one go on the new slide.
15096 \begin_layout Standard
15097 Slides are probably the only time you'll need to forcibly end pages in LyX
15098 (this can be specified in the
15103 In fact, you'll want to, once you finish entering the contents of one slide.
15104 If you've entered more text than can physically fit on a slide, the extra
15105 overflows onto a new slide.
15106 I don't recommend doing this, however, since the overflow slide won't have
15107 any page number on it.
15108 Furthermore, it may interfere with any
15112 you've made to accompany the oversized
15119 \begin_layout Standard
15128 environments work the same way as the
15133 They both create an
15134 \begin_inset Quotes eld
15138 \begin_inset Quotes erd
15141 followed by a label [
15142 \begin_inset Quotes eld
15146 \begin_inset Quotes erd
15150 \begin_inset Quotes eld
15154 \begin_inset Quotes erd
15158 The color is a stunning magenta instead of blue, and the
15159 \begin_inset Quotes eld
15163 \begin_inset Quotes erd
15166 will look different, in style and in length.
15167 The label fonts of all three also differ from one another.
15170 \begin_layout Standard
15175 , if the contents of a
15183 exceed the physical size of a slide or sheet of paper, the extra will overflow
15185 Again, you should avoid this.
15186 It defeats the whole purpose of
15197 \begin_layout Subsubsection
15207 \begin_layout Standard
15212 is a slide that sits atop another slide.
15213 Perhaps you wish to discuss a figure on the main
15217 before displaying the text associated with it.
15218 One way to accomplish this is tape a flap of dark paper over the part of
15223 you want to display later.
15224 This method fails, however, if you wish to overlap one graph with another,
15226 You would then have to fumble while speaking to align the two separate,
15231 s to align the two graphs.
15236 environment in both cases makes life much easier.
15239 \begin_layout Standard
15244 receives the page number of its
15245 \begin_inset Quotes eld
15249 \begin_inset Quotes erd
15257 \begin_inset Quotes eld
15265 \begin_inset Quotes erd
15272 \begin_layout Plain Layout
15273 Presumably, mutliple
15278 \begin_inset Quotes eld
15286 \begin_inset Quotes erd
15290 \begin_inset Quotes eld
15298 \begin_inset Quotes erd
15302 \begin_inset Quotes eld
15310 \begin_inset Quotes erd
15314 \begin_inset space ~
15317 appended to the page number of the parent
15327 Clearly, you want the contents of both the
15335 to each fit on a single physical slide! You should probably consider an
15341 \begin_inset Quotes eld
15345 \begin_inset Quotes erd
15357 class provides a visual cue for this: the label at the start of an
15361 is shorter than that at the start of a
15366 Lastly, when you generate printable output, you'll find alignment markers
15367 in all four corners of both the
15371 page and its parent
15376 These will assist you in lining up the two physical slides.
15379 \begin_layout Standard
15380 The major problem in overlaying two slides is aligning the contents of the
15381 two transparencies.
15382 How much space should you leave for that graph on the second slide? Worse
15383 still, what if you want a graph and a sentence on second slide, but there
15384 is text on the main transparency that goes in between them? You could try
15385 and insert vertical space of the right size.
15386 The better way is to use
15397 \begin_layout Standard
15398 As their names imply,
15406 are two command-like paragraph environments that make all subsequent text
15407 invisible and visible, respectively.
15409 \begin_inset space ~
15413 \begin_inset CommandInset ref
15415 reference "sec:slideQuirk"
15419 that you don't place anything
15423 these two environments, however.
15428 , it inserts a centered, sky-blue label into the page reading
15429 \begin_inset Quotes eld
15432 <Invisible Text Follows>
15433 \begin_inset Quotes erd
15437 For paragraphs following this label, the parts of the
15445 ; it doesn't matter which] where they would be contain instead blank space.
15449 \begin_layout Standard
15454 , the corresponding centered label is
15455 \begin_inset Quotes eld
15458 <Visible Text Follows>
15459 \begin_inset Quotes erd
15463 Paragraphs following this label behave normally.
15464 Note that the beginning of a new
15476 automatically shuts off an
15481 It's therefore not necessary to use
15492 \begin_layout Standard
15493 By now, it should be obvious how to create overlay transparencies using
15494 the proper combination of
15513 \begin_layout Enumerate
15518 , including everything that will appear on it, whether on the main slide
15526 \begin_layout Enumerate
15527 Before each figure or paragraph that will appear only on the
15536 If necessary, insert a
15540 environment after the
15547 \begin_layout Enumerate
15552 immediately following the
15559 \begin_layout Enumerate
15560 Copy the contents of this
15571 \begin_layout Enumerate
15576 , change all of the
15587 \begin_layout Standard
15589 You've just made an
15596 \begin_layout Standard
15597 There's one problem with the way I've designed the LyX
15601 class: you can't make text in the middle of a paragraph invisible, nor
15602 make text in the middle of an invisible paragraph visible again.
15603 To accomplish this feat, you'll need to use some inlined LaTeX codes.
15607 \begin_layout Plain Layout
15608 The commands of interest are:
15611 \begin_layout Itemize
15616 invisible \SpecialChar \ldots{}
15620 \begin_layout Itemize
15625 visible \SpecialChar \ldots{}
15629 \begin_layout Plain Layout
15630 \SpecialChar \ldots{}
15631 and need to be marked as TeX.
15633 \begin_inset Quotes eld
15637 \begin_inset Quotes erd
15640 you wish to change goes in between the brackets [and after the
15653 If you don't know how to mark text as TeX, see the appropriate section
15666 \begin_layout Subsubsection
15676 \begin_inset CommandInset label
15678 name "sec:slideNote"
15685 \begin_layout Standard
15694 is associated with a
15695 \begin_inset Quotes eld
15699 \begin_inset Quotes erd
15711 class provides visual cues.
15716 is shorter than that of a
15720 [yet longer than that of an
15724 ] and, like the label of an
15728 is shockingly magenta.
15729 Additionally, the printed
15733 has the page number of its
15734 \begin_inset Quotes eld
15738 \begin_inset Quotes erd
15746 \begin_inset Quotes eld
15754 \begin_inset Quotes erd
15758 \begin_inset Quotes eld
15766 \begin_inset Quotes erd
15770 \begin_inset Quotes eld
15778 \begin_inset Quotes erd
15782 You can have multiple
15786 s associated with a single
15798 , you'll probably want to break up long
15802 s so that they fit on a single sheet of paper.
15805 \begin_layout Standard
15810 is obvious: it contains anything additional you might want to say about
15816 It could also be used as a sheet of reminders for a particular
15821 In the case of the latter, you might want to make use of time markers.
15827 \begin_inset Quotes eld
15831 \begin_inset Quotes erd
15834 support for time markers, a
15839 So, you'll have to resort to using the LaTeX codes.
15842 \begin_layout Standard
15843 To use time markers, you'll need to specify the extra class option
15844 \begin_inset Quotes eld
15852 \begin_inset Quotes erd
15856 \begin_inset space ~
15860 \begin_inset CommandInset ref
15862 reference "sec:slidesetup"
15867 This option turns on timing marks, which will appear in the lower-left-hand
15873 To set what appears in the time marker, you use the LaTeX commands
15874 \begin_inset Quotes eld
15884 \begin_inset Quotes erd
15888 \begin_inset Quotes eld
15898 \begin_inset Quotes erd
15902 The arguments of both commands are time measured in seconds.
15904 \begin_inset Quotes eld
15914 \begin_inset Quotes erd
15917 sets the time marker to a given time.
15919 \begin_inset Quotes eld
15929 \begin_inset Quotes erd
15932 increments the time marker by the specified amount.
15933 Using time markers and
15937 s in this fashion, you can remind yourself how much time to spend on a particula
15945 \begin_layout Standard
15946 There's one last feature to describe.
15947 Clearly, you'd like to print out all of your
15955 s on transparencies while printing all of your
15972 with which it is associated.
15973 What's a person to do?
15976 \begin_layout Standard
15977 Luckily, there are two LaTeX commands that allow you to select what to print
15979 Both must be placed into the preamble of your document.
15981 \begin_inset Quotes eld
15993 \begin_inset Quotes erd
15996 will cause the output to contain only the
16005 Correspondingly, the command
16006 \begin_inset Quotes eld
16018 \begin_inset Quotes erd
16021 prevents the output of anything but
16026 I'd advise placing both commands in the preamble and initially comment
16028 You can then preview your entire presentation as you write.
16029 When you're done writing, you can then uncomment one of the two to select
16030 what you want to print.
16031 I like to uncomment
16032 \begin_inset Quotes eld
16044 \begin_inset Quotes erd
16047 , print to a file with
16048 \begin_inset Quotes eld
16056 \begin_inset Quotes erd
16059 in its name, comment it back out, then uncomment
16060 \begin_inset Quotes eld
16072 \begin_inset Quotes erd
16076 \begin_inset Quotes eld
16084 \begin_inset Quotes erd
16088 I can then send either file to a printer, loading transparencies or plain
16089 paper as appropriate.
16092 \begin_layout Standard
16093 You can also provide other arguments to the
16094 \begin_inset Quotes eld
16104 \begin_inset Quotes erd
16108 \begin_inset Quotes eld
16118 \begin_inset Quotes erd
16122 See a good LaTeX book for details.
16125 \begin_layout Subsection
16130 Class Template File
16133 \begin_layout Standard
16134 I have also provided a template file,
16135 \begin_inset Quotes eld
16143 \begin_inset Quotes erd
16151 To use it, begin your new presentation with
16156 ile\SpecialChar \menuseparator
16158 \begin_inset space ~
16162 \begin_inset space ~
16172 Your new LyX presentation file will contain an example
16193 additionally contain an example of the use of
16202 Lastly, the preamble will contain:
16205 \begin_layout LyX-Code
16206 % Uncomment to print out only slides and overlays
16209 \begin_layout LyX-Code
16213 \begin_layout LyX-Code
16219 \begin_inset Newline newline
16225 \begin_layout LyX-Code
16226 % Uncomment to print out only notes
16229 \begin_layout LyX-Code
16233 \begin_layout LyX-Code
16241 \begin_layout Standard
16242 One final thing: I created this class to support the LaTeX2e
16243 \begin_inset Quotes eld
16251 \begin_inset Quotes erd
16254 class, one of the built-in LaTeX2e classes.
16255 Neither I nor the rest of the LyX Team endorse or oppose the use of this
16256 built-in slide class.
16257 It's here if you want it or need it.
16258 There exist other LaTeX2e classes for creating presentations, such as the
16264 \begin_inset space ~
16268 \begin_inset CommandInset ref
16270 reference "sec:foiltex"
16275 \begin_inset Quotes eld
16283 \begin_inset Quotes erd
16286 package [present on some TeX distributions].
16287 The latter is not yet supported under LyX.
16291 \begin_layout Plain Layout
16292 Perhaps you can take on the task\SpecialChar \ldots{}
16298 I know nothing about these other classes.
16299 Try them out to see what sort of alternative they provide.
16302 \begin_layout Chapter
16303 LyX Features needing Extra Software
16306 \begin_layout Section
16310 \begin_layout Standard
16316 \begin_layout Subsection
16320 \begin_layout Standard
16329 \begin_layout Plain Layout
16334 is not yet available when you are using the LaTeX distribution MiKTeX.
16339 , you'll find in the
16346 \begin_inset space ~
16357 \begin_inset CommandInset href
16359 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
16366 \begin_layout Standard
16371 package is a program that was written by
16372 \begin_inset Flex CharStyle:Noun
16375 \begin_layout Plain Layout
16377 \begin_inset space ~
16385 in frustration because some constructs in LaTeX are sometimes non-intuitive,
16386 and easy to forget.
16387 The program runs over your LaTeX file, checks the integrity of the file,
16388 and flags some common errors.
16389 In other technical words, it is
16396 \begin_layout Standard
16397 Well, what is a syntax checker doing in LyX which is supposed to produce
16398 correct LaTeX anyways? The answer is simple: Just as
16402 not only checks the
16406 of C programs, but also does
16410 checks for type-errors,
16414 catches some common
16418 errors, in addition to the syntactical ones.
16423 is capable of detecting several common errors, such as
16426 \begin_layout Itemize
16427 Ellipsis detection:
16428 \begin_inset Newline newline
16431 Use \SpecialChar \ldots{}
16435 \begin_layout Itemize
16436 No space in front of/after parenthesis:
16437 \begin_inset Newline newline
16443 \begin_layout Itemize
16444 Enforcement of normal space after common abbreviations:
16445 \begin_inset Newline newline
16449 \begin_inset space \thinspace{}
16453 \begin_inset space \space{}
16456 is too wide spacing.
16459 \begin_layout Itemize
16460 Enforcement of end-of-sentence space when the last sentence ends with a
16462 \begin_inset Newline newline
16466 And this is wrong spacing.
16469 \begin_layout Itemize
16470 Space in front of labels and similar commands:
16471 \begin_inset Newline newline
16474 The label should stick right up to the text to avoid falling to a wrong
16477 \begin_inset CommandInset label
16487 \begin_layout Plain Layout
16488 This footnote is in danger of falling off to a wrong page
16493 The label is separated too much.
16496 \begin_layout Itemize
16497 Space in front of references, instead of hard spaces:
16498 \begin_inset Newline newline
16501 In you are in bad luck, the text will break right between the referenced
16502 text and reference number, and that's a pity.
16504 \begin_inset CommandInset ref
16506 reference "sec:chktex"
16513 \begin_layout Itemize
16515 \begin_inset Quotes eld
16519 \begin_inset Quotes erd
16523 \begin_inset Formula $\times$
16527 \begin_inset Newline newline
16530 2x2 looks cheap compared to
16531 \begin_inset Formula $2\times2$
16537 \begin_layout Standard
16538 and more \SpecialChar \ldots{}
16539 It is an invaluable tool when you are
16540 \begin_inset Quotes eld
16544 \begin_inset Quotes erd
16547 your document before printing, and you should run it right after the obligatory
16548 spelling check, and before you go fine tuning the typesetting.
16551 \begin_layout Subsection
16555 \begin_layout Standard
16556 If you have the program installed, usage is as simple as choosing
16558 Tools\SpecialChar \menuseparator
16560 \begin_inset space ~
16566 This will make LyX generate a LaTeX file of your document, start
16570 to check it, and then make LyX insert
16571 \begin_inset Quotes eld
16575 \begin_inset Quotes erd
16578 with the warnings from
16582 , if there were any.
16583 The warnings will be placed close to the point of the mistake, and you
16584 can quickly find them by using the
16586 Navigate\SpecialChar \menuseparator
16589 menu item, or the shortcut key
16598 Open the error boxes by clicking on them with the mouse, or use the shortcut
16607 bindings, or the corresponding
16616 Read the warning and correct the mistake, if it is a mistake.
16617 If you have trouble understanding what the warning is about, you can safely
16619 Remember that there is a hidden layer between the document on screen and
16620 the technical details in invoking
16624 , and this gap can make some warnings seem arcane or just right down plain
16628 \begin_layout Standard
16629 This document is an excellent testing bed for the feature, and it should
16630 provide quite a few warnings for you to fiddle with.
16631 Since computers are only so smart, expect most of the warnings to be false
16635 \begin_layout Subsection
16636 How to fine tune it
16639 \begin_layout Standard
16640 Sometimes, you'll find that
16644 makes more noise than suits your mood.
16645 Then you can choose not to use it, wait until your mood changes, or try
16650 to get better along with you.
16651 Another choice in the most desperate situations is to use
16653 View\SpecialChar \menuseparator
16655 \begin_inset space ~
16659 \begin_inset space ~
16663 \begin_inset space ~
16668 , which will get rid of all warnings instantly.
16671 \begin_layout Standard
16680 very configurable and extensible, you shouldn't expect to solve all problems
16686 Since LyX has to generate a somewhat special LaTeX file to be able to match
16687 the line numbers from the
16695 \begin_layout Plain Layout
16696 You can inspect the specific output from
16702 Edit\SpecialChar \menuseparator
16704 \begin_inset space ~
16708 \begin_inset space ~
16722 to the internal document structure, some of the warnings will not seen
16723 to appear correctly.
16724 There are two things you can do about this:
16727 \begin_layout Itemize
16732 invocation command line in
16748 installation configuration file (usually with the file
16753 See below to learn what warnings can be enabled and disabled on the command
16758 \begin_layout Itemize
16759 Export your document as a raw LaTeX file using
16761 File\SpecialChar \menuseparator
16762 Export\SpecialChar \menuseparator
16770 Invoked in this way, it can be a hassle to find the corresponding place
16771 in the document inside LyX, but with a little patience, you should be able
16775 \begin_layout Standard
16776 Here follows the warning messages that can be enabled and disabled in
16785 to disable a warning, and
16789 to enable a warning.
16790 The emphasized entries are disabled by default, because the default is
16793 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
16798 \begin_layout Standard
16799 Notice that you should only use the options that enable and disable warnings,
16800 because LyX relies on some of the other command line parameters to be set
16801 in a specific way to have a chance to communicate with
16808 \begin_layout Enumerate
16812 Command terminated with space.
16815 \begin_layout Enumerate
16818 Non-breaking space (
16819 \begin_inset Quotes eld
16827 \begin_inset Quotes erd
16830 ) should have been used.
16833 \begin_layout Enumerate
16837 You should enclose the previous parenthesis with
16838 \begin_inset Quotes eld
16846 \begin_inset Quotes erd
16852 \begin_layout Enumerate
16855 Italic correction (
16856 \begin_inset Quotes eld
16866 \begin_inset Quotes erd
16869 ) found in non-italic buffer.
16872 \begin_layout Enumerate
16875 Italic correction (
16876 \begin_inset Quotes eld
16886 \begin_inset Quotes erd
16889 ) found more than once.
16892 \begin_layout Enumerate
16896 No italic correction (
16897 \begin_inset Quotes eld
16907 \begin_inset Quotes erd
16913 \begin_layout Enumerate
16917 \begin_inset Quotes eld
16925 \begin_inset Quotes erd
16929 \begin_inset Quotes eld
16937 \begin_inset Quotes erd
16943 \begin_layout Enumerate
16946 Wrong length of dash may have been used.
16949 \begin_layout Enumerate
16953 \begin_inset Quotes eld
16961 \begin_inset Quotes erd
16965 \begin_inset Quotes eld
16973 \begin_inset Quotes erd
16979 \begin_layout Enumerate
16983 \begin_inset Quotes eld
16991 \begin_inset Quotes erd
16997 \begin_layout Enumerate
17001 \begin_inset Quotes eld
17009 \begin_inset Quotes erd
17012 to achieve an ellipsis.
17015 \begin_layout Enumerate
17018 Inter-word spacing (
17019 \begin_inset Quotes eld
17029 \begin_inset Quotes eld
17032 ) should perhaps be used.
17035 \begin_layout Enumerate
17038 Inter-sentence spacing (
17039 \begin_inset Quotes eld
17049 \begin_inset Quotes erd
17052 ) should perhaps be used.
17055 \begin_layout Enumerate
17058 Could not find argument for command.
17061 \begin_layout Enumerate
17065 \begin_inset Quotes eld
17073 \begin_inset Quotes erd
17079 \begin_layout Enumerate
17082 Math mode still on at end of LaTeX file.
17085 \begin_layout Enumerate
17089 \begin_inset Quotes eld
17097 \begin_inset Quotes erd
17100 doesn't match the number of
17101 \begin_inset Quotes eld
17109 \begin_inset Quotes erd
17115 \begin_layout Enumerate
17118 You should use either
17121 \begin_inset Quotes eld
17129 \begin_inset Quotes erd
17134 as an alternative to
17135 \begin_inset Quotes eld
17143 \begin_inset Quotes erd
17149 \begin_layout Enumerate
17156 " (ASCII 39) instead of "
17163 \begin_layout Enumerate
17166 User-specified pattern found.
17169 \begin_layout Enumerate
17172 This command might not be intended.
17175 \begin_layout Enumerate
17182 \begin_layout Enumerate
17200 \begin_layout Enumerate
17203 Delete this space to maintain correct page references.
17206 \begin_layout Enumerate
17210 You might wish to put this between a pair of
17211 \begin_inset Quotes eld
17219 \begin_inset Quotes erd
17225 \begin_layout Enumerate
17228 You ought to remove spaces in front of punctuation.
17231 \begin_layout Enumerate
17234 Could not execute LaTeX command.
17237 \begin_layout Enumerate
17246 in front of small punctuation.
17249 \begin_layout Enumerate
17257 may look prettier here.
17260 \begin_layout Enumerate
17264 Multiple spaces detected in output.
17267 \begin_layout Enumerate
17270 This text may be ignored.
17273 \begin_layout Enumerate
17279 \begin_inset Quotes eld
17284 to begin quotation, not
17291 \begin_layout Enumerate
17298 to end quotation, not
17301 \begin_inset Quotes eld
17309 \begin_layout Enumerate
17315 \begin_layout Enumerate
17318 You should perhaps use
17319 \begin_inset Quotes eld
17327 \begin_inset Quotes erd
17333 \begin_layout Enumerate
17336 You should put a space in front of/after parenthesis.
17339 \begin_layout Enumerate
17342 You should avoid spaces in front of/after parenthesis.
17345 \begin_layout Enumerate
17349 You should not use punctuation in front of/after quotes.
17352 \begin_layout Enumerate
17355 Double space found.
17358 \begin_layout Enumerate
17361 You should put punctuation outside inner/inside display math mode.
17364 \begin_layout Enumerate
17367 You ought to not use primitive TeX in LaTeX code.
17370 \begin_layout Enumerate
17373 You should remove spaces in front of
17374 \begin_inset Quotes eld
17382 \begin_inset Quotes erd
17388 \begin_layout Enumerate
17391 \begin_inset Quotes eld
17399 \begin_inset Quotes erd
17402 is normally not followed by
17403 \begin_inset Quotes eld
17411 \begin_inset Quotes erd
17417 \begin_layout Standard
17418 In later versions of LyX, we hope to provide a more complete interface to
17419 this tool (and it's smaller cousin
17423 ) to exploit the full power of it.
17424 But it's not exactly useless as it is now: go try it on one of your existing
17425 documents of a certain length and be surprised.
17428 \begin_layout Section
17429 Version Control in LyX
17432 \begin_layout Standard
17435 Lars Gullik Bjønnes,
17442 \begin_layout Subsection
17446 \begin_layout Standard
17447 A friend of mine wanted to try LyX for a group project.
17448 When he didn't find support for version control or file locking, he dropped
17450 This angered me a bit, so I thought that I should at least make support
17451 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
17452 This has now been done.
17453 LyX now supports some of the most basic RCS commands.
17454 If you need to something a bit more sophisticated you will have to do that
17455 manually in an xterm.
17458 \begin_layout Standard
17459 Before you begin to use the version control features in LyX, you should
17461 \begin_inset Quotes eld
17465 \begin_inset Quotes erd
17468 (a man file, read it with
17473 This file describes all the basic features of RCS.
17474 You should especially notice the comment about a RCS directory, and the
17475 notion of a master RCS file (the file ending in
17482 \begin_layout Standard
17483 Later basic CVS/SVN support was added.
17484 You should be familiar with CVS/SVN usage before start using it under LyX.
17485 Most of the log messages are not currently displayed after operations -
17486 you can check them in terminal window if unsure.
17489 \begin_layout Standard
17490 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
17491 package—no guarantees are made for older versions.
17494 \begin_layout Standard
17495 For introducing your own external commands consult vc-command in the manual
17499 \begin_layout Subsection
17500 RCS commands in LyX
17503 \begin_layout Standard
17504 The following sections describe the RCS commands supported by LyX.
17505 You can find them in the
17507 File\SpecialChar \menuseparator
17509 \begin_inset space ~
17515 LyX was tested against RCS 5.7.
17518 \begin_layout Subsubsection
17524 \begin_layout Standard
17525 If your document is not under revision control, this is the only item shown
17527 And if it is under revision control, the
17531 item is not visible.
17535 \begin_layout Standard
17536 This command registers your document with RCS (unless you are under the
17537 directory managed by CVS)\SpecialChar \@.
17538 You are asked interactively to supply an initial
17539 description of the document.
17540 The document is now set in Read-Only mode and you have to
17543 \begin_inset space ~
17547 \begin_inset space ~
17551 \begin_inset space ~
17556 , before making any changes to it.
17557 A document under revision control has a
17558 \begin_inset Quotes eld
17561 [RCS:<version> <locker>]
17562 \begin_inset Quotes erd
17565 item tagged to the filename in the minibuffer.
17568 \begin_layout Standard
17569 RCS command that is run:
17571 ci -q -u -i -t-"<initial description>" <file-name>
17574 \begin_layout Standard
17579 to understand the switches.
17583 \begin_layout Subsubsection
17589 \begin_layout Standard
17590 When you are finished editing a file, you check in your changes.
17591 When you do this, you are asked for a description of the changes.
17592 This is stored in the history log.
17593 The version number is bumped, your changes are applied to the master RCS
17594 file, the document is unlocked and set to Read-Only mode.
17598 \begin_layout Standard
17601 ci -q -u -m"<description>" <file-name>
17604 \begin_layout Subsubsection
17610 \begin_layout Standard
17611 By doing this you lock the document so that only you can edit it.
17612 This will also make the document Read-Write only for you.
17613 You will usually continue editing for a while and when you are finished
17614 you check in your changes.
17615 The status line is changed to reflect that you have locked the file.
17619 \begin_layout Standard
17622 co -q -l <file-name>
17625 \begin_layout Subsubsection
17628 Revert To Repository Version
17631 \begin_layout Standard
17632 This will discard all changes made to the document since the last check
17634 You get a warning before changes are discarded.
17637 \begin_layout Standard
17640 co -f -u<version> <file-name>
17643 \begin_layout Subsubsection
17649 \begin_layout Standard
17650 This makes as if the last check in never happened.
17651 No changes are made to the document loaded into LyX, but the last version
17652 is removed from the master RCS file.
17656 \begin_layout Standard
17659 rcs -o<version> <file-name>
17662 \begin_layout Subsubsection
17668 \begin_layout Standard
17669 This show the complete history of the RCS document.
17674 is shown in a browser.
17682 \begin_layout Subsection
17683 CVS commands in LyX
17686 \begin_layout Standard
17687 CVS is now partially supported by LyX.
17688 You can find the commands in the
17690 File\SpecialChar \menuseparator
17692 \begin_inset space ~
17700 \begin_layout Subsubsection
17706 \begin_layout Standard
17707 If your document is not under revision control, this is the only item shown
17709 And if it is under revision control, the
17716 item is not visible.
17720 \begin_layout Standard
17721 This command registers in CVS your document ONLY in case you have already
17722 the documents directory under CVS control (in particular
17727 This means you have to checkout the archive by yourself.
17731 \begin_layout Standard
17732 Then you are asked interactively to supply an initial description of the
17734 Don't forget that registered file is not yet commited.
17737 \begin_layout Standard
17738 CVS command that is run:
17741 \begin_inset Quotes erd
17745 \begin_inset Quotes eld
17749 \begin_inset Quotes erd
17755 \begin_layout Standard
17760 to understand the switches.
17764 \begin_layout Subsubsection
17770 \begin_layout Standard
17771 When you are finished editing a file, you commit your changes.
17772 When you do this, you are asked for a description of the changes.
17773 After that changes are commited.
17776 \begin_layout Standard
17779 cvs -q commit -m"<description>" "<file-name>"
17782 \begin_layout Subsubsection
17785 Revert To Repository Version
17788 \begin_layout Standard
17789 This will discard all changes made to the document since the last check
17791 You get a warning before changes are discarded.
17792 Firstly the file is deleted, secondly CVS update command is run.
17795 \begin_layout Standard
17799 \begin_inset Quotes eld
17803 \begin_inset Quotes erd
17809 \begin_layout Subsubsection
17815 \begin_layout Standard
17816 This show the complete history of the CVS document.
17820 \begin_inset Quotes eld
17824 \begin_inset Quotes erd
17829 is shown in a browser.
17832 \begin_layout Subsection
17833 SVN commands in LyX
17836 \begin_layout Standard
17837 SVN is now partially supported by LyX.
17838 You can find the commands in the
17840 File\SpecialChar \menuseparator
17842 \begin_inset space ~
17848 Please note that if you use password protected access to repository via
17849 ssh, you will be asked in terminal window.
17850 LyX was tested against SVN 1.4 and 1.5.
17853 \begin_layout Subsubsection
17859 \begin_layout Standard
17860 If your document is not under revision control, this is the only item shown
17862 And if it is under revision control, the
17869 item is not visible.
17873 \begin_layout Standard
17874 This command registers in SVN your document ONLY in case you have already
17875 the documents directory under SVN control (in particular
17880 This means you have to checkout the archive by yourself.
17884 \begin_layout Standard
17885 Then you are asked interactively to supply an initial description of the
17887 Don't forget that registered file is not yet commited.
17890 \begin_layout Standard
17891 SVN command that is run:
17894 \begin_inset Quotes eld
17898 \begin_inset Quotes erd
17904 \begin_layout Standard
17909 to understand the switches.
17913 \begin_layout Subsubsection
17919 \begin_layout Standard
17920 When you are finished editing a file, you commit your changes.
17921 When you do this, you are asked for a description of the changes.
17922 After that changes are commited.
17925 \begin_layout Standard
17930 \begin_layout Plain Layout
17931 In case locking is not enabled.
17933 \begin_inset CommandInset ref
17935 reference "subsec:SVN-File-Locking"
17946 svn commit -q -m"<description>" <file-name>
17949 \begin_layout Subsubsection
17955 \begin_layout Standard
17956 Updates the changes of this file from the repository.
17957 Be sure you understand SVN merging and conflicts resolving before using
17958 this function, because all conflicts has to be done manually by you!
17961 \begin_layout Standard
17966 \begin_layout Plain Layout
17975 \begin_inset Quotes eld
17979 \begin_inset Quotes erd
17985 \begin_layout Subsubsection
17988 Revert To Repository Version
17991 \begin_layout Standard
17992 This will discard all changes made to the document since the last check
17994 You get a warning before changes are discarded.
17998 \begin_layout Standard
18002 \begin_inset Quotes eld
18006 \begin_inset Quotes erd
18012 \begin_layout Subsubsection
18018 \begin_layout Standard
18019 This show the complete history of the SVN document.
18023 \begin_inset Quotes eld
18027 \begin_inset Quotes erd
18032 is shown in a browser.
18035 \begin_layout Subsubsection
18037 \begin_inset CommandInset label
18039 name "subsec:SVN-File-Locking"
18046 \begin_layout Standard
18047 The file exchange through various revision control systems brings the problem
18048 of merge conflicts in case two different users try to edit the same (parts
18050 When such conflict happens it needs manual resolving and one reasonable
18051 alternative is to provide some kind of locking mechanism, which guarantees
18052 that only one user is allowed to edit file at the given time.
18055 \begin_layout Standard
18056 SVN has two mechanisms to provide such kind of mutual exclusivity for file
18057 access - locks and automatical setting of write permissions based on
18058 \begin_inset Flex CharStyle:Code
18061 \begin_layout Plain Layout
18071 \begin_layout Plain Layout
18072 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
18078 In a case this property is detected for a given document LyX starts to
18079 use SVN locks for document editing automatically and the whole check-in/out
18080 mechanism switches to the same regimen as for RCS.
18081 This in particular means there are two different modes how file is used
18085 \begin_layout Itemize
18087 The loaded file is in the read-only mode.
18088 For editation on needs to check-out.
18093 consists of update from repository and gaining write lock.
18094 If the lock is not possible to obtain, we remain in unlocked state.
18097 \begin_layout Itemize
18099 The loaded file is in the 'normal' edit mode.
18100 No other user is allowed to edit the file.
18105 consists of commiting changes and releasing write-lock.
18106 If no changes have been made to the document, no commit will be produced
18110 \begin_layout Plain Layout
18111 Don't be puzzled by the fact that you will be asked for commit message anyway.
18116 and only the write-lock will be released.
18119 \begin_layout Standard
18123 \begin_layout Labeling
18124 \labelwidthstring 00.00.0000
18127 svn commit -q -m"<description>" "<file-name>"
18128 \begin_inset Newline newline
18131 svn unlock "<file-name>"
18134 \begin_layout Labeling
18135 \labelwidthstring 00.00.0000
18138 svn update "<file-name>"
18139 \begin_inset Newline newline
18142 svn lock "<file-name>"
18145 \begin_layout Subsection
18146 SVN and Windows Environment
18149 \begin_layout Quote
18150 My inclination is to say that if the user cannot figure out the command
18151 line operations on their own fairly quickly, they would be well advised
18152 to use TortoiseSVN.
18158 \begin_layout Subsubsection
18162 \begin_layout Standard
18163 In addition to installing LyX, and having access to a Subversion repository,
18164 the user will need to install the Subversion client program.
18165 A Windows installer for the client program is available from
18166 \begin_inset CommandInset href
18169 target "http://www.collab.net/nonav/downloads/subversion/"
18174 The user may also want to install
18175 \begin_inset CommandInset href
18178 target "http://tortoisesvn.tigris.org/"
18182 , which integrates Subversion operations into the context (rightclick) menu
18183 of Windows Explorer.
18184 Operations done outside LyX will typically be more convenient using the
18185 Explorer context menu.
18186 Note that TortoiseSVN is not a replacement for the client program, which
18187 is what LyX itself will use.
18190 \begin_layout Subsubsection
18191 Bringing a document under Subversion control
18194 \begin_layout Standard
18195 Before a LyX document can be brought under version control in Subversion,
18196 its parent directory needs to be under version control.
18197 If the document is being added to a project already in the repository,
18198 this is accomplished by checking the project out to the directory where
18199 the new document will be placed.
18200 If the project itself is not yet under version control (for instance, if
18201 this document starts a new project), the directory must be imported into
18203 This is done outside LyX.
18204 Both import and checkout are easily accomplished from the Explorer context
18205 menu using TortoiseSVN, or alternatively can be done using the command
18206 line client at a DOS prompt.
18207 The procedure for importing the project using TortoiseSVN is described
18208 below, assuming an existing repository and a new project being started
18216 For information on using the Subversion client program, run
18223 \begin_layout Enumerate
18230 in Windows Explorer, right click it, and select
18232 TortoiseSVN > Repo-browser
18235 If necessary, adjust the URL for the repository, then click OK.
18238 \begin_layout Enumerate
18239 Right click the level of the repository under which you want to place the
18240 new project folder (typically the top level) and click
18242 Create folder\SpecialChar \ldots{}
18245 Supply a name for the project folder and click OK.
18246 Add a message for the log file if desired, then click OK again.
18247 The new project folder should appear in the repository.
18248 Finally, click OK again to exit the repository browser.
18251 \begin_layout Enumerate
18252 Once again right click
18258 , this time selecting SVN Checkout\SpecialChar \ldots{}
18259 Select the URL of the project folder
18260 you just created in the repository, and set the checkout directory to
18268 You will be warned about a non-empty folder; click OK to proceed.
18269 You should now have a
18280 \begin_layout Enumerate
18281 Create or open your document in LyX and click
18286 ile\SpecialChar \menuseparator
18292 \begin_inset space ~
18295 Control\SpecialChar \menuseparator
18303 Add a log message and click OK to commit the document to version control.
18306 \begin_layout Standard
18307 From this point onward, you should have full functionality in the
18312 ile\SpecialChar \menuseparator
18318 \begin_inset space ~
18324 You also have the option of checking the document in and out, viewing its
18326 using the TortoiseSVN context menu in Windows Explorer or the Subversion
18327 client program from a command prompt.
18330 \begin_layout Subsection
18334 \begin_layout Standard
18335 With the recent addition of the vc-command function LyX power users are
18336 allowed to create their own commands for revision control.
18339 \begin_layout Standard
18340 As an example you can see how two TortoiseSVN commands could be integrated
18344 \begin_layout Description
18346 \begin_inset Flex CharStyle:Code
18349 \begin_layout Plain Layout
18350 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
18358 \begin_layout Description
18360 \begin_inset Flex CharStyle:Code
18363 \begin_layout Plain Layout
18364 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
18372 \begin_layout Section
18373 Literate Programming
18376 \begin_layout Standard
18381 (kayvan@sylvan.com)
18385 original documentation written by
18387 Edmar Wienskoski Jr.
18390 (edmar-w-jr@technologist.com)
18393 \begin_layout Subsection
18397 \begin_layout Standard
18398 The main purpose of this documentation is to show you how to use LyX for
18399 literate programming.
18400 Where it is assumed that you are familiar with this programming technique,
18402 \begin_inset Quotes eld
18406 \begin_inset Quotes erd
18410 \begin_inset Quotes eld
18414 \begin_inset Quotes erd
18418 If that is not the case, please follow the web links provided in the following
18420 There is a lot of good documentation out there covering old development
18421 history to the latest tools tips.
18424 \begin_layout Standard
18425 It is also assumed that you are familiar with LyX itself to a point that
18426 you are comfortable changing your LyX preferences, and X resources file.
18427 If that is not the case please refer to other LyX documentation to cover
18428 your specific needs.
18431 \begin_layout Subsection
18432 Literate Programming
18435 \begin_layout Standard
18436 From the Literate Programming FAQ:
18439 \begin_layout Quotation
18440 Literate programming is the combination of documentation and source together
18441 in a fashion suited for reading by human beings.
18442 In fact, literate programs should be enjoyable reading, even inviting!
18443 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
18444 and documentation in a single file.
18445 Literate programming tools then parse the file to produce either readable
18446 documentation or compilable source.
18447 The WEB style of literate programming was created by D.
18448 \begin_inset space \thinspace{}
18452 Knuth during the development of his TeX typesetting software.
18456 \begin_layout Standard
18457 Another excerpt says:
18460 \begin_layout Quotation
18463 How is literate programming different from verbose commenting?
18466 \begin_layout Quotation
18467 There are three distinguishing characteristics.
18468 In order of importance, they are:
18472 \begin_layout Itemize
18473 flexible order of elaboration
18476 \begin_layout Itemize
18477 automatic support for browsing
18480 \begin_layout Itemize
18481 typeset documentation, especially diagrams and mathematics
18485 \begin_layout Standard
18486 Now that I sparked your curiosity, take a look in the references.
18489 \begin_layout Subsubsection
18493 \begin_layout Standard
18494 The complete Literate Programming FAQ can be found at:
18497 \begin_layout Quote
18498 Literate Programming FAQ
18499 \begin_inset Flex URL
18502 \begin_layout Plain Layout
18504 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
18512 \begin_layout Standard
18513 The FAQ lists 23 (twenty three!) different literate programming tools.
18514 Where some are specialized or
18515 \begin_inset Quotes eld
18519 \begin_inset Quotes erd
18522 for particular programming languages, while other have general scope.
18527 for my own use for several reasons:
18530 \begin_layout Itemize
18531 It can generate the documentation either in LaTeX or HTML.
18534 \begin_layout Itemize
18535 It has a open architecture, i.
18536 \begin_inset space \thinspace{}
18540 \begin_inset space \space{}
18543 it is easy to plug in new filters and to perform special processing that
18548 \begin_layout Itemize
18549 There is a good selection of filters available already (the HTML is one
18553 \begin_layout Itemize
18557 \begin_layout Standard
18558 The Noweb web page can be found at:
18561 \begin_layout Quote
18563 \begin_inset Flex URL
18566 \begin_layout Plain Layout
18568 http://www.cs.virginia.edu/~nr/noweb/
18576 \begin_layout Standard
18577 Starting from there you can reach many other interesting links and even
18578 some literate program examples.
18581 \begin_layout Subsection
18582 LyX and Literate Programming
18585 \begin_layout Standard
18586 The LyX support for Literate Programming is provided by using the generic
18587 LyX converters mechanism.
18588 This support is provided in a
18589 \begin_inset Quotes eld
18593 \begin_inset Quotes erd
18597 \begin_inset space \thinspace{}
18601 \begin_inset space \space{}
18604 you will be able to use this new LyX feature with some other literate programmin
18605 g tool of your choice by just changing your LyX preferences.
18608 \begin_layout Subsubsection
18609 Generating documents and code (weaving and tangling)
18612 \begin_layout Paragraph
18613 Selecting the document class
18616 \begin_layout Standard
18617 If you have installed Noweb and LyX successfully, whenever you open a new
18618 document or try to change the document class of an existing one, you will
18619 find that there are three new document classes available:
18622 \begin_layout Itemize
18626 \begin_layout Itemize
18630 \begin_layout Itemize
18634 \begin_layout Standard
18635 You must select one of them to create your literate documents from.
18639 \begin_layout Standard
18640 Note that literate documents are not limited to these three classes.
18641 New classes can be generated from other styles like letter or in combination
18642 with other class variations like Article (AMS).
18643 If you have special needs that cannot be covered by one of the existing
18644 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
18645 will arrange to insert a new entry, or teach you how to do it.
18649 \begin_layout Plain Layout
18650 It is very simple, it involves the creation of a file with four lines, and
18651 re-running of the auto configuration.
18656 Moreover, if you use a literate tool other than Noweb you may need to create
18657 a new set of document classes for it.
18660 \begin_layout Paragraph
18664 \begin_layout Standard
18665 LyX enables you to write code with a layout named
18673 \begin_layout Plain Layout
18674 The equivalent Noweb term is
18675 \begin_inset Quotes eld
18679 \begin_inset Quotes erd
18683 For historical reasons, I got used to the term
18684 \begin_inset Quotes eld
18688 \begin_inset Quotes erd
18691 introduced by other literate tool named Nuweb, which I used for many years
18692 before rendering myself to Noweb.
18697 Noweb delimits scraps like this:
18700 \begin_layout LyX-Code
18704 \begin_layout LyX-Code
18708 \begin_layout LyX-Code
18712 \begin_layout LyX-Code
18716 \begin_layout LyX-Code
18720 \begin_layout Standard
18721 The problem is that whatever is written in between the << and the
18725 must be taken literally, i.
18726 \begin_inset space \thinspace{}
18730 \begin_inset space \space{}
18733 LyX should be prevented from making any special interpretation of what has
18735 This is handled by a special layout named Scrap, that works like a normal
18736 paragraph but has a free spacing capability.
18739 \begin_layout Standard
18740 The down side of the Scrap paragraph layout is that consecutive paragraphs
18741 of code will be spaced with one empty line in the source code and also
18742 in the printed documentation.
18743 The work around is to enter each line of code within a single Scrap, with
18744 a newline (ctrl-return).
18745 The example above will look like this:
18749 \begin_layout Plain Layout
18750 If you have a printed version of this document you will not see any difference
18751 between the previous example and this one.
18759 \begin_layout LyX-Code
18761 \begin_inset Newline newline
18765 \begin_inset Newline newline
18769 \begin_inset Newline newline
18773 \begin_inset Newline newline
18779 \begin_layout Standard
18780 This layout works fine.
18781 The only real inconvenience is that you have to type ctrl-return instead
18786 \begin_layout Plain Layout
18787 It is in my list of
18788 \begin_inset Quotes eld
18792 \begin_inset Quotes erd
18803 \begin_layout Standard
18804 As a special note, you can also use the
18805 \begin_inset Quotes eld
18809 \begin_inset Quotes erd
18812 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
18816 \begin_layout LyX-Code
18818 \begin_inset Newline newline
18821 def some_function(args):
18822 \begin_inset Newline newline
18825 "This is the doc string for this function."
18826 \begin_inset Newline newline
18829 print "My args: ", args
18832 \begin_layout LyX-Code
18833 @ %def some_function
18836 \begin_layout Standard
18837 For an example of this usage and the resulting cross-reference output, look
18838 at the Literate python program in
18840 LIBDIR/examples/listerrors.lyx
18842 which should make this all clear.
18845 \begin_layout Paragraph
18846 Generating the documentation
18849 \begin_layout Standard
18850 At this point you already have a new document file with a proper document
18851 class, and with some code and text on it.
18852 How do I print it? The answer is simple, you select
18854 View\SpecialChar \menuseparator
18858 Just like you would do for a plain document.
18859 No special procedure is required.
18862 \begin_layout Standard
18863 To help orientate you, I will now explain what happens inside LyX:
18866 \begin_layout Enumerate
18869 Update\SpecialChar \menuseparator
18872 menu option is chosen, a LaTeX file is generated.
18877 \begin_layout Standard
18878 If the document is of any literate class the generated file will be named
18879 with an extension name defined by the
18880 \begin_inset Quotes eld
18884 \begin_inset Quotes erd
18887 format (defined in the Preferences panel), otherwise the file will have
18896 \begin_layout Enumerate
18897 Note that the only difference so far is in the name of the file, no special
18898 processing is required by LyX.
18899 Given that you formatted the code using the Scrap layout that, by itself,
18900 takes care of the business.
18903 \begin_layout Enumerate
18904 If the document is of any literate class LyX will then use the internal
18905 LyX to Noweb converter, followed by the Noweb to LaTeX converter
18909 \begin_layout Plain Layout
18910 The converters are defined in the
18912 Tools\SpecialChar \menuseparator
18916 \begin_inset Quotes eld
18920 \begin_inset Quotes erd
18932 manual for general information about converters.
18937 to generate the LaTeX file.
18941 \begin_layout Standard
18942 Otherwise it will just skip this step.
18946 \begin_layout Enumerate
18947 Finally, LaTeX is invoked and the regular post processing continues as in
18951 \begin_layout Standard
18952 Independence from a particular
18953 \begin_inset Quotes eld
18957 \begin_inset Quotes erd
18960 is easily achieved by changing the commands that are run by the various
18964 \begin_layout Paragraph
18965 Generating the code
18968 \begin_layout Standard
18969 When the build menu option is chosen or the corresponding button in the
18970 toolbar is pressed, a LaTeX file is generated just like step 1 above.
18971 Next, LyX invokes the
18976 This converter needs to be defined by the user and is not installed by
18977 default, though the Program format is.
18978 This converter (like any other converter) will have two parts:
18981 \begin_layout Enumerate
18982 The converter program itself.
18983 This program performs the conversion from the one format to the other (in
18984 this case, from the Noweb format to the Program pseudo-format).
18987 \begin_layout Enumerate
18988 The error log parser.
18989 This is a program whose sole purpose is to rewrite error messages in a
18990 format that LyX understands.
18991 This makes it possible for LyX to place error boxes in the right places
18992 in the file buffer.
18995 \begin_layout Standard
18996 The first part, the
18997 \begin_inset Quotes eld
19001 \begin_inset Quotes erd
19004 setting, should be set to
19005 \begin_inset Quotes eld
19013 \begin_inset Quotes erd
19017 This basically means that LyX will call
19018 \begin_inset Quotes eld
19022 \begin_inset Quotes erd
19025 (a program or script) with the name of the Noweb file (normally a file
19026 in the LyX temp directory).
19030 \begin_layout Standard
19031 This is an implementation of
19032 \begin_inset Quotes eld
19036 \begin_inset Quotes erd
19039 that you can place in a directory on your path:
19042 \begin_layout LyX-Code
19046 \begin_layout LyX-Code
19050 \begin_layout LyX-Code
19051 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
19054 \begin_layout Standard
19055 The next part of the converter setting is the
19056 \begin_inset Quotes eld
19060 \begin_inset Quotes erd
19063 which is to be set to
19064 \begin_inset Quotes eld
19069 parselog=listerrors
19072 \begin_inset Quotes erd
19076 This will run any errors that are generated by the
19077 \begin_inset Quotes eld
19081 \begin_inset Quotes erd
19084 process through the
19085 \begin_inset Quotes eld
19089 \begin_inset Quotes erd
19095 \begin_layout Standard
19096 The converter code looks in
19104 then on the path for the
19105 \begin_inset Quotes eld
19109 \begin_inset Quotes erd
19115 \begin_layout Standard
19116 The build will normally take place in LyX's temporary directory, so the
19117 files produced by the conversion will be in that directory.
19118 LyX will copy out what it regards as the `main' file, but the
19122 conversion may produce several files, and so most of these would then be
19123 deleted when LyX was closed.
19124 The present solution is to use a `copier',
19128 \begin_layout Plain Layout
19137 manual for information on these.
19146 script in its default mode, so that the entire contents of the temporary
19147 directory is copied.
19148 More will get copied than is needed, to be sure, but nothing will be lost.
19149 If, however, you know what extensions the generated files will have, this
19150 can be improved by using the
19159 This option takes a comma-separated list of extensions to copy.
19160 So, for example, if the conversion will generate only files with the extensions
19169 , then the correct definition would be:
19172 \begin_layout LyX-Code
19173 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
19176 \begin_layout Standard
19177 The result will be that only files with these two extensions will be copied
19181 \begin_layout Paragraph
19182 Build instructions in the document
19185 \begin_layout Standard
19186 The last piece of the integration between LyX and noweb is the
19187 \begin_inset Quotes eld
19191 \begin_inset Quotes erd
19195 Generally, the instructions for building your program should be embedded
19196 in a scrap of its own.
19198 \begin_inset Quotes eld
19202 \begin_inset Quotes erd
19205 above uses the notangle command to look for this scrap (called
19206 \begin_inset Quotes eld
19210 \begin_inset Quotes erd
19213 ) and runs its contents through
19214 \begin_inset Quotes eld
19218 \begin_inset Quotes erd
19224 \begin_layout Standard
19225 Typically, such a scrap would look something like this:
19228 \begin_layout LyX-Code
19230 \begin_inset Newline newline
19234 \begin_inset Newline newline
19238 \begin_inset Newline newline
19241 if [ -z "${NOWEB_SOURCE}" ]
19242 \begin_inset Newline newline
19246 \begin_inset Newline newline
19249 NOWEB_SOURCE=myfile.nw
19250 \begin_inset Newline newline
19254 \begin_inset Newline newline
19258 code to extract files ...]
19259 \begin_inset Newline newline
19263 code to compile files ...]
19264 \begin_inset Newline newline
19270 \begin_layout Standard
19273 LIBDIR/examples/listerrors.lyx
19277 LIBDIR/examples/Literate.lyx
19279 which implement two versions of the
19280 \begin_inset Quotes eld
19284 \begin_inset Quotes erd
19287 program for some illustrations of how all of these pieces go together or
19290 LIBDIR/examples/noweb2lyx.lyx.
19293 Interestingly, these three files show off the language-indepence of the
19294 LyX literate programming support since they are written in Python, C and
19298 \begin_layout Subsubsection
19302 \begin_layout Standard
19303 All the Literate Programming support is configured by the
19305 Tools\SpecialChar \menuseparator
19309 \begin_inset Quotes eld
19313 \begin_inset Quotes erd
19317 The important parts are:
19320 \begin_layout Description
19322 \begin_inset space ~
19326 \begin_inset Quotes eld
19330 \begin_inset Quotes erd
19334 \begin_inset space ~
19337 format Set up via the Formats tab, this is where the Noweb-specific pieces
19347 , the file extension is set to
19352 This tells LyX to create a file with a
19356 extension in the first step of the conversion process.
19359 \begin_layout Description
19361 \begin_inset space ~
19369 \begin_inset space ~
19372 format This is an empty format whose sole purpose is to be the endpoint
19373 of a conversion (which then allows us to set up a converter for it).
19376 \begin_layout Description
19385 This converter performs the
19386 \begin_inset Quotes eld
19390 \begin_inset Quotes erd
19393 of the literate document.
19394 For Noweb, it is set to
19395 \begin_inset Quotes eld
19400 noweave -delay -index $$i > $$o
19403 \begin_inset Quotes erd
19409 \begin_layout Description
19419 \begin_inset Quotes eld
19423 \begin_inset Quotes erd
19427 As stated above, the Converter is set to
19428 \begin_inset Quotes eld
19436 \begin_inset Quotes erd
19439 , with Flags set to
19440 \begin_inset Quotes eld
19445 originaldir,parselog=listerrors
19448 \begin_inset Quotes erd
19454 \begin_layout Subsubsection
19458 \begin_layout Standard
19459 There is also a new function implemented in the LyX server, the
19460 \begin_inset Quotes eld
19463 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
19467 \begin_layout Standard
19468 When debugging code with ddd/gdb, it is possible to invoke a text editor
19469 at the current execution position with a single key stroke.
19470 The default ddd configuration for that is shift-ctrl-V.
19471 It happens that you can define the editor command line invocation in ddd
19474 Edit\SpecialChar \menuseparator
19475 Preferences\SpecialChar \menuseparator
19478 dialog and changing the "Edit Sources" entry.
19481 \begin_layout Standard
19482 I take advantage of the new created LyX server function and this ddd feature,
19484 \begin_inset Quotes eld
19488 \begin_inset Quotes erd
19494 \begin_layout LyX-Code
19495 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
19498 \begin_layout Standard
19499 With this, whenever you are using ddd and find a point in the program that
19500 you want to edit, you just press shift-ctrl-V (in the ddd window), and
19501 ddd you forward this information to LyX through the LyX server and then
19502 the LyX window will show the same file with the cursor at the same position
19503 ddd was pointing to.
19504 No more guessing or long scrolling to locate a point in the program back
19508 \begin_layout Standard
19509 Note however that you must enable the LyX server to get this feature working
19510 (it is disabled by default).
19511 You can enable it in
19523 ) by entering in the
19528 \begin_inset Quotes eld
19533 /home/<your-home-directory>/.lyx/lyxpipe
19536 \begin_inset Quotes erd
19542 \begin_layout Standard
19543 Read the LyX server documentation in the
19545 Customization Manual
19547 for further information.
19550 \begin_layout Subsubsection
19554 \begin_layout Standard
19555 There are six new buttons that can be added to your LyX toolbar.
19556 Five of these buttons are short cuts to layout styles:
19577 The last one is a short cut to the
19578 \begin_inset Quotes eld
19582 \begin_inset Quotes erd
19589 \begin_layout Standard
19590 LyX has a range of buttons that are available for tool bar customization.
19591 In my toolbar I like to combine the six short cuts above with two more:
19596 \SpecialChar \menuseparator
19601 \SpecialChar \menuseparator
19608 View\SpecialChar \menuseparator
19612 Here is how it looks like:
19615 \begin_layout LyX-Code
19619 \begin_layout LyX-Code
19623 \begin_layout LyX-Code
19624 Icon "layout Standard"
19627 \begin_layout LyX-Code
19628 Icon "layout Section"
19631 \begin_layout LyX-Code
19632 Icon "layout LaTeX"
19635 \begin_layout LyX-Code
19636 Icon "layout LyX-Code"
19639 \begin_layout LyX-Code
19640 Icon "layout Scrap"
19643 \begin_layout LyX-Code
19647 \begin_layout LyX-Code
19651 \begin_layout LyX-Code
19652 Icon "buffer-typeset"
19655 \begin_layout LyX-Code
19656 Icon "build-program"
19659 \begin_layout LyX-Code
19663 \begin_layout LyX-Code
19667 \begin_layout LyX-Code
19671 \begin_layout LyX-Code
19675 \begin_layout LyX-Code
19679 \begin_layout Subsubsection
19680 Colors customization
19683 \begin_layout Standard
19684 There are a number of colors in LyX that can be customized in
19689 One of the things that bothers people is the LaTeX font color.
19690 The default color is red, since the scraps uses LaTeX font, and there is
19691 a lot of scraps in literate documents, you may get tired of seeing everything
19693 You can change it by going to the tabs
19702 \begin_layout Standard
19703 The next thing is the visible presence of the newline character in the screen.
19704 You can choose the color of this particular character and make it blend
19706 I recommend you choosing a color that is close to the background but not
19707 equal, that way you still can see it is there, but it is not bothering
19712 \begin_layout Chapter
19713 Secrets of the LaTeX Masters
19714 \begin_inset CommandInset label
19723 \begin_layout Standard
19724 Though LyX is a powerful tool, it cannot hope to support everything that
19725 can be done with pure TeX/LaTeX.
19726 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
19727 as long as you are not afraid to use that
19728 \begin_inset Quotes eld
19732 \begin_inset Quotes erd
19735 button on the toolbar or add things to the LaTeX preamble.
19736 This section lists some tips, tricks, and otherwise cool ideas to give
19737 your document that extra little flair.
19740 Do try this at home
19742 , just start with something a little smaller and less important than your
19746 \begin_layout Standard
19747 Most ideas in this section require less common files in your LaTeX installation.
19748 If you have a system like teTeX, most will already be available.
19749 A few, however, will need to be downloaded from one of the CTAN archives.
19750 Often, there are several ways to do something, or several LaTeX style files
19751 which do the same thing.
19752 We do not endorse one choice over another, we simply claim that we have
19753 done a particular task with a particular file.
19754 Put on your wizard hat, keep an eye out for dragons, and let us begin.
19757 \begin_layout Section
19761 \begin_layout Standard
19764 Lars Gullik Bjønnes
19767 \begin_layout Subsection
19771 \begin_layout Standard
19772 The aim for this chapter
19776 \begin_layout Plain Layout
19777 Editor's note: Lars' original chapter was a masterful description of how
19783 However, it was too long to flow smoothly in this document.
19784 I have therefore chosen to excerpt the most important sections here (sorry,
19785 Lars); you can read the original chapter (and more of the story!) in the
19788 examples/multicol.lyx
19796 is to show how the LaTeX package
19800 can be used in a LyX document.
19801 As LyX doesn't support the
19805 package natively yet, we have to use some small hacks.
19806 By reading this section it should be obvious how to do this.
19809 \begin_layout Subsection
19813 \begin_layout Standard
19818 package allows switching between one and multicolumn format on the same
19820 Footnotes are handled correctly (for the most part), but will be placed
19821 at the bottom of the page and not under each column.
19822 LaTeX's float mechanism, however, is partly disabled in the current implementat
19824 At the moment only page-wide floats can be used within the scope of the
19828 \begin_layout Subsection
19832 \begin_layout Subsubsection
19836 \begin_layout Standard
19837 If you want to have two columns in your text, you have use LaTeX mode to
19842 begin{multicols}{2}
19844 at the point where you want the two column layout to start, and then
19850 where you want it to end.
19854 \begin_layout Standard
19858 \begin_layout Plain Layout
19862 begin{multicols}{2}
19870 \begin_layout Standard
19875 The Adventure of the Empty House
19878 \begin_inset Newline newline
19883 Sir Arthur Conan Doyle
19886 \begin_layout Standard
19889 It was in the spring of the year 1894 that all London was interested, and
19890 the fashionable world dismayed, by the murder of the Honourable Ronald
19891 Adair under most unusual and inexplicable circumstances.
19892 The public has already learned those particulars of the crime which came
19893 out in the police investigation, but a good deal was suppressed upon that
19894 occasion, since the case for the prosecution was so overwhelmingly strong
19895 that it was not necessary to bring forward all the facts.
19896 Only now, at the end of nearly ten years, am I allowed to supply those
19897 missing links which make up the whole of that remarkable chain.
19898 The crime was of interest in itself, but that interest was as nothing to
19899 me compared to the inconceivable sequel, which afforded me the greatest
19900 shock and surprise of any event in my adventurous life.
19901 Even now, after this long interval, I find myself thrilling as I think
19902 of it, and feeling once more that sudden flood of joy, amazement, and increduli
19903 ty which utterly submerged my mind.
19904 Let me say to that public, which has shown some interest in those glimpses
19905 which I have occasionally given them of the thoughts and actions of a very
19906 remarkable man, that they are not to blame me if I have not shared my knowledge
19907 with them, for I should have considered it my first duty to do so, had
19908 I not been barred by a positive prohibition from his own lips, which was
19909 only withdrawn upon the third of last month.
19912 \begin_layout Standard
19916 \begin_layout Plain Layout
19928 \begin_layout Subsubsection
19932 \begin_layout Standard
19933 The same pattern is used when you want more than two columns:
19936 \begin_layout Standard
19940 \begin_layout Plain Layout
19944 begin{multicols}{3}
19952 \begin_layout Standard
19955 It can be imagined that my close intimacy with Sherlock Holmes had interested
19956 me deeply in crime, and that after his disappearance I never failed to
19957 read with care the various problems which came before the public.
19958 And I even attempted, more than once, for my own private satisfaction,
19959 to employ his methods in their solution, though with indifferent success.
19960 There was none, however, which appealed to me like this tragedy of Ronald
19962 As I read the evidence at the inquest, which led up to a verdict of willful
19963 murder against some person or persons unknown, I realized more clearly
19964 than I had ever done the loss which the community had sustained by the
19965 death of Sherlock Holmes.
19966 There were points about this strange business which would, I was sure,
19967 have specially appealed to him, and the efforts of the police would have
19968 been supplemented, or more probably anticipated, by the trained observation
19969 and the alert mind of the first criminal agent in Europe.
19970 All day, as I drove upon my round, I turned over the case in my mind and
19971 found no explanation which appeared to me to be adequate.
19972 At the risk of telling a twice-told tale, I will recapitulate the facts
19973 as they were known to the public at the conclusion of the inquest.
19976 \begin_layout Standard
19980 \begin_layout Plain Layout
19992 \begin_layout Standard
19993 You can have more than 3 columns if you want to, but that might not be very
19994 pleasant for the eye.
19997 \begin_layout Subsubsection
19998 Columns inside columns
20001 \begin_layout Standard
20002 You can even have columns inside columns:
20005 \begin_layout Standard
20009 \begin_layout Plain Layout
20013 begin{multicols}{2}
20021 \begin_layout Standard
20024 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
20025 at that time governor of one of the Australian colonies.
20026 Adair's mother had returned from Australia to undergo the operation for
20027 cataract, and she, her son Ronald, and her daughter Hilda were living together
20031 \begin_layout Standard
20035 \begin_layout Plain Layout
20039 begin{multicols}{2}
20047 \begin_layout Standard
20050 The youth moved in the best society–had, so far as was known, no enemies
20051 and no particular vices.
20052 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
20053 had been broken off by mutual consent some months before, and there was
20054 no sign that it had left any very profound feeling behind it.
20055 For the rest {sic} the man's life moved in a narrow and conventional circle,
20056 for his habits were quiet and his nature unemotional.
20057 Yet it was upon this easy-going young aristocrat that death came, in most
20058 strange and unexpected form, between the hours of ten and eleven-twenty
20059 on the night of March 30, 1894.
20062 \begin_layout Standard
20066 \begin_layout Plain Layout
20078 \begin_layout Standard
20081 Ronald Adair was fond of cards–playing continually, but never for such stakes
20083 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
20084 It was shown that, after dinner on the day of his death, he had played
20085 a rubber of whist at the latter club.
20086 He had also played there in the afternoon.
20091 The evidence of those who had played with him– Mr.
20092 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
20093 and that there was a fairly equal fall of the cards.
20094 Adair might have lost five pounds, but not more.
20095 His fortune was a considerable one, and such a loss could not in any way
20097 He had played nearly every day at one club or other, but he was a cautious
20098 player, and usually rose a winner.
20099 It came out in evidence that, in partnership with Colonel Moran, he had
20100 actually won as much as four hundred and twenty pounds in a sitting, some
20101 weeks before, from Godfrey Milner and Lord Balmoral.
20102 So much for his recent history as it came out at the inquest.
20105 \begin_layout Standard
20109 \begin_layout Plain Layout
20121 \begin_layout Standard
20122 Please do read the file
20124 examples/multicol.lyx
20126 for more advanced examples including column and header spacing, vertical
20127 separator lines, and more.
20130 \begin_layout Section
20135 Paragraph Environment
20136 \begin_inset OptArg
20139 \begin_layout Plain Layout
20140 Numbering in Enumerate
20148 \begin_layout Standard
20154 \begin_layout Standard
20155 \begin_inset VSpace bigskip
20161 \begin_layout Standard
20163 The default numbering for the
20167 paragraph environment begins with Arabic numbers and ends with uppercase
20169 Suppose, however, you wanted a different type of numbering scheme.
20170 Here's a quickie example of how to change the numbering scheme:
20173 \begin_layout LyX-Code
20183 \begin_layout LyX-Code
20193 \begin_layout LyX-Code
20203 \begin_layout LyX-Code
20213 \begin_layout Standard
20214 \SpecialChar \ldots{}
20215 which changes the numbering scheme to uppercase Roman numerals, uppercase
20216 letters, Arabic numbers, and lowercase letter.
20219 \begin_layout Standard
20220 Additionally, the previous example also adds a little bit extra to the numbering
20222 For example, the first level label actually looks like:
20223 \begin_inset Quotes eld
20227 \begin_inset Quotes erd
20231 For ease of reading, we'll describe what the numbering schemes look like
20232 using a notation something like this: <
20233 \begin_inset Quotes eld
20237 \begin_inset Quotes erd
20241 \begin_inset space ~
20245 \begin_inset Quotes erd
20249 \begin_inset Quotes erd
20253 \begin_inset space ~
20257 \begin_inset Quotes erd
20261 \begin_inset Quotes erd
20265 \begin_inset space ~
20269 \begin_inset Quotes eld
20273 \begin_inset Quotes erd
20280 \begin_layout Standard
20281 As you can see in the example, there is a label command for each nesting
20288 \SpecialChar \ldots{}
20295 , as well as a counter,
20299 \SpecialChar \ldots{}
20305 There are also five
20306 \begin_inset Quotes eld
20310 \begin_inset Quotes erd
20343 , each of which take one counter as an argument.
20344 You can add characters before or after these, but there's no need to add
20348 \begin_layout Standard
20349 You can get really fancy with these.
20353 \begin_layout LyX-Code
20367 \begin_layout LyX-Code
20379 \begin_layout LyX-Code
20389 \begin_layout LyX-Code
20399 \begin_layout Standard
20400 produces the somewhat out of hand numbering scheme: <
20401 \begin_inset Quotes eld
20405 \begin_inset Quotes erd
20409 \begin_inset space ~
20413 \begin_inset Quotes erd
20417 \begin_inset Quotes erd
20421 \begin_inset space ~
20425 \begin_inset Quotes erd
20429 \begin_inset Quotes erd
20433 \begin_inset space ~
20437 \begin_inset Quotes eld
20441 \begin_inset Quotes erd
20448 \begin_layout Standard
20452 \begin_layout Section
20456 \begin_layout Standard
20462 \begin_layout Standard
20463 \begin_inset VSpace bigskip
20469 \begin_layout Standard
20474 \begin_layout Plain Layout
20480 tmpfont}{cmr17 scaled 2500}{
20492 \begin_layout Standard
20497 \begin_layout Plain Layout
20508 hose of you who like the style of old books probably also like
20509 \begin_inset Quotes eld
20513 \begin_inset Quotes erd
20516 —those large capital letters which begin each new chapter or section.
20517 Implementing them with plain LyX/LaTeX is straightforward (assuming you
20518 know some plain TeX!) but does require a lot of work and many iterations,
20519 as you can see by all the ugly TeX-mode stuff at the beginning of this
20523 \begin_layout Standard
20527 \begin_layout Plain Layout
20533 bigdrop{-1em}{3}{ptmri}{T}+
20538 here is a much easier way of doing this, of course.
20547 ) package from CTAN allows a simple way to add such letters to your documents.
20548 Since this package is not a standard part of teTeX, I can't demonstrate
20549 it within this document, but if you copy this paragraph to a new document,
20551 \begin_inset Quotes eld
20561 \begin_inset Quotes erd
20564 and the pluses from the TeX code at the beginning of the paragraph, and
20569 usepackage{dropcaps}
20571 to your LaTeX preamble, you will get a nice Times Roman Italic
20572 \begin_inset Quotes eld
20576 \begin_inset Quotes erd
20579 , whose height is three lines of text and which protrudes 1 em into the
20581 (Make certain you have copied
20582 \begin_inset Quotes eld
20590 \begin_inset Quotes erd
20593 into a directory where TeX can see it.) The first argument is the amount
20594 of indentation; in this case the negative sign moves it into the margin.
20595 The second argument is the height of the letter in number of lines of text.
20596 The third argument is the font name: virtually anything which has a tfm
20597 file should work (wade through the
20599 .../texmf/fonts/tfm
20601 directory for possibilities).
20602 My personal favorite is
20603 \begin_inset Quotes eld
20611 \begin_inset Quotes erd
20614 , a fancy German font specifically designed for dropped capitals.
20615 The fourth argument is the letter (or letters) to be dropped.
20620 package also offers the
20626 command, as well as a slightly simplified
20635 \begin_layout Section
20636 Non-standard Paragraph Shapes
20639 \begin_layout Standard
20645 \begin_layout Standard
20646 \begin_inset VSpace bigskip
20652 \begin_layout Standard
20656 \begin_layout Plain Layout
20668 \begin_layout Standard
20672 \begin_layout Plain Layout
20681 \begin_layout Plain Layout
20695 \begin_layout Standard
20700 \begin_layout Plain Layout
20711 \begin_layout Plain Layout
20720 \begin_layout Plain Layout
20729 \begin_layout Plain Layout
20738 \begin_layout Plain Layout
20747 \begin_layout Plain Layout
20756 \begin_layout Plain Layout
20765 \begin_layout Plain Layout
20774 \begin_layout Plain Layout
20783 \begin_layout Plain Layout
20792 \begin_layout Plain Layout
20801 \begin_layout Plain Layout
20810 \begin_layout Plain Layout
20819 \begin_layout Plain Layout
20828 \begin_layout Plain Layout
20837 \begin_layout Plain Layout
20846 \begin_layout Plain Layout
20855 \begin_layout Plain Layout
20864 \begin_layout Plain Layout
20873 \begin_layout Plain Layout
20879 There are times when the tyranny of rectangular paragraphs must be overthrown.
20880 In such situations, a call to the delightful plain TeX command
20887 As you can see, completely arbitrary shapes can be laid out with a suitable
20888 set of linelength definitions.
20889 While this parshape may look a bit silly and useless, one could conceive
20890 of situations such as finely tuned dropped capitals, word wrapping around
20891 non-rectangular graphics, etc.
20892 which will benefit from such handcrafting.
20895 \begin_layout Standard
20896 \begin_inset VSpace bigskip
20902 \begin_layout Standard
20907 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
20914 is the number of lines of text which define the paragraph.
20915 If there turn out to be fewer lines, the shape is truncated; if there are
20916 more, the excess lines have the same dimensions as the last line of the
20926 entries specify the indentation of the line from the left margin, and the
20927 length of the line as measured from that point.
20928 The shape applies only to the current paragraph; everything is reset to
20929 normal for the next paragraph.
20932 \begin_layout Standard
20936 \begin_layout Plain Layout
20948 \begin_layout Section
20952 \begin_layout Standard
20953 As you can see, the examples in this section range from the useful to the
20955 While I don't expect that anyone will ever need the paragraph shape demonstrate
20956 d in the last section, the important point is that you can do almost anything
20957 you want in LyX if you are willing to figure out how to do it in TeX and
20959 TeX is a fantastically powerful typesetting system and all that power is
20960 available to you since LyX uses it as its backend.