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 \begin_inset Flex Code
2934 \begin_layout Plain Layout
2940 package is used to create multiple bibliographies.
2941 The former package is used if you select
2942 \begin_inset Quotes eld
2946 \begin_inset Quotes erd
2954 \begin_inset Flex Noun
2957 \begin_layout Plain Layout
2958 Sectioned Bibliography
2965 \begin_inset Flex Code
2968 \begin_layout Plain Layout
2978 \begin_layout Plain Layout
2979 An alternative approach, if you are willing to use some
2980 \begin_inset Flex Noun
2983 \begin_layout Plain Layout
2991 \begin_inset space ~
2995 \begin_inset CommandInset ref
2997 reference "sec:Inserting-TeX-Code"
3002 \begin_inset Flex Code
3005 \begin_layout Plain Layout
3017 \begin_inset Flex Code
3020 \begin_layout Plain Layout
3026 is used, \SpecialChar LyX
3027 encloses the specified units in
3028 \begin_inset Flex Code
3031 \begin_layout Plain Layout
3038 \begin_inset Flex Code
3041 \begin_layout Plain Layout
3050 \begin_inset Flex Code
3053 \begin_layout Plain Layout
3061 in order to create the units.
3062 Note that this approach has some limitations.
3063 First, every citation reference has to be inside some
3064 \begin_inset Flex Code
3067 \begin_layout Plain Layout
3074 So citations outside a defined unit (e.
3075 \begin_inset space \thinspace{}
3078 g., before the first section if you use
3079 \begin_inset Quotes eld
3083 \begin_inset Quotes erd
3087 \begin_inset Quotes eld
3091 \begin_inset Quotes erd
3095 You can also create your own units by entering
3096 \begin_inset Flex Code
3099 \begin_layout Plain Layout
3108 \begin_inset Flex Code
3111 \begin_layout Plain Layout
3120 code (for instance to work around the mentioned limitation).
3122 \begin_inset Flex Code
3125 \begin_layout Plain Layout
3132 A second limitation is that
3133 \begin_inset Flex Code
3136 \begin_layout Plain Layout
3142 always processes all references of a bibliography database, even if they
3144 This can result in odd labels (e.
3145 \begin_inset space \thinspace{}
3150 \begin_inset Quotes eld
3154 \begin_inset Quotes erd
3157 if two works of this author from 2014 are in the database, even if only
3161 \begin_layout Standard
3167 \begin_inset Flex Code
3170 \begin_layout Plain Layout
3176 option is used instead.
3177 If you need specific units, you can start them with the \SpecialChar TeX
3179 \begin_inset Flex Code
3182 \begin_layout Plain Layout
3191 \begin_inset Flex Code
3194 \begin_layout Plain Layout
3203 If you also want to control the end of the unit, use the environment
3204 \begin_inset Flex Code
3207 \begin_layout Plain Layout
3217 \begin_inset Flex Code
3220 \begin_layout Plain Layout
3230 \begin_inset Flex Code
3233 \begin_layout Plain Layout
3240 In addition to the individual bibliography of the current unit,
3244 also provides an easy way to output all bibliographies, subsequently, at
3246 \begin_inset space \thinspace{}
3249 g., at the end of the document).
3251 \begin_inset Quotes eld
3255 \begin_inset Quotes erd
3258 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3264 manual for more information on this topic.
3267 \begin_layout Section
3271 \begin_layout Subsection
3275 \begin_layout Standard
3276 When you are working on a large file with many sections, it is often convenient
3277 to break up the document into several files, or perhaps you have something
3278 where a table may change from time to time, but the preceding text does
3280 In these cases, you should seriously consider using multipart documents.
3281 For example, scientific papers often have five major sections: the introduction
3282 , observations, results, discussion, and conclusion.
3283 Each of these could be its own separate \SpecialChar LyX
3285 \begin_inset Quotes eld
3289 \begin_inset Quotes erd
3292 file which contains the title, authors, abstract, references, etc., plus
3293 the five included files.
3294 It is important to note that each of these files is a full \SpecialChar LyX
3296 can be formatted and printed on its own, as well as included in a master
3298 Each of these files must have the same document class, however—don't attempt
3299 to mix book classes with article classes.
3300 You may also include \SpecialChar LaTeX
3301 files; however, these files must not have their own
3303 \begin_inset space \thinspace{}
3307 \begin_inset space \space{}
3310 everything up to and including the
3311 \begin_inset Flex Code
3314 \begin_layout Plain Layout
3323 \begin_inset Flex Code
3326 \begin_layout Plain Layout
3334 line must be deleted) or else errors will be generated when you try to
3338 \begin_layout Standard
3340 allows you to include files quite easily with
3341 \begin_inset Flex Noun
3344 \begin_layout Plain Layout
3345 Insert\SpecialChar menuseparator
3347 \begin_inset space ~
3356 When you click on this selection a small box is inserted into the file
3357 at the current cursor location.
3358 Clicking on the box raises a dialog which allows you to select the file
3359 to be included, and the method of its inclusion.
3363 \begin_layout Standard
3364 The file selection box should by now be obvious.
3365 The three inclusion methods are
3366 \begin_inset Quotes eld
3370 \begin_inset Quotes erd
3374 \begin_inset Quotes eld
3378 \begin_inset Quotes erd
3382 \begin_inset Quotes eld
3386 \begin_inset Quotes erd
3390 The difference between
3391 \begin_inset Quotes eld
3395 \begin_inset Quotes erd
3399 \begin_inset Quotes eld
3403 \begin_inset Quotes erd
3406 is really only meaningful to \SpecialChar LaTeX
3407 perts, but the practical difference is that
3409 \begin_inset Quotes eld
3413 \begin_inset Quotes erd
3416 are typeset beginning on a new page, while files that are
3417 \begin_inset Quotes eld
3421 \begin_inset Quotes erd
3424 are typeset starting on the current page.
3427 \begin_layout Standard
3428 Generally, the master file is converted into a full \SpecialChar LaTeX
3429 file before typesetting,
3430 while the included files are converted to \SpecialChar LaTeX
3431 files that do not have all the
3432 preamble information.
3435 \begin_layout Standard
3437 \begin_inset Quotes eld
3441 \begin_inset Quotes erd
3444 included file allows you to include a file typeset exactly as it appears
3446 \begin_inset space \thinspace{}
3450 \begin_inset space \space{}
3454 \begin_inset Flex Code
3457 \begin_layout Plain Layout
3463 mode, with the characters set in a fixed-width typewriter font.
3464 Normally, spaces in this file are invisible, though two consecutive spaces
3465 are conserved, unlike \SpecialChar LyX
3466 's normal treatment of spaces.
3467 However, setting the
3468 \begin_inset Flex Noun
3471 \begin_layout Plain Layout
3473 \begin_inset space ~
3477 \begin_inset space ~
3481 \begin_inset space ~
3489 checkbox typesets a mark to unambiguously define the presence of a space.
3493 \begin_layout Subsection
3494 Cross-References Between Files
3497 \begin_layout Standard
3498 \begin_inset Box Shadowbox
3508 height_special "totalheight"
3513 backgroundcolor "none"
3516 \begin_layout Plain Layout
3517 This section is somewhat out of date.
3518 Need to describe default master documents and how children are opened when
3528 \begin_layout Standard
3529 It is possible to set up cross-references between the different files.
3530 First, open all the files in question: let's call them A and B in a two
3531 file example, where B is included in A.
3532 Let's say you insert a label in A, then want to reference it in B.
3533 Open the cross-reference dialog whilst in document B, and you can select
3535 \begin_inset Quotes eld
3539 \begin_inset Quotes erd
3545 \begin_layout Subsection
3546 Bibliography Lists in all Subdocuments
3549 \begin_layout Standard
3550 \begin_inset Box Frameless
3560 height_special "totalheight"
3565 backgroundcolor "none"
3568 \begin_layout Plain Layout
3569 This section also needs updating.
3570 There is now material about this on the wiki, and it could be copied here.
3578 \begin_layout Standard
3579 Copy the bibliography list with all entries to all subdocuments and transform
3581 This way \SpecialChar LyX
3583 \begin_inset Flex Code
3586 \begin_layout Plain Layout
3592 -files and you can easily insert references without making the bibliography
3596 \begin_layout Standard
3597 As the bibliography list is in a comment, \SpecialChar LaTeX
3598 won't use it and the references
3599 will look like this: [?], instead of like this: [1].
3600 One solution is to use the \SpecialChar LaTeX
3602 \begin_inset Flex Code
3605 \begin_layout Plain Layout
3611 that will only include comments by processing the files separately.
3612 To do this, add in the \SpecialChar LaTeX
3613 preamble of every subdocument the following:
3616 \begin_layout LyX-Code
3622 \begin_layout LyX-Code
3625 includecomment{comment}
3628 \begin_layout Standard
3630 \begin_inset Flex URL
3633 \begin_layout Plain Layout
3635 http://wiki.lyx.org/FAQ/Unsorted#toc31
3643 \begin_layout Section
3648 \begin_layout Standard
3649 Users sometimes need to be able to
3650 \begin_inset Quotes eld
3654 \begin_inset Quotes erd
3658 file together with all the images (and other files) on which it depends,
3659 either for sending to a publisher or for sharing with a co-author.
3661 2.0 includes a Python script (
3662 \begin_inset Flex Code
3665 \begin_layout Plain Layout
3671 ) that automates this process.
3672 To use it, you must have either the
3673 \begin_inset Flex Code
3676 \begin_layout Plain Layout
3683 \begin_inset Flex Code
3686 \begin_layout Plain Layout
3692 python modules installed on your system.
3693 By default, the script prefers the
3694 \begin_inset Flex Code
3697 \begin_layout Plain Layout
3704 \begin_inset Flex Code
3707 \begin_layout Plain Layout
3713 format on Unix-like systems and the
3714 \begin_inset Flex Code
3717 \begin_layout Plain Layout
3726 \begin_layout Standard
3728 's configuration process will set the script up to export a `\SpecialChar LyX
3730 and this format will then be available under
3731 \begin_inset Flex Code
3734 \begin_layout Plain Layout
3735 File\SpecialChar menuseparator
3744 \begin_layout Standard
3745 Independently of the platform, the generation of a particular archive format
3746 can be forced by adding either the
3747 \begin_inset Flex Code
3750 \begin_layout Plain Layout
3757 \begin_inset Flex Code
3760 \begin_layout Plain Layout
3767 \begin_inset Flex Code
3770 \begin_layout Plain Layout
3777 \begin_inset Flex Code
3780 \begin_layout Plain Layout
3786 format) switch to the
3787 \begin_inset Flex Code
3790 \begin_layout Plain Layout
3792 \SpecialChar menuseparator
3800 \begin_inset Flex Code
3803 \begin_layout Plain Layout
3804 Tools\SpecialChar menuseparator
3805 Preferences\SpecialChar menuseparator
3806 File Handling\SpecialChar menuseparator
3813 (Make sure you add the switch after the script name, not before it.)
3816 \begin_layout Section
3817 Fancy Headers and Footers
3820 \begin_layout Standard
3821 The default page layout is rather plain; for an
3822 \begin_inset Flex Code
3825 \begin_layout Plain Layout
3831 document class, all you get is a centered page number at the bottom of
3833 This document uses KOMA-script's book class, so it appears to be a bit
3835 But to really put on a show, you need to set the document page style to
3837 \begin_inset Quotes eld
3841 \begin_inset Quotes erd
3844 , as mentioned in the
3849 This section describes the \SpecialChar LaTeX
3850 code you need to insert in your \SpecialChar LaTeX
3852 order to get the desired effects.
3855 \begin_layout Standard
3856 For more information on fancy headers, see the
3857 \begin_inset Flex Code
3860 \begin_layout Plain Layout
3866 package documentation.
3868 \begin_inset Flex URL
3871 \begin_layout Plain Layout
3873 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3881 \begin_layout Standard
3882 The page header is divided into three fields, not surprisingly labeled
3883 \begin_inset Quotes eld
3887 \begin_inset Quotes erd
3891 \begin_inset Quotes eld
3895 \begin_inset Quotes erd
3899 \begin_inset Quotes eld
3903 \begin_inset Quotes erd
3907 The footer is also divided into these three fields.
3908 The \SpecialChar LaTeX
3909 commands to set these fields in the simplest manner are
3910 \begin_inset Flex Code
3913 \begin_layout Plain Layout
3922 \begin_inset Flex Code
3925 \begin_layout Plain Layout
3934 \begin_inset Flex Code
3937 \begin_layout Plain Layout
3946 \begin_inset Flex Code
3949 \begin_layout Plain Layout
3958 Suppose you wish to put your name in the upper left hand corner of each
3960 Simply insert the following command in the preamble:
3963 \begin_layout Standard
3972 \begin_layout Standard
3973 You will now see your name in the upper left.
3974 If a field has a default entry that you would like to get rid of (often
3975 the page number appears in the central footer) simply include a command
3976 with a blank argument, e.
3977 \begin_inset space \thinspace{}
3983 \begin_layout Standard
3991 \begin_layout Standard
3992 Let's get really fancy: lets put the section number with the word
3993 \begin_inset Quotes eld
3997 \begin_inset Quotes erd
4001 \begin_inset space \thinspace{}
4005 \begin_inset space \space{}
4008 Section 3) in the upper left, the page number (e.
4009 \begin_inset space \thinspace{}
4013 \begin_inset space \space{}
4016 Page 4) in the upper right, your name in the lower left, and the date in
4018 The following commands should now appear in the preamble:
4021 \begin_layout Standard
4031 \begin_layout Standard
4039 \begin_layout Standard
4049 \begin_layout Standard
4058 \begin_layout Standard
4066 \begin_layout Standard
4076 \begin_layout Standard
4078 \begin_inset Flex Code
4081 \begin_layout Plain Layout
4090 \begin_inset Flex Code
4093 \begin_layout Plain Layout
4101 access \SpecialChar LaTeX
4102 's section and page counters, and so print out the current section
4105 \begin_inset Flex Code
4108 \begin_layout Plain Layout
4116 simply prints out today's date.
4119 \begin_layout Standard
4120 The thicknesses of the horizontal rules drawn beneath the header and above
4121 the footer can also be modified.
4122 If you don't want one of the rules, set its thickness to 0.
4123 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4129 \begin_inset Flex Code
4132 \begin_layout Plain Layout
4137 headrulewidth}{0.4pt}
4143 \begin_inset Flex Code
4146 \begin_layout Plain Layout
4151 footrulewidth}{0.4pt}
4156 to set the thicknesses.
4159 \begin_layout Standard
4160 You can switch the header/footer settings on and off for individual pages
4162 \begin_inset Flex Code
4165 \begin_layout Plain Layout
4168 thispagestyle{empty}
4174 \begin_inset Flex Code
4177 \begin_layout Plain Layout
4180 thispagestyle{plain}
4186 \begin_inset Flex Code
4189 \begin_layout Plain Layout
4192 thispagestyle{fancy}
4198 Simply insert them in the text on the page you want changed and mark them
4201 In fact, title pages are marked as plain by default, while following pages
4202 are marked fancy when using the global fancy setting.
4205 \begin_layout Standard
4206 As a final example, it is possible to include an image in the header or
4208 Suppose you want to put a company logo in the upper lefthand corner.
4209 You might try something like
4212 \begin_layout Standard
4221 includegraphics{logo.eps}}}
4224 \begin_layout Standard
4226 (you may need to preface this with
4227 \begin_inset Flex Code
4230 \begin_layout Plain Layout
4234 usepackage{graphics}
4239 if you don't include graphics elsewhere in your document).
4242 \begin_layout Section
4243 Itemize Bullet Selection
4244 \begin_inset CommandInset label
4253 \begin_layout Standard
4259 \begin_layout Subsection
4263 \begin_layout Standard
4265 provides 216 bullet shapes that can be accessed from a simple dialog.
4266 Using this dialog you can easily specify what bullet shape to use at each
4267 level of an itemized list.
4268 These settings are document-wide so you won't be able to specify different
4269 sets of bullets for different paragraphs.
4273 \begin_layout Plain Layout
4274 Well, actually you can but you'll have to do it by hand.
4282 \begin_layout Subsection
4286 \begin_layout Standard
4287 Open the dialog by selecting the
4288 \begin_inset Flex Noun
4291 \begin_layout Plain Layout
4292 Document\SpecialChar menuseparator
4298 menu item and then select the
4299 \begin_inset Flex Noun
4302 \begin_layout Plain Layout
4311 \begin_layout Standard
4312 The dialog provides you with a table of bullet shapes.
4313 A column of buttons on the left of the table provides access to the six
4314 different panels of bullet shapes.
4315 The row of buttons across the top is used to select which bullet depth
4317 A text entry under the table shows the currently selected bullet shape's
4319 equivalent and this can be edited if desired.
4320 If you do modify the text you will also need to specify any needed packages
4321 in the \SpecialChar LaTeX
4325 \begin_layout Standard
4326 The six panels are divided up by the packages they require.
4327 The following table shows the mappings from button name to \SpecialChar LaTeX
4331 \begin_layout Standard
4333 \begin_inset Tabular
4334 <lyxtabular version="3" rows="7" columns="2">
4335 <features tabularvalignment="middle">
4336 <column alignment="center" valignment="top" width="0pt">
4337 <column alignment="center" valignment="top" width="0pt">
4339 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4342 \begin_layout Plain Layout
4357 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4360 \begin_layout Plain Layout
4377 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4380 \begin_layout Plain Layout
4395 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4398 \begin_layout Plain Layout
4407 base \SpecialChar LaTeX
4415 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4418 \begin_layout Plain Layout
4433 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4436 \begin_layout Plain Layout
4453 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4456 \begin_layout Plain Layout
4471 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4474 \begin_layout Plain Layout
4491 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4494 \begin_layout Plain Layout
4509 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4512 \begin_layout Plain Layout
4529 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4532 \begin_layout Plain Layout
4547 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4550 \begin_layout Plain Layout
4567 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4570 \begin_layout Plain Layout
4585 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4588 \begin_layout Plain Layout
4611 \begin_layout Standard
4613 doesn't stop you using bullets from packages you don't have.
4614 If you get errors from \SpecialChar LaTeX
4615 when you try to view or print the file, then it
4616 is likely you are missing a package.
4620 \begin_layout Plain Layout
4622 doesn't restrict your use since you may be editing locally and exporting
4631 \begin_layout Subsection
4635 \begin_layout Standard
4636 Select which bullet depth you want to change then select the bullet shape
4638 Any changes will not be visible in \SpecialChar LyX
4639 , but are visible when viewing the document.
4642 \begin_layout Standard
4643 You can reset a bullet shape to the default simply by clicking your right
4644 mouse button on the appropriate bullet depth button.
4648 \begin_layout Plain Layout
4653 want to have multiple sets of paragraphs with different sets of bullets
4654 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4656 The bullet selection dialog can help though because it provides you with
4657 the \SpecialChar LaTeX
4658 code for a wide range of bullet shapes.
4659 To make your own custom paragraphs you have the following options:
4662 \begin_layout Plain Layout
4666 \begin_layout Plain Layout
4682 \begin_layout Plain Layout
4686 \begin_layout Plain Layout
4708 \begin_layout Itemize
4709 Use the \SpecialChar LaTeX
4711 \begin_inset Flex Code
4714 \begin_layout Plain Layout
4722 to specify a new bullet shape for a given depth.
4723 You'll also need to save the current bullet shape so you can restore it
4725 In this itemized list the following \SpecialChar LaTeX
4726 code was used to change the bullet
4727 used for the first depth.
4731 \begin_layout LyX-Code
4741 \begin_layout LyX-Code
4758 \begin_layout Itemize
4759 Note that the itemize depth is specified in Roman numerals as part of the
4769 \begin_layout Itemize
4773 \begin_layout Plain Layout
4786 Specify each individual entry by starting each item with the bullet shape
4787 enclosed in square brackets and set as
4788 \begin_inset Flex Noun
4791 \begin_layout Plain Layout
4799 For example, this item was started with
4800 \begin_inset Flex Code
4803 \begin_layout Plain Layout
4818 \begin_layout Plain Layout
4822 \begin_layout Plain Layout
4838 \begin_layout Plain Layout
4839 You'll also need to revert the labelitem back to its previous setting for
4840 the global bullet shape settings to remain in effect.
4841 The way used here was:
4844 \begin_layout LyX-Code
4859 \begin_layout Chapter
4861 and the World Wide Web
4864 \begin_layout Standard
4866 has long supported the export of documents to various web-friendly formats,
4868 Before verson 2.0, however, HTML export was always accomplished by the use
4869 of external converters.
4873 \begin_layout Plain Layout
4874 For details on the use of external converters with \SpecialChar LyX
4879 section of the Customization manual.
4884 These fall into two large groups: there are converters that use \SpecialChar LaTeX
4886 intermediate format, such as
4887 \begin_inset Flex Code
4890 \begin_layout Plain Layout
4897 \begin_inset Flex Code
4900 \begin_layout Plain Layout
4907 \begin_inset Flex Code
4910 \begin_layout Plain Layout
4916 , relying upon \SpecialChar LyX
4917 to produce the \SpecialChar LaTeX
4918 ; and there is a converter that works directly
4921 \begin_inset Flex Code
4924 \begin_layout Plain Layout
4932 All of these have different advantages and disadvantages.
4936 \begin_layout Standard
4937 The \SpecialChar LaTeX
4938 -based converters have the advantage that, in principle, they know everythin
4939 g about the exported document that \SpecialChar LaTeX
4941 Such converters do not care, for example, if a certain block of code was
4942 produced by \SpecialChar LyX
4943 or was Evil Red Text.
4944 These converters know about
4945 \begin_inset Flex Code
4948 \begin_layout Plain Layout
4954 files, counters, and references, and can often make use of the
4955 \begin_inset Flex Code
4958 \begin_layout Plain Layout
4964 files generated by Bib\SpecialChar TeX
4966 On the other hand, \SpecialChar LaTeX
4967 is a very hard language to parse—it is sometimes said
4968 that only \SpecialChar TeX
4969 itself understands \SpecialChar TeX
4970 —and \SpecialChar LaTeX
4971 -based converters will often choke on
4972 what seem to be quite simple constructs; complex ones can throw them completely
4973 , and as of this writing, for example, the
4977 manual will not export with
4978 \begin_inset Flex Code
4981 \begin_layout Plain Layout
4987 , though the others will.
4988 The other issue concerns how math is handled.
4989 These converters typically convert the formulae into little pictures that
4990 are then linked from the HTML document.
4991 Since these are actually generated by \SpecialChar LaTeX
4992 , they are accurate.
4993 But they do not scale well, and just getting them to look as if they are
4994 actually meant to be in your document—so that the font sizes seem to be
4995 roughly the same—can be a challenge.
4998 \begin_layout Standard
5000 \begin_inset Flex Code
5003 \begin_layout Plain Layout
5011 \begin_inset CommandInset href
5013 name "http://elyxer.nongnu.org/"
5014 target "http://elyxer.nongnu.org/"
5019 ) solves some of these problems.
5020 In particular, the formulae it produces scale perfectly, since it renders
5021 math using a combination of HTML and CSS rather than converting the formulae
5023 But even moderately complex formula are rendered less well than with
5024 \begin_inset Flex Code
5027 \begin_layout Plain Layout
5033 ; this reflects the limitations of HTML.
5037 \begin_layout Plain Layout
5039 \begin_inset Flex Code
5042 \begin_layout Plain Layout
5049 can also use jsMath and MathJax for equations, but this setting is only
5050 available globally and requires one to have access to a server that runs
5056 More importantly (as of version 1.1.1, at least),
5057 \begin_inset Flex Code
5060 \begin_layout Plain Layout
5067 has limited support for math macros and no support for user-defined paragraph
5068 or character styles.
5069 These limitations make
5070 \begin_inset Flex Code
5073 \begin_layout Plain Layout
5080 unsuitable for many of the documents \SpecialChar LyX
5082 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5084 have decided to follow a different path and have made \SpecialChar LyX
5086 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5087 , DocBook, and plaintext.
5090 \begin_layout Standard
5091 As of this writing, XHTML output remains under development and should probably
5093 \begin_inset Quotes eld
5097 \begin_inset Quotes erd
5104 \begin_layout Plain Layout
5106 \begin_inset Flex Code
5109 \begin_layout Plain Layout
5110 development/HTML.notes
5115 , which can be found in the \SpecialChar LyX
5117 \begin_inset CommandInset href
5119 name "accessed online"
5120 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5125 , usually contains up-to-date information about the state of XHTML output.
5126 See also the list of XHTML bugs on
5127 \begin_inset CommandInset href
5129 name "the bug tracker"
5130 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"
5140 Still, the developers have chosen this approach because it has several
5141 potential advantages over the other two.
5144 \begin_layout Standard
5145 These advantages are primarily due to the fact that the XHTML output routines,
5146 since they are part of \SpecialChar LyX
5147 , know everything \SpecialChar LyX
5148 knows about the document being
5153 \begin_layout Plain Layout
5154 Another advantage is that, since these routines are internal to \SpecialChar LyX
5156 immune to changes in \SpecialChar LyX
5157 's file format, or to changes in the semantics of
5163 So they know about the table of contents (as displayed in the outline),
5164 about the counters associated with different paragraph styles, and about
5165 user-defined styles.
5166 The XHTML output routines know what \SpecialChar LyX
5167 knows about internationalization,
5168 too, so they will output
5169 \begin_inset Quotes eld
5173 \begin_inset Quotes erd
5177 \begin_inset Quotes eld
5185 \begin_inset Quotes erd
5188 , depending upon the language in effect at the time.
5192 \begin_layout Standard
5193 Quite generally, the output routines know what \SpecialChar LyX
5194 knows about document layout,
5195 that is, about how the document is to be rendered on screen.
5196 We use this information when we output the document as XHTML.
5197 In particular, \SpecialChar LyX
5202 generates CSS style information corresponding to the layout information
5203 it uses to render the document on screen: if section headings are supposed
5204 to be sans-serif and bold as seen in \SpecialChar LyX
5205 , then (by default) they will be sans-seri
5206 f and bold when viewed in a web browser, too.
5207 And this is true not just for pre-defined styles, like Section, but for
5208 any style, including user-defined styles.
5209 Indeed, the XHTML output routines make no distinction between user-defined
5210 paragraph and character styles and \SpecialChar LyX
5211 's own pre-defined styles: in each case,
5212 everything \SpecialChar LyX
5213 knows about the styles is contained in the layout files.
5214 And much the same is true as regards pre-defined textual insets, such as
5215 footnotes, and various custom insets.
5219 \begin_layout Standard
5220 The result is that XHTML output can be customized and extended in exactly
5221 the same way \SpecialChar LaTeX
5222 output can be customized and extended: through layout files
5224 See chapter five of the
5228 manual for the details.
5231 \begin_layout Standard
5232 The remainder of this chapter contains more detailed information on XHTML
5233 output, its limitations, and ways to work around those limitations.
5236 \begin_layout Section
5237 Math Output in XHTML
5240 \begin_layout Standard
5242 offers four choices for how math is rendered.
5243 These have various advantages and disadvantages:
5246 \begin_layout Itemize
5248 \begin_inset Newline newline
5251 MathML is a dialect of XML designed specifically for mathematics on the
5252 web, and it typically renders very well in browsers that support it.
5253 The disadvantage is that not all browsers support MathML, and support is
5254 not complete even in the Gecko-based browsers, such as Firefox.
5255 \begin_inset Newline newline
5259 is unable to render a formula as MathML—for example, if the formula
5261 \begin_inset Flex Code
5264 \begin_layout Plain Layout
5270 package or ERT—then it will instead output the formula as an image.
5274 \begin_layout Itemize
5276 \begin_inset Newline newline
5280 \begin_inset Flex Code
5283 \begin_layout Plain Layout
5289 outputs math as HTML, styled by CSS.
5293 \begin_layout Plain Layout
5295 has borrowed some of the CSS for its HTML output from
5296 \begin_inset Flex Code
5299 \begin_layout Plain Layout
5310 For simple formulae, this can work quite well, though with more complicated
5311 formulae it tends to break down.
5312 Still, this method has the advantage that it is very widely supported and
5313 so it may be appropriate for documents that contain only a little, fairly
5315 \begin_inset Newline newline
5318 If Lyx is unable to render a formula as HTML—for example, if the formula
5320 \begin_inset Flex Code
5323 \begin_layout Plain Layout
5329 package or ERT—then it will instead output the formula as an image.
5333 \begin_layout Itemize
5335 \begin_inset Newline newline
5339 \begin_inset Flex Code
5342 \begin_layout Plain Layout
5349 will output formulae as images, the very same images, in fact, that are
5350 used for instant preview.
5354 \begin_layout Plain Layout
5355 Instant preview does
5359 have to be on for images to be output, however.
5364 The advantage to this method is that the images are simply generated by
5366 , so they are very accurate.
5367 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5368 so they do not scale terribly well, and one cannot copy them, etc.
5369 (As of this writing, there are also problems about equation numbering.
5371 \begin_inset CommandInset href
5374 target "http://www.lyx.org/trac/ticket/6894"
5380 \begin_inset Newline newline
5383 The size of the images can be controlled by setting the
5384 \begin_inset Quotes eld
5388 \begin_inset Quotes erd
5392 \begin_inset Flex Noun
5395 \begin_layout Plain Layout
5396 Document\SpecialChar menuseparator
5397 Settings\SpecialChar menuseparator
5407 \begin_layout Plain Layout
5408 For those who want to know, this controls the resolution of the image in
5409 dots per inch and is based upon a default of 75 dpi.
5415 \begin_inset Newline newline
5419 for some reason fails to create an image for a formula (e.g., if a required
5421 package is not installed), then it will fall back to outputing the raw
5426 \begin_layout Itemize
5429 \begin_inset Newline newline
5432 Finally, \SpecialChar LyX
5433 will happily output math as \SpecialChar LaTeX
5435 As well as being the output of last resort, this method can be used with
5437 \begin_inset CommandInset href
5440 target "http://www.math.union.edu/~dpvc/jsMath/"
5445 , which uses JavaScript to render \SpecialChar LaTeX
5446 embedded in HTML documents.
5448 wraps the \SpecialChar LaTeX
5450 \begin_inset Flex Code
5453 \begin_layout Plain Layout
5459 (for inline formulas) or
5460 \begin_inset Flex Code
5463 \begin_layout Plain Layout
5469 (for displayed formulas) with
5470 \begin_inset Flex Code
5473 \begin_layout Plain Layout
5479 , as is required for jsMath.
5482 \begin_layout Standard
5483 One of these output methods must be selected under
5484 \begin_inset Flex Noun
5487 \begin_layout Plain Layout
5488 Document\SpecialChar menuseparator
5489 Settings\SpecialChar menuseparator
5496 By default, \SpecialChar LyX
5498 This is a document-wide setting, therefore.
5501 \begin_layout Standard
5502 Eventually, \SpecialChar LyX
5503 will offer the user the option to select an alternate output
5504 method for a particular inset, say, one that isn't being rendered very
5509 \begin_layout Plain Layout
5510 That said, since \SpecialChar LyX
5511 falls back to images if the inset contains ERT, then one
5512 can force output as an image by putting some harmless ERT into the math,
5514 \begin_inset Formula $a=b\relax$
5525 \begin_layout Section
5526 Bibliography and Citations
5529 \begin_layout Standard
5530 XHTML output fully supports bibliographies and citations.
5534 \begin_layout Standard
5535 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5537 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5540 If you are using numerical citations, then \SpecialChar LyX
5541 will output numerical labels,
5542 such as [1] or [17], rather than simply showing the citation key in square
5543 brackets, as it does on-screen.
5544 If you are using author-year citations, then \SpecialChar LyX
5545 will add lowercase letters
5546 to the years, just as Bib\SpecialChar TeX
5547 does, if it finds more than one citation for
5548 a given author-year combination.
5549 The labels will be printed with the bibliography entries.
5550 Note that there is, at present, no way to customize the appearance of the
5551 labels, for example, to choose between square brackets and parentheses.
5554 \begin_layout Standard
5555 Bibliography output is handled by the same machinery that handles the presentati
5556 on of reference information in the citation dialog, so you will see in the
5557 XHTML output pretty much what you would see if you were to look at a given
5558 entry in the citation dialog.
5559 The formatting can be customized in your layout file or, preferably, in
5565 manual for the details.
5568 \begin_layout Standard
5569 The main defect at present is that cross-referenced information is printed
5570 with every entry with which it is associated.
5571 So you can see things like this:
5576 \begin_inset Quotes eld
5579 Context and Logical Form
5580 \begin_inset Quotes erd
5585 Language in Context: Selected Essays
5587 (Oxford: Oxford University Press, 2007), pp.
5593 \begin_inset Quotes eld
5596 Semantics in Context
5597 \begin_inset Quotes erd
5602 Language in Context: Selected Essays
5604 (Oxford: Oxford University Press, 2007), pp.
5608 \begin_layout Standard
5609 This should be fixed before long.
5612 \begin_layout Standard
5613 There is no support at present for sectioned bibliographies.
5614 If you have multiple bibliographies, then \SpecialChar LyX
5615 will print the same bibliography
5619 \begin_layout Section
5623 \begin_layout Standard
5625 will happily export indexes as XHTML, but with certain limitations at the
5629 \begin_layout Standard
5630 Index export will be most reliable when you do not attempt to use the fancy
5631 constructs that are described in the section on indexes in the
5639 \begin_layout Plain Layout
5640 The main issue here is that \SpecialChar LyX
5641 itself does not really handle these.
5642 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5648 We'll describe how they are handled using the subsection headings from
5652 \begin_layout Itemize
5653 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5654 makes an effort to support these,
5655 but the entries must be separated by
5656 \begin_inset Quotes eld
5660 \begin_inset Quotes erd
5663 , that is, there must be spaces around the exclamation point.
5664 This is because it is otherwise too difficult to check for escaped exclamation
5665 points, ones in math, and so forth.
5668 \begin_layout Itemize
5669 Page Ranges: There is no support at all for page ranges, since these make
5670 no sense with XHMTL.
5671 Instead, you will just get two index entries, one at either end.
5674 \begin_layout Itemize
5675 Cross-referencing: There is no support for cross-referencing.
5677 finds an entry containing the
5678 \begin_inset Quotes eld
5681 |see\SpecialChar ldots
5683 \begin_inset Quotes erd
5686 construct, it is just dropped, and the rest is treated as an ordinary index
5690 \begin_layout Itemize
5691 Index Entry Order: \SpecialChar LyX
5692 does support attempts to fix the sorting order.
5693 It will take what is before the first `@' it finds and use that for sorting,
5694 taking what follows the first `@' to be the actual entry.
5695 At present, \SpecialChar LyX
5696 does not check for escaped `@', so do not try to index email
5700 \begin_layout Itemize
5701 Index Entry Layout: You can format entries by using the text style dialog,
5702 or by using any other method available within \SpecialChar LyX
5704 There is no support for constructs like:
5705 \begin_inset Quotes eld
5709 \begin_inset Quotes erd
5713 Indeed, if \SpecialChar LyX
5714 finds a pipe symbol, `|', in an entry, it will delete it and
5715 everything that follows it.
5718 \begin_layout Itemize
5719 Multiple Indexes: There is no support for multiple indexes.
5720 Rather, all index entries will be printed as one large index.
5721 To avoid our printing several versions of the index, we print only the
5722 main index, so make sure you have one.
5725 \begin_layout Section
5726 Nomenclature and Glossary
5729 \begin_layout Standard
5730 There is at present no support for glossaries.
5731 Adding it would be fairly trivial, and welcome.
5734 \begin_layout Chapter
5735 The \SpecialChar LyX
5739 \begin_layout Section
5743 \begin_layout Standard
5744 The `\SpecialChar LyX
5745 server' allows other programs to talk to \SpecialChar LyX
5746 , invoke \SpecialChar LyX
5747 commands, and retrieve
5748 information about the \SpecialChar LyX
5750 This is only intended for advanced users, but they should find it useful.
5751 It is by writing to the \SpecialChar LyX
5752 server, for example, that bibliography managers,
5753 such as JabRef, are able to
5754 \begin_inset Quotes eld
5758 \begin_inset Quotes erd
5761 citations to \SpecialChar LyX
5765 \begin_layout Section
5766 Starting the \SpecialChar LyX
5770 \begin_layout Standard
5771 The \SpecialChar LyX
5772 server works through the use of a pair of named pipes.
5773 These are usually located in
5774 \begin_inset Flex Code
5777 \begin_layout Plain Layout
5783 , (except on Windows, where
5787 named pipes are special objects located in
5788 \begin_inset Flex Code
5791 \begin_layout Plain Layout
5803 ) and have the names
5804 \begin_inset Quotes eld
5808 \begin_inset Flex Code
5811 \begin_layout Plain Layout
5818 \begin_inset Quotes erd
5822 \begin_inset Quotes eld
5826 \begin_inset Flex Code
5829 \begin_layout Plain Layout
5836 \begin_inset Quotes erd
5840 External programs write into
5841 \begin_inset Flex Code
5844 \begin_layout Plain Layout
5850 and read back data from
5851 \begin_inset Flex Code
5854 \begin_layout Plain Layout
5861 The stem of the pipe names can be defined in the
5862 \begin_inset Flex Noun
5865 \begin_layout Plain Layout
5866 Tools\SpecialChar menuseparator
5873 \begin_inset Flex Code
5876 \begin_layout Plain Layout
5877 "/home/myhome/lyxpipe"
5883 \begin_inset Flex Code
5886 \begin_layout Plain Layout
5900 on Windows (where any working path instead of lyxpipe can be used, for
5902 \begin_inset Flex Code
5905 \begin_layout Plain Layout
5928 configure this manually in order for the server to start.
5931 \begin_layout Standard
5934 \begin_inset Flex Code
5937 \begin_layout Plain Layout
5944 \begin_inset Flex Code
5947 \begin_layout Plain Layout
5953 ' to create the pipes.
5954 If one of the pipes already exists, \SpecialChar LyX
5955 will assume that another \SpecialChar LyX
5957 is already running and will not start the server.
5958 On POSIX (Unix like) systems, if for some other reason, an unused
5959 \begin_inset Quotes eld
5963 \begin_inset Quotes erd
5966 pipe is left in existence when \SpecialChar LyX
5967 closes, then \SpecialChar LyX
5968 will try to delete it.
5969 If this fails for some reason, you will need to delete the pipes manually
5970 and then restart \SpecialChar LyX
5972 On Windows, pipes are deleted by the OS on program termination or crash,
5974 \begin_inset Quotes eld
5978 \begin_inset Quotes erd
5981 pipes should not be possible.
5984 \begin_layout Standard
5985 To have several \SpecialChar LyX
5986 processes with servers at the same time, you have to use
5987 different configurations, perhaps by using separate user directories, each
5989 \begin_inset Flex Code
5992 \begin_layout Plain Layout
5998 file, for each process.
6001 \begin_layout Standard
6002 If you are developing a client program, you might find it useful to enable
6003 debugging information from the \SpecialChar LyX
6005 Do this by starting \SpecialChar LyX
6007 \begin_inset Flex Code
6010 \begin_layout Plain Layout
6019 \begin_layout Standard
6020 You can find a complete example client written in C++ in the source distribution
6022 \begin_inset Flex Code
6025 \begin_layout Plain Layout
6026 development/lyxserver/server_monitor.cpp
6034 \begin_layout Standard
6035 Another useful tool is the command-line based client found in
6036 \begin_inset Flex Code
6039 \begin_layout Plain Layout
6040 src/client/lyxclient
6048 \begin_layout Section
6049 Normal communication
6052 \begin_layout Standard
6053 To issue a \SpecialChar LyX
6054 call, the client writes a line of ASCII text into the input
6056 This line has the following format:
6073 \begin_layout Description
6074 clientname is a name that the client can choose arbitrarily.
6075 Its only use is that \SpecialChar LyX
6076 will echo it if it sends an answer—so a client can
6077 dispatch results from different requesters.
6080 \begin_layout Description
6081 function is the function you want \SpecialChar LyX
6083 It is the same as the commands you'd use in the minibuffer.
6086 \begin_layout Description
6087 argument is an optional argument which is meaningful only to some functions
6089 \begin_inset Quotes eld
6093 \begin_inset Quotes erd
6096 LFUN will insert the argument as text at the cursor position).
6099 \begin_layout Standard
6100 The answer from \SpecialChar LyX
6101 will arrive in the output pipe and be of the form
6118 \begin_layout Standard
6127 are just echoed from the command request, while
6131 is more or less useful information filled according to how the command
6132 execution worked out.
6133 Some commands, such as
6134 \begin_inset Quotes eld
6138 \begin_inset Quotes erd
6141 , will return information about the internal state of \SpecialChar LyX
6143 return an empty data-response.
6144 This means that the command execution went fine.
6147 \begin_layout Standard
6148 In case of errors, the response from \SpecialChar LyX
6166 \begin_layout Standard
6171 should contain an explanation of why the command failed.
6174 \begin_layout Standard
6178 \begin_layout LyX-Code
6179 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6180 \begin_inset Newline newline
6183 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6184 \begin_inset Newline newline
6187 read a <~/.lyxpipe.out
6188 \begin_inset Newline newline
6194 \begin_layout Subsection
6195 AppleScript (Mac OS X)
6198 \begin_layout Standard
6199 Since \SpecialChar LyX
6200 2.1, \SpecialChar LyX
6201 supports basic interactions with AppleScript for normal communicatio
6202 n through the command run.
6203 This command takes a direct argument (the
6207 to perform) and an optional argument.
6208 It either returns the output of the function or triggers an error with
6209 the error message and code.
6212 \begin_layout Standard
6216 \begin_layout LyX-Code
6217 tell application "\SpecialChar LyX
6221 \begin_layout LyX-Code
6225 \begin_layout LyX-Code
6226 -- Stores the current file name into f
6229 \begin_layout LyX-Code
6230 set f to (run "server-get-filename" with argument "")
6233 \begin_layout LyX-Code
6234 on error the error_message number the error_number
6237 \begin_layout LyX-Code
6238 display dialog "Error: " & the error_number & ".
6242 \begin_layout LyX-Code
6243 & the error_message buttons {"OK"} default button 1
6246 \begin_layout LyX-Code
6250 \begin_layout LyX-Code
6254 \begin_layout Section
6258 \begin_layout Standard
6260 can notify clients of events going on asynchronously.
6261 Currently it will only do this if the user binds a key sequence with the
6263 \begin_inset Quotes eld
6267 \begin_inset Quotes erd
6271 The format of the string \SpecialChar LyX
6272 sends is as follows:
6276 \begin_inset Flex Code
6279 \begin_layout Plain Layout
6290 \begin_layout Standard
6295 is the printed representation of the key sequence that was actually typed
6299 \begin_layout Standard
6300 This mechanism can be used to extend \SpecialChar LyX
6301 's command set and implement macros.
6302 Bind some key sequence to
6303 \begin_inset Quotes eld
6307 \begin_inset Quotes erd
6311 Then start a client that listens on the output pipe, dispatches the command
6312 according to the sequence, and starts a function that may use \SpecialChar LyX
6315 requests to issue a command or a series of commands to \SpecialChar LyX
6319 \begin_layout Section
6320 The simple \SpecialChar LyX
6324 \begin_layout Standard
6326 implements a simple protocol that can be used for session management.
6327 All messages are of the form
6340 \begin_layout Standard
6346 \begin_inset Quotes eld
6350 \begin_inset Quotes erd
6354 \begin_inset Quotes eld
6358 \begin_inset Quotes erd
6363 \begin_inset Quotes eld
6367 \begin_inset Quotes erd
6370 is received from a client, \SpecialChar LyX
6371 will report back to inform the client that
6372 it's listening to it's messages, while
6373 \begin_inset Quotes eld
6377 \begin_inset Quotes erd
6380 sent from \SpecialChar LyX
6381 will inform clients that \SpecialChar LyX
6385 \begin_layout Section
6386 Reverse DVI/PDF search
6389 \begin_layout Standard
6390 Some DVI/PDF viewers
6394 \begin_layout Plain Layout
6395 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6396 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6405 facility (also called
6410 This means that you can tell \SpecialChar LyX
6411 to put the cursor to a specific line in the
6412 document by clicking at the respective position in the DVI/PDF output.
6413 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6415 This is done via the \SpecialChar LyX
6416 server either by using the named pipe (
6420 ), or the UNIX domain socket (
6424 ) that \SpecialChar LyX
6425 creates in its temporary directory (this is the way the
6426 \begin_inset Flex Code
6429 \begin_layout Plain Layout
6435 program communicates with \SpecialChar LyX
6437 In some cases, you need a helper script that mediates between the viewer
6438 and \SpecialChar LyX
6439 , in others, the viewer can communicate with \SpecialChar LyX
6441 This depends on the selected viewer and on your operating system.
6442 The same applies to the way viewers need to be configured and the way the
6443 reverse search is actually performed.
6444 In what follows, we will thus describe how to setup reverse search for
6446 Before we turn to this, though, we will explain what needs to be done generally
6447 to enable reverse search in the DVI/PDF output.
6450 \begin_layout Subsection
6452 \begin_inset CommandInset label
6454 name "subsec:rev-search"
6461 \begin_layout Standard
6462 In most cases \SpecialChar LyX
6463 will do the work for you by
6464 \change_inserted -712698321 1500975045
6465 pressing the following button in the toolbar:
6468 arg "buffer-toggle-output-sync"
6472 Alternatively, you can also enable the feature by checking
6474 Synchronize with Output
6477 \begin_inset Flex Noun
6480 \begin_layout Plain Layout
6482 \change_inserted -712698321 1500975071
6483 Document\SpecialChar menuseparator
6484 Settings\SpecialChar menuseparator
6491 \change_deleted -712698321 1500974764
6493 \begin_inset Flex Noun
6496 \begin_layout Plain Layout
6497 Synchronize with Output
6503 \begin_inset Flex Noun
6506 \begin_layout Plain Layout
6507 Document\SpecialChar menuseparator
6508 Settings\SpecialChar menuseparator
6517 In such a case \SpecialChar LyX
6518 will automatically insert the necessary Sync\SpecialChar TeX
6520 PDF) or load the srcltx package (for DVI) respectively.
6521 This option can be easily reached also on
6522 \begin_inset Flex Code
6525 \begin_layout Plain Layout
6534 \begin_layout Standard
6535 If you need a different setting, you can select or input a custom macro
6536 from the drop down box just below
6537 \begin_inset Flex Noun
6540 \begin_layout Plain Layout
6541 Document\SpecialChar menuseparator
6542 Settings\SpecialChar menuseparator
6543 Output\SpecialChar menuseparator
6544 Synchronize with Output
6552 \begin_layout Standard
6553 Note that the method
6554 \begin_inset Flex Code
6557 \begin_layout Plain Layout
6565 enables gzip compression.
6566 If your viewer does not support it, you should instead use
6567 \begin_inset Flex Code
6570 \begin_layout Plain Layout
6581 \begin_layout Standard
6582 Please also note that including the
6583 \begin_inset Flex Code
6586 \begin_layout Plain Layout
6593 \begin_inset Flex Code
6596 \begin_layout Plain Layout
6602 sometimes has an undesired impact on the typesetting.
6603 Thus, you should switch output synchronization off for the final typesetting
6605 \begin_inset Flex Code
6608 \begin_layout Plain Layout
6615 \begin_inset Flex Code
6618 \begin_layout Plain Layout
6628 \begin_layout Standard
6629 In case you need some more special settings that are not covered by the
6630 automatic settings, read the next section about how to set up output synchroniz
6632 If the automatic setup suits your needs, you can readily jump to section
6633 \begin_inset space ~
6637 \begin_inset CommandInset ref
6639 reference "subsec:configuring-viewers"
6643 , where the necessary configuration steps in your viewer – needed both with
6644 the automatic and the manual setup – are described.
6647 \begin_layout Subsection
6651 \begin_layout Standard
6653 provides several different methods for reverse search.
6654 Some are built-in in the
6655 \begin_inset Flex Code
6658 \begin_layout Plain Layout
6664 program, some are provided by external packages.
6665 Your choice depends on whether your \SpecialChar LaTeX
6666 distribution already provides a given
6667 method (the built-in methods are rather new) and whether your viewer can
6669 The available methods are described in the following.
6672 \begin_layout Subsubsection*
6673 Built-in DVI-search via src-specials (DVI only)
6676 \begin_layout Standard
6677 This method provides the DVI file with the necessary information for reverse
6679 It is available in \SpecialChar LaTeX
6680 since quite some time (any somewhat recent \SpecialChar LaTeX
6682 should include it), and it works reliably.
6683 To enable it, change the
6684 \begin_inset Flex Noun
6687 \begin_layout Plain Layout
6698 \begin_inset Flex Noun
6701 \begin_layout Plain Layout
6712 \begin_inset Flex Noun
6715 \begin_layout Plain Layout
6716 Preferences\SpecialChar menuseparator
6717 File Handling\SpecialChar menuseparator
6724 \begin_inset Flex Code
6727 \begin_layout Plain Layout
6728 latex -src-specials $$i
6734 If this doesn't work, check if your \SpecialChar TeX
6735 engine needs different options (the
6736 syntax might differ in some distributions).
6739 \begin_layout Subsubsection*
6740 External Packages (PDFSync and scrltx)
6743 \begin_layout Standard
6752 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6754 In order to enable it, load the packages in the \SpecialChar LyX
6758 \begin_layout Itemize
6759 \begin_inset Flex Code
6762 \begin_layout Plain Layout
6770 for reverse PDF search,
6773 \begin_layout Itemize
6774 \begin_inset Flex Code
6777 \begin_layout Plain Layout
6780 usepackage[active]{srcltx}
6785 for reverse DVI search.
6788 \begin_layout Standard
6789 If you want to be able to perform both DVI and PDF reverse searches, you
6790 can also insert in the preamble the following lines
6793 \begin_layout LyX-Code
6797 \begin_inset Newline newline
6803 \begin_inset Newline newline
6809 \begin_inset Newline newline
6815 \begin_inset Newline newline
6820 usepackage[active]{srcltx}
6821 \begin_inset Newline newline
6829 \begin_layout Standard
6830 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6831 right package will be used.
6834 \begin_layout Standard
6835 Note that PDFSync might affect the output layout of your document.
6836 It is therefore advised to disable PDFsync for final documents.
6839 \begin_layout Subsubsection*
6840 Built-in reverse search via Sync\SpecialChar TeX
6844 \begin_layout Standard
6846 \begin_inset Flex Code
6849 \begin_layout Plain Layout
6855 have built-in support for both PDF and DVI reverse search.
6858 Sync\SpecialChar TeX
6861 facility is basically the result of the integration of the PDFSync package
6862 to the pdftex program and its merge with the
6867 You need at least \SpecialChar TeX
6868 Live 2008 or a recent Mik\SpecialChar TeX
6869 distribution in order to use
6874 \begin_layout Plain Layout
6875 For some reason, Mik\SpecialChar TeX
6876 does not understand/obey the command \SpecialChar LyX
6878 the preamble when you check the "Enable Forward/Reverse Search" button
6879 in the toolbar and does not generate the necessary info.
6882 \begin_layout Plain Layout
6883 The generation of the required info can be forced by changing the converter
6885 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
6886 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
6887 the -synctex=1 switch).
6892 Also note that only a few PDF viewers (
6893 \change_inserted -712698321 1500977288
6896 Okular and Qpdfview on Unix, Skim on the Mac, SumatraPDF on Windows
6897 \change_inserted -712698321 1500977299
6898 ; see the next section for details
6900 ) already provide Sync\SpecialChar TeX
6904 \begin_layout Standard
6905 To enable Sync\SpecialChar TeX
6906 for DVI output, change the
6907 \begin_inset Flex Noun
6910 \begin_layout Plain Layout
6921 \begin_inset Flex Noun
6924 \begin_layout Plain Layout
6935 \begin_inset Flex Noun
6938 \begin_layout Plain Layout
6939 Preferences\SpecialChar menuseparator
6940 File Handling\SpecialChar menuseparator
6947 \begin_inset Flex Code
6950 \begin_layout Plain Layout
6951 latex -synctex=1 $$i
6956 , and for PDF output, change the
6957 \begin_inset Flex Noun
6960 \begin_layout Plain Layout
6965 (pdflatex) -> PDF (pdflatex)
6971 \change_deleted -712698321 1500977453
6975 \begin_inset Flex Code
6978 \begin_layout Plain Layout
6979 pdflatex -synctex=1 $$i
6986 \change_inserted -712698321 1500977740
6987 Should your viewer not be considered in the following description, or in
6988 case of missing success, please
6989 \change_deleted -712698321 1500977741
6991 \change_inserted -712698321 1500977744
6994 heck the documentation of your viewer whether the viewer needs to be configured
6995 for the use with Sync\SpecialChar TeX
7000 \begin_layout Plain Layout
7001 Note that the option
7002 \begin_inset Flex Code
7005 \begin_layout Plain Layout
7011 option enables gzip compression.
7012 If your viewer does not support it, you should instead use
7013 \begin_inset Flex Code
7016 \begin_layout Plain Layout
7030 \begin_layout Subsection
7031 Configuring and using specific viewers
7032 \begin_inset CommandInset label
7034 name "subsec:configuring-viewers"
7041 \begin_layout Subsubsection*
7042 Xdvi (all platforms)
7045 \begin_layout Standard
7047 \begin_inset Flex Code
7050 \begin_layout Plain Layout
7056 , you don't need to do anything else for performing a reverse DVI search,
7058 already provides the necessary hooks for automatically using the
7059 \begin_inset Flex Code
7062 \begin_layout Plain Layout
7069 Just setup your document as described above (reverse search is triggered
7070 by Ctrl-click or Alt-click on Mac OSX, respectively).
7073 \begin_layout Standard
7074 However, if for whatever reason you want to use the named pipe instead of
7075 the socket for communicating with \SpecialChar LyX
7076 , simply change the DVI viewer in
7077 \begin_inset Flex Noun
7080 \begin_layout Plain Layout
7081 Preferences\SpecialChar menuseparator
7082 File Handling\SpecialChar menuseparator
7092 \begin_layout Plain Layout
7093 On Mac OSX you have to use
7094 \begin_inset Flex Code
7097 \begin_layout Plain Layout
7098 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7109 \begin_inset Flex Code
7112 \begin_layout Plain Layout
7113 xdvi -editor "lyxeditor.sh %f %l"
7119 \begin_inset Flex Code
7122 \begin_layout Plain Layout
7128 is a suitable script.
7129 For example, a minimal shell script is the following one:
7132 \begin_layout LyX-Code
7134 \begin_inset Newline newline
7137 LYXPIPE="/path/to/lyxpipe"
7138 \begin_inset Newline newline
7141 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7142 \begin_inset Newline newline
7145 echo "$COMMAND" > "${LYXPIPE}".in || exit
7146 \begin_inset Newline newline
7149 read TMP < "${LYXPIPE}".out || exit
7152 \begin_layout Standard
7154 \begin_inset Flex Code
7157 \begin_layout Plain Layout
7163 is the LyXServer pipe path specified in
7164 \begin_inset Flex Noun
7167 \begin_layout Plain Layout
7168 Preferences\SpecialChar menuseparator
7178 \begin_layout Plain Layout
7180 \begin_inset Flex Code
7183 \begin_layout Plain Layout
7189 folder of a source distribution you can find a
7190 \begin_inset Flex Code
7193 \begin_layout Plain Layout
7199 script which is able to locate the
7203 based on your preferences.
7211 \begin_layout Subsubsection*
7215 \begin_layout Standard
7217 \begin_inset Flex Code
7220 \begin_layout Plain Layout
7221 /Applications/MacDviX_Folder/calleditor.script
7226 , add the following lines:
7229 \begin_layout LyX-Code
7230 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7231 \begin_inset Newline newline
7237 \begin_layout Standard
7238 Modify the lines accordingly if you install \SpecialChar LyX
7239 somewhere else than in the
7240 Applications folder.
7243 \begin_layout Standard
7244 Reverse search is triggered by Alt-click (OPTION-click).
7247 \begin_layout Subsubsection*
7251 \begin_layout Standard
7253 \begin_inset Flex Code
7256 \begin_layout Plain Layout
7257 open -a Skim.app $$i
7262 to the viewer setting in
7263 \begin_inset Flex Noun
7266 \begin_layout Plain Layout
7267 Preferences\SpecialChar menuseparator
7268 File Handling\SpecialChar menuseparator
7269 File formats\SpecialChar menuseparator
7276 \begin_inset Flex Noun
7279 \begin_layout Plain Layout
7280 Skim\SpecialChar menuseparator
7281 Preferences\SpecialChar menuseparator
7288 \begin_inset Flex Noun
7291 \begin_layout Plain Layout
7297 preset and enter command
7298 \begin_inset Flex Noun
7301 \begin_layout Plain Layout
7302 /Applications/\SpecialChar LyX
7303 .app/Contents/MacOS/lyxeditor
7311 \begin_layout Standard
7312 Reverse search is triggered by COMMAND-SHIFT-click
7315 \begin_layout Subsubsection*
7319 \begin_layout Standard
7320 Reverse search with evince does not work out of the box, but it can be achieved
7321 by means of some third party helper scripts.
7323 \begin_inset CommandInset href
7325 target "http://wiki.lyx.org/LyX/SyncTeX"
7333 \begin_layout Subsubsection*
7337 \begin_layout Standard
7339 \begin_inset Flex Noun
7342 \begin_layout Plain Layout
7343 Settings\SpecialChar menuseparator
7344 Configure Okular\SpecialChar menuseparator
7351 \change_inserted -712698321 1500981642
7353 \change_deleted -712698321 1500981641
7357 \change_deleted -712698321 1500981634
7359 \begin_inset Quotes eld
7363 \change_inserted -712698321 1500981635
7367 \begin_inset Quotes erd
7371 \change_inserted -712698321 1500981659
7373 This inserts the appropriate
7374 \change_deleted -712698321 1500981663
7378 \change_inserted -712698321 1500981665
7382 \begin_inset Flex Code
7385 \begin_layout Plain Layout
7392 \change_inserted -712698321 1500981668
7398 \begin_layout Standard
7399 Reverse search is triggered by SHIFT-click.
7402 \begin_layout Subsubsection*
7406 \begin_layout Standard
7407 Qpdfview supports Sync\SpecialChar TeX
7408 since version 0.3.5.
7410 \begin_inset Flex Noun
7413 \begin_layout Plain Layout
7414 Edit\SpecialChar menuseparator
7415 Settings\SpecialChar menuseparator
7421 , click on the input field of the
7422 \begin_inset Quotes eld
7426 \begin_inset Quotes erd
7429 item and add the command
7430 \begin_inset Flex Code
7433 \begin_layout Plain Layout
7442 \begin_layout Standard
7443 Reverse search is triggered by double-click or, in more recent versions,
7447 \begin_layout Subsubsection*
7451 \begin_layout Standard
7452 Launch yap, choose its
7453 \begin_inset Flex Noun
7456 \begin_layout Plain Layout
7457 View\SpecialChar menuseparator
7464 \begin_inset Quotes eld
7468 \begin_inset Quotes erd
7473 \begin_inset Quotes eld
7476 New\SpecialChar ldots
7478 \begin_inset Quotes erd
7481 button and, in the window that opens, enter
7482 \begin_inset Quotes eld
7487 \begin_inset Quotes erd
7490 (or any other name you like) in the
7491 \begin_inset Quotes eld
7495 \begin_inset Quotes erd
7499 Now click on the button labeled
7500 \begin_inset Quotes eld
7505 \begin_inset Quotes erd
7508 to open a file dialog and navigate to the directory containing the batch
7510 \begin_inset Flex Code
7513 \begin_layout Plain Layout
7521 \begin_inset Flex Code
7524 \begin_layout Plain Layout
7530 and then specify the program arguments as
7531 \begin_inset Flex Code
7534 \begin_layout Plain Layout
7542 \begin_inset Flex Code
7545 \begin_layout Plain Layout
7551 wrapper is used for communicating with \SpecialChar LyX
7559 \begin_layout LyX-Code
7561 \begin_inset Newline newline
7564 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
7573 \begin_inset Newline newline
7587 \begin_layout Standard
7588 Make sure that the \SpecialChar LyX
7589 Server pipe path you specified in \SpecialChar LyX
7591 \begin_inset Flex Code
7594 \begin_layout Plain Layout
7608 , otherwise change the
7609 \begin_inset Flex Code
7612 \begin_layout Plain Layout
7618 wrapper accordingly.
7621 \begin_layout Standard
7622 In yap, reverse search is triggered by double-click.
7625 \begin_layout Subsubsection*
7626 SumatraPDF (Windows)
7629 \begin_layout Standard
7630 In order to use SumatraPDF for inverse search, enter
7631 \begin_inset Flex Code
7634 \begin_layout Plain Layout
7635 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
7640 in the viewer setting in
7641 \begin_inset Flex Noun
7644 \begin_layout Plain Layout
7645 Preferences\SpecialChar menuseparator
7646 File Handling\SpecialChar menuseparator
7647 File formats\SpecialChar menuseparator
7654 \begin_inset Flex Code
7657 \begin_layout Plain Layout
7663 is the previous wrapper.
7664 If SumatraPDF.exe is not in your command PATH, use its full file name.
7667 \begin_layout Standard
7668 Reverse search is triggered by double-click.
7671 \begin_layout Subsubsection*
7675 \begin_layout Standard
7676 First of all, make sure that yap is your default DVI viewer in the Windows
7677 environment, then launch it, choose its
7678 \begin_inset Flex Noun
7681 \begin_layout Plain Layout
7682 View\SpecialChar menuseparator
7689 \begin_inset Quotes eld
7693 \begin_inset Quotes erd
7698 \begin_inset Quotes eld
7701 New\SpecialChar ldots
7703 \begin_inset Quotes erd
7706 button and, in the window that opens, enter
7707 \begin_inset Quotes eld
7712 \begin_inset Quotes erd
7715 (or any other name you like) in the
7716 \begin_inset Quotes eld
7720 \begin_inset Quotes erd
7724 Now click on the button labeled
7725 \begin_inset Quotes eld
7730 \begin_inset Quotes erd
7733 to open a file dialog and navigate to the directory containing the
7734 \begin_inset Flex Code
7737 \begin_layout Plain Layout
7743 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7746 \begin_inset Flex Code
7749 \begin_layout Plain Layout
7755 and then specify the program arguments as
7756 \begin_inset Flex Code
7759 \begin_layout Plain Layout
7766 In this way, you will be using the
7770 for communicating with \SpecialChar LyX
7772 If, for whatever reason, you want to use the
7777 \begin_inset Flex Code
7780 \begin_layout Plain Layout
7786 option and be sure to specify the \SpecialChar LyX
7787 Server pipe path in the \SpecialChar LyX
7791 \begin_layout Standard
7792 In yap, reverse search is triggered by double-click.
7795 \begin_layout Subsubsection*
7799 \begin_layout Standard
7800 In order to use SumatraPDF for inverse search, enter
7801 \begin_inset Flex Code
7804 \begin_layout Plain Layout
7805 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7810 in the viewer setting in
7811 \begin_inset Flex Noun
7814 \begin_layout Plain Layout
7815 Preferences\SpecialChar menuseparator
7816 File Handling\SpecialChar menuseparator
7817 File formats\SpecialChar menuseparator
7824 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7826 \begin_inset Flex Code
7829 \begin_layout Plain Layout
7835 enables communication via the
7841 \begin_inset Flex Code
7844 \begin_layout Plain Layout
7850 option if you want to use the
7854 , and be sure to specify the \SpecialChar LyX
7855 Server pipe path in the \SpecialChar LyX
7859 \begin_layout Standard
7860 Reverse search is triggered by double-click.
7863 \begin_layout Section
7867 \begin_layout Standard
7868 Forward search is, as the name implies, in a sense the
7869 \begin_inset Quotes eld
7873 \begin_inset Quotes erd
7877 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7879 If forward search is set up (as described in what follows), you can put
7880 the cursor anywhere in your \SpecialChar LyX
7882 \begin_inset Flex Noun
7885 \begin_layout Plain Layout
7886 Navigate\SpecialChar menuseparator
7893 \begin_inset Flex Noun
7896 \begin_layout Plain Layout
7902 in the context menu via right mouse click), and then the viewer will jump
7903 to that position as well.
7904 This implies, of course, that your viewer supports this function.
7907 \begin_layout Standard
7908 To make forward search possible, you first need to provide the generated
7909 output PDF/DVI file with additional information about the \SpecialChar TeX
7911 This can be done via the methods described in the section
7912 \begin_inset CommandInset ref
7914 reference "subsec:rev-search"
7921 \begin_layout Standard
7922 Additionally, you need to configure \SpecialChar LyX
7923 for using your viewers in
7924 \begin_inset Flex Noun
7927 \begin_layout Plain Layout
7928 Tools\SpecialChar menuseparator
7929 Preferences\SpecialChar menuseparator
7930 Output\SpecialChar menuseparator
7937 We provide a range of tested configurations for some viewers, which you
7938 can select from the drop down list.
7939 If none of these configurations suits you, you have to find out and enter
7940 a suitable configuration yourself.
7941 The definition syntax uses the following placeholders:
7944 \begin_layout Itemize
7946 \begin_inset Flex Code
7949 \begin_layout Plain Layout
7958 \begin_layout Itemize
7960 \begin_inset Flex Code
7963 \begin_layout Plain Layout
7969 : name of the (temporary) exported .tex file (without path)
7972 \begin_layout Itemize
7974 \begin_inset Flex Code
7977 \begin_layout Plain Layout
7983 : name of the (temporary) exported .tex file (including path)
7986 \begin_layout Itemize
7988 \begin_inset Flex Code
7991 \begin_layout Plain Layout
7997 : name of the exported output file (either dvi or pdf, depending on which
7998 one exists in the temporary directory)
8001 \begin_layout Standard
8002 Note that only some of the viewers provide full and usable forward search
8003 functionality out of the box, among them yap, xdvi, okular
8007 \begin_layout Plain Layout
8008 You might want to set
8009 \begin_inset Flex Code
8012 \begin_layout Plain Layout
8019 \begin_inset Flex Noun
8022 \begin_layout Plain Layout
8023 Tools\SpecialChar menuseparator
8024 Preferences\SpecialChar menuseparator
8025 File Handling\SpecialChar menuseparator
8027 \begin_inset space ~
8040 , qpdfview, and SumatraPDF
8044 \begin_layout Plain Layout
8045 SumatraPDF can also use DDE commands through the external program CMCDDE
8047 \begin_inset CommandInset href
8049 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8060 Others, such as evince
8064 \begin_layout Plain Layout
8065 Forward search with evince can be achieved by means of third party helper
8068 \begin_inset CommandInset href
8070 target "http://wiki.lyx.org/LyX/SyncTeX"
8080 , require some extra tools in order to use forward search.
8081 While many of the widespread PDF viewers (most notably Adobe Reader) do
8082 not support forward search at all, some other viewers – e.
8083 \begin_inset space \thinspace{}
8087 xpdf – allow at least to reload the document and jump to a specific page
8088 of the file, so you can at least navigate
8089 \begin_inset Quotes eld
8093 \begin_inset Quotes erd
8097 This latter functionality is provided by an external call of synctex (see
8098 the predefined example configurations).
8102 \begin_layout Standard
8103 Forward search works both with DVI and PDF output.
8105 simply checks which preview format you have used before (i.
8106 \begin_inset space \thinspace{}
8109 e., which format is already there in the temporary directory) and chooses
8110 the appropriate configuration for the respective format.
8113 \begin_layout Chapter
8114 Special Document Classes
8117 \begin_layout Section
8121 \begin_layout Standard
8127 \begin_layout Subsection
8131 \begin_layout Standard
8132 This section describes how \SpecialChar LyX
8133 can be used to write articles for submission
8134 to the scientific journal
8136 Astronomy and Astrophysics
8139 \begin_inset Flex URL
8142 \begin_layout Plain Layout
8144 http://www.edpsciences.fr/aa/
8149 ) using Version 5.01 of the document class
8154 This package can be downloaded from the ftp site
8157 \begin_layout Standard
8158 \begin_inset VSpace medskip
8164 \begin_layout Standard
8166 \begin_inset Flex URL
8169 \begin_layout Plain Layout
8171 ftp://ftp.edpsciences.org/pub/aa/readme.html
8179 \begin_layout Standard
8180 \begin_inset VSpace medskip
8186 \begin_layout Standard
8187 A manual comes together with that package, and this text is not meant to
8188 replace the original manual but is merely a short guide in how to realize
8189 the correct form of your paper.
8193 \begin_layout Standard
8194 Please note that the publisher of the journal was changed from Springer
8195 to EDP Sciences starting January 1, 2001.
8196 That change involved also some slight changes to the style files, namely
8197 the removal of the thesaurus command.
8198 The \SpecialChar LyX
8199 class aa supports the newest version of these style files, V 5.01.
8200 If you have an older version installed, please upgrade.
8201 For compatibility, the old (version 4) layout has been kept as
8206 Please refer to the comments in
8209 Dir/layouts/aapaper.layout
8214 \begin_layout Subsection
8218 \begin_layout Standard
8219 It is recommended you start from the example template distributed with \SpecialChar LyX
8221 If you are not using a template, note the following settings:
8224 \begin_layout Itemize
8231 Document\SpecialChar menuseparator
8234 dialog (OK, that one was obvious).
8237 \begin_layout Itemize
8238 Don't change the option
8241 \begin_inset space ~
8251 The whole layout is done by the macros, you shouldn't change anything.
8254 \begin_layout Subsection
8258 \begin_layout Standard
8259 First thing to enter is the header information.
8260 It consists of seven entries, of which some are optional.
8264 \begin_layout Itemize
8272 \begin_layout Itemize
8280 \begin_layout Itemize
8288 \begin_layout Itemize
8296 \begin_layout Itemize
8301 : [optional] if more than one author: whom to contact for offprint requests.
8304 \begin_layout Itemize
8309 : [optional] mail address for contacts.
8312 \begin_layout Itemize
8320 Received: <date>; Accepted <date>
8323 \begin_layout Standard
8324 There is no need to issue the
8330 command, this is done automatically by \SpecialChar LyX
8331 when the header is finished.
8332 Although the order of the single header entries doesn't matter it is advised
8333 to keep the above sequence, just to get the best optics and meets the layout
8334 of the real document.
8337 \begin_layout Standard
8338 If you want to place footnotes in the header block, e.
8339 \begin_inset space \thinspace{}
8343 \begin_inset space \space{}
8346 to state your present address, just use the standard footnote via the menu
8349 Insert\SpecialChar menuseparator
8354 will automagically use the term
8363 \begin_layout Standard
8364 In addition to these topics, the macros use three additional \SpecialChar LaTeX
8366 have no counterpart in \SpecialChar LyX
8370 \begin_layout Itemize
8377 to separate different names for more than one author and institute, respectivel
8381 \begin_layout Itemize
8388 to mark corresponding author/institute pairs.
8389 The institutes are numbered sequentially as they appear in the
8393 field, so you have to put a marker to each author.
8396 \begin_layout Itemize
8403 to supply an email address for fast contact.
8406 \begin_layout Standard
8407 In all cases, the appropriate command has to be entered in \SpecialChar LyX
8415 \begin_layout Subsection
8419 \begin_layout Standard
8420 The abstract should immediately follow the header block.
8421 With version 5 the abstract environment was changed to a command, and there
8422 is now a resctriction to only one paragraph.
8423 In addition, it should contain an entry with the keywords.
8424 This is not yet implemented for \SpecialChar LyX
8425 , therefore you have to enter the \SpecialChar LaTeX
8433 by hand and mark it as \SpecialChar LaTeX
8435 Refer to the example paper.
8438 \begin_layout Subsection
8439 Supported environments
8442 \begin_layout Standard
8443 The A&A paper layout supports the following environments for structuring
8447 \begin_layout Itemize
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
8520 \begin_layout Subsection
8521 Commands not supported by \SpecialChar LyX
8525 \begin_layout Standard
8526 Some commands are not yet supported by the
8530 layout for \SpecialChar LyX
8532 Some have already been mentioned.
8533 For the sake of completeness, they are listed all together here:
8536 \begin_layout Itemize
8544 \begin_layout Itemize
8552 \begin_layout Itemize
8560 \begin_layout Itemize
8568 \begin_layout Itemize
8576 \begin_layout Itemize
8584 \begin_layout Itemize
8592 \begin_layout Itemize
8600 \begin_layout Standard
8601 If you want to use any of these commands, you have to enter them yourself.
8604 Do not forget to mark them as \SpecialChar LaTeX
8608 \begin_layout Subsection
8609 Figure and Table Floats
8612 \begin_layout Standard
8614 provides support for the necessary float environments
8616 figure, figure*, table
8622 , therefore we won't tell much about it here.
8626 \begin_inset space ~
8632 Just remember that tables should be left-aligned.
8633 For that, select the table and change the alignment in
8635 Edit\SpecialChar menuseparator
8637 \begin_inset space ~
8643 \begin_layout Standard
8644 There is only one special thing: the figures with caption besides the figure.
8645 To create such a figure, you have to do the following:
8648 \begin_layout Enumerate
8649 Create a wide figure float:
8651 Insert\SpecialChar menuseparator
8652 Float\SpecialChar menuseparator
8655 , then right click in the figure and select
8658 \begin_inset space ~
8666 \begin_layout Enumerate
8667 Enter your caption text.
8670 \begin_layout Enumerate
8675 to move the cursor above the caption.
8678 \begin_layout Enumerate
8682 \begin_layout Enumerate
8683 Position the cursor behind the figure and insert a horizontal fill:
8685 Insert\SpecialChar menuseparator
8687 \begin_inset space ~
8690 Character\SpecialChar menuseparator
8692 \begin_inset space ~
8700 \begin_layout Enumerate
8701 Switch to \SpecialChar LaTeX
8705 \begin_inset space ~
8713 \begin_layout Enumerate
8723 Do not close the brace!
8726 \begin_layout Enumerate
8727 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8732 \begin_inset space ~
8744 \begin_layout Standard
8745 Also, refer to the figures in the example paper.
8748 \begin_layout Subsection
8752 \begin_layout Standard
8753 For submission, the paper has to be formated in a special double-spacing
8755 For this purpose, you have to give the option
8759 to the documentclass.
8760 This must be done using the extra class options field in the
8762 Document\SpecialChar menuseparator
8766 Just enter the string
8773 \begin_layout Subsection
8777 \begin_layout Standard
8782 directory contains an example paper written with \SpecialChar LyX
8784 It is the example paper from the original macro package, translated to
8787 Use it for inspiration, and compare the original \SpecialChar LaTeX
8788 code with \SpecialChar LyX
8792 \begin_layout Section
8797 \begin_layout Standard
8803 \begin_layout Subsection
8807 \begin_layout Standard
8809 is a set of macros produced by the American Astronomical Society to
8810 facilitate electronic manuscript submission to the three journals they
8811 publish: the Astrophysical Journal (including the Letters and Supplement),
8812 the Astronomical Journal, and the Publications of the Astronomical Society
8815 has proven to be an excellent tool for generating these documents, especially
8816 given its equation, citation, and figure handling capabilities.
8818 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8819 is the version described here, or higher.
8820 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8821 2.09 and are fundamentally
8822 incompatible with \SpecialChar LyX
8824 The AAS\SpecialChar TeX
8825 package may be downloaded from the AAS\SpecialChar TeX
8829 \begin_layout Standard
8830 \begin_inset VSpace medskip
8836 \begin_layout Standard
8838 \begin_inset Flex URL
8841 \begin_layout Plain Layout
8843 https://aas.org/aastex/aastex-downloads
8851 \begin_layout Standard
8852 \begin_inset VSpace medskip
8858 \begin_layout Standard
8859 A complete user guide is contained in that package and you should familiarize
8860 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8863 will not reduce the need to figure out all the AAS\SpecialChar TeX
8864 commands, it will only
8865 reduce the drudgery of typing everything in.
8866 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8868 completely to the requirements of the journal to which you are submitting
8872 \begin_layout Subsection
8873 Starting a New Paper
8876 \begin_layout Standard
8877 I strongly suggest that you start with the AAS\SpecialChar TeX
8881 File\SpecialChar menuseparator
8888 , enter the new file name, then choose the
8893 This will show the most common fields found in a manuscript.
8894 Simply overwrite the existing text (including the brackets,
8898 ) with the correct information.
8899 Many of the AAS\SpecialChar TeX
8900 commands and environments can be implemented directly in
8902 , but some cannot: most noticeably
8914 , which should stick out like a sore thumb if you actually just opened the
8916 For commands such as these, the \SpecialChar LaTeX
8917 code must be entered directly and marked
8919 Such commands are referred to as \SpecialChar TeX
8920 code, or Evil Red Text.
8921 I tried to minimize the amount of \SpecialChar TeX
8922 code needed in an AAS\SpecialChar TeX
8924 there is still a bit more required than any of us would like.
8927 \begin_layout Subsection
8928 Finishing Your Paper
8931 \begin_layout Standard
8932 When the paper is finished to your satisfaction and previews/prints correctly,
8934 \begin_inset Quotes eld
8938 \begin_inset Quotes erd
8941 actions which need to be done before you submit it to the journals.
8945 \begin_layout Enumerate
8946 Export your paper as a \SpecialChar LaTeX
8949 File\SpecialChar menuseparator
8950 Export\SpecialChar menuseparator
8958 \begin_layout Enumerate
8963 file with your favorite text editor
8967 \begin_layout Enumerate
8968 remove the comment lines before the
8977 \begin_layout Enumerate
8982 usepackage...{fontenc}
8984 line if it appears (usually just after
8999 \begin_layout Enumerate
9000 remove everything between (and including) the
9012 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9014 (which should appear immediately after the
9015 \begin_inset Quotes eld
9018 User specified \SpecialChar LaTeX
9020 \begin_inset Quotes erd
9031 \begin_layout Enumerate
9032 Run the resulting file through \SpecialChar LaTeX
9033 to make sure it still processes correctly.
9036 \begin_layout Enumerate
9037 Reread the journal requirements to make sure your filenames and formats
9041 \begin_layout Enumerate
9045 \begin_layout Subsection
9046 Comments On Specific Commands
9049 \begin_layout Standard
9050 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9057 ) gives a good description of each.
9058 Thus it's probably easiest for me to go down the list as found in the guide
9059 and offer comments where necessary.
9060 So let's begin \SpecialChar ldots
9064 \begin_layout Subsubsection
9065 Things that work as expected
9068 \begin_layout Standard
9069 Because they work as you might expect, I simply list them and the section
9170 begin{thebibliography}
9178 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9179 graphicx figure commands (2.14.1),
9203 (2.15.4, amongst other places),
9230 \begin_layout Standard
9231 The following style options also work correctly:
9252 Simply put them in the
9258 Layout\SpecialChar menuseparator
9264 \begin_layout Subsubsection
9265 Things that work, but require more comment
9268 \begin_layout Standard
9269 The following items work, but require a little more discussion:
9272 \begin_layout Itemize
9273 These items are reserved for use by the journal editors, but you can put
9274 them into the \SpecialChar LaTeX
9275 preamble if you feel compelled to do so:
9308 \begin_layout Itemize
9309 These items may be placed in the \SpecialChar LaTeX
9310 preamble, and are included as blanks in
9332 \begin_layout Itemize
9339 (2.3) – can only be used
9340 \begin_inset Quotes eld
9344 \begin_inset Quotes erd
9347 , not in the middle of a paragraph.
9348 Use \SpecialChar TeX
9349 code if you need to embed it.
9352 \begin_layout Itemize
9359 (2.3) – will have extra {} after it.
9360 This should not cause an error.
9363 \begin_layout Itemize
9370 (2.6) – can only be used
9371 \begin_inset Quotes eld
9375 \begin_inset Quotes erd
9378 , not in the middle of a paragraph.
9379 Use \SpecialChar TeX
9380 code if you need to embed it.
9383 \begin_layout Itemize
9390 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9394 \begin_layout Itemize
9408 \begin_layout Itemize
9415 (2.9) – will have extra {} after it.
9416 This should not cause an error.
9419 \begin_layout Itemize
9426 (2.11) – will have extra {} after it.
9427 This should not cause an error.
9430 \begin_layout Itemize
9437 (2.14.2) – you can insert an optional filename argument by placing the cursor
9438 at the beginning of the text and selecting
9440 Insert\SpecialChar menuseparator
9445 \begin_inset Quotes eld
9449 \begin_inset Quotes erd
9452 inserts an optional argument of the type needed by
9459 Hopefully it will be renamed someday.
9462 \begin_layout Itemize
9475 for the catalog ID optional parameter
9478 \begin_layout Itemize
9491 for the catalog ID optional parameter
9494 \begin_layout Subsubsection
9495 Things not implemented, use \SpecialChar TeX
9499 \begin_layout Standard
9522 setcounter{equation}
9524 (2.12), Journal name abbreviations (2.13.4),
9560 (2.15.4, insert it as the first element in the lefthand cell after where
9562 Don't use any of \SpecialChar LyX
9563 's rules in the table),
9575 (2.15.5), much of Misc (2.17, except
9626 \begin_layout Subsubsection
9627 Things that cannot be implemented
9630 \begin_layout Standard
9632 at least in any meaningful sort of way, so I suggest ignoring them.
9633 They are the references environment (2.13.3), and the deluxetable environment
9635 If you really, really need to use deluxetable, I suggest editing it in
9636 a separate file with a text editor, then using
9638 Insert\SpecialChar menuseparator
9640 \begin_inset space ~
9645 to include it in your \SpecialChar LyX
9651 file to see an example of this.
9654 \begin_layout Subsection
9655 FAQs, Tips, Tricks, and Other Ruminations
9658 \begin_layout Subsubsection
9659 Getting \SpecialChar LyX
9660 and AAS\SpecialChar TeX
9664 \begin_layout Standard
9665 It can be a bit tricky to get \SpecialChar LyX
9666 to recognize a new layout and document class.
9667 When all else fails, do this:
9670 \begin_layout Enumerate
9671 Make certain that \SpecialChar LaTeX
9672 can find AAS\SpecialChar TeX
9674 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9676 directory completely unrelated to \SpecialChar LaTeX
9677 or AAS\SpecialChar TeX
9678 and run \SpecialChar LaTeX
9686 \begin_layout Enumerate
9691 appears in \SpecialChar LyX
9699 \begin_layout Enumerate
9702 Tools\SpecialChar menuseparator
9706 , then restart \SpecialChar LyX
9710 \begin_layout Enumerate
9711 Open a regular new file, not from a template.
9712 Does AAS\SpecialChar TeX
9713 appear in the class list in
9715 Document\SpecialChar menuseparator
9721 \begin_layout Standard
9722 If you get a warning from an existing AAS\SpecialChar TeX
9723 document about not being able
9724 to find the AAS\SpecialChar TeX
9725 layout or a message about
9726 \begin_inset Quotes eld
9729 You should not mix title layouts with normal ones
9730 \begin_inset Quotes erd
9733 , things haven't been installed correctly.
9736 \begin_layout Subsubsection
9738 error processing a table
9741 \begin_layout Standard
9743 , by default, attempts to center the table caption/title.
9744 This seems to produce a bad interaction in AAS\SpecialChar TeX
9745 so you should click somewhere
9746 in the caption/title, then select
9748 Edit\SpecialChar menuseparator
9750 \begin_inset space ~
9764 This took care of it for me.
9767 \begin_layout Subsubsection
9771 \begin_layout Standard
9772 A couple of things: 1) I have noticed some funny spacing in the reference
9773 entries in the text.
9774 When you enter the bibliography item data, make sure their is
9778 space between the last author and the parenthesis setting off the year;
9782 \begin_inset space \thinspace{}
9786 \begin_inset space \space{}
9800 2) Entering the references at all is not obvious.
9801 The easiest thing is to start typing your first reference at the end of
9802 the document, then mark it as type
9807 That will put a small gray box in front of what you just typed.
9808 Click on the box to fill in the rest of the information.
9809 For new references, go to the end of an existing reference and press return.
9810 That will create a new line with its own box, etc.
9813 \begin_layout Subsubsection
9817 \begin_layout Standard
9818 Even though AAS\SpecialChar TeX
9819 provides its own figure commands (
9825 , for example), I much prefer \SpecialChar LaTeX
9826 's standard figure commands (with the default
9835 \begin_inset space ~
9838 commands as \SpecialChar TeX
9839 code into a Figure Float box if you desire, but I never have
9840 much luck getting the layout right.
9841 With the standard graphics, \SpecialChar LyX
9846 usepackage{graphicx}
9848 command into the \SpecialChar LaTeX
9849 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9851 interspersing the figures in the text.
9852 I believe ApJ accepts figures exactly this way now; AJ might still use
9854 \begin_inset Quotes eld
9857 stack everything at the end
9858 \begin_inset Quotes erd
9864 \begin_layout Subsubsection
9865 Things I could have done, but didn't
9868 \begin_layout Standard
9870 \begin_inset Quotes eld
9874 \begin_inset Quotes erd
9877 things I could have implemented, but chose not to.
9878 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9880 even though it is double-spaced in the paper manuscript.
9881 Also, I chose not to make separate layouts for the preprint and preprint2
9883 Since I assume you will spend most of your time in the plain manuscript
9884 mode anyway, I decided not to chew up more disk space with this.
9888 \begin_layout Subsection
9892 \begin_layout Standard
9893 Your mileage may vary.
9894 I've now had papers published by both ApJ and AJ that have had 98% of the
9895 effort done in \SpecialChar LyX
9896 ; the last 2% was the \SpecialChar LaTeX
9897 post-processing and a few cleanups.
9898 I have had no trouble with the submission process, and I'm sure the journals
9899 were never aware that there might be a difference.
9900 So, go forth and publish!
9903 \begin_layout Section
9904 AMS \SpecialChar LaTeX
9908 \begin_layout Standard
9918 \begin_layout Standard
9919 \begin_inset VSpace bigskip
9925 \begin_layout Standard
9927 The AMS \SpecialChar LaTeX
9928 layouts are set up to conform to suggested styles for mathematical
9929 papers to be submitted to American Mathematical Society publications.
9930 The layouts are not tailored to a specific journal, but easily can be.
9931 You should refer to the AMS documentation for specific instructions for
9932 each journal (usually it will entail only changing a single line in the
9935 That documentation is available on the Web at
9936 \begin_inset Flex URL
9939 \begin_layout Plain Layout
9947 \begin_inset Flex URL
9950 \begin_layout Plain Layout
9952 ftp://ftp.ams.org/pub/tex/amslatex/
9958 These layouts are appropriate, and useful, for any mathematical writing.
9962 \begin_layout Standard
9963 There are two basic AMS \SpecialChar LaTeX
9967 \begin_layout Itemize
9968 amsart: The standard AMS article format.
9971 \begin_layout Itemize
9972 amsbook: the standard AMS book (really, monograph) format.
9976 \begin_layout Standard
9977 The layouts themselves contain only the minimum necessary to use the AMS
9979 They do not, in particular, contain any of the `theorem' environments used
9980 for setting theorems, lemmas, and the like.
9981 These are contained, instead, in the
9982 \begin_inset Flex Code
9985 \begin_layout Plain Layout
9991 module, which is loaded by default when you select one of the AMS classes.
9992 (It can also be used with other classes and can be removed, if you would
9993 rather use something else.) Less commonly used environments are in the
9994 \begin_inset Flex Code
9997 \begin_layout Plain Layout
9998 Theorems (AMS-Extended)
10003 module, which must be loaded manually.
10006 \begin_layout Standard
10007 By default, theorems and the like are numbered consecutively throughout
10008 the document, but this may be modified by loading the module
10009 \begin_inset Flex Code
10012 \begin_layout Plain Layout
10013 Theorems (Order by Section)
10018 or, if you are using
10019 \begin_inset Flex Code
10022 \begin_layout Plain Layout
10029 \begin_inset Flex Code
10032 \begin_layout Plain Layout
10033 Theorems (Order by Chapter)
10039 These will number the results as
10040 \begin_inset Formula $n.m$
10043 , where the first number refers to the section (or chapter) and the second
10044 refers to the total number of results so far in that section (or chapter).
10045 Many environments are also available unnumbered.
10046 These are indicated by an asterisk at the end.
10047 If you happen to want
10051 unnumbered results, the module
10052 \begin_inset Flex Code
10055 \begin_layout Plain Layout
10061 provides that option.
10064 \begin_layout Standard
10065 Note that these modules do not
10069 to be used with the AMS classes.
10070 It is perfectly possible to use the
10071 \begin_inset Flex Code
10074 \begin_layout Plain Layout
10080 module, and the others mentioned, with other classes, such as
10081 \begin_inset Flex Code
10084 \begin_layout Plain Layout
10091 \begin_inset Flex Code
10094 \begin_layout Plain Layout
10101 \begin_inset Flex Code
10104 \begin_layout Plain Layout
10113 \begin_layout Subsection
10114 What these layouts provide
10117 \begin_layout Standard
10118 There is a long list of included environments provided by these layouts.
10119 In AMS-\SpecialChar LaTeX
10120 , there is, in fact, an opportunity to define an unlimited variety
10121 of `theorem' environments.
10122 However, the AMS recommends the environments that are available in \SpecialChar LyX
10127 \begin_layout Standard
10128 The following environments—as well as the standard environments, such as
10130 \begin_inset Flex Noun
10133 \begin_layout Plain Layout
10140 \begin_inset Flex Noun
10143 \begin_layout Plain Layout
10150 \begin_inset Flex Noun
10153 \begin_layout Plain Layout
10160 \begin_inset Flex Noun
10163 \begin_layout Plain Layout
10170 \begin_inset Flex Noun
10173 \begin_layout Plain Layout
10180 \begin_inset Flex Code
10183 \begin_layout Plain Layout
10190 \begin_inset Flex Code
10193 \begin_layout Plain Layout
10202 \begin_layout Description
10203 Address This should be the author's permanent address.
10206 \begin_layout Description
10208 \begin_inset space ~
10211 Address This should be the author's temporary address at the time of submission,
10212 if different from the Address.
10215 \begin_layout Description
10216 Email Author's e-mail address
10219 \begin_layout Description
10220 URL Author's Web address, if desired.
10223 \begin_layout Description
10224 Keywords Key words or phrases used to identify specific topics discussed
10228 \begin_layout Description
10229 Subjectclass These refer to the AMS Subject Classifications, published and
10232 Mathematical Reviews
10235 These are also available online at the AMS cites listed above.
10238 \begin_layout Description
10242 \begin_layout Description
10246 \begin_layout Description
10250 \begin_layout Standard
10251 The following environments are provided by both the
10252 \begin_inset Flex Code
10255 \begin_layout Plain Layout
10262 \begin_inset Flex Code
10265 \begin_layout Plain Layout
10271 modules, in the latter case in both starred (unnumbered) and unstarred
10272 (numbered) versions.
10273 These same environments are provided only in the starred versions by the
10275 \begin_inset Flex Code
10278 \begin_layout Plain Layout
10287 \begin_layout Theorem
10288 This is typically used for the statements of major results.
10292 \begin_layout Corollary*
10293 This is used for statements which follow fairly directly from previous statement
10295 Again, these can be major results.
10299 \begin_layout Lemma
10300 These are smaller results needed to prove other statements.
10303 \begin_layout Proposition
10304 These are less major results which (hopefully) add to the general theory
10308 \begin_layout Conjecture
10309 These are statements provided without justification, which the author does
10310 not know how to prove, but which seem to be true (to the author, at least).
10313 \begin_layout Definition*
10314 Guess what this is for.
10315 The font is different for this environment than for the previous ones.
10319 \begin_layout Example*
10320 Used for examples illustrating proven results.
10323 \begin_layout Problem
10324 It's not really known what this is for.
10325 You should figure it out.
10328 \begin_layout Exercise*
10329 Write a description for this one.
10332 \begin_layout Remark
10333 This environment is also a type of theorem, usually a lesser sort of observation.
10336 \begin_layout Claim*
10337 Often used in the course of giving a proof of a larger result.
10341 Generally, these are used to break up long arguments, using specific instances
10347 The numbering scheme for cases is on its own, not together with other numbered
10352 \begin_layout Proof
10353 At the end of this environment, a QED symbol (usually a square, but it can
10354 vary with different styles) is placed.
10355 If you want to have other environments within this one—for example, Case
10356 environments—and have the QED symbol appear only after them, then the other
10357 environments need to be nested within the proof environment.
10360 Nesting Environments
10366 for information on nesting.
10369 \begin_layout Standard
10370 And these environments are provided by
10371 \begin_inset Flex Code
10374 \begin_layout Plain Layout
10375 Theorems (AMS-Extended)
10383 \begin_layout Criterion*
10384 A required condition.
10387 \begin_layout Algorithm*
10388 A general procedure to be used.
10391 \begin_layout Axiom*
10392 This is a property or statement taken as true within the system being discussed.
10395 \begin_layout Condition*
10396 Sometimes used to state a condition assumed within the present context of
10400 \begin_layout Note*
10401 Similar to a Remark.
10404 \begin_layout Notation*
10405 Used for the explanation of, yes, notation.
10408 \begin_layout Summary
10409 Do we really need to tell you?
10412 \begin_layout Acknowledgement*
10416 \begin_layout Conclusion*
10417 Sometimes used at the end of a long train of argument.
10421 Used in a way similar to Proposition, though perhaps lower on the scale.
10424 \begin_layout Standard
10425 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10428 They need to be available on your system in order to use these environments.
10431 \begin_layout Section
10439 \begin_layout Standard
10445 \begin_layout Subsection
10449 \begin_layout Standard
10450 These are the layout files for some of the journals of the American Geophysical
10452 It is assumed that you have both the AGU's own class files and AGUplus
10453 installed (everything to be found at
10454 \begin_inset Flex URL
10457 \begin_layout Plain Layout
10459 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10467 \begin_layout Subsection
10471 \begin_layout Standard
10481 They are still called this in the \SpecialChar LyX
10482 GUI, though their \SpecialChar LaTeX
10495 \begin_layout Standard
10496 Newly defined styles are
10533 These are mostly manuscript attributes and defined in the AGU class documentati
10537 \begin_layout Standard
10538 I suspect this is still badly incomplete.
10541 \begin_layout Subsection
10545 \begin_layout Standard
10562 \begin_layout Subsection
10566 \begin_layout Itemize
10569 Journal of Geophysical Research
10578 \begin_layout Standard
10579 Add your own, it isn't so hard! Look at the
10590 \begin_layout Subsection
10591 Bugs and things to remember
10594 \begin_layout Standard
10595 In order to use the new layouts, you must remember to do the following for
10599 \begin_layout Enumerate
10605 This can be done in the
10607 Layout\SpecialChar menuseparator
10612 Document\SpecialChar menuseparator
10616 (AGU articles are always in English, right? So
10620 choose a language.)
10623 \begin_layout Enumerate
10628 into the document's
10633 (Yes, this is a bug.)
10636 \begin_layout Enumerate
10637 Make sure you use the
10641 bibliography style, by entering
10645 into the second field of the Bib\SpecialChar TeX
10647 None of the standard styles will do.
10650 \begin_layout Section
10654 \begin_layout Standard
10660 \begin_layout Subsection
10664 \begin_layout Standard
10665 Broadway is for writing plays.
10666 The format is more decorative than Hollywood, and much less standardized.
10667 This format should be suitable for workshops.
10670 \begin_layout Subsection
10674 \begin_layout Standard
10675 The same as in Hollywood.
10678 \begin_layout Subsection
10682 \begin_layout Standard
10687 names as labels then cross-reference the label to insert the name.
10688 The cross-reference dialog will show the current cast of characters.
10691 \begin_layout Subsection
10692 Paper size and Margins
10695 \begin_layout Standard
10696 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10699 \begin_layout Subsection
10703 \begin_layout Standard
10704 The following environments are available.
10705 You can use broadway.bind to get the bind keys shown at the right.
10708 \begin_layout Itemize
10712 \begin_inset Newline newline
10717 You should not have to use this, but it is here for anything that does not
10721 \begin_layout Itemize
10725 \begin_inset space \hfill{}
10729 \begin_inset Newline newline
10734 Used to describe stage setting and the action.
10735 First use of speaker names in all CAPs.
10738 \begin_layout Itemize
10742 \begin_inset space \hfill{}
10746 \begin_inset Newline newline
10751 Automatically numbered.
10752 On screen it will be arabic, but will print as Roman.
10755 \begin_layout Itemize
10759 \begin_inset space \hfill{}
10763 \begin_inset Newline newline
10773 It is just centered text.
10776 \begin_layout Itemize
10780 \begin_inset space \hfill{}
10784 \begin_inset Newline newline
10789 Not automatically numbered.
10790 You supply the number.
10791 This is because I couldn't figure out how.
10794 \begin_layout Itemize
10798 \begin_inset space \hfill{}
10802 \begin_inset Newline newline
10807 A special case of Narrative to describe the setting and action as the curtain
10811 \begin_layout Itemize
10815 \begin_inset space \hfill{}
10819 \begin_inset Newline newline
10824 The speaker's (actor's) title, centered in all CAPS.
10827 \begin_layout Itemize
10831 \begin_inset space \hfill{}
10835 \begin_inset Newline newline
10840 Instructions to the speaker.
10841 The parentheses are automatically inserted.
10842 The ( will appear on screen, but both will be in the printed play.
10843 This environment is only used within
10850 \begin_layout Itemize
10854 \begin_inset space \hfill{}
10858 \begin_inset Newline newline
10863 What the Speaker says.
10866 \begin_layout Itemize
10870 \begin_inset space \hfill{}
10874 \begin_inset Newline newline
10879 The curtain comes down.
10882 \begin_layout Itemize
10886 \begin_inset space \hfill{}
10892 \begin_layout Itemize
10896 \begin_inset space \hfill{}
10902 \begin_layout Itemize
10906 \begin_inset space \hfill{}
10912 \begin_layout Standard
10916 \begin_layout Section
10920 \begin_layout Standard
10925 can be used to type letters according to German conventions.
10926 A template file is included in
10928 .../lyx/share/templates
10930 for you to use as a starting point.
10933 \begin_layout Section
10941 \begin_layout Standard
10947 \begin_layout Subsection
10951 \begin_layout Standard
10952 This is the layout file for the European Geophysical Society journals.
10957 can be downloaded from the web site of the EGS under
10958 \begin_inset Flex URL
10961 \begin_layout Plain Layout
10971 \begin_layout Subsection
10975 \begin_layout Standard
10978 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10986 The current layout file is unfortunately very unmodular and would benefit
10987 from using the various
10994 \begin_layout Section
10998 \begin_layout Standard
10999 See the \SpecialChar LyX
11005 It contains all infos you need.
11008 \begin_layout Section
11011 Foil\SpecialChar TeX
11015 \begin_inset CommandInset label
11024 \begin_layout Standard
11030 \begin_layout Subsection
11034 \begin_layout Standard
11035 This section describes how to use \SpecialChar LyX
11036 to make slides for overhead projectors.
11037 There are two document classes that can do this: the default slides class
11040 Foil\SpecialChar TeX
11044 This section documents the latter.
11047 \begin_layout Standard
11048 I'm going to say this again, nice and clear, so that there's no misunderstanding
11052 \begin_layout Standard
11053 \begin_inset VSpace bigskip
11059 \begin_layout Standard
11063 This section documents the class
11064 \begin_inset Quotes eld
11072 \begin_inset Quotes erd
11080 \begin_layout Standard
11081 \begin_inset VSpace bigskip
11087 \begin_layout Standard
11088 If you're looking for the documentation for
11089 \begin_inset Quotes eld
11097 \begin_inset Quotes erd
11100 , check out section
11101 \begin_inset space ~
11105 \begin_inset CommandInset ref
11107 reference "sec:slitex"
11112 If your machine doesn't have the
11120 installed, you'll probably have to use the default
11124 class, which isn't quite as good as
11129 \begin_layout Standard
11134 class is designed for use with version
11135 \begin_inset space ~
11143 class file which is now an integral part of \SpecialChar LaTeX2e
11147 \begin_layout Subsection
11151 \begin_layout Standard
11152 Obviously, to use this document class, you need to select
11163 \begin_inset space ~
11169 There are some settings in the
11172 \begin_inset space ~
11177 dialog that you should know about that are specific to this class:
11180 \begin_layout Itemize
11181 Don't change the options
11192 \begin_inset space ~
11198 They're ignored by the
11205 \begin_layout Itemize
11206 The default font size is 20
11207 \begin_inset space \thinspace{}
11210 pt with the other options being 17
11211 \begin_inset space \thinspace{}
11215 \begin_inset space \thinspace{}
11219 \begin_inset space \thinspace{}
11225 \begin_layout Itemize
11226 The default font is
11234 but all math equations are still typeset in the usual roman font.
11237 \begin_layout Itemize
11240 Foil\SpecialChar TeX
11243 supports A4 and Letter paper sizes as well as a special size for working
11245 \begin_inset space \thinspace{}
11249 It doesn't support A5, B5, legal or executive paper sizes.
11252 \begin_layout Itemize
11253 Don't bother changing the
11257 settings because they are ignored anyway.
11258 All floats appear where they are defined in the text.
11261 \begin_layout Itemize
11266 setting behaves a bit differently for this class.
11269 Foil\SpecialChar TeX
11272 provides extensive footer and header capabilities including a user-defined
11275 \begin_inset space ~
11279 \begin_inset CommandInset ref
11281 reference "sec:foilfoot"
11286 The title page is treated differently to all other pages in the document
11295 has the logo centered at the bottom of the page (if one is defined).
11296 The possible page style choices and what they do are as follows:
11300 \begin_layout Labeling
11301 \labelwidthstring MMMMMMM
11308 The final output contains no page numbers, or other headers or footers
11309 (except footnotes of course).
11313 \begin_layout Labeling
11314 \labelwidthstring MMMMMMM
11321 The final output contains page numbers centered at the bottom of the page.
11322 No other headings or footers (other than footnotes).
11325 \begin_layout Labeling
11326 \labelwidthstring MMMMMMM
11331 Page numbers in lower right corner.
11332 Additional headers and footers are also shown.
11333 This is also the default.
11336 \begin_layout Labeling
11337 \labelwidthstring MMMMMMM
11342 Gives you access to the
11346 package although its use with
11348 Foil\SpecialChar TeX
11351 is discouraged by the writer of the
11353 Foil\SpecialChar TeX
11356 package because of some potential page layout clashes.
11360 \begin_layout Subsubsection
11364 \begin_layout Standard
11365 The following options may be used in the extra class options in the
11367 Document\SpecialChar menuseparator
11373 \begin_layout Labeling
11374 \labelwidthstring MMMMMMx
11379 This sets up the page layout for 7.33
11380 \begin_inset space \thinspace{}
11384 \begin_inset space \thinspace{}
11387 in paper, which is about the same aspect ratio as a 35
11388 \begin_inset space \thinspace{}
11391 mm slide, making it a bit easier to work with this medium.
11394 \begin_layout Labeling
11395 \labelwidthstring MMMMMMx
11400 Places a rule across the page below the header on every page except the
11404 \begin_layout Labeling
11405 \labelwidthstring MMMMMMx
11410 Places a rule across the page above the footer on every page except the
11414 \begin_layout Labeling
11415 \labelwidthstring MMMMMMx
11420 This is automatically set each time you create a new
11427 Foil\SpecialChar TeX
11430 to use the dvips driver to rotate those pages that are set as landscape
11434 \begin_layout Labeling
11435 \labelwidthstring MMMMMMx
11440 Simply changes the page dimensions to those of a landscape page but doesn't
11442 Thus if you use this option you need to use an external program to rotate
11443 each page or feed your paper through your printer as landscape.
11444 Note that this option effectively reverses the roles of the
11452 environments (don't worry these are described in the next section).
11455 \begin_layout Labeling
11456 \labelwidthstring MMMMMMx
11461 Equation numbers on the left.
11464 \begin_layout Labeling
11465 \labelwidthstring MMMMMMx
11470 Flush-left equations.
11473 \begin_layout Subsection
11474 Supported Environments
11477 \begin_layout Standard
11478 Most of the environments commonly supported in other classes are also supported
11484 There are several additional environments provided by
11486 Foil\SpecialChar TeX
11489 as well as a couple added by \SpecialChar LyX
11491 The following environments are shared with other classes:
11494 \begin_layout Standard
11495 \begin_inset Flex Multiple Columns
11498 \begin_layout Itemize
11504 \begin_layout Itemize
11510 \begin_layout Itemize
11516 \begin_layout Itemize
11522 \begin_layout Itemize
11528 \begin_layout Itemize
11535 \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
11612 \begin_layout Standard
11613 That is, all the major environments apart from the sectioning environments.
11614 Since foils are essentially self-contained sections, with a title and body,
11617 Foil\SpecialChar TeX
11620 provides specific commands for starting new foils and these are:
11623 \begin_layout Itemize
11629 \begin_layout Itemize
11635 \begin_layout Standard
11637 also provides slightly modified versions of these two environments called:
11640 \begin_layout Itemize
11646 \begin_layout Itemize
11649 ShortRotatefoilhead
11652 \begin_layout Standard
11653 and the differences will be explained in the next section.
11656 \begin_layout Standard
11657 Since foils are often used in presenting ideas or new theorems and such
11660 Foil\SpecialChar TeX
11663 also provides a comprehensive box of goodies for presenting them:
11666 \begin_layout Standard
11667 \begin_inset Flex Multiple Columns
11670 \begin_layout Itemize
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
11741 \begin_layout Standard
11742 The starred versions are unnumbered while the unstarred versions are numbered.
11743 There are also two list environments added by \SpecialChar LyX
11747 \begin_layout Itemize
11753 \begin_layout Itemize
11759 \begin_layout Standard
11762 Foil\SpecialChar TeX
11765 provides some powerful header and footer capabilities that are best set
11766 in the preamble although they may be set at any point in a document.
11767 If you want to change these settings in your document the best place to
11768 do so is at the very top of a foil, i.
11769 \begin_inset space \thinspace{}
11775 \begin_inset space \space{}
11780 straight after the foilhead.
11783 \begin_layout Standard
11784 For this purpose, the following command styles are provided [
11791 \begin_layout Standard
11792 \begin_inset Flex Multiple Columns
11795 \begin_layout Itemize
11799 \begin_inset space ~
11805 \begin_layout Itemize
11811 \begin_layout Itemize
11815 \begin_inset space ~
11821 \begin_layout Itemize
11825 \begin_inset space ~
11831 \begin_layout Itemize
11835 \begin_inset space ~
11842 \begin_layout Plain Layout
11843 \begin_inset space ~
11855 \begin_layout Standard
11856 There are also a few commands provided by
11858 Foil\SpecialChar TeX
11861 that aren't directly supported by \SpecialChar LyX
11862 but I'll tell you what they do and how
11863 to use them in section
11864 \begin_inset space ~
11868 \begin_inset CommandInset ref
11870 reference "sec:unsuppfoils"
11877 \begin_layout Subsection
11878 Building a Set of Foils
11881 \begin_layout Standard
11882 This section will give a simple introduction to using the different environments
11883 to build a set of foils.
11884 If you want to see an example set of foils, take a look at the
11888 file you find in \SpecialChar LyX
11896 \begin_layout Subsubsection
11897 Give It a Title Page
11900 \begin_layout Standard
11901 Unlike other classes that provide
11921 creates the title on a page of its own.
11922 If you leave out the
11926 environment \SpecialChar LaTeX
11927 will substitute the current date (every time you regenerate
11931 \begin_layout Subsubsection
11935 \begin_layout Standard
11936 As I mentioned earlier, there are four ways of starting a new foil.
11937 For portrait foils you should use
11946 The difference between these two environments is the amount of space between
11947 the title of the foil (the foilhead) and the body of the foil.
11950 \begin_layout Standard
11951 Landscape foils are generated using the
11957 ShortRotatefoilhead
11960 Again the only difference is the spacing between foilhead and body.
11961 Both of the short versions have 0.5
11962 \begin_inset space ~
11965 inches less separation between the foilhead and the body.
11969 \begin_layout Standard
11970 One problem with the support for landscape foils is the requirement that
11971 you have to use the
11975 driver to generate the PostScript output otherwise the foils won't be rotated.
11976 It is possible to get landscape foils even if you haven't got the
11980 driver provided you can feed your foils sideways through your printer ;-)
11983 \begin_layout Subsubsection
11984 Theorems, Lemmas, Proofs and more
11987 \begin_layout Standard
11988 Due to a small bug in \SpecialChar LyX
11989 you can't have two of the same type of these environments
11990 directly following each other.
11991 They must be separated by something.
11992 If you try, you will just be extending the previous environment as if you
11993 had merged the two environments together.
11994 So, how do you get around this problem? The simplest option is to insert
11995 some text between the two environments or add a
12000 environment between the two with just a
12001 \begin_inset Quotes eld
12009 \begin_inset Quotes erd
12013 This will force \SpecialChar LyX
12014 to produce two separate environments and hence the correct
12017 An example is provided in the example file included with the \SpecialChar LyX
12019 Remember, this problem only occurs if you are trying to place two of the
12020 same type of theorem-like environments one directly after the other.
12023 \begin_layout Subsubsection
12027 \begin_layout Standard
12028 You get all the commonly supported list styles found in other classes as
12029 well as two new ones.
12030 I'll only describe the new ones here.
12031 If you want to find out more about the other list environments check out
12037 If you intend to use itemized lists you might also want to read about the
12041 \begin_inset space ~
12045 \begin_inset space ~
12050 dialog described above in section
12051 \begin_inset space ~
12055 \begin_inset CommandInset ref
12057 reference "sec:bullet"
12064 \begin_layout Standard
12065 The two new list styles,
12073 , are designed to make it easier for you to create lists of do's and don'ts
12074 or right and wrong by providing dedicated environments that use a tick
12075 or a cross as the label of the list.
12076 These lists are in fact dedicated variants of the
12081 They do however require that you have the
12085 packages installed.
12088 \begin_layout Subsubsection
12092 \begin_layout Standard
12095 Foil\SpecialChar TeX
12098 redefines the floating tables and figures so that they appear exactly where
12099 they are in the text rather than pushing them to the top of the page or
12100 to some user specified location.
12101 In fact if you change the float placement settings they are simply ignored.
12104 \begin_layout Subsubsection
12105 Page Headers and Footers
12106 \begin_inset CommandInset label
12108 name "sec:foilfoot"
12115 \begin_layout Standard
12119 \begin_inset space ~
12128 are two commands used to control the left-footer text string.
12129 The first is meant to allow you to include a graphic logo on your foils
12131 \begin_inset Quotes eld
12136 Foil\SpecialChar TeX
12140 \begin_inset Quotes erd
12144 While the second is meant to provide a classification for the audience,
12148 \begin_inset space \thinspace{}
12154 \begin_inset space \space{}
12158 It is empty by default.
12161 \begin_layout Standard
12162 The remaining page corners can be filled by
12165 \begin_inset space ~
12170 (which defaults to page numbers),
12173 \begin_inset space ~
12181 \begin_inset space ~
12189 \begin_layout Subsection
12192 Foil\SpecialChar TeX
12196 \begin_inset CommandInset label
12198 name "sec:unsuppfoils"
12205 \begin_layout Standard
12206 All the commands mentioned below need to be set in a
12216 within another environment.
12219 \begin_layout Subsubsection
12223 \begin_layout Standard
12224 All lengths are adjusted using the
12247 should be replaced by the name given to the length you want to change and
12252 is the length value.
12253 All lengths should be specified in units of length such as inches (
12265 ) or relative to some document or font-based length such as
12275 \begin_layout Standard
12276 It's possible to change the spacing between a foilhead and the body of the
12277 foil by adjusting the length specified by
12284 For example, to make
12289 \begin_inset space \space{}
12292 in closer to their bodies put the following in the preamble:
12298 foilheadskip}{-0.5in}
12301 \begin_layout Standard
12302 The spacings around floats can be adjusted by setting these lengths:
12305 \begin_layout Labeling
12306 \labelwidthstring MMMMMMMMMMM
12313 Separation between the text and the top of the float
12316 \begin_layout Labeling
12317 \labelwidthstring MMMMMMMMMMM
12324 Separation between the float and the caption
12327 \begin_layout Labeling
12328 \labelwidthstring MMMMMMMMMMM
12335 Separation between the caption and the following text
12338 \begin_layout Labeling
12339 \labelwidthstring MMMMMMMMMMM
12346 You can make the captions narrower than the surrounding text by adjusting
12348 Best done relative to
12357 \begin_layout Standard
12358 There are also several title page related lengths that you may find useful
12359 if you have a long title or several authors:
12362 \begin_layout Labeling
12363 \labelwidthstring MMMMMMMMMMM
12370 Separation from headers to
12375 \begin_layout Labeling
12376 \labelwidthstring MMMMMMMMMMM
12394 \begin_layout Labeling
12395 \labelwidthstring MMMMMMMMMMM
12409 \begin_layout Labeling
12410 \labelwidthstring MMMMMMMMMMM
12426 \begin_layout Labeling
12427 \labelwidthstring MMMMMMMMMMM
12443 \begin_layout Standard
12444 The last length related command affects all the list environments.
12455 a list environment then all the vertical spacing between the list items
12457 Note that this is a command not a length so it doesn't require
12463 like the stuff mentioned above.
12466 \begin_layout Subsubsection
12467 Headers and Footers
12470 \begin_layout Standard
12483 commands control whether the logo in the
12487 definition appear on a given page.
12494 in the preamble then none of the foils will have the logo on them.
12495 If you don't want the logo on a particular page place the
12501 directly after the foilhead of that page and the
12507 directly after the next foilhead.
12510 \begin_layout Standard
12511 If you decide to use the
12515 page style setting in the
12518 \begin_inset space ~
12523 dialog you should probably add
12533 to your preamble so headers and footers on landscape pages are correctly
12534 placed when rotated.
12535 This is due to some clashes between the page layouts provided by the
12546 \begin_layout Section
12547 Hollywood (Hollywood spec scripts)
12550 \begin_layout Standard
12556 \begin_layout Subsection
12560 \begin_layout Standard
12561 Getting the format of a Hollywood script right is a
12562 \begin_inset Quotes eld
12566 \begin_inset Quotes erd
12569 It is designed to make the readers focus on content and to be easy and
12570 familiar for the actors to read.
12571 Each page of a script should be one minute of film.
12572 Nothing goes in a script that you cannot see or hear on screen.
12573 The courier 12 pt font should be used throughout.
12577 \begin_layout Subsection
12581 \begin_layout Standard
12582 Speakers' lines should NEVER break in mid-sentence.
12583 If a speaker's lines continue over a page break, repeat the
12587 title followed by (Cont'd).
12590 \begin_layout Subsection
12594 \begin_layout Standard
12599 names as labels then cross-reference the label to insert the name.
12600 The cross-reference dialog will show the current cast of characters.
12601 You can use this to insert the speaker name in narratives also.
12604 \begin_layout Subsection
12605 Paper size and Margins
12608 \begin_layout Standard
12609 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12612 \begin_layout Subsection
12616 \begin_layout Standard
12617 The following environments are available.
12618 You can use hollywood.bind to get the bind keys shown at the right.
12621 \begin_layout Itemize
12625 \begin_inset Newline newline
12630 Used where nothing else works.
12634 \begin_layout Itemize
12640 \begin_inset space \hfill{}
12648 \begin_inset Newline newline
12651 Usually followed by something like
12652 \begin_inset Quotes eld
12655 on Sally waking up.
12656 \begin_inset Quotes erd
12662 \begin_layout Itemize
12666 \begin_inset space \hfill{}
12670 \begin_inset Newline newline
12675 Introduces a new INTERIOR camera set-up.
12676 Always followed by DAY or NIGHT, or something similar to define the lighting
12678 Everthing on this line in CAPS.
12681 \begin_layout Itemize
12685 \begin_inset space \hfill{}
12689 \begin_inset Newline newline
12694 Introduces a new EXTERIOR camera set-up.
12695 Everthing on this line in CAPS.
12698 \begin_layout Itemize
12702 \begin_inset space \hfill{}
12706 \begin_inset Newline newline
12711 The character speaking.
12714 \begin_layout Itemize
12718 \begin_inset space \hfill{}
12722 \begin_inset Newline newline
12727 Instructions to the speaker.
12728 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12730 Both will be printed.
12733 \begin_layout Itemize
12737 \begin_inset space \hfill{}
12741 \begin_inset Newline newline
12753 \begin_layout Itemize
12757 \begin_inset space \hfill{}
12761 \begin_inset Newline newline
12766 Camera movement instruction.
12768 \begin_inset space \thinspace{}
12772 \begin_inset space \space{}
12778 \begin_layout Itemize
12782 \begin_inset space \hfill{}
12788 \begin_layout Itemize
12792 \begin_inset space \hfill{}
12798 \begin_layout Itemize
12802 \begin_inset space \hfill{}
12808 \begin_layout Itemize
12812 \begin_inset space \hfill{}
12818 \begin_layout Subsection
12822 \begin_layout Itemize
12826 \begin_layout Itemize
12830 \begin_layout Itemize
12832 \begin_inset space \thinspace{}
12839 \begin_layout Itemize
12844 \begin_layout Itemize
12845 PAN — camera movement
12848 \begin_layout Itemize
12849 INSERT — cut to close-up of
12852 \begin_layout Section
12856 \begin_layout Standard
12859 Panayotis Papasotiriou
12862 \begin_layout Subsection
12866 \begin_layout Standard
12867 The ijmpc package is a set of macros that facilitates electronic manuscript
12870 International Journal of Modern Physics C
12873 Similarly, the ijmpd package is for creating manuscripts to be submitted
12876 International Journal of Modern Physics D
12879 Both journals are published by World Scientific.
12880 The corresponding document classes are named
12889 These files, together with instructions for the authors, can be downloaded
12891 \begin_inset Flex URL
12894 \begin_layout Plain Layout
12896 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12902 \begin_inset Flex URL
12905 \begin_layout Plain Layout
12907 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12913 Both packages are modified versions of the standard
12914 \begin_inset Quotes eld
12918 \begin_inset Quotes erd
12921 package, and they are almost (but not exactly) identical.
12922 Most of their features are supported by \SpecialChar LyX
12924 I have used \SpecialChar LyX
12925 successfully to write articles submitted to both journals
12926 without any problem.
12929 \begin_layout Subsection
12933 \begin_layout Standard
12934 As usual, the easiest way to write a paper is to start with a template.
12937 File\SpecialChar menuseparator
12953 This will give an (almost) empty document that includes the most common
12954 fields found in a manuscript.
12955 Simply overwrite the existing text (including the brackets,
12960 You should keep in mind the following remarks.
12963 \begin_layout Enumerate
12965 won't let you change the font size and the page style of the document,
12966 because such modifications are not allowed by both packages.
12969 \begin_layout Enumerate
12970 The language of the document should not be changed.
12971 Before previewing your paper, be sure that the babel package is not used.
12972 To do this, click on
12974 Tools\SpecialChar menuseparator
12985 checkbox in the language settings, and click on
12993 , if you wish to make this change permanent).
12996 \begin_layout Enumerate
12998 \begin_inset Quotes eld
13002 \begin_inset Quotes erd
13005 style must be used to define keywords.
13008 \begin_layout Enumerate
13009 The ijmpc package provides a style named
13010 \begin_inset Quotes eld
13013 Classification Codes
13014 \begin_inset Quotes erd
13017 , which can be used to define classification codes, such as PACS numbers.
13018 Note that this facility is not supported by the ijmpd package.
13021 \begin_layout Enumerate
13022 Several new environments are available:
13023 \begin_inset Quotes eld
13027 \begin_inset Quotes erd
13031 \begin_inset Quotes eld
13035 \begin_inset Quotes erd
13039 \begin_inset Quotes eld
13043 \begin_inset Quotes erd
13047 \begin_inset Quotes eld
13051 \begin_inset Quotes erd
13055 \begin_inset Quotes eld
13059 \begin_inset Quotes erd
13063 \begin_inset Quotes eld
13067 \begin_inset Quotes erd
13071 \begin_inset Quotes eld
13075 \begin_inset Quotes erd
13079 \begin_inset Quotes eld
13083 \begin_inset Quotes erd
13087 \begin_inset Quotes eld
13091 \begin_inset Quotes erd
13095 \begin_inset Quotes eld
13099 \begin_inset Quotes erd
13103 \begin_inset Quotes eld
13107 \begin_inset Quotes erd
13111 \begin_inset Quotes eld
13115 \begin_inset Quotes erd
13119 \begin_inset Quotes eld
13123 \begin_inset Quotes erd
13127 \begin_inset Quotes eld
13131 \begin_inset Quotes erd
13135 Their use is more or less obvious.
13137 supports all these environments; it will use the proper label, text style,
13138 and numbering scheme for each of them.
13141 \begin_layout Enumerate
13142 Both packages use basic citations; the natbib package should not be used.
13143 In \SpecialChar LyX
13144 , citation references are shown as usual; in the output, citations are
13145 shown as superscripts.
13146 If you want to use a citation as normal text, you should use the
13151 \begin_inset space \thinspace{}
13155 \begin_inset space \space{}
13159 \begin_inset Quotes eld
13163 \begin_inset space \space{}
13173 \begin_inset Quotes erd
13179 \begin_layout Enumerate
13181 \begin_inset Quotes eld
13185 \begin_inset Quotes erd
13188 section in both packages.
13189 To put acknowledgments, just use the
13190 \begin_inset Quotes eld
13194 \begin_inset Quotes erd
13200 \begin_layout Enumerate
13201 Appendices may be added to the paper,
13205 the Acknowledgments and
13211 provides a special environment, called
13212 \begin_inset Quotes eld
13216 \begin_inset Quotes erd
13219 which marks the beginning of the appendices.
13220 This environment should be left blank; it just sends a \SpecialChar LaTeX
13221 command, but nothing
13223 In \SpecialChar LyX
13225 \begin_inset Quotes eld
13229 \begin_inset Quotes erd
13232 is printed with blue letters, as a signal that all sections after that
13233 point are appendices.
13234 To write an appendix, use the
13235 \begin_inset Quotes eld
13239 \begin_inset Quotes erd
13244 will number each appendix with capital letters, as required by both journals.
13246 \begin_inset Quotes eld
13250 \begin_inset Quotes erd
13257 be present before the first appendix; if not, all appendices will be numbered
13258 as normal sections in the output.
13261 \begin_layout Enumerate
13262 The ijmpc and the ijmpd packages use the
13266 command to implement table captions.
13267 As a result, a table created by \SpecialChar LyX
13268 is printed correctly, but its caption
13270 However, you can use some \SpecialChar TeX
13271 code to overcome this problem, so that captions
13272 are printed as expected.
13273 To do so, create a float table as usual, remove the caption, and replace
13274 it with the \SpecialChar TeX
13285 (sic); you must also the \SpecialChar TeX
13290 immediately after the tabular material.
13291 Study the example table included in the template files to see how this
13292 trick is implemented.
13293 Alternatively, If you need table captions, you should implement the whole
13298 file, then include this file to the \SpecialChar LyX
13301 Insert\SpecialChar menuseparator
13302 File\SpecialChar menuseparator
13304 \begin_inset space ~
13310 Details on how to create a table float can be found in the files
13318 , included in the corresponding packages.
13321 \begin_layout Subsection
13322 Preparing a paper for submission
13325 \begin_layout Standard
13326 Before you submit your paper you must export the \SpecialChar LyX
13327 document as a \SpecialChar LaTeX
13330 File\SpecialChar menuseparator
13331 Export\SpecialChar menuseparator
13339 \begin_layout Plain Layout
13340 Actually you have the choice between \SpecialChar LaTeX
13341 (plain) and pdflatex.
13342 If you intend to use pdflatex to prepare the paper, you should use the
13343 pdflatex option so that included graphics are converted to PDF format,
13344 ready for use by pdflatex.
13349 , then make the following changes to the resulting
13356 \begin_layout Enumerate
13357 Remove the comment lines before the
13366 \begin_layout Enumerate
13367 Remove everything between (and including) the
13379 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13383 \begin_layout Standard
13388 file should be saved and processed through \SpecialChar LaTeX
13389 as many times as necessary.
13390 You may also want to check the resulting
13397 \begin_layout Subsection
13398 Use of \SpecialChar TeX
13402 \begin_layout Standard
13403 The use of \SpecialChar TeX
13404 code is reduced to two commands, which must be placed at the
13405 top of the document.
13406 If you started writing your paper by using the
13414 template, the \SpecialChar TeX
13415 code needed is already in its place; you usually don't need
13417 You may only modify the first \SpecialChar TeX
13418 code to specify the information printed
13419 to the top of odd and even pages (authors' names and short paper's title,
13421 This \SpecialChar TeX
13422 code must have the form
13426 markboth{Authors' Names}{Short Paper's Title}
13431 \begin_layout Section
13435 \begin_layout Standard
13441 \begin_layout Subsection
13445 \begin_layout Standard
13446 The iopart package provides a document class to create electronic manuscript
13447 submission to the journals published by the Institute of Physics.
13448 Instructions for the authors how to create a paper using the iopart class
13449 can be downloaded together with the iopart package from the site
13450 \begin_inset Flex URL
13453 \begin_layout Plain Layout
13455 ftp://ftp.iop.org/pub/journals/latex2e
13463 \begin_layout Subsection
13467 \begin_layout Standard
13468 The easiest way to write a paper is to start with the file
13472 that is available in \SpecialChar LyX
13473 's examples files folder.
13474 Open this file, save it under a new name, and start writing.
13475 The example file explains how to use the special text environments.
13476 Here are the most important advices:
13479 \begin_layout Itemize
13480 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13483 Use AMS math package
13485 in the document settings under
13492 \begin_layout Itemize
13495 The title environment defines the kind of your paper.
13496 So use one of the following environments for the title:
13500 \begin_layout Itemize
13509 \begin_layout Itemize
13518 \begin_layout Itemize
13524 for a Topical review
13527 \begin_layout Itemize
13536 \begin_layout Itemize
13545 \begin_layout Itemize
13551 for a Paper (same as Title)
13554 \begin_layout Itemize
13560 for a Preliminary communication
13563 \begin_layout Itemize
13569 for a Rapid communication
13572 \begin_layout Itemize
13578 for a Letter to the editor
13582 \begin_layout Itemize
13585 All title environments except of
13589 can have an optional short title.
13592 \begin_layout Itemize
13593 There is a general title environment
13597 which is not directly supported by the \SpecialChar LyX
13599 This can be used as \SpecialChar TeX
13600 code when your document doesn't fit into one of the
13604 \begin_layout Standard
13605 For more informations like hints for special table and formula formatting,
13606 look at the IOP author guidelines.
13609 \begin_layout Section
13613 \begin_layout Standard
13616 Panayotis Papasotiriou
13619 \begin_layout Subsection
13623 \begin_layout Standard
13624 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13625 that facilitates electronic manuscript submission to the journals they
13627 Most known of them (at least in my domain of interest) are
13629 Astrophysics and Space Science
13635 , but there are many others (see a complete list at
13636 \begin_inset Flex URL
13639 \begin_layout Plain Layout
13641 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13647 The Kluwer package may be downloaded from the site
13648 \begin_inset Flex URL
13651 \begin_layout Plain Layout
13653 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13659 A complete user guide is contained in that package (but it can also be
13660 downloaded separately).
13663 \begin_layout Standard
13665 supports many features of the package but not everything.
13666 However, the \SpecialChar TeX
13667 code needed is reduced to some
13668 \begin_inset Quotes eld
13672 \begin_inset Quotes erd
13675 commands of the package (see
13676 \begin_inset space ~
13680 \begin_inset CommandInset ref
13682 reference "subsec:kluwer_peculiarities"
13687 I have recently used \SpecialChar LyX
13688 to write an article submitted to the
13690 Astrophysics and Space Science
13692 without any problem.
13695 \begin_layout Subsection
13699 \begin_layout Standard
13700 The easiest way to write a paper is to start with the Kluwer template file.
13703 File\SpecialChar menuseparator
13715 This will give an (almost) empty document that includes the most common
13716 fields found in a manuscript and a short description of their use.
13717 As in most templates, simply overwrite the existing text (including the
13722 ) with the correct information.
13725 \begin_layout Subsection
13726 Preparing a paper for submission
13729 \begin_layout Standard
13730 As in the AAS\SpecialChar TeX
13731 package, before you submit your paper to a journal you must
13733 \begin_inset Quotes eld
13737 \begin_inset Quotes erd
13743 \begin_layout Enumerate
13744 Export your paper as a \SpecialChar LaTeX
13746 To do this, click on
13748 File\SpecialChar menuseparator
13749 Export\SpecialChar menuseparator
13757 \begin_layout Enumerate
13762 file with a text editor and make the following changes
13766 \begin_layout Enumerate
13767 remove the comment lines before the
13776 \begin_layout Enumerate
13777 remove everything between (and including) the
13789 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13793 \begin_layout Standard
13802 \begin_layout Enumerate
13807 file through \SpecialChar LaTeX
13808 as many times as necessary (usually up to three).
13811 \begin_layout Enumerate
13817 \begin_inset space \thinspace{}
13821 \begin_inset space \space{}
13828 , and check if everything is OK (it should, if you didn't make any mistake).
13831 \begin_layout Subsection
13832 \begin_inset Quotes eld
13836 \begin_inset Quotes erd
13839 of the Kluwer package
13840 \begin_inset CommandInset label
13842 name "subsec:kluwer_peculiarities"
13849 \begin_layout Standard
13850 The Kluwer package has the following
13851 \begin_inset Quotes eld
13855 \begin_inset Quotes erd
13861 \begin_layout Enumerate
13862 It is possible to write multiple articles in the same \SpecialChar LaTeX
13867 \begin_layout Plain Layout
13868 I can't imagine any good reason to do this.
13874 Each article must be included in the environment
13875 \begin_inset Quotes eld
13879 \begin_inset Quotes erd
13883 Unfortunately, this environment cannot be omitted, even if you write just
13885 Therefore, each article starts with the command
13891 and, obviously, ends with the command
13898 Although this can be implemented in \SpecialChar LyX
13899 , I didn't included it, since it looks
13900 ugly and can confuse the novice user.
13901 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13904 \begin_inset Quotes eld
13909 \begin_inset Quotes erd
13915 \begin_layout Enumerate
13916 Information given at the beginning of the article (i.
13917 \begin_inset space \thinspace{}
13921 \begin_inset space \space{}
13924 title, subtitle, author, institution, running title, running author, abstract
13925 and keywords) must be included in an environment called
13926 \begin_inset Quotes eld
13930 \begin_inset Quotes erd
13934 This is not implemented in \SpecialChar LyX
13935 , so you must enter title, subtitle etc.
13936 \begin_inset space ~
13939 between two \SpecialChar TeX
13955 \begin_layout Enumerate
13956 According to the user manual, the label of each bibliography item must be
13980 \begin_layout Standard
13985 template takes care of all these
13986 \begin_inset Quotes eld
13990 \begin_inset Quotes erd
13994 If you start a new paper using this template you don't need to do anything
13999 \begin_layout Enumerate
14000 don't delete the \SpecialChar TeX
14001 code included in the template, and
14004 \begin_layout Enumerate
14005 copy the example bibliography item included in the template and modify it
14006 as necessary to enter new bibliography items.
14009 \begin_layout Section
14013 \begin_layout Standard
14019 \begin_layout Subsection
14023 \begin_layout Standard
14024 The \SpecialChar LyX
14027 article (koma-script)
14031 report (koma-script)
14049 correspond to the \SpecialChar LaTeX
14067 \begin_inset space ~
14070 of the Koma-Script family.
14071 They are replacements for the standard document classes
14087 , resp., and fit better to European typography conventions in a number of
14091 \begin_layout Itemize
14092 Standard character size is 11pt in
14094 article (koma-script)
14098 report (koma-script)
14106 letter (koma-script)
14111 \begin_layout Itemize
14112 Headings, labels of the description environment, and a number of elements
14115 letter (koma-script)
14117 document class are set in a bold sans serif font.
14121 \begin_layout Plain Layout
14122 There is a big difference between the bold sans serif old cm fonts and new
14123 ec fonts, especially in the appearance of headings.
14124 In comparison, the ec bold sans serif fonts look a bit thin.
14125 Here the \SpecialChar LaTeX
14134 helps to produce the
14135 \begin_inset Quotes eld
14139 \begin_inset Quotes erd
14142 appearance when using the ec fonts.
14147 The numbering of chapter headings is made in the same way as the numbering
14148 of section headings, that is without the extra line
14149 \begin_inset Quotes eld
14152 Chapter\SpecialChar ldots
14154 \begin_inset Quotes erd
14158 In addition, the appearance of the headings can be modified by using a
14159 number of options (in \SpecialChar LyX
14160 to be entered in the field
14163 \begin_inset space ~
14170 Layout\SpecialChar menuseparator
14177 \begin_layout Itemize
14178 The main means in the Koma-Script document classes to design the type area
14187 (in \SpecialChar LyX
14188 to be entered in the extra class options field in the dialog
14190 Document\SpecialChar menuseparator
14194 They make a clearer modification of page margins possible as do the options
14197 Document\SpecialChar menuseparator
14204 \begin_layout Itemize
14205 The \SpecialChar LaTeX
14206 document classes of the Koma-Script family define a number of additional
14208 Those part of it which makes sense in \SpecialChar LyX
14209 is implemented in corresponding
14213 \begin_layout Standard
14214 Detailed descriptions of the \SpecialChar LaTeX
14215 document classes of the Koma-Script family
14216 can be found in the Koma-Script documentation
14227 \begin_layout Subsection
14228 article (koma-script), report (koma-script), and book (koma-script)
14231 \begin_layout Standard
14232 The document classes
14234 article (koma-script)
14238 report (koma-script)
14248 are implemented in the layout files
14261 They contain all the paragraph types of the corresponding standard document
14274 , resp., partly modified, with the exception of the \SpecialChar LyX
14279 -type, which is replaced by the new
14283 -type having the same functionality.
14288 -Type there is a number of new paragraph types added.
14295 letter (koma-script)
14300 \begin_layout Itemize
14309 : are equivalents to
14317 , resp., additionally inserting an entry in the table of contents.
14326 are not contained in
14328 article (koma-script)
14333 \begin_layout Itemize
14342 : behave exactly as
14350 , resp., additionally clearing running heads.
14355 is not contained in
14357 article (koma-script)
14363 \begin_layout Plain Layout
14376 report (koma-script)
14378 , but since this is identical to
14382 , is has not been implemented in \SpecialChar LyX
14391 \begin_layout Itemize
14396 : generates a heading directly above the following paragraph in the standard
14397 character size without affecting the structure of the document.
14400 \begin_layout Itemize
14409 are special captions which respect the different space settings needed
14410 for captions placed above or below an element (if you follow strict typographic
14411 rules, you might want to place table captions always above the table).
14412 You can also use the class option
14416 , which will switch
14429 You need at least Koma-Script version 2.8q to use this.
14432 \begin_layout Itemize
14437 : can be used to set a bonmot, e.
14438 \begin_inset space \thinspace{}
14442 \begin_inset space \space{}
14445 at the beginning of a chapter.
14446 If you use the optional argument (
14448 Insert\SpecialChar menuseparator
14450 \begin_inset space ~
14455 ), you can insert the dictum's author there.
14456 Dictum and author are separated by a line.
14457 You need at least Koma-Script version 2.8q to use this.
14462 is not contained in
14464 article (koma-script)
14469 \begin_layout Standard
14470 The following types, together with the standard types
14482 , form the title area of the document.
14483 They must be entered ahead of the first
14484 \begin_inset Quotes eld
14488 \begin_inset Quotes erd
14495 \begin_layout Plain Layout
14496 The corresponding \SpecialChar LaTeX
14497 commands must appear before the
14508 When such a type is used more than once, the latter usage overwrites the
14509 former one, that means, for every type only the latest usage is valid.
14510 The order of the different types however has, like
14522 , no effect on the appearance of the produced document.
14525 \begin_layout Itemize
14530 : produces a centered paragraph above the ordinary title (
14542 ) for the subject of the document.
14545 \begin_layout Itemize
14550 : produces a centered paragraph below the ordinary title (
14562 ) for the publishers' name.
14565 \begin_layout Itemize
14572 report (koma-script)
14578 produces a centered paragraph on its own page behind the title page, or
14581 article (koma-script)
14583 produces a centered paragraph below the ordinary title (
14599 ) for a dedication.
14602 \begin_layout Itemize
14607 : produces a left aligned paragraph above the ordinary title (
14623 ) for a document`s head.
14626 \begin_layout Itemize
14631 : produces in a double-sided print in
14633 report (koma-script)
14639 a left-aligned paragraph at the top of the title page`s back or has no
14640 effect in a single-sided print or in
14642 article (koma-script)
14647 \begin_layout Itemize
14652 : produces in a double-sided print in
14654 report (koma-script)
14660 a left-aligned paragraph at the bottom of the title page`s back or has
14661 no effect in a single-sided print or in
14663 article (koma-script)
14668 \begin_layout Itemize
14673 : produces a special
14674 \begin_inset Quotes eld
14678 \begin_inset Quotes erd
14681 page ahead of the actual document containing a paragraph without special
14685 \begin_layout Standard
14686 The layout files for the document classes
14688 article (koma-script)
14692 report (koma-script)
14698 do include the file
14703 This is thought of as a place to define your own types.
14708 in your personal layout directory and edit the file!
14711 \begin_layout Subsection
14712 letter (koma-script)
14715 \begin_layout Standard
14719 letter (koma-script)
14721 is implemented in the layout file
14726 It contains all the paragraph types of the corresponding standard document
14731 , partly modified, with the exception of the \SpecialChar LyX
14745 type, which is replaced by the new
14750 In addition, it contains, in contrast to the standard document class, the
14769 Furthermore, there are a number of new letter specific types.
14772 \begin_layout Standard
14773 The appearance of the letter produced by this document class can be controlled
14774 by a number of \SpecialChar LaTeX
14775 commands, which you can put in the \SpecialChar LaTeX
14780 \begin_layout Plain Layout
14781 For example, the standard appearance of the letter`s heading, consisting
14782 of name and address, is quite self-willed.
14784 \begin_inset Quotes eld
14788 \begin_inset Quotes erd
14791 heading is produced by the following \SpecialChar LaTeX
14792 commands in the preamble:
14795 \begin_layout LyX-Code
14805 \begin_layout LyX-Code
14821 \begin_layout LyX-Code
14831 \begin_layout LyX-Code
14851 A detailed German description of such \SpecialChar LaTeX
14852 commands can be found in the Koma-Script
14858 With it, the letter's author can produce his personal letter layout.
14861 \begin_layout Standard
14870 define the beginning of the letter and must be used in every letter.
14871 To emphasize them in the \SpecialChar LyX
14872 document class, they are marked with the letter
14882 \begin_inset space ~
14885 in the left margin.
14886 It is possible to write any number of letters in one file.
14891 type produces a new letter using the same addressee and a
14895 type produces a new addressee.
14912 are ordinary paragraph types and can also be used several times in one
14913 and the same letter.
14916 \begin_layout Itemize
14921 : produces a paragraph for the addressee and implicitly defines the beginning
14925 \begin_layout Itemize
14930 : produces a paragraph for the form of address and implicitly produces a
14934 \begin_layout Itemize
14939 : produces a paragraph for a close.
14942 \begin_layout Itemize
14947 : produces a paragraph for a postscript.
14950 \begin_layout Itemize
14955 : produces a paragraph for a distribution list.
14958 \begin_layout Itemize
14963 : produces a paragraph for enclosures.
14966 \begin_layout Standard
15007 are input types provided with a label to enter information, which will
15008 be processed by the document class.
15012 \begin_layout Plain Layout
15013 It could be seen as a matter of inconsequence, that the types
15021 described above are not such input types as well.
15022 Because of the special meaning of those types, however, I have implemented
15023 them as ordinary paragraph types with a one letter mark in the left margin.
15024 Moreover, it would affect my feeling of symmetry, if the
15032 type had such a serious different appearance.
15037 The types must be used ahead of the corresponding
15044 \begin_layout Standard
15045 An implementation of these types in a WYSIWYG fashion does not seem to make
15046 sense, because the real appearance of the produced letter does not only
15047 depend on the usage of the particular type, but also on other factors.
15048 For example, a signature entered in the
15052 type will in the standard behavior appear in the produced letter only,
15053 when in the same letter also a
15058 The entered value of the
15062 type will in the standard behavior not appear in the produced letter at
15064 The possibility to design the letter`s heading freely is already indicated
15065 in a footnote above.
15068 \begin_layout Standard
15069 The input types can also be used as empty paragraphs.
15070 This makes sense e.
15071 \begin_inset space \thinspace{}
15075 \begin_inset space \space{}
15087 type is not used at all, in the standard behavior the value of the
15091 type is used as signature, whereas if an empty
15095 type is used, no signature value is defined.
15098 \begin_layout Standard
15099 By using the input types it is possible to write a letter template, containing
15100 filled input types with your personal dates (name, address, etc.) and empty
15101 input types for other dates you want to enter.
15104 \begin_layout Itemize
15109 : sender's name, in the standard behavior appears as a centered paragraph
15110 in small caps in the letter`s heading.
15113 \begin_layout Itemize
15118 : sender's signature, in the standard behavior appears below the
15127 type is used, the value of the
15131 type appears instead.
15134 \begin_layout Itemize
15139 : sender's address, in the standard behavior appears in a centered paragraph
15140 in the letter`s heading below the sender's name.
15143 \begin_layout Itemize
15148 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15159 \begin_layout Itemize
15164 : place of the letter`s making.
15167 \begin_layout Itemize
15172 : date of the letter`s making.
15181 , in the standard behavior, produce the place and the date in a right-aligned
15182 line below the addressee's field.
15187 type is used, neither place nor date appear, independent of the value of
15197 type is used, the date of the letter `s production is used.
15200 \begin_layout Itemize
15205 : sender`s back address, in the standard behavior appears above the addressee's
15206 field in a small sans serif font.
15209 \begin_layout Itemize
15214 : special mail information, in the standard behavior appears underlined
15215 above the addressee's field below the back address.
15218 \begin_layout Itemize
15223 : additional information, in the standard behavior appears on right side
15224 below the addressee`s field.
15227 \begin_layout Itemize
15232 : the letter's title, in the standard behavior appears in a big, bold, sans
15233 serif font above the subject.
15236 \begin_layout Itemize
15241 : the letter's subject, in the standard behavior appears in a bold font
15249 \begin_layout Standard
15270 produce a business letter like line above the
15274 line containing the fields
15275 \begin_inset Quotes eld
15279 \begin_inset Quotes erd
15283 \begin_inset Quotes eld
15287 \begin_inset Quotes erd
15291 \begin_inset Quotes eld
15295 \begin_inset Quotes erd
15299 \begin_inset Quotes eld
15303 \begin_inset Quotes erd
15307 \begin_inset Quotes eld
15311 \begin_inset Quotes erd
15315 \begin_inset Quotes eld
15319 \begin_inset Quotes erd
15323 For the date field, the value of the
15329 \begin_inset Quotes eld
15332 business letter types
15333 \begin_inset Quotes erd
15336 is used, the value of the
15340 type however does not appear, but only the \SpecialChar LaTeX
15348 The ordinary output of place and date in a right-aligned line below the
15349 addressee`s field is suppressed.
15350 The types are implemented as input types provided with a label and must
15351 be used ahead of the corresponding
15358 \begin_layout Itemize
15366 \begin_layout Itemize
15374 \begin_layout Itemize
15382 \begin_layout Itemize
15390 \begin_layout Itemize
15398 \begin_layout Subsection
15399 The new letter class: letter (koma-script v.2)
15402 \begin_layout Standard
15408 \begin_layout Standard
15409 \begin_inset VSpace medskip
15415 \begin_layout Standard
15417 Koma-Script version 2.8 has introduced a new letter class
15421 which supersedes the now unsupported
15426 It has — on the \SpecialChar LaTeX
15427 side — a completely new interface and is not compatible
15428 with the old class.
15429 Therefore, \SpecialChar LyX
15430 supports both, though it is recommended you use the new class.
15433 \begin_layout Standard
15434 This class covers the same functionality as
15436 letter (koma-script),
15439 The basic items are
15443 (receiver's address, same as
15447 in the old layout),
15460 will start a new letter (i.
15461 \begin_inset space \thinspace{}
15465 \begin_inset space \space{}
15468 you can write several letters per document).
15469 New elements are sender's
15485 and the possibility to use a
15491 Insert\SpecialChar menuseparator
15497 \begin_layout Standard
15498 The biggest improvement is, though, that the letter's layout is configurable
15499 to meet almost any needs.
15500 This can be done via the preamble or with a special style file (Letter
15501 Class Option, extension
15505 ), that will be read in as a class option.
15509 \begin_layout Plain Layout
15510 The KOMA package comes with some default
15515 There is, for instance, a
15519 file that follows german typesetting rules, or a
15523 that provides the default layout of the old
15528 The latter can be loaded with the class option
15534 Layout\SpecialChar menuseparator
15535 Document\SpecialChar menuseparator
15547 template that is included in \SpecialChar LyX
15549 A detailed description is to be found in the Koma-Script documentation
15557 \begin_layout Subsection
15561 \begin_layout Standard
15562 Visualizing the Koma-Script document classes in \SpecialChar LyX
15563 , the \SpecialChar LyX
15564 internals cause some
15568 \begin_layout Itemize
15569 The chapter number of a
15573 type appears on a line of its own above the chapter heading instead of
15574 appearing in the same line ahead of it.
15575 The cause for that is the \SpecialChar LyX
15576 internal behavior for the labeltype
15580 in the layout file.
15583 \begin_layout Itemize
15584 The headings of the types
15592 are only put in the
15593 \begin_inset Quotes eld
15597 \begin_inset Quotes erd
15601 table of contents, but not in the \SpecialChar LyX
15602 table of contents (
15604 Document\SpecialChar menuseparator
15606 \begin_inset space ~
15610 \begin_inset space ~
15618 \begin_layout Itemize
15619 The paragraphs in a
15623 document class appear in a skip separation mode, not indented.
15624 This is the standard behavior, no special \SpecialChar LaTeX
15625 commands are needed for that.
15628 Document\SpecialChar menuseparator
15631 dialog the corresponding radio button indicates
15640 value always has the effect that extra \SpecialChar LaTeX
15641 commands are inserted in the document
15642 to produce the gap, which is not what is wanted in this case.
15645 \begin_layout Section
15649 \begin_layout Standard
15655 \begin_layout Subsection
15659 \begin_layout Standard
15660 Memoir is a very powerful and constantly evolving class.
15661 It has been designed with regard to fictional and non-fictional literature.
15662 Its aim is to let the user have maximum control over the typesetting of
15664 Memoir is based on the standard book class, but it can also emulate the
15665 article class (see below).
15668 \begin_layout Standard
15669 Peter Wilson, the developer of Memoir, is known as the author of lots of
15670 useful packages in the \SpecialChar LaTeX
15672 Most of them have been merged with Memoir.
15673 Therefore, it is much easier to layout the table of contents, appendices,
15674 chapter designs and such.
15676 , though, does not support all of these goodies natively.
15677 Some of them might be added to forthcoming releases
15681 \begin_layout Plain Layout
15682 You are invited to send suggestions to
15683 \begin_inset Flex URL
15686 \begin_layout Plain Layout
15688 lyx-devel@lists.lyx.org
15698 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15700 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15702 commands (\SpecialChar TeX
15707 \begin_layout Plain Layout
15712 \begin_layout Plain Layout
15722 \begin_inset space ~
15726 \begin_inset CommandInset ref
15728 reference "sec:Inserting-TeX-Code"
15738 In this section, we can only list those features that are natively supported
15739 by \SpecialChar LyX
15741 For detailed descriptions (and for the rest of features) we recommend you
15742 have a look at the detailed manual of the Memoir class
15746 \begin_layout Plain Layout
15751 \begin_layout Plain Layout
15761 \begin_inset Flex URL
15764 \begin_layout Plain Layout
15766 CTAN:/macros/latex/memoir/memman.pdf
15776 , which is not only a user guide for the class, but also both a comprehensive
15777 description on good typesetting and a superb example for good typesetting
15781 \begin_layout Subsection
15782 Basic features and restrictions
15785 \begin_layout Standard
15786 Memoir supports basically all features of the standard book classes.
15787 There are, however, some differences, as follows:
15790 \begin_layout Description
15792 \begin_inset space ~
15795 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15798 \begin_layout Description
15800 \begin_inset space ~
15803 style: The fancy page style is not supported, due to a command clash between
15804 Memoir and the fancyhdr package (they both define a command with the same
15805 name, which confuses \SpecialChar LaTeX
15807 Instead, Memoir comes with a number of its own page styles (see
15809 Layout\SpecialChar menuseparator
15810 Document\SpecialChar menuseparator
15812 \begin_inset space ~
15818 If you want to use these for the chapter pages, you have to use the command
15825 in the main text or in preamble (e.
15826 \begin_inset space \thinspace{}
15830 \begin_inset space \space{}
15837 chapterstyle{companion}
15842 \begin_layout Description
15843 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15844 optional argument in the standard classes.
15845 With this, you can specify an alternative version of the title for the
15846 table of contents and the headers (for instance, if the title is too long).
15847 In \SpecialChar LyX
15848 , you can do this via
15850 Insert\SpecialChar menuseparator
15852 \begin_inset space ~
15857 at the beginning of a chapter/section.
15858 Memoir features a second optional argument and thus separates the table
15859 of contents from the header.
15860 You can define three variants of a title with this: one for the main text,
15861 one for the table of contents, and one for the headers.
15862 Simply insert two optional arguments if you need this feature, the first
15863 one containing the short title for the Table of Contents, the second one
15864 containing an alternative short title for the headers.
15867 \begin_layout Description
15868 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15869 of contents, the list of figures and the list of table start a new page
15871 Memoir does not follow this route.
15872 You have to insert a page break yourself, if you want to have one.
15875 \begin_layout Description
15876 Titlepage: For some unknown reason, Memoir uses pagination on the title
15877 page (in the standard classes, title pages are
15878 \begin_inset Quotes eld
15882 \begin_inset Quotes erd
15886 If you want an empty title page, type
15890 aliaspagestyle{title}{empty}
15895 \begin_layout Description
15896 Article: With the class option
15902 Layout\SpecialChar menuseparator
15903 Document\SpecialChar menuseparator
15905 \begin_inset space ~
15910 ), you can emulate article style.
15911 That is, counters (footnotes, figures, tables etc.) will not be reset on
15912 new chapters, chapters don't start a new page (but are—in contrary to
15913 \begin_inset Quotes eld
15917 \begin_inset Quotes erd
15920 article classes—still allowed), parts, though, use their own page, as in
15924 \begin_layout Description
15925 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15926 font commands, which have been used in the old \SpecialChar LaTeX
15928 \begin_inset space \thinspace{}
15932 \begin_inset space \space{}
15948 It produces an error and stops \SpecialChar LaTeX
15949 whenever such a command appears.
15954 reallows the commands and spits out warnings instead (which does at least
15955 not stop \SpecialChar LaTeX
15957 Since a lot of packages and particularly Bib\SpecialChar TeX
15958 style files are still using
15959 those commands, we have decided to use this option by default.
15962 \begin_layout Subsection
15966 \begin_layout Standard
15967 We will only describe the features supported by \SpecialChar LyX
15968 (which is not much currently).
15969 Please consult the Memoir manual
15973 \begin_layout Plain Layout
15978 \begin_layout Plain Layout
15988 \begin_inset Flex URL
15991 \begin_layout Plain Layout
15993 CTAN:/macros/latex/memoir/memman.pdf
16006 \begin_layout Description
16007 Abstract: You may wonder why an abstract is an extra feature.
16008 Well, it is in book class.
16009 Usually books don't have abstracts.
16010 Memoir, however, has.
16011 You can use it wherever and how often you like.
16014 \begin_layout Description
16015 Chapterprecis: You may know this older typesetting style: The contents of
16016 a chapter are summarized below the title and also in the table of contents
16018 \begin_inset space \thinspace{}
16022 \begin_inset space \space{}
16027 Our hero arrives in Troia; he loses some friends; he finds others
16030 Chapterprecis does exactly this.
16031 It is therefore only sensible below a chapter.
16034 \begin_layout Description
16035 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16036 The epigraph environment provides an elegant way of typesetting such a
16038 The motto itself (text) and its author (source) are divided by a short
16040 Unfortunately, we have to fool \SpecialChar LyX
16041 a bit here again, since the environment
16042 needs two arguments (text and source).
16043 In this case, we have to use curly brackets (in \SpecialChar TeX
16044 mode) between the two
16055 <author of the slogan>.
16058 \begin_layout Description
16059 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16060 complex figurative poems).
16062 can only support a few of them.
16063 One is poemtitle, which is a centered title for poems, which will also
16064 be added to the table of contents (verse is the standard environment for
16066 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16068 because they have to be nested inside regular verse environments, which
16069 is not possible with \SpecialChar LyX
16073 \begin_layout Description
16074 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16077 \begin_layout Section
16078 Article (mwart), book (mwbk) and report (mwrep)
16079 \begin_inset Argument status
16082 \begin_layout Plain Layout
16095 \begin_layout Standard
16101 \begin_layout Standard
16102 The \SpecialChar LyX
16119 correspond to the \SpecialChar LaTeX
16133 They are replacements for the standard document classes
16145 , resp., and fit better to Polish typography conventions in a number of points.
16149 \begin_layout Standard
16153 \begin_layout Itemize
16154 Unnumbered titles (with star, e.
16155 \begin_inset space \thinspace{}
16159 \begin_inset space \space{}
16166 ) are added into table of contents,
16169 \begin_layout Itemize
16170 Additional page styles:
16174 \begin_layout Description
16175 uheadings header with separated lines,
16178 \begin_layout Description
16179 myheadings custom header, contents headers via commands:
16194 \begin_layout Description
16195 myuheadings custom header with separated lines,
16198 \begin_layout Description
16199 outer page number is placed on outer side of page
16203 \begin_layout Itemize
16208 \begin_layout Description
16209 rmheadings serif titles — default,
16212 \begin_layout Description
16213 sfheadings sansserif titles,
16216 \begin_layout Description
16217 authortitle on title page first placed is author next title — default,
16220 \begin_layout Description
16221 titleauthor on title page first placed is title next author,
16224 \begin_layout Description
16225 withmarginpar reserve place on page for margins.
16229 \begin_layout Section
16233 \begin_layout Standard
16238 provides an alternative to the standard
16243 It provides similar functionality, but you might prefer this layout with
16244 sans serif sections, headings, and more.
16247 \begin_layout Section
16248 Rev\SpecialChar TeX
16252 \begin_layout Standard
16258 \begin_layout Standard
16259 \begin_inset VSpace bigskip
16265 \begin_layout Standard
16270 \begin_inset space ~
16275 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16277 \begin_inset Formula $\beta$
16280 release of May, 1999) class.
16283 \begin_layout Standard
16289 textclass, which works with Rev\SpecialChar TeX
16291 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16293 That means that it doesn't interact very well with \SpecialChar LyX
16294 , which requires \SpecialChar LaTeX2e
16296 it has been kludged to work.
16297 Since Rev\SpecialChar TeX
16298 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16303 Rev\SpecialChar TeX
16305 \begin_inset space ~
16310 textclass should also be pretty easy to use.
16313 \begin_layout Standard
16314 These documents are supposed to be used in
16318 to the Rev\SpecialChar TeX
16319 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16321 and assume you'll know what to put in the preamble if necessary.
16324 \begin_layout Subsection
16328 \begin_layout Standard
16329 All you need to do is install Rev\SpecialChar TeX
16330 4, as described in the package's README
16332 The package can be found at The Rev\SpecialChar TeX
16334 \begin_inset Flex URL
16337 \begin_layout Plain Layout
16339 http://publish.aps.org/revtex4/
16345 Install it somewhere that \SpecialChar LaTeX
16347 Test it by trying to \SpecialChar LaTeX
16348 a short Rev\SpecialChar TeX
16349 4 document in some random directory (i.
16350 \begin_inset space \thinspace{}
16354 \begin_inset space \space{}
16357 not the directory where you installed the class file.) Then, if you reconfigure
16359 , it will find the class file and let you use the Rev\SpecialChar TeX
16363 \begin_layout Standard
16364 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16373 \begin_inset space ~
16378 template, found in the templates directory.
16381 \begin_layout Subsection
16385 \begin_layout Standard
16386 Optional arguments to
16393 \begin_inset Quotes eld
16397 \begin_inset Quotes erd
16401 \begin_inset Quotes eld
16405 \begin_inset Quotes erd
16411 \begin_inset space ~
16419 \begin_inset space ~
16425 Remember that in Rev\SpecialChar TeX
16426 , at least one optional argument is required!
16429 \begin_layout Standard
16430 Other preamble matter, like
16437 \begin_inset space ~
16444 \begin_inset space ~
16449 dialog, also as usual.
16452 \begin_layout Subsection
16456 \begin_layout Standard
16457 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16459 For example, the Email layout corresponds to
16466 Note that (at least as of Rev\SpecialChar TeX
16475 layouts are exactly equivalent, so you shouldn't need to use both.
16479 \begin_layout Plain Layout
16480 In case you're curious, both were included so that
16484 would be able to translate both
16504 \begin_layout Subsection
16508 \begin_layout Standard
16509 There are a couple of important unique aspects of Rev\SpecialChar TeX
16510 4 which might cause
16511 bugs that will be even more confusing in \SpecialChar LyX
16515 \begin_layout Standard
16516 In Rev\SpecialChar TeX
16534 The \SpecialChar LyX
16535 equivalent is that there is a separate Thanks layout.
16540 write footnotes in the
16544 layout, or weird things may happen.
16545 See the Rev\SpecialChar TeX
16546 4 documentation for more details.
16549 \begin_layout Standard
16553 \begin_inset space ~
16561 \begin_inset space ~
16570 layouts must be placed
16578 layout and the corresponding
16595 , the \SpecialChar LaTeX
16599 \begin_layout Subsection
16603 \begin_layout Standard
16604 The main problem with this layout is that you can't use the optional arguments
16605 to layouts like Email and Title.
16606 (The problem is not unique to this layout; you can't use optional arguments
16607 to the Section layouts either.) This means that after you export that file
16608 to \SpecialChar LaTeX
16609 (which you'll need to do eventually to send it in to APS), you'll need
16610 to edit the \SpecialChar LaTeX
16611 file with a text editor to add the optional arguments to set,
16613 \begin_inset space \thinspace{}
16617 \begin_inset space \space{}
16620 the running title for the page headers.
16621 Lacking these layouts makes the
16627 (and the equivalent
16633 ) useless, so the corresponding layouts don't exist, and will have to be
16638 \begin_layout Plain Layout
16643 actually, \SpecialChar LyX
16644 1.3.0 supports some forms of optional arguments, but this layout
16645 has not been updated yet to take advantage of it.
16653 \begin_layout Section
16654 Springer Journals (
16661 \begin_layout Standard
16667 \begin_layout Subsection
16671 \begin_layout Standard
16672 These are the layout files for some of the journal formats used by Springer
16673 Verlag and listed on
16674 \begin_inset Flex URL
16677 \begin_layout Plain Layout
16679 http://www.springer.de/author/tex/help-journals.html
16684 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16686 It is a modular system: the things common to all journals are implemented
16691 , which journal-specific layout files (such as, e.
16692 \begin_inset space \thinspace{}
16696 \begin_inset space \space{}
16703 for Journal of Geodesy) can include.
16706 \begin_layout Standard
16707 This means that implementing support for any other Springer journal on this
16708 list is as simple as writing your own
16716 file following the outline given in
16724 \begin_layout Standard
16725 It is reasonably well tested only for the Journal of Geodesy.
16734 come with the standard \SpecialChar LyX
16736 Install the relevant class file (downloaded from Springer) in a proper
16737 directory, reconfigure \SpecialChar LaTeX
16738 (in the te\SpecialChar TeX
16743 , as root if necessary — doesn't \SpecialChar LyX
16744 take care of this?), reconfigure \SpecialChar LyX
16749 \begin_layout Subsection
16753 \begin_layout Standard
16754 A large number of theorem-like styles —
16766 \begin_layout Standard
16769 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16770 _Title, Author_Running, Institute,
16771 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16774 See the Springer class file documentation for details.
16777 \begin_layout Subsection
16781 \begin_layout Itemize
16793 \begin_layout Itemize
16796 Probability Theory and Related Fields
16802 — Jean-Marc Lasgouttes
16805 \begin_layout Standard
16806 Add your own, it isn't so hard!
16809 \begin_layout Subsection
16813 \begin_layout Standard
16814 These files are partly based on the older
16818 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16820 file from Springer.
16825 layout, are now defunct.
16826 Jean-Marc Lasgouttes helped out big in making me find my way around the
16828 layout file mechanism.
16831 \begin_layout Subsection
16835 \begin_layout Standard
16837 But probably less than in the old hacked-\SpecialChar LaTeX
16845 \begin_layout Standard
16847 \begin_inset space \thinspace{}
16850 g.: does not display the number for theorem-like layouts, just #.
16853 \begin_layout Section
16856 Sli\SpecialChar TeX
16860 \begin_inset CommandInset label
16869 \begin_layout Standard
16877 \begin_layout Subsection
16881 \begin_layout Standard
16882 This section describes how to use \SpecialChar LyX
16883 to make slides for overhead projectors.
16884 There are two document classes that can do this: the default slides class
16887 Foil\SpecialChar TeX
16891 This section documents the former.
16894 \begin_layout Standard
16895 I'm going to say this again, nice and clear, so that there's no misunderstanding
16899 \begin_layout Standard
16900 \begin_inset VSpace bigskip
16906 \begin_layout Standard
16910 This section documents the class
16911 \begin_inset Quotes eld
16919 \begin_inset Quotes erd
16927 \begin_layout Standard
16928 \begin_inset VSpace bigskip
16934 \begin_layout Standard
16935 If you're looking for the documentation for
16936 \begin_inset Quotes eld
16941 slides (Foil\SpecialChar TeX
16945 \begin_inset Quotes erd
16948 , check out section
16949 \begin_inset space ~
16953 \begin_inset CommandInset ref
16955 reference "sec:foiltex"
16965 \begin_inset Quotes eld
16970 slides (Foil\SpecialChar TeX
16974 \begin_inset Quotes erd
16977 ] is actually somewhat better than the default
16985 \begin_layout Plain Layout
16987 or so I've been told repeatedly by its advocates.
16988 Having never used it, I have no idea if this claim is true or not.
16993 which this section documents.
16996 \begin_layout Standard
16997 This class is the \SpecialChar LaTeX2e
16998 improvement of the old
17000 Sli\SpecialChar TeX
17004 Every \SpecialChar LaTeX2e
17005 distribution includes this class [which I'll just refer to as
17006 \begin_inset Quotes eld
17014 \begin_inset Quotes erd
17017 from now on], so you're bound to have it.
17018 As I noted earlier, there are other classes, such as
17022 , which also produce slides for overhead projectors and do a better job
17024 However, there are some things which
17028 can do which the others can't, such as generate overlays.
17029 Read on to learn more!
17032 \begin_layout Subsection
17034 \begin_inset CommandInset label
17036 name "sec:slidesetup"
17043 \begin_layout Standard
17044 Obviously, to use this document class, you need to select
17045 \begin_inset Quotes eld
17053 \begin_inset Quotes erd
17056 from the class list in the
17058 Document\SpecialChar menuseparator
17062 There are some other special things you should know about this class:
17065 \begin_layout Itemize
17066 Don't bother changing the options
17071 They're not supported by the
17078 \begin_layout Itemize
17082 \begin_inset space ~
17087 behaves a bit differently for this class.
17088 The possible choices and what they do are as follows:
17092 \begin_layout Description
17097 The final output contains page numbers in the lower right corner.
17100 \begin_layout Description
17109 , but also prints out any time markers you've put in.
17110 This is the default.
17113 \begin_layout Description
17118 The final output contains no page numbers, time markers, or alignment markers.
17122 \begin_layout Itemize
17127 class has an extra option:
17133 \begin_inset Quotes eld
17141 \begin_inset Quotes erd
17144 in the extra class options.
17148 \begin_layout Standard
17149 Using this options allows you to add time markers to
17155 \begin_inset space ~
17159 \begin_inset CommandInset ref
17161 reference "sec:slideNote"
17169 \begin_layout Standard
17170 You can also use the template file
17171 \begin_inset Quotes eld
17179 \begin_inset Quotes erd
17182 to automatically set up a document to use the
17188 File\SpecialChar menuseparator
17190 \begin_inset space ~
17194 \begin_inset space ~
17199 to open your new document].
17200 The template file also contains some examples of the special paragraph
17201 environments used by this class.
17202 I'll describe those next.
17205 \begin_layout Subsection
17206 Paragraph Environments
17209 \begin_layout Subsubsection
17210 Supported Environments
17213 \begin_layout Standard
17214 The first thing you'll notice when you start up a new
17218 document is the font size and type: it's the equivalent of the size
17219 \begin_inset Quotes eld
17227 \begin_inset Quotes erd
17233 \begin_inset space ~
17239 This is also what's used in the output.
17241 \begin_inset Quotes eld
17245 \begin_inset Quotes erd
17248 to remind you that this is a slide.
17249 Your final slides will use a larger font; ergo, you'll have less space.
17250 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17253 \begin_layout Standard
17254 The next thing that becomes obvious is the changes to the paragraph environment
17255 pull-down box [at the far-left end of the toolbar].
17256 Most of the paragraph environments you're used to seeing are missing.
17257 There are also five new ones.
17262 class itself only supports certain paragraph environments:
17265 \begin_layout Itemize
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
17326 \begin_layout Itemize
17332 \begin_layout Standard
17333 All of the other standard environments, including the section-heading environmen
17334 ts, aren't used in the
17341 \begin_layout Standard
17342 On the other hand, you'll notice the following new environments:
17345 \begin_layout Itemize
17351 \begin_layout Itemize
17357 \begin_layout Itemize
17363 \begin_layout Itemize
17369 \begin_layout Itemize
17375 \begin_layout Standard
17376 These five are kind of quirky, due to a
17377 \begin_inset Quotes eld
17381 \begin_inset Quotes erd
17384 in \SpecialChar LyX
17386 You see, \SpecialChar LyX
17387 doesn't permit you to nest any other paragraph environment into
17388 an empty environment.
17389 Now, that's fine and dandy, but it means that you wouldn't be able to start
17390 a slide with anything except plain text.
17391 To deal with this, I've performed a little
17392 \begin_inset Quotes eld
17397 \begin_inset Quotes erd
17403 \begin_layout Subsubsection
17404 Quirks of the New Environments
17405 \begin_inset CommandInset label
17407 name "sec:slideQuirk"
17414 \begin_layout Standard
17415 All five of the new paragraph environments are somewhat quirky due to inherent
17416 limitiations in the current version of \SpecialChar LyX
17418 As I just mentioned, \SpecialChar LyX
17419 forbids environments that begin with another environment.
17420 To get around this, the
17424 environment isn't a paragraph environment as described in the
17432 \begin_layout Standard
17433 You should consider
17446 \begin_inset Quotes eld
17449 pseudo-environments.
17450 \begin_inset Quotes erd
17453 They look like a section heading or a
17454 \begin_inset Quotes eld
17462 \begin_inset Quotes erd
17465 but really begin a [and, if necessary, end the previous] paragraph environment.
17475 \begin_inset Quotes eld
17479 \begin_inset Quotes erd
17482 These two perform some action.
17485 \begin_layout Standard
17486 A common feature of all five environments,
17506 , is a rather long-ish label.
17507 The text following this label — ordinarily the contents of the paragraph
17508 environment — is utterly irrelevant for
17530 completely ignores it.
17531 In fact, you can leave these five environments completely empty.
17535 \begin_layout Standard
17540 to put any text after the rather long-ish label, you might want to.
17541 This could be a short description of the contents of the
17546 In that case, enter your descriptive comment and hit
17550 as you normally would.
17553 \begin_layout Standard
17554 If, on the other hand, you don't want to enter any descriptive text, you'll
17555 hit another \SpecialChar LyX
17558 , like nature, abhors a vacuum, and will not let you start a new paragraph
17559 environment until you put something in the old one.
17563 \begin_layout Itemize
17564 Start entering the text that will
17592 \begin_layout Itemize
17593 Now move to the beginning of that paragraph.
17597 \begin_layout Itemize
17606 \begin_layout Itemize
17607 Finally, change this new, empty paragraph to a
17631 \begin_layout Standard
17632 Some future version of \SpecialChar LyX
17633 will, hopefully, resolve this quirkiness\SpecialChar ldots
17637 \begin_layout Subsection
17638 Making a Presentation with
17651 \begin_layout Subsubsection
17659 \begin_layout Standard
17660 If you're expecting this section to teach you how to actually make a presentatio
17661 n, you'll be sorely disappointed.
17662 Naturally, I'll describe all of the ways the
17666 class can assist you in preparing the materials for a presentation.
17667 Filling in the contents, however, is up to you.
17672 the \SpecialChar LyX
17676 \begin_layout Standard
17681 environment [in the manner described in section
17682 \begin_inset space ~
17686 \begin_inset CommandInset ref
17688 reference "sec:slideQuirk"
17692 ] tells \SpecialChar LyX
17693 to begin a new slide [duh].
17694 The label for this environment/
17695 \begin_inset Quotes erd
17699 \begin_inset Quotes erd
17703 \begin_inset Quotes eld
17707 \begin_inset Quotes erd
17710 in cool blue, followed by the label,
17711 \begin_inset Quotes eld
17715 \begin_inset Quotes erd
17719 Any text or paragraph environments that follow this one go on the new slide.
17723 \begin_layout Standard
17724 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17726 (this can be specified in the
17731 In fact, you'll want to, once you finish entering the contents of one slide.
17732 If you've entered more text than can physically fit on a slide, the extra
17733 overflows onto a new slide.
17734 I don't recommend doing this, however, since the overflow slide won't have
17735 any page number on it.
17736 Furthermore, it may interfere with any
17740 you've made to accompany the oversized
17747 \begin_layout Standard
17756 environments work the same way as the
17761 They both create an
17762 \begin_inset Quotes eld
17766 \begin_inset Quotes erd
17769 followed by a label [
17770 \begin_inset Quotes eld
17774 \begin_inset Quotes erd
17778 \begin_inset Quotes eld
17782 \begin_inset Quotes erd
17786 The color is a stunning magenta instead of blue, and the
17787 \begin_inset Quotes eld
17791 \begin_inset Quotes erd
17794 will look different, in style and in length.
17795 The label fonts of all three also differ from one another.
17798 \begin_layout Standard
17803 , if the contents of a
17811 exceed the physical size of a slide or sheet of paper, the extra will overflow
17813 Again, you should avoid this.
17814 It defeats the whole purpose of
17825 \begin_layout Subsubsection
17835 \begin_layout Standard
17840 is a slide that sits atop another slide.
17841 Perhaps you wish to discuss a figure on the main
17845 before displaying the text associated with it.
17846 One way to accomplish this is tape a flap of dark paper over the part of
17851 you want to display later.
17852 This method fails, however, if you wish to overlap one graph with another,
17854 You would then have to fumble while speaking to align the two separate,
17859 s to align the two graphs.
17864 environment in both cases makes life much easier.
17867 \begin_layout Standard
17872 receives the page number of its
17873 \begin_inset Quotes eld
17877 \begin_inset Quotes erd
17885 \begin_inset Quotes eld
17893 \begin_inset Quotes erd
17900 \begin_layout Plain Layout
17901 Presumably, mutliple
17906 \begin_inset Quotes eld
17914 \begin_inset Quotes erd
17918 \begin_inset Quotes eld
17926 \begin_inset Quotes erd
17930 \begin_inset Quotes eld
17938 \begin_inset Quotes erd
17942 \begin_inset space ~
17945 appended to the page number of the parent
17955 Clearly, you want the contents of both the
17963 to each fit on a single physical slide! You should probably consider an
17969 \begin_inset Quotes eld
17973 \begin_inset Quotes erd
17981 Indeed, the \SpecialChar LyX
17986 class provides a visual cue for this: the label at the start of an
17990 is shorter than that at the start of a
17995 Lastly, when you generate printable output, you'll find alignment markers
17996 in all four corners of both the
18000 page and its parent
18005 These will assist you in lining up the two physical slides.
18008 \begin_layout Standard
18009 The major problem in overlaying two slides is aligning the contents of the
18010 two transparencies.
18011 How much space should you leave for that graph on the second slide? Worse
18012 still, what if you want a graph and a sentence on second slide, but there
18013 is text on the main transparency that goes in between them? You could try
18014 and insert vertical space of the right size.
18015 The better way is to use
18026 \begin_layout Standard
18027 As their names imply,
18035 are two command-like paragraph environments that make all subsequent text
18036 invisible and visible, respectively.
18038 \begin_inset space ~
18042 \begin_inset CommandInset ref
18044 reference "sec:slideQuirk"
18048 that you don't place anything
18052 these two environments, however.
18057 , it inserts a centered, sky-blue label into the page reading
18058 \begin_inset Quotes eld
18061 <Invisible Text Follows>
18062 \begin_inset Quotes erd
18066 For paragraphs following this label, the parts of the
18074 ; it doesn't matter which] where they would be contain instead blank space.
18078 \begin_layout Standard
18083 , the corresponding centered label is
18084 \begin_inset Quotes eld
18087 <Visible Text Follows>
18088 \begin_inset Quotes erd
18092 Paragraphs following this label behave normally.
18093 Note that the beginning of a new
18105 automatically shuts off an
18110 It's therefore not necessary to use
18121 \begin_layout Standard
18122 By now, it should be obvious how to create overlay transparencies using
18123 the proper combination of
18142 \begin_layout Enumerate
18147 , including everything that will appear on it, whether on the main slide
18155 \begin_layout Enumerate
18156 Before each figure or paragraph that will appear only on the
18165 If necessary, insert a
18169 environment after the
18176 \begin_layout Enumerate
18181 immediately following the
18188 \begin_layout Enumerate
18189 Copy the contents of this
18200 \begin_layout Enumerate
18205 , change all of the
18216 \begin_layout Standard
18218 You've just made an
18225 \begin_layout Standard
18226 There's one problem with the way I've designed the \SpecialChar LyX
18231 class: you can't make text in the middle of a paragraph invisible, nor
18232 make text in the middle of an invisible paragraph visible again.
18233 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18238 \begin_layout Plain Layout
18239 The commands of interest are:
18242 \begin_layout Itemize
18247 invisible \SpecialChar ldots
18251 \begin_layout Itemize
18256 visible \SpecialChar ldots
18260 \begin_layout Plain Layout
18262 and need to be marked as \SpecialChar TeX
18265 \begin_inset Quotes eld
18269 \begin_inset Quotes erd
18272 you wish to change goes in between the brackets [and after the
18285 If you don't know how to mark text as \SpecialChar TeX
18286 , see the appropriate section of
18299 \begin_layout Subsubsection
18309 \begin_inset CommandInset label
18311 name "sec:slideNote"
18318 \begin_layout Standard
18327 is associated with a
18328 \begin_inset Quotes eld
18332 \begin_inset Quotes erd
18340 Here, too, the \SpecialChar LyX
18345 class provides visual cues.
18350 is shorter than that of a
18354 [yet longer than that of an
18358 ] and, like the label of an
18362 is shockingly magenta.
18363 Additionally, the printed
18367 has the page number of its
18368 \begin_inset Quotes eld
18372 \begin_inset Quotes erd
18380 \begin_inset Quotes eld
18388 \begin_inset Quotes erd
18392 \begin_inset Quotes eld
18400 \begin_inset Quotes erd
18404 \begin_inset Quotes eld
18412 \begin_inset Quotes erd
18416 You can have multiple
18420 s associated with a single
18432 , you'll probably want to break up long
18436 s so that they fit on a single sheet of paper.
18439 \begin_layout Standard
18444 is obvious: it contains anything additional you might want to say about
18450 It could also be used as a sheet of reminders for a particular
18455 In the case of the latter, you might want to make use of time markers.
18456 Currently, the \SpecialChar LyX
18462 \begin_inset Quotes eld
18466 \begin_inset Quotes erd
18469 support for time markers, a
18471 Sli\SpecialChar TeX
18475 So, you'll have to resort to using the \SpecialChar LaTeX
18479 \begin_layout Standard
18480 To use time markers, you'll need to specify the extra class option
18481 \begin_inset Quotes eld
18489 \begin_inset Quotes erd
18493 \begin_inset space ~
18497 \begin_inset CommandInset ref
18499 reference "sec:slidesetup"
18504 This option turns on timing marks, which will appear in the lower-left-hand
18510 To set what appears in the time marker, you use the \SpecialChar LaTeX
18512 \begin_inset Quotes eld
18522 \begin_inset Quotes erd
18526 \begin_inset Quotes eld
18536 \begin_inset Quotes erd
18540 The arguments of both commands are time measured in seconds.
18542 \begin_inset Quotes eld
18552 \begin_inset Quotes erd
18555 sets the time marker to a given time.
18557 \begin_inset Quotes eld
18567 \begin_inset Quotes erd
18570 increments the time marker by the specified amount.
18571 Using time markers and
18575 s in this fashion, you can remind yourself how much time to spend on a particula
18583 \begin_layout Standard
18584 There's one last feature to describe.
18585 Clearly, you'd like to print out all of your
18593 s on transparencies while printing all of your
18610 with which it is associated.
18611 What's a person to do?
18614 \begin_layout Standard
18615 Luckily, there are two \SpecialChar LaTeX
18616 commands that allow you to select what to print
18618 Both must be placed into the preamble of your document.
18620 \begin_inset Quotes eld
18632 \begin_inset Quotes erd
18635 will cause the output to contain only the
18644 Correspondingly, the command
18645 \begin_inset Quotes eld
18657 \begin_inset Quotes erd
18660 prevents the output of anything but
18665 I'd advise placing both commands in the preamble and initially comment
18667 You can then preview your entire presentation as you write.
18668 When you're done writing, you can then uncomment one of the two to select
18669 what you want to print.
18670 I like to uncomment
18671 \begin_inset Quotes eld
18683 \begin_inset Quotes erd
18686 , print to a file with
18687 \begin_inset Quotes eld
18695 \begin_inset Quotes erd
18698 in its name, comment it back out, then uncomment
18699 \begin_inset Quotes eld
18711 \begin_inset Quotes erd
18715 \begin_inset Quotes eld
18723 \begin_inset Quotes erd
18727 I can then send either file to a printer, loading transparencies or plain
18728 paper as appropriate.
18731 \begin_layout Standard
18732 You can also provide other arguments to the
18733 \begin_inset Quotes eld
18743 \begin_inset Quotes erd
18747 \begin_inset Quotes eld
18757 \begin_inset Quotes erd
18761 See a good \SpecialChar LaTeX
18765 \begin_layout Subsection
18770 Class Template File
18773 \begin_layout Standard
18774 I have also provided a template file,
18775 \begin_inset Quotes eld
18783 \begin_inset Quotes erd
18791 To use it, begin your new presentation with
18793 File\SpecialChar menuseparator
18795 \begin_inset space ~
18799 \begin_inset space ~
18805 Your new \SpecialChar LyX
18806 presentation file will contain an example
18827 additionally contain an example of the use of
18836 Lastly, the preamble will contain:
18839 \begin_layout LyX-Code
18840 % Uncomment to print out only slides and overlays
18843 \begin_layout LyX-Code
18847 \begin_layout LyX-Code
18853 \begin_inset Newline newline
18859 \begin_layout LyX-Code
18860 % Uncomment to print out only notes
18863 \begin_layout LyX-Code
18867 \begin_layout LyX-Code
18875 \begin_layout Standard
18876 One final thing: I created this class to support the \SpecialChar LaTeX2e
18878 \begin_inset Quotes eld
18883 Sli\SpecialChar TeX
18887 \begin_inset Quotes erd
18890 class, one of the built-in \SpecialChar LaTeX2e
18892 Neither I nor the rest of the \SpecialChar LyX
18893 Team endorse or oppose the use of this built-in
18895 It's here if you want it or need it.
18896 There exist other \SpecialChar LaTeX2e
18897 classes for creating presentations, such as the
18902 \begin_inset space ~
18906 \begin_inset CommandInset ref
18908 reference "sec:foiltex"
18913 \begin_inset Quotes eld
18921 \begin_inset Quotes erd
18924 package [present on some \SpecialChar TeX
18926 The latter is not yet supported under \SpecialChar LyX
18931 \begin_layout Plain Layout
18932 Perhaps you can take on the task\SpecialChar ldots
18938 I know nothing about these other classes.
18939 Try them out to see what sort of alternative they provide.
18942 \begin_layout Chapter
18944 Features needing Extra Software
18947 \begin_layout Section
18948 Checking \SpecialChar TeX
18952 \begin_layout Standard
18958 \begin_layout Subsection
18962 \begin_layout Standard
18971 \begin_layout Plain Layout
18976 is not yet available when you are using the \SpecialChar LaTeX
18977 distribution MiK\SpecialChar TeX
18983 , you'll find in the
18990 \begin_inset space ~
19001 \begin_inset Newline newline
19005 \begin_inset CommandInset href
19007 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
19015 \begin_layout Standard
19018 Chk\SpecialChar TeX
19021 package is a program that was written by
19022 \begin_inset Flex Noun
19025 \begin_layout Plain Layout
19027 \begin_inset space ~
19035 in frustration because some constructs in \SpecialChar LaTeX
19036 are sometimes non-intuitive,
19037 and easy to forget.
19038 The program runs over your \SpecialChar LaTeX
19039 file, checks the integrity of the file, and
19040 flags some common errors.
19041 In other technical words, it is
19045 for \SpecialChar LaTeX
19049 \begin_layout Standard
19050 Well, what is a syntax checker doing in \SpecialChar LyX
19051 which is supposed to produce correct
19053 anyways? The answer is simple: Just as
19057 not only checks the
19061 of C programs, but also does
19065 checks for type-errors,
19067 Chk\SpecialChar TeX
19070 catches some common
19074 errors, in addition to the syntactical ones.
19077 Chk\SpecialChar TeX
19080 is capable of detecting several common errors, such as
19083 \begin_layout Itemize
19084 Ellipsis detection:
19085 \begin_inset Newline newline
19088 Use \SpecialChar ldots
19092 \begin_layout Itemize
19093 No space in front of/after parenthesis:
19094 \begin_inset Newline newline
19100 \begin_layout Itemize
19101 Enforcement of normal space after common abbreviations:
19102 \begin_inset Newline newline
19106 \begin_inset space \thinspace{}
19110 \begin_inset space \space{}
19113 is too wide spacing.
19116 \begin_layout Itemize
19117 Enforcement of end-of-sentence space when the last sentence ends with a
19119 \begin_inset Newline newline
19123 And this is wrong spacing.
19126 \begin_layout Itemize
19127 Space in front of labels and similar commands:
19128 \begin_inset Newline newline
19131 The label should stick right up to the text to avoid falling to a wrong
19134 \begin_inset CommandInset label
19144 \begin_layout Plain Layout
19145 This footnote is in danger of falling off to a wrong page
19150 The label is separated too much.
19153 \begin_layout Itemize
19154 Space in front of references, instead of hard spaces:
19155 \begin_inset Newline newline
19158 If you have bad luck, the text will break right between the referenced text
19159 and reference number, and that's a pity.
19161 \begin_inset CommandInset ref
19163 reference "sec:chktex"
19170 \begin_layout Itemize
19172 \begin_inset Quotes eld
19176 \begin_inset Quotes erd
19180 \begin_inset Formula $\times$
19184 \begin_inset Newline newline
19187 2x2 looks cheap compared to
19188 \begin_inset Formula $2\times2$
19194 \begin_layout Standard
19195 and more \SpecialChar ldots
19196 It is an invaluable tool when you are
19197 \begin_inset Quotes eld
19201 \begin_inset Quotes erd
19204 your document before printing, and you should run it right after the obligatory
19205 spelling check, and before you go fine tuning the typesetting.
19208 \begin_layout Subsection
19212 \begin_layout Standard
19213 If you have the program installed, usage is as simple as choosing
19215 Tools\SpecialChar menuseparator
19217 \begin_inset space ~
19223 This will make \SpecialChar LyX
19224 generate a \SpecialChar LaTeX
19225 file of your document, start
19227 Chk\SpecialChar TeX
19230 to check it, and then make \SpecialChar LyX
19232 \begin_inset Quotes eld
19236 \begin_inset Quotes erd
19239 with the warnings from
19241 Chk\SpecialChar TeX
19244 , if there were any.
19245 The warnings will be placed close to the point of the mistake, and you
19246 can quickly find them by using the
19248 Navigate\SpecialChar menuseparator
19251 menu item, or the shortcut key
19260 Open the error boxes by clicking on them with the mouse, or use the shortcut
19269 bindings, or the corresponding
19278 Read the warning and correct the mistake, if it is a mistake.
19279 If you have trouble understanding what the warning is about, you can safely
19281 Remember that there is a hidden layer between the document on screen and
19282 the technical details in invoking
19284 Chk\SpecialChar TeX
19287 , and this gap can make some warnings seem arcane or just plain silly.
19290 \begin_layout Standard
19291 This document is an excellent testing bed for the feature, and it should
19292 provide quite a few warnings for you to fiddle with.
19293 Since computers are only so smart, expect most of the warnings to be false
19297 \begin_layout Subsection
19298 How to fine tune it
19301 \begin_layout Standard
19302 Sometimes, you'll find that
19304 Chk\SpecialChar TeX
19307 makes more noise than suits your mood.
19308 Then you can choose not to use it, wait until your mood changes, or try
19311 Chk\SpecialChar TeX
19314 to get better along with you.
19317 \begin_layout Standard
19320 Chk\SpecialChar TeX
19327 very configurable and extensible, you should not expect to solve all problems
19330 Chk\SpecialChar TeX
19333 in \SpecialChar LyX
19335 Since \SpecialChar LyX
19336 has to generate a somewhat special \SpecialChar LaTeX
19337 file to be able to match the
19338 line numbers from the
19340 Chk\SpecialChar TeX
19347 \begin_layout Plain Layout
19348 You can inspect the specific output from
19354 Document\SpecialChar menuseparator
19357 \begin_inset space ~
19371 to the internal document structure, some of the warnings will not appear
19373 There are two things you can do about this:
19376 \begin_layout Itemize
19379 Chk\SpecialChar TeX
19382 invocation command line in
19383 \begin_inset Flex Noun
19386 \begin_layout Plain Layout
19387 Tools\SpecialChar menuseparator
19388 Preferences\SpecialChar menuseparator
19389 Output\SpecialChar menuseparator
19390 LaTeX\SpecialChar menuseparator
19398 Chk\SpecialChar TeX
19401 installation configuration file (usually with the file
19406 See below to learn what warnings can be enabled and disabled on the command
19410 \begin_layout Itemize
19411 Export your document as a raw \SpecialChar LaTeX
19414 File\SpecialChar menuseparator
19415 Export\SpecialChar menuseparator
19424 Invoked in this way, it can be a hassle to find the corresponding place
19425 in the document inside \SpecialChar LyX
19426 , but with a little patience, you should be able
19430 \begin_layout Standard
19431 Here follows the warning messages that can be enabled and disabled in
19440 to disable a warning, and
19444 to enable a warning.
19445 The emphasized entries are disabled by default, because the default is
19448 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19453 \begin_layout Standard
19454 Notice that you should only use the options that enable and disable warnings,
19455 because \SpecialChar LyX
19456 relies on some of the other command line parameters to be set
19457 in a specific way to have a chance to communicate with
19464 \begin_layout Enumerate
19468 Command terminated with space.
19471 \begin_layout Enumerate
19474 Non-breaking space (
19475 \begin_inset Quotes eld
19483 \begin_inset Quotes erd
19486 ) should have been used.
19489 \begin_layout Enumerate
19493 You should enclose the previous parenthesis with
19494 \begin_inset Quotes eld
19502 \begin_inset Quotes erd
19508 \begin_layout Enumerate
19511 Italic correction (
19512 \begin_inset Quotes eld
19522 \begin_inset Quotes erd
19525 ) found in non-italic buffer.
19528 \begin_layout Enumerate
19531 Italic correction (
19532 \begin_inset Quotes eld
19542 \begin_inset Quotes erd
19545 ) found more than once.
19548 \begin_layout Enumerate
19552 No italic correction (
19553 \begin_inset Quotes eld
19563 \begin_inset Quotes erd
19569 \begin_layout Enumerate
19573 \begin_inset Quotes eld
19581 \begin_inset Quotes erd
19585 \begin_inset Quotes eld
19593 \begin_inset Quotes erd
19599 \begin_layout Enumerate
19602 Wrong length of dash may have been used.
19605 \begin_layout Enumerate
19609 \begin_inset Quotes eld
19617 \begin_inset Quotes erd
19621 \begin_inset Quotes eld
19629 \begin_inset Quotes erd
19635 \begin_layout Enumerate
19639 \begin_inset Quotes eld
19647 \begin_inset Quotes erd
19653 \begin_layout Enumerate
19657 \begin_inset Quotes eld
19665 \begin_inset Quotes erd
19668 to achieve an ellipsis.
19671 \begin_layout Enumerate
19674 Inter-word spacing (
19675 \begin_inset Quotes eld
19685 \begin_inset Quotes eld
19688 ) should perhaps be used.
19691 \begin_layout Enumerate
19694 Inter-sentence spacing (
19695 \begin_inset Quotes eld
19705 \begin_inset Quotes erd
19708 ) should perhaps be used.
19711 \begin_layout Enumerate
19714 Could not find argument for command.
19717 \begin_layout Enumerate
19721 \begin_inset Quotes eld
19729 \begin_inset Quotes erd
19735 \begin_layout Enumerate
19738 Math mode still on at end of \SpecialChar LaTeX
19742 \begin_layout Enumerate
19746 \begin_inset Quotes eld
19754 \begin_inset Quotes erd
19757 doesn't match the number of
19758 \begin_inset Quotes eld
19766 \begin_inset Quotes erd
19772 \begin_layout Enumerate
19775 You should use either
19778 \begin_inset Quotes eld
19786 \begin_inset Quotes erd
19791 as an alternative to
19792 \begin_inset Quotes eld
19800 \begin_inset Quotes erd
19806 \begin_layout Enumerate
19813 " (ASCII 39) instead of "
19820 \begin_layout Enumerate
19823 User-specified pattern found.
19826 \begin_layout Enumerate
19829 This command might not be intended.
19832 \begin_layout Enumerate
19839 \begin_layout Enumerate
19857 \begin_layout Enumerate
19860 Delete this space to maintain correct page references.
19863 \begin_layout Enumerate
19867 You might wish to put this between a pair of
19868 \begin_inset Quotes eld
19876 \begin_inset Quotes erd
19882 \begin_layout Enumerate
19885 You ought to remove spaces in front of punctuation.
19888 \begin_layout Enumerate
19891 Could not execute \SpecialChar LaTeX
19895 \begin_layout Enumerate
19904 in front of small punctuation.
19907 \begin_layout Enumerate
19915 may look prettier here.
19918 \begin_layout Enumerate
19922 Multiple spaces detected in output.
19925 \begin_layout Enumerate
19928 This text may be ignored.
19931 \begin_layout Enumerate
19937 \begin_inset Quotes eld
19942 to begin quotation, not
19949 \begin_layout Enumerate
19956 to end quotation, not
19959 \begin_inset Quotes eld
19967 \begin_layout Enumerate
19973 \begin_layout Enumerate
19976 You should perhaps use
19977 \begin_inset Quotes eld
19985 \begin_inset Quotes erd
19991 \begin_layout Enumerate
19994 You should put a space in front of/after parenthesis.
19997 \begin_layout Enumerate
20000 You should avoid spaces in front of/after parenthesis.
20003 \begin_layout Enumerate
20007 You should not use punctuation in front of/after quotes.
20010 \begin_layout Enumerate
20013 Double space found.
20016 \begin_layout Enumerate
20019 You should put punctuation outside inner/inside display math mode.
20022 \begin_layout Enumerate
20025 You ought to not use primitive \SpecialChar TeX
20026 in \SpecialChar LaTeX
20030 \begin_layout Enumerate
20033 You should remove spaces in front of
20034 \begin_inset Quotes eld
20042 \begin_inset Quotes erd
20048 \begin_layout Enumerate
20051 \begin_inset Quotes eld
20059 \begin_inset Quotes erd
20062 is normally not followed by
20063 \begin_inset Quotes eld
20071 \begin_inset Quotes erd
20077 \begin_layout Standard
20078 In later versions of \SpecialChar LyX
20079 , we hope to provide a more complete interface to this
20080 tool (and it's smaller cousin
20084 ) to exploit the full power of it.
20085 But it's not exactly useless as it is now: go try it on one of your existing
20086 documents of a certain length and be surprised.
20089 \begin_layout Section
20090 Version Control in \SpecialChar LyX
20094 \begin_layout Standard
20097 Lars Gullik Bjønnes
20104 \begin_layout Subsection
20108 \begin_layout Standard
20110 supports some of the most basic RCS/CVS/SVN/GIT commands.
20111 If you need something a bit more sophisticated you will have to do that
20112 manually in a terminal.
20115 \begin_layout Standard
20116 Also note that CVS support is not as good as subversion support so we advise
20118 A good place to start learning Subversion is SVN Book
20122 \begin_layout Plain Layout
20123 \begin_inset CommandInset href
20125 target "http://svnbook.red-bean.com/"
20136 In the case of RCS you should read
20137 \begin_inset Quotes eld
20141 \begin_inset Quotes erd
20144 (a man file, read it with
20149 This file describes all the basic features of RCS.
20150 You should especially notice the comment about a RCS directory, and the
20151 notion of a master RCS file (the file ending in
20158 \begin_layout Standard
20159 Before you begin to use the version control features in \SpecialChar LyX
20161 familiar with RCS/CVS/SVN/GIT usage.
20162 The implementation in \SpecialChar LyX
20163 assumes a recent version of the GNU RCS or CVS/SVN
20164 package — no guarantees are made for older versions.
20165 Most of the log messages are not currently displayed after operations —
20166 you can check them in the Messages pane if unsure.
20167 Regular users of version control will appreciate VC toolbar, which can
20170 View\SpecialChar menuseparator
20171 Toolbars\SpecialChar menuseparator
20173 \begin_inset space ~
20181 \begin_layout Standard
20182 For introducing your own external commands consult vc-command in the manual
20183 of \SpecialChar LyX
20187 \begin_layout Standard
20188 It is strongly recommended to store documents in uncompressed format if
20189 using version control (uncheck
20191 Document\SpecialChar menuseparator
20194 if it is checked): Uncompressed LyX documents are text files and therefore
20195 for merging two different versions by version control systems.
20196 Compressed LyX documents are binary files, which cannot be merged by version
20200 \begin_layout Subsection
20201 RCS commands in \SpecialChar LyX
20205 \begin_layout Standard
20206 The following sections describe the RCS commands supported by \SpecialChar LyX
20208 You can find them in the
20210 File\SpecialChar menuseparator
20212 \begin_inset space ~
20219 was tested against RCS 5.7/5.8.
20222 \begin_layout Subsubsection
20228 \begin_layout Standard
20229 If your document is not under revision control, this is the only item shown
20231 And if it is under revision control, the
20235 item is not visible.
20239 \begin_layout Standard
20240 This command registers your document with RCS (unless you are under the
20241 directory managed by CVS)\SpecialChar endofsentence
20242 You are asked interactively to supply an initial
20243 description of the document.
20244 The document is now set in Read-Only mode and you have to
20247 \begin_inset space ~
20251 \begin_inset space ~
20255 \begin_inset space ~
20260 , before making any changes to it.
20261 A document under revision control has a
20262 \begin_inset Quotes eld
20265 [RCS:<version> <locker>]
20266 \begin_inset Quotes erd
20269 item tagged to the filename in the minibuffer.
20272 \begin_layout Standard
20273 RCS command that is run:
20275 ci -q -u -i -t-"<initial description>" <file-name>
20278 \begin_layout Standard
20283 to understand the switches.
20287 \begin_layout Subsubsection
20293 \begin_layout Standard
20294 When you are finished editing a file, you check in your changes.
20295 When you do this, you are asked for a description of the changes.
20296 This is stored in the history log.
20297 The version number is bumped, your changes are applied to the master RCS
20298 file, the document is unlocked and set to Read-Only mode.
20301 \begin_layout Standard
20304 ci -q -u -m"<description>" <file-name>
20307 \begin_layout Subsubsection
20313 \begin_layout Standard
20314 By doing this you lock the document so that only you can edit it.
20315 This will also make the document Read-Write only for you.
20316 You will usually continue editing for a while and when you are finished
20317 you check in your changes.
20318 The status line is changed to reflect that you have locked the file.
20321 \begin_layout Standard
20324 co -q -l <file-name>
20327 \begin_layout Subsubsection
20330 Revert To Repository Version
20333 \begin_layout Standard
20334 This will discard all changes made to the document since the last check
20336 You get a warning before changes are discarded.
20339 \begin_layout Standard
20342 co -f -u<version> <file-name>
20345 \begin_layout Subsubsection
20351 \begin_layout Standard
20352 This will create a copy of the current document.
20353 Since RCS does not support copy operations natively, the version history
20354 is not preserved, and the copy is added as a new file.
20355 It requires a clean document without any changes since the last checkin.
20356 You are asked for a file name and a description of the copy operation.
20357 After that the copy is created, both locally and in the repository.
20358 If the parent directories of the copied and original document differ, all
20359 relative paths of included files of the copy are adjusted (like in
20361 File\SpecialChar menuseparator
20366 Finally, the copy is loaded instead of the original document.
20369 \begin_layout Labeling
20370 \labelwidthstring 00.00.0000
20372 \begin_inset space ~
20376 \begin_inset space ~
20380 \begin_inset Newline newline
20384 \begin_inset Flex Code
20387 \begin_layout Plain Layout
20390 \begin_inset Quotes eld
20394 \begin_inset Quotes erd
20403 \begin_inset Flex Code
20406 \begin_layout Plain Layout
20409 \begin_inset Quotes eld
20413 \begin_inset Quotes erd
20422 \begin_inset Newline newline
20426 \begin_inset Flex Code
20429 \begin_layout Plain Layout
20433 \begin_inset Quotes eld
20437 \begin_inset Quotes erd
20448 \begin_layout Subsubsection
20454 \begin_layout Standard
20455 This makes as if the last check in never happened.
20456 No changes are made to the document loaded into \SpecialChar LyX
20457 , but the last version
20458 is removed from the master RCS file.
20461 \begin_layout Standard
20464 rcs -o<version> <file-name>
20467 \begin_layout Subsubsection
20473 \begin_layout Standard
20474 This shows the complete history of the RCS document.
20479 is shown in a browser.
20487 \begin_layout Subsubsection
20491 \begin_layout Standard
20493 supports RCS version number, author name, date and time of last commit.
20494 All those are extracted from
20496 rlog -r <file-name>
20500 \begin_inset CommandInset ref
20502 reference "subsec:VCS-Revision-Information"
20509 \begin_layout Subsection
20510 CVS commands in \SpecialChar LyX
20514 \begin_layout Standard
20515 A subset of CVS operations is supported by \SpecialChar LyX
20517 You can find the commands in the
20519 File\SpecialChar menuseparator
20521 \begin_inset space ~
20527 The version control system SVN is more powerful, so please use it instead
20528 of CVS if possible.
20531 \begin_layout Subsubsection
20537 \begin_layout Standard
20538 If you start from scratch with CVS you have to create your repository and
20539 checkout the working copy with external tools.
20540 If you're using a client-server setup you may need to login before doing
20541 the first repository checkout.
20544 \begin_layout Standard
20545 If your documents are under revision control and others are using the same
20546 repository problems arise when different changes to the same document at
20547 the same location happen.
20548 Standard CVS repositories don't operate with a file locking mechanism.
20549 This may be surprising, but conflicts only occur if people disagree on
20550 the proper content of the same part of a document.
20551 So, if co-workers are used to communicate regularly, these conflicts occur
20553 If they don't communicate they have a fundamental problem anyway.
20554 Nevertheless some people like to work with so called
20555 \begin_inset Quotes eld
20559 \begin_inset Quotes erd
20563 If they do so the working copy of all files is readonly when checked out
20564 first and the user starts editing after using a special command to make
20565 the working copy writable.
20566 When the changes are checked in the working copy returns to readonly state.
20567 With \SpecialChar LyX
20568 one has to edit the
20569 \begin_inset Flex Code
20572 \begin_layout Plain Layout
20578 file and add the line
20579 \begin_inset Flex Code
20582 \begin_layout Plain Layout
20588 to work with reserved checkouts.
20589 The benefit is the possibility to see who is using a writable copy of some
20591 It's not guaranteed only one user makes a copy writable.
20594 \begin_layout Standard
20596 tries to guess if you're using reserved or non-reserved checkouts.
20597 If your working copy is readonly or it is writable and an additional copy
20598 of your document exists in the CVS/Base sub-directory a reserved otherwise
20599 a non-reserved checkout is assumed.
20600 When a reserved checkout is detected you have to use
20601 \begin_inset Flex Noun
20604 \begin_layout Plain Layout
20610 to make your working copy writable if it's readonly.
20612 \begin_inset Flex Noun
20615 \begin_layout Plain Layout
20621 operation is possible and that makes your working copy readonly again after
20622 transferring your changes to the repository.
20625 \begin_layout Standard
20626 More information about CVS can be found here
20627 \begin_inset Flex URL
20630 \begin_layout Plain Layout
20632 http://www.nongnu.org/cvs
20638 \begin_inset Flex URL
20641 \begin_layout Plain Layout
20643 http://ximbiot.com/cvs
20651 \begin_layout Standard
20656 to understand the sub-commands and the switches mentioned below.
20659 \begin_layout Subsubsection
20665 \begin_layout Standard
20666 If your document is not under revision control, this is the only item shown
20668 And if it is under revision control, the
20672 item is not visible.
20676 \begin_layout Standard
20677 This command registers in CVS your document
20678 \begin_inset Flex Strong
20681 \begin_layout Plain Layout
20689 in the case you have already the documents directory under CVS control
20695 This means you have to create or checkout the archive by yourself using
20697 (In case you forget that step \SpecialChar LyX
20698 registers the document with RCS.)
20701 \begin_layout Standard
20702 Then you are asked interactively to supply an initial description of the
20704 Don't forget that registered file is not yet checked in.
20707 \begin_layout Standard
20708 CVS command that is run:
20710 cvs -q add -m"<entered message>" "<file-name>"
20713 \begin_layout Standard
20718 above and for all other CVS commands is an abbreviation for
20719 \begin_inset Quotes eld
20722 change the current working directory to file location and use the file name
20723 without path component as argument
20724 \begin_inset Quotes erd
20730 \begin_layout Subsubsection
20736 \begin_layout Standard
20737 When you are finished editing a file, you commit your changes.
20738 When you do this and you had changed the document, you are asked for a
20739 description of the changes.
20740 After that changes are written to the repository.
20741 In case you didn't change the document and a reserved checkout is detected
20742 the reservation made on
20743 \begin_inset Flex Noun
20746 \begin_layout Plain Layout
20755 \begin_layout Labeling
20756 \labelwidthstring 00.00.0000
20758 \begin_inset space ~
20762 \begin_inset space ~
20766 \begin_inset Newline newline
20770 \begin_inset Flex Code
20773 \begin_layout Plain Layout
20776 -q commit -m"<description>" "<file-name>"
20782 \begin_inset Newline newline
20786 \begin_inset Flex Code
20789 \begin_layout Plain Layout
20800 \begin_layout Subsubsection
20806 \begin_layout Standard
20807 When you are sharing a repository with others, you may have to incorporate
20808 their changes into your working copy.
20811 \begin_layout Standard
20814 cvs -q update "<file-name>"
20817 \begin_layout Standard
20818 If a readonly checkout is detected the working copy is made writable and
20822 \begin_layout Standard
20825 cvs -q edit "<file-name>"
20828 \begin_layout Subsubsection
20831 Revert To Repository Version
20834 \begin_layout Standard
20835 This will discard all changes made to the document since the last check
20837 You get a warning before changes are discarded.
20838 Firstly the file is deleted, secondly CVS update command is run.
20841 \begin_layout Standard
20844 cvs -q update "<file-name>"
20847 \begin_layout Standard
20848 If a reserved checkout is detected and the working copy has no changes only
20849 the reservation is undone.
20852 \begin_layout Standard
20855 cvs -q unedit "<file-name>"
20858 \begin_layout Subsubsection
20864 \begin_layout Standard
20865 This will create a copy of the current document.
20866 Since CVS does not support copy operations natively, the version history
20867 is not preserved, and the copy is added as a new file.
20868 It requires a clean document without any changes since the last checkin.
20869 You are asked for a file name and a description of the copy operation.
20870 After that the copy is created, both locally and in the repository.
20871 If the parent directories of the copied and original document differ, all
20872 relative paths of included files of the copy are adjusted (like in
20874 File\SpecialChar menuseparator
20879 Finally, the copy is loaded instead of the original document.
20882 \begin_layout Labeling
20883 \labelwidthstring 00.00.0000
20885 \begin_inset space ~
20889 \begin_inset space ~
20893 \begin_inset Newline newline
20897 \begin_inset Flex Code
20900 \begin_layout Plain Layout
20903 \begin_inset Quotes eld
20907 \begin_inset Quotes erd
20916 \begin_inset Flex Code
20919 \begin_layout Plain Layout
20922 \begin_inset Quotes eld
20926 \begin_inset Quotes erd
20935 \begin_inset Newline newline
20939 \begin_inset Flex Code
20942 \begin_layout Plain Layout
20946 \begin_inset Quotes eld
20950 \begin_inset Quotes erd
20961 \begin_layout Subsubsection
20967 \begin_layout Standard
20968 This will rename the current document.
20969 Since CVS does not support rename operations natively, the version history
20970 is not preserved, the renamed document is added as a new file, and the
20971 original document is deleted.
20972 It requires a clean document without any changes since the last checkin.
20973 You are asked for a file name and a description of the rename operation.
20974 After that the document is renamed, both locally and in the repository.
20975 If the parent directories of the new and old file names differ, all relative
20976 paths of included files are adjusted (like in
20978 File\SpecialChar menuseparator
20983 Finally, the document is reloaded using the new name.
20986 \begin_layout Labeling
20987 \labelwidthstring 00.00.0000
20989 \begin_inset space ~
20993 \begin_inset space ~
20997 \begin_inset Newline newline
21001 \begin_inset Flex Code
21004 \begin_layout Plain Layout
21007 \begin_inset Quotes eld
21011 \begin_inset Quotes erd
21020 \begin_inset Flex Code
21023 \begin_layout Plain Layout
21026 \begin_inset Quotes eld
21030 \begin_inset Quotes erd
21039 \begin_inset Newline newline
21043 \begin_inset Flex Code
21046 \begin_layout Plain Layout
21050 \begin_inset Quotes eld
21054 \begin_inset Quotes erd
21063 \begin_inset Newline newline
21067 \begin_inset Flex Code
21070 \begin_layout Plain Layout
21074 \begin_inset Quotes eld
21078 \begin_inset Quotes erd
21089 \begin_layout Subsubsection
21090 Update of the local directory checkout from repository
21093 \begin_layout Standard
21094 Once your documents gets more complex, containing sub-documents and pictures,
21096 \begin_inset Flex Code
21099 \begin_layout Plain Layout
21105 files and so on using version control becomes more complicated.
21107 supports updating the whole tree in which resides the document.
21108 This become especially useful once you cooperate with people which neither
21109 have detailed knowledge about CVS usage nor they have ambition to commit
21110 additional material to the repository.
21111 You have to organize the files structure so that all external files are
21112 in the same directory or subdirectories of the document.
21113 It's good practice anyway to store multipart documents in an extra directory.
21116 \begin_layout Standard
21118 \begin_inset Flex Code
21121 \begin_layout Plain Layout
21122 Update local directory from repository
21127 command updates the whole directory.
21128 If local changes are detected user is warned before update starts.
21129 In case of merge conflicts both versions of the conflicting document parts
21130 are placed in the final document.
21131 You have to review and correct the result of the merge.
21132 You'll find the conflicts enclosed in pairs of
21133 \begin_inset Flex Code
21136 \begin_layout Plain Layout
21143 \begin_inset Flex Code
21146 \begin_layout Plain Layout
21153 \begin_inset Flex Code
21156 \begin_layout Plain Layout
21163 The first part is your version as before the update operation with the
21164 document name prepended.
21165 The second one is the repository version with the version number after
21167 \begin_inset Flex Code
21170 \begin_layout Plain Layout
21179 \begin_layout Labeling
21180 \labelwidthstring 00.00.0000
21182 \begin_inset space ~
21186 \begin_inset space ~
21190 \begin_inset Newline newline
21194 \begin_inset Flex Code
21197 \begin_layout Plain Layout
21205 (Ask if changes are detected.)
21206 \begin_inset Newline newline
21210 \begin_inset Flex Code
21213 \begin_layout Plain Layout
21214 cd $path; cvs -q update
21224 \begin_layout Standard
21226 \begin_inset Flex Code
21229 \begin_layout Plain Layout
21235 stands for the path to the document.
21238 \begin_layout Subsubsection
21244 \begin_layout Standard
21245 This shows the complete history of the CVS document.
21248 cvs log "<file-name>"
21250 is shown in a browser.
21253 \begin_layout Subsubsection
21257 \begin_layout Standard
21259 supports CVS version number, author name, date and time of last commit.
21260 All those are extracted from
21262 cvs log -r <file-name>
21266 \begin_inset CommandInset ref
21268 reference "subsec:VCS-Revision-Information"
21275 \begin_layout Subsection
21276 SVN commands in \SpecialChar LyX
21280 \begin_layout Standard
21281 SVN is now partially supported by \SpecialChar LyX
21283 You can find the commands in the
21285 File\SpecialChar menuseparator
21287 \begin_inset space ~
21293 Please note that if you use password protected access to repository via
21294 ssh, you will be asked in terminal window.
21296 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21300 \begin_layout Plain Layout
21301 Most of the commands will work with 1.4 too, see
21302 \begin_inset CommandInset ref
21304 reference "subsec:SVN-Repo-Update"
21309 There seems to be currently unresolved permissions problem under SVN 1.8
21310 with reverting changes when file is locked.
21318 \begin_layout Subsubsection
21324 \begin_layout Standard
21325 If your document is not under revision control, this is the only item shown
21327 And if it is under revision control, the
21331 item is not visible.
21334 \begin_layout Standard
21335 This command registers in SVN your document ONLY in case you have already
21336 the documents directory under SVN control (in particular
21341 This means you have to checkout the archive by yourself.
21344 \begin_layout Standard
21345 Then you are asked interactively to supply an initial description of the
21347 Don't forget that registered file is not yet commited.
21350 \begin_layout Standard
21351 SVN command that is run:
21354 \begin_inset Quotes eld
21358 \begin_inset Quotes erd
21364 \begin_layout Standard
21369 to understand the switches.
21372 \begin_layout Subsubsection
21378 \begin_layout Standard
21379 When you are finished editing a file, you commit your changes.
21380 When you do this, you are asked for a description of the changes.
21381 After that changes are commited.
21384 \begin_layout Standard
21389 \begin_layout Plain Layout
21390 In case locking is not enabled.
21392 \begin_inset CommandInset ref
21394 reference "subsec:SVN-File-Locking"
21405 svn commit -q -m"<description>" <file-name>
21408 \begin_layout Subsubsection
21414 \begin_layout Standard
21415 Updates the changes of this file from the repository.
21416 Be sure you understand SVN merging and conflicts resolving before using
21417 this function, because all conflicts has to be resolved manually by you!
21420 \begin_layout Standard
21425 \begin_layout Plain Layout
21433 svn update --non-interactive
21434 \begin_inset Quotes eld
21438 \begin_inset Quotes erd
21444 \begin_layout Subsubsection
21447 Revert To Repository Version
21450 \begin_layout Standard
21451 This will discard all changes made to the document since the last check
21453 You get a warning before changes are discarded.
21456 \begin_layout Standard
21460 \begin_inset Quotes eld
21464 \begin_inset Quotes erd
21470 \begin_layout Subsubsection
21476 \begin_layout Standard
21477 This will create a copy of the current document including the version history.
21478 It requires a clean document without any changes since the last checkin.
21479 You are asked for a file name and a description of the copy operation.
21480 After that the copy is created, both locally and in the repository.
21481 If the parent directories of the copied and original document differ, all
21482 relative paths of included files of the copy are adjusted (like in
21484 File\SpecialChar menuseparator
21489 Finally, the copy is loaded instead of the original document.
21492 \begin_layout Labeling
21493 \labelwidthstring 00.00.0000
21495 \begin_inset space ~
21499 \begin_inset space ~
21503 \begin_inset Newline newline
21507 \begin_inset Flex Code
21510 \begin_layout Plain Layout
21514 \begin_inset Quotes eld
21518 \begin_inset Quotes erd
21522 \begin_inset Quotes eld
21526 \begin_inset Quotes erd
21535 \begin_inset Newline newline
21539 \begin_inset Flex Code
21542 \begin_layout Plain Layout
21551 \begin_layout Subsubsection
21557 \begin_layout Standard
21558 This will rename the current document including the version history.
21559 It requires a clean document without any changes since the last checkin.
21560 You are asked for a file name and a description of the rename operation.
21561 After that the document is renamed, both locally and in the repository.
21562 If the parent directories of the new and old file names differ, all relative
21563 paths of included files are adjusted (like in
21565 File\SpecialChar menuseparator
21570 Finally, the document is reloaded using the new name.
21573 \begin_layout Labeling
21574 \labelwidthstring 00.00.0000
21576 \begin_inset space ~
21580 \begin_inset space ~
21584 \begin_inset Newline newline
21588 \begin_inset Flex Code
21591 \begin_layout Plain Layout
21595 \begin_inset Quotes eld
21599 \begin_inset Quotes erd
21603 \begin_inset Quotes eld
21607 \begin_inset Quotes erd
21616 \begin_inset Newline newline
21620 \begin_inset Flex Code
21623 \begin_layout Plain Layout
21632 \begin_layout Subsubsection
21633 \begin_inset CommandInset label
21635 name "subsec:SVN-Repo-Update"
21639 Update of the local directory checkout from repository
21643 \begin_layout Plain Layout
21644 Note that this command will work only with subversion
21645 \begin_inset Formula $\geqq1.5$
21656 \begin_layout Standard
21657 All the commands above have one shortcomming - they deal with the current
21659 Once your document contains pictures, includes external
21660 \begin_inset Flex Code
21663 \begin_layout Plain Layout
21669 files and so on administration becomes more complicated.
21671 now supports updating the whole tree in which resides the document
21675 \begin_layout Plain Layout
21676 One need to organize the files structure so that all external files are
21677 in the same directory or subdirectories of the document.
21684 This become especially useful once you cooperate with people which neither
21685 know about subversion management nor they have ambition to commit additional
21686 material to the repository.
21690 \begin_layout Standard
21691 \begin_inset Flex Code
21694 \begin_layout Plain Layout
21695 Update local directory from repository
21700 command updates the whole directory and in case of merge conflicts local
21701 version of the files are left, so no unintended data loss occurs.
21702 If local changes are detected user is warned before update starts.
21705 \begin_layout Labeling
21706 \labelwidthstring 00.00.0000
21708 \begin_inset space ~
21712 \begin_inset space ~
21716 \begin_inset Newline newline
21720 \begin_inset Flex Code
21723 \begin_layout Plain Layout
21729 (Ask if changes are detected.)
21730 \begin_inset Newline newline
21734 \begin_inset Flex Code
21737 \begin_layout Plain Layout
21738 svn update –accept mine-full $path
21746 \begin_layout Standard
21748 \begin_inset Flex Code
21751 \begin_layout Plain Layout
21757 stands for the path to the document.
21760 \begin_layout Subsubsection
21766 \begin_layout Standard
21767 This shows the complete history of the SVN document.
21771 \begin_inset Quotes eld
21775 \begin_inset Quotes erd
21780 is shown in a browser.
21783 \begin_layout Subsubsection
21785 \begin_inset CommandInset label
21787 name "subsec:SVN-File-Locking"
21794 \begin_layout Standard
21795 The file exchange through various revision control systems brings the problem
21796 of merge conflicts in case two different users try to edit the same (parts
21798 When such a conflict happens it needs manual resolving and one reasonable
21799 alternative is to provide some kind of locking mechanism, which guarantees
21800 that only one user is allowed to edit file at the given time.
21803 \begin_layout Standard
21804 SVN has two such mechanisms to provide mutual exclusivity for file access
21805 - locks and automatic setting of write permissions (see sec.
21807 \begin_inset CommandInset ref
21809 reference "subsec:Automatical-Locking-Property"
21814 \begin_inset Flex Code
21817 \begin_layout Plain Layout
21827 \begin_layout Plain Layout
21828 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21834 If this property is detected for a given document \SpecialChar LyX
21835 starts to use SVN locks
21836 for document editing automatically and the whole check-in/out mechanism
21837 switches to the same regimen as for RCS.
21838 This in particular means there are two different modes of file use in \SpecialChar LyX
21842 \begin_layout Itemize
21844 The loaded file is in the read-only mode.
21845 For editing on needs to check-out.
21850 consists of updating from the repository and gaining write lock.
21851 If the lock is not possible to obtain, we remain in unlocked state.
21854 \begin_layout Itemize
21856 The loaded file is in the 'normal' edit mode.
21857 No other user is allowed to edit the file.
21862 consists of commiting changes and releasing write-lock.
21863 If no changes have been made to the document, no commit will be produced
21867 \begin_layout Plain Layout
21868 Don't be puzzled by the fact that you will be asked for commit message anyway.
21873 and only the write-lock will be released.
21876 \begin_layout Standard
21880 \begin_layout Labeling
21881 \labelwidthstring 00.00.0000
21884 svn commit -q -m"<description>" "<file-name>"
21885 \begin_inset Newline newline
21888 svn unlock "<file-name>"
21891 \begin_layout Labeling
21892 \labelwidthstring 00.00.0000
21895 svn update "<file-name>"
21896 \begin_inset Newline newline
21899 svn lock "<file-name>"
21902 \begin_layout Subsubsection
21905 \begin_inset CommandInset label
21907 name "subsec:Automatical-Locking-Property"
21913 Automatic Locking Property
21916 \begin_layout Standard
21917 The above mentioned automatic setting of write permissions of the .lyx file
21920 File\SpecialChar menuseparator
21922 \begin_inset space ~
21925 Control\SpecialChar menuseparator
21926 Toggle locking property
21929 This command is active only when the file is not locked on the svn server
21931 you need to check-out before proceeding).
21934 \begin_layout Labeling
21935 \labelwidthstring 00.00.0000
21937 \begin_inset space ~
21943 \begin_layout Labeling
21944 \labelwidthstring 00.00.0000
21947 svn propset svn:needs-lock ON "<file-name>"
21950 \begin_layout Labeling
21951 \labelwidthstring 00.00.0000
21954 svn propdel svn:needs-lock "<file-name>"
21957 \begin_layout Subsubsection
21958 \begin_inset CommandInset label
21960 name "subsec:VCS-Revision-Information"
21964 Revision Information in Documents
21967 \begin_layout Standard
21968 There are more possibilities how to activate revision information in our
21972 \begin_layout Itemize
21978 \begin_layout Itemize
21979 tree revision information (
21980 \begin_inset Flex Code
21983 \begin_layout Plain Layout
21990 The result is the output of the
21991 \begin_inset Flex Code
21994 \begin_layout Plain Layout
22000 command, the following table gives you an idea, how to read the results.
22003 \begin_layout Standard
22005 \begin_inset Tabular
22006 <lyxtabular version="3" rows="6" columns="2">
22007 <features tabularvalignment="middle">
22008 <column alignment="center" valignment="top">
22009 <column alignment="center" valignment="top">
22011 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22014 \begin_layout Plain Layout
22020 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22023 \begin_layout Plain Layout
22031 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22034 \begin_layout Plain Layout
22040 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22043 \begin_layout Plain Layout
22044 mixed revision working copy
22051 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22054 \begin_layout Plain Layout
22060 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22063 \begin_layout Plain Layout
22064 modified working copy
22071 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22074 \begin_layout Plain Layout
22080 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22083 \begin_layout Plain Layout
22084 switched working copy
22091 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22094 \begin_layout Plain Layout
22100 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22103 \begin_layout Plain Layout
22104 partial working copy, from a sparse checkout
22111 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22114 \begin_layout Plain Layout
22120 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22123 \begin_layout Plain Layout
22124 mixed revision, modified, switched working copy
22137 \begin_layout Itemize
22138 file revision information.
22139 The result comes from parsing the output of
22140 \begin_inset Flex Code
22143 \begin_layout Plain Layout
22145 \begin_inset space ~
22149 \begin_inset space ~
22153 \begin_inset space ~
22162 Supported flags are:
22166 \begin_layout Itemize
22167 version number of the last commit (
22168 \begin_inset Flex Code
22171 \begin_layout Plain Layout
22180 \begin_layout Itemize
22181 author of the last commit (
22182 \begin_inset Flex Code
22185 \begin_layout Plain Layout
22194 \begin_layout Itemize
22195 date of the last commit (
22196 \begin_inset Flex Code
22199 \begin_layout Plain Layout
22208 \begin_layout Itemize
22209 time of the last commit (
22210 \begin_inset Flex Code
22213 \begin_layout Plain Layout
22223 \begin_layout Standard
22224 You can obtain this info via InsetInfo (e.g.
22226 \begin_inset Flex Code
22229 \begin_layout Plain Layout
22230 info-insert buffer vcs-date
22236 The information will be available only when you have the file stored under
22237 svn managment (i.e.
22239 \begin_inset Flex Code
22242 \begin_layout Plain Layout
22248 directory is available with your document).
22252 \begin_layout Itemize
22253 Another—a hacking one—possibility is to use svn keywords
22257 \begin_layout Plain Layout
22258 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22264 In short – you set file keywords property (e.g.
22267 svn propset svn:keywords 'Rev' file.lyx
22269 ) and then paste keyword \SpecialChar TeX
22274 \begin_layout Plain Layout
22275 This is an easy way how to ensure that \SpecialChar LyX
22276 won't break the line in the middle
22282 tag in your document (e.g.
22287 \begin_layout Plain Layout
22295 This way svn client will automatically substitute revision number (e.g.
22300 \begin_layout Plain Layout
22307 ) after each update and commit.
22308 There are more problems with this approach.
22309 Firstly, the '$' character is used in \SpecialChar TeX
22310 world for math equations, so any
22311 occurence of math formula
22312 \begin_inset Formula $Rev$
22316 \begin_inset Formula $Rev:59$
22319 in your \SpecialChar LyX
22321 Similarly for other keywords like Id, Date, Author, etc.
22322 Secondly svn output is dependent on your locales, so its very easy that
22323 svn would produce some problematic strings once Date is used.
22324 Thirdly you get the whole 'Rev: 59' string in your document instead of
22326 Until subversion implements user's custom keywords it will be hard to use
22327 this approach reliably or let \SpecialChar LyX
22328 to support it directly.
22331 \begin_layout Subsection
22332 SVN and Windows Environment
22335 \begin_layout Quote
22336 My inclination is to say that if the user cannot figure out the command
22337 line operations on their own fairly quickly, they would be well advised
22338 to use TortoiseSVN.
22344 \begin_layout Subsubsection
22348 \begin_layout Standard
22349 In addition to installing \SpecialChar LyX
22350 , and having access to a Subversion repository,
22351 the user will need to install the Subversion client program.
22352 A Windows installer for the client program is available from
22353 \begin_inset CommandInset href
22356 target "http://www.collab.net/nonav/downloads/subversion/"
22362 The user may also want to install
22363 \begin_inset CommandInset href
22366 target "http://tortoisesvn.tigris.org/"
22371 , which integrates Subversion operations into the context (rightclick) menu
22372 of Windows Explorer.
22373 Operations done outside \SpecialChar LyX
22374 will typically be more convenient using the Explorer
22376 Note that TortoiseSVN is not a replacement for the client program, which
22377 is what \SpecialChar LyX
22381 \begin_layout Subsubsection
22382 Bringing a document under Subversion control
22385 \begin_layout Standard
22386 Before a \SpecialChar LyX
22387 document can be brought under version control in Subversion, its
22388 parent directory needs to be under version control.
22389 If the document is being added to a project already in the repository,
22390 this is accomplished by checking the project out to the directory where
22391 the new document will be placed.
22392 If the project itself is not yet under version control (for instance, if
22393 this document starts a new project), the directory must be imported into
22395 This is done outside \SpecialChar LyX
22397 Both import and checkout are easily accomplished from the Explorer context
22398 menu using TortoiseSVN, or alternatively can be done using the command
22399 line client at a DOS prompt.
22400 The procedure for importing the project using TortoiseSVN is described
22401 below, assuming an existing repository and a new project being started
22409 For information on using the Subversion client program, run
22416 \begin_layout Enumerate
22423 in Windows Explorer, right click it, and select
22425 TortoiseSVN\SpecialChar menuseparator
22429 If necessary, adjust the URL for the repository, then click OK.
22432 \begin_layout Enumerate
22433 Right click the level of the repository under which you want to place the
22434 new project folder (typically the top level) and click
22438 Supply a name for the project folder and click OK.
22439 Add a message for the log file if desired, then click OK again.
22440 The new project folder should appear in the repository.
22441 Finally, click OK again to exit the repository browser.
22444 \begin_layout Enumerate
22445 Once again right click
22451 , this time selecting SVN Checkout\SpecialChar ldots
22452 Select the URL of the project folder
22453 you just created in the repository, and set the checkout directory to
22461 You will be warned about a non-empty folder; click OK to proceed.
22462 You should now have a
22473 \begin_layout Enumerate
22474 Create or open your document in \SpecialChar LyX
22477 File\SpecialChar menuseparator
22479 \begin_inset space ~
22482 Control\SpecialChar menuseparator
22486 Add a log message and click OK to commit the document to version control.
22489 \begin_layout Standard
22490 From this point onward, you should have full functionality in the
22492 File\SpecialChar menuseparator
22494 \begin_inset space ~
22500 You also have the option of checking the document in and out, viewing its
22502 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22503 client program from a command prompt.
22506 \begin_layout Subsubsection
22507 SSH tunnel used with SVN under Windows
22510 \begin_layout Standard
22511 Compared with Linux setting up an svn client to communicate over ssh under
22512 Windows is a rather troublesome task.
22513 We will at least offer some hints how to setup the client side but prior
22514 knowledge about ssh and the Windows command line is needed, also be prepared
22515 for a great deal of frustration\SpecialChar ldots
22519 \begin_layout Enumerate
22520 Get an svn client for windows, as described in the previous sections.
22521 When it is a fresh install run some svn command (e.g.
22523 \begin_inset Flex Code
22526 \begin_layout Plain Layout
22532 ) to create config files, which you will need to change later on.
22535 \begin_layout Enumerate
22536 Choose an ssh client for Windows.
22537 There are several possibilities, we will use the one from Putty tools
22541 \begin_layout Plain Layout
22542 \begin_inset Flex URL
22545 \begin_layout Plain Layout
22547 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22558 You will need to set the connection up so that the client doesn't ask for
22559 any password from you.
22560 To keep things easy we will use only keys without any additional password
22565 \begin_layout Enumerate
22567 \begin_inset Flex Code
22570 \begin_layout Plain Layout
22577 Save your private .ppk key file and put the public one on the server side.
22578 If the SVN server runs on Linux, note that the format of the public key
22579 is not compatible with Linux openssh and you will need to direcly copy-paste
22582 Public key for pasting into OpenSSH authorized_keys file
22584 :” edit field into the server's
22585 \begin_inset Flex Code
22588 \begin_layout Plain Layout
22589 ~/.ssh/authorized_keys
22595 \begin_inset Flex Code
22598 \begin_layout Plain Layout
22607 \begin_layout Enumerate
22609 \begin_inset Flex Code
22612 \begin_layout Plain Layout
22619 In the SVN config file
22623 \begin_layout Plain Layout
22624 Exact path depends on Windows version, usually somewhere around
22625 \begin_inset Flex Code
22628 \begin_layout Plain Layout
22631 Documents and Settings
22645 \begin_inset Flex Code
22648 \begin_layout Plain Layout
22663 , section [tunnels], setup ssh command, e.g.
22665 \begin_inset Flex Code
22668 \begin_layout Plain Layout
22669 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22678 \begin_layout Plain Layout
22679 It will usually take a lot of time to get exact command right and it depends
22681 For example do not have some remote server saved as a default session in
22683 If things fail, try to connect via plink without SVN first.
22692 \begin_layout Enumerate
22693 Checkout the SVN archive, e.
22694 \begin_inset space \thinspace{}
22698 \begin_inset Newline newline
22702 \begin_inset Flex Code
22705 \begin_layout Plain Layout
22706 svn co svn+ssh://user@server/repository_path
22714 \begin_layout Subsubsection
22715 End-of-Line Conversions
22718 \begin_layout Standard
22719 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22721 use different line endings inside the .lyx files.
22722 This is not a problem as far as \SpecialChar LyX
22723 functionality is concerned, but the commit
22724 diffs will be huge and merge-conflicts prone.
22725 Fortunately SVN itself knows
22729 \begin_layout Plain Layout
22730 \begin_inset Flex URL
22733 \begin_layout Plain Layout
22735 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22745 how to deal with CR/LF problems when switching .lyx files to the
22746 \begin_inset Flex Code
22749 \begin_layout Plain Layout
22759 \begin_layout Plain Layout
22761 \begin_inset Flex Code
22764 \begin_layout Plain Layout
22765 svn propset svn:eol-style native FILE_NAME
22778 \begin_layout Subsection
22779 GIT commands in \SpecialChar LyX
22783 \begin_layout Standard
22784 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22786 You can find the commands in the
22788 File\SpecialChar menuseparator
22790 \begin_inset space ~
22796 Please note that if you use password protected access to repository via
22797 ssh, you will be asked in terminal window.
22799 was tested against GIT 1.7.
22803 \begin_layout Plain Layout
22804 Windows users please note that you need to ensure that git is on the path.
22805 This can be set from within \SpecialChar LyX
22808 Tools\SpecialChar menuseparator
22809 Preferences\SpecialChar menuseparator
22810 Paths\SpecialChar menuseparator
22821 \begin_layout Standard
22822 One big difference of GIT and the other supported version control systems
22823 is the distributed nature of GIT: With traditional version control systems
22824 there is one central server which hosts the repository.
22825 Users commit their changes to the server, and get updates made by other
22827 With GIT, users commit to a local repository.
22828 The local repository can be synchronized with one or more remote repositories
22830 \begin_inset Flex Code
22833 \begin_layout Plain Layout
22840 \begin_inset Flex Code
22843 \begin_layout Plain Layout
22851 does not interact in any way with remote GIT repositories.
22852 It works exclusively with the local repository in a very similar way as
22853 with a central CVS or SVN repository.
22854 If you use remote GIT repositories you need to do the
22855 \begin_inset Flex Code
22858 \begin_layout Plain Layout
22865 \begin_inset Flex Code
22868 \begin_layout Plain Layout
22874 operations with your favourite GIT client.
22877 \begin_layout Subsubsection
22883 \begin_layout Standard
22884 If your document is not under revision control, this is the only item shown
22886 And if it is under revision control, the
22890 item is not visible.
22893 \begin_layout Standard
22894 This command registers in GIT your document ONLY in case you have already
22895 the documents directory under GIT control (in particular
22900 This means you have to checkout the archive by yourself.
22903 \begin_layout Standard
22904 Then you are asked interactively to supply an initial description of the
22906 Don't forget that registered file is not yet commited.
22909 \begin_layout Standard
22910 GIT command that is run:
22913 \begin_inset Quotes eld
22917 \begin_inset Quotes erd
22923 \begin_layout Standard
22928 to understand the switches.
22931 \begin_layout Subsubsection
22937 \begin_layout Standard
22938 When you are finished editing a file, you commit your changes.
22939 When you do this, you are asked for a description of the changes.
22940 After that changes are commited.
22943 \begin_layout Standard
22946 git commit -q -m"<description>" <file-name>
22949 \begin_layout Subsubsection
22952 Revert To Repository Version
22955 \begin_layout Standard
22956 This will discard all changes made to the document since the last check
22958 You get a warning before changes are discarded.
22961 \begin_layout Standard
22965 \begin_inset Quotes eld
22969 \begin_inset Quotes erd
22975 \begin_layout Subsubsection
22981 \begin_layout Standard
22982 This will rename the current document including the version history.
22983 It requires a clean document without any changes since the last checkin.
22984 You are asked for a file name and a description of the rename operation.
22985 After that the document is renamed, both locally and in the repository.
22986 If the parent directories of the new and old file names differ, all relative
22987 paths of included files are adjusted (like in
22989 File\SpecialChar menuseparator
22994 Finally, the document is reloaded using the new name.
22997 \begin_layout Labeling
22998 \labelwidthstring 00.00.0000
23000 \begin_inset space ~
23004 \begin_inset space ~
23008 \begin_inset Newline newline
23012 \begin_inset Flex Code
23015 \begin_layout Plain Layout
23019 \begin_inset Quotes eld
23023 \begin_inset Quotes erd
23027 \begin_inset Quotes eld
23031 \begin_inset Quotes erd
23040 \begin_inset Newline newline
23044 \begin_inset Flex Code
23047 \begin_layout Plain Layout
23056 \begin_layout Subsubsection
23062 \begin_layout Standard
23063 This shows the complete history of the GIT document.
23067 \begin_inset Quotes eld
23071 \begin_inset Quotes erd
23076 is shown in a browser.
23079 \begin_layout Subsubsection
23083 \begin_layout Standard
23085 supports GIT hash number of the last commit to the file, author name, date
23086 and time of last commit.
23087 All those are extracted from
23089 git log -n 1 --pretty=format:%H%n%an%n%ai
23092 Tree version information is obtained via
23094 git describe --abbrev --dirty --long
23098 \begin_inset CommandInset ref
23100 reference "subsec:VCS-Revision-Information"
23107 \begin_layout Subsection
23111 \begin_layout Standard
23112 With the recent addition of the vc-command function \SpecialChar LyX
23113 power users are allowed
23114 to create their own commands for revision control.
23117 \begin_layout Standard
23118 As an example you can see how two TortoiseSVN commands could be integrated
23122 \begin_layout Description
23124 \begin_inset Flex Code
23127 \begin_layout Plain Layout
23128 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23136 \begin_layout Description
23138 \begin_inset Flex Code
23141 \begin_layout Plain Layout
23142 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23150 \begin_layout Subsection
23151 Version control and Document comparison
23154 \begin_layout Standard
23155 One of the typical uses of version control is to inspect the changes between
23156 revisions, usually by creating
23157 \begin_inset Flex Code
23160 \begin_layout Plain Layout
23167 While this is useful for plain text files, it is much less useful in the
23168 case of \SpecialChar LyX
23169 files, which have more a complicated structure.
23170 Hence we provide binding to the Document comparison feature.
23171 There are two ways of calling this feature - either by direct call of
23172 \begin_inset Flex Code
23175 \begin_layout Plain Layout
23182 function (for details see \SpecialChar LyX
23183 functions manual) or by icon/menu item
23184 \begin_inset Flex Noun
23187 \begin_layout Plain Layout
23188 Compare with older revision...
23194 One can either compare two chosen revisions of the document or he can simply
23195 compare the current version of edited text with older revisions (where
23197 \begin_inset Flex Noun
23200 \begin_layout Plain Layout
23206 ' revisions back means comparison of the edited file with last commited
23211 \begin_layout Standard
23212 This feature is supported for SVN and RCS though due to the more complicated
23213 versioning scheme of RCS there is a constraint – when addressing the revisions
23214 in dialog, numbers always point to the last number in RCS revision number,
23217 We don't currently support GIT addressing of revisions, one can just compare
23218 edited document with its revision X steps backs, where X is addressed as
23222 \begin_layout Section
23223 Literate Programming
23226 \begin_layout Standard
23231 (kayvan@sylvan.com)
23235 original documentation written by
23237 Edmar Wienskoski Jr.
23240 (edmar-w-jr@technologist.com)
23243 \begin_layout Subsection
23247 \begin_layout Standard
23248 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23250 programming, where it is assumed that you are familiar with this programming
23251 technique, and know what
23252 \begin_inset Quotes eld
23256 \begin_inset Quotes erd
23260 \begin_inset Quotes eld
23264 \begin_inset Quotes erd
23268 If that is not the case, please follow the web links provided in the following
23270 There is a lot of good documentation out there covering old development
23271 history to the latest tools tips.
23274 \begin_layout Standard
23275 It is also assumed that you are familiar with \SpecialChar LyX
23276 itself to a point that you
23277 are comfortable changing your \SpecialChar LyX
23278 preferences, and X resources file.
23279 If that is not the case please refer to other \SpecialChar LyX
23280 documentation to cover your
23284 \begin_layout Subsection
23285 Literate Programming
23288 \begin_layout Standard
23289 From the Literate Programming FAQ:
23292 \begin_layout Quotation
23293 Literate programming is the combination of documentation and source together
23294 in a fashion suited for reading by human beings.
23295 In fact, literate programs should be enjoyable reading, even inviting!
23296 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23297 and documentation in a single file.
23298 Literate programming tools then parse the file to produce either readable
23299 documentation or compilable source.
23300 The WEB style of literate programming was created by D.
23301 \begin_inset space \thinspace{}
23305 Knuth during the development of his \SpecialChar TeX
23306 typesetting software.
23310 \begin_layout Standard
23311 Another excerpt says:
23314 \begin_layout Quotation
23317 How is literate programming different from verbose commenting?
23320 \begin_layout Quotation
23321 There are three distinguishing characteristics.
23322 In order of importance, they are:
23326 \begin_layout Itemize
23327 flexible order of elaboration
23330 \begin_layout Itemize
23331 automatic support for browsing
23334 \begin_layout Itemize
23335 typeset documentation, especially diagrams and mathematics
23339 \begin_layout Standard
23340 Now that I sparked your curiosity, take a look in the references.
23343 \begin_layout Subsubsection
23347 \begin_layout Standard
23348 The complete Literate Programming FAQ can be found at:
23351 \begin_layout Quote
23352 Literate Programming FAQ
23353 \begin_inset Flex URL
23356 \begin_layout Plain Layout
23358 http://www.literateprogramming.com/lpfaq.pdf
23366 \begin_layout Standard
23367 The FAQ lists 23 (twenty three!) different literate programming tools.
23368 Where some are specialized or
23369 \begin_inset Quotes eld
23373 \begin_inset Quotes erd
23376 for particular programming languages, while other have general scope.
23381 for my own use for several reasons:
23384 \begin_layout Itemize
23385 It can generate the documentation either in \SpecialChar LaTeX
23389 \begin_layout Itemize
23390 It has a open architecture, i.
23391 \begin_inset space \thinspace{}
23395 \begin_inset space \space{}
23398 it is easy to plug in new filters and to perform special processing that
23403 \begin_layout Itemize
23404 There is a good selection of filters available already (the HTML is one
23408 \begin_layout Itemize
23412 \begin_layout Standard
23413 The Noweb web page can be found at:
23416 \begin_layout Quote
23418 \begin_inset Flex URL
23421 \begin_layout Plain Layout
23423 http://www.cs.virginia.edu/~nr/noweb/
23431 \begin_layout Standard
23432 Starting from there you can reach many other interesting links and even
23433 some literate program examples.
23436 \begin_layout Subsection
23438 and Literate Programming with Noweb
23441 \begin_layout Standard
23442 The \SpecialChar LyX
23443 support for Literate Programming is provided by using the generic \SpecialChar LyX
23445 converters mechanism.
23446 This support is provided in a
23447 \begin_inset Quotes eld
23451 \begin_inset Quotes erd
23455 \begin_inset space \thinspace{}
23459 \begin_inset space \space{}
23462 you will be able to use this new \SpecialChar LyX
23463 feature with some other literate programming
23464 tool of your choice by just changing your \SpecialChar LyX
23468 \begin_layout Subsubsection
23469 Generating documents and code (weaving and tangling)
23472 \begin_layout Paragraph
23473 Using the noweb module
23476 \begin_layout Standard
23477 If you have installed Noweb and \SpecialChar LyX
23478 successfully, whenever you open a new document,
23479 after you have chosen its document class, use the Document->Settings menu
23481 \begin_inset Quotes eld
23485 \begin_inset Quotes erd
23489 If Noweb is correctly installed, when you click on the
23490 \begin_inset Quotes eld
23494 \begin_inset Quotes erd
23497 link, you will see the
23498 \begin_inset Quotes eld
23502 \begin_inset Quotes erd
23505 module in the available list and you can add it to your document.
23508 \begin_layout Paragraph
23512 \begin_layout Standard
23514 enables you to write code with a layout named
23515 \begin_inset Flex Noun
23518 \begin_layout Plain Layout
23525 Noweb delimits chunks like this:
23528 \begin_layout LyX-Code
23532 \begin_layout LyX-Code
23536 \begin_layout LyX-Code
23540 \begin_layout LyX-Code
23544 \begin_layout LyX-Code
23548 \begin_layout Standard
23549 The problem is that whatever is written in between the << and the
23553 must be taken literally, i.
23554 \begin_inset space \thinspace{}
23558 \begin_inset space \space{}
23562 should be prevented from making any special interpretation of what has
23564 This is also handled by
23565 \begin_inset Flex Noun
23568 \begin_layout Plain Layout
23574 , that works like a normal paragraph but has a free spacing capability.
23577 \begin_layout Standard
23578 As a special note, you can also use the
23579 \begin_inset Quotes eld
23583 \begin_inset Quotes erd
23586 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23590 \begin_layout LyX-Code
23594 \begin_layout LyX-Code
23595 def some_function(args):
23598 \begin_layout LyX-Code
23599 "This is the doc string for this function."
23602 \begin_layout LyX-Code
23603 print "My args: ", args
23606 \begin_layout LyX-Code
23607 @ %def some_function
23610 \begin_layout Standard
23611 For an example of this usage and the resulting cross-reference output, look
23612 at the Literate python program in
23614 LIBDIR/examples/listerrors.lyx
23616 which should make this all clear.
23619 \begin_layout Paragraph
23620 Generating the documentation
23623 \begin_layout Standard
23624 At this point you already have a new document file with a proper document
23625 class, and with some code and text on it.
23626 How do I print it? The answer is simple, you select
23628 View\SpecialChar menuseparator
23632 Just like you would do for a plain document.
23633 No special procedure is required.
23636 \begin_layout Standard
23637 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23641 \begin_layout Enumerate
23644 Update\SpecialChar menuseparator
23647 menu option is chosen, a \SpecialChar LaTeX
23653 \begin_layout Standard
23654 If the document is of any literate class the generated file will be named
23655 with an extension name defined by the
23656 \begin_inset Quotes eld
23660 \begin_inset Quotes erd
23663 format (defined in the Preferences panel), otherwise the file will have
23672 \begin_layout Enumerate
23673 Note that the only difference so far is in the name of the file, no special
23674 processing is required by \SpecialChar LyX
23676 Given that you formatted the code using the
23677 \begin_inset Flex Noun
23680 \begin_layout Plain Layout
23686 layout that, by itself, takes care of the business.
23689 \begin_layout Enumerate
23690 If the document is of any literate class \SpecialChar LyX
23691 will then use the internal \SpecialChar LyX
23693 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23698 \begin_layout Plain Layout
23699 The converters are defined in the
23701 Tools\SpecialChar menuseparator
23705 \begin_inset Quotes eld
23709 \begin_inset Quotes erd
23721 manual for general information about converters.
23726 to generate the \SpecialChar LaTeX
23731 \begin_layout Standard
23732 Otherwise it will just skip this step.
23736 \begin_layout Enumerate
23737 Finally, \SpecialChar LaTeX
23738 is invoked and the regular post processing continues as in a plain
23742 \begin_layout Standard
23743 Independence from a particular
23744 \begin_inset Quotes eld
23748 \begin_inset Quotes erd
23751 is easily achieved by changing the commands that are run by the various
23755 \begin_layout Paragraph
23756 Generating the code
23759 \begin_layout Standard
23760 When the build menu option is chosen or the corresponding button in the
23761 toolbar is pressed, a \SpecialChar LaTeX
23762 file is generated just like step 1 above.
23763 Next, \SpecialChar LyX
23769 This converter needs to be defined by the user and is not installed by
23770 default, though the Program format is.
23771 This converter (like any other converter) will have two parts:
23774 \begin_layout Enumerate
23775 The converter program itself.
23776 This program performs the conversion from the one format to the other (in
23777 this case, from the Noweb format to the Program pseudo-format).
23780 \begin_layout Enumerate
23781 The error log parser.
23782 This is a program whose sole purpose is to rewrite error messages in a
23783 format that \SpecialChar LyX
23785 This makes it possible for \SpecialChar LyX
23786 to place error boxes in the right places in
23790 \begin_layout Standard
23791 The first part, the
23792 \begin_inset Quotes eld
23796 \begin_inset Quotes erd
23799 setting, should be set to
23800 \begin_inset Newline newline
23804 \begin_inset Quotes eld
23812 \begin_inset Quotes erd
23816 \begin_inset Newline newline
23819 This basically means that \SpecialChar LyX
23821 \begin_inset Quotes eld
23825 \begin_inset Quotes erd
23828 (a program or script) with the name of the Noweb file (normally a file
23829 in the \SpecialChar LyX
23830 temp directory) and the directory path of the original \SpecialChar LyX
23835 \begin_layout Standard
23836 This is an implementation of
23837 \begin_inset Quotes eld
23841 \begin_inset Quotes erd
23844 that you can place in a directory on your path:
23847 \begin_layout Standard
23848 \begin_inset VSpace defskip
23854 \begin_layout Standard
23855 \begin_inset Newpage pagebreak
23861 \begin_layout Standard
23867 \begin_layout Standard
23873 \begin_layout Standard
23876 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23879 \begin_layout Standard
23880 \begin_inset VSpace defskip
23886 \begin_layout Standard
23887 The next part of the converter setting is the
23888 \begin_inset Quotes eld
23892 \begin_inset Quotes erd
23895 which is to be set to
23896 \begin_inset Newline newline
23900 \begin_inset Quotes eld
23905 parselog=$$s/scripts/listerrors
23908 \begin_inset Quotes erd
23912 \begin_inset Newline newline
23915 This will run any errors that are generated by the
23916 \begin_inset Quotes eld
23920 \begin_inset Quotes erd
23923 process through the
23924 \begin_inset Quotes eld
23928 \begin_inset Quotes erd
23934 \begin_layout Standard
23935 The build will normally take place in \SpecialChar LyX
23936 's temporary directory, so the files
23937 produced by the conversion will be in that directory.
23939 will copy out what it regards as the `main' file, but the
23943 conversion may produce several files, and so most of these would then be
23944 deleted when \SpecialChar LyX
23946 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23947 the build-script chunk can place the generated files in that location.
23950 \begin_layout Paragraph
23951 Build instructions in the document
23954 \begin_layout Standard
23955 The last piece of the integration between \SpecialChar LyX
23957 \begin_inset Quotes eld
23961 \begin_inset Quotes erd
23965 Generally, the instructions for building your program should be embedded
23966 in a chunk of its own.
23968 \begin_inset Quotes eld
23972 \begin_inset Quotes erd
23975 above uses the notangle command to look for this chunk (called
23976 \begin_inset Quotes eld
23980 \begin_inset Quotes erd
23983 ) and runs its contents through
23984 \begin_inset Quotes eld
23988 \begin_inset Quotes erd
23994 \begin_layout Standard
23995 Typically, such a chunk would look something like this:
23998 \begin_layout LyX-Code
24002 \begin_layout LyX-Code
24004 \begin_inset Newline newline
24007 if [ -z "${NOWEB_SOURCE}" ]
24008 \begin_inset Newline newline
24014 \begin_layout LyX-Code
24015 NOWEB_SOURCE=myfile.nw
24016 \begin_inset Newline newline
24020 \begin_inset Newline newline
24024 code to extract files ...
24025 use NOWEB_OUTPUT_DIR here ...]
24026 \begin_inset Newline newline
24030 code to compile files ...]
24031 \begin_inset Newline newline
24037 \begin_layout Standard
24040 LIBDIR/examples/listerrors.lyx
24044 LIBDIR/examples/Literate.lyx
24046 which implement two versions of the
24047 \begin_inset Quotes eld
24051 \begin_inset Quotes erd
24054 program for some illustrations of how all of these pieces go together or
24057 LIBDIR/examples/noweb2lyx.lyx.
24060 Interestingly, these three files show off the language-indepence of the
24062 literate programming support since they are written in Python, C and Perl
24066 \begin_layout Subsubsection
24067 Configuring \SpecialChar LyX
24071 \begin_layout Standard
24072 All the Literate Programming support is configured by the
24074 Tools\SpecialChar menuseparator
24078 \begin_inset Quotes eld
24082 \begin_inset Quotes erd
24086 The important parts are:
24089 \begin_layout Description
24091 \begin_inset space ~
24095 \begin_inset Quotes eld
24099 \begin_inset Quotes erd
24103 \begin_inset space ~
24106 format Set up via the File Formats tab, this is where the Noweb-specific
24116 , the file extension is set to
24121 This tells \SpecialChar LyX
24122 to create a file with a
24126 extension in the first step of the conversion process.
24129 \begin_layout Description
24131 \begin_inset space ~
24139 \begin_inset space ~
24142 format This is an empty format whose sole purpose is to be the endpoint
24143 of a conversion (which then allows us to set up a converter for it).
24146 \begin_layout Description
24156 This converter performs the
24157 \begin_inset Quotes eld
24161 \begin_inset Quotes erd
24164 of the literate document.
24165 For Noweb, it is set to
24166 \begin_inset Quotes eld
24171 noweave -delay -index $$i > $$o
24174 \begin_inset Quotes erd
24180 \begin_layout Description
24190 \begin_inset Quotes eld
24194 \begin_inset Quotes erd
24198 As stated above, the Converter is set to
24199 \begin_inset Quotes eld
24207 \begin_inset Quotes erd
24210 , with Flags set to
24211 \begin_inset Newline newline
24215 \begin_inset Quotes eld
24220 parselog=$$s/scripts/listerrors
24223 \begin_inset Quotes erd
24229 \begin_layout Subsubsection
24233 \begin_layout Standard
24234 There is also a new function implemented in the \SpecialChar LyX
24236 \begin_inset Quotes eld
24239 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24243 \begin_layout Standard
24244 When debugging code with ddd/gdb, it is possible to invoke a text editor
24245 at the current execution position with a single key stroke.
24246 The default ddd configuration for that is shift-ctrl-V.
24247 It happens that you can define the editor command line invocation in ddd
24250 Edit\SpecialChar menuseparator
24251 Preferences\SpecialChar menuseparator
24254 dialog and changing the "Edit Sources" entry.
24257 \begin_layout Standard
24258 I take advantage of the newly created \SpecialChar LyX
24259 server function and this ddd feature,
24261 \begin_inset Quotes eld
24265 \begin_inset Quotes erd
24271 \begin_layout Standard
24272 \begin_inset VSpace defskip
24278 \begin_layout Standard
24281 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24284 \begin_layout Standard
24285 \begin_inset VSpace defskip
24291 \begin_layout Standard
24292 With this, whenever you are using ddd and find a point in the program that
24293 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24294 ddd will forward this information to \SpecialChar LyX
24295 through the \SpecialChar LyX
24296 server and then the
24298 window will show the same file with the cursor at the same position ddd
24300 No more guessing or long scrolling to locate a point in the program back
24304 \begin_layout Standard
24305 Note however that you must enable the \SpecialChar LyX
24306 server to get this feature working
24307 (it is disabled by default).
24308 You can enable it in
24320 ) by entering in the
24326 \begin_inset Quotes eld
24331 /home/<your-home-directory>/.lyx/lyxpipe
24334 \begin_inset Quotes erd
24340 \begin_layout Standard
24341 Read the \SpecialChar LyX
24342 server documentation in the
24344 Customization Manual
24346 for further information.
24349 \begin_layout Subsubsection
24353 \begin_layout Standard
24354 There are six new buttons that can be added to your \SpecialChar LyX
24356 Five of these buttons are short cuts to layout styles:
24379 The last one is a short cut to the
24380 \begin_inset Quotes eld
24384 \begin_inset Quotes erd
24391 \begin_layout Standard
24393 has a range of buttons that are available for tool bar customization.
24394 In my toolbar I like to combine the six short cuts above with two more:
24399 \SpecialChar menuseparator
24404 \SpecialChar menuseparator
24411 Document\SpecialChar menuseparator
24412 View\SpecialChar menuseparator
24416 Here is how it looks like:
24419 \begin_layout LyX-Code
24423 \begin_layout LyX-Code
24427 \begin_layout LyX-Code
24428 Icon "layout Standard"
24431 \begin_layout LyX-Code
24432 Icon "layout Section"
24435 \begin_layout LyX-Code
24436 Icon "layout \SpecialChar LaTeX
24440 \begin_layout LyX-Code
24441 Icon "layout \SpecialChar LyX
24445 \begin_layout LyX-Code
24446 Icon "layout Chunk"
24449 \begin_layout LyX-Code
24453 \begin_layout LyX-Code
24457 \begin_layout LyX-Code
24458 Icon "buffer-typeset"
24461 \begin_layout LyX-Code
24462 Icon "build-program"
24465 \begin_layout LyX-Code
24469 \begin_layout LyX-Code
24473 \begin_layout LyX-Code
24477 \begin_layout LyX-Code
24481 \begin_layout LyX-Code
24485 \begin_layout Subsubsection
24486 Colors customization
24489 \begin_layout Standard
24490 There are a number of colors in \SpecialChar LyX
24491 that can be customized in
24496 One of the things that bothers people is the \SpecialChar LaTeX
24498 The default color is red, since the chunks uses \SpecialChar LaTeX
24499 font, and there is a lot
24500 of chunks in literate documents, you may get tired of seeing everything
24502 You can change it by going to the tabs
24511 \begin_layout Standard
24512 The next thing is the visible presence of the newline character in the screen.
24513 You can choose the color of this particular character and make it blend
24515 I recommend you choosing a color that is close to the background but not
24516 equal, that way you still can see it is there, but it is not bothering
24520 \begin_layout Subsection
24525 \begin_layout Standard
24534 is documented in the
24538 example file and in the Sweave manual (menu
24540 Help\SpecialChar menuseparator
24546 \begin_layout Chapter
24550 \begin_layout Standard
24551 You can do everything with \SpecialChar LyX
24552 that you can do with \SpecialChar LaTeX
24554 However, \SpecialChar LyX
24555 cannot support every \SpecialChar LaTeX
24557 But you can always use \SpecialChar TeX
24559 This chapter shows you some more special things you might want to use.
24560 For other special things you can do with figures, tables, floats, boxes
24561 and notes, have a look at the
24564 \begin_inset space ~
24572 \begin_layout Section
24573 Multiple Text Columns
24576 \begin_layout Standard
24577 This feature is independent of the option
24579 Two-column document
24581 in the document settings under
24586 If you want to have 2
24587 \begin_inset space ~
24590 columns for the whole document, it is recommended to use the
24592 Two-column document
24595 For all other cases use this feature.
24598 \begin_layout Standard
24599 To use multiple text columns in your document, you have to load the module
24606 Document\SpecialChar menuseparator
24607 Settings\SpecialChar menuseparator
24610 ) and must have the \SpecialChar LaTeX
24618 \begin_layout Standard
24619 Footnotes within multiple columns will be placed at the bottom of the page
24620 and not under each column.
24621 Within the different columns you can use everything, with the limitation
24622 that for floats you need to use the float option
24629 \begin_layout Subsection
24633 \begin_layout Standard
24634 If you want to have 2
24635 \begin_inset space ~
24638 columns in your text, insert a multicolumn inset via the menu
24640 Insert\SpecialChar menuseparator
24642 \begin_inset space ~
24645 Insets\SpecialChar menuseparator
24647 \begin_inset space ~
24652 where the columns should start.
24653 Write all text that should be printed in 2
24654 \begin_inset space ~
24657 columns into this inset.
24660 \begin_layout Standard
24661 Here is an example:
24664 \begin_layout Standard
24666 \begin_inset Flex Multiple Columns
24669 \begin_layout Plain Layout
24674 The Adventure of the Empty House
24677 \begin_inset Newline newline
24680 by Sir Arthur Conan Doyle
24683 \begin_layout Plain Layout
24686 It was in the spring of the year 1894 that all London was interested, and
24687 the fashionable world dismayed, by the murder of the Honourable Ronald
24688 Adair under most unusual and inexplicable circumstances.
24689 The public has already learned those particulars of the crime which came
24690 out in the police investigation, but a good deal was suppressed upon that
24691 occasion, since the case for the prosecution was so overwhelmingly strong
24692 that it was not necessary to bring forward all the facts.
24693 Only now, at the end of nearly ten years, am I allowed to supply those
24694 missing links which make up the whole of that remarkable chain.
24695 The crime was of interest in itself, but that interest was as nothing to
24696 me compared to the inconceivable sequel, which afforded me the greatest
24697 shock and surprise of any event in my adventurous life.
24698 Even now, after this long interval, I find myself thrilling as I think
24699 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24700 ty which utterly submerged my mind.
24701 Let me say to that public, which has shown some interest in those glimpses
24702 which I have occasionally given them of the thoughts and actions of a very
24703 remarkable man, that they are not to blame me if I have not shared my knowledge
24704 with them, for I should have considered it my first duty to do so, had
24705 I not been barred by a positive prohibition from his own lips, which was
24706 only withdrawn upon the third of last month.
24714 \begin_layout Standard
24715 To get 3 or more columns, set the cursor into the multicolumn inset and
24718 Insert\SpecialChar menuseparator
24720 \begin_inset space ~
24724 \begin_inset space ~
24730 The number of the desired columns is written into that inset (for 3
24731 \begin_inset space ~
24735 \begin_inset Quotes eld
24739 \begin_inset Quotes erd
24743 \begin_inset Newline newline
24746 Here is an example with 3
24747 \begin_inset space ~
24753 \begin_layout Standard
24754 \begin_inset Flex Multiple Columns
24757 \begin_layout Plain Layout
24760 \begin_inset Argument 1
24763 \begin_layout Plain Layout
24769 It can be imagined that my close intimacy with Sherlock Holmes had interested
24770 me deeply in crime, and that after his disappearance I never failed to
24771 read with care the various problems which came before the public.
24772 And I even attempted, more than once, for my own private satisfaction,
24773 to employ his methods in their solution, though with indifferent success.
24774 There was none, however, which appealed to me like this tragedy of Ronald
24776 As I read the evidence at the inquest, which led up to a verdict of willful
24777 murder against some person or persons unknown, I realized more clearly
24778 than I had ever done the loss which the community had sustained by the
24779 death of Sherlock Holmes.
24780 There were points about this strange business which would, I was sure,
24781 have specially appealed to him, and the efforts of the police would have
24782 been supplemented, or more probably anticipated, by the trained observation
24783 and the alert mind of the first criminal agent in Europe.
24784 All day, as I drove upon my round, I turned over the case in my mind and
24785 found no explanation which appeared to me to be adequate.
24786 At the risk of telling a twice-told tale, I will recapitulate the facts
24787 as they were known to the public at the conclusion of the inquest.
24795 \begin_layout Standard
24796 You can have up to 10
24797 \begin_inset space ~
24800 columns if you want to, but that might not be very pleasant for the readers
24804 \begin_layout Standard
24805 \begin_inset Newpage newpage
24811 \begin_layout Subsection
24812 Columns inside Columns
24815 \begin_layout Standard
24816 You can also have columns inside columns:
24819 \begin_layout Standard
24820 \begin_inset Flex Multiple Columns
24823 \begin_layout Plain Layout
24826 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24827 at that time governor of one of the Australian colonies.
24828 Adair's mother had returned from Australia to undergo the operation for
24829 cataract, and she, her son Ronald, and her daughter Hilda were living together
24833 \begin_layout Plain Layout
24834 \begin_inset Flex Multiple Columns
24837 \begin_layout Plain Layout
24840 The youth moved in the best society–had, so far as was known, no enemies
24841 and no particular vices.
24842 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24843 had been broken off by mutual consent some months before, and there was
24844 no sign that it had left any very profound feeling behind it.
24845 For the rest {sic} the man's life moved in a narrow and conventional circle,
24846 for his habits were quiet and his nature unemotional.
24847 Yet it was upon this easy-going young aristocrat that death came, in most
24848 strange and unexpected form, between the hours of ten and eleven-twenty
24849 on the night of March 30, 1894.
24857 \begin_layout Plain Layout
24860 Ronald Adair was fond of cards–playing continually, but never for such stakes
24862 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24863 It was shown that, after dinner on the day of his death, he had played
24864 a rubber of whist at the latter club.
24865 He had also played there in the afternoon.
24870 The evidence of those who had played with him– Mr.
24871 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24872 and that there was a fairly equal fall of the cards.
24873 Adair might have lost five pounds, but not more.
24874 His fortune was a considerable one, and such a loss could not in any way
24876 He had played nearly every day at one club or other, but he was a cautious
24877 player, and usually rose a winner.
24878 It came out in evidence that, in partnership with Colonel Moran, he had
24879 actually won as much as four hundred and twenty pounds in a sitting, some
24880 weeks before, from Godfrey Milner and Lord Balmoral.
24881 So much for his recent history as it came out at the inquest.
24889 \begin_layout Subsection
24893 \begin_layout Standard
24894 The examples in this section show some more special features of multiple
24898 \begin_layout Standard
24899 For more features of multiple columns, have a look at the documentation
24900 of the \SpecialChar LaTeX
24906 \begin_inset CommandInset citation
24916 \begin_layout Subsubsection
24920 \begin_layout Standard
24921 To add a preface text for multiple columns, set the cursor into the multicolumn
24922 inset and use the menu
24924 Insert\SpecialChar menuseparator
24928 Write your preface text into that inset.
24929 \begin_inset Newline newline
24932 This is an example with some preface text:
24935 \begin_layout Standard
24936 \begin_inset VSpace bigskip
24942 \begin_layout Standard
24943 \begin_inset Flex Multiple Columns
24946 \begin_layout Plain Layout
24947 \begin_inset Argument 2
24950 \begin_layout Plain Layout
24951 And the story continues and continues and continues and continues\SpecialChar ldots
24959 On the evening of the crime, he returned from the club exactly at ten.
24960 His mother and sister were out spending the evening with a relation.
24961 The servant deposed that she heard him enter the front room on the second
24962 floor, generally used as his sitting-room.
24963 She had lit a fire there, and as it smoked she had opened the window.
24964 No sound was heard from the room until eleven-twenty, the hour of the return
24965 of Lady Maynooth and her daughter.
24966 Desiring to say good-night, she attempted to enter her son's room.
24967 The door was locked on the inside, and no answer could be got to their
24968 cries and knocking.
24969 Help was obtained, and the door forced.
24970 The unfortunate young man was found lying near the table.
24971 His head had been horribly mutilated by an expanding revolver bullet, but
24972 no weapon of any sort was to be found in the room.
24980 \begin_layout Standard
24981 You can also use a section heading as the preface if you use a section command
24982 as \SpecialChar TeX
24984 For example the command
24987 \begin_layout Standard
24992 subsection{subsection title}
24995 \begin_layout Standard
24996 creates a subsection.
24997 In this example the preface is a subsubsection:
25000 \begin_layout Standard
25001 \begin_inset Flex Multiple Columns
25004 \begin_layout Plain Layout
25005 \begin_inset Argument 2
25008 \begin_layout Plain Layout
25012 \begin_layout Plain Layout
25021 This is a subsubsection heading as a preface
25025 \begin_layout Plain Layout
25039 A minute examination of the circumstances served only to make the case more
25041 In the first place, no reason could be given why the young man should have
25042 fastened the door upon the inside.
25043 There was the possibility that the murderer had done this, and had afterwards
25044 escaped by the window.
25045 The drop was at least twenty feet, however, and a bed of crocuses in full
25047 Neither the flowers nor the earth showed any sign of having been disturbed,
25048 nor were there any marks upon the narrow strip of grass which separated
25049 the house from the road.
25050 Apparently, therefore, it was the young man himself who had fastened the
25052 But how did he come by his death? No one could have climbed up to the window
25053 without leaving traces.
25054 Suppose a man had fired through the window, he would indeed be a remarkable
25055 shot who could with a revolver inflict so deadly a wound.
25056 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
25057 a hundred yards of the house.
25058 No one had heard a shot.
25066 \begin_layout Standard
25067 If there is less vertical space than 6
25068 \begin_inset space ~
25071 text lines is left on the page at the beginning of the multiple columns,
25072 a page break will be inserted before the multiple columns.
25073 Depending on the number of lines of the preface text, you might want to
25075 This is done by setting the cursor into the mulitcolumn inset behind the
25076 preface (if there is any) and using the menu
25078 Insert\SpecialChar menuseparator
25080 \begin_inset space ~
25084 \begin_inset space ~
25088 \begin_inset space ~
25094 Insert into that inset the amount of space like e.
25095 \begin_inset space \thinspace{}
25099 \begin_inset space \space{}
25103 \begin_inset Quotes eld
25107 \begin_inset Quotes erd
25111 \begin_inset Newline newline
25114 In this example the space is set to 7
25115 \begin_inset space ~
25118 text lines by using
25119 \begin_inset Quotes eld
25125 \begin_inset Quotes erd
25134 needs to be inserted as \SpecialChar TeX
25138 \begin_layout Standard
25139 \begin_inset Flex Multiple Columns
25142 \begin_layout Plain Layout
25143 \begin_inset Argument 3
25146 \begin_layout Plain Layout
25151 \begin_layout Plain Layout
25167 On the evening of the crime, he returned from the club exactly at ten.
25168 His mother and sister were out spending the evening with a relation.
25169 The servant deposed that she heard him enter the front room on the second
25170 floor, generally used as his sitting-room.
25171 She had lit a fire there, and as it smoked she had opened the window.
25172 No sound was heard from the room until eleven-twenty, the hour of the return
25173 of Lady Maynooth and her daughter.
25174 Desiring to say good-night, she attempted to enter her son's room.
25175 The door was locked on the inside, and no answer could be got to their
25176 cries and knocking.
25177 Help was obtained, and the door forced.
25178 The unfortunate young man was found lying near the table.
25179 His head had been horribly mutilated by an expanding revolver bullet, but
25180 no weapon of any sort was to be found in the room.
25188 \begin_layout Subsubsection
25192 \begin_layout Standard
25193 The amount of space before and after multiple columns can be changed by
25194 changing the length
25201 For example the command
25204 \begin_layout Standard
25214 \begin_layout Standard
25215 in \SpecialChar TeX
25216 Code changes its value to 3
25217 \begin_inset space \thinspace{}
25221 The change must be made before the multiple columns' start.
25222 The predefined value is 13
25223 \begin_inset space \thinspace{}
25229 \begin_layout Standard
25237 \begin_inset space \thinspace{}
25243 \begin_layout Standard
25247 \begin_layout Plain Layout
25253 multicolsep}{2.5cm}
25261 \begin_layout Standard
25262 \begin_inset Flex Multiple Columns
25265 \begin_layout Plain Layout
25268 All day I turned these facts over in my mind, endeavouring to hit upon some
25269 theory which could reconcile them all, and to find that line of least resistanc
25270 e which my poor friend had declared to be the starting-point of every investigat
25272 I confess that I made little progress.
25273 In the evening I strolled across the Park, and found myself about six o'clock
25274 at the Oxford Street end of Park Lane.
25275 A group of loafers upon the pavements, all staring up at a particular window,
25276 directed me to the house which I had come to see.
25277 A tall, thin man with coloured glasses, whom I strongly suspected of being
25278 a plain-clothes detective, was pointing out some theory of his own, while
25279 the others crowded round to listen to what he said.
25280 I got as near him as I could, but his observations seemed to me to be absurd,
25281 so I withdrew again in some disgust.
25282 As I did so I struck against an elderly, deformed man, who had been behind
25283 me, and I knocked down several books which he was carrying.
25291 \begin_layout Standard
25292 \begin_inset Note Greyedout
25295 \begin_layout Plain Layout
25300 The values you set with
25306 will be used for all following multiple columns until you change them again.
25314 \begin_layout Standard
25318 \begin_layout Plain Layout
25330 \begin_inset Note Note
25333 \begin_layout Plain Layout
25334 go back to the default
25342 \begin_layout Standard
25343 \begin_inset Newpage newpage
25349 \begin_layout Subsubsection
25353 \begin_layout Standard
25354 A column break can be forced by inserting the command
25360 as \SpecialChar TeX
25361 Code to that position in the text where the column should be broken.
25362 Note that this leads in most cases to whitespace in the text.
25363 \begin_inset Newline newline
25366 Here is an example:
25369 \begin_layout Standard
25370 \begin_inset Flex Multiple Columns
25373 \begin_layout Plain Layout
25376 \begin_inset Quotes eld
25379 You're surprised to see me, sir,
25380 \begin_inset Quotes erd
25383 said he, in a strange, croaking voice.
25386 \begin_layout Plain Layout
25389 I acknowledged that I was.
25392 \begin_layout Plain Layout
25395 \begin_inset Quotes eld
25398 Well, I've a conscience, sir, and when I chanced to see you go into this
25399 house, as I came hobbling after you, I thought to myself, I'll just step
25400 in and see that kind gentleman, and tell him that if I was a bit gruff
25401 in my manner there was not any harm meant, and that I am much obliged to
25402 him for picking up my books.
25403 \begin_inset Quotes erd
25409 \begin_layout Plain Layout
25412 \begin_inset Quotes eld
25415 You make too much of a trifle,
25416 \begin_inset Quotes erd
25421 \begin_inset Quotes eld
25424 May I ask how you knew who I was?
25425 \begin_inset Quotes erd
25428 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25432 \begin_layout Plain Layout
25444 \begin_layout Plain Layout
25447 \begin_inset Quotes eld
25450 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25451 you'll find my little bookshop at the corner of Church Street, and very
25452 happy to see you, I am sure.
25453 Maybe you collect yourself, sir.
25457 \begin_inset space ~
25470 –a bargain, every one of them.
25471 With five volumes you could just fill that gap on that second shelf.
25472 It looks untidy, does it not, sir?
25473 \begin_inset Quotes erd
25484 \begin_layout Subsubsection
25488 \begin_layout Standard
25489 The width of the columns is automatically calculated, but you can modify
25490 the space between the columns.
25491 This is done by changing the length
25498 Its predefined value is 10
25499 \begin_inset space \thinspace{}
25503 Here is an example where
25510 \begin_inset space \thinspace{}
25516 \begin_layout Standard
25520 \begin_layout Plain Layout
25534 \begin_layout Standard
25535 \begin_inset Flex Multiple Columns
25538 \begin_layout Plain Layout
25541 My observations of No.
25542 \begin_inset space \space{}
25545 427 Park Lane did little to clear up the problem in which I was interested.
25546 The house was separated from the street by a low wall and railing, the
25547 whole not more than five feet high.
25548 It was perfectly easy, therefore, for anyone to get into the garden, but
25549 the window was entirely inaccessible, since there was no water pipe or
25550 anything which could help the most active man to climb it.
25551 More puzzled than ever, I retraced my steps to Kensington.
25552 I had not been in my study five minutes when the maid entered to say that
25553 a person desired to see me.
25554 To my astonishment it was none other than my strange old book collector,
25555 his sharp, wizened face peering out from a frame of white hair, and his
25556 precious volumes, a dozen of them at least, wedged under his right arm.
25564 \begin_layout Standard
25568 \begin_layout Plain Layout
25580 \begin_inset Note Note
25583 \begin_layout Plain Layout
25584 go back to the default
25592 \begin_layout Subsubsection
25596 \begin_layout Standard
25597 Between the columns a rule with a width of the length
25604 If this rule width is set to 0
25605 \begin_inset space \thinspace{}
25608 pt (this is the default), the rule is suppressed.
25609 In the following example the rule is 2
25610 \begin_inset space \thinspace{}
25616 \begin_layout Standard
25620 \begin_layout Plain Layout
25626 columnseprule}{2pt}
25634 \begin_layout Standard
25635 \begin_inset Flex Multiple Columns
25638 \begin_layout Plain Layout
25641 \begin_inset Quotes eld
25644 You're surprised to see me, sir,
25645 \begin_inset Quotes erd
25648 said he, in a strange, croaking voice.
25651 \begin_layout Plain Layout
25654 I acknowledged that I was.
25657 \begin_layout Plain Layout
25660 \begin_inset Quotes eld
25663 Well, I've a conscience, sir, and when I chanced to see you go into this
25664 house, as I came hobbling after you, I thought to myself, I'll just step
25665 in and see that kind gentleman, and tell him that if I was a bit gruff
25666 in my manner there was not any harm meant, and that I am much obliged to
25667 him for picking up my books.
25668 \begin_inset Quotes erd
25674 \begin_layout Plain Layout
25677 \begin_inset Quotes eld
25680 You make too much of a trifle,
25681 \begin_inset Quotes erd
25686 \begin_inset Quotes eld
25689 May I ask how you knew who I was?
25690 \begin_inset Quotes erd
25696 \begin_layout Plain Layout
25699 \begin_inset Quotes eld
25702 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25703 you'll find my little bookshop at the corner of Church Street, and very
25704 happy to see you, I am sure.
25705 Maybe you collect yourself, sir.
25709 \begin_inset space ~
25722 –a bargain, every one of them.
25723 With five volumes you could just fill that gap on that second shelf.
25724 It looks untidy, does it not, sir?
25725 \begin_inset Quotes erd
25736 \begin_layout Standard
25737 \begin_inset VSpace defskip
25743 \begin_layout Standard
25744 The rule can be colored by redefining the command
25751 This is done by inserting the command
25752 \begin_inset Newline newline
25761 columnseprulecolor}{
25766 \begin_inset Newline newline
25769 as \SpecialChar TeX
25770 Code before the multicolumn inset.
25775 in this command by a color of your choice.
25776 You can use all pre- and self-defined colors.
25784 \begin_inset space ~
25789 for more information about pre- and self-defined colors.
25790 To go back to the default color insert the command
25791 \begin_inset Newline newline
25800 columnseprulecolor}{
25805 \begin_inset Newline newline
25808 Here is the example with a cyan rule and 1
25809 \begin_inset space \thinspace{}
25812 cm column separation:
25815 \begin_layout Standard
25819 \begin_layout Plain Layout
25828 \begin_layout Plain Layout
25834 columnseprulecolor}{
25844 \begin_layout Standard
25845 \begin_inset Flex Multiple Columns
25848 \begin_layout Plain Layout
25851 \begin_inset Quotes eld
25854 You're surprised to see me, sir,
25855 \begin_inset Quotes erd
25858 said he, in a strange, croaking voice.
25861 \begin_layout Plain Layout
25864 I acknowledged that I was.
25867 \begin_layout Plain Layout
25870 \begin_inset Quotes eld
25873 Well, I've a conscience, sir, and when I chanced to see you go into this
25874 house, as I came hobbling after you, I thought to myself, I'll just step
25875 in and see that kind gentleman, and tell him that if I was a bit gruff
25876 in my manner there was not any harm meant, and that I am much obliged to
25877 him for picking up my books.
25878 \begin_inset Quotes erd
25884 \begin_layout Plain Layout
25887 \begin_inset Quotes eld
25890 You make too much of a trifle,
25891 \begin_inset Quotes erd
25896 \begin_inset Quotes eld
25899 May I ask how you knew who I was?
25900 \begin_inset Quotes erd
25906 \begin_layout Plain Layout
25909 \begin_inset Quotes eld
25912 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25913 you'll find my little bookshop at the corner of Church Street, and very
25914 happy to see you, I am sure.
25915 Maybe you collect yourself, sir.
25919 \begin_inset space ~
25932 –a bargain, every one of them.
25933 With five volumes you could just fill that gap on that second shelf.
25934 It looks untidy, does it not, sir?
25935 \begin_inset Quotes erd
25946 \begin_layout Standard
25950 \begin_layout Plain Layout
25956 columnseprule}{0pt}
25959 \begin_layout Plain Layout
25965 columnseprulecolor}{
25973 \begin_inset Note Note
25976 \begin_layout Plain Layout
25977 go back to the default
25985 \begin_layout Section
25986 Non-standard Paragraph Shapes
25989 \begin_layout Standard
25992 as well as any other text processor uses by default rectangular paragraphs.
25993 For special cases like for example posters, invitation cards or poems you
25994 can modify the paragraph shape to one of your choice.
25995 This can be done by using the \SpecialChar LaTeX
26000 which is loaded by using in the document settings the module
26002 Custom paragraph shapes
26007 \begin_layout Subsection
26011 \begin_layout Standard
26016 provides the following shapes:
26019 \begin_layout Standard
26020 \begin_inset Tabular
26021 <lyxtabular version="3" rows="13" columns="3">
26022 <features booktabs="true" islongtable="true" longtabularalignment="center">
26023 <column alignment="center" valignment="middle" width="16col%">
26024 <column alignment="center" valignment="middle" width="40col%">
26025 <column alignment="center" valignment="middle" width="35col%">
26026 <row endhead="true">
26027 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26030 \begin_layout Plain Layout
26036 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26039 \begin_layout Plain Layout
26045 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26048 \begin_layout Plain Layout
26056 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26059 \begin_layout Plain Layout
26065 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26068 \begin_layout Plain Layout
26069 Circle with circular hole (in the size of a CD/DVD)
26074 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26077 \begin_layout Plain Layout
26078 Cannot be scaled, take care there is not too much text
26085 <cell alignment="center" valignment="top" topline="true" usebox="none">
26088 \begin_layout Plain Layout
26094 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26097 \begin_layout Plain Layout
26103 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26106 \begin_layout Plain Layout
26107 Fragile, calculation might fail
26114 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26117 \begin_layout Plain Layout
26123 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26126 \begin_layout Plain Layout
26127 Rhomboid (symbolizing a
26128 \begin_inset Quotes eld
26132 \begin_inset Quotes erd
26140 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26143 \begin_layout Plain Layout
26151 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26154 \begin_layout Plain Layout
26160 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26163 \begin_layout Plain Layout
26169 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26172 \begin_layout Plain Layout
26180 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26183 \begin_layout Plain Layout
26189 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26192 \begin_layout Plain Layout
26198 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26201 \begin_layout Plain Layout
26209 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26212 \begin_layout Plain Layout
26218 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26221 \begin_layout Plain Layout
26222 Nut for bolt (hexagon with circular hole)
26227 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26230 \begin_layout Plain Layout
26238 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26241 \begin_layout Plain Layout
26247 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26250 \begin_layout Plain Layout
26256 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26259 \begin_layout Plain Layout
26267 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26270 \begin_layout Plain Layout
26276 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26279 \begin_layout Plain Layout
26285 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26288 \begin_layout Plain Layout
26296 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26299 \begin_layout Plain Layout
26305 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26308 \begin_layout Plain Layout
26314 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26317 \begin_layout Plain Layout
26325 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26328 \begin_layout Plain Layout
26334 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26337 \begin_layout Plain Layout
26338 Normal/reversed rain drop
26343 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26346 \begin_layout Plain Layout
26347 Fragile, calculation might fail
26354 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26357 \begin_layout Plain Layout
26364 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26367 \begin_layout Plain Layout
26368 The \SpecialChar TeX
26374 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26377 \begin_layout Plain Layout
26385 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26388 \begin_layout Plain Layout
26390 \begin_inset Newline newline
26398 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26401 \begin_layout Plain Layout
26402 Triangles in different orientations
26407 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26410 \begin_layout Plain Layout
26424 \begin_layout Standard
26425 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26427 for environments in the toolbar.
26430 \begin_layout Standard
26431 \begin_inset Newpage newpage
26437 \begin_layout Standard
26438 Here is an example paragraph in the shape of a nut:
26441 \begin_layout Standard
26442 \begin_inset VSpace bigskip
26451 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26452 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26454 At vero eos et accusam et justo duo dolores et ea rebum.
26455 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
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
26462 \begin_layout Standard
26463 \begin_inset VSpace bigskip
26469 \begin_layout Standard
26470 \begin_inset Note Greyedout
26473 \begin_layout Plain Layout
26478 : shapepar paragraphs cannot run over a page break.
26486 \begin_layout Standard
26487 \begin_inset VSpace bigskip
26493 \begin_layout Standard
26498 takes care that the shape will always be preserved, no matter how much
26499 text is in the paragraph.
26500 Therefore the paragraph size changes with the amount of contained text.
26501 This can lead to paragraph sizes exceeding the page margins.
26502 To demonstrate the size scaling, here is the same example paragraph but
26503 with twice as much text:
26506 \begin_layout Standard
26507 \begin_inset Newpage newpage
26516 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26517 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26519 At vero eos et accusam et justo duo dolores et ea rebum.
26520 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
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 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26526 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26528 At vero eos et accusam et justo duo dolores et ea rebum.
26529 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
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
26536 \begin_layout Standard
26537 \begin_inset VSpace bigskip
26543 \begin_layout Standard
26544 An exception is the shape
26549 It cannot be scaled because it must fit the size of a CD/DVD.
26550 Therefore the amount of text that fits into the shape is limited.
26551 \begin_inset Newline newline
26562 shape are fragile, meaning that the calculation of their size can fail,
26563 depending on the amount of text.
26564 You will then get the \SpecialChar LaTeX
26566 \begin_inset Quotes eld
26569 Arithmetic overflow
26570 \begin_inset Quotes erd
26574 In this case one can try to remove or add some text; if nothing works one
26575 has to use another shape.
26578 \begin_layout Standard
26579 \begin_inset VSpace bigskip
26585 \begin_layout Standard
26586 For shapes with tips you will maybe see that \SpecialChar LaTeX
26587 's hyphenation routine fails
26588 for text in the tips.
26589 Therefore it is often necessary to add hyphenation points
26594 arg "specialchar-insert hyphenation"
26599 ) to the corresponding text parts.
26602 \begin_layout Standard
26603 \begin_inset VSpace bigskip
26609 \begin_layout Standard
26610 Shapepar paragraphs are either always centered or placed on the page so
26611 that their left border touches the left page margin.
26612 You can therefore not use the paragraph dialog to align such paragraphs.
26613 A solution is to put the paragraph into a minipage or parbox and align
26615 The problem is hereby to find the right width for the box.
26616 Because if it is too wide and you center the box, the paragraph is not
26617 centered too because it sticks at the left side of the box.
26618 So you might have to play a bit with the width until it fits.
26619 Here are two heart-shaped paragraphs, the first one is not aligned, the
26620 second one is right-aligned:
26623 \begin_layout Standard
26624 \begin_inset Newpage newpage
26630 \begin_layout Heart
26634 Lo\SpecialChar softhyphen
26635 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26636 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26638 At vero eos et accusam et justo duo dolores et ea rebum.
26639 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26643 \begin_layout Standard
26644 \begin_inset VSpace bigskip
26650 \begin_layout Standard
26653 \begin_inset Box Frameless
26663 height_special "totalheight"
26668 backgroundcolor "none"
26671 \begin_layout Heart
26675 Lo\SpecialChar softhyphen
26676 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26677 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26679 At vero eos et accusam et justo duo dolores et ea rebum.
26680 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26689 \begin_layout Subsection
26693 \begin_layout Standard
26694 You can define any shape you want.
26695 Doing this manually is a lot of work because every coordinate must be specified.
26696 But there is a way to let the computer calculate the coordinates:
26699 \begin_layout Enumerate
26700 Install the program
26701 \begin_inset CommandInset href
26704 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26712 \begin_layout Enumerate
26719 TeX/LaTeX\SpecialChar menuseparator
26720 Settings\SpecialChar menuseparator
26723 and select the font size you are using in your document.
26724 For example this document uses the size 12
26725 \begin_inset space \thinspace{}
26731 \begin_layout Enumerate
26735 \begin_layout Enumerate
26738 TeX/LaTeX\SpecialChar menuseparator
26741 to export the shape to coordinates.
26742 In the appearing dialog use either the outline of your shape for the coordinate
26743 s or the path itself.
26747 \begin_layout Plain Layout
26748 For more information see
26749 \begin_inset CommandInset href
26751 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26764 \begin_layout Standard
26765 The coordinates are written into a \SpecialChar TeX
26767 To use it for your \SpecialChar LyX
26771 \begin_layout Enumerate
26772 Place the cursor before the first character of your paragraph (or into a
26776 \begin_layout Enumerate
26777 Open in \SpecialChar LyX
26780 Insert\SpecialChar menuseparator
26781 File\SpecialChar menuseparator
26783 \begin_inset space ~
26788 , select the file and use
26797 \begin_layout Standard
26798 \begin_inset VSpace defskip
26804 \begin_layout Standard
26805 \begin_inset Note Greyedout
26808 \begin_layout Plain Layout
26813 : The changed shape only applies to the current paragraph; everything is
26814 reset to normal for the next paragraph.
26815 Therefore the shape definition file must be input into every paragraph
26816 with the desired shape.
26824 \begin_layout Standard
26825 \begin_inset VSpace bigskip
26831 \begin_layout Standard
26832 Here is an example:
26835 \begin_layout Standard
26836 \begin_inset VSpace bigskip
26842 \begin_layout Standard
26843 \begin_inset CommandInset include
26845 filename "SpecialParagraphShape.tex"
26851 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26852 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26854 At vero eos et accusam et justo duo dolores et ea rebum.
26855 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
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
26862 \begin_layout Standard
26863 \begin_inset VSpace bigskip
26869 \begin_layout Standard
26874 to draw complexer shapes in
26878 you can draw the shape in a program of your choice and import the resulting
26884 Then you only need to draw a line or spline along the outline of the image.
26887 \begin_layout Standard
26888 \begin_inset VSpace bigskip
26894 \begin_layout Standard
26897 Custom paragraph shapes
26899 also provides the two commands
26907 which can be used to define custom shapes coordinate by coordinate.
26911 \begin_layout Plain Layout
26912 These commands are internally used for all shapes described here.
26917 For information how these styles are used and about further customization
26918 possibilities, have a look at the documentation of the package
26923 \begin_inset CommandInset citation
26933 \begin_layout Bibliography
26934 \begin_inset CommandInset bibitem
26935 LatexCommand bibitem
26941 Documentation of the \SpecialChar LaTeX
26943 \begin_inset CommandInset href
26946 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26954 \begin_layout Bibliography
26955 \begin_inset CommandInset bibitem
26956 LatexCommand bibitem
26962 Documentation of the \SpecialChar LaTeX
26964 \begin_inset CommandInset href
26967 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"