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 natively 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
4145 but it does work with Cygwin versions of LyX.
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
4476 \begin_inset Newline newline
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 Section
4614 \begin_layout Standard
4615 Some DVI viewers provide the reverse DVI search feature (also called
4619 ), allowing the cursor in LyX to automatically jump to the point corresponding
4620 to a given position in the previewed DVI file.
4621 A program or script will be called by the DVI viewer when initiating a
4623 The way the search is triggered depends on the viewer (for example,
4624 \begin_inset Flex CharStyle:Code
4627 \begin_layout Plain Layout
4633 uses Ctrl-click, whereas
4634 \begin_inset Flex CharStyle:Code
4637 \begin_layout Plain Layout
4643 uses double click) but in general the program is called with two arguments,
4644 a filename and a line number, and, in turn, it should pass this info to
4645 a running instance of LyX.
4646 This can be done through the LyX server either by using the named pipe,
4647 or the unix domain socket that lyx creates in its temporary directory (this
4649 \begin_inset Flex CharStyle:Code
4652 \begin_layout Plain Layout
4658 program communicates with LyX).
4661 \begin_layout Standard
4662 The reverse DVI search feature can be enabled in LyX as follows:
4665 \begin_layout Itemize
4666 The DVI file should contain suitable info (src-specials) produced either
4667 by using appropriate options when calling the LaTeX compiler (method 1),
4669 \begin_inset Flex CharStyle:Code
4672 \begin_layout Plain Layout
4682 \begin_layout Description
4684 \begin_inset space ~
4687 1 If you use recent texlive or miktex distributions, change the
4688 \begin_inset Flex CharStyle:MenuItem
4691 \begin_layout Plain Layout
4696 \begin_layout Plain Layout
4709 \begin_inset Flex CharStyle:MenuItem
4712 \begin_layout Plain Layout
4717 \begin_layout Plain Layout
4724 eX (plain)->DraftDVI
4730 \begin_inset Flex CharStyle:MenuItem
4733 \begin_layout Plain Layout
4734 Tools\SpecialChar \menuseparator
4735 Preferences\SpecialChar \menuseparator
4736 File Handling\SpecialChar \menuseparator
4743 \begin_inset Flex CharStyle:Code
4746 \begin_layout Plain Layout
4747 latex -src-specials $$i
4752 , otherwise check what is the appropriate option for your TeX engine.
4755 \begin_layout Description
4757 \begin_inset space ~
4760 2 As an alternative to redefining the converter (maybe because you use the
4761 pplatex command instead of latex for producing a DVI file), insert
4762 \begin_inset Flex CharStyle:Code
4765 \begin_layout Plain Layout
4768 usepackage[active]{srcltx}
4773 in the preamble of the LyX file.
4777 \begin_layout Itemize
4779 \begin_inset Flex CharStyle:Code
4782 \begin_layout Plain Layout
4788 , you don't need to do anything else, as LyX already provides the necessary
4789 hooks for automatically using the
4790 \begin_inset Flex CharStyle:Code
4793 \begin_layout Plain Layout
4800 However, if for whatever reason you want to use the named pipe instead
4801 of the socket for communicating with lyx, simply change the DVI viewer
4803 \begin_inset Flex CharStyle:MenuItem
4806 \begin_layout Plain Layout
4807 Tools\SpecialChar \menuseparator
4808 Preferences\SpecialChar \menuseparator
4809 File Handling\SpecialChar \menuseparator
4816 \begin_inset Flex CharStyle:Code
4819 \begin_layout Plain Layout
4820 xdvi -editor 'lyxeditor.sh %f %l'
4826 \begin_inset Flex CharStyle:Code
4829 \begin_layout Plain Layout
4835 is a suitable script.
4836 For example, a minimal shell script is the following one:
4840 \begin_layout LyX-Code
4842 \begin_inset Newline newline
4845 LYXPIPE="/path/to/lyxpipe"
4846 \begin_inset Newline newline
4849 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
4850 \begin_inset Newline newline
4853 echo "$COMMAND" > "${LYXPIPE}".in || exit
4854 \begin_inset Newline newline
4857 read < "${LYXPIPE}".out || exit
4860 \begin_layout Standard
4862 \begin_inset Flex CharStyle:Code
4865 \begin_layout Plain Layout
4871 is the LyXServer pipe path specified in
4872 \begin_inset Newline newline
4876 \begin_inset Flex CharStyle:MenuItem
4879 \begin_layout Plain Layout
4880 Tools\SpecialChar \menuseparator
4881 Preferences\SpecialChar \menuseparator
4891 \begin_layout Itemize
4892 If you use the Cygwin version of LyX and yap as a viewer, you should set
4893 the name of the program that communicates with LyX directly in yap as follows.
4894 After launching yap, choose its
4895 \begin_inset Flex CharStyle:MenuItem
4898 \begin_layout Plain Layout
4899 View\SpecialChar \menuseparator
4905 menu and select the "Inverse DVI Search" tab.
4906 Click on the "New..." button and, in the window which opens, enter "LyX Editor"
4907 (or any other name you like) in the "Name:" field.
4908 Now click on the button labeled "..." to open a filedialog and navigate to
4909 the directory containing the batch file
4910 \begin_inset Flex CharStyle:Code
4913 \begin_layout Plain Layout
4921 \begin_inset Flex CharStyle:Code
4924 \begin_layout Plain Layout
4930 and then specify the program arguments as
4931 \begin_inset Flex CharStyle:Code
4934 \begin_layout Plain Layout
4940 if you want to use the shell script above, or as
4941 \begin_inset Flex CharStyle:Code
4944 \begin_layout Plain Layout
4950 if you want to use the
4951 \begin_inset Flex CharStyle:Code
4954 \begin_layout Plain Layout
4961 As yap is a native Windows application, the filename it provides should
4962 be converted to posix style before being passed to
4963 \begin_inset Flex CharStyle:Code
4966 \begin_layout Plain Layout
4973 \begin_inset Flex CharStyle:Code
4976 \begin_layout Plain Layout
4982 , and this is the purpose of the
4983 \begin_inset Flex CharStyle:Code
4986 \begin_layout Plain Layout
4992 wrapper, which is as follows:
4996 \begin_layout LyX-Code
4998 \begin_inset Newline newline
5001 if "%1" == "-g" goto lyxclient
5002 \begin_inset Newline newline
5005 bash -c 'lyxeditor.sh $(cygpath "%1") %2'
5006 \begin_inset Newline newline
5010 \begin_inset Newline newline
5014 \begin_inset Newline newline
5017 bash -c 'lyxclient %1 $(cygpath "%2") %3'
5020 \begin_layout Standard
5021 You have to make sure that both
5022 \begin_inset Flex CharStyle:Code
5025 \begin_layout Plain Layout
5032 \begin_inset Flex CharStyle:Code
5035 \begin_layout Plain Layout
5041 are in the command PATH, otherwise you have to use their full posix path
5042 in the above batch file.
5046 \begin_layout Standard
5047 If you did no mistakes, and if src-specials are activated as previously
5048 described, whenever you Ctrl-click in xdvi, or double click in yap, the
5049 cursor in LyX should jump to the desired location.
5052 \begin_layout Chapter
5053 Special Document Classes
5056 \begin_layout Section
5060 \begin_layout Standard
5066 \begin_layout Subsection
5070 \begin_layout Standard
5071 This section describes how LyX can be used to write articles for submission
5072 to the scientific journal
5074 Astronomy and Astrophysics
5076 (www.edpsciences.fr/aa/
5077 \begin_inset Flex URL
5080 \begin_layout Plain Layout
5082 http://www.edpsciences.fr/aa/
5087 ) using Version 5.01 of the document class
5092 This package can be downloaded from the ftp site
5095 \begin_layout Standard
5096 \begin_inset VSpace medskip
5102 \begin_layout Standard
5104 \begin_inset Flex URL
5107 \begin_layout Plain Layout
5109 ftp://ftp.edpsciences.org/pub/aa/readme.html
5117 \begin_layout Standard
5118 \begin_inset VSpace medskip
5124 \begin_layout Standard
5125 A manual comes together with that package, and this text is not meant to
5126 replace the original manual but merely a short guide how to realize the
5127 correct form of your paper.
5131 \begin_layout Standard
5132 Please note that the publisher of the journal was changed from Springer
5133 to EDP Sciences starting January 1, 2001.
5134 That change implicated also some slight changes of the style files, namely
5135 the removal of the thesaurus command.
5136 The LyX class aa supports the newest version of these style files, V 5.01.
5137 If you have an older version installed, please upgrade.
5138 For compatibility, the old (version 4) layout has been kept as
5143 Please refer to the comments in
5145 LyXDir/layouts/aapaper.layout
5150 \begin_layout Subsection
5154 \begin_layout Standard
5155 It is recommended you start from the example template distributed with LyX.
5156 If you are not using a template, note the following settings:
5159 \begin_layout Itemize
5166 Document\SpecialChar \menuseparator
5169 dialog (OK, that one was obvious).
5172 \begin_layout Itemize
5173 Don't change the option
5176 \begin_inset space ~
5186 The whole layout is done by the macros, you shouldn't change anything.
5189 \begin_layout Subsection
5193 \begin_layout Standard
5194 First thing to enter is the header information.
5195 It consists of seven entries, of which some are optional.
5199 \begin_layout Itemize
5207 \begin_layout Itemize
5215 \begin_layout Itemize
5223 \begin_layout Itemize
5231 \begin_layout Itemize
5236 : [optional] if more than one author: whom to contact for offprint requests.
5239 \begin_layout Itemize
5244 : [optional] mail address for contacts.
5247 \begin_layout Itemize
5255 Received: <date>; Accepted <date>
5258 \begin_layout Standard
5259 There is no need to issue the
5265 command, this is done automatically by LyX when the header is finished.
5266 Although the order of the single header entries doesn't matter it is advised
5267 to keep the above sequence, just to get the best optics and meets the layout
5268 of the real document.
5271 \begin_layout Standard
5272 If you want to place footnotes in the header block, e.
5273 \begin_inset space \thinspace{}
5277 \begin_inset space \space{}
5280 to state your present address, just use the standard footnote via the menu
5283 Insert\SpecialChar \menuseparator
5287 LyX will automagically use the term
5296 \begin_layout Standard
5297 In addition to these topics, the macros use three additional LaTeX commands
5298 that have no counterpart in LyX:
5301 \begin_layout Itemize
5308 to separate different names for more than one author and institute, respectivel
5312 \begin_layout Itemize
5319 to mark corresponding author/institute pairs.
5320 The institutes are numbered sequentially as they appear in the
5324 field, so you have to put a marker to each author.
5327 \begin_layout Itemize
5334 to supply an email address for fast contact.
5337 \begin_layout Standard
5338 In all cases, the appropriate command has to be entered in LyX and marked
5344 \begin_layout Subsection
5348 \begin_layout Standard
5349 The abstract should immediately follow the header block.
5350 With version 5 the abstract environment was changed to a command, and there
5351 is now a resctriction to only one paragraph.
5352 In addition, it should contain an entry with the keywords.
5353 This is not yet implemented for LyX, therefore you have to enter the LaTeX
5360 by hand and mark it as LaTeX code.
5361 Refer to the example paper.
5364 \begin_layout Subsection
5365 Supported environments
5368 \begin_layout Standard
5369 The A&A paper layout supports the following environments for structuring
5373 \begin_layout Itemize
5379 \begin_layout Itemize
5385 \begin_layout Itemize
5391 \begin_layout Itemize
5397 \begin_layout Itemize
5403 \begin_layout Itemize
5409 \begin_layout Itemize
5415 \begin_layout Itemize
5421 \begin_layout Itemize
5427 \begin_layout Itemize
5433 \begin_layout Itemize
5439 \begin_layout Itemize
5445 \begin_layout Subsection
5446 Commands not supported by LyX
5449 \begin_layout Standard
5450 Some commands are not yet supported by the
5455 Some have already been mentioned.
5456 For the sake of completeness, they are listed all together here:
5459 \begin_layout Itemize
5467 \begin_layout Itemize
5475 \begin_layout Itemize
5483 \begin_layout Itemize
5491 \begin_layout Itemize
5499 \begin_layout Itemize
5507 \begin_layout Itemize
5515 \begin_layout Itemize
5523 \begin_layout Standard
5524 If you want to use any of these commands, you have to enter them yourself.
5527 Do not forget to mark them as LaTeX code!
5530 \begin_layout Subsection
5531 Figure and Table Floats
5534 \begin_layout Standard
5535 LyX provides support for the necessary float environments
5537 figure, figure*, table
5543 , therefore we won't tell much about it here.
5547 \begin_inset space ~
5553 Just remember that tables should be left-aligned.
5554 For that, select the table and change the alignment in
5556 Edit\SpecialChar \menuseparator
5558 \begin_inset space ~
5564 \begin_layout Standard
5565 There is only one special thing: the figures with caption besides the figure.
5566 To create such a figure, you have to do the following:
5569 \begin_layout Enumerate
5570 Create a wide figure float:
5572 Insert\SpecialChar \menuseparator
5573 Float\SpecialChar \menuseparator
5576 , then right click in the figure and select
5582 \begin_inset space ~
5590 \begin_layout Enumerate
5591 Enter your caption text.
5594 \begin_layout Enumerate
5599 to move the cursor above the caption.
5602 \begin_layout Enumerate
5606 \begin_layout Enumerate
5607 Position the cursor behind the figure and insert a horizontal fill:
5609 Insert\SpecialChar \menuseparator
5611 \begin_inset space ~
5614 Character\SpecialChar \menuseparator
5616 \begin_inset space ~
5624 \begin_layout Enumerate
5625 Switch to LaTeX mode:
5628 \begin_inset space ~
5636 \begin_layout Enumerate
5646 Do not close the brace!
5649 \begin_layout Enumerate
5650 Position the cursor behind the caption text, switch to LaTeX mode and insert
5654 \begin_inset space ~
5666 \begin_layout Standard
5667 Also, refer to the figures in the example paper.
5670 \begin_layout Subsection
5674 \begin_layout Standard
5675 For submission, the paper has to be formated in a special double-spacing
5677 For this purpose, you have to give the option
5681 to the documentclass.
5682 This must be done using the extra class options field in the
5684 Document\SpecialChar \menuseparator
5688 Just enter the string
5695 \begin_layout Subsection
5699 \begin_layout Standard
5704 directory contains an example paper written with LyX.
5705 It is the example paper from the original macro package, translated to
5707 Use it for inspiration, and compare the original LaTeX code with LyX way
5711 \begin_layout Section
5715 \begin_layout Standard
5721 \begin_layout Subsection
5725 \begin_layout Standard
5726 AASTeX is a set of macros produced by the American Astronomical Society
5727 to facilitate electronic manuscript submission to the three journals they
5728 publish: the Astrophysical Journal (including the Letters and Supplement),
5729 the Astronomical Journal, and the Publications of the Astronomical Society
5731 LyX has proven to be an excellent tool for generating these documents,
5732 especially given its equation, citation, and figure handling capabilities.
5733 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5734 is the version described here, or higher.
5735 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5736 incompatible with LyX.
5737 The AASTeX package may be downloaded from the AASTeX Web site
5740 \begin_layout Standard
5741 \begin_inset VSpace medskip
5747 \begin_layout Standard
5749 \begin_inset Flex URL
5752 \begin_layout Plain Layout
5754 http://www.journals.uchicago.edu/AAS/AASTeX
5762 \begin_layout Standard
5763 \begin_inset VSpace medskip
5769 \begin_layout Standard
5770 A complete user guide is contained in that package and you should familiarize
5771 yourself with it thoroughly before embarking on writing a paper in LyX.
5772 LyX will not reduce the need to figure out all the AASTeX commands, it
5773 will only reduce the drudgery of typing everything in.
5774 It is your responsibility to ensure that the final exported LaTeX document
5775 conforms completely to the requirements of the journal to which you are
5776 submitting your paper.
5779 \begin_layout Subsection
5780 Starting a New Paper
5783 \begin_layout Standard
5784 I strongly suggest that you start with the AASTeX template file.
5787 File\SpecialChar \menuseparator
5794 , enter the new file name, then choose the
5799 This will show the most common fields found in a manuscript.
5800 Simply overwrite the existing text (including the brackets,
5804 ) with the correct information.
5805 Many of the AASTeX commands and environments can be implemented directly
5806 in LyX, but some cannot: most noticeably
5818 , which should stick out like a sore thumb if you actually just opened the
5820 For commands such as these, the LaTeX code must be entered directly and
5822 Such commands are referred to as TeX code, or Evil Red Text.
5823 I tried to minimize the amount of TeX code needed in an AASTeX document,
5824 but there is still a bit more required than any of us would like.
5827 \begin_layout Subsection
5828 Finishing Your Paper
5831 \begin_layout Standard
5832 When the paper is finished to your satisfaction and previews/prints correctly,
5834 \begin_inset Quotes eld
5838 \begin_inset Quotes erd
5841 actions which need to be done before you submit it to the journals.
5845 \begin_layout Enumerate
5846 Export your paper as a LaTeX file (
5848 File\SpecialChar \menuseparator
5849 Export\SpecialChar \menuseparator
5856 \begin_layout Enumerate
5861 file with your favorite text editor
5865 \begin_layout Enumerate
5866 remove the comment lines before the
5875 \begin_layout Enumerate
5880 usepackage...{fontenc}
5882 line if it appears (usually just after
5897 \begin_layout Enumerate
5898 remove everything between (and including) the
5910 commands, except for any commands you specifically put into the LaTeX preamble
5911 (which should appear immediately after the
5912 \begin_inset Quotes eld
5915 User specified LaTeX commands
5916 \begin_inset Quotes erd
5927 \begin_layout Enumerate
5928 Run the resulting file through LaTeX to make sure it still processes correctly.
5931 \begin_layout Enumerate
5932 Reread the journal requirements to make sure your filenames and formats
5936 \begin_layout Enumerate
5940 \begin_layout Subsection
5941 Comments On Specific Commands
5944 \begin_layout Standard
5945 I will not describe the detailed usage of the individual AASTeX commands:
5946 the AASTeX User Guide (
5950 ) gives a good description of each.
5951 Thus it's probably easiest for me to go down the list as found in the guide
5952 and offer comments where necessary.
5953 So let's begin \SpecialChar \ldots{}
5957 \begin_layout Subsubsection
5958 Things that work as expected
5961 \begin_layout Standard
5965 \begin_layout Plain Layout
5977 \begin_layout Standard
5978 Because they work as you might expect, I simply list them and the section
6079 begin{thebibliography}
6087 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6088 graphicx figure commands (2.14.1),
6112 (2.15.4, amongst other places),
6139 \begin_layout Standard
6140 The following style options also work correctly:
6161 Simply put them in the
6167 Layout\SpecialChar \menuseparator
6173 \begin_layout Standard
6177 \begin_layout Plain Layout
6189 \begin_layout Subsubsection
6190 Things that work, but require more comment
6193 \begin_layout Standard
6194 The following items work, but require a little more discussion:
6197 \begin_layout Itemize
6198 These items are reserved for use by the journal editors, but you can put
6199 them into the LaTeX preamble if you feel compelled to do so:
6232 \begin_layout Itemize
6233 These items may be placed in the LaTeX preamble, and are included as blanks
6234 in the template file:
6255 \begin_layout Itemize
6262 (2.3) – can only be used
6263 \begin_inset Quotes eld
6267 \begin_inset Quotes erd
6270 , not in the middle of a paragraph.
6271 Use TeX code if you need to embed it.
6274 \begin_layout Itemize
6281 (2.3) – will have extra {} after it.
6282 This should not cause an error.
6285 \begin_layout Itemize
6292 (2.6) – can only be used
6293 \begin_inset Quotes eld
6297 \begin_inset Quotes erd
6300 , not in the middle of a paragraph.
6301 Use TeX code if you need to embed it.
6304 \begin_layout Itemize
6311 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6315 \begin_layout Itemize
6322 (2.8) – same as for
6329 \begin_layout Itemize
6336 (2.9) – will have extra {} after it.
6337 This should not cause an error.
6340 \begin_layout Itemize
6347 (2.11) – will have extra {} after it.
6348 This should not cause an error.
6351 \begin_layout Itemize
6358 (2.14.2) – you can insert an optional filename argument by placing the cursor
6359 at the beginning of the text and selecting
6361 Insert\SpecialChar \menuseparator
6366 \begin_inset Quotes eld
6370 \begin_inset Quotes erd
6373 inserts an optional argument of the type needed by
6380 Hopefully it will be renamed someday.
6383 \begin_layout Itemize
6390 (2.17.1) – same as
6396 for the catalog ID optional parameter
6399 \begin_layout Itemize
6406 (2.17.1) – same as
6412 for the catalog ID optional parameter
6415 \begin_layout Subsubsection
6416 Things not implemented, use TeX code
6419 \begin_layout Standard
6423 \begin_layout Plain Layout
6435 \begin_layout Standard
6458 setcounter{equation}
6460 (2.12), Journal name abbreviations (2.13.4),
6496 (2.15.4, insert it as the first element in the lefthand cell after where
6498 Don't use any of LyX's rules in the table),
6510 (2.15.5), much of Misc (2.17, except
6561 \begin_layout Standard
6565 \begin_layout Plain Layout
6577 \begin_layout Subsubsection
6578 Things that cannot be implemented
6581 \begin_layout Standard
6582 \SpecialChar \ldots{}
6583 at least in any meaningful sort of way, so I suggest ignoring them.
6584 They are the references environment (2.13.3), and the deluxetable environment
6586 If you really, really need to use deluxetable, I suggest editing it in
6587 a separate file with a text editor, then using
6589 Insert\SpecialChar \menuseparator
6591 \begin_inset space ~
6596 to include it in your LyX document.
6601 file to see an example of this.
6604 \begin_layout Subsection
6605 FAQs, Tips, Tricks, and Other Ruminations
6608 \begin_layout Subsubsection
6609 Getting LyX and AASTeX to cooperate
6612 \begin_layout Standard
6613 It can be a bit tricky to get LyX to recognize a new layout and document
6615 When all else fails, do this:
6618 \begin_layout Enumerate
6619 Make certain that LaTeX can find AASTeX.
6620 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6621 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6628 \begin_layout Enumerate
6640 \begin_layout Enumerate
6643 Tools\SpecialChar \menuseparator
6646 in LyX, then restart LyX.
6649 \begin_layout Enumerate
6650 Open a regular new file, not from a template.
6651 Does AASTeX appear in the class list in
6653 Document\SpecialChar \menuseparator
6659 \begin_layout Standard
6660 If you get a warning from an existing AASTeX document about not being able
6661 to find the AASTeX layout or a message about
6662 \begin_inset Quotes eld
6665 You should not mix title layouts with normal ones
6666 \begin_inset Quotes erd
6669 , things haven't been installed correctly.
6672 \begin_layout Subsubsection
6673 LaTeX error processing a table
6676 \begin_layout Standard
6677 LyX, by default, attempts to center the table caption/title.
6678 This seems to produce a bad interaction in AASTeX so you should click somewhere
6679 in the caption/title, then select
6681 Edit\SpecialChar \menuseparator
6683 \begin_inset space ~
6697 This took care of it for me.
6700 \begin_layout Subsubsection
6704 \begin_layout Standard
6705 A couple of things: 1) I have noticed some funny spacing in the reference
6706 entries in the text.
6707 When you enter the bibliography item data, make sure their is
6711 space between the last author and the parenthesis setting off the year;
6715 \begin_inset space \thinspace{}
6719 \begin_inset space \space{}
6733 2) Entering the references at all is not obvious.
6734 The easiest thing is to start typing your first reference at the end of
6735 the document, then mark it as type
6740 That will put a small gray box in front of what you just typed.
6741 Click on the box to fill in the rest of the information.
6742 For new references, go to the end of an existing reference and press return.
6743 That will create a new line with its own box, etc.
6746 \begin_layout Subsubsection
6750 \begin_layout Standard
6751 Even though AASTeX provides its own figure commands (
6757 , for example), I much prefer LaTeX's standard figure commands (with the
6766 \begin_inset space ~
6769 commands as TeX code into a Figure Float box if you desire, but I never
6770 have much luck getting the layout right.
6771 With the standard graphics, LyX will insert a
6775 usepackage{graphicx}
6777 command into the LaTeX preamble and handle the figures in the standard
6778 LaTeX2e way, interspersing the figures in the text.
6779 I believe ApJ accepts figures exactly this way now; AJ might still use
6781 \begin_inset Quotes eld
6784 stack everything at the end
6785 \begin_inset Quotes erd
6791 \begin_layout Subsubsection
6792 Things I could have done, but didn't
6795 \begin_layout Standard
6797 \begin_inset Quotes eld
6801 \begin_inset Quotes erd
6804 things I could have implemented, but chose not to.
6805 For instance, I saw no point in double-spacing the text in the LyX window,
6806 even though it is double-spaced in the paper manuscript.
6807 Also, I chose not to make separate layouts for the preprint and preprint2
6809 Since I assume you will spend most of your time in the plain manuscript
6810 mode anyway, I decided not to chew up more disk space with this.
6814 \begin_layout Subsection
6818 \begin_layout Standard
6819 Your mileage may vary.
6820 I've now had papers published by both ApJ and AJ that have had 98% of the
6821 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6823 I have had no trouble with the submission process, and I'm sure the journals
6824 were never aware that there might be a difference.
6825 So, go forth and publish!
6828 \begin_layout Section
6832 \begin_layout Standard
6835 David Johnson; updated by Richard Heck
6838 \begin_layout Standard
6839 \begin_inset VSpace bigskip
6845 \begin_layout Standard
6847 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
6848 papers to be submitted to American Mathematical Society publications.
6849 The layouts are not tailored to a specific journal, but easily can be.
6850 You should refer to the AMS documentation for specific instructions for
6851 each journal (usually it will entail only changing a single line in the
6853 That documentation is available on the Web at
6854 \begin_inset Flex URL
6857 \begin_layout Plain Layout
6865 \begin_inset Flex URL
6868 \begin_layout Plain Layout
6870 ftp://ftp.ams.org/pub/tex/amslatex/
6876 These layouts are appropriate, and useful, for any mathematical writing.
6880 \begin_layout Standard
6881 There are two basic AMS LaTeX layouts:
6884 \begin_layout Itemize
6885 amsart: The standard AMS article format.
6888 \begin_layout Itemize
6889 amsbook: the standard AMS book (really, monograph) format.
6893 \begin_layout Standard
6894 The layouts themselves contain only the minimum necessary to use the AMS
6896 They do not, in particular, contain any of the `theorem' environments used
6897 for setting theorems, lemmas, and the like.
6898 These are contained, instead, in the
6899 \begin_inset Flex CharStyle:Code
6902 \begin_layout Plain Layout
6908 module, which is loaded by default when when you select one of the AMS
6910 (It can also be used with other classes and can be removed, if you would
6911 rather use something else.) Less commonly used environments are in the
6912 \begin_inset Flex CharStyle:Code
6915 \begin_layout Plain Layout
6916 Theorems (AMS-Extended)
6921 module, which must be loaded manually.
6924 \begin_layout Standard
6925 By default, theorems and the like are numbered consecutively throughout
6926 the document, but this may be modified by loading the module
6927 \begin_inset Flex CharStyle:Code
6930 \begin_layout Plain Layout
6931 Theorems (Order by Section)
6936 or, if you are using
6937 \begin_inset Flex CharStyle:Code
6940 \begin_layout Plain Layout
6947 \begin_inset Flex CharStyle:Code
6950 \begin_layout Plain Layout
6951 Theorems (Order by Chapter)
6957 These will number the results as
6958 \begin_inset Formula $n.m$
6961 , where the first number refers to the section (or chapter) and the second
6962 refers to the total number of results so far in that section (or chapter).
6963 Many environments are also available unnumbered.
6964 These are indicated by an asterisk at the end.
6965 If you happen to want
6969 unnumbered results, the the module
6970 \begin_inset Flex CharStyle:Code
6973 \begin_layout Plain Layout
6979 provides that option.
6982 \begin_layout Standard
6983 Note that these modules do not
6987 to be used with the AMS classes.
6988 It is perfectly possible to use the
6989 \begin_inset Flex CharStyle:Code
6992 \begin_layout Plain Layout
6998 module, and the others mentioned, with other classes, such as
6999 \begin_inset Flex CharStyle:Code
7002 \begin_layout Plain Layout
7009 \begin_inset Flex CharStyle:Code
7012 \begin_layout Plain Layout
7019 \begin_inset Flex CharStyle:Code
7022 \begin_layout Plain Layout
7031 \begin_layout Subsection
7032 What these layouts provide
7035 \begin_layout Standard
7036 There is a long list of included environments provided by these layouts.
7037 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
7038 variety of `theorem' environments.
7039 However, the AMS recommends the environments that are available in LyX.
7043 \begin_layout Standard
7044 The following environments—as well as the standard environments, such as
7046 \begin_inset Flex CharStyle:Noun
7049 \begin_layout Plain Layout
7056 \begin_inset Flex CharStyle:Noun
7059 \begin_layout Plain Layout
7066 \begin_inset Flex CharStyle:Noun
7069 \begin_layout Plain Layout
7076 \begin_inset Flex CharStyle:Noun
7079 \begin_layout Plain Layout
7086 \begin_inset Flex CharStyle:Noun
7089 \begin_layout Plain Layout
7096 \begin_inset Flex CharStyle:Code
7099 \begin_layout Plain Layout
7106 \begin_inset Flex CharStyle:Code
7109 \begin_layout Plain Layout
7118 \begin_layout Description
7119 Address This should be the author's permanent address.
7122 \begin_layout Description
7124 \begin_inset space ~
7127 Address This should be the author's temporary address at the time of submission,
7128 if different from the Address.
7131 \begin_layout Description
7132 Email Author's e-mail address
7135 \begin_layout Description
7136 URL Author's Web address, if desired.
7139 \begin_layout Description
7140 Keywords Key words or phrases used to identify specific topics discussed
7144 \begin_layout Description
7145 Subjectclass These refer to the AMS Subject Classifications, published and
7148 Mathematical Reviews
7151 These are also available online at the AMS cites listed above.
7154 \begin_layout Description
7158 \begin_layout Description
7162 \begin_layout Description
7166 \begin_layout Standard
7167 The following environments are provided by both the
7168 \begin_inset Flex CharStyle:Code
7171 \begin_layout Plain Layout
7178 \begin_inset Flex CharStyle:Code
7181 \begin_layout Plain Layout
7187 modules, in the latter case in both starred (unnumbered) and unstarred
7188 (numbered) versions.
7189 These same environments are provided only in the starred versions by the
7191 \begin_inset Flex CharStyle:Code
7194 \begin_layout Plain Layout
7203 \begin_layout Theorem
7204 This is typically used for the statements of major results.
7208 \begin_layout Corollary*
7209 This is used for statements which follow fairly directly from previous statement
7211 Again, these can be major results.
7216 These are smaller results needed to prove other statements.
7219 \begin_layout Proposition
7220 These are less major results which (hopefully) add to the general theory
7224 \begin_layout Conjecture
7225 These are statements provided without justification, which the author does
7226 not know how to prove, but which seem to be true (to the author, at least).
7229 \begin_layout Definition*
7230 Guess what this is for.
7231 The font is different for this environment than for the previous ones.
7235 \begin_layout Example*
7236 Used for examples illustrating proven results.
7239 \begin_layout Problem
7240 It's not really known what this is for.
7241 You should figure it out.
7244 \begin_layout Exercise*
7245 Write a description for this one.
7248 \begin_layout Remark
7249 This environment is also a type of theorem, usually a lesser sort of observation.
7252 \begin_layout Claim*
7253 Often used in the course of giving a proof of a larger result.
7257 Generally, these are used to break up long arguments, using specific instances
7263 The numbering scheme for cases is on its own, not together with other numbered
7269 At the end of this environment, a QED symbol (usually a square, but it can
7270 vary with different styles) is placed.
7271 If you want to have other environments within this one—for example, Case
7272 environments—and have the QED symbol appear only after them, then the other
7273 environments need to be nested within the proof environment.
7276 Nesting Environments
7282 for information on nesting.
7285 \begin_layout Standard
7286 And these environments are provided by
7287 \begin_inset Flex CharStyle:Code
7290 \begin_layout Plain Layout
7291 Theorems (AMS-Extended)
7299 \begin_layout Criterion*
7300 A required condition.
7303 \begin_layout Algorithm*
7304 A general procedure to be used.
7307 \begin_layout Axiom*
7308 This is a property or statement taken as true within the system being discussed.
7311 \begin_layout Condition*
7312 Sometimes used to state a condition assumed within the present context of
7317 Similar to a Remark.
7320 \begin_layout Notation*
7321 Used for the explanation of, yes, notation.
7324 \begin_layout Summary
7325 Do we really need to tell you?
7328 \begin_layout Acknowledgement*
7332 \begin_layout Conclusion*
7333 Sometimes used at the end of a long train of argument.
7337 Used in a way similar to Proposition, though perhaps lower on the scale.
7340 \begin_layout Standard
7341 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
7343 They need to be available on your system in order to use these environments.
7346 \begin_layout Section
7354 \begin_layout Standard
7360 \begin_layout Subsection
7364 \begin_layout Standard
7365 These are the layout files for some of the journals of the American Geophysical
7367 It is assumed that you have both the AGU's own class files and AGUplus
7368 installed (everything to be found at
7369 \begin_inset Flex URL
7372 \begin_layout Plain Layout
7374 ftp://ftp.agu.org/journals/latex/journals
7382 \begin_layout Subsection
7386 \begin_layout Standard
7396 They are still called this in the LyX GUI, though their LaTeX equivalents
7397 in the AGU classes are
7408 \begin_layout Standard
7409 Newly defined styles are
7446 These are mostly manuscript attributes and defined in the AGU class documentati
7450 \begin_layout Standard
7451 I suspect this is still badly incomplete.
7454 \begin_layout Subsection
7458 \begin_layout Standard
7475 \begin_layout Subsection
7479 \begin_layout Itemize
7482 Journal of Geophysical Research
7491 \begin_layout Standard
7492 Add your own, it isn't so hard! Look at the
7503 \begin_layout Subsection
7504 Bugs and things to remember
7507 \begin_layout Standard
7508 In order to use the new layouts, you must remember to do the following for
7512 \begin_layout Enumerate
7518 This can be done in the
7520 Layout\SpecialChar \menuseparator
7525 Document\SpecialChar \menuseparator
7529 (AGU articles are always in English, right? So
7536 \begin_layout Enumerate
7546 (Yes, this is a bug.)
7549 \begin_layout Enumerate
7550 Make sure you use the
7554 bibliography style, by entering
7558 into the second field of the BibTeX inset.
7559 None of the standard styles will do.
7562 \begin_layout Section
7566 \begin_layout Standard
7572 \begin_layout Subsection
7576 \begin_layout Standard
7577 Broadway is for writing plays.
7578 The format is more decorative than Hollywood, and much less standardized.
7579 This format should be suitable for workshops.
7582 \begin_layout Subsection
7586 \begin_layout Standard
7587 The same as in Hollywood.
7590 \begin_layout Subsection
7594 \begin_layout Standard
7599 names as labels then cross-reference the label to insert the name.
7600 The cross-reference dialog will show the current cast of characters.
7603 \begin_layout Subsection
7604 Paper size and Margins
7607 \begin_layout Standard
7608 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
7611 \begin_layout Subsection
7615 \begin_layout Standard
7616 The following environments are available.
7617 You can use broadway.bind to get the bind keys shown at the right.
7620 \begin_layout Itemize
7624 \begin_inset Newline newline
7629 You should not have to use this, but it is here for anything that does not
7633 \begin_layout Itemize
7637 \begin_inset space \hfill{}
7641 \begin_inset Newline newline
7646 Used to describe stage setting and the action.
7647 First use of speaker names in all CAPs.
7650 \begin_layout Itemize
7654 \begin_inset space \hfill{}
7658 \begin_inset Newline newline
7663 Automatically numbered.
7664 On screen it will be arabic, but will print as Roman.
7667 \begin_layout Itemize
7671 \begin_inset space \hfill{}
7675 \begin_inset Newline newline
7685 It is just centered text.
7688 \begin_layout Itemize
7692 \begin_inset space \hfill{}
7696 \begin_inset Newline newline
7701 Not automatically numbered.
7702 You supply the number.
7703 This is because I couldn't figure out how.
7706 \begin_layout Itemize
7710 \begin_inset space \hfill{}
7714 \begin_inset Newline newline
7719 A special case of Narrative to describe the setting and action as the curtain
7723 \begin_layout Itemize
7727 \begin_inset space \hfill{}
7731 \begin_inset Newline newline
7736 The speaker's (actor's) title, centered in all CAPS.
7739 \begin_layout Itemize
7743 \begin_inset space \hfill{}
7747 \begin_inset Newline newline
7752 Instructions to the speaker.
7753 The parentheses are automatically inserted.
7754 The ( will appear on screen, but both will be in the printed play.
7755 This environment is only used within
7762 \begin_layout Itemize
7766 \begin_inset space \hfill{}
7770 \begin_inset Newline newline
7775 What the Speaker says.
7778 \begin_layout Itemize
7782 \begin_inset space \hfill{}
7786 \begin_inset Newline newline
7791 The curtain comes down.
7794 \begin_layout Itemize
7798 \begin_inset space \hfill{}
7804 \begin_layout Itemize
7808 \begin_inset space \hfill{}
7814 \begin_layout Itemize
7818 \begin_inset space \hfill{}
7824 \begin_layout Standard
7828 \begin_layout Section
7832 \begin_layout Standard
7837 can be used to type letters according to German conventions.
7838 A template file is included in
7840 .../lyx/share/templates
7842 for you to use as a starting point.
7845 \begin_layout Section
7853 \begin_layout Standard
7859 \begin_layout Subsection
7863 \begin_layout Standard
7864 This is the layout file for the European Geophysical Society journals.
7869 can be downloaded from the web site of the EGS under
7870 \begin_inset Flex URL
7873 \begin_layout Plain Layout
7883 \begin_layout Subsection
7887 \begin_layout Standard
7890 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
7898 The current layout file is unfortunately very unmodular and would benefit
7899 from using the various
7906 \begin_layout Section
7910 \begin_layout Standard
7916 \begin_layout Standard
7917 Elsevier Science Publishers B.V.
7918 provides a standard LaTeX document class (
7922 ) for submitting articles to their various journals.
7923 The style file can be downloaded directly from their web site:
7924 \begin_inset Flex URL
7927 \begin_layout Plain Layout
7929 http://authors.elsevier.com/
7935 Instructions are supplied along with the class file, which details the
7936 requirements of the publishers.
7937 LyX includes package that allows for the use of this class, by a layout
7938 and a template file.
7939 Installation of the class file is the same as for any other LaTeX package;
7940 instructions are provided in the Elsevier documentation.
7943 \begin_layout Standard
7953 As the Elsevier class file is based mainly on the standard article class,
7954 most of the normal functionality is provided.
7955 The Elsevier class defines a number of mathematical environments, which
7956 are similar to the AMS environments.
7957 These commands are all described in the Elsevier documentation, and are
7961 \begin_layout Standard
7962 The easiest way to use the Elsevier style is to base documents on the included
7964 It is best not to use options such as fancy headings or the geometry package,
7965 as elements such as these are defined by Elsevier in their style file.
7966 Ideally, no extra packages except those mentioned in the Elsevier documentation
7968 Essentially, Elsevier require as
7969 \begin_inset Quotes eld
7973 \begin_inset Quotes erd
7976 a LaTeX file as possible, as their intention is to take the supplied file
7977 and replace the class file with one for the particular journal to which
7978 the paper has been submitted.
7979 This also means that not too much time should be spent on the formating
7981 When it comes to be published, this will change anyway.
7982 The rest of the usage for this layout is substantially the same as for
7983 the normal article class.
7984 For details of what Elsevier do and don't allow, refer to their documentation.
7987 \begin_layout Section
7996 \begin_inset CommandInset label
8005 \begin_layout Standard
8011 \begin_layout Subsection
8015 \begin_layout Standard
8016 This section describes how to use LyX to make slides for overhead projectors.
8017 There are two document classes that can do this: the default slides class
8023 This section documents the latter.
8026 \begin_layout Standard
8027 I'm going to say this again, nice and clear, so that there's no misunderstanding
8031 \begin_layout Standard
8032 \begin_inset VSpace bigskip
8038 \begin_layout Standard
8042 This section documents the class
8043 \begin_inset Quotes eld
8051 \begin_inset Quotes erd
8059 \begin_layout Standard
8060 \begin_inset VSpace bigskip
8066 \begin_layout Standard
8067 If you're looking for the documentation for
8068 \begin_inset Quotes eld
8076 \begin_inset Quotes erd
8080 \begin_inset space ~
8084 \begin_inset CommandInset ref
8086 reference "sec:slitex"
8091 If your machine doesn't have the
8096 \begin_inset Quotes eld
8104 \begin_inset Quotes erd
8107 ] installed, you'll probably have to use the default
8111 class, which isn't quite as good as
8116 \begin_layout Standard
8121 class is designed for use with version 2.1 of the
8125 LaTeX class file which is now an integral part of LaTeX2e.
8128 \begin_layout Subsection
8132 \begin_layout Standard
8133 Obviously, to use this document class, you need to select
8134 \begin_inset Quotes eld
8142 \begin_inset Quotes erd
8152 \begin_inset space ~
8158 There are some settings in the
8161 \begin_inset space ~
8166 dialog that you should know about that are specific to this class:
8169 \begin_layout Itemize
8170 Don't change the options
8181 \begin_inset space ~
8187 They're ignored by the
8194 \begin_layout Itemize
8195 The default font size is 20
8196 \begin_inset space \thinspace{}
8199 pt with the other options being 17
8200 \begin_inset space \thinspace{}
8204 \begin_inset space \thinspace{}
8208 \begin_inset space \thinspace{}
8214 \begin_layout Itemize
8223 but all math equations are still typeset in the usual roman font.
8226 \begin_layout Itemize
8231 TeX supports A4 and Letter paper sizes as well as a special size for working
8233 \begin_inset space \thinspace{}
8237 It doesn't support A5, B5, legal or executive paper sizes.
8240 \begin_layout Itemize
8241 Don't bother changing the
8245 settings because they are ignored anyway.
8246 All floats appear where they are defined in the text.
8249 \begin_layout Itemize
8254 setting behaves a bit differently for this class.
8259 TeX provides extensive footer and header capabilities including a user-defined
8262 \begin_inset space ~
8266 \begin_inset CommandInset ref
8268 reference "sec:foilfoot"
8273 The title page is treated differently to all other pages in the document
8282 has the logo centered at the bottom of the page (if one is defined).
8283 The possible page style choices and what they do are as follows:
8287 \begin_layout Labeling
8288 \labelwidthstring MMMMMMM
8295 The final output contains no page numbers, or other headers or footers
8296 (except footnotes of course).
8300 \begin_layout Labeling
8301 \labelwidthstring MMMMMMM
8308 The final output contains page numbers centered at the bottom of the page.
8309 No other headings or footers (other than footnotes).
8312 \begin_layout Labeling
8313 \labelwidthstring MMMMMMM
8318 Page numbers in lower right corner.
8319 Additional headers and footers are also shown.
8320 This is also the default.
8323 \begin_layout Labeling
8324 \labelwidthstring MMMMMMM
8329 Gives you access to the
8333 package although its use with
8337 TeX is discouraged by the writer of the
8341 TeX package because of some potential page layout clashes.
8345 \begin_layout Subsubsection
8349 \begin_layout Standard
8350 The following options may be used in the extra class options in the
8352 Document\SpecialChar \menuseparator
8358 \begin_layout Labeling
8359 \labelwidthstring MMMMMMx
8364 This sets up the page layout for 7.33
8365 \begin_inset space \thinspace{}
8369 \begin_inset space \thinspace{}
8372 in paper, which is about the same aspect ratio as a 35
8373 \begin_inset space \thinspace{}
8376 mm slide, making it a bit easier to work with this medium.
8379 \begin_layout Labeling
8380 \labelwidthstring MMMMMMx
8385 Places a rule across the page below the header on every page except the
8389 \begin_layout Labeling
8390 \labelwidthstring MMMMMMx
8395 Places a rule across the page above the footer on every page except the
8399 \begin_layout Labeling
8400 \labelwidthstring MMMMMMx
8405 This is automatically set each time you create a new
8414 TeX to use the dvips driver to rotate those pages that are set as landscape
8418 \begin_layout Labeling
8419 \labelwidthstring MMMMMMx
8424 Simply changes the page dimensions to those of a landscape page but doesn't
8426 Thus if you use this option you need to use an external program to rotate
8427 each page or feed your paper through your printer as landscape.
8428 Note that this option effectively reverses the roles of the
8436 environments (don't worry these are described in the next section).
8439 \begin_layout Labeling
8440 \labelwidthstring MMMMMMx
8445 Equation numbers on the left.
8448 \begin_layout Labeling
8449 \labelwidthstring MMMMMMx
8454 Flush-left equations.
8457 \begin_layout Subsection
8458 Supported Environments
8461 \begin_layout Standard
8462 Most of the environments commonly supported in other classes are also supported
8468 There are several additional environments provided by
8472 TeX as well as a couple added by LyX.
8473 The following environments are shared with other classes:
8476 \begin_layout Standard
8480 \begin_layout Plain Layout
8492 \begin_layout Itemize
8498 \begin_layout Itemize
8504 \begin_layout Itemize
8510 \begin_layout Itemize
8516 \begin_layout Itemize
8522 \begin_layout Itemize
8528 \begin_layout Itemize
8534 \begin_layout Itemize
8540 \begin_layout Itemize
8546 \begin_layout Itemize
8552 \begin_layout Itemize
8558 \begin_layout Itemize
8564 \begin_layout Itemize
8570 \begin_layout Itemize
8576 \begin_layout Itemize
8582 \begin_layout Itemize
8588 \begin_layout Itemize
8594 \begin_layout Itemize
8600 \begin_layout Standard
8604 \begin_layout Plain Layout
8616 \begin_layout Standard
8617 That is, all the major environments apart from the sectioning environments.
8618 Since foils are essentially self-contained sections, with a title and body,
8623 TeX provides specific commands for starting new foils and these are:
8626 \begin_layout Itemize
8632 \begin_layout Itemize
8638 \begin_layout Standard
8639 LyX also provides slightly modified versions of these two environments called:
8642 \begin_layout Itemize
8648 \begin_layout Itemize
8654 \begin_layout Standard
8655 and the differences will be explained in the next section.
8658 \begin_layout Standard
8659 Since foils are often used in presenting ideas or new theorems and such
8664 TeX also provides a comprehensive box of goodies for presenting them:
8667 \begin_layout Standard
8671 \begin_layout Plain Layout
8683 \begin_layout Itemize
8689 \begin_layout Itemize
8695 \begin_layout Itemize
8701 \begin_layout Itemize
8707 \begin_layout Itemize
8713 \begin_layout Itemize
8719 \begin_layout Itemize
8725 \begin_layout Itemize
8731 \begin_layout Itemize
8737 \begin_layout Itemize
8743 \begin_layout Itemize
8749 \begin_layout Standard
8753 \begin_layout Plain Layout
8765 \begin_layout Standard
8766 The starred versions are unnumbered while the unstarred versions are numbered.
8767 There are also two list environments added by LyX and these are:
8770 \begin_layout Itemize
8776 \begin_layout Itemize
8782 \begin_layout Standard
8787 TeX provides some powerful header and footer capabilities that are best
8788 set in the preamble although they may be set at any point in a document.
8789 If you want to change these settings in your document the best place to
8790 do so is at the very top of a foil, i.
8791 \begin_inset space \thinspace{}
8797 \begin_inset space \space{}
8802 straight after the foilhead.
8805 \begin_layout Standard
8806 For this purpose, the following command styles are provided [
8813 \begin_layout Standard
8817 \begin_layout Plain Layout
8829 \begin_layout Itemize
8833 \begin_inset space ~
8839 \begin_layout Itemize
8845 \begin_layout Itemize
8849 \begin_inset space ~
8855 \begin_layout Itemize
8859 \begin_inset space ~
8865 \begin_layout Itemize
8869 \begin_inset space ~
8876 \begin_layout Standard
8877 \begin_inset space ~
8884 \begin_layout Standard
8888 \begin_layout Plain Layout
8900 \begin_layout Standard
8901 There are also a few commands provided by
8905 TeX that aren't directly supported by LyX but I'll tell you what they do
8906 and how to use them in section
8907 \begin_inset space ~
8911 \begin_inset CommandInset ref
8913 reference "sec:unsuppfoils"
8920 \begin_layout Subsection
8921 Building a Set of Foils
8924 \begin_layout Standard
8925 This section will give a simple introduction to using the different environments
8926 to build a set of foils.
8927 If you want to see an example set of foils, take a look at the
8931 file you find in LyX's
8938 \begin_layout Subsubsection
8939 Give It a Title Page
8942 \begin_layout Standard
8943 Unlike other classes that provide
8963 creates the title on a page of its own.
8964 If you leave out the
8968 environment LaTeX will substitute the current date (every time you regenerate
8972 \begin_layout Subsubsection
8976 \begin_layout Standard
8977 As I mentioned earlier, there are four ways of starting a new foil.
8978 For portrait foils you should use
8987 The difference between these two environments is the amount of space between
8988 the title of the foil (the foilhead) and the body of the foil.
8991 \begin_layout Standard
8992 Landscape foils are generated using the
9001 Again the only difference is the spacing between foilhead and body.
9002 Both of the short versions have 0.5 inches less separation between the foilhead
9007 \begin_layout Standard
9008 One problem with the support for landscape foils is the requirement that
9013 driver to generate the PostScript output otherwise the foils won't be rotated.
9014 It is possible to get landscape foils even if you haven't got the
9018 driver provided you can feed your foils sideways through your printer ;-)
9021 \begin_layout Subsubsection
9022 Theorems, Lemmas, Proofs and more
9025 \begin_layout Standard
9026 Due to a small bug in LyX you can't have two of the same type of these environme
9027 nts directly following each other.
9028 They must be separated by something.
9029 If you try, you will just be extending the previous environment as if you
9030 had merged the two environments together.
9031 So, how do you get around this problem? The simplest option is to insert
9032 some text between the two environments or add a
9036 environment between the two with just a
9037 \begin_inset Quotes eld
9045 \begin_inset Quotes erd
9049 This will force LyX to produce two separate environments and hence the
9050 correct LaTeX output.
9051 An example is provided in the example file included with the LyX distribution.
9052 Remember, this problem only occurs if you are trying to place two of the
9053 same type of theorem-like environments one directly after the other.
9056 \begin_layout Subsubsection
9060 \begin_layout Standard
9061 You get all the commonly supported list styles found in other classes as
9062 well as two new ones.
9063 I'll only describe the new ones here.
9064 If you want to find out more about the other list environments check out
9070 If you intend to use itemized lists you might also want to read about the
9074 \begin_inset space ~
9078 \begin_inset space ~
9083 dialog described above in section
9084 \begin_inset space ~
9088 \begin_inset CommandInset ref
9090 reference "sec:bullet"
9097 \begin_layout Standard
9098 The two new list styles,
9106 , are designed to make it easier for you to create lists of do's and don'ts
9107 or right and wrong by providing dedicated environments that use a tick
9108 or a cross as the label of the list.
9109 These lists are in fact dedicated variants of the
9114 They do however require that you have the
9121 \begin_layout Subsubsection
9125 \begin_layout Standard
9130 TeX redefines the floating tables and figures so that they appear exactly
9131 where they are in the text rather than pushing them to the top of the page
9132 or to some user specified location.
9133 In fact if you change the float placement settings they are simply ignored.
9136 \begin_layout Subsubsection
9137 Page Headers and Footers
9138 \begin_inset CommandInset label
9147 \begin_layout Standard
9151 \begin_inset space ~
9160 are two commands used to control the left-footer text string.
9161 The first is meant to allow you to include a graphic logo on your foils
9163 \begin_inset Quotes eld
9171 \begin_inset Quotes erd
9175 While the second is meant to provide a classification for the audience,
9179 \begin_inset space \thinspace{}
9185 \begin_inset space \space{}
9189 It is empty by default.
9192 \begin_layout Standard
9193 The remaining page corners can be filled by
9196 \begin_inset space ~
9201 (which defaults to page numbers),
9204 \begin_inset space ~
9212 \begin_inset space ~
9220 \begin_layout Subsection
9226 \begin_inset CommandInset label
9228 name "sec:unsuppfoils"
9235 \begin_layout Standard
9236 All the commands mentioned below need to be set in a
9244 within another environment.
9247 \begin_layout Subsubsection
9251 \begin_layout Standard
9252 All lengths are adjusted using the
9275 should be replaced by the name given to the length you want to change and
9280 is the length value.
9281 All lengths should be specified in units of length such as inches (
9293 ) or relative to some document or font-based length such as
9303 \begin_layout Standard
9304 It's possible to change the spacing between a foilhead and the body of the
9305 foil by adjusting the length specified by
9312 For example, to make
9317 \begin_inset space \space{}
9320 in closer to their bodies put the following in the preamble:
9326 foilheadskip}{-0.5in}
9329 \begin_layout Standard
9330 The spacings around floats can be adjusted by setting these lengths:
9333 \begin_layout Labeling
9334 \labelwidthstring MMMMMMMMMMM
9341 Separation between the text and the top of the float
9344 \begin_layout Labeling
9345 \labelwidthstring MMMMMMMMMMM
9352 Separation between the float and the caption
9355 \begin_layout Labeling
9356 \labelwidthstring MMMMMMMMMMM
9363 Separation between the caption and the following text
9366 \begin_layout Labeling
9367 \labelwidthstring MMMMMMMMMMM
9374 You can make the captions narrower than the surrounding text by adjusting
9376 Best done relative to
9385 \begin_layout Standard
9386 There are also several title page related lengths that you may find useful
9387 if you have a long title or several authors:
9390 \begin_layout Labeling
9391 \labelwidthstring MMMMMMMMMMM
9398 Separation from headers to
9403 \begin_layout Labeling
9404 \labelwidthstring MMMMMMMMMMM
9422 \begin_layout Labeling
9423 \labelwidthstring MMMMMMMMMMM
9437 \begin_layout Labeling
9438 \labelwidthstring MMMMMMMMMMM
9454 \begin_layout Labeling
9455 \labelwidthstring MMMMMMMMMMM
9471 \begin_layout Standard
9472 The last length related command affects all the list environments.
9483 a list environment then all the vertical spacing between the list items
9485 Note that this is a command not a length so it doesn't require
9491 like the stuff mentioned above.
9494 \begin_layout Subsubsection
9498 \begin_layout Standard
9511 commands control whether the logo in the
9515 definition appear on a given page.
9522 in the preamble then none of the foils will have the logo on them.
9523 If you don't want the logo on a particular page place the
9529 directly after the foilhead of that page and the
9535 directly after the next foilhead.
9538 \begin_layout Standard
9539 If you decide to use the
9543 page style setting in the
9546 \begin_inset space ~
9551 dialog you should probably add
9561 to your preamble so headers and footers on landscape pages are correctly
9562 placed when rotated.
9563 This is due to some clashes between the page layouts provided by the
9574 \begin_layout Section
9575 Hollywood (Hollywood spec scripts)
9578 \begin_layout Standard
9584 \begin_layout Subsection
9588 \begin_layout Standard
9589 Getting the format of a Hollywood script right is a
9590 \begin_inset Quotes eld
9594 \begin_inset Quotes erd
9597 It is designed to make the readers focus on content and to be easy and
9598 familiar for the actors to read.
9599 Each page of a script should be one minute of film.
9600 Nothing goes in a script that you cannot see or hear on screen.
9601 The courier 12 pt font should be used throughout.
9605 \begin_layout Subsection
9609 \begin_layout Standard
9610 Speakers' lines should NEVER break in mid-sentence.
9611 If a speaker's lines continue over a page break, repeat the
9615 title followed by (Cont'd).
9618 \begin_layout Subsection
9622 \begin_layout Standard
9627 names as labels then cross-reference the label to insert the name.
9628 The cross-reference dialog will show the current cast of characters.
9629 You can use this to insert the speaker name in narratives also.
9632 \begin_layout Subsection
9633 Paper size and Margins
9636 \begin_layout Standard
9637 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
9640 \begin_layout Subsection
9644 \begin_layout Standard
9645 The following environments are available.
9646 You can use hollywood.bind to get the bind keys shown at the right.
9649 \begin_layout Itemize
9653 \begin_inset Newline newline
9658 Used where nothing else works.
9662 \begin_layout Itemize
9668 \begin_inset space \hfill{}
9676 \begin_inset Newline newline
9679 Usually followed by something like
9680 \begin_inset Quotes eld
9684 \begin_inset Quotes erd
9690 \begin_layout Itemize
9694 \begin_inset space \hfill{}
9698 \begin_inset Newline newline
9703 Introduces a new INTERIOR camera set-up.
9704 Always followed by DAY or NIGHT, or something similar to define the lighting
9706 Everthing on this line in CAPS.
9709 \begin_layout Itemize
9713 \begin_inset space \hfill{}
9717 \begin_inset Newline newline
9722 Introduces a new EXTERIOR camera set-up.
9723 Everthing on this line in CAPS.
9726 \begin_layout Itemize
9730 \begin_inset space \hfill{}
9734 \begin_inset Newline newline
9739 The character speaking.
9742 \begin_layout Itemize
9746 \begin_inset space \hfill{}
9750 \begin_inset Newline newline
9755 Instructions to the speaker.
9756 The () are automatically inserted, but only the ( will show in LyX.
9757 Both will be printed.
9760 \begin_layout Itemize
9764 \begin_inset space \hfill{}
9768 \begin_inset Newline newline
9780 \begin_layout Itemize
9784 \begin_inset space \hfill{}
9788 \begin_inset Newline newline
9793 Camera movement instruction.
9795 \begin_inset space \thinspace{}
9799 \begin_inset space \space{}
9805 \begin_layout Itemize
9809 \begin_inset space \hfill{}
9815 \begin_layout Itemize
9819 \begin_inset space \hfill{}
9825 \begin_layout Itemize
9829 \begin_inset space \hfill{}
9835 \begin_layout Itemize
9839 \begin_inset space \hfill{}
9845 \begin_layout Subsection
9849 \begin_layout Itemize
9850 (O.S) — off screen
9853 \begin_layout Itemize
9854 (V.0) — voice over
9857 \begin_layout Itemize
9859 \begin_inset space \thinspace{}
9866 \begin_layout Itemize
9871 \begin_layout Itemize
9872 PAN — camera movement
9875 \begin_layout Itemize
9876 INSERT — cut to close-up of
9879 \begin_layout Section
9883 \begin_layout Standard
9886 Panayotis Papasotiriou
9889 \begin_layout Subsection
9893 \begin_layout Standard
9894 The ijmpc package is a set of macros that facilitates electronic manuscript
9897 International Journal of Modern Physics C
9900 Similarly, the ijmpd package is for creating manuscripts to be submitted
9903 International Journal of Modern Physics D
9906 Both journals are published by World Scientific.
9907 The corresponding document classes are named
9916 These files, together with instructions for the authors, can be downloaded
9918 \begin_inset Flex URL
9921 \begin_layout Plain Layout
9923 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
9929 \begin_inset Flex URL
9932 \begin_layout Plain Layout
9934 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
9940 Both packages are modified versions of the standard
9941 \begin_inset Quotes eld
9945 \begin_inset Quotes erd
9948 package, and they are almost (but not exactly) identical.
9949 Most of their features are supported by LyX.
9950 I have used LyX successfully to write articles submitted to both journals
9951 without any problem.
9954 \begin_layout Subsection
9958 \begin_layout Standard
9959 As usual, the easiest way to write a paper is to start with a template.
9962 File\SpecialChar \menuseparator
9981 This will give an (almost) empty document that includes the most common
9982 fields found in a manuscript.
9983 Simply overwrite the existing text (including the brackets,
9988 You should keep in mind the following remarks.
9991 \begin_layout Enumerate
9992 LyX won't let you change the font size and the page style of the document,
9993 because such modifications are not allowed by both packages.
9996 \begin_layout Enumerate
9997 The language of the document should not be changed.
9998 Before previewing your paper, be sure that the babel package is not used.
9999 To do this, click on
10001 Tools\SpecialChar \menuseparator
10012 checkbox in the language settings, and click on
10020 , if you wish to make this change permanent).
10023 \begin_layout Enumerate
10025 \begin_inset Quotes eld
10029 \begin_inset Quotes erd
10032 style must be used to define keywords.
10035 \begin_layout Enumerate
10036 The ijmpc package provides a style named
10037 \begin_inset Quotes eld
10040 Classification Codes
10041 \begin_inset Quotes erd
10044 , which can be used to define classification codes, such as PACS numbers.
10045 Note that this facility is not supported by the ijmpd package.
10048 \begin_layout Enumerate
10049 Several new environments are available:
10050 \begin_inset Quotes eld
10054 \begin_inset Quotes erd
10058 \begin_inset Quotes eld
10062 \begin_inset Quotes erd
10066 \begin_inset Quotes eld
10070 \begin_inset Quotes erd
10074 \begin_inset Quotes eld
10078 \begin_inset Quotes erd
10082 \begin_inset Quotes eld
10086 \begin_inset Quotes erd
10090 \begin_inset Quotes eld
10094 \begin_inset Quotes erd
10098 \begin_inset Quotes eld
10102 \begin_inset Quotes erd
10106 \begin_inset Quotes eld
10110 \begin_inset Quotes erd
10114 \begin_inset Quotes eld
10118 \begin_inset Quotes erd
10122 \begin_inset Quotes eld
10126 \begin_inset Quotes erd
10130 \begin_inset Quotes eld
10134 \begin_inset Quotes erd
10138 \begin_inset Quotes eld
10142 \begin_inset Quotes erd
10146 \begin_inset Quotes eld
10150 \begin_inset Quotes erd
10154 \begin_inset Quotes eld
10158 \begin_inset Quotes erd
10162 Their use is more or less obvious.
10163 LyX supports all these environments; it will use the proper label, text
10164 style, and numbering scheme for each of them.
10167 \begin_layout Enumerate
10168 Both packages use basic citations; the natbib package should not be used.
10169 In LyX, citation references are shown as usual; in the output, citations
10170 are shown as superscripts.
10171 If you want to use a citation as normal text, you should use the
10176 \begin_inset space \thinspace{}
10180 \begin_inset space \space{}
10184 \begin_inset Quotes eld
10188 \begin_inset space \space{}
10198 \begin_inset Quotes erd
10204 \begin_layout Enumerate
10206 \begin_inset Quotes eld
10210 \begin_inset Quotes erd
10213 section in both packages.
10214 To put acknowledgments, just use the
10215 \begin_inset Quotes eld
10219 \begin_inset Quotes erd
10225 \begin_layout Enumerate
10226 Appendices may be added to the paper,
10230 the Acknowledgments and
10235 LyX provides a special environment, called
10236 \begin_inset Quotes eld
10240 \begin_inset Quotes erd
10243 which marks the beginning of the appendices.
10244 This environment should be left blank; it just sends a LaTeX command, but
10245 nothing is really printed.
10247 \begin_inset Quotes eld
10251 \begin_inset Quotes erd
10254 is printed with blue letters, as a signal that all sections after that
10255 point are appendices.
10256 To write an appendix, use the
10257 \begin_inset Quotes eld
10261 \begin_inset Quotes erd
10265 LyX will number each appendix with capital letters, as required by both
10268 \begin_inset Quotes eld
10272 \begin_inset Quotes erd
10279 be present before the first appendix; if not, all appendices will be numbered
10280 as normal sections in the output.
10283 \begin_layout Enumerate
10284 The ijmpc and the ijmpd packages use the
10288 command to implement table captions.
10289 As a result, a table created by LyX is printed correctly, but its caption
10291 However, you can use some TeX code to overpass this problem, so that captions
10292 are printed as expected.
10293 To do so, create a float table as usual, remove the caption, and replace
10294 it with the TeX code
10304 (sic); you must also the TeX code
10308 immediately after the tabular material.
10309 Study the example table included in the template files to see how this
10310 trick is implemented.
10311 Alternatively, If you need table captions, you should implement the whole
10316 file, then include this file to the LyX document (
10318 Insert\SpecialChar \menuseparator
10319 File\SpecialChar \menuseparator
10321 \begin_inset space ~
10327 Details on how to create a table float can be found in the files
10335 , included in the corresponding packages.
10338 \begin_layout Subsection
10339 Preparing a paper for submission
10342 \begin_layout Standard
10343 Before you submit your paper you must export the LyX document as a LaTeX
10346 File\SpecialChar \menuseparator
10347 Export\SpecialChar \menuseparator
10358 \begin_layout Plain Layout
10359 Actually you have the choice between LaTeX (plain) and pdflatex.
10360 If you intend to use pdflatex to prepare the paper, you should use the
10361 pdflatex option so that included graphics are converted to PDF format,
10362 ready for use by pdflatex.
10367 , then make the following changes to the resulting
10374 \begin_layout Enumerate
10375 Remove the comment lines before the
10384 \begin_layout Enumerate
10385 Remove everything between (and including) the
10397 commands, except for any commands you specifically put into the LaTeX preamble.
10400 \begin_layout Standard
10405 file should be saved and processed through LaTeX as many times as necessary.
10406 You may also want to check the resulting
10413 \begin_layout Subsection
10417 \begin_layout Standard
10418 The use of TeX code is reduced to two commands, which must be placed at
10419 the top of the document.
10420 If you started writing your paper by using the
10428 template, the TeX code needed is already in its place; you usually don't
10430 You may only modify the first TeX code to specify the information printed
10431 to the top of odd and even pages (authors' names and short paper's title,
10433 This TeX code must have the form
10437 markboth{Authors' Names}{Short Paper's Title}
10442 \begin_layout Section
10446 \begin_layout Standard
10452 \begin_layout Subsection
10456 \begin_layout Standard
10457 The iopart package provides a document class to create electronic manuscript
10458 submission to the journals published by the Institute of Physics.
10459 Instructions for the authors how to create a paper using the iopart class
10460 can be downloaded together with the iopart package from the site
10461 \begin_inset Flex URL
10464 \begin_layout Plain Layout
10466 ftp://ftp.iop.org/pub/journals/latex2e
10474 \begin_layout Subsection
10478 \begin_layout Standard
10479 The easiest way to write a paper is to start with the file
10483 that is available in LyX's examples files folder.
10484 Open this file, save it under a new name, and start writing.
10485 The example file explains how to use the special text environments.
10486 Here are the most important advices:
10489 \begin_layout Itemize
10490 To be able to compile your document to a PDF, PS, or DVI, assure that the
10493 Use AMS math package
10495 in the document settings under
10502 \begin_layout Itemize
10505 The title environment defines the kind of your paper.
10506 So use one of the following environments for the title:
10510 \begin_layout Itemize
10519 \begin_layout Itemize
10528 \begin_layout Itemize
10534 for a Topical review
10537 \begin_layout Itemize
10546 \begin_layout Itemize
10555 \begin_layout Itemize
10561 for a Paper (same as Title)
10564 \begin_layout Itemize
10570 for a Preliminary communication
10573 \begin_layout Itemize
10579 for a Rapid communication
10582 \begin_layout Itemize
10588 for a Letter to the editor
10592 \begin_layout Itemize
10595 All title environments except of
10599 can have an optional short title.
10602 \begin_layout Itemize
10603 There is a general title environment
10607 which is not directly supported by the LyX.
10608 This can be used as TeX code when your document doesn't fit into one of
10609 the other title types.
10612 \begin_layout Standard
10613 For more informations like hints for special table and formula formatting,
10614 look at the IOP author guidelines.
10617 \begin_layout Section
10621 \begin_layout Standard
10624 Panayotis Papasotiriou
10627 \begin_layout Subsection
10631 \begin_layout Standard
10632 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
10633 that facilitates electronic manuscript submission to the journals they
10635 Most known of them (at least in my domain of interest) are
10637 Astrophysics and Space Science
10643 , but there are many others (see a complete list at
10644 \begin_inset Flex URL
10647 \begin_layout Plain Layout
10649 http://www.wkap.nl/jrnllist.htm/JRNLHOME
10655 The Kluwer package may be downloaded from the site
10656 \begin_inset Flex URL
10659 \begin_layout Plain Layout
10661 http://www.wkap.nl/kaphtml.htm/STYLEFILES
10667 A complete user guide is contained in that package (but it can also be
10668 downloaded separately).
10671 \begin_layout Standard
10672 LyX supports many features of the package but not everything.
10673 However, the TeX code needed is reduced to some
10674 \begin_inset Quotes eld
10678 \begin_inset Quotes erd
10681 commands of the package (see
10682 \begin_inset space ~
10686 \begin_inset CommandInset ref
10688 reference "subsec:kluwer_peculiarities"
10693 I have recently used LyX to write an article submitted to the
10695 Astrophysics and Space Science
10697 without any problem.
10700 \begin_layout Subsection
10704 \begin_layout Standard
10705 The easiest way to write a paper is to start with the Kluwer template file.
10708 File\SpecialChar \menuseparator
10720 This will give an (almost) empty document that includes the most common
10721 fields found in a manuscript and a short description of their use.
10722 As in most templates, simply overwrite the existing text (including the
10727 ) with the correct information.
10730 \begin_layout Subsection
10731 Preparing a paper for submission
10734 \begin_layout Standard
10735 As in the AASTeX package, before you submit your paper to a journal you
10737 \begin_inset Quotes eld
10741 \begin_inset Quotes erd
10747 \begin_layout Enumerate
10748 Export your paper as a LaTeX file.
10749 To do this, click on
10751 File\SpecialChar \menuseparator
10752 Export\SpecialChar \menuseparator
10759 \begin_layout Enumerate
10764 file with a text editor and make the following changes
10768 \begin_layout Enumerate
10769 remove the comment lines before the
10778 \begin_layout Enumerate
10779 remove everything between (and including) the
10791 commands, except for any commands you specifically put into the LaTeX preamble.
10794 \begin_layout Standard
10803 \begin_layout Enumerate
10808 file through LaTeX as many times as necessary (usually up to three).
10811 \begin_layout Enumerate
10817 \begin_inset space \thinspace{}
10821 \begin_inset space \space{}
10828 , and check if everything is OK (it should, if you didn't make any mistake).
10831 \begin_layout Subsection
10832 \begin_inset Quotes eld
10836 \begin_inset Quotes erd
10839 of the Kluwer package
10840 \begin_inset CommandInset label
10842 name "subsec:kluwer_peculiarities"
10849 \begin_layout Standard
10850 The Kluwer package has the following
10851 \begin_inset Quotes eld
10855 \begin_inset Quotes erd
10861 \begin_layout Enumerate
10862 It is possible to write multiple articles in the same LaTeX file
10866 \begin_layout Plain Layout
10867 I can't imagine any good reason to do this.
10873 Each article must be included in the environment
10874 \begin_inset Quotes eld
10878 \begin_inset Quotes erd
10882 Unfortunately, this environment cannot be omitted, even if you write just
10884 Therefore, each article starts with the command
10890 and, obviously, ends with the command
10897 Although this can be implemented in LyX, I didn't included it, since it
10898 looks ugly and can confuse the novice user.
10899 Therefore, you need to enter them directly and mark them as LaTeX code
10901 \begin_inset Quotes eld
10905 \begin_inset Quotes erd
10911 \begin_layout Enumerate
10912 Information given at the beginning of the article (i.
10913 \begin_inset space \thinspace{}
10917 \begin_inset space \space{}
10920 title, subtitle, author, institution, running title, running author, abstract
10921 and keywords) must be included in an environment called
10922 \begin_inset Quotes eld
10926 \begin_inset Quotes erd
10930 This is not implemented in LyX, so you must enter title, subtitle etc.
10931 \begin_inset space ~
10934 between two TeX code lines (
10949 \begin_layout Enumerate
10950 According to the user manual, the label of each bibliography item must be
10974 \begin_layout Standard
10979 template takes care of all these
10980 \begin_inset Quotes eld
10984 \begin_inset Quotes erd
10988 If you start a new paper using this template you don't need to do anything
10993 \begin_layout Enumerate
10994 don't delete the TeX code included in the template, and
10997 \begin_layout Enumerate
10998 copy the example bibliography item included in the template and modify it
10999 as necessary to enter new bibliography items.
11002 \begin_layout Section
11006 \begin_layout Standard
11012 \begin_layout Subsection
11016 \begin_layout Standard
11017 The LyX document classes
11019 article (koma-script)
11023 report (koma-script)
11041 correspond to the LaTeX document classes
11058 \begin_inset space ~
11061 of the Koma-Script family.
11062 They are replacements for the standard document classes
11078 , resp., and fit better to European typography conventions in a number of
11082 \begin_layout Itemize
11083 Standard character size is 11pt in
11085 article (koma-script)
11089 report (koma-script)
11097 letter (koma-script)
11102 \begin_layout Itemize
11103 Headings, labels of the description environment, and a number of elements
11106 letter (koma-script)
11108 document class are set in a bold sans serif font.
11112 \begin_layout Plain Layout
11113 There is a big difference between the bold sans serif old cm fonts and new
11114 ec fonts, especially in the appearance of headings.
11115 In comparison, the ec bold sans serif fonts look a bit thin.
11116 Here the LaTeX package
11124 helps to produce the
11125 \begin_inset Quotes eld
11129 \begin_inset Quotes erd
11132 appearance when using the ec fonts.
11137 The numbering of chapter headings is made in the same way as the numbering
11138 of section headings, that is without the extra line
11139 \begin_inset Quotes eld
11142 Chapter\SpecialChar \ldots{}
11144 \begin_inset Quotes erd
11148 In addition, the appearance of the headings can be modified by using a
11149 number of options (in LyX to be entered in the field
11152 \begin_inset space ~
11159 Layout\SpecialChar \menuseparator
11163 A detailed German description of these options can be found in the Koma-Script
11171 \begin_layout Itemize
11172 The main means in the Koma-Script document classes to design the type area
11181 (in LyX to be entered in the extra class options field in the dialog
11183 Document\SpecialChar \menuseparator
11187 They make a clearer modification of page margins possible as do the options
11190 Document\SpecialChar \menuseparator
11194 A detailed German description of these and other type area options can
11195 be found in the Koma-Script documentation
11202 \begin_layout Itemize
11203 The LaTeX document classes of the Koma-Script family define a number of
11204 additional commands.
11205 Those part of it which makes sense in LyX is implemented in corresponding
11209 \begin_layout Standard
11210 A detailed German description of the LaTeX document classes of the Koma-Script
11211 family can be found in the Koma-Script documentation
11219 \begin_layout Plain Layout
11220 There is an English translation
11224 , but it is not a complete one.
11229 The following sections describe only those aspects, which are relevant
11233 \begin_layout Subsection
11234 article (koma-script), report (koma-script), and book (koma-script)
11237 \begin_layout Standard
11238 The document classes
11240 article (koma-script)
11244 report (koma-script)
11254 are implemented in the layout files
11267 They contain all the paragraph types of the corresponding standard document
11280 , resp., partly modified, with the exception of the LyX specific
11284 -type, which is replaced by the new
11288 -type having the same functionality.
11293 -Type there is a number of new paragraph types added.
11300 letter (koma-script)
11305 \begin_layout Itemize
11314 : are equivalents to
11322 , resp., additionally inserting an entry in the table of contents.
11331 are not contained in
11333 article (koma-script)
11338 \begin_layout Itemize
11347 : behave exactly as
11355 , resp., additionally clearing running heads.
11360 is not contained in
11362 article (koma-script)
11368 \begin_layout Plain Layout
11381 report (koma-script)
11383 , but since this is identical to
11387 , is has not been implemented in LyX.
11395 \begin_layout Itemize
11400 : generates a heading directly above the following paragraph in the standard
11401 character size without affecting the structure of the document.
11404 \begin_layout Itemize
11413 are special captions which respect the different space settings needed
11414 for captions placed above or below an element (if you follow strict typographic
11415 rules, you might want to place table captions always above the table).
11416 You can also use the class option
11420 , which will switch
11433 You need at least Koma-Script version 2.8q to use this.
11436 \begin_layout Itemize
11441 : can be used to set a bonmot, e.
11442 \begin_inset space \thinspace{}
11446 \begin_inset space \space{}
11449 at the beginning of a chapter.
11450 If you use the optional argument (
11452 Insert\SpecialChar \menuseparator
11454 \begin_inset space ~
11459 ), you can insert the dictum's author there.
11460 Dictum and author are separated by a line.
11461 You need at least Koma-Script version 2.8q to use this.
11466 is not contained in
11468 article (koma-script)
11473 \begin_layout Standard
11474 The following types, together with the standard types
11486 , form the title area of the document.
11487 They must be entered ahead of the first
11488 \begin_inset Quotes eld
11492 \begin_inset Quotes erd
11499 \begin_layout Plain Layout
11500 The corresponding LaTeX commands must appear before the
11511 When such a type is used more than once, the latter usage overwrites the
11512 former one, that means, for every type only the latest usage is valid.
11513 The order of the different types however has, like
11525 , no effect on the appearance of the produced document.
11528 \begin_layout Itemize
11533 : produces a centered paragraph above the ordinary title (
11545 ) for the subject of the document.
11548 \begin_layout Itemize
11553 : produces a centered paragraph below the ordinary title (
11565 ) for the publishers' name.
11568 \begin_layout Itemize
11575 report (koma-script)
11581 produces a centered paragraph on its own page behind the title page, or
11584 article (koma-script)
11586 produces a centered paragraph below the ordinary title (
11602 ) for a dedication.
11605 \begin_layout Itemize
11610 : produces a left aligned paragraph above the ordinary title (
11626 ) for a document`s head.
11629 \begin_layout Itemize
11634 : produces in a double-sided print in
11636 report (koma-script)
11642 a left-aligned paragraph at the top of the title page`s back or has no
11643 effect in a single-sided print or in
11645 article (koma-script)
11650 \begin_layout Itemize
11655 : produces in a double-sided print in
11657 report (koma-script)
11663 a left-aligned paragraph at the bottom of the title page`s back or has
11664 no effect in a single-sided print or in
11666 article (koma-script)
11671 \begin_layout Itemize
11676 : produces a special
11677 \begin_inset Quotes eld
11681 \begin_inset Quotes erd
11684 page ahead of the actual document containing a paragraph without special
11688 \begin_layout Standard
11689 The layout files for the document classes
11691 article (koma-script)
11695 report (koma-script)
11701 do include the file
11706 This is thought of as a place to define your own types.
11711 in your personal layout directory and edit the file!
11714 \begin_layout Subsection
11715 letter (koma-script)
11718 \begin_layout Standard
11722 \begin_layout Plain Layout
11734 \begin_layout Standard
11738 letter (koma-script)
11740 is implemented in the layout file
11745 It contains all the paragraph types of the corresponding standard document
11750 , partly modified, with the exception of the LyX specific types
11762 type, which is replaced by the new
11767 In addition, it contains, in contrast to the standard document class, the
11785 Furthermore, there are a number of new letter specific types.
11788 \begin_layout Standard
11792 \begin_layout Plain Layout
11804 \begin_layout Standard
11805 The appearance of the letter produced by this document class can be controlled
11806 by a number of LaTeX commands, which you can put in the LaTeX preamble.
11810 \begin_layout Plain Layout
11811 For example, the standard appearance of the letter`s heading, consisting
11812 of name and address, is quite self-willed.
11814 \begin_inset Quotes eld
11818 \begin_inset Quotes erd
11821 heading is produced by the following LaTeX commands in the preamble:
11824 \begin_layout LyX-Code
11834 \begin_layout LyX-Code
11850 \begin_layout LyX-Code
11860 \begin_layout LyX-Code
11880 A detailed German description of such LaTeX commands can be found in the
11881 Koma-Script documentation
11886 With it, the letter's author can produce his personal letter layout.
11889 \begin_layout Standard
11898 define the beginning of the letter and must be used in every letter.
11899 To emphasize them in the LyX document class, they are marked with the letter
11909 \begin_inset space ~
11912 in the left margin.
11913 It is possible to write any number of letters in one file.
11918 type produces a new letter using the same addressee and a
11922 type produces a new addressee.
11939 are ordinary paragraph types and can also be used several times in one
11940 and the same letter.
11943 \begin_layout Itemize
11948 : produces a paragraph for the addressee and implicitly defines the beginning
11952 \begin_layout Itemize
11957 : produces a paragraph for the form of address and implicitly produces a
11961 \begin_layout Itemize
11966 : produces a paragraph for a close.
11969 \begin_layout Itemize
11974 : produces a paragraph for a postscript.
11977 \begin_layout Itemize
11982 : produces a paragraph for a distribution list.
11985 \begin_layout Itemize
11990 : produces a paragraph for enclosures.
11993 \begin_layout Standard
12034 are input types provided with a label to enter information, which will
12035 be processed by the document class.
12039 \begin_layout Plain Layout
12040 It could be seen as a matter of inconsequence, that the types
12048 described above are not such input types as well.
12049 Because of the special meaning of those types, however, I have implemented
12050 them as ordinary paragraph types with a one letter mark in the left margin.
12051 Moreover, it would affect my feeling of symmetry, if the
12059 type had such a serious different appearance.
12064 The types must be used ahead of the corresponding
12071 \begin_layout Standard
12072 An implementation of these types in a WYSIWYG fashion does not seem to make
12073 sense, because the real appearance of the produced letter does not only
12074 depend on the usage of the particular type, but also on other factors.
12075 For example, a signature entered in the
12079 type will in the standard behavior appear in the produced letter only,
12080 when in the same letter also a
12085 The entered value of the
12089 type will in the standard behavior not appear in the produced letter at
12091 The possibility to design the letter`s heading freely is already indicated
12092 in a footnote above.
12095 \begin_layout Standard
12096 The input types can also be used as empty paragraphs.
12097 This makes sense e.
12098 \begin_inset space \thinspace{}
12102 \begin_inset space \space{}
12114 type is not used at all, in the standard behavior the value of the
12118 type is used as signature, whereas if an empty
12122 type is used, no signature value is defined.
12125 \begin_layout Standard
12126 By using the input types it is possible to write a letter template, containing
12127 filled input types with your personal dates (name, address, etc.) and empty
12128 input types for other dates you want to enter.
12131 \begin_layout Itemize
12136 : sender's name, in the standard behavior appears as a centered paragraph
12137 in small caps in the letter`s heading.
12140 \begin_layout Itemize
12145 : sender's signature, in the standard behavior appears below the
12154 type is used, the value of the
12158 type appears instead.
12161 \begin_layout Itemize
12166 : sender's address, in the standard behavior appears in a centered paragraph
12167 in the letter`s heading below the sender's name.
12170 \begin_layout Itemize
12175 : sender's telephone number, in the standard behavior only sets the LaTeX
12185 \begin_layout Itemize
12190 : place of the letter`s making.
12193 \begin_layout Itemize
12198 : date of the letter`s making.
12207 , in the standard behavior, produce the place and the date in a right-aligned
12208 line below the addressee's field.
12213 type is used, neither place nor date appear, independent of the value of
12223 type is used, the date of the letter `s production is used.
12226 \begin_layout Itemize
12231 : sender`s back address, in the standard behavior appears above the addressee's
12232 field in a small sans serif font.
12235 \begin_layout Itemize
12240 : special mail information, in the standard behavior appears underlined
12241 above the addressee's field below the back address.
12244 \begin_layout Itemize
12249 : additional information, in the standard behavior appears on right side
12250 below the addressee`s field.
12253 \begin_layout Itemize
12258 : the letter's title, in the standard behavior appears in a big, bold, sans
12259 serif font above the subject.
12262 \begin_layout Itemize
12267 : the letter's subject, in the standard behavior appears in a bold font
12275 \begin_layout Standard
12296 produce a business letter like line above the
12300 line containing the fields
12301 \begin_inset Quotes eld
12305 \begin_inset Quotes erd
12309 \begin_inset Quotes eld
12313 \begin_inset Quotes erd
12317 \begin_inset Quotes eld
12321 \begin_inset Quotes erd
12325 \begin_inset Quotes eld
12329 \begin_inset Quotes erd
12333 \begin_inset Quotes eld
12337 \begin_inset Quotes erd
12341 \begin_inset Quotes eld
12345 \begin_inset Quotes erd
12349 For the date field, the value of the
12355 \begin_inset Quotes eld
12358 business letter types
12359 \begin_inset Quotes erd
12362 is used, the value of the
12366 type however does not appear, but only the LaTeX variable
12373 The ordinary output of place and date in a right-aligned line below the
12374 addressee`s field is suppressed.
12375 The types are implemented as input types provided with a label and must
12376 be used ahead of the corresponding
12383 \begin_layout Itemize
12391 \begin_layout Itemize
12399 \begin_layout Itemize
12407 \begin_layout Itemize
12415 \begin_layout Itemize
12423 \begin_layout Subsection
12424 The new letter class: letter (koma-script v.2)
12427 \begin_layout Standard
12430 Jürgen Spitzmüller
12433 \begin_layout Standard
12434 \begin_inset VSpace medskip
12440 \begin_layout Standard
12442 Koma-Script version 2.8 has introduced a new letter class
12446 which supersedes the now unsupported
12451 It has — on the LaTeX side — a completely new interface and is not compatible
12452 with the old class.
12453 Therefore, LyX supports both, though it is recommended to use the new class.
12456 \begin_layout Standard
12457 This class covers the same functionality as
12459 letter (koma-script),
12462 The basic items are
12466 (receiver's address, same as
12470 in the old layout),
12483 will start a new letter (i.
12484 \begin_inset space \thinspace{}
12488 \begin_inset space \space{}
12491 you can write several letters per document).
12492 New elements are sender's
12508 and the possibility to use a
12514 Insert\SpecialChar \menuseparator
12520 \begin_layout Standard
12521 The biggest improvement is, though, that the letter's layout is configurable
12522 at almost any needs.
12523 This can be done via the preamble or with a special style file (Letter
12524 Class Option, extension
12528 ), that will be read in as a class option.
12532 \begin_layout Plain Layout
12533 The KOMA package comes with some default
12538 There is, for instance, a
12542 file that follows german typesetting rules, or a
12546 that provides the default layout of the old
12551 The latter can be loaded with the class option
12560 ayout\SpecialChar \menuseparator
12565 ocument\SpecialChar \menuseparator
12577 template that is included in LyX for examples.
12578 A detailed description is to be found in the Koma-Script documentation
12586 \begin_layout Subsection
12590 \begin_layout Standard
12591 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
12595 \begin_layout Itemize
12596 The chapter number of a
12600 type appears on a line of its own above the chapter heading instead of
12601 appearing in the same line ahead of it.
12602 The cause for that is the LyX internal behavior for the labeltype
12606 in the layout file.
12609 \begin_layout Itemize
12610 The headings of the types
12618 are only put in the
12619 \begin_inset Quotes eld
12623 \begin_inset Quotes erd
12626 LaTeX table of contents, but not in the LyX table of contents (
12628 Document\SpecialChar \menuseparator
12630 \begin_inset space ~
12634 \begin_inset space ~
12642 \begin_layout Itemize
12643 The paragraphs in a
12647 document class appear in a skip separation mode, not indented.
12648 This is the standard behavior, no special LaTeX commands are needed for
12652 Document\SpecialChar \menuseparator
12655 dialog the corresponding radio button indicates
12664 value always has the effect that extra LaTeX commands are inserted in the
12665 document to produce the gap, which is not what is wanted in this case.
12668 \begin_layout Section
12669 Latex8 (IEEE Conference Papers)
12672 \begin_layout Standard
12678 \begin_layout Subsection
12682 \begin_layout Standard
12683 Since this class is specifically for writing submissions to IEEE sponsored
12684 conferences I strongly recommend that you get a copy of their Authors Kit.
12689 package and associated bibliography style file is included in the kit.
12690 The Authors Kit is usually sent out by email once your initial submission
12692 There is a lot of useful information in the Authors Kit explaining formatting
12693 restrictions and so on and I will assume you have read this since that
12694 means I don't have to repeat it all here.
12697 \begin_layout Subsection
12701 \begin_layout Standard
12702 [AR\SpecialChar \@.
12706 \begin_layout Subsection
12707 Supported Environments
12710 \begin_layout Itemize
12716 \begin_layout Itemize
12722 \begin_layout Itemize
12728 \begin_layout Itemize
12734 \begin_layout Itemize
12740 \begin_layout Itemize
12746 \begin_layout Itemize
12752 \begin_layout Itemize
12758 \begin_layout Itemize
12764 \begin_layout Subsection
12765 Differences Between Screen and Paper
12768 \begin_layout Standard
12769 There are slight differences in appearance mainly with the presentation
12770 of section counters.
12771 On screen the trailing period of the section counter is missing but it
12772 will appear in the output so don't let this worry you.
12775 \begin_layout Section
12779 \begin_layout Standard
12782 Jürgen Spitzmüller
12785 \begin_layout Subsection
12789 \begin_layout Standard
12790 Memoir is a very powerful and constantly evolving class.
12791 It has been designed with regard to fictional and non-fictional literature.
12792 Its aim is to let the user have maximum control over the typesetting of
12794 Memoir is based on the standard book class, but it can also emulate the
12795 article class (see below).
12798 \begin_layout Standard
12799 Peter Wilson, the developer of Memoir, is known as the author of lots of
12800 useful packages in the LaTeX world.
12801 Most of them have been merged with Memoir.
12802 Therefore, it is much easier to layout the table of contents, appendices,
12803 chapter designs and such.
12804 LyX, though, does not support all of these goodies natively.
12805 Some of them might be added to forthcoming releases
12809 \begin_layout Plain Layout
12810 You are invited to send suggestions to
12811 \begin_inset Flex URL
12814 \begin_layout Plain Layout
12816 lyx-devel@lists.lyx.org
12826 , lots will probably never, due to the limitations of LyX's framework.
12827 Of course you can still use all features with the help of some native LaTeX
12832 \begin_layout Plain Layout
12837 \begin_layout Plain Layout
12847 \begin_inset space ~
12851 \begin_inset CommandInset ref
12853 reference "sec:Inserting-TeX-Code"
12863 In this section, we can only list those features which are natively supported
12865 For detailed descriptions (and for the rest of features) we are recommending
12866 to have a look at the detailed manual of the Memoir class
12870 \begin_layout Plain Layout
12875 \begin_layout Plain Layout
12885 \begin_inset Flex URL
12888 \begin_layout Plain Layout
12890 CTAN:/macros/latex/memoir/memman.pdf
12900 , which is not only a user guide for the class, but also both a comprehensive
12901 description on good typesetting and a superb example for good typesetting
12905 \begin_layout Subsection
12906 Basic features and restrictions
12909 \begin_layout Standard
12910 Memoir supports basically all features of the standard book classes.
12911 There are, however, some differences, as follows:
12914 \begin_layout Description
12916 \begin_inset space ~
12919 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
12922 \begin_layout Description
12924 \begin_inset space ~
12927 style: The fancy page style is not supported, due to a command clash between
12928 Memoir and the fancyhdr package (they are both defining a command with
12929 the same name, which confuses LaTeX).
12930 Instead, Memoir comes with a bunch of own page styles (see
12932 Layout\SpecialChar \menuseparator
12933 Document\SpecialChar \menuseparator
12935 \begin_inset space ~
12941 If you want to use these for the chapter pages, you have to use the command
12948 in the main text or in preamble (e.
12949 \begin_inset space \thinspace{}
12953 \begin_inset space \space{}
12960 chapterstyle{companion}
12965 \begin_layout Description
12966 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
12967 an optional argument in the standard classes.
12968 With this, you can specify an alternative version of the title for the
12969 table of contents and the headers (for instance, if the title is too long).
12970 In LyX, you can do this via
12972 Insert\SpecialChar \menuseparator
12974 \begin_inset space ~
12979 at the beginning of a chapter/section.
12980 Memoir features a second optional argument and thus separates the table
12981 of contents from the header.
12982 You can define three variants of a title with this: one for the main text,
12983 one for the table of contents, and one for the headers.
12984 Simply insert two optional arguments if you need this feature, the first
12985 one containing the short title for the Table of Contents, the second one
12986 containing an alternative short title for the headers.
12989 \begin_layout Description
12990 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
12991 of contents, the list of figures and the list of table start a new page
12993 Memoir does not follow this route.
12994 You have to insert a page break yourself, if you want to have one.
12997 \begin_layout Description
12998 Titlepage: For some unknown reason, Memoir uses pagination on the title
12999 page (in the standard classes, title pages are
13000 \begin_inset Quotes eld
13004 \begin_inset Quotes erd
13008 \begin_inset space \thinspace{}
13012 \begin_inset space \space{}
13016 If you want an empty title page, type
13020 aliaspagestyle{title}{empty}
13025 \begin_layout Description
13026 Article: With the class option
13032 Layout\SpecialChar \menuseparator
13033 Document\SpecialChar \menuseparator
13035 \begin_inset space ~
13040 ), you can emulate article style.
13041 That is, counters (footnotes, figures, tables etc.) will not be reset on
13042 new chapters, chapters don't start a new page (but are—in contrary to
13043 \begin_inset Quotes eld
13047 \begin_inset Quotes erd
13050 article classes—still allowed), parts, though, use their own page, as in
13054 \begin_layout Description
13055 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
13056 font commands, which have been used in the old LaTeX version 2.09 (e.
13057 \begin_inset space \thinspace{}
13061 \begin_inset space \space{}
13077 It produces an error and stops LaTeX whenever such a command appears.
13082 reallows the commands and spits out warnings instead (which does at least
13084 Since a lot of packages and particularly BibTeX style files are still using
13085 those commands, we have decided to use this option by default.
13088 \begin_layout Subsection
13092 \begin_layout Standard
13093 We will only describe the features supported by LyX (which is not much currently
13095 Please consult the Memoir manual
13099 \begin_layout Plain Layout
13104 \begin_layout Plain Layout
13114 \begin_inset Flex URL
13117 \begin_layout Plain Layout
13119 CTAN:/macros/latex/memoir/memman.pdf
13132 \begin_layout Description
13133 Abstract: You may wonder why an abstract is an extra feature.
13134 Well, it is in book class.
13135 Usually books don't have abstracts.
13136 Memoir, however, has.
13137 You can use it wherever and how often you like.
13140 \begin_layout Description
13141 Chapterprecis: You may know this from belletristic: The contents of a chapter
13142 is shortly described below the title and also in the table of contents
13144 \begin_inset space \thinspace{}
13148 \begin_inset space \space{}
13153 Our hero arrives in Troia; he loses some friends; he finds others
13156 Chapterprecis does exactly this.
13157 It is therefore only sensible below a chapter.
13160 \begin_layout Description
13161 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
13162 The epigraph environment provides an elegant way of typesetting such a
13164 The motto itself (text) and its author (source) are divided by a short
13166 Unfortunately, we have to fool LyX a bit here again, since the environment
13167 needs two arguments (text and source).
13168 In this case, we have to use curly brackets (in TeX mode) between the two
13179 <author of the slogan>.
13182 \begin_layout Description
13183 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
13184 complex figurative poems).
13185 LyX can only support a few of them.
13186 One is poemtitle, which is a centered title for poems, which will also
13187 be added to the table of contents (verse is the standard environment for
13189 Memoir has some enhanced versions of verse, but you need to use TeX code,
13190 because they have to be nested inside regular verse environments, which
13191 is not possible with LyX).
13194 \begin_layout Description
13195 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
13198 \begin_layout Section
13199 Article (mwart), book (mwbk) and report (mwrep)
13200 \begin_inset OptArg
13203 \begin_layout Plain Layout
13216 \begin_layout Standard
13222 \begin_layout Standard
13223 The LyX document classes
13239 correspond to the LaTeX document classes
13252 They are replacements for the standard document classes
13264 , resp., and fit better to Polish typography conventions in a number of points.
13268 \begin_layout Standard
13272 \begin_layout Itemize
13273 Unnumbered titles (with star, e.
13274 \begin_inset space \thinspace{}
13278 \begin_inset space \space{}
13285 ) are added into table of contents,
13288 \begin_layout Itemize
13289 Additional page styles:
13293 \begin_layout Description
13294 uheadings header with separated lines,
13297 \begin_layout Description
13298 myheadings custom header, contents headers via commands:
13313 \begin_layout Description
13314 myuheadings custom header with separated lines,
13317 \begin_layout Description
13318 outer page number is placed on outer side of page
13322 \begin_layout Itemize
13327 \begin_layout Description
13328 rmheadings serif titles — default,
13331 \begin_layout Description
13332 sfheadings sansserif titles,
13335 \begin_layout Description
13336 authortitle on title page first placed is author next title — default,
13339 \begin_layout Description
13340 titleauthor on title page first placed is title next author,
13343 \begin_layout Description
13344 withmarginpar reserve place on page for margins.
13348 \begin_layout Section
13352 \begin_layout Standard
13357 provides an alternative to the standard
13362 It provides similar functionality, but you might prefer this layout with
13363 sans serif sections, headings, and more.
13366 \begin_layout Section
13370 \begin_layout Standard
13376 \begin_layout Standard
13377 \begin_inset VSpace bigskip
13383 \begin_layout Standard
13388 \begin_inset space ~
13393 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13394 \begin_inset Formula $\beta$
13397 release of May, 1999) class.
13400 \begin_layout Standard
13405 textclass, which works with RevTeX 3.1.
13406 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13407 That means that it doesn't interact very well with LyX, which requires
13408 LaTeX2e, although it has been kludged to work.
13409 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13413 \begin_inset space ~
13418 textclass should also be pretty easy to use.
13421 \begin_layout Standard
13422 These documents are supposed to be used in
13426 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13427 macros, and assume you'll know what to put in the preamble if necessary.
13430 \begin_layout Subsection
13434 \begin_layout Standard
13435 All you need to do is install RevTeX 4, as described in the package's README
13437 The package can be found at The RevTeX 4 Web Site
13438 \begin_inset Flex URL
13441 \begin_layout Plain Layout
13443 http://publish.aps.org/revtex4/
13449 Install it somewhere that LaTeX can see it.
13450 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13452 \begin_inset space \thinspace{}
13456 \begin_inset space \space{}
13459 not the directory where you installed the class file.) Then, if you reconfigure
13460 LyX, it will find the class file and let you use the RevTeX4 textclass.
13463 \begin_layout Standard
13464 Probably the easiest way to get started is either to import a RevTeX 4 document
13472 \begin_inset space ~
13477 template, found in the templates directory.
13480 \begin_layout Subsection
13484 \begin_layout Standard
13485 Optional arguments to
13492 \begin_inset Quotes eld
13496 \begin_inset Quotes erd
13500 \begin_inset Quotes eld
13504 \begin_inset Quotes erd
13514 \begin_inset space ~
13522 \begin_inset space ~
13528 Remember that in RevTeX, at least one optional argument is required!
13531 \begin_layout Standard
13532 Other preamble matter, like
13539 \begin_inset space ~
13549 \begin_inset space ~
13554 dialog, also as usual.
13557 \begin_layout Subsection
13561 \begin_layout Standard
13562 The layouts basically correspond to the commands in RevTeX4.0.
13563 For example, the Email layout corresponds to
13570 Note that (at least as of RevTeX 4.0 Beta), the
13578 layouts are exactly equivalent, so you shouldn't need to use both.
13582 \begin_layout Plain Layout
13583 In case you're curious, both were included so that
13587 would be able to translate both
13607 \begin_layout Subsection
13611 \begin_layout Standard
13612 There are a couple of important unique aspects of RevTeX 4 which might cause
13613 bugs that will be even more confusing in LyX.
13616 \begin_layout Standard
13634 The LyX equivalent is that there is a separate Thanks layout.
13639 write footnotes in the
13643 layout, or weird things may happen.
13644 See the RevTeX 4 documentation for more details.
13647 \begin_layout Standard
13651 \begin_inset space ~
13659 \begin_inset space ~
13668 layouts must be placed
13676 layout and the corresponding
13693 , the LaTeX won't compile.
13696 \begin_layout Subsection
13700 \begin_layout Standard
13701 The main problem with this layout is that you can't use the optional arguments
13702 to layouts like Email and Title.
13703 (The problem is not unique to this layout; you can't use optional arguments
13704 to the Section layouts either.) This means that after you export that file
13705 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13706 need to edit the LaTeX file with a text editor to add the optional arguments
13708 \begin_inset space \thinspace{}
13712 \begin_inset space \space{}
13715 the running title for the page headers.
13716 Lacking these layouts makes the
13722 (and the equivalent
13728 ) useless, so the corresponding layouts don't exist, and will have to be
13733 \begin_layout Plain Layout
13738 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13739 has not been updated yet to take advantage of it.
13747 \begin_layout Section
13748 Springer Journals (
13755 \begin_layout Standard
13761 \begin_layout Subsection
13765 \begin_layout Standard
13766 These are the layout files for some of the journal formats used by Springer
13767 Verlag and listed on
13768 \begin_inset Flex URL
13771 \begin_layout Plain Layout
13773 http://www.springer.de/author/tex/help-journals.html
13778 , where you should also go to fetch the class files (yes, these are LaTeX2e
13780 It is a modular system: the things common to all journals are implemented
13785 , which journal-specific layout files (such as, e.
13786 \begin_inset space \thinspace{}
13790 \begin_inset space \space{}
13797 for Journal of Geodesy) can include.
13800 \begin_layout Standard
13801 This means that implementing support for any other Springer journal on this
13802 list is as simple as writing your own
13810 file following the outline given in
13818 \begin_layout Standard
13819 It is reasonably well tested only for the Journal of Geodesy.
13828 come with the standard LyX distribution.
13829 Install the relevant class file (downloaded from Springer) in a proper
13830 directory, reconfigure LaTeX (in the teTeX case by running
13834 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
13835 and it should work.
13838 \begin_layout Subsection
13842 \begin_layout Standard
13843 A large number of theorem-like styles —
13849 \SpecialChar \ldots{}
13855 \begin_layout Standard
13858 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
13859 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
13862 See the Springer class file documentation for details.
13865 \begin_layout Subsection
13869 \begin_layout Itemize
13881 \begin_layout Itemize
13884 Probability Theory and Related Fields
13890 — Jean-Marc Lasgouttes
13893 \begin_layout Standard
13894 Add your own, it isn't so hard!
13897 \begin_layout Subsection
13901 \begin_layout Standard
13902 These files are partly based on the older
13906 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
13907 file from Springer.
13912 layout, are now defunct.
13913 Jean-Marc Lasgouttes helped out big in making me find my way around the
13914 LyX layout file mechanism.
13917 \begin_layout Subsection
13921 \begin_layout Standard
13923 But probably less than in the old hacked-LaTeX
13930 \begin_layout Standard
13932 \begin_inset space \thinspace{}
13935 g.: does not display the number for theorem-like layouts, just #.
13938 \begin_layout Section
13944 \begin_inset CommandInset label
13953 \begin_layout Standard
13961 \begin_layout Subsection
13965 \begin_layout Standard
13966 This section describes how to use LyX to make slides for overhead projectors.
13967 There are two document classes that can do this: the default slides class
13973 This section documents the former.
13976 \begin_layout Standard
13977 I'm going to say this again, nice and clear, so that there's no misunderstanding
13981 \begin_layout Standard
13982 \begin_inset VSpace bigskip
13988 \begin_layout Standard
13992 This section documents the class
13993 \begin_inset Quotes eld
14001 \begin_inset Quotes erd
14009 \begin_layout Standard
14010 \begin_inset VSpace bigskip
14016 \begin_layout Standard
14017 If you're looking for the documentation for
14018 \begin_inset Quotes eld
14026 \begin_inset Quotes erd
14029 , check out section
14030 \begin_inset space ~
14034 \begin_inset CommandInset ref
14036 reference "sec:foiltex"
14046 \begin_inset Quotes eld
14054 \begin_inset Quotes erd
14057 ] is actually somewhat better than the default
14065 \begin_layout Plain Layout
14066 \SpecialChar \ldots{}
14067 or so I've been told repeatedly by its advocates.
14068 Having never used it, I have no idea if this claim is true or not.
14073 which this section documents.
14076 \begin_layout Standard
14077 This class is the LaTeX2e improvement of the old
14082 Every LaTeX2e distribution includes this class [which I'll just refer to
14084 \begin_inset Quotes eld
14092 \begin_inset Quotes erd
14095 from now on], so you're bound to have it.
14096 As I noted earlier, there are other classes, such as
14100 , which also produce slides for overhead projectors and do a better job
14102 However, there are some things which
14106 can do which the others can't, such as generate overlays.
14107 Read on to learn more!
14110 \begin_layout Subsection
14112 \begin_inset CommandInset label
14114 name "sec:slidesetup"
14121 \begin_layout Standard
14122 Obviously, to use this document class, you need to select
14123 \begin_inset Quotes eld
14131 \begin_inset Quotes erd
14134 from the class list in the
14136 Document\SpecialChar \menuseparator
14140 There are some other special things you should know about this class:
14143 \begin_layout Itemize
14144 Don't bother changing the options
14149 They're not supported by the
14156 \begin_layout Itemize
14160 \begin_inset space ~
14165 behaves a bit differently for this class.
14166 The possible choices and what they do are as follows:
14170 \begin_layout Description
14175 The final output contains page numbers in the lower right corner.
14178 \begin_layout Description
14187 , but also prints out any time markers you've put in.
14188 This is the default.
14191 \begin_layout Description
14196 The final output contains no page numbers, time markers, or alignment markers.
14200 \begin_layout Itemize
14205 class has an extra option:
14211 \begin_inset Quotes eld
14219 \begin_inset Quotes erd
14222 in the extra class options.
14226 \begin_layout Standard
14227 Using this options allows you to add time markers to
14233 \begin_inset space ~
14237 \begin_inset CommandInset ref
14239 reference "sec:slideNote"
14247 \begin_layout Standard
14248 You can also use the template file
14249 \begin_inset Quotes eld
14257 \begin_inset Quotes erd
14260 to automatically set up a document to use the
14266 File\SpecialChar \menuseparator
14268 \begin_inset space ~
14272 \begin_inset space ~
14277 to open your new document].
14278 The template file also contains some examples of the special paragraph
14279 environments used by this class.
14280 I'll describe those next.
14283 \begin_layout Subsection
14284 Paragraph Environments
14287 \begin_layout Subsubsection
14288 Supported Environments
14291 \begin_layout Standard
14292 The first thing you'll notice when you start up a new
14296 document is the font size and type: it's the equivalent of the size
14297 \begin_inset Quotes eld
14305 \begin_inset Quotes erd
14311 \begin_inset space ~
14317 This is also what's used in the output.
14319 \begin_inset Quotes eld
14323 \begin_inset Quotes erd
14326 to remind you that this is a slide.
14327 Your final slides will use a larger font; ergo, you'll have less space.
14328 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
14331 \begin_layout Standard
14332 The next thing that becomes obvious is the changes to the paragraph environment
14333 pull-down box [at the far-left end of the toolbar].
14334 Most of the paragraph environments you're used to seeing are missing.
14335 There are also five new ones.
14340 class itself only supports certain paragraph environments:
14343 \begin_layout Itemize
14349 \begin_layout Itemize
14355 \begin_layout Itemize
14361 \begin_layout Itemize
14367 \begin_layout Itemize
14373 \begin_layout Itemize
14379 \begin_layout Itemize
14385 \begin_layout Itemize
14391 \begin_layout Itemize
14397 \begin_layout Itemize
14403 \begin_layout Itemize
14409 \begin_layout Standard
14410 All of the other standard environments, including the section-heading environmen
14411 ts, aren't used in the
14418 \begin_layout Standard
14419 On the other hand, you'll notice the following new environments:
14422 \begin_layout Itemize
14428 \begin_layout Itemize
14434 \begin_layout Itemize
14440 \begin_layout Itemize
14446 \begin_layout Itemize
14452 \begin_layout Standard
14453 These five are kind of quirky, due to a
14454 \begin_inset Quotes eld
14458 \begin_inset Quotes erd
14462 You see, LyX doesn't permit you to nest any other paragraph environment
14463 into an empty environment.
14464 Now, that's fine and dandy, but it means that you wouldn't be able to start
14465 a slide with anything except plain text.
14466 To deal with this, I've performed a little
14467 \begin_inset Quotes eld
14471 \begin_inset Quotes erd
14477 \begin_layout Subsubsection
14478 Quirks of the New Environments
14479 \begin_inset CommandInset label
14481 name "sec:slideQuirk"
14488 \begin_layout Standard
14489 All five of the new paragraph environments are somewhat quirky due to inherent
14490 limitiations in the current version of LyX.
14491 As I just mentioned, LyX forbids environments that begin with another environme
14493 To get around this, the
14497 environment isn't a paragraph environment as described in the
14505 \begin_layout Standard
14506 You should consider
14519 \begin_inset Quotes eld
14522 pseudo-environments.
14523 \begin_inset Quotes erd
14526 They look like a section heading or a
14527 \begin_inset Quotes eld
14535 \begin_inset Quotes erd
14538 but really begin a [and, if necessary, end the previous] paragraph environment.
14548 \begin_inset Quotes eld
14552 \begin_inset Quotes erd
14555 These two perform some action.
14558 \begin_layout Standard
14559 A common feature of all five environments,
14579 , is a rather long-ish label.
14580 The text following this label — ordinarily the contents of the paragraph
14581 environment — is utterly irrelevant for
14602 LyX completely ignores it.
14603 In fact, you can leave these five environments completely empty.
14607 \begin_layout Standard
14612 to put any text after the rather long-ish label, you might want to.
14613 This could be a short description of the contents of the
14618 In that case, enter in your descriptive comment and hit
14622 as you normally would.
14625 \begin_layout Standard
14626 If, on the other hand, you don't want to enter in any descriptive text,
14627 you'll hit another LyX quirk.
14628 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
14629 environment until you put something in the old one.
14633 \begin_layout Itemize
14634 Start entering the text that will
14662 \begin_layout Itemize
14663 Now move to the beginning of that paragraph.
14667 \begin_layout Itemize
14676 \begin_layout Itemize
14677 Finally, change this new, empty paragraph to a
14701 \begin_layout Standard
14702 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
14706 \begin_layout Subsection
14707 Making a Presentation with
14720 \begin_layout Subsubsection
14728 \begin_layout Standard
14729 If you're expecting this section to teach you how to actually make a presentatio
14730 n, you'll be sorely disappointed.
14731 Naturally, I'll describe all of the ways the
14735 class can assist you in preparing the materials for a presentation.
14736 Filling in the contents, however, is up to you.
14741 the LyX philosophy.]
14744 \begin_layout Standard
14749 environment [in the manner described in section
14750 \begin_inset space ~
14754 \begin_inset CommandInset ref
14756 reference "sec:slideQuirk"
14760 ] tells LyX to begin a new slide [duh].
14761 The label for this environment/
14762 \begin_inset Quotes erd
14766 \begin_inset Quotes erd
14770 \begin_inset Quotes eld
14774 \begin_inset Quotes erd
14777 in cool blue, followed by the label,
14778 \begin_inset Quotes eld
14782 \begin_inset Quotes erd
14786 Any text or paragraph environments that follow this one go on the new slide.
14790 \begin_layout Standard
14791 Slides are probably the only time you'll need to forcibly end pages in LyX
14792 (this can be specified in the
14797 In fact, you'll want to, once you finish entering the contents of one slide.
14798 If you've entered more text than can physically fit on a slide, the extra
14799 overflows onto a new slide.
14800 I don't recommend doing this, however, since the overflow slide won't have
14801 any page number on it.
14802 Furthermore, it may interfere with any
14806 you've made to accompany the oversized
14813 \begin_layout Standard
14822 environments work the same way as the
14827 They both create an
14828 \begin_inset Quotes eld
14832 \begin_inset Quotes erd
14835 followed by a label [
14836 \begin_inset Quotes eld
14840 \begin_inset Quotes erd
14844 \begin_inset Quotes eld
14848 \begin_inset Quotes erd
14852 The color is a stunning magenta instead of blue, and the
14853 \begin_inset Quotes eld
14857 \begin_inset Quotes erd
14860 will look different, in style and in length.
14861 The label fonts of all three also differ from one another.
14864 \begin_layout Standard
14869 , if the contents of a
14877 exceed the physical size of a slide or sheet of paper, the extra will overflow
14879 Again, you should avoid this.
14880 It defeats the whole purpose of
14891 \begin_layout Subsubsection
14901 \begin_layout Standard
14906 is a slide that sits atop another slide.
14907 Perhaps you wish to discuss a figure on the main
14911 before displaying the text associated with it.
14912 One way to accomplish this is tape a flap of dark paper over the part of
14917 you want to display later.
14918 This method fails, however, if you wish to overlap one graph with another,
14920 You would then have to fumble while speaking to align the two separate,
14925 s to align the two graphs.
14930 environment in both cases makes life much easier.
14933 \begin_layout Standard
14938 receives the page number of its
14939 \begin_inset Quotes eld
14943 \begin_inset Quotes erd
14951 \begin_inset Quotes eld
14959 \begin_inset Quotes erd
14966 \begin_layout Plain Layout
14967 Presumably, mutliple
14972 \begin_inset Quotes eld
14980 \begin_inset Quotes erd
14984 \begin_inset Quotes eld
14992 \begin_inset Quotes erd
14996 \begin_inset Quotes eld
15004 \begin_inset Quotes erd
15008 \begin_inset space ~
15011 appended to the page number of the parent
15021 Clearly, you want the contents of both the
15029 to each fit on a single physical slide! You should probably consider an
15035 \begin_inset Quotes eld
15039 \begin_inset Quotes erd
15051 class provides a visual cue for this: the label at the start of an
15055 is shorter than that at the start of a
15060 Lastly, when you generate printable output, you'll find alignment markers
15061 in all four corners of both the
15065 page and its parent
15070 These will assist you in lining up the two physical slides.
15073 \begin_layout Standard
15074 The major problem in overlaying two slides is aligning the contents of the
15075 two transparencies.
15076 How much space should you leave for that graph on the second slide? Worse
15077 still, what if you want a graph and a sentence on second slide, but there
15078 is text on the main transparency that goes in between them? You could try
15079 and insert vertical space of the right size.
15080 The better way is to use
15091 \begin_layout Standard
15092 As their names imply,
15100 are two command-like paragraph environments that make all subsequent text
15101 invisible and visible, respectively.
15103 \begin_inset space ~
15107 \begin_inset CommandInset ref
15109 reference "sec:slideQuirk"
15113 that you don't place anything
15117 these two environments, however.
15122 , it inserts a centered, sky-blue label into the page reading
15123 \begin_inset Quotes eld
15126 <Invisible Text Follows>
15127 \begin_inset Quotes erd
15131 For paragraphs following this label, the parts of the
15139 ; it doesn't matter which] where they would be contain instead blank space.
15143 \begin_layout Standard
15148 , the corresponding centered label is
15149 \begin_inset Quotes eld
15152 <Visible Text Follows>
15153 \begin_inset Quotes erd
15157 Paragraphs following this label behave normally.
15158 Note that the beginning of a new
15170 automatically shuts off an
15175 It's therefore not necessary to use
15186 \begin_layout Standard
15187 By now, it should be obvious how to create overlay transparencies using
15188 the proper combination of
15207 \begin_layout Enumerate
15212 , including everything that will appear on it, whether on the main slide
15220 \begin_layout Enumerate
15221 Before each figure or paragraph that will appear only on the
15230 If necessary, insert a
15234 environment after the
15241 \begin_layout Enumerate
15246 immediately following the
15253 \begin_layout Enumerate
15254 Copy the contents of this
15265 \begin_layout Enumerate
15270 , change all of the
15281 \begin_layout Standard
15283 You've just made an
15290 \begin_layout Standard
15291 There's one problem with the way I've designed the LyX
15295 class: you can't make text in the middle of a paragraph invisible, nor
15296 make text in the middle of an invisible paragraph visible again.
15297 To accomplish this feat, you'll need to use some inlined LaTeX codes.
15301 \begin_layout Plain Layout
15302 The commands of interest are:
15305 \begin_layout Itemize
15310 invisible \SpecialChar \ldots{}
15314 \begin_layout Itemize
15319 visible \SpecialChar \ldots{}
15323 \begin_layout Plain Layout
15324 \SpecialChar \ldots{}
15325 and need to be marked as TeX.
15327 \begin_inset Quotes eld
15331 \begin_inset Quotes erd
15334 you wish to change goes in between the brackets [and after the
15347 If you don't know how to mark text as TeX, see the appropriate section
15360 \begin_layout Subsubsection
15370 \begin_inset CommandInset label
15372 name "sec:slideNote"
15379 \begin_layout Standard
15388 is associated with a
15389 \begin_inset Quotes eld
15393 \begin_inset Quotes erd
15405 class provides visual cues.
15410 is shorter than that of a
15414 [yet longer than that of an
15418 ] and, like the label of an
15422 is shockingly magenta.
15423 Additionally, the printed
15427 has the page number of its
15428 \begin_inset Quotes eld
15432 \begin_inset Quotes erd
15440 \begin_inset Quotes eld
15448 \begin_inset Quotes erd
15452 \begin_inset Quotes eld
15460 \begin_inset Quotes erd
15464 \begin_inset Quotes eld
15472 \begin_inset Quotes erd
15476 You can have multiple
15480 s associated with a single
15492 , you'll probably want to break up long
15496 s so that they fit on a single sheet of paper.
15499 \begin_layout Standard
15504 is obvious: it contains anything additional you might want to say about
15510 It could also be used as a sheet of reminders for a particular
15515 In the case of the latter, you might want to make use of time markers.
15521 \begin_inset Quotes eld
15525 \begin_inset Quotes erd
15528 support for time markers, a
15533 So, you'll have to resort to using the LaTeX codes.
15536 \begin_layout Standard
15537 To use time markers, you'll need to specify the extra class option
15538 \begin_inset Quotes eld
15546 \begin_inset Quotes erd
15550 \begin_inset space ~
15554 \begin_inset CommandInset ref
15556 reference "sec:slidesetup"
15561 This option turns on timing marks, which will appear in the lower-left-hand
15567 To set what appears in the time marker, you use the LaTeX commands
15568 \begin_inset Quotes eld
15578 \begin_inset Quotes erd
15582 \begin_inset Quotes eld
15592 \begin_inset Quotes erd
15596 The arguments of both commands are time measured in seconds.
15598 \begin_inset Quotes eld
15608 \begin_inset Quotes erd
15611 sets the time marker to a given time.
15613 \begin_inset Quotes eld
15623 \begin_inset Quotes erd
15626 increments the time marker by the specified amount.
15627 Using time markers and
15631 s in this fashion, you can remind yourself how much time to spend on a particula
15639 \begin_layout Standard
15640 There's one last feature to describe.
15641 Clearly, you'd like to print out all of your
15649 s on transparencies while printing all of your
15666 with which it is associated.
15667 What's a person to do?
15670 \begin_layout Standard
15671 Luckily, there are two LaTeX commands that allow you to select what to print
15673 Both must be placed into the preamble of your document.
15675 \begin_inset Quotes eld
15687 \begin_inset Quotes erd
15690 will cause the output to contain only the
15699 Correspondingly, the command
15700 \begin_inset Quotes eld
15712 \begin_inset Quotes erd
15715 prevents the output of anything but
15720 I'd advise placing both commands in the preamble and initially comment
15722 You can then preview your entire presentation as you write.
15723 When you're done writing, you can then uncomment one of the two to select
15724 what you want to print.
15725 I like to uncomment
15726 \begin_inset Quotes eld
15738 \begin_inset Quotes erd
15741 , print to a file with
15742 \begin_inset Quotes eld
15750 \begin_inset Quotes erd
15753 in its name, comment it back out, then uncomment
15754 \begin_inset Quotes eld
15766 \begin_inset Quotes erd
15770 \begin_inset Quotes eld
15778 \begin_inset Quotes erd
15782 I can then send either file to a printer, loading transparencies or plain
15783 paper as appropriate.
15786 \begin_layout Standard
15787 You can also provide other arguments to the
15788 \begin_inset Quotes eld
15798 \begin_inset Quotes erd
15802 \begin_inset Quotes eld
15812 \begin_inset Quotes erd
15816 See a good LaTeX book for details.
15819 \begin_layout Subsection
15824 Class Template File
15827 \begin_layout Standard
15828 I have also provided a template file,
15829 \begin_inset Quotes eld
15837 \begin_inset Quotes erd
15845 To use it, begin your new presentation with
15850 ile\SpecialChar \menuseparator
15852 \begin_inset space ~
15856 \begin_inset space ~
15866 Your new LyX presentation file will contain an example
15887 additionally contain an example of the use of
15896 Lastly, the preamble will contain:
15899 \begin_layout LyX-Code
15900 % Uncomment to print out only slides and overlays
15903 \begin_layout LyX-Code
15907 \begin_layout LyX-Code
15913 \begin_inset Newline newline
15919 \begin_layout LyX-Code
15920 % Uncomment to print out only notes
15923 \begin_layout LyX-Code
15927 \begin_layout LyX-Code
15935 \begin_layout Standard
15936 One final thing: I created this class to support the LaTeX2e
15937 \begin_inset Quotes eld
15945 \begin_inset Quotes erd
15948 class, one of the built-in LaTeX2e classes.
15949 Neither I nor the rest of the LyX Team endorse or oppose the use of this
15950 built-in slide class.
15951 It's here if you want it or need it.
15952 There exist other LaTeX2e classes for creating presentations, such as the
15958 \begin_inset space ~
15962 \begin_inset CommandInset ref
15964 reference "sec:foiltex"
15969 \begin_inset Quotes eld
15977 \begin_inset Quotes erd
15980 package [present on some TeX distributions].
15981 The latter is not yet supported under LyX.
15985 \begin_layout Plain Layout
15986 Perhaps you can take on the task\SpecialChar \ldots{}
15992 I know nothing about these other classes.
15993 Try them out to see what sort of alternative they provide.
15996 \begin_layout Chapter
15997 LyX Features needing Extra Software
16000 \begin_layout Section
16004 \begin_layout Standard
16010 \begin_layout Subsection
16014 \begin_layout Standard
16023 \begin_layout Plain Layout
16028 is not yet available when you are using the LaTeX distribution MiKTeX.
16033 , you'll find in the
16040 \begin_inset space ~
16051 \begin_inset CommandInset href
16053 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
16060 \begin_layout Standard
16065 package is a program that was written by
16066 \begin_inset Flex CharStyle:Noun
16069 \begin_layout Plain Layout
16071 \begin_inset space ~
16079 in frustration because some constructs in LaTeX are sometimes non-intuitive,
16080 and easy to forget.
16081 The program runs over your LaTeX file, checks the integrity of the file,
16082 and flags some common errors.
16083 In other technical words, it is
16090 \begin_layout Standard
16091 Well, what is a syntax checker doing in LyX which is supposed to produce
16092 correct LaTeX anyways? The answer is simple: Just as
16096 not only checks the
16100 of C programs, but also does
16104 checks for type-errors,
16108 catches some common
16112 errors, in addition to the syntactical ones.
16117 is capable of detecting several common errors, such as
16120 \begin_layout Itemize
16121 Ellipsis detection:
16122 \begin_inset Newline newline
16125 Use \SpecialChar \ldots{}
16129 \begin_layout Itemize
16130 No space in front of/after parenthesis:
16131 \begin_inset Newline newline
16137 \begin_layout Itemize
16138 Enforcement of normal space after common abbreviations:
16139 \begin_inset Newline newline
16143 \begin_inset space \thinspace{}
16147 \begin_inset space \space{}
16150 is too wide spacing.
16153 \begin_layout Itemize
16154 Enforcement of end-of-sentence space when the last sentence ends with a
16156 \begin_inset Newline newline
16160 And this is wrong spacing.
16163 \begin_layout Itemize
16164 Space in front of labels and similar commands:
16165 \begin_inset Newline newline
16168 The label should stick right up to the text to avoid falling to a wrong
16171 \begin_inset CommandInset label
16181 \begin_layout Plain Layout
16182 This footnote is in danger of falling off to a wrong page
16187 The label is separated too much.
16190 \begin_layout Itemize
16191 Space in front of references, instead of hard spaces:
16192 \begin_inset Newline newline
16195 In you are in bad luck, the text will break right between the referenced
16196 text and reference number, and that's a pity.
16198 \begin_inset CommandInset ref
16200 reference "sec:chktex"
16207 \begin_layout Itemize
16209 \begin_inset Quotes eld
16213 \begin_inset Quotes erd
16217 \begin_inset Formula $\times$
16221 \begin_inset Newline newline
16224 2x2 looks cheap compared to
16225 \begin_inset Formula $2\times2$
16231 \begin_layout Standard
16232 and more \SpecialChar \ldots{}
16233 It is an invaluable tool when you are
16234 \begin_inset Quotes eld
16238 \begin_inset Quotes erd
16241 your document before printing, and you should run it right after the obligatory
16242 spelling check, and before you go fine tuning the typesetting.
16245 \begin_layout Subsection
16249 \begin_layout Standard
16250 If you have the program installed, usage is as simple as choosing
16252 Tools\SpecialChar \menuseparator
16254 \begin_inset space ~
16260 This will make LyX generate a LaTeX file of your document, start
16264 to check it, and then make LyX insert
16265 \begin_inset Quotes eld
16269 \begin_inset Quotes erd
16272 with the warnings from
16276 , if there were any.
16277 The warnings will be placed close to the point of the mistake, and you
16278 can quickly find them by using the
16280 Navigate\SpecialChar \menuseparator
16283 menu item, or the shortcut key
16292 Open the error boxes by clicking on them with the mouse, or use the shortcut
16301 bindings, or the corresponding
16310 Read the warning and correct the mistake, if it is a mistake.
16311 If you have trouble understanding what the warning is about, you can safely
16313 Remember that there is a hidden layer between the document on screen and
16314 the technical details in invoking
16318 , and this gap can make some warnings seem arcane or just right down plain
16322 \begin_layout Standard
16323 This document is an excellent testing bed for the feature, and it should
16324 provide quite a few warnings for you to fiddle with.
16325 Since computers are only so smart, expect most of the warnings to be false
16329 \begin_layout Subsection
16330 How to fine tune it
16333 \begin_layout Standard
16334 Sometimes, you'll find that
16338 makes more noise than suits your mood.
16339 Then you can choose not to use it, wait until your mood changes, or try
16344 to get better along with you.
16345 Another choice in the most desperate situations is to use
16347 View\SpecialChar \menuseparator
16349 \begin_inset space ~
16353 \begin_inset space ~
16357 \begin_inset space ~
16362 , which will get rid of all warnings instantly.
16365 \begin_layout Standard
16374 very configurable and extensible, you shouldn't expect to solve all problems
16380 Since LyX has to generate a somewhat special LaTeX file to be able to match
16381 the line numbers from the
16389 \begin_layout Plain Layout
16390 You can inspect the specific output from
16396 Edit\SpecialChar \menuseparator
16398 \begin_inset space ~
16402 \begin_inset space ~
16416 to the internal document structure, some of the warnings will not seen
16417 to appear correctly.
16418 There are two things you can do about this:
16421 \begin_layout Itemize
16426 invocation command line in
16442 installation configuration file (usually with the file
16447 See below to learn what warnings can be enabled and disabled on the command
16452 \begin_layout Itemize
16453 Export your document as a raw LaTeX file using
16455 File\SpecialChar \menuseparator
16456 Export\SpecialChar \menuseparator
16464 Invoked in this way, it can be a hassle to find the corresponding place
16465 in the document inside LyX, but with a little patience, you should be able
16469 \begin_layout Standard
16470 Here follows the warning messages that can be enabled and disabled in
16479 to disable a warning, and
16483 to enable a warning.
16484 The emphasized entries are disabled by default, because the default is
16487 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
16492 \begin_layout Standard
16493 Notice that you should only use the options that enable and disable warnings,
16494 because LyX relies on some of the other command line parameters to be set
16495 in a specific way to have a chance to communicate with
16502 \begin_layout Enumerate
16506 Command terminated with space.
16509 \begin_layout Enumerate
16512 Non-breaking space (
16513 \begin_inset Quotes eld
16521 \begin_inset Quotes erd
16524 ) should have been used.
16527 \begin_layout Enumerate
16531 You should enclose the previous parenthesis with
16532 \begin_inset Quotes eld
16540 \begin_inset Quotes erd
16546 \begin_layout Enumerate
16549 Italic correction (
16550 \begin_inset Quotes eld
16560 \begin_inset Quotes erd
16563 ) found in non-italic buffer.
16566 \begin_layout Enumerate
16569 Italic correction (
16570 \begin_inset Quotes eld
16580 \begin_inset Quotes erd
16583 ) found more than once.
16586 \begin_layout Enumerate
16590 No italic correction (
16591 \begin_inset Quotes eld
16601 \begin_inset Quotes erd
16607 \begin_layout Enumerate
16611 \begin_inset Quotes eld
16619 \begin_inset Quotes erd
16623 \begin_inset Quotes eld
16631 \begin_inset Quotes erd
16637 \begin_layout Enumerate
16640 Wrong length of dash may have been used.
16643 \begin_layout Enumerate
16647 \begin_inset Quotes eld
16655 \begin_inset Quotes erd
16659 \begin_inset Quotes eld
16667 \begin_inset Quotes erd
16673 \begin_layout Enumerate
16677 \begin_inset Quotes eld
16685 \begin_inset Quotes erd
16691 \begin_layout Enumerate
16695 \begin_inset Quotes eld
16703 \begin_inset Quotes erd
16706 to achieve an ellipsis.
16709 \begin_layout Enumerate
16712 Inter-word spacing (
16713 \begin_inset Quotes eld
16723 \begin_inset Quotes eld
16726 ) should perhaps be used.
16729 \begin_layout Enumerate
16732 Inter-sentence spacing (
16733 \begin_inset Quotes eld
16743 \begin_inset Quotes erd
16746 ) should perhaps be used.
16749 \begin_layout Enumerate
16752 Could not find argument for command.
16755 \begin_layout Enumerate
16759 \begin_inset Quotes eld
16767 \begin_inset Quotes erd
16773 \begin_layout Enumerate
16776 Math mode still on at end of LaTeX file.
16779 \begin_layout Enumerate
16783 \begin_inset Quotes eld
16791 \begin_inset Quotes erd
16794 doesn't match the number of
16795 \begin_inset Quotes eld
16803 \begin_inset Quotes erd
16809 \begin_layout Enumerate
16812 You should use either
16815 \begin_inset Quotes eld
16823 \begin_inset Quotes erd
16828 as an alternative to
16829 \begin_inset Quotes eld
16837 \begin_inset Quotes erd
16843 \begin_layout Enumerate
16850 " (ASCII 39) instead of "
16857 \begin_layout Enumerate
16860 User-specified pattern found.
16863 \begin_layout Enumerate
16866 This command might not be intended.
16869 \begin_layout Enumerate
16876 \begin_layout Enumerate
16894 \begin_layout Enumerate
16897 Delete this space to maintain correct page references.
16900 \begin_layout Enumerate
16904 You might wish to put this between a pair of
16905 \begin_inset Quotes eld
16913 \begin_inset Quotes erd
16919 \begin_layout Enumerate
16922 You ought to remove spaces in front of punctuation.
16925 \begin_layout Enumerate
16928 Could not execute LaTeX command.
16931 \begin_layout Enumerate
16940 in front of small punctuation.
16943 \begin_layout Enumerate
16951 may look prettier here.
16954 \begin_layout Enumerate
16958 Multiple spaces detected in output.
16961 \begin_layout Enumerate
16964 This text may be ignored.
16967 \begin_layout Enumerate
16973 \begin_inset Quotes eld
16978 to begin quotation, not
16985 \begin_layout Enumerate
16992 to end quotation, not
16995 \begin_inset Quotes eld
17003 \begin_layout Enumerate
17009 \begin_layout Enumerate
17012 You should perhaps use
17013 \begin_inset Quotes eld
17021 \begin_inset Quotes erd
17027 \begin_layout Enumerate
17030 You should put a space in front of/after parenthesis.
17033 \begin_layout Enumerate
17036 You should avoid spaces in front of/after parenthesis.
17039 \begin_layout Enumerate
17043 You should not use punctuation in front of/after quotes.
17046 \begin_layout Enumerate
17049 Double space found.
17052 \begin_layout Enumerate
17055 You should put punctuation outside inner/inside display math mode.
17058 \begin_layout Enumerate
17061 You ought to not use primitive TeX in LaTeX code.
17064 \begin_layout Enumerate
17067 You should remove spaces in front of
17068 \begin_inset Quotes eld
17076 \begin_inset Quotes erd
17082 \begin_layout Enumerate
17085 \begin_inset Quotes eld
17093 \begin_inset Quotes erd
17096 is normally not followed by
17097 \begin_inset Quotes eld
17105 \begin_inset Quotes erd
17111 \begin_layout Standard
17112 In later versions of LyX, we hope to provide a more complete interface to
17113 this tool (and it's smaller cousin
17117 ) to exploit the full power of it.
17118 But it's not exactly useless as it is now: go try it on one of your existing
17119 documents of a certain length and be surprised.
17122 \begin_layout Section
17123 Version Control in LyX
17126 \begin_layout Standard
17129 Lars Gullik Bjønnes,
17136 \begin_layout Subsection
17140 \begin_layout Standard
17141 A friend of mine wanted to try LyX for a group project.
17142 When he didn't find support for version control or file locking, he dropped
17144 This angered me a bit, so I thought that I should at least make support
17145 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
17146 This has now been done.
17147 LyX now supports some of the most basic RCS commands.
17148 If you need to something a bit more sophisticated you will have to do that
17149 manually in an xterm.
17152 \begin_layout Standard
17153 Before you begin to use the version control features in LyX, you should
17155 \begin_inset Quotes eld
17159 \begin_inset Quotes erd
17162 (a man file, read it with
17167 This file describes all the basic features of RCS.
17168 You should especially notice the comment about a RCS directory, and the
17169 notion of a master RCS file (the file ending in
17176 \begin_layout Standard
17177 Later basic CVS/SVN support was added.
17178 You should be familiar with CVS/SVN usage before start using it under LyX.
17179 Most of the log messages are not currently displayed after operations -
17180 you can check them in terminal window if unsure.
17183 \begin_layout Standard
17184 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
17185 package—no guarantees are made for older versions.
17188 \begin_layout Standard
17189 For introducing your own external commands consult vc-command in the manual
17193 \begin_layout Subsection
17194 RCS commands in LyX
17197 \begin_layout Standard
17198 The following sections describe the RCS commands supported by LyX.
17199 You can find them in the
17201 File\SpecialChar \menuseparator
17203 \begin_inset space ~
17209 LyX was tested against RCS 5.7.
17212 \begin_layout Subsubsection
17218 \begin_layout Standard
17219 If your document is not under revision control, this is the only item shown
17221 And if it is under revision control, the
17225 item is not visible.
17229 \begin_layout Standard
17230 This command registers your document with RCS (unless you are under the
17231 directory managed by CVS)\SpecialChar \@.
17232 You are asked interactively to supply an initial
17233 description of the document.
17234 The document is now set in Read-Only mode and you have to
17237 \begin_inset space ~
17241 \begin_inset space ~
17245 \begin_inset space ~
17250 , before making any changes to it.
17251 A document under revision control has a
17252 \begin_inset Quotes eld
17255 [RCS:<version> <locker>]
17256 \begin_inset Quotes erd
17259 item tagged to the filename in the minibuffer.
17262 \begin_layout Standard
17263 RCS command that is run:
17265 ci -q -u -i -t-"<initial description>" <file-name>
17268 \begin_layout Standard
17273 to understand the switches.
17277 \begin_layout Subsubsection
17283 \begin_layout Standard
17284 When you are finished editing a file, you check in your changes.
17285 When you do this, you are asked for a description of the changes.
17286 This is stored in the history log.
17287 The version number is bumped, your changes are applied to the master RCS
17288 file, the document is unlocked and set to Read-Only mode.
17292 \begin_layout Standard
17295 ci -q -u -m"<description>" <file-name>
17298 \begin_layout Subsubsection
17304 \begin_layout Standard
17305 By doing this you lock the document so that only you can edit it.
17306 This will also make the document Read-Write only for you.
17307 You will usually continue editing for a while and when you are finished
17308 you check in your changes.
17309 The status line is changed to reflect that you have locked the file.
17313 \begin_layout Standard
17316 co -q -l <file-name>
17319 \begin_layout Subsubsection
17322 Revert To Repository Version
17325 \begin_layout Standard
17326 This will discard all changes made to the document since the last check
17328 You get a warning before changes are discarded.
17331 \begin_layout Standard
17334 co -f -u<version> <file-name>
17337 \begin_layout Subsubsection
17343 \begin_layout Standard
17344 This makes as if the last check in never happened.
17345 No changes are made to the document loaded into LyX, but the last version
17346 is removed from the master RCS file.
17350 \begin_layout Standard
17353 rcs -o<version> <file-name>
17356 \begin_layout Subsubsection
17362 \begin_layout Standard
17363 This show the complete history of the RCS document.
17368 is shown in a browser.
17376 \begin_layout Subsection
17377 CVS commands in LyX
17380 \begin_layout Standard
17381 CVS is now partially supported by LyX.
17382 You can find the commands in the
17384 File\SpecialChar \menuseparator
17386 \begin_inset space ~
17394 \begin_layout Subsubsection
17400 \begin_layout Standard
17401 If your document is not under revision control, this is the only item shown
17403 And if it is under revision control, the
17410 item is not visible.
17414 \begin_layout Standard
17415 This command registers in CVS your document ONLY in case you have already
17416 the documents directory under CVS control (in particular
17421 This means you have to checkout the archive by yourself.
17425 \begin_layout Standard
17426 Then you are asked interactively to supply an initial description of the
17428 Don't forget that registered file is not yet commited.
17431 \begin_layout Standard
17432 CVS command that is run:
17435 \begin_inset Quotes erd
17439 \begin_inset Quotes eld
17443 \begin_inset Quotes erd
17449 \begin_layout Standard
17454 to understand the switches.
17458 \begin_layout Subsubsection
17464 \begin_layout Standard
17465 When you are finished editing a file, you commit your changes.
17466 When you do this, you are asked for a description of the changes.
17467 After that changes are commited.
17470 \begin_layout Standard
17473 cvs -q commit -m"<description>" "<file-name>"
17476 \begin_layout Subsubsection
17479 Revert To Repository Version
17482 \begin_layout Standard
17483 This will discard all changes made to the document since the last check
17485 You get a warning before changes are discarded.
17486 Firstly the file is deleted, secondly CVS update command is run.
17489 \begin_layout Standard
17493 \begin_inset Quotes eld
17497 \begin_inset Quotes erd
17503 \begin_layout Subsubsection
17509 \begin_layout Standard
17510 This show the complete history of the CVS document.
17514 \begin_inset Quotes eld
17518 \begin_inset Quotes erd
17523 is shown in a browser.
17526 \begin_layout Subsection
17527 SVN commands in LyX
17530 \begin_layout Standard
17531 SVN is now partially supported by LyX.
17532 You can find the commands in the
17534 File\SpecialChar \menuseparator
17536 \begin_inset space ~
17542 Please note that if you use password protected access to repository via
17543 ssh, you will be asked in terminal window.
17544 LyX was tested against SVN 1.4 and 1.5.
17547 \begin_layout Subsubsection
17553 \begin_layout Standard
17554 If your document is not under revision control, this is the only item shown
17556 And if it is under revision control, the
17563 item is not visible.
17567 \begin_layout Standard
17568 This command registers in SVN your document ONLY in case you have already
17569 the documents directory under SVN control (in particular
17574 This means you have to checkout the archive by yourself.
17578 \begin_layout Standard
17579 Then you are asked interactively to supply an initial description of the
17581 Don't forget that registered file is not yet commited.
17584 \begin_layout Standard
17585 SVN command that is run:
17588 \begin_inset Quotes eld
17592 \begin_inset Quotes erd
17598 \begin_layout Standard
17603 to understand the switches.
17607 \begin_layout Subsubsection
17613 \begin_layout Standard
17614 When you are finished editing a file, you commit your changes.
17615 When you do this, you are asked for a description of the changes.
17616 After that changes are commited.
17619 \begin_layout Standard
17624 \begin_layout Plain Layout
17625 In case locking is not enabled.
17627 \begin_inset CommandInset ref
17629 reference "subsec:SVN-File-Locking"
17640 svn commit -q -m"<description>" <file-name>
17643 \begin_layout Subsubsection
17649 \begin_layout Standard
17650 Updates the changes of this file from the repository.
17651 Be sure you understand SVN merging and conflicts resolving before using
17652 this function, because all conflicts has to be done manually by you!
17655 \begin_layout Standard
17660 \begin_layout Plain Layout
17669 \begin_inset Quotes eld
17673 \begin_inset Quotes erd
17679 \begin_layout Subsubsection
17682 Revert To Repository Version
17685 \begin_layout Standard
17686 This will discard all changes made to the document since the last check
17688 You get a warning before changes are discarded.
17692 \begin_layout Standard
17696 \begin_inset Quotes eld
17700 \begin_inset Quotes erd
17706 \begin_layout Subsubsection
17712 \begin_layout Standard
17713 This show the complete history of the SVN document.
17717 \begin_inset Quotes eld
17721 \begin_inset Quotes erd
17726 is shown in a browser.
17729 \begin_layout Subsubsection
17731 \begin_inset CommandInset label
17733 name "subsec:SVN-File-Locking"
17740 \begin_layout Standard
17741 The file exchange through various revision control systems brings the problem
17742 of merge conflicts in case two different users try to edit the same (parts
17744 When such conflict happens it needs manual resolving and one reasonable
17745 alternative is to provide some kind of locking mechanism, which guarantees
17746 that only one user is allowed to edit file at the given time.
17749 \begin_layout Standard
17750 SVN has two mechanisms to provide such kind of mutual exclusivity for file
17751 access - locks and automatical setting of write permissions based on
17752 \begin_inset Flex CharStyle:Code
17755 \begin_layout Plain Layout
17765 \begin_layout Plain Layout
17766 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
17772 In a case this property is detected for a given document LyX starts to
17773 use SVN locks for document editing automatically and the whole check-in/out
17774 mechanism switches to the same regimen as for RCS.
17775 This in particular means there are two different modes how file is used
17779 \begin_layout Itemize
17781 The loaded file is in the read-only mode.
17782 For editation on needs to check-out.
17787 consists of update from repository and gaining write lock.
17788 If the lock is not possible to obtain, we remain in unlocked state.
17791 \begin_layout Itemize
17793 The loaded file is in the 'normal' edit mode.
17794 No other user is allowed to edit the file.
17799 consists of commiting changes and releasing write-lock.
17800 If no changes have been made to the document, no commit will be produced
17804 \begin_layout Plain Layout
17805 Don't be puzzled by the fact that you will be asked for commit message anyway.
17810 and only the write-lock will be released.
17813 \begin_layout Standard
17817 \begin_layout Labeling
17818 \labelwidthstring 00.00.0000
17821 svn commit -q -m"<description>" "<file-name>"
17822 \begin_inset Newline newline
17825 svn unlock "<file-name>"
17828 \begin_layout Labeling
17829 \labelwidthstring 00.00.0000
17832 svn update "<file-name>"
17833 \begin_inset Newline newline
17836 svn lock "<file-name>"
17839 \begin_layout Subsection
17840 SVN and Windows Environment
17843 \begin_layout Quote
17844 My inclination is to say that if the user cannot figure out the command
17845 line operations on their own fairly quickly, they would be well advised
17846 to use TortoiseSVN.
17852 \begin_layout Subsubsection
17856 \begin_layout Standard
17857 In addition to installing LyX, and having access to a Subversion repository,
17858 the user will need to install the Subversion client program.
17859 A Windows installer for the client program is available from
17860 \begin_inset CommandInset href
17863 target "http://www.collab.net/nonav/downloads/subversion/"
17868 The user may also want to install
17869 \begin_inset CommandInset href
17872 target "http://tortoisesvn.tigris.org/"
17876 , which integrates Subversion operations into the context (rightclick) menu
17877 of Windows Explorer.
17878 Operations done outside LyX will typically be more convenient using the
17879 Explorer context menu.
17880 Note that TortoiseSVN is not a replacement for the client program, which
17881 is what LyX itself will use.
17884 \begin_layout Subsubsection
17885 Bringing a document under Subversion control
17888 \begin_layout Standard
17889 Before a LyX document can be brought under version control in Subversion,
17890 its parent directory needs to be under version control.
17891 If the document is being added to a project already in the repository,
17892 this is accomplished by checking the project out to the directory where
17893 the new document will be placed.
17894 If the project itself is not yet under version control (for instance, if
17895 this document starts a new project), the directory must be imported into
17897 This is done outside LyX.
17898 Both import and checkout are easily accomplished from the Explorer context
17899 menu using TortoiseSVN, or alternatively can be done using the command
17900 line client at a DOS prompt.
17901 The procedure for importing the project using TortoiseSVN is described
17902 below, assuming an existing repository and a new project being started
17910 For information on using the Subversion client program, run
17917 \begin_layout Enumerate
17924 in Windows Explorer, right click it, and select
17926 TortoiseSVN > Repo-browser
17929 If necessary, adjust the URL for the repository, then click OK.
17932 \begin_layout Enumerate
17933 Right click the level of the repository under which you want to place the
17934 new project folder (typically the top level) and click
17936 Create folder\SpecialChar \ldots{}
17939 Supply a name for the project folder and click OK.
17940 Add a message for the log file if desired, then click OK again.
17941 The new project folder should appear in the repository.
17942 Finally, click OK again to exit the repository browser.
17945 \begin_layout Enumerate
17946 Once again right click
17952 , this time selecting SVN Checkout\SpecialChar \ldots{}
17953 Select the URL of the project folder
17954 you just created in the repository, and set the checkout directory to
17962 You will be warned about a non-empty folder; click OK to proceed.
17963 You should now have a
17974 \begin_layout Enumerate
17975 Create or open your document in LyX and click
17980 ile\SpecialChar \menuseparator
17986 \begin_inset space ~
17989 Control\SpecialChar \menuseparator
17997 Add a log message and click OK to commit the document to version control.
18000 \begin_layout Standard
18001 From this point onward, you should have full functionality in the
18006 ile\SpecialChar \menuseparator
18012 \begin_inset space ~
18018 You also have the option of checking the document in and out, viewing its
18020 using the TortoiseSVN context menu in Windows Explorer or the Subversion
18021 client program from a command prompt.
18024 \begin_layout Subsection
18028 \begin_layout Standard
18029 With the recent addition of the vc-command function LyX power users are
18030 allowed to create their own commands for revision control.
18033 \begin_layout Standard
18034 As an example you can see how two TortoiseSVN commands could be integrated
18038 \begin_layout Description
18040 \begin_inset Flex CharStyle:Code
18043 \begin_layout Plain Layout
18044 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
18052 \begin_layout Description
18054 \begin_inset Flex CharStyle:Code
18057 \begin_layout Plain Layout
18058 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
18066 \begin_layout Section
18067 Literate Programming
18070 \begin_layout Standard
18075 (kayvan@sylvan.com)
18079 original documentation written by
18081 Edmar Wienskoski Jr.
18084 (edmar-w-jr@technologist.com)
18087 \begin_layout Subsection
18091 \begin_layout Standard
18092 The main purpose of this documentation is to show you how to use LyX for
18093 literate programming.
18094 Where it is assumed that you are familiar with this programming technique,
18096 \begin_inset Quotes eld
18100 \begin_inset Quotes erd
18104 \begin_inset Quotes eld
18108 \begin_inset Quotes erd
18112 If that is not the case, please follow the web links provided in the following
18114 There is a lot of good documentation out there covering old development
18115 history to the latest tools tips.
18118 \begin_layout Standard
18119 It is also assumed that you are familiar with LyX itself to a point that
18120 you are comfortable changing your LyX preferences, and X resources file.
18121 If that is not the case please refer to other LyX documentation to cover
18122 your specific needs.
18125 \begin_layout Subsection
18126 Literate Programming
18129 \begin_layout Standard
18130 From the Literate Programming FAQ:
18133 \begin_layout Quotation
18134 Literate programming is the combination of documentation and source together
18135 in a fashion suited for reading by human beings.
18136 In fact, literate programs should be enjoyable reading, even inviting!
18137 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
18138 and documentation in a single file.
18139 Literate programming tools then parse the file to produce either readable
18140 documentation or compilable source.
18141 The WEB style of literate programming was created by D.
18142 \begin_inset space \thinspace{}
18146 Knuth during the development of his TeX typesetting software.
18150 \begin_layout Standard
18151 Another excerpt says:
18154 \begin_layout Quotation
18157 How is literate programming different from verbose commenting?
18160 \begin_layout Quotation
18161 There are three distinguishing characteristics.
18162 In order of importance, they are:
18166 \begin_layout Itemize
18167 flexible order of elaboration
18170 \begin_layout Itemize
18171 automatic support for browsing
18174 \begin_layout Itemize
18175 typeset documentation, especially diagrams and mathematics
18179 \begin_layout Standard
18180 Now that I sparked your curiosity, take a look in the references.
18183 \begin_layout Subsubsection
18187 \begin_layout Standard
18188 The complete Literate Programming FAQ can be found at:
18191 \begin_layout Quote
18192 Literate Programming FAQ
18193 \begin_inset Flex URL
18196 \begin_layout Plain Layout
18198 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
18206 \begin_layout Standard
18207 The FAQ lists 23 (twenty three!) different literate programming tools.
18208 Where some are specialized or
18209 \begin_inset Quotes eld
18213 \begin_inset Quotes erd
18216 for particular programming languages, while other have general scope.
18221 for my own use for several reasons:
18224 \begin_layout Itemize
18225 It can generate the documentation either in LaTeX or HTML.
18228 \begin_layout Itemize
18229 It has a open architecture, i.
18230 \begin_inset space \thinspace{}
18234 \begin_inset space \space{}
18237 it is easy to plug in new filters and to perform special processing that
18242 \begin_layout Itemize
18243 There is a good selection of filters available already (the HTML is one
18247 \begin_layout Itemize
18251 \begin_layout Standard
18252 The Noweb web page can be found at:
18255 \begin_layout Quote
18257 \begin_inset Flex URL
18260 \begin_layout Plain Layout
18262 http://www.cs.virginia.edu/~nr/noweb/
18270 \begin_layout Standard
18271 Starting from there you can reach many other interesting links and even
18272 some literate program examples.
18275 \begin_layout Subsection
18276 LyX and Literate Programming
18279 \begin_layout Standard
18280 The LyX support for Literate Programming is provided by using the generic
18281 LyX converters mechanism.
18282 This support is provided in a
18283 \begin_inset Quotes eld
18287 \begin_inset Quotes erd
18291 \begin_inset space \thinspace{}
18295 \begin_inset space \space{}
18298 you will be able to use this new LyX feature with some other literate programmin
18299 g tool of your choice by just changing your LyX preferences.
18302 \begin_layout Subsubsection
18303 Generating documents and code (weaving and tangling)
18306 \begin_layout Paragraph
18307 Selecting the document class
18310 \begin_layout Standard
18311 If you have installed Noweb and LyX successfully, whenever you open a new
18312 document or try to change the document class of an existing one, you will
18313 find that there are three new document classes available:
18316 \begin_layout Itemize
18320 \begin_layout Itemize
18324 \begin_layout Itemize
18328 \begin_layout Standard
18329 You must select one of them to create your literate documents from.
18333 \begin_layout Standard
18334 Note that literate documents are not limited to these three classes.
18335 New classes can be generated from other styles like letter or in combination
18336 with other class variations like Article (AMS).
18337 If you have special needs that cannot be covered by one of the existing
18338 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
18339 will arrange to insert a new entry, or teach you how to do it.
18343 \begin_layout Plain Layout
18344 It is very simple, it involves the creation of a file with four lines, and
18345 re-running of the auto configuration.
18350 Moreover, if you use a literate tool other than Noweb you may need to create
18351 a new set of document classes for it.
18354 \begin_layout Paragraph
18358 \begin_layout Standard
18359 LyX enables you to write code with a layout named
18367 \begin_layout Plain Layout
18368 The equivalent Noweb term is
18369 \begin_inset Quotes eld
18373 \begin_inset Quotes erd
18377 For historical reasons, I got used to the term
18378 \begin_inset Quotes eld
18382 \begin_inset Quotes erd
18385 introduced by other literate tool named Nuweb, which I used for many years
18386 before rendering myself to Noweb.
18391 Noweb delimits scraps like this:
18394 \begin_layout LyX-Code
18398 \begin_layout LyX-Code
18402 \begin_layout LyX-Code
18406 \begin_layout LyX-Code
18410 \begin_layout LyX-Code
18414 \begin_layout Standard
18415 The problem is that whatever is written in between the << and the
18419 must be taken literally, i.
18420 \begin_inset space \thinspace{}
18424 \begin_inset space \space{}
18427 LyX should be prevented from making any special interpretation of what has
18429 This is handled by a special layout named Scrap, that works like a normal
18430 paragraph but has a free spacing capability.
18433 \begin_layout Standard
18434 The down side of the Scrap paragraph layout is that consecutive paragraphs
18435 of code will be spaced with one empty line in the source code and also
18436 in the printed documentation.
18437 The work around is to enter each line of code within a single Scrap, with
18438 a newline (ctrl-return).
18439 The example above will look like this:
18443 \begin_layout Plain Layout
18444 If you have a printed version of this document you will not see any difference
18445 between the previous example and this one.
18453 \begin_layout LyX-Code
18455 \begin_inset Newline newline
18459 \begin_inset Newline newline
18463 \begin_inset Newline newline
18467 \begin_inset Newline newline
18473 \begin_layout Standard
18474 This layout works fine.
18475 The only real inconvenience is that you have to type ctrl-return instead
18480 \begin_layout Plain Layout
18481 It is in my list of
18482 \begin_inset Quotes eld
18486 \begin_inset Quotes erd
18497 \begin_layout Standard
18498 As a special note, you can also use the
18499 \begin_inset Quotes eld
18503 \begin_inset Quotes erd
18506 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
18510 \begin_layout LyX-Code
18512 \begin_inset Newline newline
18515 def some_function(args):
18516 \begin_inset Newline newline
18519 "This is the doc string for this function."
18520 \begin_inset Newline newline
18523 print "My args: ", args
18526 \begin_layout LyX-Code
18527 @ %def some_function
18530 \begin_layout Standard
18531 For an example of this usage and the resulting cross-reference output, look
18532 at the Literate python program in
18534 LIBDIR/examples/listerrors.lyx
18536 which should make this all clear.
18539 \begin_layout Paragraph
18540 Generating the documentation
18543 \begin_layout Standard
18544 At this point you already have a new document file with a proper document
18545 class, and with some code and text on it.
18546 How do I print it? The answer is simple, you select
18548 View\SpecialChar \menuseparator
18552 Just like you would do for a plain document.
18553 No special procedure is required.
18556 \begin_layout Standard
18557 To help orientate you, I will now explain what happens inside LyX:
18560 \begin_layout Enumerate
18563 Update\SpecialChar \menuseparator
18566 menu option is chosen, a LaTeX file is generated.
18571 \begin_layout Standard
18572 If the document is of any literate class the generated file will be named
18573 with an extension name defined by the
18574 \begin_inset Quotes eld
18578 \begin_inset Quotes erd
18581 format (defined in the Preferences panel), otherwise the file will have
18590 \begin_layout Enumerate
18591 Note that the only difference so far is in the name of the file, no special
18592 processing is required by LyX.
18593 Given that you formatted the code using the Scrap layout that, by itself,
18594 takes care of the business.
18597 \begin_layout Enumerate
18598 If the document is of any literate class LyX will then use the internal
18599 LyX to Noweb converter, followed by the Noweb to LaTeX converter
18603 \begin_layout Plain Layout
18604 The converters are defined in the
18606 Tools\SpecialChar \menuseparator
18610 \begin_inset Quotes eld
18614 \begin_inset Quotes erd
18626 manual for general information about converters.
18631 to generate the LaTeX file.
18635 \begin_layout Standard
18636 Otherwise it will just skip this step.
18640 \begin_layout Enumerate
18641 Finally, LaTeX is invoked and the regular post processing continues as in
18645 \begin_layout Standard
18646 Independence from a particular
18647 \begin_inset Quotes eld
18651 \begin_inset Quotes erd
18654 is easily achieved by changing the commands that are run by the various
18658 \begin_layout Paragraph
18659 Generating the code
18662 \begin_layout Standard
18663 When the build menu option is chosen or the corresponding button in the
18664 toolbar is pressed, a LaTeX file is generated just like step 1 above.
18665 Next, LyX invokes the
18670 This converter needs to be defined by the user and is not installed by
18671 default, though the Program format is.
18672 This converter (like any other converter) will have two parts:
18675 \begin_layout Enumerate
18676 The converter program itself.
18677 This program performs the conversion from the one format to the other (in
18678 this case, from the Noweb format to the Program pseudo-format).
18681 \begin_layout Enumerate
18682 The error log parser.
18683 This is a program whose sole purpose is to rewrite error messages in a
18684 format that LyX understands.
18685 This makes it possible for LyX to place error boxes in the right places
18686 in the file buffer.
18689 \begin_layout Standard
18690 The first part, the
18691 \begin_inset Quotes eld
18695 \begin_inset Quotes erd
18698 setting, should be set to
18699 \begin_inset Quotes eld
18707 \begin_inset Quotes erd
18711 This basically means that LyX will call
18712 \begin_inset Quotes eld
18716 \begin_inset Quotes erd
18719 (a program or script) with the name of the Noweb file (normally a file
18720 in the LyX temp directory).
18724 \begin_layout Standard
18725 This is an implementation of
18726 \begin_inset Quotes eld
18730 \begin_inset Quotes erd
18733 that you can place in a directory on your path:
18736 \begin_layout LyX-Code
18740 \begin_layout LyX-Code
18744 \begin_layout LyX-Code
18745 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
18748 \begin_layout Standard
18749 The next part of the converter setting is the
18750 \begin_inset Quotes eld
18754 \begin_inset Quotes erd
18757 which is to be set to
18758 \begin_inset Quotes eld
18763 parselog=listerrors
18766 \begin_inset Quotes erd
18770 This will run any errors that are generated by the
18771 \begin_inset Quotes eld
18775 \begin_inset Quotes erd
18778 process through the
18779 \begin_inset Quotes eld
18783 \begin_inset Quotes erd
18789 \begin_layout Standard
18790 The converter code looks in
18798 then on the path for the
18799 \begin_inset Quotes eld
18803 \begin_inset Quotes erd
18809 \begin_layout Standard
18810 The build will normally take place in LyX's temporary directory, so the
18811 files produced by the conversion will be in that directory.
18812 LyX will copy out what it regards as the `main' file, but the
18816 conversion may produce several files, and so most of these would then be
18817 deleted when LyX was closed.
18818 The present solution is to use a `copier',
18822 \begin_layout Plain Layout
18831 manual for information on these.
18840 script in its default mode, so that the entire contents of the temporary
18841 directory is copied.
18842 More will get copied than is needed, to be sure, but nothing will be lost.
18843 If, however, you know what extensions the generated files will have, this
18844 can be improved by using the
18853 This option takes a comma-separated list of extensions to copy.
18854 So, for example, if the conversion will generate only files with the extensions
18863 , then the correct definition would be:
18866 \begin_layout LyX-Code
18867 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
18870 \begin_layout Standard
18871 The result will be that only files with these two extensions will be copied
18875 \begin_layout Paragraph
18876 Build instructions in the document
18879 \begin_layout Standard
18880 The last piece of the integration between LyX and noweb is the
18881 \begin_inset Quotes eld
18885 \begin_inset Quotes erd
18889 Generally, the instructions for building your program should be embedded
18890 in a scrap of its own.
18892 \begin_inset Quotes eld
18896 \begin_inset Quotes erd
18899 above uses the notangle command to look for this scrap (called
18900 \begin_inset Quotes eld
18904 \begin_inset Quotes erd
18907 ) and runs its contents through
18908 \begin_inset Quotes eld
18912 \begin_inset Quotes erd
18918 \begin_layout Standard
18919 Typically, such a scrap would look something like this:
18922 \begin_layout LyX-Code
18924 \begin_inset Newline newline
18928 \begin_inset Newline newline
18932 \begin_inset Newline newline
18935 if [ -z "${NOWEB_SOURCE}" ]
18936 \begin_inset Newline newline
18940 \begin_inset Newline newline
18943 NOWEB_SOURCE=myfile.nw
18944 \begin_inset Newline newline
18948 \begin_inset Newline newline
18952 code to extract files ...]
18953 \begin_inset Newline newline
18957 code to compile files ...]
18958 \begin_inset Newline newline
18964 \begin_layout Standard
18967 LIBDIR/examples/listerrors.lyx
18971 LIBDIR/examples/Literate.lyx
18973 which implement two versions of the
18974 \begin_inset Quotes eld
18978 \begin_inset Quotes erd
18981 program for some illustrations of how all of these pieces go together or
18984 LIBDIR/examples/noweb2lyx.lyx.
18987 Interestingly, these three files show off the language-indepence of the
18988 LyX literate programming support since they are written in Python, C and
18992 \begin_layout Subsubsection
18996 \begin_layout Standard
18997 All the Literate Programming support is configured by the
18999 Tools\SpecialChar \menuseparator
19003 \begin_inset Quotes eld
19007 \begin_inset Quotes erd
19011 The important parts are:
19014 \begin_layout Description
19016 \begin_inset space ~
19020 \begin_inset Quotes eld
19024 \begin_inset Quotes erd
19028 \begin_inset space ~
19031 format Set up via the Formats tab, this is where the Noweb-specific pieces
19041 , the file extension is set to
19046 This tells LyX to create a file with a
19050 extension in the first step of the conversion process.
19053 \begin_layout Description
19055 \begin_inset space ~
19063 \begin_inset space ~
19066 format This is an empty format whose sole purpose is to be the endpoint
19067 of a conversion (which then allows us to set up a converter for it).
19070 \begin_layout Description
19079 This converter performs the
19080 \begin_inset Quotes eld
19084 \begin_inset Quotes erd
19087 of the literate document.
19088 For Noweb, it is set to
19089 \begin_inset Quotes eld
19094 noweave -delay -index $$i > $$o
19097 \begin_inset Quotes erd
19103 \begin_layout Description
19113 \begin_inset Quotes eld
19117 \begin_inset Quotes erd
19121 As stated above, the Converter is set to
19122 \begin_inset Quotes eld
19130 \begin_inset Quotes erd
19133 , with Flags set to
19134 \begin_inset Quotes eld
19139 originaldir,parselog=listerrors
19142 \begin_inset Quotes erd
19148 \begin_layout Subsubsection
19152 \begin_layout Standard
19153 There is also a new function implemented in the LyX server, the
19154 \begin_inset Quotes eld
19157 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
19161 \begin_layout Standard
19162 When debugging code with ddd/gdb, it is possible to invoke a text editor
19163 at the current execution position with a single key stroke.
19164 The default ddd configuration for that is shift-ctrl-V.
19165 It happens that you can define the editor command line invocation in ddd
19168 Edit\SpecialChar \menuseparator
19169 Preferences\SpecialChar \menuseparator
19172 dialog and changing the "Edit Sources" entry.
19175 \begin_layout Standard
19176 I take advantage of the new created LyX server function and this ddd feature,
19178 \begin_inset Quotes eld
19182 \begin_inset Quotes erd
19188 \begin_layout LyX-Code
19189 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
19192 \begin_layout Standard
19193 With this, whenever you are using ddd and find a point in the program that
19194 you want to edit, you just press shift-ctrl-V (in the ddd window), and
19195 ddd you forward this information to LyX through the LyX server and then
19196 the LyX window will show the same file with the cursor at the same position
19197 ddd was pointing to.
19198 No more guessing or long scrolling to locate a point in the program back
19202 \begin_layout Standard
19203 Note however that you must enable the LyX server to get this feature working
19204 (it is disabled by default).
19205 You can enable it in
19217 ) by entering in the
19222 \begin_inset Quotes eld
19227 /home/<your-home-directory>/.lyx/lyxpipe
19230 \begin_inset Quotes erd
19236 \begin_layout Standard
19237 Read the LyX server documentation in the
19239 Customization Manual
19241 for further information.
19244 \begin_layout Subsubsection
19248 \begin_layout Standard
19249 There are six new buttons that can be added to your LyX toolbar.
19250 Five of these buttons are short cuts to layout styles:
19271 The last one is a short cut to the
19272 \begin_inset Quotes eld
19276 \begin_inset Quotes erd
19283 \begin_layout Standard
19284 LyX has a range of buttons that are available for tool bar customization.
19285 In my toolbar I like to combine the six short cuts above with two more:
19290 \SpecialChar \menuseparator
19295 \SpecialChar \menuseparator
19302 View\SpecialChar \menuseparator
19306 Here is how it looks like:
19309 \begin_layout LyX-Code
19313 \begin_layout LyX-Code
19317 \begin_layout LyX-Code
19318 Icon "layout Standard"
19321 \begin_layout LyX-Code
19322 Icon "layout Section"
19325 \begin_layout LyX-Code
19326 Icon "layout LaTeX"
19329 \begin_layout LyX-Code
19330 Icon "layout LyX-Code"
19333 \begin_layout LyX-Code
19334 Icon "layout Scrap"
19337 \begin_layout LyX-Code
19341 \begin_layout LyX-Code
19345 \begin_layout LyX-Code
19346 Icon "buffer-typeset"
19349 \begin_layout LyX-Code
19350 Icon "build-program"
19353 \begin_layout LyX-Code
19357 \begin_layout LyX-Code
19361 \begin_layout LyX-Code
19365 \begin_layout LyX-Code
19369 \begin_layout LyX-Code
19373 \begin_layout Subsubsection
19374 Colors customization
19377 \begin_layout Standard
19378 There are a number of colors in LyX that can be customized in
19383 One of the things that bothers people is the LaTeX font color.
19384 The default color is red, since the scraps uses LaTeX font, and there is
19385 a lot of scraps in literate documents, you may get tired of seeing everything
19387 You can change it by going to the tabs
19396 \begin_layout Standard
19397 The next thing is the visible presence of the newline character in the screen.
19398 You can choose the color of this particular character and make it blend
19400 I recommend you choosing a color that is close to the background but not
19401 equal, that way you still can see it is there, but it is not bothering
19406 \begin_layout Chapter
19407 Secrets of the LaTeX Masters
19408 \begin_inset CommandInset label
19417 \begin_layout Standard
19418 Though LyX is a powerful tool, it cannot hope to support everything that
19419 can be done with pure TeX/LaTeX.
19420 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
19421 as long as you are not afraid to use that
19422 \begin_inset Quotes eld
19426 \begin_inset Quotes erd
19429 button on the toolbar or add things to the LaTeX preamble.
19430 This section lists some tips, tricks, and otherwise cool ideas to give
19431 your document that extra little flair.
19434 Do try this at home
19436 , just start with something a little smaller and less important than your
19440 \begin_layout Standard
19441 Most ideas in this section require less common files in your LaTeX installation.
19442 If you have a system like teTeX, most will already be available.
19443 A few, however, will need to be downloaded from one of the CTAN archives.
19444 Often, there are several ways to do something, or several LaTeX style files
19445 which do the same thing.
19446 We do not endorse one choice over another, we simply claim that we have
19447 done a particular task with a particular file.
19448 Put on your wizard hat, keep an eye out for dragons, and let us begin.
19451 \begin_layout Section
19455 \begin_layout Standard
19458 Lars Gullik Bjønnes
19461 \begin_layout Subsection
19465 \begin_layout Standard
19466 The aim for this chapter
19470 \begin_layout Plain Layout
19471 Editor's note: Lars' original chapter was a masterful description of how
19477 However, it was too long to flow smoothly in this document.
19478 I have therefore chosen to excerpt the most important sections here (sorry,
19479 Lars); you can read the original chapter (and more of the story!) in the
19482 examples/multicol.lyx
19490 is to show how the LaTeX package
19494 can be used in a LyX document.
19495 As LyX doesn't support the
19499 package natively yet, we have to use some small hacks.
19500 By reading this section it should be obvious how to do this.
19503 \begin_layout Subsection
19507 \begin_layout Standard
19512 package allows switching between one and multicolumn format on the same
19514 Footnotes are handled correctly (for the most part), but will be placed
19515 at the bottom of the page and not under each column.
19516 LaTeX's float mechanism, however, is partly disabled in the current implementat
19518 At the moment only page-wide floats can be used within the scope of the
19522 \begin_layout Subsection
19526 \begin_layout Subsubsection
19530 \begin_layout Standard
19531 If you want to have two columns in your text, you have use LaTeX mode to
19536 begin{multicols}{2}
19538 at the point where you want the two column layout to start, and then
19544 where you want it to end.
19548 \begin_layout Standard
19552 \begin_layout Plain Layout
19556 begin{multicols}{2}
19564 \begin_layout Standard
19569 The Adventure of the Empty House
19572 \begin_inset Newline newline
19577 Sir Arthur Conan Doyle
19580 \begin_layout Standard
19583 It was in the spring of the year 1894 that all London was interested, and
19584 the fashionable world dismayed, by the murder of the Honourable Ronald
19585 Adair under most unusual and inexplicable circumstances.
19586 The public has already learned those particulars of the crime which came
19587 out in the police investigation, but a good deal was suppressed upon that
19588 occasion, since the case for the prosecution was so overwhelmingly strong
19589 that it was not necessary to bring forward all the facts.
19590 Only now, at the end of nearly ten years, am I allowed to supply those
19591 missing links which make up the whole of that remarkable chain.
19592 The crime was of interest in itself, but that interest was as nothing to
19593 me compared to the inconceivable sequel, which afforded me the greatest
19594 shock and surprise of any event in my adventurous life.
19595 Even now, after this long interval, I find myself thrilling as I think
19596 of it, and feeling once more that sudden flood of joy, amazement, and increduli
19597 ty which utterly submerged my mind.
19598 Let me say to that public, which has shown some interest in those glimpses
19599 which I have occasionally given them of the thoughts and actions of a very
19600 remarkable man, that they are not to blame me if I have not shared my knowledge
19601 with them, for I should have considered it my first duty to do so, had
19602 I not been barred by a positive prohibition from his own lips, which was
19603 only withdrawn upon the third of last month.
19606 \begin_layout Standard
19610 \begin_layout Plain Layout
19622 \begin_layout Subsubsection
19626 \begin_layout Standard
19627 The same pattern is used when you want more than two columns:
19630 \begin_layout Standard
19634 \begin_layout Plain Layout
19638 begin{multicols}{3}
19646 \begin_layout Standard
19649 It can be imagined that my close intimacy with Sherlock Holmes had interested
19650 me deeply in crime, and that after his disappearance I never failed to
19651 read with care the various problems which came before the public.
19652 And I even attempted, more than once, for my own private satisfaction,
19653 to employ his methods in their solution, though with indifferent success.
19654 There was none, however, which appealed to me like this tragedy of Ronald
19656 As I read the evidence at the inquest, which led up to a verdict of willful
19657 murder against some person or persons unknown, I realized more clearly
19658 than I had ever done the loss which the community had sustained by the
19659 death of Sherlock Holmes.
19660 There were points about this strange business which would, I was sure,
19661 have specially appealed to him, and the efforts of the police would have
19662 been supplemented, or more probably anticipated, by the trained observation
19663 and the alert mind of the first criminal agent in Europe.
19664 All day, as I drove upon my round, I turned over the case in my mind and
19665 found no explanation which appeared to me to be adequate.
19666 At the risk of telling a twice-told tale, I will recapitulate the facts
19667 as they were known to the public at the conclusion of the inquest.
19670 \begin_layout Standard
19674 \begin_layout Plain Layout
19686 \begin_layout Standard
19687 You can have more than 3 columns if you want to, but that might not be very
19688 pleasant for the eye.
19691 \begin_layout Subsubsection
19692 Columns inside columns
19695 \begin_layout Standard
19696 You can even have columns inside columns:
19699 \begin_layout Standard
19703 \begin_layout Plain Layout
19707 begin{multicols}{2}
19715 \begin_layout Standard
19718 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
19719 at that time governor of one of the Australian colonies.
19720 Adair's mother had returned from Australia to undergo the operation for
19721 cataract, and she, her son Ronald, and her daughter Hilda were living together
19725 \begin_layout Standard
19729 \begin_layout Plain Layout
19733 begin{multicols}{2}
19741 \begin_layout Standard
19744 The youth moved in the best society–had, so far as was known, no enemies
19745 and no particular vices.
19746 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
19747 had been broken off by mutual consent some months before, and there was
19748 no sign that it had left any very profound feeling behind it.
19749 For the rest {sic} the man's life moved in a narrow and conventional circle,
19750 for his habits were quiet and his nature unemotional.
19751 Yet it was upon this easy-going young aristocrat that death came, in most
19752 strange and unexpected form, between the hours of ten and eleven-twenty
19753 on the night of March 30, 1894.
19756 \begin_layout Standard
19760 \begin_layout Plain Layout
19772 \begin_layout Standard
19775 Ronald Adair was fond of cards–playing continually, but never for such stakes
19777 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
19778 It was shown that, after dinner on the day of his death, he had played
19779 a rubber of whist at the latter club.
19780 He had also played there in the afternoon.
19785 The evidence of those who had played with him– Mr.
19786 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
19787 and that there was a fairly equal fall of the cards.
19788 Adair might have lost five pounds, but not more.
19789 His fortune was a considerable one, and such a loss could not in any way
19791 He had played nearly every day at one club or other, but he was a cautious
19792 player, and usually rose a winner.
19793 It came out in evidence that, in partnership with Colonel Moran, he had
19794 actually won as much as four hundred and twenty pounds in a sitting, some
19795 weeks before, from Godfrey Milner and Lord Balmoral.
19796 So much for his recent history as it came out at the inquest.
19799 \begin_layout Standard
19803 \begin_layout Plain Layout
19815 \begin_layout Standard
19816 Please do read the file
19818 examples/multicol.lyx
19820 for more advanced examples including column and header spacing, vertical
19821 separator lines, and more.
19824 \begin_layout Section
19829 Paragraph Environment
19830 \begin_inset OptArg
19833 \begin_layout Plain Layout
19834 Numbering in Enumerate
19842 \begin_layout Standard
19848 \begin_layout Standard
19849 \begin_inset VSpace bigskip
19855 \begin_layout Standard
19857 The default numbering for the
19861 paragraph environment begins with Arabic numbers and ends with uppercase
19863 Suppose, however, you wanted a different type of numbering scheme.
19864 Here's a quickie example of how to change the numbering scheme:
19867 \begin_layout LyX-Code
19877 \begin_layout LyX-Code
19887 \begin_layout LyX-Code
19897 \begin_layout LyX-Code
19907 \begin_layout Standard
19908 \SpecialChar \ldots{}
19909 which changes the numbering scheme to uppercase Roman numerals, uppercase
19910 letters, Arabic numbers, and lowercase letter.
19913 \begin_layout Standard
19914 Additionally, the previous example also adds a little bit extra to the numbering
19916 For example, the first level label actually looks like:
19917 \begin_inset Quotes eld
19921 \begin_inset Quotes erd
19925 For ease of reading, we'll describe what the numbering schemes look like
19926 using a notation something like this: <
19927 \begin_inset Quotes eld
19931 \begin_inset Quotes erd
19935 \begin_inset space ~
19939 \begin_inset Quotes erd
19943 \begin_inset Quotes erd
19947 \begin_inset space ~
19951 \begin_inset Quotes erd
19955 \begin_inset Quotes erd
19959 \begin_inset space ~
19963 \begin_inset Quotes eld
19967 \begin_inset Quotes erd
19974 \begin_layout Standard
19975 As you can see in the example, there is a label command for each nesting
19982 \SpecialChar \ldots{}
19989 , as well as a counter,
19993 \SpecialChar \ldots{}
19999 There are also five
20000 \begin_inset Quotes eld
20004 \begin_inset Quotes erd
20037 , each of which take one counter as an argument.
20038 You can add characters before or after these, but there's no need to add
20042 \begin_layout Standard
20043 You can get really fancy with these.
20047 \begin_layout LyX-Code
20061 \begin_layout LyX-Code
20073 \begin_layout LyX-Code
20083 \begin_layout LyX-Code
20093 \begin_layout Standard
20094 produces the somewhat out of hand numbering scheme: <
20095 \begin_inset Quotes eld
20099 \begin_inset Quotes erd
20103 \begin_inset space ~
20107 \begin_inset Quotes erd
20111 \begin_inset Quotes erd
20115 \begin_inset space ~
20119 \begin_inset Quotes erd
20123 \begin_inset Quotes erd
20127 \begin_inset space ~
20131 \begin_inset Quotes eld
20135 \begin_inset Quotes erd
20142 \begin_layout Standard
20146 \begin_layout Section
20150 \begin_layout Standard
20156 \begin_layout Standard
20157 \begin_inset VSpace bigskip
20163 \begin_layout Standard
20168 \begin_layout Plain Layout
20174 tmpfont}{cmr17 scaled 2500}{
20186 \begin_layout Standard
20191 \begin_layout Plain Layout
20202 hose of you who like the style of old books probably also like
20203 \begin_inset Quotes eld
20207 \begin_inset Quotes erd
20210 —those large capital letters which begin each new chapter or section.
20211 Implementing them with plain LyX/LaTeX is straightforward (assuming you
20212 know some plain TeX!) but does require a lot of work and many iterations,
20213 as you can see by all the ugly TeX-mode stuff at the beginning of this
20217 \begin_layout Standard
20221 \begin_layout Plain Layout
20227 bigdrop{-1em}{3}{ptmri}{T}+
20232 here is a much easier way of doing this, of course.
20241 ) package from CTAN allows a simple way to add such letters to your documents.
20242 Since this package is not a standard part of teTeX, I can't demonstrate
20243 it within this document, but if you copy this paragraph to a new document,
20245 \begin_inset Quotes eld
20255 \begin_inset Quotes erd
20258 and the pluses from the TeX code at the beginning of the paragraph, and
20263 usepackage{dropcaps}
20265 to your LaTeX preamble, you will get a nice Times Roman Italic
20266 \begin_inset Quotes eld
20270 \begin_inset Quotes erd
20273 , whose height is three lines of text and which protrudes 1 em into the
20275 (Make certain you have copied
20276 \begin_inset Quotes eld
20284 \begin_inset Quotes erd
20287 into a directory where TeX can see it.) The first argument is the amount
20288 of indentation; in this case the negative sign moves it into the margin.
20289 The second argument is the height of the letter in number of lines of text.
20290 The third argument is the font name: virtually anything which has a tfm
20291 file should work (wade through the
20293 .../texmf/fonts/tfm
20295 directory for possibilities).
20296 My personal favorite is
20297 \begin_inset Quotes eld
20305 \begin_inset Quotes erd
20308 , a fancy German font specifically designed for dropped capitals.
20309 The fourth argument is the letter (or letters) to be dropped.
20314 package also offers the
20320 command, as well as a slightly simplified
20329 \begin_layout Section
20330 Non-standard Paragraph Shapes
20333 \begin_layout Standard
20339 \begin_layout Standard
20340 \begin_inset VSpace bigskip
20346 \begin_layout Standard
20350 \begin_layout Plain Layout
20362 \begin_layout Standard
20366 \begin_layout Plain Layout
20375 \begin_layout Plain Layout
20389 \begin_layout Standard
20394 \begin_layout Plain Layout
20405 \begin_layout Plain Layout
20414 \begin_layout Plain Layout
20423 \begin_layout Plain Layout
20432 \begin_layout Plain Layout
20441 \begin_layout Plain Layout
20450 \begin_layout Plain Layout
20459 \begin_layout Plain Layout
20468 \begin_layout Plain Layout
20477 \begin_layout Plain Layout
20486 \begin_layout Plain Layout
20495 \begin_layout Plain Layout
20504 \begin_layout Plain Layout
20513 \begin_layout Plain Layout
20522 \begin_layout Plain Layout
20531 \begin_layout Plain Layout
20540 \begin_layout Plain Layout
20549 \begin_layout Plain Layout
20558 \begin_layout Plain Layout
20567 \begin_layout Plain Layout
20573 There are times when the tyranny of rectangular paragraphs must be overthrown.
20574 In such situations, a call to the delightful plain TeX command
20581 As you can see, completely arbitrary shapes can be laid out with a suitable
20582 set of linelength definitions.
20583 While this parshape may look a bit silly and useless, one could conceive
20584 of situations such as finely tuned dropped capitals, word wrapping around
20585 non-rectangular graphics, etc.
20586 which will benefit from such handcrafting.
20589 \begin_layout Standard
20590 \begin_inset VSpace bigskip
20596 \begin_layout Standard
20601 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
20608 is the number of lines of text which define the paragraph.
20609 If there turn out to be fewer lines, the shape is truncated; if there are
20610 more, the excess lines have the same dimensions as the last line of the
20620 entries specify the indentation of the line from the left margin, and the
20621 length of the line as measured from that point.
20622 The shape applies only to the current paragraph; everything is reset to
20623 normal for the next paragraph.
20626 \begin_layout Standard
20630 \begin_layout Plain Layout
20642 \begin_layout Section
20646 \begin_layout Standard
20647 As you can see, the examples in this section range from the useful to the
20649 While I don't expect that anyone will ever need the paragraph shape demonstrate
20650 d in the last section, the important point is that you can do almost anything
20651 you want in LyX if you are willing to figure out how to do it in TeX and
20653 TeX is a fantastically powerful typesetting system and all that power is
20654 available to you since LyX uses it as its backend.