1 #LyX 2.3 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
40 \maintain_unincluded_children false
42 \language_package default
45 \font_roman "lmodern" "default"
46 \font_sans "lmss" "default"
47 \font_typewriter "lmtt" "default"
48 \font_math "auto" "auto"
49 \font_default_family default
50 \use_non_tex_fonts false
53 \font_sf_scale 100 100
54 \font_tt_scale 100 100
56 \use_dash_ligatures true
58 \default_output_format pdf2
60 \bibtex_command default
61 \index_command default
65 \pdf_title "LyX's Additional Features manual"
66 \pdf_author "LyX Team"
67 \pdf_subject "LyX's additional features documentation"
68 \pdf_keywords "LyX, Documentation, Additional"
70 \pdf_bookmarksnumbered true
71 \pdf_bookmarksopen false
72 \pdf_bookmarksopenlevel 1
77 \pdf_pdfusetitle false
78 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
81 \use_package amsmath 1
82 \use_package amssymb 1
85 \use_package mathdots 1
86 \use_package mathtools 0
88 \use_package stackrel 0
89 \use_package stmaryrd 0
90 \use_package undertilde 0
92 \cite_engine_type default
96 \paperorientation portrait
101 \notefontcolor #0000ff
108 \paragraph_separation indent
109 \paragraph_indentation default
111 \math_indentation default
112 \math_numbering_side default
113 \quotes_style english
117 \paperpagestyle headings
118 \tracking_changes true
119 \output_changes false
123 \author -712698321 "Jürgen Spitzmüller"
129 Additional \SpecialChar LyX
133 \begin_layout Subtitle
138 by the \SpecialChar LyX
143 \begin_layout Plain Layout
145 Principal maintainer of this file is
150 If you have comments or error corrections, please send them to the \SpecialChar LyX
153 \begin_inset Flex Code
156 \begin_layout Plain Layout
158 <lyx-docs@lists.lyx.org>
171 \begin_layout Standard
172 \begin_inset CommandInset toc
173 LatexCommand tableofcontents
180 \begin_layout Chapter
184 \begin_layout Standard
185 This manual is essentially Part II of the
187 User's Guide\SpecialChar endofsentence
190 The reason for separating the two documents is simple: the
194 is already quite lengthy, and it contains information on all of the basic
195 features one needs to know in order to prepare most documents.
196 However, the \SpecialChar LyX
197 Team has worked to make \SpecialChar LyX
198 extensible through various configuration
199 files and external packages.
200 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
202 create a layout file (or module) for it without having to alter \SpecialChar LyX
204 We've already had contributions of several new features this way, and some
205 of them are documented here.
206 There are also some more `advanced' features, such as how to control the
207 presentation of bibliographies and how to work with multi-part documents,
208 that are not covered in the
212 and are discussed here.
215 \begin_layout Standard
216 This manual also documents some special features, like fax support, version
217 control, and SGML support, which require additional software to work properly.
218 There is also a chapter on \SpecialChar LyX
220 And lastly, there's a chapter of \SpecialChar LaTeX
221 tools and tips, things you can use to
222 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
224 After all, \SpecialChar LyX
229 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
233 \begin_layout Standard
234 If you haven't read the
238 yet, you are definitely in the wrong manual.
243 is the first place to go, since it describes the notation and format of
245 You should also be thoroughly familiar with the
249 and all of the basic features of \SpecialChar LyX
250 before attempting to read this one.
253 \begin_layout Standard
254 Since many of the topics in this manual depend heavily on \SpecialChar LyX
256 with \SpecialChar LaTeX
257 , this first chapter covers the inner workings of \SpecialChar LyX
260 to generate exactly the \SpecialChar LaTeX
262 It is obviously for more seasoned \SpecialChar LyX
266 \begin_layout Chapter
268 and \SpecialChar LaTeX
272 \begin_layout Section
274 Uses \SpecialChar LaTeX
278 \begin_layout Standard
279 This chapter is for both \SpecialChar TeX
280 -nicians and the \SpecialChar LaTeX
282 In it, we'll explain how \SpecialChar LyX
283 and \SpecialChar LaTeX
284 work together to produce printable output.
285 This is the only place in any of the manuals where we assume you know something
286 about \SpecialChar LaTeX
290 \begin_layout Standard
291 At one time, \SpecialChar LyX
293 \begin_inset Quotes eld
296 WYSIWYM frontend to \SpecialChar LaTeX
298 \begin_inset Quotes erd
301 but that's no longer true.
302 There are frontends to \SpecialChar LaTeX
307 \begin_layout Plain Layout
308 Some familar ones are \SpecialChar TeX
309 maker and kile, on Linux, and \SpecialChar TeX
311 There are also the \SpecialChar LaTeX
312 modes for vi and emacs, of course.
317 These are basically text editors with the ability to run \SpecialChar LaTeX
319 errors in the file you're editing.
320 Although \SpecialChar LyX
329 run \SpecialChar LaTeX
330 , and it also indicates errors in the file, it also does much, much
332 For one thing, you don't need to know \SpecialChar LaTeX
333 to use \SpecialChar LyX
336 has added its own extensions to \SpecialChar LaTeX
338 Try the following sometime: select
339 \begin_inset Flex Noun
342 \begin_layout Plain Layout
343 Export\SpecialChar menuseparator
350 \begin_inset Flex Noun
353 \begin_layout Plain Layout
360 \begin_inset Flex Noun
363 \begin_layout Plain Layout
364 View\SpecialChar menuseparator
374 ), then look at the preamble of the resulting
375 \begin_inset Flex Code
378 \begin_layout Plain Layout
385 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
387 These macros are defined automatically, according to the features you use
391 \begin_layout Standard
392 There are several commands that automatically invoke \SpecialChar LaTeX
397 \begin_layout Itemize
398 \begin_inset Flex Noun
401 \begin_layout Plain Layout
402 Document\SpecialChar menuseparator
411 \begin_layout Itemize
412 \begin_inset Flex Noun
415 \begin_layout Plain Layout
416 Document\SpecialChar menuseparator
425 \begin_layout Standard
426 They will only invoke \SpecialChar LaTeX
427 if the file has changed since the last time \SpecialChar LaTeX
433 \begin_layout Standard
434 When \SpecialChar LyX
435 runs \SpecialChar LaTeX
436 on the file you're editing, it performs these steps:
439 \begin_layout Enumerate
440 Convert the document to \SpecialChar LaTeX
441 and save to a file with the extension
442 \begin_inset Flex Code
445 \begin_layout Plain Layout
452 \begin_inset Flex Code
455 \begin_layout Plain Layout
464 \begin_layout Enumerate
465 Run \SpecialChar LaTeX
467 \begin_inset Flex Code
470 \begin_layout Plain Layout
476 file (maybe several times), and run any other commands (such as
477 \begin_inset Flex Code
480 \begin_layout Plain Layout
487 \begin_inset Flex Code
490 \begin_layout Plain Layout
496 ) needed to compile the \SpecialChar LaTeX
500 \begin_layout Enumerate
501 If there are any errors, show the error log.
504 \begin_layout Standard
505 If you have run \SpecialChar LaTeX
507 \begin_inset Flex Noun
510 \begin_layout Plain Layout
511 View\SpecialChar menuseparator
518 then runs a DVI viewer to display the DVI-file.
520 \begin_inset Flex Noun
523 \begin_layout Plain Layout
524 View\SpecialChar menuseparator
531 performs further steps:
534 \begin_layout Itemize
536 \begin_inset Flex Code
539 \begin_layout Plain Layout
545 to convert the DVI file to PostScript.
548 \begin_layout Itemize
549 Run a PostScript viewer, such as
550 \begin_inset Flex Code
553 \begin_layout Plain Layout
559 , to display the PostScript file.
562 \begin_layout Standard
564 does similar things when viewing, or exporting, other formats.
567 \begin_layout Section
568 Translating \SpecialChar LaTeX
569 files into \SpecialChar LyX
573 \begin_layout Standard
574 You can import a \SpecialChar LaTeX
575 file into \SpecialChar LyX
577 \begin_inset Flex Noun
580 \begin_layout Plain Layout
581 File\SpecialChar menuseparator
582 Import\SpecialChar menuseparator
588 command in \SpecialChar LyX
590 This will call a program named
591 \begin_inset Flex Code
594 \begin_layout Plain Layout
600 which will create a file
601 \begin_inset Flex Code
604 \begin_layout Plain Layout
611 \begin_inset Flex Code
614 \begin_layout Plain Layout
622 will then open that file.
626 \begin_layout Plain Layout
627 \begin_inset Flex Code
630 \begin_layout Plain Layout
636 can also be run from the command line, of course.
644 \begin_layout Standard
645 \begin_inset Flex Code
648 \begin_layout Plain Layout
654 will translate most legal \SpecialChar LaTeX
655 , but not everything.
656 It will put things it doesn't understand into \SpecialChar TeX
657 code, so after translating
659 \begin_inset Flex Code
662 \begin_layout Plain Layout
668 , you can look for \SpecialChar TeX
669 code and hand-edit it until it looks right.
672 \begin_layout Standard
673 If you don't know what \SpecialChar TeX
674 code is, read the next section.
677 \begin_layout Section
678 \begin_inset CommandInset label
680 name "sec:Inserting-TeX-Code"
684 Inserting \SpecialChar TeX
685 Code into \SpecialChar LyX
689 \begin_layout Standard
690 Anything you can do in \SpecialChar LaTeX
691 you can do in \SpecialChar LyX
692 , for a very simple reason: You can
693 always insert \SpecialChar TeX
694 code into any \SpecialChar LyX
697 cannot, and will never be able to, display every possible \SpecialChar LaTeX
699 If ever you need to insert \SpecialChar LaTeX
700 commands into your \SpecialChar LyX
701 document, you can use the
703 \begin_inset Flex Code
706 \begin_layout Plain Layout
713 box, which you can insert into your document with
714 \begin_inset Flex Noun
717 \begin_layout Plain Layout
718 Insert\SpecialChar menuseparator
728 or the keyboard shortcut
737 \begin_layout Standard
738 Here's an example of inserting \SpecialChar LaTeX
739 commands in a \SpecialChar LyX
741 The code looks like this:
744 \begin_layout LyX-Code
748 \begin_inset Newline newline
754 \begin_inset Newline newline
757 This is an example of a minipage environment.
759 \begin_inset Newline newline
762 can put nearly everything in it, even (non-floating)
763 \begin_inset Newline newline
768 \begin_inset Newline newline
774 \begin_inset Newline newline
778 \begin_inset Newline newline
784 \begin_inset Newline newline
790 \begin_inset Newline newline
796 \begin_inset Newline newline
801 \begin_inset Newline newline
807 \begin_inset Newline newline
813 \begin_inset Newline newline
819 \begin_inset Newline newline
827 \begin_layout LyX-Code
831 \begin_layout Standard
833 \begin_inset Flex Code
836 \begin_layout Plain Layout
843 box containing this text is directly after this paragraph.
844 Those of you reading the manual in \SpecialChar LyX
845 will only see the \SpecialChar TeX
847 Those reading a printed version of the manuals will see the actual results:
848 \begin_inset VSpace bigskip
854 \begin_layout Standard
858 \begin_layout Plain Layout
865 \begin_layout Plain Layout
872 \begin_layout Plain Layout
874 This is an example of a minipage environment.
875 You can put nearly everything in it, even (non-floating) figures and tables.
879 \begin_layout Plain Layout
886 \begin_layout Plain Layout
891 \begin_layout Plain Layout
898 \begin_layout Plain Layout
905 \begin_layout Plain Layout
912 \begin_layout Plain Layout
918 \begin_layout Plain Layout
925 \begin_layout Plain Layout
932 \begin_layout Plain Layout
939 \begin_layout Plain Layout
949 \begin_inset VSpace bigskip
955 \begin_layout Standard
956 In addition to using \SpecialChar TeX
957 code, you can also create a separate file containing
958 some complex \SpecialChar LaTeX
959 structure and then use
960 \begin_inset Flex Noun
963 \begin_layout Plain Layout
964 Insert\SpecialChar menuseparator
974 to include your file (you should select the type
975 \begin_inset Flex Code
978 \begin_layout Plain Layout
985 We recommend that you only do this if you have a
986 \begin_inset Flex Code
989 \begin_layout Plain Layout
1000 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1004 \begin_layout Standard
1005 There are a few last points to emphasize:
1008 \begin_layout Itemize
1014 check if your \SpecialChar LaTeX
1018 \begin_layout Itemize
1019 Beware of reinventing the wheel.
1022 \begin_layout Standard
1023 On that last point, \SpecialChar LyX
1024 does have quite a few features tucked into it, and
1026 Be sure to check the manuals to make sure that \SpecialChar LyX
1027 doesn't have such-and-such
1028 feature before you decide you have to do it by hand.
1029 Moreover, there are numerous \SpecialChar LaTeX
1030 packages out there to do all sorts of things,
1031 from labels to envelopes to fancy multipage tables.
1033 \begin_inset CommandInset href
1036 target "http://www.ctan.org/"
1044 \begin_layout Standard
1045 If you do need to do some wild and fancy things within your document, be
1046 sure to check out a good \SpecialChar LaTeX
1047 book for assistance.
1048 There are a number of them listed in the bibliography of the
1055 \begin_layout Section
1057 and the \SpecialChar LaTeX
1061 \begin_layout Subsection
1062 About the \SpecialChar LaTeX
1066 \begin_layout Standard
1067 If you already know \SpecialChar LaTeX
1068 , there is no need to explain here what the preamble
1070 If you don't, the following will give you some ideas—we recommend again
1071 that you consult a \SpecialChar LaTeX
1072 book for further information.
1073 In any case, you should read the points below, because they explain what
1074 you can do and what you don't need to do in the \SpecialChar LaTeX
1075 preamble of a \SpecialChar LyX
1079 \begin_layout Standard
1080 The \SpecialChar LaTeX
1081 preamble comes at the very beginning of a document,
1089 \begin_layout Itemize
1090 Declare the document class.
1092 \begin_inset Newline newline
1096 already does this for you.
1097 If you're a seasoned \SpecialChar LaTeX
1098 -nician, and you have a custom document class you
1099 want to use, check out the
1101 Customization Manual
1103 for information on how to make \SpecialChar LyX
1107 \begin_layout Itemize
1108 Declare the usage of packages.
1110 \begin_inset Newline newline
1114 packages provide special commands, which are only available within a document
1115 when the package has been declared in the preamble.
1116 In addition to providing special commands, the inclusion of a package can
1117 change the document.
1118 For example, the package
1119 \begin_inset Flex Code
1122 \begin_layout Plain Layout
1128 forces all paragraphs to be indented.
1129 There are other packages for labels, envelopes, margins, etc.
1133 \begin_layout Itemize
1134 Set counters, variables, lengths and widths.
1136 \begin_inset Newline newline
1139 There are several \SpecialChar LaTeX
1140 counters and variables that
1144 be set globally from within the preamble in order to have the desired effect.
1145 (There are variables that you can set and reset inside the document, too.)
1146 Margins are a good example of something that must be set in the preamble.
1147 Another example is the label format for lists.
1148 You can actually set these just about anywhere, but it's best to do it
1149 just once, inside the preamble.
1152 \begin_layout Itemize
1153 Declare user defined commands (with
1154 \begin_inset Flex Code
1157 \begin_layout Plain Layout
1166 \begin_inset Flex Code
1169 \begin_layout Plain Layout
1178 \begin_inset Newline newline
1181 These are abbreviations for \SpecialChar LaTeX
1182 commands which appear very often inside a document.
1183 Although the preamble is a good place to declare such commands, they
1187 be declared anywhere (before they are used for the first time, of course).
1188 This can be useful if there is a lot of raw \SpecialChar LaTeX
1189 code in your document, which
1190 normally should not be the case.
1193 \begin_layout Standard
1195 adds its own set of definitions to the preamble of the
1196 \begin_inset Flex Code
1199 \begin_layout Plain Layout
1206 This makes \SpecialChar LaTeX
1207 files generated by \SpecialChar LyX
1211 \begin_layout Subsection
1212 Changing the Preamble
1215 \begin_layout Standard
1216 The commands which \SpecialChar LyX
1217 adds to the preamble of a \SpecialChar LaTeX
1218 file are fixed; you can't
1219 change them without patching \SpecialChar LyX
1221 You can, however, add your own stuff to the preamble by selecting
1222 \begin_inset Flex Noun
1225 \begin_layout Plain Layout
1228 \begin_inset space ~
1237 \begin_inset Flex Noun
1240 \begin_layout Plain Layout
1241 Document\SpecialChar menuseparator
1249 adds anything in the
1250 \begin_inset Flex Noun
1253 \begin_layout Plain Layout
1259 dialog to its own built-in preamble.
1260 Before adding your own declarations in the preamble, you should make sure
1261 that \SpecialChar LyX
1262 doesn't already support what you want to do.
1263 (Remember what we said about reinventing the wheel?) Also,
1265 make sure your preamble code is correct
1269 doesn't check it for you.
1270 If there is an error, you're likely to get an error like
1271 \begin_inset Quotes eld
1275 \begin_inset Flex Code
1278 \begin_layout Plain Layout
1287 \begin_inset Quotes erd
1291 If you see this error, check your preamble.
1294 \begin_layout Subsection
1298 \begin_layout Standard
1299 Here are some examples of what you can add to a preamble, and what they
1303 \begin_layout Subsubsection
1307 \begin_layout Standard
1308 There are two variables under \SpecialChar LaTeX
1309 that control page position:
1310 \begin_inset Flex Code
1313 \begin_layout Plain Layout
1322 \begin_inset Flex Code
1325 \begin_layout Plain Layout
1334 Their names should be self-explanatory.
1335 These variables are useful if you think for a moment about computer labels.
1336 Sometimes, the size of a print medium and the area of the medium that you
1337 can actually print on aren't the same.
1339 \begin_inset Flex Code
1342 \begin_layout Plain Layout
1351 \begin_inset Flex Code
1354 \begin_layout Plain Layout
1365 \begin_layout Standard
1366 The default values for
1367 \begin_inset Flex Code
1370 \begin_layout Plain Layout
1379 \begin_inset Flex Code
1382 \begin_layout Plain Layout
1391 \begin_inset space \thinspace{}
1395 \begin_inset space \thinspace{}
1399 \begin_inset space \space{}
1402 the page isn't shifted.
1403 Unfortunately, some DVI drivers always seem to shift the page.
1404 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1405 If you're using \SpecialChar LyX
1406 on a system that you don't personally maintain, and your
1407 sysadmin is a doofus,
1408 \begin_inset Flex Code
1411 \begin_layout Plain Layout
1420 \begin_inset Flex Code
1423 \begin_layout Plain Layout
1432 Suppose your left and top margins are always 0.5
1433 \begin_inset space \thinspace{}
1437 You can add this to the preamble:
1440 \begin_layout LyX-Code
1448 \begin_layout LyX-Code
1456 \begin_layout Standard
1457 and your margins should now be correct.
1460 \begin_layout Subsubsection
1464 \begin_layout Standard
1465 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1466 There's a rather nice package, available at your nearest CTAN archive,
1467 for printing sheets of labels:
1468 \begin_inset Flex Code
1471 \begin_layout Plain Layout
1478 Now, your system may not have this package installed by default.
1479 We leave that up to you to check.
1480 You'll also want to read the documentation for it; we're not going to do
1482 Since this is an example, however, we'll give you an example of how you
1486 \begin_layout Standard
1487 First, make sure you're using the
1488 \begin_inset Flex Code
1491 \begin_layout Plain Layout
1498 Next, you need to put the following in your preamble:
1501 \begin_layout LyX-Code
1507 \begin_layout LyX-Code
1513 \begin_layout LyX-Code
1519 \begin_layout LyX-Code
1525 \begin_layout LyX-Code
1531 \begin_layout LyX-Code
1537 \begin_layout LyX-Code
1543 \begin_layout Standard
1544 This sets things up for Avery label sheets, stock #5360.
1545 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1548 \begin_inset Flex Code
1551 \begin_layout Plain Layout
1560 \begin_inset Flex Code
1563 \begin_layout Plain Layout
1571 around each label text.
1572 This and other special features of
1573 \begin_inset Flex Code
1576 \begin_layout Plain Layout
1582 are explained in its documentation.
1585 \begin_layout Standard
1586 Someday, someone may write a \SpecialChar LyX
1587 layout file to support this package directly.
1588 Maybe that someone is you.
1591 \begin_layout Subsubsection
1592 Example #3: Paragraph Indentation
1595 \begin_layout Standard
1596 Americans are trained to indent the first line of
1601 As with all of their other weird quirks, most Americans will whine and
1602 moan until they can have their way and indent the first line of all paragraphs.
1611 \begin_layout Standard
1612 Of course, this behavior isn't standard typography.
1613 In books, you typically only indent the first line of a paragraph
1617 it follows another one.
1618 The idea behind indenting the first line of a paragraph is to distinguish
1619 neighboring paragraphs from one another.
1620 If there is no previous paragraph—for example, if it follows a figure or
1621 is the first paragraph in a section—then there is no need for indentation.
1625 \begin_layout Standard
1626 If you're a typical American (we're still joking!), though, you don't care
1627 about such esoteric things; you want your indentation! Add this to the
1631 \begin_layout LyX-Code
1634 usepackage{indentfirst}
1637 \begin_layout Standard
1638 If your \SpecialChar TeX
1639 distribution isn't braindead, you'll have this package, and all
1640 of your paragraphs will get the indentation the Founding Fathers intended
1644 \begin_layout Subsubsection
1645 Example #4: This Document
1648 \begin_layout Standard
1649 You can also check out the preamble of this document to get an idea of some
1650 of the advanced things you can do.
1653 \begin_layout Section
1655 and \SpecialChar LaTeX
1659 \begin_layout Standard
1660 When \SpecialChar LyX
1661 calls \SpecialChar LaTeX
1662 , it tells \SpecialChar LaTeX
1663 to blithely ignore any errors and keep going.
1664 It then uses the logfile from the \SpecialChar LaTeX
1665 run to do a post-mortem.
1666 After analyzing the logfile, \SpecialChar LyX
1667 displays a dialog listing the errors.
1668 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1670 where the error occurred.
1674 \begin_layout Plain Layout
1676 Analyzing the logfile is a tough job, and \SpecialChar LyX
1677 doesn't always go to the right
1679 There are also cases where \SpecialChar LaTeX
1680 reports the error on one line, but the actual
1682 This is not unlike forgetting a closing brace in a program: You'll get
1683 an error, but only later.
1691 \begin_layout Standard
1692 Some folks also like to look at the log file directly: It is available from
1694 \begin_inset Flex Noun
1697 \begin_layout Plain Layout
1698 Document\SpecialChar menuseparator
1700 \begin_inset space ~
1709 There are some fairly common error messages and warnings.
1710 We'll cover those here.
1711 You should look at a good \SpecialChar LaTeX
1712 book for a complete listing.
1715 \begin_layout Itemize
1716 \begin_inset Flex Code
1719 \begin_layout Plain Layout
1726 \begin_inset Newline newline
1729 Anything beginning with these words is a warning message for the purpose
1731 \begin_inset Quotes eld
1735 \begin_inset Quotes erd
1738 the \SpecialChar LaTeX
1740 You'll get messages like this if you added or changed cross-references
1741 or bibliography entries, in which case, \SpecialChar LaTeX
1742 is trying to tell you that you
1743 need to make another run.
1744 You can by-and-large ignore these.
1747 \begin_layout Itemize
1748 \begin_inset Flex Code
1751 \begin_layout Plain Layout
1758 \begin_inset Newline newline
1761 Another warning message, this time about fonts which \SpecialChar LaTeX
1763 The rest of the message will often say something about a replacement font
1764 that \SpecialChar LaTeX
1766 You can safely ignore these, too.
1769 \begin_layout Itemize
1770 \begin_inset Flex Code
1773 \begin_layout Plain Layout
1782 \begin_inset Newline newline
1791 They are warnings about lines that were too long and run past the right
1793 Almost always, this is unnoticeable in the final output.
1794 (It can be just a point or two.) Or, only one or two characters extend past
1797 seems to generate at least one of these messages for just about any document
1799 \begin_inset Newline newline
1802 You can ignore these messages.
1803 Your eyes will tell you if there's a problem with something that's too
1804 wide; just look at the output.
1808 \begin_layout Plain Layout
1809 You can also enable the `draft' option in
1810 \begin_inset Flex Noun
1813 \begin_layout Plain Layout
1814 Document\SpecialChar menuseparator
1820 , and then \SpecialChar LaTeX
1821 will draw a black box in the margin of lines that are overfull.
1829 \begin_layout Itemize
1830 \begin_inset Flex Code
1833 \begin_layout Plain Layout
1842 \begin_inset Newline newline
1845 Not quite as common as its cousin.
1847 seems to like to print lines that are a bit too wide as opposed to ones
1848 that are a bit too narrow.
1849 We have no idea why.
1852 \begin_layout Itemize
1853 \begin_inset Flex Code
1856 \begin_layout Plain Layout
1865 \begin_inset Flex Code
1868 \begin_layout Plain Layout
1877 \begin_inset Newline newline
1880 Warnings about troubles breaking the page.
1881 Once again, just look at the output.
1882 Your eyes will tell you where something has gone wrong.
1885 \begin_layout Itemize
1886 \begin_inset Flex Code
1889 \begin_layout Plain Layout
1891 \begin_inset Quotes els
1895 \begin_inset Quotes ers
1904 \begin_inset Newline newline
1908 \begin_inset Quotes eld
1912 \begin_inset Quotes erd
1915 isn't installed on this system.
1916 This usually appears because some package your document needs isn't installed.
1917 If you didn't touch the preamble or didn't use the
1918 \begin_inset Flex Code
1921 \begin_layout Plain Layout
1929 command, then one of the packages \SpecialChar LyX
1930 tried to load is missing.
1932 \begin_inset Flex Noun
1935 \begin_layout Plain Layout
1936 Help\SpecialChar menuseparator
1943 to get a list of packages that \SpecialChar LyX
1945 This file is updated whenever you reconfigure \SpecialChar LyX
1947 \begin_inset Flex Noun
1950 \begin_layout Plain Layout
1951 Tools\SpecialChar menuseparator
1957 ) and tells you which packages have been detected and what they do.
1958 \begin_inset Newline newline
1962 \begin_inset Flex Code
1965 \begin_layout Plain Layout
1973 command and the package in question isn't installed, then you'll need to
1974 install it yourself.
1977 \begin_layout Itemize
1978 \begin_inset Flex Code
1981 \begin_layout Plain Layout
1982 LaTeX Error: Unknown option
1988 \begin_inset Newline newline
1991 Error messages beginning with this are trying to tell you that you specified
1992 a bad or undefined option to a package.
1993 Check the package's documentation.
1996 \begin_layout Itemize
1997 \begin_inset Flex Code
2000 \begin_layout Plain Layout
2001 Undefined control sequence
2007 \begin_inset Newline newline
2010 If you've inserted \SpecialChar LaTeX
2011 code into your document, but made a typo, you'll get
2013 You may have forgotten to load a package.
2014 In any case, this error message usually means that you used an undefined
2019 \begin_layout Standard
2020 There are other error and warning messages.
2021 Some are self-explanatory.
2022 These are usually \SpecialChar LaTeX
2024 Others are downright cryptic.
2025 These are usually \SpecialChar TeX
2026 error messages, and we really have
2030 what they mean or how to decipher them.
2034 \begin_layout Standard
2035 There's a general sequence you should follow if you get error messages:
2038 \begin_layout Enumerate
2039 Look at the \SpecialChar LaTeX
2040 code you inserted for typos.
2043 \begin_layout Enumerate
2044 If there are no typos, check that you used the command(s) correctly.
2047 \begin_layout Enumerate
2048 If you get a bunch of error boxes piled up at the very top of the document—and
2049 especially if you see a
2050 \begin_inset Quotes eld
2054 \begin_inset Flex Code
2057 \begin_layout Plain Layout
2066 \begin_inset Quotes erd
2069 error—it means that there are errors in the preamble.
2070 Start debugging your preamble.
2073 \begin_layout Enumerate
2074 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2076 document, the first suspect is your \SpecialChar LaTeX
2077 distribution itself.
2078 Check for missing packages and install them.
2081 \begin_layout Enumerate
2082 Okay, so there are no missing packages.
2083 Did you use any of the fine-tuning options in \SpecialChar LyX
2084 ? Specifically, did you
2088 any of them, like trying to manually insert lots of
2089 \begin_inset Flex Code
2092 \begin_layout Plain Layout
2094 \begin_inset space ~
2103 \begin_inset Flex Code
2106 \begin_layout Plain Layout
2113 \begin_inset Flex Code
2116 \begin_layout Plain Layout
2122 ? Did you try to kludge something together with these instead of using the
2123 appropriate paragraph environment?
2126 \begin_layout Enumerate
2127 All right, you didn't use any of the fine-tuning options, you played by
2129 Did you try to pull a fancy maneuver? Did you do something funky inside
2130 a table or an equation, like inserting a graphic into a table cell?
2133 \begin_layout Enumerate
2134 Do you have long sections of text where \SpecialChar LaTeX
2135 cannot find a place to break a
2136 line? By default, \SpecialChar LaTeX
2137 is rather strict about how much extra inter-word spacing
2138 it will add in order to break a line.
2139 Preferably, you should rework the paragraph to avoid the problem.
2142 \begin_layout Enumerate
2143 Did you go overboard with the nesting? \SpecialChar LyX
2144 (currently) doesn't check to make
2145 sure you're in the limits for nesting environments.
2146 If you nested a bunch of environments to the
2147 \begin_inset Formula $17^{\mathrm{th}}$
2150 level, that's the problem.
2151 (The limit in \SpecialChar LaTeX
2155 \begin_layout Enumerate
2156 Okay, you didn't get any error messages, but your output looks awful.
2157 If you have a table or figure that's too wide or long for the page, you
2162 \begin_layout Enumerate
2163 rescale the figure so it fits.
2166 \begin_layout Enumerate
2167 trim down the table so it fits.
2171 \begin_layout Enumerate
2172 If something else is wrong with the output, and you didn't try to pull anything
2173 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2176 \begin_layout Standard
2177 If all this doesn't help—well, then
2181 you might have found a bug in \SpecialChar LyX
2186 \begin_layout Chapter
2190 \begin_layout Section
2191 Customizing Bibliographies with Bib\SpecialChar TeX
2195 \begin_layout Standard
2196 The most basic information about how to use Bib\SpecialChar TeX
2201 with \SpecialChar LyX
2202 is contained in the section
2204 Bibliography databases
2211 The following subsections explain special bibliography features supported
2216 \begin_layout Subsection
2217 Alternative Citation Styles
2220 \begin_layout Standard
2221 Standard Bib\SpecialChar TeX
2223 \begin_inset space \thinspace{}
2227 \begin_inset space \space{}
2231 \begin_inset Quotes eld
2235 \begin_inset Quotes erd
2238 ) to refer to a cited work.
2239 However, in many scientific disciplines, other citation styles are in use.
2240 The most common one is the author-year style (e.
2241 \begin_inset space \thinspace{}
2245 \begin_inset space \space{}
2249 \begin_inset Quotes eld
2253 \begin_inset Quotes erd
2258 supports three packages that provide this style,
2259 \begin_inset Flex Code
2262 \begin_layout Plain Layout
2269 \begin_inset Flex Code
2272 \begin_layout Plain Layout
2279 \begin_inset Flex Code
2282 \begin_layout Plain Layout
2289 Each of these packages has their pros and cons, which cannot be listed
2291 If you only want to have simple author-year (or author-numerical) style,
2292 or if you want to use one of the countless style files for
2293 \begin_inset Flex Code
2296 \begin_layout Plain Layout
2302 , then the established
2303 \begin_inset Flex Code
2306 \begin_layout Plain Layout
2312 package is probably your choice.
2313 If you look for specific citation styles common in law studies, you might
2315 \begin_inset Flex Code
2318 \begin_layout Plain Layout
2325 If you want to have full control over the formatting or look for advanced
2326 features such as ibidem, footnote citations, full title citations, advanced
2327 date formats (such as 400 BC) or full localization to other languages than
2328 English, you should definitely consider
2329 \begin_inset Flex Code
2332 \begin_layout Plain Layout
2338 , which exceeds all other packages in terms of features, but is also quite
2339 heavy and more resource-hungry.
2342 \begin_layout Standard
2343 The handling of these packages in \SpecialChar LyX
2344 is basically the same.
2346 \begin_inset Flex Noun
2349 \begin_layout Plain Layout
2350 Document\SpecialChar menuseparator
2357 \begin_inset Flex Noun
2360 \begin_layout Plain Layout
2367 \begin_inset Flex Noun
2370 \begin_layout Plain Layout
2377 \begin_inset Flex Noun
2380 \begin_layout Plain Layout
2387 \begin_inset Flex Noun
2390 \begin_layout Plain Layout
2391 Biblatex (Natbib mode)
2397 \begin_inset Flex Noun
2400 \begin_layout Plain Layout
2407 \begin_inset Flex Noun
2410 \begin_layout Plain Layout
2417 \begin_inset space ~
2420 6.5.3 in the User's Guide for more information on these choices).
2421 With all these packages, you will get some extra features in the citation
2422 dialog and you can select the style of the reference (
2423 \begin_inset Quotes eld
2427 \begin_inset Quotes erd
2431 \begin_inset Quotes eld
2435 \begin_inset Quotes erd
2439 \begin_inset Quotes eld
2443 \begin_inset Quotes erd
2447 \begin_inset Quotes eld
2451 \begin_inset Quotes erd
2455 Note that either package needs specifically designed style files.
2456 They all ship their own, but there are lots of additional style files,
2457 and there is even an interactive style file builder
2461 \begin_layout Plain Layout
2463 \begin_inset Flex URL
2466 \begin_layout Plain Layout
2468 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2479 \begin_inset Flex Code
2482 \begin_layout Plain Layout
2491 \begin_layout Subsection
2492 Subdivided Bibliographies
2495 \begin_layout Standard
2496 Sometimes you might need to divide your bibliography into several sections.
2497 If you are for instance a historian, the possibility to separate sources
2498 and scientific works is most likely a
2499 \begin_inset Quotes eld
2503 \begin_inset Quotes erd
2507 Unfortunately, Bib\SpecialChar TeX
2508 itself does not allow you to do this.
2509 But with the help of some \SpecialChar LaTeX
2510 packages, Bib\SpecialChar TeX
2511 can be extended to fit your needs.
2514 \begin_layout Standard
2516 provides native support for one of these packages,
2524 \begin_layout Plain Layout
2526 \begin_inset Flex URL
2529 \begin_layout Plain Layout
2531 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2541 The advantage of this package (compared to other packages such as
2545 ) is that you don't need to define new citation commands.
2546 Instead, you need to prepare different bibliographic databases which include
2547 the entries for the different sections of the bibliography.
2548 For example: If you want to divide your bibliography into the sections
2550 \begin_inset Quotes eld
2554 \begin_inset Quotes erd
2558 \begin_inset Quotes eld
2562 \begin_inset Quotes erd
2565 , you first need to create two bibliographic databases, e.
2566 \begin_inset space \thinspace{}
2570 \begin_inset space \space{}
2574 \begin_inset Flex Code
2577 \begin_layout Plain Layout
2584 \begin_inset Flex Code
2587 \begin_layout Plain Layout
2597 \begin_layout Standard
2599 \begin_inset Flex Noun
2602 \begin_layout Plain Layout
2603 Document\SpecialChar menuseparator
2610 \begin_inset Flex Noun
2613 \begin_layout Plain Layout
2620 \begin_inset Flex Noun
2623 \begin_layout Plain Layout
2624 Subdivided bibliography
2630 Now you can insert multiple Bib\SpecialChar TeX
2631 bibliographies, one for each section of
2633 Returning to our example: Insert the Bib\SpecialChar TeX
2635 \begin_inset Flex Code
2638 \begin_layout Plain Layout
2644 and a second one for the database
2645 \begin_inset Flex Code
2648 \begin_layout Plain Layout
2655 You are free to use the same or different styles for each section.
2656 Additionally, you can choose if the bibliography section should contain
2658 \begin_inset Quotes eld
2661 all cited references
2662 \begin_inset Quotes erd
2665 of the specified database(s) (which is the default),
2666 \begin_inset Quotes eld
2669 all uncited references
2670 \begin_inset Quotes erd
2674 \begin_inset Quotes eld
2678 \begin_inset Quotes erd
2682 This might be useful if you would like to separate your bibliography into
2684 \begin_inset Quotes eld
2688 \begin_inset Quotes erd
2692 \begin_inset Quotes eld
2696 \begin_inset Quotes erd
2700 \begin_inset Quotes eld
2704 \begin_inset Quotes erd
2708 The titles for the sections can be added as ordinary sections or subsections.
2710 \begin_inset Flex Code
2713 \begin_layout Plain Layout
2719 removes the bibliography title, you have to manually re-add that, too (as
2720 a chapter* or section*, for instance).
2723 \begin_layout Standard
2728 , the procedure is a bit different.
2737 , the aforementioned
2738 \begin_inset Flex Noun
2741 \begin_layout Plain Layout
2742 Subdivided bibliography
2747 option is disabled if you use
2756 provides its own means to generate subdivided bibliographies.
2757 You can either add keywords to bibliography entries via the
2758 \begin_inset Flex Code
2761 \begin_layout Plain Layout
2767 entry option and then filter bibliography sections by keyword (by adding
2769 \begin_inset Flex Code
2772 \begin_layout Plain Layout
2779 \begin_inset Flex Noun
2782 \begin_layout Plain Layout
2788 field of the dialog that opens if you right-click on the
2789 \begin_inset Flex Noun
2792 \begin_layout Plain Layout
2793 Biblatex Generated Bibliography
2798 button), or you can filter by entry types (such as
2807 \begin_inset space \thinspace{}
2812 \begin_inset Flex Code
2815 \begin_layout Plain Layout
2822 \begin_inset Flex Code
2825 \begin_layout Plain Layout
2832 \begin_inset Flex Noun
2835 \begin_layout Plain Layout
2841 field, or you can create so-called
2842 \begin_inset Quotes eld
2845 Bibliography Categories
2846 \begin_inset Quotes erd
2849 to which you can assign individual entries.
2850 Please refer to the Biblatex manual, section
2852 Subdivided Bibliographies
2857 \begin_layout Subsection
2858 Multiple Bibliographies
2861 \begin_layout Standard
2862 Multiple bibliographies, e.
2863 \begin_inset space \thinspace{}
2867 \begin_inset space \space{}
2870 a bibliography for each part, chapter, section, subsection or child (sub-documen
2871 t) of the document, are also supported by \SpecialChar LyX
2873 In order to enable it, go to
2874 \begin_inset Flex Noun
2877 \begin_layout Plain Layout
2878 Document\SpecialChar menuseparator
2879 Settings\SpecialChar menuseparator
2885 and select the relevant unit (e.
2886 \begin_inset space \thinspace{}
2890 \begin_inset Quotes eld
2894 \begin_inset Quotes erd
2898 \begin_inset Flex Noun
2901 \begin_layout Plain Layout
2902 Multiple Bibliographies
2908 Then add a Bib(la)\SpecialChar TeX
2909 bibliography to each unit (e.
2910 \begin_inset space \thinspace{}
2913 g., section) of your document.
2914 In the output, a separate bibliography, containing only the references
2915 done in the current unit is generated.
2918 \begin_layout Standard
2919 If you use Bib\SpecialChar TeX
2921 \begin_inset Flex Code
2924 \begin_layout Plain Layout
2931 \change_deleted -712698321 1501067466
2933 \change_inserted -712698321 1501067466
2937 \begin_inset Flex Code
2940 \begin_layout Plain Layout
2946 package is used to create multiple bibliographies.
2947 The former package is used if you select
2948 \begin_inset Quotes eld
2952 \begin_inset Quotes erd
2960 \begin_inset Flex Noun
2963 \begin_layout Plain Layout
2964 Sectioned Bibliography
2971 \begin_inset Flex Code
2974 \begin_layout Plain Layout
2984 \begin_layout Plain Layout
2985 An alternative approach, if you are willing to use some
2986 \begin_inset Flex Noun
2989 \begin_layout Plain Layout
2997 \begin_inset space ~
3001 \begin_inset CommandInset ref
3003 reference "sec:Inserting-TeX-Code"
3008 \begin_inset Flex Code
3011 \begin_layout Plain Layout
3023 \begin_inset Flex Code
3026 \begin_layout Plain Layout
3032 is used, \SpecialChar LyX
3033 encloses the specified units in
3034 \begin_inset Flex Code
3037 \begin_layout Plain Layout
3044 \begin_inset Flex Code
3047 \begin_layout Plain Layout
3056 \begin_inset Flex Code
3059 \begin_layout Plain Layout
3067 in order to create the units.
3068 Note that this approach has some limitations.
3069 First, every citation reference has to be inside some
3070 \begin_inset Flex Code
3073 \begin_layout Plain Layout
3080 So citations outside a defined unit (e.
3081 \begin_inset space \thinspace{}
3084 g., before the first section if you use
3085 \begin_inset Quotes eld
3089 \begin_inset Quotes erd
3093 \begin_inset Quotes eld
3097 \begin_inset Quotes erd
3101 You can also create your own units by entering
3102 \begin_inset Flex Code
3105 \begin_layout Plain Layout
3114 \begin_inset Flex Code
3117 \begin_layout Plain Layout
3126 code (for instance to work around the mentioned limitation).
3128 \begin_inset Flex Code
3131 \begin_layout Plain Layout
3138 A second limitation is that
3139 \begin_inset Flex Code
3142 \begin_layout Plain Layout
3148 always processes all references of a bibliography database, even if they
3150 This can result in odd labels (e.
3151 \begin_inset space \thinspace{}
3156 \begin_inset Quotes eld
3160 \begin_inset Quotes erd
3163 if two works of this author from 2014 are in the database, even if only
3167 \begin_layout Standard
3173 \begin_inset Flex Code
3176 \begin_layout Plain Layout
3182 option is used instead.
3183 If you need specific units, you can start them with the \SpecialChar TeX
3185 \begin_inset Flex Code
3188 \begin_layout Plain Layout
3197 \begin_inset Flex Code
3200 \begin_layout Plain Layout
3209 If you also want to control the end of the unit, use the environment
3210 \begin_inset Flex Code
3213 \begin_layout Plain Layout
3223 \begin_inset Flex Code
3226 \begin_layout Plain Layout
3236 \begin_inset Flex Code
3239 \begin_layout Plain Layout
3246 In addition to the individual bibliography of the current unit,
3250 also provides an easy way to output all bibliographies, subsequently, at
3252 \begin_inset space \thinspace{}
3255 g., at the end of the document).
3257 \begin_inset Quotes eld
3261 \begin_inset Quotes erd
3264 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3270 manual for more information on this topic.
3273 \begin_layout Section
3277 \begin_layout Subsection
3281 \begin_layout Standard
3282 When you are working on a large file with many sections, it is often convenient
3283 to break up the document into several files, or perhaps you have something
3284 where a table may change from time to time, but the preceding text does
3286 In these cases, you should seriously consider using multipart documents.
3287 For example, scientific papers often have five major sections: the introduction
3288 , observations, results, discussion, and conclusion.
3289 Each of these could be its own separate \SpecialChar LyX
3291 \begin_inset Quotes eld
3295 \begin_inset Quotes erd
3298 file which contains the title, authors, abstract, references, etc., plus
3299 the five included files.
3300 It is important to note that each of these files is a full \SpecialChar LyX
3302 can be formatted and printed on its own, as well as included in a master
3304 Each of these files must have the same document class, however—don't attempt
3305 to mix book classes with article classes.
3306 You may also include \SpecialChar LaTeX
3307 files; however, these files must not have their own
3309 \begin_inset space \thinspace{}
3313 \begin_inset space \space{}
3316 everything up to and including the
3317 \begin_inset Flex Code
3320 \begin_layout Plain Layout
3329 \begin_inset Flex Code
3332 \begin_layout Plain Layout
3340 line must be deleted) or else errors will be generated when you try to
3344 \begin_layout Standard
3346 allows you to include files quite easily with
3347 \begin_inset Flex Noun
3350 \begin_layout Plain Layout
3351 Insert\SpecialChar menuseparator
3353 \begin_inset space ~
3362 When you click on this selection a small box is inserted into the file
3363 at the current cursor location.
3364 Clicking on the box raises a dialog which allows you to select the file
3365 to be included, and the method of its inclusion.
3369 \begin_layout Standard
3370 The file selection box should by now be obvious.
3371 The three inclusion methods are
3372 \begin_inset Quotes eld
3376 \begin_inset Quotes erd
3380 \begin_inset Quotes eld
3384 \begin_inset Quotes erd
3388 \begin_inset Quotes eld
3392 \begin_inset Quotes erd
3396 The difference between
3397 \begin_inset Quotes eld
3401 \begin_inset Quotes erd
3405 \begin_inset Quotes eld
3409 \begin_inset Quotes erd
3412 is really only meaningful to \SpecialChar LaTeX
3413 perts, but the practical difference is that
3415 \begin_inset Quotes eld
3419 \begin_inset Quotes erd
3422 are typeset beginning on a new page, while files that are
3423 \begin_inset Quotes eld
3427 \begin_inset Quotes erd
3430 are typeset starting on the current page.
3433 \begin_layout Standard
3434 Generally, the master file is converted into a full \SpecialChar LaTeX
3435 file before typesetting,
3436 while the included files are converted to \SpecialChar LaTeX
3437 files that do not have all the
3438 preamble information.
3441 \begin_layout Standard
3443 \begin_inset Quotes eld
3447 \begin_inset Quotes erd
3450 included file allows you to include a file typeset exactly as it appears
3452 \begin_inset space \thinspace{}
3456 \begin_inset space \space{}
3460 \begin_inset Flex Code
3463 \begin_layout Plain Layout
3469 mode, with the characters set in a fixed-width typewriter font.
3470 Normally, spaces in this file are invisible, though two consecutive spaces
3471 are conserved, unlike \SpecialChar LyX
3472 's normal treatment of spaces.
3473 However, setting the
3474 \begin_inset Flex Noun
3477 \begin_layout Plain Layout
3479 \begin_inset space ~
3483 \begin_inset space ~
3487 \begin_inset space ~
3495 checkbox typesets a mark to unambiguously define the presence of a space.
3499 \begin_layout Subsection
3500 Cross-References Between Files
3503 \begin_layout Standard
3504 \begin_inset Box Shadowbox
3514 height_special "totalheight"
3519 backgroundcolor "none"
3522 \begin_layout Plain Layout
3523 This section is somewhat out of date.
3524 Need to describe default master documents and how children are opened when
3534 \begin_layout Standard
3535 It is possible to set up cross-references between the different files.
3536 First, open all the files in question: let's call them A and B in a two
3537 file example, where B is included in A.
3538 Let's say you insert a label in A, then want to reference it in B.
3539 Open the cross-reference dialog whilst in document B, and you can select
3541 \begin_inset Quotes eld
3545 \begin_inset Quotes erd
3551 \begin_layout Subsection
3552 Bibliography Lists in all Subdocuments
3555 \begin_layout Standard
3556 \begin_inset Box Frameless
3566 height_special "totalheight"
3571 backgroundcolor "none"
3574 \begin_layout Plain Layout
3575 This section also needs updating.
3576 There is now material about this on the wiki, and it could be copied here.
3584 \begin_layout Standard
3585 Copy the bibliography list with all entries to all subdocuments and transform
3587 This way \SpecialChar LyX
3589 \begin_inset Flex Code
3592 \begin_layout Plain Layout
3598 -files and you can easily insert references without making the bibliography
3602 \begin_layout Standard
3603 As the bibliography list is in a comment, \SpecialChar LaTeX
3604 won't use it and the references
3605 will look like this: [?], instead of like this: [1].
3606 One solution is to use the \SpecialChar LaTeX
3608 \begin_inset Flex Code
3611 \begin_layout Plain Layout
3617 that will only include comments by processing the files separately.
3618 To do this, add in the \SpecialChar LaTeX
3619 preamble of every subdocument the following:
3622 \begin_layout LyX-Code
3628 \begin_layout LyX-Code
3631 includecomment{comment}
3634 \begin_layout Standard
3636 \begin_inset Flex URL
3639 \begin_layout Plain Layout
3641 http://wiki.lyx.org/FAQ/Unsorted#toc31
3649 \begin_layout Section
3654 \begin_layout Standard
3655 Users sometimes need to be able to
3656 \begin_inset Quotes eld
3660 \begin_inset Quotes erd
3664 file together with all the images (and other files) on which it depends,
3665 either for sending to a publisher or for sharing with a co-author.
3667 2.0 includes a Python script (
3668 \begin_inset Flex Code
3671 \begin_layout Plain Layout
3677 ) that automates this process.
3678 To use it, you must have either the
3679 \begin_inset Flex Code
3682 \begin_layout Plain Layout
3689 \begin_inset Flex Code
3692 \begin_layout Plain Layout
3698 python modules installed on your system.
3699 By default, the script prefers the
3700 \begin_inset Flex Code
3703 \begin_layout Plain Layout
3710 \begin_inset Flex Code
3713 \begin_layout Plain Layout
3719 format on Unix-like systems and the
3720 \begin_inset Flex Code
3723 \begin_layout Plain Layout
3732 \begin_layout Standard
3734 's configuration process will set the script up to export a `\SpecialChar LyX
3736 and this format will then be available under
3737 \begin_inset Flex Code
3740 \begin_layout Plain Layout
3741 File\SpecialChar menuseparator
3750 \begin_layout Standard
3751 Independently of the platform, the generation of a particular archive format
3752 can be forced by adding either the
3753 \begin_inset Flex Code
3756 \begin_layout Plain Layout
3763 \begin_inset Flex Code
3766 \begin_layout Plain Layout
3773 \begin_inset Flex Code
3776 \begin_layout Plain Layout
3783 \begin_inset Flex Code
3786 \begin_layout Plain Layout
3792 format) switch to the
3793 \begin_inset Flex Code
3796 \begin_layout Plain Layout
3798 \SpecialChar menuseparator
3806 \begin_inset Flex Code
3809 \begin_layout Plain Layout
3810 Tools\SpecialChar menuseparator
3811 Preferences\SpecialChar menuseparator
3812 File Handling\SpecialChar menuseparator
3819 (Make sure you add the switch after the script name, not before it.)
3822 \begin_layout Section
3823 Fancy Headers and Footers
3826 \begin_layout Standard
3827 The default page layout is rather plain; for an
3828 \begin_inset Flex Code
3831 \begin_layout Plain Layout
3837 document class, all you get is a centered page number at the bottom of
3839 This document uses KOMA-script's book class, so it appears to be a bit
3841 But to really put on a show, you need to set the document page style to
3843 \begin_inset Quotes eld
3847 \begin_inset Quotes erd
3850 , as mentioned in the
3855 This section describes the \SpecialChar LaTeX
3856 code you need to insert in your \SpecialChar LaTeX
3858 order to get the desired effects.
3861 \begin_layout Standard
3862 For more information on fancy headers, see the
3863 \begin_inset Flex Code
3866 \begin_layout Plain Layout
3872 package documentation.
3874 \begin_inset Flex URL
3877 \begin_layout Plain Layout
3879 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3887 \begin_layout Standard
3888 The page header is divided into three fields, not surprisingly labeled
3889 \begin_inset Quotes eld
3893 \begin_inset Quotes erd
3897 \begin_inset Quotes eld
3901 \begin_inset Quotes erd
3905 \begin_inset Quotes eld
3909 \begin_inset Quotes erd
3913 The footer is also divided into these three fields.
3914 The \SpecialChar LaTeX
3915 commands to set these fields in the simplest manner are
3916 \begin_inset Flex Code
3919 \begin_layout Plain Layout
3928 \begin_inset Flex Code
3931 \begin_layout Plain Layout
3940 \begin_inset Flex Code
3943 \begin_layout Plain Layout
3952 \begin_inset Flex Code
3955 \begin_layout Plain Layout
3964 Suppose you wish to put your name in the upper left hand corner of each
3966 Simply insert the following command in the preamble:
3969 \begin_layout Standard
3978 \begin_layout Standard
3979 You will now see your name in the upper left.
3980 If a field has a default entry that you would like to get rid of (often
3981 the page number appears in the central footer) simply include a command
3982 with a blank argument, e.
3983 \begin_inset space \thinspace{}
3989 \begin_layout Standard
3997 \begin_layout Standard
3998 Let's get really fancy: lets put the section number with the word
3999 \begin_inset Quotes eld
4003 \begin_inset Quotes erd
4007 \begin_inset space \thinspace{}
4011 \begin_inset space \space{}
4014 Section 3) in the upper left, the page number (e.
4015 \begin_inset space \thinspace{}
4019 \begin_inset space \space{}
4022 Page 4) in the upper right, your name in the lower left, and the date in
4024 The following commands should now appear in the preamble:
4027 \begin_layout Standard
4037 \begin_layout Standard
4045 \begin_layout Standard
4055 \begin_layout Standard
4064 \begin_layout Standard
4072 \begin_layout Standard
4082 \begin_layout Standard
4084 \begin_inset Flex Code
4087 \begin_layout Plain Layout
4096 \begin_inset Flex Code
4099 \begin_layout Plain Layout
4107 access \SpecialChar LaTeX
4108 's section and page counters, and so print out the current section
4111 \begin_inset Flex Code
4114 \begin_layout Plain Layout
4122 simply prints out today's date.
4125 \begin_layout Standard
4126 The thicknesses of the horizontal rules drawn beneath the header and above
4127 the footer can also be modified.
4128 If you don't want one of the rules, set its thickness to 0.
4129 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4135 \begin_inset Flex Code
4138 \begin_layout Plain Layout
4143 headrulewidth}{0.4pt}
4149 \begin_inset Flex Code
4152 \begin_layout Plain Layout
4157 footrulewidth}{0.4pt}
4162 to set the thicknesses.
4165 \begin_layout Standard
4166 You can switch the header/footer settings on and off for individual pages
4168 \begin_inset Flex Code
4171 \begin_layout Plain Layout
4174 thispagestyle{empty}
4180 \begin_inset Flex Code
4183 \begin_layout Plain Layout
4186 thispagestyle{plain}
4192 \begin_inset Flex Code
4195 \begin_layout Plain Layout
4198 thispagestyle{fancy}
4204 Simply insert them in the text on the page you want changed and mark them
4207 In fact, title pages are marked as plain by default, while following pages
4208 are marked fancy when using the global fancy setting.
4211 \begin_layout Standard
4212 As a final example, it is possible to include an image in the header or
4214 Suppose you want to put a company logo in the upper lefthand corner.
4215 You might try something like
4218 \begin_layout Standard
4227 includegraphics{logo.eps}}}
4230 \begin_layout Standard
4232 (you may need to preface this with
4233 \begin_inset Flex Code
4236 \begin_layout Plain Layout
4240 usepackage{graphics}
4245 if you don't include graphics elsewhere in your document).
4248 \begin_layout Section
4249 Itemize Bullet Selection
4250 \begin_inset CommandInset label
4259 \begin_layout Standard
4265 \begin_layout Subsection
4269 \begin_layout Standard
4271 provides 216 bullet shapes that can be accessed from a simple dialog.
4272 Using this dialog you can easily specify what bullet shape to use at each
4273 level of an itemized list.
4274 These settings are document-wide so you won't be able to specify different
4275 sets of bullets for different paragraphs.
4279 \begin_layout Plain Layout
4280 Well, actually you can but you'll have to do it by hand.
4288 \begin_layout Subsection
4292 \begin_layout Standard
4293 Open the dialog by selecting the
4294 \begin_inset Flex Noun
4297 \begin_layout Plain Layout
4298 Document\SpecialChar menuseparator
4304 menu item and then select the
4305 \begin_inset Flex Noun
4308 \begin_layout Plain Layout
4317 \begin_layout Standard
4318 The dialog provides you with a table of bullet shapes.
4319 A column of buttons on the left of the table provides access to the six
4320 different panels of bullet shapes.
4321 The row of buttons across the top is used to select which bullet depth
4323 A text entry under the table shows the currently selected bullet shape's
4325 equivalent and this can be edited if desired.
4326 If you do modify the text you will also need to specify any needed packages
4327 in the \SpecialChar LaTeX
4331 \begin_layout Standard
4332 The six panels are divided up by the packages they require.
4333 The following table shows the mappings from button name to \SpecialChar LaTeX
4337 \begin_layout Standard
4339 \begin_inset Tabular
4340 <lyxtabular version="3" rows="7" columns="2">
4341 <features tabularvalignment="middle">
4342 <column alignment="center" valignment="top" width="0pt">
4343 <column alignment="center" valignment="top" width="0pt">
4345 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4348 \begin_layout Plain Layout
4363 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4366 \begin_layout Plain Layout
4383 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4386 \begin_layout Plain Layout
4401 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4404 \begin_layout Plain Layout
4413 base \SpecialChar LaTeX
4421 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4424 \begin_layout Plain Layout
4439 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4442 \begin_layout Plain Layout
4459 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4462 \begin_layout Plain Layout
4477 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4480 \begin_layout Plain Layout
4497 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4500 \begin_layout Plain Layout
4515 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4518 \begin_layout Plain Layout
4535 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4538 \begin_layout Plain Layout
4553 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4556 \begin_layout Plain Layout
4573 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4576 \begin_layout Plain Layout
4591 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4594 \begin_layout Plain Layout
4617 \begin_layout Standard
4619 doesn't stop you using bullets from packages you don't have.
4620 If you get errors from \SpecialChar LaTeX
4621 when you try to view or print the file, then it
4622 is likely you are missing a package.
4626 \begin_layout Plain Layout
4628 doesn't restrict your use since you may be editing locally and exporting
4637 \begin_layout Subsection
4641 \begin_layout Standard
4642 Select which bullet depth you want to change then select the bullet shape
4644 Any changes will not be visible in \SpecialChar LyX
4645 , but are visible when viewing the document.
4648 \begin_layout Standard
4649 You can reset a bullet shape to the default simply by clicking your right
4650 mouse button on the appropriate bullet depth button.
4654 \begin_layout Plain Layout
4659 want to have multiple sets of paragraphs with different sets of bullets
4660 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4662 The bullet selection dialog can help though because it provides you with
4663 the \SpecialChar LaTeX
4664 code for a wide range of bullet shapes.
4665 To make your own custom paragraphs you have the following options:
4668 \begin_layout Plain Layout
4672 \begin_layout Plain Layout
4688 \begin_layout Plain Layout
4692 \begin_layout Plain Layout
4714 \begin_layout Itemize
4715 Use the \SpecialChar LaTeX
4717 \begin_inset Flex Code
4720 \begin_layout Plain Layout
4728 to specify a new bullet shape for a given depth.
4729 You'll also need to save the current bullet shape so you can restore it
4731 In this itemized list the following \SpecialChar LaTeX
4732 code was used to change the bullet
4733 used for the first depth.
4737 \begin_layout LyX-Code
4747 \begin_layout LyX-Code
4764 \begin_layout Itemize
4765 Note that the itemize depth is specified in Roman numerals as part of the
4775 \begin_layout Itemize
4779 \begin_layout Plain Layout
4792 Specify each individual entry by starting each item with the bullet shape
4793 enclosed in square brackets and set as
4794 \begin_inset Flex Noun
4797 \begin_layout Plain Layout
4805 For example, this item was started with
4806 \begin_inset Flex Code
4809 \begin_layout Plain Layout
4824 \begin_layout Plain Layout
4828 \begin_layout Plain Layout
4844 \begin_layout Plain Layout
4845 You'll also need to revert the labelitem back to its previous setting for
4846 the global bullet shape settings to remain in effect.
4847 The way used here was:
4850 \begin_layout LyX-Code
4865 \begin_layout Chapter
4867 and the World Wide Web
4870 \begin_layout Standard
4872 has long supported the export of documents to various web-friendly formats,
4874 Before verson 2.0, however, HTML export was always accomplished by the use
4875 of external converters.
4879 \begin_layout Plain Layout
4880 For details on the use of external converters with \SpecialChar LyX
4885 section of the Customization manual.
4890 These fall into two large groups: there are converters that use \SpecialChar LaTeX
4892 intermediate format, such as
4893 \begin_inset Flex Code
4896 \begin_layout Plain Layout
4903 \begin_inset Flex Code
4906 \begin_layout Plain Layout
4913 \begin_inset Flex Code
4916 \begin_layout Plain Layout
4922 , relying upon \SpecialChar LyX
4923 to produce the \SpecialChar LaTeX
4924 ; and there is a converter that works directly
4927 \begin_inset Flex Code
4930 \begin_layout Plain Layout
4938 All of these have different advantages and disadvantages.
4942 \begin_layout Standard
4943 The \SpecialChar LaTeX
4944 -based converters have the advantage that, in principle, they know everythin
4945 g about the exported document that \SpecialChar LaTeX
4947 Such converters do not care, for example, if a certain block of code was
4948 produced by \SpecialChar LyX
4949 or was Evil Red Text.
4950 These converters know about
4951 \begin_inset Flex Code
4954 \begin_layout Plain Layout
4960 files, counters, and references, and can often make use of the
4961 \begin_inset Flex Code
4964 \begin_layout Plain Layout
4970 files generated by Bib\SpecialChar TeX
4972 On the other hand, \SpecialChar LaTeX
4973 is a very hard language to parse—it is sometimes said
4974 that only \SpecialChar TeX
4975 itself understands \SpecialChar TeX
4976 —and \SpecialChar LaTeX
4977 -based converters will often choke on
4978 what seem to be quite simple constructs; complex ones can throw them completely
4979 , and as of this writing, for example, the
4983 manual will not export with
4984 \begin_inset Flex Code
4987 \begin_layout Plain Layout
4993 , though the others will.
4994 The other issue concerns how math is handled.
4995 These converters typically convert the formulae into little pictures that
4996 are then linked from the HTML document.
4997 Since these are actually generated by \SpecialChar LaTeX
4998 , they are accurate.
4999 But they do not scale well, and just getting them to look as if they are
5000 actually meant to be in your document—so that the font sizes seem to be
5001 roughly the same—can be a challenge.
5004 \begin_layout Standard
5006 \begin_inset Flex Code
5009 \begin_layout Plain Layout
5017 \begin_inset CommandInset href
5019 name "http://elyxer.nongnu.org/"
5020 target "http://elyxer.nongnu.org/"
5025 ) solves some of these problems.
5026 In particular, the formulae it produces scale perfectly, since it renders
5027 math using a combination of HTML and CSS rather than converting the formulae
5029 But even moderately complex formula are rendered less well than with
5030 \begin_inset Flex Code
5033 \begin_layout Plain Layout
5039 ; this reflects the limitations of HTML.
5043 \begin_layout Plain Layout
5045 \begin_inset Flex Code
5048 \begin_layout Plain Layout
5055 can also use jsMath and MathJax for equations, but this setting is only
5056 available globally and requires one to have access to a server that runs
5062 More importantly (as of version 1.1.1, at least),
5063 \begin_inset Flex Code
5066 \begin_layout Plain Layout
5073 has limited support for math macros and no support for user-defined paragraph
5074 or character styles.
5075 These limitations make
5076 \begin_inset Flex Code
5079 \begin_layout Plain Layout
5086 unsuitable for many of the documents \SpecialChar LyX
5088 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5090 have decided to follow a different path and have made \SpecialChar LyX
5092 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5093 , DocBook, and plaintext.
5096 \begin_layout Standard
5097 As of this writing, XHTML output remains under development and should probably
5099 \begin_inset Quotes eld
5103 \begin_inset Quotes erd
5110 \begin_layout Plain Layout
5112 \begin_inset Flex Code
5115 \begin_layout Plain Layout
5116 development/HTML.notes
5121 , which can be found in the \SpecialChar LyX
5123 \begin_inset CommandInset href
5125 name "accessed online"
5126 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5131 , usually contains up-to-date information about the state of XHTML output.
5132 See also the list of XHTML bugs on
5133 \begin_inset CommandInset href
5135 name "the bug tracker"
5136 target "http://www.lyx.org/trac/query?status=reopened&status=assigned&status=new&max=0&component=xhtml+export&order=id&col=id&col=summary&col=reporter&col=keywords&keywords=%21%7Efixedintrunk&desc=1"
5146 Still, the developers have chosen this approach because it has several
5147 potential advantages over the other two.
5150 \begin_layout Standard
5151 These advantages are primarily due to the fact that the XHTML output routines,
5152 since they are part of \SpecialChar LyX
5153 , know everything \SpecialChar LyX
5154 knows about the document being
5159 \begin_layout Plain Layout
5160 Another advantage is that, since these routines are internal to \SpecialChar LyX
5162 immune to changes in \SpecialChar LyX
5163 's file format, or to changes in the semantics of
5169 So they know about the table of contents (as displayed in the outline),
5170 about the counters associated with different paragraph styles, and about
5171 user-defined styles.
5172 The XHTML output routines know what \SpecialChar LyX
5173 knows about internationalization,
5174 too, so they will output
5175 \begin_inset Quotes eld
5179 \begin_inset Quotes erd
5183 \begin_inset Quotes eld
5191 \begin_inset Quotes erd
5194 , depending upon the language in effect at the time.
5198 \begin_layout Standard
5199 Quite generally, the output routines know what \SpecialChar LyX
5200 knows about document layout,
5201 that is, about how the document is to be rendered on screen.
5202 We use this information when we output the document as XHTML.
5203 In particular, \SpecialChar LyX
5208 generates CSS style information corresponding to the layout information
5209 it uses to render the document on screen: if section headings are supposed
5210 to be sans-serif and bold as seen in \SpecialChar LyX
5211 , then (by default) they will be sans-seri
5212 f and bold when viewed in a web browser, too.
5213 And this is true not just for pre-defined styles, like Section, but for
5214 any style, including user-defined styles.
5215 Indeed, the XHTML output routines make no distinction between user-defined
5216 paragraph and character styles and \SpecialChar LyX
5217 's own pre-defined styles: in each case,
5218 everything \SpecialChar LyX
5219 knows about the styles is contained in the layout files.
5220 And much the same is true as regards pre-defined textual insets, such as
5221 footnotes, and various custom insets.
5225 \begin_layout Standard
5226 The result is that XHTML output can be customized and extended in exactly
5227 the same way \SpecialChar LaTeX
5228 output can be customized and extended: through layout files
5230 See chapter five of the
5234 manual for the details.
5237 \begin_layout Standard
5238 The remainder of this chapter contains more detailed information on XHTML
5239 output, its limitations, and ways to work around those limitations.
5242 \begin_layout Section
5243 Math Output in XHTML
5246 \begin_layout Standard
5248 offers four choices for how math is rendered.
5249 These have various advantages and disadvantages:
5252 \begin_layout Itemize
5254 \begin_inset Newline newline
5257 MathML is a dialect of XML designed specifically for mathematics on the
5258 web, and it typically renders very well in browsers that support it.
5259 The disadvantage is that not all browsers support MathML, and support is
5260 not complete even in the Gecko-based browsers, such as Firefox.
5261 \begin_inset Newline newline
5265 is unable to render a formula as MathML—for example, if the formula
5267 \begin_inset Flex Code
5270 \begin_layout Plain Layout
5276 package or ERT—then it will instead output the formula as an image.
5280 \begin_layout Itemize
5282 \begin_inset Newline newline
5286 \begin_inset Flex Code
5289 \begin_layout Plain Layout
5295 outputs math as HTML, styled by CSS.
5299 \begin_layout Plain Layout
5301 has borrowed some of the CSS for its HTML output from
5302 \begin_inset Flex Code
5305 \begin_layout Plain Layout
5316 For simple formulae, this can work quite well, though with more complicated
5317 formulae it tends to break down.
5318 Still, this method has the advantage that it is very widely supported and
5319 so it may be appropriate for documents that contain only a little, fairly
5321 \begin_inset Newline newline
5324 If Lyx is unable to render a formula as HTML—for example, if the formula
5326 \begin_inset Flex Code
5329 \begin_layout Plain Layout
5335 package or ERT—then it will instead output the formula as an image.
5339 \begin_layout Itemize
5341 \begin_inset Newline newline
5345 \begin_inset Flex Code
5348 \begin_layout Plain Layout
5355 will output formulae as images, the very same images, in fact, that are
5356 used for instant preview.
5360 \begin_layout Plain Layout
5361 Instant preview does
5365 have to be on for images to be output, however.
5370 The advantage to this method is that the images are simply generated by
5372 , so they are very accurate.
5373 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5374 so they do not scale terribly well, and one cannot copy them, etc.
5375 (As of this writing, there are also problems about equation numbering.
5377 \begin_inset CommandInset href
5380 target "http://www.lyx.org/trac/ticket/6894"
5386 \begin_inset Newline newline
5389 The size of the images can be controlled by setting the
5390 \begin_inset Quotes eld
5394 \begin_inset Quotes erd
5398 \begin_inset Flex Noun
5401 \begin_layout Plain Layout
5402 Document\SpecialChar menuseparator
5403 Settings\SpecialChar menuseparator
5413 \begin_layout Plain Layout
5414 For those who want to know, this controls the resolution of the image in
5415 dots per inch and is based upon a default of 75 dpi.
5421 \begin_inset Newline newline
5425 for some reason fails to create an image for a formula (e.g., if a required
5427 package is not installed), then it will fall back to outputing the raw
5432 \begin_layout Itemize
5435 \begin_inset Newline newline
5438 Finally, \SpecialChar LyX
5439 will happily output math as \SpecialChar LaTeX
5441 As well as being the output of last resort, this method can be used with
5443 \begin_inset CommandInset href
5446 target "http://www.math.union.edu/~dpvc/jsMath/"
5451 , which uses JavaScript to render \SpecialChar LaTeX
5452 embedded in HTML documents.
5454 wraps the \SpecialChar LaTeX
5456 \begin_inset Flex Code
5459 \begin_layout Plain Layout
5465 (for inline formulas) or
5466 \begin_inset Flex Code
5469 \begin_layout Plain Layout
5475 (for displayed formulas) with
5476 \begin_inset Flex Code
5479 \begin_layout Plain Layout
5485 , as is required for jsMath.
5488 \begin_layout Standard
5489 One of these output methods must be selected under
5490 \begin_inset Flex Noun
5493 \begin_layout Plain Layout
5494 Document\SpecialChar menuseparator
5495 Settings\SpecialChar menuseparator
5502 By default, \SpecialChar LyX
5504 This is a document-wide setting, therefore.
5507 \begin_layout Standard
5508 Eventually, \SpecialChar LyX
5509 will offer the user the option to select an alternate output
5510 method for a particular inset, say, one that isn't being rendered very
5515 \begin_layout Plain Layout
5516 That said, since \SpecialChar LyX
5517 falls back to images if the inset contains ERT, then one
5518 can force output as an image by putting some harmless ERT into the math,
5520 \begin_inset Formula $a=b\relax$
5531 \begin_layout Section
5532 Bibliography and Citations
5535 \begin_layout Standard
5536 XHTML output fully supports bibliographies and citations.
5540 \begin_layout Standard
5541 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5543 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5546 If you are using numerical citations, then \SpecialChar LyX
5547 will output numerical labels,
5548 such as [1] or [17], rather than simply showing the citation key in square
5549 brackets, as it does on-screen.
5550 If you are using author-year citations, then \SpecialChar LyX
5551 will add lowercase letters
5552 to the years, just as Bib\SpecialChar TeX
5553 does, if it finds more than one citation for
5554 a given author-year combination.
5555 The labels will be printed with the bibliography entries.
5556 Note that there is, at present, no way to customize the appearance of the
5557 labels, for example, to choose between square brackets and parentheses.
5560 \begin_layout Standard
5561 Bibliography output is handled by the same machinery that handles the presentati
5562 on of reference information in the citation dialog, so you will see in the
5563 XHTML output pretty much what you would see if you were to look at a given
5564 entry in the citation dialog.
5565 The formatting can be customized in your layout file or, preferably, in
5571 manual for the details.
5574 \begin_layout Standard
5575 The main defect at present is that cross-referenced information is printed
5576 with every entry with which it is associated.
5577 So you can see things like this:
5582 \begin_inset Quotes eld
5585 Context and Logical Form
5586 \begin_inset Quotes erd
5591 Language in Context: Selected Essays
5593 (Oxford: Oxford University Press, 2007), pp.
5599 \begin_inset Quotes eld
5602 Semantics in Context
5603 \begin_inset Quotes erd
5608 Language in Context: Selected Essays
5610 (Oxford: Oxford University Press, 2007), pp.
5614 \begin_layout Standard
5615 This should be fixed before long.
5618 \begin_layout Standard
5619 There is no support at present for sectioned bibliographies.
5620 If you have multiple bibliographies, then \SpecialChar LyX
5621 will print the same bibliography
5625 \begin_layout Section
5629 \begin_layout Standard
5631 will happily export indexes as XHTML, but with certain limitations at the
5635 \begin_layout Standard
5636 Index export will be most reliable when you do not attempt to use the fancy
5637 constructs that are described in the section on indexes in the
5645 \begin_layout Plain Layout
5646 The main issue here is that \SpecialChar LyX
5647 itself does not really handle these.
5648 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5654 We'll describe how they are handled using the subsection headings from
5658 \begin_layout Itemize
5659 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5660 makes an effort to support these,
5661 but the entries must be separated by
5662 \begin_inset Quotes eld
5666 \begin_inset Quotes erd
5669 , that is, there must be spaces around the exclamation point.
5670 This is because it is otherwise too difficult to check for escaped exclamation
5671 points, ones in math, and so forth.
5674 \begin_layout Itemize
5675 Page Ranges: There is no support at all for page ranges, since these make
5676 no sense with XHMTL.
5677 Instead, you will just get two index entries, one at either end.
5680 \begin_layout Itemize
5681 Cross-referencing: There is no support for cross-referencing.
5683 finds an entry containing the
5684 \begin_inset Quotes eld
5687 |see\SpecialChar ldots
5689 \begin_inset Quotes erd
5692 construct, it is just dropped, and the rest is treated as an ordinary index
5696 \begin_layout Itemize
5697 Index Entry Order: \SpecialChar LyX
5698 does support attempts to fix the sorting order.
5699 It will take what is before the first `@' it finds and use that for sorting,
5700 taking what follows the first `@' to be the actual entry.
5701 At present, \SpecialChar LyX
5702 does not check for escaped `@', so do not try to index email
5706 \begin_layout Itemize
5707 Index Entry Layout: You can format entries by using the text style dialog,
5708 or by using any other method available within \SpecialChar LyX
5710 There is no support for constructs like:
5711 \begin_inset Quotes eld
5715 \begin_inset Quotes erd
5719 Indeed, if \SpecialChar LyX
5720 finds a pipe symbol, `|', in an entry, it will delete it and
5721 everything that follows it.
5724 \begin_layout Itemize
5725 Multiple Indexes: There is no support for multiple indexes.
5726 Rather, all index entries will be printed as one large index.
5727 To avoid our printing several versions of the index, we print only the
5728 main index, so make sure you have one.
5731 \begin_layout Section
5732 Nomenclature and Glossary
5735 \begin_layout Standard
5736 There is at present no support for glossaries.
5737 Adding it would be fairly trivial, and welcome.
5740 \begin_layout Chapter
5741 The \SpecialChar LyX
5745 \begin_layout Section
5749 \begin_layout Standard
5750 The `\SpecialChar LyX
5751 server' allows other programs to talk to \SpecialChar LyX
5752 , invoke \SpecialChar LyX
5753 commands, and retrieve
5754 information about the \SpecialChar LyX
5756 This is only intended for advanced users, but they should find it useful.
5757 It is by writing to the \SpecialChar LyX
5758 server, for example, that bibliography managers,
5759 such as JabRef, are able to
5760 \begin_inset Quotes eld
5764 \begin_inset Quotes erd
5767 citations to \SpecialChar LyX
5771 \begin_layout Section
5772 Starting the \SpecialChar LyX
5776 \begin_layout Standard
5777 The \SpecialChar LyX
5778 server works through the use of a pair of named pipes.
5779 These are usually located in
5780 \begin_inset Flex Code
5783 \begin_layout Plain Layout
5789 , (except on Windows, where
5793 named pipes are special objects located in
5794 \begin_inset Flex Code
5797 \begin_layout Plain Layout
5809 ) and have the names
5810 \begin_inset Quotes eld
5814 \begin_inset Flex Code
5817 \begin_layout Plain Layout
5824 \begin_inset Quotes erd
5828 \begin_inset Quotes eld
5832 \begin_inset Flex Code
5835 \begin_layout Plain Layout
5842 \begin_inset Quotes erd
5846 External programs write into
5847 \begin_inset Flex Code
5850 \begin_layout Plain Layout
5856 and read back data from
5857 \begin_inset Flex Code
5860 \begin_layout Plain Layout
5867 The stem of the pipe names can be defined in the
5868 \begin_inset Flex Noun
5871 \begin_layout Plain Layout
5872 Tools\SpecialChar menuseparator
5879 \begin_inset Flex Code
5882 \begin_layout Plain Layout
5883 "/home/myhome/lyxpipe"
5889 \begin_inset Flex Code
5892 \begin_layout Plain Layout
5906 on Windows (where any working path instead of lyxpipe can be used, for
5908 \begin_inset Flex Code
5911 \begin_layout Plain Layout
5934 configure this manually in order for the server to start.
5937 \begin_layout Standard
5940 \begin_inset Flex Code
5943 \begin_layout Plain Layout
5950 \begin_inset Flex Code
5953 \begin_layout Plain Layout
5959 ' to create the pipes.
5960 If one of the pipes already exists, \SpecialChar LyX
5961 will assume that another \SpecialChar LyX
5963 is already running and will not start the server.
5964 On POSIX (Unix like) systems, if for some other reason, an unused
5965 \begin_inset Quotes eld
5969 \begin_inset Quotes erd
5972 pipe is left in existence when \SpecialChar LyX
5973 closes, then \SpecialChar LyX
5974 will try to delete it.
5975 If this fails for some reason, you will need to delete the pipes manually
5976 and then restart \SpecialChar LyX
5978 On Windows, pipes are deleted by the OS on program termination or crash,
5980 \begin_inset Quotes eld
5984 \begin_inset Quotes erd
5987 pipes should not be possible.
5990 \begin_layout Standard
5991 To have several \SpecialChar LyX
5992 processes with servers at the same time, you have to use
5993 different configurations, perhaps by using separate user directories, each
5995 \begin_inset Flex Code
5998 \begin_layout Plain Layout
6004 file, for each process.
6007 \begin_layout Standard
6008 If you are developing a client program, you might find it useful to enable
6009 debugging information from the \SpecialChar LyX
6011 Do this by starting \SpecialChar LyX
6013 \begin_inset Flex Code
6016 \begin_layout Plain Layout
6025 \begin_layout Standard
6026 You can find a complete example client written in C++ in the source distribution
6028 \begin_inset Flex Code
6031 \begin_layout Plain Layout
6032 development/lyxserver/server_monitor.cpp
6040 \begin_layout Standard
6041 Another useful tool is the command-line based client found in
6042 \begin_inset Flex Code
6045 \begin_layout Plain Layout
6046 src/client/lyxclient
6054 \begin_layout Section
6055 Normal communication
6058 \begin_layout Standard
6059 To issue a \SpecialChar LyX
6060 call, the client writes a line of ASCII text into the input
6062 This line has the following format:
6079 \begin_layout Description
6080 clientname is a name that the client can choose arbitrarily.
6081 Its only use is that \SpecialChar LyX
6082 will echo it if it sends an answer—so a client can
6083 dispatch results from different requesters.
6086 \begin_layout Description
6087 function is the function you want \SpecialChar LyX
6089 It is the same as the commands you'd use in the minibuffer.
6092 \begin_layout Description
6093 argument is an optional argument which is meaningful only to some functions
6095 \begin_inset Quotes eld
6099 \begin_inset Quotes erd
6102 LFUN will insert the argument as text at the cursor position).
6105 \begin_layout Standard
6106 The answer from \SpecialChar LyX
6107 will arrive in the output pipe and be of the form
6124 \begin_layout Standard
6133 are just echoed from the command request, while
6137 is more or less useful information filled according to how the command
6138 execution worked out.
6139 Some commands, such as
6140 \begin_inset Quotes eld
6144 \begin_inset Quotes erd
6147 , will return information about the internal state of \SpecialChar LyX
6149 return an empty data-response.
6150 This means that the command execution went fine.
6153 \begin_layout Standard
6154 In case of errors, the response from \SpecialChar LyX
6172 \begin_layout Standard
6177 should contain an explanation of why the command failed.
6180 \begin_layout Standard
6184 \begin_layout LyX-Code
6185 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6186 \begin_inset Newline newline
6189 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6190 \begin_inset Newline newline
6193 read a <~/.lyxpipe.out
6194 \begin_inset Newline newline
6200 \begin_layout Subsection
6201 AppleScript (Mac OS X)
6204 \begin_layout Standard
6205 Since \SpecialChar LyX
6206 2.1, \SpecialChar LyX
6207 supports basic interactions with AppleScript for normal communicatio
6208 n through the command run.
6209 This command takes a direct argument (the
6213 to perform) and an optional argument.
6214 It either returns the output of the function or triggers an error with
6215 the error message and code.
6218 \begin_layout Standard
6222 \begin_layout LyX-Code
6223 tell application "\SpecialChar LyX
6227 \begin_layout LyX-Code
6231 \begin_layout LyX-Code
6232 -- Stores the current file name into f
6235 \begin_layout LyX-Code
6236 set f to (run "server-get-filename" with argument "")
6239 \begin_layout LyX-Code
6240 on error the error_message number the error_number
6243 \begin_layout LyX-Code
6244 display dialog "Error: " & the error_number & ".
6248 \begin_layout LyX-Code
6249 & the error_message buttons {"OK"} default button 1
6252 \begin_layout LyX-Code
6256 \begin_layout LyX-Code
6260 \begin_layout Section
6264 \begin_layout Standard
6266 can notify clients of events going on asynchronously.
6267 Currently it will only do this if the user binds a key sequence with the
6269 \begin_inset Quotes eld
6273 \begin_inset Quotes erd
6277 The format of the string \SpecialChar LyX
6278 sends is as follows:
6282 \begin_inset Flex Code
6285 \begin_layout Plain Layout
6296 \begin_layout Standard
6301 is the printed representation of the key sequence that was actually typed
6305 \begin_layout Standard
6306 This mechanism can be used to extend \SpecialChar LyX
6307 's command set and implement macros.
6308 Bind some key sequence to
6309 \begin_inset Quotes eld
6313 \begin_inset Quotes erd
6317 Then start a client that listens on the output pipe, dispatches the command
6318 according to the sequence, and starts a function that may use \SpecialChar LyX
6321 requests to issue a command or a series of commands to \SpecialChar LyX
6325 \begin_layout Section
6326 The simple \SpecialChar LyX
6330 \begin_layout Standard
6332 implements a simple protocol that can be used for session management.
6333 All messages are of the form
6346 \begin_layout Standard
6352 \begin_inset Quotes eld
6356 \begin_inset Quotes erd
6360 \begin_inset Quotes eld
6364 \begin_inset Quotes erd
6369 \begin_inset Quotes eld
6373 \begin_inset Quotes erd
6376 is received from a client, \SpecialChar LyX
6377 will report back to inform the client that
6378 it's listening to it's messages, while
6379 \begin_inset Quotes eld
6383 \begin_inset Quotes erd
6386 sent from \SpecialChar LyX
6387 will inform clients that \SpecialChar LyX
6391 \begin_layout Section
6392 Reverse DVI/PDF search
6395 \begin_layout Standard
6396 Some DVI/PDF viewers
6400 \begin_layout Plain Layout
6401 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6402 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6411 facility (also called
6416 This means that you can tell \SpecialChar LyX
6417 to put the cursor to a specific line in the
6418 document by clicking at the respective position in the DVI/PDF output.
6419 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6421 This is done via the \SpecialChar LyX
6422 server either by using the named pipe (
6426 ), or the UNIX domain socket (
6430 ) that \SpecialChar LyX
6431 creates in its temporary directory (this is the way the
6432 \begin_inset Flex Code
6435 \begin_layout Plain Layout
6441 program communicates with \SpecialChar LyX
6443 In some cases, you need a helper script that mediates between the viewer
6444 and \SpecialChar LyX
6445 , in others, the viewer can communicate with \SpecialChar LyX
6447 This depends on the selected viewer and on your operating system.
6448 The same applies to the way viewers need to be configured and the way the
6449 reverse search is actually performed.
6450 In what follows, we will thus describe how to setup reverse search for
6452 Before we turn to this, though, we will explain what needs to be done generally
6453 to enable reverse search in the DVI/PDF output.
6456 \begin_layout Subsection
6458 \begin_inset CommandInset label
6460 name "subsec:rev-search"
6467 \begin_layout Standard
6468 In most cases \SpecialChar LyX
6469 will do the work for you by
6470 \change_inserted -712698321 1500975045
6471 pressing the following button in the toolbar:
6474 arg "buffer-toggle-output-sync"
6478 Alternatively, you can also enable the feature by checking
6480 Synchronize with Output
6483 \begin_inset Flex Noun
6486 \begin_layout Plain Layout
6488 \change_inserted -712698321 1500975071
6489 Document\SpecialChar menuseparator
6490 Settings\SpecialChar menuseparator
6497 \change_deleted -712698321 1500974764
6499 \begin_inset Flex Noun
6502 \begin_layout Plain Layout
6503 Synchronize with Output
6509 \begin_inset Flex Noun
6512 \begin_layout Plain Layout
6513 Document\SpecialChar menuseparator
6514 Settings\SpecialChar menuseparator
6523 In such a case \SpecialChar LyX
6524 will automatically insert the necessary Sync\SpecialChar TeX
6526 PDF) or load the srcltx package (for DVI) respectively.
6527 This option can be easily reached also on
6528 \begin_inset Flex Code
6531 \begin_layout Plain Layout
6540 \begin_layout Standard
6541 If you need a different setting, you can select or input a custom macro
6542 from the drop down box just below
6543 \begin_inset Flex Noun
6546 \begin_layout Plain Layout
6547 Document\SpecialChar menuseparator
6548 Settings\SpecialChar menuseparator
6549 Output\SpecialChar menuseparator
6550 Synchronize with Output
6558 \begin_layout Standard
6559 Note that the method
6560 \begin_inset Flex Code
6563 \begin_layout Plain Layout
6571 enables gzip compression.
6572 If your viewer does not support it, you should instead use
6573 \begin_inset Flex Code
6576 \begin_layout Plain Layout
6587 \begin_layout Standard
6588 Please also note that including the
6589 \begin_inset Flex Code
6592 \begin_layout Plain Layout
6599 \begin_inset Flex Code
6602 \begin_layout Plain Layout
6608 sometimes has an undesired impact on the typesetting.
6609 Thus, you should switch output synchronization off for the final typesetting
6611 \begin_inset Flex Code
6614 \begin_layout Plain Layout
6621 \begin_inset Flex Code
6624 \begin_layout Plain Layout
6634 \begin_layout Standard
6635 In case you need some more special settings that are not covered by the
6636 automatic settings, read the next section about how to set up output synchroniz
6638 If the automatic setup suits your needs, you can readily jump to section
6639 \begin_inset space ~
6643 \begin_inset CommandInset ref
6645 reference "subsec:configuring-viewers"
6649 , where the necessary configuration steps in your viewer – needed both with
6650 the automatic and the manual setup – are described.
6653 \begin_layout Subsection
6657 \begin_layout Standard
6659 provides several different methods for reverse search.
6660 Some are built-in in the
6661 \begin_inset Flex Code
6664 \begin_layout Plain Layout
6670 program, some are provided by external packages.
6671 Your choice depends on whether your \SpecialChar LaTeX
6672 distribution already provides a given
6673 method (the built-in methods are rather new) and whether your viewer can
6675 The available methods are described in the following.
6678 \begin_layout Subsubsection*
6679 Built-in DVI-search via src-specials (DVI only)
6682 \begin_layout Standard
6683 This method provides the DVI file with the necessary information for reverse
6685 It is available in \SpecialChar LaTeX
6686 since quite some time (any somewhat recent \SpecialChar LaTeX
6688 should include it), and it works reliably.
6689 To enable it, change the
6690 \begin_inset Flex Noun
6693 \begin_layout Plain Layout
6704 \begin_inset Flex Noun
6707 \begin_layout Plain Layout
6718 \begin_inset Flex Noun
6721 \begin_layout Plain Layout
6722 Preferences\SpecialChar menuseparator
6723 File Handling\SpecialChar menuseparator
6730 \begin_inset Flex Code
6733 \begin_layout Plain Layout
6734 latex -src-specials $$i
6740 If this doesn't work, check if your \SpecialChar TeX
6741 engine needs different options (the
6742 syntax might differ in some distributions).
6745 \begin_layout Subsubsection*
6746 External Packages (PDFSync and scrltx)
6749 \begin_layout Standard
6758 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6760 In order to enable it, load the packages in the \SpecialChar LyX
6764 \begin_layout Itemize
6765 \begin_inset Flex Code
6768 \begin_layout Plain Layout
6776 for reverse PDF search,
6779 \begin_layout Itemize
6780 \begin_inset Flex Code
6783 \begin_layout Plain Layout
6786 usepackage[active]{srcltx}
6791 for reverse DVI search.
6794 \begin_layout Standard
6795 If you want to be able to perform both DVI and PDF reverse searches, you
6796 can also insert in the preamble the following lines
6799 \begin_layout LyX-Code
6803 \begin_inset Newline newline
6809 \begin_inset Newline newline
6815 \begin_inset Newline newline
6821 \begin_inset Newline newline
6826 usepackage[active]{srcltx}
6827 \begin_inset Newline newline
6835 \begin_layout Standard
6836 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6837 right package will be used.
6840 \begin_layout Standard
6841 Note that PDFSync might affect the output layout of your document.
6842 It is therefore advised to disable PDFsync for final documents.
6845 \begin_layout Subsubsection*
6846 Built-in reverse search via Sync\SpecialChar TeX
6850 \begin_layout Standard
6852 \begin_inset Flex Code
6855 \begin_layout Plain Layout
6861 have built-in support for both PDF and DVI reverse search.
6864 Sync\SpecialChar TeX
6867 facility is basically the result of the integration of the PDFSync package
6868 to the pdftex program and its merge with the
6873 You need at least \SpecialChar TeX
6874 Live 2008 or a recent Mik\SpecialChar TeX
6875 distribution in order to use
6880 \begin_layout Plain Layout
6881 For some reason, Mik\SpecialChar TeX
6882 does not understand/obey the command \SpecialChar LyX
6884 the preamble when you check the "Enable Forward/Reverse Search" button
6885 in the toolbar and does not generate the necessary info.
6888 \begin_layout Plain Layout
6889 The generation of the required info can be forced by changing the converter
6891 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
6892 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
6893 the -synctex=1 switch).
6898 Also note that only a few PDF viewers (
6899 \change_inserted -712698321 1500977288
6902 Okular and Qpdfview on Unix, Skim on the Mac, SumatraPDF on Windows
6903 \change_inserted -712698321 1500977299
6904 ; see the next section for details
6906 ) already provide Sync\SpecialChar TeX
6910 \begin_layout Standard
6911 To enable Sync\SpecialChar TeX
6912 for DVI output, change the
6913 \begin_inset Flex Noun
6916 \begin_layout Plain Layout
6927 \begin_inset Flex Noun
6930 \begin_layout Plain Layout
6941 \begin_inset Flex Noun
6944 \begin_layout Plain Layout
6945 Preferences\SpecialChar menuseparator
6946 File Handling\SpecialChar menuseparator
6953 \begin_inset Flex Code
6956 \begin_layout Plain Layout
6957 latex -synctex=1 $$i
6962 , and for PDF output, change the
6963 \begin_inset Flex Noun
6966 \begin_layout Plain Layout
6971 (pdflatex) -> PDF (pdflatex)
6977 \change_deleted -712698321 1500977453
6981 \begin_inset Flex Code
6984 \begin_layout Plain Layout
6985 pdflatex -synctex=1 $$i
6992 \change_inserted -712698321 1500977740
6993 Should your viewer not be considered in the following description, or in
6994 case of missing success, please
6995 \change_deleted -712698321 1500977741
6997 \change_inserted -712698321 1500977744
7000 heck the documentation of your viewer whether the viewer needs to be configured
7001 for the use with Sync\SpecialChar TeX
7006 \begin_layout Plain Layout
7007 Note that the option
7008 \begin_inset Flex Code
7011 \begin_layout Plain Layout
7017 option enables gzip compression.
7018 If your viewer does not support it, you should instead use
7019 \begin_inset Flex Code
7022 \begin_layout Plain Layout
7036 \begin_layout Subsection
7037 Configuring and using specific viewers
7038 \begin_inset CommandInset label
7040 name "subsec:configuring-viewers"
7047 \begin_layout Subsubsection*
7048 Xdvi (all platforms)
7051 \begin_layout Standard
7053 \begin_inset Flex Code
7056 \begin_layout Plain Layout
7062 , you don't need to do anything else for performing a reverse DVI search,
7064 already provides the necessary hooks for automatically using the
7065 \begin_inset Flex Code
7068 \begin_layout Plain Layout
7075 Just setup your document as described above (reverse search is triggered
7076 by Ctrl-click or Alt-click on Mac OSX, respectively).
7079 \begin_layout Standard
7080 However, if for whatever reason you want to use the named pipe instead of
7081 the socket for communicating with \SpecialChar LyX
7082 , simply change the DVI viewer in
7083 \begin_inset Flex Noun
7086 \begin_layout Plain Layout
7087 Preferences\SpecialChar menuseparator
7088 File Handling\SpecialChar menuseparator
7098 \begin_layout Plain Layout
7099 On Mac OSX you have to use
7100 \begin_inset Flex Code
7103 \begin_layout Plain Layout
7104 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7115 \begin_inset Flex Code
7118 \begin_layout Plain Layout
7119 xdvi -editor "lyxeditor.sh %f %l"
7125 \begin_inset Flex Code
7128 \begin_layout Plain Layout
7134 is a suitable script.
7135 For example, a minimal shell script is the following one:
7138 \begin_layout LyX-Code
7140 \begin_inset Newline newline
7143 LYXPIPE="/path/to/lyxpipe"
7144 \begin_inset Newline newline
7147 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7148 \begin_inset Newline newline
7151 echo "$COMMAND" > "${LYXPIPE}".in || exit
7152 \begin_inset Newline newline
7155 read TMP < "${LYXPIPE}".out || exit
7158 \begin_layout Standard
7160 \begin_inset Flex Code
7163 \begin_layout Plain Layout
7169 is the LyXServer pipe path specified in
7170 \begin_inset Flex Noun
7173 \begin_layout Plain Layout
7174 Preferences\SpecialChar menuseparator
7184 \begin_layout Plain Layout
7186 \begin_inset Flex Code
7189 \begin_layout Plain Layout
7195 folder of a source distribution you can find a
7196 \begin_inset Flex Code
7199 \begin_layout Plain Layout
7205 script which is able to locate the
7209 based on your preferences.
7217 \begin_layout Subsubsection*
7221 \begin_layout Standard
7223 \begin_inset Flex Code
7226 \begin_layout Plain Layout
7227 /Applications/MacDviX_Folder/calleditor.script
7232 , add the following lines:
7235 \begin_layout LyX-Code
7236 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7237 \begin_inset Newline newline
7243 \begin_layout Standard
7244 Modify the lines accordingly if you install \SpecialChar LyX
7245 somewhere else than in the
7246 Applications folder.
7249 \begin_layout Standard
7250 Reverse search is triggered by Alt-click (OPTION-click).
7253 \begin_layout Subsubsection*
7257 \begin_layout Standard
7259 \begin_inset Flex Code
7262 \begin_layout Plain Layout
7263 open -a Skim.app $$i
7268 to the viewer setting in
7269 \begin_inset Flex Noun
7272 \begin_layout Plain Layout
7273 Preferences\SpecialChar menuseparator
7274 File Handling\SpecialChar menuseparator
7275 File formats\SpecialChar menuseparator
7282 \begin_inset Flex Noun
7285 \begin_layout Plain Layout
7286 Skim\SpecialChar menuseparator
7287 Preferences\SpecialChar menuseparator
7294 \begin_inset Flex Noun
7297 \begin_layout Plain Layout
7303 preset and enter command
7304 \begin_inset Flex Noun
7307 \begin_layout Plain Layout
7308 /Applications/\SpecialChar LyX
7309 .app/Contents/MacOS/lyxeditor
7317 \begin_layout Standard
7318 Reverse search is triggered by COMMAND-SHIFT-click
7321 \begin_layout Subsubsection*
7325 \begin_layout Standard
7326 Reverse search with evince does not work out of the box, but it can be achieved
7327 by means of some third party helper scripts.
7329 \begin_inset CommandInset href
7331 target "http://wiki.lyx.org/LyX/SyncTeX"
7339 \begin_layout Subsubsection*
7343 \begin_layout Standard
7345 \begin_inset Flex Noun
7348 \begin_layout Plain Layout
7349 Settings\SpecialChar menuseparator
7350 Configure Okular\SpecialChar menuseparator
7357 \change_inserted -712698321 1500981642
7359 \change_deleted -712698321 1500981641
7363 \change_deleted -712698321 1500981634
7365 \begin_inset Quotes eld
7369 \change_inserted -712698321 1500981635
7373 \begin_inset Quotes erd
7377 \change_inserted -712698321 1500981659
7379 This inserts the appropriate
7380 \change_deleted -712698321 1500981663
7384 \change_inserted -712698321 1500981665
7388 \begin_inset Flex Code
7391 \begin_layout Plain Layout
7398 \change_inserted -712698321 1500981668
7404 \begin_layout Standard
7405 Reverse search is triggered by SHIFT-click.
7408 \begin_layout Subsubsection*
7412 \begin_layout Standard
7413 Qpdfview supports Sync\SpecialChar TeX
7414 since version 0.3.5.
7416 \begin_inset Flex Noun
7419 \begin_layout Plain Layout
7420 Edit\SpecialChar menuseparator
7421 Settings\SpecialChar menuseparator
7427 , click on the input field of the
7428 \begin_inset Quotes eld
7432 \begin_inset Quotes erd
7435 item and add the command
7436 \begin_inset Flex Code
7439 \begin_layout Plain Layout
7448 \begin_layout Standard
7449 Reverse search is triggered by double-click or, in more recent versions,
7453 \begin_layout Subsubsection*
7457 \begin_layout Standard
7458 Launch yap, choose its
7459 \begin_inset Flex Noun
7462 \begin_layout Plain Layout
7463 View\SpecialChar menuseparator
7470 \begin_inset Quotes eld
7474 \begin_inset Quotes erd
7479 \begin_inset Quotes eld
7482 New\SpecialChar ldots
7484 \begin_inset Quotes erd
7487 button and, in the window that opens, enter
7488 \begin_inset Quotes eld
7493 \begin_inset Quotes erd
7496 (or any other name you like) in the
7497 \begin_inset Quotes eld
7501 \begin_inset Quotes erd
7505 Now click on the button labeled
7506 \begin_inset Quotes eld
7511 \begin_inset Quotes erd
7514 to open a file dialog and navigate to the directory containing the batch
7516 \begin_inset Flex Code
7519 \begin_layout Plain Layout
7527 \begin_inset Flex Code
7530 \begin_layout Plain Layout
7536 and then specify the program arguments as
7537 \begin_inset Flex Code
7540 \begin_layout Plain Layout
7548 \begin_inset Flex Code
7551 \begin_layout Plain Layout
7557 wrapper is used for communicating with \SpecialChar LyX
7565 \begin_layout LyX-Code
7567 \begin_inset Newline newline
7570 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
7579 \begin_inset Newline newline
7593 \begin_layout Standard
7594 Make sure that the \SpecialChar LyX
7595 Server pipe path you specified in \SpecialChar LyX
7597 \begin_inset Flex Code
7600 \begin_layout Plain Layout
7614 , otherwise change the
7615 \begin_inset Flex Code
7618 \begin_layout Plain Layout
7624 wrapper accordingly.
7627 \begin_layout Standard
7628 In yap, reverse search is triggered by double-click.
7631 \begin_layout Subsubsection*
7632 SumatraPDF (Windows)
7635 \begin_layout Standard
7636 In order to use SumatraPDF for inverse search, enter
7637 \begin_inset Flex Code
7640 \begin_layout Plain Layout
7641 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
7646 in the viewer setting in
7647 \begin_inset Flex Noun
7650 \begin_layout Plain Layout
7651 Preferences\SpecialChar menuseparator
7652 File Handling\SpecialChar menuseparator
7653 File formats\SpecialChar menuseparator
7660 \begin_inset Flex Code
7663 \begin_layout Plain Layout
7669 is the previous wrapper.
7670 If SumatraPDF.exe is not in your command PATH, use its full file name.
7673 \begin_layout Standard
7674 Reverse search is triggered by double-click.
7677 \begin_layout Subsubsection*
7681 \begin_layout Standard
7682 First of all, make sure that yap is your default DVI viewer in the Windows
7683 environment, then launch it, choose its
7684 \begin_inset Flex Noun
7687 \begin_layout Plain Layout
7688 View\SpecialChar menuseparator
7695 \begin_inset Quotes eld
7699 \begin_inset Quotes erd
7704 \begin_inset Quotes eld
7707 New\SpecialChar ldots
7709 \begin_inset Quotes erd
7712 button and, in the window that opens, enter
7713 \begin_inset Quotes eld
7718 \begin_inset Quotes erd
7721 (or any other name you like) in the
7722 \begin_inset Quotes eld
7726 \begin_inset Quotes erd
7730 Now click on the button labeled
7731 \begin_inset Quotes eld
7736 \begin_inset Quotes erd
7739 to open a file dialog and navigate to the directory containing the
7740 \begin_inset Flex Code
7743 \begin_layout Plain Layout
7749 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7752 \begin_inset Flex Code
7755 \begin_layout Plain Layout
7761 and then specify the program arguments as
7762 \begin_inset Flex Code
7765 \begin_layout Plain Layout
7772 In this way, you will be using the
7776 for communicating with \SpecialChar LyX
7778 If, for whatever reason, you want to use the
7783 \begin_inset Flex Code
7786 \begin_layout Plain Layout
7792 option and be sure to specify the \SpecialChar LyX
7793 Server pipe path in the \SpecialChar LyX
7797 \begin_layout Standard
7798 In yap, reverse search is triggered by double-click.
7801 \begin_layout Subsubsection*
7805 \begin_layout Standard
7806 In order to use SumatraPDF for inverse search, enter
7807 \begin_inset Flex Code
7810 \begin_layout Plain Layout
7811 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7816 in the viewer setting in
7817 \begin_inset Flex Noun
7820 \begin_layout Plain Layout
7821 Preferences\SpecialChar menuseparator
7822 File Handling\SpecialChar menuseparator
7823 File formats\SpecialChar menuseparator
7830 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7832 \begin_inset Flex Code
7835 \begin_layout Plain Layout
7841 enables communication via the
7847 \begin_inset Flex Code
7850 \begin_layout Plain Layout
7856 option if you want to use the
7860 , and be sure to specify the \SpecialChar LyX
7861 Server pipe path in the \SpecialChar LyX
7865 \begin_layout Standard
7866 Reverse search is triggered by double-click.
7869 \begin_layout Section
7873 \begin_layout Standard
7874 Forward search is, as the name implies, in a sense the
7875 \begin_inset Quotes eld
7879 \begin_inset Quotes erd
7883 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7885 If forward search is set up (as described in what follows), you can put
7886 the cursor anywhere in your \SpecialChar LyX
7888 \begin_inset Flex Noun
7891 \begin_layout Plain Layout
7892 Navigate\SpecialChar menuseparator
7899 \begin_inset Flex Noun
7902 \begin_layout Plain Layout
7908 in the context menu via right mouse click), and then the viewer will jump
7909 to that position as well.
7910 This implies, of course, that your viewer supports this function.
7913 \begin_layout Standard
7914 To make forward search possible, you first need to provide the generated
7915 output PDF/DVI file with additional information about the \SpecialChar TeX
7917 This can be done via the methods described in the section
7918 \begin_inset CommandInset ref
7920 reference "subsec:rev-search"
7927 \begin_layout Standard
7928 Additionally, you need to configure \SpecialChar LyX
7929 for using your viewers in
7930 \begin_inset Flex Noun
7933 \begin_layout Plain Layout
7934 Tools\SpecialChar menuseparator
7935 Preferences\SpecialChar menuseparator
7936 Output\SpecialChar menuseparator
7943 We provide a range of tested configurations for some viewers, which you
7944 can select from the drop down list.
7945 If none of these configurations suits you, you have to find out and enter
7946 a suitable configuration yourself.
7947 The definition syntax uses the following placeholders:
7950 \begin_layout Itemize
7952 \begin_inset Flex Code
7955 \begin_layout Plain Layout
7964 \begin_layout Itemize
7966 \begin_inset Flex Code
7969 \begin_layout Plain Layout
7975 : name of the (temporary) exported .tex file (without path)
7978 \begin_layout Itemize
7980 \begin_inset Flex Code
7983 \begin_layout Plain Layout
7989 : name of the (temporary) exported .tex file (including path)
7992 \begin_layout Itemize
7994 \begin_inset Flex Code
7997 \begin_layout Plain Layout
8003 : name of the exported output file (either dvi or pdf, depending on which
8004 one exists in the temporary directory)
8007 \begin_layout Standard
8008 Note that only some of the viewers provide full and usable forward search
8009 functionality out of the box, among them yap, xdvi, okular
8013 \begin_layout Plain Layout
8014 You might want to set
8015 \begin_inset Flex Code
8018 \begin_layout Plain Layout
8025 \begin_inset Flex Noun
8028 \begin_layout Plain Layout
8029 Tools\SpecialChar menuseparator
8030 Preferences\SpecialChar menuseparator
8031 File Handling\SpecialChar menuseparator
8033 \begin_inset space ~
8046 , qpdfview, and SumatraPDF
8050 \begin_layout Plain Layout
8051 SumatraPDF can also use DDE commands through the external program CMCDDE
8053 \begin_inset CommandInset href
8055 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8066 Others, such as evince
8070 \begin_layout Plain Layout
8071 Forward search with evince can be achieved by means of third party helper
8074 \begin_inset CommandInset href
8076 target "http://wiki.lyx.org/LyX/SyncTeX"
8086 , require some extra tools in order to use forward search.
8087 While many of the widespread PDF viewers (most notably Adobe Reader) do
8088 not support forward search at all, some other viewers – e.
8089 \begin_inset space \thinspace{}
8093 xpdf – allow at least to reload the document and jump to a specific page
8094 of the file, so you can at least navigate
8095 \begin_inset Quotes eld
8099 \begin_inset Quotes erd
8103 This latter functionality is provided by an external call of synctex (see
8104 the predefined example configurations).
8108 \begin_layout Standard
8109 Forward search works both with DVI and PDF output.
8111 simply checks which preview format you have used before (i.
8112 \begin_inset space \thinspace{}
8115 e., which format is already there in the temporary directory) and chooses
8116 the appropriate configuration for the respective format.
8119 \begin_layout Chapter
8120 Special Document Classes
8123 \begin_layout Section
8127 \begin_layout Standard
8133 \begin_layout Subsection
8137 \begin_layout Standard
8138 This section describes how \SpecialChar LyX
8139 can be used to write articles for submission
8140 to the scientific journal
8142 Astronomy and Astrophysics
8145 \begin_inset Flex URL
8148 \begin_layout Plain Layout
8150 http://www.edpsciences.fr/aa/
8155 ) using Version 5.01 of the document class
8160 This package can be downloaded from the ftp site
8163 \begin_layout Standard
8164 \begin_inset VSpace medskip
8170 \begin_layout Standard
8172 \begin_inset Flex URL
8175 \begin_layout Plain Layout
8177 ftp://ftp.edpsciences.org/pub/aa/readme.html
8185 \begin_layout Standard
8186 \begin_inset VSpace medskip
8192 \begin_layout Standard
8193 A manual comes together with that package, and this text is not meant to
8194 replace the original manual but is merely a short guide in how to realize
8195 the correct form of your paper.
8199 \begin_layout Standard
8200 Please note that the publisher of the journal was changed from Springer
8201 to EDP Sciences starting January 1, 2001.
8202 That change involved also some slight changes to the style files, namely
8203 the removal of the thesaurus command.
8204 The \SpecialChar LyX
8205 class aa supports the newest version of these style files, V 5.01.
8206 If you have an older version installed, please upgrade.
8207 For compatibility, the old (version 4) layout has been kept as
8212 Please refer to the comments in
8215 Dir/layouts/aapaper.layout
8220 \begin_layout Subsection
8224 \begin_layout Standard
8225 It is recommended you start from the example template distributed with \SpecialChar LyX
8227 If you are not using a template, note the following settings:
8230 \begin_layout Itemize
8237 Document\SpecialChar menuseparator
8240 dialog (OK, that one was obvious).
8243 \begin_layout Itemize
8244 Don't change the option
8247 \begin_inset space ~
8257 The whole layout is done by the macros, you shouldn't change anything.
8260 \begin_layout Subsection
8264 \begin_layout Standard
8265 First thing to enter is the header information.
8266 It consists of seven entries, of which some are optional.
8270 \begin_layout Itemize
8278 \begin_layout Itemize
8286 \begin_layout Itemize
8294 \begin_layout Itemize
8302 \begin_layout Itemize
8307 : [optional] if more than one author: whom to contact for offprint requests.
8310 \begin_layout Itemize
8315 : [optional] mail address for contacts.
8318 \begin_layout Itemize
8326 Received: <date>; Accepted <date>
8329 \begin_layout Standard
8330 There is no need to issue the
8336 command, this is done automatically by \SpecialChar LyX
8337 when the header is finished.
8338 Although the order of the single header entries doesn't matter it is advised
8339 to keep the above sequence, just to get the best optics and meets the layout
8340 of the real document.
8343 \begin_layout Standard
8344 If you want to place footnotes in the header block, e.
8345 \begin_inset space \thinspace{}
8349 \begin_inset space \space{}
8352 to state your present address, just use the standard footnote via the menu
8355 Insert\SpecialChar menuseparator
8360 will automagically use the term
8369 \begin_layout Standard
8370 In addition to these topics, the macros use three additional \SpecialChar LaTeX
8372 have no counterpart in \SpecialChar LyX
8376 \begin_layout Itemize
8383 to separate different names for more than one author and institute, respectivel
8387 \begin_layout Itemize
8394 to mark corresponding author/institute pairs.
8395 The institutes are numbered sequentially as they appear in the
8399 field, so you have to put a marker to each author.
8402 \begin_layout Itemize
8409 to supply an email address for fast contact.
8412 \begin_layout Standard
8413 In all cases, the appropriate command has to be entered in \SpecialChar LyX
8421 \begin_layout Subsection
8425 \begin_layout Standard
8426 The abstract should immediately follow the header block.
8427 With version 5 the abstract environment was changed to a command, and there
8428 is now a resctriction to only one paragraph.
8429 In addition, it should contain an entry with the keywords.
8430 This is not yet implemented for \SpecialChar LyX
8431 , therefore you have to enter the \SpecialChar LaTeX
8439 by hand and mark it as \SpecialChar LaTeX
8441 Refer to the example paper.
8444 \begin_layout Subsection
8445 Supported environments
8448 \begin_layout Standard
8449 The A&A paper layout supports the following environments for structuring
8453 \begin_layout Itemize
8459 \begin_layout Itemize
8465 \begin_layout Itemize
8471 \begin_layout Itemize
8477 \begin_layout Itemize
8483 \begin_layout Itemize
8489 \begin_layout Itemize
8495 \begin_layout Itemize
8501 \begin_layout Itemize
8507 \begin_layout Itemize
8513 \begin_layout Itemize
8519 \begin_layout Itemize
8526 \begin_layout Subsection
8527 Commands not supported by \SpecialChar LyX
8531 \begin_layout Standard
8532 Some commands are not yet supported by the
8536 layout for \SpecialChar LyX
8538 Some have already been mentioned.
8539 For the sake of completeness, they are listed all together here:
8542 \begin_layout Itemize
8550 \begin_layout Itemize
8558 \begin_layout Itemize
8566 \begin_layout Itemize
8574 \begin_layout Itemize
8582 \begin_layout Itemize
8590 \begin_layout Itemize
8598 \begin_layout Itemize
8606 \begin_layout Standard
8607 If you want to use any of these commands, you have to enter them yourself.
8610 Do not forget to mark them as \SpecialChar LaTeX
8614 \begin_layout Subsection
8615 Figure and Table Floats
8618 \begin_layout Standard
8620 provides support for the necessary float environments
8622 figure, figure*, table
8628 , therefore we won't tell much about it here.
8632 \begin_inset space ~
8638 Just remember that tables should be left-aligned.
8639 For that, select the table and change the alignment in
8641 Edit\SpecialChar menuseparator
8643 \begin_inset space ~
8649 \begin_layout Standard
8650 There is only one special thing: the figures with caption besides the figure.
8651 To create such a figure, you have to do the following:
8654 \begin_layout Enumerate
8655 Create a wide figure float:
8657 Insert\SpecialChar menuseparator
8658 Float\SpecialChar menuseparator
8661 , then right click in the figure and select
8664 \begin_inset space ~
8672 \begin_layout Enumerate
8673 Enter your caption text.
8676 \begin_layout Enumerate
8681 to move the cursor above the caption.
8684 \begin_layout Enumerate
8688 \begin_layout Enumerate
8689 Position the cursor behind the figure and insert a horizontal fill:
8691 Insert\SpecialChar menuseparator
8693 \begin_inset space ~
8696 Character\SpecialChar menuseparator
8698 \begin_inset space ~
8706 \begin_layout Enumerate
8707 Switch to \SpecialChar LaTeX
8711 \begin_inset space ~
8719 \begin_layout Enumerate
8729 Do not close the brace!
8732 \begin_layout Enumerate
8733 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8738 \begin_inset space ~
8750 \begin_layout Standard
8751 Also, refer to the figures in the example paper.
8754 \begin_layout Subsection
8758 \begin_layout Standard
8759 For submission, the paper has to be formated in a special double-spacing
8761 For this purpose, you have to give the option
8765 to the documentclass.
8766 This must be done using the extra class options field in the
8768 Document\SpecialChar menuseparator
8772 Just enter the string
8779 \begin_layout Subsection
8783 \begin_layout Standard
8788 directory contains an example paper written with \SpecialChar LyX
8790 It is the example paper from the original macro package, translated to
8793 Use it for inspiration, and compare the original \SpecialChar LaTeX
8794 code with \SpecialChar LyX
8798 \begin_layout Section
8803 \begin_layout Standard
8809 \begin_layout Subsection
8813 \begin_layout Standard
8815 is a set of macros produced by the American Astronomical Society to
8816 facilitate electronic manuscript submission to the three journals they
8817 publish: the Astrophysical Journal (including the Letters and Supplement),
8818 the Astronomical Journal, and the Publications of the Astronomical Society
8821 has proven to be an excellent tool for generating these documents, especially
8822 given its equation, citation, and figure handling capabilities.
8824 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8825 is the version described here, or higher.
8826 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8827 2.09 and are fundamentally
8828 incompatible with \SpecialChar LyX
8830 The AAS\SpecialChar TeX
8831 package may be downloaded from the AAS\SpecialChar TeX
8835 \begin_layout Standard
8836 \begin_inset VSpace medskip
8842 \begin_layout Standard
8844 \begin_inset Flex URL
8847 \begin_layout Plain Layout
8849 https://aas.org/aastex/aastex-downloads
8857 \begin_layout Standard
8858 \begin_inset VSpace medskip
8864 \begin_layout Standard
8865 A complete user guide is contained in that package and you should familiarize
8866 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8869 will not reduce the need to figure out all the AAS\SpecialChar TeX
8870 commands, it will only
8871 reduce the drudgery of typing everything in.
8872 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8874 completely to the requirements of the journal to which you are submitting
8878 \begin_layout Subsection
8879 Starting a New Paper
8882 \begin_layout Standard
8883 I strongly suggest that you start with the AAS\SpecialChar TeX
8887 File\SpecialChar menuseparator
8894 , enter the new file name, then choose the
8899 This will show the most common fields found in a manuscript.
8900 Simply overwrite the existing text (including the brackets,
8904 ) with the correct information.
8905 Many of the AAS\SpecialChar TeX
8906 commands and environments can be implemented directly in
8908 , but some cannot: most noticeably
8920 , which should stick out like a sore thumb if you actually just opened the
8922 For commands such as these, the \SpecialChar LaTeX
8923 code must be entered directly and marked
8925 Such commands are referred to as \SpecialChar TeX
8926 code, or Evil Red Text.
8927 I tried to minimize the amount of \SpecialChar TeX
8928 code needed in an AAS\SpecialChar TeX
8930 there is still a bit more required than any of us would like.
8933 \begin_layout Subsection
8934 Finishing Your Paper
8937 \begin_layout Standard
8938 When the paper is finished to your satisfaction and previews/prints correctly,
8940 \begin_inset Quotes eld
8944 \begin_inset Quotes erd
8947 actions which need to be done before you submit it to the journals.
8951 \begin_layout Enumerate
8952 Export your paper as a \SpecialChar LaTeX
8955 File\SpecialChar menuseparator
8956 Export\SpecialChar menuseparator
8964 \begin_layout Enumerate
8969 file with your favorite text editor
8973 \begin_layout Enumerate
8974 remove the comment lines before the
8983 \begin_layout Enumerate
8988 usepackage...{fontenc}
8990 line if it appears (usually just after
9005 \begin_layout Enumerate
9006 remove everything between (and including) the
9018 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9020 (which should appear immediately after the
9021 \begin_inset Quotes eld
9024 User specified \SpecialChar LaTeX
9026 \begin_inset Quotes erd
9037 \begin_layout Enumerate
9038 Run the resulting file through \SpecialChar LaTeX
9039 to make sure it still processes correctly.
9042 \begin_layout Enumerate
9043 Reread the journal requirements to make sure your filenames and formats
9047 \begin_layout Enumerate
9051 \begin_layout Subsection
9052 Comments On Specific Commands
9055 \begin_layout Standard
9056 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9063 ) gives a good description of each.
9064 Thus it's probably easiest for me to go down the list as found in the guide
9065 and offer comments where necessary.
9066 So let's begin \SpecialChar ldots
9070 \begin_layout Subsubsection
9071 Things that work as expected
9074 \begin_layout Standard
9075 Because they work as you might expect, I simply list them and the section
9176 begin{thebibliography}
9184 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9185 graphicx figure commands (2.14.1),
9209 (2.15.4, amongst other places),
9236 \begin_layout Standard
9237 The following style options also work correctly:
9258 Simply put them in the
9264 Layout\SpecialChar menuseparator
9270 \begin_layout Subsubsection
9271 Things that work, but require more comment
9274 \begin_layout Standard
9275 The following items work, but require a little more discussion:
9278 \begin_layout Itemize
9279 These items are reserved for use by the journal editors, but you can put
9280 them into the \SpecialChar LaTeX
9281 preamble if you feel compelled to do so:
9314 \begin_layout Itemize
9315 These items may be placed in the \SpecialChar LaTeX
9316 preamble, and are included as blanks in
9338 \begin_layout Itemize
9345 (2.3) – can only be used
9346 \begin_inset Quotes eld
9350 \begin_inset Quotes erd
9353 , not in the middle of a paragraph.
9354 Use \SpecialChar TeX
9355 code if you need to embed it.
9358 \begin_layout Itemize
9365 (2.3) – will have extra {} after it.
9366 This should not cause an error.
9369 \begin_layout Itemize
9376 (2.6) – can only be used
9377 \begin_inset Quotes eld
9381 \begin_inset Quotes erd
9384 , not in the middle of a paragraph.
9385 Use \SpecialChar TeX
9386 code if you need to embed it.
9389 \begin_layout Itemize
9396 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9400 \begin_layout Itemize
9414 \begin_layout Itemize
9421 (2.9) – will have extra {} after it.
9422 This should not cause an error.
9425 \begin_layout Itemize
9432 (2.11) – will have extra {} after it.
9433 This should not cause an error.
9436 \begin_layout Itemize
9443 (2.14.2) – you can insert an optional filename argument by placing the cursor
9444 at the beginning of the text and selecting
9446 Insert\SpecialChar menuseparator
9451 \begin_inset Quotes eld
9455 \begin_inset Quotes erd
9458 inserts an optional argument of the type needed by
9465 Hopefully it will be renamed someday.
9468 \begin_layout Itemize
9481 for the catalog ID optional parameter
9484 \begin_layout Itemize
9497 for the catalog ID optional parameter
9500 \begin_layout Subsubsection
9501 Things not implemented, use \SpecialChar TeX
9505 \begin_layout Standard
9528 setcounter{equation}
9530 (2.12), Journal name abbreviations (2.13.4),
9566 (2.15.4, insert it as the first element in the lefthand cell after where
9568 Don't use any of \SpecialChar LyX
9569 's rules in the table),
9581 (2.15.5), much of Misc (2.17, except
9632 \begin_layout Subsubsection
9633 Things that cannot be implemented
9636 \begin_layout Standard
9638 at least in any meaningful sort of way, so I suggest ignoring them.
9639 They are the references environment (2.13.3), and the deluxetable environment
9641 If you really, really need to use deluxetable, I suggest editing it in
9642 a separate file with a text editor, then using
9644 Insert\SpecialChar menuseparator
9646 \begin_inset space ~
9651 to include it in your \SpecialChar LyX
9657 file to see an example of this.
9660 \begin_layout Subsection
9661 FAQs, Tips, Tricks, and Other Ruminations
9664 \begin_layout Subsubsection
9665 Getting \SpecialChar LyX
9666 and AAS\SpecialChar TeX
9670 \begin_layout Standard
9671 It can be a bit tricky to get \SpecialChar LyX
9672 to recognize a new layout and document class.
9673 When all else fails, do this:
9676 \begin_layout Enumerate
9677 Make certain that \SpecialChar LaTeX
9678 can find AAS\SpecialChar TeX
9680 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9682 directory completely unrelated to \SpecialChar LaTeX
9683 or AAS\SpecialChar TeX
9684 and run \SpecialChar LaTeX
9692 \begin_layout Enumerate
9697 appears in \SpecialChar LyX
9705 \begin_layout Enumerate
9708 Tools\SpecialChar menuseparator
9712 , then restart \SpecialChar LyX
9716 \begin_layout Enumerate
9717 Open a regular new file, not from a template.
9718 Does AAS\SpecialChar TeX
9719 appear in the class list in
9721 Document\SpecialChar menuseparator
9727 \begin_layout Standard
9728 If you get a warning from an existing AAS\SpecialChar TeX
9729 document about not being able
9730 to find the AAS\SpecialChar TeX
9731 layout or a message about
9732 \begin_inset Quotes eld
9735 You should not mix title layouts with normal ones
9736 \begin_inset Quotes erd
9739 , things haven't been installed correctly.
9742 \begin_layout Subsubsection
9744 error processing a table
9747 \begin_layout Standard
9749 , by default, attempts to center the table caption/title.
9750 This seems to produce a bad interaction in AAS\SpecialChar TeX
9751 so you should click somewhere
9752 in the caption/title, then select
9754 Edit\SpecialChar menuseparator
9756 \begin_inset space ~
9770 This took care of it for me.
9773 \begin_layout Subsubsection
9777 \begin_layout Standard
9778 A couple of things: 1) I have noticed some funny spacing in the reference
9779 entries in the text.
9780 When you enter the bibliography item data, make sure their is
9784 space between the last author and the parenthesis setting off the year;
9788 \begin_inset space \thinspace{}
9792 \begin_inset space \space{}
9806 2) Entering the references at all is not obvious.
9807 The easiest thing is to start typing your first reference at the end of
9808 the document, then mark it as type
9813 That will put a small gray box in front of what you just typed.
9814 Click on the box to fill in the rest of the information.
9815 For new references, go to the end of an existing reference and press return.
9816 That will create a new line with its own box, etc.
9819 \begin_layout Subsubsection
9823 \begin_layout Standard
9824 Even though AAS\SpecialChar TeX
9825 provides its own figure commands (
9831 , for example), I much prefer \SpecialChar LaTeX
9832 's standard figure commands (with the default
9841 \begin_inset space ~
9844 commands as \SpecialChar TeX
9845 code into a Figure Float box if you desire, but I never have
9846 much luck getting the layout right.
9847 With the standard graphics, \SpecialChar LyX
9852 usepackage{graphicx}
9854 command into the \SpecialChar LaTeX
9855 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9857 interspersing the figures in the text.
9858 I believe ApJ accepts figures exactly this way now; AJ might still use
9860 \begin_inset Quotes eld
9863 stack everything at the end
9864 \begin_inset Quotes erd
9870 \begin_layout Subsubsection
9871 Things I could have done, but didn't
9874 \begin_layout Standard
9876 \begin_inset Quotes eld
9880 \begin_inset Quotes erd
9883 things I could have implemented, but chose not to.
9884 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9886 even though it is double-spaced in the paper manuscript.
9887 Also, I chose not to make separate layouts for the preprint and preprint2
9889 Since I assume you will spend most of your time in the plain manuscript
9890 mode anyway, I decided not to chew up more disk space with this.
9894 \begin_layout Subsection
9898 \begin_layout Standard
9899 Your mileage may vary.
9900 I've now had papers published by both ApJ and AJ that have had 98% of the
9901 effort done in \SpecialChar LyX
9902 ; the last 2% was the \SpecialChar LaTeX
9903 post-processing and a few cleanups.
9904 I have had no trouble with the submission process, and I'm sure the journals
9905 were never aware that there might be a difference.
9906 So, go forth and publish!
9909 \begin_layout Section
9910 AMS \SpecialChar LaTeX
9914 \begin_layout Standard
9924 \begin_layout Standard
9925 \begin_inset VSpace bigskip
9931 \begin_layout Standard
9933 The AMS \SpecialChar LaTeX
9934 layouts are set up to conform to suggested styles for mathematical
9935 papers to be submitted to American Mathematical Society publications.
9936 The layouts are not tailored to a specific journal, but easily can be.
9937 You should refer to the AMS documentation for specific instructions for
9938 each journal (usually it will entail only changing a single line in the
9941 That documentation is available on the Web at
9942 \begin_inset Flex URL
9945 \begin_layout Plain Layout
9953 \begin_inset Flex URL
9956 \begin_layout Plain Layout
9958 ftp://ftp.ams.org/pub/tex/amslatex/
9964 These layouts are appropriate, and useful, for any mathematical writing.
9968 \begin_layout Standard
9969 There are two basic AMS \SpecialChar LaTeX
9973 \begin_layout Itemize
9974 amsart: The standard AMS article format.
9977 \begin_layout Itemize
9978 amsbook: the standard AMS book (really, monograph) format.
9982 \begin_layout Standard
9983 The layouts themselves contain only the minimum necessary to use the AMS
9985 They do not, in particular, contain any of the `theorem' environments used
9986 for setting theorems, lemmas, and the like.
9987 These are contained, instead, in the
9988 \begin_inset Flex Code
9991 \begin_layout Plain Layout
9997 module, which is loaded by default when you select one of the AMS classes.
9998 (It can also be used with other classes and can be removed, if you would
9999 rather use something else.) Less commonly used environments are in the
10000 \begin_inset Flex Code
10003 \begin_layout Plain Layout
10004 Theorems (AMS-Extended)
10009 module, which must be loaded manually.
10012 \begin_layout Standard
10013 By default, theorems and the like are numbered consecutively throughout
10014 the document, but this may be modified by loading the module
10015 \begin_inset Flex Code
10018 \begin_layout Plain Layout
10019 Theorems (Order by Section)
10024 or, if you are using
10025 \begin_inset Flex Code
10028 \begin_layout Plain Layout
10035 \begin_inset Flex Code
10038 \begin_layout Plain Layout
10039 Theorems (Order by Chapter)
10045 These will number the results as
10046 \begin_inset Formula $n.m$
10049 , where the first number refers to the section (or chapter) and the second
10050 refers to the total number of results so far in that section (or chapter).
10051 Many environments are also available unnumbered.
10052 These are indicated by an asterisk at the end.
10053 If you happen to want
10057 unnumbered results, the module
10058 \begin_inset Flex Code
10061 \begin_layout Plain Layout
10067 provides that option.
10070 \begin_layout Standard
10071 Note that these modules do not
10075 to be used with the AMS classes.
10076 It is perfectly possible to use the
10077 \begin_inset Flex Code
10080 \begin_layout Plain Layout
10086 module, and the others mentioned, with other classes, such as
10087 \begin_inset Flex Code
10090 \begin_layout Plain Layout
10097 \begin_inset Flex Code
10100 \begin_layout Plain Layout
10107 \begin_inset Flex Code
10110 \begin_layout Plain Layout
10119 \begin_layout Subsection
10120 What these layouts provide
10123 \begin_layout Standard
10124 There is a long list of included environments provided by these layouts.
10125 In AMS-\SpecialChar LaTeX
10126 , there is, in fact, an opportunity to define an unlimited variety
10127 of `theorem' environments.
10128 However, the AMS recommends the environments that are available in \SpecialChar LyX
10133 \begin_layout Standard
10134 The following environments—as well as the standard environments, such as
10136 \begin_inset Flex Noun
10139 \begin_layout Plain Layout
10146 \begin_inset Flex Noun
10149 \begin_layout Plain Layout
10156 \begin_inset Flex Noun
10159 \begin_layout Plain Layout
10166 \begin_inset Flex Noun
10169 \begin_layout Plain Layout
10176 \begin_inset Flex Noun
10179 \begin_layout Plain Layout
10186 \begin_inset Flex Code
10189 \begin_layout Plain Layout
10196 \begin_inset Flex Code
10199 \begin_layout Plain Layout
10208 \begin_layout Description
10209 Address This should be the author's permanent address.
10212 \begin_layout Description
10214 \begin_inset space ~
10217 Address This should be the author's temporary address at the time of submission,
10218 if different from the Address.
10221 \begin_layout Description
10222 Email Author's e-mail address
10225 \begin_layout Description
10226 URL Author's Web address, if desired.
10229 \begin_layout Description
10230 Keywords Key words or phrases used to identify specific topics discussed
10234 \begin_layout Description
10235 Subjectclass These refer to the AMS Subject Classifications, published and
10238 Mathematical Reviews
10241 These are also available online at the AMS cites listed above.
10244 \begin_layout Description
10248 \begin_layout Description
10252 \begin_layout Description
10256 \begin_layout Standard
10257 The following environments are provided by both the
10258 \begin_inset Flex Code
10261 \begin_layout Plain Layout
10268 \begin_inset Flex Code
10271 \begin_layout Plain Layout
10277 modules, in the latter case in both starred (unnumbered) and unstarred
10278 (numbered) versions.
10279 These same environments are provided only in the starred versions by the
10281 \begin_inset Flex Code
10284 \begin_layout Plain Layout
10293 \begin_layout Theorem
10294 This is typically used for the statements of major results.
10298 \begin_layout Corollary*
10299 This is used for statements which follow fairly directly from previous statement
10301 Again, these can be major results.
10305 \begin_layout Lemma
10306 These are smaller results needed to prove other statements.
10309 \begin_layout Proposition
10310 These are less major results which (hopefully) add to the general theory
10314 \begin_layout Conjecture
10315 These are statements provided without justification, which the author does
10316 not know how to prove, but which seem to be true (to the author, at least).
10319 \begin_layout Definition*
10320 Guess what this is for.
10321 The font is different for this environment than for the previous ones.
10325 \begin_layout Example*
10326 Used for examples illustrating proven results.
10329 \begin_layout Problem
10330 It's not really known what this is for.
10331 You should figure it out.
10334 \begin_layout Exercise*
10335 Write a description for this one.
10338 \begin_layout Remark
10339 This environment is also a type of theorem, usually a lesser sort of observation.
10342 \begin_layout Claim*
10343 Often used in the course of giving a proof of a larger result.
10347 Generally, these are used to break up long arguments, using specific instances
10353 The numbering scheme for cases is on its own, not together with other numbered
10358 \begin_layout Proof
10359 At the end of this environment, a QED symbol (usually a square, but it can
10360 vary with different styles) is placed.
10361 If you want to have other environments within this one—for example, Case
10362 environments—and have the QED symbol appear only after them, then the other
10363 environments need to be nested within the proof environment.
10366 Nesting Environments
10372 for information on nesting.
10375 \begin_layout Standard
10376 And these environments are provided by
10377 \begin_inset Flex Code
10380 \begin_layout Plain Layout
10381 Theorems (AMS-Extended)
10389 \begin_layout Criterion*
10390 A required condition.
10393 \begin_layout Algorithm*
10394 A general procedure to be used.
10397 \begin_layout Axiom*
10398 This is a property or statement taken as true within the system being discussed.
10401 \begin_layout Condition*
10402 Sometimes used to state a condition assumed within the present context of
10406 \begin_layout Note*
10407 Similar to a Remark.
10410 \begin_layout Notation*
10411 Used for the explanation of, yes, notation.
10414 \begin_layout Summary
10415 Do we really need to tell you?
10418 \begin_layout Acknowledgement*
10422 \begin_layout Conclusion*
10423 Sometimes used at the end of a long train of argument.
10427 Used in a way similar to Proposition, though perhaps lower on the scale.
10430 \begin_layout Standard
10431 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10434 They need to be available on your system in order to use these environments.
10437 \begin_layout Section
10445 \begin_layout Standard
10451 \begin_layout Subsection
10455 \begin_layout Standard
10456 These are the layout files for some of the journals of the American Geophysical
10458 It is assumed that you have both the AGU's own class files and AGUplus
10459 installed (everything to be found at
10460 \begin_inset Flex URL
10463 \begin_layout Plain Layout
10465 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10473 \begin_layout Subsection
10477 \begin_layout Standard
10487 They are still called this in the \SpecialChar LyX
10488 GUI, though their \SpecialChar LaTeX
10501 \begin_layout Standard
10502 Newly defined styles are
10539 These are mostly manuscript attributes and defined in the AGU class documentati
10543 \begin_layout Standard
10544 I suspect this is still badly incomplete.
10547 \begin_layout Subsection
10551 \begin_layout Standard
10568 \begin_layout Subsection
10572 \begin_layout Itemize
10575 Journal of Geophysical Research
10584 \begin_layout Standard
10585 Add your own, it isn't so hard! Look at the
10596 \begin_layout Subsection
10597 Bugs and things to remember
10600 \begin_layout Standard
10601 In order to use the new layouts, you must remember to do the following for
10605 \begin_layout Enumerate
10611 This can be done in the
10613 Layout\SpecialChar menuseparator
10618 Document\SpecialChar menuseparator
10622 (AGU articles are always in English, right? So
10626 choose a language.)
10629 \begin_layout Enumerate
10634 into the document's
10639 (Yes, this is a bug.)
10642 \begin_layout Enumerate
10643 Make sure you use the
10647 bibliography style, by entering
10651 into the second field of the Bib\SpecialChar TeX
10653 None of the standard styles will do.
10656 \begin_layout Section
10660 \begin_layout Standard
10666 \begin_layout Subsection
10670 \begin_layout Standard
10671 Broadway is for writing plays.
10672 The format is more decorative than Hollywood, and much less standardized.
10673 This format should be suitable for workshops.
10676 \begin_layout Subsection
10680 \begin_layout Standard
10681 The same as in Hollywood.
10684 \begin_layout Subsection
10688 \begin_layout Standard
10693 names as labels then cross-reference the label to insert the name.
10694 The cross-reference dialog will show the current cast of characters.
10697 \begin_layout Subsection
10698 Paper size and Margins
10701 \begin_layout Standard
10702 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10705 \begin_layout Subsection
10709 \begin_layout Standard
10710 The following environments are available.
10711 You can use broadway.bind to get the bind keys shown at the right.
10714 \begin_layout Itemize
10718 \begin_inset Newline newline
10723 You should not have to use this, but it is here for anything that does not
10727 \begin_layout Itemize
10731 \begin_inset space \hfill{}
10735 \begin_inset Newline newline
10740 Used to describe stage setting and the action.
10741 First use of speaker names in all CAPs.
10744 \begin_layout Itemize
10748 \begin_inset space \hfill{}
10752 \begin_inset Newline newline
10757 Automatically numbered.
10758 On screen it will be arabic, but will print as Roman.
10761 \begin_layout Itemize
10765 \begin_inset space \hfill{}
10769 \begin_inset Newline newline
10779 It is just centered text.
10782 \begin_layout Itemize
10786 \begin_inset space \hfill{}
10790 \begin_inset Newline newline
10795 Not automatically numbered.
10796 You supply the number.
10797 This is because I couldn't figure out how.
10800 \begin_layout Itemize
10804 \begin_inset space \hfill{}
10808 \begin_inset Newline newline
10813 A special case of Narrative to describe the setting and action as the curtain
10817 \begin_layout Itemize
10821 \begin_inset space \hfill{}
10825 \begin_inset Newline newline
10830 The speaker's (actor's) title, centered in all CAPS.
10833 \begin_layout Itemize
10837 \begin_inset space \hfill{}
10841 \begin_inset Newline newline
10846 Instructions to the speaker.
10847 The parentheses are automatically inserted.
10848 The ( will appear on screen, but both will be in the printed play.
10849 This environment is only used within
10856 \begin_layout Itemize
10860 \begin_inset space \hfill{}
10864 \begin_inset Newline newline
10869 What the Speaker says.
10872 \begin_layout Itemize
10876 \begin_inset space \hfill{}
10880 \begin_inset Newline newline
10885 The curtain comes down.
10888 \begin_layout Itemize
10892 \begin_inset space \hfill{}
10898 \begin_layout Itemize
10902 \begin_inset space \hfill{}
10908 \begin_layout Itemize
10912 \begin_inset space \hfill{}
10918 \begin_layout Standard
10922 \begin_layout Section
10926 \begin_layout Standard
10931 can be used to type letters according to German conventions.
10932 A template file is included in
10934 .../lyx/share/templates
10936 for you to use as a starting point.
10939 \begin_layout Section
10947 \begin_layout Standard
10953 \begin_layout Subsection
10957 \begin_layout Standard
10958 This is the layout file for the European Geophysical Society journals.
10963 can be downloaded from the web site of the EGS under
10964 \begin_inset Flex URL
10967 \begin_layout Plain Layout
10977 \begin_layout Subsection
10981 \begin_layout Standard
10984 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10992 The current layout file is unfortunately very unmodular and would benefit
10993 from using the various
11000 \begin_layout Section
11004 \begin_layout Standard
11005 See the \SpecialChar LyX
11011 It contains all infos you need.
11014 \begin_layout Section
11017 Foil\SpecialChar TeX
11021 \begin_inset CommandInset label
11030 \begin_layout Standard
11036 \begin_layout Subsection
11040 \begin_layout Standard
11041 This section describes how to use \SpecialChar LyX
11042 to make slides for overhead projectors.
11043 There are two document classes that can do this: the default slides class
11046 Foil\SpecialChar TeX
11050 This section documents the latter.
11053 \begin_layout Standard
11054 I'm going to say this again, nice and clear, so that there's no misunderstanding
11058 \begin_layout Standard
11059 \begin_inset VSpace bigskip
11065 \begin_layout Standard
11069 This section documents the class
11070 \begin_inset Quotes eld
11078 \begin_inset Quotes erd
11086 \begin_layout Standard
11087 \begin_inset VSpace bigskip
11093 \begin_layout Standard
11094 If you're looking for the documentation for
11095 \begin_inset Quotes eld
11103 \begin_inset Quotes erd
11106 , check out section
11107 \begin_inset space ~
11111 \begin_inset CommandInset ref
11113 reference "sec:slitex"
11118 If your machine doesn't have the
11126 installed, you'll probably have to use the default
11130 class, which isn't quite as good as
11135 \begin_layout Standard
11140 class is designed for use with version
11141 \begin_inset space ~
11149 class file which is now an integral part of \SpecialChar LaTeX2e
11153 \begin_layout Subsection
11157 \begin_layout Standard
11158 Obviously, to use this document class, you need to select
11169 \begin_inset space ~
11175 There are some settings in the
11178 \begin_inset space ~
11183 dialog that you should know about that are specific to this class:
11186 \begin_layout Itemize
11187 Don't change the options
11198 \begin_inset space ~
11204 They're ignored by the
11211 \begin_layout Itemize
11212 The default font size is 20
11213 \begin_inset space \thinspace{}
11216 pt with the other options being 17
11217 \begin_inset space \thinspace{}
11221 \begin_inset space \thinspace{}
11225 \begin_inset space \thinspace{}
11231 \begin_layout Itemize
11232 The default font is
11240 but all math equations are still typeset in the usual roman font.
11243 \begin_layout Itemize
11246 Foil\SpecialChar TeX
11249 supports A4 and Letter paper sizes as well as a special size for working
11251 \begin_inset space \thinspace{}
11255 It doesn't support A5, B5, legal or executive paper sizes.
11258 \begin_layout Itemize
11259 Don't bother changing the
11263 settings because they are ignored anyway.
11264 All floats appear where they are defined in the text.
11267 \begin_layout Itemize
11272 setting behaves a bit differently for this class.
11275 Foil\SpecialChar TeX
11278 provides extensive footer and header capabilities including a user-defined
11281 \begin_inset space ~
11285 \begin_inset CommandInset ref
11287 reference "sec:foilfoot"
11292 The title page is treated differently to all other pages in the document
11301 has the logo centered at the bottom of the page (if one is defined).
11302 The possible page style choices and what they do are as follows:
11306 \begin_layout Labeling
11307 \labelwidthstring MMMMMMM
11314 The final output contains no page numbers, or other headers or footers
11315 (except footnotes of course).
11319 \begin_layout Labeling
11320 \labelwidthstring MMMMMMM
11327 The final output contains page numbers centered at the bottom of the page.
11328 No other headings or footers (other than footnotes).
11331 \begin_layout Labeling
11332 \labelwidthstring MMMMMMM
11337 Page numbers in lower right corner.
11338 Additional headers and footers are also shown.
11339 This is also the default.
11342 \begin_layout Labeling
11343 \labelwidthstring MMMMMMM
11348 Gives you access to the
11352 package although its use with
11354 Foil\SpecialChar TeX
11357 is discouraged by the writer of the
11359 Foil\SpecialChar TeX
11362 package because of some potential page layout clashes.
11366 \begin_layout Subsubsection
11370 \begin_layout Standard
11371 The following options may be used in the extra class options in the
11373 Document\SpecialChar menuseparator
11379 \begin_layout Labeling
11380 \labelwidthstring MMMMMMx
11385 This sets up the page layout for 7.33
11386 \begin_inset space \thinspace{}
11390 \begin_inset space \thinspace{}
11393 in paper, which is about the same aspect ratio as a 35
11394 \begin_inset space \thinspace{}
11397 mm slide, making it a bit easier to work with this medium.
11400 \begin_layout Labeling
11401 \labelwidthstring MMMMMMx
11406 Places a rule across the page below the header on every page except the
11410 \begin_layout Labeling
11411 \labelwidthstring MMMMMMx
11416 Places a rule across the page above the footer on every page except the
11420 \begin_layout Labeling
11421 \labelwidthstring MMMMMMx
11426 This is automatically set each time you create a new
11433 Foil\SpecialChar TeX
11436 to use the dvips driver to rotate those pages that are set as landscape
11440 \begin_layout Labeling
11441 \labelwidthstring MMMMMMx
11446 Simply changes the page dimensions to those of a landscape page but doesn't
11448 Thus if you use this option you need to use an external program to rotate
11449 each page or feed your paper through your printer as landscape.
11450 Note that this option effectively reverses the roles of the
11458 environments (don't worry these are described in the next section).
11461 \begin_layout Labeling
11462 \labelwidthstring MMMMMMx
11467 Equation numbers on the left.
11470 \begin_layout Labeling
11471 \labelwidthstring MMMMMMx
11476 Flush-left equations.
11479 \begin_layout Subsection
11480 Supported Environments
11483 \begin_layout Standard
11484 Most of the environments commonly supported in other classes are also supported
11490 There are several additional environments provided by
11492 Foil\SpecialChar TeX
11495 as well as a couple added by \SpecialChar LyX
11497 The following environments are shared with other classes:
11500 \begin_layout Standard
11501 \begin_inset Flex Multiple Columns
11504 \begin_layout Itemize
11510 \begin_layout Itemize
11516 \begin_layout Itemize
11522 \begin_layout Itemize
11528 \begin_layout Itemize
11534 \begin_layout Itemize
11541 \begin_layout Itemize
11547 \begin_layout Itemize
11553 \begin_layout Itemize
11559 \begin_layout Itemize
11565 \begin_layout Itemize
11571 \begin_layout Itemize
11577 \begin_layout Itemize
11583 \begin_layout Itemize
11589 \begin_layout Itemize
11595 \begin_layout Itemize
11601 \begin_layout Itemize
11607 \begin_layout Itemize
11618 \begin_layout Standard
11619 That is, all the major environments apart from the sectioning environments.
11620 Since foils are essentially self-contained sections, with a title and body,
11623 Foil\SpecialChar TeX
11626 provides specific commands for starting new foils and these are:
11629 \begin_layout Itemize
11635 \begin_layout Itemize
11641 \begin_layout Standard
11643 also provides slightly modified versions of these two environments called:
11646 \begin_layout Itemize
11652 \begin_layout Itemize
11655 ShortRotatefoilhead
11658 \begin_layout Standard
11659 and the differences will be explained in the next section.
11662 \begin_layout Standard
11663 Since foils are often used in presenting ideas or new theorems and such
11666 Foil\SpecialChar TeX
11669 also provides a comprehensive box of goodies for presenting them:
11672 \begin_layout Standard
11673 \begin_inset Flex Multiple Columns
11676 \begin_layout Itemize
11682 \begin_layout Itemize
11688 \begin_layout Itemize
11694 \begin_layout Itemize
11700 \begin_layout Itemize
11706 \begin_layout Itemize
11712 \begin_layout Itemize
11718 \begin_layout Itemize
11724 \begin_layout Itemize
11730 \begin_layout Itemize
11736 \begin_layout Itemize
11747 \begin_layout Standard
11748 The starred versions are unnumbered while the unstarred versions are numbered.
11749 There are also two list environments added by \SpecialChar LyX
11753 \begin_layout Itemize
11759 \begin_layout Itemize
11765 \begin_layout Standard
11768 Foil\SpecialChar TeX
11771 provides some powerful header and footer capabilities that are best set
11772 in the preamble although they may be set at any point in a document.
11773 If you want to change these settings in your document the best place to
11774 do so is at the very top of a foil, i.
11775 \begin_inset space \thinspace{}
11781 \begin_inset space \space{}
11786 straight after the foilhead.
11789 \begin_layout Standard
11790 For this purpose, the following command styles are provided [
11797 \begin_layout Standard
11798 \begin_inset Flex Multiple Columns
11801 \begin_layout Itemize
11805 \begin_inset space ~
11811 \begin_layout Itemize
11817 \begin_layout Itemize
11821 \begin_inset space ~
11827 \begin_layout Itemize
11831 \begin_inset space ~
11837 \begin_layout Itemize
11841 \begin_inset space ~
11848 \begin_layout Plain Layout
11849 \begin_inset space ~
11861 \begin_layout Standard
11862 There are also a few commands provided by
11864 Foil\SpecialChar TeX
11867 that aren't directly supported by \SpecialChar LyX
11868 but I'll tell you what they do and how
11869 to use them in section
11870 \begin_inset space ~
11874 \begin_inset CommandInset ref
11876 reference "sec:unsuppfoils"
11883 \begin_layout Subsection
11884 Building a Set of Foils
11887 \begin_layout Standard
11888 This section will give a simple introduction to using the different environments
11889 to build a set of foils.
11890 If you want to see an example set of foils, take a look at the
11894 file you find in \SpecialChar LyX
11902 \begin_layout Subsubsection
11903 Give It a Title Page
11906 \begin_layout Standard
11907 Unlike other classes that provide
11927 creates the title on a page of its own.
11928 If you leave out the
11932 environment \SpecialChar LaTeX
11933 will substitute the current date (every time you regenerate
11937 \begin_layout Subsubsection
11941 \begin_layout Standard
11942 As I mentioned earlier, there are four ways of starting a new foil.
11943 For portrait foils you should use
11952 The difference between these two environments is the amount of space between
11953 the title of the foil (the foilhead) and the body of the foil.
11956 \begin_layout Standard
11957 Landscape foils are generated using the
11963 ShortRotatefoilhead
11966 Again the only difference is the spacing between foilhead and body.
11967 Both of the short versions have 0.5
11968 \begin_inset space ~
11971 inches less separation between the foilhead and the body.
11975 \begin_layout Standard
11976 One problem with the support for landscape foils is the requirement that
11977 you have to use the
11981 driver to generate the PostScript output otherwise the foils won't be rotated.
11982 It is possible to get landscape foils even if you haven't got the
11986 driver provided you can feed your foils sideways through your printer ;-)
11989 \begin_layout Subsubsection
11990 Theorems, Lemmas, Proofs and more
11993 \begin_layout Standard
11994 Due to a small bug in \SpecialChar LyX
11995 you can't have two of the same type of these environments
11996 directly following each other.
11997 They must be separated by something.
11998 If you try, you will just be extending the previous environment as if you
11999 had merged the two environments together.
12000 So, how do you get around this problem? The simplest option is to insert
12001 some text between the two environments or add a
12006 environment between the two with just a
12007 \begin_inset Quotes eld
12015 \begin_inset Quotes erd
12019 This will force \SpecialChar LyX
12020 to produce two separate environments and hence the correct
12023 An example is provided in the example file included with the \SpecialChar LyX
12025 Remember, this problem only occurs if you are trying to place two of the
12026 same type of theorem-like environments one directly after the other.
12029 \begin_layout Subsubsection
12033 \begin_layout Standard
12034 You get all the commonly supported list styles found in other classes as
12035 well as two new ones.
12036 I'll only describe the new ones here.
12037 If you want to find out more about the other list environments check out
12043 If you intend to use itemized lists you might also want to read about the
12047 \begin_inset space ~
12051 \begin_inset space ~
12056 dialog described above in section
12057 \begin_inset space ~
12061 \begin_inset CommandInset ref
12063 reference "sec:bullet"
12070 \begin_layout Standard
12071 The two new list styles,
12079 , are designed to make it easier for you to create lists of do's and don'ts
12080 or right and wrong by providing dedicated environments that use a tick
12081 or a cross as the label of the list.
12082 These lists are in fact dedicated variants of the
12087 They do however require that you have the
12091 packages installed.
12094 \begin_layout Subsubsection
12098 \begin_layout Standard
12101 Foil\SpecialChar TeX
12104 redefines the floating tables and figures so that they appear exactly where
12105 they are in the text rather than pushing them to the top of the page or
12106 to some user specified location.
12107 In fact if you change the float placement settings they are simply ignored.
12110 \begin_layout Subsubsection
12111 Page Headers and Footers
12112 \begin_inset CommandInset label
12114 name "sec:foilfoot"
12121 \begin_layout Standard
12125 \begin_inset space ~
12134 are two commands used to control the left-footer text string.
12135 The first is meant to allow you to include a graphic logo on your foils
12137 \begin_inset Quotes eld
12142 Foil\SpecialChar TeX
12146 \begin_inset Quotes erd
12150 While the second is meant to provide a classification for the audience,
12154 \begin_inset space \thinspace{}
12160 \begin_inset space \space{}
12164 It is empty by default.
12167 \begin_layout Standard
12168 The remaining page corners can be filled by
12171 \begin_inset space ~
12176 (which defaults to page numbers),
12179 \begin_inset space ~
12187 \begin_inset space ~
12195 \begin_layout Subsection
12198 Foil\SpecialChar TeX
12202 \begin_inset CommandInset label
12204 name "sec:unsuppfoils"
12211 \begin_layout Standard
12212 All the commands mentioned below need to be set in a
12222 within another environment.
12225 \begin_layout Subsubsection
12229 \begin_layout Standard
12230 All lengths are adjusted using the
12253 should be replaced by the name given to the length you want to change and
12258 is the length value.
12259 All lengths should be specified in units of length such as inches (
12271 ) or relative to some document or font-based length such as
12281 \begin_layout Standard
12282 It's possible to change the spacing between a foilhead and the body of the
12283 foil by adjusting the length specified by
12290 For example, to make
12295 \begin_inset space \space{}
12298 in closer to their bodies put the following in the preamble:
12304 foilheadskip}{-0.5in}
12307 \begin_layout Standard
12308 The spacings around floats can be adjusted by setting these lengths:
12311 \begin_layout Labeling
12312 \labelwidthstring MMMMMMMMMMM
12319 Separation between the text and the top of the float
12322 \begin_layout Labeling
12323 \labelwidthstring MMMMMMMMMMM
12330 Separation between the float and the caption
12333 \begin_layout Labeling
12334 \labelwidthstring MMMMMMMMMMM
12341 Separation between the caption and the following text
12344 \begin_layout Labeling
12345 \labelwidthstring MMMMMMMMMMM
12352 You can make the captions narrower than the surrounding text by adjusting
12354 Best done relative to
12363 \begin_layout Standard
12364 There are also several title page related lengths that you may find useful
12365 if you have a long title or several authors:
12368 \begin_layout Labeling
12369 \labelwidthstring MMMMMMMMMMM
12376 Separation from headers to
12381 \begin_layout Labeling
12382 \labelwidthstring MMMMMMMMMMM
12400 \begin_layout Labeling
12401 \labelwidthstring MMMMMMMMMMM
12415 \begin_layout Labeling
12416 \labelwidthstring MMMMMMMMMMM
12432 \begin_layout Labeling
12433 \labelwidthstring MMMMMMMMMMM
12449 \begin_layout Standard
12450 The last length related command affects all the list environments.
12461 a list environment then all the vertical spacing between the list items
12463 Note that this is a command not a length so it doesn't require
12469 like the stuff mentioned above.
12472 \begin_layout Subsubsection
12473 Headers and Footers
12476 \begin_layout Standard
12489 commands control whether the logo in the
12493 definition appear on a given page.
12500 in the preamble then none of the foils will have the logo on them.
12501 If you don't want the logo on a particular page place the
12507 directly after the foilhead of that page and the
12513 directly after the next foilhead.
12516 \begin_layout Standard
12517 If you decide to use the
12521 page style setting in the
12524 \begin_inset space ~
12529 dialog you should probably add
12539 to your preamble so headers and footers on landscape pages are correctly
12540 placed when rotated.
12541 This is due to some clashes between the page layouts provided by the
12552 \begin_layout Section
12553 Hollywood (Hollywood spec scripts)
12556 \begin_layout Standard
12562 \begin_layout Subsection
12566 \begin_layout Standard
12567 Getting the format of a Hollywood script right is a
12568 \begin_inset Quotes eld
12572 \begin_inset Quotes erd
12575 It is designed to make the readers focus on content and to be easy and
12576 familiar for the actors to read.
12577 Each page of a script should be one minute of film.
12578 Nothing goes in a script that you cannot see or hear on screen.
12579 The courier 12 pt font should be used throughout.
12583 \begin_layout Subsection
12587 \begin_layout Standard
12588 Speakers' lines should NEVER break in mid-sentence.
12589 If a speaker's lines continue over a page break, repeat the
12593 title followed by (Cont'd).
12596 \begin_layout Subsection
12600 \begin_layout Standard
12605 names as labels then cross-reference the label to insert the name.
12606 The cross-reference dialog will show the current cast of characters.
12607 You can use this to insert the speaker name in narratives also.
12610 \begin_layout Subsection
12611 Paper size and Margins
12614 \begin_layout Standard
12615 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12618 \begin_layout Subsection
12622 \begin_layout Standard
12623 The following environments are available.
12624 You can use hollywood.bind to get the bind keys shown at the right.
12627 \begin_layout Itemize
12631 \begin_inset Newline newline
12636 Used where nothing else works.
12640 \begin_layout Itemize
12646 \begin_inset space \hfill{}
12654 \begin_inset Newline newline
12657 Usually followed by something like
12658 \begin_inset Quotes eld
12661 on Sally waking up.
12662 \begin_inset Quotes erd
12668 \begin_layout Itemize
12672 \begin_inset space \hfill{}
12676 \begin_inset Newline newline
12681 Introduces a new INTERIOR camera set-up.
12682 Always followed by DAY or NIGHT, or something similar to define the lighting
12684 Everthing on this line in CAPS.
12687 \begin_layout Itemize
12691 \begin_inset space \hfill{}
12695 \begin_inset Newline newline
12700 Introduces a new EXTERIOR camera set-up.
12701 Everthing on this line in CAPS.
12704 \begin_layout Itemize
12708 \begin_inset space \hfill{}
12712 \begin_inset Newline newline
12717 The character speaking.
12720 \begin_layout Itemize
12724 \begin_inset space \hfill{}
12728 \begin_inset Newline newline
12733 Instructions to the speaker.
12734 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12736 Both will be printed.
12739 \begin_layout Itemize
12743 \begin_inset space \hfill{}
12747 \begin_inset Newline newline
12759 \begin_layout Itemize
12763 \begin_inset space \hfill{}
12767 \begin_inset Newline newline
12772 Camera movement instruction.
12774 \begin_inset space \thinspace{}
12778 \begin_inset space \space{}
12784 \begin_layout Itemize
12788 \begin_inset space \hfill{}
12794 \begin_layout Itemize
12798 \begin_inset space \hfill{}
12804 \begin_layout Itemize
12808 \begin_inset space \hfill{}
12814 \begin_layout Itemize
12818 \begin_inset space \hfill{}
12824 \begin_layout Subsection
12828 \begin_layout Itemize
12832 \begin_layout Itemize
12836 \begin_layout Itemize
12838 \begin_inset space \thinspace{}
12845 \begin_layout Itemize
12850 \begin_layout Itemize
12851 PAN — camera movement
12854 \begin_layout Itemize
12855 INSERT — cut to close-up of
12858 \begin_layout Section
12862 \begin_layout Standard
12865 Panayotis Papasotiriou
12868 \begin_layout Subsection
12872 \begin_layout Standard
12873 The ijmpc package is a set of macros that facilitates electronic manuscript
12876 International Journal of Modern Physics C
12879 Similarly, the ijmpd package is for creating manuscripts to be submitted
12882 International Journal of Modern Physics D
12885 Both journals are published by World Scientific.
12886 The corresponding document classes are named
12895 These files, together with instructions for the authors, can be downloaded
12897 \begin_inset Flex URL
12900 \begin_layout Plain Layout
12902 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12908 \begin_inset Flex URL
12911 \begin_layout Plain Layout
12913 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12919 Both packages are modified versions of the standard
12920 \begin_inset Quotes eld
12924 \begin_inset Quotes erd
12927 package, and they are almost (but not exactly) identical.
12928 Most of their features are supported by \SpecialChar LyX
12930 I have used \SpecialChar LyX
12931 successfully to write articles submitted to both journals
12932 without any problem.
12935 \begin_layout Subsection
12939 \begin_layout Standard
12940 As usual, the easiest way to write a paper is to start with a template.
12943 File\SpecialChar menuseparator
12959 This will give an (almost) empty document that includes the most common
12960 fields found in a manuscript.
12961 Simply overwrite the existing text (including the brackets,
12966 You should keep in mind the following remarks.
12969 \begin_layout Enumerate
12971 won't let you change the font size and the page style of the document,
12972 because such modifications are not allowed by both packages.
12975 \begin_layout Enumerate
12976 The language of the document should not be changed.
12977 Before previewing your paper, be sure that the babel package is not used.
12978 To do this, click on
12980 Tools\SpecialChar menuseparator
12991 checkbox in the language settings, and click on
12999 , if you wish to make this change permanent).
13002 \begin_layout Enumerate
13004 \begin_inset Quotes eld
13008 \begin_inset Quotes erd
13011 style must be used to define keywords.
13014 \begin_layout Enumerate
13015 The ijmpc package provides a style named
13016 \begin_inset Quotes eld
13019 Classification Codes
13020 \begin_inset Quotes erd
13023 , which can be used to define classification codes, such as PACS numbers.
13024 Note that this facility is not supported by the ijmpd package.
13027 \begin_layout Enumerate
13028 Several new environments are available:
13029 \begin_inset Quotes eld
13033 \begin_inset Quotes erd
13037 \begin_inset Quotes eld
13041 \begin_inset Quotes erd
13045 \begin_inset Quotes eld
13049 \begin_inset Quotes erd
13053 \begin_inset Quotes eld
13057 \begin_inset Quotes erd
13061 \begin_inset Quotes eld
13065 \begin_inset Quotes erd
13069 \begin_inset Quotes eld
13073 \begin_inset Quotes erd
13077 \begin_inset Quotes eld
13081 \begin_inset Quotes erd
13085 \begin_inset Quotes eld
13089 \begin_inset Quotes erd
13093 \begin_inset Quotes eld
13097 \begin_inset Quotes erd
13101 \begin_inset Quotes eld
13105 \begin_inset Quotes erd
13109 \begin_inset Quotes eld
13113 \begin_inset Quotes erd
13117 \begin_inset Quotes eld
13121 \begin_inset Quotes erd
13125 \begin_inset Quotes eld
13129 \begin_inset Quotes erd
13133 \begin_inset Quotes eld
13137 \begin_inset Quotes erd
13141 Their use is more or less obvious.
13143 supports all these environments; it will use the proper label, text style,
13144 and numbering scheme for each of them.
13147 \begin_layout Enumerate
13148 Both packages use basic citations; the natbib package should not be used.
13149 In \SpecialChar LyX
13150 , citation references are shown as usual; in the output, citations are
13151 shown as superscripts.
13152 If you want to use a citation as normal text, you should use the
13157 \begin_inset space \thinspace{}
13161 \begin_inset space \space{}
13165 \begin_inset Quotes eld
13169 \begin_inset space \space{}
13179 \begin_inset Quotes erd
13185 \begin_layout Enumerate
13187 \begin_inset Quotes eld
13191 \begin_inset Quotes erd
13194 section in both packages.
13195 To put acknowledgments, just use the
13196 \begin_inset Quotes eld
13200 \begin_inset Quotes erd
13206 \begin_layout Enumerate
13207 Appendices may be added to the paper,
13211 the Acknowledgments and
13217 provides a special environment, called
13218 \begin_inset Quotes eld
13222 \begin_inset Quotes erd
13225 which marks the beginning of the appendices.
13226 This environment should be left blank; it just sends a \SpecialChar LaTeX
13227 command, but nothing
13229 In \SpecialChar LyX
13231 \begin_inset Quotes eld
13235 \begin_inset Quotes erd
13238 is printed with blue letters, as a signal that all sections after that
13239 point are appendices.
13240 To write an appendix, use the
13241 \begin_inset Quotes eld
13245 \begin_inset Quotes erd
13250 will number each appendix with capital letters, as required by both journals.
13252 \begin_inset Quotes eld
13256 \begin_inset Quotes erd
13263 be present before the first appendix; if not, all appendices will be numbered
13264 as normal sections in the output.
13267 \begin_layout Enumerate
13268 The ijmpc and the ijmpd packages use the
13272 command to implement table captions.
13273 As a result, a table created by \SpecialChar LyX
13274 is printed correctly, but its caption
13276 However, you can use some \SpecialChar TeX
13277 code to overcome this problem, so that captions
13278 are printed as expected.
13279 To do so, create a float table as usual, remove the caption, and replace
13280 it with the \SpecialChar TeX
13291 (sic); you must also the \SpecialChar TeX
13296 immediately after the tabular material.
13297 Study the example table included in the template files to see how this
13298 trick is implemented.
13299 Alternatively, If you need table captions, you should implement the whole
13304 file, then include this file to the \SpecialChar LyX
13307 Insert\SpecialChar menuseparator
13308 File\SpecialChar menuseparator
13310 \begin_inset space ~
13316 Details on how to create a table float can be found in the files
13324 , included in the corresponding packages.
13327 \begin_layout Subsection
13328 Preparing a paper for submission
13331 \begin_layout Standard
13332 Before you submit your paper you must export the \SpecialChar LyX
13333 document as a \SpecialChar LaTeX
13336 File\SpecialChar menuseparator
13337 Export\SpecialChar menuseparator
13345 \begin_layout Plain Layout
13346 Actually you have the choice between \SpecialChar LaTeX
13347 (plain) and pdflatex.
13348 If you intend to use pdflatex to prepare the paper, you should use the
13349 pdflatex option so that included graphics are converted to PDF format,
13350 ready for use by pdflatex.
13355 , then make the following changes to the resulting
13362 \begin_layout Enumerate
13363 Remove the comment lines before the
13372 \begin_layout Enumerate
13373 Remove everything between (and including) the
13385 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13389 \begin_layout Standard
13394 file should be saved and processed through \SpecialChar LaTeX
13395 as many times as necessary.
13396 You may also want to check the resulting
13403 \begin_layout Subsection
13404 Use of \SpecialChar TeX
13408 \begin_layout Standard
13409 The use of \SpecialChar TeX
13410 code is reduced to two commands, which must be placed at the
13411 top of the document.
13412 If you started writing your paper by using the
13420 template, the \SpecialChar TeX
13421 code needed is already in its place; you usually don't need
13423 You may only modify the first \SpecialChar TeX
13424 code to specify the information printed
13425 to the top of odd and even pages (authors' names and short paper's title,
13427 This \SpecialChar TeX
13428 code must have the form
13432 markboth{Authors' Names}{Short Paper's Title}
13437 \begin_layout Section
13441 \begin_layout Standard
13447 \begin_layout Subsection
13451 \begin_layout Standard
13452 The iopart package provides a document class to create electronic manuscript
13453 submission to the journals published by the Institute of Physics.
13454 Instructions for the authors how to create a paper using the iopart class
13455 can be downloaded together with the iopart package from the site
13456 \begin_inset Flex URL
13459 \begin_layout Plain Layout
13461 ftp://ftp.iop.org/pub/journals/latex2e
13469 \begin_layout Subsection
13473 \begin_layout Standard
13474 The easiest way to write a paper is to start with the file
13478 that is available in \SpecialChar LyX
13479 's examples files folder.
13480 Open this file, save it under a new name, and start writing.
13481 The example file explains how to use the special text environments.
13482 Here are the most important advices:
13485 \begin_layout Itemize
13486 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13489 Use AMS math package
13491 in the document settings under
13498 \begin_layout Itemize
13501 The title environment defines the kind of your paper.
13502 So use one of the following environments for the title:
13506 \begin_layout Itemize
13515 \begin_layout Itemize
13524 \begin_layout Itemize
13530 for a Topical review
13533 \begin_layout Itemize
13542 \begin_layout Itemize
13551 \begin_layout Itemize
13557 for a Paper (same as Title)
13560 \begin_layout Itemize
13566 for a Preliminary communication
13569 \begin_layout Itemize
13575 for a Rapid communication
13578 \begin_layout Itemize
13584 for a Letter to the editor
13588 \begin_layout Itemize
13591 All title environments except of
13595 can have an optional short title.
13598 \begin_layout Itemize
13599 There is a general title environment
13603 which is not directly supported by the \SpecialChar LyX
13605 This can be used as \SpecialChar TeX
13606 code when your document doesn't fit into one of the
13610 \begin_layout Standard
13611 For more informations like hints for special table and formula formatting,
13612 look at the IOP author guidelines.
13615 \begin_layout Section
13619 \begin_layout Standard
13622 Panayotis Papasotiriou
13625 \begin_layout Subsection
13629 \begin_layout Standard
13630 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13631 that facilitates electronic manuscript submission to the journals they
13633 Most known of them (at least in my domain of interest) are
13635 Astrophysics and Space Science
13641 , but there are many others (see a complete list at
13642 \begin_inset Flex URL
13645 \begin_layout Plain Layout
13647 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13653 The Kluwer package may be downloaded from the site
13654 \begin_inset Flex URL
13657 \begin_layout Plain Layout
13659 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13665 A complete user guide is contained in that package (but it can also be
13666 downloaded separately).
13669 \begin_layout Standard
13671 supports many features of the package but not everything.
13672 However, the \SpecialChar TeX
13673 code needed is reduced to some
13674 \begin_inset Quotes eld
13678 \begin_inset Quotes erd
13681 commands of the package (see
13682 \begin_inset space ~
13686 \begin_inset CommandInset ref
13688 reference "subsec:kluwer_peculiarities"
13693 I have recently used \SpecialChar LyX
13694 to write an article submitted to the
13696 Astrophysics and Space Science
13698 without any problem.
13701 \begin_layout Subsection
13705 \begin_layout Standard
13706 The easiest way to write a paper is to start with the Kluwer template file.
13709 File\SpecialChar menuseparator
13721 This will give an (almost) empty document that includes the most common
13722 fields found in a manuscript and a short description of their use.
13723 As in most templates, simply overwrite the existing text (including the
13728 ) with the correct information.
13731 \begin_layout Subsection
13732 Preparing a paper for submission
13735 \begin_layout Standard
13736 As in the AAS\SpecialChar TeX
13737 package, before you submit your paper to a journal you must
13739 \begin_inset Quotes eld
13743 \begin_inset Quotes erd
13749 \begin_layout Enumerate
13750 Export your paper as a \SpecialChar LaTeX
13752 To do this, click on
13754 File\SpecialChar menuseparator
13755 Export\SpecialChar menuseparator
13763 \begin_layout Enumerate
13768 file with a text editor and make the following changes
13772 \begin_layout Enumerate
13773 remove the comment lines before the
13782 \begin_layout Enumerate
13783 remove everything between (and including) the
13795 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13799 \begin_layout Standard
13808 \begin_layout Enumerate
13813 file through \SpecialChar LaTeX
13814 as many times as necessary (usually up to three).
13817 \begin_layout Enumerate
13823 \begin_inset space \thinspace{}
13827 \begin_inset space \space{}
13834 , and check if everything is OK (it should, if you didn't make any mistake).
13837 \begin_layout Subsection
13838 \begin_inset Quotes eld
13842 \begin_inset Quotes erd
13845 of the Kluwer package
13846 \begin_inset CommandInset label
13848 name "subsec:kluwer_peculiarities"
13855 \begin_layout Standard
13856 The Kluwer package has the following
13857 \begin_inset Quotes eld
13861 \begin_inset Quotes erd
13867 \begin_layout Enumerate
13868 It is possible to write multiple articles in the same \SpecialChar LaTeX
13873 \begin_layout Plain Layout
13874 I can't imagine any good reason to do this.
13880 Each article must be included in the environment
13881 \begin_inset Quotes eld
13885 \begin_inset Quotes erd
13889 Unfortunately, this environment cannot be omitted, even if you write just
13891 Therefore, each article starts with the command
13897 and, obviously, ends with the command
13904 Although this can be implemented in \SpecialChar LyX
13905 , I didn't included it, since it looks
13906 ugly and can confuse the novice user.
13907 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13910 \begin_inset Quotes eld
13915 \begin_inset Quotes erd
13921 \begin_layout Enumerate
13922 Information given at the beginning of the article (i.
13923 \begin_inset space \thinspace{}
13927 \begin_inset space \space{}
13930 title, subtitle, author, institution, running title, running author, abstract
13931 and keywords) must be included in an environment called
13932 \begin_inset Quotes eld
13936 \begin_inset Quotes erd
13940 This is not implemented in \SpecialChar LyX
13941 , so you must enter title, subtitle etc.
13942 \begin_inset space ~
13945 between two \SpecialChar TeX
13961 \begin_layout Enumerate
13962 According to the user manual, the label of each bibliography item must be
13986 \begin_layout Standard
13991 template takes care of all these
13992 \begin_inset Quotes eld
13996 \begin_inset Quotes erd
14000 If you start a new paper using this template you don't need to do anything
14005 \begin_layout Enumerate
14006 don't delete the \SpecialChar TeX
14007 code included in the template, and
14010 \begin_layout Enumerate
14011 copy the example bibliography item included in the template and modify it
14012 as necessary to enter new bibliography items.
14015 \begin_layout Section
14019 \begin_layout Standard
14025 \begin_layout Subsection
14029 \begin_layout Standard
14030 The \SpecialChar LyX
14033 article (koma-script)
14037 report (koma-script)
14055 correspond to the \SpecialChar LaTeX
14073 \begin_inset space ~
14076 of the Koma-Script family.
14077 They are replacements for the standard document classes
14093 , resp., and fit better to European typography conventions in a number of
14097 \begin_layout Itemize
14098 Standard character size is 11pt in
14100 article (koma-script)
14104 report (koma-script)
14112 letter (koma-script)
14117 \begin_layout Itemize
14118 Headings, labels of the description environment, and a number of elements
14121 letter (koma-script)
14123 document class are set in a bold sans serif font.
14127 \begin_layout Plain Layout
14128 There is a big difference between the bold sans serif old cm fonts and new
14129 ec fonts, especially in the appearance of headings.
14130 In comparison, the ec bold sans serif fonts look a bit thin.
14131 Here the \SpecialChar LaTeX
14140 helps to produce the
14141 \begin_inset Quotes eld
14145 \begin_inset Quotes erd
14148 appearance when using the ec fonts.
14153 The numbering of chapter headings is made in the same way as the numbering
14154 of section headings, that is without the extra line
14155 \begin_inset Quotes eld
14158 Chapter\SpecialChar ldots
14160 \begin_inset Quotes erd
14164 In addition, the appearance of the headings can be modified by using a
14165 number of options (in \SpecialChar LyX
14166 to be entered in the field
14169 \begin_inset space ~
14176 Layout\SpecialChar menuseparator
14183 \begin_layout Itemize
14184 The main means in the Koma-Script document classes to design the type area
14193 (in \SpecialChar LyX
14194 to be entered in the extra class options field in the dialog
14196 Document\SpecialChar menuseparator
14200 They make a clearer modification of page margins possible as do the options
14203 Document\SpecialChar menuseparator
14210 \begin_layout Itemize
14211 The \SpecialChar LaTeX
14212 document classes of the Koma-Script family define a number of additional
14214 Those part of it which makes sense in \SpecialChar LyX
14215 is implemented in corresponding
14219 \begin_layout Standard
14220 Detailed descriptions of the \SpecialChar LaTeX
14221 document classes of the Koma-Script family
14222 can be found in the Koma-Script documentation
14233 \begin_layout Subsection
14234 article (koma-script), report (koma-script), and book (koma-script)
14237 \begin_layout Standard
14238 The document classes
14240 article (koma-script)
14244 report (koma-script)
14254 are implemented in the layout files
14267 They contain all the paragraph types of the corresponding standard document
14280 , resp., partly modified, with the exception of the \SpecialChar LyX
14285 -type, which is replaced by the new
14289 -type having the same functionality.
14294 -Type there is a number of new paragraph types added.
14301 letter (koma-script)
14306 \begin_layout Itemize
14315 : are equivalents to
14323 , resp., additionally inserting an entry in the table of contents.
14332 are not contained in
14334 article (koma-script)
14339 \begin_layout Itemize
14348 : behave exactly as
14356 , resp., additionally clearing running heads.
14361 is not contained in
14363 article (koma-script)
14369 \begin_layout Plain Layout
14382 report (koma-script)
14384 , but since this is identical to
14388 , is has not been implemented in \SpecialChar LyX
14397 \begin_layout Itemize
14402 : generates a heading directly above the following paragraph in the standard
14403 character size without affecting the structure of the document.
14406 \begin_layout Itemize
14415 are special captions which respect the different space settings needed
14416 for captions placed above or below an element (if you follow strict typographic
14417 rules, you might want to place table captions always above the table).
14418 You can also use the class option
14422 , which will switch
14435 You need at least Koma-Script version 2.8q to use this.
14438 \begin_layout Itemize
14443 : can be used to set a bonmot, e.
14444 \begin_inset space \thinspace{}
14448 \begin_inset space \space{}
14451 at the beginning of a chapter.
14452 If you use the optional argument (
14454 Insert\SpecialChar menuseparator
14456 \begin_inset space ~
14461 ), you can insert the dictum's author there.
14462 Dictum and author are separated by a line.
14463 You need at least Koma-Script version 2.8q to use this.
14468 is not contained in
14470 article (koma-script)
14475 \begin_layout Standard
14476 The following types, together with the standard types
14488 , form the title area of the document.
14489 They must be entered ahead of the first
14490 \begin_inset Quotes eld
14494 \begin_inset Quotes erd
14501 \begin_layout Plain Layout
14502 The corresponding \SpecialChar LaTeX
14503 commands must appear before the
14514 When such a type is used more than once, the latter usage overwrites the
14515 former one, that means, for every type only the latest usage is valid.
14516 The order of the different types however has, like
14528 , no effect on the appearance of the produced document.
14531 \begin_layout Itemize
14536 : produces a centered paragraph above the ordinary title (
14548 ) for the subject of the document.
14551 \begin_layout Itemize
14556 : produces a centered paragraph below the ordinary title (
14568 ) for the publishers' name.
14571 \begin_layout Itemize
14578 report (koma-script)
14584 produces a centered paragraph on its own page behind the title page, or
14587 article (koma-script)
14589 produces a centered paragraph below the ordinary title (
14605 ) for a dedication.
14608 \begin_layout Itemize
14613 : produces a left aligned paragraph above the ordinary title (
14629 ) for a document`s head.
14632 \begin_layout Itemize
14637 : produces in a double-sided print in
14639 report (koma-script)
14645 a left-aligned paragraph at the top of the title page`s back or has no
14646 effect in a single-sided print or in
14648 article (koma-script)
14653 \begin_layout Itemize
14658 : produces in a double-sided print in
14660 report (koma-script)
14666 a left-aligned paragraph at the bottom of the title page`s back or has
14667 no effect in a single-sided print or in
14669 article (koma-script)
14674 \begin_layout Itemize
14679 : produces a special
14680 \begin_inset Quotes eld
14684 \begin_inset Quotes erd
14687 page ahead of the actual document containing a paragraph without special
14691 \begin_layout Standard
14692 The layout files for the document classes
14694 article (koma-script)
14698 report (koma-script)
14704 do include the file
14709 This is thought of as a place to define your own types.
14714 in your personal layout directory and edit the file!
14717 \begin_layout Subsection
14718 letter (koma-script)
14721 \begin_layout Standard
14725 letter (koma-script)
14727 is implemented in the layout file
14732 It contains all the paragraph types of the corresponding standard document
14737 , partly modified, with the exception of the \SpecialChar LyX
14751 type, which is replaced by the new
14756 In addition, it contains, in contrast to the standard document class, the
14775 Furthermore, there are a number of new letter specific types.
14778 \begin_layout Standard
14779 The appearance of the letter produced by this document class can be controlled
14780 by a number of \SpecialChar LaTeX
14781 commands, which you can put in the \SpecialChar LaTeX
14786 \begin_layout Plain Layout
14787 For example, the standard appearance of the letter`s heading, consisting
14788 of name and address, is quite self-willed.
14790 \begin_inset Quotes eld
14794 \begin_inset Quotes erd
14797 heading is produced by the following \SpecialChar LaTeX
14798 commands in the preamble:
14801 \begin_layout LyX-Code
14811 \begin_layout LyX-Code
14827 \begin_layout LyX-Code
14837 \begin_layout LyX-Code
14857 A detailed German description of such \SpecialChar LaTeX
14858 commands can be found in the Koma-Script
14864 With it, the letter's author can produce his personal letter layout.
14867 \begin_layout Standard
14876 define the beginning of the letter and must be used in every letter.
14877 To emphasize them in the \SpecialChar LyX
14878 document class, they are marked with the letter
14888 \begin_inset space ~
14891 in the left margin.
14892 It is possible to write any number of letters in one file.
14897 type produces a new letter using the same addressee and a
14901 type produces a new addressee.
14918 are ordinary paragraph types and can also be used several times in one
14919 and the same letter.
14922 \begin_layout Itemize
14927 : produces a paragraph for the addressee and implicitly defines the beginning
14931 \begin_layout Itemize
14936 : produces a paragraph for the form of address and implicitly produces a
14940 \begin_layout Itemize
14945 : produces a paragraph for a close.
14948 \begin_layout Itemize
14953 : produces a paragraph for a postscript.
14956 \begin_layout Itemize
14961 : produces a paragraph for a distribution list.
14964 \begin_layout Itemize
14969 : produces a paragraph for enclosures.
14972 \begin_layout Standard
15013 are input types provided with a label to enter information, which will
15014 be processed by the document class.
15018 \begin_layout Plain Layout
15019 It could be seen as a matter of inconsequence, that the types
15027 described above are not such input types as well.
15028 Because of the special meaning of those types, however, I have implemented
15029 them as ordinary paragraph types with a one letter mark in the left margin.
15030 Moreover, it would affect my feeling of symmetry, if the
15038 type had such a serious different appearance.
15043 The types must be used ahead of the corresponding
15050 \begin_layout Standard
15051 An implementation of these types in a WYSIWYG fashion does not seem to make
15052 sense, because the real appearance of the produced letter does not only
15053 depend on the usage of the particular type, but also on other factors.
15054 For example, a signature entered in the
15058 type will in the standard behavior appear in the produced letter only,
15059 when in the same letter also a
15064 The entered value of the
15068 type will in the standard behavior not appear in the produced letter at
15070 The possibility to design the letter`s heading freely is already indicated
15071 in a footnote above.
15074 \begin_layout Standard
15075 The input types can also be used as empty paragraphs.
15076 This makes sense e.
15077 \begin_inset space \thinspace{}
15081 \begin_inset space \space{}
15093 type is not used at all, in the standard behavior the value of the
15097 type is used as signature, whereas if an empty
15101 type is used, no signature value is defined.
15104 \begin_layout Standard
15105 By using the input types it is possible to write a letter template, containing
15106 filled input types with your personal dates (name, address, etc.) and empty
15107 input types for other dates you want to enter.
15110 \begin_layout Itemize
15115 : sender's name, in the standard behavior appears as a centered paragraph
15116 in small caps in the letter`s heading.
15119 \begin_layout Itemize
15124 : sender's signature, in the standard behavior appears below the
15133 type is used, the value of the
15137 type appears instead.
15140 \begin_layout Itemize
15145 : sender's address, in the standard behavior appears in a centered paragraph
15146 in the letter`s heading below the sender's name.
15149 \begin_layout Itemize
15154 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15165 \begin_layout Itemize
15170 : place of the letter`s making.
15173 \begin_layout Itemize
15178 : date of the letter`s making.
15187 , in the standard behavior, produce the place and the date in a right-aligned
15188 line below the addressee's field.
15193 type is used, neither place nor date appear, independent of the value of
15203 type is used, the date of the letter `s production is used.
15206 \begin_layout Itemize
15211 : sender`s back address, in the standard behavior appears above the addressee's
15212 field in a small sans serif font.
15215 \begin_layout Itemize
15220 : special mail information, in the standard behavior appears underlined
15221 above the addressee's field below the back address.
15224 \begin_layout Itemize
15229 : additional information, in the standard behavior appears on right side
15230 below the addressee`s field.
15233 \begin_layout Itemize
15238 : the letter's title, in the standard behavior appears in a big, bold, sans
15239 serif font above the subject.
15242 \begin_layout Itemize
15247 : the letter's subject, in the standard behavior appears in a bold font
15255 \begin_layout Standard
15276 produce a business letter like line above the
15280 line containing the fields
15281 \begin_inset Quotes eld
15285 \begin_inset Quotes erd
15289 \begin_inset Quotes eld
15293 \begin_inset Quotes erd
15297 \begin_inset Quotes eld
15301 \begin_inset Quotes erd
15305 \begin_inset Quotes eld
15309 \begin_inset Quotes erd
15313 \begin_inset Quotes eld
15317 \begin_inset Quotes erd
15321 \begin_inset Quotes eld
15325 \begin_inset Quotes erd
15329 For the date field, the value of the
15335 \begin_inset Quotes eld
15338 business letter types
15339 \begin_inset Quotes erd
15342 is used, the value of the
15346 type however does not appear, but only the \SpecialChar LaTeX
15354 The ordinary output of place and date in a right-aligned line below the
15355 addressee`s field is suppressed.
15356 The types are implemented as input types provided with a label and must
15357 be used ahead of the corresponding
15364 \begin_layout Itemize
15372 \begin_layout Itemize
15380 \begin_layout Itemize
15388 \begin_layout Itemize
15396 \begin_layout Itemize
15404 \begin_layout Subsection
15405 The new letter class: letter (koma-script v.2)
15408 \begin_layout Standard
15414 \begin_layout Standard
15415 \begin_inset VSpace medskip
15421 \begin_layout Standard
15423 Koma-Script version 2.8 has introduced a new letter class
15427 which supersedes the now unsupported
15432 It has — on the \SpecialChar LaTeX
15433 side — a completely new interface and is not compatible
15434 with the old class.
15435 Therefore, \SpecialChar LyX
15436 supports both, though it is recommended you use the new class.
15439 \begin_layout Standard
15440 This class covers the same functionality as
15442 letter (koma-script),
15445 The basic items are
15449 (receiver's address, same as
15453 in the old layout),
15466 will start a new letter (i.
15467 \begin_inset space \thinspace{}
15471 \begin_inset space \space{}
15474 you can write several letters per document).
15475 New elements are sender's
15491 and the possibility to use a
15497 Insert\SpecialChar menuseparator
15503 \begin_layout Standard
15504 The biggest improvement is, though, that the letter's layout is configurable
15505 to meet almost any needs.
15506 This can be done via the preamble or with a special style file (Letter
15507 Class Option, extension
15511 ), that will be read in as a class option.
15515 \begin_layout Plain Layout
15516 The KOMA package comes with some default
15521 There is, for instance, a
15525 file that follows german typesetting rules, or a
15529 that provides the default layout of the old
15534 The latter can be loaded with the class option
15540 Layout\SpecialChar menuseparator
15541 Document\SpecialChar menuseparator
15553 template that is included in \SpecialChar LyX
15555 A detailed description is to be found in the Koma-Script documentation
15563 \begin_layout Subsection
15567 \begin_layout Standard
15568 Visualizing the Koma-Script document classes in \SpecialChar LyX
15569 , the \SpecialChar LyX
15570 internals cause some
15574 \begin_layout Itemize
15575 The chapter number of a
15579 type appears on a line of its own above the chapter heading instead of
15580 appearing in the same line ahead of it.
15581 The cause for that is the \SpecialChar LyX
15582 internal behavior for the labeltype
15586 in the layout file.
15589 \begin_layout Itemize
15590 The headings of the types
15598 are only put in the
15599 \begin_inset Quotes eld
15603 \begin_inset Quotes erd
15607 table of contents, but not in the \SpecialChar LyX
15608 table of contents (
15610 Document\SpecialChar menuseparator
15612 \begin_inset space ~
15616 \begin_inset space ~
15624 \begin_layout Itemize
15625 The paragraphs in a
15629 document class appear in a skip separation mode, not indented.
15630 This is the standard behavior, no special \SpecialChar LaTeX
15631 commands are needed for that.
15634 Document\SpecialChar menuseparator
15637 dialog the corresponding radio button indicates
15646 value always has the effect that extra \SpecialChar LaTeX
15647 commands are inserted in the document
15648 to produce the gap, which is not what is wanted in this case.
15651 \begin_layout Section
15655 \begin_layout Standard
15661 \begin_layout Subsection
15665 \begin_layout Standard
15666 Memoir is a very powerful and constantly evolving class.
15667 It has been designed with regard to fictional and non-fictional literature.
15668 Its aim is to let the user have maximum control over the typesetting of
15670 Memoir is based on the standard book class, but it can also emulate the
15671 article class (see below).
15674 \begin_layout Standard
15675 Peter Wilson, the developer of Memoir, is known as the author of lots of
15676 useful packages in the \SpecialChar LaTeX
15678 Most of them have been merged with Memoir.
15679 Therefore, it is much easier to layout the table of contents, appendices,
15680 chapter designs and such.
15682 , though, does not support all of these goodies natively.
15683 Some of them might be added to forthcoming releases
15687 \begin_layout Plain Layout
15688 You are invited to send suggestions to
15689 \begin_inset Flex URL
15692 \begin_layout Plain Layout
15694 lyx-devel@lists.lyx.org
15704 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15706 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15708 commands (\SpecialChar TeX
15713 \begin_layout Plain Layout
15718 \begin_layout Plain Layout
15728 \begin_inset space ~
15732 \begin_inset CommandInset ref
15734 reference "sec:Inserting-TeX-Code"
15744 In this section, we can only list those features that are natively supported
15745 by \SpecialChar LyX
15747 For detailed descriptions (and for the rest of features) we recommend you
15748 have a look at the detailed manual of the Memoir class
15752 \begin_layout Plain Layout
15757 \begin_layout Plain Layout
15767 \begin_inset Flex URL
15770 \begin_layout Plain Layout
15772 CTAN:/macros/latex/memoir/memman.pdf
15782 , which is not only a user guide for the class, but also both a comprehensive
15783 description on good typesetting and a superb example for good typesetting
15787 \begin_layout Subsection
15788 Basic features and restrictions
15791 \begin_layout Standard
15792 Memoir supports basically all features of the standard book classes.
15793 There are, however, some differences, as follows:
15796 \begin_layout Description
15798 \begin_inset space ~
15801 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15804 \begin_layout Description
15806 \begin_inset space ~
15809 style: The fancy page style is not supported, due to a command clash between
15810 Memoir and the fancyhdr package (they both define a command with the same
15811 name, which confuses \SpecialChar LaTeX
15813 Instead, Memoir comes with a number of its own page styles (see
15815 Layout\SpecialChar menuseparator
15816 Document\SpecialChar menuseparator
15818 \begin_inset space ~
15824 If you want to use these for the chapter pages, you have to use the command
15831 in the main text or in preamble (e.
15832 \begin_inset space \thinspace{}
15836 \begin_inset space \space{}
15843 chapterstyle{companion}
15848 \begin_layout Description
15849 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15850 optional argument in the standard classes.
15851 With this, you can specify an alternative version of the title for the
15852 table of contents and the headers (for instance, if the title is too long).
15853 In \SpecialChar LyX
15854 , you can do this via
15856 Insert\SpecialChar menuseparator
15858 \begin_inset space ~
15863 at the beginning of a chapter/section.
15864 Memoir features a second optional argument and thus separates the table
15865 of contents from the header.
15866 You can define three variants of a title with this: one for the main text,
15867 one for the table of contents, and one for the headers.
15868 Simply insert two optional arguments if you need this feature, the first
15869 one containing the short title for the Table of Contents, the second one
15870 containing an alternative short title for the headers.
15873 \begin_layout Description
15874 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15875 of contents, the list of figures and the list of table start a new page
15877 Memoir does not follow this route.
15878 You have to insert a page break yourself, if you want to have one.
15881 \begin_layout Description
15882 Titlepage: For some unknown reason, Memoir uses pagination on the title
15883 page (in the standard classes, title pages are
15884 \begin_inset Quotes eld
15888 \begin_inset Quotes erd
15892 If you want an empty title page, type
15896 aliaspagestyle{title}{empty}
15901 \begin_layout Description
15902 Article: With the class option
15908 Layout\SpecialChar menuseparator
15909 Document\SpecialChar menuseparator
15911 \begin_inset space ~
15916 ), you can emulate article style.
15917 That is, counters (footnotes, figures, tables etc.) will not be reset on
15918 new chapters, chapters don't start a new page (but are—in contrary to
15919 \begin_inset Quotes eld
15923 \begin_inset Quotes erd
15926 article classes—still allowed), parts, though, use their own page, as in
15930 \begin_layout Description
15931 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15932 font commands, which have been used in the old \SpecialChar LaTeX
15934 \begin_inset space \thinspace{}
15938 \begin_inset space \space{}
15954 It produces an error and stops \SpecialChar LaTeX
15955 whenever such a command appears.
15960 reallows the commands and spits out warnings instead (which does at least
15961 not stop \SpecialChar LaTeX
15963 Since a lot of packages and particularly Bib\SpecialChar TeX
15964 style files are still using
15965 those commands, we have decided to use this option by default.
15968 \begin_layout Subsection
15972 \begin_layout Standard
15973 We will only describe the features supported by \SpecialChar LyX
15974 (which is not much currently).
15975 Please consult the Memoir manual
15979 \begin_layout Plain Layout
15984 \begin_layout Plain Layout
15994 \begin_inset Flex URL
15997 \begin_layout Plain Layout
15999 CTAN:/macros/latex/memoir/memman.pdf
16012 \begin_layout Description
16013 Abstract: You may wonder why an abstract is an extra feature.
16014 Well, it is in book class.
16015 Usually books don't have abstracts.
16016 Memoir, however, has.
16017 You can use it wherever and how often you like.
16020 \begin_layout Description
16021 Chapterprecis: You may know this older typesetting style: The contents of
16022 a chapter are summarized below the title and also in the table of contents
16024 \begin_inset space \thinspace{}
16028 \begin_inset space \space{}
16033 Our hero arrives in Troia; he loses some friends; he finds others
16036 Chapterprecis does exactly this.
16037 It is therefore only sensible below a chapter.
16040 \begin_layout Description
16041 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16042 The epigraph environment provides an elegant way of typesetting such a
16044 The motto itself (text) and its author (source) are divided by a short
16046 Unfortunately, we have to fool \SpecialChar LyX
16047 a bit here again, since the environment
16048 needs two arguments (text and source).
16049 In this case, we have to use curly brackets (in \SpecialChar TeX
16050 mode) between the two
16061 <author of the slogan>.
16064 \begin_layout Description
16065 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16066 complex figurative poems).
16068 can only support a few of them.
16069 One is poemtitle, which is a centered title for poems, which will also
16070 be added to the table of contents (verse is the standard environment for
16072 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16074 because they have to be nested inside regular verse environments, which
16075 is not possible with \SpecialChar LyX
16079 \begin_layout Description
16080 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16083 \begin_layout Section
16084 Article (mwart), book (mwbk) and report (mwrep)
16085 \begin_inset Argument status
16088 \begin_layout Plain Layout
16101 \begin_layout Standard
16107 \begin_layout Standard
16108 The \SpecialChar LyX
16125 correspond to the \SpecialChar LaTeX
16139 They are replacements for the standard document classes
16151 , resp., and fit better to Polish typography conventions in a number of points.
16155 \begin_layout Standard
16159 \begin_layout Itemize
16160 Unnumbered titles (with star, e.
16161 \begin_inset space \thinspace{}
16165 \begin_inset space \space{}
16172 ) are added into table of contents,
16175 \begin_layout Itemize
16176 Additional page styles:
16180 \begin_layout Description
16181 uheadings header with separated lines,
16184 \begin_layout Description
16185 myheadings custom header, contents headers via commands:
16200 \begin_layout Description
16201 myuheadings custom header with separated lines,
16204 \begin_layout Description
16205 outer page number is placed on outer side of page
16209 \begin_layout Itemize
16214 \begin_layout Description
16215 rmheadings serif titles — default,
16218 \begin_layout Description
16219 sfheadings sansserif titles,
16222 \begin_layout Description
16223 authortitle on title page first placed is author next title — default,
16226 \begin_layout Description
16227 titleauthor on title page first placed is title next author,
16230 \begin_layout Description
16231 withmarginpar reserve place on page for margins.
16235 \begin_layout Section
16239 \begin_layout Standard
16244 provides an alternative to the standard
16249 It provides similar functionality, but you might prefer this layout with
16250 sans serif sections, headings, and more.
16253 \begin_layout Section
16254 Rev\SpecialChar TeX
16258 \begin_layout Standard
16264 \begin_layout Standard
16265 \begin_inset VSpace bigskip
16271 \begin_layout Standard
16276 \begin_inset space ~
16281 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16283 \begin_inset Formula $\beta$
16286 release of May, 1999) class.
16289 \begin_layout Standard
16295 textclass, which works with Rev\SpecialChar TeX
16297 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16299 That means that it doesn't interact very well with \SpecialChar LyX
16300 , which requires \SpecialChar LaTeX2e
16302 it has been kludged to work.
16303 Since Rev\SpecialChar TeX
16304 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16309 Rev\SpecialChar TeX
16311 \begin_inset space ~
16316 textclass should also be pretty easy to use.
16319 \begin_layout Standard
16320 These documents are supposed to be used in
16324 to the Rev\SpecialChar TeX
16325 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16327 and assume you'll know what to put in the preamble if necessary.
16330 \begin_layout Subsection
16334 \begin_layout Standard
16335 All you need to do is install Rev\SpecialChar TeX
16336 4, as described in the package's README
16338 The package can be found at The Rev\SpecialChar TeX
16340 \begin_inset Flex URL
16343 \begin_layout Plain Layout
16345 http://publish.aps.org/revtex4/
16351 Install it somewhere that \SpecialChar LaTeX
16353 Test it by trying to \SpecialChar LaTeX
16354 a short Rev\SpecialChar TeX
16355 4 document in some random directory (i.
16356 \begin_inset space \thinspace{}
16360 \begin_inset space \space{}
16363 not the directory where you installed the class file.) Then, if you reconfigure
16365 , it will find the class file and let you use the Rev\SpecialChar TeX
16369 \begin_layout Standard
16370 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16379 \begin_inset space ~
16384 template, found in the templates directory.
16387 \begin_layout Subsection
16391 \begin_layout Standard
16392 Optional arguments to
16399 \begin_inset Quotes eld
16403 \begin_inset Quotes erd
16407 \begin_inset Quotes eld
16411 \begin_inset Quotes erd
16417 \begin_inset space ~
16425 \begin_inset space ~
16431 Remember that in Rev\SpecialChar TeX
16432 , at least one optional argument is required!
16435 \begin_layout Standard
16436 Other preamble matter, like
16443 \begin_inset space ~
16450 \begin_inset space ~
16455 dialog, also as usual.
16458 \begin_layout Subsection
16462 \begin_layout Standard
16463 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16465 For example, the Email layout corresponds to
16472 Note that (at least as of Rev\SpecialChar TeX
16481 layouts are exactly equivalent, so you shouldn't need to use both.
16485 \begin_layout Plain Layout
16486 In case you're curious, both were included so that
16490 would be able to translate both
16510 \begin_layout Subsection
16514 \begin_layout Standard
16515 There are a couple of important unique aspects of Rev\SpecialChar TeX
16516 4 which might cause
16517 bugs that will be even more confusing in \SpecialChar LyX
16521 \begin_layout Standard
16522 In Rev\SpecialChar TeX
16540 The \SpecialChar LyX
16541 equivalent is that there is a separate Thanks layout.
16546 write footnotes in the
16550 layout, or weird things may happen.
16551 See the Rev\SpecialChar TeX
16552 4 documentation for more details.
16555 \begin_layout Standard
16559 \begin_inset space ~
16567 \begin_inset space ~
16576 layouts must be placed
16584 layout and the corresponding
16601 , the \SpecialChar LaTeX
16605 \begin_layout Subsection
16609 \begin_layout Standard
16610 The main problem with this layout is that you can't use the optional arguments
16611 to layouts like Email and Title.
16612 (The problem is not unique to this layout; you can't use optional arguments
16613 to the Section layouts either.) This means that after you export that file
16614 to \SpecialChar LaTeX
16615 (which you'll need to do eventually to send it in to APS), you'll need
16616 to edit the \SpecialChar LaTeX
16617 file with a text editor to add the optional arguments to set,
16619 \begin_inset space \thinspace{}
16623 \begin_inset space \space{}
16626 the running title for the page headers.
16627 Lacking these layouts makes the
16633 (and the equivalent
16639 ) useless, so the corresponding layouts don't exist, and will have to be
16644 \begin_layout Plain Layout
16649 actually, \SpecialChar LyX
16650 1.3.0 supports some forms of optional arguments, but this layout
16651 has not been updated yet to take advantage of it.
16659 \begin_layout Section
16660 Springer Journals (
16667 \begin_layout Standard
16673 \begin_layout Subsection
16677 \begin_layout Standard
16678 These are the layout files for some of the journal formats used by Springer
16679 Verlag and listed on
16680 \begin_inset Flex URL
16683 \begin_layout Plain Layout
16685 http://www.springer.de/author/tex/help-journals.html
16690 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16692 It is a modular system: the things common to all journals are implemented
16697 , which journal-specific layout files (such as, e.
16698 \begin_inset space \thinspace{}
16702 \begin_inset space \space{}
16709 for Journal of Geodesy) can include.
16712 \begin_layout Standard
16713 This means that implementing support for any other Springer journal on this
16714 list is as simple as writing your own
16722 file following the outline given in
16730 \begin_layout Standard
16731 It is reasonably well tested only for the Journal of Geodesy.
16740 come with the standard \SpecialChar LyX
16742 Install the relevant class file (downloaded from Springer) in a proper
16743 directory, reconfigure \SpecialChar LaTeX
16744 (in the te\SpecialChar TeX
16749 , as root if necessary — doesn't \SpecialChar LyX
16750 take care of this?), reconfigure \SpecialChar LyX
16755 \begin_layout Subsection
16759 \begin_layout Standard
16760 A large number of theorem-like styles —
16772 \begin_layout Standard
16775 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16776 _Title, Author_Running, Institute,
16777 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16780 See the Springer class file documentation for details.
16783 \begin_layout Subsection
16787 \begin_layout Itemize
16799 \begin_layout Itemize
16802 Probability Theory and Related Fields
16808 — Jean-Marc Lasgouttes
16811 \begin_layout Standard
16812 Add your own, it isn't so hard!
16815 \begin_layout Subsection
16819 \begin_layout Standard
16820 These files are partly based on the older
16824 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16826 file from Springer.
16831 layout, are now defunct.
16832 Jean-Marc Lasgouttes helped out big in making me find my way around the
16834 layout file mechanism.
16837 \begin_layout Subsection
16841 \begin_layout Standard
16843 But probably less than in the old hacked-\SpecialChar LaTeX
16851 \begin_layout Standard
16853 \begin_inset space \thinspace{}
16856 g.: does not display the number for theorem-like layouts, just #.
16859 \begin_layout Section
16862 Sli\SpecialChar TeX
16866 \begin_inset CommandInset label
16875 \begin_layout Standard
16883 \begin_layout Subsection
16887 \begin_layout Standard
16888 This section describes how to use \SpecialChar LyX
16889 to make slides for overhead projectors.
16890 There are two document classes that can do this: the default slides class
16893 Foil\SpecialChar TeX
16897 This section documents the former.
16900 \begin_layout Standard
16901 I'm going to say this again, nice and clear, so that there's no misunderstanding
16905 \begin_layout Standard
16906 \begin_inset VSpace bigskip
16912 \begin_layout Standard
16916 This section documents the class
16917 \begin_inset Quotes eld
16925 \begin_inset Quotes erd
16933 \begin_layout Standard
16934 \begin_inset VSpace bigskip
16940 \begin_layout Standard
16941 If you're looking for the documentation for
16942 \begin_inset Quotes eld
16947 slides (Foil\SpecialChar TeX
16951 \begin_inset Quotes erd
16954 , check out section
16955 \begin_inset space ~
16959 \begin_inset CommandInset ref
16961 reference "sec:foiltex"
16971 \begin_inset Quotes eld
16976 slides (Foil\SpecialChar TeX
16980 \begin_inset Quotes erd
16983 ] is actually somewhat better than the default
16991 \begin_layout Plain Layout
16993 or so I've been told repeatedly by its advocates.
16994 Having never used it, I have no idea if this claim is true or not.
16999 which this section documents.
17002 \begin_layout Standard
17003 This class is the \SpecialChar LaTeX2e
17004 improvement of the old
17006 Sli\SpecialChar TeX
17010 Every \SpecialChar LaTeX2e
17011 distribution includes this class [which I'll just refer to as
17012 \begin_inset Quotes eld
17020 \begin_inset Quotes erd
17023 from now on], so you're bound to have it.
17024 As I noted earlier, there are other classes, such as
17028 , which also produce slides for overhead projectors and do a better job
17030 However, there are some things which
17034 can do which the others can't, such as generate overlays.
17035 Read on to learn more!
17038 \begin_layout Subsection
17040 \begin_inset CommandInset label
17042 name "sec:slidesetup"
17049 \begin_layout Standard
17050 Obviously, to use this document class, you need to select
17051 \begin_inset Quotes eld
17059 \begin_inset Quotes erd
17062 from the class list in the
17064 Document\SpecialChar menuseparator
17068 There are some other special things you should know about this class:
17071 \begin_layout Itemize
17072 Don't bother changing the options
17077 They're not supported by the
17084 \begin_layout Itemize
17088 \begin_inset space ~
17093 behaves a bit differently for this class.
17094 The possible choices and what they do are as follows:
17098 \begin_layout Description
17103 The final output contains page numbers in the lower right corner.
17106 \begin_layout Description
17115 , but also prints out any time markers you've put in.
17116 This is the default.
17119 \begin_layout Description
17124 The final output contains no page numbers, time markers, or alignment markers.
17128 \begin_layout Itemize
17133 class has an extra option:
17139 \begin_inset Quotes eld
17147 \begin_inset Quotes erd
17150 in the extra class options.
17154 \begin_layout Standard
17155 Using this options allows you to add time markers to
17161 \begin_inset space ~
17165 \begin_inset CommandInset ref
17167 reference "sec:slideNote"
17175 \begin_layout Standard
17176 You can also use the template file
17177 \begin_inset Quotes eld
17185 \begin_inset Quotes erd
17188 to automatically set up a document to use the
17194 File\SpecialChar menuseparator
17196 \begin_inset space ~
17200 \begin_inset space ~
17205 to open your new document].
17206 The template file also contains some examples of the special paragraph
17207 environments used by this class.
17208 I'll describe those next.
17211 \begin_layout Subsection
17212 Paragraph Environments
17215 \begin_layout Subsubsection
17216 Supported Environments
17219 \begin_layout Standard
17220 The first thing you'll notice when you start up a new
17224 document is the font size and type: it's the equivalent of the size
17225 \begin_inset Quotes eld
17233 \begin_inset Quotes erd
17239 \begin_inset space ~
17245 This is also what's used in the output.
17247 \begin_inset Quotes eld
17251 \begin_inset Quotes erd
17254 to remind you that this is a slide.
17255 Your final slides will use a larger font; ergo, you'll have less space.
17256 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17259 \begin_layout Standard
17260 The next thing that becomes obvious is the changes to the paragraph environment
17261 pull-down box [at the far-left end of the toolbar].
17262 Most of the paragraph environments you're used to seeing are missing.
17263 There are also five new ones.
17268 class itself only supports certain paragraph environments:
17271 \begin_layout Itemize
17277 \begin_layout Itemize
17283 \begin_layout Itemize
17289 \begin_layout Itemize
17295 \begin_layout Itemize
17301 \begin_layout Itemize
17307 \begin_layout Itemize
17313 \begin_layout Itemize
17319 \begin_layout Itemize
17325 \begin_layout Itemize
17332 \begin_layout Itemize
17338 \begin_layout Standard
17339 All of the other standard environments, including the section-heading environmen
17340 ts, aren't used in the
17347 \begin_layout Standard
17348 On the other hand, you'll notice the following new environments:
17351 \begin_layout Itemize
17357 \begin_layout Itemize
17363 \begin_layout Itemize
17369 \begin_layout Itemize
17375 \begin_layout Itemize
17381 \begin_layout Standard
17382 These five are kind of quirky, due to a
17383 \begin_inset Quotes eld
17387 \begin_inset Quotes erd
17390 in \SpecialChar LyX
17392 You see, \SpecialChar LyX
17393 doesn't permit you to nest any other paragraph environment into
17394 an empty environment.
17395 Now, that's fine and dandy, but it means that you wouldn't be able to start
17396 a slide with anything except plain text.
17397 To deal with this, I've performed a little
17398 \begin_inset Quotes eld
17403 \begin_inset Quotes erd
17409 \begin_layout Subsubsection
17410 Quirks of the New Environments
17411 \begin_inset CommandInset label
17413 name "sec:slideQuirk"
17420 \begin_layout Standard
17421 All five of the new paragraph environments are somewhat quirky due to inherent
17422 limitiations in the current version of \SpecialChar LyX
17424 As I just mentioned, \SpecialChar LyX
17425 forbids environments that begin with another environment.
17426 To get around this, the
17430 environment isn't a paragraph environment as described in the
17438 \begin_layout Standard
17439 You should consider
17452 \begin_inset Quotes eld
17455 pseudo-environments.
17456 \begin_inset Quotes erd
17459 They look like a section heading or a
17460 \begin_inset Quotes eld
17468 \begin_inset Quotes erd
17471 but really begin a [and, if necessary, end the previous] paragraph environment.
17481 \begin_inset Quotes eld
17485 \begin_inset Quotes erd
17488 These two perform some action.
17491 \begin_layout Standard
17492 A common feature of all five environments,
17512 , is a rather long-ish label.
17513 The text following this label — ordinarily the contents of the paragraph
17514 environment — is utterly irrelevant for
17536 completely ignores it.
17537 In fact, you can leave these five environments completely empty.
17541 \begin_layout Standard
17546 to put any text after the rather long-ish label, you might want to.
17547 This could be a short description of the contents of the
17552 In that case, enter your descriptive comment and hit
17556 as you normally would.
17559 \begin_layout Standard
17560 If, on the other hand, you don't want to enter any descriptive text, you'll
17561 hit another \SpecialChar LyX
17564 , like nature, abhors a vacuum, and will not let you start a new paragraph
17565 environment until you put something in the old one.
17569 \begin_layout Itemize
17570 Start entering the text that will
17598 \begin_layout Itemize
17599 Now move to the beginning of that paragraph.
17603 \begin_layout Itemize
17612 \begin_layout Itemize
17613 Finally, change this new, empty paragraph to a
17637 \begin_layout Standard
17638 Some future version of \SpecialChar LyX
17639 will, hopefully, resolve this quirkiness\SpecialChar ldots
17643 \begin_layout Subsection
17644 Making a Presentation with
17657 \begin_layout Subsubsection
17665 \begin_layout Standard
17666 If you're expecting this section to teach you how to actually make a presentatio
17667 n, you'll be sorely disappointed.
17668 Naturally, I'll describe all of the ways the
17672 class can assist you in preparing the materials for a presentation.
17673 Filling in the contents, however, is up to you.
17678 the \SpecialChar LyX
17682 \begin_layout Standard
17687 environment [in the manner described in section
17688 \begin_inset space ~
17692 \begin_inset CommandInset ref
17694 reference "sec:slideQuirk"
17698 ] tells \SpecialChar LyX
17699 to begin a new slide [duh].
17700 The label for this environment/
17701 \begin_inset Quotes erd
17705 \begin_inset Quotes erd
17709 \begin_inset Quotes eld
17713 \begin_inset Quotes erd
17716 in cool blue, followed by the label,
17717 \begin_inset Quotes eld
17721 \begin_inset Quotes erd
17725 Any text or paragraph environments that follow this one go on the new slide.
17729 \begin_layout Standard
17730 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17732 (this can be specified in the
17737 In fact, you'll want to, once you finish entering the contents of one slide.
17738 If you've entered more text than can physically fit on a slide, the extra
17739 overflows onto a new slide.
17740 I don't recommend doing this, however, since the overflow slide won't have
17741 any page number on it.
17742 Furthermore, it may interfere with any
17746 you've made to accompany the oversized
17753 \begin_layout Standard
17762 environments work the same way as the
17767 They both create an
17768 \begin_inset Quotes eld
17772 \begin_inset Quotes erd
17775 followed by a label [
17776 \begin_inset Quotes eld
17780 \begin_inset Quotes erd
17784 \begin_inset Quotes eld
17788 \begin_inset Quotes erd
17792 The color is a stunning magenta instead of blue, and the
17793 \begin_inset Quotes eld
17797 \begin_inset Quotes erd
17800 will look different, in style and in length.
17801 The label fonts of all three also differ from one another.
17804 \begin_layout Standard
17809 , if the contents of a
17817 exceed the physical size of a slide or sheet of paper, the extra will overflow
17819 Again, you should avoid this.
17820 It defeats the whole purpose of
17831 \begin_layout Subsubsection
17841 \begin_layout Standard
17846 is a slide that sits atop another slide.
17847 Perhaps you wish to discuss a figure on the main
17851 before displaying the text associated with it.
17852 One way to accomplish this is tape a flap of dark paper over the part of
17857 you want to display later.
17858 This method fails, however, if you wish to overlap one graph with another,
17860 You would then have to fumble while speaking to align the two separate,
17865 s to align the two graphs.
17870 environment in both cases makes life much easier.
17873 \begin_layout Standard
17878 receives the page number of its
17879 \begin_inset Quotes eld
17883 \begin_inset Quotes erd
17891 \begin_inset Quotes eld
17899 \begin_inset Quotes erd
17906 \begin_layout Plain Layout
17907 Presumably, mutliple
17912 \begin_inset Quotes eld
17920 \begin_inset Quotes erd
17924 \begin_inset Quotes eld
17932 \begin_inset Quotes erd
17936 \begin_inset Quotes eld
17944 \begin_inset Quotes erd
17948 \begin_inset space ~
17951 appended to the page number of the parent
17961 Clearly, you want the contents of both the
17969 to each fit on a single physical slide! You should probably consider an
17975 \begin_inset Quotes eld
17979 \begin_inset Quotes erd
17987 Indeed, the \SpecialChar LyX
17992 class provides a visual cue for this: the label at the start of an
17996 is shorter than that at the start of a
18001 Lastly, when you generate printable output, you'll find alignment markers
18002 in all four corners of both the
18006 page and its parent
18011 These will assist you in lining up the two physical slides.
18014 \begin_layout Standard
18015 The major problem in overlaying two slides is aligning the contents of the
18016 two transparencies.
18017 How much space should you leave for that graph on the second slide? Worse
18018 still, what if you want a graph and a sentence on second slide, but there
18019 is text on the main transparency that goes in between them? You could try
18020 and insert vertical space of the right size.
18021 The better way is to use
18032 \begin_layout Standard
18033 As their names imply,
18041 are two command-like paragraph environments that make all subsequent text
18042 invisible and visible, respectively.
18044 \begin_inset space ~
18048 \begin_inset CommandInset ref
18050 reference "sec:slideQuirk"
18054 that you don't place anything
18058 these two environments, however.
18063 , it inserts a centered, sky-blue label into the page reading
18064 \begin_inset Quotes eld
18067 <Invisible Text Follows>
18068 \begin_inset Quotes erd
18072 For paragraphs following this label, the parts of the
18080 ; it doesn't matter which] where they would be contain instead blank space.
18084 \begin_layout Standard
18089 , the corresponding centered label is
18090 \begin_inset Quotes eld
18093 <Visible Text Follows>
18094 \begin_inset Quotes erd
18098 Paragraphs following this label behave normally.
18099 Note that the beginning of a new
18111 automatically shuts off an
18116 It's therefore not necessary to use
18127 \begin_layout Standard
18128 By now, it should be obvious how to create overlay transparencies using
18129 the proper combination of
18148 \begin_layout Enumerate
18153 , including everything that will appear on it, whether on the main slide
18161 \begin_layout Enumerate
18162 Before each figure or paragraph that will appear only on the
18171 If necessary, insert a
18175 environment after the
18182 \begin_layout Enumerate
18187 immediately following the
18194 \begin_layout Enumerate
18195 Copy the contents of this
18206 \begin_layout Enumerate
18211 , change all of the
18222 \begin_layout Standard
18224 You've just made an
18231 \begin_layout Standard
18232 There's one problem with the way I've designed the \SpecialChar LyX
18237 class: you can't make text in the middle of a paragraph invisible, nor
18238 make text in the middle of an invisible paragraph visible again.
18239 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18244 \begin_layout Plain Layout
18245 The commands of interest are:
18248 \begin_layout Itemize
18253 invisible \SpecialChar ldots
18257 \begin_layout Itemize
18262 visible \SpecialChar ldots
18266 \begin_layout Plain Layout
18268 and need to be marked as \SpecialChar TeX
18271 \begin_inset Quotes eld
18275 \begin_inset Quotes erd
18278 you wish to change goes in between the brackets [and after the
18291 If you don't know how to mark text as \SpecialChar TeX
18292 , see the appropriate section of
18305 \begin_layout Subsubsection
18315 \begin_inset CommandInset label
18317 name "sec:slideNote"
18324 \begin_layout Standard
18333 is associated with a
18334 \begin_inset Quotes eld
18338 \begin_inset Quotes erd
18346 Here, too, the \SpecialChar LyX
18351 class provides visual cues.
18356 is shorter than that of a
18360 [yet longer than that of an
18364 ] and, like the label of an
18368 is shockingly magenta.
18369 Additionally, the printed
18373 has the page number of its
18374 \begin_inset Quotes eld
18378 \begin_inset Quotes erd
18386 \begin_inset Quotes eld
18394 \begin_inset Quotes erd
18398 \begin_inset Quotes eld
18406 \begin_inset Quotes erd
18410 \begin_inset Quotes eld
18418 \begin_inset Quotes erd
18422 You can have multiple
18426 s associated with a single
18438 , you'll probably want to break up long
18442 s so that they fit on a single sheet of paper.
18445 \begin_layout Standard
18450 is obvious: it contains anything additional you might want to say about
18456 It could also be used as a sheet of reminders for a particular
18461 In the case of the latter, you might want to make use of time markers.
18462 Currently, the \SpecialChar LyX
18468 \begin_inset Quotes eld
18472 \begin_inset Quotes erd
18475 support for time markers, a
18477 Sli\SpecialChar TeX
18481 So, you'll have to resort to using the \SpecialChar LaTeX
18485 \begin_layout Standard
18486 To use time markers, you'll need to specify the extra class option
18487 \begin_inset Quotes eld
18495 \begin_inset Quotes erd
18499 \begin_inset space ~
18503 \begin_inset CommandInset ref
18505 reference "sec:slidesetup"
18510 This option turns on timing marks, which will appear in the lower-left-hand
18516 To set what appears in the time marker, you use the \SpecialChar LaTeX
18518 \begin_inset Quotes eld
18528 \begin_inset Quotes erd
18532 \begin_inset Quotes eld
18542 \begin_inset Quotes erd
18546 The arguments of both commands are time measured in seconds.
18548 \begin_inset Quotes eld
18558 \begin_inset Quotes erd
18561 sets the time marker to a given time.
18563 \begin_inset Quotes eld
18573 \begin_inset Quotes erd
18576 increments the time marker by the specified amount.
18577 Using time markers and
18581 s in this fashion, you can remind yourself how much time to spend on a particula
18589 \begin_layout Standard
18590 There's one last feature to describe.
18591 Clearly, you'd like to print out all of your
18599 s on transparencies while printing all of your
18616 with which it is associated.
18617 What's a person to do?
18620 \begin_layout Standard
18621 Luckily, there are two \SpecialChar LaTeX
18622 commands that allow you to select what to print
18624 Both must be placed into the preamble of your document.
18626 \begin_inset Quotes eld
18638 \begin_inset Quotes erd
18641 will cause the output to contain only the
18650 Correspondingly, the command
18651 \begin_inset Quotes eld
18663 \begin_inset Quotes erd
18666 prevents the output of anything but
18671 I'd advise placing both commands in the preamble and initially comment
18673 You can then preview your entire presentation as you write.
18674 When you're done writing, you can then uncomment one of the two to select
18675 what you want to print.
18676 I like to uncomment
18677 \begin_inset Quotes eld
18689 \begin_inset Quotes erd
18692 , print to a file with
18693 \begin_inset Quotes eld
18701 \begin_inset Quotes erd
18704 in its name, comment it back out, then uncomment
18705 \begin_inset Quotes eld
18717 \begin_inset Quotes erd
18721 \begin_inset Quotes eld
18729 \begin_inset Quotes erd
18733 I can then send either file to a printer, loading transparencies or plain
18734 paper as appropriate.
18737 \begin_layout Standard
18738 You can also provide other arguments to the
18739 \begin_inset Quotes eld
18749 \begin_inset Quotes erd
18753 \begin_inset Quotes eld
18763 \begin_inset Quotes erd
18767 See a good \SpecialChar LaTeX
18771 \begin_layout Subsection
18776 Class Template File
18779 \begin_layout Standard
18780 I have also provided a template file,
18781 \begin_inset Quotes eld
18789 \begin_inset Quotes erd
18797 To use it, begin your new presentation with
18799 File\SpecialChar menuseparator
18801 \begin_inset space ~
18805 \begin_inset space ~
18811 Your new \SpecialChar LyX
18812 presentation file will contain an example
18833 additionally contain an example of the use of
18842 Lastly, the preamble will contain:
18845 \begin_layout LyX-Code
18846 % Uncomment to print out only slides and overlays
18849 \begin_layout LyX-Code
18853 \begin_layout LyX-Code
18859 \begin_inset Newline newline
18865 \begin_layout LyX-Code
18866 % Uncomment to print out only notes
18869 \begin_layout LyX-Code
18873 \begin_layout LyX-Code
18881 \begin_layout Standard
18882 One final thing: I created this class to support the \SpecialChar LaTeX2e
18884 \begin_inset Quotes eld
18889 Sli\SpecialChar TeX
18893 \begin_inset Quotes erd
18896 class, one of the built-in \SpecialChar LaTeX2e
18898 Neither I nor the rest of the \SpecialChar LyX
18899 Team endorse or oppose the use of this built-in
18901 It's here if you want it or need it.
18902 There exist other \SpecialChar LaTeX2e
18903 classes for creating presentations, such as the
18908 \begin_inset space ~
18912 \begin_inset CommandInset ref
18914 reference "sec:foiltex"
18919 \begin_inset Quotes eld
18927 \begin_inset Quotes erd
18930 package [present on some \SpecialChar TeX
18932 The latter is not yet supported under \SpecialChar LyX
18937 \begin_layout Plain Layout
18938 Perhaps you can take on the task\SpecialChar ldots
18944 I know nothing about these other classes.
18945 Try them out to see what sort of alternative they provide.
18948 \begin_layout Chapter
18950 Features needing Extra Software
18953 \begin_layout Section
18954 Checking \SpecialChar TeX
18958 \begin_layout Standard
18964 \begin_layout Subsection
18968 \begin_layout Standard
18977 \begin_layout Plain Layout
18982 is not yet available when you are using the \SpecialChar LaTeX
18983 distribution MiK\SpecialChar TeX
18989 , you'll find in the
18996 \begin_inset space ~
19007 \begin_inset Newline newline
19011 \begin_inset CommandInset href
19013 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
19021 \begin_layout Standard
19024 Chk\SpecialChar TeX
19027 package is a program that was written by
19028 \begin_inset Flex Noun
19031 \begin_layout Plain Layout
19033 \begin_inset space ~
19041 in frustration because some constructs in \SpecialChar LaTeX
19042 are sometimes non-intuitive,
19043 and easy to forget.
19044 The program runs over your \SpecialChar LaTeX
19045 file, checks the integrity of the file, and
19046 flags some common errors.
19047 In other technical words, it is
19051 for \SpecialChar LaTeX
19055 \begin_layout Standard
19056 Well, what is a syntax checker doing in \SpecialChar LyX
19057 which is supposed to produce correct
19059 anyways? The answer is simple: Just as
19063 not only checks the
19067 of C programs, but also does
19071 checks for type-errors,
19073 Chk\SpecialChar TeX
19076 catches some common
19080 errors, in addition to the syntactical ones.
19083 Chk\SpecialChar TeX
19086 is capable of detecting several common errors, such as
19089 \begin_layout Itemize
19090 Ellipsis detection:
19091 \begin_inset Newline newline
19094 Use \SpecialChar ldots
19098 \begin_layout Itemize
19099 No space in front of/after parenthesis:
19100 \begin_inset Newline newline
19106 \begin_layout Itemize
19107 Enforcement of normal space after common abbreviations:
19108 \begin_inset Newline newline
19112 \begin_inset space \thinspace{}
19116 \begin_inset space \space{}
19119 is too wide spacing.
19122 \begin_layout Itemize
19123 Enforcement of end-of-sentence space when the last sentence ends with a
19125 \begin_inset Newline newline
19129 And this is wrong spacing.
19132 \begin_layout Itemize
19133 Space in front of labels and similar commands:
19134 \begin_inset Newline newline
19137 The label should stick right up to the text to avoid falling to a wrong
19140 \begin_inset CommandInset label
19150 \begin_layout Plain Layout
19151 This footnote is in danger of falling off to a wrong page
19156 The label is separated too much.
19159 \begin_layout Itemize
19160 Space in front of references, instead of hard spaces:
19161 \begin_inset Newline newline
19164 If you have bad luck, the text will break right between the referenced text
19165 and reference number, and that's a pity.
19167 \begin_inset CommandInset ref
19169 reference "sec:chktex"
19176 \begin_layout Itemize
19178 \begin_inset Quotes eld
19182 \begin_inset Quotes erd
19186 \begin_inset Formula $\times$
19190 \begin_inset Newline newline
19193 2x2 looks cheap compared to
19194 \begin_inset Formula $2\times2$
19200 \begin_layout Standard
19201 and more \SpecialChar ldots
19202 It is an invaluable tool when you are
19203 \begin_inset Quotes eld
19207 \begin_inset Quotes erd
19210 your document before printing, and you should run it right after the obligatory
19211 spelling check, and before you go fine tuning the typesetting.
19214 \begin_layout Subsection
19218 \begin_layout Standard
19219 If you have the program installed, usage is as simple as choosing
19221 Tools\SpecialChar menuseparator
19223 \begin_inset space ~
19229 This will make \SpecialChar LyX
19230 generate a \SpecialChar LaTeX
19231 file of your document, start
19233 Chk\SpecialChar TeX
19236 to check it, and then make \SpecialChar LyX
19238 \begin_inset Quotes eld
19242 \begin_inset Quotes erd
19245 with the warnings from
19247 Chk\SpecialChar TeX
19250 , if there were any.
19251 The warnings will be placed close to the point of the mistake, and you
19252 can quickly find them by using the
19254 Navigate\SpecialChar menuseparator
19257 menu item, or the shortcut key
19266 Open the error boxes by clicking on them with the mouse, or use the shortcut
19275 bindings, or the corresponding
19284 Read the warning and correct the mistake, if it is a mistake.
19285 If you have trouble understanding what the warning is about, you can safely
19287 Remember that there is a hidden layer between the document on screen and
19288 the technical details in invoking
19290 Chk\SpecialChar TeX
19293 , and this gap can make some warnings seem arcane or just plain silly.
19296 \begin_layout Standard
19297 This document is an excellent testing bed for the feature, and it should
19298 provide quite a few warnings for you to fiddle with.
19299 Since computers are only so smart, expect most of the warnings to be false
19303 \begin_layout Subsection
19304 How to fine tune it
19307 \begin_layout Standard
19308 Sometimes, you'll find that
19310 Chk\SpecialChar TeX
19313 makes more noise than suits your mood.
19314 Then you can choose not to use it, wait until your mood changes, or try
19317 Chk\SpecialChar TeX
19320 to get better along with you.
19323 \begin_layout Standard
19326 Chk\SpecialChar TeX
19333 very configurable and extensible, you should not expect to solve all problems
19336 Chk\SpecialChar TeX
19339 in \SpecialChar LyX
19341 Since \SpecialChar LyX
19342 has to generate a somewhat special \SpecialChar LaTeX
19343 file to be able to match the
19344 line numbers from the
19346 Chk\SpecialChar TeX
19353 \begin_layout Plain Layout
19354 You can inspect the specific output from
19360 Document\SpecialChar menuseparator
19363 \begin_inset space ~
19377 to the internal document structure, some of the warnings will not appear
19379 There are two things you can do about this:
19382 \begin_layout Itemize
19385 Chk\SpecialChar TeX
19388 invocation command line in
19389 \begin_inset Flex Noun
19392 \begin_layout Plain Layout
19393 Tools\SpecialChar menuseparator
19394 Preferences\SpecialChar menuseparator
19395 Output\SpecialChar menuseparator
19396 LaTeX\SpecialChar menuseparator
19404 Chk\SpecialChar TeX
19407 installation configuration file (usually with the file
19412 See below to learn what warnings can be enabled and disabled on the command
19416 \begin_layout Itemize
19417 Export your document as a raw \SpecialChar LaTeX
19420 File\SpecialChar menuseparator
19421 Export\SpecialChar menuseparator
19430 Invoked in this way, it can be a hassle to find the corresponding place
19431 in the document inside \SpecialChar LyX
19432 , but with a little patience, you should be able
19436 \begin_layout Standard
19437 Here follows the warning messages that can be enabled and disabled in
19446 to disable a warning, and
19450 to enable a warning.
19451 The emphasized entries are disabled by default, because the default is
19454 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19459 \begin_layout Standard
19460 Notice that you should only use the options that enable and disable warnings,
19461 because \SpecialChar LyX
19462 relies on some of the other command line parameters to be set
19463 in a specific way to have a chance to communicate with
19470 \begin_layout Enumerate
19474 Command terminated with space.
19477 \begin_layout Enumerate
19480 Non-breaking space (
19481 \begin_inset Quotes eld
19489 \begin_inset Quotes erd
19492 ) should have been used.
19495 \begin_layout Enumerate
19499 You should enclose the previous parenthesis with
19500 \begin_inset Quotes eld
19508 \begin_inset Quotes erd
19514 \begin_layout Enumerate
19517 Italic correction (
19518 \begin_inset Quotes eld
19528 \begin_inset Quotes erd
19531 ) found in non-italic buffer.
19534 \begin_layout Enumerate
19537 Italic correction (
19538 \begin_inset Quotes eld
19548 \begin_inset Quotes erd
19551 ) found more than once.
19554 \begin_layout Enumerate
19558 No italic correction (
19559 \begin_inset Quotes eld
19569 \begin_inset Quotes erd
19575 \begin_layout Enumerate
19579 \begin_inset Quotes eld
19587 \begin_inset Quotes erd
19591 \begin_inset Quotes eld
19599 \begin_inset Quotes erd
19605 \begin_layout Enumerate
19608 Wrong length of dash may have been used.
19611 \begin_layout Enumerate
19615 \begin_inset Quotes eld
19623 \begin_inset Quotes erd
19627 \begin_inset Quotes eld
19635 \begin_inset Quotes erd
19641 \begin_layout Enumerate
19645 \begin_inset Quotes eld
19653 \begin_inset Quotes erd
19659 \begin_layout Enumerate
19663 \begin_inset Quotes eld
19671 \begin_inset Quotes erd
19674 to achieve an ellipsis.
19677 \begin_layout Enumerate
19680 Inter-word spacing (
19681 \begin_inset Quotes eld
19691 \begin_inset Quotes eld
19694 ) should perhaps be used.
19697 \begin_layout Enumerate
19700 Inter-sentence spacing (
19701 \begin_inset Quotes eld
19711 \begin_inset Quotes erd
19714 ) should perhaps be used.
19717 \begin_layout Enumerate
19720 Could not find argument for command.
19723 \begin_layout Enumerate
19727 \begin_inset Quotes eld
19735 \begin_inset Quotes erd
19741 \begin_layout Enumerate
19744 Math mode still on at end of \SpecialChar LaTeX
19748 \begin_layout Enumerate
19752 \begin_inset Quotes eld
19760 \begin_inset Quotes erd
19763 doesn't match the number of
19764 \begin_inset Quotes eld
19772 \begin_inset Quotes erd
19778 \begin_layout Enumerate
19781 You should use either
19784 \begin_inset Quotes eld
19792 \begin_inset Quotes erd
19797 as an alternative to
19798 \begin_inset Quotes eld
19806 \begin_inset Quotes erd
19812 \begin_layout Enumerate
19819 " (ASCII 39) instead of "
19826 \begin_layout Enumerate
19829 User-specified pattern found.
19832 \begin_layout Enumerate
19835 This command might not be intended.
19838 \begin_layout Enumerate
19845 \begin_layout Enumerate
19863 \begin_layout Enumerate
19866 Delete this space to maintain correct page references.
19869 \begin_layout Enumerate
19873 You might wish to put this between a pair of
19874 \begin_inset Quotes eld
19882 \begin_inset Quotes erd
19888 \begin_layout Enumerate
19891 You ought to remove spaces in front of punctuation.
19894 \begin_layout Enumerate
19897 Could not execute \SpecialChar LaTeX
19901 \begin_layout Enumerate
19910 in front of small punctuation.
19913 \begin_layout Enumerate
19921 may look prettier here.
19924 \begin_layout Enumerate
19928 Multiple spaces detected in output.
19931 \begin_layout Enumerate
19934 This text may be ignored.
19937 \begin_layout Enumerate
19943 \begin_inset Quotes eld
19948 to begin quotation, not
19955 \begin_layout Enumerate
19962 to end quotation, not
19965 \begin_inset Quotes eld
19973 \begin_layout Enumerate
19979 \begin_layout Enumerate
19982 You should perhaps use
19983 \begin_inset Quotes eld
19991 \begin_inset Quotes erd
19997 \begin_layout Enumerate
20000 You should put a space in front of/after parenthesis.
20003 \begin_layout Enumerate
20006 You should avoid spaces in front of/after parenthesis.
20009 \begin_layout Enumerate
20013 You should not use punctuation in front of/after quotes.
20016 \begin_layout Enumerate
20019 Double space found.
20022 \begin_layout Enumerate
20025 You should put punctuation outside inner/inside display math mode.
20028 \begin_layout Enumerate
20031 You ought to not use primitive \SpecialChar TeX
20032 in \SpecialChar LaTeX
20036 \begin_layout Enumerate
20039 You should remove spaces in front of
20040 \begin_inset Quotes eld
20048 \begin_inset Quotes erd
20054 \begin_layout Enumerate
20057 \begin_inset Quotes eld
20065 \begin_inset Quotes erd
20068 is normally not followed by
20069 \begin_inset Quotes eld
20077 \begin_inset Quotes erd
20083 \begin_layout Standard
20084 In later versions of \SpecialChar LyX
20085 , we hope to provide a more complete interface to this
20086 tool (and it's smaller cousin
20090 ) to exploit the full power of it.
20091 But it's not exactly useless as it is now: go try it on one of your existing
20092 documents of a certain length and be surprised.
20095 \begin_layout Section
20096 Version Control in \SpecialChar LyX
20100 \begin_layout Standard
20103 Lars Gullik Bjønnes
20110 \begin_layout Subsection
20114 \begin_layout Standard
20116 supports some of the most basic RCS/CVS/SVN/GIT commands.
20117 If you need something a bit more sophisticated you will have to do that
20118 manually in a terminal.
20121 \begin_layout Standard
20122 Also note that CVS support is not as good as subversion support so we advise
20124 A good place to start learning Subversion is SVN Book
20128 \begin_layout Plain Layout
20129 \begin_inset CommandInset href
20131 target "http://svnbook.red-bean.com/"
20142 In the case of RCS you should read
20143 \begin_inset Quotes eld
20147 \begin_inset Quotes erd
20150 (a man file, read it with
20155 This file describes all the basic features of RCS.
20156 You should especially notice the comment about a RCS directory, and the
20157 notion of a master RCS file (the file ending in
20164 \begin_layout Standard
20165 Before you begin to use the version control features in \SpecialChar LyX
20167 familiar with RCS/CVS/SVN/GIT usage.
20168 The implementation in \SpecialChar LyX
20169 assumes a recent version of the GNU RCS or CVS/SVN
20170 package — no guarantees are made for older versions.
20171 Most of the log messages are not currently displayed after operations —
20172 you can check them in the Messages pane if unsure.
20173 Regular users of version control will appreciate VC toolbar, which can
20176 View\SpecialChar menuseparator
20177 Toolbars\SpecialChar menuseparator
20179 \begin_inset space ~
20187 \begin_layout Standard
20188 For introducing your own external commands consult vc-command in the manual
20189 of \SpecialChar LyX
20193 \begin_layout Standard
20194 It is strongly recommended to store documents in uncompressed format if
20195 using version control (uncheck
20197 Document\SpecialChar menuseparator
20200 if it is checked): Uncompressed LyX documents are text files and therefore
20201 for merging two different versions by version control systems.
20202 Compressed LyX documents are binary files, which cannot be merged by version
20206 \begin_layout Subsection
20207 RCS commands in \SpecialChar LyX
20211 \begin_layout Standard
20212 The following sections describe the RCS commands supported by \SpecialChar LyX
20214 You can find them in the
20216 File\SpecialChar menuseparator
20218 \begin_inset space ~
20225 was tested against RCS 5.7/5.8.
20228 \begin_layout Subsubsection
20234 \begin_layout Standard
20235 If your document is not under revision control, this is the only item shown
20237 And if it is under revision control, the
20241 item is not visible.
20245 \begin_layout Standard
20246 This command registers your document with RCS (unless you are under the
20247 directory managed by CVS)\SpecialChar endofsentence
20248 You are asked interactively to supply an initial
20249 description of the document.
20250 The document is now set in Read-Only mode and you have to
20253 \begin_inset space ~
20257 \begin_inset space ~
20261 \begin_inset space ~
20266 , before making any changes to it.
20267 A document under revision control has a
20268 \begin_inset Quotes eld
20271 [RCS:<version> <locker>]
20272 \begin_inset Quotes erd
20275 item tagged to the filename in the minibuffer.
20278 \begin_layout Standard
20279 RCS command that is run:
20281 ci -q -u -i -t-"<initial description>" <file-name>
20284 \begin_layout Standard
20289 to understand the switches.
20293 \begin_layout Subsubsection
20299 \begin_layout Standard
20300 When you are finished editing a file, you check in your changes.
20301 When you do this, you are asked for a description of the changes.
20302 This is stored in the history log.
20303 The version number is bumped, your changes are applied to the master RCS
20304 file, the document is unlocked and set to Read-Only mode.
20307 \begin_layout Standard
20310 ci -q -u -m"<description>" <file-name>
20313 \begin_layout Subsubsection
20319 \begin_layout Standard
20320 By doing this you lock the document so that only you can edit it.
20321 This will also make the document Read-Write only for you.
20322 You will usually continue editing for a while and when you are finished
20323 you check in your changes.
20324 The status line is changed to reflect that you have locked the file.
20327 \begin_layout Standard
20330 co -q -l <file-name>
20333 \begin_layout Subsubsection
20336 Revert To Repository Version
20339 \begin_layout Standard
20340 This will discard all changes made to the document since the last check
20342 You get a warning before changes are discarded.
20345 \begin_layout Standard
20348 co -f -u<version> <file-name>
20351 \begin_layout Subsubsection
20357 \begin_layout Standard
20358 This will create a copy of the current document.
20359 Since RCS does not support copy operations natively, the version history
20360 is not preserved, and the copy is added as a new file.
20361 It requires a clean document without any changes since the last checkin.
20362 You are asked for a file name and a description of the copy operation.
20363 After that the copy is created, both locally and in the repository.
20364 If the parent directories of the copied and original document differ, all
20365 relative paths of included files of the copy are adjusted (like in
20367 File\SpecialChar menuseparator
20372 Finally, the copy is loaded instead of the original document.
20375 \begin_layout Labeling
20376 \labelwidthstring 00.00.0000
20378 \begin_inset space ~
20382 \begin_inset space ~
20386 \begin_inset Newline newline
20390 \begin_inset Flex Code
20393 \begin_layout Plain Layout
20396 \begin_inset Quotes eld
20400 \begin_inset Quotes erd
20409 \begin_inset Flex Code
20412 \begin_layout Plain Layout
20415 \begin_inset Quotes eld
20419 \begin_inset Quotes erd
20428 \begin_inset Newline newline
20432 \begin_inset Flex Code
20435 \begin_layout Plain Layout
20439 \begin_inset Quotes eld
20443 \begin_inset Quotes erd
20454 \begin_layout Subsubsection
20460 \begin_layout Standard
20461 This makes as if the last check in never happened.
20462 No changes are made to the document loaded into \SpecialChar LyX
20463 , but the last version
20464 is removed from the master RCS file.
20467 \begin_layout Standard
20470 rcs -o<version> <file-name>
20473 \begin_layout Subsubsection
20479 \begin_layout Standard
20480 This shows the complete history of the RCS document.
20485 is shown in a browser.
20493 \begin_layout Subsubsection
20497 \begin_layout Standard
20499 supports RCS version number, author name, date and time of last commit.
20500 All those are extracted from
20502 rlog -r <file-name>
20506 \begin_inset CommandInset ref
20508 reference "subsec:VCS-Revision-Information"
20515 \begin_layout Subsection
20516 CVS commands in \SpecialChar LyX
20520 \begin_layout Standard
20521 A subset of CVS operations is supported by \SpecialChar LyX
20523 You can find the commands in the
20525 File\SpecialChar menuseparator
20527 \begin_inset space ~
20533 The version control system SVN is more powerful, so please use it instead
20534 of CVS if possible.
20537 \begin_layout Subsubsection
20543 \begin_layout Standard
20544 If you start from scratch with CVS you have to create your repository and
20545 checkout the working copy with external tools.
20546 If you're using a client-server setup you may need to login before doing
20547 the first repository checkout.
20550 \begin_layout Standard
20551 If your documents are under revision control and others are using the same
20552 repository problems arise when different changes to the same document at
20553 the same location happen.
20554 Standard CVS repositories don't operate with a file locking mechanism.
20555 This may be surprising, but conflicts only occur if people disagree on
20556 the proper content of the same part of a document.
20557 So, if co-workers are used to communicate regularly, these conflicts occur
20559 If they don't communicate they have a fundamental problem anyway.
20560 Nevertheless some people like to work with so called
20561 \begin_inset Quotes eld
20565 \begin_inset Quotes erd
20569 If they do so the working copy of all files is readonly when checked out
20570 first and the user starts editing after using a special command to make
20571 the working copy writable.
20572 When the changes are checked in the working copy returns to readonly state.
20573 With \SpecialChar LyX
20574 one has to edit the
20575 \begin_inset Flex Code
20578 \begin_layout Plain Layout
20584 file and add the line
20585 \begin_inset Flex Code
20588 \begin_layout Plain Layout
20594 to work with reserved checkouts.
20595 The benefit is the possibility to see who is using a writable copy of some
20597 It's not guaranteed only one user makes a copy writable.
20600 \begin_layout Standard
20602 tries to guess if you're using reserved or non-reserved checkouts.
20603 If your working copy is readonly or it is writable and an additional copy
20604 of your document exists in the CVS/Base sub-directory a reserved otherwise
20605 a non-reserved checkout is assumed.
20606 When a reserved checkout is detected you have to use
20607 \begin_inset Flex Noun
20610 \begin_layout Plain Layout
20616 to make your working copy writable if it's readonly.
20618 \begin_inset Flex Noun
20621 \begin_layout Plain Layout
20627 operation is possible and that makes your working copy readonly again after
20628 transferring your changes to the repository.
20631 \begin_layout Standard
20632 More information about CVS can be found here
20633 \begin_inset Flex URL
20636 \begin_layout Plain Layout
20638 http://www.nongnu.org/cvs
20644 \begin_inset Flex URL
20647 \begin_layout Plain Layout
20649 http://ximbiot.com/cvs
20657 \begin_layout Standard
20662 to understand the sub-commands and the switches mentioned below.
20665 \begin_layout Subsubsection
20671 \begin_layout Standard
20672 If your document is not under revision control, this is the only item shown
20674 And if it is under revision control, the
20678 item is not visible.
20682 \begin_layout Standard
20683 This command registers in CVS your document
20684 \begin_inset Flex Strong
20687 \begin_layout Plain Layout
20695 in the case you have already the documents directory under CVS control
20701 This means you have to create or checkout the archive by yourself using
20703 (In case you forget that step \SpecialChar LyX
20704 registers the document with RCS.)
20707 \begin_layout Standard
20708 Then you are asked interactively to supply an initial description of the
20710 Don't forget that registered file is not yet checked in.
20713 \begin_layout Standard
20714 CVS command that is run:
20716 cvs -q add -m"<entered message>" "<file-name>"
20719 \begin_layout Standard
20724 above and for all other CVS commands is an abbreviation for
20725 \begin_inset Quotes eld
20728 change the current working directory to file location and use the file name
20729 without path component as argument
20730 \begin_inset Quotes erd
20736 \begin_layout Subsubsection
20742 \begin_layout Standard
20743 When you are finished editing a file, you commit your changes.
20744 When you do this and you had changed the document, you are asked for a
20745 description of the changes.
20746 After that changes are written to the repository.
20747 In case you didn't change the document and a reserved checkout is detected
20748 the reservation made on
20749 \begin_inset Flex Noun
20752 \begin_layout Plain Layout
20761 \begin_layout Labeling
20762 \labelwidthstring 00.00.0000
20764 \begin_inset space ~
20768 \begin_inset space ~
20772 \begin_inset Newline newline
20776 \begin_inset Flex Code
20779 \begin_layout Plain Layout
20782 -q commit -m"<description>" "<file-name>"
20788 \begin_inset Newline newline
20792 \begin_inset Flex Code
20795 \begin_layout Plain Layout
20806 \begin_layout Subsubsection
20812 \begin_layout Standard
20813 When you are sharing a repository with others, you may have to incorporate
20814 their changes into your working copy.
20817 \begin_layout Standard
20820 cvs -q update "<file-name>"
20823 \begin_layout Standard
20824 If a readonly checkout is detected the working copy is made writable and
20828 \begin_layout Standard
20831 cvs -q edit "<file-name>"
20834 \begin_layout Subsubsection
20837 Revert To Repository Version
20840 \begin_layout Standard
20841 This will discard all changes made to the document since the last check
20843 You get a warning before changes are discarded.
20844 Firstly the file is deleted, secondly CVS update command is run.
20847 \begin_layout Standard
20850 cvs -q update "<file-name>"
20853 \begin_layout Standard
20854 If a reserved checkout is detected and the working copy has no changes only
20855 the reservation is undone.
20858 \begin_layout Standard
20861 cvs -q unedit "<file-name>"
20864 \begin_layout Subsubsection
20870 \begin_layout Standard
20871 This will create a copy of the current document.
20872 Since CVS does not support copy operations natively, the version history
20873 is not preserved, and the copy is added as a new file.
20874 It requires a clean document without any changes since the last checkin.
20875 You are asked for a file name and a description of the copy operation.
20876 After that the copy is created, both locally and in the repository.
20877 If the parent directories of the copied and original document differ, all
20878 relative paths of included files of the copy are adjusted (like in
20880 File\SpecialChar menuseparator
20885 Finally, the copy is loaded instead of the original document.
20888 \begin_layout Labeling
20889 \labelwidthstring 00.00.0000
20891 \begin_inset space ~
20895 \begin_inset space ~
20899 \begin_inset Newline newline
20903 \begin_inset Flex Code
20906 \begin_layout Plain Layout
20909 \begin_inset Quotes eld
20913 \begin_inset Quotes erd
20922 \begin_inset Flex Code
20925 \begin_layout Plain Layout
20928 \begin_inset Quotes eld
20932 \begin_inset Quotes erd
20941 \begin_inset Newline newline
20945 \begin_inset Flex Code
20948 \begin_layout Plain Layout
20952 \begin_inset Quotes eld
20956 \begin_inset Quotes erd
20967 \begin_layout Subsubsection
20973 \begin_layout Standard
20974 This will rename the current document.
20975 Since CVS does not support rename operations natively, the version history
20976 is not preserved, the renamed document is added as a new file, and the
20977 original document is deleted.
20978 It requires a clean document without any changes since the last checkin.
20979 You are asked for a file name and a description of the rename operation.
20980 After that the document is renamed, both locally and in the repository.
20981 If the parent directories of the new and old file names differ, all relative
20982 paths of included files are adjusted (like in
20984 File\SpecialChar menuseparator
20989 Finally, the document is reloaded using the new name.
20992 \begin_layout Labeling
20993 \labelwidthstring 00.00.0000
20995 \begin_inset space ~
20999 \begin_inset space ~
21003 \begin_inset Newline newline
21007 \begin_inset Flex Code
21010 \begin_layout Plain Layout
21013 \begin_inset Quotes eld
21017 \begin_inset Quotes erd
21026 \begin_inset Flex Code
21029 \begin_layout Plain Layout
21032 \begin_inset Quotes eld
21036 \begin_inset Quotes erd
21045 \begin_inset Newline newline
21049 \begin_inset Flex Code
21052 \begin_layout Plain Layout
21056 \begin_inset Quotes eld
21060 \begin_inset Quotes erd
21069 \begin_inset Newline newline
21073 \begin_inset Flex Code
21076 \begin_layout Plain Layout
21080 \begin_inset Quotes eld
21084 \begin_inset Quotes erd
21095 \begin_layout Subsubsection
21096 Update of the local directory checkout from repository
21099 \begin_layout Standard
21100 Once your documents gets more complex, containing sub-documents and pictures,
21102 \begin_inset Flex Code
21105 \begin_layout Plain Layout
21111 files and so on using version control becomes more complicated.
21113 supports updating the whole tree in which resides the document.
21114 This become especially useful once you cooperate with people which neither
21115 have detailed knowledge about CVS usage nor they have ambition to commit
21116 additional material to the repository.
21117 You have to organize the files structure so that all external files are
21118 in the same directory or subdirectories of the document.
21119 It's good practice anyway to store multipart documents in an extra directory.
21122 \begin_layout Standard
21124 \begin_inset Flex Code
21127 \begin_layout Plain Layout
21128 Update local directory from repository
21133 command updates the whole directory.
21134 If local changes are detected user is warned before update starts.
21135 In case of merge conflicts both versions of the conflicting document parts
21136 are placed in the final document.
21137 You have to review and correct the result of the merge.
21138 You'll find the conflicts enclosed in pairs of
21139 \begin_inset Flex Code
21142 \begin_layout Plain Layout
21149 \begin_inset Flex Code
21152 \begin_layout Plain Layout
21159 \begin_inset Flex Code
21162 \begin_layout Plain Layout
21169 The first part is your version as before the update operation with the
21170 document name prepended.
21171 The second one is the repository version with the version number after
21173 \begin_inset Flex Code
21176 \begin_layout Plain Layout
21185 \begin_layout Labeling
21186 \labelwidthstring 00.00.0000
21188 \begin_inset space ~
21192 \begin_inset space ~
21196 \begin_inset Newline newline
21200 \begin_inset Flex Code
21203 \begin_layout Plain Layout
21211 (Ask if changes are detected.)
21212 \begin_inset Newline newline
21216 \begin_inset Flex Code
21219 \begin_layout Plain Layout
21220 cd $path; cvs -q update
21230 \begin_layout Standard
21232 \begin_inset Flex Code
21235 \begin_layout Plain Layout
21241 stands for the path to the document.
21244 \begin_layout Subsubsection
21250 \begin_layout Standard
21251 This shows the complete history of the CVS document.
21254 cvs log "<file-name>"
21256 is shown in a browser.
21259 \begin_layout Subsubsection
21263 \begin_layout Standard
21265 supports CVS version number, author name, date and time of last commit.
21266 All those are extracted from
21268 cvs log -r <file-name>
21272 \begin_inset CommandInset ref
21274 reference "subsec:VCS-Revision-Information"
21281 \begin_layout Subsection
21282 SVN commands in \SpecialChar LyX
21286 \begin_layout Standard
21287 SVN is now partially supported by \SpecialChar LyX
21289 You can find the commands in the
21291 File\SpecialChar menuseparator
21293 \begin_inset space ~
21299 Please note that if you use password protected access to repository via
21300 ssh, you will be asked in terminal window.
21302 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21306 \begin_layout Plain Layout
21307 Most of the commands will work with 1.4 too, see
21308 \begin_inset CommandInset ref
21310 reference "subsec:SVN-Repo-Update"
21315 There seems to be currently unresolved permissions problem under SVN 1.8
21316 with reverting changes when file is locked.
21324 \begin_layout Subsubsection
21330 \begin_layout Standard
21331 If your document is not under revision control, this is the only item shown
21333 And if it is under revision control, the
21337 item is not visible.
21340 \begin_layout Standard
21341 This command registers in SVN your document ONLY in case you have already
21342 the documents directory under SVN control (in particular
21347 This means you have to checkout the archive by yourself.
21350 \begin_layout Standard
21351 Then you are asked interactively to supply an initial description of the
21353 Don't forget that registered file is not yet commited.
21356 \begin_layout Standard
21357 SVN command that is run:
21360 \begin_inset Quotes eld
21364 \begin_inset Quotes erd
21370 \begin_layout Standard
21375 to understand the switches.
21378 \begin_layout Subsubsection
21384 \begin_layout Standard
21385 When you are finished editing a file, you commit your changes.
21386 When you do this, you are asked for a description of the changes.
21387 After that changes are commited.
21390 \begin_layout Standard
21395 \begin_layout Plain Layout
21396 In case locking is not enabled.
21398 \begin_inset CommandInset ref
21400 reference "subsec:SVN-File-Locking"
21411 svn commit -q -m"<description>" <file-name>
21414 \begin_layout Subsubsection
21420 \begin_layout Standard
21421 Updates the changes of this file from the repository.
21422 Be sure you understand SVN merging and conflicts resolving before using
21423 this function, because all conflicts has to be resolved manually by you!
21426 \begin_layout Standard
21431 \begin_layout Plain Layout
21439 svn update --non-interactive
21440 \begin_inset Quotes eld
21444 \begin_inset Quotes erd
21450 \begin_layout Subsubsection
21453 Revert To Repository Version
21456 \begin_layout Standard
21457 This will discard all changes made to the document since the last check
21459 You get a warning before changes are discarded.
21462 \begin_layout Standard
21466 \begin_inset Quotes eld
21470 \begin_inset Quotes erd
21476 \begin_layout Subsubsection
21482 \begin_layout Standard
21483 This will create a copy of the current document including the version history.
21484 It requires a clean document without any changes since the last checkin.
21485 You are asked for a file name and a description of the copy operation.
21486 After that the copy is created, both locally and in the repository.
21487 If the parent directories of the copied and original document differ, all
21488 relative paths of included files of the copy are adjusted (like in
21490 File\SpecialChar menuseparator
21495 Finally, the copy is loaded instead of the original document.
21498 \begin_layout Labeling
21499 \labelwidthstring 00.00.0000
21501 \begin_inset space ~
21505 \begin_inset space ~
21509 \begin_inset Newline newline
21513 \begin_inset Flex Code
21516 \begin_layout Plain Layout
21520 \begin_inset Quotes eld
21524 \begin_inset Quotes erd
21528 \begin_inset Quotes eld
21532 \begin_inset Quotes erd
21541 \begin_inset Newline newline
21545 \begin_inset Flex Code
21548 \begin_layout Plain Layout
21557 \begin_layout Subsubsection
21563 \begin_layout Standard
21564 This will rename the current document including the version history.
21565 It requires a clean document without any changes since the last checkin.
21566 You are asked for a file name and a description of the rename operation.
21567 After that the document is renamed, both locally and in the repository.
21568 If the parent directories of the new and old file names differ, all relative
21569 paths of included files are adjusted (like in
21571 File\SpecialChar menuseparator
21576 Finally, the document is reloaded using the new name.
21579 \begin_layout Labeling
21580 \labelwidthstring 00.00.0000
21582 \begin_inset space ~
21586 \begin_inset space ~
21590 \begin_inset Newline newline
21594 \begin_inset Flex Code
21597 \begin_layout Plain Layout
21601 \begin_inset Quotes eld
21605 \begin_inset Quotes erd
21609 \begin_inset Quotes eld
21613 \begin_inset Quotes erd
21622 \begin_inset Newline newline
21626 \begin_inset Flex Code
21629 \begin_layout Plain Layout
21638 \begin_layout Subsubsection
21639 \begin_inset CommandInset label
21641 name "subsec:SVN-Repo-Update"
21645 Update of the local directory checkout from repository
21649 \begin_layout Plain Layout
21650 Note that this command will work only with subversion
21651 \begin_inset Formula $\geqq1.5$
21662 \begin_layout Standard
21663 All the commands above have one shortcomming - they deal with the current
21665 Once your document contains pictures, includes external
21666 \begin_inset Flex Code
21669 \begin_layout Plain Layout
21675 files and so on administration becomes more complicated.
21677 now supports updating the whole tree in which resides the document
21681 \begin_layout Plain Layout
21682 One need to organize the files structure so that all external files are
21683 in the same directory or subdirectories of the document.
21690 This become especially useful once you cooperate with people which neither
21691 know about subversion management nor they have ambition to commit additional
21692 material to the repository.
21696 \begin_layout Standard
21697 \begin_inset Flex Code
21700 \begin_layout Plain Layout
21701 Update local directory from repository
21706 command updates the whole directory and in case of merge conflicts local
21707 version of the files are left, so no unintended data loss occurs.
21708 If local changes are detected user is warned before update starts.
21711 \begin_layout Labeling
21712 \labelwidthstring 00.00.0000
21714 \begin_inset space ~
21718 \begin_inset space ~
21722 \begin_inset Newline newline
21726 \begin_inset Flex Code
21729 \begin_layout Plain Layout
21735 (Ask if changes are detected.)
21736 \begin_inset Newline newline
21740 \begin_inset Flex Code
21743 \begin_layout Plain Layout
21744 svn update –accept mine-full $path
21752 \begin_layout Standard
21754 \begin_inset Flex Code
21757 \begin_layout Plain Layout
21763 stands for the path to the document.
21766 \begin_layout Subsubsection
21772 \begin_layout Standard
21773 This shows the complete history of the SVN document.
21777 \begin_inset Quotes eld
21781 \begin_inset Quotes erd
21786 is shown in a browser.
21789 \begin_layout Subsubsection
21791 \begin_inset CommandInset label
21793 name "subsec:SVN-File-Locking"
21800 \begin_layout Standard
21801 The file exchange through various revision control systems brings the problem
21802 of merge conflicts in case two different users try to edit the same (parts
21804 When such a conflict happens it needs manual resolving and one reasonable
21805 alternative is to provide some kind of locking mechanism, which guarantees
21806 that only one user is allowed to edit file at the given time.
21809 \begin_layout Standard
21810 SVN has two such mechanisms to provide mutual exclusivity for file access
21811 - locks and automatic setting of write permissions (see sec.
21813 \begin_inset CommandInset ref
21815 reference "subsec:Automatical-Locking-Property"
21820 \begin_inset Flex Code
21823 \begin_layout Plain Layout
21833 \begin_layout Plain Layout
21834 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21840 If this property is detected for a given document \SpecialChar LyX
21841 starts to use SVN locks
21842 for document editing automatically and the whole check-in/out mechanism
21843 switches to the same regimen as for RCS.
21844 This in particular means there are two different modes of file use in \SpecialChar LyX
21848 \begin_layout Itemize
21850 The loaded file is in the read-only mode.
21851 For editing on needs to check-out.
21856 consists of updating from the repository and gaining write lock.
21857 If the lock is not possible to obtain, we remain in unlocked state.
21860 \begin_layout Itemize
21862 The loaded file is in the 'normal' edit mode.
21863 No other user is allowed to edit the file.
21868 consists of commiting changes and releasing write-lock.
21869 If no changes have been made to the document, no commit will be produced
21873 \begin_layout Plain Layout
21874 Don't be puzzled by the fact that you will be asked for commit message anyway.
21879 and only the write-lock will be released.
21882 \begin_layout Standard
21886 \begin_layout Labeling
21887 \labelwidthstring 00.00.0000
21890 svn commit -q -m"<description>" "<file-name>"
21891 \begin_inset Newline newline
21894 svn unlock "<file-name>"
21897 \begin_layout Labeling
21898 \labelwidthstring 00.00.0000
21901 svn update "<file-name>"
21902 \begin_inset Newline newline
21905 svn lock "<file-name>"
21908 \begin_layout Subsubsection
21911 \begin_inset CommandInset label
21913 name "subsec:Automatical-Locking-Property"
21919 Automatic Locking Property
21922 \begin_layout Standard
21923 The above mentioned automatic setting of write permissions of the .lyx file
21926 File\SpecialChar menuseparator
21928 \begin_inset space ~
21931 Control\SpecialChar menuseparator
21932 Toggle locking property
21935 This command is active only when the file is not locked on the svn server
21937 you need to check-out before proceeding).
21940 \begin_layout Labeling
21941 \labelwidthstring 00.00.0000
21943 \begin_inset space ~
21949 \begin_layout Labeling
21950 \labelwidthstring 00.00.0000
21953 svn propset svn:needs-lock ON "<file-name>"
21956 \begin_layout Labeling
21957 \labelwidthstring 00.00.0000
21960 svn propdel svn:needs-lock "<file-name>"
21963 \begin_layout Subsubsection
21964 \begin_inset CommandInset label
21966 name "subsec:VCS-Revision-Information"
21970 Revision Information in Documents
21973 \begin_layout Standard
21974 There are more possibilities how to activate revision information in our
21978 \begin_layout Itemize
21984 \begin_layout Itemize
21985 tree revision information (
21986 \begin_inset Flex Code
21989 \begin_layout Plain Layout
21996 The result is the output of the
21997 \begin_inset Flex Code
22000 \begin_layout Plain Layout
22006 command, the following table gives you an idea, how to read the results.
22009 \begin_layout Standard
22011 \begin_inset Tabular
22012 <lyxtabular version="3" rows="6" columns="2">
22013 <features tabularvalignment="middle">
22014 <column alignment="center" valignment="top">
22015 <column alignment="center" valignment="top">
22017 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22020 \begin_layout Plain Layout
22026 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22029 \begin_layout Plain Layout
22037 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22040 \begin_layout Plain Layout
22046 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22049 \begin_layout Plain Layout
22050 mixed revision working copy
22057 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22060 \begin_layout Plain Layout
22066 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22069 \begin_layout Plain Layout
22070 modified working copy
22077 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22080 \begin_layout Plain Layout
22086 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22089 \begin_layout Plain Layout
22090 switched working copy
22097 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22100 \begin_layout Plain Layout
22106 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22109 \begin_layout Plain Layout
22110 partial working copy, from a sparse checkout
22117 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22120 \begin_layout Plain Layout
22126 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22129 \begin_layout Plain Layout
22130 mixed revision, modified, switched working copy
22143 \begin_layout Itemize
22144 file revision information.
22145 The result comes from parsing the output of
22146 \begin_inset Flex Code
22149 \begin_layout Plain Layout
22151 \begin_inset space ~
22155 \begin_inset space ~
22159 \begin_inset space ~
22168 Supported flags are:
22172 \begin_layout Itemize
22173 version number of the last commit (
22174 \begin_inset Flex Code
22177 \begin_layout Plain Layout
22186 \begin_layout Itemize
22187 author of the last commit (
22188 \begin_inset Flex Code
22191 \begin_layout Plain Layout
22200 \begin_layout Itemize
22201 date of the last commit (
22202 \begin_inset Flex Code
22205 \begin_layout Plain Layout
22214 \begin_layout Itemize
22215 time of the last commit (
22216 \begin_inset Flex Code
22219 \begin_layout Plain Layout
22229 \begin_layout Standard
22230 You can obtain this info via InsetInfo (e.g.
22232 \begin_inset Flex Code
22235 \begin_layout Plain Layout
22236 info-insert buffer vcs-date
22242 The information will be available only when you have the file stored under
22243 svn managment (i.e.
22245 \begin_inset Flex Code
22248 \begin_layout Plain Layout
22254 directory is available with your document).
22258 \begin_layout Itemize
22259 Another—a hacking one—possibility is to use svn keywords
22263 \begin_layout Plain Layout
22264 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22270 In short – you set file keywords property (e.g.
22273 svn propset svn:keywords 'Rev' file.lyx
22275 ) and then paste keyword \SpecialChar TeX
22280 \begin_layout Plain Layout
22281 This is an easy way how to ensure that \SpecialChar LyX
22282 won't break the line in the middle
22288 tag in your document (e.g.
22293 \begin_layout Plain Layout
22301 This way svn client will automatically substitute revision number (e.g.
22306 \begin_layout Plain Layout
22313 ) after each update and commit.
22314 There are more problems with this approach.
22315 Firstly, the '$' character is used in \SpecialChar TeX
22316 world for math equations, so any
22317 occurence of math formula
22318 \begin_inset Formula $Rev$
22322 \begin_inset Formula $Rev:59$
22325 in your \SpecialChar LyX
22327 Similarly for other keywords like Id, Date, Author, etc.
22328 Secondly svn output is dependent on your locales, so its very easy that
22329 svn would produce some problematic strings once Date is used.
22330 Thirdly you get the whole 'Rev: 59' string in your document instead of
22332 Until subversion implements user's custom keywords it will be hard to use
22333 this approach reliably or let \SpecialChar LyX
22334 to support it directly.
22337 \begin_layout Subsection
22338 SVN and Windows Environment
22341 \begin_layout Quote
22342 My inclination is to say that if the user cannot figure out the command
22343 line operations on their own fairly quickly, they would be well advised
22344 to use TortoiseSVN.
22350 \begin_layout Subsubsection
22354 \begin_layout Standard
22355 In addition to installing \SpecialChar LyX
22356 , and having access to a Subversion repository,
22357 the user will need to install the Subversion client program.
22358 A Windows installer for the client program is available from
22359 \begin_inset CommandInset href
22362 target "http://www.collab.net/nonav/downloads/subversion/"
22368 The user may also want to install
22369 \begin_inset CommandInset href
22372 target "http://tortoisesvn.tigris.org/"
22377 , which integrates Subversion operations into the context (rightclick) menu
22378 of Windows Explorer.
22379 Operations done outside \SpecialChar LyX
22380 will typically be more convenient using the Explorer
22382 Note that TortoiseSVN is not a replacement for the client program, which
22383 is what \SpecialChar LyX
22387 \begin_layout Subsubsection
22388 Bringing a document under Subversion control
22391 \begin_layout Standard
22392 Before a \SpecialChar LyX
22393 document can be brought under version control in Subversion, its
22394 parent directory needs to be under version control.
22395 If the document is being added to a project already in the repository,
22396 this is accomplished by checking the project out to the directory where
22397 the new document will be placed.
22398 If the project itself is not yet under version control (for instance, if
22399 this document starts a new project), the directory must be imported into
22401 This is done outside \SpecialChar LyX
22403 Both import and checkout are easily accomplished from the Explorer context
22404 menu using TortoiseSVN, or alternatively can be done using the command
22405 line client at a DOS prompt.
22406 The procedure for importing the project using TortoiseSVN is described
22407 below, assuming an existing repository and a new project being started
22415 For information on using the Subversion client program, run
22422 \begin_layout Enumerate
22429 in Windows Explorer, right click it, and select
22431 TortoiseSVN\SpecialChar menuseparator
22435 If necessary, adjust the URL for the repository, then click OK.
22438 \begin_layout Enumerate
22439 Right click the level of the repository under which you want to place the
22440 new project folder (typically the top level) and click
22444 Supply a name for the project folder and click OK.
22445 Add a message for the log file if desired, then click OK again.
22446 The new project folder should appear in the repository.
22447 Finally, click OK again to exit the repository browser.
22450 \begin_layout Enumerate
22451 Once again right click
22457 , this time selecting SVN Checkout\SpecialChar ldots
22458 Select the URL of the project folder
22459 you just created in the repository, and set the checkout directory to
22467 You will be warned about a non-empty folder; click OK to proceed.
22468 You should now have a
22479 \begin_layout Enumerate
22480 Create or open your document in \SpecialChar LyX
22483 File\SpecialChar menuseparator
22485 \begin_inset space ~
22488 Control\SpecialChar menuseparator
22492 Add a log message and click OK to commit the document to version control.
22495 \begin_layout Standard
22496 From this point onward, you should have full functionality in the
22498 File\SpecialChar menuseparator
22500 \begin_inset space ~
22506 You also have the option of checking the document in and out, viewing its
22508 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22509 client program from a command prompt.
22512 \begin_layout Subsubsection
22513 SSH tunnel used with SVN under Windows
22516 \begin_layout Standard
22517 Compared with Linux setting up an svn client to communicate over ssh under
22518 Windows is a rather troublesome task.
22519 We will at least offer some hints how to setup the client side but prior
22520 knowledge about ssh and the Windows command line is needed, also be prepared
22521 for a great deal of frustration\SpecialChar ldots
22525 \begin_layout Enumerate
22526 Get an svn client for windows, as described in the previous sections.
22527 When it is a fresh install run some svn command (e.g.
22529 \begin_inset Flex Code
22532 \begin_layout Plain Layout
22538 ) to create config files, which you will need to change later on.
22541 \begin_layout Enumerate
22542 Choose an ssh client for Windows.
22543 There are several possibilities, we will use the one from Putty tools
22547 \begin_layout Plain Layout
22548 \begin_inset Flex URL
22551 \begin_layout Plain Layout
22553 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22564 You will need to set the connection up so that the client doesn't ask for
22565 any password from you.
22566 To keep things easy we will use only keys without any additional password
22571 \begin_layout Enumerate
22573 \begin_inset Flex Code
22576 \begin_layout Plain Layout
22583 Save your private .ppk key file and put the public one on the server side.
22584 If the SVN server runs on Linux, note that the format of the public key
22585 is not compatible with Linux openssh and you will need to direcly copy-paste
22588 Public key for pasting into OpenSSH authorized_keys file
22590 :” edit field into the server's
22591 \begin_inset Flex Code
22594 \begin_layout Plain Layout
22595 ~/.ssh/authorized_keys
22601 \begin_inset Flex Code
22604 \begin_layout Plain Layout
22613 \begin_layout Enumerate
22615 \begin_inset Flex Code
22618 \begin_layout Plain Layout
22625 In the SVN config file
22629 \begin_layout Plain Layout
22630 Exact path depends on Windows version, usually somewhere around
22631 \begin_inset Flex Code
22634 \begin_layout Plain Layout
22637 Documents and Settings
22651 \begin_inset Flex Code
22654 \begin_layout Plain Layout
22669 , section [tunnels], setup ssh command, e.g.
22671 \begin_inset Flex Code
22674 \begin_layout Plain Layout
22675 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22684 \begin_layout Plain Layout
22685 It will usually take a lot of time to get exact command right and it depends
22687 For example do not have some remote server saved as a default session in
22689 If things fail, try to connect via plink without SVN first.
22698 \begin_layout Enumerate
22699 Checkout the SVN archive, e.
22700 \begin_inset space \thinspace{}
22704 \begin_inset Newline newline
22708 \begin_inset Flex Code
22711 \begin_layout Plain Layout
22712 svn co svn+ssh://user@server/repository_path
22720 \begin_layout Subsubsection
22721 End-of-Line Conversions
22724 \begin_layout Standard
22725 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22727 use different line endings inside the .lyx files.
22728 This is not a problem as far as \SpecialChar LyX
22729 functionality is concerned, but the commit
22730 diffs will be huge and merge-conflicts prone.
22731 Fortunately SVN itself knows
22735 \begin_layout Plain Layout
22736 \begin_inset Flex URL
22739 \begin_layout Plain Layout
22741 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22751 how to deal with CR/LF problems when switching .lyx files to the
22752 \begin_inset Flex Code
22755 \begin_layout Plain Layout
22765 \begin_layout Plain Layout
22767 \begin_inset Flex Code
22770 \begin_layout Plain Layout
22771 svn propset svn:eol-style native FILE_NAME
22784 \begin_layout Subsection
22785 GIT commands in \SpecialChar LyX
22789 \begin_layout Standard
22790 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22792 You can find the commands in the
22794 File\SpecialChar menuseparator
22796 \begin_inset space ~
22802 Please note that if you use password protected access to repository via
22803 ssh, you will be asked in terminal window.
22805 was tested against GIT 1.7.
22809 \begin_layout Plain Layout
22810 Windows users please note that you need to ensure that git is on the path.
22811 This can be set from within \SpecialChar LyX
22814 Tools\SpecialChar menuseparator
22815 Preferences\SpecialChar menuseparator
22816 Paths\SpecialChar menuseparator
22827 \begin_layout Standard
22828 One big difference of GIT and the other supported version control systems
22829 is the distributed nature of GIT: With traditional version control systems
22830 there is one central server which hosts the repository.
22831 Users commit their changes to the server, and get updates made by other
22833 With GIT, users commit to a local repository.
22834 The local repository can be synchronized with one or more remote repositories
22836 \begin_inset Flex Code
22839 \begin_layout Plain Layout
22846 \begin_inset Flex Code
22849 \begin_layout Plain Layout
22857 does not interact in any way with remote GIT repositories.
22858 It works exclusively with the local repository in a very similar way as
22859 with a central CVS or SVN repository.
22860 If you use remote GIT repositories you need to do the
22861 \begin_inset Flex Code
22864 \begin_layout Plain Layout
22871 \begin_inset Flex Code
22874 \begin_layout Plain Layout
22880 operations with your favourite GIT client.
22883 \begin_layout Subsubsection
22889 \begin_layout Standard
22890 If your document is not under revision control, this is the only item shown
22892 And if it is under revision control, the
22896 item is not visible.
22899 \begin_layout Standard
22900 This command registers in GIT your document ONLY in case you have already
22901 the documents directory under GIT control (in particular
22906 This means you have to checkout the archive by yourself.
22909 \begin_layout Standard
22910 Then you are asked interactively to supply an initial description of the
22912 Don't forget that registered file is not yet commited.
22915 \begin_layout Standard
22916 GIT command that is run:
22919 \begin_inset Quotes eld
22923 \begin_inset Quotes erd
22929 \begin_layout Standard
22934 to understand the switches.
22937 \begin_layout Subsubsection
22943 \begin_layout Standard
22944 When you are finished editing a file, you commit your changes.
22945 When you do this, you are asked for a description of the changes.
22946 After that changes are commited.
22949 \begin_layout Standard
22952 git commit -q -m"<description>" <file-name>
22955 \begin_layout Subsubsection
22958 Revert To Repository Version
22961 \begin_layout Standard
22962 This will discard all changes made to the document since the last check
22964 You get a warning before changes are discarded.
22967 \begin_layout Standard
22971 \begin_inset Quotes eld
22975 \begin_inset Quotes erd
22981 \begin_layout Subsubsection
22987 \begin_layout Standard
22988 This will rename the current document including the version history.
22989 It requires a clean document without any changes since the last checkin.
22990 You are asked for a file name and a description of the rename operation.
22991 After that the document is renamed, both locally and in the repository.
22992 If the parent directories of the new and old file names differ, all relative
22993 paths of included files are adjusted (like in
22995 File\SpecialChar menuseparator
23000 Finally, the document is reloaded using the new name.
23003 \begin_layout Labeling
23004 \labelwidthstring 00.00.0000
23006 \begin_inset space ~
23010 \begin_inset space ~
23014 \begin_inset Newline newline
23018 \begin_inset Flex Code
23021 \begin_layout Plain Layout
23025 \begin_inset Quotes eld
23029 \begin_inset Quotes erd
23033 \begin_inset Quotes eld
23037 \begin_inset Quotes erd
23046 \begin_inset Newline newline
23050 \begin_inset Flex Code
23053 \begin_layout Plain Layout
23062 \begin_layout Subsubsection
23068 \begin_layout Standard
23069 This shows the complete history of the GIT document.
23073 \begin_inset Quotes eld
23077 \begin_inset Quotes erd
23082 is shown in a browser.
23085 \begin_layout Subsubsection
23089 \begin_layout Standard
23091 supports GIT hash number of the last commit to the file, author name, date
23092 and time of last commit.
23093 All those are extracted from
23095 git log -n 1 --pretty=format:%H%n%an%n%ai
23098 Tree version information is obtained via
23100 git describe --abbrev --dirty --long
23104 \begin_inset CommandInset ref
23106 reference "subsec:VCS-Revision-Information"
23113 \begin_layout Subsection
23117 \begin_layout Standard
23118 With the recent addition of the vc-command function \SpecialChar LyX
23119 power users are allowed
23120 to create their own commands for revision control.
23123 \begin_layout Standard
23124 As an example you can see how two TortoiseSVN commands could be integrated
23128 \begin_layout Description
23130 \begin_inset Flex Code
23133 \begin_layout Plain Layout
23134 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23142 \begin_layout Description
23144 \begin_inset Flex Code
23147 \begin_layout Plain Layout
23148 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23156 \begin_layout Subsection
23157 Version control and Document comparison
23160 \begin_layout Standard
23161 One of the typical uses of version control is to inspect the changes between
23162 revisions, usually by creating
23163 \begin_inset Flex Code
23166 \begin_layout Plain Layout
23173 While this is useful for plain text files, it is much less useful in the
23174 case of \SpecialChar LyX
23175 files, which have more a complicated structure.
23176 Hence we provide binding to the Document comparison feature.
23177 There are two ways of calling this feature - either by direct call of
23178 \begin_inset Flex Code
23181 \begin_layout Plain Layout
23188 function (for details see \SpecialChar LyX
23189 functions manual) or by icon/menu item
23190 \begin_inset Flex Noun
23193 \begin_layout Plain Layout
23194 Compare with older revision...
23200 One can either compare two chosen revisions of the document or he can simply
23201 compare the current version of edited text with older revisions (where
23203 \begin_inset Flex Noun
23206 \begin_layout Plain Layout
23212 ' revisions back means comparison of the edited file with last commited
23217 \begin_layout Standard
23218 This feature is supported for SVN and RCS though due to the more complicated
23219 versioning scheme of RCS there is a constraint – when addressing the revisions
23220 in dialog, numbers always point to the last number in RCS revision number,
23223 We don't currently support GIT addressing of revisions, one can just compare
23224 edited document with its revision X steps backs, where X is addressed as
23228 \begin_layout Section
23229 Literate Programming
23232 \begin_layout Standard
23237 (kayvan@sylvan.com)
23241 original documentation written by
23243 Edmar Wienskoski Jr.
23246 (edmar-w-jr@technologist.com)
23249 \begin_layout Subsection
23253 \begin_layout Standard
23254 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23256 programming, where it is assumed that you are familiar with this programming
23257 technique, and know what
23258 \begin_inset Quotes eld
23262 \begin_inset Quotes erd
23266 \begin_inset Quotes eld
23270 \begin_inset Quotes erd
23274 If that is not the case, please follow the web links provided in the following
23276 There is a lot of good documentation out there covering old development
23277 history to the latest tools tips.
23280 \begin_layout Standard
23281 It is also assumed that you are familiar with \SpecialChar LyX
23282 itself to a point that you
23283 are comfortable changing your \SpecialChar LyX
23284 preferences, and X resources file.
23285 If that is not the case please refer to other \SpecialChar LyX
23286 documentation to cover your
23290 \begin_layout Subsection
23291 Literate Programming
23294 \begin_layout Standard
23295 From the Literate Programming FAQ:
23298 \begin_layout Quotation
23299 Literate programming is the combination of documentation and source together
23300 in a fashion suited for reading by human beings.
23301 In fact, literate programs should be enjoyable reading, even inviting!
23302 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23303 and documentation in a single file.
23304 Literate programming tools then parse the file to produce either readable
23305 documentation or compilable source.
23306 The WEB style of literate programming was created by D.
23307 \begin_inset space \thinspace{}
23311 Knuth during the development of his \SpecialChar TeX
23312 typesetting software.
23316 \begin_layout Standard
23317 Another excerpt says:
23320 \begin_layout Quotation
23323 How is literate programming different from verbose commenting?
23326 \begin_layout Quotation
23327 There are three distinguishing characteristics.
23328 In order of importance, they are:
23332 \begin_layout Itemize
23333 flexible order of elaboration
23336 \begin_layout Itemize
23337 automatic support for browsing
23340 \begin_layout Itemize
23341 typeset documentation, especially diagrams and mathematics
23345 \begin_layout Standard
23346 Now that I sparked your curiosity, take a look in the references.
23349 \begin_layout Subsubsection
23353 \begin_layout Standard
23354 The complete Literate Programming FAQ can be found at:
23357 \begin_layout Quote
23358 Literate Programming FAQ
23359 \begin_inset Flex URL
23362 \begin_layout Plain Layout
23364 http://www.literateprogramming.com/lpfaq.pdf
23372 \begin_layout Standard
23373 The FAQ lists 23 (twenty three!) different literate programming tools.
23374 Where some are specialized or
23375 \begin_inset Quotes eld
23379 \begin_inset Quotes erd
23382 for particular programming languages, while other have general scope.
23387 for my own use for several reasons:
23390 \begin_layout Itemize
23391 It can generate the documentation either in \SpecialChar LaTeX
23395 \begin_layout Itemize
23396 It has a open architecture, i.
23397 \begin_inset space \thinspace{}
23401 \begin_inset space \space{}
23404 it is easy to plug in new filters and to perform special processing that
23409 \begin_layout Itemize
23410 There is a good selection of filters available already (the HTML is one
23414 \begin_layout Itemize
23418 \begin_layout Standard
23419 The Noweb web page can be found at:
23422 \begin_layout Quote
23424 \begin_inset Flex URL
23427 \begin_layout Plain Layout
23429 http://www.cs.virginia.edu/~nr/noweb/
23437 \begin_layout Standard
23438 Starting from there you can reach many other interesting links and even
23439 some literate program examples.
23442 \begin_layout Subsection
23444 and Literate Programming with Noweb
23447 \begin_layout Standard
23448 The \SpecialChar LyX
23449 support for Literate Programming is provided by using the generic \SpecialChar LyX
23451 converters mechanism.
23452 This support is provided in a
23453 \begin_inset Quotes eld
23457 \begin_inset Quotes erd
23461 \begin_inset space \thinspace{}
23465 \begin_inset space \space{}
23468 you will be able to use this new \SpecialChar LyX
23469 feature with some other literate programming
23470 tool of your choice by just changing your \SpecialChar LyX
23474 \begin_layout Subsubsection
23475 Generating documents and code (weaving and tangling)
23478 \begin_layout Paragraph
23479 Using the noweb module
23482 \begin_layout Standard
23483 If you have installed Noweb and \SpecialChar LyX
23484 successfully, whenever you open a new document,
23485 after you have chosen its document class, use the Document->Settings menu
23487 \begin_inset Quotes eld
23491 \begin_inset Quotes erd
23495 If Noweb is correctly installed, when you click on the
23496 \begin_inset Quotes eld
23500 \begin_inset Quotes erd
23503 link, you will see the
23504 \begin_inset Quotes eld
23508 \begin_inset Quotes erd
23511 module in the available list and you can add it to your document.
23514 \begin_layout Paragraph
23518 \begin_layout Standard
23520 enables you to write code with a layout named
23521 \begin_inset Flex Noun
23524 \begin_layout Plain Layout
23531 Noweb delimits chunks like this:
23534 \begin_layout LyX-Code
23538 \begin_layout LyX-Code
23542 \begin_layout LyX-Code
23546 \begin_layout LyX-Code
23550 \begin_layout LyX-Code
23554 \begin_layout Standard
23555 The problem is that whatever is written in between the << and the
23559 must be taken literally, i.
23560 \begin_inset space \thinspace{}
23564 \begin_inset space \space{}
23568 should be prevented from making any special interpretation of what has
23570 This is also handled by
23571 \begin_inset Flex Noun
23574 \begin_layout Plain Layout
23580 , that works like a normal paragraph but has a free spacing capability.
23583 \begin_layout Standard
23584 As a special note, you can also use the
23585 \begin_inset Quotes eld
23589 \begin_inset Quotes erd
23592 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23596 \begin_layout LyX-Code
23600 \begin_layout LyX-Code
23601 def some_function(args):
23604 \begin_layout LyX-Code
23605 "This is the doc string for this function."
23608 \begin_layout LyX-Code
23609 print "My args: ", args
23612 \begin_layout LyX-Code
23613 @ %def some_function
23616 \begin_layout Standard
23617 For an example of this usage and the resulting cross-reference output, look
23618 at the Literate python program in
23620 LIBDIR/examples/listerrors.lyx
23622 which should make this all clear.
23625 \begin_layout Paragraph
23626 Generating the documentation
23629 \begin_layout Standard
23630 At this point you already have a new document file with a proper document
23631 class, and with some code and text on it.
23632 How do I print it? The answer is simple, you select
23634 View\SpecialChar menuseparator
23638 Just like you would do for a plain document.
23639 No special procedure is required.
23642 \begin_layout Standard
23643 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23647 \begin_layout Enumerate
23650 Update\SpecialChar menuseparator
23653 menu option is chosen, a \SpecialChar LaTeX
23659 \begin_layout Standard
23660 If the document is of any literate class the generated file will be named
23661 with an extension name defined by the
23662 \begin_inset Quotes eld
23666 \begin_inset Quotes erd
23669 format (defined in the Preferences panel), otherwise the file will have
23678 \begin_layout Enumerate
23679 Note that the only difference so far is in the name of the file, no special
23680 processing is required by \SpecialChar LyX
23682 Given that you formatted the code using the
23683 \begin_inset Flex Noun
23686 \begin_layout Plain Layout
23692 layout that, by itself, takes care of the business.
23695 \begin_layout Enumerate
23696 If the document is of any literate class \SpecialChar LyX
23697 will then use the internal \SpecialChar LyX
23699 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23704 \begin_layout Plain Layout
23705 The converters are defined in the
23707 Tools\SpecialChar menuseparator
23711 \begin_inset Quotes eld
23715 \begin_inset Quotes erd
23727 manual for general information about converters.
23732 to generate the \SpecialChar LaTeX
23737 \begin_layout Standard
23738 Otherwise it will just skip this step.
23742 \begin_layout Enumerate
23743 Finally, \SpecialChar LaTeX
23744 is invoked and the regular post processing continues as in a plain
23748 \begin_layout Standard
23749 Independence from a particular
23750 \begin_inset Quotes eld
23754 \begin_inset Quotes erd
23757 is easily achieved by changing the commands that are run by the various
23761 \begin_layout Paragraph
23762 Generating the code
23765 \begin_layout Standard
23766 When the build menu option is chosen or the corresponding button in the
23767 toolbar is pressed, a \SpecialChar LaTeX
23768 file is generated just like step 1 above.
23769 Next, \SpecialChar LyX
23775 This converter needs to be defined by the user and is not installed by
23776 default, though the Program format is.
23777 This converter (like any other converter) will have two parts:
23780 \begin_layout Enumerate
23781 The converter program itself.
23782 This program performs the conversion from the one format to the other (in
23783 this case, from the Noweb format to the Program pseudo-format).
23786 \begin_layout Enumerate
23787 The error log parser.
23788 This is a program whose sole purpose is to rewrite error messages in a
23789 format that \SpecialChar LyX
23791 This makes it possible for \SpecialChar LyX
23792 to place error boxes in the right places in
23796 \begin_layout Standard
23797 The first part, the
23798 \begin_inset Quotes eld
23802 \begin_inset Quotes erd
23805 setting, should be set to
23806 \begin_inset Newline newline
23810 \begin_inset Quotes eld
23818 \begin_inset Quotes erd
23822 \begin_inset Newline newline
23825 This basically means that \SpecialChar LyX
23827 \begin_inset Quotes eld
23831 \begin_inset Quotes erd
23834 (a program or script) with the name of the Noweb file (normally a file
23835 in the \SpecialChar LyX
23836 temp directory) and the directory path of the original \SpecialChar LyX
23841 \begin_layout Standard
23842 This is an implementation of
23843 \begin_inset Quotes eld
23847 \begin_inset Quotes erd
23850 that you can place in a directory on your path:
23853 \begin_layout Standard
23854 \begin_inset VSpace defskip
23860 \begin_layout Standard
23861 \begin_inset Newpage pagebreak
23867 \begin_layout Standard
23873 \begin_layout Standard
23879 \begin_layout Standard
23882 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23885 \begin_layout Standard
23886 \begin_inset VSpace defskip
23892 \begin_layout Standard
23893 The next part of the converter setting is the
23894 \begin_inset Quotes eld
23898 \begin_inset Quotes erd
23901 which is to be set to
23902 \begin_inset Newline newline
23906 \begin_inset Quotes eld
23911 parselog=$$s/scripts/listerrors
23914 \begin_inset Quotes erd
23918 \begin_inset Newline newline
23921 This will run any errors that are generated by the
23922 \begin_inset Quotes eld
23926 \begin_inset Quotes erd
23929 process through the
23930 \begin_inset Quotes eld
23934 \begin_inset Quotes erd
23940 \begin_layout Standard
23941 The build will normally take place in \SpecialChar LyX
23942 's temporary directory, so the files
23943 produced by the conversion will be in that directory.
23945 will copy out what it regards as the `main' file, but the
23949 conversion may produce several files, and so most of these would then be
23950 deleted when \SpecialChar LyX
23952 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23953 the build-script chunk can place the generated files in that location.
23956 \begin_layout Paragraph
23957 Build instructions in the document
23960 \begin_layout Standard
23961 The last piece of the integration between \SpecialChar LyX
23963 \begin_inset Quotes eld
23967 \begin_inset Quotes erd
23971 Generally, the instructions for building your program should be embedded
23972 in a chunk of its own.
23974 \begin_inset Quotes eld
23978 \begin_inset Quotes erd
23981 above uses the notangle command to look for this chunk (called
23982 \begin_inset Quotes eld
23986 \begin_inset Quotes erd
23989 ) and runs its contents through
23990 \begin_inset Quotes eld
23994 \begin_inset Quotes erd
24000 \begin_layout Standard
24001 Typically, such a chunk would look something like this:
24004 \begin_layout LyX-Code
24008 \begin_layout LyX-Code
24010 \begin_inset Newline newline
24013 if [ -z "${NOWEB_SOURCE}" ]
24014 \begin_inset Newline newline
24020 \begin_layout LyX-Code
24021 NOWEB_SOURCE=myfile.nw
24022 \begin_inset Newline newline
24026 \begin_inset Newline newline
24030 code to extract files ...
24031 use NOWEB_OUTPUT_DIR here ...]
24032 \begin_inset Newline newline
24036 code to compile files ...]
24037 \begin_inset Newline newline
24043 \begin_layout Standard
24046 LIBDIR/examples/listerrors.lyx
24050 LIBDIR/examples/Literate.lyx
24052 which implement two versions of the
24053 \begin_inset Quotes eld
24057 \begin_inset Quotes erd
24060 program for some illustrations of how all of these pieces go together or
24063 LIBDIR/examples/noweb2lyx.lyx.
24066 Interestingly, these three files show off the language-indepence of the
24068 literate programming support since they are written in Python, C and Perl
24072 \begin_layout Subsubsection
24073 Configuring \SpecialChar LyX
24077 \begin_layout Standard
24078 All the Literate Programming support is configured by the
24080 Tools\SpecialChar menuseparator
24084 \begin_inset Quotes eld
24088 \begin_inset Quotes erd
24092 The important parts are:
24095 \begin_layout Description
24097 \begin_inset space ~
24101 \begin_inset Quotes eld
24105 \begin_inset Quotes erd
24109 \begin_inset space ~
24112 format Set up via the File Formats tab, this is where the Noweb-specific
24122 , the file extension is set to
24127 This tells \SpecialChar LyX
24128 to create a file with a
24132 extension in the first step of the conversion process.
24135 \begin_layout Description
24137 \begin_inset space ~
24145 \begin_inset space ~
24148 format This is an empty format whose sole purpose is to be the endpoint
24149 of a conversion (which then allows us to set up a converter for it).
24152 \begin_layout Description
24162 This converter performs the
24163 \begin_inset Quotes eld
24167 \begin_inset Quotes erd
24170 of the literate document.
24171 For Noweb, it is set to
24172 \begin_inset Quotes eld
24177 noweave -delay -index $$i > $$o
24180 \begin_inset Quotes erd
24186 \begin_layout Description
24196 \begin_inset Quotes eld
24200 \begin_inset Quotes erd
24204 As stated above, the Converter is set to
24205 \begin_inset Quotes eld
24213 \begin_inset Quotes erd
24216 , with Flags set to
24217 \begin_inset Newline newline
24221 \begin_inset Quotes eld
24226 parselog=$$s/scripts/listerrors
24229 \begin_inset Quotes erd
24235 \begin_layout Subsubsection
24239 \begin_layout Standard
24240 There is also a new function implemented in the \SpecialChar LyX
24242 \begin_inset Quotes eld
24245 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24249 \begin_layout Standard
24250 When debugging code with ddd/gdb, it is possible to invoke a text editor
24251 at the current execution position with a single key stroke.
24252 The default ddd configuration for that is shift-ctrl-V.
24253 It happens that you can define the editor command line invocation in ddd
24256 Edit\SpecialChar menuseparator
24257 Preferences\SpecialChar menuseparator
24260 dialog and changing the "Edit Sources" entry.
24263 \begin_layout Standard
24264 I take advantage of the newly created \SpecialChar LyX
24265 server function and this ddd feature,
24267 \begin_inset Quotes eld
24271 \begin_inset Quotes erd
24277 \begin_layout Standard
24278 \begin_inset VSpace defskip
24284 \begin_layout Standard
24287 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24290 \begin_layout Standard
24291 \begin_inset VSpace defskip
24297 \begin_layout Standard
24298 With this, whenever you are using ddd and find a point in the program that
24299 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24300 ddd will forward this information to \SpecialChar LyX
24301 through the \SpecialChar LyX
24302 server and then the
24304 window will show the same file with the cursor at the same position ddd
24306 No more guessing or long scrolling to locate a point in the program back
24310 \begin_layout Standard
24311 Note however that you must enable the \SpecialChar LyX
24312 server to get this feature working
24313 (it is disabled by default).
24314 You can enable it in
24326 ) by entering in the
24332 \begin_inset Quotes eld
24337 /home/<your-home-directory>/.lyx/lyxpipe
24340 \begin_inset Quotes erd
24346 \begin_layout Standard
24347 Read the \SpecialChar LyX
24348 server documentation in the
24350 Customization Manual
24352 for further information.
24355 \begin_layout Subsubsection
24359 \begin_layout Standard
24360 There are six new buttons that can be added to your \SpecialChar LyX
24362 Five of these buttons are short cuts to layout styles:
24385 The last one is a short cut to the
24386 \begin_inset Quotes eld
24390 \begin_inset Quotes erd
24397 \begin_layout Standard
24399 has a range of buttons that are available for tool bar customization.
24400 In my toolbar I like to combine the six short cuts above with two more:
24405 \SpecialChar menuseparator
24410 \SpecialChar menuseparator
24417 Document\SpecialChar menuseparator
24418 View\SpecialChar menuseparator
24422 Here is how it looks like:
24425 \begin_layout LyX-Code
24429 \begin_layout LyX-Code
24433 \begin_layout LyX-Code
24434 Icon "layout Standard"
24437 \begin_layout LyX-Code
24438 Icon "layout Section"
24441 \begin_layout LyX-Code
24442 Icon "layout \SpecialChar LaTeX
24446 \begin_layout LyX-Code
24447 Icon "layout \SpecialChar LyX
24451 \begin_layout LyX-Code
24452 Icon "layout Chunk"
24455 \begin_layout LyX-Code
24459 \begin_layout LyX-Code
24463 \begin_layout LyX-Code
24464 Icon "buffer-typeset"
24467 \begin_layout LyX-Code
24468 Icon "build-program"
24471 \begin_layout LyX-Code
24475 \begin_layout LyX-Code
24479 \begin_layout LyX-Code
24483 \begin_layout LyX-Code
24487 \begin_layout LyX-Code
24491 \begin_layout Subsubsection
24492 Colors customization
24495 \begin_layout Standard
24496 There are a number of colors in \SpecialChar LyX
24497 that can be customized in
24502 One of the things that bothers people is the \SpecialChar LaTeX
24504 The default color is red, since the chunks uses \SpecialChar LaTeX
24505 font, and there is a lot
24506 of chunks in literate documents, you may get tired of seeing everything
24508 You can change it by going to the tabs
24517 \begin_layout Standard
24518 The next thing is the visible presence of the newline character in the screen.
24519 You can choose the color of this particular character and make it blend
24521 I recommend you choosing a color that is close to the background but not
24522 equal, that way you still can see it is there, but it is not bothering
24526 \begin_layout Subsection
24531 \begin_layout Standard
24540 is documented in the
24544 example file and in the Sweave manual (menu
24546 Help\SpecialChar menuseparator
24552 \begin_layout Chapter
24556 \begin_layout Standard
24557 You can do everything with \SpecialChar LyX
24558 that you can do with \SpecialChar LaTeX
24560 However, \SpecialChar LyX
24561 cannot support every \SpecialChar LaTeX
24563 But you can always use \SpecialChar TeX
24565 This chapter shows you some more special things you might want to use.
24566 For other special things you can do with figures, tables, floats, boxes
24567 and notes, have a look at the
24570 \begin_inset space ~
24578 \begin_layout Section
24579 Multiple Text Columns
24582 \begin_layout Standard
24583 This feature is independent of the option
24585 Two-column document
24587 in the document settings under
24592 If you want to have 2
24593 \begin_inset space ~
24596 columns for the whole document, it is recommended to use the
24598 Two-column document
24601 For all other cases use this feature.
24604 \begin_layout Standard
24605 To use multiple text columns in your document, you have to load the module
24612 Document\SpecialChar menuseparator
24613 Settings\SpecialChar menuseparator
24616 ) and must have the \SpecialChar LaTeX
24624 \begin_layout Standard
24625 Footnotes within multiple columns will be placed at the bottom of the page
24626 and not under each column.
24627 Within the different columns you can use everything, with the limitation
24628 that for floats you need to use the float option
24635 \begin_layout Subsection
24639 \begin_layout Standard
24640 If you want to have 2
24641 \begin_inset space ~
24644 columns in your text, insert a multicolumn inset via the menu
24646 Insert\SpecialChar menuseparator
24648 \begin_inset space ~
24651 Insets\SpecialChar menuseparator
24653 \begin_inset space ~
24658 where the columns should start.
24659 Write all text that should be printed in 2
24660 \begin_inset space ~
24663 columns into this inset.
24666 \begin_layout Standard
24667 Here is an example:
24670 \begin_layout Standard
24672 \begin_inset Flex Multiple Columns
24675 \begin_layout Plain Layout
24680 The Adventure of the Empty House
24683 \begin_inset Newline newline
24686 by Sir Arthur Conan Doyle
24689 \begin_layout Plain Layout
24692 It was in the spring of the year 1894 that all London was interested, and
24693 the fashionable world dismayed, by the murder of the Honourable Ronald
24694 Adair under most unusual and inexplicable circumstances.
24695 The public has already learned those particulars of the crime which came
24696 out in the police investigation, but a good deal was suppressed upon that
24697 occasion, since the case for the prosecution was so overwhelmingly strong
24698 that it was not necessary to bring forward all the facts.
24699 Only now, at the end of nearly ten years, am I allowed to supply those
24700 missing links which make up the whole of that remarkable chain.
24701 The crime was of interest in itself, but that interest was as nothing to
24702 me compared to the inconceivable sequel, which afforded me the greatest
24703 shock and surprise of any event in my adventurous life.
24704 Even now, after this long interval, I find myself thrilling as I think
24705 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24706 ty which utterly submerged my mind.
24707 Let me say to that public, which has shown some interest in those glimpses
24708 which I have occasionally given them of the thoughts and actions of a very
24709 remarkable man, that they are not to blame me if I have not shared my knowledge
24710 with them, for I should have considered it my first duty to do so, had
24711 I not been barred by a positive prohibition from his own lips, which was
24712 only withdrawn upon the third of last month.
24720 \begin_layout Standard
24721 To get 3 or more columns, set the cursor into the multicolumn inset and
24724 Insert\SpecialChar menuseparator
24726 \begin_inset space ~
24730 \begin_inset space ~
24736 The number of the desired columns is written into that inset (for 3
24737 \begin_inset space ~
24741 \begin_inset Quotes eld
24745 \begin_inset Quotes erd
24749 \begin_inset Newline newline
24752 Here is an example with 3
24753 \begin_inset space ~
24759 \begin_layout Standard
24760 \begin_inset Flex Multiple Columns
24763 \begin_layout Plain Layout
24766 \begin_inset Argument 1
24769 \begin_layout Plain Layout
24775 It can be imagined that my close intimacy with Sherlock Holmes had interested
24776 me deeply in crime, and that after his disappearance I never failed to
24777 read with care the various problems which came before the public.
24778 And I even attempted, more than once, for my own private satisfaction,
24779 to employ his methods in their solution, though with indifferent success.
24780 There was none, however, which appealed to me like this tragedy of Ronald
24782 As I read the evidence at the inquest, which led up to a verdict of willful
24783 murder against some person or persons unknown, I realized more clearly
24784 than I had ever done the loss which the community had sustained by the
24785 death of Sherlock Holmes.
24786 There were points about this strange business which would, I was sure,
24787 have specially appealed to him, and the efforts of the police would have
24788 been supplemented, or more probably anticipated, by the trained observation
24789 and the alert mind of the first criminal agent in Europe.
24790 All day, as I drove upon my round, I turned over the case in my mind and
24791 found no explanation which appeared to me to be adequate.
24792 At the risk of telling a twice-told tale, I will recapitulate the facts
24793 as they were known to the public at the conclusion of the inquest.
24801 \begin_layout Standard
24802 You can have up to 10
24803 \begin_inset space ~
24806 columns if you want to, but that might not be very pleasant for the readers
24810 \begin_layout Standard
24811 \begin_inset Newpage newpage
24817 \begin_layout Subsection
24818 Columns inside Columns
24821 \begin_layout Standard
24822 You can also have columns inside columns:
24825 \begin_layout Standard
24826 \begin_inset Flex Multiple Columns
24829 \begin_layout Plain Layout
24832 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24833 at that time governor of one of the Australian colonies.
24834 Adair's mother had returned from Australia to undergo the operation for
24835 cataract, and she, her son Ronald, and her daughter Hilda were living together
24839 \begin_layout Plain Layout
24840 \begin_inset Flex Multiple Columns
24843 \begin_layout Plain Layout
24846 The youth moved in the best society–had, so far as was known, no enemies
24847 and no particular vices.
24848 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24849 had been broken off by mutual consent some months before, and there was
24850 no sign that it had left any very profound feeling behind it.
24851 For the rest {sic} the man's life moved in a narrow and conventional circle,
24852 for his habits were quiet and his nature unemotional.
24853 Yet it was upon this easy-going young aristocrat that death came, in most
24854 strange and unexpected form, between the hours of ten and eleven-twenty
24855 on the night of March 30, 1894.
24863 \begin_layout Plain Layout
24866 Ronald Adair was fond of cards–playing continually, but never for such stakes
24868 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24869 It was shown that, after dinner on the day of his death, he had played
24870 a rubber of whist at the latter club.
24871 He had also played there in the afternoon.
24876 The evidence of those who had played with him– Mr.
24877 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24878 and that there was a fairly equal fall of the cards.
24879 Adair might have lost five pounds, but not more.
24880 His fortune was a considerable one, and such a loss could not in any way
24882 He had played nearly every day at one club or other, but he was a cautious
24883 player, and usually rose a winner.
24884 It came out in evidence that, in partnership with Colonel Moran, he had
24885 actually won as much as four hundred and twenty pounds in a sitting, some
24886 weeks before, from Godfrey Milner and Lord Balmoral.
24887 So much for his recent history as it came out at the inquest.
24895 \begin_layout Subsection
24899 \begin_layout Standard
24900 The examples in this section show some more special features of multiple
24904 \begin_layout Standard
24905 For more features of multiple columns, have a look at the documentation
24906 of the \SpecialChar LaTeX
24912 \begin_inset CommandInset citation
24922 \begin_layout Subsubsection
24926 \begin_layout Standard
24927 To add a preface text for multiple columns, set the cursor into the multicolumn
24928 inset and use the menu
24930 Insert\SpecialChar menuseparator
24934 Write your preface text into that inset.
24935 \begin_inset Newline newline
24938 This is an example with some preface text:
24941 \begin_layout Standard
24942 \begin_inset VSpace bigskip
24948 \begin_layout Standard
24949 \begin_inset Flex Multiple Columns
24952 \begin_layout Plain Layout
24953 \begin_inset Argument 2
24956 \begin_layout Plain Layout
24957 And the story continues and continues and continues and continues\SpecialChar ldots
24965 On the evening of the crime, he returned from the club exactly at ten.
24966 His mother and sister were out spending the evening with a relation.
24967 The servant deposed that she heard him enter the front room on the second
24968 floor, generally used as his sitting-room.
24969 She had lit a fire there, and as it smoked she had opened the window.
24970 No sound was heard from the room until eleven-twenty, the hour of the return
24971 of Lady Maynooth and her daughter.
24972 Desiring to say good-night, she attempted to enter her son's room.
24973 The door was locked on the inside, and no answer could be got to their
24974 cries and knocking.
24975 Help was obtained, and the door forced.
24976 The unfortunate young man was found lying near the table.
24977 His head had been horribly mutilated by an expanding revolver bullet, but
24978 no weapon of any sort was to be found in the room.
24986 \begin_layout Standard
24987 You can also use a section heading as the preface if you use a section command
24988 as \SpecialChar TeX
24990 For example the command
24993 \begin_layout Standard
24998 subsection{subsection title}
25001 \begin_layout Standard
25002 creates a subsection.
25003 In this example the preface is a subsubsection:
25006 \begin_layout Standard
25007 \begin_inset Flex Multiple Columns
25010 \begin_layout Plain Layout
25011 \begin_inset Argument 2
25014 \begin_layout Plain Layout
25018 \begin_layout Plain Layout
25027 This is a subsubsection heading as a preface
25031 \begin_layout Plain Layout
25045 A minute examination of the circumstances served only to make the case more
25047 In the first place, no reason could be given why the young man should have
25048 fastened the door upon the inside.
25049 There was the possibility that the murderer had done this, and had afterwards
25050 escaped by the window.
25051 The drop was at least twenty feet, however, and a bed of crocuses in full
25053 Neither the flowers nor the earth showed any sign of having been disturbed,
25054 nor were there any marks upon the narrow strip of grass which separated
25055 the house from the road.
25056 Apparently, therefore, it was the young man himself who had fastened the
25058 But how did he come by his death? No one could have climbed up to the window
25059 without leaving traces.
25060 Suppose a man had fired through the window, he would indeed be a remarkable
25061 shot who could with a revolver inflict so deadly a wound.
25062 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
25063 a hundred yards of the house.
25064 No one had heard a shot.
25072 \begin_layout Standard
25073 If there is less vertical space than 6
25074 \begin_inset space ~
25077 text lines is left on the page at the beginning of the multiple columns,
25078 a page break will be inserted before the multiple columns.
25079 Depending on the number of lines of the preface text, you might want to
25081 This is done by setting the cursor into the mulitcolumn inset behind the
25082 preface (if there is any) and using the menu
25084 Insert\SpecialChar menuseparator
25086 \begin_inset space ~
25090 \begin_inset space ~
25094 \begin_inset space ~
25100 Insert into that inset the amount of space like e.
25101 \begin_inset space \thinspace{}
25105 \begin_inset space \space{}
25109 \begin_inset Quotes eld
25113 \begin_inset Quotes erd
25117 \begin_inset Newline newline
25120 In this example the space is set to 7
25121 \begin_inset space ~
25124 text lines by using
25125 \begin_inset Quotes eld
25131 \begin_inset Quotes erd
25140 needs to be inserted as \SpecialChar TeX
25144 \begin_layout Standard
25145 \begin_inset Flex Multiple Columns
25148 \begin_layout Plain Layout
25149 \begin_inset Argument 3
25152 \begin_layout Plain Layout
25157 \begin_layout Plain Layout
25173 On the evening of the crime, he returned from the club exactly at ten.
25174 His mother and sister were out spending the evening with a relation.
25175 The servant deposed that she heard him enter the front room on the second
25176 floor, generally used as his sitting-room.
25177 She had lit a fire there, and as it smoked she had opened the window.
25178 No sound was heard from the room until eleven-twenty, the hour of the return
25179 of Lady Maynooth and her daughter.
25180 Desiring to say good-night, she attempted to enter her son's room.
25181 The door was locked on the inside, and no answer could be got to their
25182 cries and knocking.
25183 Help was obtained, and the door forced.
25184 The unfortunate young man was found lying near the table.
25185 His head had been horribly mutilated by an expanding revolver bullet, but
25186 no weapon of any sort was to be found in the room.
25194 \begin_layout Subsubsection
25198 \begin_layout Standard
25199 The amount of space before and after multiple columns can be changed by
25200 changing the length
25207 For example the command
25210 \begin_layout Standard
25220 \begin_layout Standard
25221 in \SpecialChar TeX
25222 Code changes its value to 3
25223 \begin_inset space \thinspace{}
25227 The change must be made before the multiple columns' start.
25228 The predefined value is 13
25229 \begin_inset space \thinspace{}
25235 \begin_layout Standard
25243 \begin_inset space \thinspace{}
25249 \begin_layout Standard
25253 \begin_layout Plain Layout
25259 multicolsep}{2.5cm}
25267 \begin_layout Standard
25268 \begin_inset Flex Multiple Columns
25271 \begin_layout Plain Layout
25274 All day I turned these facts over in my mind, endeavouring to hit upon some
25275 theory which could reconcile them all, and to find that line of least resistanc
25276 e which my poor friend had declared to be the starting-point of every investigat
25278 I confess that I made little progress.
25279 In the evening I strolled across the Park, and found myself about six o'clock
25280 at the Oxford Street end of Park Lane.
25281 A group of loafers upon the pavements, all staring up at a particular window,
25282 directed me to the house which I had come to see.
25283 A tall, thin man with coloured glasses, whom I strongly suspected of being
25284 a plain-clothes detective, was pointing out some theory of his own, while
25285 the others crowded round to listen to what he said.
25286 I got as near him as I could, but his observations seemed to me to be absurd,
25287 so I withdrew again in some disgust.
25288 As I did so I struck against an elderly, deformed man, who had been behind
25289 me, and I knocked down several books which he was carrying.
25297 \begin_layout Standard
25298 \begin_inset Note Greyedout
25301 \begin_layout Plain Layout
25306 The values you set with
25312 will be used for all following multiple columns until you change them again.
25320 \begin_layout Standard
25324 \begin_layout Plain Layout
25336 \begin_inset Note Note
25339 \begin_layout Plain Layout
25340 go back to the default
25348 \begin_layout Standard
25349 \begin_inset Newpage newpage
25355 \begin_layout Subsubsection
25359 \begin_layout Standard
25360 A column break can be forced by inserting the command
25366 as \SpecialChar TeX
25367 Code to that position in the text where the column should be broken.
25368 Note that this leads in most cases to whitespace in the text.
25369 \begin_inset Newline newline
25372 Here is an example:
25375 \begin_layout Standard
25376 \begin_inset Flex Multiple Columns
25379 \begin_layout Plain Layout
25382 \begin_inset Quotes eld
25385 You're surprised to see me, sir,
25386 \begin_inset Quotes erd
25389 said he, in a strange, croaking voice.
25392 \begin_layout Plain Layout
25395 I acknowledged that I was.
25398 \begin_layout Plain Layout
25401 \begin_inset Quotes eld
25404 Well, I've a conscience, sir, and when I chanced to see you go into this
25405 house, as I came hobbling after you, I thought to myself, I'll just step
25406 in and see that kind gentleman, and tell him that if I was a bit gruff
25407 in my manner there was not any harm meant, and that I am much obliged to
25408 him for picking up my books.
25409 \begin_inset Quotes erd
25415 \begin_layout Plain Layout
25418 \begin_inset Quotes eld
25421 You make too much of a trifle,
25422 \begin_inset Quotes erd
25427 \begin_inset Quotes eld
25430 May I ask how you knew who I was?
25431 \begin_inset Quotes erd
25434 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25438 \begin_layout Plain Layout
25450 \begin_layout Plain Layout
25453 \begin_inset Quotes eld
25456 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25457 you'll find my little bookshop at the corner of Church Street, and very
25458 happy to see you, I am sure.
25459 Maybe you collect yourself, sir.
25463 \begin_inset space ~
25476 –a bargain, every one of them.
25477 With five volumes you could just fill that gap on that second shelf.
25478 It looks untidy, does it not, sir?
25479 \begin_inset Quotes erd
25490 \begin_layout Subsubsection
25494 \begin_layout Standard
25495 The width of the columns is automatically calculated, but you can modify
25496 the space between the columns.
25497 This is done by changing the length
25504 Its predefined value is 10
25505 \begin_inset space \thinspace{}
25509 Here is an example where
25516 \begin_inset space \thinspace{}
25522 \begin_layout Standard
25526 \begin_layout Plain Layout
25540 \begin_layout Standard
25541 \begin_inset Flex Multiple Columns
25544 \begin_layout Plain Layout
25547 My observations of No.
25548 \begin_inset space \space{}
25551 427 Park Lane did little to clear up the problem in which I was interested.
25552 The house was separated from the street by a low wall and railing, the
25553 whole not more than five feet high.
25554 It was perfectly easy, therefore, for anyone to get into the garden, but
25555 the window was entirely inaccessible, since there was no water pipe or
25556 anything which could help the most active man to climb it.
25557 More puzzled than ever, I retraced my steps to Kensington.
25558 I had not been in my study five minutes when the maid entered to say that
25559 a person desired to see me.
25560 To my astonishment it was none other than my strange old book collector,
25561 his sharp, wizened face peering out from a frame of white hair, and his
25562 precious volumes, a dozen of them at least, wedged under his right arm.
25570 \begin_layout Standard
25574 \begin_layout Plain Layout
25586 \begin_inset Note Note
25589 \begin_layout Plain Layout
25590 go back to the default
25598 \begin_layout Subsubsection
25602 \begin_layout Standard
25603 Between the columns a rule with a width of the length
25610 If this rule width is set to 0
25611 \begin_inset space \thinspace{}
25614 pt (this is the default), the rule is suppressed.
25615 In the following example the rule is 2
25616 \begin_inset space \thinspace{}
25622 \begin_layout Standard
25626 \begin_layout Plain Layout
25632 columnseprule}{2pt}
25640 \begin_layout Standard
25641 \begin_inset Flex Multiple Columns
25644 \begin_layout Plain Layout
25647 \begin_inset Quotes eld
25650 You're surprised to see me, sir,
25651 \begin_inset Quotes erd
25654 said he, in a strange, croaking voice.
25657 \begin_layout Plain Layout
25660 I acknowledged that I was.
25663 \begin_layout Plain Layout
25666 \begin_inset Quotes eld
25669 Well, I've a conscience, sir, and when I chanced to see you go into this
25670 house, as I came hobbling after you, I thought to myself, I'll just step
25671 in and see that kind gentleman, and tell him that if I was a bit gruff
25672 in my manner there was not any harm meant, and that I am much obliged to
25673 him for picking up my books.
25674 \begin_inset Quotes erd
25680 \begin_layout Plain Layout
25683 \begin_inset Quotes eld
25686 You make too much of a trifle,
25687 \begin_inset Quotes erd
25692 \begin_inset Quotes eld
25695 May I ask how you knew who I was?
25696 \begin_inset Quotes erd
25702 \begin_layout Plain Layout
25705 \begin_inset Quotes eld
25708 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25709 you'll find my little bookshop at the corner of Church Street, and very
25710 happy to see you, I am sure.
25711 Maybe you collect yourself, sir.
25715 \begin_inset space ~
25728 –a bargain, every one of them.
25729 With five volumes you could just fill that gap on that second shelf.
25730 It looks untidy, does it not, sir?
25731 \begin_inset Quotes erd
25742 \begin_layout Standard
25743 \begin_inset VSpace defskip
25749 \begin_layout Standard
25750 The rule can be colored by redefining the command
25757 This is done by inserting the command
25758 \begin_inset Newline newline
25767 columnseprulecolor}{
25772 \begin_inset Newline newline
25775 as \SpecialChar TeX
25776 Code before the multicolumn inset.
25781 in this command by a color of your choice.
25782 You can use all pre- and self-defined colors.
25790 \begin_inset space ~
25795 for more information about pre- and self-defined colors.
25796 To go back to the default color insert the command
25797 \begin_inset Newline newline
25806 columnseprulecolor}{
25811 \begin_inset Newline newline
25814 Here is the example with a cyan rule and 1
25815 \begin_inset space \thinspace{}
25818 cm column separation:
25821 \begin_layout Standard
25825 \begin_layout Plain Layout
25834 \begin_layout Plain Layout
25840 columnseprulecolor}{
25850 \begin_layout Standard
25851 \begin_inset Flex Multiple Columns
25854 \begin_layout Plain Layout
25857 \begin_inset Quotes eld
25860 You're surprised to see me, sir,
25861 \begin_inset Quotes erd
25864 said he, in a strange, croaking voice.
25867 \begin_layout Plain Layout
25870 I acknowledged that I was.
25873 \begin_layout Plain Layout
25876 \begin_inset Quotes eld
25879 Well, I've a conscience, sir, and when I chanced to see you go into this
25880 house, as I came hobbling after you, I thought to myself, I'll just step
25881 in and see that kind gentleman, and tell him that if I was a bit gruff
25882 in my manner there was not any harm meant, and that I am much obliged to
25883 him for picking up my books.
25884 \begin_inset Quotes erd
25890 \begin_layout Plain Layout
25893 \begin_inset Quotes eld
25896 You make too much of a trifle,
25897 \begin_inset Quotes erd
25902 \begin_inset Quotes eld
25905 May I ask how you knew who I was?
25906 \begin_inset Quotes erd
25912 \begin_layout Plain Layout
25915 \begin_inset Quotes eld
25918 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25919 you'll find my little bookshop at the corner of Church Street, and very
25920 happy to see you, I am sure.
25921 Maybe you collect yourself, sir.
25925 \begin_inset space ~
25938 –a bargain, every one of them.
25939 With five volumes you could just fill that gap on that second shelf.
25940 It looks untidy, does it not, sir?
25941 \begin_inset Quotes erd
25952 \begin_layout Standard
25956 \begin_layout Plain Layout
25962 columnseprule}{0pt}
25965 \begin_layout Plain Layout
25971 columnseprulecolor}{
25979 \begin_inset Note Note
25982 \begin_layout Plain Layout
25983 go back to the default
25991 \begin_layout Section
25992 Non-standard Paragraph Shapes
25995 \begin_layout Standard
25998 as well as any other text processor uses by default rectangular paragraphs.
25999 For special cases like for example posters, invitation cards or poems you
26000 can modify the paragraph shape to one of your choice.
26001 This can be done by using the \SpecialChar LaTeX
26006 which is loaded by using in the document settings the module
26008 Custom paragraph shapes
26013 \begin_layout Subsection
26017 \begin_layout Standard
26022 provides the following shapes:
26025 \begin_layout Standard
26026 \begin_inset Tabular
26027 <lyxtabular version="3" rows="13" columns="3">
26028 <features booktabs="true" islongtable="true" longtabularalignment="center">
26029 <column alignment="center" valignment="middle" width="16col%">
26030 <column alignment="center" valignment="middle" width="40col%">
26031 <column alignment="center" valignment="middle" width="35col%">
26032 <row endhead="true">
26033 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26036 \begin_layout Plain Layout
26042 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26045 \begin_layout Plain Layout
26051 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26054 \begin_layout Plain Layout
26062 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26065 \begin_layout Plain Layout
26071 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26074 \begin_layout Plain Layout
26075 Circle with circular hole (in the size of a CD/DVD)
26080 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26083 \begin_layout Plain Layout
26084 Cannot be scaled, take care there is not too much text
26091 <cell alignment="center" valignment="top" topline="true" usebox="none">
26094 \begin_layout Plain Layout
26100 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26103 \begin_layout Plain Layout
26109 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26112 \begin_layout Plain Layout
26113 Fragile, calculation might fail
26120 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26123 \begin_layout Plain Layout
26129 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26132 \begin_layout Plain Layout
26133 Rhomboid (symbolizing a
26134 \begin_inset Quotes eld
26138 \begin_inset Quotes erd
26146 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26149 \begin_layout Plain Layout
26157 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26160 \begin_layout Plain Layout
26166 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26169 \begin_layout Plain Layout
26175 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26178 \begin_layout Plain Layout
26186 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26189 \begin_layout Plain Layout
26195 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26198 \begin_layout Plain Layout
26204 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26207 \begin_layout Plain Layout
26215 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26218 \begin_layout Plain Layout
26224 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26227 \begin_layout Plain Layout
26228 Nut for bolt (hexagon with circular hole)
26233 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26236 \begin_layout Plain Layout
26244 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26247 \begin_layout Plain Layout
26253 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26256 \begin_layout Plain Layout
26262 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26265 \begin_layout Plain Layout
26273 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26276 \begin_layout Plain Layout
26282 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26285 \begin_layout Plain Layout
26291 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26294 \begin_layout Plain Layout
26302 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26305 \begin_layout Plain Layout
26311 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26314 \begin_layout Plain Layout
26320 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26323 \begin_layout Plain Layout
26331 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26334 \begin_layout Plain Layout
26340 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26343 \begin_layout Plain Layout
26344 Normal/reversed rain drop
26349 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26352 \begin_layout Plain Layout
26353 Fragile, calculation might fail
26360 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26363 \begin_layout Plain Layout
26370 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26373 \begin_layout Plain Layout
26374 The \SpecialChar TeX
26380 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26383 \begin_layout Plain Layout
26391 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26394 \begin_layout Plain Layout
26396 \begin_inset Newline newline
26404 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26407 \begin_layout Plain Layout
26408 Triangles in different orientations
26413 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26416 \begin_layout Plain Layout
26430 \begin_layout Standard
26431 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26433 for environments in the toolbar.
26436 \begin_layout Standard
26437 \begin_inset Newpage newpage
26443 \begin_layout Standard
26444 Here is an example paragraph in the shape of a nut:
26447 \begin_layout Standard
26448 \begin_inset VSpace bigskip
26457 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26458 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26460 At vero eos et accusam et justo duo dolores et ea rebum.
26461 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26463 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26464 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26468 \begin_layout Standard
26469 \begin_inset VSpace bigskip
26475 \begin_layout Standard
26476 \begin_inset Note Greyedout
26479 \begin_layout Plain Layout
26484 : shapepar paragraphs cannot run over a page break.
26492 \begin_layout Standard
26493 \begin_inset VSpace bigskip
26499 \begin_layout Standard
26504 takes care that the shape will always be preserved, no matter how much
26505 text is in the paragraph.
26506 Therefore the paragraph size changes with the amount of contained text.
26507 This can lead to paragraph sizes exceeding the page margins.
26508 To demonstrate the size scaling, here is the same example paragraph but
26509 with twice as much text:
26512 \begin_layout Standard
26513 \begin_inset Newpage newpage
26522 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26523 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26525 At vero eos et accusam et justo duo dolores et ea rebum.
26526 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26528 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26529 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26531 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26532 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26534 At vero eos et accusam et justo duo dolores et ea rebum.
26535 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26537 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26538 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26542 \begin_layout Standard
26543 \begin_inset VSpace bigskip
26549 \begin_layout Standard
26550 An exception is the shape
26555 It cannot be scaled because it must fit the size of a CD/DVD.
26556 Therefore the amount of text that fits into the shape is limited.
26557 \begin_inset Newline newline
26568 shape are fragile, meaning that the calculation of their size can fail,
26569 depending on the amount of text.
26570 You will then get the \SpecialChar LaTeX
26572 \begin_inset Quotes eld
26575 Arithmetic overflow
26576 \begin_inset Quotes erd
26580 In this case one can try to remove or add some text; if nothing works one
26581 has to use another shape.
26584 \begin_layout Standard
26585 \begin_inset VSpace bigskip
26591 \begin_layout Standard
26592 For shapes with tips you will maybe see that \SpecialChar LaTeX
26593 's hyphenation routine fails
26594 for text in the tips.
26595 Therefore it is often necessary to add hyphenation points
26600 arg "specialchar-insert hyphenation"
26605 ) to the corresponding text parts.
26608 \begin_layout Standard
26609 \begin_inset VSpace bigskip
26615 \begin_layout Standard
26616 Shapepar paragraphs are either always centered or placed on the page so
26617 that their left border touches the left page margin.
26618 You can therefore not use the paragraph dialog to align such paragraphs.
26619 A solution is to put the paragraph into a minipage or parbox and align
26621 The problem is hereby to find the right width for the box.
26622 Because if it is too wide and you center the box, the paragraph is not
26623 centered too because it sticks at the left side of the box.
26624 So you might have to play a bit with the width until it fits.
26625 Here are two heart-shaped paragraphs, the first one is not aligned, the
26626 second one is right-aligned:
26629 \begin_layout Standard
26630 \begin_inset Newpage newpage
26636 \begin_layout Heart
26640 Lo\SpecialChar softhyphen
26641 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26642 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26644 At vero eos et accusam et justo duo dolores et ea rebum.
26645 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26649 \begin_layout Standard
26650 \begin_inset VSpace bigskip
26656 \begin_layout Standard
26659 \begin_inset Box Frameless
26669 height_special "totalheight"
26674 backgroundcolor "none"
26677 \begin_layout Heart
26681 Lo\SpecialChar softhyphen
26682 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26683 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26685 At vero eos et accusam et justo duo dolores et ea rebum.
26686 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26695 \begin_layout Subsection
26699 \begin_layout Standard
26700 You can define any shape you want.
26701 Doing this manually is a lot of work because every coordinate must be specified.
26702 But there is a way to let the computer calculate the coordinates:
26705 \begin_layout Enumerate
26706 Install the program
26707 \begin_inset CommandInset href
26710 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26718 \begin_layout Enumerate
26725 TeX/LaTeX\SpecialChar menuseparator
26726 Settings\SpecialChar menuseparator
26729 and select the font size you are using in your document.
26730 For example this document uses the size 12
26731 \begin_inset space \thinspace{}
26737 \begin_layout Enumerate
26741 \begin_layout Enumerate
26744 TeX/LaTeX\SpecialChar menuseparator
26747 to export the shape to coordinates.
26748 In the appearing dialog use either the outline of your shape for the coordinate
26749 s or the path itself.
26753 \begin_layout Plain Layout
26754 For more information see
26755 \begin_inset CommandInset href
26757 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26770 \begin_layout Standard
26771 The coordinates are written into a \SpecialChar TeX
26773 To use it for your \SpecialChar LyX
26777 \begin_layout Enumerate
26778 Place the cursor before the first character of your paragraph (or into a
26782 \begin_layout Enumerate
26783 Open in \SpecialChar LyX
26786 Insert\SpecialChar menuseparator
26787 File\SpecialChar menuseparator
26789 \begin_inset space ~
26794 , select the file and use
26803 \begin_layout Standard
26804 \begin_inset VSpace defskip
26810 \begin_layout Standard
26811 \begin_inset Note Greyedout
26814 \begin_layout Plain Layout
26819 : The changed shape only applies to the current paragraph; everything is
26820 reset to normal for the next paragraph.
26821 Therefore the shape definition file must be input into every paragraph
26822 with the desired shape.
26830 \begin_layout Standard
26831 \begin_inset VSpace bigskip
26837 \begin_layout Standard
26838 Here is an example:
26841 \begin_layout Standard
26842 \begin_inset VSpace bigskip
26848 \begin_layout Standard
26849 \begin_inset CommandInset include
26851 filename "SpecialParagraphShape.tex"
26857 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26858 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26860 At vero eos et accusam et justo duo dolores et ea rebum.
26861 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26863 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26864 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26868 \begin_layout Standard
26869 \begin_inset VSpace bigskip
26875 \begin_layout Standard
26880 to draw complexer shapes in
26884 you can draw the shape in a program of your choice and import the resulting
26890 Then you only need to draw a line or spline along the outline of the image.
26893 \begin_layout Standard
26894 \begin_inset VSpace bigskip
26900 \begin_layout Standard
26903 Custom paragraph shapes
26905 also provides the two commands
26913 which can be used to define custom shapes coordinate by coordinate.
26917 \begin_layout Plain Layout
26918 These commands are internally used for all shapes described here.
26923 For information how these styles are used and about further customization
26924 possibilities, have a look at the documentation of the package
26929 \begin_inset CommandInset citation
26939 \begin_layout Bibliography
26940 \begin_inset CommandInset bibitem
26941 LatexCommand bibitem
26947 Documentation of the \SpecialChar LaTeX
26949 \begin_inset CommandInset href
26952 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26960 \begin_layout Bibliography
26961 \begin_inset CommandInset bibitem
26962 LatexCommand bibitem
26968 Documentation of the \SpecialChar LaTeX
26970 \begin_inset CommandInset href
26973 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"