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 enabling the option
6464 \begin_inset Flex Noun
6467 \begin_layout Plain Layout
6468 Synchronize with Output
6474 \begin_inset Flex Noun
6477 \begin_layout Plain Layout
6478 Document\SpecialChar menuseparator
6479 Settings\SpecialChar menuseparator
6486 In such a case \SpecialChar LyX
6487 will automatically insert the necessary Sync\SpecialChar TeX
6489 PDF) or load the srcltx package (for DVI) respectively.
6490 This option can be easily reached also on
6491 \begin_inset Flex Code
6494 \begin_layout Plain Layout
6503 \begin_layout Standard
6504 If you need a different setting, you can select or input a custom macro
6505 from the drop down box just below
6506 \begin_inset Flex Noun
6509 \begin_layout Plain Layout
6510 Document\SpecialChar menuseparator
6511 Settings\SpecialChar menuseparator
6512 Output\SpecialChar menuseparator
6513 Synchronize with Output
6521 \begin_layout Standard
6522 Note that the method
6523 \begin_inset Flex Code
6526 \begin_layout Plain Layout
6534 enables gzip compression.
6535 If your viewer does not support it, you should instead use
6536 \begin_inset Flex Code
6539 \begin_layout Plain Layout
6550 \begin_layout Standard
6551 Please also note that including the
6552 \begin_inset Flex Code
6555 \begin_layout Plain Layout
6562 \begin_inset Flex Code
6565 \begin_layout Plain Layout
6571 sometimes has an undesired impact on the typesetting.
6572 Thus, you should switch output synchronization off for the final typesetting
6574 \begin_inset Flex Code
6577 \begin_layout Plain Layout
6584 \begin_inset Flex Code
6587 \begin_layout Plain Layout
6597 \begin_layout Standard
6598 In case you need some more special settings that are not covered by the
6599 automatic settings, read the next section about how to set up output synchroniz
6601 If the automatic setup suits your needs, you can readily jump to section
6602 \begin_inset space ~
6606 \begin_inset CommandInset ref
6608 reference "subsec:configuring-viewers"
6612 , where the necessary configuration steps in your viewer – needed both with
6613 the automatic and the manual setup – are described.
6616 \begin_layout Subsection
6620 \begin_layout Standard
6622 provides several different methods for reverse search.
6623 Some are built-in in the
6624 \begin_inset Flex Code
6627 \begin_layout Plain Layout
6633 program, some are provided by external packages.
6634 Your choice depends on whether your \SpecialChar LaTeX
6635 distribution already provides a given
6636 method (the built-in methods are rather new) and whether your viewer can
6638 The available methods are described in the following.
6641 \begin_layout Subsubsection*
6642 Built-in DVI-search via src-specials (DVI only)
6645 \begin_layout Standard
6646 This method provides the DVI file with the necessary information for reverse
6648 It is available in \SpecialChar LaTeX
6649 since quite some time (any somewhat recent \SpecialChar LaTeX
6651 should include it), and it works reliably.
6652 To enable it, change the
6653 \begin_inset Flex Noun
6656 \begin_layout Plain Layout
6667 \begin_inset Flex Noun
6670 \begin_layout Plain Layout
6681 \begin_inset Flex Noun
6684 \begin_layout Plain Layout
6685 Preferences\SpecialChar menuseparator
6686 File Handling\SpecialChar menuseparator
6693 \begin_inset Flex Code
6696 \begin_layout Plain Layout
6697 latex -src-specials $$i
6703 If this doesn't work, check if your \SpecialChar TeX
6704 engine needs different options (the
6705 syntax might differ in some distributions).
6708 \begin_layout Subsubsection*
6709 External Packages (PDFSync and scrltx)
6712 \begin_layout Standard
6721 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6723 In order to enable it, load the packages in the \SpecialChar LyX
6727 \begin_layout Itemize
6728 \begin_inset Flex Code
6731 \begin_layout Plain Layout
6739 for reverse PDF search,
6742 \begin_layout Itemize
6743 \begin_inset Flex Code
6746 \begin_layout Plain Layout
6749 usepackage[active]{srcltx}
6754 for reverse DVI search.
6757 \begin_layout Standard
6758 If you want to be able to perform both DVI and PDF reverse searches, you
6759 can also insert in the preamble the following lines
6762 \begin_layout LyX-Code
6766 \begin_inset Newline newline
6772 \begin_inset Newline newline
6778 \begin_inset Newline newline
6784 \begin_inset Newline newline
6789 usepackage[active]{srcltx}
6790 \begin_inset Newline newline
6798 \begin_layout Standard
6799 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6800 right package will be used.
6803 \begin_layout Standard
6804 Note that PDFSync might affect the output layout of your document.
6805 It is therefore advised to disable PDFsync for final documents.
6808 \begin_layout Subsubsection*
6809 Built-in reverse search via Sync\SpecialChar TeX
6813 \begin_layout Standard
6815 \begin_inset Flex Code
6818 \begin_layout Plain Layout
6824 have built-in support for both PDF and DVI reverse search.
6827 Sync\SpecialChar TeX
6830 facility is basically the result of the integration of the PDFSync package
6831 to the pdftex program and its merge with the
6836 You need at least \SpecialChar TeX
6837 Live 2008 or a recent Mik\SpecialChar TeX
6838 distribution in order to use
6843 \begin_layout Plain Layout
6844 For some reason, Mik\SpecialChar TeX
6845 does not understand/obey the command \SpecialChar LyX
6847 the preamble when you check the "Enable Forward/Reverse Search" button
6848 in the toolbar and does not generate the necessary info.
6851 \begin_layout Plain Layout
6852 The generation of the required info can be forced by changing the converter
6854 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
6855 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
6856 the -synctex=1 switch).
6861 Also note that only a few PDF viewers (Okular and Qpdfview on Unix, Skim
6862 on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
6866 \begin_layout Standard
6867 To enable Sync\SpecialChar TeX
6868 for DVI output, change the
6869 \begin_inset Flex Noun
6872 \begin_layout Plain Layout
6883 \begin_inset Flex Noun
6886 \begin_layout Plain Layout
6897 \begin_inset Flex Noun
6900 \begin_layout Plain Layout
6901 Preferences\SpecialChar menuseparator
6902 File Handling\SpecialChar menuseparator
6909 \begin_inset Flex Code
6912 \begin_layout Plain Layout
6913 latex -synctex=1 $$i
6918 , and for PDF output, change the
6919 \begin_inset Flex Noun
6922 \begin_layout Plain Layout
6927 (pdflatex) -> PDF (pdflatex)
6933 \begin_inset Flex Code
6936 \begin_layout Plain Layout
6937 pdflatex -synctex=1 $$i
6943 Check the documentation of your viewer whether the viewer needs to be configure
6944 d for the use with Sync\SpecialChar TeX
6949 \begin_layout Plain Layout
6950 Note that the option
6951 \begin_inset Flex Code
6954 \begin_layout Plain Layout
6960 option enables gzip compression.
6961 If your viewer does not support it, you should instead use
6962 \begin_inset Flex Code
6965 \begin_layout Plain Layout
6979 \begin_layout Subsection
6980 Configuring and using specific viewers
6981 \begin_inset CommandInset label
6983 name "subsec:configuring-viewers"
6990 \begin_layout Subsubsection*
6991 Xdvi (all platforms)
6994 \begin_layout Standard
6996 \begin_inset Flex Code
6999 \begin_layout Plain Layout
7005 , you don't need to do anything else for performing a reverse DVI search,
7007 already provides the necessary hooks for automatically using the
7008 \begin_inset Flex Code
7011 \begin_layout Plain Layout
7018 Just setup your document as described above (reverse search is triggered
7019 by Ctrl-click or Alt-click on Mac OSX, respectively).
7022 \begin_layout Standard
7023 However, if for whatever reason you want to use the named pipe instead of
7024 the socket for communicating with \SpecialChar LyX
7025 , simply change the DVI viewer in
7026 \begin_inset Flex Noun
7029 \begin_layout Plain Layout
7030 Preferences\SpecialChar menuseparator
7031 File Handling\SpecialChar menuseparator
7041 \begin_layout Plain Layout
7042 On Mac OSX you have to use
7043 \begin_inset Flex Code
7046 \begin_layout Plain Layout
7047 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7058 \begin_inset Flex Code
7061 \begin_layout Plain Layout
7062 xdvi -editor "lyxeditor.sh %f %l"
7068 \begin_inset Flex Code
7071 \begin_layout Plain Layout
7077 is a suitable script.
7078 For example, a minimal shell script is the following one:
7081 \begin_layout LyX-Code
7083 \begin_inset Newline newline
7086 LYXPIPE="/path/to/lyxpipe"
7087 \begin_inset Newline newline
7090 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7091 \begin_inset Newline newline
7094 echo "$COMMAND" > "${LYXPIPE}".in || exit
7095 \begin_inset Newline newline
7098 read TMP < "${LYXPIPE}".out || exit
7101 \begin_layout Standard
7103 \begin_inset Flex Code
7106 \begin_layout Plain Layout
7112 is the LyXServer pipe path specified in
7113 \begin_inset Flex Noun
7116 \begin_layout Plain Layout
7117 Preferences\SpecialChar menuseparator
7127 \begin_layout Plain Layout
7129 \begin_inset Flex Code
7132 \begin_layout Plain Layout
7138 folder of a source distribution you can find a
7139 \begin_inset Flex Code
7142 \begin_layout Plain Layout
7148 script which is able to locate the
7152 based on your preferences.
7160 \begin_layout Subsubsection*
7164 \begin_layout Standard
7166 \begin_inset Flex Code
7169 \begin_layout Plain Layout
7170 /Applications/MacDviX_Folder/calleditor.script
7175 , add the following lines:
7178 \begin_layout LyX-Code
7179 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7180 \begin_inset Newline newline
7186 \begin_layout Standard
7187 Modify the lines accordingly if you install \SpecialChar LyX
7188 somewhere else than in the
7189 Applications folder.
7192 \begin_layout Standard
7193 Reverse search is triggered by Alt-click (OPTION-click).
7196 \begin_layout Subsubsection*
7200 \begin_layout Standard
7202 \begin_inset Flex Code
7205 \begin_layout Plain Layout
7206 open -a Skim.app $$i
7211 to the viewer setting in
7212 \begin_inset Flex Noun
7215 \begin_layout Plain Layout
7216 Preferences\SpecialChar menuseparator
7217 File Handling\SpecialChar menuseparator
7218 File formats\SpecialChar menuseparator
7225 \begin_inset Flex Noun
7228 \begin_layout Plain Layout
7229 Skim\SpecialChar menuseparator
7230 Preferences\SpecialChar menuseparator
7237 \begin_inset Flex Noun
7240 \begin_layout Plain Layout
7246 preset and enter command
7247 \begin_inset Flex Noun
7250 \begin_layout Plain Layout
7251 /Applications/\SpecialChar LyX
7252 .app/Contents/MacOS/lyxeditor
7260 \begin_layout Standard
7261 Reverse search is triggered by COMMAND-SHIFT-click
7264 \begin_layout Subsubsection*
7266 \change_inserted -712698321 1500278482
7270 \begin_layout Standard
7272 \change_inserted -712698321 1500278679
7273 Reverse search with evince does not work out of the box, but it can be achieved
7274 by means of some third party helper scripts.
7276 \begin_inset CommandInset href
7278 target "http://wiki.lyx.org/LyX/SyncTeX"
7286 \begin_layout Subsubsection*
7290 \begin_layout Standard
7292 \begin_inset Flex Noun
7295 \begin_layout Plain Layout
7296 Settings\SpecialChar menuseparator
7297 Configure Okular\SpecialChar menuseparator
7304 \begin_inset Quotes eld
7308 \begin_inset Quotes erd
7312 \begin_inset Flex Code
7315 \begin_layout Plain Layout
7324 \begin_layout Standard
7325 Reverse search is triggered by SHIFT-click.
7328 \begin_layout Subsubsection*
7332 \begin_layout Standard
7333 Qpdfview supports Sync\SpecialChar TeX
7334 since version 0.3.5.
7336 \begin_inset Flex Noun
7339 \begin_layout Plain Layout
7340 Edit\SpecialChar menuseparator
7341 Settings\SpecialChar menuseparator
7347 , click on the input field of the
7348 \begin_inset Quotes eld
7352 \begin_inset Quotes erd
7355 item and add the command
7356 \begin_inset Flex Code
7359 \begin_layout Plain Layout
7368 \begin_layout Standard
7369 Reverse search is triggered by double-click or, in more recent versions,
7373 \begin_layout Subsubsection*
7377 \begin_layout Standard
7378 Launch yap, choose its
7379 \begin_inset Flex Noun
7382 \begin_layout Plain Layout
7383 View\SpecialChar menuseparator
7390 \begin_inset Quotes eld
7394 \begin_inset Quotes erd
7399 \begin_inset Quotes eld
7402 New\SpecialChar ldots
7404 \begin_inset Quotes erd
7407 button and, in the window that opens, enter
7408 \begin_inset Quotes eld
7413 \begin_inset Quotes erd
7416 (or any other name you like) in the
7417 \begin_inset Quotes eld
7421 \begin_inset Quotes erd
7425 Now click on the button labeled
7426 \begin_inset Quotes eld
7431 \begin_inset Quotes erd
7434 to open a file dialog and navigate to the directory containing the batch
7436 \begin_inset Flex Code
7439 \begin_layout Plain Layout
7447 \begin_inset Flex Code
7450 \begin_layout Plain Layout
7456 and then specify the program arguments as
7457 \begin_inset Flex Code
7460 \begin_layout Plain Layout
7468 \begin_inset Flex Code
7471 \begin_layout Plain Layout
7477 wrapper is used for communicating with \SpecialChar LyX
7485 \begin_layout LyX-Code
7487 \begin_inset Newline newline
7490 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
7499 \begin_inset Newline newline
7513 \begin_layout Standard
7514 Make sure that the \SpecialChar LyX
7515 Server pipe path you specified in \SpecialChar LyX
7517 \begin_inset Flex Code
7520 \begin_layout Plain Layout
7534 , otherwise change the
7535 \begin_inset Flex Code
7538 \begin_layout Plain Layout
7544 wrapper accordingly.
7547 \begin_layout Standard
7548 In yap, reverse search is triggered by double-click.
7551 \begin_layout Subsubsection*
7552 SumatraPDF (Windows)
7555 \begin_layout Standard
7556 In order to use SumatraPDF for inverse search, enter
7557 \begin_inset Flex Code
7560 \begin_layout Plain Layout
7561 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
7566 in the viewer setting in
7567 \begin_inset Flex Noun
7570 \begin_layout Plain Layout
7571 Preferences\SpecialChar menuseparator
7572 File Handling\SpecialChar menuseparator
7573 File formats\SpecialChar menuseparator
7580 \begin_inset Flex Code
7583 \begin_layout Plain Layout
7589 is the previous wrapper.
7590 If SumatraPDF.exe is not in your command PATH, use its full file name.
7593 \begin_layout Standard
7594 Reverse search is triggered by double-click.
7597 \begin_layout Subsubsection*
7601 \begin_layout Standard
7602 First of all, make sure that yap is your default DVI viewer in the Windows
7603 environment, then launch it, choose its
7604 \begin_inset Flex Noun
7607 \begin_layout Plain Layout
7608 View\SpecialChar menuseparator
7615 \begin_inset Quotes eld
7619 \begin_inset Quotes erd
7624 \begin_inset Quotes eld
7627 New\SpecialChar ldots
7629 \begin_inset Quotes erd
7632 button and, in the window that opens, enter
7633 \begin_inset Quotes eld
7638 \begin_inset Quotes erd
7641 (or any other name you like) in the
7642 \begin_inset Quotes eld
7646 \begin_inset Quotes erd
7650 Now click on the button labeled
7651 \begin_inset Quotes eld
7656 \begin_inset Quotes erd
7659 to open a file dialog and navigate to the directory containing the
7660 \begin_inset Flex Code
7663 \begin_layout Plain Layout
7669 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7672 \begin_inset Flex Code
7675 \begin_layout Plain Layout
7681 and then specify the program arguments as
7682 \begin_inset Flex Code
7685 \begin_layout Plain Layout
7692 In this way, you will be using the
7696 for communicating with \SpecialChar LyX
7698 If, for whatever reason, you want to use the
7703 \begin_inset Flex Code
7706 \begin_layout Plain Layout
7712 option and be sure to specify the \SpecialChar LyX
7713 Server pipe path in the \SpecialChar LyX
7717 \begin_layout Standard
7718 In yap, reverse search is triggered by double-click.
7721 \begin_layout Subsubsection*
7725 \begin_layout Standard
7726 In order to use SumatraPDF for inverse search, enter
7727 \begin_inset Flex Code
7730 \begin_layout Plain Layout
7731 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7736 in the viewer setting in
7737 \begin_inset Flex Noun
7740 \begin_layout Plain Layout
7741 Preferences\SpecialChar menuseparator
7742 File Handling\SpecialChar menuseparator
7743 File formats\SpecialChar menuseparator
7750 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7752 \begin_inset Flex Code
7755 \begin_layout Plain Layout
7761 enables communication via the
7767 \begin_inset Flex Code
7770 \begin_layout Plain Layout
7776 option if you want to use the
7780 , and be sure to specify the \SpecialChar LyX
7781 Server pipe path in the \SpecialChar LyX
7785 \begin_layout Standard
7786 Reverse search is triggered by double-click.
7789 \begin_layout Section
7793 \begin_layout Standard
7794 Forward search is, as the name implies, in a sense the
7795 \begin_inset Quotes eld
7799 \begin_inset Quotes erd
7803 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7805 If forward search is set up (as described in what follows), you can put
7806 the cursor anywhere in your \SpecialChar LyX
7808 \begin_inset Flex Noun
7811 \begin_layout Plain Layout
7812 Navigate\SpecialChar menuseparator
7819 \begin_inset Flex Noun
7822 \begin_layout Plain Layout
7828 in the context menu via right mouse click), and then the viewer will jump
7829 to that position as well.
7830 This implies, of course, that your viewer supports this function.
7833 \begin_layout Standard
7834 To make forward search possible, you first need to provide the generated
7835 output PDF/DVI file with additional information about the \SpecialChar TeX
7837 This can be done via the methods described in the section
7838 \begin_inset CommandInset ref
7840 reference "subsec:rev-search"
7847 \begin_layout Standard
7848 Additionally, you need to configure \SpecialChar LyX
7849 for using your viewers in
7850 \begin_inset Flex Noun
7853 \begin_layout Plain Layout
7854 Tools\SpecialChar menuseparator
7855 Preferences\SpecialChar menuseparator
7856 Output\SpecialChar menuseparator
7863 We provide a range of tested configurations for some viewers, which you
7864 can select from the drop down list.
7865 If none of these configurations suits you, you have to find out and enter
7866 a suitable configuration yourself.
7867 The definition syntax uses the following placeholders:
7870 \begin_layout Itemize
7872 \begin_inset Flex Code
7875 \begin_layout Plain Layout
7884 \begin_layout Itemize
7886 \begin_inset Flex Code
7889 \begin_layout Plain Layout
7895 : name of the (temporary) exported .tex file (without path)
7898 \begin_layout Itemize
7900 \begin_inset Flex Code
7903 \begin_layout Plain Layout
7909 : name of the (temporary) exported .tex file (including path)
7912 \begin_layout Itemize
7914 \begin_inset Flex Code
7917 \begin_layout Plain Layout
7923 : name of the exported output file (either dvi or pdf, depending on which
7924 one exists in the temporary directory)
7927 \begin_layout Standard
7928 Note that only some of the viewers provide full
7929 \change_inserted -712698321 1500279079
7932 forward search functionality
7933 \change_inserted -712698321 1500278927
7936 , among them yap, xdvi, okular
7940 \begin_layout Plain Layout
7941 You might want to set
7942 \begin_inset Flex Code
7945 \begin_layout Plain Layout
7952 \begin_inset Flex Noun
7955 \begin_layout Plain Layout
7956 Tools\SpecialChar menuseparator
7957 Preferences\SpecialChar menuseparator
7958 File Handling\SpecialChar menuseparator
7960 \begin_inset space ~
7974 \change_inserted -712698321 1500278795
7981 \begin_layout Plain Layout
7982 SumatraPDF can also use DDE commands through the external program CMCDDE
7984 \begin_inset CommandInset href
7986 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
7998 \change_inserted -712698321 1500279294
7999 Others, such as evince
8003 \begin_layout Plain Layout
8004 \paragraph_spacing single
8006 \change_inserted -712698321 1500278873
8007 Forward search with evince can be achieved by means of third party helper
8010 \begin_inset CommandInset href
8012 target "http://wiki.lyx.org/LyX/SyncTeX"
8024 , require some extra tools in order to use forward search.
8027 While many of the widespread PDF viewers (most notably Adobe Reader) do
8028 not support forward search at all, some other viewers – e.
8029 \begin_inset space \thinspace{}
8034 \change_deleted -712698321 1500278769
8037 xpdf – allow at least to reload the document and jump to a specific page
8038 of the file, so you can at least navigate
8039 \begin_inset Quotes eld
8043 \begin_inset Quotes erd
8047 This latter functionality is provided by an external call of synctex (see
8048 the predefined example configurations).
8052 \begin_layout Standard
8053 Forward search works both with DVI and PDF output.
8055 simply checks which preview format you have used before (i.
8056 \begin_inset space \thinspace{}
8059 e., which format is already there in the temporary directory) and chooses
8060 the appropriate configuration for the respective format.
8063 \begin_layout Chapter
8064 Special Document Classes
8067 \begin_layout Section
8071 \begin_layout Standard
8077 \begin_layout Subsection
8081 \begin_layout Standard
8082 This section describes how \SpecialChar LyX
8083 can be used to write articles for submission
8084 to the scientific journal
8086 Astronomy and Astrophysics
8089 \begin_inset Flex URL
8092 \begin_layout Plain Layout
8094 http://www.edpsciences.fr/aa/
8099 ) using Version 5.01 of the document class
8104 This package can be downloaded from the ftp site
8107 \begin_layout Standard
8108 \begin_inset VSpace medskip
8114 \begin_layout Standard
8116 \begin_inset Flex URL
8119 \begin_layout Plain Layout
8121 ftp://ftp.edpsciences.org/pub/aa/readme.html
8129 \begin_layout Standard
8130 \begin_inset VSpace medskip
8136 \begin_layout Standard
8137 A manual comes together with that package, and this text is not meant to
8138 replace the original manual but is merely a short guide in how to realize
8139 the correct form of your paper.
8143 \begin_layout Standard
8144 Please note that the publisher of the journal was changed from Springer
8145 to EDP Sciences starting January 1, 2001.
8146 That change involved also some slight changes to the style files, namely
8147 the removal of the thesaurus command.
8148 The \SpecialChar LyX
8149 class aa supports the newest version of these style files, V 5.01.
8150 If you have an older version installed, please upgrade.
8151 For compatibility, the old (version 4) layout has been kept as
8156 Please refer to the comments in
8159 Dir/layouts/aapaper.layout
8164 \begin_layout Subsection
8168 \begin_layout Standard
8169 It is recommended you start from the example template distributed with \SpecialChar LyX
8171 If you are not using a template, note the following settings:
8174 \begin_layout Itemize
8181 Document\SpecialChar menuseparator
8184 dialog (OK, that one was obvious).
8187 \begin_layout Itemize
8188 Don't change the option
8191 \begin_inset space ~
8201 The whole layout is done by the macros, you shouldn't change anything.
8204 \begin_layout Subsection
8208 \begin_layout Standard
8209 First thing to enter is the header information.
8210 It consists of seven entries, of which some are optional.
8214 \begin_layout Itemize
8222 \begin_layout Itemize
8230 \begin_layout Itemize
8238 \begin_layout Itemize
8246 \begin_layout Itemize
8251 : [optional] if more than one author: whom to contact for offprint requests.
8254 \begin_layout Itemize
8259 : [optional] mail address for contacts.
8262 \begin_layout Itemize
8270 Received: <date>; Accepted <date>
8273 \begin_layout Standard
8274 There is no need to issue the
8280 command, this is done automatically by \SpecialChar LyX
8281 when the header is finished.
8282 Although the order of the single header entries doesn't matter it is advised
8283 to keep the above sequence, just to get the best optics and meets the layout
8284 of the real document.
8287 \begin_layout Standard
8288 If you want to place footnotes in the header block, e.
8289 \begin_inset space \thinspace{}
8293 \begin_inset space \space{}
8296 to state your present address, just use the standard footnote via the menu
8299 Insert\SpecialChar menuseparator
8304 will automagically use the term
8313 \begin_layout Standard
8314 In addition to these topics, the macros use three additional \SpecialChar LaTeX
8316 have no counterpart in \SpecialChar LyX
8320 \begin_layout Itemize
8327 to separate different names for more than one author and institute, respectivel
8331 \begin_layout Itemize
8338 to mark corresponding author/institute pairs.
8339 The institutes are numbered sequentially as they appear in the
8343 field, so you have to put a marker to each author.
8346 \begin_layout Itemize
8353 to supply an email address for fast contact.
8356 \begin_layout Standard
8357 In all cases, the appropriate command has to be entered in \SpecialChar LyX
8365 \begin_layout Subsection
8369 \begin_layout Standard
8370 The abstract should immediately follow the header block.
8371 With version 5 the abstract environment was changed to a command, and there
8372 is now a resctriction to only one paragraph.
8373 In addition, it should contain an entry with the keywords.
8374 This is not yet implemented for \SpecialChar LyX
8375 , therefore you have to enter the \SpecialChar LaTeX
8383 by hand and mark it as \SpecialChar LaTeX
8385 Refer to the example paper.
8388 \begin_layout Subsection
8389 Supported environments
8392 \begin_layout Standard
8393 The A&A paper layout supports the following environments for structuring
8397 \begin_layout Itemize
8403 \begin_layout Itemize
8409 \begin_layout Itemize
8415 \begin_layout Itemize
8421 \begin_layout Itemize
8427 \begin_layout Itemize
8433 \begin_layout Itemize
8439 \begin_layout Itemize
8445 \begin_layout Itemize
8451 \begin_layout Itemize
8457 \begin_layout Itemize
8463 \begin_layout Itemize
8470 \begin_layout Subsection
8471 Commands not supported by \SpecialChar LyX
8475 \begin_layout Standard
8476 Some commands are not yet supported by the
8480 layout for \SpecialChar LyX
8482 Some have already been mentioned.
8483 For the sake of completeness, they are listed all together here:
8486 \begin_layout Itemize
8494 \begin_layout Itemize
8502 \begin_layout Itemize
8510 \begin_layout Itemize
8518 \begin_layout Itemize
8526 \begin_layout Itemize
8534 \begin_layout Itemize
8542 \begin_layout Itemize
8550 \begin_layout Standard
8551 If you want to use any of these commands, you have to enter them yourself.
8554 Do not forget to mark them as \SpecialChar LaTeX
8558 \begin_layout Subsection
8559 Figure and Table Floats
8562 \begin_layout Standard
8564 provides support for the necessary float environments
8566 figure, figure*, table
8572 , therefore we won't tell much about it here.
8576 \begin_inset space ~
8582 Just remember that tables should be left-aligned.
8583 For that, select the table and change the alignment in
8585 Edit\SpecialChar menuseparator
8587 \begin_inset space ~
8593 \begin_layout Standard
8594 There is only one special thing: the figures with caption besides the figure.
8595 To create such a figure, you have to do the following:
8598 \begin_layout Enumerate
8599 Create a wide figure float:
8601 Insert\SpecialChar menuseparator
8602 Float\SpecialChar menuseparator
8605 , then right click in the figure and select
8608 \begin_inset space ~
8616 \begin_layout Enumerate
8617 Enter your caption text.
8620 \begin_layout Enumerate
8625 to move the cursor above the caption.
8628 \begin_layout Enumerate
8632 \begin_layout Enumerate
8633 Position the cursor behind the figure and insert a horizontal fill:
8635 Insert\SpecialChar menuseparator
8637 \begin_inset space ~
8640 Character\SpecialChar menuseparator
8642 \begin_inset space ~
8650 \begin_layout Enumerate
8651 Switch to \SpecialChar LaTeX
8655 \begin_inset space ~
8663 \begin_layout Enumerate
8673 Do not close the brace!
8676 \begin_layout Enumerate
8677 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8682 \begin_inset space ~
8694 \begin_layout Standard
8695 Also, refer to the figures in the example paper.
8698 \begin_layout Subsection
8702 \begin_layout Standard
8703 For submission, the paper has to be formated in a special double-spacing
8705 For this purpose, you have to give the option
8709 to the documentclass.
8710 This must be done using the extra class options field in the
8712 Document\SpecialChar menuseparator
8716 Just enter the string
8723 \begin_layout Subsection
8727 \begin_layout Standard
8732 directory contains an example paper written with \SpecialChar LyX
8734 It is the example paper from the original macro package, translated to
8737 Use it for inspiration, and compare the original \SpecialChar LaTeX
8738 code with \SpecialChar LyX
8742 \begin_layout Section
8747 \begin_layout Standard
8753 \begin_layout Subsection
8757 \begin_layout Standard
8759 is a set of macros produced by the American Astronomical Society to
8760 facilitate electronic manuscript submission to the three journals they
8761 publish: the Astrophysical Journal (including the Letters and Supplement),
8762 the Astronomical Journal, and the Publications of the Astronomical Society
8765 has proven to be an excellent tool for generating these documents, especially
8766 given its equation, citation, and figure handling capabilities.
8768 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8769 is the version described here, or higher.
8770 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8771 2.09 and are fundamentally
8772 incompatible with \SpecialChar LyX
8774 The AAS\SpecialChar TeX
8775 package may be downloaded from the AAS\SpecialChar TeX
8779 \begin_layout Standard
8780 \begin_inset VSpace medskip
8786 \begin_layout Standard
8788 \begin_inset Flex URL
8791 \begin_layout Plain Layout
8793 https://aas.org/aastex/aastex-downloads
8801 \begin_layout Standard
8802 \begin_inset VSpace medskip
8808 \begin_layout Standard
8809 A complete user guide is contained in that package and you should familiarize
8810 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8813 will not reduce the need to figure out all the AAS\SpecialChar TeX
8814 commands, it will only
8815 reduce the drudgery of typing everything in.
8816 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8818 completely to the requirements of the journal to which you are submitting
8822 \begin_layout Subsection
8823 Starting a New Paper
8826 \begin_layout Standard
8827 I strongly suggest that you start with the AAS\SpecialChar TeX
8831 File\SpecialChar menuseparator
8838 , enter the new file name, then choose the
8843 This will show the most common fields found in a manuscript.
8844 Simply overwrite the existing text (including the brackets,
8848 ) with the correct information.
8849 Many of the AAS\SpecialChar TeX
8850 commands and environments can be implemented directly in
8852 , but some cannot: most noticeably
8864 , which should stick out like a sore thumb if you actually just opened the
8866 For commands such as these, the \SpecialChar LaTeX
8867 code must be entered directly and marked
8869 Such commands are referred to as \SpecialChar TeX
8870 code, or Evil Red Text.
8871 I tried to minimize the amount of \SpecialChar TeX
8872 code needed in an AAS\SpecialChar TeX
8874 there is still a bit more required than any of us would like.
8877 \begin_layout Subsection
8878 Finishing Your Paper
8881 \begin_layout Standard
8882 When the paper is finished to your satisfaction and previews/prints correctly,
8884 \begin_inset Quotes eld
8888 \begin_inset Quotes erd
8891 actions which need to be done before you submit it to the journals.
8895 \begin_layout Enumerate
8896 Export your paper as a \SpecialChar LaTeX
8899 File\SpecialChar menuseparator
8900 Export\SpecialChar menuseparator
8908 \begin_layout Enumerate
8913 file with your favorite text editor
8917 \begin_layout Enumerate
8918 remove the comment lines before the
8927 \begin_layout Enumerate
8932 usepackage...{fontenc}
8934 line if it appears (usually just after
8949 \begin_layout Enumerate
8950 remove everything between (and including) the
8962 commands, except for any commands you specifically put into the \SpecialChar LaTeX
8964 (which should appear immediately after the
8965 \begin_inset Quotes eld
8968 User specified \SpecialChar LaTeX
8970 \begin_inset Quotes erd
8981 \begin_layout Enumerate
8982 Run the resulting file through \SpecialChar LaTeX
8983 to make sure it still processes correctly.
8986 \begin_layout Enumerate
8987 Reread the journal requirements to make sure your filenames and formats
8991 \begin_layout Enumerate
8995 \begin_layout Subsection
8996 Comments On Specific Commands
8999 \begin_layout Standard
9000 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9007 ) gives a good description of each.
9008 Thus it's probably easiest for me to go down the list as found in the guide
9009 and offer comments where necessary.
9010 So let's begin \SpecialChar ldots
9014 \begin_layout Subsubsection
9015 Things that work as expected
9018 \begin_layout Standard
9019 Because they work as you might expect, I simply list them and the section
9120 begin{thebibliography}
9128 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9129 graphicx figure commands (2.14.1),
9153 (2.15.4, amongst other places),
9180 \begin_layout Standard
9181 The following style options also work correctly:
9202 Simply put them in the
9208 Layout\SpecialChar menuseparator
9214 \begin_layout Subsubsection
9215 Things that work, but require more comment
9218 \begin_layout Standard
9219 The following items work, but require a little more discussion:
9222 \begin_layout Itemize
9223 These items are reserved for use by the journal editors, but you can put
9224 them into the \SpecialChar LaTeX
9225 preamble if you feel compelled to do so:
9258 \begin_layout Itemize
9259 These items may be placed in the \SpecialChar LaTeX
9260 preamble, and are included as blanks in
9282 \begin_layout Itemize
9289 (2.3) – can only be used
9290 \begin_inset Quotes eld
9294 \begin_inset Quotes erd
9297 , not in the middle of a paragraph.
9298 Use \SpecialChar TeX
9299 code if you need to embed it.
9302 \begin_layout Itemize
9309 (2.3) – will have extra {} after it.
9310 This should not cause an error.
9313 \begin_layout Itemize
9320 (2.6) – can only be used
9321 \begin_inset Quotes eld
9325 \begin_inset Quotes erd
9328 , not in the middle of a paragraph.
9329 Use \SpecialChar TeX
9330 code if you need to embed it.
9333 \begin_layout Itemize
9340 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9344 \begin_layout Itemize
9358 \begin_layout Itemize
9365 (2.9) – will have extra {} after it.
9366 This should not cause an error.
9369 \begin_layout Itemize
9376 (2.11) – will have extra {} after it.
9377 This should not cause an error.
9380 \begin_layout Itemize
9387 (2.14.2) – you can insert an optional filename argument by placing the cursor
9388 at the beginning of the text and selecting
9390 Insert\SpecialChar menuseparator
9395 \begin_inset Quotes eld
9399 \begin_inset Quotes erd
9402 inserts an optional argument of the type needed by
9409 Hopefully it will be renamed someday.
9412 \begin_layout Itemize
9425 for the catalog ID optional parameter
9428 \begin_layout Itemize
9441 for the catalog ID optional parameter
9444 \begin_layout Subsubsection
9445 Things not implemented, use \SpecialChar TeX
9449 \begin_layout Standard
9472 setcounter{equation}
9474 (2.12), Journal name abbreviations (2.13.4),
9510 (2.15.4, insert it as the first element in the lefthand cell after where
9512 Don't use any of \SpecialChar LyX
9513 's rules in the table),
9525 (2.15.5), much of Misc (2.17, except
9576 \begin_layout Subsubsection
9577 Things that cannot be implemented
9580 \begin_layout Standard
9582 at least in any meaningful sort of way, so I suggest ignoring them.
9583 They are the references environment (2.13.3), and the deluxetable environment
9585 If you really, really need to use deluxetable, I suggest editing it in
9586 a separate file with a text editor, then using
9588 Insert\SpecialChar menuseparator
9590 \begin_inset space ~
9595 to include it in your \SpecialChar LyX
9601 file to see an example of this.
9604 \begin_layout Subsection
9605 FAQs, Tips, Tricks, and Other Ruminations
9608 \begin_layout Subsubsection
9609 Getting \SpecialChar LyX
9610 and AAS\SpecialChar TeX
9614 \begin_layout Standard
9615 It can be a bit tricky to get \SpecialChar LyX
9616 to recognize a new layout and document class.
9617 When all else fails, do this:
9620 \begin_layout Enumerate
9621 Make certain that \SpecialChar LaTeX
9622 can find AAS\SpecialChar TeX
9624 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9626 directory completely unrelated to \SpecialChar LaTeX
9627 or AAS\SpecialChar TeX
9628 and run \SpecialChar LaTeX
9636 \begin_layout Enumerate
9641 appears in \SpecialChar LyX
9649 \begin_layout Enumerate
9652 Tools\SpecialChar menuseparator
9656 , then restart \SpecialChar LyX
9660 \begin_layout Enumerate
9661 Open a regular new file, not from a template.
9662 Does AAS\SpecialChar TeX
9663 appear in the class list in
9665 Document\SpecialChar menuseparator
9671 \begin_layout Standard
9672 If you get a warning from an existing AAS\SpecialChar TeX
9673 document about not being able
9674 to find the AAS\SpecialChar TeX
9675 layout or a message about
9676 \begin_inset Quotes eld
9679 You should not mix title layouts with normal ones
9680 \begin_inset Quotes erd
9683 , things haven't been installed correctly.
9686 \begin_layout Subsubsection
9688 error processing a table
9691 \begin_layout Standard
9693 , by default, attempts to center the table caption/title.
9694 This seems to produce a bad interaction in AAS\SpecialChar TeX
9695 so you should click somewhere
9696 in the caption/title, then select
9698 Edit\SpecialChar menuseparator
9700 \begin_inset space ~
9714 This took care of it for me.
9717 \begin_layout Subsubsection
9721 \begin_layout Standard
9722 A couple of things: 1) I have noticed some funny spacing in the reference
9723 entries in the text.
9724 When you enter the bibliography item data, make sure their is
9728 space between the last author and the parenthesis setting off the year;
9732 \begin_inset space \thinspace{}
9736 \begin_inset space \space{}
9750 2) Entering the references at all is not obvious.
9751 The easiest thing is to start typing your first reference at the end of
9752 the document, then mark it as type
9757 That will put a small gray box in front of what you just typed.
9758 Click on the box to fill in the rest of the information.
9759 For new references, go to the end of an existing reference and press return.
9760 That will create a new line with its own box, etc.
9763 \begin_layout Subsubsection
9767 \begin_layout Standard
9768 Even though AAS\SpecialChar TeX
9769 provides its own figure commands (
9775 , for example), I much prefer \SpecialChar LaTeX
9776 's standard figure commands (with the default
9785 \begin_inset space ~
9788 commands as \SpecialChar TeX
9789 code into a Figure Float box if you desire, but I never have
9790 much luck getting the layout right.
9791 With the standard graphics, \SpecialChar LyX
9796 usepackage{graphicx}
9798 command into the \SpecialChar LaTeX
9799 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9801 interspersing the figures in the text.
9802 I believe ApJ accepts figures exactly this way now; AJ might still use
9804 \begin_inset Quotes eld
9807 stack everything at the end
9808 \begin_inset Quotes erd
9814 \begin_layout Subsubsection
9815 Things I could have done, but didn't
9818 \begin_layout Standard
9820 \begin_inset Quotes eld
9824 \begin_inset Quotes erd
9827 things I could have implemented, but chose not to.
9828 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9830 even though it is double-spaced in the paper manuscript.
9831 Also, I chose not to make separate layouts for the preprint and preprint2
9833 Since I assume you will spend most of your time in the plain manuscript
9834 mode anyway, I decided not to chew up more disk space with this.
9838 \begin_layout Subsection
9842 \begin_layout Standard
9843 Your mileage may vary.
9844 I've now had papers published by both ApJ and AJ that have had 98% of the
9845 effort done in \SpecialChar LyX
9846 ; the last 2% was the \SpecialChar LaTeX
9847 post-processing and a few cleanups.
9848 I have had no trouble with the submission process, and I'm sure the journals
9849 were never aware that there might be a difference.
9850 So, go forth and publish!
9853 \begin_layout Section
9854 AMS \SpecialChar LaTeX
9858 \begin_layout Standard
9868 \begin_layout Standard
9869 \begin_inset VSpace bigskip
9875 \begin_layout Standard
9877 The AMS \SpecialChar LaTeX
9878 layouts are set up to conform to suggested styles for mathematical
9879 papers to be submitted to American Mathematical Society publications.
9880 The layouts are not tailored to a specific journal, but easily can be.
9881 You should refer to the AMS documentation for specific instructions for
9882 each journal (usually it will entail only changing a single line in the
9885 That documentation is available on the Web at
9886 \begin_inset Flex URL
9889 \begin_layout Plain Layout
9897 \begin_inset Flex URL
9900 \begin_layout Plain Layout
9902 ftp://ftp.ams.org/pub/tex/amslatex/
9908 These layouts are appropriate, and useful, for any mathematical writing.
9912 \begin_layout Standard
9913 There are two basic AMS \SpecialChar LaTeX
9917 \begin_layout Itemize
9918 amsart: The standard AMS article format.
9921 \begin_layout Itemize
9922 amsbook: the standard AMS book (really, monograph) format.
9926 \begin_layout Standard
9927 The layouts themselves contain only the minimum necessary to use the AMS
9929 They do not, in particular, contain any of the `theorem' environments used
9930 for setting theorems, lemmas, and the like.
9931 These are contained, instead, in the
9932 \begin_inset Flex Code
9935 \begin_layout Plain Layout
9941 module, which is loaded by default when you select one of the AMS classes.
9942 (It can also be used with other classes and can be removed, if you would
9943 rather use something else.) Less commonly used environments are in the
9944 \begin_inset Flex Code
9947 \begin_layout Plain Layout
9948 Theorems (AMS-Extended)
9953 module, which must be loaded manually.
9956 \begin_layout Standard
9957 By default, theorems and the like are numbered consecutively throughout
9958 the document, but this may be modified by loading the module
9959 \begin_inset Flex Code
9962 \begin_layout Plain Layout
9963 Theorems (Order by Section)
9968 or, if you are using
9969 \begin_inset Flex Code
9972 \begin_layout Plain Layout
9979 \begin_inset Flex Code
9982 \begin_layout Plain Layout
9983 Theorems (Order by Chapter)
9989 These will number the results as
9990 \begin_inset Formula $n.m$
9993 , where the first number refers to the section (or chapter) and the second
9994 refers to the total number of results so far in that section (or chapter).
9995 Many environments are also available unnumbered.
9996 These are indicated by an asterisk at the end.
9997 If you happen to want
10001 unnumbered results, the module
10002 \begin_inset Flex Code
10005 \begin_layout Plain Layout
10011 provides that option.
10014 \begin_layout Standard
10015 Note that these modules do not
10019 to be used with the AMS classes.
10020 It is perfectly possible to use the
10021 \begin_inset Flex Code
10024 \begin_layout Plain Layout
10030 module, and the others mentioned, with other classes, such as
10031 \begin_inset Flex Code
10034 \begin_layout Plain Layout
10041 \begin_inset Flex Code
10044 \begin_layout Plain Layout
10051 \begin_inset Flex Code
10054 \begin_layout Plain Layout
10063 \begin_layout Subsection
10064 What these layouts provide
10067 \begin_layout Standard
10068 There is a long list of included environments provided by these layouts.
10069 In AMS-\SpecialChar LaTeX
10070 , there is, in fact, an opportunity to define an unlimited variety
10071 of `theorem' environments.
10072 However, the AMS recommends the environments that are available in \SpecialChar LyX
10077 \begin_layout Standard
10078 The following environments—as well as the standard environments, such as
10080 \begin_inset Flex Noun
10083 \begin_layout Plain Layout
10090 \begin_inset Flex Noun
10093 \begin_layout Plain Layout
10100 \begin_inset Flex Noun
10103 \begin_layout Plain Layout
10110 \begin_inset Flex Noun
10113 \begin_layout Plain Layout
10120 \begin_inset Flex Noun
10123 \begin_layout Plain Layout
10130 \begin_inset Flex Code
10133 \begin_layout Plain Layout
10140 \begin_inset Flex Code
10143 \begin_layout Plain Layout
10152 \begin_layout Description
10153 Address This should be the author's permanent address.
10156 \begin_layout Description
10158 \begin_inset space ~
10161 Address This should be the author's temporary address at the time of submission,
10162 if different from the Address.
10165 \begin_layout Description
10166 Email Author's e-mail address
10169 \begin_layout Description
10170 URL Author's Web address, if desired.
10173 \begin_layout Description
10174 Keywords Key words or phrases used to identify specific topics discussed
10178 \begin_layout Description
10179 Subjectclass These refer to the AMS Subject Classifications, published and
10182 Mathematical Reviews
10185 These are also available online at the AMS cites listed above.
10188 \begin_layout Description
10192 \begin_layout Description
10196 \begin_layout Description
10200 \begin_layout Standard
10201 The following environments are provided by both the
10202 \begin_inset Flex Code
10205 \begin_layout Plain Layout
10212 \begin_inset Flex Code
10215 \begin_layout Plain Layout
10221 modules, in the latter case in both starred (unnumbered) and unstarred
10222 (numbered) versions.
10223 These same environments are provided only in the starred versions by the
10225 \begin_inset Flex Code
10228 \begin_layout Plain Layout
10237 \begin_layout Theorem
10238 This is typically used for the statements of major results.
10242 \begin_layout Corollary*
10243 This is used for statements which follow fairly directly from previous statement
10245 Again, these can be major results.
10249 \begin_layout Lemma
10250 These are smaller results needed to prove other statements.
10253 \begin_layout Proposition
10254 These are less major results which (hopefully) add to the general theory
10258 \begin_layout Conjecture
10259 These are statements provided without justification, which the author does
10260 not know how to prove, but which seem to be true (to the author, at least).
10263 \begin_layout Definition*
10264 Guess what this is for.
10265 The font is different for this environment than for the previous ones.
10269 \begin_layout Example*
10270 Used for examples illustrating proven results.
10273 \begin_layout Problem
10274 It's not really known what this is for.
10275 You should figure it out.
10278 \begin_layout Exercise*
10279 Write a description for this one.
10282 \begin_layout Remark
10283 This environment is also a type of theorem, usually a lesser sort of observation.
10286 \begin_layout Claim*
10287 Often used in the course of giving a proof of a larger result.
10291 Generally, these are used to break up long arguments, using specific instances
10297 The numbering scheme for cases is on its own, not together with other numbered
10302 \begin_layout Proof
10303 At the end of this environment, a QED symbol (usually a square, but it can
10304 vary with different styles) is placed.
10305 If you want to have other environments within this one—for example, Case
10306 environments—and have the QED symbol appear only after them, then the other
10307 environments need to be nested within the proof environment.
10310 Nesting Environments
10316 for information on nesting.
10319 \begin_layout Standard
10320 And these environments are provided by
10321 \begin_inset Flex Code
10324 \begin_layout Plain Layout
10325 Theorems (AMS-Extended)
10333 \begin_layout Criterion*
10334 A required condition.
10337 \begin_layout Algorithm*
10338 A general procedure to be used.
10341 \begin_layout Axiom*
10342 This is a property or statement taken as true within the system being discussed.
10345 \begin_layout Condition*
10346 Sometimes used to state a condition assumed within the present context of
10350 \begin_layout Note*
10351 Similar to a Remark.
10354 \begin_layout Notation*
10355 Used for the explanation of, yes, notation.
10358 \begin_layout Summary
10359 Do we really need to tell you?
10362 \begin_layout Acknowledgement*
10366 \begin_layout Conclusion*
10367 Sometimes used at the end of a long train of argument.
10371 Used in a way similar to Proposition, though perhaps lower on the scale.
10374 \begin_layout Standard
10375 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10378 They need to be available on your system in order to use these environments.
10381 \begin_layout Section
10389 \begin_layout Standard
10395 \begin_layout Subsection
10399 \begin_layout Standard
10400 These are the layout files for some of the journals of the American Geophysical
10402 It is assumed that you have both the AGU's own class files and AGUplus
10403 installed (everything to be found at
10404 \begin_inset Flex URL
10407 \begin_layout Plain Layout
10409 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10417 \begin_layout Subsection
10421 \begin_layout Standard
10431 They are still called this in the \SpecialChar LyX
10432 GUI, though their \SpecialChar LaTeX
10445 \begin_layout Standard
10446 Newly defined styles are
10483 These are mostly manuscript attributes and defined in the AGU class documentati
10487 \begin_layout Standard
10488 I suspect this is still badly incomplete.
10491 \begin_layout Subsection
10495 \begin_layout Standard
10512 \begin_layout Subsection
10516 \begin_layout Itemize
10519 Journal of Geophysical Research
10528 \begin_layout Standard
10529 Add your own, it isn't so hard! Look at the
10540 \begin_layout Subsection
10541 Bugs and things to remember
10544 \begin_layout Standard
10545 In order to use the new layouts, you must remember to do the following for
10549 \begin_layout Enumerate
10555 This can be done in the
10557 Layout\SpecialChar menuseparator
10562 Document\SpecialChar menuseparator
10566 (AGU articles are always in English, right? So
10570 choose a language.)
10573 \begin_layout Enumerate
10578 into the document's
10583 (Yes, this is a bug.)
10586 \begin_layout Enumerate
10587 Make sure you use the
10591 bibliography style, by entering
10595 into the second field of the Bib\SpecialChar TeX
10597 None of the standard styles will do.
10600 \begin_layout Section
10604 \begin_layout Standard
10610 \begin_layout Subsection
10614 \begin_layout Standard
10615 Broadway is for writing plays.
10616 The format is more decorative than Hollywood, and much less standardized.
10617 This format should be suitable for workshops.
10620 \begin_layout Subsection
10624 \begin_layout Standard
10625 The same as in Hollywood.
10628 \begin_layout Subsection
10632 \begin_layout Standard
10637 names as labels then cross-reference the label to insert the name.
10638 The cross-reference dialog will show the current cast of characters.
10641 \begin_layout Subsection
10642 Paper size and Margins
10645 \begin_layout Standard
10646 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10649 \begin_layout Subsection
10653 \begin_layout Standard
10654 The following environments are available.
10655 You can use broadway.bind to get the bind keys shown at the right.
10658 \begin_layout Itemize
10662 \begin_inset Newline newline
10667 You should not have to use this, but it is here for anything that does not
10671 \begin_layout Itemize
10675 \begin_inset space \hfill{}
10679 \begin_inset Newline newline
10684 Used to describe stage setting and the action.
10685 First use of speaker names in all CAPs.
10688 \begin_layout Itemize
10692 \begin_inset space \hfill{}
10696 \begin_inset Newline newline
10701 Automatically numbered.
10702 On screen it will be arabic, but will print as Roman.
10705 \begin_layout Itemize
10709 \begin_inset space \hfill{}
10713 \begin_inset Newline newline
10723 It is just centered text.
10726 \begin_layout Itemize
10730 \begin_inset space \hfill{}
10734 \begin_inset Newline newline
10739 Not automatically numbered.
10740 You supply the number.
10741 This is because I couldn't figure out how.
10744 \begin_layout Itemize
10748 \begin_inset space \hfill{}
10752 \begin_inset Newline newline
10757 A special case of Narrative to describe the setting and action as the curtain
10761 \begin_layout Itemize
10765 \begin_inset space \hfill{}
10769 \begin_inset Newline newline
10774 The speaker's (actor's) title, centered in all CAPS.
10777 \begin_layout Itemize
10781 \begin_inset space \hfill{}
10785 \begin_inset Newline newline
10790 Instructions to the speaker.
10791 The parentheses are automatically inserted.
10792 The ( will appear on screen, but both will be in the printed play.
10793 This environment is only used within
10800 \begin_layout Itemize
10804 \begin_inset space \hfill{}
10808 \begin_inset Newline newline
10813 What the Speaker says.
10816 \begin_layout Itemize
10820 \begin_inset space \hfill{}
10824 \begin_inset Newline newline
10829 The curtain comes down.
10832 \begin_layout Itemize
10836 \begin_inset space \hfill{}
10842 \begin_layout Itemize
10846 \begin_inset space \hfill{}
10852 \begin_layout Itemize
10856 \begin_inset space \hfill{}
10862 \begin_layout Standard
10866 \begin_layout Section
10870 \begin_layout Standard
10875 can be used to type letters according to German conventions.
10876 A template file is included in
10878 .../lyx/share/templates
10880 for you to use as a starting point.
10883 \begin_layout Section
10891 \begin_layout Standard
10897 \begin_layout Subsection
10901 \begin_layout Standard
10902 This is the layout file for the European Geophysical Society journals.
10907 can be downloaded from the web site of the EGS under
10908 \begin_inset Flex URL
10911 \begin_layout Plain Layout
10921 \begin_layout Subsection
10925 \begin_layout Standard
10928 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10936 The current layout file is unfortunately very unmodular and would benefit
10937 from using the various
10944 \begin_layout Section
10948 \begin_layout Standard
10949 See the \SpecialChar LyX
10955 It contains all infos you need.
10958 \begin_layout Section
10961 Foil\SpecialChar TeX
10965 \begin_inset CommandInset label
10974 \begin_layout Standard
10980 \begin_layout Subsection
10984 \begin_layout Standard
10985 This section describes how to use \SpecialChar LyX
10986 to make slides for overhead projectors.
10987 There are two document classes that can do this: the default slides class
10990 Foil\SpecialChar TeX
10994 This section documents the latter.
10997 \begin_layout Standard
10998 I'm going to say this again, nice and clear, so that there's no misunderstanding
11002 \begin_layout Standard
11003 \begin_inset VSpace bigskip
11009 \begin_layout Standard
11013 This section documents the class
11014 \begin_inset Quotes eld
11022 \begin_inset Quotes erd
11030 \begin_layout Standard
11031 \begin_inset VSpace bigskip
11037 \begin_layout Standard
11038 If you're looking for the documentation for
11039 \begin_inset Quotes eld
11047 \begin_inset Quotes erd
11050 , check out section
11051 \begin_inset space ~
11055 \begin_inset CommandInset ref
11057 reference "sec:slitex"
11062 If your machine doesn't have the
11070 installed, you'll probably have to use the default
11074 class, which isn't quite as good as
11079 \begin_layout Standard
11084 class is designed for use with version
11085 \begin_inset space ~
11093 class file which is now an integral part of \SpecialChar LaTeX2e
11097 \begin_layout Subsection
11101 \begin_layout Standard
11102 Obviously, to use this document class, you need to select
11113 \begin_inset space ~
11119 There are some settings in the
11122 \begin_inset space ~
11127 dialog that you should know about that are specific to this class:
11130 \begin_layout Itemize
11131 Don't change the options
11142 \begin_inset space ~
11148 They're ignored by the
11155 \begin_layout Itemize
11156 The default font size is 20
11157 \begin_inset space \thinspace{}
11160 pt with the other options being 17
11161 \begin_inset space \thinspace{}
11165 \begin_inset space \thinspace{}
11169 \begin_inset space \thinspace{}
11175 \begin_layout Itemize
11176 The default font is
11184 but all math equations are still typeset in the usual roman font.
11187 \begin_layout Itemize
11190 Foil\SpecialChar TeX
11193 supports A4 and Letter paper sizes as well as a special size for working
11195 \begin_inset space \thinspace{}
11199 It doesn't support A5, B5, legal or executive paper sizes.
11202 \begin_layout Itemize
11203 Don't bother changing the
11207 settings because they are ignored anyway.
11208 All floats appear where they are defined in the text.
11211 \begin_layout Itemize
11216 setting behaves a bit differently for this class.
11219 Foil\SpecialChar TeX
11222 provides extensive footer and header capabilities including a user-defined
11225 \begin_inset space ~
11229 \begin_inset CommandInset ref
11231 reference "sec:foilfoot"
11236 The title page is treated differently to all other pages in the document
11245 has the logo centered at the bottom of the page (if one is defined).
11246 The possible page style choices and what they do are as follows:
11250 \begin_layout Labeling
11251 \labelwidthstring MMMMMMM
11258 The final output contains no page numbers, or other headers or footers
11259 (except footnotes of course).
11263 \begin_layout Labeling
11264 \labelwidthstring MMMMMMM
11271 The final output contains page numbers centered at the bottom of the page.
11272 No other headings or footers (other than footnotes).
11275 \begin_layout Labeling
11276 \labelwidthstring MMMMMMM
11281 Page numbers in lower right corner.
11282 Additional headers and footers are also shown.
11283 This is also the default.
11286 \begin_layout Labeling
11287 \labelwidthstring MMMMMMM
11292 Gives you access to the
11296 package although its use with
11298 Foil\SpecialChar TeX
11301 is discouraged by the writer of the
11303 Foil\SpecialChar TeX
11306 package because of some potential page layout clashes.
11310 \begin_layout Subsubsection
11314 \begin_layout Standard
11315 The following options may be used in the extra class options in the
11317 Document\SpecialChar menuseparator
11323 \begin_layout Labeling
11324 \labelwidthstring MMMMMMx
11329 This sets up the page layout for 7.33
11330 \begin_inset space \thinspace{}
11334 \begin_inset space \thinspace{}
11337 in paper, which is about the same aspect ratio as a 35
11338 \begin_inset space \thinspace{}
11341 mm slide, making it a bit easier to work with this medium.
11344 \begin_layout Labeling
11345 \labelwidthstring MMMMMMx
11350 Places a rule across the page below the header on every page except the
11354 \begin_layout Labeling
11355 \labelwidthstring MMMMMMx
11360 Places a rule across the page above the footer on every page except the
11364 \begin_layout Labeling
11365 \labelwidthstring MMMMMMx
11370 This is automatically set each time you create a new
11377 Foil\SpecialChar TeX
11380 to use the dvips driver to rotate those pages that are set as landscape
11384 \begin_layout Labeling
11385 \labelwidthstring MMMMMMx
11390 Simply changes the page dimensions to those of a landscape page but doesn't
11392 Thus if you use this option you need to use an external program to rotate
11393 each page or feed your paper through your printer as landscape.
11394 Note that this option effectively reverses the roles of the
11402 environments (don't worry these are described in the next section).
11405 \begin_layout Labeling
11406 \labelwidthstring MMMMMMx
11411 Equation numbers on the left.
11414 \begin_layout Labeling
11415 \labelwidthstring MMMMMMx
11420 Flush-left equations.
11423 \begin_layout Subsection
11424 Supported Environments
11427 \begin_layout Standard
11428 Most of the environments commonly supported in other classes are also supported
11434 There are several additional environments provided by
11436 Foil\SpecialChar TeX
11439 as well as a couple added by \SpecialChar LyX
11441 The following environments are shared with other classes:
11444 \begin_layout Standard
11445 \begin_inset Flex Multiple Columns
11448 \begin_layout Itemize
11454 \begin_layout Itemize
11460 \begin_layout Itemize
11466 \begin_layout Itemize
11472 \begin_layout Itemize
11478 \begin_layout Itemize
11485 \begin_layout Itemize
11491 \begin_layout Itemize
11497 \begin_layout Itemize
11503 \begin_layout Itemize
11509 \begin_layout Itemize
11515 \begin_layout Itemize
11521 \begin_layout Itemize
11527 \begin_layout Itemize
11533 \begin_layout Itemize
11539 \begin_layout Itemize
11545 \begin_layout Itemize
11551 \begin_layout Itemize
11562 \begin_layout Standard
11563 That is, all the major environments apart from the sectioning environments.
11564 Since foils are essentially self-contained sections, with a title and body,
11567 Foil\SpecialChar TeX
11570 provides specific commands for starting new foils and these are:
11573 \begin_layout Itemize
11579 \begin_layout Itemize
11585 \begin_layout Standard
11587 also provides slightly modified versions of these two environments called:
11590 \begin_layout Itemize
11596 \begin_layout Itemize
11599 ShortRotatefoilhead
11602 \begin_layout Standard
11603 and the differences will be explained in the next section.
11606 \begin_layout Standard
11607 Since foils are often used in presenting ideas or new theorems and such
11610 Foil\SpecialChar TeX
11613 also provides a comprehensive box of goodies for presenting them:
11616 \begin_layout Standard
11617 \begin_inset Flex Multiple Columns
11620 \begin_layout Itemize
11626 \begin_layout Itemize
11632 \begin_layout Itemize
11638 \begin_layout Itemize
11644 \begin_layout Itemize
11650 \begin_layout Itemize
11656 \begin_layout Itemize
11662 \begin_layout Itemize
11668 \begin_layout Itemize
11674 \begin_layout Itemize
11680 \begin_layout Itemize
11691 \begin_layout Standard
11692 The starred versions are unnumbered while the unstarred versions are numbered.
11693 There are also two list environments added by \SpecialChar LyX
11697 \begin_layout Itemize
11703 \begin_layout Itemize
11709 \begin_layout Standard
11712 Foil\SpecialChar TeX
11715 provides some powerful header and footer capabilities that are best set
11716 in the preamble although they may be set at any point in a document.
11717 If you want to change these settings in your document the best place to
11718 do so is at the very top of a foil, i.
11719 \begin_inset space \thinspace{}
11725 \begin_inset space \space{}
11730 straight after the foilhead.
11733 \begin_layout Standard
11734 For this purpose, the following command styles are provided [
11741 \begin_layout Standard
11742 \begin_inset Flex Multiple Columns
11745 \begin_layout Itemize
11749 \begin_inset space ~
11755 \begin_layout Itemize
11761 \begin_layout Itemize
11765 \begin_inset space ~
11771 \begin_layout Itemize
11775 \begin_inset space ~
11781 \begin_layout Itemize
11785 \begin_inset space ~
11792 \begin_layout Plain Layout
11793 \begin_inset space ~
11805 \begin_layout Standard
11806 There are also a few commands provided by
11808 Foil\SpecialChar TeX
11811 that aren't directly supported by \SpecialChar LyX
11812 but I'll tell you what they do and how
11813 to use them in section
11814 \begin_inset space ~
11818 \begin_inset CommandInset ref
11820 reference "sec:unsuppfoils"
11827 \begin_layout Subsection
11828 Building a Set of Foils
11831 \begin_layout Standard
11832 This section will give a simple introduction to using the different environments
11833 to build a set of foils.
11834 If you want to see an example set of foils, take a look at the
11838 file you find in \SpecialChar LyX
11846 \begin_layout Subsubsection
11847 Give It a Title Page
11850 \begin_layout Standard
11851 Unlike other classes that provide
11871 creates the title on a page of its own.
11872 If you leave out the
11876 environment \SpecialChar LaTeX
11877 will substitute the current date (every time you regenerate
11881 \begin_layout Subsubsection
11885 \begin_layout Standard
11886 As I mentioned earlier, there are four ways of starting a new foil.
11887 For portrait foils you should use
11896 The difference between these two environments is the amount of space between
11897 the title of the foil (the foilhead) and the body of the foil.
11900 \begin_layout Standard
11901 Landscape foils are generated using the
11907 ShortRotatefoilhead
11910 Again the only difference is the spacing between foilhead and body.
11911 Both of the short versions have 0.5
11912 \begin_inset space ~
11915 inches less separation between the foilhead and the body.
11919 \begin_layout Standard
11920 One problem with the support for landscape foils is the requirement that
11921 you have to use the
11925 driver to generate the PostScript output otherwise the foils won't be rotated.
11926 It is possible to get landscape foils even if you haven't got the
11930 driver provided you can feed your foils sideways through your printer ;-)
11933 \begin_layout Subsubsection
11934 Theorems, Lemmas, Proofs and more
11937 \begin_layout Standard
11938 Due to a small bug in \SpecialChar LyX
11939 you can't have two of the same type of these environments
11940 directly following each other.
11941 They must be separated by something.
11942 If you try, you will just be extending the previous environment as if you
11943 had merged the two environments together.
11944 So, how do you get around this problem? The simplest option is to insert
11945 some text between the two environments or add a
11950 environment between the two with just a
11951 \begin_inset Quotes eld
11959 \begin_inset Quotes erd
11963 This will force \SpecialChar LyX
11964 to produce two separate environments and hence the correct
11967 An example is provided in the example file included with the \SpecialChar LyX
11969 Remember, this problem only occurs if you are trying to place two of the
11970 same type of theorem-like environments one directly after the other.
11973 \begin_layout Subsubsection
11977 \begin_layout Standard
11978 You get all the commonly supported list styles found in other classes as
11979 well as two new ones.
11980 I'll only describe the new ones here.
11981 If you want to find out more about the other list environments check out
11987 If you intend to use itemized lists you might also want to read about the
11991 \begin_inset space ~
11995 \begin_inset space ~
12000 dialog described above in section
12001 \begin_inset space ~
12005 \begin_inset CommandInset ref
12007 reference "sec:bullet"
12014 \begin_layout Standard
12015 The two new list styles,
12023 , are designed to make it easier for you to create lists of do's and don'ts
12024 or right and wrong by providing dedicated environments that use a tick
12025 or a cross as the label of the list.
12026 These lists are in fact dedicated variants of the
12031 They do however require that you have the
12035 packages installed.
12038 \begin_layout Subsubsection
12042 \begin_layout Standard
12045 Foil\SpecialChar TeX
12048 redefines the floating tables and figures so that they appear exactly where
12049 they are in the text rather than pushing them to the top of the page or
12050 to some user specified location.
12051 In fact if you change the float placement settings they are simply ignored.
12054 \begin_layout Subsubsection
12055 Page Headers and Footers
12056 \begin_inset CommandInset label
12058 name "sec:foilfoot"
12065 \begin_layout Standard
12069 \begin_inset space ~
12078 are two commands used to control the left-footer text string.
12079 The first is meant to allow you to include a graphic logo on your foils
12081 \begin_inset Quotes eld
12086 Foil\SpecialChar TeX
12090 \begin_inset Quotes erd
12094 While the second is meant to provide a classification for the audience,
12098 \begin_inset space \thinspace{}
12104 \begin_inset space \space{}
12108 It is empty by default.
12111 \begin_layout Standard
12112 The remaining page corners can be filled by
12115 \begin_inset space ~
12120 (which defaults to page numbers),
12123 \begin_inset space ~
12131 \begin_inset space ~
12139 \begin_layout Subsection
12142 Foil\SpecialChar TeX
12146 \begin_inset CommandInset label
12148 name "sec:unsuppfoils"
12155 \begin_layout Standard
12156 All the commands mentioned below need to be set in a
12166 within another environment.
12169 \begin_layout Subsubsection
12173 \begin_layout Standard
12174 All lengths are adjusted using the
12197 should be replaced by the name given to the length you want to change and
12202 is the length value.
12203 All lengths should be specified in units of length such as inches (
12215 ) or relative to some document or font-based length such as
12225 \begin_layout Standard
12226 It's possible to change the spacing between a foilhead and the body of the
12227 foil by adjusting the length specified by
12234 For example, to make
12239 \begin_inset space \space{}
12242 in closer to their bodies put the following in the preamble:
12248 foilheadskip}{-0.5in}
12251 \begin_layout Standard
12252 The spacings around floats can be adjusted by setting these lengths:
12255 \begin_layout Labeling
12256 \labelwidthstring MMMMMMMMMMM
12263 Separation between the text and the top of the float
12266 \begin_layout Labeling
12267 \labelwidthstring MMMMMMMMMMM
12274 Separation between the float and the caption
12277 \begin_layout Labeling
12278 \labelwidthstring MMMMMMMMMMM
12285 Separation between the caption and the following text
12288 \begin_layout Labeling
12289 \labelwidthstring MMMMMMMMMMM
12296 You can make the captions narrower than the surrounding text by adjusting
12298 Best done relative to
12307 \begin_layout Standard
12308 There are also several title page related lengths that you may find useful
12309 if you have a long title or several authors:
12312 \begin_layout Labeling
12313 \labelwidthstring MMMMMMMMMMM
12320 Separation from headers to
12325 \begin_layout Labeling
12326 \labelwidthstring MMMMMMMMMMM
12344 \begin_layout Labeling
12345 \labelwidthstring MMMMMMMMMMM
12359 \begin_layout Labeling
12360 \labelwidthstring MMMMMMMMMMM
12376 \begin_layout Labeling
12377 \labelwidthstring MMMMMMMMMMM
12393 \begin_layout Standard
12394 The last length related command affects all the list environments.
12405 a list environment then all the vertical spacing between the list items
12407 Note that this is a command not a length so it doesn't require
12413 like the stuff mentioned above.
12416 \begin_layout Subsubsection
12417 Headers and Footers
12420 \begin_layout Standard
12433 commands control whether the logo in the
12437 definition appear on a given page.
12444 in the preamble then none of the foils will have the logo on them.
12445 If you don't want the logo on a particular page place the
12451 directly after the foilhead of that page and the
12457 directly after the next foilhead.
12460 \begin_layout Standard
12461 If you decide to use the
12465 page style setting in the
12468 \begin_inset space ~
12473 dialog you should probably add
12483 to your preamble so headers and footers on landscape pages are correctly
12484 placed when rotated.
12485 This is due to some clashes between the page layouts provided by the
12496 \begin_layout Section
12497 Hollywood (Hollywood spec scripts)
12500 \begin_layout Standard
12506 \begin_layout Subsection
12510 \begin_layout Standard
12511 Getting the format of a Hollywood script right is a
12512 \begin_inset Quotes eld
12516 \begin_inset Quotes erd
12519 It is designed to make the readers focus on content and to be easy and
12520 familiar for the actors to read.
12521 Each page of a script should be one minute of film.
12522 Nothing goes in a script that you cannot see or hear on screen.
12523 The courier 12 pt font should be used throughout.
12527 \begin_layout Subsection
12531 \begin_layout Standard
12532 Speakers' lines should NEVER break in mid-sentence.
12533 If a speaker's lines continue over a page break, repeat the
12537 title followed by (Cont'd).
12540 \begin_layout Subsection
12544 \begin_layout Standard
12549 names as labels then cross-reference the label to insert the name.
12550 The cross-reference dialog will show the current cast of characters.
12551 You can use this to insert the speaker name in narratives also.
12554 \begin_layout Subsection
12555 Paper size and Margins
12558 \begin_layout Standard
12559 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12562 \begin_layout Subsection
12566 \begin_layout Standard
12567 The following environments are available.
12568 You can use hollywood.bind to get the bind keys shown at the right.
12571 \begin_layout Itemize
12575 \begin_inset Newline newline
12580 Used where nothing else works.
12584 \begin_layout Itemize
12590 \begin_inset space \hfill{}
12598 \begin_inset Newline newline
12601 Usually followed by something like
12602 \begin_inset Quotes eld
12605 on Sally waking up.
12606 \begin_inset Quotes erd
12612 \begin_layout Itemize
12616 \begin_inset space \hfill{}
12620 \begin_inset Newline newline
12625 Introduces a new INTERIOR camera set-up.
12626 Always followed by DAY or NIGHT, or something similar to define the lighting
12628 Everthing on this line in CAPS.
12631 \begin_layout Itemize
12635 \begin_inset space \hfill{}
12639 \begin_inset Newline newline
12644 Introduces a new EXTERIOR camera set-up.
12645 Everthing on this line in CAPS.
12648 \begin_layout Itemize
12652 \begin_inset space \hfill{}
12656 \begin_inset Newline newline
12661 The character speaking.
12664 \begin_layout Itemize
12668 \begin_inset space \hfill{}
12672 \begin_inset Newline newline
12677 Instructions to the speaker.
12678 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12680 Both will be printed.
12683 \begin_layout Itemize
12687 \begin_inset space \hfill{}
12691 \begin_inset Newline newline
12703 \begin_layout Itemize
12707 \begin_inset space \hfill{}
12711 \begin_inset Newline newline
12716 Camera movement instruction.
12718 \begin_inset space \thinspace{}
12722 \begin_inset space \space{}
12728 \begin_layout Itemize
12732 \begin_inset space \hfill{}
12738 \begin_layout Itemize
12742 \begin_inset space \hfill{}
12748 \begin_layout Itemize
12752 \begin_inset space \hfill{}
12758 \begin_layout Itemize
12762 \begin_inset space \hfill{}
12768 \begin_layout Subsection
12772 \begin_layout Itemize
12776 \begin_layout Itemize
12780 \begin_layout Itemize
12782 \begin_inset space \thinspace{}
12789 \begin_layout Itemize
12794 \begin_layout Itemize
12795 PAN — camera movement
12798 \begin_layout Itemize
12799 INSERT — cut to close-up of
12802 \begin_layout Section
12806 \begin_layout Standard
12809 Panayotis Papasotiriou
12812 \begin_layout Subsection
12816 \begin_layout Standard
12817 The ijmpc package is a set of macros that facilitates electronic manuscript
12820 International Journal of Modern Physics C
12823 Similarly, the ijmpd package is for creating manuscripts to be submitted
12826 International Journal of Modern Physics D
12829 Both journals are published by World Scientific.
12830 The corresponding document classes are named
12839 These files, together with instructions for the authors, can be downloaded
12841 \begin_inset Flex URL
12844 \begin_layout Plain Layout
12846 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12852 \begin_inset Flex URL
12855 \begin_layout Plain Layout
12857 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12863 Both packages are modified versions of the standard
12864 \begin_inset Quotes eld
12868 \begin_inset Quotes erd
12871 package, and they are almost (but not exactly) identical.
12872 Most of their features are supported by \SpecialChar LyX
12874 I have used \SpecialChar LyX
12875 successfully to write articles submitted to both journals
12876 without any problem.
12879 \begin_layout Subsection
12883 \begin_layout Standard
12884 As usual, the easiest way to write a paper is to start with a template.
12887 File\SpecialChar menuseparator
12903 This will give an (almost) empty document that includes the most common
12904 fields found in a manuscript.
12905 Simply overwrite the existing text (including the brackets,
12910 You should keep in mind the following remarks.
12913 \begin_layout Enumerate
12915 won't let you change the font size and the page style of the document,
12916 because such modifications are not allowed by both packages.
12919 \begin_layout Enumerate
12920 The language of the document should not be changed.
12921 Before previewing your paper, be sure that the babel package is not used.
12922 To do this, click on
12924 Tools\SpecialChar menuseparator
12935 checkbox in the language settings, and click on
12943 , if you wish to make this change permanent).
12946 \begin_layout Enumerate
12948 \begin_inset Quotes eld
12952 \begin_inset Quotes erd
12955 style must be used to define keywords.
12958 \begin_layout Enumerate
12959 The ijmpc package provides a style named
12960 \begin_inset Quotes eld
12963 Classification Codes
12964 \begin_inset Quotes erd
12967 , which can be used to define classification codes, such as PACS numbers.
12968 Note that this facility is not supported by the ijmpd package.
12971 \begin_layout Enumerate
12972 Several new environments are available:
12973 \begin_inset Quotes eld
12977 \begin_inset Quotes erd
12981 \begin_inset Quotes eld
12985 \begin_inset Quotes erd
12989 \begin_inset Quotes eld
12993 \begin_inset Quotes erd
12997 \begin_inset Quotes eld
13001 \begin_inset Quotes erd
13005 \begin_inset Quotes eld
13009 \begin_inset Quotes erd
13013 \begin_inset Quotes eld
13017 \begin_inset Quotes erd
13021 \begin_inset Quotes eld
13025 \begin_inset Quotes erd
13029 \begin_inset Quotes eld
13033 \begin_inset Quotes erd
13037 \begin_inset Quotes eld
13041 \begin_inset Quotes erd
13045 \begin_inset Quotes eld
13049 \begin_inset Quotes erd
13053 \begin_inset Quotes eld
13057 \begin_inset Quotes erd
13061 \begin_inset Quotes eld
13065 \begin_inset Quotes erd
13069 \begin_inset Quotes eld
13073 \begin_inset Quotes erd
13077 \begin_inset Quotes eld
13081 \begin_inset Quotes erd
13085 Their use is more or less obvious.
13087 supports all these environments; it will use the proper label, text style,
13088 and numbering scheme for each of them.
13091 \begin_layout Enumerate
13092 Both packages use basic citations; the natbib package should not be used.
13093 In \SpecialChar LyX
13094 , citation references are shown as usual; in the output, citations are
13095 shown as superscripts.
13096 If you want to use a citation as normal text, you should use the
13101 \begin_inset space \thinspace{}
13105 \begin_inset space \space{}
13109 \begin_inset Quotes eld
13113 \begin_inset space \space{}
13123 \begin_inset Quotes erd
13129 \begin_layout Enumerate
13131 \begin_inset Quotes eld
13135 \begin_inset Quotes erd
13138 section in both packages.
13139 To put acknowledgments, just use the
13140 \begin_inset Quotes eld
13144 \begin_inset Quotes erd
13150 \begin_layout Enumerate
13151 Appendices may be added to the paper,
13155 the Acknowledgments and
13161 provides a special environment, called
13162 \begin_inset Quotes eld
13166 \begin_inset Quotes erd
13169 which marks the beginning of the appendices.
13170 This environment should be left blank; it just sends a \SpecialChar LaTeX
13171 command, but nothing
13173 In \SpecialChar LyX
13175 \begin_inset Quotes eld
13179 \begin_inset Quotes erd
13182 is printed with blue letters, as a signal that all sections after that
13183 point are appendices.
13184 To write an appendix, use the
13185 \begin_inset Quotes eld
13189 \begin_inset Quotes erd
13194 will number each appendix with capital letters, as required by both journals.
13196 \begin_inset Quotes eld
13200 \begin_inset Quotes erd
13207 be present before the first appendix; if not, all appendices will be numbered
13208 as normal sections in the output.
13211 \begin_layout Enumerate
13212 The ijmpc and the ijmpd packages use the
13216 command to implement table captions.
13217 As a result, a table created by \SpecialChar LyX
13218 is printed correctly, but its caption
13220 However, you can use some \SpecialChar TeX
13221 code to overcome this problem, so that captions
13222 are printed as expected.
13223 To do so, create a float table as usual, remove the caption, and replace
13224 it with the \SpecialChar TeX
13235 (sic); you must also the \SpecialChar TeX
13240 immediately after the tabular material.
13241 Study the example table included in the template files to see how this
13242 trick is implemented.
13243 Alternatively, If you need table captions, you should implement the whole
13248 file, then include this file to the \SpecialChar LyX
13251 Insert\SpecialChar menuseparator
13252 File\SpecialChar menuseparator
13254 \begin_inset space ~
13260 Details on how to create a table float can be found in the files
13268 , included in the corresponding packages.
13271 \begin_layout Subsection
13272 Preparing a paper for submission
13275 \begin_layout Standard
13276 Before you submit your paper you must export the \SpecialChar LyX
13277 document as a \SpecialChar LaTeX
13280 File\SpecialChar menuseparator
13281 Export\SpecialChar menuseparator
13289 \begin_layout Plain Layout
13290 Actually you have the choice between \SpecialChar LaTeX
13291 (plain) and pdflatex.
13292 If you intend to use pdflatex to prepare the paper, you should use the
13293 pdflatex option so that included graphics are converted to PDF format,
13294 ready for use by pdflatex.
13299 , then make the following changes to the resulting
13306 \begin_layout Enumerate
13307 Remove the comment lines before the
13316 \begin_layout Enumerate
13317 Remove everything between (and including) the
13329 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13333 \begin_layout Standard
13338 file should be saved and processed through \SpecialChar LaTeX
13339 as many times as necessary.
13340 You may also want to check the resulting
13347 \begin_layout Subsection
13348 Use of \SpecialChar TeX
13352 \begin_layout Standard
13353 The use of \SpecialChar TeX
13354 code is reduced to two commands, which must be placed at the
13355 top of the document.
13356 If you started writing your paper by using the
13364 template, the \SpecialChar TeX
13365 code needed is already in its place; you usually don't need
13367 You may only modify the first \SpecialChar TeX
13368 code to specify the information printed
13369 to the top of odd and even pages (authors' names and short paper's title,
13371 This \SpecialChar TeX
13372 code must have the form
13376 markboth{Authors' Names}{Short Paper's Title}
13381 \begin_layout Section
13385 \begin_layout Standard
13391 \begin_layout Subsection
13395 \begin_layout Standard
13396 The iopart package provides a document class to create electronic manuscript
13397 submission to the journals published by the Institute of Physics.
13398 Instructions for the authors how to create a paper using the iopart class
13399 can be downloaded together with the iopart package from the site
13400 \begin_inset Flex URL
13403 \begin_layout Plain Layout
13405 ftp://ftp.iop.org/pub/journals/latex2e
13413 \begin_layout Subsection
13417 \begin_layout Standard
13418 The easiest way to write a paper is to start with the file
13422 that is available in \SpecialChar LyX
13423 's examples files folder.
13424 Open this file, save it under a new name, and start writing.
13425 The example file explains how to use the special text environments.
13426 Here are the most important advices:
13429 \begin_layout Itemize
13430 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13433 Use AMS math package
13435 in the document settings under
13442 \begin_layout Itemize
13445 The title environment defines the kind of your paper.
13446 So use one of the following environments for the title:
13450 \begin_layout Itemize
13459 \begin_layout Itemize
13468 \begin_layout Itemize
13474 for a Topical review
13477 \begin_layout Itemize
13486 \begin_layout Itemize
13495 \begin_layout Itemize
13501 for a Paper (same as Title)
13504 \begin_layout Itemize
13510 for a Preliminary communication
13513 \begin_layout Itemize
13519 for a Rapid communication
13522 \begin_layout Itemize
13528 for a Letter to the editor
13532 \begin_layout Itemize
13535 All title environments except of
13539 can have an optional short title.
13542 \begin_layout Itemize
13543 There is a general title environment
13547 which is not directly supported by the \SpecialChar LyX
13549 This can be used as \SpecialChar TeX
13550 code when your document doesn't fit into one of the
13554 \begin_layout Standard
13555 For more informations like hints for special table and formula formatting,
13556 look at the IOP author guidelines.
13559 \begin_layout Section
13563 \begin_layout Standard
13566 Panayotis Papasotiriou
13569 \begin_layout Subsection
13573 \begin_layout Standard
13574 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13575 that facilitates electronic manuscript submission to the journals they
13577 Most known of them (at least in my domain of interest) are
13579 Astrophysics and Space Science
13585 , but there are many others (see a complete list at
13586 \begin_inset Flex URL
13589 \begin_layout Plain Layout
13591 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13597 The Kluwer package may be downloaded from the site
13598 \begin_inset Flex URL
13601 \begin_layout Plain Layout
13603 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13609 A complete user guide is contained in that package (but it can also be
13610 downloaded separately).
13613 \begin_layout Standard
13615 supports many features of the package but not everything.
13616 However, the \SpecialChar TeX
13617 code needed is reduced to some
13618 \begin_inset Quotes eld
13622 \begin_inset Quotes erd
13625 commands of the package (see
13626 \begin_inset space ~
13630 \begin_inset CommandInset ref
13632 reference "subsec:kluwer_peculiarities"
13637 I have recently used \SpecialChar LyX
13638 to write an article submitted to the
13640 Astrophysics and Space Science
13642 without any problem.
13645 \begin_layout Subsection
13649 \begin_layout Standard
13650 The easiest way to write a paper is to start with the Kluwer template file.
13653 File\SpecialChar menuseparator
13665 This will give an (almost) empty document that includes the most common
13666 fields found in a manuscript and a short description of their use.
13667 As in most templates, simply overwrite the existing text (including the
13672 ) with the correct information.
13675 \begin_layout Subsection
13676 Preparing a paper for submission
13679 \begin_layout Standard
13680 As in the AAS\SpecialChar TeX
13681 package, before you submit your paper to a journal you must
13683 \begin_inset Quotes eld
13687 \begin_inset Quotes erd
13693 \begin_layout Enumerate
13694 Export your paper as a \SpecialChar LaTeX
13696 To do this, click on
13698 File\SpecialChar menuseparator
13699 Export\SpecialChar menuseparator
13707 \begin_layout Enumerate
13712 file with a text editor and make the following changes
13716 \begin_layout Enumerate
13717 remove the comment lines before the
13726 \begin_layout Enumerate
13727 remove everything between (and including) the
13739 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13743 \begin_layout Standard
13752 \begin_layout Enumerate
13757 file through \SpecialChar LaTeX
13758 as many times as necessary (usually up to three).
13761 \begin_layout Enumerate
13767 \begin_inset space \thinspace{}
13771 \begin_inset space \space{}
13778 , and check if everything is OK (it should, if you didn't make any mistake).
13781 \begin_layout Subsection
13782 \begin_inset Quotes eld
13786 \begin_inset Quotes erd
13789 of the Kluwer package
13790 \begin_inset CommandInset label
13792 name "subsec:kluwer_peculiarities"
13799 \begin_layout Standard
13800 The Kluwer package has the following
13801 \begin_inset Quotes eld
13805 \begin_inset Quotes erd
13811 \begin_layout Enumerate
13812 It is possible to write multiple articles in the same \SpecialChar LaTeX
13817 \begin_layout Plain Layout
13818 I can't imagine any good reason to do this.
13824 Each article must be included in the environment
13825 \begin_inset Quotes eld
13829 \begin_inset Quotes erd
13833 Unfortunately, this environment cannot be omitted, even if you write just
13835 Therefore, each article starts with the command
13841 and, obviously, ends with the command
13848 Although this can be implemented in \SpecialChar LyX
13849 , I didn't included it, since it looks
13850 ugly and can confuse the novice user.
13851 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13854 \begin_inset Quotes eld
13859 \begin_inset Quotes erd
13865 \begin_layout Enumerate
13866 Information given at the beginning of the article (i.
13867 \begin_inset space \thinspace{}
13871 \begin_inset space \space{}
13874 title, subtitle, author, institution, running title, running author, abstract
13875 and keywords) must be included in an environment called
13876 \begin_inset Quotes eld
13880 \begin_inset Quotes erd
13884 This is not implemented in \SpecialChar LyX
13885 , so you must enter title, subtitle etc.
13886 \begin_inset space ~
13889 between two \SpecialChar TeX
13905 \begin_layout Enumerate
13906 According to the user manual, the label of each bibliography item must be
13930 \begin_layout Standard
13935 template takes care of all these
13936 \begin_inset Quotes eld
13940 \begin_inset Quotes erd
13944 If you start a new paper using this template you don't need to do anything
13949 \begin_layout Enumerate
13950 don't delete the \SpecialChar TeX
13951 code included in the template, and
13954 \begin_layout Enumerate
13955 copy the example bibliography item included in the template and modify it
13956 as necessary to enter new bibliography items.
13959 \begin_layout Section
13963 \begin_layout Standard
13969 \begin_layout Subsection
13973 \begin_layout Standard
13974 The \SpecialChar LyX
13977 article (koma-script)
13981 report (koma-script)
13999 correspond to the \SpecialChar LaTeX
14017 \begin_inset space ~
14020 of the Koma-Script family.
14021 They are replacements for the standard document classes
14037 , resp., and fit better to European typography conventions in a number of
14041 \begin_layout Itemize
14042 Standard character size is 11pt in
14044 article (koma-script)
14048 report (koma-script)
14056 letter (koma-script)
14061 \begin_layout Itemize
14062 Headings, labels of the description environment, and a number of elements
14065 letter (koma-script)
14067 document class are set in a bold sans serif font.
14071 \begin_layout Plain Layout
14072 There is a big difference between the bold sans serif old cm fonts and new
14073 ec fonts, especially in the appearance of headings.
14074 In comparison, the ec bold sans serif fonts look a bit thin.
14075 Here the \SpecialChar LaTeX
14084 helps to produce the
14085 \begin_inset Quotes eld
14089 \begin_inset Quotes erd
14092 appearance when using the ec fonts.
14097 The numbering of chapter headings is made in the same way as the numbering
14098 of section headings, that is without the extra line
14099 \begin_inset Quotes eld
14102 Chapter\SpecialChar ldots
14104 \begin_inset Quotes erd
14108 In addition, the appearance of the headings can be modified by using a
14109 number of options (in \SpecialChar LyX
14110 to be entered in the field
14113 \begin_inset space ~
14120 Layout\SpecialChar menuseparator
14127 \begin_layout Itemize
14128 The main means in the Koma-Script document classes to design the type area
14137 (in \SpecialChar LyX
14138 to be entered in the extra class options field in the dialog
14140 Document\SpecialChar menuseparator
14144 They make a clearer modification of page margins possible as do the options
14147 Document\SpecialChar menuseparator
14154 \begin_layout Itemize
14155 The \SpecialChar LaTeX
14156 document classes of the Koma-Script family define a number of additional
14158 Those part of it which makes sense in \SpecialChar LyX
14159 is implemented in corresponding
14163 \begin_layout Standard
14164 Detailed descriptions of the \SpecialChar LaTeX
14165 document classes of the Koma-Script family
14166 can be found in the Koma-Script documentation
14177 \begin_layout Subsection
14178 article (koma-script), report (koma-script), and book (koma-script)
14181 \begin_layout Standard
14182 The document classes
14184 article (koma-script)
14188 report (koma-script)
14198 are implemented in the layout files
14211 They contain all the paragraph types of the corresponding standard document
14224 , resp., partly modified, with the exception of the \SpecialChar LyX
14229 -type, which is replaced by the new
14233 -type having the same functionality.
14238 -Type there is a number of new paragraph types added.
14245 letter (koma-script)
14250 \begin_layout Itemize
14259 : are equivalents to
14267 , resp., additionally inserting an entry in the table of contents.
14276 are not contained in
14278 article (koma-script)
14283 \begin_layout Itemize
14292 : behave exactly as
14300 , resp., additionally clearing running heads.
14305 is not contained in
14307 article (koma-script)
14313 \begin_layout Plain Layout
14326 report (koma-script)
14328 , but since this is identical to
14332 , is has not been implemented in \SpecialChar LyX
14341 \begin_layout Itemize
14346 : generates a heading directly above the following paragraph in the standard
14347 character size without affecting the structure of the document.
14350 \begin_layout Itemize
14359 are special captions which respect the different space settings needed
14360 for captions placed above or below an element (if you follow strict typographic
14361 rules, you might want to place table captions always above the table).
14362 You can also use the class option
14366 , which will switch
14379 You need at least Koma-Script version 2.8q to use this.
14382 \begin_layout Itemize
14387 : can be used to set a bonmot, e.
14388 \begin_inset space \thinspace{}
14392 \begin_inset space \space{}
14395 at the beginning of a chapter.
14396 If you use the optional argument (
14398 Insert\SpecialChar menuseparator
14400 \begin_inset space ~
14405 ), you can insert the dictum's author there.
14406 Dictum and author are separated by a line.
14407 You need at least Koma-Script version 2.8q to use this.
14412 is not contained in
14414 article (koma-script)
14419 \begin_layout Standard
14420 The following types, together with the standard types
14432 , form the title area of the document.
14433 They must be entered ahead of the first
14434 \begin_inset Quotes eld
14438 \begin_inset Quotes erd
14445 \begin_layout Plain Layout
14446 The corresponding \SpecialChar LaTeX
14447 commands must appear before the
14458 When such a type is used more than once, the latter usage overwrites the
14459 former one, that means, for every type only the latest usage is valid.
14460 The order of the different types however has, like
14472 , no effect on the appearance of the produced document.
14475 \begin_layout Itemize
14480 : produces a centered paragraph above the ordinary title (
14492 ) for the subject of the document.
14495 \begin_layout Itemize
14500 : produces a centered paragraph below the ordinary title (
14512 ) for the publishers' name.
14515 \begin_layout Itemize
14522 report (koma-script)
14528 produces a centered paragraph on its own page behind the title page, or
14531 article (koma-script)
14533 produces a centered paragraph below the ordinary title (
14549 ) for a dedication.
14552 \begin_layout Itemize
14557 : produces a left aligned paragraph above the ordinary title (
14573 ) for a document`s head.
14576 \begin_layout Itemize
14581 : produces in a double-sided print in
14583 report (koma-script)
14589 a left-aligned paragraph at the top of the title page`s back or has no
14590 effect in a single-sided print or in
14592 article (koma-script)
14597 \begin_layout Itemize
14602 : produces in a double-sided print in
14604 report (koma-script)
14610 a left-aligned paragraph at the bottom of the title page`s back or has
14611 no effect in a single-sided print or in
14613 article (koma-script)
14618 \begin_layout Itemize
14623 : produces a special
14624 \begin_inset Quotes eld
14628 \begin_inset Quotes erd
14631 page ahead of the actual document containing a paragraph without special
14635 \begin_layout Standard
14636 The layout files for the document classes
14638 article (koma-script)
14642 report (koma-script)
14648 do include the file
14653 This is thought of as a place to define your own types.
14658 in your personal layout directory and edit the file!
14661 \begin_layout Subsection
14662 letter (koma-script)
14665 \begin_layout Standard
14669 letter (koma-script)
14671 is implemented in the layout file
14676 It contains all the paragraph types of the corresponding standard document
14681 , partly modified, with the exception of the \SpecialChar LyX
14695 type, which is replaced by the new
14700 In addition, it contains, in contrast to the standard document class, the
14719 Furthermore, there are a number of new letter specific types.
14722 \begin_layout Standard
14723 The appearance of the letter produced by this document class can be controlled
14724 by a number of \SpecialChar LaTeX
14725 commands, which you can put in the \SpecialChar LaTeX
14730 \begin_layout Plain Layout
14731 For example, the standard appearance of the letter`s heading, consisting
14732 of name and address, is quite self-willed.
14734 \begin_inset Quotes eld
14738 \begin_inset Quotes erd
14741 heading is produced by the following \SpecialChar LaTeX
14742 commands in the preamble:
14745 \begin_layout LyX-Code
14755 \begin_layout LyX-Code
14771 \begin_layout LyX-Code
14781 \begin_layout LyX-Code
14801 A detailed German description of such \SpecialChar LaTeX
14802 commands can be found in the Koma-Script
14808 With it, the letter's author can produce his personal letter layout.
14811 \begin_layout Standard
14820 define the beginning of the letter and must be used in every letter.
14821 To emphasize them in the \SpecialChar LyX
14822 document class, they are marked with the letter
14832 \begin_inset space ~
14835 in the left margin.
14836 It is possible to write any number of letters in one file.
14841 type produces a new letter using the same addressee and a
14845 type produces a new addressee.
14862 are ordinary paragraph types and can also be used several times in one
14863 and the same letter.
14866 \begin_layout Itemize
14871 : produces a paragraph for the addressee and implicitly defines the beginning
14875 \begin_layout Itemize
14880 : produces a paragraph for the form of address and implicitly produces a
14884 \begin_layout Itemize
14889 : produces a paragraph for a close.
14892 \begin_layout Itemize
14897 : produces a paragraph for a postscript.
14900 \begin_layout Itemize
14905 : produces a paragraph for a distribution list.
14908 \begin_layout Itemize
14913 : produces a paragraph for enclosures.
14916 \begin_layout Standard
14957 are input types provided with a label to enter information, which will
14958 be processed by the document class.
14962 \begin_layout Plain Layout
14963 It could be seen as a matter of inconsequence, that the types
14971 described above are not such input types as well.
14972 Because of the special meaning of those types, however, I have implemented
14973 them as ordinary paragraph types with a one letter mark in the left margin.
14974 Moreover, it would affect my feeling of symmetry, if the
14982 type had such a serious different appearance.
14987 The types must be used ahead of the corresponding
14994 \begin_layout Standard
14995 An implementation of these types in a WYSIWYG fashion does not seem to make
14996 sense, because the real appearance of the produced letter does not only
14997 depend on the usage of the particular type, but also on other factors.
14998 For example, a signature entered in the
15002 type will in the standard behavior appear in the produced letter only,
15003 when in the same letter also a
15008 The entered value of the
15012 type will in the standard behavior not appear in the produced letter at
15014 The possibility to design the letter`s heading freely is already indicated
15015 in a footnote above.
15018 \begin_layout Standard
15019 The input types can also be used as empty paragraphs.
15020 This makes sense e.
15021 \begin_inset space \thinspace{}
15025 \begin_inset space \space{}
15037 type is not used at all, in the standard behavior the value of the
15041 type is used as signature, whereas if an empty
15045 type is used, no signature value is defined.
15048 \begin_layout Standard
15049 By using the input types it is possible to write a letter template, containing
15050 filled input types with your personal dates (name, address, etc.) and empty
15051 input types for other dates you want to enter.
15054 \begin_layout Itemize
15059 : sender's name, in the standard behavior appears as a centered paragraph
15060 in small caps in the letter`s heading.
15063 \begin_layout Itemize
15068 : sender's signature, in the standard behavior appears below the
15077 type is used, the value of the
15081 type appears instead.
15084 \begin_layout Itemize
15089 : sender's address, in the standard behavior appears in a centered paragraph
15090 in the letter`s heading below the sender's name.
15093 \begin_layout Itemize
15098 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15109 \begin_layout Itemize
15114 : place of the letter`s making.
15117 \begin_layout Itemize
15122 : date of the letter`s making.
15131 , in the standard behavior, produce the place and the date in a right-aligned
15132 line below the addressee's field.
15137 type is used, neither place nor date appear, independent of the value of
15147 type is used, the date of the letter `s production is used.
15150 \begin_layout Itemize
15155 : sender`s back address, in the standard behavior appears above the addressee's
15156 field in a small sans serif font.
15159 \begin_layout Itemize
15164 : special mail information, in the standard behavior appears underlined
15165 above the addressee's field below the back address.
15168 \begin_layout Itemize
15173 : additional information, in the standard behavior appears on right side
15174 below the addressee`s field.
15177 \begin_layout Itemize
15182 : the letter's title, in the standard behavior appears in a big, bold, sans
15183 serif font above the subject.
15186 \begin_layout Itemize
15191 : the letter's subject, in the standard behavior appears in a bold font
15199 \begin_layout Standard
15220 produce a business letter like line above the
15224 line containing the fields
15225 \begin_inset Quotes eld
15229 \begin_inset Quotes erd
15233 \begin_inset Quotes eld
15237 \begin_inset Quotes erd
15241 \begin_inset Quotes eld
15245 \begin_inset Quotes erd
15249 \begin_inset Quotes eld
15253 \begin_inset Quotes erd
15257 \begin_inset Quotes eld
15261 \begin_inset Quotes erd
15265 \begin_inset Quotes eld
15269 \begin_inset Quotes erd
15273 For the date field, the value of the
15279 \begin_inset Quotes eld
15282 business letter types
15283 \begin_inset Quotes erd
15286 is used, the value of the
15290 type however does not appear, but only the \SpecialChar LaTeX
15298 The ordinary output of place and date in a right-aligned line below the
15299 addressee`s field is suppressed.
15300 The types are implemented as input types provided with a label and must
15301 be used ahead of the corresponding
15308 \begin_layout Itemize
15316 \begin_layout Itemize
15324 \begin_layout Itemize
15332 \begin_layout Itemize
15340 \begin_layout Itemize
15348 \begin_layout Subsection
15349 The new letter class: letter (koma-script v.2)
15352 \begin_layout Standard
15358 \begin_layout Standard
15359 \begin_inset VSpace medskip
15365 \begin_layout Standard
15367 Koma-Script version 2.8 has introduced a new letter class
15371 which supersedes the now unsupported
15376 It has — on the \SpecialChar LaTeX
15377 side — a completely new interface and is not compatible
15378 with the old class.
15379 Therefore, \SpecialChar LyX
15380 supports both, though it is recommended you use the new class.
15383 \begin_layout Standard
15384 This class covers the same functionality as
15386 letter (koma-script),
15389 The basic items are
15393 (receiver's address, same as
15397 in the old layout),
15410 will start a new letter (i.
15411 \begin_inset space \thinspace{}
15415 \begin_inset space \space{}
15418 you can write several letters per document).
15419 New elements are sender's
15435 and the possibility to use a
15441 Insert\SpecialChar menuseparator
15447 \begin_layout Standard
15448 The biggest improvement is, though, that the letter's layout is configurable
15449 to meet almost any needs.
15450 This can be done via the preamble or with a special style file (Letter
15451 Class Option, extension
15455 ), that will be read in as a class option.
15459 \begin_layout Plain Layout
15460 The KOMA package comes with some default
15465 There is, for instance, a
15469 file that follows german typesetting rules, or a
15473 that provides the default layout of the old
15478 The latter can be loaded with the class option
15484 Layout\SpecialChar menuseparator
15485 Document\SpecialChar menuseparator
15497 template that is included in \SpecialChar LyX
15499 A detailed description is to be found in the Koma-Script documentation
15507 \begin_layout Subsection
15511 \begin_layout Standard
15512 Visualizing the Koma-Script document classes in \SpecialChar LyX
15513 , the \SpecialChar LyX
15514 internals cause some
15518 \begin_layout Itemize
15519 The chapter number of a
15523 type appears on a line of its own above the chapter heading instead of
15524 appearing in the same line ahead of it.
15525 The cause for that is the \SpecialChar LyX
15526 internal behavior for the labeltype
15530 in the layout file.
15533 \begin_layout Itemize
15534 The headings of the types
15542 are only put in the
15543 \begin_inset Quotes eld
15547 \begin_inset Quotes erd
15551 table of contents, but not in the \SpecialChar LyX
15552 table of contents (
15554 Document\SpecialChar menuseparator
15556 \begin_inset space ~
15560 \begin_inset space ~
15568 \begin_layout Itemize
15569 The paragraphs in a
15573 document class appear in a skip separation mode, not indented.
15574 This is the standard behavior, no special \SpecialChar LaTeX
15575 commands are needed for that.
15578 Document\SpecialChar menuseparator
15581 dialog the corresponding radio button indicates
15590 value always has the effect that extra \SpecialChar LaTeX
15591 commands are inserted in the document
15592 to produce the gap, which is not what is wanted in this case.
15595 \begin_layout Section
15599 \begin_layout Standard
15605 \begin_layout Subsection
15609 \begin_layout Standard
15610 Memoir is a very powerful and constantly evolving class.
15611 It has been designed with regard to fictional and non-fictional literature.
15612 Its aim is to let the user have maximum control over the typesetting of
15614 Memoir is based on the standard book class, but it can also emulate the
15615 article class (see below).
15618 \begin_layout Standard
15619 Peter Wilson, the developer of Memoir, is known as the author of lots of
15620 useful packages in the \SpecialChar LaTeX
15622 Most of them have been merged with Memoir.
15623 Therefore, it is much easier to layout the table of contents, appendices,
15624 chapter designs and such.
15626 , though, does not support all of these goodies natively.
15627 Some of them might be added to forthcoming releases
15631 \begin_layout Plain Layout
15632 You are invited to send suggestions to
15633 \begin_inset Flex URL
15636 \begin_layout Plain Layout
15638 lyx-devel@lists.lyx.org
15648 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15650 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15652 commands (\SpecialChar TeX
15657 \begin_layout Plain Layout
15662 \begin_layout Plain Layout
15672 \begin_inset space ~
15676 \begin_inset CommandInset ref
15678 reference "sec:Inserting-TeX-Code"
15688 In this section, we can only list those features that are natively supported
15689 by \SpecialChar LyX
15691 For detailed descriptions (and for the rest of features) we recommend you
15692 have a look at the detailed manual of the Memoir class
15696 \begin_layout Plain Layout
15701 \begin_layout Plain Layout
15711 \begin_inset Flex URL
15714 \begin_layout Plain Layout
15716 CTAN:/macros/latex/memoir/memman.pdf
15726 , which is not only a user guide for the class, but also both a comprehensive
15727 description on good typesetting and a superb example for good typesetting
15731 \begin_layout Subsection
15732 Basic features and restrictions
15735 \begin_layout Standard
15736 Memoir supports basically all features of the standard book classes.
15737 There are, however, some differences, as follows:
15740 \begin_layout Description
15742 \begin_inset space ~
15745 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15748 \begin_layout Description
15750 \begin_inset space ~
15753 style: The fancy page style is not supported, due to a command clash between
15754 Memoir and the fancyhdr package (they both define a command with the same
15755 name, which confuses \SpecialChar LaTeX
15757 Instead, Memoir comes with a number of its own page styles (see
15759 Layout\SpecialChar menuseparator
15760 Document\SpecialChar menuseparator
15762 \begin_inset space ~
15768 If you want to use these for the chapter pages, you have to use the command
15775 in the main text or in preamble (e.
15776 \begin_inset space \thinspace{}
15780 \begin_inset space \space{}
15787 chapterstyle{companion}
15792 \begin_layout Description
15793 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15794 optional argument in the standard classes.
15795 With this, you can specify an alternative version of the title for the
15796 table of contents and the headers (for instance, if the title is too long).
15797 In \SpecialChar LyX
15798 , you can do this via
15800 Insert\SpecialChar menuseparator
15802 \begin_inset space ~
15807 at the beginning of a chapter/section.
15808 Memoir features a second optional argument and thus separates the table
15809 of contents from the header.
15810 You can define three variants of a title with this: one for the main text,
15811 one for the table of contents, and one for the headers.
15812 Simply insert two optional arguments if you need this feature, the first
15813 one containing the short title for the Table of Contents, the second one
15814 containing an alternative short title for the headers.
15817 \begin_layout Description
15818 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15819 of contents, the list of figures and the list of table start a new page
15821 Memoir does not follow this route.
15822 You have to insert a page break yourself, if you want to have one.
15825 \begin_layout Description
15826 Titlepage: For some unknown reason, Memoir uses pagination on the title
15827 page (in the standard classes, title pages are
15828 \begin_inset Quotes eld
15832 \begin_inset Quotes erd
15836 If you want an empty title page, type
15840 aliaspagestyle{title}{empty}
15845 \begin_layout Description
15846 Article: With the class option
15852 Layout\SpecialChar menuseparator
15853 Document\SpecialChar menuseparator
15855 \begin_inset space ~
15860 ), you can emulate article style.
15861 That is, counters (footnotes, figures, tables etc.) will not be reset on
15862 new chapters, chapters don't start a new page (but are—in contrary to
15863 \begin_inset Quotes eld
15867 \begin_inset Quotes erd
15870 article classes—still allowed), parts, though, use their own page, as in
15874 \begin_layout Description
15875 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15876 font commands, which have been used in the old \SpecialChar LaTeX
15878 \begin_inset space \thinspace{}
15882 \begin_inset space \space{}
15898 It produces an error and stops \SpecialChar LaTeX
15899 whenever such a command appears.
15904 reallows the commands and spits out warnings instead (which does at least
15905 not stop \SpecialChar LaTeX
15907 Since a lot of packages and particularly Bib\SpecialChar TeX
15908 style files are still using
15909 those commands, we have decided to use this option by default.
15912 \begin_layout Subsection
15916 \begin_layout Standard
15917 We will only describe the features supported by \SpecialChar LyX
15918 (which is not much currently).
15919 Please consult the Memoir manual
15923 \begin_layout Plain Layout
15928 \begin_layout Plain Layout
15938 \begin_inset Flex URL
15941 \begin_layout Plain Layout
15943 CTAN:/macros/latex/memoir/memman.pdf
15956 \begin_layout Description
15957 Abstract: You may wonder why an abstract is an extra feature.
15958 Well, it is in book class.
15959 Usually books don't have abstracts.
15960 Memoir, however, has.
15961 You can use it wherever and how often you like.
15964 \begin_layout Description
15965 Chapterprecis: You may know this older typesetting style: The contents of
15966 a chapter are summarized below the title and also in the table of contents
15968 \begin_inset space \thinspace{}
15972 \begin_inset space \space{}
15977 Our hero arrives in Troia; he loses some friends; he finds others
15980 Chapterprecis does exactly this.
15981 It is therefore only sensible below a chapter.
15984 \begin_layout Description
15985 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15986 The epigraph environment provides an elegant way of typesetting such a
15988 The motto itself (text) and its author (source) are divided by a short
15990 Unfortunately, we have to fool \SpecialChar LyX
15991 a bit here again, since the environment
15992 needs two arguments (text and source).
15993 In this case, we have to use curly brackets (in \SpecialChar TeX
15994 mode) between the two
16005 <author of the slogan>.
16008 \begin_layout Description
16009 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16010 complex figurative poems).
16012 can only support a few of them.
16013 One is poemtitle, which is a centered title for poems, which will also
16014 be added to the table of contents (verse is the standard environment for
16016 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16018 because they have to be nested inside regular verse environments, which
16019 is not possible with \SpecialChar LyX
16023 \begin_layout Description
16024 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16027 \begin_layout Section
16028 Article (mwart), book (mwbk) and report (mwrep)
16029 \begin_inset Argument status
16032 \begin_layout Plain Layout
16045 \begin_layout Standard
16051 \begin_layout Standard
16052 The \SpecialChar LyX
16069 correspond to the \SpecialChar LaTeX
16083 They are replacements for the standard document classes
16095 , resp., and fit better to Polish typography conventions in a number of points.
16099 \begin_layout Standard
16103 \begin_layout Itemize
16104 Unnumbered titles (with star, e.
16105 \begin_inset space \thinspace{}
16109 \begin_inset space \space{}
16116 ) are added into table of contents,
16119 \begin_layout Itemize
16120 Additional page styles:
16124 \begin_layout Description
16125 uheadings header with separated lines,
16128 \begin_layout Description
16129 myheadings custom header, contents headers via commands:
16144 \begin_layout Description
16145 myuheadings custom header with separated lines,
16148 \begin_layout Description
16149 outer page number is placed on outer side of page
16153 \begin_layout Itemize
16158 \begin_layout Description
16159 rmheadings serif titles — default,
16162 \begin_layout Description
16163 sfheadings sansserif titles,
16166 \begin_layout Description
16167 authortitle on title page first placed is author next title — default,
16170 \begin_layout Description
16171 titleauthor on title page first placed is title next author,
16174 \begin_layout Description
16175 withmarginpar reserve place on page for margins.
16179 \begin_layout Section
16183 \begin_layout Standard
16188 provides an alternative to the standard
16193 It provides similar functionality, but you might prefer this layout with
16194 sans serif sections, headings, and more.
16197 \begin_layout Section
16198 Rev\SpecialChar TeX
16202 \begin_layout Standard
16208 \begin_layout Standard
16209 \begin_inset VSpace bigskip
16215 \begin_layout Standard
16220 \begin_inset space ~
16225 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16227 \begin_inset Formula $\beta$
16230 release of May, 1999) class.
16233 \begin_layout Standard
16239 textclass, which works with Rev\SpecialChar TeX
16241 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16243 That means that it doesn't interact very well with \SpecialChar LyX
16244 , which requires \SpecialChar LaTeX2e
16246 it has been kludged to work.
16247 Since Rev\SpecialChar TeX
16248 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16253 Rev\SpecialChar TeX
16255 \begin_inset space ~
16260 textclass should also be pretty easy to use.
16263 \begin_layout Standard
16264 These documents are supposed to be used in
16268 to the Rev\SpecialChar TeX
16269 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16271 and assume you'll know what to put in the preamble if necessary.
16274 \begin_layout Subsection
16278 \begin_layout Standard
16279 All you need to do is install Rev\SpecialChar TeX
16280 4, as described in the package's README
16282 The package can be found at The Rev\SpecialChar TeX
16284 \begin_inset Flex URL
16287 \begin_layout Plain Layout
16289 http://publish.aps.org/revtex4/
16295 Install it somewhere that \SpecialChar LaTeX
16297 Test it by trying to \SpecialChar LaTeX
16298 a short Rev\SpecialChar TeX
16299 4 document in some random directory (i.
16300 \begin_inset space \thinspace{}
16304 \begin_inset space \space{}
16307 not the directory where you installed the class file.) Then, if you reconfigure
16309 , it will find the class file and let you use the Rev\SpecialChar TeX
16313 \begin_layout Standard
16314 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16323 \begin_inset space ~
16328 template, found in the templates directory.
16331 \begin_layout Subsection
16335 \begin_layout Standard
16336 Optional arguments to
16343 \begin_inset Quotes eld
16347 \begin_inset Quotes erd
16351 \begin_inset Quotes eld
16355 \begin_inset Quotes erd
16361 \begin_inset space ~
16369 \begin_inset space ~
16375 Remember that in Rev\SpecialChar TeX
16376 , at least one optional argument is required!
16379 \begin_layout Standard
16380 Other preamble matter, like
16387 \begin_inset space ~
16394 \begin_inset space ~
16399 dialog, also as usual.
16402 \begin_layout Subsection
16406 \begin_layout Standard
16407 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16409 For example, the Email layout corresponds to
16416 Note that (at least as of Rev\SpecialChar TeX
16425 layouts are exactly equivalent, so you shouldn't need to use both.
16429 \begin_layout Plain Layout
16430 In case you're curious, both were included so that
16434 would be able to translate both
16454 \begin_layout Subsection
16458 \begin_layout Standard
16459 There are a couple of important unique aspects of Rev\SpecialChar TeX
16460 4 which might cause
16461 bugs that will be even more confusing in \SpecialChar LyX
16465 \begin_layout Standard
16466 In Rev\SpecialChar TeX
16484 The \SpecialChar LyX
16485 equivalent is that there is a separate Thanks layout.
16490 write footnotes in the
16494 layout, or weird things may happen.
16495 See the Rev\SpecialChar TeX
16496 4 documentation for more details.
16499 \begin_layout Standard
16503 \begin_inset space ~
16511 \begin_inset space ~
16520 layouts must be placed
16528 layout and the corresponding
16545 , the \SpecialChar LaTeX
16549 \begin_layout Subsection
16553 \begin_layout Standard
16554 The main problem with this layout is that you can't use the optional arguments
16555 to layouts like Email and Title.
16556 (The problem is not unique to this layout; you can't use optional arguments
16557 to the Section layouts either.) This means that after you export that file
16558 to \SpecialChar LaTeX
16559 (which you'll need to do eventually to send it in to APS), you'll need
16560 to edit the \SpecialChar LaTeX
16561 file with a text editor to add the optional arguments to set,
16563 \begin_inset space \thinspace{}
16567 \begin_inset space \space{}
16570 the running title for the page headers.
16571 Lacking these layouts makes the
16577 (and the equivalent
16583 ) useless, so the corresponding layouts don't exist, and will have to be
16588 \begin_layout Plain Layout
16593 actually, \SpecialChar LyX
16594 1.3.0 supports some forms of optional arguments, but this layout
16595 has not been updated yet to take advantage of it.
16603 \begin_layout Section
16604 Springer Journals (
16611 \begin_layout Standard
16617 \begin_layout Subsection
16621 \begin_layout Standard
16622 These are the layout files for some of the journal formats used by Springer
16623 Verlag and listed on
16624 \begin_inset Flex URL
16627 \begin_layout Plain Layout
16629 http://www.springer.de/author/tex/help-journals.html
16634 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16636 It is a modular system: the things common to all journals are implemented
16641 , which journal-specific layout files (such as, e.
16642 \begin_inset space \thinspace{}
16646 \begin_inset space \space{}
16653 for Journal of Geodesy) can include.
16656 \begin_layout Standard
16657 This means that implementing support for any other Springer journal on this
16658 list is as simple as writing your own
16666 file following the outline given in
16674 \begin_layout Standard
16675 It is reasonably well tested only for the Journal of Geodesy.
16684 come with the standard \SpecialChar LyX
16686 Install the relevant class file (downloaded from Springer) in a proper
16687 directory, reconfigure \SpecialChar LaTeX
16688 (in the te\SpecialChar TeX
16693 , as root if necessary — doesn't \SpecialChar LyX
16694 take care of this?), reconfigure \SpecialChar LyX
16699 \begin_layout Subsection
16703 \begin_layout Standard
16704 A large number of theorem-like styles —
16716 \begin_layout Standard
16719 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16720 _Title, Author_Running, Institute,
16721 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16724 See the Springer class file documentation for details.
16727 \begin_layout Subsection
16731 \begin_layout Itemize
16743 \begin_layout Itemize
16746 Probability Theory and Related Fields
16752 — Jean-Marc Lasgouttes
16755 \begin_layout Standard
16756 Add your own, it isn't so hard!
16759 \begin_layout Subsection
16763 \begin_layout Standard
16764 These files are partly based on the older
16768 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16770 file from Springer.
16775 layout, are now defunct.
16776 Jean-Marc Lasgouttes helped out big in making me find my way around the
16778 layout file mechanism.
16781 \begin_layout Subsection
16785 \begin_layout Standard
16787 But probably less than in the old hacked-\SpecialChar LaTeX
16795 \begin_layout Standard
16797 \begin_inset space \thinspace{}
16800 g.: does not display the number for theorem-like layouts, just #.
16803 \begin_layout Section
16806 Sli\SpecialChar TeX
16810 \begin_inset CommandInset label
16819 \begin_layout Standard
16827 \begin_layout Subsection
16831 \begin_layout Standard
16832 This section describes how to use \SpecialChar LyX
16833 to make slides for overhead projectors.
16834 There are two document classes that can do this: the default slides class
16837 Foil\SpecialChar TeX
16841 This section documents the former.
16844 \begin_layout Standard
16845 I'm going to say this again, nice and clear, so that there's no misunderstanding
16849 \begin_layout Standard
16850 \begin_inset VSpace bigskip
16856 \begin_layout Standard
16860 This section documents the class
16861 \begin_inset Quotes eld
16869 \begin_inset Quotes erd
16877 \begin_layout Standard
16878 \begin_inset VSpace bigskip
16884 \begin_layout Standard
16885 If you're looking for the documentation for
16886 \begin_inset Quotes eld
16891 slides (Foil\SpecialChar TeX
16895 \begin_inset Quotes erd
16898 , check out section
16899 \begin_inset space ~
16903 \begin_inset CommandInset ref
16905 reference "sec:foiltex"
16915 \begin_inset Quotes eld
16920 slides (Foil\SpecialChar TeX
16924 \begin_inset Quotes erd
16927 ] is actually somewhat better than the default
16935 \begin_layout Plain Layout
16937 or so I've been told repeatedly by its advocates.
16938 Having never used it, I have no idea if this claim is true or not.
16943 which this section documents.
16946 \begin_layout Standard
16947 This class is the \SpecialChar LaTeX2e
16948 improvement of the old
16950 Sli\SpecialChar TeX
16954 Every \SpecialChar LaTeX2e
16955 distribution includes this class [which I'll just refer to as
16956 \begin_inset Quotes eld
16964 \begin_inset Quotes erd
16967 from now on], so you're bound to have it.
16968 As I noted earlier, there are other classes, such as
16972 , which also produce slides for overhead projectors and do a better job
16974 However, there are some things which
16978 can do which the others can't, such as generate overlays.
16979 Read on to learn more!
16982 \begin_layout Subsection
16984 \begin_inset CommandInset label
16986 name "sec:slidesetup"
16993 \begin_layout Standard
16994 Obviously, to use this document class, you need to select
16995 \begin_inset Quotes eld
17003 \begin_inset Quotes erd
17006 from the class list in the
17008 Document\SpecialChar menuseparator
17012 There are some other special things you should know about this class:
17015 \begin_layout Itemize
17016 Don't bother changing the options
17021 They're not supported by the
17028 \begin_layout Itemize
17032 \begin_inset space ~
17037 behaves a bit differently for this class.
17038 The possible choices and what they do are as follows:
17042 \begin_layout Description
17047 The final output contains page numbers in the lower right corner.
17050 \begin_layout Description
17059 , but also prints out any time markers you've put in.
17060 This is the default.
17063 \begin_layout Description
17068 The final output contains no page numbers, time markers, or alignment markers.
17072 \begin_layout Itemize
17077 class has an extra option:
17083 \begin_inset Quotes eld
17091 \begin_inset Quotes erd
17094 in the extra class options.
17098 \begin_layout Standard
17099 Using this options allows you to add time markers to
17105 \begin_inset space ~
17109 \begin_inset CommandInset ref
17111 reference "sec:slideNote"
17119 \begin_layout Standard
17120 You can also use the template file
17121 \begin_inset Quotes eld
17129 \begin_inset Quotes erd
17132 to automatically set up a document to use the
17138 File\SpecialChar menuseparator
17140 \begin_inset space ~
17144 \begin_inset space ~
17149 to open your new document].
17150 The template file also contains some examples of the special paragraph
17151 environments used by this class.
17152 I'll describe those next.
17155 \begin_layout Subsection
17156 Paragraph Environments
17159 \begin_layout Subsubsection
17160 Supported Environments
17163 \begin_layout Standard
17164 The first thing you'll notice when you start up a new
17168 document is the font size and type: it's the equivalent of the size
17169 \begin_inset Quotes eld
17177 \begin_inset Quotes erd
17183 \begin_inset space ~
17189 This is also what's used in the output.
17191 \begin_inset Quotes eld
17195 \begin_inset Quotes erd
17198 to remind you that this is a slide.
17199 Your final slides will use a larger font; ergo, you'll have less space.
17200 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17203 \begin_layout Standard
17204 The next thing that becomes obvious is the changes to the paragraph environment
17205 pull-down box [at the far-left end of the toolbar].
17206 Most of the paragraph environments you're used to seeing are missing.
17207 There are also five new ones.
17212 class itself only supports certain paragraph environments:
17215 \begin_layout Itemize
17221 \begin_layout Itemize
17227 \begin_layout Itemize
17233 \begin_layout Itemize
17239 \begin_layout Itemize
17245 \begin_layout Itemize
17251 \begin_layout Itemize
17257 \begin_layout Itemize
17263 \begin_layout Itemize
17269 \begin_layout Itemize
17276 \begin_layout Itemize
17282 \begin_layout Standard
17283 All of the other standard environments, including the section-heading environmen
17284 ts, aren't used in the
17291 \begin_layout Standard
17292 On the other hand, you'll notice the following new environments:
17295 \begin_layout Itemize
17301 \begin_layout Itemize
17307 \begin_layout Itemize
17313 \begin_layout Itemize
17319 \begin_layout Itemize
17325 \begin_layout Standard
17326 These five are kind of quirky, due to a
17327 \begin_inset Quotes eld
17331 \begin_inset Quotes erd
17334 in \SpecialChar LyX
17336 You see, \SpecialChar LyX
17337 doesn't permit you to nest any other paragraph environment into
17338 an empty environment.
17339 Now, that's fine and dandy, but it means that you wouldn't be able to start
17340 a slide with anything except plain text.
17341 To deal with this, I've performed a little
17342 \begin_inset Quotes eld
17347 \begin_inset Quotes erd
17353 \begin_layout Subsubsection
17354 Quirks of the New Environments
17355 \begin_inset CommandInset label
17357 name "sec:slideQuirk"
17364 \begin_layout Standard
17365 All five of the new paragraph environments are somewhat quirky due to inherent
17366 limitiations in the current version of \SpecialChar LyX
17368 As I just mentioned, \SpecialChar LyX
17369 forbids environments that begin with another environment.
17370 To get around this, the
17374 environment isn't a paragraph environment as described in the
17382 \begin_layout Standard
17383 You should consider
17396 \begin_inset Quotes eld
17399 pseudo-environments.
17400 \begin_inset Quotes erd
17403 They look like a section heading or a
17404 \begin_inset Quotes eld
17412 \begin_inset Quotes erd
17415 but really begin a [and, if necessary, end the previous] paragraph environment.
17425 \begin_inset Quotes eld
17429 \begin_inset Quotes erd
17432 These two perform some action.
17435 \begin_layout Standard
17436 A common feature of all five environments,
17456 , is a rather long-ish label.
17457 The text following this label — ordinarily the contents of the paragraph
17458 environment — is utterly irrelevant for
17480 completely ignores it.
17481 In fact, you can leave these five environments completely empty.
17485 \begin_layout Standard
17490 to put any text after the rather long-ish label, you might want to.
17491 This could be a short description of the contents of the
17496 In that case, enter your descriptive comment and hit
17500 as you normally would.
17503 \begin_layout Standard
17504 If, on the other hand, you don't want to enter any descriptive text, you'll
17505 hit another \SpecialChar LyX
17508 , like nature, abhors a vacuum, and will not let you start a new paragraph
17509 environment until you put something in the old one.
17513 \begin_layout Itemize
17514 Start entering the text that will
17542 \begin_layout Itemize
17543 Now move to the beginning of that paragraph.
17547 \begin_layout Itemize
17556 \begin_layout Itemize
17557 Finally, change this new, empty paragraph to a
17581 \begin_layout Standard
17582 Some future version of \SpecialChar LyX
17583 will, hopefully, resolve this quirkiness\SpecialChar ldots
17587 \begin_layout Subsection
17588 Making a Presentation with
17601 \begin_layout Subsubsection
17609 \begin_layout Standard
17610 If you're expecting this section to teach you how to actually make a presentatio
17611 n, you'll be sorely disappointed.
17612 Naturally, I'll describe all of the ways the
17616 class can assist you in preparing the materials for a presentation.
17617 Filling in the contents, however, is up to you.
17622 the \SpecialChar LyX
17626 \begin_layout Standard
17631 environment [in the manner described in section
17632 \begin_inset space ~
17636 \begin_inset CommandInset ref
17638 reference "sec:slideQuirk"
17642 ] tells \SpecialChar LyX
17643 to begin a new slide [duh].
17644 The label for this environment/
17645 \begin_inset Quotes erd
17649 \begin_inset Quotes erd
17653 \begin_inset Quotes eld
17657 \begin_inset Quotes erd
17660 in cool blue, followed by the label,
17661 \begin_inset Quotes eld
17665 \begin_inset Quotes erd
17669 Any text or paragraph environments that follow this one go on the new slide.
17673 \begin_layout Standard
17674 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17676 (this can be specified in the
17681 In fact, you'll want to, once you finish entering the contents of one slide.
17682 If you've entered more text than can physically fit on a slide, the extra
17683 overflows onto a new slide.
17684 I don't recommend doing this, however, since the overflow slide won't have
17685 any page number on it.
17686 Furthermore, it may interfere with any
17690 you've made to accompany the oversized
17697 \begin_layout Standard
17706 environments work the same way as the
17711 They both create an
17712 \begin_inset Quotes eld
17716 \begin_inset Quotes erd
17719 followed by a label [
17720 \begin_inset Quotes eld
17724 \begin_inset Quotes erd
17728 \begin_inset Quotes eld
17732 \begin_inset Quotes erd
17736 The color is a stunning magenta instead of blue, and the
17737 \begin_inset Quotes eld
17741 \begin_inset Quotes erd
17744 will look different, in style and in length.
17745 The label fonts of all three also differ from one another.
17748 \begin_layout Standard
17753 , if the contents of a
17761 exceed the physical size of a slide or sheet of paper, the extra will overflow
17763 Again, you should avoid this.
17764 It defeats the whole purpose of
17775 \begin_layout Subsubsection
17785 \begin_layout Standard
17790 is a slide that sits atop another slide.
17791 Perhaps you wish to discuss a figure on the main
17795 before displaying the text associated with it.
17796 One way to accomplish this is tape a flap of dark paper over the part of
17801 you want to display later.
17802 This method fails, however, if you wish to overlap one graph with another,
17804 You would then have to fumble while speaking to align the two separate,
17809 s to align the two graphs.
17814 environment in both cases makes life much easier.
17817 \begin_layout Standard
17822 receives the page number of its
17823 \begin_inset Quotes eld
17827 \begin_inset Quotes erd
17835 \begin_inset Quotes eld
17843 \begin_inset Quotes erd
17850 \begin_layout Plain Layout
17851 Presumably, mutliple
17856 \begin_inset Quotes eld
17864 \begin_inset Quotes erd
17868 \begin_inset Quotes eld
17876 \begin_inset Quotes erd
17880 \begin_inset Quotes eld
17888 \begin_inset Quotes erd
17892 \begin_inset space ~
17895 appended to the page number of the parent
17905 Clearly, you want the contents of both the
17913 to each fit on a single physical slide! You should probably consider an
17919 \begin_inset Quotes eld
17923 \begin_inset Quotes erd
17931 Indeed, the \SpecialChar LyX
17936 class provides a visual cue for this: the label at the start of an
17940 is shorter than that at the start of a
17945 Lastly, when you generate printable output, you'll find alignment markers
17946 in all four corners of both the
17950 page and its parent
17955 These will assist you in lining up the two physical slides.
17958 \begin_layout Standard
17959 The major problem in overlaying two slides is aligning the contents of the
17960 two transparencies.
17961 How much space should you leave for that graph on the second slide? Worse
17962 still, what if you want a graph and a sentence on second slide, but there
17963 is text on the main transparency that goes in between them? You could try
17964 and insert vertical space of the right size.
17965 The better way is to use
17976 \begin_layout Standard
17977 As their names imply,
17985 are two command-like paragraph environments that make all subsequent text
17986 invisible and visible, respectively.
17988 \begin_inset space ~
17992 \begin_inset CommandInset ref
17994 reference "sec:slideQuirk"
17998 that you don't place anything
18002 these two environments, however.
18007 , it inserts a centered, sky-blue label into the page reading
18008 \begin_inset Quotes eld
18011 <Invisible Text Follows>
18012 \begin_inset Quotes erd
18016 For paragraphs following this label, the parts of the
18024 ; it doesn't matter which] where they would be contain instead blank space.
18028 \begin_layout Standard
18033 , the corresponding centered label is
18034 \begin_inset Quotes eld
18037 <Visible Text Follows>
18038 \begin_inset Quotes erd
18042 Paragraphs following this label behave normally.
18043 Note that the beginning of a new
18055 automatically shuts off an
18060 It's therefore not necessary to use
18071 \begin_layout Standard
18072 By now, it should be obvious how to create overlay transparencies using
18073 the proper combination of
18092 \begin_layout Enumerate
18097 , including everything that will appear on it, whether on the main slide
18105 \begin_layout Enumerate
18106 Before each figure or paragraph that will appear only on the
18115 If necessary, insert a
18119 environment after the
18126 \begin_layout Enumerate
18131 immediately following the
18138 \begin_layout Enumerate
18139 Copy the contents of this
18150 \begin_layout Enumerate
18155 , change all of the
18166 \begin_layout Standard
18168 You've just made an
18175 \begin_layout Standard
18176 There's one problem with the way I've designed the \SpecialChar LyX
18181 class: you can't make text in the middle of a paragraph invisible, nor
18182 make text in the middle of an invisible paragraph visible again.
18183 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18188 \begin_layout Plain Layout
18189 The commands of interest are:
18192 \begin_layout Itemize
18197 invisible \SpecialChar ldots
18201 \begin_layout Itemize
18206 visible \SpecialChar ldots
18210 \begin_layout Plain Layout
18212 and need to be marked as \SpecialChar TeX
18215 \begin_inset Quotes eld
18219 \begin_inset Quotes erd
18222 you wish to change goes in between the brackets [and after the
18235 If you don't know how to mark text as \SpecialChar TeX
18236 , see the appropriate section of
18249 \begin_layout Subsubsection
18259 \begin_inset CommandInset label
18261 name "sec:slideNote"
18268 \begin_layout Standard
18277 is associated with a
18278 \begin_inset Quotes eld
18282 \begin_inset Quotes erd
18290 Here, too, the \SpecialChar LyX
18295 class provides visual cues.
18300 is shorter than that of a
18304 [yet longer than that of an
18308 ] and, like the label of an
18312 is shockingly magenta.
18313 Additionally, the printed
18317 has the page number of its
18318 \begin_inset Quotes eld
18322 \begin_inset Quotes erd
18330 \begin_inset Quotes eld
18338 \begin_inset Quotes erd
18342 \begin_inset Quotes eld
18350 \begin_inset Quotes erd
18354 \begin_inset Quotes eld
18362 \begin_inset Quotes erd
18366 You can have multiple
18370 s associated with a single
18382 , you'll probably want to break up long
18386 s so that they fit on a single sheet of paper.
18389 \begin_layout Standard
18394 is obvious: it contains anything additional you might want to say about
18400 It could also be used as a sheet of reminders for a particular
18405 In the case of the latter, you might want to make use of time markers.
18406 Currently, the \SpecialChar LyX
18412 \begin_inset Quotes eld
18416 \begin_inset Quotes erd
18419 support for time markers, a
18421 Sli\SpecialChar TeX
18425 So, you'll have to resort to using the \SpecialChar LaTeX
18429 \begin_layout Standard
18430 To use time markers, you'll need to specify the extra class option
18431 \begin_inset Quotes eld
18439 \begin_inset Quotes erd
18443 \begin_inset space ~
18447 \begin_inset CommandInset ref
18449 reference "sec:slidesetup"
18454 This option turns on timing marks, which will appear in the lower-left-hand
18460 To set what appears in the time marker, you use the \SpecialChar LaTeX
18462 \begin_inset Quotes eld
18472 \begin_inset Quotes erd
18476 \begin_inset Quotes eld
18486 \begin_inset Quotes erd
18490 The arguments of both commands are time measured in seconds.
18492 \begin_inset Quotes eld
18502 \begin_inset Quotes erd
18505 sets the time marker to a given time.
18507 \begin_inset Quotes eld
18517 \begin_inset Quotes erd
18520 increments the time marker by the specified amount.
18521 Using time markers and
18525 s in this fashion, you can remind yourself how much time to spend on a particula
18533 \begin_layout Standard
18534 There's one last feature to describe.
18535 Clearly, you'd like to print out all of your
18543 s on transparencies while printing all of your
18560 with which it is associated.
18561 What's a person to do?
18564 \begin_layout Standard
18565 Luckily, there are two \SpecialChar LaTeX
18566 commands that allow you to select what to print
18568 Both must be placed into the preamble of your document.
18570 \begin_inset Quotes eld
18582 \begin_inset Quotes erd
18585 will cause the output to contain only the
18594 Correspondingly, the command
18595 \begin_inset Quotes eld
18607 \begin_inset Quotes erd
18610 prevents the output of anything but
18615 I'd advise placing both commands in the preamble and initially comment
18617 You can then preview your entire presentation as you write.
18618 When you're done writing, you can then uncomment one of the two to select
18619 what you want to print.
18620 I like to uncomment
18621 \begin_inset Quotes eld
18633 \begin_inset Quotes erd
18636 , print to a file with
18637 \begin_inset Quotes eld
18645 \begin_inset Quotes erd
18648 in its name, comment it back out, then uncomment
18649 \begin_inset Quotes eld
18661 \begin_inset Quotes erd
18665 \begin_inset Quotes eld
18673 \begin_inset Quotes erd
18677 I can then send either file to a printer, loading transparencies or plain
18678 paper as appropriate.
18681 \begin_layout Standard
18682 You can also provide other arguments to the
18683 \begin_inset Quotes eld
18693 \begin_inset Quotes erd
18697 \begin_inset Quotes eld
18707 \begin_inset Quotes erd
18711 See a good \SpecialChar LaTeX
18715 \begin_layout Subsection
18720 Class Template File
18723 \begin_layout Standard
18724 I have also provided a template file,
18725 \begin_inset Quotes eld
18733 \begin_inset Quotes erd
18741 To use it, begin your new presentation with
18743 File\SpecialChar menuseparator
18745 \begin_inset space ~
18749 \begin_inset space ~
18755 Your new \SpecialChar LyX
18756 presentation file will contain an example
18777 additionally contain an example of the use of
18786 Lastly, the preamble will contain:
18789 \begin_layout LyX-Code
18790 % Uncomment to print out only slides and overlays
18793 \begin_layout LyX-Code
18797 \begin_layout LyX-Code
18803 \begin_inset Newline newline
18809 \begin_layout LyX-Code
18810 % Uncomment to print out only notes
18813 \begin_layout LyX-Code
18817 \begin_layout LyX-Code
18825 \begin_layout Standard
18826 One final thing: I created this class to support the \SpecialChar LaTeX2e
18828 \begin_inset Quotes eld
18833 Sli\SpecialChar TeX
18837 \begin_inset Quotes erd
18840 class, one of the built-in \SpecialChar LaTeX2e
18842 Neither I nor the rest of the \SpecialChar LyX
18843 Team endorse or oppose the use of this built-in
18845 It's here if you want it or need it.
18846 There exist other \SpecialChar LaTeX2e
18847 classes for creating presentations, such as the
18852 \begin_inset space ~
18856 \begin_inset CommandInset ref
18858 reference "sec:foiltex"
18863 \begin_inset Quotes eld
18871 \begin_inset Quotes erd
18874 package [present on some \SpecialChar TeX
18876 The latter is not yet supported under \SpecialChar LyX
18881 \begin_layout Plain Layout
18882 Perhaps you can take on the task\SpecialChar ldots
18888 I know nothing about these other classes.
18889 Try them out to see what sort of alternative they provide.
18892 \begin_layout Chapter
18894 Features needing Extra Software
18897 \begin_layout Section
18898 Checking \SpecialChar TeX
18902 \begin_layout Standard
18908 \begin_layout Subsection
18912 \begin_layout Standard
18921 \begin_layout Plain Layout
18926 is not yet available when you are using the \SpecialChar LaTeX
18927 distribution MiK\SpecialChar TeX
18933 , you'll find in the
18940 \begin_inset space ~
18951 \begin_inset Newline newline
18955 \begin_inset CommandInset href
18957 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18965 \begin_layout Standard
18968 Chk\SpecialChar TeX
18971 package is a program that was written by
18972 \begin_inset Flex Noun
18975 \begin_layout Plain Layout
18977 \begin_inset space ~
18985 in frustration because some constructs in \SpecialChar LaTeX
18986 are sometimes non-intuitive,
18987 and easy to forget.
18988 The program runs over your \SpecialChar LaTeX
18989 file, checks the integrity of the file, and
18990 flags some common errors.
18991 In other technical words, it is
18995 for \SpecialChar LaTeX
18999 \begin_layout Standard
19000 Well, what is a syntax checker doing in \SpecialChar LyX
19001 which is supposed to produce correct
19003 anyways? The answer is simple: Just as
19007 not only checks the
19011 of C programs, but also does
19015 checks for type-errors,
19017 Chk\SpecialChar TeX
19020 catches some common
19024 errors, in addition to the syntactical ones.
19027 Chk\SpecialChar TeX
19030 is capable of detecting several common errors, such as
19033 \begin_layout Itemize
19034 Ellipsis detection:
19035 \begin_inset Newline newline
19038 Use \SpecialChar ldots
19042 \begin_layout Itemize
19043 No space in front of/after parenthesis:
19044 \begin_inset Newline newline
19050 \begin_layout Itemize
19051 Enforcement of normal space after common abbreviations:
19052 \begin_inset Newline newline
19056 \begin_inset space \thinspace{}
19060 \begin_inset space \space{}
19063 is too wide spacing.
19066 \begin_layout Itemize
19067 Enforcement of end-of-sentence space when the last sentence ends with a
19069 \begin_inset Newline newline
19073 And this is wrong spacing.
19076 \begin_layout Itemize
19077 Space in front of labels and similar commands:
19078 \begin_inset Newline newline
19081 The label should stick right up to the text to avoid falling to a wrong
19084 \begin_inset CommandInset label
19094 \begin_layout Plain Layout
19095 This footnote is in danger of falling off to a wrong page
19100 The label is separated too much.
19103 \begin_layout Itemize
19104 Space in front of references, instead of hard spaces:
19105 \begin_inset Newline newline
19108 If you have bad luck, the text will break right between the referenced text
19109 and reference number, and that's a pity.
19111 \begin_inset CommandInset ref
19113 reference "sec:chktex"
19120 \begin_layout Itemize
19122 \begin_inset Quotes eld
19126 \begin_inset Quotes erd
19130 \begin_inset Formula $\times$
19134 \begin_inset Newline newline
19137 2x2 looks cheap compared to
19138 \begin_inset Formula $2\times2$
19144 \begin_layout Standard
19145 and more \SpecialChar ldots
19146 It is an invaluable tool when you are
19147 \begin_inset Quotes eld
19151 \begin_inset Quotes erd
19154 your document before printing, and you should run it right after the obligatory
19155 spelling check, and before you go fine tuning the typesetting.
19158 \begin_layout Subsection
19162 \begin_layout Standard
19163 If you have the program installed, usage is as simple as choosing
19165 Tools\SpecialChar menuseparator
19167 \begin_inset space ~
19173 This will make \SpecialChar LyX
19174 generate a \SpecialChar LaTeX
19175 file of your document, start
19177 Chk\SpecialChar TeX
19180 to check it, and then make \SpecialChar LyX
19182 \begin_inset Quotes eld
19186 \begin_inset Quotes erd
19189 with the warnings from
19191 Chk\SpecialChar TeX
19194 , if there were any.
19195 The warnings will be placed close to the point of the mistake, and you
19196 can quickly find them by using the
19198 Navigate\SpecialChar menuseparator
19201 menu item, or the shortcut key
19210 Open the error boxes by clicking on them with the mouse, or use the shortcut
19219 bindings, or the corresponding
19228 Read the warning and correct the mistake, if it is a mistake.
19229 If you have trouble understanding what the warning is about, you can safely
19231 Remember that there is a hidden layer between the document on screen and
19232 the technical details in invoking
19234 Chk\SpecialChar TeX
19237 , and this gap can make some warnings seem arcane or just plain silly.
19240 \begin_layout Standard
19241 This document is an excellent testing bed for the feature, and it should
19242 provide quite a few warnings for you to fiddle with.
19243 Since computers are only so smart, expect most of the warnings to be false
19247 \begin_layout Subsection
19248 How to fine tune it
19251 \begin_layout Standard
19252 Sometimes, you'll find that
19254 Chk\SpecialChar TeX
19257 makes more noise than suits your mood.
19258 Then you can choose not to use it, wait until your mood changes, or try
19261 Chk\SpecialChar TeX
19264 to get better along with you.
19267 \begin_layout Standard
19270 Chk\SpecialChar TeX
19277 very configurable and extensible, you should not expect to solve all problems
19280 Chk\SpecialChar TeX
19283 in \SpecialChar LyX
19285 Since \SpecialChar LyX
19286 has to generate a somewhat special \SpecialChar LaTeX
19287 file to be able to match the
19288 line numbers from the
19290 Chk\SpecialChar TeX
19297 \begin_layout Plain Layout
19298 You can inspect the specific output from
19304 Document\SpecialChar menuseparator
19307 \begin_inset space ~
19321 to the internal document structure, some of the warnings will not appear
19323 There are two things you can do about this:
19326 \begin_layout Itemize
19329 Chk\SpecialChar TeX
19332 invocation command line in
19333 \begin_inset Flex Noun
19336 \begin_layout Plain Layout
19337 Tools\SpecialChar menuseparator
19338 Preferences\SpecialChar menuseparator
19339 Output\SpecialChar menuseparator
19340 LaTeX\SpecialChar menuseparator
19348 Chk\SpecialChar TeX
19351 installation configuration file (usually with the file
19356 See below to learn what warnings can be enabled and disabled on the command
19360 \begin_layout Itemize
19361 Export your document as a raw \SpecialChar LaTeX
19364 File\SpecialChar menuseparator
19365 Export\SpecialChar menuseparator
19374 Invoked in this way, it can be a hassle to find the corresponding place
19375 in the document inside \SpecialChar LyX
19376 , but with a little patience, you should be able
19380 \begin_layout Standard
19381 Here follows the warning messages that can be enabled and disabled in
19390 to disable a warning, and
19394 to enable a warning.
19395 The emphasized entries are disabled by default, because the default is
19398 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19403 \begin_layout Standard
19404 Notice that you should only use the options that enable and disable warnings,
19405 because \SpecialChar LyX
19406 relies on some of the other command line parameters to be set
19407 in a specific way to have a chance to communicate with
19414 \begin_layout Enumerate
19418 Command terminated with space.
19421 \begin_layout Enumerate
19424 Non-breaking space (
19425 \begin_inset Quotes eld
19433 \begin_inset Quotes erd
19436 ) should have been used.
19439 \begin_layout Enumerate
19443 You should enclose the previous parenthesis with
19444 \begin_inset Quotes eld
19452 \begin_inset Quotes erd
19458 \begin_layout Enumerate
19461 Italic correction (
19462 \begin_inset Quotes eld
19472 \begin_inset Quotes erd
19475 ) found in non-italic buffer.
19478 \begin_layout Enumerate
19481 Italic correction (
19482 \begin_inset Quotes eld
19492 \begin_inset Quotes erd
19495 ) found more than once.
19498 \begin_layout Enumerate
19502 No italic correction (
19503 \begin_inset Quotes eld
19513 \begin_inset Quotes erd
19519 \begin_layout Enumerate
19523 \begin_inset Quotes eld
19531 \begin_inset Quotes erd
19535 \begin_inset Quotes eld
19543 \begin_inset Quotes erd
19549 \begin_layout Enumerate
19552 Wrong length of dash may have been used.
19555 \begin_layout Enumerate
19559 \begin_inset Quotes eld
19567 \begin_inset Quotes erd
19571 \begin_inset Quotes eld
19579 \begin_inset Quotes erd
19585 \begin_layout Enumerate
19589 \begin_inset Quotes eld
19597 \begin_inset Quotes erd
19603 \begin_layout Enumerate
19607 \begin_inset Quotes eld
19615 \begin_inset Quotes erd
19618 to achieve an ellipsis.
19621 \begin_layout Enumerate
19624 Inter-word spacing (
19625 \begin_inset Quotes eld
19635 \begin_inset Quotes eld
19638 ) should perhaps be used.
19641 \begin_layout Enumerate
19644 Inter-sentence spacing (
19645 \begin_inset Quotes eld
19655 \begin_inset Quotes erd
19658 ) should perhaps be used.
19661 \begin_layout Enumerate
19664 Could not find argument for command.
19667 \begin_layout Enumerate
19671 \begin_inset Quotes eld
19679 \begin_inset Quotes erd
19685 \begin_layout Enumerate
19688 Math mode still on at end of \SpecialChar LaTeX
19692 \begin_layout Enumerate
19696 \begin_inset Quotes eld
19704 \begin_inset Quotes erd
19707 doesn't match the number of
19708 \begin_inset Quotes eld
19716 \begin_inset Quotes erd
19722 \begin_layout Enumerate
19725 You should use either
19728 \begin_inset Quotes eld
19736 \begin_inset Quotes erd
19741 as an alternative to
19742 \begin_inset Quotes eld
19750 \begin_inset Quotes erd
19756 \begin_layout Enumerate
19763 " (ASCII 39) instead of "
19770 \begin_layout Enumerate
19773 User-specified pattern found.
19776 \begin_layout Enumerate
19779 This command might not be intended.
19782 \begin_layout Enumerate
19789 \begin_layout Enumerate
19807 \begin_layout Enumerate
19810 Delete this space to maintain correct page references.
19813 \begin_layout Enumerate
19817 You might wish to put this between a pair of
19818 \begin_inset Quotes eld
19826 \begin_inset Quotes erd
19832 \begin_layout Enumerate
19835 You ought to remove spaces in front of punctuation.
19838 \begin_layout Enumerate
19841 Could not execute \SpecialChar LaTeX
19845 \begin_layout Enumerate
19854 in front of small punctuation.
19857 \begin_layout Enumerate
19865 may look prettier here.
19868 \begin_layout Enumerate
19872 Multiple spaces detected in output.
19875 \begin_layout Enumerate
19878 This text may be ignored.
19881 \begin_layout Enumerate
19887 \begin_inset Quotes eld
19892 to begin quotation, not
19899 \begin_layout Enumerate
19906 to end quotation, not
19909 \begin_inset Quotes eld
19917 \begin_layout Enumerate
19923 \begin_layout Enumerate
19926 You should perhaps use
19927 \begin_inset Quotes eld
19935 \begin_inset Quotes erd
19941 \begin_layout Enumerate
19944 You should put a space in front of/after parenthesis.
19947 \begin_layout Enumerate
19950 You should avoid spaces in front of/after parenthesis.
19953 \begin_layout Enumerate
19957 You should not use punctuation in front of/after quotes.
19960 \begin_layout Enumerate
19963 Double space found.
19966 \begin_layout Enumerate
19969 You should put punctuation outside inner/inside display math mode.
19972 \begin_layout Enumerate
19975 You ought to not use primitive \SpecialChar TeX
19976 in \SpecialChar LaTeX
19980 \begin_layout Enumerate
19983 You should remove spaces in front of
19984 \begin_inset Quotes eld
19992 \begin_inset Quotes erd
19998 \begin_layout Enumerate
20001 \begin_inset Quotes eld
20009 \begin_inset Quotes erd
20012 is normally not followed by
20013 \begin_inset Quotes eld
20021 \begin_inset Quotes erd
20027 \begin_layout Standard
20028 In later versions of \SpecialChar LyX
20029 , we hope to provide a more complete interface to this
20030 tool (and it's smaller cousin
20034 ) to exploit the full power of it.
20035 But it's not exactly useless as it is now: go try it on one of your existing
20036 documents of a certain length and be surprised.
20039 \begin_layout Section
20040 Version Control in \SpecialChar LyX
20044 \begin_layout Standard
20047 Lars Gullik Bjønnes
20054 \begin_layout Subsection
20058 \begin_layout Standard
20060 supports some of the most basic RCS/CVS/SVN/GIT commands.
20061 If you need something a bit more sophisticated you will have to do that
20062 manually in a terminal.
20065 \begin_layout Standard
20066 Also note that CVS support is not as good as subversion support so we advise
20068 A good place to start learning Subversion is SVN Book
20072 \begin_layout Plain Layout
20073 \begin_inset CommandInset href
20075 target "http://svnbook.red-bean.com/"
20086 In the case of RCS you should read
20087 \begin_inset Quotes eld
20091 \begin_inset Quotes erd
20094 (a man file, read it with
20099 This file describes all the basic features of RCS.
20100 You should especially notice the comment about a RCS directory, and the
20101 notion of a master RCS file (the file ending in
20108 \begin_layout Standard
20109 Before you begin to use the version control features in \SpecialChar LyX
20111 familiar with RCS/CVS/SVN/GIT usage.
20112 The implementation in \SpecialChar LyX
20113 assumes a recent version of the GNU RCS or CVS/SVN
20114 package — no guarantees are made for older versions.
20115 Most of the log messages are not currently displayed after operations —
20116 you can check them in the Messages pane if unsure.
20117 Regular users of version control will appreciate VC toolbar, which can
20120 View\SpecialChar menuseparator
20121 Toolbars\SpecialChar menuseparator
20123 \begin_inset space ~
20131 \begin_layout Standard
20132 For introducing your own external commands consult vc-command in the manual
20133 of \SpecialChar LyX
20137 \begin_layout Standard
20138 It is strongly recommended to store documents in uncompressed format if
20139 using version control (uncheck
20141 Document\SpecialChar menuseparator
20144 if it is checked): Uncompressed LyX documents are text files and therefore
20145 for merging two different versions by version control systems.
20146 Compressed LyX documents are binary files, which cannot be merged by version
20150 \begin_layout Subsection
20151 RCS commands in \SpecialChar LyX
20155 \begin_layout Standard
20156 The following sections describe the RCS commands supported by \SpecialChar LyX
20158 You can find them in the
20160 File\SpecialChar menuseparator
20162 \begin_inset space ~
20169 was tested against RCS 5.7/5.8.
20172 \begin_layout Subsubsection
20178 \begin_layout Standard
20179 If your document is not under revision control, this is the only item shown
20181 And if it is under revision control, the
20185 item is not visible.
20189 \begin_layout Standard
20190 This command registers your document with RCS (unless you are under the
20191 directory managed by CVS)\SpecialChar endofsentence
20192 You are asked interactively to supply an initial
20193 description of the document.
20194 The document is now set in Read-Only mode and you have to
20197 \begin_inset space ~
20201 \begin_inset space ~
20205 \begin_inset space ~
20210 , before making any changes to it.
20211 A document under revision control has a
20212 \begin_inset Quotes eld
20215 [RCS:<version> <locker>]
20216 \begin_inset Quotes erd
20219 item tagged to the filename in the minibuffer.
20222 \begin_layout Standard
20223 RCS command that is run:
20225 ci -q -u -i -t-"<initial description>" <file-name>
20228 \begin_layout Standard
20233 to understand the switches.
20237 \begin_layout Subsubsection
20243 \begin_layout Standard
20244 When you are finished editing a file, you check in your changes.
20245 When you do this, you are asked for a description of the changes.
20246 This is stored in the history log.
20247 The version number is bumped, your changes are applied to the master RCS
20248 file, the document is unlocked and set to Read-Only mode.
20251 \begin_layout Standard
20254 ci -q -u -m"<description>" <file-name>
20257 \begin_layout Subsubsection
20263 \begin_layout Standard
20264 By doing this you lock the document so that only you can edit it.
20265 This will also make the document Read-Write only for you.
20266 You will usually continue editing for a while and when you are finished
20267 you check in your changes.
20268 The status line is changed to reflect that you have locked the file.
20271 \begin_layout Standard
20274 co -q -l <file-name>
20277 \begin_layout Subsubsection
20280 Revert To Repository Version
20283 \begin_layout Standard
20284 This will discard all changes made to the document since the last check
20286 You get a warning before changes are discarded.
20289 \begin_layout Standard
20292 co -f -u<version> <file-name>
20295 \begin_layout Subsubsection
20301 \begin_layout Standard
20302 This will create a copy of the current document.
20303 Since RCS does not support copy operations natively, the version history
20304 is not preserved, and the copy is added as a new file.
20305 It requires a clean document without any changes since the last checkin.
20306 You are asked for a file name and a description of the copy operation.
20307 After that the copy is created, both locally and in the repository.
20308 If the parent directories of the copied and original document differ, all
20309 relative paths of included files of the copy are adjusted (like in
20311 File\SpecialChar menuseparator
20316 Finally, the copy is loaded instead of the original document.
20319 \begin_layout Labeling
20320 \labelwidthstring 00.00.0000
20322 \begin_inset space ~
20326 \begin_inset space ~
20330 \begin_inset Newline newline
20334 \begin_inset Flex Code
20337 \begin_layout Plain Layout
20340 \begin_inset Quotes eld
20344 \begin_inset Quotes erd
20353 \begin_inset Flex Code
20356 \begin_layout Plain Layout
20359 \begin_inset Quotes eld
20363 \begin_inset Quotes erd
20372 \begin_inset Newline newline
20376 \begin_inset Flex Code
20379 \begin_layout Plain Layout
20383 \begin_inset Quotes eld
20387 \begin_inset Quotes erd
20398 \begin_layout Subsubsection
20404 \begin_layout Standard
20405 This makes as if the last check in never happened.
20406 No changes are made to the document loaded into \SpecialChar LyX
20407 , but the last version
20408 is removed from the master RCS file.
20411 \begin_layout Standard
20414 rcs -o<version> <file-name>
20417 \begin_layout Subsubsection
20423 \begin_layout Standard
20424 This shows the complete history of the RCS document.
20429 is shown in a browser.
20437 \begin_layout Subsubsection
20441 \begin_layout Standard
20443 supports RCS version number, author name, date and time of last commit.
20444 All those are extracted from
20446 rlog -r <file-name>
20450 \begin_inset CommandInset ref
20452 reference "subsec:VCS-Revision-Information"
20459 \begin_layout Subsection
20460 CVS commands in \SpecialChar LyX
20464 \begin_layout Standard
20465 A subset of CVS operations is supported by \SpecialChar LyX
20467 You can find the commands in the
20469 File\SpecialChar menuseparator
20471 \begin_inset space ~
20477 The version control system SVN is more powerful, so please use it instead
20478 of CVS if possible.
20481 \begin_layout Subsubsection
20487 \begin_layout Standard
20488 If you start from scratch with CVS you have to create your repository and
20489 checkout the working copy with external tools.
20490 If you're using a client-server setup you may need to login before doing
20491 the first repository checkout.
20494 \begin_layout Standard
20495 If your documents are under revision control and others are using the same
20496 repository problems arise when different changes to the same document at
20497 the same location happen.
20498 Standard CVS repositories don't operate with a file locking mechanism.
20499 This may be surprising, but conflicts only occur if people disagree on
20500 the proper content of the same part of a document.
20501 So, if co-workers are used to communicate regularly, these conflicts occur
20503 If they don't communicate they have a fundamental problem anyway.
20504 Nevertheless some people like to work with so called
20505 \begin_inset Quotes eld
20509 \begin_inset Quotes erd
20513 If they do so the working copy of all files is readonly when checked out
20514 first and the user starts editing after using a special command to make
20515 the working copy writable.
20516 When the changes are checked in the working copy returns to readonly state.
20517 With \SpecialChar LyX
20518 one has to edit the
20519 \begin_inset Flex Code
20522 \begin_layout Plain Layout
20528 file and add the line
20529 \begin_inset Flex Code
20532 \begin_layout Plain Layout
20538 to work with reserved checkouts.
20539 The benefit is the possibility to see who is using a writable copy of some
20541 It's not guaranteed only one user makes a copy writable.
20544 \begin_layout Standard
20546 tries to guess if you're using reserved or non-reserved checkouts.
20547 If your working copy is readonly or it is writable and an additional copy
20548 of your document exists in the CVS/Base sub-directory a reserved otherwise
20549 a non-reserved checkout is assumed.
20550 When a reserved checkout is detected you have to use
20551 \begin_inset Flex Noun
20554 \begin_layout Plain Layout
20560 to make your working copy writable if it's readonly.
20562 \begin_inset Flex Noun
20565 \begin_layout Plain Layout
20571 operation is possible and that makes your working copy readonly again after
20572 transferring your changes to the repository.
20575 \begin_layout Standard
20576 More information about CVS can be found here
20577 \begin_inset Flex URL
20580 \begin_layout Plain Layout
20582 http://www.nongnu.org/cvs
20588 \begin_inset Flex URL
20591 \begin_layout Plain Layout
20593 http://ximbiot.com/cvs
20601 \begin_layout Standard
20606 to understand the sub-commands and the switches mentioned below.
20609 \begin_layout Subsubsection
20615 \begin_layout Standard
20616 If your document is not under revision control, this is the only item shown
20618 And if it is under revision control, the
20622 item is not visible.
20626 \begin_layout Standard
20627 This command registers in CVS your document
20628 \begin_inset Flex Strong
20631 \begin_layout Plain Layout
20639 in the case you have already the documents directory under CVS control
20645 This means you have to create or checkout the archive by yourself using
20647 (In case you forget that step \SpecialChar LyX
20648 registers the document with RCS.)
20651 \begin_layout Standard
20652 Then you are asked interactively to supply an initial description of the
20654 Don't forget that registered file is not yet checked in.
20657 \begin_layout Standard
20658 CVS command that is run:
20660 cvs -q add -m"<entered message>" "<file-name>"
20663 \begin_layout Standard
20668 above and for all other CVS commands is an abbreviation for
20669 \begin_inset Quotes eld
20672 change the current working directory to file location and use the file name
20673 without path component as argument
20674 \begin_inset Quotes erd
20680 \begin_layout Subsubsection
20686 \begin_layout Standard
20687 When you are finished editing a file, you commit your changes.
20688 When you do this and you had changed the document, you are asked for a
20689 description of the changes.
20690 After that changes are written to the repository.
20691 In case you didn't change the document and a reserved checkout is detected
20692 the reservation made on
20693 \begin_inset Flex Noun
20696 \begin_layout Plain Layout
20705 \begin_layout Labeling
20706 \labelwidthstring 00.00.0000
20708 \begin_inset space ~
20712 \begin_inset space ~
20716 \begin_inset Newline newline
20720 \begin_inset Flex Code
20723 \begin_layout Plain Layout
20726 -q commit -m"<description>" "<file-name>"
20732 \begin_inset Newline newline
20736 \begin_inset Flex Code
20739 \begin_layout Plain Layout
20750 \begin_layout Subsubsection
20756 \begin_layout Standard
20757 When you are sharing a repository with others, you may have to incorporate
20758 their changes into your working copy.
20761 \begin_layout Standard
20764 cvs -q update "<file-name>"
20767 \begin_layout Standard
20768 If a readonly checkout is detected the working copy is made writable and
20772 \begin_layout Standard
20775 cvs -q edit "<file-name>"
20778 \begin_layout Subsubsection
20781 Revert To Repository Version
20784 \begin_layout Standard
20785 This will discard all changes made to the document since the last check
20787 You get a warning before changes are discarded.
20788 Firstly the file is deleted, secondly CVS update command is run.
20791 \begin_layout Standard
20794 cvs -q update "<file-name>"
20797 \begin_layout Standard
20798 If a reserved checkout is detected and the working copy has no changes only
20799 the reservation is undone.
20802 \begin_layout Standard
20805 cvs -q unedit "<file-name>"
20808 \begin_layout Subsubsection
20814 \begin_layout Standard
20815 This will create a copy of the current document.
20816 Since CVS does not support copy operations natively, the version history
20817 is not preserved, and the copy is added as a new file.
20818 It requires a clean document without any changes since the last checkin.
20819 You are asked for a file name and a description of the copy operation.
20820 After that the copy is created, both locally and in the repository.
20821 If the parent directories of the copied and original document differ, all
20822 relative paths of included files of the copy are adjusted (like in
20824 File\SpecialChar menuseparator
20829 Finally, the copy is loaded instead of the original document.
20832 \begin_layout Labeling
20833 \labelwidthstring 00.00.0000
20835 \begin_inset space ~
20839 \begin_inset space ~
20843 \begin_inset Newline newline
20847 \begin_inset Flex Code
20850 \begin_layout Plain Layout
20853 \begin_inset Quotes eld
20857 \begin_inset Quotes erd
20866 \begin_inset Flex Code
20869 \begin_layout Plain Layout
20872 \begin_inset Quotes eld
20876 \begin_inset Quotes erd
20885 \begin_inset Newline newline
20889 \begin_inset Flex Code
20892 \begin_layout Plain Layout
20896 \begin_inset Quotes eld
20900 \begin_inset Quotes erd
20911 \begin_layout Subsubsection
20917 \begin_layout Standard
20918 This will rename the current document.
20919 Since CVS does not support rename operations natively, the version history
20920 is not preserved, the renamed document is added as a new file, and the
20921 original document is deleted.
20922 It requires a clean document without any changes since the last checkin.
20923 You are asked for a file name and a description of the rename operation.
20924 After that the document is renamed, both locally and in the repository.
20925 If the parent directories of the new and old file names differ, all relative
20926 paths of included files are adjusted (like in
20928 File\SpecialChar menuseparator
20933 Finally, the document is reloaded using the new name.
20936 \begin_layout Labeling
20937 \labelwidthstring 00.00.0000
20939 \begin_inset space ~
20943 \begin_inset space ~
20947 \begin_inset Newline newline
20951 \begin_inset Flex Code
20954 \begin_layout Plain Layout
20957 \begin_inset Quotes eld
20961 \begin_inset Quotes erd
20970 \begin_inset Flex Code
20973 \begin_layout Plain Layout
20976 \begin_inset Quotes eld
20980 \begin_inset Quotes erd
20989 \begin_inset Newline newline
20993 \begin_inset Flex Code
20996 \begin_layout Plain Layout
21000 \begin_inset Quotes eld
21004 \begin_inset Quotes erd
21013 \begin_inset Newline newline
21017 \begin_inset Flex Code
21020 \begin_layout Plain Layout
21024 \begin_inset Quotes eld
21028 \begin_inset Quotes erd
21039 \begin_layout Subsubsection
21040 Update of the local directory checkout from repository
21043 \begin_layout Standard
21044 Once your documents gets more complex, containing sub-documents and pictures,
21046 \begin_inset Flex Code
21049 \begin_layout Plain Layout
21055 files and so on using version control becomes more complicated.
21057 supports updating the whole tree in which resides the document.
21058 This become especially useful once you cooperate with people which neither
21059 have detailed knowledge about CVS usage nor they have ambition to commit
21060 additional material to the repository.
21061 You have to organize the files structure so that all external files are
21062 in the same directory or subdirectories of the document.
21063 It's good practice anyway to store multipart documents in an extra directory.
21066 \begin_layout Standard
21068 \begin_inset Flex Code
21071 \begin_layout Plain Layout
21072 Update local directory from repository
21077 command updates the whole directory.
21078 If local changes are detected user is warned before update starts.
21079 In case of merge conflicts both versions of the conflicting document parts
21080 are placed in the final document.
21081 You have to review and correct the result of the merge.
21082 You'll find the conflicts enclosed in pairs of
21083 \begin_inset Flex Code
21086 \begin_layout Plain Layout
21093 \begin_inset Flex Code
21096 \begin_layout Plain Layout
21103 \begin_inset Flex Code
21106 \begin_layout Plain Layout
21113 The first part is your version as before the update operation with the
21114 document name prepended.
21115 The second one is the repository version with the version number after
21117 \begin_inset Flex Code
21120 \begin_layout Plain Layout
21129 \begin_layout Labeling
21130 \labelwidthstring 00.00.0000
21132 \begin_inset space ~
21136 \begin_inset space ~
21140 \begin_inset Newline newline
21144 \begin_inset Flex Code
21147 \begin_layout Plain Layout
21155 (Ask if changes are detected.)
21156 \begin_inset Newline newline
21160 \begin_inset Flex Code
21163 \begin_layout Plain Layout
21164 cd $path; cvs -q update
21174 \begin_layout Standard
21176 \begin_inset Flex Code
21179 \begin_layout Plain Layout
21185 stands for the path to the document.
21188 \begin_layout Subsubsection
21194 \begin_layout Standard
21195 This shows the complete history of the CVS document.
21198 cvs log "<file-name>"
21200 is shown in a browser.
21203 \begin_layout Subsubsection
21207 \begin_layout Standard
21209 supports CVS version number, author name, date and time of last commit.
21210 All those are extracted from
21212 cvs log -r <file-name>
21216 \begin_inset CommandInset ref
21218 reference "subsec:VCS-Revision-Information"
21225 \begin_layout Subsection
21226 SVN commands in \SpecialChar LyX
21230 \begin_layout Standard
21231 SVN is now partially supported by \SpecialChar LyX
21233 You can find the commands in the
21235 File\SpecialChar menuseparator
21237 \begin_inset space ~
21243 Please note that if you use password protected access to repository via
21244 ssh, you will be asked in terminal window.
21246 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21250 \begin_layout Plain Layout
21251 Most of the commands will work with 1.4 too, see
21252 \begin_inset CommandInset ref
21254 reference "subsec:SVN-Repo-Update"
21259 There seems to be currently unresolved permissions problem under SVN 1.8
21260 with reverting changes when file is locked.
21268 \begin_layout Subsubsection
21274 \begin_layout Standard
21275 If your document is not under revision control, this is the only item shown
21277 And if it is under revision control, the
21281 item is not visible.
21284 \begin_layout Standard
21285 This command registers in SVN your document ONLY in case you have already
21286 the documents directory under SVN control (in particular
21291 This means you have to checkout the archive by yourself.
21294 \begin_layout Standard
21295 Then you are asked interactively to supply an initial description of the
21297 Don't forget that registered file is not yet commited.
21300 \begin_layout Standard
21301 SVN command that is run:
21304 \begin_inset Quotes eld
21308 \begin_inset Quotes erd
21314 \begin_layout Standard
21319 to understand the switches.
21322 \begin_layout Subsubsection
21328 \begin_layout Standard
21329 When you are finished editing a file, you commit your changes.
21330 When you do this, you are asked for a description of the changes.
21331 After that changes are commited.
21334 \begin_layout Standard
21339 \begin_layout Plain Layout
21340 In case locking is not enabled.
21342 \begin_inset CommandInset ref
21344 reference "subsec:SVN-File-Locking"
21355 svn commit -q -m"<description>" <file-name>
21358 \begin_layout Subsubsection
21364 \begin_layout Standard
21365 Updates the changes of this file from the repository.
21366 Be sure you understand SVN merging and conflicts resolving before using
21367 this function, because all conflicts has to be resolved manually by you!
21370 \begin_layout Standard
21375 \begin_layout Plain Layout
21383 svn update --non-interactive
21384 \begin_inset Quotes eld
21388 \begin_inset Quotes erd
21394 \begin_layout Subsubsection
21397 Revert To Repository Version
21400 \begin_layout Standard
21401 This will discard all changes made to the document since the last check
21403 You get a warning before changes are discarded.
21406 \begin_layout Standard
21410 \begin_inset Quotes eld
21414 \begin_inset Quotes erd
21420 \begin_layout Subsubsection
21426 \begin_layout Standard
21427 This will create a copy of the current document including the version history.
21428 It requires a clean document without any changes since the last checkin.
21429 You are asked for a file name and a description of the copy operation.
21430 After that the copy is created, both locally and in the repository.
21431 If the parent directories of the copied and original document differ, all
21432 relative paths of included files of the copy are adjusted (like in
21434 File\SpecialChar menuseparator
21439 Finally, the copy is loaded instead of the original document.
21442 \begin_layout Labeling
21443 \labelwidthstring 00.00.0000
21445 \begin_inset space ~
21449 \begin_inset space ~
21453 \begin_inset Newline newline
21457 \begin_inset Flex Code
21460 \begin_layout Plain Layout
21464 \begin_inset Quotes eld
21468 \begin_inset Quotes erd
21472 \begin_inset Quotes eld
21476 \begin_inset Quotes erd
21485 \begin_inset Newline newline
21489 \begin_inset Flex Code
21492 \begin_layout Plain Layout
21501 \begin_layout Subsubsection
21507 \begin_layout Standard
21508 This will rename the current document including the version history.
21509 It requires a clean document without any changes since the last checkin.
21510 You are asked for a file name and a description of the rename operation.
21511 After that the document is renamed, both locally and in the repository.
21512 If the parent directories of the new and old file names differ, all relative
21513 paths of included files are adjusted (like in
21515 File\SpecialChar menuseparator
21520 Finally, the document is reloaded using the new name.
21523 \begin_layout Labeling
21524 \labelwidthstring 00.00.0000
21526 \begin_inset space ~
21530 \begin_inset space ~
21534 \begin_inset Newline newline
21538 \begin_inset Flex Code
21541 \begin_layout Plain Layout
21545 \begin_inset Quotes eld
21549 \begin_inset Quotes erd
21553 \begin_inset Quotes eld
21557 \begin_inset Quotes erd
21566 \begin_inset Newline newline
21570 \begin_inset Flex Code
21573 \begin_layout Plain Layout
21582 \begin_layout Subsubsection
21583 \begin_inset CommandInset label
21585 name "subsec:SVN-Repo-Update"
21589 Update of the local directory checkout from repository
21593 \begin_layout Plain Layout
21594 Note that this command will work only with subversion
21595 \begin_inset Formula $\geqq1.5$
21606 \begin_layout Standard
21607 All the commands above have one shortcomming - they deal with the current
21609 Once your document contains pictures, includes external
21610 \begin_inset Flex Code
21613 \begin_layout Plain Layout
21619 files and so on administration becomes more complicated.
21621 now supports updating the whole tree in which resides the document
21625 \begin_layout Plain Layout
21626 One need to organize the files structure so that all external files are
21627 in the same directory or subdirectories of the document.
21634 This become especially useful once you cooperate with people which neither
21635 know about subversion management nor they have ambition to commit additional
21636 material to the repository.
21640 \begin_layout Standard
21641 \begin_inset Flex Code
21644 \begin_layout Plain Layout
21645 Update local directory from repository
21650 command updates the whole directory and in case of merge conflicts local
21651 version of the files are left, so no unintended data loss occurs.
21652 If local changes are detected user is warned before update starts.
21655 \begin_layout Labeling
21656 \labelwidthstring 00.00.0000
21658 \begin_inset space ~
21662 \begin_inset space ~
21666 \begin_inset Newline newline
21670 \begin_inset Flex Code
21673 \begin_layout Plain Layout
21679 (Ask if changes are detected.)
21680 \begin_inset Newline newline
21684 \begin_inset Flex Code
21687 \begin_layout Plain Layout
21688 svn update –accept mine-full $path
21696 \begin_layout Standard
21698 \begin_inset Flex Code
21701 \begin_layout Plain Layout
21707 stands for the path to the document.
21710 \begin_layout Subsubsection
21716 \begin_layout Standard
21717 This shows the complete history of the SVN document.
21721 \begin_inset Quotes eld
21725 \begin_inset Quotes erd
21730 is shown in a browser.
21733 \begin_layout Subsubsection
21735 \begin_inset CommandInset label
21737 name "subsec:SVN-File-Locking"
21744 \begin_layout Standard
21745 The file exchange through various revision control systems brings the problem
21746 of merge conflicts in case two different users try to edit the same (parts
21748 When such a conflict happens it needs manual resolving and one reasonable
21749 alternative is to provide some kind of locking mechanism, which guarantees
21750 that only one user is allowed to edit file at the given time.
21753 \begin_layout Standard
21754 SVN has two such mechanisms to provide mutual exclusivity for file access
21755 - locks and automatic setting of write permissions (see sec.
21757 \begin_inset CommandInset ref
21759 reference "subsec:Automatical-Locking-Property"
21764 \begin_inset Flex Code
21767 \begin_layout Plain Layout
21777 \begin_layout Plain Layout
21778 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21784 If this property is detected for a given document \SpecialChar LyX
21785 starts to use SVN locks
21786 for document editing automatically and the whole check-in/out mechanism
21787 switches to the same regimen as for RCS.
21788 This in particular means there are two different modes of file use in \SpecialChar LyX
21792 \begin_layout Itemize
21794 The loaded file is in the read-only mode.
21795 For editing on needs to check-out.
21800 consists of updating from the repository and gaining write lock.
21801 If the lock is not possible to obtain, we remain in unlocked state.
21804 \begin_layout Itemize
21806 The loaded file is in the 'normal' edit mode.
21807 No other user is allowed to edit the file.
21812 consists of commiting changes and releasing write-lock.
21813 If no changes have been made to the document, no commit will be produced
21817 \begin_layout Plain Layout
21818 Don't be puzzled by the fact that you will be asked for commit message anyway.
21823 and only the write-lock will be released.
21826 \begin_layout Standard
21830 \begin_layout Labeling
21831 \labelwidthstring 00.00.0000
21834 svn commit -q -m"<description>" "<file-name>"
21835 \begin_inset Newline newline
21838 svn unlock "<file-name>"
21841 \begin_layout Labeling
21842 \labelwidthstring 00.00.0000
21845 svn update "<file-name>"
21846 \begin_inset Newline newline
21849 svn lock "<file-name>"
21852 \begin_layout Subsubsection
21855 \begin_inset CommandInset label
21857 name "subsec:Automatical-Locking-Property"
21863 Automatic Locking Property
21866 \begin_layout Standard
21867 The above mentioned automatic setting of write permissions of the .lyx file
21870 File\SpecialChar menuseparator
21872 \begin_inset space ~
21875 Control\SpecialChar menuseparator
21876 Toggle locking property
21879 This command is active only when the file is not locked on the svn server
21881 you need to check-out before proceeding).
21884 \begin_layout Labeling
21885 \labelwidthstring 00.00.0000
21887 \begin_inset space ~
21893 \begin_layout Labeling
21894 \labelwidthstring 00.00.0000
21897 svn propset svn:needs-lock ON "<file-name>"
21900 \begin_layout Labeling
21901 \labelwidthstring 00.00.0000
21904 svn propdel svn:needs-lock "<file-name>"
21907 \begin_layout Subsubsection
21908 \begin_inset CommandInset label
21910 name "subsec:VCS-Revision-Information"
21914 Revision Information in Documents
21917 \begin_layout Standard
21918 There are more possibilities how to activate revision information in our
21922 \begin_layout Itemize
21928 \begin_layout Itemize
21929 tree revision information (
21930 \begin_inset Flex Code
21933 \begin_layout Plain Layout
21940 The result is the output of the
21941 \begin_inset Flex Code
21944 \begin_layout Plain Layout
21950 command, the following table gives you an idea, how to read the results.
21953 \begin_layout Standard
21955 \begin_inset Tabular
21956 <lyxtabular version="3" rows="6" columns="2">
21957 <features tabularvalignment="middle">
21958 <column alignment="center" valignment="top">
21959 <column alignment="center" valignment="top">
21961 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21964 \begin_layout Plain Layout
21970 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21973 \begin_layout Plain Layout
21981 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21984 \begin_layout Plain Layout
21990 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21993 \begin_layout Plain Layout
21994 mixed revision working copy
22001 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22004 \begin_layout Plain Layout
22010 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22013 \begin_layout Plain Layout
22014 modified working copy
22021 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22024 \begin_layout Plain Layout
22030 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22033 \begin_layout Plain Layout
22034 switched working copy
22041 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22044 \begin_layout Plain Layout
22050 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22053 \begin_layout Plain Layout
22054 partial working copy, from a sparse checkout
22061 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22064 \begin_layout Plain Layout
22070 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22073 \begin_layout Plain Layout
22074 mixed revision, modified, switched working copy
22087 \begin_layout Itemize
22088 file revision information.
22089 The result comes from parsing the output of
22090 \begin_inset Flex Code
22093 \begin_layout Plain Layout
22095 \begin_inset space ~
22099 \begin_inset space ~
22103 \begin_inset space ~
22112 Supported flags are:
22116 \begin_layout Itemize
22117 version number of the last commit (
22118 \begin_inset Flex Code
22121 \begin_layout Plain Layout
22130 \begin_layout Itemize
22131 author of the last commit (
22132 \begin_inset Flex Code
22135 \begin_layout Plain Layout
22144 \begin_layout Itemize
22145 date of the last commit (
22146 \begin_inset Flex Code
22149 \begin_layout Plain Layout
22158 \begin_layout Itemize
22159 time of the last commit (
22160 \begin_inset Flex Code
22163 \begin_layout Plain Layout
22173 \begin_layout Standard
22174 You can obtain this info via InsetInfo (e.g.
22176 \begin_inset Flex Code
22179 \begin_layout Plain Layout
22180 info-insert buffer vcs-date
22186 The information will be available only when you have the file stored under
22187 svn managment (i.e.
22189 \begin_inset Flex Code
22192 \begin_layout Plain Layout
22198 directory is available with your document).
22202 \begin_layout Itemize
22203 Another—a hacking one—possibility is to use svn keywords
22207 \begin_layout Plain Layout
22208 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22214 In short – you set file keywords property (e.g.
22217 svn propset svn:keywords 'Rev' file.lyx
22219 ) and then paste keyword \SpecialChar TeX
22224 \begin_layout Plain Layout
22225 This is an easy way how to ensure that \SpecialChar LyX
22226 won't break the line in the middle
22232 tag in your document (e.g.
22237 \begin_layout Plain Layout
22245 This way svn client will automatically substitute revision number (e.g.
22250 \begin_layout Plain Layout
22257 ) after each update and commit.
22258 There are more problems with this approach.
22259 Firstly, the '$' character is used in \SpecialChar TeX
22260 world for math equations, so any
22261 occurence of math formula
22262 \begin_inset Formula $Rev$
22266 \begin_inset Formula $Rev:59$
22269 in your \SpecialChar LyX
22271 Similarly for other keywords like Id, Date, Author, etc.
22272 Secondly svn output is dependent on your locales, so its very easy that
22273 svn would produce some problematic strings once Date is used.
22274 Thirdly you get the whole 'Rev: 59' string in your document instead of
22276 Until subversion implements user's custom keywords it will be hard to use
22277 this approach reliably or let \SpecialChar LyX
22278 to support it directly.
22281 \begin_layout Subsection
22282 SVN and Windows Environment
22285 \begin_layout Quote
22286 My inclination is to say that if the user cannot figure out the command
22287 line operations on their own fairly quickly, they would be well advised
22288 to use TortoiseSVN.
22294 \begin_layout Subsubsection
22298 \begin_layout Standard
22299 In addition to installing \SpecialChar LyX
22300 , and having access to a Subversion repository,
22301 the user will need to install the Subversion client program.
22302 A Windows installer for the client program is available from
22303 \begin_inset CommandInset href
22306 target "http://www.collab.net/nonav/downloads/subversion/"
22312 The user may also want to install
22313 \begin_inset CommandInset href
22316 target "http://tortoisesvn.tigris.org/"
22321 , which integrates Subversion operations into the context (rightclick) menu
22322 of Windows Explorer.
22323 Operations done outside \SpecialChar LyX
22324 will typically be more convenient using the Explorer
22326 Note that TortoiseSVN is not a replacement for the client program, which
22327 is what \SpecialChar LyX
22331 \begin_layout Subsubsection
22332 Bringing a document under Subversion control
22335 \begin_layout Standard
22336 Before a \SpecialChar LyX
22337 document can be brought under version control in Subversion, its
22338 parent directory needs to be under version control.
22339 If the document is being added to a project already in the repository,
22340 this is accomplished by checking the project out to the directory where
22341 the new document will be placed.
22342 If the project itself is not yet under version control (for instance, if
22343 this document starts a new project), the directory must be imported into
22345 This is done outside \SpecialChar LyX
22347 Both import and checkout are easily accomplished from the Explorer context
22348 menu using TortoiseSVN, or alternatively can be done using the command
22349 line client at a DOS prompt.
22350 The procedure for importing the project using TortoiseSVN is described
22351 below, assuming an existing repository and a new project being started
22359 For information on using the Subversion client program, run
22366 \begin_layout Enumerate
22373 in Windows Explorer, right click it, and select
22375 TortoiseSVN\SpecialChar menuseparator
22379 If necessary, adjust the URL for the repository, then click OK.
22382 \begin_layout Enumerate
22383 Right click the level of the repository under which you want to place the
22384 new project folder (typically the top level) and click
22388 Supply a name for the project folder and click OK.
22389 Add a message for the log file if desired, then click OK again.
22390 The new project folder should appear in the repository.
22391 Finally, click OK again to exit the repository browser.
22394 \begin_layout Enumerate
22395 Once again right click
22401 , this time selecting SVN Checkout\SpecialChar ldots
22402 Select the URL of the project folder
22403 you just created in the repository, and set the checkout directory to
22411 You will be warned about a non-empty folder; click OK to proceed.
22412 You should now have a
22423 \begin_layout Enumerate
22424 Create or open your document in \SpecialChar LyX
22427 File\SpecialChar menuseparator
22429 \begin_inset space ~
22432 Control\SpecialChar menuseparator
22436 Add a log message and click OK to commit the document to version control.
22439 \begin_layout Standard
22440 From this point onward, you should have full functionality in the
22442 File\SpecialChar menuseparator
22444 \begin_inset space ~
22450 You also have the option of checking the document in and out, viewing its
22452 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22453 client program from a command prompt.
22456 \begin_layout Subsubsection
22457 SSH tunnel used with SVN under Windows
22460 \begin_layout Standard
22461 Compared with Linux setting up an svn client to communicate over ssh under
22462 Windows is a rather troublesome task.
22463 We will at least offer some hints how to setup the client side but prior
22464 knowledge about ssh and the Windows command line is needed, also be prepared
22465 for a great deal of frustration\SpecialChar ldots
22469 \begin_layout Enumerate
22470 Get an svn client for windows, as described in the previous sections.
22471 When it is a fresh install run some svn command (e.g.
22473 \begin_inset Flex Code
22476 \begin_layout Plain Layout
22482 ) to create config files, which you will need to change later on.
22485 \begin_layout Enumerate
22486 Choose an ssh client for Windows.
22487 There are several possibilities, we will use the one from Putty tools
22491 \begin_layout Plain Layout
22492 \begin_inset Flex URL
22495 \begin_layout Plain Layout
22497 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22508 You will need to set the connection up so that the client doesn't ask for
22509 any password from you.
22510 To keep things easy we will use only keys without any additional password
22515 \begin_layout Enumerate
22517 \begin_inset Flex Code
22520 \begin_layout Plain Layout
22527 Save your private .ppk key file and put the public one on the server side.
22528 If the SVN server runs on Linux, note that the format of the public key
22529 is not compatible with Linux openssh and you will need to direcly copy-paste
22532 Public key for pasting into OpenSSH authorized_keys file
22534 :” edit field into the server's
22535 \begin_inset Flex Code
22538 \begin_layout Plain Layout
22539 ~/.ssh/authorized_keys
22545 \begin_inset Flex Code
22548 \begin_layout Plain Layout
22557 \begin_layout Enumerate
22559 \begin_inset Flex Code
22562 \begin_layout Plain Layout
22569 In the SVN config file
22573 \begin_layout Plain Layout
22574 Exact path depends on Windows version, usually somewhere around
22575 \begin_inset Flex Code
22578 \begin_layout Plain Layout
22581 Documents and Settings
22595 \begin_inset Flex Code
22598 \begin_layout Plain Layout
22613 , section [tunnels], setup ssh command, e.g.
22615 \begin_inset Flex Code
22618 \begin_layout Plain Layout
22619 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22628 \begin_layout Plain Layout
22629 It will usually take a lot of time to get exact command right and it depends
22631 For example do not have some remote server saved as a default session in
22633 If things fail, try to connect via plink without SVN first.
22642 \begin_layout Enumerate
22643 Checkout the SVN archive, e.
22644 \begin_inset space \thinspace{}
22648 \begin_inset Newline newline
22652 \begin_inset Flex Code
22655 \begin_layout Plain Layout
22656 svn co svn+ssh://user@server/repository_path
22664 \begin_layout Subsubsection
22665 End-of-Line Conversions
22668 \begin_layout Standard
22669 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22671 use different line endings inside the .lyx files.
22672 This is not a problem as far as \SpecialChar LyX
22673 functionality is concerned, but the commit
22674 diffs will be huge and merge-conflicts prone.
22675 Fortunately SVN itself knows
22679 \begin_layout Plain Layout
22680 \begin_inset Flex URL
22683 \begin_layout Plain Layout
22685 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22695 how to deal with CR/LF problems when switching .lyx files to the
22696 \begin_inset Flex Code
22699 \begin_layout Plain Layout
22709 \begin_layout Plain Layout
22711 \begin_inset Flex Code
22714 \begin_layout Plain Layout
22715 svn propset svn:eol-style native FILE_NAME
22728 \begin_layout Subsection
22729 GIT commands in \SpecialChar LyX
22733 \begin_layout Standard
22734 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22736 You can find the commands in the
22738 File\SpecialChar menuseparator
22740 \begin_inset space ~
22746 Please note that if you use password protected access to repository via
22747 ssh, you will be asked in terminal window.
22749 was tested against GIT 1.7.
22753 \begin_layout Plain Layout
22754 Windows users please note that you need to ensure that git is on the path.
22755 This can be set from within \SpecialChar LyX
22758 Tools\SpecialChar menuseparator
22759 Preferences\SpecialChar menuseparator
22760 Paths\SpecialChar menuseparator
22771 \begin_layout Standard
22772 One big difference of GIT and the other supported version control systems
22773 is the distributed nature of GIT: With traditional version control systems
22774 there is one central server which hosts the repository.
22775 Users commit their changes to the server, and get updates made by other
22777 With GIT, users commit to a local repository.
22778 The local repository can be synchronized with one or more remote repositories
22780 \begin_inset Flex Code
22783 \begin_layout Plain Layout
22790 \begin_inset Flex Code
22793 \begin_layout Plain Layout
22801 does not interact in any way with remote GIT repositories.
22802 It works exclusively with the local repository in a very similar way as
22803 with a central CVS or SVN repository.
22804 If you use remote GIT repositories you need to do the
22805 \begin_inset Flex Code
22808 \begin_layout Plain Layout
22815 \begin_inset Flex Code
22818 \begin_layout Plain Layout
22824 operations with your favourite GIT client.
22827 \begin_layout Subsubsection
22833 \begin_layout Standard
22834 If your document is not under revision control, this is the only item shown
22836 And if it is under revision control, the
22840 item is not visible.
22843 \begin_layout Standard
22844 This command registers in GIT your document ONLY in case you have already
22845 the documents directory under GIT control (in particular
22850 This means you have to checkout the archive by yourself.
22853 \begin_layout Standard
22854 Then you are asked interactively to supply an initial description of the
22856 Don't forget that registered file is not yet commited.
22859 \begin_layout Standard
22860 GIT command that is run:
22863 \begin_inset Quotes eld
22867 \begin_inset Quotes erd
22873 \begin_layout Standard
22878 to understand the switches.
22881 \begin_layout Subsubsection
22887 \begin_layout Standard
22888 When you are finished editing a file, you commit your changes.
22889 When you do this, you are asked for a description of the changes.
22890 After that changes are commited.
22893 \begin_layout Standard
22896 git commit -q -m"<description>" <file-name>
22899 \begin_layout Subsubsection
22902 Revert To Repository Version
22905 \begin_layout Standard
22906 This will discard all changes made to the document since the last check
22908 You get a warning before changes are discarded.
22911 \begin_layout Standard
22915 \begin_inset Quotes eld
22919 \begin_inset Quotes erd
22925 \begin_layout Subsubsection
22931 \begin_layout Standard
22932 This will rename the current document including the version history.
22933 It requires a clean document without any changes since the last checkin.
22934 You are asked for a file name and a description of the rename operation.
22935 After that the document is renamed, both locally and in the repository.
22936 If the parent directories of the new and old file names differ, all relative
22937 paths of included files are adjusted (like in
22939 File\SpecialChar menuseparator
22944 Finally, the document is reloaded using the new name.
22947 \begin_layout Labeling
22948 \labelwidthstring 00.00.0000
22950 \begin_inset space ~
22954 \begin_inset space ~
22958 \begin_inset Newline newline
22962 \begin_inset Flex Code
22965 \begin_layout Plain Layout
22969 \begin_inset Quotes eld
22973 \begin_inset Quotes erd
22977 \begin_inset Quotes eld
22981 \begin_inset Quotes erd
22990 \begin_inset Newline newline
22994 \begin_inset Flex Code
22997 \begin_layout Plain Layout
23006 \begin_layout Subsubsection
23012 \begin_layout Standard
23013 This shows the complete history of the GIT document.
23017 \begin_inset Quotes eld
23021 \begin_inset Quotes erd
23026 is shown in a browser.
23029 \begin_layout Subsubsection
23033 \begin_layout Standard
23035 supports GIT hash number of the last commit to the file, author name, date
23036 and time of last commit.
23037 All those are extracted from
23039 git log -n 1 --pretty=format:%H%n%an%n%ai
23042 Tree version information is obtained via
23044 git describe --abbrev --dirty --long
23048 \begin_inset CommandInset ref
23050 reference "subsec:VCS-Revision-Information"
23057 \begin_layout Subsection
23061 \begin_layout Standard
23062 With the recent addition of the vc-command function \SpecialChar LyX
23063 power users are allowed
23064 to create their own commands for revision control.
23067 \begin_layout Standard
23068 As an example you can see how two TortoiseSVN commands could be integrated
23072 \begin_layout Description
23074 \begin_inset Flex Code
23077 \begin_layout Plain Layout
23078 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23086 \begin_layout Description
23088 \begin_inset Flex Code
23091 \begin_layout Plain Layout
23092 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23100 \begin_layout Subsection
23101 Version control and Document comparison
23104 \begin_layout Standard
23105 One of the typical uses of version control is to inspect the changes between
23106 revisions, usually by creating
23107 \begin_inset Flex Code
23110 \begin_layout Plain Layout
23117 While this is useful for plain text files, it is much less useful in the
23118 case of \SpecialChar LyX
23119 files, which have more a complicated structure.
23120 Hence we provide binding to the Document comparison feature.
23121 There are two ways of calling this feature - either by direct call of
23122 \begin_inset Flex Code
23125 \begin_layout Plain Layout
23132 function (for details see \SpecialChar LyX
23133 functions manual) or by icon/menu item
23134 \begin_inset Flex Noun
23137 \begin_layout Plain Layout
23138 Compare with older revision...
23144 One can either compare two chosen revisions of the document or he can simply
23145 compare the current version of edited text with older revisions (where
23147 \begin_inset Flex Noun
23150 \begin_layout Plain Layout
23156 ' revisions back means comparison of the edited file with last commited
23161 \begin_layout Standard
23162 This feature is supported for SVN and RCS though due to the more complicated
23163 versioning scheme of RCS there is a constraint – when addressing the revisions
23164 in dialog, numbers always point to the last number in RCS revision number,
23167 We don't currently support GIT addressing of revisions, one can just compare
23168 edited document with its revision X steps backs, where X is addressed as
23172 \begin_layout Section
23173 Literate Programming
23176 \begin_layout Standard
23181 (kayvan@sylvan.com)
23185 original documentation written by
23187 Edmar Wienskoski Jr.
23190 (edmar-w-jr@technologist.com)
23193 \begin_layout Subsection
23197 \begin_layout Standard
23198 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23200 programming, where it is assumed that you are familiar with this programming
23201 technique, and know what
23202 \begin_inset Quotes eld
23206 \begin_inset Quotes erd
23210 \begin_inset Quotes eld
23214 \begin_inset Quotes erd
23218 If that is not the case, please follow the web links provided in the following
23220 There is a lot of good documentation out there covering old development
23221 history to the latest tools tips.
23224 \begin_layout Standard
23225 It is also assumed that you are familiar with \SpecialChar LyX
23226 itself to a point that you
23227 are comfortable changing your \SpecialChar LyX
23228 preferences, and X resources file.
23229 If that is not the case please refer to other \SpecialChar LyX
23230 documentation to cover your
23234 \begin_layout Subsection
23235 Literate Programming
23238 \begin_layout Standard
23239 From the Literate Programming FAQ:
23242 \begin_layout Quotation
23243 Literate programming is the combination of documentation and source together
23244 in a fashion suited for reading by human beings.
23245 In fact, literate programs should be enjoyable reading, even inviting!
23246 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23247 and documentation in a single file.
23248 Literate programming tools then parse the file to produce either readable
23249 documentation or compilable source.
23250 The WEB style of literate programming was created by D.
23251 \begin_inset space \thinspace{}
23255 Knuth during the development of his \SpecialChar TeX
23256 typesetting software.
23260 \begin_layout Standard
23261 Another excerpt says:
23264 \begin_layout Quotation
23267 How is literate programming different from verbose commenting?
23270 \begin_layout Quotation
23271 There are three distinguishing characteristics.
23272 In order of importance, they are:
23276 \begin_layout Itemize
23277 flexible order of elaboration
23280 \begin_layout Itemize
23281 automatic support for browsing
23284 \begin_layout Itemize
23285 typeset documentation, especially diagrams and mathematics
23289 \begin_layout Standard
23290 Now that I sparked your curiosity, take a look in the references.
23293 \begin_layout Subsubsection
23297 \begin_layout Standard
23298 The complete Literate Programming FAQ can be found at:
23301 \begin_layout Quote
23302 Literate Programming FAQ
23303 \begin_inset Flex URL
23306 \begin_layout Plain Layout
23308 http://www.literateprogramming.com/lpfaq.pdf
23316 \begin_layout Standard
23317 The FAQ lists 23 (twenty three!) different literate programming tools.
23318 Where some are specialized or
23319 \begin_inset Quotes eld
23323 \begin_inset Quotes erd
23326 for particular programming languages, while other have general scope.
23331 for my own use for several reasons:
23334 \begin_layout Itemize
23335 It can generate the documentation either in \SpecialChar LaTeX
23339 \begin_layout Itemize
23340 It has a open architecture, i.
23341 \begin_inset space \thinspace{}
23345 \begin_inset space \space{}
23348 it is easy to plug in new filters and to perform special processing that
23353 \begin_layout Itemize
23354 There is a good selection of filters available already (the HTML is one
23358 \begin_layout Itemize
23362 \begin_layout Standard
23363 The Noweb web page can be found at:
23366 \begin_layout Quote
23368 \begin_inset Flex URL
23371 \begin_layout Plain Layout
23373 http://www.cs.virginia.edu/~nr/noweb/
23381 \begin_layout Standard
23382 Starting from there you can reach many other interesting links and even
23383 some literate program examples.
23386 \begin_layout Subsection
23388 and Literate Programming with Noweb
23391 \begin_layout Standard
23392 The \SpecialChar LyX
23393 support for Literate Programming is provided by using the generic \SpecialChar LyX
23395 converters mechanism.
23396 This support is provided in a
23397 \begin_inset Quotes eld
23401 \begin_inset Quotes erd
23405 \begin_inset space \thinspace{}
23409 \begin_inset space \space{}
23412 you will be able to use this new \SpecialChar LyX
23413 feature with some other literate programming
23414 tool of your choice by just changing your \SpecialChar LyX
23418 \begin_layout Subsubsection
23419 Generating documents and code (weaving and tangling)
23422 \begin_layout Paragraph
23423 Using the noweb module
23426 \begin_layout Standard
23427 If you have installed Noweb and \SpecialChar LyX
23428 successfully, whenever you open a new document,
23429 after you have chosen its document class, use the Document->Settings menu
23431 \begin_inset Quotes eld
23435 \begin_inset Quotes erd
23439 If Noweb is correctly installed, when you click on the
23440 \begin_inset Quotes eld
23444 \begin_inset Quotes erd
23447 link, you will see the
23448 \begin_inset Quotes eld
23452 \begin_inset Quotes erd
23455 module in the available list and you can add it to your document.
23458 \begin_layout Paragraph
23462 \begin_layout Standard
23464 enables you to write code with a layout named
23465 \begin_inset Flex Noun
23468 \begin_layout Plain Layout
23475 Noweb delimits chunks like this:
23478 \begin_layout LyX-Code
23482 \begin_layout LyX-Code
23486 \begin_layout LyX-Code
23490 \begin_layout LyX-Code
23494 \begin_layout LyX-Code
23498 \begin_layout Standard
23499 The problem is that whatever is written in between the << and the
23503 must be taken literally, i.
23504 \begin_inset space \thinspace{}
23508 \begin_inset space \space{}
23512 should be prevented from making any special interpretation of what has
23514 This is also handled by
23515 \begin_inset Flex Noun
23518 \begin_layout Plain Layout
23524 , that works like a normal paragraph but has a free spacing capability.
23527 \begin_layout Standard
23528 As a special note, you can also use the
23529 \begin_inset Quotes eld
23533 \begin_inset Quotes erd
23536 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23540 \begin_layout LyX-Code
23544 \begin_layout LyX-Code
23545 def some_function(args):
23548 \begin_layout LyX-Code
23549 "This is the doc string for this function."
23552 \begin_layout LyX-Code
23553 print "My args: ", args
23556 \begin_layout LyX-Code
23557 @ %def some_function
23560 \begin_layout Standard
23561 For an example of this usage and the resulting cross-reference output, look
23562 at the Literate python program in
23564 LIBDIR/examples/listerrors.lyx
23566 which should make this all clear.
23569 \begin_layout Paragraph
23570 Generating the documentation
23573 \begin_layout Standard
23574 At this point you already have a new document file with a proper document
23575 class, and with some code and text on it.
23576 How do I print it? The answer is simple, you select
23578 View\SpecialChar menuseparator
23582 Just like you would do for a plain document.
23583 No special procedure is required.
23586 \begin_layout Standard
23587 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23591 \begin_layout Enumerate
23594 Update\SpecialChar menuseparator
23597 menu option is chosen, a \SpecialChar LaTeX
23603 \begin_layout Standard
23604 If the document is of any literate class the generated file will be named
23605 with an extension name defined by the
23606 \begin_inset Quotes eld
23610 \begin_inset Quotes erd
23613 format (defined in the Preferences panel), otherwise the file will have
23622 \begin_layout Enumerate
23623 Note that the only difference so far is in the name of the file, no special
23624 processing is required by \SpecialChar LyX
23626 Given that you formatted the code using the
23627 \begin_inset Flex Noun
23630 \begin_layout Plain Layout
23636 layout that, by itself, takes care of the business.
23639 \begin_layout Enumerate
23640 If the document is of any literate class \SpecialChar LyX
23641 will then use the internal \SpecialChar LyX
23643 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23648 \begin_layout Plain Layout
23649 The converters are defined in the
23651 Tools\SpecialChar menuseparator
23655 \begin_inset Quotes eld
23659 \begin_inset Quotes erd
23671 manual for general information about converters.
23676 to generate the \SpecialChar LaTeX
23681 \begin_layout Standard
23682 Otherwise it will just skip this step.
23686 \begin_layout Enumerate
23687 Finally, \SpecialChar LaTeX
23688 is invoked and the regular post processing continues as in a plain
23692 \begin_layout Standard
23693 Independence from a particular
23694 \begin_inset Quotes eld
23698 \begin_inset Quotes erd
23701 is easily achieved by changing the commands that are run by the various
23705 \begin_layout Paragraph
23706 Generating the code
23709 \begin_layout Standard
23710 When the build menu option is chosen or the corresponding button in the
23711 toolbar is pressed, a \SpecialChar LaTeX
23712 file is generated just like step 1 above.
23713 Next, \SpecialChar LyX
23719 This converter needs to be defined by the user and is not installed by
23720 default, though the Program format is.
23721 This converter (like any other converter) will have two parts:
23724 \begin_layout Enumerate
23725 The converter program itself.
23726 This program performs the conversion from the one format to the other (in
23727 this case, from the Noweb format to the Program pseudo-format).
23730 \begin_layout Enumerate
23731 The error log parser.
23732 This is a program whose sole purpose is to rewrite error messages in a
23733 format that \SpecialChar LyX
23735 This makes it possible for \SpecialChar LyX
23736 to place error boxes in the right places in
23740 \begin_layout Standard
23741 The first part, the
23742 \begin_inset Quotes eld
23746 \begin_inset Quotes erd
23749 setting, should be set to
23750 \begin_inset Newline newline
23754 \begin_inset Quotes eld
23762 \begin_inset Quotes erd
23766 \begin_inset Newline newline
23769 This basically means that \SpecialChar LyX
23771 \begin_inset Quotes eld
23775 \begin_inset Quotes erd
23778 (a program or script) with the name of the Noweb file (normally a file
23779 in the \SpecialChar LyX
23780 temp directory) and the directory path of the original \SpecialChar LyX
23785 \begin_layout Standard
23786 This is an implementation of
23787 \begin_inset Quotes eld
23791 \begin_inset Quotes erd
23794 that you can place in a directory on your path:
23797 \begin_layout Standard
23798 \begin_inset VSpace defskip
23804 \begin_layout Standard
23805 \begin_inset Newpage pagebreak
23811 \begin_layout Standard
23817 \begin_layout Standard
23823 \begin_layout Standard
23826 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23829 \begin_layout Standard
23830 \begin_inset VSpace defskip
23836 \begin_layout Standard
23837 The next part of the converter setting is the
23838 \begin_inset Quotes eld
23842 \begin_inset Quotes erd
23845 which is to be set to
23846 \begin_inset Newline newline
23850 \begin_inset Quotes eld
23855 parselog=$$s/scripts/listerrors
23858 \begin_inset Quotes erd
23862 \begin_inset Newline newline
23865 This will run any errors that are generated by the
23866 \begin_inset Quotes eld
23870 \begin_inset Quotes erd
23873 process through the
23874 \begin_inset Quotes eld
23878 \begin_inset Quotes erd
23884 \begin_layout Standard
23885 The build will normally take place in \SpecialChar LyX
23886 's temporary directory, so the files
23887 produced by the conversion will be in that directory.
23889 will copy out what it regards as the `main' file, but the
23893 conversion may produce several files, and so most of these would then be
23894 deleted when \SpecialChar LyX
23896 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23897 the build-script chunk can place the generated files in that location.
23900 \begin_layout Paragraph
23901 Build instructions in the document
23904 \begin_layout Standard
23905 The last piece of the integration between \SpecialChar LyX
23907 \begin_inset Quotes eld
23911 \begin_inset Quotes erd
23915 Generally, the instructions for building your program should be embedded
23916 in a chunk of its own.
23918 \begin_inset Quotes eld
23922 \begin_inset Quotes erd
23925 above uses the notangle command to look for this chunk (called
23926 \begin_inset Quotes eld
23930 \begin_inset Quotes erd
23933 ) and runs its contents through
23934 \begin_inset Quotes eld
23938 \begin_inset Quotes erd
23944 \begin_layout Standard
23945 Typically, such a chunk would look something like this:
23948 \begin_layout LyX-Code
23952 \begin_layout LyX-Code
23954 \begin_inset Newline newline
23957 if [ -z "${NOWEB_SOURCE}" ]
23958 \begin_inset Newline newline
23964 \begin_layout LyX-Code
23965 NOWEB_SOURCE=myfile.nw
23966 \begin_inset Newline newline
23970 \begin_inset Newline newline
23974 code to extract files ...
23975 use NOWEB_OUTPUT_DIR here ...]
23976 \begin_inset Newline newline
23980 code to compile files ...]
23981 \begin_inset Newline newline
23987 \begin_layout Standard
23990 LIBDIR/examples/listerrors.lyx
23994 LIBDIR/examples/Literate.lyx
23996 which implement two versions of the
23997 \begin_inset Quotes eld
24001 \begin_inset Quotes erd
24004 program for some illustrations of how all of these pieces go together or
24007 LIBDIR/examples/noweb2lyx.lyx.
24010 Interestingly, these three files show off the language-indepence of the
24012 literate programming support since they are written in Python, C and Perl
24016 \begin_layout Subsubsection
24017 Configuring \SpecialChar LyX
24021 \begin_layout Standard
24022 All the Literate Programming support is configured by the
24024 Tools\SpecialChar menuseparator
24028 \begin_inset Quotes eld
24032 \begin_inset Quotes erd
24036 The important parts are:
24039 \begin_layout Description
24041 \begin_inset space ~
24045 \begin_inset Quotes eld
24049 \begin_inset Quotes erd
24053 \begin_inset space ~
24056 format Set up via the File Formats tab, this is where the Noweb-specific
24066 , the file extension is set to
24071 This tells \SpecialChar LyX
24072 to create a file with a
24076 extension in the first step of the conversion process.
24079 \begin_layout Description
24081 \begin_inset space ~
24089 \begin_inset space ~
24092 format This is an empty format whose sole purpose is to be the endpoint
24093 of a conversion (which then allows us to set up a converter for it).
24096 \begin_layout Description
24106 This converter performs the
24107 \begin_inset Quotes eld
24111 \begin_inset Quotes erd
24114 of the literate document.
24115 For Noweb, it is set to
24116 \begin_inset Quotes eld
24121 noweave -delay -index $$i > $$o
24124 \begin_inset Quotes erd
24130 \begin_layout Description
24140 \begin_inset Quotes eld
24144 \begin_inset Quotes erd
24148 As stated above, the Converter is set to
24149 \begin_inset Quotes eld
24157 \begin_inset Quotes erd
24160 , with Flags set to
24161 \begin_inset Newline newline
24165 \begin_inset Quotes eld
24170 parselog=$$s/scripts/listerrors
24173 \begin_inset Quotes erd
24179 \begin_layout Subsubsection
24183 \begin_layout Standard
24184 There is also a new function implemented in the \SpecialChar LyX
24186 \begin_inset Quotes eld
24189 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24193 \begin_layout Standard
24194 When debugging code with ddd/gdb, it is possible to invoke a text editor
24195 at the current execution position with a single key stroke.
24196 The default ddd configuration for that is shift-ctrl-V.
24197 It happens that you can define the editor command line invocation in ddd
24200 Edit\SpecialChar menuseparator
24201 Preferences\SpecialChar menuseparator
24204 dialog and changing the "Edit Sources" entry.
24207 \begin_layout Standard
24208 I take advantage of the newly created \SpecialChar LyX
24209 server function and this ddd feature,
24211 \begin_inset Quotes eld
24215 \begin_inset Quotes erd
24221 \begin_layout Standard
24222 \begin_inset VSpace defskip
24228 \begin_layout Standard
24231 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24234 \begin_layout Standard
24235 \begin_inset VSpace defskip
24241 \begin_layout Standard
24242 With this, whenever you are using ddd and find a point in the program that
24243 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24244 ddd will forward this information to \SpecialChar LyX
24245 through the \SpecialChar LyX
24246 server and then the
24248 window will show the same file with the cursor at the same position ddd
24250 No more guessing or long scrolling to locate a point in the program back
24254 \begin_layout Standard
24255 Note however that you must enable the \SpecialChar LyX
24256 server to get this feature working
24257 (it is disabled by default).
24258 You can enable it in
24270 ) by entering in the
24276 \begin_inset Quotes eld
24281 /home/<your-home-directory>/.lyx/lyxpipe
24284 \begin_inset Quotes erd
24290 \begin_layout Standard
24291 Read the \SpecialChar LyX
24292 server documentation in the
24294 Customization Manual
24296 for further information.
24299 \begin_layout Subsubsection
24303 \begin_layout Standard
24304 There are six new buttons that can be added to your \SpecialChar LyX
24306 Five of these buttons are short cuts to layout styles:
24329 The last one is a short cut to the
24330 \begin_inset Quotes eld
24334 \begin_inset Quotes erd
24341 \begin_layout Standard
24343 has a range of buttons that are available for tool bar customization.
24344 In my toolbar I like to combine the six short cuts above with two more:
24349 \SpecialChar menuseparator
24354 \SpecialChar menuseparator
24361 Document\SpecialChar menuseparator
24362 View\SpecialChar menuseparator
24366 Here is how it looks like:
24369 \begin_layout LyX-Code
24373 \begin_layout LyX-Code
24377 \begin_layout LyX-Code
24378 Icon "layout Standard"
24381 \begin_layout LyX-Code
24382 Icon "layout Section"
24385 \begin_layout LyX-Code
24386 Icon "layout \SpecialChar LaTeX
24390 \begin_layout LyX-Code
24391 Icon "layout \SpecialChar LyX
24395 \begin_layout LyX-Code
24396 Icon "layout Chunk"
24399 \begin_layout LyX-Code
24403 \begin_layout LyX-Code
24407 \begin_layout LyX-Code
24408 Icon "buffer-typeset"
24411 \begin_layout LyX-Code
24412 Icon "build-program"
24415 \begin_layout LyX-Code
24419 \begin_layout LyX-Code
24423 \begin_layout LyX-Code
24427 \begin_layout LyX-Code
24431 \begin_layout LyX-Code
24435 \begin_layout Subsubsection
24436 Colors customization
24439 \begin_layout Standard
24440 There are a number of colors in \SpecialChar LyX
24441 that can be customized in
24446 One of the things that bothers people is the \SpecialChar LaTeX
24448 The default color is red, since the chunks uses \SpecialChar LaTeX
24449 font, and there is a lot
24450 of chunks in literate documents, you may get tired of seeing everything
24452 You can change it by going to the tabs
24461 \begin_layout Standard
24462 The next thing is the visible presence of the newline character in the screen.
24463 You can choose the color of this particular character and make it blend
24465 I recommend you choosing a color that is close to the background but not
24466 equal, that way you still can see it is there, but it is not bothering
24470 \begin_layout Subsection
24475 \begin_layout Standard
24484 is documented in the
24488 example file and in the Sweave manual (menu
24490 Help\SpecialChar menuseparator
24496 \begin_layout Chapter
24500 \begin_layout Standard
24501 You can do everything with \SpecialChar LyX
24502 that you can do with \SpecialChar LaTeX
24504 However, \SpecialChar LyX
24505 cannot support every \SpecialChar LaTeX
24507 But you can always use \SpecialChar TeX
24509 This chapter shows you some more special things you might want to use.
24510 For other special things you can do with figures, tables, floats, boxes
24511 and notes, have a look at the
24514 \begin_inset space ~
24522 \begin_layout Section
24523 Multiple Text Columns
24526 \begin_layout Standard
24527 This feature is independent of the option
24529 Two-column document
24531 in the document settings under
24536 If you want to have 2
24537 \begin_inset space ~
24540 columns for the whole document, it is recommended to use the
24542 Two-column document
24545 For all other cases use this feature.
24548 \begin_layout Standard
24549 To use multiple text columns in your document, you have to load the module
24556 Document\SpecialChar menuseparator
24557 Settings\SpecialChar menuseparator
24560 ) and must have the \SpecialChar LaTeX
24568 \begin_layout Standard
24569 Footnotes within multiple columns will be placed at the bottom of the page
24570 and not under each column.
24571 Within the different columns you can use everything, with the limitation
24572 that for floats you need to use the float option
24579 \begin_layout Subsection
24583 \begin_layout Standard
24584 If you want to have 2
24585 \begin_inset space ~
24588 columns in your text, insert a multicolumn inset via the menu
24590 Insert\SpecialChar menuseparator
24592 \begin_inset space ~
24595 Insets\SpecialChar menuseparator
24597 \begin_inset space ~
24602 where the columns should start.
24603 Write all text that should be printed in 2
24604 \begin_inset space ~
24607 columns into this inset.
24610 \begin_layout Standard
24611 Here is an example:
24614 \begin_layout Standard
24616 \begin_inset Flex Multiple Columns
24619 \begin_layout Plain Layout
24624 The Adventure of the Empty House
24627 \begin_inset Newline newline
24630 by Sir Arthur Conan Doyle
24633 \begin_layout Plain Layout
24636 It was in the spring of the year 1894 that all London was interested, and
24637 the fashionable world dismayed, by the murder of the Honourable Ronald
24638 Adair under most unusual and inexplicable circumstances.
24639 The public has already learned those particulars of the crime which came
24640 out in the police investigation, but a good deal was suppressed upon that
24641 occasion, since the case for the prosecution was so overwhelmingly strong
24642 that it was not necessary to bring forward all the facts.
24643 Only now, at the end of nearly ten years, am I allowed to supply those
24644 missing links which make up the whole of that remarkable chain.
24645 The crime was of interest in itself, but that interest was as nothing to
24646 me compared to the inconceivable sequel, which afforded me the greatest
24647 shock and surprise of any event in my adventurous life.
24648 Even now, after this long interval, I find myself thrilling as I think
24649 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24650 ty which utterly submerged my mind.
24651 Let me say to that public, which has shown some interest in those glimpses
24652 which I have occasionally given them of the thoughts and actions of a very
24653 remarkable man, that they are not to blame me if I have not shared my knowledge
24654 with them, for I should have considered it my first duty to do so, had
24655 I not been barred by a positive prohibition from his own lips, which was
24656 only withdrawn upon the third of last month.
24664 \begin_layout Standard
24665 To get 3 or more columns, set the cursor into the multicolumn inset and
24668 Insert\SpecialChar menuseparator
24670 \begin_inset space ~
24674 \begin_inset space ~
24680 The number of the desired columns is written into that inset (for 3
24681 \begin_inset space ~
24685 \begin_inset Quotes eld
24689 \begin_inset Quotes erd
24693 \begin_inset Newline newline
24696 Here is an example with 3
24697 \begin_inset space ~
24703 \begin_layout Standard
24704 \begin_inset Flex Multiple Columns
24707 \begin_layout Plain Layout
24710 \begin_inset Argument 1
24713 \begin_layout Plain Layout
24719 It can be imagined that my close intimacy with Sherlock Holmes had interested
24720 me deeply in crime, and that after his disappearance I never failed to
24721 read with care the various problems which came before the public.
24722 And I even attempted, more than once, for my own private satisfaction,
24723 to employ his methods in their solution, though with indifferent success.
24724 There was none, however, which appealed to me like this tragedy of Ronald
24726 As I read the evidence at the inquest, which led up to a verdict of willful
24727 murder against some person or persons unknown, I realized more clearly
24728 than I had ever done the loss which the community had sustained by the
24729 death of Sherlock Holmes.
24730 There were points about this strange business which would, I was sure,
24731 have specially appealed to him, and the efforts of the police would have
24732 been supplemented, or more probably anticipated, by the trained observation
24733 and the alert mind of the first criminal agent in Europe.
24734 All day, as I drove upon my round, I turned over the case in my mind and
24735 found no explanation which appeared to me to be adequate.
24736 At the risk of telling a twice-told tale, I will recapitulate the facts
24737 as they were known to the public at the conclusion of the inquest.
24745 \begin_layout Standard
24746 You can have up to 10
24747 \begin_inset space ~
24750 columns if you want to, but that might not be very pleasant for the readers
24754 \begin_layout Standard
24755 \begin_inset Newpage newpage
24761 \begin_layout Subsection
24762 Columns inside Columns
24765 \begin_layout Standard
24766 You can also have columns inside columns:
24769 \begin_layout Standard
24770 \begin_inset Flex Multiple Columns
24773 \begin_layout Plain Layout
24776 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24777 at that time governor of one of the Australian colonies.
24778 Adair's mother had returned from Australia to undergo the operation for
24779 cataract, and she, her son Ronald, and her daughter Hilda were living together
24783 \begin_layout Plain Layout
24784 \begin_inset Flex Multiple Columns
24787 \begin_layout Plain Layout
24790 The youth moved in the best society–had, so far as was known, no enemies
24791 and no particular vices.
24792 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24793 had been broken off by mutual consent some months before, and there was
24794 no sign that it had left any very profound feeling behind it.
24795 For the rest {sic} the man's life moved in a narrow and conventional circle,
24796 for his habits were quiet and his nature unemotional.
24797 Yet it was upon this easy-going young aristocrat that death came, in most
24798 strange and unexpected form, between the hours of ten and eleven-twenty
24799 on the night of March 30, 1894.
24807 \begin_layout Plain Layout
24810 Ronald Adair was fond of cards–playing continually, but never for such stakes
24812 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24813 It was shown that, after dinner on the day of his death, he had played
24814 a rubber of whist at the latter club.
24815 He had also played there in the afternoon.
24820 The evidence of those who had played with him– Mr.
24821 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24822 and that there was a fairly equal fall of the cards.
24823 Adair might have lost five pounds, but not more.
24824 His fortune was a considerable one, and such a loss could not in any way
24826 He had played nearly every day at one club or other, but he was a cautious
24827 player, and usually rose a winner.
24828 It came out in evidence that, in partnership with Colonel Moran, he had
24829 actually won as much as four hundred and twenty pounds in a sitting, some
24830 weeks before, from Godfrey Milner and Lord Balmoral.
24831 So much for his recent history as it came out at the inquest.
24839 \begin_layout Subsection
24843 \begin_layout Standard
24844 The examples in this section show some more special features of multiple
24848 \begin_layout Standard
24849 For more features of multiple columns, have a look at the documentation
24850 of the \SpecialChar LaTeX
24856 \begin_inset CommandInset citation
24866 \begin_layout Subsubsection
24870 \begin_layout Standard
24871 To add a preface text for multiple columns, set the cursor into the multicolumn
24872 inset and use the menu
24874 Insert\SpecialChar menuseparator
24878 Write your preface text into that inset.
24879 \begin_inset Newline newline
24882 This is an example with some preface text:
24885 \begin_layout Standard
24886 \begin_inset VSpace bigskip
24892 \begin_layout Standard
24893 \begin_inset Flex Multiple Columns
24896 \begin_layout Plain Layout
24897 \begin_inset Argument 2
24900 \begin_layout Plain Layout
24901 And the story continues and continues and continues and continues\SpecialChar ldots
24909 On the evening of the crime, he returned from the club exactly at ten.
24910 His mother and sister were out spending the evening with a relation.
24911 The servant deposed that she heard him enter the front room on the second
24912 floor, generally used as his sitting-room.
24913 She had lit a fire there, and as it smoked she had opened the window.
24914 No sound was heard from the room until eleven-twenty, the hour of the return
24915 of Lady Maynooth and her daughter.
24916 Desiring to say good-night, she attempted to enter her son's room.
24917 The door was locked on the inside, and no answer could be got to their
24918 cries and knocking.
24919 Help was obtained, and the door forced.
24920 The unfortunate young man was found lying near the table.
24921 His head had been horribly mutilated by an expanding revolver bullet, but
24922 no weapon of any sort was to be found in the room.
24930 \begin_layout Standard
24931 You can also use a section heading as the preface if you use a section command
24932 as \SpecialChar TeX
24934 For example the command
24937 \begin_layout Standard
24942 subsection{subsection title}
24945 \begin_layout Standard
24946 creates a subsection.
24947 In this example the preface is a subsubsection:
24950 \begin_layout Standard
24951 \begin_inset Flex Multiple Columns
24954 \begin_layout Plain Layout
24955 \begin_inset Argument 2
24958 \begin_layout Plain Layout
24962 \begin_layout Plain Layout
24971 This is a subsubsection heading as a preface
24975 \begin_layout Plain Layout
24989 A minute examination of the circumstances served only to make the case more
24991 In the first place, no reason could be given why the young man should have
24992 fastened the door upon the inside.
24993 There was the possibility that the murderer had done this, and had afterwards
24994 escaped by the window.
24995 The drop was at least twenty feet, however, and a bed of crocuses in full
24997 Neither the flowers nor the earth showed any sign of having been disturbed,
24998 nor were there any marks upon the narrow strip of grass which separated
24999 the house from the road.
25000 Apparently, therefore, it was the young man himself who had fastened the
25002 But how did he come by his death? No one could have climbed up to the window
25003 without leaving traces.
25004 Suppose a man had fired through the window, he would indeed be a remarkable
25005 shot who could with a revolver inflict so deadly a wound.
25006 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
25007 a hundred yards of the house.
25008 No one had heard a shot.
25016 \begin_layout Standard
25017 If there is less vertical space than 6
25018 \begin_inset space ~
25021 text lines is left on the page at the beginning of the multiple columns,
25022 a page break will be inserted before the multiple columns.
25023 Depending on the number of lines of the preface text, you might want to
25025 This is done by setting the cursor into the mulitcolumn inset behind the
25026 preface (if there is any) and using the menu
25028 Insert\SpecialChar menuseparator
25030 \begin_inset space ~
25034 \begin_inset space ~
25038 \begin_inset space ~
25044 Insert into that inset the amount of space like e.
25045 \begin_inset space \thinspace{}
25049 \begin_inset space \space{}
25053 \begin_inset Quotes eld
25057 \begin_inset Quotes erd
25061 \begin_inset Newline newline
25064 In this example the space is set to 7
25065 \begin_inset space ~
25068 text lines by using
25069 \begin_inset Quotes eld
25075 \begin_inset Quotes erd
25084 needs to be inserted as \SpecialChar TeX
25088 \begin_layout Standard
25089 \begin_inset Flex Multiple Columns
25092 \begin_layout Plain Layout
25093 \begin_inset Argument 3
25096 \begin_layout Plain Layout
25101 \begin_layout Plain Layout
25117 On the evening of the crime, he returned from the club exactly at ten.
25118 His mother and sister were out spending the evening with a relation.
25119 The servant deposed that she heard him enter the front room on the second
25120 floor, generally used as his sitting-room.
25121 She had lit a fire there, and as it smoked she had opened the window.
25122 No sound was heard from the room until eleven-twenty, the hour of the return
25123 of Lady Maynooth and her daughter.
25124 Desiring to say good-night, she attempted to enter her son's room.
25125 The door was locked on the inside, and no answer could be got to their
25126 cries and knocking.
25127 Help was obtained, and the door forced.
25128 The unfortunate young man was found lying near the table.
25129 His head had been horribly mutilated by an expanding revolver bullet, but
25130 no weapon of any sort was to be found in the room.
25138 \begin_layout Subsubsection
25142 \begin_layout Standard
25143 The amount of space before and after multiple columns can be changed by
25144 changing the length
25151 For example the command
25154 \begin_layout Standard
25164 \begin_layout Standard
25165 in \SpecialChar TeX
25166 Code changes its value to 3
25167 \begin_inset space \thinspace{}
25171 The change must be made before the multiple columns' start.
25172 The predefined value is 13
25173 \begin_inset space \thinspace{}
25179 \begin_layout Standard
25187 \begin_inset space \thinspace{}
25193 \begin_layout Standard
25197 \begin_layout Plain Layout
25203 multicolsep}{2.5cm}
25211 \begin_layout Standard
25212 \begin_inset Flex Multiple Columns
25215 \begin_layout Plain Layout
25218 All day I turned these facts over in my mind, endeavouring to hit upon some
25219 theory which could reconcile them all, and to find that line of least resistanc
25220 e which my poor friend had declared to be the starting-point of every investigat
25222 I confess that I made little progress.
25223 In the evening I strolled across the Park, and found myself about six o'clock
25224 at the Oxford Street end of Park Lane.
25225 A group of loafers upon the pavements, all staring up at a particular window,
25226 directed me to the house which I had come to see.
25227 A tall, thin man with coloured glasses, whom I strongly suspected of being
25228 a plain-clothes detective, was pointing out some theory of his own, while
25229 the others crowded round to listen to what he said.
25230 I got as near him as I could, but his observations seemed to me to be absurd,
25231 so I withdrew again in some disgust.
25232 As I did so I struck against an elderly, deformed man, who had been behind
25233 me, and I knocked down several books which he was carrying.
25241 \begin_layout Standard
25242 \begin_inset Note Greyedout
25245 \begin_layout Plain Layout
25250 The values you set with
25256 will be used for all following multiple columns until you change them again.
25264 \begin_layout Standard
25268 \begin_layout Plain Layout
25280 \begin_inset Note Note
25283 \begin_layout Plain Layout
25284 go back to the default
25292 \begin_layout Standard
25293 \begin_inset Newpage newpage
25299 \begin_layout Subsubsection
25303 \begin_layout Standard
25304 A column break can be forced by inserting the command
25310 as \SpecialChar TeX
25311 Code to that position in the text where the column should be broken.
25312 Note that this leads in most cases to whitespace in the text.
25313 \begin_inset Newline newline
25316 Here is an example:
25319 \begin_layout Standard
25320 \begin_inset Flex Multiple Columns
25323 \begin_layout Plain Layout
25326 \begin_inset Quotes eld
25329 You're surprised to see me, sir,
25330 \begin_inset Quotes erd
25333 said he, in a strange, croaking voice.
25336 \begin_layout Plain Layout
25339 I acknowledged that I was.
25342 \begin_layout Plain Layout
25345 \begin_inset Quotes eld
25348 Well, I've a conscience, sir, and when I chanced to see you go into this
25349 house, as I came hobbling after you, I thought to myself, I'll just step
25350 in and see that kind gentleman, and tell him that if I was a bit gruff
25351 in my manner there was not any harm meant, and that I am much obliged to
25352 him for picking up my books.
25353 \begin_inset Quotes erd
25359 \begin_layout Plain Layout
25362 \begin_inset Quotes eld
25365 You make too much of a trifle,
25366 \begin_inset Quotes erd
25371 \begin_inset Quotes eld
25374 May I ask how you knew who I was?
25375 \begin_inset Quotes erd
25378 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25382 \begin_layout Plain Layout
25394 \begin_layout Plain Layout
25397 \begin_inset Quotes eld
25400 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25401 you'll find my little bookshop at the corner of Church Street, and very
25402 happy to see you, I am sure.
25403 Maybe you collect yourself, sir.
25407 \begin_inset space ~
25420 –a bargain, every one of them.
25421 With five volumes you could just fill that gap on that second shelf.
25422 It looks untidy, does it not, sir?
25423 \begin_inset Quotes erd
25434 \begin_layout Subsubsection
25438 \begin_layout Standard
25439 The width of the columns is automatically calculated, but you can modify
25440 the space between the columns.
25441 This is done by changing the length
25448 Its predefined value is 10
25449 \begin_inset space \thinspace{}
25453 Here is an example where
25460 \begin_inset space \thinspace{}
25466 \begin_layout Standard
25470 \begin_layout Plain Layout
25484 \begin_layout Standard
25485 \begin_inset Flex Multiple Columns
25488 \begin_layout Plain Layout
25491 My observations of No.
25492 \begin_inset space \space{}
25495 427 Park Lane did little to clear up the problem in which I was interested.
25496 The house was separated from the street by a low wall and railing, the
25497 whole not more than five feet high.
25498 It was perfectly easy, therefore, for anyone to get into the garden, but
25499 the window was entirely inaccessible, since there was no water pipe or
25500 anything which could help the most active man to climb it.
25501 More puzzled than ever, I retraced my steps to Kensington.
25502 I had not been in my study five minutes when the maid entered to say that
25503 a person desired to see me.
25504 To my astonishment it was none other than my strange old book collector,
25505 his sharp, wizened face peering out from a frame of white hair, and his
25506 precious volumes, a dozen of them at least, wedged under his right arm.
25514 \begin_layout Standard
25518 \begin_layout Plain Layout
25530 \begin_inset Note Note
25533 \begin_layout Plain Layout
25534 go back to the default
25542 \begin_layout Subsubsection
25546 \begin_layout Standard
25547 Between the columns a rule with a width of the length
25554 If this rule width is set to 0
25555 \begin_inset space \thinspace{}
25558 pt (this is the default), the rule is suppressed.
25559 In the following example the rule is 2
25560 \begin_inset space \thinspace{}
25566 \begin_layout Standard
25570 \begin_layout Plain Layout
25576 columnseprule}{2pt}
25584 \begin_layout Standard
25585 \begin_inset Flex Multiple Columns
25588 \begin_layout Plain Layout
25591 \begin_inset Quotes eld
25594 You're surprised to see me, sir,
25595 \begin_inset Quotes erd
25598 said he, in a strange, croaking voice.
25601 \begin_layout Plain Layout
25604 I acknowledged that I was.
25607 \begin_layout Plain Layout
25610 \begin_inset Quotes eld
25613 Well, I've a conscience, sir, and when I chanced to see you go into this
25614 house, as I came hobbling after you, I thought to myself, I'll just step
25615 in and see that kind gentleman, and tell him that if I was a bit gruff
25616 in my manner there was not any harm meant, and that I am much obliged to
25617 him for picking up my books.
25618 \begin_inset Quotes erd
25624 \begin_layout Plain Layout
25627 \begin_inset Quotes eld
25630 You make too much of a trifle,
25631 \begin_inset Quotes erd
25636 \begin_inset Quotes eld
25639 May I ask how you knew who I was?
25640 \begin_inset Quotes erd
25646 \begin_layout Plain Layout
25649 \begin_inset Quotes eld
25652 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25653 you'll find my little bookshop at the corner of Church Street, and very
25654 happy to see you, I am sure.
25655 Maybe you collect yourself, sir.
25659 \begin_inset space ~
25672 –a bargain, every one of them.
25673 With five volumes you could just fill that gap on that second shelf.
25674 It looks untidy, does it not, sir?
25675 \begin_inset Quotes erd
25686 \begin_layout Standard
25687 \begin_inset VSpace defskip
25693 \begin_layout Standard
25694 The rule can be colored by redefining the command
25701 This is done by inserting the command
25702 \begin_inset Newline newline
25711 columnseprulecolor}{
25716 \begin_inset Newline newline
25719 as \SpecialChar TeX
25720 Code before the multicolumn inset.
25725 in this command by a color of your choice.
25726 You can use all pre- and self-defined colors.
25734 \begin_inset space ~
25739 for more information about pre- and self-defined colors.
25740 To go back to the default color insert the command
25741 \begin_inset Newline newline
25750 columnseprulecolor}{
25755 \begin_inset Newline newline
25758 Here is the example with a cyan rule and 1
25759 \begin_inset space \thinspace{}
25762 cm column separation:
25765 \begin_layout Standard
25769 \begin_layout Plain Layout
25778 \begin_layout Plain Layout
25784 columnseprulecolor}{
25794 \begin_layout Standard
25795 \begin_inset Flex Multiple Columns
25798 \begin_layout Plain Layout
25801 \begin_inset Quotes eld
25804 You're surprised to see me, sir,
25805 \begin_inset Quotes erd
25808 said he, in a strange, croaking voice.
25811 \begin_layout Plain Layout
25814 I acknowledged that I was.
25817 \begin_layout Plain Layout
25820 \begin_inset Quotes eld
25823 Well, I've a conscience, sir, and when I chanced to see you go into this
25824 house, as I came hobbling after you, I thought to myself, I'll just step
25825 in and see that kind gentleman, and tell him that if I was a bit gruff
25826 in my manner there was not any harm meant, and that I am much obliged to
25827 him for picking up my books.
25828 \begin_inset Quotes erd
25834 \begin_layout Plain Layout
25837 \begin_inset Quotes eld
25840 You make too much of a trifle,
25841 \begin_inset Quotes erd
25846 \begin_inset Quotes eld
25849 May I ask how you knew who I was?
25850 \begin_inset Quotes erd
25856 \begin_layout Plain Layout
25859 \begin_inset Quotes eld
25862 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25863 you'll find my little bookshop at the corner of Church Street, and very
25864 happy to see you, I am sure.
25865 Maybe you collect yourself, sir.
25869 \begin_inset space ~
25882 –a bargain, every one of them.
25883 With five volumes you could just fill that gap on that second shelf.
25884 It looks untidy, does it not, sir?
25885 \begin_inset Quotes erd
25896 \begin_layout Standard
25900 \begin_layout Plain Layout
25906 columnseprule}{0pt}
25909 \begin_layout Plain Layout
25915 columnseprulecolor}{
25923 \begin_inset Note Note
25926 \begin_layout Plain Layout
25927 go back to the default
25935 \begin_layout Section
25936 Non-standard Paragraph Shapes
25939 \begin_layout Standard
25942 as well as any other text processor uses by default rectangular paragraphs.
25943 For special cases like for example posters, invitation cards or poems you
25944 can modify the paragraph shape to one of your choice.
25945 This can be done by using the \SpecialChar LaTeX
25950 which is loaded by using in the document settings the module
25952 Custom paragraph shapes
25957 \begin_layout Subsection
25961 \begin_layout Standard
25966 provides the following shapes:
25969 \begin_layout Standard
25970 \begin_inset Tabular
25971 <lyxtabular version="3" rows="13" columns="3">
25972 <features booktabs="true" islongtable="true" longtabularalignment="center">
25973 <column alignment="center" valignment="middle" width="16col%">
25974 <column alignment="center" valignment="middle" width="40col%">
25975 <column alignment="center" valignment="middle" width="35col%">
25976 <row endhead="true">
25977 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25980 \begin_layout Plain Layout
25986 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25989 \begin_layout Plain Layout
25995 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25998 \begin_layout Plain Layout
26006 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26009 \begin_layout Plain Layout
26015 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26018 \begin_layout Plain Layout
26019 Circle with circular hole (in the size of a CD/DVD)
26024 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26027 \begin_layout Plain Layout
26028 Cannot be scaled, take care there is not too much text
26035 <cell alignment="center" valignment="top" topline="true" usebox="none">
26038 \begin_layout Plain Layout
26044 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26047 \begin_layout Plain Layout
26053 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26056 \begin_layout Plain Layout
26057 Fragile, calculation might fail
26064 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26067 \begin_layout Plain Layout
26073 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26076 \begin_layout Plain Layout
26077 Rhomboid (symbolizing a
26078 \begin_inset Quotes eld
26082 \begin_inset Quotes erd
26090 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26093 \begin_layout Plain Layout
26101 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26104 \begin_layout Plain Layout
26110 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26113 \begin_layout Plain Layout
26119 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26122 \begin_layout Plain Layout
26130 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26133 \begin_layout Plain Layout
26139 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26142 \begin_layout Plain Layout
26148 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26151 \begin_layout Plain Layout
26159 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26162 \begin_layout Plain Layout
26168 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26171 \begin_layout Plain Layout
26172 Nut for bolt (hexagon with circular hole)
26177 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26180 \begin_layout Plain Layout
26188 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26191 \begin_layout Plain Layout
26197 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26200 \begin_layout Plain Layout
26206 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26209 \begin_layout Plain Layout
26217 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26220 \begin_layout Plain Layout
26226 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26229 \begin_layout Plain Layout
26235 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26238 \begin_layout Plain Layout
26246 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26249 \begin_layout Plain Layout
26255 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26258 \begin_layout Plain Layout
26264 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26267 \begin_layout Plain Layout
26275 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26278 \begin_layout Plain Layout
26284 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26287 \begin_layout Plain Layout
26288 Normal/reversed rain drop
26293 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26296 \begin_layout Plain Layout
26297 Fragile, calculation might fail
26304 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26307 \begin_layout Plain Layout
26314 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26317 \begin_layout Plain Layout
26318 The \SpecialChar TeX
26324 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26327 \begin_layout Plain Layout
26335 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26338 \begin_layout Plain Layout
26340 \begin_inset Newline newline
26348 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26351 \begin_layout Plain Layout
26352 Triangles in different orientations
26357 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26360 \begin_layout Plain Layout
26374 \begin_layout Standard
26375 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26377 for environments in the toolbar.
26380 \begin_layout Standard
26381 \begin_inset Newpage newpage
26387 \begin_layout Standard
26388 Here is an example paragraph in the shape of a nut:
26391 \begin_layout Standard
26392 \begin_inset VSpace bigskip
26401 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26402 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26404 At vero eos et accusam et justo duo dolores et ea rebum.
26405 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26407 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26408 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26412 \begin_layout Standard
26413 \begin_inset VSpace bigskip
26419 \begin_layout Standard
26420 \begin_inset Note Greyedout
26423 \begin_layout Plain Layout
26428 : shapepar paragraphs cannot run over a page break.
26436 \begin_layout Standard
26437 \begin_inset VSpace bigskip
26443 \begin_layout Standard
26448 takes care that the shape will always be preserved, no matter how much
26449 text is in the paragraph.
26450 Therefore the paragraph size changes with the amount of contained text.
26451 This can lead to paragraph sizes exceeding the page margins.
26452 To demonstrate the size scaling, here is the same example paragraph but
26453 with twice as much text:
26456 \begin_layout Standard
26457 \begin_inset Newpage newpage
26466 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26467 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26469 At vero eos et accusam et justo duo dolores et ea rebum.
26470 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26472 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26473 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26475 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26476 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26478 At vero eos et accusam et justo duo dolores et ea rebum.
26479 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26481 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26482 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26486 \begin_layout Standard
26487 \begin_inset VSpace bigskip
26493 \begin_layout Standard
26494 An exception is the shape
26499 It cannot be scaled because it must fit the size of a CD/DVD.
26500 Therefore the amount of text that fits into the shape is limited.
26501 \begin_inset Newline newline
26512 shape are fragile, meaning that the calculation of their size can fail,
26513 depending on the amount of text.
26514 You will then get the \SpecialChar LaTeX
26516 \begin_inset Quotes eld
26519 Arithmetic overflow
26520 \begin_inset Quotes erd
26524 In this case one can try to remove or add some text; if nothing works one
26525 has to use another shape.
26528 \begin_layout Standard
26529 \begin_inset VSpace bigskip
26535 \begin_layout Standard
26536 For shapes with tips you will maybe see that \SpecialChar LaTeX
26537 's hyphenation routine fails
26538 for text in the tips.
26539 Therefore it is often necessary to add hyphenation points
26544 arg "specialchar-insert hyphenation"
26549 ) to the corresponding text parts.
26552 \begin_layout Standard
26553 \begin_inset VSpace bigskip
26559 \begin_layout Standard
26560 Shapepar paragraphs are either always centered or placed on the page so
26561 that their left border touches the left page margin.
26562 You can therefore not use the paragraph dialog to align such paragraphs.
26563 A solution is to put the paragraph into a minipage or parbox and align
26565 The problem is hereby to find the right width for the box.
26566 Because if it is too wide and you center the box, the paragraph is not
26567 centered too because it sticks at the left side of the box.
26568 So you might have to play a bit with the width until it fits.
26569 Here are two heart-shaped paragraphs, the first one is not aligned, the
26570 second one is right-aligned:
26573 \begin_layout Standard
26574 \begin_inset Newpage newpage
26580 \begin_layout Heart
26584 Lo\SpecialChar softhyphen
26585 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26586 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26588 At vero eos et accusam et justo duo dolores et ea rebum.
26589 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26593 \begin_layout Standard
26594 \begin_inset VSpace bigskip
26600 \begin_layout Standard
26603 \begin_inset Box Frameless
26613 height_special "totalheight"
26618 backgroundcolor "none"
26621 \begin_layout Heart
26625 Lo\SpecialChar softhyphen
26626 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26627 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26629 At vero eos et accusam et justo duo dolores et ea rebum.
26630 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26639 \begin_layout Subsection
26643 \begin_layout Standard
26644 You can define any shape you want.
26645 Doing this manually is a lot of work because every coordinate must be specified.
26646 But there is a way to let the computer calculate the coordinates:
26649 \begin_layout Enumerate
26650 Install the program
26651 \begin_inset CommandInset href
26654 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26662 \begin_layout Enumerate
26669 TeX/LaTeX\SpecialChar menuseparator
26670 Settings\SpecialChar menuseparator
26673 and select the font size you are using in your document.
26674 For example this document uses the size 12
26675 \begin_inset space \thinspace{}
26681 \begin_layout Enumerate
26685 \begin_layout Enumerate
26688 TeX/LaTeX\SpecialChar menuseparator
26691 to export the shape to coordinates.
26692 In the appearing dialog use either the outline of your shape for the coordinate
26693 s or the path itself.
26697 \begin_layout Plain Layout
26698 For more information see
26699 \begin_inset CommandInset href
26701 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26714 \begin_layout Standard
26715 The coordinates are written into a \SpecialChar TeX
26717 To use it for your \SpecialChar LyX
26721 \begin_layout Enumerate
26722 Place the cursor before the first character of your paragraph (or into a
26726 \begin_layout Enumerate
26727 Open in \SpecialChar LyX
26730 Insert\SpecialChar menuseparator
26731 File\SpecialChar menuseparator
26733 \begin_inset space ~
26738 , select the file and use
26747 \begin_layout Standard
26748 \begin_inset VSpace defskip
26754 \begin_layout Standard
26755 \begin_inset Note Greyedout
26758 \begin_layout Plain Layout
26763 : The changed shape only applies to the current paragraph; everything is
26764 reset to normal for the next paragraph.
26765 Therefore the shape definition file must be input into every paragraph
26766 with the desired shape.
26774 \begin_layout Standard
26775 \begin_inset VSpace bigskip
26781 \begin_layout Standard
26782 Here is an example:
26785 \begin_layout Standard
26786 \begin_inset VSpace bigskip
26792 \begin_layout Standard
26793 \begin_inset CommandInset include
26795 filename "SpecialParagraphShape.tex"
26801 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26802 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26804 At vero eos et accusam et justo duo dolores et ea rebum.
26805 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26807 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26808 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26812 \begin_layout Standard
26813 \begin_inset VSpace bigskip
26819 \begin_layout Standard
26824 to draw complexer shapes in
26828 you can draw the shape in a program of your choice and import the resulting
26834 Then you only need to draw a line or spline along the outline of the image.
26837 \begin_layout Standard
26838 \begin_inset VSpace bigskip
26844 \begin_layout Standard
26847 Custom paragraph shapes
26849 also provides the two commands
26857 which can be used to define custom shapes coordinate by coordinate.
26861 \begin_layout Plain Layout
26862 These commands are internally used for all shapes described here.
26867 For information how these styles are used and about further customization
26868 possibilities, have a look at the documentation of the package
26873 \begin_inset CommandInset citation
26883 \begin_layout Bibliography
26884 \begin_inset CommandInset bibitem
26885 LatexCommand bibitem
26891 Documentation of the \SpecialChar LaTeX
26893 \begin_inset CommandInset href
26896 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26904 \begin_layout Bibliography
26905 \begin_inset CommandInset bibitem
26906 LatexCommand bibitem
26912 Documentation of the \SpecialChar LaTeX
26914 \begin_inset CommandInset href
26917 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"