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
86 \pdf_title "LyX's Extended manual"
87 \pdf_author "LyX Team"
88 \pdf_subject "LyX's extended documentation"
89 \pdf_keywords "LyX, Documentation, Extended"
91 \pdf_bookmarksnumbered true
92 \pdf_bookmarksopen false
93 \pdf_bookmarksopenlevel 1
98 \pdf_pdfusetitle false
99 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
107 \paperorientation portrait
108 \backgroundcolor #ffffff
111 \paragraph_separation indent
113 \quotes_language english
116 \paperpagestyle headings
117 \tracking_changes false
118 \output_changes false
126 Additional LyX Features
134 \begin_layout Plain Layout
136 Principal maintainer of this file is
141 If you have comments or error corrections, please send them to the LyX
142 Documentation mailing list,
143 \begin_inset Flex CharStyle:Code
146 \begin_layout Plain Layout
148 <lyx-docs@lists.lyx.org>
161 \begin_layout Standard
162 \begin_inset CommandInset toc
163 LatexCommand tableofcontents
170 \begin_layout Chapter
174 \begin_layout Standard
175 This manual is essentially Part II of the
177 User's Guide\SpecialChar \@.
180 The reason for separating this document out is simple: the
184 is already quite lengthy, and it contains information on all of the basic
185 features one needs to know in order to prepare most documents.
186 However, the LyX Team has worked to LyX extensible through various configuratio
187 n files and external packages.
188 That means that if you want to support the Fizzwizzle LaTeX package, you
189 can create a layout file (or module) for it without having to alter LyX
191 We've already had contributions of several new features this way.
192 This is the place where all of those get documented.
195 \begin_layout Standard
196 This manual also documents some special features, like fax support, version
197 control, and SGML support, which require additional software to work properly.
198 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
199 spruce up your documents by directly using the powerful features of LaTeX.
204 only WYSIWYM and will only ever interface to some, not all, LaTeX features.
207 \begin_layout Standard
208 If you haven't read the
212 yet, you are definitely in the wrong manual.
217 is the first place to go, since it describes the notation and format of
219 You should also be thoroughly familiar with the
223 and all of the basic features of LyX before attempting to read this one.
226 \begin_layout Standard
227 Since all the topics in this manual depend heavily on LyX's interaction
228 with LaTeX, this first chapter covers the inner workings of LyX and how
229 to direct LyX to generate exactly the LaTeX code you want.
230 It is obviously for more seasoned LyX users.
233 \begin_layout Chapter
237 \begin_layout Section
241 \begin_layout Standard
242 This chapter is for both TeX-nicians and the LaTeX-curious.
243 In it, we'll explain how LyX and LaTeX work together to produce printable
245 This is the only place in any of the manuals where we assume you know something
249 \begin_layout Standard
250 At one time, LyX was called a
251 \begin_inset Quotes eld
254 WYSIWYM frontend to LaTeX,
255 \begin_inset Quotes erd
258 but that's no longer true.
259 There are frontends to LaTeX out there.
263 \begin_layout Plain Layout
264 Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
265 There are also the LaTeX modes for vi and emacs, of course.
270 These are basically text editors with the ability to run LaTeX and mark
271 any errors in the file you're editing.
280 run LaTeX, and it also indicates errors in the file, it also does much,
282 For one thing, you don't need to know LaTeX to use LyX effectively.
283 And LyX has added its own extensions to LaTeX.
284 Try the following sometime: select
285 \begin_inset Flex CharStyle:MenuItem
288 \begin_layout Plain Layout
289 Export\SpecialChar \menuseparator
296 \begin_inset Flex CharStyle:MenuItem
299 \begin_layout Plain Layout
306 \begin_inset Flex CharStyle:MenuItem
309 \begin_layout Plain Layout
310 View\SpecialChar \menuseparator
316 ), then look at the preamble of the resulting
317 \begin_inset Flex CharStyle:Code
320 \begin_layout Plain Layout
327 You'll notice a variety of new macros defined specifically by LyX.
328 These macros are defined automatically, according to the features you use
332 \begin_layout Standard
333 There are several commands that automatically invoke LaTeX.
337 \begin_layout Itemize
338 \begin_inset Flex CharStyle:MenuItem
341 \begin_layout Plain Layout
342 View\SpecialChar \menuseparator
351 \begin_layout Itemize
352 \begin_inset Flex CharStyle:MenuItem
355 \begin_layout Plain Layout
356 View\SpecialChar \menuseparator
357 Update\SpecialChar \menuseparator
366 \begin_layout Itemize
367 \begin_inset Flex CharStyle:MenuItem
370 \begin_layout Plain Layout
371 File\SpecialChar \menuseparator
380 \begin_layout Itemize
381 \begin_inset Flex CharStyle:MenuItem
384 \begin_layout Plain Layout
385 File\SpecialChar \menuseparator
394 \begin_layout Standard
395 They will only invoke LaTeX if the file has changed since the last time
400 \begin_layout Standard
401 When LyX runs LaTeX on the file you're editing, it performs these steps:
404 \begin_layout Enumerate
405 Convert the document to LaTeX and save to a file with the extension
406 \begin_inset Flex CharStyle:Code
409 \begin_layout Plain Layout
416 \begin_inset Flex CharStyle:Code
419 \begin_layout Plain Layout
428 \begin_layout Enumerate
430 \begin_inset Flex CharStyle:Code
433 \begin_layout Plain Layout
439 file (maybe several times), and run any other commands (such as
440 \begin_inset Flex CharStyle:Code
443 \begin_layout Plain Layout
450 \begin_inset Flex CharStyle:Code
453 \begin_layout Plain Layout
459 ) needed to compile the LaTeX file.
462 \begin_layout Enumerate
463 If there are any errors, show the error log.
466 \begin_layout Standard
467 If you've run LaTeX using
468 \begin_inset Flex CharStyle:MenuItem
471 \begin_layout Plain Layout
474 \SpecialChar \menuseparator
482 , LyX then runs a DVI viewer to display the DVI-file.
484 \begin_inset Flex CharStyle:MenuItem
487 \begin_layout Plain Layout
490 \SpecialChar \menuseparator
498 , LyX performs further steps:
501 \begin_layout Itemize
503 \begin_inset Flex CharStyle:Code
506 \begin_layout Plain Layout
512 to convert the DVI file to PostScript.
515 \begin_layout Itemize
516 Run a PostScript viewer, such as
517 \begin_inset Flex CharStyle:Code
520 \begin_layout Plain Layout
526 , to display the PostScript file.
529 \begin_layout Standard
530 LyX does similar things when viewing, or exporting, other formats.
533 \begin_layout Section
534 Translating LaTeX files into LyX
537 \begin_layout Standard
538 You can import a LaTeX file into LyX by using the
539 \begin_inset Flex CharStyle:MenuItem
542 \begin_layout Plain Layout
543 File\SpecialChar \menuseparator
544 Import\SpecialChar \menuseparator
551 This will call a program named
552 \begin_inset Flex CharStyle:Code
555 \begin_layout Plain Layout
561 which will create a file
562 \begin_inset Flex CharStyle:Code
565 \begin_layout Plain Layout
572 \begin_inset Flex CharStyle:Code
575 \begin_layout Plain Layout
582 LyX will then open that file.
586 \begin_layout Plain Layout
587 \begin_inset Flex CharStyle:Code
590 \begin_layout Plain Layout
596 can also be run from the command line, of course.
604 \begin_layout Standard
605 \begin_inset Flex CharStyle:Code
608 \begin_layout Plain Layout
614 will translate most legal LaTeX, but not everything.
615 It will put things it doesn't understand into TeX code, so after translating
617 \begin_inset Flex CharStyle:Code
620 \begin_layout Plain Layout
626 , you can look for TeX code and hand-edit it until it looks right.
629 \begin_layout Standard
630 If you don't know what TeX code is, read the next section.
633 \begin_layout Section
634 \begin_inset CommandInset label
636 name "sec:Inserting-TeX-Code"
640 Inserting TeX Code into LyX Documents
643 \begin_layout Standard
644 Anything you can do in LaTeX you can do in LyX, for a very simple reason:
645 You can always insert TeX code into any LyX document.
646 LyX cannot, and will never be able to, display every possible LaTeX construct.
647 If ever you need to insert LaTeX commands into your LyX document, you can
649 \begin_inset Flex CharStyle:Code
652 \begin_layout Plain Layout
658 box, which you can insert into your document with
659 \begin_inset Flex CharStyle:MenuItem
662 \begin_layout Plain Layout
663 Insert\SpecialChar \menuseparator
672 \begin_layout Standard
673 Here's an example of inserting LaTeX commands in a LyX document.
674 The code looks like this:
677 \begin_layout LyX-Code
681 \begin_inset Newline newline
687 \begin_inset Newline newline
690 This is an example for a minipage environment.
692 \begin_inset Newline newline
695 can put nearly everything in it, even (non-floating)
696 \begin_inset Newline newline
701 \begin_inset Newline newline
707 \begin_inset Newline newline
711 \begin_inset Newline newline
717 \begin_inset Newline newline
723 \begin_inset Newline newline
729 \begin_inset Newline newline
734 \begin_inset Newline newline
740 \begin_inset Newline newline
746 \begin_inset Newline newline
752 \begin_inset Newline newline
760 \begin_layout LyX-Code
764 \begin_layout Standard
766 \begin_inset Flex CharStyle:Code
769 \begin_layout Plain Layout
775 box containing this text is directly after this paragraph.
776 Those of you reading the manual in LyX will only see the TeX code inset.
777 Those reading a printed version of the manuals will see the actual results:
780 \begin_layout Standard
784 \begin_layout Plain Layout
791 \begin_layout Plain Layout
798 \begin_layout Plain Layout
800 This is an example for a minipage environment.
801 You can put nearly everything in it, even (non-floating) figures and tables.
805 \begin_layout Plain Layout
812 \begin_layout Plain Layout
817 \begin_layout Plain Layout
824 \begin_layout Plain Layout
831 \begin_layout Plain Layout
838 \begin_layout Plain Layout
844 \begin_layout Plain Layout
851 \begin_layout Plain Layout
858 \begin_layout Plain Layout
865 \begin_layout Plain Layout
877 \begin_layout Standard
878 In addition to using TeX code, you can also create a separate file containing
879 some complex LaTeX structure and then use
880 \begin_inset Flex CharStyle:MenuItem
883 \begin_layout Plain Layout
884 Insert\SpecialChar \menuseparator
894 to include your file (you should select the type
895 \begin_inset Flex CharStyle:Code
898 \begin_layout Plain Layout
905 We recommend that you only do this if you have a
906 \begin_inset Flex CharStyle:Code
909 \begin_layout Plain Layout
920 Otherwise, you'll have a big job tracking down LaTeX errors.
923 \begin_layout Standard
924 There are a few last points to emphasize:
927 \begin_layout Itemize
932 check if your LaTeX code is correct.
935 \begin_layout Itemize
936 Beware reinventing the wheel.
939 \begin_layout Standard
940 On that last point, LyX does have quite a few features tucked into it, and
942 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
943 feature before you decide you have to do it by hand.
944 Moreover, there are numerous LaTeX packages out there to do all sorts of
945 things, from labels to envelopes to fancy multipage tables.
947 \begin_inset CommandInset href
950 target "http://www.ctan.org/"
954 for details, and see chapter
955 \begin_inset CommandInset ref
957 reference "cha:secrets"
964 \begin_layout Standard
965 If you do need to do some wild and fancy things within your document, be
966 sure to check out a good LaTeX book for assistance.
967 There are a number of them listed in the bibliography of the
974 \begin_layout Section
975 LyX and the LaTeX Preamble
978 \begin_layout Subsection
979 About the LaTeX Preamble
982 \begin_layout Standard
983 If you already know LaTeX, there is no need to explain here what the preamble
985 If you don't, the following will give you some ideas—we recommend again
986 that you consult a LaTeX book for further information.
987 In any case, you should read the points below, because they explain what
988 you can do and what you don't need to do in the LaTeX preamble of a LyX
992 \begin_layout Standard
993 The LaTeX preamble comes at the very beginning of a document,
1001 \begin_layout Itemize
1002 Declare the document class.
1004 \begin_inset Newline newline
1007 LyX already does this for you.
1008 If you're a seasoned LaTeX-nician, and you have a custom document class
1009 you want to use, check out the
1011 Customization Manual
1013 for information on how to make LyX interface to it.
1016 \begin_layout Itemize
1017 Declare the usage of packages.
1019 \begin_inset Newline newline
1022 LaTeX packages provide special commands, which are only available within
1023 a document when the package has been declared in the preamble.
1024 For example, the package
1025 \begin_inset Flex CharStyle:Code
1028 \begin_layout Plain Layout
1034 forces all paragraphs to be indented.
1035 There are other packages for labels, envelopes, margins, etc.
1039 \begin_layout Itemize
1040 Set counters, variables, lengths and widths.
1042 \begin_inset Newline newline
1045 There are several LaTeX counters and variables which
1049 be set globally from within the preamble in order to have the desired effect.
1050 (There are variables which you can set and reset inside the document, too.)
1051 Margins are a good example of something which must be set in the preamble.
1052 Another example is the label format for lists.
1053 You can actually set these just about anywhere, but it's best to do it
1054 just once, inside the preamble.
1057 \begin_layout Itemize
1058 Declare user defined commands (with
1059 \begin_inset Flex CharStyle:Code
1062 \begin_layout Plain Layout
1071 \begin_inset Flex CharStyle:Code
1074 \begin_layout Plain Layout
1083 \begin_inset Newline newline
1086 These are abbreviations for LaTeX commands which appear very often inside
1088 Although the preamble is a good place to declare such commands, they
1092 be declared anywhere (before they are used for the first time, of course).
1093 This can be useful if there is a lot of raw LaTeX code in your document,
1094 which normally should not be the case.
1097 \begin_layout Standard
1098 LyX adds its own set of definitions to the preamble of the
1099 \begin_inset Flex CharStyle:Code
1102 \begin_layout Plain Layout
1109 This makes LaTeX files generated by LyX portable.
1112 \begin_layout Subsection
1113 Changing the Preamble
1116 \begin_layout Standard
1117 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1118 can't change them without patching LyX itself.
1119 You can, however, add your own stuff to the preamble by selecting
1120 \begin_inset Flex CharStyle:MenuItem
1123 \begin_layout Plain Layout
1125 \begin_inset space ~
1134 \begin_inset Flex CharStyle:MenuItem
1137 \begin_layout Plain Layout
1138 Document\SpecialChar \menuseparator
1145 LyX adds anything in the
1146 \begin_inset Flex CharStyle:MenuItem
1149 \begin_layout Plain Layout
1155 dialog to its own built-in preamble.
1156 Before adding your own declarations in the preamble, you should make sure
1157 that LyX doesn't already support what you want to do.
1158 (Remember what we said about reinventing the wheel?) Also,
1160 make sure your preamble code is correct
1163 LyX doesn't check it for you.
1164 If there is an error, you're likely to get an error like
1165 \begin_inset Quotes eld
1169 \begin_inset Flex CharStyle:Code
1172 \begin_layout Plain Layout
1181 \begin_inset Quotes erd
1185 If you see this error, check your preamble.
1188 \begin_layout Subsection
1192 \begin_layout Standard
1193 Here are some examples of what you can add to a preamble, and what they
1197 \begin_layout Subsubsection
1201 \begin_layout Standard
1202 There are two variables under LaTeX that control page position:
1203 \begin_inset Flex CharStyle:Code
1206 \begin_layout Plain Layout
1215 \begin_inset Flex CharStyle:Code
1218 \begin_layout Plain Layout
1227 Their names should be self-explanatory.
1228 These variables are useful if you think for a moment about computer labels.
1229 Sometimes, the size of a print medium and the area of the medium that you
1230 can actually print on aren't the same.
1232 \begin_inset Flex CharStyle:Code
1235 \begin_layout Plain Layout
1244 \begin_inset Flex CharStyle:Code
1247 \begin_layout Plain Layout
1258 \begin_layout Standard
1259 The default values for
1260 \begin_inset Flex CharStyle:Code
1263 \begin_layout Plain Layout
1272 \begin_inset Flex CharStyle:Code
1275 \begin_layout Plain Layout
1284 \begin_inset space \thinspace{}
1288 \begin_inset space \thinspace{}
1292 \begin_inset space \space{}
1295 the page isn't shifted.
1296 Unfortunately, some DVI drivers always seem to shift the page.
1297 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1298 If you're using LyX on a system that you don't personally maintain, and
1299 your sysadmin is a doofus,
1300 \begin_inset Flex CharStyle:Code
1303 \begin_layout Plain Layout
1312 \begin_inset Flex CharStyle:Code
1315 \begin_layout Plain Layout
1324 Suppose you're left and top margins are always 0.5
1325 \begin_inset space \thinspace{}
1329 You can add this to the preamble:
1332 \begin_layout LyX-Code
1340 \begin_layout LyX-Code
1348 \begin_layout Standard
1349 and your margins should now be correct.
1352 \begin_layout Subsubsection
1356 \begin_layout Standard
1357 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1358 There's a rather nice package, available at your nearest CTAN archive,
1359 for printing sheets of labels:
1360 \begin_inset Flex CharStyle:Code
1363 \begin_layout Plain Layout
1370 Now, your system may not have this package installed by default.
1371 We leave that up to you to check.
1372 You'll also want to read the documentation for it; we're not going to do
1374 Since this is an example, however, we'll give you an example of how you
1378 \begin_layout Standard
1379 First, make sure you're using the
1380 \begin_inset Flex CharStyle:Code
1383 \begin_layout Plain Layout
1390 Next, you need to put the following in your preamble:
1393 \begin_layout LyX-Code
1399 \begin_layout LyX-Code
1405 \begin_layout LyX-Code
1411 \begin_layout LyX-Code
1417 \begin_layout LyX-Code
1423 \begin_layout LyX-Code
1429 \begin_layout LyX-Code
1435 \begin_layout Standard
1436 This sets things up for Avery label sheets, stock #5360.
1437 You're now ready to print labels, but you'll need to insert LaTeX code,
1438 placing the commands
1439 \begin_inset Flex CharStyle:Code
1442 \begin_layout Plain Layout
1451 \begin_inset Flex CharStyle:Code
1454 \begin_layout Plain Layout
1462 around each label text.
1463 This and other special features of
1464 \begin_inset Flex CharStyle:Code
1467 \begin_layout Plain Layout
1473 are explained in its documentation.
1476 \begin_layout Standard
1477 Someday, someone may write a LyX layout file to support this package directly.
1478 Maybe that someone is you.
1481 \begin_layout Subsubsection
1482 Example #3: Paragraph Indentation
1485 \begin_layout Standard
1486 Americans are trained to indent the first line of
1491 As with all of their other weird quirks, most Americans will whine and
1492 moan until they can have their way and indent the first line of all paragraphs.
1501 \begin_layout Standard
1502 Of course, this behavior isn't standard typography.
1503 In books, you typically only indent the first line of a paragraph
1507 it follows another one.
1508 The idea behind indenting the first line of a paragraph is to distinguish
1509 neighboring paragraphs from one another.
1510 If there is no previous paragraph—for example, if it follows a figure or
1511 is the first paragraph in a section—then there is no need for indentation.
1515 \begin_layout Standard
1516 If you're a typical American (we're still joking!), though, you don't care
1517 about such esoteric things; you want your indentation! Add this to the
1521 \begin_layout LyX-Code
1524 usepackage{indentfirst}
1527 \begin_layout Standard
1528 If your TeX distribution isn't braindead, you'll have this package, and
1529 all of your paragraphs will get the indentation the Founding Fathers intended
1533 \begin_layout Subsubsection
1534 Example #4: This Document
1537 \begin_layout Standard
1538 You can also check out the preamble of this document to get an idea of some
1539 of the advanced things you can do.
1540 Also, there are more examples and an assortment of LaTeX
1541 \begin_inset Quotes eld
1545 \begin_inset Quotes erd
1549 \begin_inset space ~
1553 \begin_inset CommandInset ref
1555 reference "cha:secrets"
1563 \begin_layout Section
1564 LyX and LaTeX Errors
1567 \begin_layout Standard
1568 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1570 It then uses the logfile from the LaTeX run to do a post-mortem.
1571 After analyzing the logfile,LyX displays a dialog listing the errors.
1572 Clicking on any one of them will take you to the position in your LyX file
1573 where the error occurred.
1577 \begin_layout Plain Layout
1579 Analyzing the logfile is a tough job, and LyX doesn't always go to the
1581 There are also cases where LaTeX reports the error on one line, but the
1582 actual error is earlier.
1583 This is not unlike forgetting a closing brace in a program: You'll get
1584 an error, but only later.
1592 \begin_layout Standard
1593 Some folks also like to look at the log file directly: It is available from
1595 \begin_inset Flex CharStyle:MenuItem
1598 \begin_layout Plain Layout
1601 \SpecialChar \menuseparator
1605 \begin_inset space ~
1614 There are some fairly common error messages and warnings.
1615 We'll cover those here.
1616 You should look at a good LaTeX book for a complete listing.
1619 \begin_layout Itemize
1620 \begin_inset Flex CharStyle:Code
1623 \begin_layout Plain Layout
1630 \begin_inset Newline newline
1633 Anything beginning with these words is a warning message for the purpose
1635 \begin_inset Quotes eld
1639 \begin_inset Quotes erd
1642 the LaTeX code itself.
1643 You'll get messages like this if you added or changed cross-references
1644 or bibliography entries, in which case, LaTeX is trying to tell you that
1645 you need to make another run.
1646 You can by-and-large ignore these.
1649 \begin_layout Itemize
1650 \begin_inset Flex CharStyle:Code
1653 \begin_layout Plain Layout
1660 \begin_inset Newline newline
1663 Another warning message, this time about fonts which LaTeX couldn't find.
1664 The rest of the message will often say something about a replacement font
1666 You can safely ignore these, too.
1669 \begin_layout Itemize
1670 \begin_inset Flex CharStyle:Code
1673 \begin_layout Plain Layout
1682 \begin_inset Newline newline
1690 They are warnings about lines that were too long and run past the right
1692 Almost always, this is unnoticeable in the final output.
1693 (It can be just a point or two.) Or, only one or two characters extend past
1695 LaTeX seems to generate at least one of these messages for just about any
1697 \begin_inset Newline newline
1700 You can ignore these messages.
1701 Your eyes will tell you if there's a problem with something that's too
1702 wide; just look at the output.
1706 \begin_layout Plain Layout
1707 You can also enable the `draft' option in
1708 \begin_inset Flex CharStyle:MenuItem
1711 \begin_layout Plain Layout
1714 \SpecialChar \menuseparator
1722 , and then LaTeX will draw a black box in the margin of lines that are overfull.
1730 \begin_layout Itemize
1731 \begin_inset Flex CharStyle:Code
1734 \begin_layout Plain Layout
1743 \begin_inset Newline newline
1746 Not quite as common as its cousin.
1747 LaTeX seems to like to print lines that are a bit too wide as opposed to
1748 ones that are a bit too narrow.
1749 We have no idea why.
1752 \begin_layout Itemize
1753 \begin_inset Flex CharStyle:Code
1756 \begin_layout Plain Layout
1765 \begin_inset Flex CharStyle:Code
1768 \begin_layout Plain Layout
1777 \begin_inset Newline newline
1780 Warnings about troubles breaking the page.
1781 Once again, just look at the output.
1782 Your eyes will tell you where something has gone wrong.
1785 \begin_layout Itemize
1786 \begin_inset Flex CharStyle:Code
1789 \begin_layout Plain Layout
1791 \begin_inset Quotes els
1795 \begin_inset Quotes ers
1804 \begin_inset Newline newline
1808 \begin_inset Quotes eld
1812 \begin_inset Quotes erd
1815 isn't installed on this system.
1816 This usually appears because some package your document needs isn't installed.
1817 If you didn't touch the preamble or didn't use the
1818 \begin_inset Flex CharStyle:Code
1821 \begin_layout Plain Layout
1829 command, then one of the packages LyX tried to load is missing.
1831 \begin_inset Flex CharStyle:MenuItem
1834 \begin_layout Plain Layout
1835 Help\SpecialChar \menuseparator
1841 to get a list of packages that LyX knows about.
1842 This file is updated whenever you reconfigure LyX (using
1843 \begin_inset Flex CharStyle:MenuItem
1846 \begin_layout Plain Layout
1847 Tools\SpecialChar \menuseparator
1853 ) and tells you which packages have been detected and what they do.
1854 \begin_inset Newline newline
1858 \begin_inset Flex CharStyle:Code
1861 \begin_layout Plain Layout
1869 command and the package in question isn't installed, then you'll need to
1870 install it yourself.
1873 \begin_layout Itemize
1874 \begin_inset Flex CharStyle:Code
1877 \begin_layout Plain Layout
1878 LaTeX Error: Unknown option
1884 \begin_inset Newline newline
1887 Error messages beginning with this are trying to tell you that you specified
1888 a bad or undefined option to a package.
1889 Check the package's documentation.
1892 \begin_layout Itemize
1893 \begin_inset Flex CharStyle:Code
1896 \begin_layout Plain Layout
1897 Undefined control sequence
1903 \begin_inset Newline newline
1906 If you've inserted LaTeX code into your document, but made a typo, you'll
1908 You may have forgotten to load a package.
1909 In any case, this error message usually means that you used an undefined
1914 \begin_layout Standard
1915 There are other error and warning messages.
1916 Some are self-explanatory.
1917 These are usually LaTeX messages.
1918 Others are downright cryptic.
1919 These are usually TeX error messages, and we really have
1923 what they mean or how to decipher them.
1927 \begin_layout Standard
1928 There's a general sequence you should follow if you get error messages:
1931 \begin_layout Enumerate
1932 Look at the LaTeX code you inserted for typos.
1935 \begin_layout Enumerate
1936 If there are no typos, check that you used the command(s) correctly.
1939 \begin_layout Enumerate
1940 If you get a bunch of error boxes piled up at the very top of the document—and
1941 especially if you see a
1942 \begin_inset Quotes eld
1946 \begin_inset Flex CharStyle:Code
1949 \begin_layout Plain Layout
1958 \begin_inset Quotes erd
1961 error—it means that there are errors in the preamble.
1962 Start debugging your preamble.
1965 \begin_layout Enumerate
1966 If you didn't add anything to the preamble and didn't add any LaTeX code
1967 to the document, the first suspect is your LaTeX distribution itself.
1968 Check for missing packages and install them.
1971 \begin_layout Enumerate
1972 Okay, so there are no missing packages.
1973 Did you use any of the fine-tuning options in LyX? Specifically, did you
1978 any of them, like trying to manually insert lots of
1979 \begin_inset Flex CharStyle:Code
1982 \begin_layout Plain Layout
1984 \begin_inset space ~
1993 \begin_inset Flex CharStyle:Code
1996 \begin_layout Plain Layout
2003 \begin_inset Flex CharStyle:Code
2006 \begin_layout Plain Layout
2012 ? Did you try to kludge something together with these instead of using the
2013 appropriate paragraph environment?
2016 \begin_layout Enumerate
2017 All right, you didn't use any of the fine-tuning options, you played by
2019 Did you try to pull a fancy maneuver? Did you do something funky inside
2020 a table or an equation, like inserting a graphic into a table cell?
2023 \begin_layout Enumerate
2024 Do you have long sections of text where LaTeX cannot find a place to break
2025 a line? By default, LaTeX is rather strict about how much extra inter-word
2026 spacing it will add in order to break a line.
2027 Preferably, you should rework the paragraph to avoid the problem.
2028 If this isn't an option, you can wrap your text in
2029 \begin_inset Flex CharStyle:Code
2032 \begin_layout Plain Layout
2040 to make LaTeX's line breaking more, well, sloppy.
2043 \begin_layout Enumerate
2044 Did you go overboard with the nesting? LyX (currently) doesn't check to
2045 make sure you're in the limits for nesting environments.
2046 If you nested a bunch of environments to the
2047 \begin_inset Formula $17^{\mathrm{th}}$
2050 level, that's the problem.
2051 (The limit in LaTeX is five.)
2054 \begin_layout Enumerate
2055 Okay, you didn't get any error messages, but your output looks awful.
2056 If you have a table or figure that's too wide or long for the page, you
2061 \begin_layout Enumerate
2062 rescale the figure so it fits.
2065 \begin_layout Enumerate
2066 trim down the table so it fits.
2070 \begin_layout Enumerate
2071 If something else is wrong with the output, and you didn't try to pull anything
2072 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2075 \begin_layout Standard
2076 If all this doesn't help—well, then
2080 you might have found a bug in LyX\SpecialChar \ldots{}
2084 \begin_layout Chapter
2088 \begin_layout Section
2089 Customizing Bibliographies with BibTeX
2092 \begin_layout Standard
2093 The basics how to use BibTeX are explained in section
2095 Bibliography databases (BibTeX)
2102 The following subsections explain special bibliography features supported
2106 \begin_layout Subsection
2107 Alternative Citation Styles
2110 \begin_layout Standard
2111 Standard BibTeX uses numbers (e.
2112 \begin_inset space \thinspace{}
2116 \begin_inset space \space{}
2120 \begin_inset Quotes eld
2124 \begin_inset Quotes erd
2127 ) to refer to a cited work.
2128 However, in many scientific disciplines, other citation styles are in use.
2129 The most common one is the author-year style (e.
2130 \begin_inset space \thinspace{}
2134 \begin_inset space \space{}
2138 \begin_inset Quotes eld
2142 \begin_inset Quotes erd
2146 LyX supports two packages that provide this style,
2147 \begin_inset Flex CharStyle:Code
2150 \begin_layout Plain Layout
2157 \begin_inset Flex CharStyle:Code
2160 \begin_layout Plain Layout
2167 Both packages have their pros and cons, which cannot be listed in detail.
2168 If you only want to have simple author-year (or author-numerical) style,
2169 or if you want to use one of the countless style files for
2170 \begin_inset Flex CharStyle:Code
2173 \begin_layout Plain Layout
2179 , than the established
2180 \begin_inset Flex CharStyle:Code
2183 \begin_layout Plain Layout
2189 package is probably your choice.
2190 If you need special features like short title references, ibidem etc., you
2192 \begin_inset Flex CharStyle:Code
2195 \begin_layout Plain Layout
2204 \begin_layout Standard
2205 The handling of both packages in LyX is basically the same.
2207 \begin_inset Flex CharStyle:MenuItem
2210 \begin_layout Plain Layout
2211 Document\SpecialChar \menuseparator
2218 \begin_inset Flex CharStyle:MenuItem
2221 \begin_layout Plain Layout
2228 \begin_inset Flex CharStyle:MenuItem
2231 \begin_layout Plain Layout
2238 \begin_inset Flex CharStyle:MenuItem
2241 \begin_layout Plain Layout
2248 With both packages, you will get some extra features in the citation dialog
2249 and you can select the style of the reference (
2250 \begin_inset Quotes eld
2254 \begin_inset Quotes erd
2258 \begin_inset Quotes eld
2262 \begin_inset Quotes erd
2266 \begin_inset Quotes eld
2270 \begin_inset Quotes erd
2274 \begin_inset Quotes eld
2278 \begin_inset Quotes erd
2282 Note that both packages need specifically designed style files.
2283 They both ship their own, but there are lots of additional style files,
2284 and there is even an interactive style file builder
2288 \begin_layout Plain Layout
2290 \begin_inset Flex URL
2293 \begin_layout Plain Layout
2295 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2306 \begin_inset Flex CharStyle:Code
2309 \begin_layout Plain Layout
2318 \begin_layout Subsection
2319 Sectioned Bibliographies
2322 \begin_layout Standard
2323 Sometimes you might need to divide your bibliography into several sections.
2324 If you are for instance a historian, the possibility to separate sources
2325 and scientific works is most likely a
2326 \begin_inset Quotes eld
2330 \begin_inset Quotes erd
2334 Unfortunately, BibTeX itself does not allow you to do this.
2335 But with the help of some LaTeX packages, BibTeX can be extended to fit
2339 \begin_layout Standard
2340 LyX provides native support for one of these packages,
2348 \begin_layout Plain Layout
2350 \begin_inset Flex URL
2353 \begin_layout Plain Layout
2355 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2365 The advantage of this package (compared to other packages like
2369 ) is that you don't need to define new citation commands.
2370 Instead, you need to prepare different bibliographic databases which include
2371 the entries for the different sections of the bibliography.
2372 For example: If you want to divide your bibliography into the sections
2374 \begin_inset Quotes eld
2378 \begin_inset Quotes erd
2382 \begin_inset Quotes eld
2386 \begin_inset Quotes erd
2389 , you first need to create two bibliographic databases, e.
2390 \begin_inset space \thinspace{}
2394 \begin_inset space \space{}
2398 \begin_inset Flex CharStyle:Code
2401 \begin_layout Plain Layout
2408 \begin_inset Flex CharStyle:Code
2411 \begin_layout Plain Layout
2421 \begin_layout Standard
2423 \begin_inset Flex CharStyle:MenuItem
2426 \begin_layout Plain Layout
2427 Document\SpecialChar \menuseparator
2434 \begin_inset Flex CharStyle:MenuItem
2437 \begin_layout Plain Layout
2444 \begin_inset Flex CharStyle:MenuItem
2447 \begin_layout Plain Layout
2448 Sectioned bibliography
2454 Now you can insert multiple BibTeX bibliographies, one for each section
2455 of your bibliography.
2456 Returning to our example: Insert the BibTeX bibliography
2457 \begin_inset Flex CharStyle:Code
2460 \begin_layout Plain Layout
2466 and a second one for the database
2467 \begin_inset Flex CharStyle:Code
2470 \begin_layout Plain Layout
2477 You are free to use the same or different styles for each section.
2478 Additionally, you can chose if the bibliography section should contain
2480 \begin_inset Quotes eld
2483 all cited references
2484 \begin_inset Quotes erd
2487 of the specified database(s) (which is the default),
2488 \begin_inset Quotes eld
2491 all uncited references
2492 \begin_inset Quotes erd
2496 \begin_inset Quotes eld
2500 \begin_inset Quotes erd
2504 This might be useful if you would like to separate your bibliography into
2506 \begin_inset Quotes eld
2510 \begin_inset Quotes erd
2514 \begin_inset Quotes eld
2518 \begin_inset Quotes erd
2522 \begin_inset Quotes eld
2526 \begin_inset Quotes erd
2530 The titles for the sections can be added as ordinary sections or subsections.
2532 \begin_inset Flex CharStyle:Code
2535 \begin_layout Plain Layout
2541 removes the bibliography title, you have manually re-add that, too (as
2542 a chapter* or section*, for instance).
2545 \begin_layout Subsection
2546 Multiple Bibliographies
2549 \begin_layout Standard
2550 Multiple bibliographies, e.
2551 \begin_inset space \thinspace{}
2555 \begin_inset space \space{}
2558 a bibliography for each section or chapter of the document, are not supported
2561 \begin_inset Flex CharStyle:Code
2564 \begin_layout Plain Layout
2570 package, which is used for the creation of sectioned bibliographies in
2571 LyX (see the previous section), provides an easy way to solve this task,
2572 if you are willing to use some
2573 \begin_inset Flex CharStyle:MenuItem
2576 \begin_layout Plain Layout
2583 \begin_inset space ~
2587 \begin_inset CommandInset ref
2589 reference "sec:Inserting-TeX-Code"
2597 \begin_layout Plain Layout
2598 An alternative approach is to use the
2599 \begin_inset Flex CharStyle:Code
2602 \begin_layout Plain Layout
2609 \begin_inset Flex CharStyle:Code
2612 \begin_layout Plain Layout
2618 package, respectively.
2626 \begin_layout Standard
2628 \begin_inset Flex CharStyle:MenuItem
2631 \begin_layout Plain Layout
2632 Document\SpecialChar \menuseparator
2639 \begin_inset Flex CharStyle:MenuItem
2642 \begin_layout Plain Layout
2649 \begin_inset Flex CharStyle:MenuItem
2652 \begin_layout Plain Layout
2653 Sectioned bibliography
2659 In the document, you have to enclose the sections, which shall contain
2660 their own bibliography (including the BibTeX bibliography itself), between
2662 \begin_inset Flex CharStyle:Code
2665 \begin_layout Plain Layout
2674 \begin_inset Flex CharStyle:Code
2677 \begin_layout Plain Layout
2685 (those commands have to be inserted as TeX code).
2686 The bibliography will contain all references which have been cited in the
2688 \begin_inset Flex CharStyle:Code
2691 \begin_layout Plain Layout
2702 If you are using this approach, then every citation reference has to be
2704 \begin_inset Flex CharStyle:Code
2707 \begin_layout Plain Layout
2715 \begin_inset Flex CharStyle:Code
2718 \begin_layout Plain Layout
2727 \begin_layout Section
2731 \begin_layout Subsection
2735 \begin_layout Standard
2736 When you are working on a large file with many sections, it is often convenient
2737 to break up the document into several files, or perhaps you have something
2738 where a table may change from time to time, but the preceding text does
2740 In these cases, you should seriously consider using multipart documents.
2741 For example, scientific papers often have five major sections: the introduction
2742 , observations, results, discussion, and conclusion.
2743 Each of these could be its own separate LyX file, with one
2744 \begin_inset Quotes eld
2748 \begin_inset Quotes erd
2751 file which contains the title, authors, abstract, references, etc., plus
2752 the five included files.
2753 It is important to note that each of these files is a full LyX file which
2754 can be formatted and printed on its own, as well as included in a master
2756 Each of these files must have the same document class, however—don't attempt
2757 to mix book classes with article classes.
2758 You may also include LaTeX files; however, these files must not have their
2760 \begin_inset space \thinspace{}
2764 \begin_inset space \space{}
2767 everything up to and including the
2768 \begin_inset Flex CharStyle:Code
2771 \begin_layout Plain Layout
2780 \begin_inset Flex CharStyle:Code
2783 \begin_layout Plain Layout
2791 line must be deleted) or else errors will be generated when you try to
2795 \begin_layout Standard
2796 LyX allows you to include files quite easily with
2797 \begin_inset Flex CharStyle:MenuItem
2800 \begin_layout Plain Layout
2801 Insert\SpecialChar \menuseparator
2803 \begin_inset space ~
2812 When you click on this selection a small box is inserted into the file
2813 at the current cursor location.
2814 Clicking on the box raises a dialog which allows you to select the file
2815 to be included, and the method of its inclusion.
2819 \begin_layout Standard
2820 The file selection box should by now be obvious.
2821 The three inclusion methods are
2822 \begin_inset Quotes eld
2826 \begin_inset Quotes erd
2830 \begin_inset Quotes eld
2834 \begin_inset Quotes erd
2838 \begin_inset Quotes eld
2842 \begin_inset Quotes erd
2846 The difference between
2847 \begin_inset Quotes eld
2851 \begin_inset Quotes erd
2855 \begin_inset Quotes eld
2859 \begin_inset Quotes erd
2862 is really only meaningful to LaTeXperts, but the practical difference is
2863 that files which are
2864 \begin_inset Quotes eld
2868 \begin_inset Quotes erd
2871 are typeset beginning on a new page, while files which are
2872 \begin_inset Quotes eld
2876 \begin_inset Quotes erd
2879 are typeset starting on the current page.
2882 \begin_layout Standard
2883 Generally, the master file is converted into a full LaTeX file before typesettin
2884 g, while the included files are converted to LaTeX files which do not have
2885 all the preamble information.
2888 \begin_layout Standard
2890 \begin_inset Quotes eld
2894 \begin_inset Quotes erd
2897 included file allows you to include a file typeset exactly as it appears
2899 \begin_inset space \thinspace{}
2903 \begin_inset space \space{}
2907 \begin_inset Flex CharStyle:Code
2910 \begin_layout Plain Layout
2916 mode, with the characters set in a fixed-width typewriter font.
2917 Normally, spaces in this file are invisible, though two consecutive spaces
2918 are conserved, unlike LyX's normal treatment of spaces.
2919 However, setting the
2920 \begin_inset Flex CharStyle:MenuItem
2923 \begin_layout Plain Layout
2925 \begin_inset space ~
2929 \begin_inset space ~
2933 \begin_inset space ~
2941 checkbox typesets a mark to unambiguously define the presence of a space.
2945 \begin_layout Subsection
2946 Cross-References Between Files
2949 \begin_layout Standard
2950 \begin_inset Box Shadowbox
2959 height_special "totalheight"
2962 \begin_layout Plain Layout
2963 This section is somewhat out of date.
2964 Need to describe default master documents and how children are opened when
2974 \begin_layout Standard
2975 It is possible to set up cross-references between the different files.
2976 First, open all the files in question: let's call them A and B in a two
2977 file example, where B is included in A.
2978 Let's say you insert a label in A, then want to reference it in B.
2979 Open the cross-reference dialog in whilst in document B, and you can select
2981 \begin_inset Quotes eld
2985 \begin_inset Quotes erd
2991 \begin_layout Subsection
2992 Bibliography Lists in all Subdocuments
2995 \begin_layout Standard
2996 \begin_inset Box Frameless
3005 height_special "totalheight"
3008 \begin_layout Plain Layout
3009 This section also needs updating.
3010 There is now material about this on the wiki, and it could be copied here.
3018 \begin_layout Standard
3019 Copy the bibliography list with all entries to all subdocuments and transform
3021 This way LyX will find the
3022 \begin_inset Flex CharStyle:Code
3025 \begin_layout Plain Layout
3031 -files and you can easily insert references without making the bibliography
3035 \begin_layout Standard
3036 As the bibliography list is in a comment, LaTeX won't use use it and the
3037 references will look like this: [?], instead of like this: [1].
3038 One solution is to use the LaTeX-package
3039 \begin_inset Flex CharStyle:Code
3042 \begin_layout Plain Layout
3048 that will only include comments by processing the files separately.
3049 To do this, add in the LaTeX preamble of every subdocument the following:
3052 \begin_layout LyX-Code
3058 \begin_layout LyX-Code
3061 includecomment{comment}
3064 \begin_layout Standard
3066 \begin_inset Flex URL
3069 \begin_layout Plain Layout
3071 http://wiki.lyx.org/FAQ/Unsorted#toc31
3079 \begin_layout Section
3080 Fancy Headers and Footers
3083 \begin_layout Standard
3084 The default page layout is rather plain; for an
3085 \begin_inset Flex CharStyle:Code
3088 \begin_layout Plain Layout
3094 document class, all you get is a centered page number at the bottom of
3096 This document uses KOMA-script's book class, so it appears to be a bit
3098 But to really put on a show, you need to set the document page style to
3100 \begin_inset Quotes eld
3104 \begin_inset Quotes erd
3107 , as mentioned in the
3112 This section describes the LaTeX code you need to insert in your LaTeX
3113 preamble in order to get the desired effects.
3116 \begin_layout Standard
3117 The page header is divided into three fields, not surprisingly labeled
3118 \begin_inset Quotes eld
3122 \begin_inset Quotes erd
3126 \begin_inset Quotes eld
3130 \begin_inset Quotes erd
3134 \begin_inset Quotes eld
3138 \begin_inset Quotes erd
3142 The footer is also divided into these three fields.
3143 The LaTeX commands to set these fields in the simplest manner are
3144 \begin_inset Flex CharStyle:Code
3147 \begin_layout Plain Layout
3156 \begin_inset Flex CharStyle:Code
3159 \begin_layout Plain Layout
3168 \begin_inset Flex CharStyle:Code
3171 \begin_layout Plain Layout
3180 \begin_inset Flex CharStyle:Code
3183 \begin_layout Plain Layout
3192 Suppose you wish to put your name in the upper left hand corner of each
3194 Simply insert the following command in the preamble:
3197 \begin_layout Standard
3206 \begin_layout Standard
3207 You will now see your name in the upper left.
3208 If a field has a default entry that you would like to get rid of (often
3209 the page number appears in the central footer, simply include a command
3210 with a blank argument, e.
3211 \begin_inset space \thinspace{}
3217 \begin_layout Standard
3225 \begin_layout Standard
3226 Let's get really fancy: lets put the section number with the word
3227 \begin_inset Quotes eld
3231 \begin_inset Quotes erd
3235 \begin_inset space \thinspace{}
3239 \begin_inset space \space{}
3242 Section 3) in the upper left, the page number (e.
3243 \begin_inset space \thinspace{}
3247 \begin_inset space \space{}
3250 Page 4) in the upper right, your name in the lower left, and the date in
3252 The following commands should now appear in the preamble:
3255 \begin_layout Standard
3265 \begin_layout Standard
3273 \begin_layout Standard
3283 \begin_layout Standard
3292 \begin_layout Standard
3300 \begin_layout Standard
3310 \begin_layout Standard
3312 \begin_inset Flex CharStyle:Code
3315 \begin_layout Plain Layout
3324 \begin_inset Flex CharStyle:Code
3327 \begin_layout Plain Layout
3335 access LaTeX's section and page counters, and so print out the current
3336 section and page numbers.
3338 \begin_inset Flex CharStyle:Code
3341 \begin_layout Plain Layout
3349 simply prints out today's date.
3352 \begin_layout Standard
3353 The thicknesses of the horizontal rules drawn beneath the header and above
3354 the footer can also be modified.
3355 If you don't want one of the rules, set its thickness to 0.
3356 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3362 \begin_inset Flex CharStyle:Code
3365 \begin_layout Plain Layout
3370 headrulewidth}{0.4pt}
3376 \begin_inset Flex CharStyle:Code
3379 \begin_layout Plain Layout
3384 footrulewidth}{0.4pt}
3389 to set the thicknesses.
3392 \begin_layout Standard
3393 You can switch the header/footer settings on and off for individual pages
3395 \begin_inset Flex CharStyle:Code
3398 \begin_layout Plain Layout
3401 thispagestyle{empty}
3407 \begin_inset Flex CharStyle:Code
3410 \begin_layout Plain Layout
3413 thispagestyle{plain}
3419 \begin_inset Flex CharStyle:Code
3422 \begin_layout Plain Layout
3425 thispagestyle{fancy}
3431 Simply insert them in the text on the page you want changed and mark them
3433 In fact, title pages are marked as plain by default, while following pages
3434 are marked fancy when using the global fancy setting.
3437 \begin_layout Standard
3438 There are more complex commands which will let you insert things in the
3439 upper left on odd numbered pages, etc., but we will refer you to the
3440 \begin_inset Flex CharStyle:Code
3443 \begin_layout Plain Layout
3449 package documentation for more information.
3451 \begin_inset Flex CharStyle:Code
3454 \begin_layout Plain Layout
3463 \begin_layout Standard
3464 As a final example, it is possible to include an image in the header or
3466 Suppose you want to put a company logo in the upper lefthand corner.
3467 You might try something like
3470 \begin_layout Standard
3479 includegraphics{logo.eps}}}
3482 \begin_layout Standard
3484 (you may need to preface this with
3485 \begin_inset Flex CharStyle:Code
3488 \begin_layout Plain Layout
3492 usepackage{graphics}
3497 if you don't include graphics elsewhere in your document).
3500 \begin_layout Section
3501 Itemize Bullet Selection
3502 \begin_inset CommandInset label
3511 \begin_layout Standard
3517 \begin_layout Subsection
3521 \begin_layout Standard
3522 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3523 Using this dialog you can easily specify what bullet shape to use at each
3524 level of an itemized list.
3525 These settings are document-wide so you won't be able to specify different
3526 sets of bullets for different paragraphs.
3530 \begin_layout Plain Layout
3531 Well, actually you can but you'll have to do it by hand.
3539 \begin_layout Subsection
3543 \begin_layout Standard
3544 Open the dialog by selecting the
3545 \begin_inset Flex CharStyle:MenuItem
3548 \begin_layout Plain Layout
3549 Document\SpecialChar \menuseparator
3555 menu item and then select the
3556 \begin_inset Flex CharStyle:MenuItem
3559 \begin_layout Plain Layout
3568 \begin_layout Standard
3569 The dialog provides you with a table of bullet shapes.
3570 A column of buttons on the left of the table provides access to the six
3571 different panels of bullet shapes.
3572 The row of buttons across the top is used to select which bullet depth
3574 A text entry under the table shows the currently selected bullet shape's
3575 LaTeX equivalent and this can be edited if desired.
3576 If you do modify the text you will also need to specify any needed packages
3577 in the LaTeX preamble.
3580 \begin_layout Standard
3581 The six panels are divided up by the packages they require.
3582 The following table shows the mappings from button name to LaTeX packages.
3585 \begin_layout Standard
3587 \begin_inset Tabular
3588 <lyxtabular version="3" rows="7" columns="2">
3589 <features tabularvalignment="middle">
3590 <column alignment="center" valignment="top" width="0pt">
3591 <column alignment="center" valignment="top" width="0pt">
3593 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3596 \begin_layout Plain Layout
3611 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3614 \begin_layout Plain Layout
3631 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3634 \begin_layout Plain Layout
3649 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3652 \begin_layout Plain Layout
3668 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3671 \begin_layout Plain Layout
3686 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3689 \begin_layout Plain Layout
3706 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3709 \begin_layout Plain Layout
3724 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3727 \begin_layout Plain Layout
3744 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3747 \begin_layout Plain Layout
3762 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3765 \begin_layout Plain Layout
3782 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3785 \begin_layout Plain Layout
3800 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3803 \begin_layout Plain Layout
3820 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3823 \begin_layout Plain Layout
3838 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3841 \begin_layout Plain Layout
3864 \begin_layout Standard
3865 LyX doesn't stop you using bullets from packages you don't have.
3866 If you get errors from LaTeX when you try to view or print the file, then
3867 it is likely you are missing a package.
3871 \begin_layout Plain Layout
3872 LyX doesn't restrict your use since you may be editing locally and exporting
3881 \begin_layout Subsection
3885 \begin_layout Standard
3886 Select which bullet depth you want to change then select the bullet shape
3888 Any changes will not be visible in LyX, but are visible when viewing the
3892 \begin_layout Standard
3893 You can reset a bullet shape to the default simply by clicking your right
3894 mouse button on the appropriate bullet depth button.
3898 \begin_layout Plain Layout
3903 want to have multiple sets of paragraphs with different sets of bullets
3904 in each, then you're going to have to get your hands dirty with TeX code.
3905 The bullet selection dialog can help though because it provides you with
3906 the LaTeX code for a wide range of bullet shapes.
3907 To make your own custom paragraphs you have the following options:
3910 \begin_layout Plain Layout
3914 \begin_layout Plain Layout
3930 \begin_layout Plain Layout
3934 \begin_layout Plain Layout
3956 \begin_layout Itemize
3957 Use the LaTeX command
3958 \begin_inset Flex CharStyle:Code
3961 \begin_layout Plain Layout
3969 to specify a new bullet shape for a given depth.
3970 You'll also need to save the current bullet shape so you can restore it
3972 In this itemized list the following LaTeX code was used to change the bullet
3973 used for the first depth.
3977 \begin_layout LyX-Code
3987 \begin_layout LyX-Code
4004 \begin_layout Itemize
4005 Note that the itemize depth is specified in Roman numerals as part of the
4015 \begin_layout Itemize
4019 \begin_layout Plain Layout
4032 Specify each individual entry by starting each item with the bullet shape
4033 enclosed in square brackets and set as
4034 \begin_inset Flex CharStyle:MenuItem
4037 \begin_layout Plain Layout
4044 For example, this item was started with
4045 \begin_inset Flex CharStyle:Code
4048 \begin_layout Plain Layout
4063 \begin_layout Plain Layout
4067 \begin_layout Plain Layout
4083 \begin_layout Plain Layout
4084 You'll also need to revert the labelitem back to its previous setting for
4085 the global bullet shape settings to remain in effect.
4086 The way used here was:
4089 \begin_layout LyX-Code
4104 \begin_layout Chapter
4108 \begin_layout Section
4112 \begin_layout Standard
4113 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
4114 and retrieve information about the LyX internal state.
4115 This is only intended for advanced users, but they should find it useful.
4116 It is by writing to the LyX server, for example, that bibliography managers,
4117 such as JabRef, are able to
4118 \begin_inset Quotes eld
4122 \begin_inset Quotes erd
4128 \begin_layout Standard
4129 Please note that, at present,
4131 the server does not work on Windows
4137 \begin_layout Plain Layout
4138 There is no reason it cannot do so.
4139 But none of the developers on Windows have yet implemented this functionality
4148 \begin_layout Section
4149 Starting the LyX Server
4152 \begin_layout Standard
4153 The LyX server works through the use of a pair of named pipes.
4154 These are usually located in
4155 \begin_inset Flex CharStyle:Code
4158 \begin_layout Plain Layout
4165 \begin_inset Quotes eld
4169 \begin_inset Flex CharStyle:Code
4172 \begin_layout Plain Layout
4179 \begin_inset Quotes erd
4183 \begin_inset Quotes eld
4187 \begin_inset Flex CharStyle:Code
4190 \begin_layout Plain Layout
4197 \begin_inset Quotes erd
4201 External programs write into
4202 \begin_inset Flex CharStyle:Code
4205 \begin_layout Plain Layout
4211 and read back data from
4212 \begin_inset Flex CharStyle:Code
4215 \begin_layout Plain Layout
4222 The stem of the pipe names can be defined in the
4223 \begin_inset Flex CharStyle:MenuItem
4226 \begin_layout Plain Layout
4227 Tools\SpecialChar \menuseparator
4234 \begin_inset Flex CharStyle:Code
4237 \begin_layout Plain Layout
4238 "/home/myhome/lyxpipe"
4248 configure this manually in order for the server to start.
4251 \begin_layout Standard
4253 \begin_inset Flex CharStyle:Code
4256 \begin_layout Plain Layout
4263 \begin_inset Flex CharStyle:Code
4266 \begin_layout Plain Layout
4272 ' to create the pipes.
4273 If one of the pipes already exists, LyX will assume that another LyX process
4274 is already running and will not start the server.
4275 If for some other reason, an unused
4276 \begin_inset Quotes eld
4280 \begin_inset Quotes erd
4283 pipe is left in existence when LyX closes, then LyX will try to delete
4285 If this fails for some reason, you will need to delete the pipes manually
4286 and then restart LyX.
4289 \begin_layout Standard
4290 To have several LyX processes with servers at the same time, you have to
4291 use different configurations, perhaps by using separate user directories,
4293 \begin_inset Flex CharStyle:Code
4296 \begin_layout Plain Layout
4302 file, for each process.
4305 \begin_layout Standard
4306 If you are developing a client program, you might find it useful to enable
4307 debugging information from the LyX server.
4308 Do this by starting LyX as
4309 \begin_inset Flex CharStyle:Code
4312 \begin_layout Plain Layout
4321 \begin_layout Standard
4322 You can find a complete example client written in C in the source distribution
4324 \begin_inset Flex CharStyle:Code
4327 \begin_layout Plain Layout
4328 development/lyxserver/server_monitor.c
4336 \begin_layout Standard
4337 Another useful tool is command-line based client you will find in
4338 \begin_inset Flex CharStyle:Code
4341 \begin_layout Plain Layout
4342 src/client/lyxclient
4350 \begin_layout Section
4351 Normal communication
4354 \begin_layout Standard
4355 To issue a LyX call, the client writes a line of ASCII text into the input
4357 This line has the following format:
4374 \begin_layout Description
4375 clientname is a name that the client can choose arbitrarily.
4376 Its only use is that LyX will echo it if it sends an answer—so a client
4377 can dispatch results from different requesters.
4380 \begin_layout Description
4381 function is the function you want LyX to perform.
4382 It is the same as the commands you'd use in the minibuffer.
4385 \begin_layout Description
4386 argument is an optional argument which is meaningful only to some functions
4388 \begin_inset Quotes eld
4392 \begin_inset Quotes erd
4395 LFUN will insert the argument as text at the cursor position).
4398 \begin_layout Standard
4399 The answer from LyX will arrive in the output pipe and be of the form
4416 \begin_layout Standard
4425 are just echoed from the command request, while
4429 is more or less useful information filled according to how the command
4430 execution worked out.
4431 Some commands, such as
4432 \begin_inset Quotes eld
4436 \begin_inset Quotes erd
4439 , will return information about the internal state of LyX, while other will
4440 return an empty data-response.
4441 This means that the command execution went fine.
4444 \begin_layout Standard
4445 In case of errors, the response from LyX will have this form
4462 \begin_layout Standard
4467 should contain an explanation of why the command failed.
4470 \begin_layout Standard
4474 \begin_layout LyX-Code
4475 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
4478 \begin_layout LyX-Code
4479 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
4480 \begin_inset Newline newline
4483 read a <~/.lyxpipe.out
4484 \begin_inset Newline newline
4490 \begin_layout Section
4494 \begin_layout Standard
4495 LyX can notify clients of events going on asynchronously.
4496 Currently it will only do this if the user binds a key sequence with the
4498 \begin_inset Quotes eld
4502 \begin_inset Quotes erd
4506 The format of the string LyX sends is as follows:
4510 \begin_inset Flex CharStyle:Code
4513 \begin_layout Plain Layout
4524 \begin_layout Standard
4529 is the printed representation of the key sequence that was actually typed
4533 \begin_layout Standard
4534 This mechanism can be used to extend LyX's command set and implement macros.
4535 Bind some key sequence to
4536 \begin_inset Quotes eld
4540 \begin_inset Quotes erd
4544 Then start a client that listens on the output pipe, dispatches the command
4545 according to the sequence, and starts a function that may use LyX calls
4546 and LyX requests to issue a command or a series of commands to LyX.
4549 \begin_layout Section
4550 The simple LyX Server Protocol
4553 \begin_layout Standard
4554 LyX implements a simple protocol that can be used for session management.
4555 All messages are of the form
4568 \begin_layout Standard
4574 \begin_inset Quotes eld
4578 \begin_inset Quotes erd
4582 \begin_inset Quotes eld
4586 \begin_inset Quotes erd
4591 \begin_inset Quotes eld
4595 \begin_inset Quotes erd
4598 is received from a client, LyX will report back to inform the client that
4599 it's listening to it's messages, while
4600 \begin_inset Quotes eld
4604 \begin_inset Quotes erd
4607 sent from LyX will inform clients that LyX is closing.
4610 \begin_layout Chapter
4611 Special Document Classes
4614 \begin_layout Section
4618 \begin_layout Standard
4624 \begin_layout Subsection
4628 \begin_layout Standard
4629 This section describes how LyX can be used to write articles for submission
4630 to the scientific journal
4632 Astronomy and Astrophysics
4634 (www.edpsciences.fr/aa/
4635 \begin_inset Flex URL
4638 \begin_layout Plain Layout
4640 http://www.edpsciences.fr/aa/
4645 ) using Version 5.01 of the document class
4650 This package can be downloaded from the ftp site
4653 \begin_layout Standard
4654 \begin_inset VSpace medskip
4660 \begin_layout Standard
4662 \begin_inset Flex URL
4665 \begin_layout Plain Layout
4667 ftp://ftp.edpsciences.org/pub/aa/readme.html
4675 \begin_layout Standard
4676 \begin_inset VSpace medskip
4682 \begin_layout Standard
4683 A manual comes together with that package, and this text is not meant to
4684 replace the original manual but merely a short guide how to realize the
4685 correct form of your paper.
4689 \begin_layout Standard
4690 Please note that the publisher of the journal was changed from Springer
4691 to EDP Sciences starting January 1, 2001.
4692 That change implicated also some slight changes of the style files, namely
4693 the removal of the thesaurus command.
4694 The LyX class aa supports the newest version of these style files, V 5.01.
4695 If you have an older version installed, please upgrade.
4696 For compatibility, the old (version 4) layout has been kept as
4701 Please refer to the comments in
4703 LyXDir/layouts/aapaper.layout
4708 \begin_layout Subsection
4712 \begin_layout Standard
4713 It is recommended you start from the example template distributed with LyX.
4714 If you are not using a template, note the following settings:
4717 \begin_layout Itemize
4724 Document\SpecialChar \menuseparator
4727 dialog (OK, that one was obvious).
4730 \begin_layout Itemize
4731 Don't change the option
4734 \begin_inset space ~
4744 The whole layout is done by the macros, you shouldn't change anything.
4747 \begin_layout Subsection
4751 \begin_layout Standard
4752 First thing to enter is the header information.
4753 It consists of seven entries, of which some are optional.
4757 \begin_layout Itemize
4765 \begin_layout Itemize
4773 \begin_layout Itemize
4781 \begin_layout Itemize
4789 \begin_layout Itemize
4794 : [optional] if more than one author: whom to contact for offprint requests.
4797 \begin_layout Itemize
4802 : [optional] mail address for contacts.
4805 \begin_layout Itemize
4813 Received: <date>; Accepted <date>
4816 \begin_layout Standard
4817 There is no need to issue the
4823 command, this is done automatically by LyX when the header is finished.
4824 Although the order of the single header entries doesn't matter it is advised
4825 to keep the above sequence, just to get the best optics and meets the layout
4826 of the real document.
4829 \begin_layout Standard
4830 If you want to place footnotes in the header block, e.
4831 \begin_inset space \thinspace{}
4835 \begin_inset space \space{}
4838 to state your present address, just use the standard footnote via the menu
4841 Insert\SpecialChar \menuseparator
4845 LyX will automagically use the term
4854 \begin_layout Standard
4855 In addition to these topics, the macros use three additional LaTeX commands
4856 that have no counterpart in LyX:
4859 \begin_layout Itemize
4866 to separate different names for more than one author and institute, respectivel
4870 \begin_layout Itemize
4877 to mark corresponding author/institute pairs.
4878 The institutes are numbered sequentially as they appear in the
4882 field, so you have to put a marker to each author.
4885 \begin_layout Itemize
4892 to supply an email address for fast contact.
4895 \begin_layout Standard
4896 In all cases, the appropriate command has to be entered in LyX and marked
4902 \begin_layout Subsection
4906 \begin_layout Standard
4907 The abstract should immediately follow the header block.
4908 With version 5 the abstract environment was changed to a command, and there
4909 is now a resctriction to only one paragraph.
4910 In addition, it should contain an entry with the keywords.
4911 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4918 by hand and mark it as LaTeX code.
4919 Refer to the example paper.
4922 \begin_layout Subsection
4923 Supported environments
4926 \begin_layout Standard
4927 The A&A paper layout supports the following environments for structuring
4931 \begin_layout Itemize
4937 \begin_layout Itemize
4943 \begin_layout Itemize
4949 \begin_layout Itemize
4955 \begin_layout Itemize
4961 \begin_layout Itemize
4967 \begin_layout Itemize
4973 \begin_layout Itemize
4979 \begin_layout Itemize
4985 \begin_layout Itemize
4991 \begin_layout Itemize
4997 \begin_layout Itemize
5003 \begin_layout Subsection
5004 Commands not supported by LyX
5007 \begin_layout Standard
5008 Some commands are not yet supported by the
5013 Some have already been mentioned.
5014 For the sake of completeness, they are listed all together here:
5017 \begin_layout Itemize
5025 \begin_layout Itemize
5033 \begin_layout Itemize
5041 \begin_layout Itemize
5049 \begin_layout Itemize
5057 \begin_layout Itemize
5065 \begin_layout Itemize
5073 \begin_layout Itemize
5081 \begin_layout Standard
5082 If you want to use any of these commands, you have to enter them yourself.
5085 Do not forget to mark them as LaTeX code!
5088 \begin_layout Subsection
5089 Figure and Table Floats
5092 \begin_layout Standard
5093 LyX provides support for the necessary float environments
5095 figure, figure*, table
5101 , therefore we won't tell much about it here.
5105 \begin_inset space ~
5111 Just remember that tables should be left-aligned.
5112 For that, select the table and change the alignment in
5114 Edit\SpecialChar \menuseparator
5116 \begin_inset space ~
5122 \begin_layout Standard
5123 There is only one special thing: the figures with caption besides the figure.
5124 To create such a figure, you have to do the following:
5127 \begin_layout Enumerate
5128 Create a wide figure float:
5130 Insert\SpecialChar \menuseparator
5131 Float\SpecialChar \menuseparator
5134 , then right click in the figure and select
5140 \begin_inset space ~
5148 \begin_layout Enumerate
5149 Enter your caption text.
5152 \begin_layout Enumerate
5157 to move the cursor above the caption.
5160 \begin_layout Enumerate
5164 \begin_layout Enumerate
5165 Position the cursor behind the figure and insert a horizontal fill:
5167 Insert\SpecialChar \menuseparator
5169 \begin_inset space ~
5172 Character\SpecialChar \menuseparator
5174 \begin_inset space ~
5182 \begin_layout Enumerate
5183 Switch to LaTeX mode:
5186 \begin_inset space ~
5194 \begin_layout Enumerate
5204 Do not close the brace!
5207 \begin_layout Enumerate
5208 Position the cursor behind the caption text, switch to LaTeX mode and insert
5212 \begin_inset space ~
5224 \begin_layout Standard
5225 Also, refer to the figures in the example paper.
5228 \begin_layout Subsection
5232 \begin_layout Standard
5233 For submission, the paper has to be formated in a special double-spacing
5235 For this purpose, you have to give the option
5239 to the documentclass.
5240 This must be done using the extra class options field in the
5242 Document\SpecialChar \menuseparator
5246 Just enter the string
5253 \begin_layout Subsection
5257 \begin_layout Standard
5262 directory contains an example paper written with LyX.
5263 It is the example paper from the original macro package, translated to
5265 Use it for inspiration, and compare the original LaTeX code with LyX way
5269 \begin_layout Section
5273 \begin_layout Standard
5279 \begin_layout Subsection
5283 \begin_layout Standard
5284 AASTeX is a set of macros produced by the American Astronomical Society
5285 to facilitate electronic manuscript submission to the three journals they
5286 publish: the Astrophysical Journal (including the Letters and Supplement),
5287 the Astronomical Journal, and the Publications of the Astronomical Society
5289 LyX has proven to be an excellent tool for generating these documents,
5290 especially given its equation, citation, and figure handling capabilities.
5291 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5292 is the version described here, or higher.
5293 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5294 incompatible with LyX.
5295 The AASTeX package may be downloaded from the AASTeX Web site
5298 \begin_layout Standard
5299 \begin_inset VSpace medskip
5305 \begin_layout Standard
5307 \begin_inset Flex URL
5310 \begin_layout Plain Layout
5312 http://www.journals.uchicago.edu/AAS/AASTeX
5320 \begin_layout Standard
5321 \begin_inset VSpace medskip
5327 \begin_layout Standard
5328 A complete user guide is contained in that package and you should familiarize
5329 yourself with it thoroughly before embarking on writing a paper in LyX.
5330 LyX will not reduce the need to figure out all the AASTeX commands, it
5331 will only reduce the drudgery of typing everything in.
5332 It is your responsibility to ensure that the final exported LaTeX document
5333 conforms completely to the requirements of the journal to which you are
5334 submitting your paper.
5337 \begin_layout Subsection
5338 Starting a New Paper
5341 \begin_layout Standard
5342 I strongly suggest that you start with the AASTeX template file.
5345 File\SpecialChar \menuseparator
5352 , enter the new file name, then choose the
5357 This will show the most common fields found in a manuscript.
5358 Simply overwrite the existing text (including the brackets,
5362 ) with the correct information.
5363 Many of the AASTeX commands and environments can be implemented directly
5364 in LyX, but some cannot: most noticeably
5376 , which should stick out like a sore thumb if you actually just opened the
5378 For commands such as these, the LaTeX code must be entered directly and
5380 Such commands are referred to as TeX code, or Evil Red Text.
5381 I tried to minimize the amount of TeX code needed in an AASTeX document,
5382 but there is still a bit more required than any of us would like.
5385 \begin_layout Subsection
5386 Finishing Your Paper
5389 \begin_layout Standard
5390 When the paper is finished to your satisfaction and previews/prints correctly,
5392 \begin_inset Quotes eld
5396 \begin_inset Quotes erd
5399 actions which need to be done before you submit it to the journals.
5403 \begin_layout Enumerate
5404 Export your paper as a LaTeX file (
5406 File\SpecialChar \menuseparator
5407 Export\SpecialChar \menuseparator
5414 \begin_layout Enumerate
5419 file with your favorite text editor
5423 \begin_layout Enumerate
5424 remove the comment lines before the
5433 \begin_layout Enumerate
5438 usepackage...{fontenc}
5440 line if it appears (usually just after
5455 \begin_layout Enumerate
5456 remove everything between (and including) the
5468 commands, except for any commands you specifically put into the LaTeX preamble
5469 (which should appear immediately after the
5470 \begin_inset Quotes eld
5473 User specified LaTeX commands
5474 \begin_inset Quotes erd
5485 \begin_layout Enumerate
5486 Run the resulting file through LaTeX to make sure it still processes correctly.
5489 \begin_layout Enumerate
5490 Reread the journal requirements to make sure your filenames and formats
5494 \begin_layout Enumerate
5498 \begin_layout Subsection
5499 Comments On Specific Commands
5502 \begin_layout Standard
5503 I will not describe the detailed usage of the individual AASTeX commands:
5504 the AASTeX User Guide (
5508 ) gives a good description of each.
5509 Thus it's probably easiest for me to go down the list as found in the guide
5510 and offer comments where necessary.
5511 So let's begin \SpecialChar \ldots{}
5515 \begin_layout Subsubsection
5516 Things that work as expected
5519 \begin_layout Standard
5523 \begin_layout Plain Layout
5535 \begin_layout Standard
5536 Because they work as you might expect, I simply list them and the section
5637 begin{thebibliography}
5645 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5646 graphicx figure commands (2.14.1),
5670 (2.15.4, amongst other places),
5697 \begin_layout Standard
5698 The following style options also work correctly:
5719 Simply put them in the
5725 Layout\SpecialChar \menuseparator
5731 \begin_layout Standard
5735 \begin_layout Plain Layout
5747 \begin_layout Subsubsection
5748 Things that work, but require more comment
5751 \begin_layout Standard
5752 The following items work, but require a little more discussion:
5755 \begin_layout Itemize
5756 These items are reserved for use by the journal editors, but you can put
5757 them into the LaTeX preamble if you feel compelled to do so:
5790 \begin_layout Itemize
5791 These items may be placed in the LaTeX preamble, and are included as blanks
5792 in the template file:
5813 \begin_layout Itemize
5820 (2.3) – can only be used
5821 \begin_inset Quotes eld
5825 \begin_inset Quotes erd
5828 , not in the middle of a paragraph.
5829 Use TeX code if you need to embed it.
5832 \begin_layout Itemize
5839 (2.3) – will have extra {} after it.
5840 This should not cause an error.
5843 \begin_layout Itemize
5850 (2.6) – can only be used
5851 \begin_inset Quotes eld
5855 \begin_inset Quotes erd
5858 , not in the middle of a paragraph.
5859 Use TeX code if you need to embed it.
5862 \begin_layout Itemize
5869 (2.8) – can't insert a cross-reference tag, you must type the tag name by
5873 \begin_layout Itemize
5887 \begin_layout Itemize
5894 (2.9) – will have extra {} after it.
5895 This should not cause an error.
5898 \begin_layout Itemize
5905 (2.11) – will have extra {} after it.
5906 This should not cause an error.
5909 \begin_layout Itemize
5916 (2.14.2) – you can insert an optional filename argument by placing the cursor
5917 at the beginning of the text and selecting
5919 Insert\SpecialChar \menuseparator
5924 \begin_inset Quotes eld
5928 \begin_inset Quotes erd
5931 inserts an optional argument of the type needed by
5938 Hopefully it will be renamed someday.
5941 \begin_layout Itemize
5954 for the catalog ID optional parameter
5957 \begin_layout Itemize
5970 for the catalog ID optional parameter
5973 \begin_layout Subsubsection
5974 Things not implemented, use TeX code
5977 \begin_layout Standard
5981 \begin_layout Plain Layout
5993 \begin_layout Standard
6016 setcounter{equation}
6018 (2.12), Journal name abbreviations (2.13.4),
6054 (2.15.4, insert it as the first element in the lefthand cell after where
6056 Don't use any of LyX's rules in the table),
6068 (2.15.5), much of Misc (2.17, except
6119 \begin_layout Standard
6123 \begin_layout Plain Layout
6135 \begin_layout Subsubsection
6136 Things that cannot be implemented
6139 \begin_layout Standard
6140 \SpecialChar \ldots{}
6141 at least in any meaningful sort of way, so I suggest ignoring them.
6142 They are the references environment (2.13.3), and the deluxetable environment
6144 If you really, really need to use deluxetable, I suggest editing it in
6145 a separate file with a text editor, then using
6147 Insert\SpecialChar \menuseparator
6149 \begin_inset space ~
6154 to include it in your LyX document.
6159 file to see an example of this.
6162 \begin_layout Subsection
6163 FAQs, Tips, Tricks, and Other Ruminations
6166 \begin_layout Subsubsection
6167 Getting LyX and AASTeX to cooperate
6170 \begin_layout Standard
6171 It can be a bit tricky to get LyX to recognize a new layout and document
6173 When all else fails, do this:
6176 \begin_layout Enumerate
6177 Make certain that LaTeX can find AASTeX.
6178 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6179 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6186 \begin_layout Enumerate
6198 \begin_layout Enumerate
6201 Tools\SpecialChar \menuseparator
6204 in LyX, then restart LyX.
6207 \begin_layout Enumerate
6208 Open a regular new file, not from a template.
6209 Does AASTeX appear in the class list in
6211 Document\SpecialChar \menuseparator
6217 \begin_layout Standard
6218 If you get a warning from an existing AASTeX document about not being able
6219 to find the AASTeX layout or a message about
6220 \begin_inset Quotes eld
6223 You should not mix title layouts with normal ones
6224 \begin_inset Quotes erd
6227 , things haven't been installed correctly.
6230 \begin_layout Subsubsection
6231 LaTeX error processing a table
6234 \begin_layout Standard
6235 LyX, by default, attempts to center the table caption/title.
6236 This seems to produce a bad interaction in AASTeX so you should click somewhere
6237 in the caption/title, then select
6239 Edit\SpecialChar \menuseparator
6241 \begin_inset space ~
6255 This took care of it for me.
6258 \begin_layout Subsubsection
6262 \begin_layout Standard
6263 A couple of things: 1) I have noticed some funny spacing in the reference
6264 entries in the text.
6265 When you enter the bibliography item data, make sure their is
6269 space between the last author and the parenthesis setting off the year;
6273 \begin_inset space \thinspace{}
6277 \begin_inset space \space{}
6291 2) Entering the references at all is not obvious.
6292 The easiest thing is to start typing your first reference at the end of
6293 the document, then mark it as type
6298 That will put a small gray box in front of what you just typed.
6299 Click on the box to fill in the rest of the information.
6300 For new references, go to the end of an existing reference and press return.
6301 That will create a new line with its own box, etc.
6304 \begin_layout Subsubsection
6308 \begin_layout Standard
6309 Even though AASTeX provides its own figure commands (
6315 , for example), I much prefer LaTeX's standard figure commands (with the
6324 \begin_inset space ~
6327 commands as TeX code into a Figure Float box if you desire, but I never
6328 have much luck getting the layout right.
6329 With the standard graphics, LyX will insert a
6333 usepackage{graphicx}
6335 command into the LaTeX preamble and handle the figures in the standard
6336 LaTeX2e way, interspersing the figures in the text.
6337 I believe ApJ accepts figures exactly this way now; AJ might still use
6339 \begin_inset Quotes eld
6342 stack everything at the end
6343 \begin_inset Quotes erd
6349 \begin_layout Subsubsection
6350 Things I could have done, but didn't
6353 \begin_layout Standard
6355 \begin_inset Quotes eld
6359 \begin_inset Quotes erd
6362 things I could have implemented, but chose not to.
6363 For instance, I saw no point in double-spacing the text in the LyX window,
6364 even though it is double-spaced in the paper manuscript.
6365 Also, I chose not to make separate layouts for the preprint and preprint2
6367 Since I assume you will spend most of your time in the plain manuscript
6368 mode anyway, I decided not to chew up more disk space with this.
6372 \begin_layout Subsection
6376 \begin_layout Standard
6377 Your mileage may vary.
6378 I've now had papers published by both ApJ and AJ that have had 98% of the
6379 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6381 I have had no trouble with the submission process, and I'm sure the journals
6382 were never aware that there might be a difference.
6383 So, go forth and publish!
6386 \begin_layout Section
6390 \begin_layout Standard
6393 David Johnson; updated by Richard Heck
6396 \begin_layout Standard
6397 \begin_inset VSpace bigskip
6403 \begin_layout Standard
6405 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
6406 papers to be submitted to American Mathematical Society publications.
6407 The layouts are not tailored to a specific journal, but easily can be.
6408 You should refer to the AMS documentation for specific instructions for
6409 each journal (usually it will entail only changing a single line in the
6411 That documentation is available on the Web at
6412 \begin_inset Flex URL
6415 \begin_layout Plain Layout
6423 \begin_inset Flex URL
6426 \begin_layout Plain Layout
6428 ftp://ftp.ams.org/pub/tex/amslatex/
6434 These layouts are appropriate, and useful, for any mathematical writing.
6438 \begin_layout Standard
6439 There are two basic AMS LaTeX layouts:
6442 \begin_layout Itemize
6443 amsart: The standard AMS article format.
6446 \begin_layout Itemize
6447 amsbook: the standard AMS book (really, monograph) format.
6451 \begin_layout Standard
6452 The layouts themselves contain only the minimum necessary to use the AMS
6454 They do not, in particular, contain any of the `theorem' environments used
6455 for setting theorems, lemmas, and the like.
6456 These are contained, instead, in the
6457 \begin_inset Flex CharStyle:Code
6460 \begin_layout Plain Layout
6466 module, which is loaded by default when when you select one of the AMS
6468 (It can also be used with other classes and can be removed, if you would
6469 rather use something else.) Less commonly used environments are in the
6470 \begin_inset Flex CharStyle:Code
6473 \begin_layout Plain Layout
6474 Theorems (AMS-Extended)
6479 module, which must be loaded manually.
6482 \begin_layout Standard
6483 By default, theorems and the like are numbered consecutively throughout
6484 the document, but this may be modified by loading the module
6485 \begin_inset Flex CharStyle:Code
6488 \begin_layout Plain Layout
6489 Theorems (Order by Section)
6494 or, if you are using
6495 \begin_inset Flex CharStyle:Code
6498 \begin_layout Plain Layout
6505 \begin_inset Flex CharStyle:Code
6508 \begin_layout Plain Layout
6509 Theorems (Order by Chapter)
6515 These will number the results as
6516 \begin_inset Formula $n.m$
6519 , where the first number refers to the section (or chapter) and the second
6520 refers to the total number of results so far in that section (or chapter).
6521 Many environments are also available unnumbered.
6522 These are indicated by an asterisk at the end.
6523 If you happen to want
6527 unnumbered results, the the module
6528 \begin_inset Flex CharStyle:Code
6531 \begin_layout Plain Layout
6537 provides that option.
6540 \begin_layout Standard
6541 Note that these modules do not
6545 to be used with the AMS classes.
6546 It is perfectly possible to use the
6547 \begin_inset Flex CharStyle:Code
6550 \begin_layout Plain Layout
6556 module, and the others mentioned, with other classes, such as
6557 \begin_inset Flex CharStyle:Code
6560 \begin_layout Plain Layout
6567 \begin_inset Flex CharStyle:Code
6570 \begin_layout Plain Layout
6577 \begin_inset Flex CharStyle:Code
6580 \begin_layout Plain Layout
6589 \begin_layout Subsection
6590 What these layouts provide
6593 \begin_layout Standard
6594 There is a long list of included environments provided by these layouts.
6595 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
6596 variety of `theorem' environments.
6597 However, the AMS recommends the environments that are available in LyX.
6601 \begin_layout Standard
6602 The following environments—as well as the standard environments, such as
6604 \begin_inset Flex CharStyle:Noun
6607 \begin_layout Plain Layout
6614 \begin_inset Flex CharStyle:Noun
6617 \begin_layout Plain Layout
6624 \begin_inset Flex CharStyle:Noun
6627 \begin_layout Plain Layout
6634 \begin_inset Flex CharStyle:Noun
6637 \begin_layout Plain Layout
6644 \begin_inset Flex CharStyle:Noun
6647 \begin_layout Plain Layout
6654 \begin_inset Flex CharStyle:Code
6657 \begin_layout Plain Layout
6664 \begin_inset Flex CharStyle:Code
6667 \begin_layout Plain Layout
6676 \begin_layout Description
6677 Address This should be the author's permanent address.
6680 \begin_layout Description
6682 \begin_inset space ~
6685 Address This should be the author's temporary address at the time of submission,
6686 if different from the Address.
6689 \begin_layout Description
6690 Email Author's e-mail address
6693 \begin_layout Description
6694 URL Author's Web address, if desired.
6697 \begin_layout Description
6698 Keywords Key words or phrases used to identify specific topics discussed
6702 \begin_layout Description
6703 Subjectclass These refer to the AMS Subject Classifications, published and
6706 Mathematical Reviews
6709 These are also available online at the AMS cites listed above.
6712 \begin_layout Description
6716 \begin_layout Description
6720 \begin_layout Description
6724 \begin_layout Standard
6725 The following environments are provided by both the
6726 \begin_inset Flex CharStyle:Code
6729 \begin_layout Plain Layout
6736 \begin_inset Flex CharStyle:Code
6739 \begin_layout Plain Layout
6745 modules, in the latter case in both starred (unnumbered) and unstarred
6746 (numbered) versions.
6747 These same environments are provided only in the starred versions by the
6749 \begin_inset Flex CharStyle:Code
6752 \begin_layout Plain Layout
6761 \begin_layout Theorem
6762 This is typically used for the statements of major results.
6766 \begin_layout Corollary*
6767 This is used for statements which follow fairly directly from previous statement
6769 Again, these can be major results.
6774 These are smaller results needed to prove other statements.
6777 \begin_layout Proposition
6778 These are less major results which (hopefully) add to the general theory
6782 \begin_layout Conjecture
6783 These are statements provided without justification, which the author does
6784 not know how to prove, but which seem to be true (to the author, at least).
6787 \begin_layout Definition*
6788 Guess what this is for.
6789 The font is different for this environment than for the previous ones.
6793 \begin_layout Example*
6794 Used for examples illustrating proven results.
6797 \begin_layout Problem
6798 It's not really known what this is for.
6799 You should figure it out.
6802 \begin_layout Exercise*
6803 Write a description for this one.
6806 \begin_layout Remark
6807 This environment is also a type of theorem, usually a lesser sort of observation.
6810 \begin_layout Claim*
6811 Often used in the course of giving a proof of a larger result.
6815 Generally, these are used to break up long arguments, using specific instances
6821 The numbering scheme for cases is on its own, not together with other numbered
6827 At the end of this environment, a QED symbol (usually a square, but it can
6828 vary with different styles) is placed.
6829 If you want to have other environments within this one—for example, Case
6830 environments—and have the QED symbol appear only after them, then the other
6831 environments need to be nested within the proof environment.
6834 Nesting Environments
6840 for information on nesting.
6843 \begin_layout Standard
6844 And these environments are provided by
6845 \begin_inset Flex CharStyle:Code
6848 \begin_layout Plain Layout
6849 Theorems (AMS-Extended)
6857 \begin_layout Criterion*
6858 A required condition.
6861 \begin_layout Algorithm*
6862 A general procedure to be used.
6865 \begin_layout Axiom*
6866 This is a property or statement taken as true within the system being discussed.
6869 \begin_layout Condition*
6870 Sometimes used to state a condition assumed within the present context of
6875 Similar to a Remark.
6878 \begin_layout Notation*
6879 Used for the explanation of, yes, notation.
6882 \begin_layout Summary
6883 Do we really need to tell you?
6886 \begin_layout Acknowledgement*
6890 \begin_layout Conclusion*
6891 Sometimes used at the end of a long train of argument.
6895 Used in a way similar to Proposition, though perhaps lower on the scale.
6898 \begin_layout Standard
6899 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
6901 They need to be available on your system in order to use these environments.
6904 \begin_layout Section
6912 \begin_layout Standard
6918 \begin_layout Subsection
6922 \begin_layout Standard
6923 These are the layout files for some of the journals of the American Geophysical
6925 It is assumed that you have both the AGU's own class files and AGUplus
6926 installed (everything to be found at
6927 \begin_inset Flex URL
6930 \begin_layout Plain Layout
6932 ftp://ftp.agu.org/journals/latex/journals
6940 \begin_layout Subsection
6944 \begin_layout Standard
6954 They are still called this in the LyX GUI, though their LaTeX equivalents
6955 in the AGU classes are
6966 \begin_layout Standard
6967 Newly defined styles are
7004 These are mostly manuscript attributes and defined in the AGU class documentati
7008 \begin_layout Standard
7009 I suspect this is still badly incomplete.
7012 \begin_layout Subsection
7016 \begin_layout Standard
7033 \begin_layout Subsection
7037 \begin_layout Itemize
7040 Journal of Geophysical Research
7049 \begin_layout Standard
7050 Add your own, it isn't so hard! Look at the
7061 \begin_layout Subsection
7062 Bugs and things to remember
7065 \begin_layout Standard
7066 In order to use the new layouts, you must remember to do the following for
7070 \begin_layout Enumerate
7076 This can be done in the
7078 Layout\SpecialChar \menuseparator
7083 Document\SpecialChar \menuseparator
7087 (AGU articles are always in English, right? So
7094 \begin_layout Enumerate
7104 (Yes, this is a bug.)
7107 \begin_layout Enumerate
7108 Make sure you use the
7112 bibliography style, by entering
7116 into the second field of the BibTeX inset.
7117 None of the standard styles will do.
7120 \begin_layout Section
7124 \begin_layout Standard
7130 \begin_layout Subsection
7134 \begin_layout Standard
7135 Broadway is for writing plays.
7136 The format is more decorative than Hollywood, and much less standardized.
7137 This format should be suitable for workshops.
7140 \begin_layout Subsection
7144 \begin_layout Standard
7145 The same as in Hollywood.
7148 \begin_layout Subsection
7152 \begin_layout Standard
7157 names as labels then cross-reference the label to insert the name.
7158 The cross-reference dialog will show the current cast of characters.
7161 \begin_layout Subsection
7162 Paper size and Margins
7165 \begin_layout Standard
7166 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
7169 \begin_layout Subsection
7173 \begin_layout Standard
7174 The following environments are available.
7175 You can use broadway.bind to get the bind keys shown at the right.
7178 \begin_layout Itemize
7182 \begin_inset Newline newline
7187 You should not have to use this, but it is here for anything that does not
7191 \begin_layout Itemize
7195 \begin_inset space \hfill{}
7199 \begin_inset Newline newline
7204 Used to describe stage setting and the action.
7205 First use of speaker names in all CAPs.
7208 \begin_layout Itemize
7212 \begin_inset space \hfill{}
7216 \begin_inset Newline newline
7221 Automatically numbered.
7222 On screen it will be arabic, but will print as Roman.
7225 \begin_layout Itemize
7229 \begin_inset space \hfill{}
7233 \begin_inset Newline newline
7243 It is just centered text.
7246 \begin_layout Itemize
7250 \begin_inset space \hfill{}
7254 \begin_inset Newline newline
7259 Not automatically numbered.
7260 You supply the number.
7261 This is because I couldn't figure out how.
7264 \begin_layout Itemize
7268 \begin_inset space \hfill{}
7272 \begin_inset Newline newline
7277 A special case of Narrative to describe the setting and action as the curtain
7281 \begin_layout Itemize
7285 \begin_inset space \hfill{}
7289 \begin_inset Newline newline
7294 The speaker's (actor's) title, centered in all CAPS.
7297 \begin_layout Itemize
7301 \begin_inset space \hfill{}
7305 \begin_inset Newline newline
7310 Instructions to the speaker.
7311 The parentheses are automatically inserted.
7312 The ( will appear on screen, but both will be in the printed play.
7313 This environment is only used within
7320 \begin_layout Itemize
7324 \begin_inset space \hfill{}
7328 \begin_inset Newline newline
7333 What the Speaker says.
7336 \begin_layout Itemize
7340 \begin_inset space \hfill{}
7344 \begin_inset Newline newline
7349 The curtain comes down.
7352 \begin_layout Itemize
7356 \begin_inset space \hfill{}
7362 \begin_layout Itemize
7366 \begin_inset space \hfill{}
7372 \begin_layout Itemize
7376 \begin_inset space \hfill{}
7382 \begin_layout Standard
7386 \begin_layout Section
7390 \begin_layout Standard
7395 can be used to type letters according to German conventions.
7396 A template file is included in
7398 .../lyx/share/templates
7400 for you to use as a starting point.
7403 \begin_layout Section
7411 \begin_layout Standard
7417 \begin_layout Subsection
7421 \begin_layout Standard
7422 This is the layout file for the European Geophysical Society journals.
7427 can be downloaded from the web site of the EGS under
7428 \begin_inset Flex URL
7431 \begin_layout Plain Layout
7441 \begin_layout Subsection
7445 \begin_layout Standard
7448 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
7456 The current layout file is unfortunately very unmodular and would benefit
7457 from using the various
7464 \begin_layout Section
7468 \begin_layout Standard
7474 \begin_layout Standard
7475 Elsevier Science Publishers B.V.
7476 provides a standard LaTeX document class (
7480 ) for submitting articles to their various journals.
7481 The style file can be downloaded directly from their web site:
7482 \begin_inset Flex URL
7485 \begin_layout Plain Layout
7487 http://authors.elsevier.com/
7493 Instructions are supplied along with the class file, which details the
7494 requirements of the publishers.
7495 LyX includes package that allows for the use of this class, by a layout
7496 and a template file.
7497 Installation of the class file is the same as for any other LaTeX package;
7498 instructions are provided in the Elsevier documentation.
7501 \begin_layout Standard
7511 As the Elsevier class file is based mainly on the standard article class,
7512 most of the normal functionality is provided.
7513 The Elsevier class defines a number of mathematical environments, which
7514 are similar to the AMS environments.
7515 These commands are all described in the Elsevier documentation, and are
7519 \begin_layout Standard
7520 The easiest way to use the Elsevier style is to base documents on the included
7522 It is best not to use options such as fancy headings or the geometry package,
7523 as elements such as these are defined by Elsevier in their style file.
7524 Ideally, no extra packages except those mentioned in the Elsevier documentation
7526 Essentially, Elsevier require as
7527 \begin_inset Quotes eld
7531 \begin_inset Quotes erd
7534 a LaTeX file as possible, as their intention is to take the supplied file
7535 and replace the class file with one for the particular journal to which
7536 the paper has been submitted.
7537 This also means that not too much time should be spent on the formating
7539 When it comes to be published, this will change anyway.
7540 The rest of the usage for this layout is substantially the same as for
7541 the normal article class.
7542 For details of what Elsevier do and don't allow, refer to their documentation.
7545 \begin_layout Section
7554 \begin_inset CommandInset label
7563 \begin_layout Standard
7569 \begin_layout Subsection
7573 \begin_layout Standard
7574 This section describes how to use LyX to make slides for overhead projectors.
7575 There are two document classes that can do this: the default slides class
7581 This section documents the latter.
7584 \begin_layout Standard
7585 I'm going to say this again, nice and clear, so that there's no misunderstanding
7589 \begin_layout Standard
7590 \begin_inset VSpace bigskip
7596 \begin_layout Standard
7600 This section documents the class
7601 \begin_inset Quotes eld
7609 \begin_inset Quotes erd
7617 \begin_layout Standard
7618 \begin_inset VSpace bigskip
7624 \begin_layout Standard
7625 If you're looking for the documentation for
7626 \begin_inset Quotes eld
7634 \begin_inset Quotes erd
7638 \begin_inset space ~
7642 \begin_inset CommandInset ref
7644 reference "sec:slitex"
7649 If your machine doesn't have the
7654 \begin_inset Quotes eld
7662 \begin_inset Quotes erd
7665 ] installed, you'll probably have to use the default
7669 class, which isn't quite as good as
7674 \begin_layout Standard
7679 class is designed for use with version 2.1 of the
7683 LaTeX class file which is now an integral part of LaTeX2e.
7686 \begin_layout Subsection
7690 \begin_layout Standard
7691 Obviously, to use this document class, you need to select
7692 \begin_inset Quotes eld
7700 \begin_inset Quotes erd
7710 \begin_inset space ~
7716 There are some settings in the
7719 \begin_inset space ~
7724 dialog that you should know about that are specific to this class:
7727 \begin_layout Itemize
7728 Don't change the options
7739 \begin_inset space ~
7745 They're ignored by the
7752 \begin_layout Itemize
7753 The default font size is 20
7754 \begin_inset space \thinspace{}
7757 pt with the other options being 17
7758 \begin_inset space \thinspace{}
7762 \begin_inset space \thinspace{}
7766 \begin_inset space \thinspace{}
7772 \begin_layout Itemize
7781 but all math equations are still typeset in the usual roman font.
7784 \begin_layout Itemize
7789 TeX supports A4 and Letter paper sizes as well as a special size for working
7791 \begin_inset space \thinspace{}
7795 It doesn't support A5, B5, legal or executive paper sizes.
7798 \begin_layout Itemize
7799 Don't bother changing the
7803 settings because they are ignored anyway.
7804 All floats appear where they are defined in the text.
7807 \begin_layout Itemize
7812 setting behaves a bit differently for this class.
7817 TeX provides extensive footer and header capabilities including a user-defined
7820 \begin_inset space ~
7824 \begin_inset CommandInset ref
7826 reference "sec:foilfoot"
7831 The title page is treated differently to all other pages in the document
7840 has the logo centered at the bottom of the page (if one is defined).
7841 The possible page style choices and what they do are as follows:
7845 \begin_layout Labeling
7846 \labelwidthstring MMMMMMM
7853 The final output contains no page numbers, or other headers or footers
7854 (except footnotes of course).
7858 \begin_layout Labeling
7859 \labelwidthstring MMMMMMM
7866 The final output contains page numbers centered at the bottom of the page.
7867 No other headings or footers (other than footnotes).
7870 \begin_layout Labeling
7871 \labelwidthstring MMMMMMM
7876 Page numbers in lower right corner.
7877 Additional headers and footers are also shown.
7878 This is also the default.
7881 \begin_layout Labeling
7882 \labelwidthstring MMMMMMM
7887 Gives you access to the
7891 package although its use with
7895 TeX is discouraged by the writer of the
7899 TeX package because of some potential page layout clashes.
7903 \begin_layout Subsubsection
7907 \begin_layout Standard
7908 The following options may be used in the extra class options in the
7910 Document\SpecialChar \menuseparator
7916 \begin_layout Labeling
7917 \labelwidthstring MMMMMMx
7922 This sets up the page layout for 7.33
7923 \begin_inset space \thinspace{}
7927 \begin_inset space \thinspace{}
7930 in paper, which is about the same aspect ratio as a 35
7931 \begin_inset space \thinspace{}
7934 mm slide, making it a bit easier to work with this medium.
7937 \begin_layout Labeling
7938 \labelwidthstring MMMMMMx
7943 Places a rule across the page below the header on every page except the
7947 \begin_layout Labeling
7948 \labelwidthstring MMMMMMx
7953 Places a rule across the page above the footer on every page except the
7957 \begin_layout Labeling
7958 \labelwidthstring MMMMMMx
7963 This is automatically set each time you create a new
7972 TeX to use the dvips driver to rotate those pages that are set as landscape
7976 \begin_layout Labeling
7977 \labelwidthstring MMMMMMx
7982 Simply changes the page dimensions to those of a landscape page but doesn't
7984 Thus if you use this option you need to use an external program to rotate
7985 each page or feed your paper through your printer as landscape.
7986 Note that this option effectively reverses the roles of the
7994 environments (don't worry these are described in the next section).
7997 \begin_layout Labeling
7998 \labelwidthstring MMMMMMx
8003 Equation numbers on the left.
8006 \begin_layout Labeling
8007 \labelwidthstring MMMMMMx
8012 Flush-left equations.
8015 \begin_layout Subsection
8016 Supported Environments
8019 \begin_layout Standard
8020 Most of the environments commonly supported in other classes are also supported
8026 There are several additional environments provided by
8030 TeX as well as a couple added by LyX.
8031 The following environments are shared with other classes:
8034 \begin_layout Standard
8038 \begin_layout Plain Layout
8050 \begin_layout Itemize
8056 \begin_layout Itemize
8062 \begin_layout Itemize
8068 \begin_layout Itemize
8074 \begin_layout Itemize
8080 \begin_layout Itemize
8086 \begin_layout Itemize
8092 \begin_layout Itemize
8098 \begin_layout Itemize
8104 \begin_layout Itemize
8110 \begin_layout Itemize
8116 \begin_layout Itemize
8122 \begin_layout Itemize
8128 \begin_layout Itemize
8134 \begin_layout Itemize
8140 \begin_layout Itemize
8146 \begin_layout Itemize
8152 \begin_layout Itemize
8158 \begin_layout Standard
8162 \begin_layout Plain Layout
8174 \begin_layout Standard
8175 That is, all the major environments apart from the sectioning environments.
8176 Since foils are essentially self-contained sections, with a title and body,
8181 TeX provides specific commands for starting new foils and these are:
8184 \begin_layout Itemize
8190 \begin_layout Itemize
8196 \begin_layout Standard
8197 LyX also provides slightly modified versions of these two environments called:
8200 \begin_layout Itemize
8206 \begin_layout Itemize
8212 \begin_layout Standard
8213 and the differences will be explained in the next section.
8216 \begin_layout Standard
8217 Since foils are often used in presenting ideas or new theorems and such
8222 TeX also provides a comprehensive box of goodies for presenting them:
8225 \begin_layout Standard
8229 \begin_layout Plain Layout
8241 \begin_layout Itemize
8247 \begin_layout Itemize
8253 \begin_layout Itemize
8259 \begin_layout Itemize
8265 \begin_layout Itemize
8271 \begin_layout Itemize
8277 \begin_layout Itemize
8283 \begin_layout Itemize
8289 \begin_layout Itemize
8295 \begin_layout Itemize
8301 \begin_layout Itemize
8307 \begin_layout Standard
8311 \begin_layout Plain Layout
8323 \begin_layout Standard
8324 The starred versions are unnumbered while the unstarred versions are numbered.
8325 There are also two list environments added by LyX and these are:
8328 \begin_layout Itemize
8334 \begin_layout Itemize
8340 \begin_layout Standard
8345 TeX provides some powerful header and footer capabilities that are best
8346 set in the preamble although they may be set at any point in a document.
8347 If you want to change these settings in your document the best place to
8348 do so is at the very top of a foil, i.
8349 \begin_inset space \thinspace{}
8355 \begin_inset space \space{}
8360 straight after the foilhead.
8363 \begin_layout Standard
8364 For this purpose, the following command styles are provided [
8371 \begin_layout Standard
8375 \begin_layout Plain Layout
8387 \begin_layout Itemize
8391 \begin_inset space ~
8397 \begin_layout Itemize
8403 \begin_layout Itemize
8407 \begin_inset space ~
8413 \begin_layout Itemize
8417 \begin_inset space ~
8423 \begin_layout Itemize
8427 \begin_inset space ~
8434 \begin_layout Standard
8435 \begin_inset space ~
8442 \begin_layout Standard
8446 \begin_layout Plain Layout
8458 \begin_layout Standard
8459 There are also a few commands provided by
8463 TeX that aren't directly supported by LyX but I'll tell you what they do
8464 and how to use them in section
8465 \begin_inset space ~
8469 \begin_inset CommandInset ref
8471 reference "sec:unsuppfoils"
8478 \begin_layout Subsection
8479 Building a Set of Foils
8482 \begin_layout Standard
8483 This section will give a simple introduction to using the different environments
8484 to build a set of foils.
8485 If you want to see an example set of foils, take a look at the
8489 file you find in LyX's
8496 \begin_layout Subsubsection
8497 Give It a Title Page
8500 \begin_layout Standard
8501 Unlike other classes that provide
8521 creates the title on a page of its own.
8522 If you leave out the
8526 environment LaTeX will substitute the current date (every time you regenerate
8530 \begin_layout Subsubsection
8534 \begin_layout Standard
8535 As I mentioned earlier, there are four ways of starting a new foil.
8536 For portrait foils you should use
8545 The difference between these two environments is the amount of space between
8546 the title of the foil (the foilhead) and the body of the foil.
8549 \begin_layout Standard
8550 Landscape foils are generated using the
8559 Again the only difference is the spacing between foilhead and body.
8560 Both of the short versions have 0.5 inches less separation between the foilhead
8565 \begin_layout Standard
8566 One problem with the support for landscape foils is the requirement that
8571 driver to generate the PostScript output otherwise the foils won't be rotated.
8572 It is possible to get landscape foils even if you haven't got the
8576 driver provided you can feed your foils sideways through your printer ;-)
8579 \begin_layout Subsubsection
8580 Theorems, Lemmas, Proofs and more
8583 \begin_layout Standard
8584 Due to a small bug in LyX you can't have two of the same type of these environme
8585 nts directly following each other.
8586 They must be separated by something.
8587 If you try, you will just be extending the previous environment as if you
8588 had merged the two environments together.
8589 So, how do you get around this problem? The simplest option is to insert
8590 some text between the two environments or add a
8594 environment between the two with just a
8595 \begin_inset Quotes eld
8603 \begin_inset Quotes erd
8607 This will force LyX to produce two separate environments and hence the
8608 correct LaTeX output.
8609 An example is provided in the example file included with the LyX distribution.
8610 Remember, this problem only occurs if you are trying to place two of the
8611 same type of theorem-like environments one directly after the other.
8614 \begin_layout Subsubsection
8618 \begin_layout Standard
8619 You get all the commonly supported list styles found in other classes as
8620 well as two new ones.
8621 I'll only describe the new ones here.
8622 If you want to find out more about the other list environments check out
8628 If you intend to use itemized lists you might also want to read about the
8632 \begin_inset space ~
8636 \begin_inset space ~
8641 dialog described above in section
8642 \begin_inset space ~
8646 \begin_inset CommandInset ref
8648 reference "sec:bullet"
8655 \begin_layout Standard
8656 The two new list styles,
8664 , are designed to make it easier for you to create lists of do's and don'ts
8665 or right and wrong by providing dedicated environments that use a tick
8666 or a cross as the label of the list.
8667 These lists are in fact dedicated variants of the
8672 They do however require that you have the
8679 \begin_layout Subsubsection
8683 \begin_layout Standard
8688 TeX redefines the floating tables and figures so that they appear exactly
8689 where they are in the text rather than pushing them to the top of the page
8690 or to some user specified location.
8691 In fact if you change the float placement settings they are simply ignored.
8694 \begin_layout Subsubsection
8695 Page Headers and Footers
8696 \begin_inset CommandInset label
8705 \begin_layout Standard
8709 \begin_inset space ~
8718 are two commands used to control the left-footer text string.
8719 The first is meant to allow you to include a graphic logo on your foils
8721 \begin_inset Quotes eld
8729 \begin_inset Quotes erd
8733 While the second is meant to provide a classification for the audience,
8737 \begin_inset space \thinspace{}
8743 \begin_inset space \space{}
8747 It is empty by default.
8750 \begin_layout Standard
8751 The remaining page corners can be filled by
8754 \begin_inset space ~
8759 (which defaults to page numbers),
8762 \begin_inset space ~
8770 \begin_inset space ~
8778 \begin_layout Subsection
8784 \begin_inset CommandInset label
8786 name "sec:unsuppfoils"
8793 \begin_layout Standard
8794 All the commands mentioned below need to be set in a
8802 within another environment.
8805 \begin_layout Subsubsection
8809 \begin_layout Standard
8810 All lengths are adjusted using the
8833 should be replaced by the name given to the length you want to change and
8838 is the length value.
8839 All lengths should be specified in units of length such as inches (
8851 ) or relative to some document or font-based length such as
8861 \begin_layout Standard
8862 It's possible to change the spacing between a foilhead and the body of the
8863 foil by adjusting the length specified by
8870 For example, to make
8875 \begin_inset space \space{}
8878 in closer to their bodies put the following in the preamble:
8884 foilheadskip}{-0.5in}
8887 \begin_layout Standard
8888 The spacings around floats can be adjusted by setting these lengths:
8891 \begin_layout Labeling
8892 \labelwidthstring MMMMMMMMMMM
8899 Separation between the text and the top of the float
8902 \begin_layout Labeling
8903 \labelwidthstring MMMMMMMMMMM
8910 Separation between the float and the caption
8913 \begin_layout Labeling
8914 \labelwidthstring MMMMMMMMMMM
8921 Separation between the caption and the following text
8924 \begin_layout Labeling
8925 \labelwidthstring MMMMMMMMMMM
8932 You can make the captions narrower than the surrounding text by adjusting
8934 Best done relative to
8943 \begin_layout Standard
8944 There are also several title page related lengths that you may find useful
8945 if you have a long title or several authors:
8948 \begin_layout Labeling
8949 \labelwidthstring MMMMMMMMMMM
8956 Separation from headers to
8961 \begin_layout Labeling
8962 \labelwidthstring MMMMMMMMMMM
8980 \begin_layout Labeling
8981 \labelwidthstring MMMMMMMMMMM
8995 \begin_layout Labeling
8996 \labelwidthstring MMMMMMMMMMM
9012 \begin_layout Labeling
9013 \labelwidthstring MMMMMMMMMMM
9029 \begin_layout Standard
9030 The last length related command affects all the list environments.
9041 a list environment then all the vertical spacing between the list items
9043 Note that this is a command not a length so it doesn't require
9049 like the stuff mentioned above.
9052 \begin_layout Subsubsection
9056 \begin_layout Standard
9069 commands control whether the logo in the
9073 definition appear on a given page.
9080 in the preamble then none of the foils will have the logo on them.
9081 If you don't want the logo on a particular page place the
9087 directly after the foilhead of that page and the
9093 directly after the next foilhead.
9096 \begin_layout Standard
9097 If you decide to use the
9101 page style setting in the
9104 \begin_inset space ~
9109 dialog you should probably add
9119 to your preamble so headers and footers on landscape pages are correctly
9120 placed when rotated.
9121 This is due to some clashes between the page layouts provided by the
9132 \begin_layout Section
9133 Hollywood (Hollywood spec scripts)
9136 \begin_layout Standard
9142 \begin_layout Subsection
9146 \begin_layout Standard
9147 Getting the format of a Hollywood script right is a
9148 \begin_inset Quotes eld
9152 \begin_inset Quotes erd
9155 It is designed to make the readers focus on content and to be easy and
9156 familiar for the actors to read.
9157 Each page of a script should be one minute of film.
9158 Nothing goes in a script that you cannot see or hear on screen.
9159 The courier 12 pt font should be used throughout.
9163 \begin_layout Subsection
9167 \begin_layout Standard
9168 Speakers' lines should NEVER break in mid-sentence.
9169 If a speaker's lines continue over a page break, repeat the
9173 title followed by (Cont'd).
9176 \begin_layout Subsection
9180 \begin_layout Standard
9185 names as labels then cross-reference the label to insert the name.
9186 The cross-reference dialog will show the current cast of characters.
9187 You can use this to insert the speaker name in narratives also.
9190 \begin_layout Subsection
9191 Paper size and Margins
9194 \begin_layout Standard
9195 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
9198 \begin_layout Subsection
9202 \begin_layout Standard
9203 The following environments are available.
9204 You can use hollywood.bind to get the bind keys shown at the right.
9207 \begin_layout Itemize
9211 \begin_inset Newline newline
9216 Used where nothing else works.
9220 \begin_layout Itemize
9226 \begin_inset space \hfill{}
9234 \begin_inset Newline newline
9237 Usually followed by something like
9238 \begin_inset Quotes eld
9242 \begin_inset Quotes erd
9248 \begin_layout Itemize
9252 \begin_inset space \hfill{}
9256 \begin_inset Newline newline
9261 Introduces a new INTERIOR camera set-up.
9262 Always followed by DAY or NIGHT, or something similar to define the lighting
9264 Everthing on this line in CAPS.
9267 \begin_layout Itemize
9271 \begin_inset space \hfill{}
9275 \begin_inset Newline newline
9280 Introduces a new EXTERIOR camera set-up.
9281 Everthing on this line in CAPS.
9284 \begin_layout Itemize
9288 \begin_inset space \hfill{}
9292 \begin_inset Newline newline
9297 The character speaking.
9300 \begin_layout Itemize
9304 \begin_inset space \hfill{}
9308 \begin_inset Newline newline
9313 Instructions to the speaker.
9314 The () are automatically inserted, but only the ( will show in LyX.
9315 Both will be printed.
9318 \begin_layout Itemize
9322 \begin_inset space \hfill{}
9326 \begin_inset Newline newline
9338 \begin_layout Itemize
9342 \begin_inset space \hfill{}
9346 \begin_inset Newline newline
9351 Camera movement instruction.
9353 \begin_inset space \thinspace{}
9357 \begin_inset space \space{}
9363 \begin_layout Itemize
9367 \begin_inset space \hfill{}
9373 \begin_layout Itemize
9377 \begin_inset space \hfill{}
9383 \begin_layout Itemize
9387 \begin_inset space \hfill{}
9393 \begin_layout Itemize
9397 \begin_inset space \hfill{}
9403 \begin_layout Subsection
9407 \begin_layout Itemize
9411 \begin_layout Itemize
9415 \begin_layout Itemize
9417 \begin_inset space \thinspace{}
9424 \begin_layout Itemize
9429 \begin_layout Itemize
9430 PAN — camera movement
9433 \begin_layout Itemize
9434 INSERT — cut to close-up of
9437 \begin_layout Section
9441 \begin_layout Standard
9444 Panayotis Papasotiriou
9447 \begin_layout Subsection
9451 \begin_layout Standard
9452 The ijmpc package is a set of macros that facilitates electronic manuscript
9455 International Journal of Modern Physics C
9458 Similarly, the ijmpd package is for creating manuscripts to be submitted
9461 International Journal of Modern Physics D
9464 Both journals are published by World Scientific.
9465 The corresponding document classes are named
9474 These files, together with instructions for the authors, can be downloaded
9476 \begin_inset Flex URL
9479 \begin_layout Plain Layout
9481 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
9487 \begin_inset Flex URL
9490 \begin_layout Plain Layout
9492 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
9498 Both packages are modified versions of the standard
9499 \begin_inset Quotes eld
9503 \begin_inset Quotes erd
9506 package, and they are almost (but not exactly) identical.
9507 Most of their features are supported by LyX.
9508 I have used LyX successfully to write articles submitted to both journals
9509 without any problem.
9512 \begin_layout Subsection
9516 \begin_layout Standard
9517 As usual, the easiest way to write a paper is to start with a template.
9520 File\SpecialChar \menuseparator
9539 This will give an (almost) empty document that includes the most common
9540 fields found in a manuscript.
9541 Simply overwrite the existing text (including the brackets,
9546 You should keep in mind the following remarks.
9549 \begin_layout Enumerate
9550 LyX won't let you change the font size and the page style of the document,
9551 because such modifications are not allowed by both packages.
9554 \begin_layout Enumerate
9555 The language of the document should not be changed.
9556 Before previewing your paper, be sure that the babel package is not used.
9557 To do this, click on
9559 Tools\SpecialChar \menuseparator
9570 checkbox in the language settings, and click on
9578 , if you wish to make this change permanent).
9581 \begin_layout Enumerate
9583 \begin_inset Quotes eld
9587 \begin_inset Quotes erd
9590 style must be used to define keywords.
9593 \begin_layout Enumerate
9594 The ijmpc package provides a style named
9595 \begin_inset Quotes eld
9598 Classification Codes
9599 \begin_inset Quotes erd
9602 , which can be used to define classification codes, such as PACS numbers.
9603 Note that this facility is not supported by the ijmpd package.
9606 \begin_layout Enumerate
9607 Several new environments are available:
9608 \begin_inset Quotes eld
9612 \begin_inset Quotes erd
9616 \begin_inset Quotes eld
9620 \begin_inset Quotes erd
9624 \begin_inset Quotes eld
9628 \begin_inset Quotes erd
9632 \begin_inset Quotes eld
9636 \begin_inset Quotes erd
9640 \begin_inset Quotes eld
9644 \begin_inset Quotes erd
9648 \begin_inset Quotes eld
9652 \begin_inset Quotes erd
9656 \begin_inset Quotes eld
9660 \begin_inset Quotes erd
9664 \begin_inset Quotes eld
9668 \begin_inset Quotes erd
9672 \begin_inset Quotes eld
9676 \begin_inset Quotes erd
9680 \begin_inset Quotes eld
9684 \begin_inset Quotes erd
9688 \begin_inset Quotes eld
9692 \begin_inset Quotes erd
9696 \begin_inset Quotes eld
9700 \begin_inset Quotes erd
9704 \begin_inset Quotes eld
9708 \begin_inset Quotes erd
9712 \begin_inset Quotes eld
9716 \begin_inset Quotes erd
9720 Their use is more or less obvious.
9721 LyX supports all these environments; it will use the proper label, text
9722 style, and numbering scheme for each of them.
9725 \begin_layout Enumerate
9726 Both packages use basic citations; the natbib package should not be used.
9727 In LyX, citation references are shown as usual; in the output, citations
9728 are shown as superscripts.
9729 If you want to use a citation as normal text, you should use the
9734 \begin_inset space \thinspace{}
9738 \begin_inset space \space{}
9742 \begin_inset Quotes eld
9746 \begin_inset space \space{}
9756 \begin_inset Quotes erd
9762 \begin_layout Enumerate
9764 \begin_inset Quotes eld
9768 \begin_inset Quotes erd
9771 section in both packages.
9772 To put acknowledgments, just use the
9773 \begin_inset Quotes eld
9777 \begin_inset Quotes erd
9783 \begin_layout Enumerate
9784 Appendices may be added to the paper,
9788 the Acknowledgments and
9793 LyX provides a special environment, called
9794 \begin_inset Quotes eld
9798 \begin_inset Quotes erd
9801 which marks the beginning of the appendices.
9802 This environment should be left blank; it just sends a LaTeX command, but
9803 nothing is really printed.
9805 \begin_inset Quotes eld
9809 \begin_inset Quotes erd
9812 is printed with blue letters, as a signal that all sections after that
9813 point are appendices.
9814 To write an appendix, use the
9815 \begin_inset Quotes eld
9819 \begin_inset Quotes erd
9823 LyX will number each appendix with capital letters, as required by both
9826 \begin_inset Quotes eld
9830 \begin_inset Quotes erd
9837 be present before the first appendix; if not, all appendices will be numbered
9838 as normal sections in the output.
9841 \begin_layout Enumerate
9842 The ijmpc and the ijmpd packages use the
9846 command to implement table captions.
9847 As a result, a table created by LyX is printed correctly, but its caption
9849 However, you can use some TeX code to overpass this problem, so that captions
9850 are printed as expected.
9851 To do so, create a float table as usual, remove the caption, and replace
9852 it with the TeX code
9862 (sic); you must also the TeX code
9866 immediately after the tabular material.
9867 Study the example table included in the template files to see how this
9868 trick is implemented.
9869 Alternatively, If you need table captions, you should implement the whole
9874 file, then include this file to the LyX document (
9876 Insert\SpecialChar \menuseparator
9877 File\SpecialChar \menuseparator
9879 \begin_inset space ~
9885 Details on how to create a table float can be found in the files
9893 , included in the corresponding packages.
9896 \begin_layout Subsection
9897 Preparing a paper for submission
9900 \begin_layout Standard
9901 Before you submit your paper you must export the LyX document as a LaTeX
9904 File\SpecialChar \menuseparator
9905 Export\SpecialChar \menuseparator
9916 \begin_layout Plain Layout
9917 Actually you have the choice between LaTeX (plain) and pdflatex.
9918 If you intend to use pdflatex to prepare the paper, you should use the
9919 pdflatex option so that included graphics are converted to PDF format,
9920 ready for use by pdflatex.
9925 , then make the following changes to the resulting
9932 \begin_layout Enumerate
9933 Remove the comment lines before the
9942 \begin_layout Enumerate
9943 Remove everything between (and including) the
9955 commands, except for any commands you specifically put into the LaTeX preamble.
9958 \begin_layout Standard
9963 file should be saved and processed through LaTeX as many times as necessary.
9964 You may also want to check the resulting
9971 \begin_layout Subsection
9975 \begin_layout Standard
9976 The use of TeX code is reduced to two commands, which must be placed at
9977 the top of the document.
9978 If you started writing your paper by using the
9986 template, the TeX code needed is already in its place; you usually don't
9988 You may only modify the first TeX code to specify the information printed
9989 to the top of odd and even pages (authors' names and short paper's title,
9991 This TeX code must have the form
9995 markboth{Authors' Names}{Short Paper's Title}
10000 \begin_layout Section
10004 \begin_layout Standard
10010 \begin_layout Subsection
10014 \begin_layout Standard
10015 The iopart package provides a document class to create electronic manuscript
10016 submission to the journals published by the Institute of Physics.
10017 Instructions for the authors how to create a paper using the iopart class
10018 can be downloaded together with the iopart package from the site
10019 \begin_inset Flex URL
10022 \begin_layout Plain Layout
10024 ftp://ftp.iop.org/pub/journals/latex2e
10032 \begin_layout Subsection
10036 \begin_layout Standard
10037 The easiest way to write a paper is to start with the file
10041 that is available in LyX's examples files folder.
10042 Open this file, save it under a new name, and start writing.
10043 The example file explains how to use the special text environments.
10044 Here are the most important advices:
10047 \begin_layout Itemize
10048 To be able to compile your document to a PDF, PS, or DVI, assure that the
10051 Use AMS math package
10053 in the document settings under
10060 \begin_layout Itemize
10063 The title environment defines the kind of your paper.
10064 So use one of the following environments for the title:
10068 \begin_layout Itemize
10077 \begin_layout Itemize
10086 \begin_layout Itemize
10092 for a Topical review
10095 \begin_layout Itemize
10104 \begin_layout Itemize
10113 \begin_layout Itemize
10119 for a Paper (same as Title)
10122 \begin_layout Itemize
10128 for a Preliminary communication
10131 \begin_layout Itemize
10137 for a Rapid communication
10140 \begin_layout Itemize
10146 for a Letter to the editor
10150 \begin_layout Itemize
10153 All title environments except of
10157 can have an optional short title.
10160 \begin_layout Itemize
10161 There is a general title environment
10165 which is not directly supported by the LyX.
10166 This can be used as TeX code when your document doesn't fit into one of
10167 the other title types.
10170 \begin_layout Standard
10171 For more informations like hints for special table and formula formatting,
10172 look at the IOP author guidelines.
10175 \begin_layout Section
10179 \begin_layout Standard
10182 Panayotis Papasotiriou
10185 \begin_layout Subsection
10189 \begin_layout Standard
10190 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
10191 that facilitates electronic manuscript submission to the journals they
10193 Most known of them (at least in my domain of interest) are
10195 Astrophysics and Space Science
10201 , but there are many others (see a complete list at
10202 \begin_inset Flex URL
10205 \begin_layout Plain Layout
10207 http://www.wkap.nl/jrnllist.htm/JRNLHOME
10213 The Kluwer package may be downloaded from the site
10214 \begin_inset Flex URL
10217 \begin_layout Plain Layout
10219 http://www.wkap.nl/kaphtml.htm/STYLEFILES
10225 A complete user guide is contained in that package (but it can also be
10226 downloaded separately).
10229 \begin_layout Standard
10230 LyX supports many features of the package but not everything.
10231 However, the TeX code needed is reduced to some
10232 \begin_inset Quotes eld
10236 \begin_inset Quotes erd
10239 commands of the package (see
10240 \begin_inset space ~
10244 \begin_inset CommandInset ref
10246 reference "subsec:kluwer_peculiarities"
10251 I have recently used LyX to write an article submitted to the
10253 Astrophysics and Space Science
10255 without any problem.
10258 \begin_layout Subsection
10262 \begin_layout Standard
10263 The easiest way to write a paper is to start with the Kluwer template file.
10266 File\SpecialChar \menuseparator
10278 This will give an (almost) empty document that includes the most common
10279 fields found in a manuscript and a short description of their use.
10280 As in most templates, simply overwrite the existing text (including the
10285 ) with the correct information.
10288 \begin_layout Subsection
10289 Preparing a paper for submission
10292 \begin_layout Standard
10293 As in the AASTeX package, before you submit your paper to a journal you
10295 \begin_inset Quotes eld
10299 \begin_inset Quotes erd
10305 \begin_layout Enumerate
10306 Export your paper as a LaTeX file.
10307 To do this, click on
10309 File\SpecialChar \menuseparator
10310 Export\SpecialChar \menuseparator
10317 \begin_layout Enumerate
10322 file with a text editor and make the following changes
10326 \begin_layout Enumerate
10327 remove the comment lines before the
10336 \begin_layout Enumerate
10337 remove everything between (and including) the
10349 commands, except for any commands you specifically put into the LaTeX preamble.
10352 \begin_layout Standard
10361 \begin_layout Enumerate
10366 file through LaTeX as many times as necessary (usually up to three).
10369 \begin_layout Enumerate
10375 \begin_inset space \thinspace{}
10379 \begin_inset space \space{}
10386 , and check if everything is OK (it should, if you didn't make any mistake).
10389 \begin_layout Subsection
10390 \begin_inset Quotes eld
10394 \begin_inset Quotes erd
10397 of the Kluwer package
10398 \begin_inset CommandInset label
10400 name "subsec:kluwer_peculiarities"
10407 \begin_layout Standard
10408 The Kluwer package has the following
10409 \begin_inset Quotes eld
10413 \begin_inset Quotes erd
10419 \begin_layout Enumerate
10420 It is possible to write multiple articles in the same LaTeX file
10424 \begin_layout Plain Layout
10425 I can't imagine any good reason to do this.
10431 Each article must be included in the environment
10432 \begin_inset Quotes eld
10436 \begin_inset Quotes erd
10440 Unfortunately, this environment cannot be omitted, even if you write just
10442 Therefore, each article starts with the command
10448 and, obviously, ends with the command
10455 Although this can be implemented in LyX, I didn't included it, since it
10456 looks ugly and can confuse the novice user.
10457 Therefore, you need to enter them directly and mark them as LaTeX code
10459 \begin_inset Quotes eld
10463 \begin_inset Quotes erd
10469 \begin_layout Enumerate
10470 Information given at the beginning of the article (i.
10471 \begin_inset space \thinspace{}
10475 \begin_inset space \space{}
10478 title, subtitle, author, institution, running title, running author, abstract
10479 and keywords) must be included in an environment called
10480 \begin_inset Quotes eld
10484 \begin_inset Quotes erd
10488 This is not implemented in LyX, so you must enter title, subtitle etc.
10489 \begin_inset space ~
10492 between two TeX code lines (
10507 \begin_layout Enumerate
10508 According to the user manual, the label of each bibliography item must be
10532 \begin_layout Standard
10537 template takes care of all these
10538 \begin_inset Quotes eld
10542 \begin_inset Quotes erd
10546 If you start a new paper using this template you don't need to do anything
10551 \begin_layout Enumerate
10552 don't delete the TeX code included in the template, and
10555 \begin_layout Enumerate
10556 copy the example bibliography item included in the template and modify it
10557 as necessary to enter new bibliography items.
10560 \begin_layout Section
10564 \begin_layout Standard
10570 \begin_layout Subsection
10574 \begin_layout Standard
10575 The LyX document classes
10577 article (koma-script)
10581 report (koma-script)
10599 correspond to the LaTeX document classes
10616 \begin_inset space ~
10619 of the Koma-Script family.
10620 They are replacements for the standard document classes
10636 , resp., and fit better to European typography conventions in a number of
10640 \begin_layout Itemize
10641 Standard character size is 11pt in
10643 article (koma-script)
10647 report (koma-script)
10655 letter (koma-script)
10660 \begin_layout Itemize
10661 Headings, labels of the description environment, and a number of elements
10664 letter (koma-script)
10666 document class are set in a bold sans serif font.
10670 \begin_layout Plain Layout
10671 There is a big difference between the bold sans serif old cm fonts and new
10672 ec fonts, especially in the appearance of headings.
10673 In comparison, the ec bold sans serif fonts look a bit thin.
10674 Here the LaTeX package
10682 helps to produce the
10683 \begin_inset Quotes eld
10687 \begin_inset Quotes erd
10690 appearance when using the ec fonts.
10695 The numbering of chapter headings is made in the same way as the numbering
10696 of section headings, that is without the extra line
10697 \begin_inset Quotes eld
10700 Chapter\SpecialChar \ldots{}
10702 \begin_inset Quotes erd
10706 In addition, the appearance of the headings can be modified by using a
10707 number of options (in LyX to be entered in the field
10710 \begin_inset space ~
10717 Layout\SpecialChar \menuseparator
10721 A detailed German description of these options can be found in the Koma-Script
10729 \begin_layout Itemize
10730 The main means in the Koma-Script document classes to design the type area
10739 (in LyX to be entered in the extra class options field in the dialog
10741 Document\SpecialChar \menuseparator
10745 They make a clearer modification of page margins possible as do the options
10748 Document\SpecialChar \menuseparator
10752 A detailed German description of these and other type area options can
10753 be found in the Koma-Script documentation
10760 \begin_layout Itemize
10761 The LaTeX document classes of the Koma-Script family define a number of
10762 additional commands.
10763 Those part of it which makes sense in LyX is implemented in corresponding
10767 \begin_layout Standard
10768 A detailed German description of the LaTeX document classes of the Koma-Script
10769 family can be found in the Koma-Script documentation
10777 \begin_layout Plain Layout
10778 There is an English translation
10782 , but it is not a complete one.
10787 The following sections describe only those aspects, which are relevant
10791 \begin_layout Subsection
10792 article (koma-script), report (koma-script), and book (koma-script)
10795 \begin_layout Standard
10796 The document classes
10798 article (koma-script)
10802 report (koma-script)
10812 are implemented in the layout files
10825 They contain all the paragraph types of the corresponding standard document
10838 , resp., partly modified, with the exception of the LyX specific
10842 -type, which is replaced by the new
10846 -type having the same functionality.
10851 -Type there is a number of new paragraph types added.
10858 letter (koma-script)
10863 \begin_layout Itemize
10872 : are equivalents to
10880 , resp., additionally inserting an entry in the table of contents.
10889 are not contained in
10891 article (koma-script)
10896 \begin_layout Itemize
10905 : behave exactly as
10913 , resp., additionally clearing running heads.
10918 is not contained in
10920 article (koma-script)
10926 \begin_layout Plain Layout
10939 report (koma-script)
10941 , but since this is identical to
10945 , is has not been implemented in LyX.
10953 \begin_layout Itemize
10958 : generates a heading directly above the following paragraph in the standard
10959 character size without affecting the structure of the document.
10962 \begin_layout Itemize
10971 are special captions which respect the different space settings needed
10972 for captions placed above or below an element (if you follow strict typographic
10973 rules, you might want to place table captions always above the table).
10974 You can also use the class option
10978 , which will switch
10991 You need at least Koma-Script version 2.8q to use this.
10994 \begin_layout Itemize
10999 : can be used to set a bonmot, e.
11000 \begin_inset space \thinspace{}
11004 \begin_inset space \space{}
11007 at the beginning of a chapter.
11008 If you use the optional argument (
11010 Insert\SpecialChar \menuseparator
11012 \begin_inset space ~
11017 ), you can insert the dictum's author there.
11018 Dictum and author are separated by a line.
11019 You need at least Koma-Script version 2.8q to use this.
11024 is not contained in
11026 article (koma-script)
11031 \begin_layout Standard
11032 The following types, together with the standard types
11044 , form the title area of the document.
11045 They must be entered ahead of the first
11046 \begin_inset Quotes eld
11050 \begin_inset Quotes erd
11057 \begin_layout Plain Layout
11058 The corresponding LaTeX commands must appear before the
11069 When such a type is used more than once, the latter usage overwrites the
11070 former one, that means, for every type only the latest usage is valid.
11071 The order of the different types however has, like
11083 , no effect on the appearance of the produced document.
11086 \begin_layout Itemize
11091 : produces a centered paragraph above the ordinary title (
11103 ) for the subject of the document.
11106 \begin_layout Itemize
11111 : produces a centered paragraph below the ordinary title (
11123 ) for the publishers' name.
11126 \begin_layout Itemize
11133 report (koma-script)
11139 produces a centered paragraph on its own page behind the title page, or
11142 article (koma-script)
11144 produces a centered paragraph below the ordinary title (
11160 ) for a dedication.
11163 \begin_layout Itemize
11168 : produces a left aligned paragraph above the ordinary title (
11184 ) for a document`s head.
11187 \begin_layout Itemize
11192 : produces in a double-sided print in
11194 report (koma-script)
11200 a left-aligned paragraph at the top of the title page`s back or has no
11201 effect in a single-sided print or in
11203 article (koma-script)
11208 \begin_layout Itemize
11213 : produces in a double-sided print in
11215 report (koma-script)
11221 a left-aligned paragraph at the bottom of the title page`s back or has
11222 no effect in a single-sided print or in
11224 article (koma-script)
11229 \begin_layout Itemize
11234 : produces a special
11235 \begin_inset Quotes eld
11239 \begin_inset Quotes erd
11242 page ahead of the actual document containing a paragraph without special
11246 \begin_layout Standard
11247 The layout files for the document classes
11249 article (koma-script)
11253 report (koma-script)
11259 do include the file
11264 This is thought of as a place to define your own types.
11269 in your personal layout directory and edit the file!
11272 \begin_layout Subsection
11273 letter (koma-script)
11276 \begin_layout Standard
11280 \begin_layout Plain Layout
11292 \begin_layout Standard
11296 letter (koma-script)
11298 is implemented in the layout file
11303 It contains all the paragraph types of the corresponding standard document
11308 , partly modified, with the exception of the LyX specific types
11320 type, which is replaced by the new
11325 In addition, it contains, in contrast to the standard document class, the
11343 Furthermore, there are a number of new letter specific types.
11346 \begin_layout Standard
11350 \begin_layout Plain Layout
11362 \begin_layout Standard
11363 The appearance of the letter produced by this document class can be controlled
11364 by a number of LaTeX commands, which you can put in the LaTeX preamble.
11368 \begin_layout Plain Layout
11369 For example, the standard appearance of the letter`s heading, consisting
11370 of name and address, is quite self-willed.
11372 \begin_inset Quotes eld
11376 \begin_inset Quotes erd
11379 heading is produced by the following LaTeX commands in the preamble:
11382 \begin_layout LyX-Code
11392 \begin_layout LyX-Code
11408 \begin_layout LyX-Code
11418 \begin_layout LyX-Code
11438 A detailed German description of such LaTeX commands can be found in the
11439 Koma-Script documentation
11444 With it, the letter's author can produce his personal letter layout.
11447 \begin_layout Standard
11456 define the beginning of the letter and must be used in every letter.
11457 To emphasize them in the LyX document class, they are marked with the letter
11467 \begin_inset space ~
11470 in the left margin.
11471 It is possible to write any number of letters in one file.
11476 type produces a new letter using the same addressee and a
11480 type produces a new addressee.
11497 are ordinary paragraph types and can also be used several times in one
11498 and the same letter.
11501 \begin_layout Itemize
11506 : produces a paragraph for the addressee and implicitly defines the beginning
11510 \begin_layout Itemize
11515 : produces a paragraph for the form of address and implicitly produces a
11519 \begin_layout Itemize
11524 : produces a paragraph for a close.
11527 \begin_layout Itemize
11532 : produces a paragraph for a postscript.
11535 \begin_layout Itemize
11540 : produces a paragraph for a distribution list.
11543 \begin_layout Itemize
11548 : produces a paragraph for enclosures.
11551 \begin_layout Standard
11592 are input types provided with a label to enter information, which will
11593 be processed by the document class.
11597 \begin_layout Plain Layout
11598 It could be seen as a matter of inconsequence, that the types
11606 described above are not such input types as well.
11607 Because of the special meaning of those types, however, I have implemented
11608 them as ordinary paragraph types with a one letter mark in the left margin.
11609 Moreover, it would affect my feeling of symmetry, if the
11617 type had such a serious different appearance.
11622 The types must be used ahead of the corresponding
11629 \begin_layout Standard
11630 An implementation of these types in a WYSIWYG fashion does not seem to make
11631 sense, because the real appearance of the produced letter does not only
11632 depend on the usage of the particular type, but also on other factors.
11633 For example, a signature entered in the
11637 type will in the standard behavior appear in the produced letter only,
11638 when in the same letter also a
11643 The entered value of the
11647 type will in the standard behavior not appear in the produced letter at
11649 The possibility to design the letter`s heading freely is already indicated
11650 in a footnote above.
11653 \begin_layout Standard
11654 The input types can also be used as empty paragraphs.
11655 This makes sense e.
11656 \begin_inset space \thinspace{}
11660 \begin_inset space \space{}
11672 type is not used at all, in the standard behavior the value of the
11676 type is used as signature, whereas if an empty
11680 type is used, no signature value is defined.
11683 \begin_layout Standard
11684 By using the input types it is possible to write a letter template, containing
11685 filled input types with your personal dates (name, address, etc.) and empty
11686 input types for other dates you want to enter.
11689 \begin_layout Itemize
11694 : sender's name, in the standard behavior appears as a centered paragraph
11695 in small caps in the letter`s heading.
11698 \begin_layout Itemize
11703 : sender's signature, in the standard behavior appears below the
11712 type is used, the value of the
11716 type appears instead.
11719 \begin_layout Itemize
11724 : sender's address, in the standard behavior appears in a centered paragraph
11725 in the letter`s heading below the sender's name.
11728 \begin_layout Itemize
11733 : sender's telephone number, in the standard behavior only sets the LaTeX
11743 \begin_layout Itemize
11748 : place of the letter`s making.
11751 \begin_layout Itemize
11756 : date of the letter`s making.
11765 , in the standard behavior, produce the place and the date in a right-aligned
11766 line below the addressee's field.
11771 type is used, neither place nor date appear, independent of the value of
11781 type is used, the date of the letter `s production is used.
11784 \begin_layout Itemize
11789 : sender`s back address, in the standard behavior appears above the addressee's
11790 field in a small sans serif font.
11793 \begin_layout Itemize
11798 : special mail information, in the standard behavior appears underlined
11799 above the addressee's field below the back address.
11802 \begin_layout Itemize
11807 : additional information, in the standard behavior appears on right side
11808 below the addressee`s field.
11811 \begin_layout Itemize
11816 : the letter's title, in the standard behavior appears in a big, bold, sans
11817 serif font above the subject.
11820 \begin_layout Itemize
11825 : the letter's subject, in the standard behavior appears in a bold font
11833 \begin_layout Standard
11854 produce a business letter like line above the
11858 line containing the fields
11859 \begin_inset Quotes eld
11863 \begin_inset Quotes erd
11867 \begin_inset Quotes eld
11871 \begin_inset Quotes erd
11875 \begin_inset Quotes eld
11879 \begin_inset Quotes erd
11883 \begin_inset Quotes eld
11887 \begin_inset Quotes erd
11891 \begin_inset Quotes eld
11895 \begin_inset Quotes erd
11899 \begin_inset Quotes eld
11903 \begin_inset Quotes erd
11907 For the date field, the value of the
11913 \begin_inset Quotes eld
11916 business letter types
11917 \begin_inset Quotes erd
11920 is used, the value of the
11924 type however does not appear, but only the LaTeX variable
11931 The ordinary output of place and date in a right-aligned line below the
11932 addressee`s field is suppressed.
11933 The types are implemented as input types provided with a label and must
11934 be used ahead of the corresponding
11941 \begin_layout Itemize
11949 \begin_layout Itemize
11957 \begin_layout Itemize
11965 \begin_layout Itemize
11973 \begin_layout Itemize
11981 \begin_layout Subsection
11982 The new letter class: letter (koma-script v.2)
11985 \begin_layout Standard
11991 \begin_layout Standard
11992 \begin_inset VSpace medskip
11998 \begin_layout Standard
12000 Koma-Script version 2.8 has introduced a new letter class
12004 which supersedes the now unsupported
12009 It has — on the LaTeX side — a completely new interface and is not compatible
12010 with the old class.
12011 Therefore, LyX supports both, though it is recommended to use the new class.
12014 \begin_layout Standard
12015 This class covers the same functionality as
12017 letter (koma-script),
12020 The basic items are
12024 (receiver's address, same as
12028 in the old layout),
12041 will start a new letter (i.
12042 \begin_inset space \thinspace{}
12046 \begin_inset space \space{}
12049 you can write several letters per document).
12050 New elements are sender's
12066 and the possibility to use a
12072 Insert\SpecialChar \menuseparator
12078 \begin_layout Standard
12079 The biggest improvement is, though, that the letter's layout is configurable
12080 at almost any needs.
12081 This can be done via the preamble or with a special style file (Letter
12082 Class Option, extension
12086 ), that will be read in as a class option.
12090 \begin_layout Plain Layout
12091 The KOMA package comes with some default
12096 There is, for instance, a
12100 file that follows german typesetting rules, or a
12104 that provides the default layout of the old
12109 The latter can be loaded with the class option
12118 ayout\SpecialChar \menuseparator
12123 ocument\SpecialChar \menuseparator
12135 template that is included in LyX for examples.
12136 A detailed description is to be found in the Koma-Script documentation
12144 \begin_layout Subsection
12148 \begin_layout Standard
12149 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
12153 \begin_layout Itemize
12154 The chapter number of a
12158 type appears on a line of its own above the chapter heading instead of
12159 appearing in the same line ahead of it.
12160 The cause for that is the LyX internal behavior for the labeltype
12164 in the layout file.
12167 \begin_layout Itemize
12168 The headings of the types
12176 are only put in the
12177 \begin_inset Quotes eld
12181 \begin_inset Quotes erd
12184 LaTeX table of contents, but not in the LyX table of contents (
12186 Document\SpecialChar \menuseparator
12188 \begin_inset space ~
12192 \begin_inset space ~
12200 \begin_layout Itemize
12201 The paragraphs in a
12205 document class appear in a skip separation mode, not indented.
12206 This is the standard behavior, no special LaTeX commands are needed for
12210 Document\SpecialChar \menuseparator
12213 dialog the corresponding radio button indicates
12222 value always has the effect that extra LaTeX commands are inserted in the
12223 document to produce the gap, which is not what is wanted in this case.
12226 \begin_layout Section
12227 Latex8 (IEEE Conference Papers)
12230 \begin_layout Standard
12236 \begin_layout Subsection
12240 \begin_layout Standard
12241 Since this class is specifically for writing submissions to IEEE sponsored
12242 conferences I strongly recommend that you get a copy of their Authors Kit.
12247 package and associated bibliography style file is included in the kit.
12248 The Authors Kit is usually sent out by email once your initial submission
12250 There is a lot of useful information in the Authors Kit explaining formatting
12251 restrictions and so on and I will assume you have read this since that
12252 means I don't have to repeat it all here.
12255 \begin_layout Subsection
12259 \begin_layout Standard
12260 [AR\SpecialChar \@.
12264 \begin_layout Subsection
12265 Supported Environments
12268 \begin_layout Itemize
12274 \begin_layout Itemize
12280 \begin_layout Itemize
12286 \begin_layout Itemize
12292 \begin_layout Itemize
12298 \begin_layout Itemize
12304 \begin_layout Itemize
12310 \begin_layout Itemize
12316 \begin_layout Itemize
12322 \begin_layout Subsection
12323 Differences Between Screen and Paper
12326 \begin_layout Standard
12327 There are slight differences in appearance mainly with the presentation
12328 of section counters.
12329 On screen the trailing period of the section counter is missing but it
12330 will appear in the output so don't let this worry you.
12333 \begin_layout Section
12337 \begin_layout Standard
12343 \begin_layout Subsection
12347 \begin_layout Standard
12348 Memoir is a very powerful and constantly evolving class.
12349 It has been designed with regard to fictional and non-fictional literature.
12350 Its aim is to let the user have maximum control over the typesetting of
12352 Memoir is based on the standard book class, but it can also emulate the
12353 article class (see below).
12356 \begin_layout Standard
12357 Peter Wilson, the developer of Memoir, is known as the author of lots of
12358 useful packages in the LaTeX world.
12359 Most of them have been merged with Memoir.
12360 Therefore, it is much easier to layout the table of contents, appendices,
12361 chapter designs and such.
12362 LyX, though, does not support all of these goodies natively.
12363 Some of them might be added to forthcoming releases
12367 \begin_layout Plain Layout
12368 You are invited to send suggestions to
12369 \begin_inset Flex URL
12372 \begin_layout Plain Layout
12374 lyx-devel@lists.lyx.org
12384 , lots will probably never, due to the limitations of LyX's framework.
12385 Of course you can still use all features with the help of some native LaTeX
12390 \begin_layout Plain Layout
12395 \begin_layout Plain Layout
12405 \begin_inset space ~
12409 \begin_inset CommandInset ref
12411 reference "sec:Inserting-TeX-Code"
12421 In this section, we can only list those features which are natively supported
12423 For detailed descriptions (and for the rest of features) we are recommending
12424 to have a look at the detailed manual of the Memoir class
12428 \begin_layout Plain Layout
12433 \begin_layout Plain Layout
12443 \begin_inset Flex URL
12446 \begin_layout Plain Layout
12448 CTAN:/macros/latex/memoir/memman.pdf
12458 , which is not only a user guide for the class, but also both a comprehensive
12459 description on good typesetting and a superb example for good typesetting
12463 \begin_layout Subsection
12464 Basic features and restrictions
12467 \begin_layout Standard
12468 Memoir supports basically all features of the standard book classes.
12469 There are, however, some differences, as follows:
12472 \begin_layout Description
12474 \begin_inset space ~
12477 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
12480 \begin_layout Description
12482 \begin_inset space ~
12485 style: The fancy page style is not supported, due to a command clash between
12486 Memoir and the fancyhdr package (they are both defining a command with
12487 the same name, which confuses LaTeX).
12488 Instead, Memoir comes with a bunch of own page styles (see
12490 Layout\SpecialChar \menuseparator
12491 Document\SpecialChar \menuseparator
12493 \begin_inset space ~
12499 If you want to use these for the chapter pages, you have to use the command
12506 in the main text or in preamble (e.
12507 \begin_inset space \thinspace{}
12511 \begin_inset space \space{}
12518 chapterstyle{companion}
12523 \begin_layout Description
12524 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
12525 an optional argument in the standard classes.
12526 With this, you can specify an alternative version of the title for the
12527 table of contents and the headers (for instance, if the title is too long).
12528 In LyX, you can do this via
12530 Insert\SpecialChar \menuseparator
12532 \begin_inset space ~
12537 at the beginning of a chapter/section.
12538 Memoir features a second optional argument and thus separates the table
12539 of contents from the header.
12540 You can define three variants of a title with this: one for the main text,
12541 one for the table of contents, and one for the headers.
12542 Simply insert two optional arguments if you need this feature, the first
12543 one containing the short title for the Table of Contents, the second one
12544 containing an alternative short title for the headers.
12547 \begin_layout Description
12548 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
12549 of contents, the list of figures and the list of table start a new page
12551 Memoir does not follow this route.
12552 You have to insert a page break yourself, if you want to have one.
12555 \begin_layout Description
12556 Titlepage: For some unknown reason, Memoir uses pagination on the title
12557 page (in the standard classes, title pages are
12558 \begin_inset Quotes eld
12562 \begin_inset Quotes erd
12566 \begin_inset space \thinspace{}
12570 \begin_inset space \space{}
12574 If you want an empty title page, type
12578 aliaspagestyle{title}{empty}
12583 \begin_layout Description
12584 Article: With the class option
12590 Layout\SpecialChar \menuseparator
12591 Document\SpecialChar \menuseparator
12593 \begin_inset space ~
12598 ), you can emulate article style.
12599 That is, counters (footnotes, figures, tables etc.) will not be reset on
12600 new chapters, chapters don't start a new page (but are—in contrary to
12601 \begin_inset Quotes eld
12605 \begin_inset Quotes erd
12608 article classes—still allowed), parts, though, use their own page, as in
12612 \begin_layout Description
12613 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
12614 font commands, which have been used in the old LaTeX version 2.09 (e.
12615 \begin_inset space \thinspace{}
12619 \begin_inset space \space{}
12635 It produces an error and stops LaTeX whenever such a command appears.
12640 reallows the commands and spits out warnings instead (which does at least
12642 Since a lot of packages and particularly BibTeX style files are still using
12643 those commands, we have decided to use this option by default.
12646 \begin_layout Subsection
12650 \begin_layout Standard
12651 We will only describe the features supported by LyX (which is not much currently
12653 Please consult the Memoir manual
12657 \begin_layout Plain Layout
12662 \begin_layout Plain Layout
12672 \begin_inset Flex URL
12675 \begin_layout Plain Layout
12677 CTAN:/macros/latex/memoir/memman.pdf
12690 \begin_layout Description
12691 Abstract: You may wonder why an abstract is an extra feature.
12692 Well, it is in book class.
12693 Usually books don't have abstracts.
12694 Memoir, however, has.
12695 You can use it wherever and how often you like.
12698 \begin_layout Description
12699 Chapterprecis: You may know this from belletristic: The contents of a chapter
12700 is shortly described below the title and also in the table of contents
12702 \begin_inset space \thinspace{}
12706 \begin_inset space \space{}
12711 Our hero arrives in Troia; he loses some friends; he finds others
12714 Chapterprecis does exactly this.
12715 It is therefore only sensible below a chapter.
12718 \begin_layout Description
12719 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
12720 The epigraph environment provides an elegant way of typesetting such a
12722 The motto itself (text) and its author (source) are divided by a short
12724 Unfortunately, we have to fool LyX a bit here again, since the environment
12725 needs two arguments (text and source).
12726 In this case, we have to use curly brackets (in TeX mode) between the two
12737 <author of the slogan>.
12740 \begin_layout Description
12741 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
12742 complex figurative poems).
12743 LyX can only support a few of them.
12744 One is poemtitle, which is a centered title for poems, which will also
12745 be added to the table of contents (verse is the standard environment for
12747 Memoir has some enhanced versions of verse, but you need to use TeX code,
12748 because they have to be nested inside regular verse environments, which
12749 is not possible with LyX).
12752 \begin_layout Description
12753 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
12756 \begin_layout Section
12757 Article (mwart), book (mwbk) and report (mwrep)
12758 \begin_inset OptArg
12761 \begin_layout Plain Layout
12774 \begin_layout Standard
12780 \begin_layout Standard
12781 The LyX document classes
12797 correspond to the LaTeX document classes
12810 They are replacements for the standard document classes
12822 , resp., and fit better to Polish typography conventions in a number of points.
12826 \begin_layout Standard
12830 \begin_layout Itemize
12831 Unnumbered titles (with star, e.
12832 \begin_inset space \thinspace{}
12836 \begin_inset space \space{}
12843 ) are added into table of contents,
12846 \begin_layout Itemize
12847 Additional page styles:
12851 \begin_layout Description
12852 uheadings header with separated lines,
12855 \begin_layout Description
12856 myheadings custom header, contents headers via commands:
12871 \begin_layout Description
12872 myuheadings custom header with separated lines,
12875 \begin_layout Description
12876 outer page number is placed on outer side of page
12880 \begin_layout Itemize
12885 \begin_layout Description
12886 rmheadings serif titles — default,
12889 \begin_layout Description
12890 sfheadings sansserif titles,
12893 \begin_layout Description
12894 authortitle on title page first placed is author next title — default,
12897 \begin_layout Description
12898 titleauthor on title page first placed is title next author,
12901 \begin_layout Description
12902 withmarginpar reserve place on page for margins.
12906 \begin_layout Section
12910 \begin_layout Standard
12915 provides an alternative to the standard
12920 It provides similar functionality, but you might prefer this layout with
12921 sans serif sections, headings, and more.
12924 \begin_layout Section
12928 \begin_layout Standard
12934 \begin_layout Standard
12935 \begin_inset VSpace bigskip
12941 \begin_layout Standard
12946 \begin_inset space ~
12951 textclass works with the American Physical Sociey's RevTeX 4.0 (the
12952 \begin_inset Formula $\beta$
12955 release of May, 1999) class.
12958 \begin_layout Standard
12963 textclass, which works with RevTeX 3.1.
12964 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
12965 That means that it doesn't interact very well with LyX, which requires
12966 LaTeX2e, although it has been kludged to work.
12967 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
12971 \begin_inset space ~
12976 textclass should also be pretty easy to use.
12979 \begin_layout Standard
12980 These documents are supposed to be used in
12984 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
12985 macros, and assume you'll know what to put in the preamble if necessary.
12988 \begin_layout Subsection
12992 \begin_layout Standard
12993 All you need to do is install RevTeX 4, as described in the package's README
12995 The package can be found at The RevTeX 4 Web Site
12996 \begin_inset Flex URL
12999 \begin_layout Plain Layout
13001 http://publish.aps.org/revtex4/
13007 Install it somewhere that LaTeX can see it.
13008 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13010 \begin_inset space \thinspace{}
13014 \begin_inset space \space{}
13017 not the directory where you installed the class file.) Then, if you reconfigure
13018 LyX, it will find the class file and let you use the RevTeX4 textclass.
13021 \begin_layout Standard
13022 Probably the easiest way to get started is either to import a RevTeX 4 document
13030 \begin_inset space ~
13035 template, found in the templates directory.
13038 \begin_layout Subsection
13042 \begin_layout Standard
13043 Optional arguments to
13050 \begin_inset Quotes eld
13054 \begin_inset Quotes erd
13058 \begin_inset Quotes eld
13062 \begin_inset Quotes erd
13072 \begin_inset space ~
13080 \begin_inset space ~
13086 Remember that in RevTeX, at least one optional argument is required!
13089 \begin_layout Standard
13090 Other preamble matter, like
13097 \begin_inset space ~
13107 \begin_inset space ~
13112 dialog, also as usual.
13115 \begin_layout Subsection
13119 \begin_layout Standard
13120 The layouts basically correspond to the commands in RevTeX4.0.
13121 For example, the Email layout corresponds to
13128 Note that (at least as of RevTeX 4.0 Beta), the
13136 layouts are exactly equivalent, so you shouldn't need to use both.
13140 \begin_layout Plain Layout
13141 In case you're curious, both were included so that
13145 would be able to translate both
13165 \begin_layout Subsection
13169 \begin_layout Standard
13170 There are a couple of important unique aspects of RevTeX 4 which might cause
13171 bugs that will be even more confusing in LyX.
13174 \begin_layout Standard
13192 The LyX equivalent is that there is a separate Thanks layout.
13197 write footnotes in the
13201 layout, or weird things may happen.
13202 See the RevTeX 4 documentation for more details.
13205 \begin_layout Standard
13209 \begin_inset space ~
13217 \begin_inset space ~
13226 layouts must be placed
13234 layout and the corresponding
13251 , the LaTeX won't compile.
13254 \begin_layout Subsection
13258 \begin_layout Standard
13259 The main problem with this layout is that you can't use the optional arguments
13260 to layouts like Email and Title.
13261 (The problem is not unique to this layout; you can't use optional arguments
13262 to the Section layouts either.) This means that after you export that file
13263 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13264 need to edit the LaTeX file with a text editor to add the optional arguments
13266 \begin_inset space \thinspace{}
13270 \begin_inset space \space{}
13273 the running title for the page headers.
13274 Lacking these layouts makes the
13280 (and the equivalent
13286 ) useless, so the corresponding layouts don't exist, and will have to be
13291 \begin_layout Plain Layout
13296 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13297 has not been updated yet to take advantage of it.
13305 \begin_layout Section
13306 Springer Journals (
13313 \begin_layout Standard
13319 \begin_layout Subsection
13323 \begin_layout Standard
13324 These are the layout files for some of the journal formats used by Springer
13325 Verlag and listed on
13326 \begin_inset Flex URL
13329 \begin_layout Plain Layout
13331 http://www.springer.de/author/tex/help-journals.html
13336 , where you should also go to fetch the class files (yes, these are LaTeX2e
13338 It is a modular system: the things common to all journals are implemented
13343 , which journal-specific layout files (such as, e.
13344 \begin_inset space \thinspace{}
13348 \begin_inset space \space{}
13355 for Journal of Geodesy) can include.
13358 \begin_layout Standard
13359 This means that implementing support for any other Springer journal on this
13360 list is as simple as writing your own
13368 file following the outline given in
13376 \begin_layout Standard
13377 It is reasonably well tested only for the Journal of Geodesy.
13386 come with the standard LyX distribution.
13387 Install the relevant class file (downloaded from Springer) in a proper
13388 directory, reconfigure LaTeX (in the teTeX case by running
13392 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
13393 and it should work.
13396 \begin_layout Subsection
13400 \begin_layout Standard
13401 A large number of theorem-like styles —
13407 \SpecialChar \ldots{}
13413 \begin_layout Standard
13416 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
13417 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
13420 See the Springer class file documentation for details.
13423 \begin_layout Subsection
13427 \begin_layout Itemize
13439 \begin_layout Itemize
13442 Probability Theory and Related Fields
13448 — Jean-Marc Lasgouttes
13451 \begin_layout Standard
13452 Add your own, it isn't so hard!
13455 \begin_layout Subsection
13459 \begin_layout Standard
13460 These files are partly based on the older
13464 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
13465 file from Springer.
13470 layout, are now defunct.
13471 Jean-Marc Lasgouttes helped out big in making me find my way around the
13472 LyX layout file mechanism.
13475 \begin_layout Subsection
13479 \begin_layout Standard
13481 But probably less than in the old hacked-LaTeX
13488 \begin_layout Standard
13490 \begin_inset space \thinspace{}
13493 g.: does not display the number for theorem-like layouts, just #.
13496 \begin_layout Section
13502 \begin_inset CommandInset label
13511 \begin_layout Standard
13519 \begin_layout Subsection
13523 \begin_layout Standard
13524 This section describes how to use LyX to make slides for overhead projectors.
13525 There are two document classes that can do this: the default slides class
13531 This section documents the former.
13534 \begin_layout Standard
13535 I'm going to say this again, nice and clear, so that there's no misunderstanding
13539 \begin_layout Standard
13540 \begin_inset VSpace bigskip
13546 \begin_layout Standard
13550 This section documents the class
13551 \begin_inset Quotes eld
13559 \begin_inset Quotes erd
13567 \begin_layout Standard
13568 \begin_inset VSpace bigskip
13574 \begin_layout Standard
13575 If you're looking for the documentation for
13576 \begin_inset Quotes eld
13584 \begin_inset Quotes erd
13587 , check out section
13588 \begin_inset space ~
13592 \begin_inset CommandInset ref
13594 reference "sec:foiltex"
13604 \begin_inset Quotes eld
13612 \begin_inset Quotes erd
13615 ] is actually somewhat better than the default
13623 \begin_layout Plain Layout
13624 \SpecialChar \ldots{}
13625 or so I've been told repeatedly by its advocates.
13626 Having never used it, I have no idea if this claim is true or not.
13631 which this section documents.
13634 \begin_layout Standard
13635 This class is the LaTeX2e improvement of the old
13640 Every LaTeX2e distribution includes this class [which I'll just refer to
13642 \begin_inset Quotes eld
13650 \begin_inset Quotes erd
13653 from now on], so you're bound to have it.
13654 As I noted earlier, there are other classes, such as
13658 , which also produce slides for overhead projectors and do a better job
13660 However, there are some things which
13664 can do which the others can't, such as generate overlays.
13665 Read on to learn more!
13668 \begin_layout Subsection
13670 \begin_inset CommandInset label
13672 name "sec:slidesetup"
13679 \begin_layout Standard
13680 Obviously, to use this document class, you need to select
13681 \begin_inset Quotes eld
13689 \begin_inset Quotes erd
13692 from the class list in the
13694 Document\SpecialChar \menuseparator
13698 There are some other special things you should know about this class:
13701 \begin_layout Itemize
13702 Don't bother changing the options
13707 They're not supported by the
13714 \begin_layout Itemize
13718 \begin_inset space ~
13723 behaves a bit differently for this class.
13724 The possible choices and what they do are as follows:
13728 \begin_layout Description
13733 The final output contains page numbers in the lower right corner.
13736 \begin_layout Description
13745 , but also prints out any time markers you've put in.
13746 This is the default.
13749 \begin_layout Description
13754 The final output contains no page numbers, time markers, or alignment markers.
13758 \begin_layout Itemize
13763 class has an extra option:
13769 \begin_inset Quotes eld
13777 \begin_inset Quotes erd
13780 in the extra class options.
13784 \begin_layout Standard
13785 Using this options allows you to add time markers to
13791 \begin_inset space ~
13795 \begin_inset CommandInset ref
13797 reference "sec:slideNote"
13805 \begin_layout Standard
13806 You can also use the template file
13807 \begin_inset Quotes eld
13815 \begin_inset Quotes erd
13818 to automatically set up a document to use the
13824 File\SpecialChar \menuseparator
13826 \begin_inset space ~
13830 \begin_inset space ~
13835 to open your new document].
13836 The template file also contains some examples of the special paragraph
13837 environments used by this class.
13838 I'll describe those next.
13841 \begin_layout Subsection
13842 Paragraph Environments
13845 \begin_layout Subsubsection
13846 Supported Environments
13849 \begin_layout Standard
13850 The first thing you'll notice when you start up a new
13854 document is the font size and type: it's the equivalent of the size
13855 \begin_inset Quotes eld
13863 \begin_inset Quotes erd
13869 \begin_inset space ~
13875 This is also what's used in the output.
13877 \begin_inset Quotes eld
13881 \begin_inset Quotes erd
13884 to remind you that this is a slide.
13885 Your final slides will use a larger font; ergo, you'll have less space.
13886 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
13889 \begin_layout Standard
13890 The next thing that becomes obvious is the changes to the paragraph environment
13891 pull-down box [at the far-left end of the toolbar].
13892 Most of the paragraph environments you're used to seeing are missing.
13893 There are also five new ones.
13898 class itself only supports certain paragraph environments:
13901 \begin_layout Itemize
13907 \begin_layout Itemize
13913 \begin_layout Itemize
13919 \begin_layout Itemize
13925 \begin_layout Itemize
13931 \begin_layout Itemize
13937 \begin_layout Itemize
13943 \begin_layout Itemize
13949 \begin_layout Itemize
13955 \begin_layout Itemize
13961 \begin_layout Itemize
13967 \begin_layout Standard
13968 All of the other standard environments, including the section-heading environmen
13969 ts, aren't used in the
13976 \begin_layout Standard
13977 On the other hand, you'll notice the following new environments:
13980 \begin_layout Itemize
13986 \begin_layout Itemize
13992 \begin_layout Itemize
13998 \begin_layout Itemize
14004 \begin_layout Itemize
14010 \begin_layout Standard
14011 These five are kind of quirky, due to a
14012 \begin_inset Quotes eld
14016 \begin_inset Quotes erd
14020 You see, LyX doesn't permit you to nest any other paragraph environment
14021 into an empty environment.
14022 Now, that's fine and dandy, but it means that you wouldn't be able to start
14023 a slide with anything except plain text.
14024 To deal with this, I've performed a little
14025 \begin_inset Quotes eld
14029 \begin_inset Quotes erd
14035 \begin_layout Subsubsection
14036 Quirks of the New Environments
14037 \begin_inset CommandInset label
14039 name "sec:slideQuirk"
14046 \begin_layout Standard
14047 All five of the new paragraph environments are somewhat quirky due to inherent
14048 limitiations in the current version of LyX.
14049 As I just mentioned, LyX forbids environments that begin with another environme
14051 To get around this, the
14055 environment isn't a paragraph environment as described in the
14063 \begin_layout Standard
14064 You should consider
14077 \begin_inset Quotes eld
14080 pseudo-environments.
14081 \begin_inset Quotes erd
14084 They look like a section heading or a
14085 \begin_inset Quotes eld
14093 \begin_inset Quotes erd
14096 but really begin a [and, if necessary, end the previous] paragraph environment.
14106 \begin_inset Quotes eld
14110 \begin_inset Quotes erd
14113 These two perform some action.
14116 \begin_layout Standard
14117 A common feature of all five environments,
14137 , is a rather long-ish label.
14138 The text following this label — ordinarily the contents of the paragraph
14139 environment — is utterly irrelevant for
14160 LyX completely ignores it.
14161 In fact, you can leave these five environments completely empty.
14165 \begin_layout Standard
14170 to put any text after the rather long-ish label, you might want to.
14171 This could be a short description of the contents of the
14176 In that case, enter in your descriptive comment and hit
14180 as you normally would.
14183 \begin_layout Standard
14184 If, on the other hand, you don't want to enter in any descriptive text,
14185 you'll hit another LyX quirk.
14186 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
14187 environment until you put something in the old one.
14191 \begin_layout Itemize
14192 Start entering the text that will
14220 \begin_layout Itemize
14221 Now move to the beginning of that paragraph.
14225 \begin_layout Itemize
14234 \begin_layout Itemize
14235 Finally, change this new, empty paragraph to a
14259 \begin_layout Standard
14260 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
14264 \begin_layout Subsection
14265 Making a Presentation with
14278 \begin_layout Subsubsection
14286 \begin_layout Standard
14287 If you're expecting this section to teach you how to actually make a presentatio
14288 n, you'll be sorely disappointed.
14289 Naturally, I'll describe all of the ways the
14293 class can assist you in preparing the materials for a presentation.
14294 Filling in the contents, however, is up to you.
14299 the LyX philosophy.]
14302 \begin_layout Standard
14307 environment [in the manner described in section
14308 \begin_inset space ~
14312 \begin_inset CommandInset ref
14314 reference "sec:slideQuirk"
14318 ] tells LyX to begin a new slide [duh].
14319 The label for this environment/
14320 \begin_inset Quotes erd
14324 \begin_inset Quotes erd
14328 \begin_inset Quotes eld
14332 \begin_inset Quotes erd
14335 in cool blue, followed by the label,
14336 \begin_inset Quotes eld
14340 \begin_inset Quotes erd
14344 Any text or paragraph environments that follow this one go on the new slide.
14348 \begin_layout Standard
14349 Slides are probably the only time you'll need to forcibly end pages in LyX
14350 (this can be specified in the
14355 In fact, you'll want to, once you finish entering the contents of one slide.
14356 If you've entered more text than can physically fit on a slide, the extra
14357 overflows onto a new slide.
14358 I don't recommend doing this, however, since the overflow slide won't have
14359 any page number on it.
14360 Furthermore, it may interfere with any
14364 you've made to accompany the oversized
14371 \begin_layout Standard
14380 environments work the same way as the
14385 They both create an
14386 \begin_inset Quotes eld
14390 \begin_inset Quotes erd
14393 followed by a label [
14394 \begin_inset Quotes eld
14398 \begin_inset Quotes erd
14402 \begin_inset Quotes eld
14406 \begin_inset Quotes erd
14410 The color is a stunning magenta instead of blue, and the
14411 \begin_inset Quotes eld
14415 \begin_inset Quotes erd
14418 will look different, in style and in length.
14419 The label fonts of all three also differ from one another.
14422 \begin_layout Standard
14427 , if the contents of a
14435 exceed the physical size of a slide or sheet of paper, the extra will overflow
14437 Again, you should avoid this.
14438 It defeats the whole purpose of
14449 \begin_layout Subsubsection
14459 \begin_layout Standard
14464 is a slide that sits atop another slide.
14465 Perhaps you wish to discuss a figure on the main
14469 before displaying the text associated with it.
14470 One way to accomplish this is tape a flap of dark paper over the part of
14475 you want to display later.
14476 This method fails, however, if you wish to overlap one graph with another,
14478 You would then have to fumble while speaking to align the two separate,
14483 s to align the two graphs.
14488 environment in both cases makes life much easier.
14491 \begin_layout Standard
14496 receives the page number of its
14497 \begin_inset Quotes eld
14501 \begin_inset Quotes erd
14509 \begin_inset Quotes eld
14517 \begin_inset Quotes erd
14524 \begin_layout Plain Layout
14525 Presumably, mutliple
14530 \begin_inset Quotes eld
14538 \begin_inset Quotes erd
14542 \begin_inset Quotes eld
14550 \begin_inset Quotes erd
14554 \begin_inset Quotes eld
14562 \begin_inset Quotes erd
14566 \begin_inset space ~
14569 appended to the page number of the parent
14579 Clearly, you want the contents of both the
14587 to each fit on a single physical slide! You should probably consider an
14593 \begin_inset Quotes eld
14597 \begin_inset Quotes erd
14609 class provides a visual cue for this: the label at the start of an
14613 is shorter than that at the start of a
14618 Lastly, when you generate printable output, you'll find alignment markers
14619 in all four corners of both the
14623 page and its parent
14628 These will assist you in lining up the two physical slides.
14631 \begin_layout Standard
14632 The major problem in overlaying two slides is aligning the contents of the
14633 two transparencies.
14634 How much space should you leave for that graph on the second slide? Worse
14635 still, what if you want a graph and a sentence on second slide, but there
14636 is text on the main transparency that goes in between them? You could try
14637 and insert vertical space of the right size.
14638 The better way is to use
14649 \begin_layout Standard
14650 As their names imply,
14658 are two command-like paragraph environments that make all subsequent text
14659 invisible and visible, respectively.
14661 \begin_inset space ~
14665 \begin_inset CommandInset ref
14667 reference "sec:slideQuirk"
14671 that you don't place anything
14675 these two environments, however.
14680 , it inserts a centered, sky-blue label into the page reading
14681 \begin_inset Quotes eld
14684 <Invisible Text Follows>
14685 \begin_inset Quotes erd
14689 For paragraphs following this label, the parts of the
14697 ; it doesn't matter which] where they would be contain instead blank space.
14701 \begin_layout Standard
14706 , the corresponding centered label is
14707 \begin_inset Quotes eld
14710 <Visible Text Follows>
14711 \begin_inset Quotes erd
14715 Paragraphs following this label behave normally.
14716 Note that the beginning of a new
14728 automatically shuts off an
14733 It's therefore not necessary to use
14744 \begin_layout Standard
14745 By now, it should be obvious how to create overlay transparencies using
14746 the proper combination of
14765 \begin_layout Enumerate
14770 , including everything that will appear on it, whether on the main slide
14778 \begin_layout Enumerate
14779 Before each figure or paragraph that will appear only on the
14788 If necessary, insert a
14792 environment after the
14799 \begin_layout Enumerate
14804 immediately following the
14811 \begin_layout Enumerate
14812 Copy the contents of this
14823 \begin_layout Enumerate
14828 , change all of the
14839 \begin_layout Standard
14841 You've just made an
14848 \begin_layout Standard
14849 There's one problem with the way I've designed the LyX
14853 class: you can't make text in the middle of a paragraph invisible, nor
14854 make text in the middle of an invisible paragraph visible again.
14855 To accomplish this feat, you'll need to use some inlined LaTeX codes.
14859 \begin_layout Plain Layout
14860 The commands of interest are:
14863 \begin_layout Itemize
14868 invisible \SpecialChar \ldots{}
14872 \begin_layout Itemize
14877 visible \SpecialChar \ldots{}
14881 \begin_layout Plain Layout
14882 \SpecialChar \ldots{}
14883 and need to be marked as TeX.
14885 \begin_inset Quotes eld
14889 \begin_inset Quotes erd
14892 you wish to change goes in between the brackets [and after the
14905 If you don't know how to mark text as TeX, see the appropriate section
14918 \begin_layout Subsubsection
14928 \begin_inset CommandInset label
14930 name "sec:slideNote"
14937 \begin_layout Standard
14946 is associated with a
14947 \begin_inset Quotes eld
14951 \begin_inset Quotes erd
14963 class provides visual cues.
14968 is shorter than that of a
14972 [yet longer than that of an
14976 ] and, like the label of an
14980 is shockingly magenta.
14981 Additionally, the printed
14985 has the page number of its
14986 \begin_inset Quotes eld
14990 \begin_inset Quotes erd
14998 \begin_inset Quotes eld
15006 \begin_inset Quotes erd
15010 \begin_inset Quotes eld
15018 \begin_inset Quotes erd
15022 \begin_inset Quotes eld
15030 \begin_inset Quotes erd
15034 You can have multiple
15038 s associated with a single
15050 , you'll probably want to break up long
15054 s so that they fit on a single sheet of paper.
15057 \begin_layout Standard
15062 is obvious: it contains anything additional you might want to say about
15068 It could also be used as a sheet of reminders for a particular
15073 In the case of the latter, you might want to make use of time markers.
15079 \begin_inset Quotes eld
15083 \begin_inset Quotes erd
15086 support for time markers, a
15091 So, you'll have to resort to using the LaTeX codes.
15094 \begin_layout Standard
15095 To use time markers, you'll need to specify the extra class option
15096 \begin_inset Quotes eld
15104 \begin_inset Quotes erd
15108 \begin_inset space ~
15112 \begin_inset CommandInset ref
15114 reference "sec:slidesetup"
15119 This option turns on timing marks, which will appear in the lower-left-hand
15125 To set what appears in the time marker, you use the LaTeX commands
15126 \begin_inset Quotes eld
15136 \begin_inset Quotes erd
15140 \begin_inset Quotes eld
15150 \begin_inset Quotes erd
15154 The arguments of both commands are time measured in seconds.
15156 \begin_inset Quotes eld
15166 \begin_inset Quotes erd
15169 sets the time marker to a given time.
15171 \begin_inset Quotes eld
15181 \begin_inset Quotes erd
15184 increments the time marker by the specified amount.
15185 Using time markers and
15189 s in this fashion, you can remind yourself how much time to spend on a particula
15197 \begin_layout Standard
15198 There's one last feature to describe.
15199 Clearly, you'd like to print out all of your
15207 s on transparencies while printing all of your
15224 with which it is associated.
15225 What's a person to do?
15228 \begin_layout Standard
15229 Luckily, there are two LaTeX commands that allow you to select what to print
15231 Both must be placed into the preamble of your document.
15233 \begin_inset Quotes eld
15245 \begin_inset Quotes erd
15248 will cause the output to contain only the
15257 Correspondingly, the command
15258 \begin_inset Quotes eld
15270 \begin_inset Quotes erd
15273 prevents the output of anything but
15278 I'd advise placing both commands in the preamble and initially comment
15280 You can then preview your entire presentation as you write.
15281 When you're done writing, you can then uncomment one of the two to select
15282 what you want to print.
15283 I like to uncomment
15284 \begin_inset Quotes eld
15296 \begin_inset Quotes erd
15299 , print to a file with
15300 \begin_inset Quotes eld
15308 \begin_inset Quotes erd
15311 in its name, comment it back out, then uncomment
15312 \begin_inset Quotes eld
15324 \begin_inset Quotes erd
15328 \begin_inset Quotes eld
15336 \begin_inset Quotes erd
15340 I can then send either file to a printer, loading transparencies or plain
15341 paper as appropriate.
15344 \begin_layout Standard
15345 You can also provide other arguments to the
15346 \begin_inset Quotes eld
15356 \begin_inset Quotes erd
15360 \begin_inset Quotes eld
15370 \begin_inset Quotes erd
15374 See a good LaTeX book for details.
15377 \begin_layout Subsection
15382 Class Template File
15385 \begin_layout Standard
15386 I have also provided a template file,
15387 \begin_inset Quotes eld
15395 \begin_inset Quotes erd
15403 To use it, begin your new presentation with
15408 ile\SpecialChar \menuseparator
15410 \begin_inset space ~
15414 \begin_inset space ~
15424 Your new LyX presentation file will contain an example
15445 additionally contain an example of the use of
15454 Lastly, the preamble will contain:
15457 \begin_layout LyX-Code
15458 % Uncomment to print out only slides and overlays
15461 \begin_layout LyX-Code
15465 \begin_layout LyX-Code
15471 \begin_inset Newline newline
15477 \begin_layout LyX-Code
15478 % Uncomment to print out only notes
15481 \begin_layout LyX-Code
15485 \begin_layout LyX-Code
15493 \begin_layout Standard
15494 One final thing: I created this class to support the LaTeX2e
15495 \begin_inset Quotes eld
15503 \begin_inset Quotes erd
15506 class, one of the built-in LaTeX2e classes.
15507 Neither I nor the rest of the LyX Team endorse or oppose the use of this
15508 built-in slide class.
15509 It's here if you want it or need it.
15510 There exist other LaTeX2e classes for creating presentations, such as the
15516 \begin_inset space ~
15520 \begin_inset CommandInset ref
15522 reference "sec:foiltex"
15527 \begin_inset Quotes eld
15535 \begin_inset Quotes erd
15538 package [present on some TeX distributions].
15539 The latter is not yet supported under LyX.
15543 \begin_layout Plain Layout
15544 Perhaps you can take on the task\SpecialChar \ldots{}
15550 I know nothing about these other classes.
15551 Try them out to see what sort of alternative they provide.
15554 \begin_layout Chapter
15555 LyX Features needing Extra Software
15558 \begin_layout Section
15562 \begin_layout Standard
15568 \begin_layout Subsection
15572 \begin_layout Standard
15581 \begin_layout Plain Layout
15586 is not yet available when you are using the LaTeX distribution MiKTeX.
15591 , you'll find in the
15598 \begin_inset space ~
15609 \begin_inset CommandInset href
15611 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
15618 \begin_layout Standard
15623 package is a program that was written by
15624 \begin_inset Flex CharStyle:Noun
15627 \begin_layout Plain Layout
15629 \begin_inset space ~
15637 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15638 and easy to forget.
15639 The program runs over your LaTeX file, checks the integrity of the file,
15640 and flags some common errors.
15641 In other technical words, it is
15648 \begin_layout Standard
15649 Well, what is a syntax checker doing in LyX which is supposed to produce
15650 correct LaTeX anyways? The answer is simple: Just as
15654 not only checks the
15658 of C programs, but also does
15662 checks for type-errors,
15666 catches some common
15670 errors, in addition to the syntactical ones.
15675 is capable of detecting several common errors, such as
15678 \begin_layout Itemize
15679 Ellipsis detection:
15680 \begin_inset Newline newline
15683 Use \SpecialChar \ldots{}
15687 \begin_layout Itemize
15688 No space in front of/after parenthesis:
15689 \begin_inset Newline newline
15695 \begin_layout Itemize
15696 Enforcement of normal space after common abbreviations:
15697 \begin_inset Newline newline
15701 \begin_inset space \thinspace{}
15705 \begin_inset space \space{}
15708 is too wide spacing.
15711 \begin_layout Itemize
15712 Enforcement of end-of-sentence space when the last sentence ends with a
15714 \begin_inset Newline newline
15718 And this is wrong spacing.
15721 \begin_layout Itemize
15722 Space in front of labels and similar commands:
15723 \begin_inset Newline newline
15726 The label should stick right up to the text to avoid falling to a wrong
15729 \begin_inset CommandInset label
15739 \begin_layout Plain Layout
15740 This footnote is in danger of falling off to a wrong page
15745 The label is separated too much.
15748 \begin_layout Itemize
15749 Space in front of references, instead of hard spaces:
15750 \begin_inset Newline newline
15753 In you are in bad luck, the text will break right between the referenced
15754 text and reference number, and that's a pity.
15756 \begin_inset CommandInset ref
15758 reference "sec:chktex"
15765 \begin_layout Itemize
15767 \begin_inset Quotes eld
15771 \begin_inset Quotes erd
15775 \begin_inset Formula $\times$
15779 \begin_inset Newline newline
15782 2x2 looks cheap compared to
15783 \begin_inset Formula $2\times2$
15789 \begin_layout Standard
15790 and more \SpecialChar \ldots{}
15791 It is an invaluable tool when you are
15792 \begin_inset Quotes eld
15796 \begin_inset Quotes erd
15799 your document before printing, and you should run it right after the obligatory
15800 spelling check, and before you go fine tuning the typesetting.
15803 \begin_layout Subsection
15807 \begin_layout Standard
15808 If you have the program installed, usage is as simple as choosing
15810 Tools\SpecialChar \menuseparator
15812 \begin_inset space ~
15818 This will make LyX generate a LaTeX file of your document, start
15822 to check it, and then make LyX insert
15823 \begin_inset Quotes eld
15827 \begin_inset Quotes erd
15830 with the warnings from
15834 , if there were any.
15835 The warnings will be placed close to the point of the mistake, and you
15836 can quickly find them by using the
15838 Navigate\SpecialChar \menuseparator
15841 menu item, or the shortcut key
15850 Open the error boxes by clicking on them with the mouse, or use the shortcut
15859 bindings, or the corresponding
15868 Read the warning and correct the mistake, if it is a mistake.
15869 If you have trouble understanding what the warning is about, you can safely
15871 Remember that there is a hidden layer between the document on screen and
15872 the technical details in invoking
15876 , and this gap can make some warnings seem arcane or just right down plain
15880 \begin_layout Standard
15881 This document is an excellent testing bed for the feature, and it should
15882 provide quite a few warnings for you to fiddle with.
15883 Since computers are only so smart, expect most of the warnings to be false
15887 \begin_layout Subsection
15888 How to fine tune it
15891 \begin_layout Standard
15892 Sometimes, you'll find that
15896 makes more noise than suits your mood.
15897 Then you can choose not to use it, wait until your mood changes, or try
15902 to get better along with you.
15903 Another choice in the most desperate situations is to use
15905 View\SpecialChar \menuseparator
15907 \begin_inset space ~
15911 \begin_inset space ~
15915 \begin_inset space ~
15920 , which will get rid of all warnings instantly.
15923 \begin_layout Standard
15932 very configurable and extensible, you shouldn't expect to solve all problems
15938 Since LyX has to generate a somewhat special LaTeX file to be able to match
15939 the line numbers from the
15947 \begin_layout Plain Layout
15948 You can inspect the specific output from
15954 Edit\SpecialChar \menuseparator
15956 \begin_inset space ~
15960 \begin_inset space ~
15974 to the internal document structure, some of the warnings will not seen
15975 to appear correctly.
15976 There are two things you can do about this:
15979 \begin_layout Itemize
15984 invocation command line in
16000 installation configuration file (usually with the file
16005 See below to learn what warnings can be enabled and disabled on the command
16010 \begin_layout Itemize
16011 Export your document as a raw LaTeX file using
16013 File\SpecialChar \menuseparator
16014 Export\SpecialChar \menuseparator
16022 Invoked in this way, it can be a hassle to find the corresponding place
16023 in the document inside LyX, but with a little patience, you should be able
16027 \begin_layout Standard
16028 Here follows the warning messages that can be enabled and disabled in
16037 to disable a warning, and
16041 to enable a warning.
16042 The emphasized entries are disabled by default, because the default is
16045 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
16050 \begin_layout Standard
16051 Notice that you should only use the options that enable and disable warnings,
16052 because LyX relies on some of the other command line parameters to be set
16053 in a specific way to have a chance to communicate with
16060 \begin_layout Enumerate
16064 Command terminated with space.
16067 \begin_layout Enumerate
16070 Non-breaking space (
16071 \begin_inset Quotes eld
16079 \begin_inset Quotes erd
16082 ) should have been used.
16085 \begin_layout Enumerate
16089 You should enclose the previous parenthesis with
16090 \begin_inset Quotes eld
16098 \begin_inset Quotes erd
16104 \begin_layout Enumerate
16107 Italic correction (
16108 \begin_inset Quotes eld
16118 \begin_inset Quotes erd
16121 ) found in non-italic buffer.
16124 \begin_layout Enumerate
16127 Italic correction (
16128 \begin_inset Quotes eld
16138 \begin_inset Quotes erd
16141 ) found more than once.
16144 \begin_layout Enumerate
16148 No italic correction (
16149 \begin_inset Quotes eld
16159 \begin_inset Quotes erd
16165 \begin_layout Enumerate
16169 \begin_inset Quotes eld
16177 \begin_inset Quotes erd
16181 \begin_inset Quotes eld
16189 \begin_inset Quotes erd
16195 \begin_layout Enumerate
16198 Wrong length of dash may have been used.
16201 \begin_layout Enumerate
16205 \begin_inset Quotes eld
16213 \begin_inset Quotes erd
16217 \begin_inset Quotes eld
16225 \begin_inset Quotes erd
16231 \begin_layout Enumerate
16235 \begin_inset Quotes eld
16243 \begin_inset Quotes erd
16249 \begin_layout Enumerate
16253 \begin_inset Quotes eld
16261 \begin_inset Quotes erd
16264 to achieve an ellipsis.
16267 \begin_layout Enumerate
16270 Inter-word spacing (
16271 \begin_inset Quotes eld
16281 \begin_inset Quotes eld
16284 ) should perhaps be used.
16287 \begin_layout Enumerate
16290 Inter-sentence spacing (
16291 \begin_inset Quotes eld
16301 \begin_inset Quotes erd
16304 ) should perhaps be used.
16307 \begin_layout Enumerate
16310 Could not find argument for command.
16313 \begin_layout Enumerate
16317 \begin_inset Quotes eld
16325 \begin_inset Quotes erd
16331 \begin_layout Enumerate
16334 Math mode still on at end of LaTeX file.
16337 \begin_layout Enumerate
16341 \begin_inset Quotes eld
16349 \begin_inset Quotes erd
16352 doesn't match the number of
16353 \begin_inset Quotes eld
16361 \begin_inset Quotes erd
16367 \begin_layout Enumerate
16370 You should use either
16373 \begin_inset Quotes eld
16381 \begin_inset Quotes erd
16386 as an alternative to
16387 \begin_inset Quotes eld
16395 \begin_inset Quotes erd
16401 \begin_layout Enumerate
16408 " (ASCII 39) instead of "
16415 \begin_layout Enumerate
16418 User-specified pattern found.
16421 \begin_layout Enumerate
16424 This command might not be intended.
16427 \begin_layout Enumerate
16434 \begin_layout Enumerate
16452 \begin_layout Enumerate
16455 Delete this space to maintain correct page references.
16458 \begin_layout Enumerate
16462 You might wish to put this between a pair of
16463 \begin_inset Quotes eld
16471 \begin_inset Quotes erd
16477 \begin_layout Enumerate
16480 You ought to remove spaces in front of punctuation.
16483 \begin_layout Enumerate
16486 Could not execute LaTeX command.
16489 \begin_layout Enumerate
16498 in front of small punctuation.
16501 \begin_layout Enumerate
16509 may look prettier here.
16512 \begin_layout Enumerate
16516 Multiple spaces detected in output.
16519 \begin_layout Enumerate
16522 This text may be ignored.
16525 \begin_layout Enumerate
16531 \begin_inset Quotes eld
16536 to begin quotation, not
16543 \begin_layout Enumerate
16550 to end quotation, not
16553 \begin_inset Quotes eld
16561 \begin_layout Enumerate
16567 \begin_layout Enumerate
16570 You should perhaps use
16571 \begin_inset Quotes eld
16579 \begin_inset Quotes erd
16585 \begin_layout Enumerate
16588 You should put a space in front of/after parenthesis.
16591 \begin_layout Enumerate
16594 You should avoid spaces in front of/after parenthesis.
16597 \begin_layout Enumerate
16601 You should not use punctuation in front of/after quotes.
16604 \begin_layout Enumerate
16607 Double space found.
16610 \begin_layout Enumerate
16613 You should put punctuation outside inner/inside display math mode.
16616 \begin_layout Enumerate
16619 You ought to not use primitive TeX in LaTeX code.
16622 \begin_layout Enumerate
16625 You should remove spaces in front of
16626 \begin_inset Quotes eld
16634 \begin_inset Quotes erd
16640 \begin_layout Enumerate
16643 \begin_inset Quotes eld
16651 \begin_inset Quotes erd
16654 is normally not followed by
16655 \begin_inset Quotes eld
16663 \begin_inset Quotes erd
16669 \begin_layout Standard
16670 In later versions of LyX, we hope to provide a more complete interface to
16671 this tool (and it's smaller cousin
16675 ) to exploit the full power of it.
16676 But it's not exactly useless as it is now: go try it on one of your existing
16677 documents of a certain length and be surprised.
16680 \begin_layout Section
16681 Version Control in LyX
16684 \begin_layout Standard
16687 Lars Gullik Bjønnes,
16694 \begin_layout Subsection
16698 \begin_layout Standard
16699 A friend of mine wanted to try LyX for a group project.
16700 When he didn't find support for version control or file locking, he dropped
16702 This angered me a bit, so I thought that I should at least make support
16703 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16704 This has now been done.
16705 LyX now supports some of the most basic RCS commands.
16706 If you need to something a bit more sophisticated you will have to do that
16707 manually in an xterm.
16710 \begin_layout Standard
16711 Before you begin to use the version control features in LyX, you should
16713 \begin_inset Quotes eld
16717 \begin_inset Quotes erd
16720 (a man file, read it with
16725 This file describes all the basic features of RCS.
16726 You should especially notice the comment about a RCS directory, and the
16727 notion of a master RCS file (the file ending in
16734 \begin_layout Standard
16735 Later basic CVS/SVN support was added.
16736 You should be familiar with CVS/SVN usage before start using it under LyX.
16737 Most of the log messages are not currently displayed after operations -
16738 you can check them in terminal window if unsure.
16741 \begin_layout Standard
16742 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
16743 package—no guarantees are made for older versions.
16746 \begin_layout Standard
16747 For introducing your own external commands consult vc-command in the manual
16751 \begin_layout Subsection
16752 RCS commands in LyX
16755 \begin_layout Standard
16756 The following sections describe the RCS commands supported by LyX.
16757 You can find them in the
16759 File\SpecialChar \menuseparator
16761 \begin_inset space ~
16767 LyX was tested against RCS 5.7.
16770 \begin_layout Subsubsection
16776 \begin_layout Standard
16777 If your document is not under revision control, this is the only item shown
16779 And if it is under revision control, the
16783 item is not visible.
16787 \begin_layout Standard
16788 This command registers your document with RCS (unless you are under the
16789 directory managed by CVS)\SpecialChar \@.
16790 You are asked interactively to supply an initial
16791 description of the document.
16792 The document is now set in Read-Only mode and you have to
16795 \begin_inset space ~
16799 \begin_inset space ~
16803 \begin_inset space ~
16808 , before making any changes to it.
16809 A document under revision control has a
16810 \begin_inset Quotes eld
16813 [RCS:<version> <locker>]
16814 \begin_inset Quotes erd
16817 item tagged to the filename in the minibuffer.
16820 \begin_layout Standard
16821 RCS command that is run:
16823 ci -q -u -i -t-"<initial description>" <file-name>
16826 \begin_layout Standard
16831 to understand the switches.
16835 \begin_layout Subsubsection
16841 \begin_layout Standard
16842 When you are finished editing a file, you check in your changes.
16843 When you do this, you are asked for a description of the changes.
16844 This is stored in the history log.
16845 The version number is bumped, your changes are applied to the master RCS
16846 file, the document is unlocked and set to Read-Only mode.
16850 \begin_layout Standard
16853 ci -q -u -m"<description>" <file-name>
16856 \begin_layout Subsubsection
16862 \begin_layout Standard
16863 By doing this you lock the document so that only you can edit it.
16864 This will also make the document Read-Write only for you.
16865 You will usually continue editing for a while and when you are finished
16866 you check in your changes.
16867 The status line is changed to reflect that you have locked the file.
16871 \begin_layout Standard
16874 co -q -l <file-name>
16877 \begin_layout Subsubsection
16880 Revert To Repository Version
16883 \begin_layout Standard
16884 This will discard all changes made to the document since the last check
16886 You get a warning before changes are discarded.
16889 \begin_layout Standard
16892 co -f -u<version> <file-name>
16895 \begin_layout Subsubsection
16901 \begin_layout Standard
16902 This makes as if the last check in never happened.
16903 No changes are made to the document loaded into LyX, but the last version
16904 is removed from the master RCS file.
16908 \begin_layout Standard
16911 rcs -o<version> <file-name>
16914 \begin_layout Subsubsection
16920 \begin_layout Standard
16921 This show the complete history of the RCS document.
16926 is shown in a browser.
16934 \begin_layout Subsection
16935 CVS commands in LyX
16938 \begin_layout Standard
16939 CVS is now partially supported by LyX.
16940 You can find the commands in the
16942 File\SpecialChar \menuseparator
16944 \begin_inset space ~
16952 \begin_layout Subsubsection
16958 \begin_layout Standard
16959 If your document is not under revision control, this is the only item shown
16961 And if it is under revision control, the
16968 item is not visible.
16972 \begin_layout Standard
16973 This command registers in CVS your document ONLY in case you have already
16974 the documents directory under CVS control (in particular
16979 This means you have to checkout the archive by yourself.
16983 \begin_layout Standard
16984 Then you are asked interactively to supply an initial description of the
16986 Don't forget that registered file is not yet commited.
16989 \begin_layout Standard
16990 CVS command that is run:
16993 \begin_inset Quotes erd
16997 \begin_inset Quotes eld
17001 \begin_inset Quotes erd
17007 \begin_layout Standard
17012 to understand the switches.
17016 \begin_layout Subsubsection
17022 \begin_layout Standard
17023 When you are finished editing a file, you commit your changes.
17024 When you do this, you are asked for a description of the changes.
17025 After that changes are commited.
17028 \begin_layout Standard
17031 cvs -q commit -m"<description>" "<file-name>"
17034 \begin_layout Subsubsection
17037 Revert To Repository Version
17040 \begin_layout Standard
17041 This will discard all changes made to the document since the last check
17043 You get a warning before changes are discarded.
17044 Firstly the file is deleted, secondly CVS update command is run.
17047 \begin_layout Standard
17051 \begin_inset Quotes eld
17055 \begin_inset Quotes erd
17061 \begin_layout Subsubsection
17067 \begin_layout Standard
17068 This show the complete history of the CVS document.
17072 \begin_inset Quotes eld
17076 \begin_inset Quotes erd
17081 is shown in a browser.
17084 \begin_layout Subsection
17085 SVN commands in LyX
17088 \begin_layout Standard
17089 SVN is now partially supported by LyX.
17090 You can find the commands in the
17092 File\SpecialChar \menuseparator
17094 \begin_inset space ~
17100 Please note that if you use password protected access to repository via
17101 ssh, you will be asked in terminal window.
17102 LyX was tested against SVN 1.4 and 1.5.
17105 \begin_layout Subsubsection
17111 \begin_layout Standard
17112 If your document is not under revision control, this is the only item shown
17114 And if it is under revision control, the
17121 item is not visible.
17125 \begin_layout Standard
17126 This command registers in SVN your document ONLY in case you have already
17127 the documents directory under SVN control (in particular
17132 This means you have to checkout the archive by yourself.
17136 \begin_layout Standard
17137 Then you are asked interactively to supply an initial description of the
17139 Don't forget that registered file is not yet commited.
17142 \begin_layout Standard
17143 SVN command that is run:
17146 \begin_inset Quotes eld
17150 \begin_inset Quotes erd
17156 \begin_layout Standard
17161 to understand the switches.
17165 \begin_layout Subsubsection
17171 \begin_layout Standard
17172 When you are finished editing a file, you commit your changes.
17173 When you do this, you are asked for a description of the changes.
17174 After that changes are commited.
17177 \begin_layout Standard
17182 \begin_layout Plain Layout
17183 In case locking is not enabled.
17185 \begin_inset CommandInset ref
17187 reference "subsec:SVN-File-Locking"
17198 svn commit -q -m"<description>" <file-name>
17201 \begin_layout Subsubsection
17207 \begin_layout Standard
17208 Updates the changes of this file from the repository.
17209 Be sure you understand SVN merging and conflicts resolving before using
17210 this function, because all conflicts has to be done manually by you!
17213 \begin_layout Standard
17218 \begin_layout Plain Layout
17227 \begin_inset Quotes eld
17231 \begin_inset Quotes erd
17237 \begin_layout Subsubsection
17240 Revert To Repository Version
17243 \begin_layout Standard
17244 This will discard all changes made to the document since the last check
17246 You get a warning before changes are discarded.
17250 \begin_layout Standard
17254 \begin_inset Quotes eld
17258 \begin_inset Quotes erd
17264 \begin_layout Subsubsection
17270 \begin_layout Standard
17271 This show the complete history of the SVN document.
17275 \begin_inset Quotes eld
17279 \begin_inset Quotes erd
17284 is shown in a browser.
17287 \begin_layout Subsubsection
17289 \begin_inset CommandInset label
17291 name "subsec:SVN-File-Locking"
17298 \begin_layout Standard
17299 The file exchange through various revision control systems brings the problem
17300 of merge conflicts in case two different users try to edit the same (parts
17302 When such conflict happens it needs manual resolving and one reasonable
17303 alternative is to provide some kind of locking mechanism, which guarantees
17304 that only one user is allowed to edit file at the given time.
17307 \begin_layout Standard
17308 SVN has two mechanisms to provide such kind of mutual exclusivity for file
17309 access - locks and automatical setting of write permissions based on
17310 \begin_inset Flex CharStyle:Code
17313 \begin_layout Plain Layout
17323 \begin_layout Plain Layout
17324 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
17330 In a case this property is detected for a given document LyX starts to
17331 use SVN locks for document editing automatically and the whole check-in/out
17332 mechanism switches to the same regimen as for RCS.
17333 This in particular means there are two different modes how file is used
17337 \begin_layout Itemize
17339 The loaded file is in the read-only mode.
17340 For editation on needs to check-out.
17345 consists of update from repository and gaining write lock.
17346 If the lock is not possible to obtain, we remain in unlocked state.
17349 \begin_layout Itemize
17351 The loaded file is in the 'normal' edit mode.
17352 No other user is allowed to edit the file.
17357 consists of commiting changes and releasing write-lock.
17358 If no changes have been made to the document, no commit will be produced
17362 \begin_layout Plain Layout
17363 Don't be puzzled by the fact that you will be asked for commit message anyway.
17368 and only the write-lock will be released.
17371 \begin_layout Standard
17375 \begin_layout Labeling
17376 \labelwidthstring 00.00.0000
17379 svn commit -q -m"<description>" "<file-name>"
17380 \begin_inset Newline newline
17383 svn unlock "<file-name>"
17386 \begin_layout Labeling
17387 \labelwidthstring 00.00.0000
17390 svn update "<file-name>"
17391 \begin_inset Newline newline
17394 svn lock "<file-name>"
17397 \begin_layout Subsection
17398 SVN and Windows Environment
17401 \begin_layout Quote
17402 My inclination is to say that if the user cannot figure out the command
17403 line operations on their own fairly quickly, they would be well advised
17404 to use TortoiseSVN.
17410 \begin_layout Subsubsection
17414 \begin_layout Standard
17415 In addition to installing LyX, and having access to a Subversion repository,
17416 the user will need to install the Subversion client program.
17417 A Windows installer for the client program is available from
17418 \begin_inset CommandInset href
17421 target "http://www.collab.net/nonav/downloads/subversion/"
17426 The user may also want to install
17427 \begin_inset CommandInset href
17430 target "http://tortoisesvn.tigris.org/"
17434 , which integrates Subversion operations into the context (rightclick) menu
17435 of Windows Explorer.
17436 Operations done outside LyX will typically be more convenient using the
17437 Explorer context menu.
17438 Note that TortoiseSVN is not a replacement for the client program, which
17439 is what LyX itself will use.
17442 \begin_layout Subsubsection
17443 Bringing a document under Subversion control
17446 \begin_layout Standard
17447 Before a LyX document can be brought under version control in Subversion,
17448 its parent directory needs to be under version control.
17449 If the document is being added to a project already in the repository,
17450 this is accomplished by checking the project out to the directory where
17451 the new document will be placed.
17452 If the project itself is not yet under version control (for instance, if
17453 this document starts a new project), the directory must be imported into
17455 This is done outside LyX.
17456 Both import and checkout are easily accomplished from the Explorer context
17457 menu using TortoiseSVN, or alternatively can be done using the command
17458 line client at a DOS prompt.
17459 The procedure for importing the project using TortoiseSVN is described
17460 below, assuming an existing repository and a new project being started
17468 For information on using the Subversion client program, run
17475 \begin_layout Enumerate
17482 in Windows Explorer, right click it, and select
17484 TortoiseSVN > Repo-browser
17487 If necessary, adjust the URL for the repository, then click OK.
17490 \begin_layout Enumerate
17491 Right click the level of the repository under which you want to place the
17492 new project folder (typically the top level) and click
17494 Create folder\SpecialChar \ldots{}
17497 Supply a name for the project folder and click OK.
17498 Add a message for the log file if desired, then click OK again.
17499 The new project folder should appear in the repository.
17500 Finally, click OK again to exit the repository browser.
17503 \begin_layout Enumerate
17504 Once again right click
17510 , this time selecting SVN Checkout\SpecialChar \ldots{}
17511 Select the URL of the project folder
17512 you just created in the repository, and set the checkout directory to
17520 You will be warned about a non-empty folder; click OK to proceed.
17521 You should now have a
17532 \begin_layout Enumerate
17533 Create or open your document in LyX and click
17538 ile\SpecialChar \menuseparator
17544 \begin_inset space ~
17547 Control\SpecialChar \menuseparator
17555 Add a log message and click OK to commit the document to version control.
17558 \begin_layout Standard
17559 From this point onward, you should have full functionality in the
17564 ile\SpecialChar \menuseparator
17570 \begin_inset space ~
17576 You also have the option of checking the document in and out, viewing its
17578 using the TortoiseSVN context menu in Windows Explorer or the Subversion
17579 client program from a command prompt.
17582 \begin_layout Subsection
17586 \begin_layout Standard
17587 With the recent addition of the vc-command function LyX power users are
17588 allowed to create their own commands for revision control.
17591 \begin_layout Standard
17592 As an example you can see how two TortoiseSVN commands could be integrated
17596 \begin_layout Description
17598 \begin_inset Flex CharStyle:Code
17601 \begin_layout Plain Layout
17602 vc-command D "." "TortoiseProc /command:commit /path:$$p"
17610 \begin_layout Description
17612 \begin_inset Flex CharStyle:Code
17615 \begin_layout Plain Layout
17616 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
17624 \begin_layout Section
17625 Literate Programming
17628 \begin_layout Standard
17633 (kayvan@sylvan.com)
17637 original documentation written by
17639 Edmar Wienskoski Jr.
17642 (edmar-w-jr@technologist.com)
17645 \begin_layout Subsection
17649 \begin_layout Standard
17650 The main purpose of this documentation is to show you how to use LyX for
17651 literate programming.
17652 Where it is assumed that you are familiar with this programming technique,
17654 \begin_inset Quotes eld
17658 \begin_inset Quotes erd
17662 \begin_inset Quotes eld
17666 \begin_inset Quotes erd
17670 If that is not the case, please follow the web links provided in the following
17672 There is a lot of good documentation out there covering old development
17673 history to the latest tools tips.
17676 \begin_layout Standard
17677 It is also assumed that you are familiar with LyX itself to a point that
17678 you are comfortable changing your LyX preferences, and X resources file.
17679 If that is not the case please refer to other LyX documentation to cover
17680 your specific needs.
17683 \begin_layout Subsection
17684 Literate Programming
17687 \begin_layout Standard
17688 From the Literate Programming FAQ:
17691 \begin_layout Quotation
17692 Literate programming is the combination of documentation and source together
17693 in a fashion suited for reading by human beings.
17694 In fact, literate programs should be enjoyable reading, even inviting!
17695 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
17696 and documentation in a single file.
17697 Literate programming tools then parse the file to produce either readable
17698 documentation or compilable source.
17699 The WEB style of literate programming was created by D.
17700 \begin_inset space \thinspace{}
17704 Knuth during the development of his TeX typesetting software.
17708 \begin_layout Standard
17709 Another excerpt says:
17712 \begin_layout Quotation
17715 How is literate programming different from verbose commenting?
17718 \begin_layout Quotation
17719 There are three distinguishing characteristics.
17720 In order of importance, they are:
17724 \begin_layout Itemize
17725 flexible order of elaboration
17728 \begin_layout Itemize
17729 automatic support for browsing
17732 \begin_layout Itemize
17733 typeset documentation, especially diagrams and mathematics
17737 \begin_layout Standard
17738 Now that I sparked your curiosity, take a look in the references.
17741 \begin_layout Subsubsection
17745 \begin_layout Standard
17746 The complete Literate Programming FAQ can be found at:
17749 \begin_layout Quote
17750 Literate Programming FAQ
17751 \begin_inset Flex URL
17754 \begin_layout Plain Layout
17756 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
17764 \begin_layout Standard
17765 The FAQ lists 23 (twenty three!) different literate programming tools.
17766 Where some are specialized or
17767 \begin_inset Quotes eld
17771 \begin_inset Quotes erd
17774 for particular programming languages, while other have general scope.
17779 for my own use for several reasons:
17782 \begin_layout Itemize
17783 It can generate the documentation either in LaTeX or HTML.
17786 \begin_layout Itemize
17787 It has a open architecture, i.
17788 \begin_inset space \thinspace{}
17792 \begin_inset space \space{}
17795 it is easy to plug in new filters and to perform special processing that
17800 \begin_layout Itemize
17801 There is a good selection of filters available already (the HTML is one
17805 \begin_layout Itemize
17809 \begin_layout Standard
17810 The Noweb web page can be found at:
17813 \begin_layout Quote
17815 \begin_inset Flex URL
17818 \begin_layout Plain Layout
17820 http://www.cs.virginia.edu/~nr/noweb/
17828 \begin_layout Standard
17829 Starting from there you can reach many other interesting links and even
17830 some literate program examples.
17833 \begin_layout Subsection
17834 LyX and Literate Programming
17837 \begin_layout Standard
17838 The LyX support for Literate Programming is provided by using the generic
17839 LyX converters mechanism.
17840 This support is provided in a
17841 \begin_inset Quotes eld
17845 \begin_inset Quotes erd
17849 \begin_inset space \thinspace{}
17853 \begin_inset space \space{}
17856 you will be able to use this new LyX feature with some other literate programmin
17857 g tool of your choice by just changing your LyX preferences.
17860 \begin_layout Subsubsection
17861 Generating documents and code (weaving and tangling)
17864 \begin_layout Paragraph
17865 Selecting the document class
17868 \begin_layout Standard
17869 If you have installed Noweb and LyX successfully, whenever you open a new
17870 document or try to change the document class of an existing one, you will
17871 find that there are three new document classes available:
17874 \begin_layout Itemize
17878 \begin_layout Itemize
17882 \begin_layout Itemize
17886 \begin_layout Standard
17887 You must select one of them to create your literate documents from.
17891 \begin_layout Standard
17892 Note that literate documents are not limited to these three classes.
17893 New classes can be generated from other styles like letter or in combination
17894 with other class variations like Article (AMS).
17895 If you have special needs that cannot be covered by one of the existing
17896 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
17897 will arrange to insert a new entry, or teach you how to do it.
17901 \begin_layout Plain Layout
17902 It is very simple, it involves the creation of a file with four lines, and
17903 re-running of the auto configuration.
17908 Moreover, if you use a literate tool other than Noweb you may need to create
17909 a new set of document classes for it.
17912 \begin_layout Paragraph
17916 \begin_layout Standard
17917 LyX enables you to write code with a layout named
17925 \begin_layout Plain Layout
17926 The equivalent Noweb term is
17927 \begin_inset Quotes eld
17931 \begin_inset Quotes erd
17935 For historical reasons, I got used to the term
17936 \begin_inset Quotes eld
17940 \begin_inset Quotes erd
17943 introduced by other literate tool named Nuweb, which I used for many years
17944 before rendering myself to Noweb.
17949 Noweb delimits scraps like this:
17952 \begin_layout LyX-Code
17956 \begin_layout LyX-Code
17960 \begin_layout LyX-Code
17964 \begin_layout LyX-Code
17968 \begin_layout LyX-Code
17972 \begin_layout Standard
17973 The problem is that whatever is written in between the << and the
17977 must be taken literally, i.
17978 \begin_inset space \thinspace{}
17982 \begin_inset space \space{}
17985 LyX should be prevented from making any special interpretation of what has
17987 This is handled by a special layout named Scrap, that works like a normal
17988 paragraph but has a free spacing capability.
17991 \begin_layout Standard
17992 The down side of the Scrap paragraph layout is that consecutive paragraphs
17993 of code will be spaced with one empty line in the source code and also
17994 in the printed documentation.
17995 The work around is to enter each line of code within a single Scrap, with
17996 a newline (ctrl-return).
17997 The example above will look like this:
18001 \begin_layout Plain Layout
18002 If you have a printed version of this document you will not see any difference
18003 between the previous example and this one.
18011 \begin_layout LyX-Code
18013 \begin_inset Newline newline
18017 \begin_inset Newline newline
18021 \begin_inset Newline newline
18025 \begin_inset Newline newline
18031 \begin_layout Standard
18032 This layout works fine.
18033 The only real inconvenience is that you have to type ctrl-return instead
18038 \begin_layout Plain Layout
18039 It is in my list of
18040 \begin_inset Quotes eld
18044 \begin_inset Quotes erd
18055 \begin_layout Standard
18056 As a special note, you can also use the
18057 \begin_inset Quotes eld
18061 \begin_inset Quotes erd
18064 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
18068 \begin_layout LyX-Code
18070 \begin_inset Newline newline
18073 def some_function(args):
18074 \begin_inset Newline newline
18077 "This is the doc string for this function."
18078 \begin_inset Newline newline
18081 print "My args: ", args
18084 \begin_layout LyX-Code
18085 @ %def some_function
18088 \begin_layout Standard
18089 For an example of this usage and the resulting cross-reference output, look
18090 at the Literate python program in
18092 LIBDIR/examples/listerrors.lyx
18094 which should make this all clear.
18097 \begin_layout Paragraph
18098 Generating the documentation
18101 \begin_layout Standard
18102 At this point you already have a new document file with a proper document
18103 class, and with some code and text on it.
18104 How do I print it? The answer is simple, you select
18106 View\SpecialChar \menuseparator
18110 Just like you would do for a plain document.
18111 No special procedure is required.
18114 \begin_layout Standard
18115 To help orientate you, I will now explain what happens inside LyX:
18118 \begin_layout Enumerate
18121 Update\SpecialChar \menuseparator
18124 menu option is chosen, a LaTeX file is generated.
18129 \begin_layout Standard
18130 If the document is of any literate class the generated file will be named
18131 with an extension name defined by the
18132 \begin_inset Quotes eld
18136 \begin_inset Quotes erd
18139 format (defined in the Preferences panel), otherwise the file will have
18148 \begin_layout Enumerate
18149 Note that the only difference so far is in the name of the file, no special
18150 processing is required by LyX.
18151 Given that you formatted the code using the Scrap layout that, by itself,
18152 takes care of the business.
18155 \begin_layout Enumerate
18156 If the document is of any literate class LyX will then use the internal
18157 LyX to Noweb converter, followed by the Noweb to LaTeX converter
18161 \begin_layout Plain Layout
18162 The converters are defined in the
18164 Tools\SpecialChar \menuseparator
18168 \begin_inset Quotes eld
18172 \begin_inset Quotes erd
18184 manual for general information about converters.
18189 to generate the LaTeX file.
18193 \begin_layout Standard
18194 Otherwise it will just skip this step.
18198 \begin_layout Enumerate
18199 Finally, LaTeX is invoked and the regular post processing continues as in
18203 \begin_layout Standard
18204 Independence from a particular
18205 \begin_inset Quotes eld
18209 \begin_inset Quotes erd
18212 is easily achieved by changing the commands that are run by the various
18216 \begin_layout Paragraph
18217 Generating the code
18220 \begin_layout Standard
18221 When the build menu option is chosen or the corresponding button in the
18222 toolbar is pressed, a LaTeX file is generated just like step 1 above.
18223 Next, LyX invokes the
18228 This converter needs to be defined by the user and is not installed by
18229 default, though the Program format is.
18230 This converter (like any other converter) will have two parts:
18233 \begin_layout Enumerate
18234 The converter program itself.
18235 This program performs the conversion from the one format to the other (in
18236 this case, from the Noweb format to the Program pseudo-format).
18239 \begin_layout Enumerate
18240 The error log parser.
18241 This is a program whose sole purpose is to rewrite error messages in a
18242 format that LyX understands.
18243 This makes it possible for LyX to place error boxes in the right places
18244 in the file buffer.
18247 \begin_layout Standard
18248 The first part, the
18249 \begin_inset Quotes eld
18253 \begin_inset Quotes erd
18256 setting, should be set to
18257 \begin_inset Quotes eld
18265 \begin_inset Quotes erd
18269 This basically means that LyX will call
18270 \begin_inset Quotes eld
18274 \begin_inset Quotes erd
18277 (a program or script) with the name of the Noweb file (normally a file
18278 in the LyX temp directory).
18282 \begin_layout Standard
18283 This is an implementation of
18284 \begin_inset Quotes eld
18288 \begin_inset Quotes erd
18291 that you can place in a directory on your path:
18294 \begin_layout LyX-Code
18298 \begin_layout LyX-Code
18302 \begin_layout LyX-Code
18303 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
18306 \begin_layout Standard
18307 The next part of the converter setting is the
18308 \begin_inset Quotes eld
18312 \begin_inset Quotes erd
18315 which is to be set to
18316 \begin_inset Quotes eld
18321 parselog=listerrors
18324 \begin_inset Quotes erd
18328 This will run any errors that are generated by the
18329 \begin_inset Quotes eld
18333 \begin_inset Quotes erd
18336 process through the
18337 \begin_inset Quotes eld
18341 \begin_inset Quotes erd
18347 \begin_layout Standard
18348 The converter code looks in
18356 then on the path for the
18357 \begin_inset Quotes eld
18361 \begin_inset Quotes erd
18367 \begin_layout Standard
18368 The build will normally take place in LyX's temporary directory, so the
18369 files produced by the conversion will be in that directory.
18370 LyX will copy out what it regards as the `main' file, but the
18374 conversion may produce several files, and so most of these would then be
18375 deleted when LyX was closed.
18376 The present solution is to use a `copier',
18380 \begin_layout Plain Layout
18389 manual for information on these.
18398 script in its default mode, so that the entire contents of the temporary
18399 directory is copied.
18400 More will get copied than is needed, to be sure, but nothing will be lost.
18401 If, however, you know what extensions the generated files will have, this
18402 can be improved by using the
18411 This option takes a comma-separated list of extensions to copy.
18412 So, for example, if the conversion will generate only files with the extensions
18421 , then the correct definition would be:
18424 \begin_layout LyX-Code
18425 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
18428 \begin_layout Standard
18429 The result will be that only files with these two extensions will be copied
18433 \begin_layout Paragraph
18434 Build instructions in the document
18437 \begin_layout Standard
18438 The last piece of the integration between LyX and noweb is the
18439 \begin_inset Quotes eld
18443 \begin_inset Quotes erd
18447 Generally, the instructions for building your program should be embedded
18448 in a scrap of its own.
18450 \begin_inset Quotes eld
18454 \begin_inset Quotes erd
18457 above uses the notangle command to look for this scrap (called
18458 \begin_inset Quotes eld
18462 \begin_inset Quotes erd
18465 ) and runs its contents through
18466 \begin_inset Quotes eld
18470 \begin_inset Quotes erd
18476 \begin_layout Standard
18477 Typically, such a scrap would look something like this:
18480 \begin_layout LyX-Code
18482 \begin_inset Newline newline
18486 \begin_inset Newline newline
18490 \begin_inset Newline newline
18493 if [ -z "${NOWEB_SOURCE}" ]
18494 \begin_inset Newline newline
18498 \begin_inset Newline newline
18501 NOWEB_SOURCE=myfile.nw
18502 \begin_inset Newline newline
18506 \begin_inset Newline newline
18510 code to extract files ...]
18511 \begin_inset Newline newline
18515 code to compile files ...]
18516 \begin_inset Newline newline
18522 \begin_layout Standard
18525 LIBDIR/examples/listerrors.lyx
18529 LIBDIR/examples/Literate.lyx
18531 which implement two versions of the
18532 \begin_inset Quotes eld
18536 \begin_inset Quotes erd
18539 program for some illustrations of how all of these pieces go together or
18542 LIBDIR/examples/noweb2lyx.lyx.
18545 Interestingly, these three files show off the language-indepence of the
18546 LyX literate programming support since they are written in Python, C and
18550 \begin_layout Subsubsection
18554 \begin_layout Standard
18555 All the Literate Programming support is configured by the
18557 Tools\SpecialChar \menuseparator
18561 \begin_inset Quotes eld
18565 \begin_inset Quotes erd
18569 The important parts are:
18572 \begin_layout Description
18574 \begin_inset space ~
18578 \begin_inset Quotes eld
18582 \begin_inset Quotes erd
18586 \begin_inset space ~
18589 format Set up via the Formats tab, this is where the Noweb-specific pieces
18599 , the file extension is set to
18604 This tells LyX to create a file with a
18608 extension in the first step of the conversion process.
18611 \begin_layout Description
18613 \begin_inset space ~
18621 \begin_inset space ~
18624 format This is an empty format whose sole purpose is to be the endpoint
18625 of a conversion (which then allows us to set up a converter for it).
18628 \begin_layout Description
18637 This converter performs the
18638 \begin_inset Quotes eld
18642 \begin_inset Quotes erd
18645 of the literate document.
18646 For Noweb, it is set to
18647 \begin_inset Quotes eld
18652 noweave -delay -index $$i > $$o
18655 \begin_inset Quotes erd
18661 \begin_layout Description
18671 \begin_inset Quotes eld
18675 \begin_inset Quotes erd
18679 As stated above, the Converter is set to
18680 \begin_inset Quotes eld
18688 \begin_inset Quotes erd
18691 , with Flags set to
18692 \begin_inset Quotes eld
18697 originaldir,parselog=listerrors
18700 \begin_inset Quotes erd
18706 \begin_layout Subsubsection
18710 \begin_layout Standard
18711 There is also a new function implemented in the LyX server, the
18712 \begin_inset Quotes eld
18715 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
18719 \begin_layout Standard
18720 When debugging code with ddd/gdb, it is possible to invoke a text editor
18721 at the current execution position with a single key stroke.
18722 The default ddd configuration for that is shift-ctrl-V.
18723 It happens that you can define the editor command line invocation in ddd
18726 Edit\SpecialChar \menuseparator
18727 Preferences\SpecialChar \menuseparator
18730 dialog and changing the "Edit Sources" entry.
18733 \begin_layout Standard
18734 I take advantage of the new created LyX server function and this ddd feature,
18736 \begin_inset Quotes eld
18740 \begin_inset Quotes erd
18746 \begin_layout LyX-Code
18747 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
18750 \begin_layout Standard
18751 With this, whenever you are using ddd and find a point in the program that
18752 you want to edit, you just press shift-ctrl-V (in the ddd window), and
18753 ddd you forward this information to LyX through the LyX server and then
18754 the LyX window will show the same file with the cursor at the same position
18755 ddd was pointing to.
18756 No more guessing or long scrolling to locate a point in the program back
18760 \begin_layout Standard
18761 Note however that you must enable the LyX server to get this feature working
18762 (it is disabled by default).
18763 You can enable it in
18775 ) by entering in the
18780 \begin_inset Quotes eld
18785 /home/<your-home-directory>/.lyx/lyxpipe
18788 \begin_inset Quotes erd
18794 \begin_layout Standard
18795 Read the LyX server documentation in the
18797 Customization Manual
18799 for further information.
18802 \begin_layout Subsubsection
18806 \begin_layout Standard
18807 There are six new buttons that can be added to your LyX toolbar.
18808 Five of these buttons are short cuts to layout styles:
18829 The last one is a short cut to the
18830 \begin_inset Quotes eld
18834 \begin_inset Quotes erd
18841 \begin_layout Standard
18842 LyX has a range of buttons that are available for tool bar customization.
18843 In my toolbar I like to combine the six short cuts above with two more:
18848 \SpecialChar \menuseparator
18853 \SpecialChar \menuseparator
18860 View\SpecialChar \menuseparator
18864 Here is how it looks like:
18867 \begin_layout LyX-Code
18871 \begin_layout LyX-Code
18875 \begin_layout LyX-Code
18876 Icon "layout Standard"
18879 \begin_layout LyX-Code
18880 Icon "layout Section"
18883 \begin_layout LyX-Code
18884 Icon "layout LaTeX"
18887 \begin_layout LyX-Code
18888 Icon "layout LyX-Code"
18891 \begin_layout LyX-Code
18892 Icon "layout Scrap"
18895 \begin_layout LyX-Code
18899 \begin_layout LyX-Code
18903 \begin_layout LyX-Code
18904 Icon "buffer-typeset"
18907 \begin_layout LyX-Code
18908 Icon "build-program"
18911 \begin_layout LyX-Code
18915 \begin_layout LyX-Code
18919 \begin_layout LyX-Code
18923 \begin_layout LyX-Code
18927 \begin_layout LyX-Code
18931 \begin_layout Subsubsection
18932 Colors customization
18935 \begin_layout Standard
18936 There are a number of colors in LyX that can be customized in
18941 One of the things that bothers people is the LaTeX font color.
18942 The default color is red, since the scraps uses LaTeX font, and there is
18943 a lot of scraps in literate documents, you may get tired of seeing everything
18945 You can change it by going to the tabs
18954 \begin_layout Standard
18955 The next thing is the visible presence of the newline character in the screen.
18956 You can choose the color of this particular character and make it blend
18958 I recommend you choosing a color that is close to the background but not
18959 equal, that way you still can see it is there, but it is not bothering
18964 \begin_layout Chapter
18965 Secrets of the LaTeX Masters
18966 \begin_inset CommandInset label
18975 \begin_layout Standard
18976 Though LyX is a powerful tool, it cannot hope to support everything that
18977 can be done with pure TeX/LaTeX.
18978 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
18979 as long as you are not afraid to use that
18980 \begin_inset Quotes eld
18984 \begin_inset Quotes erd
18987 button on the toolbar or add things to the LaTeX preamble.
18988 This section lists some tips, tricks, and otherwise cool ideas to give
18989 your document that extra little flair.
18992 Do try this at home
18994 , just start with something a little smaller and less important than your
18998 \begin_layout Standard
18999 Most ideas in this section require less common files in your LaTeX installation.
19000 If you have a system like teTeX, most will already be available.
19001 A few, however, will need to be downloaded from one of the CTAN archives.
19002 Often, there are several ways to do something, or several LaTeX style files
19003 which do the same thing.
19004 We do not endorse one choice over another, we simply claim that we have
19005 done a particular task with a particular file.
19006 Put on your wizard hat, keep an eye out for dragons, and let us begin.
19009 \begin_layout Section
19013 \begin_layout Standard
19016 Lars Gullik Bjønnes
19019 \begin_layout Subsection
19023 \begin_layout Standard
19024 The aim for this chapter
19028 \begin_layout Plain Layout
19029 Editor's note: Lars' original chapter was a masterful description of how
19035 However, it was too long to flow smoothly in this document.
19036 I have therefore chosen to excerpt the most important sections here (sorry,
19037 Lars); you can read the original chapter (and more of the story!) in the
19040 examples/multicol.lyx
19048 is to show how the LaTeX package
19052 can be used in a LyX document.
19053 As LyX doesn't support the
19057 package natively yet, we have to use some small hacks.
19058 By reading this section it should be obvious how to do this.
19061 \begin_layout Subsection
19065 \begin_layout Standard
19070 package allows switching between one and multicolumn format on the same
19072 Footnotes are handled correctly (for the most part), but will be placed
19073 at the bottom of the page and not under each column.
19074 LaTeX's float mechanism, however, is partly disabled in the current implementat
19076 At the moment only page-wide floats can be used within the scope of the
19080 \begin_layout Subsection
19084 \begin_layout Subsubsection
19088 \begin_layout Standard
19089 If you want to have two columns in your text, you have use LaTeX mode to
19094 begin{multicols}{2}
19096 at the point where you want the two column layout to start, and then
19102 where you want it to end.
19106 \begin_layout Standard
19110 \begin_layout Plain Layout
19114 begin{multicols}{2}
19122 \begin_layout Standard
19127 The Adventure of the Empty House
19130 \begin_inset Newline newline
19135 Sir Arthur Conan Doyle
19138 \begin_layout Standard
19141 It was in the spring of the year 1894 that all London was interested, and
19142 the fashionable world dismayed, by the murder of the Honourable Ronald
19143 Adair under most unusual and inexplicable circumstances.
19144 The public has already learned those particulars of the crime which came
19145 out in the police investigation, but a good deal was suppressed upon that
19146 occasion, since the case for the prosecution was so overwhelmingly strong
19147 that it was not necessary to bring forward all the facts.
19148 Only now, at the end of nearly ten years, am I allowed to supply those
19149 missing links which make up the whole of that remarkable chain.
19150 The crime was of interest in itself, but that interest was as nothing to
19151 me compared to the inconceivable sequel, which afforded me the greatest
19152 shock and surprise of any event in my adventurous life.
19153 Even now, after this long interval, I find myself thrilling as I think
19154 of it, and feeling once more that sudden flood of joy, amazement, and increduli
19155 ty which utterly submerged my mind.
19156 Let me say to that public, which has shown some interest in those glimpses
19157 which I have occasionally given them of the thoughts and actions of a very
19158 remarkable man, that they are not to blame me if I have not shared my knowledge
19159 with them, for I should have considered it my first duty to do so, had
19160 I not been barred by a positive prohibition from his own lips, which was
19161 only withdrawn upon the third of last month.
19164 \begin_layout Standard
19168 \begin_layout Plain Layout
19180 \begin_layout Subsubsection
19184 \begin_layout Standard
19185 The same pattern is used when you want more than two columns:
19188 \begin_layout Standard
19192 \begin_layout Plain Layout
19196 begin{multicols}{3}
19204 \begin_layout Standard
19207 It can be imagined that my close intimacy with Sherlock Holmes had interested
19208 me deeply in crime, and that after his disappearance I never failed to
19209 read with care the various problems which came before the public.
19210 And I even attempted, more than once, for my own private satisfaction,
19211 to employ his methods in their solution, though with indifferent success.
19212 There was none, however, which appealed to me like this tragedy of Ronald
19214 As I read the evidence at the inquest, which led up to a verdict of willful
19215 murder against some person or persons unknown, I realized more clearly
19216 than I had ever done the loss which the community had sustained by the
19217 death of Sherlock Holmes.
19218 There were points about this strange business which would, I was sure,
19219 have specially appealed to him, and the efforts of the police would have
19220 been supplemented, or more probably anticipated, by the trained observation
19221 and the alert mind of the first criminal agent in Europe.
19222 All day, as I drove upon my round, I turned over the case in my mind and
19223 found no explanation which appeared to me to be adequate.
19224 At the risk of telling a twice-told tale, I will recapitulate the facts
19225 as they were known to the public at the conclusion of the inquest.
19228 \begin_layout Standard
19232 \begin_layout Plain Layout
19244 \begin_layout Standard
19245 You can have more than 3 columns if you want to, but that might not be very
19246 pleasant for the eye.
19249 \begin_layout Subsubsection
19250 Columns inside columns
19253 \begin_layout Standard
19254 You can even have columns inside columns:
19257 \begin_layout Standard
19261 \begin_layout Plain Layout
19265 begin{multicols}{2}
19273 \begin_layout Standard
19276 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
19277 at that time governor of one of the Australian colonies.
19278 Adair's mother had returned from Australia to undergo the operation for
19279 cataract, and she, her son Ronald, and her daughter Hilda were living together
19283 \begin_layout Standard
19287 \begin_layout Plain Layout
19291 begin{multicols}{2}
19299 \begin_layout Standard
19302 The youth moved in the best society–had, so far as was known, no enemies
19303 and no particular vices.
19304 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
19305 had been broken off by mutual consent some months before, and there was
19306 no sign that it had left any very profound feeling behind it.
19307 For the rest {sic} the man's life moved in a narrow and conventional circle,
19308 for his habits were quiet and his nature unemotional.
19309 Yet it was upon this easy-going young aristocrat that death came, in most
19310 strange and unexpected form, between the hours of ten and eleven-twenty
19311 on the night of March 30, 1894.
19314 \begin_layout Standard
19318 \begin_layout Plain Layout
19330 \begin_layout Standard
19333 Ronald Adair was fond of cards–playing continually, but never for such stakes
19335 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
19336 It was shown that, after dinner on the day of his death, he had played
19337 a rubber of whist at the latter club.
19338 He had also played there in the afternoon.
19343 The evidence of those who had played with him– Mr.
19344 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
19345 and that there was a fairly equal fall of the cards.
19346 Adair might have lost five pounds, but not more.
19347 His fortune was a considerable one, and such a loss could not in any way
19349 He had played nearly every day at one club or other, but he was a cautious
19350 player, and usually rose a winner.
19351 It came out in evidence that, in partnership with Colonel Moran, he had
19352 actually won as much as four hundred and twenty pounds in a sitting, some
19353 weeks before, from Godfrey Milner and Lord Balmoral.
19354 So much for his recent history as it came out at the inquest.
19357 \begin_layout Standard
19361 \begin_layout Plain Layout
19373 \begin_layout Standard
19374 Please do read the file
19376 examples/multicol.lyx
19378 for more advanced examples including column and header spacing, vertical
19379 separator lines, and more.
19382 \begin_layout Section
19387 Paragraph Environment
19388 \begin_inset OptArg
19391 \begin_layout Plain Layout
19392 Numbering in Enumerate
19400 \begin_layout Standard
19406 \begin_layout Standard
19407 \begin_inset VSpace bigskip
19413 \begin_layout Standard
19415 The default numbering for the
19419 paragraph environment begins with Arabic numbers and ends with uppercase
19421 Suppose, however, you wanted a different type of numbering scheme.
19422 Here's a quickie example of how to change the numbering scheme:
19425 \begin_layout LyX-Code
19435 \begin_layout LyX-Code
19445 \begin_layout LyX-Code
19455 \begin_layout LyX-Code
19465 \begin_layout Standard
19466 \SpecialChar \ldots{}
19467 which changes the numbering scheme to uppercase Roman numerals, uppercase
19468 letters, Arabic numbers, and lowercase letter.
19471 \begin_layout Standard
19472 Additionally, the previous example also adds a little bit extra to the numbering
19474 For example, the first level label actually looks like:
19475 \begin_inset Quotes eld
19479 \begin_inset Quotes erd
19483 For ease of reading, we'll describe what the numbering schemes look like
19484 using a notation something like this: <
19485 \begin_inset Quotes eld
19489 \begin_inset Quotes erd
19493 \begin_inset space ~
19497 \begin_inset Quotes erd
19501 \begin_inset Quotes erd
19505 \begin_inset space ~
19509 \begin_inset Quotes erd
19513 \begin_inset Quotes erd
19517 \begin_inset space ~
19521 \begin_inset Quotes eld
19525 \begin_inset Quotes erd
19532 \begin_layout Standard
19533 As you can see in the example, there is a label command for each nesting
19540 \SpecialChar \ldots{}
19547 , as well as a counter,
19551 \SpecialChar \ldots{}
19557 There are also five
19558 \begin_inset Quotes eld
19562 \begin_inset Quotes erd
19595 , each of which take one counter as an argument.
19596 You can add characters before or after these, but there's no need to add
19600 \begin_layout Standard
19601 You can get really fancy with these.
19605 \begin_layout LyX-Code
19619 \begin_layout LyX-Code
19631 \begin_layout LyX-Code
19641 \begin_layout LyX-Code
19651 \begin_layout Standard
19652 produces the somewhat out of hand numbering scheme: <
19653 \begin_inset Quotes eld
19657 \begin_inset Quotes erd
19661 \begin_inset space ~
19665 \begin_inset Quotes erd
19669 \begin_inset Quotes erd
19673 \begin_inset space ~
19677 \begin_inset Quotes erd
19681 \begin_inset Quotes erd
19685 \begin_inset space ~
19689 \begin_inset Quotes eld
19693 \begin_inset Quotes erd
19700 \begin_layout Standard
19704 \begin_layout Section
19708 \begin_layout Standard
19714 \begin_layout Standard
19715 \begin_inset VSpace bigskip
19721 \begin_layout Standard
19726 \begin_layout Plain Layout
19732 tmpfont}{cmr17 scaled 2500}{
19744 \begin_layout Standard
19749 \begin_layout Plain Layout
19760 hose of you who like the style of old books probably also like
19761 \begin_inset Quotes eld
19765 \begin_inset Quotes erd
19768 —those large capital letters which begin each new chapter or section.
19769 Implementing them with plain LyX/LaTeX is straightforward (assuming you
19770 know some plain TeX!) but does require a lot of work and many iterations,
19771 as you can see by all the ugly TeX-mode stuff at the beginning of this
19775 \begin_layout Standard
19779 \begin_layout Plain Layout
19785 bigdrop{-1em}{3}{ptmri}{T}+
19790 here is a much easier way of doing this, of course.
19799 ) package from CTAN allows a simple way to add such letters to your documents.
19800 Since this package is not a standard part of teTeX, I can't demonstrate
19801 it within this document, but if you copy this paragraph to a new document,
19803 \begin_inset Quotes eld
19813 \begin_inset Quotes erd
19816 and the pluses from the TeX code at the beginning of the paragraph, and
19821 usepackage{dropcaps}
19823 to your LaTeX preamble, you will get a nice Times Roman Italic
19824 \begin_inset Quotes eld
19828 \begin_inset Quotes erd
19831 , whose height is three lines of text and which protrudes 1 em into the
19833 (Make certain you have copied
19834 \begin_inset Quotes eld
19842 \begin_inset Quotes erd
19845 into a directory where TeX can see it.) The first argument is the amount
19846 of indentation; in this case the negative sign moves it into the margin.
19847 The second argument is the height of the letter in number of lines of text.
19848 The third argument is the font name: virtually anything which has a tfm
19849 file should work (wade through the
19851 .../texmf/fonts/tfm
19853 directory for possibilities).
19854 My personal favorite is
19855 \begin_inset Quotes eld
19863 \begin_inset Quotes erd
19866 , a fancy German font specifically designed for dropped capitals.
19867 The fourth argument is the letter (or letters) to be dropped.
19872 package also offers the
19878 command, as well as a slightly simplified
19887 \begin_layout Section
19888 Non-standard Paragraph Shapes
19891 \begin_layout Standard
19897 \begin_layout Standard
19898 \begin_inset VSpace bigskip
19904 \begin_layout Standard
19908 \begin_layout Plain Layout
19920 \begin_layout Standard
19924 \begin_layout Plain Layout
19933 \begin_layout Plain Layout
19947 \begin_layout Standard
19952 \begin_layout Plain Layout
19963 \begin_layout Plain Layout
19972 \begin_layout Plain Layout
19981 \begin_layout Plain Layout
19990 \begin_layout Plain Layout
19999 \begin_layout Plain Layout
20008 \begin_layout Plain Layout
20017 \begin_layout Plain Layout
20026 \begin_layout Plain Layout
20035 \begin_layout Plain Layout
20044 \begin_layout Plain Layout
20053 \begin_layout Plain Layout
20062 \begin_layout Plain Layout
20071 \begin_layout Plain Layout
20080 \begin_layout Plain Layout
20089 \begin_layout Plain Layout
20098 \begin_layout Plain Layout
20107 \begin_layout Plain Layout
20116 \begin_layout Plain Layout
20125 \begin_layout Plain Layout
20131 There are times when the tyranny of rectangular paragraphs must be overthrown.
20132 In such situations, a call to the delightful plain TeX command
20139 As you can see, completely arbitrary shapes can be laid out with a suitable
20140 set of linelength definitions.
20141 While this parshape may look a bit silly and useless, one could conceive
20142 of situations such as finely tuned dropped capitals, word wrapping around
20143 non-rectangular graphics, etc.
20144 which will benefit from such handcrafting.
20147 \begin_layout Standard
20148 \begin_inset VSpace bigskip
20154 \begin_layout Standard
20159 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
20166 is the number of lines of text which define the paragraph.
20167 If there turn out to be fewer lines, the shape is truncated; if there are
20168 more, the excess lines have the same dimensions as the last line of the
20178 entries specify the indentation of the line from the left margin, and the
20179 length of the line as measured from that point.
20180 The shape applies only to the current paragraph; everything is reset to
20181 normal for the next paragraph.
20184 \begin_layout Standard
20188 \begin_layout Plain Layout
20200 \begin_layout Section
20204 \begin_layout Standard
20205 As you can see, the examples in this section range from the useful to the
20207 While I don't expect that anyone will ever need the paragraph shape demonstrate
20208 d in the last section, the important point is that you can do almost anything
20209 you want in LyX if you are willing to figure out how to do it in TeX and
20211 TeX is a fantastically powerful typesetting system and all that power is
20212 available to you since LyX uses it as its backend.
projects / lyx.git / blob