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:%
7491 \change_inserted -712698321 1500896526
7503 \begin_inset Newline newline
7517 \begin_layout Standard
7518 Make sure that the \SpecialChar LyX
7519 Server pipe path you specified in \SpecialChar LyX
7521 \begin_inset Flex Code
7524 \begin_layout Plain Layout
7538 , otherwise change the
7539 \begin_inset Flex Code
7542 \begin_layout Plain Layout
7548 wrapper accordingly.
7551 \begin_layout Standard
7552 In yap, reverse search is triggered by double-click.
7555 \begin_layout Subsubsection*
7556 SumatraPDF (Windows)
7559 \begin_layout Standard
7560 In order to use SumatraPDF for inverse search, enter
7561 \begin_inset Flex Code
7564 \begin_layout Plain Layout
7565 SumatraPDF -inverse-search "lyxeditor.bat
7566 \change_inserted -712698321 1500887423
7570 \change_inserted -712698321 1500887424
7578 in the viewer setting in
7579 \begin_inset Flex Noun
7582 \begin_layout Plain Layout
7583 Preferences\SpecialChar menuseparator
7584 File Handling\SpecialChar menuseparator
7585 File formats\SpecialChar menuseparator
7592 \begin_inset Flex Code
7595 \begin_layout Plain Layout
7601 is the previous wrapper.
7602 If SumatraPDF.exe is not in your command PATH, use its full file name.
7605 \begin_layout Standard
7606 Reverse search is triggered by double-click.
7609 \begin_layout Subsubsection*
7613 \begin_layout Standard
7614 First of all, make sure that yap is your default DVI viewer in the Windows
7615 environment, then launch it, choose its
7616 \begin_inset Flex Noun
7619 \begin_layout Plain Layout
7620 View\SpecialChar menuseparator
7627 \begin_inset Quotes eld
7631 \begin_inset Quotes erd
7636 \begin_inset Quotes eld
7639 New\SpecialChar ldots
7641 \begin_inset Quotes erd
7644 button and, in the window that opens, enter
7645 \begin_inset Quotes eld
7650 \begin_inset Quotes erd
7653 (or any other name you like) in the
7654 \begin_inset Quotes eld
7658 \begin_inset Quotes erd
7662 Now click on the button labeled
7663 \begin_inset Quotes eld
7668 \begin_inset Quotes erd
7671 to open a file dialog and navigate to the directory containing the
7672 \begin_inset Flex Code
7675 \begin_layout Plain Layout
7681 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7684 \begin_inset Flex Code
7687 \begin_layout Plain Layout
7693 and then specify the program arguments as
7694 \begin_inset Flex Code
7697 \begin_layout Plain Layout
7704 In this way, you will be using the
7708 for communicating with \SpecialChar LyX
7710 If, for whatever reason, you want to use the
7715 \begin_inset Flex Code
7718 \begin_layout Plain Layout
7724 option and be sure to specify the \SpecialChar LyX
7725 Server pipe path in the \SpecialChar LyX
7729 \begin_layout Standard
7730 In yap, reverse search is triggered by double-click.
7733 \begin_layout Subsubsection*
7737 \begin_layout Standard
7738 In order to use SumatraPDF for inverse search, enter
7739 \begin_inset Flex Code
7742 \begin_layout Plain Layout
7743 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7748 in the viewer setting in
7749 \begin_inset Flex Noun
7752 \begin_layout Plain Layout
7753 Preferences\SpecialChar menuseparator
7754 File Handling\SpecialChar menuseparator
7755 File formats\SpecialChar menuseparator
7762 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7764 \begin_inset Flex Code
7767 \begin_layout Plain Layout
7773 enables communication via the
7779 \begin_inset Flex Code
7782 \begin_layout Plain Layout
7788 option if you want to use the
7792 , and be sure to specify the \SpecialChar LyX
7793 Server pipe path in the \SpecialChar LyX
7797 \begin_layout Standard
7798 Reverse search is triggered by double-click.
7801 \begin_layout Section
7805 \begin_layout Standard
7806 Forward search is, as the name implies, in a sense the
7807 \begin_inset Quotes eld
7811 \begin_inset Quotes erd
7815 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7817 If forward search is set up (as described in what follows), you can put
7818 the cursor anywhere in your \SpecialChar LyX
7820 \begin_inset Flex Noun
7823 \begin_layout Plain Layout
7824 Navigate\SpecialChar menuseparator
7831 \begin_inset Flex Noun
7834 \begin_layout Plain Layout
7840 in the context menu via right mouse click), and then the viewer will jump
7841 to that position as well.
7842 This implies, of course, that your viewer supports this function.
7845 \begin_layout Standard
7846 To make forward search possible, you first need to provide the generated
7847 output PDF/DVI file with additional information about the \SpecialChar TeX
7849 This can be done via the methods described in the section
7850 \begin_inset CommandInset ref
7852 reference "subsec:rev-search"
7859 \begin_layout Standard
7860 Additionally, you need to configure \SpecialChar LyX
7861 for using your viewers in
7862 \begin_inset Flex Noun
7865 \begin_layout Plain Layout
7866 Tools\SpecialChar menuseparator
7867 Preferences\SpecialChar menuseparator
7868 Output\SpecialChar menuseparator
7875 We provide a range of tested configurations for some viewers, which you
7876 can select from the drop down list.
7877 If none of these configurations suits you, you have to find out and enter
7878 a suitable configuration yourself.
7879 The definition syntax uses the following placeholders:
7882 \begin_layout Itemize
7884 \begin_inset Flex Code
7887 \begin_layout Plain Layout
7896 \begin_layout Itemize
7898 \begin_inset Flex Code
7901 \begin_layout Plain Layout
7907 : name of the (temporary) exported .tex file (without path)
7910 \begin_layout Itemize
7912 \begin_inset Flex Code
7915 \begin_layout Plain Layout
7921 : name of the (temporary) exported .tex file (including path)
7924 \begin_layout Itemize
7926 \begin_inset Flex Code
7929 \begin_layout Plain Layout
7935 : name of the exported output file (either dvi or pdf, depending on which
7936 one exists in the temporary directory)
7939 \begin_layout Standard
7940 Note that only some of the viewers provide full
7941 \change_inserted -712698321 1500279079
7944 forward search functionality
7945 \change_inserted -712698321 1500278927
7948 , among them yap, xdvi, okular
7952 \begin_layout Plain Layout
7953 You might want to set
7954 \begin_inset Flex Code
7957 \begin_layout Plain Layout
7964 \begin_inset Flex Noun
7967 \begin_layout Plain Layout
7968 Tools\SpecialChar menuseparator
7969 Preferences\SpecialChar menuseparator
7970 File Handling\SpecialChar menuseparator
7972 \begin_inset space ~
7986 \change_inserted -712698321 1500278795
7993 \begin_layout Plain Layout
7994 SumatraPDF can also use DDE commands through the external program CMCDDE
7996 \begin_inset CommandInset href
7998 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8010 \change_inserted -712698321 1500279294
8011 Others, such as evince
8015 \begin_layout Plain Layout
8016 \paragraph_spacing single
8018 \change_inserted -712698321 1500278873
8019 Forward search with evince can be achieved by means of third party helper
8022 \begin_inset CommandInset href
8024 target "http://wiki.lyx.org/LyX/SyncTeX"
8036 , require some extra tools in order to use forward search.
8039 While many of the widespread PDF viewers (most notably Adobe Reader) do
8040 not support forward search at all, some other viewers – e.
8041 \begin_inset space \thinspace{}
8046 \change_deleted -712698321 1500278769
8049 xpdf – allow at least to reload the document and jump to a specific page
8050 of the file, so you can at least navigate
8051 \begin_inset Quotes eld
8055 \begin_inset Quotes erd
8059 This latter functionality is provided by an external call of synctex (see
8060 the predefined example configurations).
8064 \begin_layout Standard
8065 Forward search works both with DVI and PDF output.
8067 simply checks which preview format you have used before (i.
8068 \begin_inset space \thinspace{}
8071 e., which format is already there in the temporary directory) and chooses
8072 the appropriate configuration for the respective format.
8075 \begin_layout Chapter
8076 Special Document Classes
8079 \begin_layout Section
8083 \begin_layout Standard
8089 \begin_layout Subsection
8093 \begin_layout Standard
8094 This section describes how \SpecialChar LyX
8095 can be used to write articles for submission
8096 to the scientific journal
8098 Astronomy and Astrophysics
8101 \begin_inset Flex URL
8104 \begin_layout Plain Layout
8106 http://www.edpsciences.fr/aa/
8111 ) using Version 5.01 of the document class
8116 This package can be downloaded from the ftp site
8119 \begin_layout Standard
8120 \begin_inset VSpace medskip
8126 \begin_layout Standard
8128 \begin_inset Flex URL
8131 \begin_layout Plain Layout
8133 ftp://ftp.edpsciences.org/pub/aa/readme.html
8141 \begin_layout Standard
8142 \begin_inset VSpace medskip
8148 \begin_layout Standard
8149 A manual comes together with that package, and this text is not meant to
8150 replace the original manual but is merely a short guide in how to realize
8151 the correct form of your paper.
8155 \begin_layout Standard
8156 Please note that the publisher of the journal was changed from Springer
8157 to EDP Sciences starting January 1, 2001.
8158 That change involved also some slight changes to the style files, namely
8159 the removal of the thesaurus command.
8160 The \SpecialChar LyX
8161 class aa supports the newest version of these style files, V 5.01.
8162 If you have an older version installed, please upgrade.
8163 For compatibility, the old (version 4) layout has been kept as
8168 Please refer to the comments in
8171 Dir/layouts/aapaper.layout
8176 \begin_layout Subsection
8180 \begin_layout Standard
8181 It is recommended you start from the example template distributed with \SpecialChar LyX
8183 If you are not using a template, note the following settings:
8186 \begin_layout Itemize
8193 Document\SpecialChar menuseparator
8196 dialog (OK, that one was obvious).
8199 \begin_layout Itemize
8200 Don't change the option
8203 \begin_inset space ~
8213 The whole layout is done by the macros, you shouldn't change anything.
8216 \begin_layout Subsection
8220 \begin_layout Standard
8221 First thing to enter is the header information.
8222 It consists of seven entries, of which some are optional.
8226 \begin_layout Itemize
8234 \begin_layout Itemize
8242 \begin_layout Itemize
8250 \begin_layout Itemize
8258 \begin_layout Itemize
8263 : [optional] if more than one author: whom to contact for offprint requests.
8266 \begin_layout Itemize
8271 : [optional] mail address for contacts.
8274 \begin_layout Itemize
8282 Received: <date>; Accepted <date>
8285 \begin_layout Standard
8286 There is no need to issue the
8292 command, this is done automatically by \SpecialChar LyX
8293 when the header is finished.
8294 Although the order of the single header entries doesn't matter it is advised
8295 to keep the above sequence, just to get the best optics and meets the layout
8296 of the real document.
8299 \begin_layout Standard
8300 If you want to place footnotes in the header block, e.
8301 \begin_inset space \thinspace{}
8305 \begin_inset space \space{}
8308 to state your present address, just use the standard footnote via the menu
8311 Insert\SpecialChar menuseparator
8316 will automagically use the term
8325 \begin_layout Standard
8326 In addition to these topics, the macros use three additional \SpecialChar LaTeX
8328 have no counterpart in \SpecialChar LyX
8332 \begin_layout Itemize
8339 to separate different names for more than one author and institute, respectivel
8343 \begin_layout Itemize
8350 to mark corresponding author/institute pairs.
8351 The institutes are numbered sequentially as they appear in the
8355 field, so you have to put a marker to each author.
8358 \begin_layout Itemize
8365 to supply an email address for fast contact.
8368 \begin_layout Standard
8369 In all cases, the appropriate command has to be entered in \SpecialChar LyX
8377 \begin_layout Subsection
8381 \begin_layout Standard
8382 The abstract should immediately follow the header block.
8383 With version 5 the abstract environment was changed to a command, and there
8384 is now a resctriction to only one paragraph.
8385 In addition, it should contain an entry with the keywords.
8386 This is not yet implemented for \SpecialChar LyX
8387 , therefore you have to enter the \SpecialChar LaTeX
8395 by hand and mark it as \SpecialChar LaTeX
8397 Refer to the example paper.
8400 \begin_layout Subsection
8401 Supported environments
8404 \begin_layout Standard
8405 The A&A paper layout supports the following environments for structuring
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
8469 \begin_layout Itemize
8475 \begin_layout Itemize
8482 \begin_layout Subsection
8483 Commands not supported by \SpecialChar LyX
8487 \begin_layout Standard
8488 Some commands are not yet supported by the
8492 layout for \SpecialChar LyX
8494 Some have already been mentioned.
8495 For the sake of completeness, they are listed all together here:
8498 \begin_layout Itemize
8506 \begin_layout Itemize
8514 \begin_layout Itemize
8522 \begin_layout Itemize
8530 \begin_layout Itemize
8538 \begin_layout Itemize
8546 \begin_layout Itemize
8554 \begin_layout Itemize
8562 \begin_layout Standard
8563 If you want to use any of these commands, you have to enter them yourself.
8566 Do not forget to mark them as \SpecialChar LaTeX
8570 \begin_layout Subsection
8571 Figure and Table Floats
8574 \begin_layout Standard
8576 provides support for the necessary float environments
8578 figure, figure*, table
8584 , therefore we won't tell much about it here.
8588 \begin_inset space ~
8594 Just remember that tables should be left-aligned.
8595 For that, select the table and change the alignment in
8597 Edit\SpecialChar menuseparator
8599 \begin_inset space ~
8605 \begin_layout Standard
8606 There is only one special thing: the figures with caption besides the figure.
8607 To create such a figure, you have to do the following:
8610 \begin_layout Enumerate
8611 Create a wide figure float:
8613 Insert\SpecialChar menuseparator
8614 Float\SpecialChar menuseparator
8617 , then right click in the figure and select
8620 \begin_inset space ~
8628 \begin_layout Enumerate
8629 Enter your caption text.
8632 \begin_layout Enumerate
8637 to move the cursor above the caption.
8640 \begin_layout Enumerate
8644 \begin_layout Enumerate
8645 Position the cursor behind the figure and insert a horizontal fill:
8647 Insert\SpecialChar menuseparator
8649 \begin_inset space ~
8652 Character\SpecialChar menuseparator
8654 \begin_inset space ~
8662 \begin_layout Enumerate
8663 Switch to \SpecialChar LaTeX
8667 \begin_inset space ~
8675 \begin_layout Enumerate
8685 Do not close the brace!
8688 \begin_layout Enumerate
8689 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8694 \begin_inset space ~
8706 \begin_layout Standard
8707 Also, refer to the figures in the example paper.
8710 \begin_layout Subsection
8714 \begin_layout Standard
8715 For submission, the paper has to be formated in a special double-spacing
8717 For this purpose, you have to give the option
8721 to the documentclass.
8722 This must be done using the extra class options field in the
8724 Document\SpecialChar menuseparator
8728 Just enter the string
8735 \begin_layout Subsection
8739 \begin_layout Standard
8744 directory contains an example paper written with \SpecialChar LyX
8746 It is the example paper from the original macro package, translated to
8749 Use it for inspiration, and compare the original \SpecialChar LaTeX
8750 code with \SpecialChar LyX
8754 \begin_layout Section
8759 \begin_layout Standard
8765 \begin_layout Subsection
8769 \begin_layout Standard
8771 is a set of macros produced by the American Astronomical Society to
8772 facilitate electronic manuscript submission to the three journals they
8773 publish: the Astrophysical Journal (including the Letters and Supplement),
8774 the Astronomical Journal, and the Publications of the Astronomical Society
8777 has proven to be an excellent tool for generating these documents, especially
8778 given its equation, citation, and figure handling capabilities.
8780 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8781 is the version described here, or higher.
8782 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8783 2.09 and are fundamentally
8784 incompatible with \SpecialChar LyX
8786 The AAS\SpecialChar TeX
8787 package may be downloaded from the AAS\SpecialChar TeX
8791 \begin_layout Standard
8792 \begin_inset VSpace medskip
8798 \begin_layout Standard
8800 \begin_inset Flex URL
8803 \begin_layout Plain Layout
8805 https://aas.org/aastex/aastex-downloads
8813 \begin_layout Standard
8814 \begin_inset VSpace medskip
8820 \begin_layout Standard
8821 A complete user guide is contained in that package and you should familiarize
8822 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8825 will not reduce the need to figure out all the AAS\SpecialChar TeX
8826 commands, it will only
8827 reduce the drudgery of typing everything in.
8828 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8830 completely to the requirements of the journal to which you are submitting
8834 \begin_layout Subsection
8835 Starting a New Paper
8838 \begin_layout Standard
8839 I strongly suggest that you start with the AAS\SpecialChar TeX
8843 File\SpecialChar menuseparator
8850 , enter the new file name, then choose the
8855 This will show the most common fields found in a manuscript.
8856 Simply overwrite the existing text (including the brackets,
8860 ) with the correct information.
8861 Many of the AAS\SpecialChar TeX
8862 commands and environments can be implemented directly in
8864 , but some cannot: most noticeably
8876 , which should stick out like a sore thumb if you actually just opened the
8878 For commands such as these, the \SpecialChar LaTeX
8879 code must be entered directly and marked
8881 Such commands are referred to as \SpecialChar TeX
8882 code, or Evil Red Text.
8883 I tried to minimize the amount of \SpecialChar TeX
8884 code needed in an AAS\SpecialChar TeX
8886 there is still a bit more required than any of us would like.
8889 \begin_layout Subsection
8890 Finishing Your Paper
8893 \begin_layout Standard
8894 When the paper is finished to your satisfaction and previews/prints correctly,
8896 \begin_inset Quotes eld
8900 \begin_inset Quotes erd
8903 actions which need to be done before you submit it to the journals.
8907 \begin_layout Enumerate
8908 Export your paper as a \SpecialChar LaTeX
8911 File\SpecialChar menuseparator
8912 Export\SpecialChar menuseparator
8920 \begin_layout Enumerate
8925 file with your favorite text editor
8929 \begin_layout Enumerate
8930 remove the comment lines before the
8939 \begin_layout Enumerate
8944 usepackage...{fontenc}
8946 line if it appears (usually just after
8961 \begin_layout Enumerate
8962 remove everything between (and including) the
8974 commands, except for any commands you specifically put into the \SpecialChar LaTeX
8976 (which should appear immediately after the
8977 \begin_inset Quotes eld
8980 User specified \SpecialChar LaTeX
8982 \begin_inset Quotes erd
8993 \begin_layout Enumerate
8994 Run the resulting file through \SpecialChar LaTeX
8995 to make sure it still processes correctly.
8998 \begin_layout Enumerate
8999 Reread the journal requirements to make sure your filenames and formats
9003 \begin_layout Enumerate
9007 \begin_layout Subsection
9008 Comments On Specific Commands
9011 \begin_layout Standard
9012 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9019 ) gives a good description of each.
9020 Thus it's probably easiest for me to go down the list as found in the guide
9021 and offer comments where necessary.
9022 So let's begin \SpecialChar ldots
9026 \begin_layout Subsubsection
9027 Things that work as expected
9030 \begin_layout Standard
9031 Because they work as you might expect, I simply list them and the section
9132 begin{thebibliography}
9140 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9141 graphicx figure commands (2.14.1),
9165 (2.15.4, amongst other places),
9192 \begin_layout Standard
9193 The following style options also work correctly:
9214 Simply put them in the
9220 Layout\SpecialChar menuseparator
9226 \begin_layout Subsubsection
9227 Things that work, but require more comment
9230 \begin_layout Standard
9231 The following items work, but require a little more discussion:
9234 \begin_layout Itemize
9235 These items are reserved for use by the journal editors, but you can put
9236 them into the \SpecialChar LaTeX
9237 preamble if you feel compelled to do so:
9270 \begin_layout Itemize
9271 These items may be placed in the \SpecialChar LaTeX
9272 preamble, and are included as blanks in
9294 \begin_layout Itemize
9301 (2.3) – can only be used
9302 \begin_inset Quotes eld
9306 \begin_inset Quotes erd
9309 , not in the middle of a paragraph.
9310 Use \SpecialChar TeX
9311 code if you need to embed it.
9314 \begin_layout Itemize
9321 (2.3) – will have extra {} after it.
9322 This should not cause an error.
9325 \begin_layout Itemize
9332 (2.6) – can only be used
9333 \begin_inset Quotes eld
9337 \begin_inset Quotes erd
9340 , not in the middle of a paragraph.
9341 Use \SpecialChar TeX
9342 code if you need to embed it.
9345 \begin_layout Itemize
9352 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9356 \begin_layout Itemize
9370 \begin_layout Itemize
9377 (2.9) – will have extra {} after it.
9378 This should not cause an error.
9381 \begin_layout Itemize
9388 (2.11) – will have extra {} after it.
9389 This should not cause an error.
9392 \begin_layout Itemize
9399 (2.14.2) – you can insert an optional filename argument by placing the cursor
9400 at the beginning of the text and selecting
9402 Insert\SpecialChar menuseparator
9407 \begin_inset Quotes eld
9411 \begin_inset Quotes erd
9414 inserts an optional argument of the type needed by
9421 Hopefully it will be renamed someday.
9424 \begin_layout Itemize
9437 for the catalog ID optional parameter
9440 \begin_layout Itemize
9453 for the catalog ID optional parameter
9456 \begin_layout Subsubsection
9457 Things not implemented, use \SpecialChar TeX
9461 \begin_layout Standard
9484 setcounter{equation}
9486 (2.12), Journal name abbreviations (2.13.4),
9522 (2.15.4, insert it as the first element in the lefthand cell after where
9524 Don't use any of \SpecialChar LyX
9525 's rules in the table),
9537 (2.15.5), much of Misc (2.17, except
9588 \begin_layout Subsubsection
9589 Things that cannot be implemented
9592 \begin_layout Standard
9594 at least in any meaningful sort of way, so I suggest ignoring them.
9595 They are the references environment (2.13.3), and the deluxetable environment
9597 If you really, really need to use deluxetable, I suggest editing it in
9598 a separate file with a text editor, then using
9600 Insert\SpecialChar menuseparator
9602 \begin_inset space ~
9607 to include it in your \SpecialChar LyX
9613 file to see an example of this.
9616 \begin_layout Subsection
9617 FAQs, Tips, Tricks, and Other Ruminations
9620 \begin_layout Subsubsection
9621 Getting \SpecialChar LyX
9622 and AAS\SpecialChar TeX
9626 \begin_layout Standard
9627 It can be a bit tricky to get \SpecialChar LyX
9628 to recognize a new layout and document class.
9629 When all else fails, do this:
9632 \begin_layout Enumerate
9633 Make certain that \SpecialChar LaTeX
9634 can find AAS\SpecialChar TeX
9636 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9638 directory completely unrelated to \SpecialChar LaTeX
9639 or AAS\SpecialChar TeX
9640 and run \SpecialChar LaTeX
9648 \begin_layout Enumerate
9653 appears in \SpecialChar LyX
9661 \begin_layout Enumerate
9664 Tools\SpecialChar menuseparator
9668 , then restart \SpecialChar LyX
9672 \begin_layout Enumerate
9673 Open a regular new file, not from a template.
9674 Does AAS\SpecialChar TeX
9675 appear in the class list in
9677 Document\SpecialChar menuseparator
9683 \begin_layout Standard
9684 If you get a warning from an existing AAS\SpecialChar TeX
9685 document about not being able
9686 to find the AAS\SpecialChar TeX
9687 layout or a message about
9688 \begin_inset Quotes eld
9691 You should not mix title layouts with normal ones
9692 \begin_inset Quotes erd
9695 , things haven't been installed correctly.
9698 \begin_layout Subsubsection
9700 error processing a table
9703 \begin_layout Standard
9705 , by default, attempts to center the table caption/title.
9706 This seems to produce a bad interaction in AAS\SpecialChar TeX
9707 so you should click somewhere
9708 in the caption/title, then select
9710 Edit\SpecialChar menuseparator
9712 \begin_inset space ~
9726 This took care of it for me.
9729 \begin_layout Subsubsection
9733 \begin_layout Standard
9734 A couple of things: 1) I have noticed some funny spacing in the reference
9735 entries in the text.
9736 When you enter the bibliography item data, make sure their is
9740 space between the last author and the parenthesis setting off the year;
9744 \begin_inset space \thinspace{}
9748 \begin_inset space \space{}
9762 2) Entering the references at all is not obvious.
9763 The easiest thing is to start typing your first reference at the end of
9764 the document, then mark it as type
9769 That will put a small gray box in front of what you just typed.
9770 Click on the box to fill in the rest of the information.
9771 For new references, go to the end of an existing reference and press return.
9772 That will create a new line with its own box, etc.
9775 \begin_layout Subsubsection
9779 \begin_layout Standard
9780 Even though AAS\SpecialChar TeX
9781 provides its own figure commands (
9787 , for example), I much prefer \SpecialChar LaTeX
9788 's standard figure commands (with the default
9797 \begin_inset space ~
9800 commands as \SpecialChar TeX
9801 code into a Figure Float box if you desire, but I never have
9802 much luck getting the layout right.
9803 With the standard graphics, \SpecialChar LyX
9808 usepackage{graphicx}
9810 command into the \SpecialChar LaTeX
9811 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9813 interspersing the figures in the text.
9814 I believe ApJ accepts figures exactly this way now; AJ might still use
9816 \begin_inset Quotes eld
9819 stack everything at the end
9820 \begin_inset Quotes erd
9826 \begin_layout Subsubsection
9827 Things I could have done, but didn't
9830 \begin_layout Standard
9832 \begin_inset Quotes eld
9836 \begin_inset Quotes erd
9839 things I could have implemented, but chose not to.
9840 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9842 even though it is double-spaced in the paper manuscript.
9843 Also, I chose not to make separate layouts for the preprint and preprint2
9845 Since I assume you will spend most of your time in the plain manuscript
9846 mode anyway, I decided not to chew up more disk space with this.
9850 \begin_layout Subsection
9854 \begin_layout Standard
9855 Your mileage may vary.
9856 I've now had papers published by both ApJ and AJ that have had 98% of the
9857 effort done in \SpecialChar LyX
9858 ; the last 2% was the \SpecialChar LaTeX
9859 post-processing and a few cleanups.
9860 I have had no trouble with the submission process, and I'm sure the journals
9861 were never aware that there might be a difference.
9862 So, go forth and publish!
9865 \begin_layout Section
9866 AMS \SpecialChar LaTeX
9870 \begin_layout Standard
9880 \begin_layout Standard
9881 \begin_inset VSpace bigskip
9887 \begin_layout Standard
9889 The AMS \SpecialChar LaTeX
9890 layouts are set up to conform to suggested styles for mathematical
9891 papers to be submitted to American Mathematical Society publications.
9892 The layouts are not tailored to a specific journal, but easily can be.
9893 You should refer to the AMS documentation for specific instructions for
9894 each journal (usually it will entail only changing a single line in the
9897 That documentation is available on the Web at
9898 \begin_inset Flex URL
9901 \begin_layout Plain Layout
9909 \begin_inset Flex URL
9912 \begin_layout Plain Layout
9914 ftp://ftp.ams.org/pub/tex/amslatex/
9920 These layouts are appropriate, and useful, for any mathematical writing.
9924 \begin_layout Standard
9925 There are two basic AMS \SpecialChar LaTeX
9929 \begin_layout Itemize
9930 amsart: The standard AMS article format.
9933 \begin_layout Itemize
9934 amsbook: the standard AMS book (really, monograph) format.
9938 \begin_layout Standard
9939 The layouts themselves contain only the minimum necessary to use the AMS
9941 They do not, in particular, contain any of the `theorem' environments used
9942 for setting theorems, lemmas, and the like.
9943 These are contained, instead, in the
9944 \begin_inset Flex Code
9947 \begin_layout Plain Layout
9953 module, which is loaded by default when you select one of the AMS classes.
9954 (It can also be used with other classes and can be removed, if you would
9955 rather use something else.) Less commonly used environments are in the
9956 \begin_inset Flex Code
9959 \begin_layout Plain Layout
9960 Theorems (AMS-Extended)
9965 module, which must be loaded manually.
9968 \begin_layout Standard
9969 By default, theorems and the like are numbered consecutively throughout
9970 the document, but this may be modified by loading the module
9971 \begin_inset Flex Code
9974 \begin_layout Plain Layout
9975 Theorems (Order by Section)
9980 or, if you are using
9981 \begin_inset Flex Code
9984 \begin_layout Plain Layout
9991 \begin_inset Flex Code
9994 \begin_layout Plain Layout
9995 Theorems (Order by Chapter)
10001 These will number the results as
10002 \begin_inset Formula $n.m$
10005 , where the first number refers to the section (or chapter) and the second
10006 refers to the total number of results so far in that section (or chapter).
10007 Many environments are also available unnumbered.
10008 These are indicated by an asterisk at the end.
10009 If you happen to want
10013 unnumbered results, the module
10014 \begin_inset Flex Code
10017 \begin_layout Plain Layout
10023 provides that option.
10026 \begin_layout Standard
10027 Note that these modules do not
10031 to be used with the AMS classes.
10032 It is perfectly possible to use the
10033 \begin_inset Flex Code
10036 \begin_layout Plain Layout
10042 module, and the others mentioned, with other classes, such as
10043 \begin_inset Flex Code
10046 \begin_layout Plain Layout
10053 \begin_inset Flex Code
10056 \begin_layout Plain Layout
10063 \begin_inset Flex Code
10066 \begin_layout Plain Layout
10075 \begin_layout Subsection
10076 What these layouts provide
10079 \begin_layout Standard
10080 There is a long list of included environments provided by these layouts.
10081 In AMS-\SpecialChar LaTeX
10082 , there is, in fact, an opportunity to define an unlimited variety
10083 of `theorem' environments.
10084 However, the AMS recommends the environments that are available in \SpecialChar LyX
10089 \begin_layout Standard
10090 The following environments—as well as the standard environments, such as
10092 \begin_inset Flex Noun
10095 \begin_layout Plain Layout
10102 \begin_inset Flex Noun
10105 \begin_layout Plain Layout
10112 \begin_inset Flex Noun
10115 \begin_layout Plain Layout
10122 \begin_inset Flex Noun
10125 \begin_layout Plain Layout
10132 \begin_inset Flex Noun
10135 \begin_layout Plain Layout
10142 \begin_inset Flex Code
10145 \begin_layout Plain Layout
10152 \begin_inset Flex Code
10155 \begin_layout Plain Layout
10164 \begin_layout Description
10165 Address This should be the author's permanent address.
10168 \begin_layout Description
10170 \begin_inset space ~
10173 Address This should be the author's temporary address at the time of submission,
10174 if different from the Address.
10177 \begin_layout Description
10178 Email Author's e-mail address
10181 \begin_layout Description
10182 URL Author's Web address, if desired.
10185 \begin_layout Description
10186 Keywords Key words or phrases used to identify specific topics discussed
10190 \begin_layout Description
10191 Subjectclass These refer to the AMS Subject Classifications, published and
10194 Mathematical Reviews
10197 These are also available online at the AMS cites listed above.
10200 \begin_layout Description
10204 \begin_layout Description
10208 \begin_layout Description
10212 \begin_layout Standard
10213 The following environments are provided by both the
10214 \begin_inset Flex Code
10217 \begin_layout Plain Layout
10224 \begin_inset Flex Code
10227 \begin_layout Plain Layout
10233 modules, in the latter case in both starred (unnumbered) and unstarred
10234 (numbered) versions.
10235 These same environments are provided only in the starred versions by the
10237 \begin_inset Flex Code
10240 \begin_layout Plain Layout
10249 \begin_layout Theorem
10250 This is typically used for the statements of major results.
10254 \begin_layout Corollary*
10255 This is used for statements which follow fairly directly from previous statement
10257 Again, these can be major results.
10261 \begin_layout Lemma
10262 These are smaller results needed to prove other statements.
10265 \begin_layout Proposition
10266 These are less major results which (hopefully) add to the general theory
10270 \begin_layout Conjecture
10271 These are statements provided without justification, which the author does
10272 not know how to prove, but which seem to be true (to the author, at least).
10275 \begin_layout Definition*
10276 Guess what this is for.
10277 The font is different for this environment than for the previous ones.
10281 \begin_layout Example*
10282 Used for examples illustrating proven results.
10285 \begin_layout Problem
10286 It's not really known what this is for.
10287 You should figure it out.
10290 \begin_layout Exercise*
10291 Write a description for this one.
10294 \begin_layout Remark
10295 This environment is also a type of theorem, usually a lesser sort of observation.
10298 \begin_layout Claim*
10299 Often used in the course of giving a proof of a larger result.
10303 Generally, these are used to break up long arguments, using specific instances
10309 The numbering scheme for cases is on its own, not together with other numbered
10314 \begin_layout Proof
10315 At the end of this environment, a QED symbol (usually a square, but it can
10316 vary with different styles) is placed.
10317 If you want to have other environments within this one—for example, Case
10318 environments—and have the QED symbol appear only after them, then the other
10319 environments need to be nested within the proof environment.
10322 Nesting Environments
10328 for information on nesting.
10331 \begin_layout Standard
10332 And these environments are provided by
10333 \begin_inset Flex Code
10336 \begin_layout Plain Layout
10337 Theorems (AMS-Extended)
10345 \begin_layout Criterion*
10346 A required condition.
10349 \begin_layout Algorithm*
10350 A general procedure to be used.
10353 \begin_layout Axiom*
10354 This is a property or statement taken as true within the system being discussed.
10357 \begin_layout Condition*
10358 Sometimes used to state a condition assumed within the present context of
10362 \begin_layout Note*
10363 Similar to a Remark.
10366 \begin_layout Notation*
10367 Used for the explanation of, yes, notation.
10370 \begin_layout Summary
10371 Do we really need to tell you?
10374 \begin_layout Acknowledgement*
10378 \begin_layout Conclusion*
10379 Sometimes used at the end of a long train of argument.
10383 Used in a way similar to Proposition, though perhaps lower on the scale.
10386 \begin_layout Standard
10387 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10390 They need to be available on your system in order to use these environments.
10393 \begin_layout Section
10401 \begin_layout Standard
10407 \begin_layout Subsection
10411 \begin_layout Standard
10412 These are the layout files for some of the journals of the American Geophysical
10414 It is assumed that you have both the AGU's own class files and AGUplus
10415 installed (everything to be found at
10416 \begin_inset Flex URL
10419 \begin_layout Plain Layout
10421 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10429 \begin_layout Subsection
10433 \begin_layout Standard
10443 They are still called this in the \SpecialChar LyX
10444 GUI, though their \SpecialChar LaTeX
10457 \begin_layout Standard
10458 Newly defined styles are
10495 These are mostly manuscript attributes and defined in the AGU class documentati
10499 \begin_layout Standard
10500 I suspect this is still badly incomplete.
10503 \begin_layout Subsection
10507 \begin_layout Standard
10524 \begin_layout Subsection
10528 \begin_layout Itemize
10531 Journal of Geophysical Research
10540 \begin_layout Standard
10541 Add your own, it isn't so hard! Look at the
10552 \begin_layout Subsection
10553 Bugs and things to remember
10556 \begin_layout Standard
10557 In order to use the new layouts, you must remember to do the following for
10561 \begin_layout Enumerate
10567 This can be done in the
10569 Layout\SpecialChar menuseparator
10574 Document\SpecialChar menuseparator
10578 (AGU articles are always in English, right? So
10582 choose a language.)
10585 \begin_layout Enumerate
10590 into the document's
10595 (Yes, this is a bug.)
10598 \begin_layout Enumerate
10599 Make sure you use the
10603 bibliography style, by entering
10607 into the second field of the Bib\SpecialChar TeX
10609 None of the standard styles will do.
10612 \begin_layout Section
10616 \begin_layout Standard
10622 \begin_layout Subsection
10626 \begin_layout Standard
10627 Broadway is for writing plays.
10628 The format is more decorative than Hollywood, and much less standardized.
10629 This format should be suitable for workshops.
10632 \begin_layout Subsection
10636 \begin_layout Standard
10637 The same as in Hollywood.
10640 \begin_layout Subsection
10644 \begin_layout Standard
10649 names as labels then cross-reference the label to insert the name.
10650 The cross-reference dialog will show the current cast of characters.
10653 \begin_layout Subsection
10654 Paper size and Margins
10657 \begin_layout Standard
10658 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10661 \begin_layout Subsection
10665 \begin_layout Standard
10666 The following environments are available.
10667 You can use broadway.bind to get the bind keys shown at the right.
10670 \begin_layout Itemize
10674 \begin_inset Newline newline
10679 You should not have to use this, but it is here for anything that does not
10683 \begin_layout Itemize
10687 \begin_inset space \hfill{}
10691 \begin_inset Newline newline
10696 Used to describe stage setting and the action.
10697 First use of speaker names in all CAPs.
10700 \begin_layout Itemize
10704 \begin_inset space \hfill{}
10708 \begin_inset Newline newline
10713 Automatically numbered.
10714 On screen it will be arabic, but will print as Roman.
10717 \begin_layout Itemize
10721 \begin_inset space \hfill{}
10725 \begin_inset Newline newline
10735 It is just centered text.
10738 \begin_layout Itemize
10742 \begin_inset space \hfill{}
10746 \begin_inset Newline newline
10751 Not automatically numbered.
10752 You supply the number.
10753 This is because I couldn't figure out how.
10756 \begin_layout Itemize
10760 \begin_inset space \hfill{}
10764 \begin_inset Newline newline
10769 A special case of Narrative to describe the setting and action as the curtain
10773 \begin_layout Itemize
10777 \begin_inset space \hfill{}
10781 \begin_inset Newline newline
10786 The speaker's (actor's) title, centered in all CAPS.
10789 \begin_layout Itemize
10793 \begin_inset space \hfill{}
10797 \begin_inset Newline newline
10802 Instructions to the speaker.
10803 The parentheses are automatically inserted.
10804 The ( will appear on screen, but both will be in the printed play.
10805 This environment is only used within
10812 \begin_layout Itemize
10816 \begin_inset space \hfill{}
10820 \begin_inset Newline newline
10825 What the Speaker says.
10828 \begin_layout Itemize
10832 \begin_inset space \hfill{}
10836 \begin_inset Newline newline
10841 The curtain comes down.
10844 \begin_layout Itemize
10848 \begin_inset space \hfill{}
10854 \begin_layout Itemize
10858 \begin_inset space \hfill{}
10864 \begin_layout Itemize
10868 \begin_inset space \hfill{}
10874 \begin_layout Standard
10878 \begin_layout Section
10882 \begin_layout Standard
10887 can be used to type letters according to German conventions.
10888 A template file is included in
10890 .../lyx/share/templates
10892 for you to use as a starting point.
10895 \begin_layout Section
10903 \begin_layout Standard
10909 \begin_layout Subsection
10913 \begin_layout Standard
10914 This is the layout file for the European Geophysical Society journals.
10919 can be downloaded from the web site of the EGS under
10920 \begin_inset Flex URL
10923 \begin_layout Plain Layout
10933 \begin_layout Subsection
10937 \begin_layout Standard
10940 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10948 The current layout file is unfortunately very unmodular and would benefit
10949 from using the various
10956 \begin_layout Section
10960 \begin_layout Standard
10961 See the \SpecialChar LyX
10967 It contains all infos you need.
10970 \begin_layout Section
10973 Foil\SpecialChar TeX
10977 \begin_inset CommandInset label
10986 \begin_layout Standard
10992 \begin_layout Subsection
10996 \begin_layout Standard
10997 This section describes how to use \SpecialChar LyX
10998 to make slides for overhead projectors.
10999 There are two document classes that can do this: the default slides class
11002 Foil\SpecialChar TeX
11006 This section documents the latter.
11009 \begin_layout Standard
11010 I'm going to say this again, nice and clear, so that there's no misunderstanding
11014 \begin_layout Standard
11015 \begin_inset VSpace bigskip
11021 \begin_layout Standard
11025 This section documents the class
11026 \begin_inset Quotes eld
11034 \begin_inset Quotes erd
11042 \begin_layout Standard
11043 \begin_inset VSpace bigskip
11049 \begin_layout Standard
11050 If you're looking for the documentation for
11051 \begin_inset Quotes eld
11059 \begin_inset Quotes erd
11062 , check out section
11063 \begin_inset space ~
11067 \begin_inset CommandInset ref
11069 reference "sec:slitex"
11074 If your machine doesn't have the
11082 installed, you'll probably have to use the default
11086 class, which isn't quite as good as
11091 \begin_layout Standard
11096 class is designed for use with version
11097 \begin_inset space ~
11105 class file which is now an integral part of \SpecialChar LaTeX2e
11109 \begin_layout Subsection
11113 \begin_layout Standard
11114 Obviously, to use this document class, you need to select
11125 \begin_inset space ~
11131 There are some settings in the
11134 \begin_inset space ~
11139 dialog that you should know about that are specific to this class:
11142 \begin_layout Itemize
11143 Don't change the options
11154 \begin_inset space ~
11160 They're ignored by the
11167 \begin_layout Itemize
11168 The default font size is 20
11169 \begin_inset space \thinspace{}
11172 pt with the other options being 17
11173 \begin_inset space \thinspace{}
11177 \begin_inset space \thinspace{}
11181 \begin_inset space \thinspace{}
11187 \begin_layout Itemize
11188 The default font is
11196 but all math equations are still typeset in the usual roman font.
11199 \begin_layout Itemize
11202 Foil\SpecialChar TeX
11205 supports A4 and Letter paper sizes as well as a special size for working
11207 \begin_inset space \thinspace{}
11211 It doesn't support A5, B5, legal or executive paper sizes.
11214 \begin_layout Itemize
11215 Don't bother changing the
11219 settings because they are ignored anyway.
11220 All floats appear where they are defined in the text.
11223 \begin_layout Itemize
11228 setting behaves a bit differently for this class.
11231 Foil\SpecialChar TeX
11234 provides extensive footer and header capabilities including a user-defined
11237 \begin_inset space ~
11241 \begin_inset CommandInset ref
11243 reference "sec:foilfoot"
11248 The title page is treated differently to all other pages in the document
11257 has the logo centered at the bottom of the page (if one is defined).
11258 The possible page style choices and what they do are as follows:
11262 \begin_layout Labeling
11263 \labelwidthstring MMMMMMM
11270 The final output contains no page numbers, or other headers or footers
11271 (except footnotes of course).
11275 \begin_layout Labeling
11276 \labelwidthstring MMMMMMM
11283 The final output contains page numbers centered at the bottom of the page.
11284 No other headings or footers (other than footnotes).
11287 \begin_layout Labeling
11288 \labelwidthstring MMMMMMM
11293 Page numbers in lower right corner.
11294 Additional headers and footers are also shown.
11295 This is also the default.
11298 \begin_layout Labeling
11299 \labelwidthstring MMMMMMM
11304 Gives you access to the
11308 package although its use with
11310 Foil\SpecialChar TeX
11313 is discouraged by the writer of the
11315 Foil\SpecialChar TeX
11318 package because of some potential page layout clashes.
11322 \begin_layout Subsubsection
11326 \begin_layout Standard
11327 The following options may be used in the extra class options in the
11329 Document\SpecialChar menuseparator
11335 \begin_layout Labeling
11336 \labelwidthstring MMMMMMx
11341 This sets up the page layout for 7.33
11342 \begin_inset space \thinspace{}
11346 \begin_inset space \thinspace{}
11349 in paper, which is about the same aspect ratio as a 35
11350 \begin_inset space \thinspace{}
11353 mm slide, making it a bit easier to work with this medium.
11356 \begin_layout Labeling
11357 \labelwidthstring MMMMMMx
11362 Places a rule across the page below the header on every page except the
11366 \begin_layout Labeling
11367 \labelwidthstring MMMMMMx
11372 Places a rule across the page above the footer on every page except the
11376 \begin_layout Labeling
11377 \labelwidthstring MMMMMMx
11382 This is automatically set each time you create a new
11389 Foil\SpecialChar TeX
11392 to use the dvips driver to rotate those pages that are set as landscape
11396 \begin_layout Labeling
11397 \labelwidthstring MMMMMMx
11402 Simply changes the page dimensions to those of a landscape page but doesn't
11404 Thus if you use this option you need to use an external program to rotate
11405 each page or feed your paper through your printer as landscape.
11406 Note that this option effectively reverses the roles of the
11414 environments (don't worry these are described in the next section).
11417 \begin_layout Labeling
11418 \labelwidthstring MMMMMMx
11423 Equation numbers on the left.
11426 \begin_layout Labeling
11427 \labelwidthstring MMMMMMx
11432 Flush-left equations.
11435 \begin_layout Subsection
11436 Supported Environments
11439 \begin_layout Standard
11440 Most of the environments commonly supported in other classes are also supported
11446 There are several additional environments provided by
11448 Foil\SpecialChar TeX
11451 as well as a couple added by \SpecialChar LyX
11453 The following environments are shared with other classes:
11456 \begin_layout Standard
11457 \begin_inset Flex Multiple Columns
11460 \begin_layout Itemize
11466 \begin_layout Itemize
11472 \begin_layout Itemize
11478 \begin_layout Itemize
11484 \begin_layout Itemize
11490 \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
11557 \begin_layout Itemize
11563 \begin_layout Itemize
11574 \begin_layout Standard
11575 That is, all the major environments apart from the sectioning environments.
11576 Since foils are essentially self-contained sections, with a title and body,
11579 Foil\SpecialChar TeX
11582 provides specific commands for starting new foils and these are:
11585 \begin_layout Itemize
11591 \begin_layout Itemize
11597 \begin_layout Standard
11599 also provides slightly modified versions of these two environments called:
11602 \begin_layout Itemize
11608 \begin_layout Itemize
11611 ShortRotatefoilhead
11614 \begin_layout Standard
11615 and the differences will be explained in the next section.
11618 \begin_layout Standard
11619 Since foils are often used in presenting ideas or new theorems and such
11622 Foil\SpecialChar TeX
11625 also provides a comprehensive box of goodies for presenting them:
11628 \begin_layout Standard
11629 \begin_inset Flex Multiple Columns
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
11686 \begin_layout Itemize
11692 \begin_layout Itemize
11703 \begin_layout Standard
11704 The starred versions are unnumbered while the unstarred versions are numbered.
11705 There are also two list environments added by \SpecialChar LyX
11709 \begin_layout Itemize
11715 \begin_layout Itemize
11721 \begin_layout Standard
11724 Foil\SpecialChar TeX
11727 provides some powerful header and footer capabilities that are best set
11728 in the preamble although they may be set at any point in a document.
11729 If you want to change these settings in your document the best place to
11730 do so is at the very top of a foil, i.
11731 \begin_inset space \thinspace{}
11737 \begin_inset space \space{}
11742 straight after the foilhead.
11745 \begin_layout Standard
11746 For this purpose, the following command styles are provided [
11753 \begin_layout Standard
11754 \begin_inset Flex Multiple Columns
11757 \begin_layout Itemize
11761 \begin_inset space ~
11767 \begin_layout Itemize
11773 \begin_layout Itemize
11777 \begin_inset space ~
11783 \begin_layout Itemize
11787 \begin_inset space ~
11793 \begin_layout Itemize
11797 \begin_inset space ~
11804 \begin_layout Plain Layout
11805 \begin_inset space ~
11817 \begin_layout Standard
11818 There are also a few commands provided by
11820 Foil\SpecialChar TeX
11823 that aren't directly supported by \SpecialChar LyX
11824 but I'll tell you what they do and how
11825 to use them in section
11826 \begin_inset space ~
11830 \begin_inset CommandInset ref
11832 reference "sec:unsuppfoils"
11839 \begin_layout Subsection
11840 Building a Set of Foils
11843 \begin_layout Standard
11844 This section will give a simple introduction to using the different environments
11845 to build a set of foils.
11846 If you want to see an example set of foils, take a look at the
11850 file you find in \SpecialChar LyX
11858 \begin_layout Subsubsection
11859 Give It a Title Page
11862 \begin_layout Standard
11863 Unlike other classes that provide
11883 creates the title on a page of its own.
11884 If you leave out the
11888 environment \SpecialChar LaTeX
11889 will substitute the current date (every time you regenerate
11893 \begin_layout Subsubsection
11897 \begin_layout Standard
11898 As I mentioned earlier, there are four ways of starting a new foil.
11899 For portrait foils you should use
11908 The difference between these two environments is the amount of space between
11909 the title of the foil (the foilhead) and the body of the foil.
11912 \begin_layout Standard
11913 Landscape foils are generated using the
11919 ShortRotatefoilhead
11922 Again the only difference is the spacing between foilhead and body.
11923 Both of the short versions have 0.5
11924 \begin_inset space ~
11927 inches less separation between the foilhead and the body.
11931 \begin_layout Standard
11932 One problem with the support for landscape foils is the requirement that
11933 you have to use the
11937 driver to generate the PostScript output otherwise the foils won't be rotated.
11938 It is possible to get landscape foils even if you haven't got the
11942 driver provided you can feed your foils sideways through your printer ;-)
11945 \begin_layout Subsubsection
11946 Theorems, Lemmas, Proofs and more
11949 \begin_layout Standard
11950 Due to a small bug in \SpecialChar LyX
11951 you can't have two of the same type of these environments
11952 directly following each other.
11953 They must be separated by something.
11954 If you try, you will just be extending the previous environment as if you
11955 had merged the two environments together.
11956 So, how do you get around this problem? The simplest option is to insert
11957 some text between the two environments or add a
11962 environment between the two with just a
11963 \begin_inset Quotes eld
11971 \begin_inset Quotes erd
11975 This will force \SpecialChar LyX
11976 to produce two separate environments and hence the correct
11979 An example is provided in the example file included with the \SpecialChar LyX
11981 Remember, this problem only occurs if you are trying to place two of the
11982 same type of theorem-like environments one directly after the other.
11985 \begin_layout Subsubsection
11989 \begin_layout Standard
11990 You get all the commonly supported list styles found in other classes as
11991 well as two new ones.
11992 I'll only describe the new ones here.
11993 If you want to find out more about the other list environments check out
11999 If you intend to use itemized lists you might also want to read about the
12003 \begin_inset space ~
12007 \begin_inset space ~
12012 dialog described above in section
12013 \begin_inset space ~
12017 \begin_inset CommandInset ref
12019 reference "sec:bullet"
12026 \begin_layout Standard
12027 The two new list styles,
12035 , are designed to make it easier for you to create lists of do's and don'ts
12036 or right and wrong by providing dedicated environments that use a tick
12037 or a cross as the label of the list.
12038 These lists are in fact dedicated variants of the
12043 They do however require that you have the
12047 packages installed.
12050 \begin_layout Subsubsection
12054 \begin_layout Standard
12057 Foil\SpecialChar TeX
12060 redefines the floating tables and figures so that they appear exactly where
12061 they are in the text rather than pushing them to the top of the page or
12062 to some user specified location.
12063 In fact if you change the float placement settings they are simply ignored.
12066 \begin_layout Subsubsection
12067 Page Headers and Footers
12068 \begin_inset CommandInset label
12070 name "sec:foilfoot"
12077 \begin_layout Standard
12081 \begin_inset space ~
12090 are two commands used to control the left-footer text string.
12091 The first is meant to allow you to include a graphic logo on your foils
12093 \begin_inset Quotes eld
12098 Foil\SpecialChar TeX
12102 \begin_inset Quotes erd
12106 While the second is meant to provide a classification for the audience,
12110 \begin_inset space \thinspace{}
12116 \begin_inset space \space{}
12120 It is empty by default.
12123 \begin_layout Standard
12124 The remaining page corners can be filled by
12127 \begin_inset space ~
12132 (which defaults to page numbers),
12135 \begin_inset space ~
12143 \begin_inset space ~
12151 \begin_layout Subsection
12154 Foil\SpecialChar TeX
12158 \begin_inset CommandInset label
12160 name "sec:unsuppfoils"
12167 \begin_layout Standard
12168 All the commands mentioned below need to be set in a
12178 within another environment.
12181 \begin_layout Subsubsection
12185 \begin_layout Standard
12186 All lengths are adjusted using the
12209 should be replaced by the name given to the length you want to change and
12214 is the length value.
12215 All lengths should be specified in units of length such as inches (
12227 ) or relative to some document or font-based length such as
12237 \begin_layout Standard
12238 It's possible to change the spacing between a foilhead and the body of the
12239 foil by adjusting the length specified by
12246 For example, to make
12251 \begin_inset space \space{}
12254 in closer to their bodies put the following in the preamble:
12260 foilheadskip}{-0.5in}
12263 \begin_layout Standard
12264 The spacings around floats can be adjusted by setting these lengths:
12267 \begin_layout Labeling
12268 \labelwidthstring MMMMMMMMMMM
12275 Separation between the text and the top of the float
12278 \begin_layout Labeling
12279 \labelwidthstring MMMMMMMMMMM
12286 Separation between the float and the caption
12289 \begin_layout Labeling
12290 \labelwidthstring MMMMMMMMMMM
12297 Separation between the caption and the following text
12300 \begin_layout Labeling
12301 \labelwidthstring MMMMMMMMMMM
12308 You can make the captions narrower than the surrounding text by adjusting
12310 Best done relative to
12319 \begin_layout Standard
12320 There are also several title page related lengths that you may find useful
12321 if you have a long title or several authors:
12324 \begin_layout Labeling
12325 \labelwidthstring MMMMMMMMMMM
12332 Separation from headers to
12337 \begin_layout Labeling
12338 \labelwidthstring MMMMMMMMMMM
12356 \begin_layout Labeling
12357 \labelwidthstring MMMMMMMMMMM
12371 \begin_layout Labeling
12372 \labelwidthstring MMMMMMMMMMM
12388 \begin_layout Labeling
12389 \labelwidthstring MMMMMMMMMMM
12405 \begin_layout Standard
12406 The last length related command affects all the list environments.
12417 a list environment then all the vertical spacing between the list items
12419 Note that this is a command not a length so it doesn't require
12425 like the stuff mentioned above.
12428 \begin_layout Subsubsection
12429 Headers and Footers
12432 \begin_layout Standard
12445 commands control whether the logo in the
12449 definition appear on a given page.
12456 in the preamble then none of the foils will have the logo on them.
12457 If you don't want the logo on a particular page place the
12463 directly after the foilhead of that page and the
12469 directly after the next foilhead.
12472 \begin_layout Standard
12473 If you decide to use the
12477 page style setting in the
12480 \begin_inset space ~
12485 dialog you should probably add
12495 to your preamble so headers and footers on landscape pages are correctly
12496 placed when rotated.
12497 This is due to some clashes between the page layouts provided by the
12508 \begin_layout Section
12509 Hollywood (Hollywood spec scripts)
12512 \begin_layout Standard
12518 \begin_layout Subsection
12522 \begin_layout Standard
12523 Getting the format of a Hollywood script right is a
12524 \begin_inset Quotes eld
12528 \begin_inset Quotes erd
12531 It is designed to make the readers focus on content and to be easy and
12532 familiar for the actors to read.
12533 Each page of a script should be one minute of film.
12534 Nothing goes in a script that you cannot see or hear on screen.
12535 The courier 12 pt font should be used throughout.
12539 \begin_layout Subsection
12543 \begin_layout Standard
12544 Speakers' lines should NEVER break in mid-sentence.
12545 If a speaker's lines continue over a page break, repeat the
12549 title followed by (Cont'd).
12552 \begin_layout Subsection
12556 \begin_layout Standard
12561 names as labels then cross-reference the label to insert the name.
12562 The cross-reference dialog will show the current cast of characters.
12563 You can use this to insert the speaker name in narratives also.
12566 \begin_layout Subsection
12567 Paper size and Margins
12570 \begin_layout Standard
12571 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12574 \begin_layout Subsection
12578 \begin_layout Standard
12579 The following environments are available.
12580 You can use hollywood.bind to get the bind keys shown at the right.
12583 \begin_layout Itemize
12587 \begin_inset Newline newline
12592 Used where nothing else works.
12596 \begin_layout Itemize
12602 \begin_inset space \hfill{}
12610 \begin_inset Newline newline
12613 Usually followed by something like
12614 \begin_inset Quotes eld
12617 on Sally waking up.
12618 \begin_inset Quotes erd
12624 \begin_layout Itemize
12628 \begin_inset space \hfill{}
12632 \begin_inset Newline newline
12637 Introduces a new INTERIOR camera set-up.
12638 Always followed by DAY or NIGHT, or something similar to define the lighting
12640 Everthing on this line in CAPS.
12643 \begin_layout Itemize
12647 \begin_inset space \hfill{}
12651 \begin_inset Newline newline
12656 Introduces a new EXTERIOR camera set-up.
12657 Everthing on this line in CAPS.
12660 \begin_layout Itemize
12664 \begin_inset space \hfill{}
12668 \begin_inset Newline newline
12673 The character speaking.
12676 \begin_layout Itemize
12680 \begin_inset space \hfill{}
12684 \begin_inset Newline newline
12689 Instructions to the speaker.
12690 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12692 Both will be printed.
12695 \begin_layout Itemize
12699 \begin_inset space \hfill{}
12703 \begin_inset Newline newline
12715 \begin_layout Itemize
12719 \begin_inset space \hfill{}
12723 \begin_inset Newline newline
12728 Camera movement instruction.
12730 \begin_inset space \thinspace{}
12734 \begin_inset space \space{}
12740 \begin_layout Itemize
12744 \begin_inset space \hfill{}
12750 \begin_layout Itemize
12754 \begin_inset space \hfill{}
12760 \begin_layout Itemize
12764 \begin_inset space \hfill{}
12770 \begin_layout Itemize
12774 \begin_inset space \hfill{}
12780 \begin_layout Subsection
12784 \begin_layout Itemize
12788 \begin_layout Itemize
12792 \begin_layout Itemize
12794 \begin_inset space \thinspace{}
12801 \begin_layout Itemize
12806 \begin_layout Itemize
12807 PAN — camera movement
12810 \begin_layout Itemize
12811 INSERT — cut to close-up of
12814 \begin_layout Section
12818 \begin_layout Standard
12821 Panayotis Papasotiriou
12824 \begin_layout Subsection
12828 \begin_layout Standard
12829 The ijmpc package is a set of macros that facilitates electronic manuscript
12832 International Journal of Modern Physics C
12835 Similarly, the ijmpd package is for creating manuscripts to be submitted
12838 International Journal of Modern Physics D
12841 Both journals are published by World Scientific.
12842 The corresponding document classes are named
12851 These files, together with instructions for the authors, can be downloaded
12853 \begin_inset Flex URL
12856 \begin_layout Plain Layout
12858 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12864 \begin_inset Flex URL
12867 \begin_layout Plain Layout
12869 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12875 Both packages are modified versions of the standard
12876 \begin_inset Quotes eld
12880 \begin_inset Quotes erd
12883 package, and they are almost (but not exactly) identical.
12884 Most of their features are supported by \SpecialChar LyX
12886 I have used \SpecialChar LyX
12887 successfully to write articles submitted to both journals
12888 without any problem.
12891 \begin_layout Subsection
12895 \begin_layout Standard
12896 As usual, the easiest way to write a paper is to start with a template.
12899 File\SpecialChar menuseparator
12915 This will give an (almost) empty document that includes the most common
12916 fields found in a manuscript.
12917 Simply overwrite the existing text (including the brackets,
12922 You should keep in mind the following remarks.
12925 \begin_layout Enumerate
12927 won't let you change the font size and the page style of the document,
12928 because such modifications are not allowed by both packages.
12931 \begin_layout Enumerate
12932 The language of the document should not be changed.
12933 Before previewing your paper, be sure that the babel package is not used.
12934 To do this, click on
12936 Tools\SpecialChar menuseparator
12947 checkbox in the language settings, and click on
12955 , if you wish to make this change permanent).
12958 \begin_layout Enumerate
12960 \begin_inset Quotes eld
12964 \begin_inset Quotes erd
12967 style must be used to define keywords.
12970 \begin_layout Enumerate
12971 The ijmpc package provides a style named
12972 \begin_inset Quotes eld
12975 Classification Codes
12976 \begin_inset Quotes erd
12979 , which can be used to define classification codes, such as PACS numbers.
12980 Note that this facility is not supported by the ijmpd package.
12983 \begin_layout Enumerate
12984 Several new environments are available:
12985 \begin_inset Quotes eld
12989 \begin_inset Quotes erd
12993 \begin_inset Quotes eld
12997 \begin_inset Quotes erd
13001 \begin_inset Quotes eld
13005 \begin_inset Quotes erd
13009 \begin_inset Quotes eld
13013 \begin_inset Quotes erd
13017 \begin_inset Quotes eld
13021 \begin_inset Quotes erd
13025 \begin_inset Quotes eld
13029 \begin_inset Quotes erd
13033 \begin_inset Quotes eld
13037 \begin_inset Quotes erd
13041 \begin_inset Quotes eld
13045 \begin_inset Quotes erd
13049 \begin_inset Quotes eld
13053 \begin_inset Quotes erd
13057 \begin_inset Quotes eld
13061 \begin_inset Quotes erd
13065 \begin_inset Quotes eld
13069 \begin_inset Quotes erd
13073 \begin_inset Quotes eld
13077 \begin_inset Quotes erd
13081 \begin_inset Quotes eld
13085 \begin_inset Quotes erd
13089 \begin_inset Quotes eld
13093 \begin_inset Quotes erd
13097 Their use is more or less obvious.
13099 supports all these environments; it will use the proper label, text style,
13100 and numbering scheme for each of them.
13103 \begin_layout Enumerate
13104 Both packages use basic citations; the natbib package should not be used.
13105 In \SpecialChar LyX
13106 , citation references are shown as usual; in the output, citations are
13107 shown as superscripts.
13108 If you want to use a citation as normal text, you should use the
13113 \begin_inset space \thinspace{}
13117 \begin_inset space \space{}
13121 \begin_inset Quotes eld
13125 \begin_inset space \space{}
13135 \begin_inset Quotes erd
13141 \begin_layout Enumerate
13143 \begin_inset Quotes eld
13147 \begin_inset Quotes erd
13150 section in both packages.
13151 To put acknowledgments, just use the
13152 \begin_inset Quotes eld
13156 \begin_inset Quotes erd
13162 \begin_layout Enumerate
13163 Appendices may be added to the paper,
13167 the Acknowledgments and
13173 provides a special environment, called
13174 \begin_inset Quotes eld
13178 \begin_inset Quotes erd
13181 which marks the beginning of the appendices.
13182 This environment should be left blank; it just sends a \SpecialChar LaTeX
13183 command, but nothing
13185 In \SpecialChar LyX
13187 \begin_inset Quotes eld
13191 \begin_inset Quotes erd
13194 is printed with blue letters, as a signal that all sections after that
13195 point are appendices.
13196 To write an appendix, use the
13197 \begin_inset Quotes eld
13201 \begin_inset Quotes erd
13206 will number each appendix with capital letters, as required by both journals.
13208 \begin_inset Quotes eld
13212 \begin_inset Quotes erd
13219 be present before the first appendix; if not, all appendices will be numbered
13220 as normal sections in the output.
13223 \begin_layout Enumerate
13224 The ijmpc and the ijmpd packages use the
13228 command to implement table captions.
13229 As a result, a table created by \SpecialChar LyX
13230 is printed correctly, but its caption
13232 However, you can use some \SpecialChar TeX
13233 code to overcome this problem, so that captions
13234 are printed as expected.
13235 To do so, create a float table as usual, remove the caption, and replace
13236 it with the \SpecialChar TeX
13247 (sic); you must also the \SpecialChar TeX
13252 immediately after the tabular material.
13253 Study the example table included in the template files to see how this
13254 trick is implemented.
13255 Alternatively, If you need table captions, you should implement the whole
13260 file, then include this file to the \SpecialChar LyX
13263 Insert\SpecialChar menuseparator
13264 File\SpecialChar menuseparator
13266 \begin_inset space ~
13272 Details on how to create a table float can be found in the files
13280 , included in the corresponding packages.
13283 \begin_layout Subsection
13284 Preparing a paper for submission
13287 \begin_layout Standard
13288 Before you submit your paper you must export the \SpecialChar LyX
13289 document as a \SpecialChar LaTeX
13292 File\SpecialChar menuseparator
13293 Export\SpecialChar menuseparator
13301 \begin_layout Plain Layout
13302 Actually you have the choice between \SpecialChar LaTeX
13303 (plain) and pdflatex.
13304 If you intend to use pdflatex to prepare the paper, you should use the
13305 pdflatex option so that included graphics are converted to PDF format,
13306 ready for use by pdflatex.
13311 , then make the following changes to the resulting
13318 \begin_layout Enumerate
13319 Remove the comment lines before the
13328 \begin_layout Enumerate
13329 Remove everything between (and including) the
13341 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13345 \begin_layout Standard
13350 file should be saved and processed through \SpecialChar LaTeX
13351 as many times as necessary.
13352 You may also want to check the resulting
13359 \begin_layout Subsection
13360 Use of \SpecialChar TeX
13364 \begin_layout Standard
13365 The use of \SpecialChar TeX
13366 code is reduced to two commands, which must be placed at the
13367 top of the document.
13368 If you started writing your paper by using the
13376 template, the \SpecialChar TeX
13377 code needed is already in its place; you usually don't need
13379 You may only modify the first \SpecialChar TeX
13380 code to specify the information printed
13381 to the top of odd and even pages (authors' names and short paper's title,
13383 This \SpecialChar TeX
13384 code must have the form
13388 markboth{Authors' Names}{Short Paper's Title}
13393 \begin_layout Section
13397 \begin_layout Standard
13403 \begin_layout Subsection
13407 \begin_layout Standard
13408 The iopart package provides a document class to create electronic manuscript
13409 submission to the journals published by the Institute of Physics.
13410 Instructions for the authors how to create a paper using the iopart class
13411 can be downloaded together with the iopart package from the site
13412 \begin_inset Flex URL
13415 \begin_layout Plain Layout
13417 ftp://ftp.iop.org/pub/journals/latex2e
13425 \begin_layout Subsection
13429 \begin_layout Standard
13430 The easiest way to write a paper is to start with the file
13434 that is available in \SpecialChar LyX
13435 's examples files folder.
13436 Open this file, save it under a new name, and start writing.
13437 The example file explains how to use the special text environments.
13438 Here are the most important advices:
13441 \begin_layout Itemize
13442 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13445 Use AMS math package
13447 in the document settings under
13454 \begin_layout Itemize
13457 The title environment defines the kind of your paper.
13458 So use one of the following environments for the title:
13462 \begin_layout Itemize
13471 \begin_layout Itemize
13480 \begin_layout Itemize
13486 for a Topical review
13489 \begin_layout Itemize
13498 \begin_layout Itemize
13507 \begin_layout Itemize
13513 for a Paper (same as Title)
13516 \begin_layout Itemize
13522 for a Preliminary communication
13525 \begin_layout Itemize
13531 for a Rapid communication
13534 \begin_layout Itemize
13540 for a Letter to the editor
13544 \begin_layout Itemize
13547 All title environments except of
13551 can have an optional short title.
13554 \begin_layout Itemize
13555 There is a general title environment
13559 which is not directly supported by the \SpecialChar LyX
13561 This can be used as \SpecialChar TeX
13562 code when your document doesn't fit into one of the
13566 \begin_layout Standard
13567 For more informations like hints for special table and formula formatting,
13568 look at the IOP author guidelines.
13571 \begin_layout Section
13575 \begin_layout Standard
13578 Panayotis Papasotiriou
13581 \begin_layout Subsection
13585 \begin_layout Standard
13586 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13587 that facilitates electronic manuscript submission to the journals they
13589 Most known of them (at least in my domain of interest) are
13591 Astrophysics and Space Science
13597 , but there are many others (see a complete list at
13598 \begin_inset Flex URL
13601 \begin_layout Plain Layout
13603 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13609 The Kluwer package may be downloaded from the site
13610 \begin_inset Flex URL
13613 \begin_layout Plain Layout
13615 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13621 A complete user guide is contained in that package (but it can also be
13622 downloaded separately).
13625 \begin_layout Standard
13627 supports many features of the package but not everything.
13628 However, the \SpecialChar TeX
13629 code needed is reduced to some
13630 \begin_inset Quotes eld
13634 \begin_inset Quotes erd
13637 commands of the package (see
13638 \begin_inset space ~
13642 \begin_inset CommandInset ref
13644 reference "subsec:kluwer_peculiarities"
13649 I have recently used \SpecialChar LyX
13650 to write an article submitted to the
13652 Astrophysics and Space Science
13654 without any problem.
13657 \begin_layout Subsection
13661 \begin_layout Standard
13662 The easiest way to write a paper is to start with the Kluwer template file.
13665 File\SpecialChar menuseparator
13677 This will give an (almost) empty document that includes the most common
13678 fields found in a manuscript and a short description of their use.
13679 As in most templates, simply overwrite the existing text (including the
13684 ) with the correct information.
13687 \begin_layout Subsection
13688 Preparing a paper for submission
13691 \begin_layout Standard
13692 As in the AAS\SpecialChar TeX
13693 package, before you submit your paper to a journal you must
13695 \begin_inset Quotes eld
13699 \begin_inset Quotes erd
13705 \begin_layout Enumerate
13706 Export your paper as a \SpecialChar LaTeX
13708 To do this, click on
13710 File\SpecialChar menuseparator
13711 Export\SpecialChar menuseparator
13719 \begin_layout Enumerate
13724 file with a text editor and make the following changes
13728 \begin_layout Enumerate
13729 remove the comment lines before the
13738 \begin_layout Enumerate
13739 remove everything between (and including) the
13751 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13755 \begin_layout Standard
13764 \begin_layout Enumerate
13769 file through \SpecialChar LaTeX
13770 as many times as necessary (usually up to three).
13773 \begin_layout Enumerate
13779 \begin_inset space \thinspace{}
13783 \begin_inset space \space{}
13790 , and check if everything is OK (it should, if you didn't make any mistake).
13793 \begin_layout Subsection
13794 \begin_inset Quotes eld
13798 \begin_inset Quotes erd
13801 of the Kluwer package
13802 \begin_inset CommandInset label
13804 name "subsec:kluwer_peculiarities"
13811 \begin_layout Standard
13812 The Kluwer package has the following
13813 \begin_inset Quotes eld
13817 \begin_inset Quotes erd
13823 \begin_layout Enumerate
13824 It is possible to write multiple articles in the same \SpecialChar LaTeX
13829 \begin_layout Plain Layout
13830 I can't imagine any good reason to do this.
13836 Each article must be included in the environment
13837 \begin_inset Quotes eld
13841 \begin_inset Quotes erd
13845 Unfortunately, this environment cannot be omitted, even if you write just
13847 Therefore, each article starts with the command
13853 and, obviously, ends with the command
13860 Although this can be implemented in \SpecialChar LyX
13861 , I didn't included it, since it looks
13862 ugly and can confuse the novice user.
13863 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13866 \begin_inset Quotes eld
13871 \begin_inset Quotes erd
13877 \begin_layout Enumerate
13878 Information given at the beginning of the article (i.
13879 \begin_inset space \thinspace{}
13883 \begin_inset space \space{}
13886 title, subtitle, author, institution, running title, running author, abstract
13887 and keywords) must be included in an environment called
13888 \begin_inset Quotes eld
13892 \begin_inset Quotes erd
13896 This is not implemented in \SpecialChar LyX
13897 , so you must enter title, subtitle etc.
13898 \begin_inset space ~
13901 between two \SpecialChar TeX
13917 \begin_layout Enumerate
13918 According to the user manual, the label of each bibliography item must be
13942 \begin_layout Standard
13947 template takes care of all these
13948 \begin_inset Quotes eld
13952 \begin_inset Quotes erd
13956 If you start a new paper using this template you don't need to do anything
13961 \begin_layout Enumerate
13962 don't delete the \SpecialChar TeX
13963 code included in the template, and
13966 \begin_layout Enumerate
13967 copy the example bibliography item included in the template and modify it
13968 as necessary to enter new bibliography items.
13971 \begin_layout Section
13975 \begin_layout Standard
13981 \begin_layout Subsection
13985 \begin_layout Standard
13986 The \SpecialChar LyX
13989 article (koma-script)
13993 report (koma-script)
14011 correspond to the \SpecialChar LaTeX
14029 \begin_inset space ~
14032 of the Koma-Script family.
14033 They are replacements for the standard document classes
14049 , resp., and fit better to European typography conventions in a number of
14053 \begin_layout Itemize
14054 Standard character size is 11pt in
14056 article (koma-script)
14060 report (koma-script)
14068 letter (koma-script)
14073 \begin_layout Itemize
14074 Headings, labels of the description environment, and a number of elements
14077 letter (koma-script)
14079 document class are set in a bold sans serif font.
14083 \begin_layout Plain Layout
14084 There is a big difference between the bold sans serif old cm fonts and new
14085 ec fonts, especially in the appearance of headings.
14086 In comparison, the ec bold sans serif fonts look a bit thin.
14087 Here the \SpecialChar LaTeX
14096 helps to produce the
14097 \begin_inset Quotes eld
14101 \begin_inset Quotes erd
14104 appearance when using the ec fonts.
14109 The numbering of chapter headings is made in the same way as the numbering
14110 of section headings, that is without the extra line
14111 \begin_inset Quotes eld
14114 Chapter\SpecialChar ldots
14116 \begin_inset Quotes erd
14120 In addition, the appearance of the headings can be modified by using a
14121 number of options (in \SpecialChar LyX
14122 to be entered in the field
14125 \begin_inset space ~
14132 Layout\SpecialChar menuseparator
14139 \begin_layout Itemize
14140 The main means in the Koma-Script document classes to design the type area
14149 (in \SpecialChar LyX
14150 to be entered in the extra class options field in the dialog
14152 Document\SpecialChar menuseparator
14156 They make a clearer modification of page margins possible as do the options
14159 Document\SpecialChar menuseparator
14166 \begin_layout Itemize
14167 The \SpecialChar LaTeX
14168 document classes of the Koma-Script family define a number of additional
14170 Those part of it which makes sense in \SpecialChar LyX
14171 is implemented in corresponding
14175 \begin_layout Standard
14176 Detailed descriptions of the \SpecialChar LaTeX
14177 document classes of the Koma-Script family
14178 can be found in the Koma-Script documentation
14189 \begin_layout Subsection
14190 article (koma-script), report (koma-script), and book (koma-script)
14193 \begin_layout Standard
14194 The document classes
14196 article (koma-script)
14200 report (koma-script)
14210 are implemented in the layout files
14223 They contain all the paragraph types of the corresponding standard document
14236 , resp., partly modified, with the exception of the \SpecialChar LyX
14241 -type, which is replaced by the new
14245 -type having the same functionality.
14250 -Type there is a number of new paragraph types added.
14257 letter (koma-script)
14262 \begin_layout Itemize
14271 : are equivalents to
14279 , resp., additionally inserting an entry in the table of contents.
14288 are not contained in
14290 article (koma-script)
14295 \begin_layout Itemize
14304 : behave exactly as
14312 , resp., additionally clearing running heads.
14317 is not contained in
14319 article (koma-script)
14325 \begin_layout Plain Layout
14338 report (koma-script)
14340 , but since this is identical to
14344 , is has not been implemented in \SpecialChar LyX
14353 \begin_layout Itemize
14358 : generates a heading directly above the following paragraph in the standard
14359 character size without affecting the structure of the document.
14362 \begin_layout Itemize
14371 are special captions which respect the different space settings needed
14372 for captions placed above or below an element (if you follow strict typographic
14373 rules, you might want to place table captions always above the table).
14374 You can also use the class option
14378 , which will switch
14391 You need at least Koma-Script version 2.8q to use this.
14394 \begin_layout Itemize
14399 : can be used to set a bonmot, e.
14400 \begin_inset space \thinspace{}
14404 \begin_inset space \space{}
14407 at the beginning of a chapter.
14408 If you use the optional argument (
14410 Insert\SpecialChar menuseparator
14412 \begin_inset space ~
14417 ), you can insert the dictum's author there.
14418 Dictum and author are separated by a line.
14419 You need at least Koma-Script version 2.8q to use this.
14424 is not contained in
14426 article (koma-script)
14431 \begin_layout Standard
14432 The following types, together with the standard types
14444 , form the title area of the document.
14445 They must be entered ahead of the first
14446 \begin_inset Quotes eld
14450 \begin_inset Quotes erd
14457 \begin_layout Plain Layout
14458 The corresponding \SpecialChar LaTeX
14459 commands must appear before the
14470 When such a type is used more than once, the latter usage overwrites the
14471 former one, that means, for every type only the latest usage is valid.
14472 The order of the different types however has, like
14484 , no effect on the appearance of the produced document.
14487 \begin_layout Itemize
14492 : produces a centered paragraph above the ordinary title (
14504 ) for the subject of the document.
14507 \begin_layout Itemize
14512 : produces a centered paragraph below the ordinary title (
14524 ) for the publishers' name.
14527 \begin_layout Itemize
14534 report (koma-script)
14540 produces a centered paragraph on its own page behind the title page, or
14543 article (koma-script)
14545 produces a centered paragraph below the ordinary title (
14561 ) for a dedication.
14564 \begin_layout Itemize
14569 : produces a left aligned paragraph above the ordinary title (
14585 ) for a document`s head.
14588 \begin_layout Itemize
14593 : produces in a double-sided print in
14595 report (koma-script)
14601 a left-aligned paragraph at the top of the title page`s back or has no
14602 effect in a single-sided print or in
14604 article (koma-script)
14609 \begin_layout Itemize
14614 : produces in a double-sided print in
14616 report (koma-script)
14622 a left-aligned paragraph at the bottom of the title page`s back or has
14623 no effect in a single-sided print or in
14625 article (koma-script)
14630 \begin_layout Itemize
14635 : produces a special
14636 \begin_inset Quotes eld
14640 \begin_inset Quotes erd
14643 page ahead of the actual document containing a paragraph without special
14647 \begin_layout Standard
14648 The layout files for the document classes
14650 article (koma-script)
14654 report (koma-script)
14660 do include the file
14665 This is thought of as a place to define your own types.
14670 in your personal layout directory and edit the file!
14673 \begin_layout Subsection
14674 letter (koma-script)
14677 \begin_layout Standard
14681 letter (koma-script)
14683 is implemented in the layout file
14688 It contains all the paragraph types of the corresponding standard document
14693 , partly modified, with the exception of the \SpecialChar LyX
14707 type, which is replaced by the new
14712 In addition, it contains, in contrast to the standard document class, the
14731 Furthermore, there are a number of new letter specific types.
14734 \begin_layout Standard
14735 The appearance of the letter produced by this document class can be controlled
14736 by a number of \SpecialChar LaTeX
14737 commands, which you can put in the \SpecialChar LaTeX
14742 \begin_layout Plain Layout
14743 For example, the standard appearance of the letter`s heading, consisting
14744 of name and address, is quite self-willed.
14746 \begin_inset Quotes eld
14750 \begin_inset Quotes erd
14753 heading is produced by the following \SpecialChar LaTeX
14754 commands in the preamble:
14757 \begin_layout LyX-Code
14767 \begin_layout LyX-Code
14783 \begin_layout LyX-Code
14793 \begin_layout LyX-Code
14813 A detailed German description of such \SpecialChar LaTeX
14814 commands can be found in the Koma-Script
14820 With it, the letter's author can produce his personal letter layout.
14823 \begin_layout Standard
14832 define the beginning of the letter and must be used in every letter.
14833 To emphasize them in the \SpecialChar LyX
14834 document class, they are marked with the letter
14844 \begin_inset space ~
14847 in the left margin.
14848 It is possible to write any number of letters in one file.
14853 type produces a new letter using the same addressee and a
14857 type produces a new addressee.
14874 are ordinary paragraph types and can also be used several times in one
14875 and the same letter.
14878 \begin_layout Itemize
14883 : produces a paragraph for the addressee and implicitly defines the beginning
14887 \begin_layout Itemize
14892 : produces a paragraph for the form of address and implicitly produces a
14896 \begin_layout Itemize
14901 : produces a paragraph for a close.
14904 \begin_layout Itemize
14909 : produces a paragraph for a postscript.
14912 \begin_layout Itemize
14917 : produces a paragraph for a distribution list.
14920 \begin_layout Itemize
14925 : produces a paragraph for enclosures.
14928 \begin_layout Standard
14969 are input types provided with a label to enter information, which will
14970 be processed by the document class.
14974 \begin_layout Plain Layout
14975 It could be seen as a matter of inconsequence, that the types
14983 described above are not such input types as well.
14984 Because of the special meaning of those types, however, I have implemented
14985 them as ordinary paragraph types with a one letter mark in the left margin.
14986 Moreover, it would affect my feeling of symmetry, if the
14994 type had such a serious different appearance.
14999 The types must be used ahead of the corresponding
15006 \begin_layout Standard
15007 An implementation of these types in a WYSIWYG fashion does not seem to make
15008 sense, because the real appearance of the produced letter does not only
15009 depend on the usage of the particular type, but also on other factors.
15010 For example, a signature entered in the
15014 type will in the standard behavior appear in the produced letter only,
15015 when in the same letter also a
15020 The entered value of the
15024 type will in the standard behavior not appear in the produced letter at
15026 The possibility to design the letter`s heading freely is already indicated
15027 in a footnote above.
15030 \begin_layout Standard
15031 The input types can also be used as empty paragraphs.
15032 This makes sense e.
15033 \begin_inset space \thinspace{}
15037 \begin_inset space \space{}
15049 type is not used at all, in the standard behavior the value of the
15053 type is used as signature, whereas if an empty
15057 type is used, no signature value is defined.
15060 \begin_layout Standard
15061 By using the input types it is possible to write a letter template, containing
15062 filled input types with your personal dates (name, address, etc.) and empty
15063 input types for other dates you want to enter.
15066 \begin_layout Itemize
15071 : sender's name, in the standard behavior appears as a centered paragraph
15072 in small caps in the letter`s heading.
15075 \begin_layout Itemize
15080 : sender's signature, in the standard behavior appears below the
15089 type is used, the value of the
15093 type appears instead.
15096 \begin_layout Itemize
15101 : sender's address, in the standard behavior appears in a centered paragraph
15102 in the letter`s heading below the sender's name.
15105 \begin_layout Itemize
15110 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15121 \begin_layout Itemize
15126 : place of the letter`s making.
15129 \begin_layout Itemize
15134 : date of the letter`s making.
15143 , in the standard behavior, produce the place and the date in a right-aligned
15144 line below the addressee's field.
15149 type is used, neither place nor date appear, independent of the value of
15159 type is used, the date of the letter `s production is used.
15162 \begin_layout Itemize
15167 : sender`s back address, in the standard behavior appears above the addressee's
15168 field in a small sans serif font.
15171 \begin_layout Itemize
15176 : special mail information, in the standard behavior appears underlined
15177 above the addressee's field below the back address.
15180 \begin_layout Itemize
15185 : additional information, in the standard behavior appears on right side
15186 below the addressee`s field.
15189 \begin_layout Itemize
15194 : the letter's title, in the standard behavior appears in a big, bold, sans
15195 serif font above the subject.
15198 \begin_layout Itemize
15203 : the letter's subject, in the standard behavior appears in a bold font
15211 \begin_layout Standard
15232 produce a business letter like line above the
15236 line containing the fields
15237 \begin_inset Quotes eld
15241 \begin_inset Quotes erd
15245 \begin_inset Quotes eld
15249 \begin_inset Quotes erd
15253 \begin_inset Quotes eld
15257 \begin_inset Quotes erd
15261 \begin_inset Quotes eld
15265 \begin_inset Quotes erd
15269 \begin_inset Quotes eld
15273 \begin_inset Quotes erd
15277 \begin_inset Quotes eld
15281 \begin_inset Quotes erd
15285 For the date field, the value of the
15291 \begin_inset Quotes eld
15294 business letter types
15295 \begin_inset Quotes erd
15298 is used, the value of the
15302 type however does not appear, but only the \SpecialChar LaTeX
15310 The ordinary output of place and date in a right-aligned line below the
15311 addressee`s field is suppressed.
15312 The types are implemented as input types provided with a label and must
15313 be used ahead of the corresponding
15320 \begin_layout Itemize
15328 \begin_layout Itemize
15336 \begin_layout Itemize
15344 \begin_layout Itemize
15352 \begin_layout Itemize
15360 \begin_layout Subsection
15361 The new letter class: letter (koma-script v.2)
15364 \begin_layout Standard
15370 \begin_layout Standard
15371 \begin_inset VSpace medskip
15377 \begin_layout Standard
15379 Koma-Script version 2.8 has introduced a new letter class
15383 which supersedes the now unsupported
15388 It has — on the \SpecialChar LaTeX
15389 side — a completely new interface and is not compatible
15390 with the old class.
15391 Therefore, \SpecialChar LyX
15392 supports both, though it is recommended you use the new class.
15395 \begin_layout Standard
15396 This class covers the same functionality as
15398 letter (koma-script),
15401 The basic items are
15405 (receiver's address, same as
15409 in the old layout),
15422 will start a new letter (i.
15423 \begin_inset space \thinspace{}
15427 \begin_inset space \space{}
15430 you can write several letters per document).
15431 New elements are sender's
15447 and the possibility to use a
15453 Insert\SpecialChar menuseparator
15459 \begin_layout Standard
15460 The biggest improvement is, though, that the letter's layout is configurable
15461 to meet almost any needs.
15462 This can be done via the preamble or with a special style file (Letter
15463 Class Option, extension
15467 ), that will be read in as a class option.
15471 \begin_layout Plain Layout
15472 The KOMA package comes with some default
15477 There is, for instance, a
15481 file that follows german typesetting rules, or a
15485 that provides the default layout of the old
15490 The latter can be loaded with the class option
15496 Layout\SpecialChar menuseparator
15497 Document\SpecialChar menuseparator
15509 template that is included in \SpecialChar LyX
15511 A detailed description is to be found in the Koma-Script documentation
15519 \begin_layout Subsection
15523 \begin_layout Standard
15524 Visualizing the Koma-Script document classes in \SpecialChar LyX
15525 , the \SpecialChar LyX
15526 internals cause some
15530 \begin_layout Itemize
15531 The chapter number of a
15535 type appears on a line of its own above the chapter heading instead of
15536 appearing in the same line ahead of it.
15537 The cause for that is the \SpecialChar LyX
15538 internal behavior for the labeltype
15542 in the layout file.
15545 \begin_layout Itemize
15546 The headings of the types
15554 are only put in the
15555 \begin_inset Quotes eld
15559 \begin_inset Quotes erd
15563 table of contents, but not in the \SpecialChar LyX
15564 table of contents (
15566 Document\SpecialChar menuseparator
15568 \begin_inset space ~
15572 \begin_inset space ~
15580 \begin_layout Itemize
15581 The paragraphs in a
15585 document class appear in a skip separation mode, not indented.
15586 This is the standard behavior, no special \SpecialChar LaTeX
15587 commands are needed for that.
15590 Document\SpecialChar menuseparator
15593 dialog the corresponding radio button indicates
15602 value always has the effect that extra \SpecialChar LaTeX
15603 commands are inserted in the document
15604 to produce the gap, which is not what is wanted in this case.
15607 \begin_layout Section
15611 \begin_layout Standard
15617 \begin_layout Subsection
15621 \begin_layout Standard
15622 Memoir is a very powerful and constantly evolving class.
15623 It has been designed with regard to fictional and non-fictional literature.
15624 Its aim is to let the user have maximum control over the typesetting of
15626 Memoir is based on the standard book class, but it can also emulate the
15627 article class (see below).
15630 \begin_layout Standard
15631 Peter Wilson, the developer of Memoir, is known as the author of lots of
15632 useful packages in the \SpecialChar LaTeX
15634 Most of them have been merged with Memoir.
15635 Therefore, it is much easier to layout the table of contents, appendices,
15636 chapter designs and such.
15638 , though, does not support all of these goodies natively.
15639 Some of them might be added to forthcoming releases
15643 \begin_layout Plain Layout
15644 You are invited to send suggestions to
15645 \begin_inset Flex URL
15648 \begin_layout Plain Layout
15650 lyx-devel@lists.lyx.org
15660 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15662 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15664 commands (\SpecialChar TeX
15669 \begin_layout Plain Layout
15674 \begin_layout Plain Layout
15684 \begin_inset space ~
15688 \begin_inset CommandInset ref
15690 reference "sec:Inserting-TeX-Code"
15700 In this section, we can only list those features that are natively supported
15701 by \SpecialChar LyX
15703 For detailed descriptions (and for the rest of features) we recommend you
15704 have a look at the detailed manual of the Memoir class
15708 \begin_layout Plain Layout
15713 \begin_layout Plain Layout
15723 \begin_inset Flex URL
15726 \begin_layout Plain Layout
15728 CTAN:/macros/latex/memoir/memman.pdf
15738 , which is not only a user guide for the class, but also both a comprehensive
15739 description on good typesetting and a superb example for good typesetting
15743 \begin_layout Subsection
15744 Basic features and restrictions
15747 \begin_layout Standard
15748 Memoir supports basically all features of the standard book classes.
15749 There are, however, some differences, as follows:
15752 \begin_layout Description
15754 \begin_inset space ~
15757 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15760 \begin_layout Description
15762 \begin_inset space ~
15765 style: The fancy page style is not supported, due to a command clash between
15766 Memoir and the fancyhdr package (they both define a command with the same
15767 name, which confuses \SpecialChar LaTeX
15769 Instead, Memoir comes with a number of its own page styles (see
15771 Layout\SpecialChar menuseparator
15772 Document\SpecialChar menuseparator
15774 \begin_inset space ~
15780 If you want to use these for the chapter pages, you have to use the command
15787 in the main text or in preamble (e.
15788 \begin_inset space \thinspace{}
15792 \begin_inset space \space{}
15799 chapterstyle{companion}
15804 \begin_layout Description
15805 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15806 optional argument in the standard classes.
15807 With this, you can specify an alternative version of the title for the
15808 table of contents and the headers (for instance, if the title is too long).
15809 In \SpecialChar LyX
15810 , you can do this via
15812 Insert\SpecialChar menuseparator
15814 \begin_inset space ~
15819 at the beginning of a chapter/section.
15820 Memoir features a second optional argument and thus separates the table
15821 of contents from the header.
15822 You can define three variants of a title with this: one for the main text,
15823 one for the table of contents, and one for the headers.
15824 Simply insert two optional arguments if you need this feature, the first
15825 one containing the short title for the Table of Contents, the second one
15826 containing an alternative short title for the headers.
15829 \begin_layout Description
15830 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15831 of contents, the list of figures and the list of table start a new page
15833 Memoir does not follow this route.
15834 You have to insert a page break yourself, if you want to have one.
15837 \begin_layout Description
15838 Titlepage: For some unknown reason, Memoir uses pagination on the title
15839 page (in the standard classes, title pages are
15840 \begin_inset Quotes eld
15844 \begin_inset Quotes erd
15848 If you want an empty title page, type
15852 aliaspagestyle{title}{empty}
15857 \begin_layout Description
15858 Article: With the class option
15864 Layout\SpecialChar menuseparator
15865 Document\SpecialChar menuseparator
15867 \begin_inset space ~
15872 ), you can emulate article style.
15873 That is, counters (footnotes, figures, tables etc.) will not be reset on
15874 new chapters, chapters don't start a new page (but are—in contrary to
15875 \begin_inset Quotes eld
15879 \begin_inset Quotes erd
15882 article classes—still allowed), parts, though, use their own page, as in
15886 \begin_layout Description
15887 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15888 font commands, which have been used in the old \SpecialChar LaTeX
15890 \begin_inset space \thinspace{}
15894 \begin_inset space \space{}
15910 It produces an error and stops \SpecialChar LaTeX
15911 whenever such a command appears.
15916 reallows the commands and spits out warnings instead (which does at least
15917 not stop \SpecialChar LaTeX
15919 Since a lot of packages and particularly Bib\SpecialChar TeX
15920 style files are still using
15921 those commands, we have decided to use this option by default.
15924 \begin_layout Subsection
15928 \begin_layout Standard
15929 We will only describe the features supported by \SpecialChar LyX
15930 (which is not much currently).
15931 Please consult the Memoir manual
15935 \begin_layout Plain Layout
15940 \begin_layout Plain Layout
15950 \begin_inset Flex URL
15953 \begin_layout Plain Layout
15955 CTAN:/macros/latex/memoir/memman.pdf
15968 \begin_layout Description
15969 Abstract: You may wonder why an abstract is an extra feature.
15970 Well, it is in book class.
15971 Usually books don't have abstracts.
15972 Memoir, however, has.
15973 You can use it wherever and how often you like.
15976 \begin_layout Description
15977 Chapterprecis: You may know this older typesetting style: The contents of
15978 a chapter are summarized below the title and also in the table of contents
15980 \begin_inset space \thinspace{}
15984 \begin_inset space \space{}
15989 Our hero arrives in Troia; he loses some friends; he finds others
15992 Chapterprecis does exactly this.
15993 It is therefore only sensible below a chapter.
15996 \begin_layout Description
15997 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15998 The epigraph environment provides an elegant way of typesetting such a
16000 The motto itself (text) and its author (source) are divided by a short
16002 Unfortunately, we have to fool \SpecialChar LyX
16003 a bit here again, since the environment
16004 needs two arguments (text and source).
16005 In this case, we have to use curly brackets (in \SpecialChar TeX
16006 mode) between the two
16017 <author of the slogan>.
16020 \begin_layout Description
16021 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16022 complex figurative poems).
16024 can only support a few of them.
16025 One is poemtitle, which is a centered title for poems, which will also
16026 be added to the table of contents (verse is the standard environment for
16028 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16030 because they have to be nested inside regular verse environments, which
16031 is not possible with \SpecialChar LyX
16035 \begin_layout Description
16036 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16039 \begin_layout Section
16040 Article (mwart), book (mwbk) and report (mwrep)
16041 \begin_inset Argument status
16044 \begin_layout Plain Layout
16057 \begin_layout Standard
16063 \begin_layout Standard
16064 The \SpecialChar LyX
16081 correspond to the \SpecialChar LaTeX
16095 They are replacements for the standard document classes
16107 , resp., and fit better to Polish typography conventions in a number of points.
16111 \begin_layout Standard
16115 \begin_layout Itemize
16116 Unnumbered titles (with star, e.
16117 \begin_inset space \thinspace{}
16121 \begin_inset space \space{}
16128 ) are added into table of contents,
16131 \begin_layout Itemize
16132 Additional page styles:
16136 \begin_layout Description
16137 uheadings header with separated lines,
16140 \begin_layout Description
16141 myheadings custom header, contents headers via commands:
16156 \begin_layout Description
16157 myuheadings custom header with separated lines,
16160 \begin_layout Description
16161 outer page number is placed on outer side of page
16165 \begin_layout Itemize
16170 \begin_layout Description
16171 rmheadings serif titles — default,
16174 \begin_layout Description
16175 sfheadings sansserif titles,
16178 \begin_layout Description
16179 authortitle on title page first placed is author next title — default,
16182 \begin_layout Description
16183 titleauthor on title page first placed is title next author,
16186 \begin_layout Description
16187 withmarginpar reserve place on page for margins.
16191 \begin_layout Section
16195 \begin_layout Standard
16200 provides an alternative to the standard
16205 It provides similar functionality, but you might prefer this layout with
16206 sans serif sections, headings, and more.
16209 \begin_layout Section
16210 Rev\SpecialChar TeX
16214 \begin_layout Standard
16220 \begin_layout Standard
16221 \begin_inset VSpace bigskip
16227 \begin_layout Standard
16232 \begin_inset space ~
16237 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16239 \begin_inset Formula $\beta$
16242 release of May, 1999) class.
16245 \begin_layout Standard
16251 textclass, which works with Rev\SpecialChar TeX
16253 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16255 That means that it doesn't interact very well with \SpecialChar LyX
16256 , which requires \SpecialChar LaTeX2e
16258 it has been kludged to work.
16259 Since Rev\SpecialChar TeX
16260 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16265 Rev\SpecialChar TeX
16267 \begin_inset space ~
16272 textclass should also be pretty easy to use.
16275 \begin_layout Standard
16276 These documents are supposed to be used in
16280 to the Rev\SpecialChar TeX
16281 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16283 and assume you'll know what to put in the preamble if necessary.
16286 \begin_layout Subsection
16290 \begin_layout Standard
16291 All you need to do is install Rev\SpecialChar TeX
16292 4, as described in the package's README
16294 The package can be found at The Rev\SpecialChar TeX
16296 \begin_inset Flex URL
16299 \begin_layout Plain Layout
16301 http://publish.aps.org/revtex4/
16307 Install it somewhere that \SpecialChar LaTeX
16309 Test it by trying to \SpecialChar LaTeX
16310 a short Rev\SpecialChar TeX
16311 4 document in some random directory (i.
16312 \begin_inset space \thinspace{}
16316 \begin_inset space \space{}
16319 not the directory where you installed the class file.) Then, if you reconfigure
16321 , it will find the class file and let you use the Rev\SpecialChar TeX
16325 \begin_layout Standard
16326 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16335 \begin_inset space ~
16340 template, found in the templates directory.
16343 \begin_layout Subsection
16347 \begin_layout Standard
16348 Optional arguments to
16355 \begin_inset Quotes eld
16359 \begin_inset Quotes erd
16363 \begin_inset Quotes eld
16367 \begin_inset Quotes erd
16373 \begin_inset space ~
16381 \begin_inset space ~
16387 Remember that in Rev\SpecialChar TeX
16388 , at least one optional argument is required!
16391 \begin_layout Standard
16392 Other preamble matter, like
16399 \begin_inset space ~
16406 \begin_inset space ~
16411 dialog, also as usual.
16414 \begin_layout Subsection
16418 \begin_layout Standard
16419 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16421 For example, the Email layout corresponds to
16428 Note that (at least as of Rev\SpecialChar TeX
16437 layouts are exactly equivalent, so you shouldn't need to use both.
16441 \begin_layout Plain Layout
16442 In case you're curious, both were included so that
16446 would be able to translate both
16466 \begin_layout Subsection
16470 \begin_layout Standard
16471 There are a couple of important unique aspects of Rev\SpecialChar TeX
16472 4 which might cause
16473 bugs that will be even more confusing in \SpecialChar LyX
16477 \begin_layout Standard
16478 In Rev\SpecialChar TeX
16496 The \SpecialChar LyX
16497 equivalent is that there is a separate Thanks layout.
16502 write footnotes in the
16506 layout, or weird things may happen.
16507 See the Rev\SpecialChar TeX
16508 4 documentation for more details.
16511 \begin_layout Standard
16515 \begin_inset space ~
16523 \begin_inset space ~
16532 layouts must be placed
16540 layout and the corresponding
16557 , the \SpecialChar LaTeX
16561 \begin_layout Subsection
16565 \begin_layout Standard
16566 The main problem with this layout is that you can't use the optional arguments
16567 to layouts like Email and Title.
16568 (The problem is not unique to this layout; you can't use optional arguments
16569 to the Section layouts either.) This means that after you export that file
16570 to \SpecialChar LaTeX
16571 (which you'll need to do eventually to send it in to APS), you'll need
16572 to edit the \SpecialChar LaTeX
16573 file with a text editor to add the optional arguments to set,
16575 \begin_inset space \thinspace{}
16579 \begin_inset space \space{}
16582 the running title for the page headers.
16583 Lacking these layouts makes the
16589 (and the equivalent
16595 ) useless, so the corresponding layouts don't exist, and will have to be
16600 \begin_layout Plain Layout
16605 actually, \SpecialChar LyX
16606 1.3.0 supports some forms of optional arguments, but this layout
16607 has not been updated yet to take advantage of it.
16615 \begin_layout Section
16616 Springer Journals (
16623 \begin_layout Standard
16629 \begin_layout Subsection
16633 \begin_layout Standard
16634 These are the layout files for some of the journal formats used by Springer
16635 Verlag and listed on
16636 \begin_inset Flex URL
16639 \begin_layout Plain Layout
16641 http://www.springer.de/author/tex/help-journals.html
16646 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16648 It is a modular system: the things common to all journals are implemented
16653 , which journal-specific layout files (such as, e.
16654 \begin_inset space \thinspace{}
16658 \begin_inset space \space{}
16665 for Journal of Geodesy) can include.
16668 \begin_layout Standard
16669 This means that implementing support for any other Springer journal on this
16670 list is as simple as writing your own
16678 file following the outline given in
16686 \begin_layout Standard
16687 It is reasonably well tested only for the Journal of Geodesy.
16696 come with the standard \SpecialChar LyX
16698 Install the relevant class file (downloaded from Springer) in a proper
16699 directory, reconfigure \SpecialChar LaTeX
16700 (in the te\SpecialChar TeX
16705 , as root if necessary — doesn't \SpecialChar LyX
16706 take care of this?), reconfigure \SpecialChar LyX
16711 \begin_layout Subsection
16715 \begin_layout Standard
16716 A large number of theorem-like styles —
16728 \begin_layout Standard
16731 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16732 _Title, Author_Running, Institute,
16733 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16736 See the Springer class file documentation for details.
16739 \begin_layout Subsection
16743 \begin_layout Itemize
16755 \begin_layout Itemize
16758 Probability Theory and Related Fields
16764 — Jean-Marc Lasgouttes
16767 \begin_layout Standard
16768 Add your own, it isn't so hard!
16771 \begin_layout Subsection
16775 \begin_layout Standard
16776 These files are partly based on the older
16780 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16782 file from Springer.
16787 layout, are now defunct.
16788 Jean-Marc Lasgouttes helped out big in making me find my way around the
16790 layout file mechanism.
16793 \begin_layout Subsection
16797 \begin_layout Standard
16799 But probably less than in the old hacked-\SpecialChar LaTeX
16807 \begin_layout Standard
16809 \begin_inset space \thinspace{}
16812 g.: does not display the number for theorem-like layouts, just #.
16815 \begin_layout Section
16818 Sli\SpecialChar TeX
16822 \begin_inset CommandInset label
16831 \begin_layout Standard
16839 \begin_layout Subsection
16843 \begin_layout Standard
16844 This section describes how to use \SpecialChar LyX
16845 to make slides for overhead projectors.
16846 There are two document classes that can do this: the default slides class
16849 Foil\SpecialChar TeX
16853 This section documents the former.
16856 \begin_layout Standard
16857 I'm going to say this again, nice and clear, so that there's no misunderstanding
16861 \begin_layout Standard
16862 \begin_inset VSpace bigskip
16868 \begin_layout Standard
16872 This section documents the class
16873 \begin_inset Quotes eld
16881 \begin_inset Quotes erd
16889 \begin_layout Standard
16890 \begin_inset VSpace bigskip
16896 \begin_layout Standard
16897 If you're looking for the documentation for
16898 \begin_inset Quotes eld
16903 slides (Foil\SpecialChar TeX
16907 \begin_inset Quotes erd
16910 , check out section
16911 \begin_inset space ~
16915 \begin_inset CommandInset ref
16917 reference "sec:foiltex"
16927 \begin_inset Quotes eld
16932 slides (Foil\SpecialChar TeX
16936 \begin_inset Quotes erd
16939 ] is actually somewhat better than the default
16947 \begin_layout Plain Layout
16949 or so I've been told repeatedly by its advocates.
16950 Having never used it, I have no idea if this claim is true or not.
16955 which this section documents.
16958 \begin_layout Standard
16959 This class is the \SpecialChar LaTeX2e
16960 improvement of the old
16962 Sli\SpecialChar TeX
16966 Every \SpecialChar LaTeX2e
16967 distribution includes this class [which I'll just refer to as
16968 \begin_inset Quotes eld
16976 \begin_inset Quotes erd
16979 from now on], so you're bound to have it.
16980 As I noted earlier, there are other classes, such as
16984 , which also produce slides for overhead projectors and do a better job
16986 However, there are some things which
16990 can do which the others can't, such as generate overlays.
16991 Read on to learn more!
16994 \begin_layout Subsection
16996 \begin_inset CommandInset label
16998 name "sec:slidesetup"
17005 \begin_layout Standard
17006 Obviously, to use this document class, you need to select
17007 \begin_inset Quotes eld
17015 \begin_inset Quotes erd
17018 from the class list in the
17020 Document\SpecialChar menuseparator
17024 There are some other special things you should know about this class:
17027 \begin_layout Itemize
17028 Don't bother changing the options
17033 They're not supported by the
17040 \begin_layout Itemize
17044 \begin_inset space ~
17049 behaves a bit differently for this class.
17050 The possible choices and what they do are as follows:
17054 \begin_layout Description
17059 The final output contains page numbers in the lower right corner.
17062 \begin_layout Description
17071 , but also prints out any time markers you've put in.
17072 This is the default.
17075 \begin_layout Description
17080 The final output contains no page numbers, time markers, or alignment markers.
17084 \begin_layout Itemize
17089 class has an extra option:
17095 \begin_inset Quotes eld
17103 \begin_inset Quotes erd
17106 in the extra class options.
17110 \begin_layout Standard
17111 Using this options allows you to add time markers to
17117 \begin_inset space ~
17121 \begin_inset CommandInset ref
17123 reference "sec:slideNote"
17131 \begin_layout Standard
17132 You can also use the template file
17133 \begin_inset Quotes eld
17141 \begin_inset Quotes erd
17144 to automatically set up a document to use the
17150 File\SpecialChar menuseparator
17152 \begin_inset space ~
17156 \begin_inset space ~
17161 to open your new document].
17162 The template file also contains some examples of the special paragraph
17163 environments used by this class.
17164 I'll describe those next.
17167 \begin_layout Subsection
17168 Paragraph Environments
17171 \begin_layout Subsubsection
17172 Supported Environments
17175 \begin_layout Standard
17176 The first thing you'll notice when you start up a new
17180 document is the font size and type: it's the equivalent of the size
17181 \begin_inset Quotes eld
17189 \begin_inset Quotes erd
17195 \begin_inset space ~
17201 This is also what's used in the output.
17203 \begin_inset Quotes eld
17207 \begin_inset Quotes erd
17210 to remind you that this is a slide.
17211 Your final slides will use a larger font; ergo, you'll have less space.
17212 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17215 \begin_layout Standard
17216 The next thing that becomes obvious is the changes to the paragraph environment
17217 pull-down box [at the far-left end of the toolbar].
17218 Most of the paragraph environments you're used to seeing are missing.
17219 There are also five new ones.
17224 class itself only supports certain paragraph environments:
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
17275 \begin_layout Itemize
17281 \begin_layout Itemize
17288 \begin_layout Itemize
17294 \begin_layout Standard
17295 All of the other standard environments, including the section-heading environmen
17296 ts, aren't used in the
17303 \begin_layout Standard
17304 On the other hand, you'll notice the following new environments:
17307 \begin_layout Itemize
17313 \begin_layout Itemize
17319 \begin_layout Itemize
17325 \begin_layout Itemize
17331 \begin_layout Itemize
17337 \begin_layout Standard
17338 These five are kind of quirky, due to a
17339 \begin_inset Quotes eld
17343 \begin_inset Quotes erd
17346 in \SpecialChar LyX
17348 You see, \SpecialChar LyX
17349 doesn't permit you to nest any other paragraph environment into
17350 an empty environment.
17351 Now, that's fine and dandy, but it means that you wouldn't be able to start
17352 a slide with anything except plain text.
17353 To deal with this, I've performed a little
17354 \begin_inset Quotes eld
17359 \begin_inset Quotes erd
17365 \begin_layout Subsubsection
17366 Quirks of the New Environments
17367 \begin_inset CommandInset label
17369 name "sec:slideQuirk"
17376 \begin_layout Standard
17377 All five of the new paragraph environments are somewhat quirky due to inherent
17378 limitiations in the current version of \SpecialChar LyX
17380 As I just mentioned, \SpecialChar LyX
17381 forbids environments that begin with another environment.
17382 To get around this, the
17386 environment isn't a paragraph environment as described in the
17394 \begin_layout Standard
17395 You should consider
17408 \begin_inset Quotes eld
17411 pseudo-environments.
17412 \begin_inset Quotes erd
17415 They look like a section heading or a
17416 \begin_inset Quotes eld
17424 \begin_inset Quotes erd
17427 but really begin a [and, if necessary, end the previous] paragraph environment.
17437 \begin_inset Quotes eld
17441 \begin_inset Quotes erd
17444 These two perform some action.
17447 \begin_layout Standard
17448 A common feature of all five environments,
17468 , is a rather long-ish label.
17469 The text following this label — ordinarily the contents of the paragraph
17470 environment — is utterly irrelevant for
17492 completely ignores it.
17493 In fact, you can leave these five environments completely empty.
17497 \begin_layout Standard
17502 to put any text after the rather long-ish label, you might want to.
17503 This could be a short description of the contents of the
17508 In that case, enter your descriptive comment and hit
17512 as you normally would.
17515 \begin_layout Standard
17516 If, on the other hand, you don't want to enter any descriptive text, you'll
17517 hit another \SpecialChar LyX
17520 , like nature, abhors a vacuum, and will not let you start a new paragraph
17521 environment until you put something in the old one.
17525 \begin_layout Itemize
17526 Start entering the text that will
17554 \begin_layout Itemize
17555 Now move to the beginning of that paragraph.
17559 \begin_layout Itemize
17568 \begin_layout Itemize
17569 Finally, change this new, empty paragraph to a
17593 \begin_layout Standard
17594 Some future version of \SpecialChar LyX
17595 will, hopefully, resolve this quirkiness\SpecialChar ldots
17599 \begin_layout Subsection
17600 Making a Presentation with
17613 \begin_layout Subsubsection
17621 \begin_layout Standard
17622 If you're expecting this section to teach you how to actually make a presentatio
17623 n, you'll be sorely disappointed.
17624 Naturally, I'll describe all of the ways the
17628 class can assist you in preparing the materials for a presentation.
17629 Filling in the contents, however, is up to you.
17634 the \SpecialChar LyX
17638 \begin_layout Standard
17643 environment [in the manner described in section
17644 \begin_inset space ~
17648 \begin_inset CommandInset ref
17650 reference "sec:slideQuirk"
17654 ] tells \SpecialChar LyX
17655 to begin a new slide [duh].
17656 The label for this environment/
17657 \begin_inset Quotes erd
17661 \begin_inset Quotes erd
17665 \begin_inset Quotes eld
17669 \begin_inset Quotes erd
17672 in cool blue, followed by the label,
17673 \begin_inset Quotes eld
17677 \begin_inset Quotes erd
17681 Any text or paragraph environments that follow this one go on the new slide.
17685 \begin_layout Standard
17686 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17688 (this can be specified in the
17693 In fact, you'll want to, once you finish entering the contents of one slide.
17694 If you've entered more text than can physically fit on a slide, the extra
17695 overflows onto a new slide.
17696 I don't recommend doing this, however, since the overflow slide won't have
17697 any page number on it.
17698 Furthermore, it may interfere with any
17702 you've made to accompany the oversized
17709 \begin_layout Standard
17718 environments work the same way as the
17723 They both create an
17724 \begin_inset Quotes eld
17728 \begin_inset Quotes erd
17731 followed by a label [
17732 \begin_inset Quotes eld
17736 \begin_inset Quotes erd
17740 \begin_inset Quotes eld
17744 \begin_inset Quotes erd
17748 The color is a stunning magenta instead of blue, and the
17749 \begin_inset Quotes eld
17753 \begin_inset Quotes erd
17756 will look different, in style and in length.
17757 The label fonts of all three also differ from one another.
17760 \begin_layout Standard
17765 , if the contents of a
17773 exceed the physical size of a slide or sheet of paper, the extra will overflow
17775 Again, you should avoid this.
17776 It defeats the whole purpose of
17787 \begin_layout Subsubsection
17797 \begin_layout Standard
17802 is a slide that sits atop another slide.
17803 Perhaps you wish to discuss a figure on the main
17807 before displaying the text associated with it.
17808 One way to accomplish this is tape a flap of dark paper over the part of
17813 you want to display later.
17814 This method fails, however, if you wish to overlap one graph with another,
17816 You would then have to fumble while speaking to align the two separate,
17821 s to align the two graphs.
17826 environment in both cases makes life much easier.
17829 \begin_layout Standard
17834 receives the page number of its
17835 \begin_inset Quotes eld
17839 \begin_inset Quotes erd
17847 \begin_inset Quotes eld
17855 \begin_inset Quotes erd
17862 \begin_layout Plain Layout
17863 Presumably, mutliple
17868 \begin_inset Quotes eld
17876 \begin_inset Quotes erd
17880 \begin_inset Quotes eld
17888 \begin_inset Quotes erd
17892 \begin_inset Quotes eld
17900 \begin_inset Quotes erd
17904 \begin_inset space ~
17907 appended to the page number of the parent
17917 Clearly, you want the contents of both the
17925 to each fit on a single physical slide! You should probably consider an
17931 \begin_inset Quotes eld
17935 \begin_inset Quotes erd
17943 Indeed, the \SpecialChar LyX
17948 class provides a visual cue for this: the label at the start of an
17952 is shorter than that at the start of a
17957 Lastly, when you generate printable output, you'll find alignment markers
17958 in all four corners of both the
17962 page and its parent
17967 These will assist you in lining up the two physical slides.
17970 \begin_layout Standard
17971 The major problem in overlaying two slides is aligning the contents of the
17972 two transparencies.
17973 How much space should you leave for that graph on the second slide? Worse
17974 still, what if you want a graph and a sentence on second slide, but there
17975 is text on the main transparency that goes in between them? You could try
17976 and insert vertical space of the right size.
17977 The better way is to use
17988 \begin_layout Standard
17989 As their names imply,
17997 are two command-like paragraph environments that make all subsequent text
17998 invisible and visible, respectively.
18000 \begin_inset space ~
18004 \begin_inset CommandInset ref
18006 reference "sec:slideQuirk"
18010 that you don't place anything
18014 these two environments, however.
18019 , it inserts a centered, sky-blue label into the page reading
18020 \begin_inset Quotes eld
18023 <Invisible Text Follows>
18024 \begin_inset Quotes erd
18028 For paragraphs following this label, the parts of the
18036 ; it doesn't matter which] where they would be contain instead blank space.
18040 \begin_layout Standard
18045 , the corresponding centered label is
18046 \begin_inset Quotes eld
18049 <Visible Text Follows>
18050 \begin_inset Quotes erd
18054 Paragraphs following this label behave normally.
18055 Note that the beginning of a new
18067 automatically shuts off an
18072 It's therefore not necessary to use
18083 \begin_layout Standard
18084 By now, it should be obvious how to create overlay transparencies using
18085 the proper combination of
18104 \begin_layout Enumerate
18109 , including everything that will appear on it, whether on the main slide
18117 \begin_layout Enumerate
18118 Before each figure or paragraph that will appear only on the
18127 If necessary, insert a
18131 environment after the
18138 \begin_layout Enumerate
18143 immediately following the
18150 \begin_layout Enumerate
18151 Copy the contents of this
18162 \begin_layout Enumerate
18167 , change all of the
18178 \begin_layout Standard
18180 You've just made an
18187 \begin_layout Standard
18188 There's one problem with the way I've designed the \SpecialChar LyX
18193 class: you can't make text in the middle of a paragraph invisible, nor
18194 make text in the middle of an invisible paragraph visible again.
18195 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18200 \begin_layout Plain Layout
18201 The commands of interest are:
18204 \begin_layout Itemize
18209 invisible \SpecialChar ldots
18213 \begin_layout Itemize
18218 visible \SpecialChar ldots
18222 \begin_layout Plain Layout
18224 and need to be marked as \SpecialChar TeX
18227 \begin_inset Quotes eld
18231 \begin_inset Quotes erd
18234 you wish to change goes in between the brackets [and after the
18247 If you don't know how to mark text as \SpecialChar TeX
18248 , see the appropriate section of
18261 \begin_layout Subsubsection
18271 \begin_inset CommandInset label
18273 name "sec:slideNote"
18280 \begin_layout Standard
18289 is associated with a
18290 \begin_inset Quotes eld
18294 \begin_inset Quotes erd
18302 Here, too, the \SpecialChar LyX
18307 class provides visual cues.
18312 is shorter than that of a
18316 [yet longer than that of an
18320 ] and, like the label of an
18324 is shockingly magenta.
18325 Additionally, the printed
18329 has the page number of its
18330 \begin_inset Quotes eld
18334 \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 \begin_inset Quotes eld
18374 \begin_inset Quotes erd
18378 You can have multiple
18382 s associated with a single
18394 , you'll probably want to break up long
18398 s so that they fit on a single sheet of paper.
18401 \begin_layout Standard
18406 is obvious: it contains anything additional you might want to say about
18412 It could also be used as a sheet of reminders for a particular
18417 In the case of the latter, you might want to make use of time markers.
18418 Currently, the \SpecialChar LyX
18424 \begin_inset Quotes eld
18428 \begin_inset Quotes erd
18431 support for time markers, a
18433 Sli\SpecialChar TeX
18437 So, you'll have to resort to using the \SpecialChar LaTeX
18441 \begin_layout Standard
18442 To use time markers, you'll need to specify the extra class option
18443 \begin_inset Quotes eld
18451 \begin_inset Quotes erd
18455 \begin_inset space ~
18459 \begin_inset CommandInset ref
18461 reference "sec:slidesetup"
18466 This option turns on timing marks, which will appear in the lower-left-hand
18472 To set what appears in the time marker, you use the \SpecialChar LaTeX
18474 \begin_inset Quotes eld
18484 \begin_inset Quotes erd
18488 \begin_inset Quotes eld
18498 \begin_inset Quotes erd
18502 The arguments of both commands are time measured in seconds.
18504 \begin_inset Quotes eld
18514 \begin_inset Quotes erd
18517 sets the time marker to a given time.
18519 \begin_inset Quotes eld
18529 \begin_inset Quotes erd
18532 increments the time marker by the specified amount.
18533 Using time markers and
18537 s in this fashion, you can remind yourself how much time to spend on a particula
18545 \begin_layout Standard
18546 There's one last feature to describe.
18547 Clearly, you'd like to print out all of your
18555 s on transparencies while printing all of your
18572 with which it is associated.
18573 What's a person to do?
18576 \begin_layout Standard
18577 Luckily, there are two \SpecialChar LaTeX
18578 commands that allow you to select what to print
18580 Both must be placed into the preamble of your document.
18582 \begin_inset Quotes eld
18594 \begin_inset Quotes erd
18597 will cause the output to contain only the
18606 Correspondingly, the command
18607 \begin_inset Quotes eld
18619 \begin_inset Quotes erd
18622 prevents the output of anything but
18627 I'd advise placing both commands in the preamble and initially comment
18629 You can then preview your entire presentation as you write.
18630 When you're done writing, you can then uncomment one of the two to select
18631 what you want to print.
18632 I like to uncomment
18633 \begin_inset Quotes eld
18645 \begin_inset Quotes erd
18648 , print to a file with
18649 \begin_inset Quotes eld
18657 \begin_inset Quotes erd
18660 in its name, comment it back out, then uncomment
18661 \begin_inset Quotes eld
18673 \begin_inset Quotes erd
18677 \begin_inset Quotes eld
18685 \begin_inset Quotes erd
18689 I can then send either file to a printer, loading transparencies or plain
18690 paper as appropriate.
18693 \begin_layout Standard
18694 You can also provide other arguments to the
18695 \begin_inset Quotes eld
18705 \begin_inset Quotes erd
18709 \begin_inset Quotes eld
18719 \begin_inset Quotes erd
18723 See a good \SpecialChar LaTeX
18727 \begin_layout Subsection
18732 Class Template File
18735 \begin_layout Standard
18736 I have also provided a template file,
18737 \begin_inset Quotes eld
18745 \begin_inset Quotes erd
18753 To use it, begin your new presentation with
18755 File\SpecialChar menuseparator
18757 \begin_inset space ~
18761 \begin_inset space ~
18767 Your new \SpecialChar LyX
18768 presentation file will contain an example
18789 additionally contain an example of the use of
18798 Lastly, the preamble will contain:
18801 \begin_layout LyX-Code
18802 % Uncomment to print out only slides and overlays
18805 \begin_layout LyX-Code
18809 \begin_layout LyX-Code
18815 \begin_inset Newline newline
18821 \begin_layout LyX-Code
18822 % Uncomment to print out only notes
18825 \begin_layout LyX-Code
18829 \begin_layout LyX-Code
18837 \begin_layout Standard
18838 One final thing: I created this class to support the \SpecialChar LaTeX2e
18840 \begin_inset Quotes eld
18845 Sli\SpecialChar TeX
18849 \begin_inset Quotes erd
18852 class, one of the built-in \SpecialChar LaTeX2e
18854 Neither I nor the rest of the \SpecialChar LyX
18855 Team endorse or oppose the use of this built-in
18857 It's here if you want it or need it.
18858 There exist other \SpecialChar LaTeX2e
18859 classes for creating presentations, such as the
18864 \begin_inset space ~
18868 \begin_inset CommandInset ref
18870 reference "sec:foiltex"
18875 \begin_inset Quotes eld
18883 \begin_inset Quotes erd
18886 package [present on some \SpecialChar TeX
18888 The latter is not yet supported under \SpecialChar LyX
18893 \begin_layout Plain Layout
18894 Perhaps you can take on the task\SpecialChar ldots
18900 I know nothing about these other classes.
18901 Try them out to see what sort of alternative they provide.
18904 \begin_layout Chapter
18906 Features needing Extra Software
18909 \begin_layout Section
18910 Checking \SpecialChar TeX
18914 \begin_layout Standard
18920 \begin_layout Subsection
18924 \begin_layout Standard
18933 \begin_layout Plain Layout
18938 is not yet available when you are using the \SpecialChar LaTeX
18939 distribution MiK\SpecialChar TeX
18945 , you'll find in the
18952 \begin_inset space ~
18963 \begin_inset Newline newline
18967 \begin_inset CommandInset href
18969 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18977 \begin_layout Standard
18980 Chk\SpecialChar TeX
18983 package is a program that was written by
18984 \begin_inset Flex Noun
18987 \begin_layout Plain Layout
18989 \begin_inset space ~
18997 in frustration because some constructs in \SpecialChar LaTeX
18998 are sometimes non-intuitive,
18999 and easy to forget.
19000 The program runs over your \SpecialChar LaTeX
19001 file, checks the integrity of the file, and
19002 flags some common errors.
19003 In other technical words, it is
19007 for \SpecialChar LaTeX
19011 \begin_layout Standard
19012 Well, what is a syntax checker doing in \SpecialChar LyX
19013 which is supposed to produce correct
19015 anyways? The answer is simple: Just as
19019 not only checks the
19023 of C programs, but also does
19027 checks for type-errors,
19029 Chk\SpecialChar TeX
19032 catches some common
19036 errors, in addition to the syntactical ones.
19039 Chk\SpecialChar TeX
19042 is capable of detecting several common errors, such as
19045 \begin_layout Itemize
19046 Ellipsis detection:
19047 \begin_inset Newline newline
19050 Use \SpecialChar ldots
19054 \begin_layout Itemize
19055 No space in front of/after parenthesis:
19056 \begin_inset Newline newline
19062 \begin_layout Itemize
19063 Enforcement of normal space after common abbreviations:
19064 \begin_inset Newline newline
19068 \begin_inset space \thinspace{}
19072 \begin_inset space \space{}
19075 is too wide spacing.
19078 \begin_layout Itemize
19079 Enforcement of end-of-sentence space when the last sentence ends with a
19081 \begin_inset Newline newline
19085 And this is wrong spacing.
19088 \begin_layout Itemize
19089 Space in front of labels and similar commands:
19090 \begin_inset Newline newline
19093 The label should stick right up to the text to avoid falling to a wrong
19096 \begin_inset CommandInset label
19106 \begin_layout Plain Layout
19107 This footnote is in danger of falling off to a wrong page
19112 The label is separated too much.
19115 \begin_layout Itemize
19116 Space in front of references, instead of hard spaces:
19117 \begin_inset Newline newline
19120 If you have bad luck, the text will break right between the referenced text
19121 and reference number, and that's a pity.
19123 \begin_inset CommandInset ref
19125 reference "sec:chktex"
19132 \begin_layout Itemize
19134 \begin_inset Quotes eld
19138 \begin_inset Quotes erd
19142 \begin_inset Formula $\times$
19146 \begin_inset Newline newline
19149 2x2 looks cheap compared to
19150 \begin_inset Formula $2\times2$
19156 \begin_layout Standard
19157 and more \SpecialChar ldots
19158 It is an invaluable tool when you are
19159 \begin_inset Quotes eld
19163 \begin_inset Quotes erd
19166 your document before printing, and you should run it right after the obligatory
19167 spelling check, and before you go fine tuning the typesetting.
19170 \begin_layout Subsection
19174 \begin_layout Standard
19175 If you have the program installed, usage is as simple as choosing
19177 Tools\SpecialChar menuseparator
19179 \begin_inset space ~
19185 This will make \SpecialChar LyX
19186 generate a \SpecialChar LaTeX
19187 file of your document, start
19189 Chk\SpecialChar TeX
19192 to check it, and then make \SpecialChar LyX
19194 \begin_inset Quotes eld
19198 \begin_inset Quotes erd
19201 with the warnings from
19203 Chk\SpecialChar TeX
19206 , if there were any.
19207 The warnings will be placed close to the point of the mistake, and you
19208 can quickly find them by using the
19210 Navigate\SpecialChar menuseparator
19213 menu item, or the shortcut key
19222 Open the error boxes by clicking on them with the mouse, or use the shortcut
19231 bindings, or the corresponding
19240 Read the warning and correct the mistake, if it is a mistake.
19241 If you have trouble understanding what the warning is about, you can safely
19243 Remember that there is a hidden layer between the document on screen and
19244 the technical details in invoking
19246 Chk\SpecialChar TeX
19249 , and this gap can make some warnings seem arcane or just plain silly.
19252 \begin_layout Standard
19253 This document is an excellent testing bed for the feature, and it should
19254 provide quite a few warnings for you to fiddle with.
19255 Since computers are only so smart, expect most of the warnings to be false
19259 \begin_layout Subsection
19260 How to fine tune it
19263 \begin_layout Standard
19264 Sometimes, you'll find that
19266 Chk\SpecialChar TeX
19269 makes more noise than suits your mood.
19270 Then you can choose not to use it, wait until your mood changes, or try
19273 Chk\SpecialChar TeX
19276 to get better along with you.
19279 \begin_layout Standard
19282 Chk\SpecialChar TeX
19289 very configurable and extensible, you should not expect to solve all problems
19292 Chk\SpecialChar TeX
19295 in \SpecialChar LyX
19297 Since \SpecialChar LyX
19298 has to generate a somewhat special \SpecialChar LaTeX
19299 file to be able to match the
19300 line numbers from the
19302 Chk\SpecialChar TeX
19309 \begin_layout Plain Layout
19310 You can inspect the specific output from
19316 Document\SpecialChar menuseparator
19319 \begin_inset space ~
19333 to the internal document structure, some of the warnings will not appear
19335 There are two things you can do about this:
19338 \begin_layout Itemize
19341 Chk\SpecialChar TeX
19344 invocation command line in
19345 \begin_inset Flex Noun
19348 \begin_layout Plain Layout
19349 Tools\SpecialChar menuseparator
19350 Preferences\SpecialChar menuseparator
19351 Output\SpecialChar menuseparator
19352 LaTeX\SpecialChar menuseparator
19360 Chk\SpecialChar TeX
19363 installation configuration file (usually with the file
19368 See below to learn what warnings can be enabled and disabled on the command
19372 \begin_layout Itemize
19373 Export your document as a raw \SpecialChar LaTeX
19376 File\SpecialChar menuseparator
19377 Export\SpecialChar menuseparator
19386 Invoked in this way, it can be a hassle to find the corresponding place
19387 in the document inside \SpecialChar LyX
19388 , but with a little patience, you should be able
19392 \begin_layout Standard
19393 Here follows the warning messages that can be enabled and disabled in
19402 to disable a warning, and
19406 to enable a warning.
19407 The emphasized entries are disabled by default, because the default is
19410 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19415 \begin_layout Standard
19416 Notice that you should only use the options that enable and disable warnings,
19417 because \SpecialChar LyX
19418 relies on some of the other command line parameters to be set
19419 in a specific way to have a chance to communicate with
19426 \begin_layout Enumerate
19430 Command terminated with space.
19433 \begin_layout Enumerate
19436 Non-breaking space (
19437 \begin_inset Quotes eld
19445 \begin_inset Quotes erd
19448 ) should have been used.
19451 \begin_layout Enumerate
19455 You should enclose the previous parenthesis with
19456 \begin_inset Quotes eld
19464 \begin_inset Quotes erd
19470 \begin_layout Enumerate
19473 Italic correction (
19474 \begin_inset Quotes eld
19484 \begin_inset Quotes erd
19487 ) found in non-italic buffer.
19490 \begin_layout Enumerate
19493 Italic correction (
19494 \begin_inset Quotes eld
19504 \begin_inset Quotes erd
19507 ) found more than once.
19510 \begin_layout Enumerate
19514 No italic correction (
19515 \begin_inset Quotes eld
19525 \begin_inset Quotes erd
19531 \begin_layout Enumerate
19535 \begin_inset Quotes eld
19543 \begin_inset Quotes erd
19547 \begin_inset Quotes eld
19555 \begin_inset Quotes erd
19561 \begin_layout Enumerate
19564 Wrong length of dash may have been used.
19567 \begin_layout Enumerate
19571 \begin_inset Quotes eld
19579 \begin_inset Quotes erd
19583 \begin_inset Quotes eld
19591 \begin_inset Quotes erd
19597 \begin_layout Enumerate
19601 \begin_inset Quotes eld
19609 \begin_inset Quotes erd
19615 \begin_layout Enumerate
19619 \begin_inset Quotes eld
19627 \begin_inset Quotes erd
19630 to achieve an ellipsis.
19633 \begin_layout Enumerate
19636 Inter-word spacing (
19637 \begin_inset Quotes eld
19647 \begin_inset Quotes eld
19650 ) should perhaps be used.
19653 \begin_layout Enumerate
19656 Inter-sentence spacing (
19657 \begin_inset Quotes eld
19667 \begin_inset Quotes erd
19670 ) should perhaps be used.
19673 \begin_layout Enumerate
19676 Could not find argument for command.
19679 \begin_layout Enumerate
19683 \begin_inset Quotes eld
19691 \begin_inset Quotes erd
19697 \begin_layout Enumerate
19700 Math mode still on at end of \SpecialChar LaTeX
19704 \begin_layout Enumerate
19708 \begin_inset Quotes eld
19716 \begin_inset Quotes erd
19719 doesn't match the number of
19720 \begin_inset Quotes eld
19728 \begin_inset Quotes erd
19734 \begin_layout Enumerate
19737 You should use either
19740 \begin_inset Quotes eld
19748 \begin_inset Quotes erd
19753 as an alternative to
19754 \begin_inset Quotes eld
19762 \begin_inset Quotes erd
19768 \begin_layout Enumerate
19775 " (ASCII 39) instead of "
19782 \begin_layout Enumerate
19785 User-specified pattern found.
19788 \begin_layout Enumerate
19791 This command might not be intended.
19794 \begin_layout Enumerate
19801 \begin_layout Enumerate
19819 \begin_layout Enumerate
19822 Delete this space to maintain correct page references.
19825 \begin_layout Enumerate
19829 You might wish to put this between a pair of
19830 \begin_inset Quotes eld
19838 \begin_inset Quotes erd
19844 \begin_layout Enumerate
19847 You ought to remove spaces in front of punctuation.
19850 \begin_layout Enumerate
19853 Could not execute \SpecialChar LaTeX
19857 \begin_layout Enumerate
19866 in front of small punctuation.
19869 \begin_layout Enumerate
19877 may look prettier here.
19880 \begin_layout Enumerate
19884 Multiple spaces detected in output.
19887 \begin_layout Enumerate
19890 This text may be ignored.
19893 \begin_layout Enumerate
19899 \begin_inset Quotes eld
19904 to begin quotation, not
19911 \begin_layout Enumerate
19918 to end quotation, not
19921 \begin_inset Quotes eld
19929 \begin_layout Enumerate
19935 \begin_layout Enumerate
19938 You should perhaps use
19939 \begin_inset Quotes eld
19947 \begin_inset Quotes erd
19953 \begin_layout Enumerate
19956 You should put a space in front of/after parenthesis.
19959 \begin_layout Enumerate
19962 You should avoid spaces in front of/after parenthesis.
19965 \begin_layout Enumerate
19969 You should not use punctuation in front of/after quotes.
19972 \begin_layout Enumerate
19975 Double space found.
19978 \begin_layout Enumerate
19981 You should put punctuation outside inner/inside display math mode.
19984 \begin_layout Enumerate
19987 You ought to not use primitive \SpecialChar TeX
19988 in \SpecialChar LaTeX
19992 \begin_layout Enumerate
19995 You should remove spaces in front of
19996 \begin_inset Quotes eld
20004 \begin_inset Quotes erd
20010 \begin_layout Enumerate
20013 \begin_inset Quotes eld
20021 \begin_inset Quotes erd
20024 is normally not followed by
20025 \begin_inset Quotes eld
20033 \begin_inset Quotes erd
20039 \begin_layout Standard
20040 In later versions of \SpecialChar LyX
20041 , we hope to provide a more complete interface to this
20042 tool (and it's smaller cousin
20046 ) to exploit the full power of it.
20047 But it's not exactly useless as it is now: go try it on one of your existing
20048 documents of a certain length and be surprised.
20051 \begin_layout Section
20052 Version Control in \SpecialChar LyX
20056 \begin_layout Standard
20059 Lars Gullik Bjønnes
20066 \begin_layout Subsection
20070 \begin_layout Standard
20072 supports some of the most basic RCS/CVS/SVN/GIT commands.
20073 If you need something a bit more sophisticated you will have to do that
20074 manually in a terminal.
20077 \begin_layout Standard
20078 Also note that CVS support is not as good as subversion support so we advise
20080 A good place to start learning Subversion is SVN Book
20084 \begin_layout Plain Layout
20085 \begin_inset CommandInset href
20087 target "http://svnbook.red-bean.com/"
20098 In the case of RCS you should read
20099 \begin_inset Quotes eld
20103 \begin_inset Quotes erd
20106 (a man file, read it with
20111 This file describes all the basic features of RCS.
20112 You should especially notice the comment about a RCS directory, and the
20113 notion of a master RCS file (the file ending in
20120 \begin_layout Standard
20121 Before you begin to use the version control features in \SpecialChar LyX
20123 familiar with RCS/CVS/SVN/GIT usage.
20124 The implementation in \SpecialChar LyX
20125 assumes a recent version of the GNU RCS or CVS/SVN
20126 package — no guarantees are made for older versions.
20127 Most of the log messages are not currently displayed after operations —
20128 you can check them in the Messages pane if unsure.
20129 Regular users of version control will appreciate VC toolbar, which can
20132 View\SpecialChar menuseparator
20133 Toolbars\SpecialChar menuseparator
20135 \begin_inset space ~
20143 \begin_layout Standard
20144 For introducing your own external commands consult vc-command in the manual
20145 of \SpecialChar LyX
20149 \begin_layout Standard
20150 It is strongly recommended to store documents in uncompressed format if
20151 using version control (uncheck
20153 Document\SpecialChar menuseparator
20156 if it is checked): Uncompressed LyX documents are text files and therefore
20157 for merging two different versions by version control systems.
20158 Compressed LyX documents are binary files, which cannot be merged by version
20162 \begin_layout Subsection
20163 RCS commands in \SpecialChar LyX
20167 \begin_layout Standard
20168 The following sections describe the RCS commands supported by \SpecialChar LyX
20170 You can find them in the
20172 File\SpecialChar menuseparator
20174 \begin_inset space ~
20181 was tested against RCS 5.7/5.8.
20184 \begin_layout Subsubsection
20190 \begin_layout Standard
20191 If your document is not under revision control, this is the only item shown
20193 And if it is under revision control, the
20197 item is not visible.
20201 \begin_layout Standard
20202 This command registers your document with RCS (unless you are under the
20203 directory managed by CVS)\SpecialChar endofsentence
20204 You are asked interactively to supply an initial
20205 description of the document.
20206 The document is now set in Read-Only mode and you have to
20209 \begin_inset space ~
20213 \begin_inset space ~
20217 \begin_inset space ~
20222 , before making any changes to it.
20223 A document under revision control has a
20224 \begin_inset Quotes eld
20227 [RCS:<version> <locker>]
20228 \begin_inset Quotes erd
20231 item tagged to the filename in the minibuffer.
20234 \begin_layout Standard
20235 RCS command that is run:
20237 ci -q -u -i -t-"<initial description>" <file-name>
20240 \begin_layout Standard
20245 to understand the switches.
20249 \begin_layout Subsubsection
20255 \begin_layout Standard
20256 When you are finished editing a file, you check in your changes.
20257 When you do this, you are asked for a description of the changes.
20258 This is stored in the history log.
20259 The version number is bumped, your changes are applied to the master RCS
20260 file, the document is unlocked and set to Read-Only mode.
20263 \begin_layout Standard
20266 ci -q -u -m"<description>" <file-name>
20269 \begin_layout Subsubsection
20275 \begin_layout Standard
20276 By doing this you lock the document so that only you can edit it.
20277 This will also make the document Read-Write only for you.
20278 You will usually continue editing for a while and when you are finished
20279 you check in your changes.
20280 The status line is changed to reflect that you have locked the file.
20283 \begin_layout Standard
20286 co -q -l <file-name>
20289 \begin_layout Subsubsection
20292 Revert To Repository Version
20295 \begin_layout Standard
20296 This will discard all changes made to the document since the last check
20298 You get a warning before changes are discarded.
20301 \begin_layout Standard
20304 co -f -u<version> <file-name>
20307 \begin_layout Subsubsection
20313 \begin_layout Standard
20314 This will create a copy of the current document.
20315 Since RCS does not support copy operations natively, the version history
20316 is not preserved, and the copy is added as a new file.
20317 It requires a clean document without any changes since the last checkin.
20318 You are asked for a file name and a description of the copy operation.
20319 After that the copy is created, both locally and in the repository.
20320 If the parent directories of the copied and original document differ, all
20321 relative paths of included files of the copy are adjusted (like in
20323 File\SpecialChar menuseparator
20328 Finally, the copy is loaded instead of the original document.
20331 \begin_layout Labeling
20332 \labelwidthstring 00.00.0000
20334 \begin_inset space ~
20338 \begin_inset space ~
20342 \begin_inset Newline newline
20346 \begin_inset Flex Code
20349 \begin_layout Plain Layout
20352 \begin_inset Quotes eld
20356 \begin_inset Quotes erd
20365 \begin_inset Flex Code
20368 \begin_layout Plain Layout
20371 \begin_inset Quotes eld
20375 \begin_inset Quotes erd
20384 \begin_inset Newline newline
20388 \begin_inset Flex Code
20391 \begin_layout Plain Layout
20395 \begin_inset Quotes eld
20399 \begin_inset Quotes erd
20410 \begin_layout Subsubsection
20416 \begin_layout Standard
20417 This makes as if the last check in never happened.
20418 No changes are made to the document loaded into \SpecialChar LyX
20419 , but the last version
20420 is removed from the master RCS file.
20423 \begin_layout Standard
20426 rcs -o<version> <file-name>
20429 \begin_layout Subsubsection
20435 \begin_layout Standard
20436 This shows the complete history of the RCS document.
20441 is shown in a browser.
20449 \begin_layout Subsubsection
20453 \begin_layout Standard
20455 supports RCS version number, author name, date and time of last commit.
20456 All those are extracted from
20458 rlog -r <file-name>
20462 \begin_inset CommandInset ref
20464 reference "subsec:VCS-Revision-Information"
20471 \begin_layout Subsection
20472 CVS commands in \SpecialChar LyX
20476 \begin_layout Standard
20477 A subset of CVS operations is supported by \SpecialChar LyX
20479 You can find the commands in the
20481 File\SpecialChar menuseparator
20483 \begin_inset space ~
20489 The version control system SVN is more powerful, so please use it instead
20490 of CVS if possible.
20493 \begin_layout Subsubsection
20499 \begin_layout Standard
20500 If you start from scratch with CVS you have to create your repository and
20501 checkout the working copy with external tools.
20502 If you're using a client-server setup you may need to login before doing
20503 the first repository checkout.
20506 \begin_layout Standard
20507 If your documents are under revision control and others are using the same
20508 repository problems arise when different changes to the same document at
20509 the same location happen.
20510 Standard CVS repositories don't operate with a file locking mechanism.
20511 This may be surprising, but conflicts only occur if people disagree on
20512 the proper content of the same part of a document.
20513 So, if co-workers are used to communicate regularly, these conflicts occur
20515 If they don't communicate they have a fundamental problem anyway.
20516 Nevertheless some people like to work with so called
20517 \begin_inset Quotes eld
20521 \begin_inset Quotes erd
20525 If they do so the working copy of all files is readonly when checked out
20526 first and the user starts editing after using a special command to make
20527 the working copy writable.
20528 When the changes are checked in the working copy returns to readonly state.
20529 With \SpecialChar LyX
20530 one has to edit the
20531 \begin_inset Flex Code
20534 \begin_layout Plain Layout
20540 file and add the line
20541 \begin_inset Flex Code
20544 \begin_layout Plain Layout
20550 to work with reserved checkouts.
20551 The benefit is the possibility to see who is using a writable copy of some
20553 It's not guaranteed only one user makes a copy writable.
20556 \begin_layout Standard
20558 tries to guess if you're using reserved or non-reserved checkouts.
20559 If your working copy is readonly or it is writable and an additional copy
20560 of your document exists in the CVS/Base sub-directory a reserved otherwise
20561 a non-reserved checkout is assumed.
20562 When a reserved checkout is detected you have to use
20563 \begin_inset Flex Noun
20566 \begin_layout Plain Layout
20572 to make your working copy writable if it's readonly.
20574 \begin_inset Flex Noun
20577 \begin_layout Plain Layout
20583 operation is possible and that makes your working copy readonly again after
20584 transferring your changes to the repository.
20587 \begin_layout Standard
20588 More information about CVS can be found here
20589 \begin_inset Flex URL
20592 \begin_layout Plain Layout
20594 http://www.nongnu.org/cvs
20600 \begin_inset Flex URL
20603 \begin_layout Plain Layout
20605 http://ximbiot.com/cvs
20613 \begin_layout Standard
20618 to understand the sub-commands and the switches mentioned below.
20621 \begin_layout Subsubsection
20627 \begin_layout Standard
20628 If your document is not under revision control, this is the only item shown
20630 And if it is under revision control, the
20634 item is not visible.
20638 \begin_layout Standard
20639 This command registers in CVS your document
20640 \begin_inset Flex Strong
20643 \begin_layout Plain Layout
20651 in the case you have already the documents directory under CVS control
20657 This means you have to create or checkout the archive by yourself using
20659 (In case you forget that step \SpecialChar LyX
20660 registers the document with RCS.)
20663 \begin_layout Standard
20664 Then you are asked interactively to supply an initial description of the
20666 Don't forget that registered file is not yet checked in.
20669 \begin_layout Standard
20670 CVS command that is run:
20672 cvs -q add -m"<entered message>" "<file-name>"
20675 \begin_layout Standard
20680 above and for all other CVS commands is an abbreviation for
20681 \begin_inset Quotes eld
20684 change the current working directory to file location and use the file name
20685 without path component as argument
20686 \begin_inset Quotes erd
20692 \begin_layout Subsubsection
20698 \begin_layout Standard
20699 When you are finished editing a file, you commit your changes.
20700 When you do this and you had changed the document, you are asked for a
20701 description of the changes.
20702 After that changes are written to the repository.
20703 In case you didn't change the document and a reserved checkout is detected
20704 the reservation made on
20705 \begin_inset Flex Noun
20708 \begin_layout Plain Layout
20717 \begin_layout Labeling
20718 \labelwidthstring 00.00.0000
20720 \begin_inset space ~
20724 \begin_inset space ~
20728 \begin_inset Newline newline
20732 \begin_inset Flex Code
20735 \begin_layout Plain Layout
20738 -q commit -m"<description>" "<file-name>"
20744 \begin_inset Newline newline
20748 \begin_inset Flex Code
20751 \begin_layout Plain Layout
20762 \begin_layout Subsubsection
20768 \begin_layout Standard
20769 When you are sharing a repository with others, you may have to incorporate
20770 their changes into your working copy.
20773 \begin_layout Standard
20776 cvs -q update "<file-name>"
20779 \begin_layout Standard
20780 If a readonly checkout is detected the working copy is made writable and
20784 \begin_layout Standard
20787 cvs -q edit "<file-name>"
20790 \begin_layout Subsubsection
20793 Revert To Repository Version
20796 \begin_layout Standard
20797 This will discard all changes made to the document since the last check
20799 You get a warning before changes are discarded.
20800 Firstly the file is deleted, secondly CVS update command is run.
20803 \begin_layout Standard
20806 cvs -q update "<file-name>"
20809 \begin_layout Standard
20810 If a reserved checkout is detected and the working copy has no changes only
20811 the reservation is undone.
20814 \begin_layout Standard
20817 cvs -q unedit "<file-name>"
20820 \begin_layout Subsubsection
20826 \begin_layout Standard
20827 This will create a copy of the current document.
20828 Since CVS does not support copy operations natively, the version history
20829 is not preserved, and the copy is added as a new file.
20830 It requires a clean document without any changes since the last checkin.
20831 You are asked for a file name and a description of the copy operation.
20832 After that the copy is created, both locally and in the repository.
20833 If the parent directories of the copied and original document differ, all
20834 relative paths of included files of the copy are adjusted (like in
20836 File\SpecialChar menuseparator
20841 Finally, the copy is loaded instead of the original document.
20844 \begin_layout Labeling
20845 \labelwidthstring 00.00.0000
20847 \begin_inset space ~
20851 \begin_inset space ~
20855 \begin_inset Newline newline
20859 \begin_inset Flex Code
20862 \begin_layout Plain Layout
20865 \begin_inset Quotes eld
20869 \begin_inset Quotes erd
20878 \begin_inset Flex Code
20881 \begin_layout Plain Layout
20884 \begin_inset Quotes eld
20888 \begin_inset Quotes erd
20897 \begin_inset Newline newline
20901 \begin_inset Flex Code
20904 \begin_layout Plain Layout
20908 \begin_inset Quotes eld
20912 \begin_inset Quotes erd
20923 \begin_layout Subsubsection
20929 \begin_layout Standard
20930 This will rename the current document.
20931 Since CVS does not support rename operations natively, the version history
20932 is not preserved, the renamed document is added as a new file, and the
20933 original document is deleted.
20934 It requires a clean document without any changes since the last checkin.
20935 You are asked for a file name and a description of the rename operation.
20936 After that the document is renamed, both locally and in the repository.
20937 If the parent directories of the new and old file names differ, all relative
20938 paths of included files are adjusted (like in
20940 File\SpecialChar menuseparator
20945 Finally, the document is reloaded using the new name.
20948 \begin_layout Labeling
20949 \labelwidthstring 00.00.0000
20951 \begin_inset space ~
20955 \begin_inset space ~
20959 \begin_inset Newline newline
20963 \begin_inset Flex Code
20966 \begin_layout Plain Layout
20969 \begin_inset Quotes eld
20973 \begin_inset Quotes erd
20982 \begin_inset Flex Code
20985 \begin_layout Plain Layout
20988 \begin_inset Quotes eld
20992 \begin_inset Quotes erd
21001 \begin_inset Newline newline
21005 \begin_inset Flex Code
21008 \begin_layout Plain Layout
21012 \begin_inset Quotes eld
21016 \begin_inset Quotes erd
21025 \begin_inset Newline newline
21029 \begin_inset Flex Code
21032 \begin_layout Plain Layout
21036 \begin_inset Quotes eld
21040 \begin_inset Quotes erd
21051 \begin_layout Subsubsection
21052 Update of the local directory checkout from repository
21055 \begin_layout Standard
21056 Once your documents gets more complex, containing sub-documents and pictures,
21058 \begin_inset Flex Code
21061 \begin_layout Plain Layout
21067 files and so on using version control becomes more complicated.
21069 supports updating the whole tree in which resides the document.
21070 This become especially useful once you cooperate with people which neither
21071 have detailed knowledge about CVS usage nor they have ambition to commit
21072 additional material to the repository.
21073 You have to organize the files structure so that all external files are
21074 in the same directory or subdirectories of the document.
21075 It's good practice anyway to store multipart documents in an extra directory.
21078 \begin_layout Standard
21080 \begin_inset Flex Code
21083 \begin_layout Plain Layout
21084 Update local directory from repository
21089 command updates the whole directory.
21090 If local changes are detected user is warned before update starts.
21091 In case of merge conflicts both versions of the conflicting document parts
21092 are placed in the final document.
21093 You have to review and correct the result of the merge.
21094 You'll find the conflicts enclosed in pairs of
21095 \begin_inset Flex Code
21098 \begin_layout Plain Layout
21105 \begin_inset Flex Code
21108 \begin_layout Plain Layout
21115 \begin_inset Flex Code
21118 \begin_layout Plain Layout
21125 The first part is your version as before the update operation with the
21126 document name prepended.
21127 The second one is the repository version with the version number after
21129 \begin_inset Flex Code
21132 \begin_layout Plain Layout
21141 \begin_layout Labeling
21142 \labelwidthstring 00.00.0000
21144 \begin_inset space ~
21148 \begin_inset space ~
21152 \begin_inset Newline newline
21156 \begin_inset Flex Code
21159 \begin_layout Plain Layout
21167 (Ask if changes are detected.)
21168 \begin_inset Newline newline
21172 \begin_inset Flex Code
21175 \begin_layout Plain Layout
21176 cd $path; cvs -q update
21186 \begin_layout Standard
21188 \begin_inset Flex Code
21191 \begin_layout Plain Layout
21197 stands for the path to the document.
21200 \begin_layout Subsubsection
21206 \begin_layout Standard
21207 This shows the complete history of the CVS document.
21210 cvs log "<file-name>"
21212 is shown in a browser.
21215 \begin_layout Subsubsection
21219 \begin_layout Standard
21221 supports CVS version number, author name, date and time of last commit.
21222 All those are extracted from
21224 cvs log -r <file-name>
21228 \begin_inset CommandInset ref
21230 reference "subsec:VCS-Revision-Information"
21237 \begin_layout Subsection
21238 SVN commands in \SpecialChar LyX
21242 \begin_layout Standard
21243 SVN is now partially supported by \SpecialChar LyX
21245 You can find the commands in the
21247 File\SpecialChar menuseparator
21249 \begin_inset space ~
21255 Please note that if you use password protected access to repository via
21256 ssh, you will be asked in terminal window.
21258 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21262 \begin_layout Plain Layout
21263 Most of the commands will work with 1.4 too, see
21264 \begin_inset CommandInset ref
21266 reference "subsec:SVN-Repo-Update"
21271 There seems to be currently unresolved permissions problem under SVN 1.8
21272 with reverting changes when file is locked.
21280 \begin_layout Subsubsection
21286 \begin_layout Standard
21287 If your document is not under revision control, this is the only item shown
21289 And if it is under revision control, the
21293 item is not visible.
21296 \begin_layout Standard
21297 This command registers in SVN your document ONLY in case you have already
21298 the documents directory under SVN control (in particular
21303 This means you have to checkout the archive by yourself.
21306 \begin_layout Standard
21307 Then you are asked interactively to supply an initial description of the
21309 Don't forget that registered file is not yet commited.
21312 \begin_layout Standard
21313 SVN command that is run:
21316 \begin_inset Quotes eld
21320 \begin_inset Quotes erd
21326 \begin_layout Standard
21331 to understand the switches.
21334 \begin_layout Subsubsection
21340 \begin_layout Standard
21341 When you are finished editing a file, you commit your changes.
21342 When you do this, you are asked for a description of the changes.
21343 After that changes are commited.
21346 \begin_layout Standard
21351 \begin_layout Plain Layout
21352 In case locking is not enabled.
21354 \begin_inset CommandInset ref
21356 reference "subsec:SVN-File-Locking"
21367 svn commit -q -m"<description>" <file-name>
21370 \begin_layout Subsubsection
21376 \begin_layout Standard
21377 Updates the changes of this file from the repository.
21378 Be sure you understand SVN merging and conflicts resolving before using
21379 this function, because all conflicts has to be resolved manually by you!
21382 \begin_layout Standard
21387 \begin_layout Plain Layout
21395 svn update --non-interactive
21396 \begin_inset Quotes eld
21400 \begin_inset Quotes erd
21406 \begin_layout Subsubsection
21409 Revert To Repository Version
21412 \begin_layout Standard
21413 This will discard all changes made to the document since the last check
21415 You get a warning before changes are discarded.
21418 \begin_layout Standard
21422 \begin_inset Quotes eld
21426 \begin_inset Quotes erd
21432 \begin_layout Subsubsection
21438 \begin_layout Standard
21439 This will create a copy of the current document including the version history.
21440 It requires a clean document without any changes since the last checkin.
21441 You are asked for a file name and a description of the copy operation.
21442 After that the copy is created, both locally and in the repository.
21443 If the parent directories of the copied and original document differ, all
21444 relative paths of included files of the copy are adjusted (like in
21446 File\SpecialChar menuseparator
21451 Finally, the copy is loaded instead of the original document.
21454 \begin_layout Labeling
21455 \labelwidthstring 00.00.0000
21457 \begin_inset space ~
21461 \begin_inset space ~
21465 \begin_inset Newline newline
21469 \begin_inset Flex Code
21472 \begin_layout Plain Layout
21476 \begin_inset Quotes eld
21480 \begin_inset Quotes erd
21484 \begin_inset Quotes eld
21488 \begin_inset Quotes erd
21497 \begin_inset Newline newline
21501 \begin_inset Flex Code
21504 \begin_layout Plain Layout
21513 \begin_layout Subsubsection
21519 \begin_layout Standard
21520 This will rename the current document including the version history.
21521 It requires a clean document without any changes since the last checkin.
21522 You are asked for a file name and a description of the rename operation.
21523 After that the document is renamed, both locally and in the repository.
21524 If the parent directories of the new and old file names differ, all relative
21525 paths of included files are adjusted (like in
21527 File\SpecialChar menuseparator
21532 Finally, the document is reloaded using the new name.
21535 \begin_layout Labeling
21536 \labelwidthstring 00.00.0000
21538 \begin_inset space ~
21542 \begin_inset space ~
21546 \begin_inset Newline newline
21550 \begin_inset Flex Code
21553 \begin_layout Plain Layout
21557 \begin_inset Quotes eld
21561 \begin_inset Quotes erd
21565 \begin_inset Quotes eld
21569 \begin_inset Quotes erd
21578 \begin_inset Newline newline
21582 \begin_inset Flex Code
21585 \begin_layout Plain Layout
21594 \begin_layout Subsubsection
21595 \begin_inset CommandInset label
21597 name "subsec:SVN-Repo-Update"
21601 Update of the local directory checkout from repository
21605 \begin_layout Plain Layout
21606 Note that this command will work only with subversion
21607 \begin_inset Formula $\geqq1.5$
21618 \begin_layout Standard
21619 All the commands above have one shortcomming - they deal with the current
21621 Once your document contains pictures, includes external
21622 \begin_inset Flex Code
21625 \begin_layout Plain Layout
21631 files and so on administration becomes more complicated.
21633 now supports updating the whole tree in which resides the document
21637 \begin_layout Plain Layout
21638 One need to organize the files structure so that all external files are
21639 in the same directory or subdirectories of the document.
21646 This become especially useful once you cooperate with people which neither
21647 know about subversion management nor they have ambition to commit additional
21648 material to the repository.
21652 \begin_layout Standard
21653 \begin_inset Flex Code
21656 \begin_layout Plain Layout
21657 Update local directory from repository
21662 command updates the whole directory and in case of merge conflicts local
21663 version of the files are left, so no unintended data loss occurs.
21664 If local changes are detected user is warned before update starts.
21667 \begin_layout Labeling
21668 \labelwidthstring 00.00.0000
21670 \begin_inset space ~
21674 \begin_inset space ~
21678 \begin_inset Newline newline
21682 \begin_inset Flex Code
21685 \begin_layout Plain Layout
21691 (Ask if changes are detected.)
21692 \begin_inset Newline newline
21696 \begin_inset Flex Code
21699 \begin_layout Plain Layout
21700 svn update –accept mine-full $path
21708 \begin_layout Standard
21710 \begin_inset Flex Code
21713 \begin_layout Plain Layout
21719 stands for the path to the document.
21722 \begin_layout Subsubsection
21728 \begin_layout Standard
21729 This shows the complete history of the SVN document.
21733 \begin_inset Quotes eld
21737 \begin_inset Quotes erd
21742 is shown in a browser.
21745 \begin_layout Subsubsection
21747 \begin_inset CommandInset label
21749 name "subsec:SVN-File-Locking"
21756 \begin_layout Standard
21757 The file exchange through various revision control systems brings the problem
21758 of merge conflicts in case two different users try to edit the same (parts
21760 When such a conflict happens it needs manual resolving and one reasonable
21761 alternative is to provide some kind of locking mechanism, which guarantees
21762 that only one user is allowed to edit file at the given time.
21765 \begin_layout Standard
21766 SVN has two such mechanisms to provide mutual exclusivity for file access
21767 - locks and automatic setting of write permissions (see sec.
21769 \begin_inset CommandInset ref
21771 reference "subsec:Automatical-Locking-Property"
21776 \begin_inset Flex Code
21779 \begin_layout Plain Layout
21789 \begin_layout Plain Layout
21790 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21796 If this property is detected for a given document \SpecialChar LyX
21797 starts to use SVN locks
21798 for document editing automatically and the whole check-in/out mechanism
21799 switches to the same regimen as for RCS.
21800 This in particular means there are two different modes of file use in \SpecialChar LyX
21804 \begin_layout Itemize
21806 The loaded file is in the read-only mode.
21807 For editing on needs to check-out.
21812 consists of updating from the repository and gaining write lock.
21813 If the lock is not possible to obtain, we remain in unlocked state.
21816 \begin_layout Itemize
21818 The loaded file is in the 'normal' edit mode.
21819 No other user is allowed to edit the file.
21824 consists of commiting changes and releasing write-lock.
21825 If no changes have been made to the document, no commit will be produced
21829 \begin_layout Plain Layout
21830 Don't be puzzled by the fact that you will be asked for commit message anyway.
21835 and only the write-lock will be released.
21838 \begin_layout Standard
21842 \begin_layout Labeling
21843 \labelwidthstring 00.00.0000
21846 svn commit -q -m"<description>" "<file-name>"
21847 \begin_inset Newline newline
21850 svn unlock "<file-name>"
21853 \begin_layout Labeling
21854 \labelwidthstring 00.00.0000
21857 svn update "<file-name>"
21858 \begin_inset Newline newline
21861 svn lock "<file-name>"
21864 \begin_layout Subsubsection
21867 \begin_inset CommandInset label
21869 name "subsec:Automatical-Locking-Property"
21875 Automatic Locking Property
21878 \begin_layout Standard
21879 The above mentioned automatic setting of write permissions of the .lyx file
21882 File\SpecialChar menuseparator
21884 \begin_inset space ~
21887 Control\SpecialChar menuseparator
21888 Toggle locking property
21891 This command is active only when the file is not locked on the svn server
21893 you need to check-out before proceeding).
21896 \begin_layout Labeling
21897 \labelwidthstring 00.00.0000
21899 \begin_inset space ~
21905 \begin_layout Labeling
21906 \labelwidthstring 00.00.0000
21909 svn propset svn:needs-lock ON "<file-name>"
21912 \begin_layout Labeling
21913 \labelwidthstring 00.00.0000
21916 svn propdel svn:needs-lock "<file-name>"
21919 \begin_layout Subsubsection
21920 \begin_inset CommandInset label
21922 name "subsec:VCS-Revision-Information"
21926 Revision Information in Documents
21929 \begin_layout Standard
21930 There are more possibilities how to activate revision information in our
21934 \begin_layout Itemize
21940 \begin_layout Itemize
21941 tree revision information (
21942 \begin_inset Flex Code
21945 \begin_layout Plain Layout
21952 The result is the output of the
21953 \begin_inset Flex Code
21956 \begin_layout Plain Layout
21962 command, the following table gives you an idea, how to read the results.
21965 \begin_layout Standard
21967 \begin_inset Tabular
21968 <lyxtabular version="3" rows="6" columns="2">
21969 <features tabularvalignment="middle">
21970 <column alignment="center" valignment="top">
21971 <column alignment="center" valignment="top">
21973 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21976 \begin_layout Plain Layout
21982 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21985 \begin_layout Plain Layout
21993 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21996 \begin_layout Plain Layout
22002 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22005 \begin_layout Plain Layout
22006 mixed revision working copy
22013 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22016 \begin_layout Plain Layout
22022 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22025 \begin_layout Plain Layout
22026 modified working copy
22033 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22036 \begin_layout Plain Layout
22042 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22045 \begin_layout Plain Layout
22046 switched working copy
22053 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22056 \begin_layout Plain Layout
22062 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22065 \begin_layout Plain Layout
22066 partial working copy, from a sparse checkout
22073 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22076 \begin_layout Plain Layout
22082 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22085 \begin_layout Plain Layout
22086 mixed revision, modified, switched working copy
22099 \begin_layout Itemize
22100 file revision information.
22101 The result comes from parsing the output of
22102 \begin_inset Flex Code
22105 \begin_layout Plain Layout
22107 \begin_inset space ~
22111 \begin_inset space ~
22115 \begin_inset space ~
22124 Supported flags are:
22128 \begin_layout Itemize
22129 version number of the last commit (
22130 \begin_inset Flex Code
22133 \begin_layout Plain Layout
22142 \begin_layout Itemize
22143 author of the last commit (
22144 \begin_inset Flex Code
22147 \begin_layout Plain Layout
22156 \begin_layout Itemize
22157 date of the last commit (
22158 \begin_inset Flex Code
22161 \begin_layout Plain Layout
22170 \begin_layout Itemize
22171 time of the last commit (
22172 \begin_inset Flex Code
22175 \begin_layout Plain Layout
22185 \begin_layout Standard
22186 You can obtain this info via InsetInfo (e.g.
22188 \begin_inset Flex Code
22191 \begin_layout Plain Layout
22192 info-insert buffer vcs-date
22198 The information will be available only when you have the file stored under
22199 svn managment (i.e.
22201 \begin_inset Flex Code
22204 \begin_layout Plain Layout
22210 directory is available with your document).
22214 \begin_layout Itemize
22215 Another—a hacking one—possibility is to use svn keywords
22219 \begin_layout Plain Layout
22220 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22226 In short – you set file keywords property (e.g.
22229 svn propset svn:keywords 'Rev' file.lyx
22231 ) and then paste keyword \SpecialChar TeX
22236 \begin_layout Plain Layout
22237 This is an easy way how to ensure that \SpecialChar LyX
22238 won't break the line in the middle
22244 tag in your document (e.g.
22249 \begin_layout Plain Layout
22257 This way svn client will automatically substitute revision number (e.g.
22262 \begin_layout Plain Layout
22269 ) after each update and commit.
22270 There are more problems with this approach.
22271 Firstly, the '$' character is used in \SpecialChar TeX
22272 world for math equations, so any
22273 occurence of math formula
22274 \begin_inset Formula $Rev$
22278 \begin_inset Formula $Rev:59$
22281 in your \SpecialChar LyX
22283 Similarly for other keywords like Id, Date, Author, etc.
22284 Secondly svn output is dependent on your locales, so its very easy that
22285 svn would produce some problematic strings once Date is used.
22286 Thirdly you get the whole 'Rev: 59' string in your document instead of
22288 Until subversion implements user's custom keywords it will be hard to use
22289 this approach reliably or let \SpecialChar LyX
22290 to support it directly.
22293 \begin_layout Subsection
22294 SVN and Windows Environment
22297 \begin_layout Quote
22298 My inclination is to say that if the user cannot figure out the command
22299 line operations on their own fairly quickly, they would be well advised
22300 to use TortoiseSVN.
22306 \begin_layout Subsubsection
22310 \begin_layout Standard
22311 In addition to installing \SpecialChar LyX
22312 , and having access to a Subversion repository,
22313 the user will need to install the Subversion client program.
22314 A Windows installer for the client program is available from
22315 \begin_inset CommandInset href
22318 target "http://www.collab.net/nonav/downloads/subversion/"
22324 The user may also want to install
22325 \begin_inset CommandInset href
22328 target "http://tortoisesvn.tigris.org/"
22333 , which integrates Subversion operations into the context (rightclick) menu
22334 of Windows Explorer.
22335 Operations done outside \SpecialChar LyX
22336 will typically be more convenient using the Explorer
22338 Note that TortoiseSVN is not a replacement for the client program, which
22339 is what \SpecialChar LyX
22343 \begin_layout Subsubsection
22344 Bringing a document under Subversion control
22347 \begin_layout Standard
22348 Before a \SpecialChar LyX
22349 document can be brought under version control in Subversion, its
22350 parent directory needs to be under version control.
22351 If the document is being added to a project already in the repository,
22352 this is accomplished by checking the project out to the directory where
22353 the new document will be placed.
22354 If the project itself is not yet under version control (for instance, if
22355 this document starts a new project), the directory must be imported into
22357 This is done outside \SpecialChar LyX
22359 Both import and checkout are easily accomplished from the Explorer context
22360 menu using TortoiseSVN, or alternatively can be done using the command
22361 line client at a DOS prompt.
22362 The procedure for importing the project using TortoiseSVN is described
22363 below, assuming an existing repository and a new project being started
22371 For information on using the Subversion client program, run
22378 \begin_layout Enumerate
22385 in Windows Explorer, right click it, and select
22387 TortoiseSVN\SpecialChar menuseparator
22391 If necessary, adjust the URL for the repository, then click OK.
22394 \begin_layout Enumerate
22395 Right click the level of the repository under which you want to place the
22396 new project folder (typically the top level) and click
22400 Supply a name for the project folder and click OK.
22401 Add a message for the log file if desired, then click OK again.
22402 The new project folder should appear in the repository.
22403 Finally, click OK again to exit the repository browser.
22406 \begin_layout Enumerate
22407 Once again right click
22413 , this time selecting SVN Checkout\SpecialChar ldots
22414 Select the URL of the project folder
22415 you just created in the repository, and set the checkout directory to
22423 You will be warned about a non-empty folder; click OK to proceed.
22424 You should now have a
22435 \begin_layout Enumerate
22436 Create or open your document in \SpecialChar LyX
22439 File\SpecialChar menuseparator
22441 \begin_inset space ~
22444 Control\SpecialChar menuseparator
22448 Add a log message and click OK to commit the document to version control.
22451 \begin_layout Standard
22452 From this point onward, you should have full functionality in the
22454 File\SpecialChar menuseparator
22456 \begin_inset space ~
22462 You also have the option of checking the document in and out, viewing its
22464 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22465 client program from a command prompt.
22468 \begin_layout Subsubsection
22469 SSH tunnel used with SVN under Windows
22472 \begin_layout Standard
22473 Compared with Linux setting up an svn client to communicate over ssh under
22474 Windows is a rather troublesome task.
22475 We will at least offer some hints how to setup the client side but prior
22476 knowledge about ssh and the Windows command line is needed, also be prepared
22477 for a great deal of frustration\SpecialChar ldots
22481 \begin_layout Enumerate
22482 Get an svn client for windows, as described in the previous sections.
22483 When it is a fresh install run some svn command (e.g.
22485 \begin_inset Flex Code
22488 \begin_layout Plain Layout
22494 ) to create config files, which you will need to change later on.
22497 \begin_layout Enumerate
22498 Choose an ssh client for Windows.
22499 There are several possibilities, we will use the one from Putty tools
22503 \begin_layout Plain Layout
22504 \begin_inset Flex URL
22507 \begin_layout Plain Layout
22509 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22520 You will need to set the connection up so that the client doesn't ask for
22521 any password from you.
22522 To keep things easy we will use only keys without any additional password
22527 \begin_layout Enumerate
22529 \begin_inset Flex Code
22532 \begin_layout Plain Layout
22539 Save your private .ppk key file and put the public one on the server side.
22540 If the SVN server runs on Linux, note that the format of the public key
22541 is not compatible with Linux openssh and you will need to direcly copy-paste
22544 Public key for pasting into OpenSSH authorized_keys file
22546 :” edit field into the server's
22547 \begin_inset Flex Code
22550 \begin_layout Plain Layout
22551 ~/.ssh/authorized_keys
22557 \begin_inset Flex Code
22560 \begin_layout Plain Layout
22569 \begin_layout Enumerate
22571 \begin_inset Flex Code
22574 \begin_layout Plain Layout
22581 In the SVN config file
22585 \begin_layout Plain Layout
22586 Exact path depends on Windows version, usually somewhere around
22587 \begin_inset Flex Code
22590 \begin_layout Plain Layout
22593 Documents and Settings
22607 \begin_inset Flex Code
22610 \begin_layout Plain Layout
22625 , section [tunnels], setup ssh command, e.g.
22627 \begin_inset Flex Code
22630 \begin_layout Plain Layout
22631 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22640 \begin_layout Plain Layout
22641 It will usually take a lot of time to get exact command right and it depends
22643 For example do not have some remote server saved as a default session in
22645 If things fail, try to connect via plink without SVN first.
22654 \begin_layout Enumerate
22655 Checkout the SVN archive, e.
22656 \begin_inset space \thinspace{}
22660 \begin_inset Newline newline
22664 \begin_inset Flex Code
22667 \begin_layout Plain Layout
22668 svn co svn+ssh://user@server/repository_path
22676 \begin_layout Subsubsection
22677 End-of-Line Conversions
22680 \begin_layout Standard
22681 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22683 use different line endings inside the .lyx files.
22684 This is not a problem as far as \SpecialChar LyX
22685 functionality is concerned, but the commit
22686 diffs will be huge and merge-conflicts prone.
22687 Fortunately SVN itself knows
22691 \begin_layout Plain Layout
22692 \begin_inset Flex URL
22695 \begin_layout Plain Layout
22697 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22707 how to deal with CR/LF problems when switching .lyx files to the
22708 \begin_inset Flex Code
22711 \begin_layout Plain Layout
22721 \begin_layout Plain Layout
22723 \begin_inset Flex Code
22726 \begin_layout Plain Layout
22727 svn propset svn:eol-style native FILE_NAME
22740 \begin_layout Subsection
22741 GIT commands in \SpecialChar LyX
22745 \begin_layout Standard
22746 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22748 You can find the commands in the
22750 File\SpecialChar menuseparator
22752 \begin_inset space ~
22758 Please note that if you use password protected access to repository via
22759 ssh, you will be asked in terminal window.
22761 was tested against GIT 1.7.
22765 \begin_layout Plain Layout
22766 Windows users please note that you need to ensure that git is on the path.
22767 This can be set from within \SpecialChar LyX
22770 Tools\SpecialChar menuseparator
22771 Preferences\SpecialChar menuseparator
22772 Paths\SpecialChar menuseparator
22783 \begin_layout Standard
22784 One big difference of GIT and the other supported version control systems
22785 is the distributed nature of GIT: With traditional version control systems
22786 there is one central server which hosts the repository.
22787 Users commit their changes to the server, and get updates made by other
22789 With GIT, users commit to a local repository.
22790 The local repository can be synchronized with one or more remote repositories
22792 \begin_inset Flex Code
22795 \begin_layout Plain Layout
22802 \begin_inset Flex Code
22805 \begin_layout Plain Layout
22813 does not interact in any way with remote GIT repositories.
22814 It works exclusively with the local repository in a very similar way as
22815 with a central CVS or SVN repository.
22816 If you use remote GIT repositories you need to do the
22817 \begin_inset Flex Code
22820 \begin_layout Plain Layout
22827 \begin_inset Flex Code
22830 \begin_layout Plain Layout
22836 operations with your favourite GIT client.
22839 \begin_layout Subsubsection
22845 \begin_layout Standard
22846 If your document is not under revision control, this is the only item shown
22848 And if it is under revision control, the
22852 item is not visible.
22855 \begin_layout Standard
22856 This command registers in GIT your document ONLY in case you have already
22857 the documents directory under GIT control (in particular
22862 This means you have to checkout the archive by yourself.
22865 \begin_layout Standard
22866 Then you are asked interactively to supply an initial description of the
22868 Don't forget that registered file is not yet commited.
22871 \begin_layout Standard
22872 GIT command that is run:
22875 \begin_inset Quotes eld
22879 \begin_inset Quotes erd
22885 \begin_layout Standard
22890 to understand the switches.
22893 \begin_layout Subsubsection
22899 \begin_layout Standard
22900 When you are finished editing a file, you commit your changes.
22901 When you do this, you are asked for a description of the changes.
22902 After that changes are commited.
22905 \begin_layout Standard
22908 git commit -q -m"<description>" <file-name>
22911 \begin_layout Subsubsection
22914 Revert To Repository Version
22917 \begin_layout Standard
22918 This will discard all changes made to the document since the last check
22920 You get a warning before changes are discarded.
22923 \begin_layout Standard
22927 \begin_inset Quotes eld
22931 \begin_inset Quotes erd
22937 \begin_layout Subsubsection
22943 \begin_layout Standard
22944 This will rename the current document including the version history.
22945 It requires a clean document without any changes since the last checkin.
22946 You are asked for a file name and a description of the rename operation.
22947 After that the document is renamed, both locally and in the repository.
22948 If the parent directories of the new and old file names differ, all relative
22949 paths of included files are adjusted (like in
22951 File\SpecialChar menuseparator
22956 Finally, the document is reloaded using the new name.
22959 \begin_layout Labeling
22960 \labelwidthstring 00.00.0000
22962 \begin_inset space ~
22966 \begin_inset space ~
22970 \begin_inset Newline newline
22974 \begin_inset Flex Code
22977 \begin_layout Plain Layout
22981 \begin_inset Quotes eld
22985 \begin_inset Quotes erd
22989 \begin_inset Quotes eld
22993 \begin_inset Quotes erd
23002 \begin_inset Newline newline
23006 \begin_inset Flex Code
23009 \begin_layout Plain Layout
23018 \begin_layout Subsubsection
23024 \begin_layout Standard
23025 This shows the complete history of the GIT document.
23029 \begin_inset Quotes eld
23033 \begin_inset Quotes erd
23038 is shown in a browser.
23041 \begin_layout Subsubsection
23045 \begin_layout Standard
23047 supports GIT hash number of the last commit to the file, author name, date
23048 and time of last commit.
23049 All those are extracted from
23051 git log -n 1 --pretty=format:%H%n%an%n%ai
23054 Tree version information is obtained via
23056 git describe --abbrev --dirty --long
23060 \begin_inset CommandInset ref
23062 reference "subsec:VCS-Revision-Information"
23069 \begin_layout Subsection
23073 \begin_layout Standard
23074 With the recent addition of the vc-command function \SpecialChar LyX
23075 power users are allowed
23076 to create their own commands for revision control.
23079 \begin_layout Standard
23080 As an example you can see how two TortoiseSVN commands could be integrated
23084 \begin_layout Description
23086 \begin_inset Flex Code
23089 \begin_layout Plain Layout
23090 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23098 \begin_layout Description
23100 \begin_inset Flex Code
23103 \begin_layout Plain Layout
23104 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23112 \begin_layout Subsection
23113 Version control and Document comparison
23116 \begin_layout Standard
23117 One of the typical uses of version control is to inspect the changes between
23118 revisions, usually by creating
23119 \begin_inset Flex Code
23122 \begin_layout Plain Layout
23129 While this is useful for plain text files, it is much less useful in the
23130 case of \SpecialChar LyX
23131 files, which have more a complicated structure.
23132 Hence we provide binding to the Document comparison feature.
23133 There are two ways of calling this feature - either by direct call of
23134 \begin_inset Flex Code
23137 \begin_layout Plain Layout
23144 function (for details see \SpecialChar LyX
23145 functions manual) or by icon/menu item
23146 \begin_inset Flex Noun
23149 \begin_layout Plain Layout
23150 Compare with older revision...
23156 One can either compare two chosen revisions of the document or he can simply
23157 compare the current version of edited text with older revisions (where
23159 \begin_inset Flex Noun
23162 \begin_layout Plain Layout
23168 ' revisions back means comparison of the edited file with last commited
23173 \begin_layout Standard
23174 This feature is supported for SVN and RCS though due to the more complicated
23175 versioning scheme of RCS there is a constraint – when addressing the revisions
23176 in dialog, numbers always point to the last number in RCS revision number,
23179 We don't currently support GIT addressing of revisions, one can just compare
23180 edited document with its revision X steps backs, where X is addressed as
23184 \begin_layout Section
23185 Literate Programming
23188 \begin_layout Standard
23193 (kayvan@sylvan.com)
23197 original documentation written by
23199 Edmar Wienskoski Jr.
23202 (edmar-w-jr@technologist.com)
23205 \begin_layout Subsection
23209 \begin_layout Standard
23210 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23212 programming, where it is assumed that you are familiar with this programming
23213 technique, and know what
23214 \begin_inset Quotes eld
23218 \begin_inset Quotes erd
23222 \begin_inset Quotes eld
23226 \begin_inset Quotes erd
23230 If that is not the case, please follow the web links provided in the following
23232 There is a lot of good documentation out there covering old development
23233 history to the latest tools tips.
23236 \begin_layout Standard
23237 It is also assumed that you are familiar with \SpecialChar LyX
23238 itself to a point that you
23239 are comfortable changing your \SpecialChar LyX
23240 preferences, and X resources file.
23241 If that is not the case please refer to other \SpecialChar LyX
23242 documentation to cover your
23246 \begin_layout Subsection
23247 Literate Programming
23250 \begin_layout Standard
23251 From the Literate Programming FAQ:
23254 \begin_layout Quotation
23255 Literate programming is the combination of documentation and source together
23256 in a fashion suited for reading by human beings.
23257 In fact, literate programs should be enjoyable reading, even inviting!
23258 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23259 and documentation in a single file.
23260 Literate programming tools then parse the file to produce either readable
23261 documentation or compilable source.
23262 The WEB style of literate programming was created by D.
23263 \begin_inset space \thinspace{}
23267 Knuth during the development of his \SpecialChar TeX
23268 typesetting software.
23272 \begin_layout Standard
23273 Another excerpt says:
23276 \begin_layout Quotation
23279 How is literate programming different from verbose commenting?
23282 \begin_layout Quotation
23283 There are three distinguishing characteristics.
23284 In order of importance, they are:
23288 \begin_layout Itemize
23289 flexible order of elaboration
23292 \begin_layout Itemize
23293 automatic support for browsing
23296 \begin_layout Itemize
23297 typeset documentation, especially diagrams and mathematics
23301 \begin_layout Standard
23302 Now that I sparked your curiosity, take a look in the references.
23305 \begin_layout Subsubsection
23309 \begin_layout Standard
23310 The complete Literate Programming FAQ can be found at:
23313 \begin_layout Quote
23314 Literate Programming FAQ
23315 \begin_inset Flex URL
23318 \begin_layout Plain Layout
23320 http://www.literateprogramming.com/lpfaq.pdf
23328 \begin_layout Standard
23329 The FAQ lists 23 (twenty three!) different literate programming tools.
23330 Where some are specialized or
23331 \begin_inset Quotes eld
23335 \begin_inset Quotes erd
23338 for particular programming languages, while other have general scope.
23343 for my own use for several reasons:
23346 \begin_layout Itemize
23347 It can generate the documentation either in \SpecialChar LaTeX
23351 \begin_layout Itemize
23352 It has a open architecture, i.
23353 \begin_inset space \thinspace{}
23357 \begin_inset space \space{}
23360 it is easy to plug in new filters and to perform special processing that
23365 \begin_layout Itemize
23366 There is a good selection of filters available already (the HTML is one
23370 \begin_layout Itemize
23374 \begin_layout Standard
23375 The Noweb web page can be found at:
23378 \begin_layout Quote
23380 \begin_inset Flex URL
23383 \begin_layout Plain Layout
23385 http://www.cs.virginia.edu/~nr/noweb/
23393 \begin_layout Standard
23394 Starting from there you can reach many other interesting links and even
23395 some literate program examples.
23398 \begin_layout Subsection
23400 and Literate Programming with Noweb
23403 \begin_layout Standard
23404 The \SpecialChar LyX
23405 support for Literate Programming is provided by using the generic \SpecialChar LyX
23407 converters mechanism.
23408 This support is provided in a
23409 \begin_inset Quotes eld
23413 \begin_inset Quotes erd
23417 \begin_inset space \thinspace{}
23421 \begin_inset space \space{}
23424 you will be able to use this new \SpecialChar LyX
23425 feature with some other literate programming
23426 tool of your choice by just changing your \SpecialChar LyX
23430 \begin_layout Subsubsection
23431 Generating documents and code (weaving and tangling)
23434 \begin_layout Paragraph
23435 Using the noweb module
23438 \begin_layout Standard
23439 If you have installed Noweb and \SpecialChar LyX
23440 successfully, whenever you open a new document,
23441 after you have chosen its document class, use the Document->Settings menu
23443 \begin_inset Quotes eld
23447 \begin_inset Quotes erd
23451 If Noweb is correctly installed, when you click on the
23452 \begin_inset Quotes eld
23456 \begin_inset Quotes erd
23459 link, you will see the
23460 \begin_inset Quotes eld
23464 \begin_inset Quotes erd
23467 module in the available list and you can add it to your document.
23470 \begin_layout Paragraph
23474 \begin_layout Standard
23476 enables you to write code with a layout named
23477 \begin_inset Flex Noun
23480 \begin_layout Plain Layout
23487 Noweb delimits chunks like this:
23490 \begin_layout LyX-Code
23494 \begin_layout LyX-Code
23498 \begin_layout LyX-Code
23502 \begin_layout LyX-Code
23506 \begin_layout LyX-Code
23510 \begin_layout Standard
23511 The problem is that whatever is written in between the << and the
23515 must be taken literally, i.
23516 \begin_inset space \thinspace{}
23520 \begin_inset space \space{}
23524 should be prevented from making any special interpretation of what has
23526 This is also handled by
23527 \begin_inset Flex Noun
23530 \begin_layout Plain Layout
23536 , that works like a normal paragraph but has a free spacing capability.
23539 \begin_layout Standard
23540 As a special note, you can also use the
23541 \begin_inset Quotes eld
23545 \begin_inset Quotes erd
23548 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23552 \begin_layout LyX-Code
23556 \begin_layout LyX-Code
23557 def some_function(args):
23560 \begin_layout LyX-Code
23561 "This is the doc string for this function."
23564 \begin_layout LyX-Code
23565 print "My args: ", args
23568 \begin_layout LyX-Code
23569 @ %def some_function
23572 \begin_layout Standard
23573 For an example of this usage and the resulting cross-reference output, look
23574 at the Literate python program in
23576 LIBDIR/examples/listerrors.lyx
23578 which should make this all clear.
23581 \begin_layout Paragraph
23582 Generating the documentation
23585 \begin_layout Standard
23586 At this point you already have a new document file with a proper document
23587 class, and with some code and text on it.
23588 How do I print it? The answer is simple, you select
23590 View\SpecialChar menuseparator
23594 Just like you would do for a plain document.
23595 No special procedure is required.
23598 \begin_layout Standard
23599 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23603 \begin_layout Enumerate
23606 Update\SpecialChar menuseparator
23609 menu option is chosen, a \SpecialChar LaTeX
23615 \begin_layout Standard
23616 If the document is of any literate class the generated file will be named
23617 with an extension name defined by the
23618 \begin_inset Quotes eld
23622 \begin_inset Quotes erd
23625 format (defined in the Preferences panel), otherwise the file will have
23634 \begin_layout Enumerate
23635 Note that the only difference so far is in the name of the file, no special
23636 processing is required by \SpecialChar LyX
23638 Given that you formatted the code using the
23639 \begin_inset Flex Noun
23642 \begin_layout Plain Layout
23648 layout that, by itself, takes care of the business.
23651 \begin_layout Enumerate
23652 If the document is of any literate class \SpecialChar LyX
23653 will then use the internal \SpecialChar LyX
23655 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23660 \begin_layout Plain Layout
23661 The converters are defined in the
23663 Tools\SpecialChar menuseparator
23667 \begin_inset Quotes eld
23671 \begin_inset Quotes erd
23683 manual for general information about converters.
23688 to generate the \SpecialChar LaTeX
23693 \begin_layout Standard
23694 Otherwise it will just skip this step.
23698 \begin_layout Enumerate
23699 Finally, \SpecialChar LaTeX
23700 is invoked and the regular post processing continues as in a plain
23704 \begin_layout Standard
23705 Independence from a particular
23706 \begin_inset Quotes eld
23710 \begin_inset Quotes erd
23713 is easily achieved by changing the commands that are run by the various
23717 \begin_layout Paragraph
23718 Generating the code
23721 \begin_layout Standard
23722 When the build menu option is chosen or the corresponding button in the
23723 toolbar is pressed, a \SpecialChar LaTeX
23724 file is generated just like step 1 above.
23725 Next, \SpecialChar LyX
23731 This converter needs to be defined by the user and is not installed by
23732 default, though the Program format is.
23733 This converter (like any other converter) will have two parts:
23736 \begin_layout Enumerate
23737 The converter program itself.
23738 This program performs the conversion from the one format to the other (in
23739 this case, from the Noweb format to the Program pseudo-format).
23742 \begin_layout Enumerate
23743 The error log parser.
23744 This is a program whose sole purpose is to rewrite error messages in a
23745 format that \SpecialChar LyX
23747 This makes it possible for \SpecialChar LyX
23748 to place error boxes in the right places in
23752 \begin_layout Standard
23753 The first part, the
23754 \begin_inset Quotes eld
23758 \begin_inset Quotes erd
23761 setting, should be set to
23762 \begin_inset Newline newline
23766 \begin_inset Quotes eld
23774 \begin_inset Quotes erd
23778 \begin_inset Newline newline
23781 This basically means that \SpecialChar LyX
23783 \begin_inset Quotes eld
23787 \begin_inset Quotes erd
23790 (a program or script) with the name of the Noweb file (normally a file
23791 in the \SpecialChar LyX
23792 temp directory) and the directory path of the original \SpecialChar LyX
23797 \begin_layout Standard
23798 This is an implementation of
23799 \begin_inset Quotes eld
23803 \begin_inset Quotes erd
23806 that you can place in a directory on your path:
23809 \begin_layout Standard
23810 \begin_inset VSpace defskip
23816 \begin_layout Standard
23817 \begin_inset Newpage pagebreak
23823 \begin_layout Standard
23829 \begin_layout Standard
23835 \begin_layout Standard
23838 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23841 \begin_layout Standard
23842 \begin_inset VSpace defskip
23848 \begin_layout Standard
23849 The next part of the converter setting is the
23850 \begin_inset Quotes eld
23854 \begin_inset Quotes erd
23857 which is to be set to
23858 \begin_inset Newline newline
23862 \begin_inset Quotes eld
23867 parselog=$$s/scripts/listerrors
23870 \begin_inset Quotes erd
23874 \begin_inset Newline newline
23877 This will run any errors that are generated by the
23878 \begin_inset Quotes eld
23882 \begin_inset Quotes erd
23885 process through the
23886 \begin_inset Quotes eld
23890 \begin_inset Quotes erd
23896 \begin_layout Standard
23897 The build will normally take place in \SpecialChar LyX
23898 's temporary directory, so the files
23899 produced by the conversion will be in that directory.
23901 will copy out what it regards as the `main' file, but the
23905 conversion may produce several files, and so most of these would then be
23906 deleted when \SpecialChar LyX
23908 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23909 the build-script chunk can place the generated files in that location.
23912 \begin_layout Paragraph
23913 Build instructions in the document
23916 \begin_layout Standard
23917 The last piece of the integration between \SpecialChar LyX
23919 \begin_inset Quotes eld
23923 \begin_inset Quotes erd
23927 Generally, the instructions for building your program should be embedded
23928 in a chunk of its own.
23930 \begin_inset Quotes eld
23934 \begin_inset Quotes erd
23937 above uses the notangle command to look for this chunk (called
23938 \begin_inset Quotes eld
23942 \begin_inset Quotes erd
23945 ) and runs its contents through
23946 \begin_inset Quotes eld
23950 \begin_inset Quotes erd
23956 \begin_layout Standard
23957 Typically, such a chunk would look something like this:
23960 \begin_layout LyX-Code
23964 \begin_layout LyX-Code
23966 \begin_inset Newline newline
23969 if [ -z "${NOWEB_SOURCE}" ]
23970 \begin_inset Newline newline
23976 \begin_layout LyX-Code
23977 NOWEB_SOURCE=myfile.nw
23978 \begin_inset Newline newline
23982 \begin_inset Newline newline
23986 code to extract files ...
23987 use NOWEB_OUTPUT_DIR here ...]
23988 \begin_inset Newline newline
23992 code to compile files ...]
23993 \begin_inset Newline newline
23999 \begin_layout Standard
24002 LIBDIR/examples/listerrors.lyx
24006 LIBDIR/examples/Literate.lyx
24008 which implement two versions of the
24009 \begin_inset Quotes eld
24013 \begin_inset Quotes erd
24016 program for some illustrations of how all of these pieces go together or
24019 LIBDIR/examples/noweb2lyx.lyx.
24022 Interestingly, these three files show off the language-indepence of the
24024 literate programming support since they are written in Python, C and Perl
24028 \begin_layout Subsubsection
24029 Configuring \SpecialChar LyX
24033 \begin_layout Standard
24034 All the Literate Programming support is configured by the
24036 Tools\SpecialChar menuseparator
24040 \begin_inset Quotes eld
24044 \begin_inset Quotes erd
24048 The important parts are:
24051 \begin_layout Description
24053 \begin_inset space ~
24057 \begin_inset Quotes eld
24061 \begin_inset Quotes erd
24065 \begin_inset space ~
24068 format Set up via the File Formats tab, this is where the Noweb-specific
24078 , the file extension is set to
24083 This tells \SpecialChar LyX
24084 to create a file with a
24088 extension in the first step of the conversion process.
24091 \begin_layout Description
24093 \begin_inset space ~
24101 \begin_inset space ~
24104 format This is an empty format whose sole purpose is to be the endpoint
24105 of a conversion (which then allows us to set up a converter for it).
24108 \begin_layout Description
24118 This converter performs the
24119 \begin_inset Quotes eld
24123 \begin_inset Quotes erd
24126 of the literate document.
24127 For Noweb, it is set to
24128 \begin_inset Quotes eld
24133 noweave -delay -index $$i > $$o
24136 \begin_inset Quotes erd
24142 \begin_layout Description
24152 \begin_inset Quotes eld
24156 \begin_inset Quotes erd
24160 As stated above, the Converter is set to
24161 \begin_inset Quotes eld
24169 \begin_inset Quotes erd
24172 , with Flags set to
24173 \begin_inset Newline newline
24177 \begin_inset Quotes eld
24182 parselog=$$s/scripts/listerrors
24185 \begin_inset Quotes erd
24191 \begin_layout Subsubsection
24195 \begin_layout Standard
24196 There is also a new function implemented in the \SpecialChar LyX
24198 \begin_inset Quotes eld
24201 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24205 \begin_layout Standard
24206 When debugging code with ddd/gdb, it is possible to invoke a text editor
24207 at the current execution position with a single key stroke.
24208 The default ddd configuration for that is shift-ctrl-V.
24209 It happens that you can define the editor command line invocation in ddd
24212 Edit\SpecialChar menuseparator
24213 Preferences\SpecialChar menuseparator
24216 dialog and changing the "Edit Sources" entry.
24219 \begin_layout Standard
24220 I take advantage of the newly created \SpecialChar LyX
24221 server function and this ddd feature,
24223 \begin_inset Quotes eld
24227 \begin_inset Quotes erd
24233 \begin_layout Standard
24234 \begin_inset VSpace defskip
24240 \begin_layout Standard
24243 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24246 \begin_layout Standard
24247 \begin_inset VSpace defskip
24253 \begin_layout Standard
24254 With this, whenever you are using ddd and find a point in the program that
24255 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24256 ddd will forward this information to \SpecialChar LyX
24257 through the \SpecialChar LyX
24258 server and then the
24260 window will show the same file with the cursor at the same position ddd
24262 No more guessing or long scrolling to locate a point in the program back
24266 \begin_layout Standard
24267 Note however that you must enable the \SpecialChar LyX
24268 server to get this feature working
24269 (it is disabled by default).
24270 You can enable it in
24282 ) by entering in the
24288 \begin_inset Quotes eld
24293 /home/<your-home-directory>/.lyx/lyxpipe
24296 \begin_inset Quotes erd
24302 \begin_layout Standard
24303 Read the \SpecialChar LyX
24304 server documentation in the
24306 Customization Manual
24308 for further information.
24311 \begin_layout Subsubsection
24315 \begin_layout Standard
24316 There are six new buttons that can be added to your \SpecialChar LyX
24318 Five of these buttons are short cuts to layout styles:
24341 The last one is a short cut to the
24342 \begin_inset Quotes eld
24346 \begin_inset Quotes erd
24353 \begin_layout Standard
24355 has a range of buttons that are available for tool bar customization.
24356 In my toolbar I like to combine the six short cuts above with two more:
24361 \SpecialChar menuseparator
24366 \SpecialChar menuseparator
24373 Document\SpecialChar menuseparator
24374 View\SpecialChar menuseparator
24378 Here is how it looks like:
24381 \begin_layout LyX-Code
24385 \begin_layout LyX-Code
24389 \begin_layout LyX-Code
24390 Icon "layout Standard"
24393 \begin_layout LyX-Code
24394 Icon "layout Section"
24397 \begin_layout LyX-Code
24398 Icon "layout \SpecialChar LaTeX
24402 \begin_layout LyX-Code
24403 Icon "layout \SpecialChar LyX
24407 \begin_layout LyX-Code
24408 Icon "layout Chunk"
24411 \begin_layout LyX-Code
24415 \begin_layout LyX-Code
24419 \begin_layout LyX-Code
24420 Icon "buffer-typeset"
24423 \begin_layout LyX-Code
24424 Icon "build-program"
24427 \begin_layout LyX-Code
24431 \begin_layout LyX-Code
24435 \begin_layout LyX-Code
24439 \begin_layout LyX-Code
24443 \begin_layout LyX-Code
24447 \begin_layout Subsubsection
24448 Colors customization
24451 \begin_layout Standard
24452 There are a number of colors in \SpecialChar LyX
24453 that can be customized in
24458 One of the things that bothers people is the \SpecialChar LaTeX
24460 The default color is red, since the chunks uses \SpecialChar LaTeX
24461 font, and there is a lot
24462 of chunks in literate documents, you may get tired of seeing everything
24464 You can change it by going to the tabs
24473 \begin_layout Standard
24474 The next thing is the visible presence of the newline character in the screen.
24475 You can choose the color of this particular character and make it blend
24477 I recommend you choosing a color that is close to the background but not
24478 equal, that way you still can see it is there, but it is not bothering
24482 \begin_layout Subsection
24487 \begin_layout Standard
24496 is documented in the
24500 example file and in the Sweave manual (menu
24502 Help\SpecialChar menuseparator
24508 \begin_layout Chapter
24512 \begin_layout Standard
24513 You can do everything with \SpecialChar LyX
24514 that you can do with \SpecialChar LaTeX
24516 However, \SpecialChar LyX
24517 cannot support every \SpecialChar LaTeX
24519 But you can always use \SpecialChar TeX
24521 This chapter shows you some more special things you might want to use.
24522 For other special things you can do with figures, tables, floats, boxes
24523 and notes, have a look at the
24526 \begin_inset space ~
24534 \begin_layout Section
24535 Multiple Text Columns
24538 \begin_layout Standard
24539 This feature is independent of the option
24541 Two-column document
24543 in the document settings under
24548 If you want to have 2
24549 \begin_inset space ~
24552 columns for the whole document, it is recommended to use the
24554 Two-column document
24557 For all other cases use this feature.
24560 \begin_layout Standard
24561 To use multiple text columns in your document, you have to load the module
24568 Document\SpecialChar menuseparator
24569 Settings\SpecialChar menuseparator
24572 ) and must have the \SpecialChar LaTeX
24580 \begin_layout Standard
24581 Footnotes within multiple columns will be placed at the bottom of the page
24582 and not under each column.
24583 Within the different columns you can use everything, with the limitation
24584 that for floats you need to use the float option
24591 \begin_layout Subsection
24595 \begin_layout Standard
24596 If you want to have 2
24597 \begin_inset space ~
24600 columns in your text, insert a multicolumn inset via the menu
24602 Insert\SpecialChar menuseparator
24604 \begin_inset space ~
24607 Insets\SpecialChar menuseparator
24609 \begin_inset space ~
24614 where the columns should start.
24615 Write all text that should be printed in 2
24616 \begin_inset space ~
24619 columns into this inset.
24622 \begin_layout Standard
24623 Here is an example:
24626 \begin_layout Standard
24628 \begin_inset Flex Multiple Columns
24631 \begin_layout Plain Layout
24636 The Adventure of the Empty House
24639 \begin_inset Newline newline
24642 by Sir Arthur Conan Doyle
24645 \begin_layout Plain Layout
24648 It was in the spring of the year 1894 that all London was interested, and
24649 the fashionable world dismayed, by the murder of the Honourable Ronald
24650 Adair under most unusual and inexplicable circumstances.
24651 The public has already learned those particulars of the crime which came
24652 out in the police investigation, but a good deal was suppressed upon that
24653 occasion, since the case for the prosecution was so overwhelmingly strong
24654 that it was not necessary to bring forward all the facts.
24655 Only now, at the end of nearly ten years, am I allowed to supply those
24656 missing links which make up the whole of that remarkable chain.
24657 The crime was of interest in itself, but that interest was as nothing to
24658 me compared to the inconceivable sequel, which afforded me the greatest
24659 shock and surprise of any event in my adventurous life.
24660 Even now, after this long interval, I find myself thrilling as I think
24661 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24662 ty which utterly submerged my mind.
24663 Let me say to that public, which has shown some interest in those glimpses
24664 which I have occasionally given them of the thoughts and actions of a very
24665 remarkable man, that they are not to blame me if I have not shared my knowledge
24666 with them, for I should have considered it my first duty to do so, had
24667 I not been barred by a positive prohibition from his own lips, which was
24668 only withdrawn upon the third of last month.
24676 \begin_layout Standard
24677 To get 3 or more columns, set the cursor into the multicolumn inset and
24680 Insert\SpecialChar menuseparator
24682 \begin_inset space ~
24686 \begin_inset space ~
24692 The number of the desired columns is written into that inset (for 3
24693 \begin_inset space ~
24697 \begin_inset Quotes eld
24701 \begin_inset Quotes erd
24705 \begin_inset Newline newline
24708 Here is an example with 3
24709 \begin_inset space ~
24715 \begin_layout Standard
24716 \begin_inset Flex Multiple Columns
24719 \begin_layout Plain Layout
24722 \begin_inset Argument 1
24725 \begin_layout Plain Layout
24731 It can be imagined that my close intimacy with Sherlock Holmes had interested
24732 me deeply in crime, and that after his disappearance I never failed to
24733 read with care the various problems which came before the public.
24734 And I even attempted, more than once, for my own private satisfaction,
24735 to employ his methods in their solution, though with indifferent success.
24736 There was none, however, which appealed to me like this tragedy of Ronald
24738 As I read the evidence at the inquest, which led up to a verdict of willful
24739 murder against some person or persons unknown, I realized more clearly
24740 than I had ever done the loss which the community had sustained by the
24741 death of Sherlock Holmes.
24742 There were points about this strange business which would, I was sure,
24743 have specially appealed to him, and the efforts of the police would have
24744 been supplemented, or more probably anticipated, by the trained observation
24745 and the alert mind of the first criminal agent in Europe.
24746 All day, as I drove upon my round, I turned over the case in my mind and
24747 found no explanation which appeared to me to be adequate.
24748 At the risk of telling a twice-told tale, I will recapitulate the facts
24749 as they were known to the public at the conclusion of the inquest.
24757 \begin_layout Standard
24758 You can have up to 10
24759 \begin_inset space ~
24762 columns if you want to, but that might not be very pleasant for the readers
24766 \begin_layout Standard
24767 \begin_inset Newpage newpage
24773 \begin_layout Subsection
24774 Columns inside Columns
24777 \begin_layout Standard
24778 You can also have columns inside columns:
24781 \begin_layout Standard
24782 \begin_inset Flex Multiple Columns
24785 \begin_layout Plain Layout
24788 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24789 at that time governor of one of the Australian colonies.
24790 Adair's mother had returned from Australia to undergo the operation for
24791 cataract, and she, her son Ronald, and her daughter Hilda were living together
24795 \begin_layout Plain Layout
24796 \begin_inset Flex Multiple Columns
24799 \begin_layout Plain Layout
24802 The youth moved in the best society–had, so far as was known, no enemies
24803 and no particular vices.
24804 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24805 had been broken off by mutual consent some months before, and there was
24806 no sign that it had left any very profound feeling behind it.
24807 For the rest {sic} the man's life moved in a narrow and conventional circle,
24808 for his habits were quiet and his nature unemotional.
24809 Yet it was upon this easy-going young aristocrat that death came, in most
24810 strange and unexpected form, between the hours of ten and eleven-twenty
24811 on the night of March 30, 1894.
24819 \begin_layout Plain Layout
24822 Ronald Adair was fond of cards–playing continually, but never for such stakes
24824 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24825 It was shown that, after dinner on the day of his death, he had played
24826 a rubber of whist at the latter club.
24827 He had also played there in the afternoon.
24832 The evidence of those who had played with him– Mr.
24833 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24834 and that there was a fairly equal fall of the cards.
24835 Adair might have lost five pounds, but not more.
24836 His fortune was a considerable one, and such a loss could not in any way
24838 He had played nearly every day at one club or other, but he was a cautious
24839 player, and usually rose a winner.
24840 It came out in evidence that, in partnership with Colonel Moran, he had
24841 actually won as much as four hundred and twenty pounds in a sitting, some
24842 weeks before, from Godfrey Milner and Lord Balmoral.
24843 So much for his recent history as it came out at the inquest.
24851 \begin_layout Subsection
24855 \begin_layout Standard
24856 The examples in this section show some more special features of multiple
24860 \begin_layout Standard
24861 For more features of multiple columns, have a look at the documentation
24862 of the \SpecialChar LaTeX
24868 \begin_inset CommandInset citation
24878 \begin_layout Subsubsection
24882 \begin_layout Standard
24883 To add a preface text for multiple columns, set the cursor into the multicolumn
24884 inset and use the menu
24886 Insert\SpecialChar menuseparator
24890 Write your preface text into that inset.
24891 \begin_inset Newline newline
24894 This is an example with some preface text:
24897 \begin_layout Standard
24898 \begin_inset VSpace bigskip
24904 \begin_layout Standard
24905 \begin_inset Flex Multiple Columns
24908 \begin_layout Plain Layout
24909 \begin_inset Argument 2
24912 \begin_layout Plain Layout
24913 And the story continues and continues and continues and continues\SpecialChar ldots
24921 On the evening of the crime, he returned from the club exactly at ten.
24922 His mother and sister were out spending the evening with a relation.
24923 The servant deposed that she heard him enter the front room on the second
24924 floor, generally used as his sitting-room.
24925 She had lit a fire there, and as it smoked she had opened the window.
24926 No sound was heard from the room until eleven-twenty, the hour of the return
24927 of Lady Maynooth and her daughter.
24928 Desiring to say good-night, she attempted to enter her son's room.
24929 The door was locked on the inside, and no answer could be got to their
24930 cries and knocking.
24931 Help was obtained, and the door forced.
24932 The unfortunate young man was found lying near the table.
24933 His head had been horribly mutilated by an expanding revolver bullet, but
24934 no weapon of any sort was to be found in the room.
24942 \begin_layout Standard
24943 You can also use a section heading as the preface if you use a section command
24944 as \SpecialChar TeX
24946 For example the command
24949 \begin_layout Standard
24954 subsection{subsection title}
24957 \begin_layout Standard
24958 creates a subsection.
24959 In this example the preface is a subsubsection:
24962 \begin_layout Standard
24963 \begin_inset Flex Multiple Columns
24966 \begin_layout Plain Layout
24967 \begin_inset Argument 2
24970 \begin_layout Plain Layout
24974 \begin_layout Plain Layout
24983 This is a subsubsection heading as a preface
24987 \begin_layout Plain Layout
25001 A minute examination of the circumstances served only to make the case more
25003 In the first place, no reason could be given why the young man should have
25004 fastened the door upon the inside.
25005 There was the possibility that the murderer had done this, and had afterwards
25006 escaped by the window.
25007 The drop was at least twenty feet, however, and a bed of crocuses in full
25009 Neither the flowers nor the earth showed any sign of having been disturbed,
25010 nor were there any marks upon the narrow strip of grass which separated
25011 the house from the road.
25012 Apparently, therefore, it was the young man himself who had fastened the
25014 But how did he come by his death? No one could have climbed up to the window
25015 without leaving traces.
25016 Suppose a man had fired through the window, he would indeed be a remarkable
25017 shot who could with a revolver inflict so deadly a wound.
25018 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
25019 a hundred yards of the house.
25020 No one had heard a shot.
25028 \begin_layout Standard
25029 If there is less vertical space than 6
25030 \begin_inset space ~
25033 text lines is left on the page at the beginning of the multiple columns,
25034 a page break will be inserted before the multiple columns.
25035 Depending on the number of lines of the preface text, you might want to
25037 This is done by setting the cursor into the mulitcolumn inset behind the
25038 preface (if there is any) and using the menu
25040 Insert\SpecialChar menuseparator
25042 \begin_inset space ~
25046 \begin_inset space ~
25050 \begin_inset space ~
25056 Insert into that inset the amount of space like e.
25057 \begin_inset space \thinspace{}
25061 \begin_inset space \space{}
25065 \begin_inset Quotes eld
25069 \begin_inset Quotes erd
25073 \begin_inset Newline newline
25076 In this example the space is set to 7
25077 \begin_inset space ~
25080 text lines by using
25081 \begin_inset Quotes eld
25087 \begin_inset Quotes erd
25096 needs to be inserted as \SpecialChar TeX
25100 \begin_layout Standard
25101 \begin_inset Flex Multiple Columns
25104 \begin_layout Plain Layout
25105 \begin_inset Argument 3
25108 \begin_layout Plain Layout
25113 \begin_layout Plain Layout
25129 On the evening of the crime, he returned from the club exactly at ten.
25130 His mother and sister were out spending the evening with a relation.
25131 The servant deposed that she heard him enter the front room on the second
25132 floor, generally used as his sitting-room.
25133 She had lit a fire there, and as it smoked she had opened the window.
25134 No sound was heard from the room until eleven-twenty, the hour of the return
25135 of Lady Maynooth and her daughter.
25136 Desiring to say good-night, she attempted to enter her son's room.
25137 The door was locked on the inside, and no answer could be got to their
25138 cries and knocking.
25139 Help was obtained, and the door forced.
25140 The unfortunate young man was found lying near the table.
25141 His head had been horribly mutilated by an expanding revolver bullet, but
25142 no weapon of any sort was to be found in the room.
25150 \begin_layout Subsubsection
25154 \begin_layout Standard
25155 The amount of space before and after multiple columns can be changed by
25156 changing the length
25163 For example the command
25166 \begin_layout Standard
25176 \begin_layout Standard
25177 in \SpecialChar TeX
25178 Code changes its value to 3
25179 \begin_inset space \thinspace{}
25183 The change must be made before the multiple columns' start.
25184 The predefined value is 13
25185 \begin_inset space \thinspace{}
25191 \begin_layout Standard
25199 \begin_inset space \thinspace{}
25205 \begin_layout Standard
25209 \begin_layout Plain Layout
25215 multicolsep}{2.5cm}
25223 \begin_layout Standard
25224 \begin_inset Flex Multiple Columns
25227 \begin_layout Plain Layout
25230 All day I turned these facts over in my mind, endeavouring to hit upon some
25231 theory which could reconcile them all, and to find that line of least resistanc
25232 e which my poor friend had declared to be the starting-point of every investigat
25234 I confess that I made little progress.
25235 In the evening I strolled across the Park, and found myself about six o'clock
25236 at the Oxford Street end of Park Lane.
25237 A group of loafers upon the pavements, all staring up at a particular window,
25238 directed me to the house which I had come to see.
25239 A tall, thin man with coloured glasses, whom I strongly suspected of being
25240 a plain-clothes detective, was pointing out some theory of his own, while
25241 the others crowded round to listen to what he said.
25242 I got as near him as I could, but his observations seemed to me to be absurd,
25243 so I withdrew again in some disgust.
25244 As I did so I struck against an elderly, deformed man, who had been behind
25245 me, and I knocked down several books which he was carrying.
25253 \begin_layout Standard
25254 \begin_inset Note Greyedout
25257 \begin_layout Plain Layout
25262 The values you set with
25268 will be used for all following multiple columns until you change them again.
25276 \begin_layout Standard
25280 \begin_layout Plain Layout
25292 \begin_inset Note Note
25295 \begin_layout Plain Layout
25296 go back to the default
25304 \begin_layout Standard
25305 \begin_inset Newpage newpage
25311 \begin_layout Subsubsection
25315 \begin_layout Standard
25316 A column break can be forced by inserting the command
25322 as \SpecialChar TeX
25323 Code to that position in the text where the column should be broken.
25324 Note that this leads in most cases to whitespace in the text.
25325 \begin_inset Newline newline
25328 Here is an example:
25331 \begin_layout Standard
25332 \begin_inset Flex Multiple Columns
25335 \begin_layout Plain Layout
25338 \begin_inset Quotes eld
25341 You're surprised to see me, sir,
25342 \begin_inset Quotes erd
25345 said he, in a strange, croaking voice.
25348 \begin_layout Plain Layout
25351 I acknowledged that I was.
25354 \begin_layout Plain Layout
25357 \begin_inset Quotes eld
25360 Well, I've a conscience, sir, and when I chanced to see you go into this
25361 house, as I came hobbling after you, I thought to myself, I'll just step
25362 in and see that kind gentleman, and tell him that if I was a bit gruff
25363 in my manner there was not any harm meant, and that I am much obliged to
25364 him for picking up my books.
25365 \begin_inset Quotes erd
25371 \begin_layout Plain Layout
25374 \begin_inset Quotes eld
25377 You make too much of a trifle,
25378 \begin_inset Quotes erd
25383 \begin_inset Quotes eld
25386 May I ask how you knew who I was?
25387 \begin_inset Quotes erd
25390 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25394 \begin_layout Plain Layout
25406 \begin_layout Plain Layout
25409 \begin_inset Quotes eld
25412 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25413 you'll find my little bookshop at the corner of Church Street, and very
25414 happy to see you, I am sure.
25415 Maybe you collect yourself, sir.
25419 \begin_inset space ~
25432 –a bargain, every one of them.
25433 With five volumes you could just fill that gap on that second shelf.
25434 It looks untidy, does it not, sir?
25435 \begin_inset Quotes erd
25446 \begin_layout Subsubsection
25450 \begin_layout Standard
25451 The width of the columns is automatically calculated, but you can modify
25452 the space between the columns.
25453 This is done by changing the length
25460 Its predefined value is 10
25461 \begin_inset space \thinspace{}
25465 Here is an example where
25472 \begin_inset space \thinspace{}
25478 \begin_layout Standard
25482 \begin_layout Plain Layout
25496 \begin_layout Standard
25497 \begin_inset Flex Multiple Columns
25500 \begin_layout Plain Layout
25503 My observations of No.
25504 \begin_inset space \space{}
25507 427 Park Lane did little to clear up the problem in which I was interested.
25508 The house was separated from the street by a low wall and railing, the
25509 whole not more than five feet high.
25510 It was perfectly easy, therefore, for anyone to get into the garden, but
25511 the window was entirely inaccessible, since there was no water pipe or
25512 anything which could help the most active man to climb it.
25513 More puzzled than ever, I retraced my steps to Kensington.
25514 I had not been in my study five minutes when the maid entered to say that
25515 a person desired to see me.
25516 To my astonishment it was none other than my strange old book collector,
25517 his sharp, wizened face peering out from a frame of white hair, and his
25518 precious volumes, a dozen of them at least, wedged under his right arm.
25526 \begin_layout Standard
25530 \begin_layout Plain Layout
25542 \begin_inset Note Note
25545 \begin_layout Plain Layout
25546 go back to the default
25554 \begin_layout Subsubsection
25558 \begin_layout Standard
25559 Between the columns a rule with a width of the length
25566 If this rule width is set to 0
25567 \begin_inset space \thinspace{}
25570 pt (this is the default), the rule is suppressed.
25571 In the following example the rule is 2
25572 \begin_inset space \thinspace{}
25578 \begin_layout Standard
25582 \begin_layout Plain Layout
25588 columnseprule}{2pt}
25596 \begin_layout Standard
25597 \begin_inset Flex Multiple Columns
25600 \begin_layout Plain Layout
25603 \begin_inset Quotes eld
25606 You're surprised to see me, sir,
25607 \begin_inset Quotes erd
25610 said he, in a strange, croaking voice.
25613 \begin_layout Plain Layout
25616 I acknowledged that I was.
25619 \begin_layout Plain Layout
25622 \begin_inset Quotes eld
25625 Well, I've a conscience, sir, and when I chanced to see you go into this
25626 house, as I came hobbling after you, I thought to myself, I'll just step
25627 in and see that kind gentleman, and tell him that if I was a bit gruff
25628 in my manner there was not any harm meant, and that I am much obliged to
25629 him for picking up my books.
25630 \begin_inset Quotes erd
25636 \begin_layout Plain Layout
25639 \begin_inset Quotes eld
25642 You make too much of a trifle,
25643 \begin_inset Quotes erd
25648 \begin_inset Quotes eld
25651 May I ask how you knew who I was?
25652 \begin_inset Quotes erd
25658 \begin_layout Plain Layout
25661 \begin_inset Quotes eld
25664 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25665 you'll find my little bookshop at the corner of Church Street, and very
25666 happy to see you, I am sure.
25667 Maybe you collect yourself, sir.
25671 \begin_inset space ~
25684 –a bargain, every one of them.
25685 With five volumes you could just fill that gap on that second shelf.
25686 It looks untidy, does it not, sir?
25687 \begin_inset Quotes erd
25698 \begin_layout Standard
25699 \begin_inset VSpace defskip
25705 \begin_layout Standard
25706 The rule can be colored by redefining the command
25713 This is done by inserting the command
25714 \begin_inset Newline newline
25723 columnseprulecolor}{
25728 \begin_inset Newline newline
25731 as \SpecialChar TeX
25732 Code before the multicolumn inset.
25737 in this command by a color of your choice.
25738 You can use all pre- and self-defined colors.
25746 \begin_inset space ~
25751 for more information about pre- and self-defined colors.
25752 To go back to the default color insert the command
25753 \begin_inset Newline newline
25762 columnseprulecolor}{
25767 \begin_inset Newline newline
25770 Here is the example with a cyan rule and 1
25771 \begin_inset space \thinspace{}
25774 cm column separation:
25777 \begin_layout Standard
25781 \begin_layout Plain Layout
25790 \begin_layout Plain Layout
25796 columnseprulecolor}{
25806 \begin_layout Standard
25807 \begin_inset Flex Multiple Columns
25810 \begin_layout Plain Layout
25813 \begin_inset Quotes eld
25816 You're surprised to see me, sir,
25817 \begin_inset Quotes erd
25820 said he, in a strange, croaking voice.
25823 \begin_layout Plain Layout
25826 I acknowledged that I was.
25829 \begin_layout Plain Layout
25832 \begin_inset Quotes eld
25835 Well, I've a conscience, sir, and when I chanced to see you go into this
25836 house, as I came hobbling after you, I thought to myself, I'll just step
25837 in and see that kind gentleman, and tell him that if I was a bit gruff
25838 in my manner there was not any harm meant, and that I am much obliged to
25839 him for picking up my books.
25840 \begin_inset Quotes erd
25846 \begin_layout Plain Layout
25849 \begin_inset Quotes eld
25852 You make too much of a trifle,
25853 \begin_inset Quotes erd
25858 \begin_inset Quotes eld
25861 May I ask how you knew who I was?
25862 \begin_inset Quotes erd
25868 \begin_layout Plain Layout
25871 \begin_inset Quotes eld
25874 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25875 you'll find my little bookshop at the corner of Church Street, and very
25876 happy to see you, I am sure.
25877 Maybe you collect yourself, sir.
25881 \begin_inset space ~
25894 –a bargain, every one of them.
25895 With five volumes you could just fill that gap on that second shelf.
25896 It looks untidy, does it not, sir?
25897 \begin_inset Quotes erd
25908 \begin_layout Standard
25912 \begin_layout Plain Layout
25918 columnseprule}{0pt}
25921 \begin_layout Plain Layout
25927 columnseprulecolor}{
25935 \begin_inset Note Note
25938 \begin_layout Plain Layout
25939 go back to the default
25947 \begin_layout Section
25948 Non-standard Paragraph Shapes
25951 \begin_layout Standard
25954 as well as any other text processor uses by default rectangular paragraphs.
25955 For special cases like for example posters, invitation cards or poems you
25956 can modify the paragraph shape to one of your choice.
25957 This can be done by using the \SpecialChar LaTeX
25962 which is loaded by using in the document settings the module
25964 Custom paragraph shapes
25969 \begin_layout Subsection
25973 \begin_layout Standard
25978 provides the following shapes:
25981 \begin_layout Standard
25982 \begin_inset Tabular
25983 <lyxtabular version="3" rows="13" columns="3">
25984 <features booktabs="true" islongtable="true" longtabularalignment="center">
25985 <column alignment="center" valignment="middle" width="16col%">
25986 <column alignment="center" valignment="middle" width="40col%">
25987 <column alignment="center" valignment="middle" width="35col%">
25988 <row endhead="true">
25989 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25992 \begin_layout Plain Layout
25998 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26001 \begin_layout Plain Layout
26007 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26010 \begin_layout Plain Layout
26018 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26021 \begin_layout Plain Layout
26027 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26030 \begin_layout Plain Layout
26031 Circle with circular hole (in the size of a CD/DVD)
26036 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26039 \begin_layout Plain Layout
26040 Cannot be scaled, take care there is not too much text
26047 <cell alignment="center" valignment="top" topline="true" usebox="none">
26050 \begin_layout Plain Layout
26056 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26059 \begin_layout Plain Layout
26065 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26068 \begin_layout Plain Layout
26069 Fragile, calculation might fail
26076 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26079 \begin_layout Plain Layout
26085 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26088 \begin_layout Plain Layout
26089 Rhomboid (symbolizing a
26090 \begin_inset Quotes eld
26094 \begin_inset Quotes erd
26102 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26105 \begin_layout Plain Layout
26113 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26116 \begin_layout Plain Layout
26122 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26125 \begin_layout Plain Layout
26131 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26134 \begin_layout Plain Layout
26142 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26145 \begin_layout Plain Layout
26151 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26154 \begin_layout Plain Layout
26160 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26163 \begin_layout Plain Layout
26171 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26174 \begin_layout Plain Layout
26180 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26183 \begin_layout Plain Layout
26184 Nut for bolt (hexagon with circular hole)
26189 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26192 \begin_layout Plain Layout
26200 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26203 \begin_layout Plain Layout
26209 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26212 \begin_layout Plain Layout
26218 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26221 \begin_layout Plain Layout
26229 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26232 \begin_layout Plain Layout
26238 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26241 \begin_layout Plain Layout
26247 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26250 \begin_layout Plain Layout
26258 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26261 \begin_layout Plain Layout
26267 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26270 \begin_layout Plain Layout
26276 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26279 \begin_layout Plain Layout
26287 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26290 \begin_layout Plain Layout
26296 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26299 \begin_layout Plain Layout
26300 Normal/reversed rain drop
26305 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26308 \begin_layout Plain Layout
26309 Fragile, calculation might fail
26316 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26319 \begin_layout Plain Layout
26326 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26329 \begin_layout Plain Layout
26330 The \SpecialChar TeX
26336 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26339 \begin_layout Plain Layout
26347 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26350 \begin_layout Plain Layout
26352 \begin_inset Newline newline
26360 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26363 \begin_layout Plain Layout
26364 Triangles in different orientations
26369 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26372 \begin_layout Plain Layout
26386 \begin_layout Standard
26387 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26389 for environments in the toolbar.
26392 \begin_layout Standard
26393 \begin_inset Newpage newpage
26399 \begin_layout Standard
26400 Here is an example paragraph in the shape of a nut:
26403 \begin_layout Standard
26404 \begin_inset VSpace bigskip
26413 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26414 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26416 At vero eos et accusam et justo duo dolores et ea rebum.
26417 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26419 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26420 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26424 \begin_layout Standard
26425 \begin_inset VSpace bigskip
26431 \begin_layout Standard
26432 \begin_inset Note Greyedout
26435 \begin_layout Plain Layout
26440 : shapepar paragraphs cannot run over a page break.
26448 \begin_layout Standard
26449 \begin_inset VSpace bigskip
26455 \begin_layout Standard
26460 takes care that the shape will always be preserved, no matter how much
26461 text is in the paragraph.
26462 Therefore the paragraph size changes with the amount of contained text.
26463 This can lead to paragraph sizes exceeding the page margins.
26464 To demonstrate the size scaling, here is the same example paragraph but
26465 with twice as much text:
26468 \begin_layout Standard
26469 \begin_inset Newpage newpage
26478 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26479 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26481 At vero eos et accusam et justo duo dolores et ea rebum.
26482 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26484 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26485 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26487 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26488 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26490 At vero eos et accusam et justo duo dolores et ea rebum.
26491 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26493 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26494 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26498 \begin_layout Standard
26499 \begin_inset VSpace bigskip
26505 \begin_layout Standard
26506 An exception is the shape
26511 It cannot be scaled because it must fit the size of a CD/DVD.
26512 Therefore the amount of text that fits into the shape is limited.
26513 \begin_inset Newline newline
26524 shape are fragile, meaning that the calculation of their size can fail,
26525 depending on the amount of text.
26526 You will then get the \SpecialChar LaTeX
26528 \begin_inset Quotes eld
26531 Arithmetic overflow
26532 \begin_inset Quotes erd
26536 In this case one can try to remove or add some text; if nothing works one
26537 has to use another shape.
26540 \begin_layout Standard
26541 \begin_inset VSpace bigskip
26547 \begin_layout Standard
26548 For shapes with tips you will maybe see that \SpecialChar LaTeX
26549 's hyphenation routine fails
26550 for text in the tips.
26551 Therefore it is often necessary to add hyphenation points
26556 arg "specialchar-insert hyphenation"
26561 ) to the corresponding text parts.
26564 \begin_layout Standard
26565 \begin_inset VSpace bigskip
26571 \begin_layout Standard
26572 Shapepar paragraphs are either always centered or placed on the page so
26573 that their left border touches the left page margin.
26574 You can therefore not use the paragraph dialog to align such paragraphs.
26575 A solution is to put the paragraph into a minipage or parbox and align
26577 The problem is hereby to find the right width for the box.
26578 Because if it is too wide and you center the box, the paragraph is not
26579 centered too because it sticks at the left side of the box.
26580 So you might have to play a bit with the width until it fits.
26581 Here are two heart-shaped paragraphs, the first one is not aligned, the
26582 second one is right-aligned:
26585 \begin_layout Standard
26586 \begin_inset Newpage newpage
26592 \begin_layout Heart
26596 Lo\SpecialChar softhyphen
26597 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26598 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26600 At vero eos et accusam et justo duo dolores et ea rebum.
26601 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26605 \begin_layout Standard
26606 \begin_inset VSpace bigskip
26612 \begin_layout Standard
26615 \begin_inset Box Frameless
26625 height_special "totalheight"
26630 backgroundcolor "none"
26633 \begin_layout Heart
26637 Lo\SpecialChar softhyphen
26638 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26639 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26641 At vero eos et accusam et justo duo dolores et ea rebum.
26642 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26651 \begin_layout Subsection
26655 \begin_layout Standard
26656 You can define any shape you want.
26657 Doing this manually is a lot of work because every coordinate must be specified.
26658 But there is a way to let the computer calculate the coordinates:
26661 \begin_layout Enumerate
26662 Install the program
26663 \begin_inset CommandInset href
26666 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26674 \begin_layout Enumerate
26681 TeX/LaTeX\SpecialChar menuseparator
26682 Settings\SpecialChar menuseparator
26685 and select the font size you are using in your document.
26686 For example this document uses the size 12
26687 \begin_inset space \thinspace{}
26693 \begin_layout Enumerate
26697 \begin_layout Enumerate
26700 TeX/LaTeX\SpecialChar menuseparator
26703 to export the shape to coordinates.
26704 In the appearing dialog use either the outline of your shape for the coordinate
26705 s or the path itself.
26709 \begin_layout Plain Layout
26710 For more information see
26711 \begin_inset CommandInset href
26713 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26726 \begin_layout Standard
26727 The coordinates are written into a \SpecialChar TeX
26729 To use it for your \SpecialChar LyX
26733 \begin_layout Enumerate
26734 Place the cursor before the first character of your paragraph (or into a
26738 \begin_layout Enumerate
26739 Open in \SpecialChar LyX
26742 Insert\SpecialChar menuseparator
26743 File\SpecialChar menuseparator
26745 \begin_inset space ~
26750 , select the file and use
26759 \begin_layout Standard
26760 \begin_inset VSpace defskip
26766 \begin_layout Standard
26767 \begin_inset Note Greyedout
26770 \begin_layout Plain Layout
26775 : The changed shape only applies to the current paragraph; everything is
26776 reset to normal for the next paragraph.
26777 Therefore the shape definition file must be input into every paragraph
26778 with the desired shape.
26786 \begin_layout Standard
26787 \begin_inset VSpace bigskip
26793 \begin_layout Standard
26794 Here is an example:
26797 \begin_layout Standard
26798 \begin_inset VSpace bigskip
26804 \begin_layout Standard
26805 \begin_inset CommandInset include
26807 filename "SpecialParagraphShape.tex"
26813 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26814 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26816 At vero eos et accusam et justo duo dolores et ea rebum.
26817 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26819 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26820 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26824 \begin_layout Standard
26825 \begin_inset VSpace bigskip
26831 \begin_layout Standard
26836 to draw complexer shapes in
26840 you can draw the shape in a program of your choice and import the resulting
26846 Then you only need to draw a line or spline along the outline of the image.
26849 \begin_layout Standard
26850 \begin_inset VSpace bigskip
26856 \begin_layout Standard
26859 Custom paragraph shapes
26861 also provides the two commands
26869 which can be used to define custom shapes coordinate by coordinate.
26873 \begin_layout Plain Layout
26874 These commands are internally used for all shapes described here.
26879 For information how these styles are used and about further customization
26880 possibilities, have a look at the documentation of the package
26885 \begin_inset CommandInset citation
26895 \begin_layout Bibliography
26896 \begin_inset CommandInset bibitem
26897 LatexCommand bibitem
26903 Documentation of the \SpecialChar LaTeX
26905 \begin_inset CommandInset href
26908 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26916 \begin_layout Bibliography
26917 \begin_inset CommandInset bibitem
26918 LatexCommand bibitem
26924 Documentation of the \SpecialChar LaTeX
26926 \begin_inset CommandInset href
26929 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"