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 1500887411
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
7566 \change_inserted -712698321 1500887421
7570 \change_inserted -712698321 1500887423
7574 \change_inserted -712698321 1500887424
7578 \change_inserted -712698321 1500887426
7586 in the viewer setting in
7587 \begin_inset Flex Noun
7590 \begin_layout Plain Layout
7591 Preferences\SpecialChar menuseparator
7592 File Handling\SpecialChar menuseparator
7593 File formats\SpecialChar menuseparator
7600 \begin_inset Flex Code
7603 \begin_layout Plain Layout
7609 is the previous wrapper.
7610 If SumatraPDF.exe is not in your command PATH, use its full file name.
7613 \begin_layout Standard
7614 Reverse search is triggered by double-click.
7617 \begin_layout Subsubsection*
7621 \begin_layout Standard
7622 First of all, make sure that yap is your default DVI viewer in the Windows
7623 environment, then launch it, choose its
7624 \begin_inset Flex Noun
7627 \begin_layout Plain Layout
7628 View\SpecialChar menuseparator
7635 \begin_inset Quotes eld
7639 \begin_inset Quotes erd
7644 \begin_inset Quotes eld
7647 New\SpecialChar ldots
7649 \begin_inset Quotes erd
7652 button and, in the window that opens, enter
7653 \begin_inset Quotes eld
7658 \begin_inset Quotes erd
7661 (or any other name you like) in the
7662 \begin_inset Quotes eld
7666 \begin_inset Quotes erd
7670 Now click on the button labeled
7671 \begin_inset Quotes eld
7676 \begin_inset Quotes erd
7679 to open a file dialog and navigate to the directory containing the
7680 \begin_inset Flex Code
7683 \begin_layout Plain Layout
7689 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7692 \begin_inset Flex Code
7695 \begin_layout Plain Layout
7701 and then specify the program arguments as
7702 \begin_inset Flex Code
7705 \begin_layout Plain Layout
7712 In this way, you will be using the
7716 for communicating with \SpecialChar LyX
7718 If, for whatever reason, you want to use the
7723 \begin_inset Flex Code
7726 \begin_layout Plain Layout
7732 option and be sure to specify the \SpecialChar LyX
7733 Server pipe path in the \SpecialChar LyX
7737 \begin_layout Standard
7738 In yap, reverse search is triggered by double-click.
7741 \begin_layout Subsubsection*
7745 \begin_layout Standard
7746 In order to use SumatraPDF for inverse search, enter
7747 \begin_inset Flex Code
7750 \begin_layout Plain Layout
7751 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7756 in the viewer setting in
7757 \begin_inset Flex Noun
7760 \begin_layout Plain Layout
7761 Preferences\SpecialChar menuseparator
7762 File Handling\SpecialChar menuseparator
7763 File formats\SpecialChar menuseparator
7770 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7772 \begin_inset Flex Code
7775 \begin_layout Plain Layout
7781 enables communication via the
7787 \begin_inset Flex Code
7790 \begin_layout Plain Layout
7796 option if you want to use the
7800 , and be sure to specify the \SpecialChar LyX
7801 Server pipe path in the \SpecialChar LyX
7805 \begin_layout Standard
7806 Reverse search is triggered by double-click.
7809 \begin_layout Section
7813 \begin_layout Standard
7814 Forward search is, as the name implies, in a sense the
7815 \begin_inset Quotes eld
7819 \begin_inset Quotes erd
7823 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7825 If forward search is set up (as described in what follows), you can put
7826 the cursor anywhere in your \SpecialChar LyX
7828 \begin_inset Flex Noun
7831 \begin_layout Plain Layout
7832 Navigate\SpecialChar menuseparator
7839 \begin_inset Flex Noun
7842 \begin_layout Plain Layout
7848 in the context menu via right mouse click), and then the viewer will jump
7849 to that position as well.
7850 This implies, of course, that your viewer supports this function.
7853 \begin_layout Standard
7854 To make forward search possible, you first need to provide the generated
7855 output PDF/DVI file with additional information about the \SpecialChar TeX
7857 This can be done via the methods described in the section
7858 \begin_inset CommandInset ref
7860 reference "subsec:rev-search"
7867 \begin_layout Standard
7868 Additionally, you need to configure \SpecialChar LyX
7869 for using your viewers in
7870 \begin_inset Flex Noun
7873 \begin_layout Plain Layout
7874 Tools\SpecialChar menuseparator
7875 Preferences\SpecialChar menuseparator
7876 Output\SpecialChar menuseparator
7883 We provide a range of tested configurations for some viewers, which you
7884 can select from the drop down list.
7885 If none of these configurations suits you, you have to find out and enter
7886 a suitable configuration yourself.
7887 The definition syntax uses the following placeholders:
7890 \begin_layout Itemize
7892 \begin_inset Flex Code
7895 \begin_layout Plain Layout
7904 \begin_layout Itemize
7906 \begin_inset Flex Code
7909 \begin_layout Plain Layout
7915 : name of the (temporary) exported .tex file (without path)
7918 \begin_layout Itemize
7920 \begin_inset Flex Code
7923 \begin_layout Plain Layout
7929 : name of the (temporary) exported .tex file (including path)
7932 \begin_layout Itemize
7934 \begin_inset Flex Code
7937 \begin_layout Plain Layout
7943 : name of the exported output file (either dvi or pdf, depending on which
7944 one exists in the temporary directory)
7947 \begin_layout Standard
7948 Note that only some of the viewers provide full
7949 \change_inserted -712698321 1500279079
7952 forward search functionality
7953 \change_inserted -712698321 1500278927
7956 , among them yap, xdvi, okular
7960 \begin_layout Plain Layout
7961 You might want to set
7962 \begin_inset Flex Code
7965 \begin_layout Plain Layout
7972 \begin_inset Flex Noun
7975 \begin_layout Plain Layout
7976 Tools\SpecialChar menuseparator
7977 Preferences\SpecialChar menuseparator
7978 File Handling\SpecialChar menuseparator
7980 \begin_inset space ~
7994 \change_inserted -712698321 1500278795
8001 \begin_layout Plain Layout
8002 SumatraPDF can also use DDE commands through the external program CMCDDE
8004 \begin_inset CommandInset href
8006 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8018 \change_inserted -712698321 1500279294
8019 Others, such as evince
8023 \begin_layout Plain Layout
8024 \paragraph_spacing single
8026 \change_inserted -712698321 1500278873
8027 Forward search with evince can be achieved by means of third party helper
8030 \begin_inset CommandInset href
8032 target "http://wiki.lyx.org/LyX/SyncTeX"
8044 , require some extra tools in order to use forward search.
8047 While many of the widespread PDF viewers (most notably Adobe Reader) do
8048 not support forward search at all, some other viewers – e.
8049 \begin_inset space \thinspace{}
8054 \change_deleted -712698321 1500278769
8057 xpdf – allow at least to reload the document and jump to a specific page
8058 of the file, so you can at least navigate
8059 \begin_inset Quotes eld
8063 \begin_inset Quotes erd
8067 This latter functionality is provided by an external call of synctex (see
8068 the predefined example configurations).
8072 \begin_layout Standard
8073 Forward search works both with DVI and PDF output.
8075 simply checks which preview format you have used before (i.
8076 \begin_inset space \thinspace{}
8079 e., which format is already there in the temporary directory) and chooses
8080 the appropriate configuration for the respective format.
8083 \begin_layout Chapter
8084 Special Document Classes
8087 \begin_layout Section
8091 \begin_layout Standard
8097 \begin_layout Subsection
8101 \begin_layout Standard
8102 This section describes how \SpecialChar LyX
8103 can be used to write articles for submission
8104 to the scientific journal
8106 Astronomy and Astrophysics
8109 \begin_inset Flex URL
8112 \begin_layout Plain Layout
8114 http://www.edpsciences.fr/aa/
8119 ) using Version 5.01 of the document class
8124 This package can be downloaded from the ftp site
8127 \begin_layout Standard
8128 \begin_inset VSpace medskip
8134 \begin_layout Standard
8136 \begin_inset Flex URL
8139 \begin_layout Plain Layout
8141 ftp://ftp.edpsciences.org/pub/aa/readme.html
8149 \begin_layout Standard
8150 \begin_inset VSpace medskip
8156 \begin_layout Standard
8157 A manual comes together with that package, and this text is not meant to
8158 replace the original manual but is merely a short guide in how to realize
8159 the correct form of your paper.
8163 \begin_layout Standard
8164 Please note that the publisher of the journal was changed from Springer
8165 to EDP Sciences starting January 1, 2001.
8166 That change involved also some slight changes to the style files, namely
8167 the removal of the thesaurus command.
8168 The \SpecialChar LyX
8169 class aa supports the newest version of these style files, V 5.01.
8170 If you have an older version installed, please upgrade.
8171 For compatibility, the old (version 4) layout has been kept as
8176 Please refer to the comments in
8179 Dir/layouts/aapaper.layout
8184 \begin_layout Subsection
8188 \begin_layout Standard
8189 It is recommended you start from the example template distributed with \SpecialChar LyX
8191 If you are not using a template, note the following settings:
8194 \begin_layout Itemize
8201 Document\SpecialChar menuseparator
8204 dialog (OK, that one was obvious).
8207 \begin_layout Itemize
8208 Don't change the option
8211 \begin_inset space ~
8221 The whole layout is done by the macros, you shouldn't change anything.
8224 \begin_layout Subsection
8228 \begin_layout Standard
8229 First thing to enter is the header information.
8230 It consists of seven entries, of which some are optional.
8234 \begin_layout Itemize
8242 \begin_layout Itemize
8250 \begin_layout Itemize
8258 \begin_layout Itemize
8266 \begin_layout Itemize
8271 : [optional] if more than one author: whom to contact for offprint requests.
8274 \begin_layout Itemize
8279 : [optional] mail address for contacts.
8282 \begin_layout Itemize
8290 Received: <date>; Accepted <date>
8293 \begin_layout Standard
8294 There is no need to issue the
8300 command, this is done automatically by \SpecialChar LyX
8301 when the header is finished.
8302 Although the order of the single header entries doesn't matter it is advised
8303 to keep the above sequence, just to get the best optics and meets the layout
8304 of the real document.
8307 \begin_layout Standard
8308 If you want to place footnotes in the header block, e.
8309 \begin_inset space \thinspace{}
8313 \begin_inset space \space{}
8316 to state your present address, just use the standard footnote via the menu
8319 Insert\SpecialChar menuseparator
8324 will automagically use the term
8333 \begin_layout Standard
8334 In addition to these topics, the macros use three additional \SpecialChar LaTeX
8336 have no counterpart in \SpecialChar LyX
8340 \begin_layout Itemize
8347 to separate different names for more than one author and institute, respectivel
8351 \begin_layout Itemize
8358 to mark corresponding author/institute pairs.
8359 The institutes are numbered sequentially as they appear in the
8363 field, so you have to put a marker to each author.
8366 \begin_layout Itemize
8373 to supply an email address for fast contact.
8376 \begin_layout Standard
8377 In all cases, the appropriate command has to be entered in \SpecialChar LyX
8385 \begin_layout Subsection
8389 \begin_layout Standard
8390 The abstract should immediately follow the header block.
8391 With version 5 the abstract environment was changed to a command, and there
8392 is now a resctriction to only one paragraph.
8393 In addition, it should contain an entry with the keywords.
8394 This is not yet implemented for \SpecialChar LyX
8395 , therefore you have to enter the \SpecialChar LaTeX
8403 by hand and mark it as \SpecialChar LaTeX
8405 Refer to the example paper.
8408 \begin_layout Subsection
8409 Supported environments
8412 \begin_layout Standard
8413 The A&A paper layout supports the following environments for structuring
8417 \begin_layout Itemize
8423 \begin_layout Itemize
8429 \begin_layout Itemize
8435 \begin_layout Itemize
8441 \begin_layout Itemize
8447 \begin_layout Itemize
8453 \begin_layout Itemize
8459 \begin_layout Itemize
8465 \begin_layout Itemize
8471 \begin_layout Itemize
8477 \begin_layout Itemize
8483 \begin_layout Itemize
8490 \begin_layout Subsection
8491 Commands not supported by \SpecialChar LyX
8495 \begin_layout Standard
8496 Some commands are not yet supported by the
8500 layout for \SpecialChar LyX
8502 Some have already been mentioned.
8503 For the sake of completeness, they are listed all together here:
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 Itemize
8570 \begin_layout Standard
8571 If you want to use any of these commands, you have to enter them yourself.
8574 Do not forget to mark them as \SpecialChar LaTeX
8578 \begin_layout Subsection
8579 Figure and Table Floats
8582 \begin_layout Standard
8584 provides support for the necessary float environments
8586 figure, figure*, table
8592 , therefore we won't tell much about it here.
8596 \begin_inset space ~
8602 Just remember that tables should be left-aligned.
8603 For that, select the table and change the alignment in
8605 Edit\SpecialChar menuseparator
8607 \begin_inset space ~
8613 \begin_layout Standard
8614 There is only one special thing: the figures with caption besides the figure.
8615 To create such a figure, you have to do the following:
8618 \begin_layout Enumerate
8619 Create a wide figure float:
8621 Insert\SpecialChar menuseparator
8622 Float\SpecialChar menuseparator
8625 , then right click in the figure and select
8628 \begin_inset space ~
8636 \begin_layout Enumerate
8637 Enter your caption text.
8640 \begin_layout Enumerate
8645 to move the cursor above the caption.
8648 \begin_layout Enumerate
8652 \begin_layout Enumerate
8653 Position the cursor behind the figure and insert a horizontal fill:
8655 Insert\SpecialChar menuseparator
8657 \begin_inset space ~
8660 Character\SpecialChar menuseparator
8662 \begin_inset space ~
8670 \begin_layout Enumerate
8671 Switch to \SpecialChar LaTeX
8675 \begin_inset space ~
8683 \begin_layout Enumerate
8693 Do not close the brace!
8696 \begin_layout Enumerate
8697 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8702 \begin_inset space ~
8714 \begin_layout Standard
8715 Also, refer to the figures in the example paper.
8718 \begin_layout Subsection
8722 \begin_layout Standard
8723 For submission, the paper has to be formated in a special double-spacing
8725 For this purpose, you have to give the option
8729 to the documentclass.
8730 This must be done using the extra class options field in the
8732 Document\SpecialChar menuseparator
8736 Just enter the string
8743 \begin_layout Subsection
8747 \begin_layout Standard
8752 directory contains an example paper written with \SpecialChar LyX
8754 It is the example paper from the original macro package, translated to
8757 Use it for inspiration, and compare the original \SpecialChar LaTeX
8758 code with \SpecialChar LyX
8762 \begin_layout Section
8767 \begin_layout Standard
8773 \begin_layout Subsection
8777 \begin_layout Standard
8779 is a set of macros produced by the American Astronomical Society to
8780 facilitate electronic manuscript submission to the three journals they
8781 publish: the Astrophysical Journal (including the Letters and Supplement),
8782 the Astronomical Journal, and the Publications of the Astronomical Society
8785 has proven to be an excellent tool for generating these documents, especially
8786 given its equation, citation, and figure handling capabilities.
8788 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8789 is the version described here, or higher.
8790 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8791 2.09 and are fundamentally
8792 incompatible with \SpecialChar LyX
8794 The AAS\SpecialChar TeX
8795 package may be downloaded from the AAS\SpecialChar TeX
8799 \begin_layout Standard
8800 \begin_inset VSpace medskip
8806 \begin_layout Standard
8808 \begin_inset Flex URL
8811 \begin_layout Plain Layout
8813 https://aas.org/aastex/aastex-downloads
8821 \begin_layout Standard
8822 \begin_inset VSpace medskip
8828 \begin_layout Standard
8829 A complete user guide is contained in that package and you should familiarize
8830 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8833 will not reduce the need to figure out all the AAS\SpecialChar TeX
8834 commands, it will only
8835 reduce the drudgery of typing everything in.
8836 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8838 completely to the requirements of the journal to which you are submitting
8842 \begin_layout Subsection
8843 Starting a New Paper
8846 \begin_layout Standard
8847 I strongly suggest that you start with the AAS\SpecialChar TeX
8851 File\SpecialChar menuseparator
8858 , enter the new file name, then choose the
8863 This will show the most common fields found in a manuscript.
8864 Simply overwrite the existing text (including the brackets,
8868 ) with the correct information.
8869 Many of the AAS\SpecialChar TeX
8870 commands and environments can be implemented directly in
8872 , but some cannot: most noticeably
8884 , which should stick out like a sore thumb if you actually just opened the
8886 For commands such as these, the \SpecialChar LaTeX
8887 code must be entered directly and marked
8889 Such commands are referred to as \SpecialChar TeX
8890 code, or Evil Red Text.
8891 I tried to minimize the amount of \SpecialChar TeX
8892 code needed in an AAS\SpecialChar TeX
8894 there is still a bit more required than any of us would like.
8897 \begin_layout Subsection
8898 Finishing Your Paper
8901 \begin_layout Standard
8902 When the paper is finished to your satisfaction and previews/prints correctly,
8904 \begin_inset Quotes eld
8908 \begin_inset Quotes erd
8911 actions which need to be done before you submit it to the journals.
8915 \begin_layout Enumerate
8916 Export your paper as a \SpecialChar LaTeX
8919 File\SpecialChar menuseparator
8920 Export\SpecialChar menuseparator
8928 \begin_layout Enumerate
8933 file with your favorite text editor
8937 \begin_layout Enumerate
8938 remove the comment lines before the
8947 \begin_layout Enumerate
8952 usepackage...{fontenc}
8954 line if it appears (usually just after
8969 \begin_layout Enumerate
8970 remove everything between (and including) the
8982 commands, except for any commands you specifically put into the \SpecialChar LaTeX
8984 (which should appear immediately after the
8985 \begin_inset Quotes eld
8988 User specified \SpecialChar LaTeX
8990 \begin_inset Quotes erd
9001 \begin_layout Enumerate
9002 Run the resulting file through \SpecialChar LaTeX
9003 to make sure it still processes correctly.
9006 \begin_layout Enumerate
9007 Reread the journal requirements to make sure your filenames and formats
9011 \begin_layout Enumerate
9015 \begin_layout Subsection
9016 Comments On Specific Commands
9019 \begin_layout Standard
9020 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9027 ) gives a good description of each.
9028 Thus it's probably easiest for me to go down the list as found in the guide
9029 and offer comments where necessary.
9030 So let's begin \SpecialChar ldots
9034 \begin_layout Subsubsection
9035 Things that work as expected
9038 \begin_layout Standard
9039 Because they work as you might expect, I simply list them and the section
9140 begin{thebibliography}
9148 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9149 graphicx figure commands (2.14.1),
9173 (2.15.4, amongst other places),
9200 \begin_layout Standard
9201 The following style options also work correctly:
9222 Simply put them in the
9228 Layout\SpecialChar menuseparator
9234 \begin_layout Subsubsection
9235 Things that work, but require more comment
9238 \begin_layout Standard
9239 The following items work, but require a little more discussion:
9242 \begin_layout Itemize
9243 These items are reserved for use by the journal editors, but you can put
9244 them into the \SpecialChar LaTeX
9245 preamble if you feel compelled to do so:
9278 \begin_layout Itemize
9279 These items may be placed in the \SpecialChar LaTeX
9280 preamble, and are included as blanks in
9302 \begin_layout Itemize
9309 (2.3) – can only be used
9310 \begin_inset Quotes eld
9314 \begin_inset Quotes erd
9317 , not in the middle of a paragraph.
9318 Use \SpecialChar TeX
9319 code if you need to embed it.
9322 \begin_layout Itemize
9329 (2.3) – will have extra {} after it.
9330 This should not cause an error.
9333 \begin_layout Itemize
9340 (2.6) – can only be used
9341 \begin_inset Quotes eld
9345 \begin_inset Quotes erd
9348 , not in the middle of a paragraph.
9349 Use \SpecialChar TeX
9350 code if you need to embed it.
9353 \begin_layout Itemize
9360 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9364 \begin_layout Itemize
9378 \begin_layout Itemize
9385 (2.9) – will have extra {} after it.
9386 This should not cause an error.
9389 \begin_layout Itemize
9396 (2.11) – will have extra {} after it.
9397 This should not cause an error.
9400 \begin_layout Itemize
9407 (2.14.2) – you can insert an optional filename argument by placing the cursor
9408 at the beginning of the text and selecting
9410 Insert\SpecialChar menuseparator
9415 \begin_inset Quotes eld
9419 \begin_inset Quotes erd
9422 inserts an optional argument of the type needed by
9429 Hopefully it will be renamed someday.
9432 \begin_layout Itemize
9445 for the catalog ID optional parameter
9448 \begin_layout Itemize
9461 for the catalog ID optional parameter
9464 \begin_layout Subsubsection
9465 Things not implemented, use \SpecialChar TeX
9469 \begin_layout Standard
9492 setcounter{equation}
9494 (2.12), Journal name abbreviations (2.13.4),
9530 (2.15.4, insert it as the first element in the lefthand cell after where
9532 Don't use any of \SpecialChar LyX
9533 's rules in the table),
9545 (2.15.5), much of Misc (2.17, except
9596 \begin_layout Subsubsection
9597 Things that cannot be implemented
9600 \begin_layout Standard
9602 at least in any meaningful sort of way, so I suggest ignoring them.
9603 They are the references environment (2.13.3), and the deluxetable environment
9605 If you really, really need to use deluxetable, I suggest editing it in
9606 a separate file with a text editor, then using
9608 Insert\SpecialChar menuseparator
9610 \begin_inset space ~
9615 to include it in your \SpecialChar LyX
9621 file to see an example of this.
9624 \begin_layout Subsection
9625 FAQs, Tips, Tricks, and Other Ruminations
9628 \begin_layout Subsubsection
9629 Getting \SpecialChar LyX
9630 and AAS\SpecialChar TeX
9634 \begin_layout Standard
9635 It can be a bit tricky to get \SpecialChar LyX
9636 to recognize a new layout and document class.
9637 When all else fails, do this:
9640 \begin_layout Enumerate
9641 Make certain that \SpecialChar LaTeX
9642 can find AAS\SpecialChar TeX
9644 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9646 directory completely unrelated to \SpecialChar LaTeX
9647 or AAS\SpecialChar TeX
9648 and run \SpecialChar LaTeX
9656 \begin_layout Enumerate
9661 appears in \SpecialChar LyX
9669 \begin_layout Enumerate
9672 Tools\SpecialChar menuseparator
9676 , then restart \SpecialChar LyX
9680 \begin_layout Enumerate
9681 Open a regular new file, not from a template.
9682 Does AAS\SpecialChar TeX
9683 appear in the class list in
9685 Document\SpecialChar menuseparator
9691 \begin_layout Standard
9692 If you get a warning from an existing AAS\SpecialChar TeX
9693 document about not being able
9694 to find the AAS\SpecialChar TeX
9695 layout or a message about
9696 \begin_inset Quotes eld
9699 You should not mix title layouts with normal ones
9700 \begin_inset Quotes erd
9703 , things haven't been installed correctly.
9706 \begin_layout Subsubsection
9708 error processing a table
9711 \begin_layout Standard
9713 , by default, attempts to center the table caption/title.
9714 This seems to produce a bad interaction in AAS\SpecialChar TeX
9715 so you should click somewhere
9716 in the caption/title, then select
9718 Edit\SpecialChar menuseparator
9720 \begin_inset space ~
9734 This took care of it for me.
9737 \begin_layout Subsubsection
9741 \begin_layout Standard
9742 A couple of things: 1) I have noticed some funny spacing in the reference
9743 entries in the text.
9744 When you enter the bibliography item data, make sure their is
9748 space between the last author and the parenthesis setting off the year;
9752 \begin_inset space \thinspace{}
9756 \begin_inset space \space{}
9770 2) Entering the references at all is not obvious.
9771 The easiest thing is to start typing your first reference at the end of
9772 the document, then mark it as type
9777 That will put a small gray box in front of what you just typed.
9778 Click on the box to fill in the rest of the information.
9779 For new references, go to the end of an existing reference and press return.
9780 That will create a new line with its own box, etc.
9783 \begin_layout Subsubsection
9787 \begin_layout Standard
9788 Even though AAS\SpecialChar TeX
9789 provides its own figure commands (
9795 , for example), I much prefer \SpecialChar LaTeX
9796 's standard figure commands (with the default
9805 \begin_inset space ~
9808 commands as \SpecialChar TeX
9809 code into a Figure Float box if you desire, but I never have
9810 much luck getting the layout right.
9811 With the standard graphics, \SpecialChar LyX
9816 usepackage{graphicx}
9818 command into the \SpecialChar LaTeX
9819 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9821 interspersing the figures in the text.
9822 I believe ApJ accepts figures exactly this way now; AJ might still use
9824 \begin_inset Quotes eld
9827 stack everything at the end
9828 \begin_inset Quotes erd
9834 \begin_layout Subsubsection
9835 Things I could have done, but didn't
9838 \begin_layout Standard
9840 \begin_inset Quotes eld
9844 \begin_inset Quotes erd
9847 things I could have implemented, but chose not to.
9848 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9850 even though it is double-spaced in the paper manuscript.
9851 Also, I chose not to make separate layouts for the preprint and preprint2
9853 Since I assume you will spend most of your time in the plain manuscript
9854 mode anyway, I decided not to chew up more disk space with this.
9858 \begin_layout Subsection
9862 \begin_layout Standard
9863 Your mileage may vary.
9864 I've now had papers published by both ApJ and AJ that have had 98% of the
9865 effort done in \SpecialChar LyX
9866 ; the last 2% was the \SpecialChar LaTeX
9867 post-processing and a few cleanups.
9868 I have had no trouble with the submission process, and I'm sure the journals
9869 were never aware that there might be a difference.
9870 So, go forth and publish!
9873 \begin_layout Section
9874 AMS \SpecialChar LaTeX
9878 \begin_layout Standard
9888 \begin_layout Standard
9889 \begin_inset VSpace bigskip
9895 \begin_layout Standard
9897 The AMS \SpecialChar LaTeX
9898 layouts are set up to conform to suggested styles for mathematical
9899 papers to be submitted to American Mathematical Society publications.
9900 The layouts are not tailored to a specific journal, but easily can be.
9901 You should refer to the AMS documentation for specific instructions for
9902 each journal (usually it will entail only changing a single line in the
9905 That documentation is available on the Web at
9906 \begin_inset Flex URL
9909 \begin_layout Plain Layout
9917 \begin_inset Flex URL
9920 \begin_layout Plain Layout
9922 ftp://ftp.ams.org/pub/tex/amslatex/
9928 These layouts are appropriate, and useful, for any mathematical writing.
9932 \begin_layout Standard
9933 There are two basic AMS \SpecialChar LaTeX
9937 \begin_layout Itemize
9938 amsart: The standard AMS article format.
9941 \begin_layout Itemize
9942 amsbook: the standard AMS book (really, monograph) format.
9946 \begin_layout Standard
9947 The layouts themselves contain only the minimum necessary to use the AMS
9949 They do not, in particular, contain any of the `theorem' environments used
9950 for setting theorems, lemmas, and the like.
9951 These are contained, instead, in the
9952 \begin_inset Flex Code
9955 \begin_layout Plain Layout
9961 module, which is loaded by default when you select one of the AMS classes.
9962 (It can also be used with other classes and can be removed, if you would
9963 rather use something else.) Less commonly used environments are in the
9964 \begin_inset Flex Code
9967 \begin_layout Plain Layout
9968 Theorems (AMS-Extended)
9973 module, which must be loaded manually.
9976 \begin_layout Standard
9977 By default, theorems and the like are numbered consecutively throughout
9978 the document, but this may be modified by loading the module
9979 \begin_inset Flex Code
9982 \begin_layout Plain Layout
9983 Theorems (Order by Section)
9988 or, if you are using
9989 \begin_inset Flex Code
9992 \begin_layout Plain Layout
9999 \begin_inset Flex Code
10002 \begin_layout Plain Layout
10003 Theorems (Order by Chapter)
10009 These will number the results as
10010 \begin_inset Formula $n.m$
10013 , where the first number refers to the section (or chapter) and the second
10014 refers to the total number of results so far in that section (or chapter).
10015 Many environments are also available unnumbered.
10016 These are indicated by an asterisk at the end.
10017 If you happen to want
10021 unnumbered results, the module
10022 \begin_inset Flex Code
10025 \begin_layout Plain Layout
10031 provides that option.
10034 \begin_layout Standard
10035 Note that these modules do not
10039 to be used with the AMS classes.
10040 It is perfectly possible to use the
10041 \begin_inset Flex Code
10044 \begin_layout Plain Layout
10050 module, and the others mentioned, with other classes, such as
10051 \begin_inset Flex Code
10054 \begin_layout Plain Layout
10061 \begin_inset Flex Code
10064 \begin_layout Plain Layout
10071 \begin_inset Flex Code
10074 \begin_layout Plain Layout
10083 \begin_layout Subsection
10084 What these layouts provide
10087 \begin_layout Standard
10088 There is a long list of included environments provided by these layouts.
10089 In AMS-\SpecialChar LaTeX
10090 , there is, in fact, an opportunity to define an unlimited variety
10091 of `theorem' environments.
10092 However, the AMS recommends the environments that are available in \SpecialChar LyX
10097 \begin_layout Standard
10098 The following environments—as well as the standard environments, such as
10100 \begin_inset Flex Noun
10103 \begin_layout Plain Layout
10110 \begin_inset Flex Noun
10113 \begin_layout Plain Layout
10120 \begin_inset Flex Noun
10123 \begin_layout Plain Layout
10130 \begin_inset Flex Noun
10133 \begin_layout Plain Layout
10140 \begin_inset Flex Noun
10143 \begin_layout Plain Layout
10150 \begin_inset Flex Code
10153 \begin_layout Plain Layout
10160 \begin_inset Flex Code
10163 \begin_layout Plain Layout
10172 \begin_layout Description
10173 Address This should be the author's permanent address.
10176 \begin_layout Description
10178 \begin_inset space ~
10181 Address This should be the author's temporary address at the time of submission,
10182 if different from the Address.
10185 \begin_layout Description
10186 Email Author's e-mail address
10189 \begin_layout Description
10190 URL Author's Web address, if desired.
10193 \begin_layout Description
10194 Keywords Key words or phrases used to identify specific topics discussed
10198 \begin_layout Description
10199 Subjectclass These refer to the AMS Subject Classifications, published and
10202 Mathematical Reviews
10205 These are also available online at the AMS cites listed above.
10208 \begin_layout Description
10212 \begin_layout Description
10216 \begin_layout Description
10220 \begin_layout Standard
10221 The following environments are provided by both the
10222 \begin_inset Flex Code
10225 \begin_layout Plain Layout
10232 \begin_inset Flex Code
10235 \begin_layout Plain Layout
10241 modules, in the latter case in both starred (unnumbered) and unstarred
10242 (numbered) versions.
10243 These same environments are provided only in the starred versions by the
10245 \begin_inset Flex Code
10248 \begin_layout Plain Layout
10257 \begin_layout Theorem
10258 This is typically used for the statements of major results.
10262 \begin_layout Corollary*
10263 This is used for statements which follow fairly directly from previous statement
10265 Again, these can be major results.
10269 \begin_layout Lemma
10270 These are smaller results needed to prove other statements.
10273 \begin_layout Proposition
10274 These are less major results which (hopefully) add to the general theory
10278 \begin_layout Conjecture
10279 These are statements provided without justification, which the author does
10280 not know how to prove, but which seem to be true (to the author, at least).
10283 \begin_layout Definition*
10284 Guess what this is for.
10285 The font is different for this environment than for the previous ones.
10289 \begin_layout Example*
10290 Used for examples illustrating proven results.
10293 \begin_layout Problem
10294 It's not really known what this is for.
10295 You should figure it out.
10298 \begin_layout Exercise*
10299 Write a description for this one.
10302 \begin_layout Remark
10303 This environment is also a type of theorem, usually a lesser sort of observation.
10306 \begin_layout Claim*
10307 Often used in the course of giving a proof of a larger result.
10311 Generally, these are used to break up long arguments, using specific instances
10317 The numbering scheme for cases is on its own, not together with other numbered
10322 \begin_layout Proof
10323 At the end of this environment, a QED symbol (usually a square, but it can
10324 vary with different styles) is placed.
10325 If you want to have other environments within this one—for example, Case
10326 environments—and have the QED symbol appear only after them, then the other
10327 environments need to be nested within the proof environment.
10330 Nesting Environments
10336 for information on nesting.
10339 \begin_layout Standard
10340 And these environments are provided by
10341 \begin_inset Flex Code
10344 \begin_layout Plain Layout
10345 Theorems (AMS-Extended)
10353 \begin_layout Criterion*
10354 A required condition.
10357 \begin_layout Algorithm*
10358 A general procedure to be used.
10361 \begin_layout Axiom*
10362 This is a property or statement taken as true within the system being discussed.
10365 \begin_layout Condition*
10366 Sometimes used to state a condition assumed within the present context of
10370 \begin_layout Note*
10371 Similar to a Remark.
10374 \begin_layout Notation*
10375 Used for the explanation of, yes, notation.
10378 \begin_layout Summary
10379 Do we really need to tell you?
10382 \begin_layout Acknowledgement*
10386 \begin_layout Conclusion*
10387 Sometimes used at the end of a long train of argument.
10391 Used in a way similar to Proposition, though perhaps lower on the scale.
10394 \begin_layout Standard
10395 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10398 They need to be available on your system in order to use these environments.
10401 \begin_layout Section
10409 \begin_layout Standard
10415 \begin_layout Subsection
10419 \begin_layout Standard
10420 These are the layout files for some of the journals of the American Geophysical
10422 It is assumed that you have both the AGU's own class files and AGUplus
10423 installed (everything to be found at
10424 \begin_inset Flex URL
10427 \begin_layout Plain Layout
10429 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10437 \begin_layout Subsection
10441 \begin_layout Standard
10451 They are still called this in the \SpecialChar LyX
10452 GUI, though their \SpecialChar LaTeX
10465 \begin_layout Standard
10466 Newly defined styles are
10503 These are mostly manuscript attributes and defined in the AGU class documentati
10507 \begin_layout Standard
10508 I suspect this is still badly incomplete.
10511 \begin_layout Subsection
10515 \begin_layout Standard
10532 \begin_layout Subsection
10536 \begin_layout Itemize
10539 Journal of Geophysical Research
10548 \begin_layout Standard
10549 Add your own, it isn't so hard! Look at the
10560 \begin_layout Subsection
10561 Bugs and things to remember
10564 \begin_layout Standard
10565 In order to use the new layouts, you must remember to do the following for
10569 \begin_layout Enumerate
10575 This can be done in the
10577 Layout\SpecialChar menuseparator
10582 Document\SpecialChar menuseparator
10586 (AGU articles are always in English, right? So
10590 choose a language.)
10593 \begin_layout Enumerate
10598 into the document's
10603 (Yes, this is a bug.)
10606 \begin_layout Enumerate
10607 Make sure you use the
10611 bibliography style, by entering
10615 into the second field of the Bib\SpecialChar TeX
10617 None of the standard styles will do.
10620 \begin_layout Section
10624 \begin_layout Standard
10630 \begin_layout Subsection
10634 \begin_layout Standard
10635 Broadway is for writing plays.
10636 The format is more decorative than Hollywood, and much less standardized.
10637 This format should be suitable for workshops.
10640 \begin_layout Subsection
10644 \begin_layout Standard
10645 The same as in Hollywood.
10648 \begin_layout Subsection
10652 \begin_layout Standard
10657 names as labels then cross-reference the label to insert the name.
10658 The cross-reference dialog will show the current cast of characters.
10661 \begin_layout Subsection
10662 Paper size and Margins
10665 \begin_layout Standard
10666 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10669 \begin_layout Subsection
10673 \begin_layout Standard
10674 The following environments are available.
10675 You can use broadway.bind to get the bind keys shown at the right.
10678 \begin_layout Itemize
10682 \begin_inset Newline newline
10687 You should not have to use this, but it is here for anything that does not
10691 \begin_layout Itemize
10695 \begin_inset space \hfill{}
10699 \begin_inset Newline newline
10704 Used to describe stage setting and the action.
10705 First use of speaker names in all CAPs.
10708 \begin_layout Itemize
10712 \begin_inset space \hfill{}
10716 \begin_inset Newline newline
10721 Automatically numbered.
10722 On screen it will be arabic, but will print as Roman.
10725 \begin_layout Itemize
10729 \begin_inset space \hfill{}
10733 \begin_inset Newline newline
10743 It is just centered text.
10746 \begin_layout Itemize
10750 \begin_inset space \hfill{}
10754 \begin_inset Newline newline
10759 Not automatically numbered.
10760 You supply the number.
10761 This is because I couldn't figure out how.
10764 \begin_layout Itemize
10768 \begin_inset space \hfill{}
10772 \begin_inset Newline newline
10777 A special case of Narrative to describe the setting and action as the curtain
10781 \begin_layout Itemize
10785 \begin_inset space \hfill{}
10789 \begin_inset Newline newline
10794 The speaker's (actor's) title, centered in all CAPS.
10797 \begin_layout Itemize
10801 \begin_inset space \hfill{}
10805 \begin_inset Newline newline
10810 Instructions to the speaker.
10811 The parentheses are automatically inserted.
10812 The ( will appear on screen, but both will be in the printed play.
10813 This environment is only used within
10820 \begin_layout Itemize
10824 \begin_inset space \hfill{}
10828 \begin_inset Newline newline
10833 What the Speaker says.
10836 \begin_layout Itemize
10840 \begin_inset space \hfill{}
10844 \begin_inset Newline newline
10849 The curtain comes down.
10852 \begin_layout Itemize
10856 \begin_inset space \hfill{}
10862 \begin_layout Itemize
10866 \begin_inset space \hfill{}
10872 \begin_layout Itemize
10876 \begin_inset space \hfill{}
10882 \begin_layout Standard
10886 \begin_layout Section
10890 \begin_layout Standard
10895 can be used to type letters according to German conventions.
10896 A template file is included in
10898 .../lyx/share/templates
10900 for you to use as a starting point.
10903 \begin_layout Section
10911 \begin_layout Standard
10917 \begin_layout Subsection
10921 \begin_layout Standard
10922 This is the layout file for the European Geophysical Society journals.
10927 can be downloaded from the web site of the EGS under
10928 \begin_inset Flex URL
10931 \begin_layout Plain Layout
10941 \begin_layout Subsection
10945 \begin_layout Standard
10948 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10956 The current layout file is unfortunately very unmodular and would benefit
10957 from using the various
10964 \begin_layout Section
10968 \begin_layout Standard
10969 See the \SpecialChar LyX
10975 It contains all infos you need.
10978 \begin_layout Section
10981 Foil\SpecialChar TeX
10985 \begin_inset CommandInset label
10994 \begin_layout Standard
11000 \begin_layout Subsection
11004 \begin_layout Standard
11005 This section describes how to use \SpecialChar LyX
11006 to make slides for overhead projectors.
11007 There are two document classes that can do this: the default slides class
11010 Foil\SpecialChar TeX
11014 This section documents the latter.
11017 \begin_layout Standard
11018 I'm going to say this again, nice and clear, so that there's no misunderstanding
11022 \begin_layout Standard
11023 \begin_inset VSpace bigskip
11029 \begin_layout Standard
11033 This section documents the class
11034 \begin_inset Quotes eld
11042 \begin_inset Quotes erd
11050 \begin_layout Standard
11051 \begin_inset VSpace bigskip
11057 \begin_layout Standard
11058 If you're looking for the documentation for
11059 \begin_inset Quotes eld
11067 \begin_inset Quotes erd
11070 , check out section
11071 \begin_inset space ~
11075 \begin_inset CommandInset ref
11077 reference "sec:slitex"
11082 If your machine doesn't have the
11090 installed, you'll probably have to use the default
11094 class, which isn't quite as good as
11099 \begin_layout Standard
11104 class is designed for use with version
11105 \begin_inset space ~
11113 class file which is now an integral part of \SpecialChar LaTeX2e
11117 \begin_layout Subsection
11121 \begin_layout Standard
11122 Obviously, to use this document class, you need to select
11133 \begin_inset space ~
11139 There are some settings in the
11142 \begin_inset space ~
11147 dialog that you should know about that are specific to this class:
11150 \begin_layout Itemize
11151 Don't change the options
11162 \begin_inset space ~
11168 They're ignored by the
11175 \begin_layout Itemize
11176 The default font size is 20
11177 \begin_inset space \thinspace{}
11180 pt with the other options being 17
11181 \begin_inset space \thinspace{}
11185 \begin_inset space \thinspace{}
11189 \begin_inset space \thinspace{}
11195 \begin_layout Itemize
11196 The default font is
11204 but all math equations are still typeset in the usual roman font.
11207 \begin_layout Itemize
11210 Foil\SpecialChar TeX
11213 supports A4 and Letter paper sizes as well as a special size for working
11215 \begin_inset space \thinspace{}
11219 It doesn't support A5, B5, legal or executive paper sizes.
11222 \begin_layout Itemize
11223 Don't bother changing the
11227 settings because they are ignored anyway.
11228 All floats appear where they are defined in the text.
11231 \begin_layout Itemize
11236 setting behaves a bit differently for this class.
11239 Foil\SpecialChar TeX
11242 provides extensive footer and header capabilities including a user-defined
11245 \begin_inset space ~
11249 \begin_inset CommandInset ref
11251 reference "sec:foilfoot"
11256 The title page is treated differently to all other pages in the document
11265 has the logo centered at the bottom of the page (if one is defined).
11266 The possible page style choices and what they do are as follows:
11270 \begin_layout Labeling
11271 \labelwidthstring MMMMMMM
11278 The final output contains no page numbers, or other headers or footers
11279 (except footnotes of course).
11283 \begin_layout Labeling
11284 \labelwidthstring MMMMMMM
11291 The final output contains page numbers centered at the bottom of the page.
11292 No other headings or footers (other than footnotes).
11295 \begin_layout Labeling
11296 \labelwidthstring MMMMMMM
11301 Page numbers in lower right corner.
11302 Additional headers and footers are also shown.
11303 This is also the default.
11306 \begin_layout Labeling
11307 \labelwidthstring MMMMMMM
11312 Gives you access to the
11316 package although its use with
11318 Foil\SpecialChar TeX
11321 is discouraged by the writer of the
11323 Foil\SpecialChar TeX
11326 package because of some potential page layout clashes.
11330 \begin_layout Subsubsection
11334 \begin_layout Standard
11335 The following options may be used in the extra class options in the
11337 Document\SpecialChar menuseparator
11343 \begin_layout Labeling
11344 \labelwidthstring MMMMMMx
11349 This sets up the page layout for 7.33
11350 \begin_inset space \thinspace{}
11354 \begin_inset space \thinspace{}
11357 in paper, which is about the same aspect ratio as a 35
11358 \begin_inset space \thinspace{}
11361 mm slide, making it a bit easier to work with this medium.
11364 \begin_layout Labeling
11365 \labelwidthstring MMMMMMx
11370 Places a rule across the page below the header on every page except the
11374 \begin_layout Labeling
11375 \labelwidthstring MMMMMMx
11380 Places a rule across the page above the footer on every page except the
11384 \begin_layout Labeling
11385 \labelwidthstring MMMMMMx
11390 This is automatically set each time you create a new
11397 Foil\SpecialChar TeX
11400 to use the dvips driver to rotate those pages that are set as landscape
11404 \begin_layout Labeling
11405 \labelwidthstring MMMMMMx
11410 Simply changes the page dimensions to those of a landscape page but doesn't
11412 Thus if you use this option you need to use an external program to rotate
11413 each page or feed your paper through your printer as landscape.
11414 Note that this option effectively reverses the roles of the
11422 environments (don't worry these are described in the next section).
11425 \begin_layout Labeling
11426 \labelwidthstring MMMMMMx
11431 Equation numbers on the left.
11434 \begin_layout Labeling
11435 \labelwidthstring MMMMMMx
11440 Flush-left equations.
11443 \begin_layout Subsection
11444 Supported Environments
11447 \begin_layout Standard
11448 Most of the environments commonly supported in other classes are also supported
11454 There are several additional environments provided by
11456 Foil\SpecialChar TeX
11459 as well as a couple added by \SpecialChar LyX
11461 The following environments are shared with other classes:
11464 \begin_layout Standard
11465 \begin_inset Flex Multiple Columns
11468 \begin_layout Itemize
11474 \begin_layout Itemize
11480 \begin_layout Itemize
11486 \begin_layout Itemize
11492 \begin_layout Itemize
11498 \begin_layout Itemize
11505 \begin_layout Itemize
11511 \begin_layout Itemize
11517 \begin_layout Itemize
11523 \begin_layout Itemize
11529 \begin_layout Itemize
11535 \begin_layout Itemize
11541 \begin_layout Itemize
11547 \begin_layout Itemize
11553 \begin_layout Itemize
11559 \begin_layout Itemize
11565 \begin_layout Itemize
11571 \begin_layout Itemize
11582 \begin_layout Standard
11583 That is, all the major environments apart from the sectioning environments.
11584 Since foils are essentially self-contained sections, with a title and body,
11587 Foil\SpecialChar TeX
11590 provides specific commands for starting new foils and these are:
11593 \begin_layout Itemize
11599 \begin_layout Itemize
11605 \begin_layout Standard
11607 also provides slightly modified versions of these two environments called:
11610 \begin_layout Itemize
11616 \begin_layout Itemize
11619 ShortRotatefoilhead
11622 \begin_layout Standard
11623 and the differences will be explained in the next section.
11626 \begin_layout Standard
11627 Since foils are often used in presenting ideas or new theorems and such
11630 Foil\SpecialChar TeX
11633 also provides a comprehensive box of goodies for presenting them:
11636 \begin_layout Standard
11637 \begin_inset Flex Multiple Columns
11640 \begin_layout Itemize
11646 \begin_layout Itemize
11652 \begin_layout Itemize
11658 \begin_layout Itemize
11664 \begin_layout Itemize
11670 \begin_layout Itemize
11676 \begin_layout Itemize
11682 \begin_layout Itemize
11688 \begin_layout Itemize
11694 \begin_layout Itemize
11700 \begin_layout Itemize
11711 \begin_layout Standard
11712 The starred versions are unnumbered while the unstarred versions are numbered.
11713 There are also two list environments added by \SpecialChar LyX
11717 \begin_layout Itemize
11723 \begin_layout Itemize
11729 \begin_layout Standard
11732 Foil\SpecialChar TeX
11735 provides some powerful header and footer capabilities that are best set
11736 in the preamble although they may be set at any point in a document.
11737 If you want to change these settings in your document the best place to
11738 do so is at the very top of a foil, i.
11739 \begin_inset space \thinspace{}
11745 \begin_inset space \space{}
11750 straight after the foilhead.
11753 \begin_layout Standard
11754 For this purpose, the following command styles are provided [
11761 \begin_layout Standard
11762 \begin_inset Flex Multiple Columns
11765 \begin_layout Itemize
11769 \begin_inset space ~
11775 \begin_layout Itemize
11781 \begin_layout Itemize
11785 \begin_inset space ~
11791 \begin_layout Itemize
11795 \begin_inset space ~
11801 \begin_layout Itemize
11805 \begin_inset space ~
11812 \begin_layout Plain Layout
11813 \begin_inset space ~
11825 \begin_layout Standard
11826 There are also a few commands provided by
11828 Foil\SpecialChar TeX
11831 that aren't directly supported by \SpecialChar LyX
11832 but I'll tell you what they do and how
11833 to use them in section
11834 \begin_inset space ~
11838 \begin_inset CommandInset ref
11840 reference "sec:unsuppfoils"
11847 \begin_layout Subsection
11848 Building a Set of Foils
11851 \begin_layout Standard
11852 This section will give a simple introduction to using the different environments
11853 to build a set of foils.
11854 If you want to see an example set of foils, take a look at the
11858 file you find in \SpecialChar LyX
11866 \begin_layout Subsubsection
11867 Give It a Title Page
11870 \begin_layout Standard
11871 Unlike other classes that provide
11891 creates the title on a page of its own.
11892 If you leave out the
11896 environment \SpecialChar LaTeX
11897 will substitute the current date (every time you regenerate
11901 \begin_layout Subsubsection
11905 \begin_layout Standard
11906 As I mentioned earlier, there are four ways of starting a new foil.
11907 For portrait foils you should use
11916 The difference between these two environments is the amount of space between
11917 the title of the foil (the foilhead) and the body of the foil.
11920 \begin_layout Standard
11921 Landscape foils are generated using the
11927 ShortRotatefoilhead
11930 Again the only difference is the spacing between foilhead and body.
11931 Both of the short versions have 0.5
11932 \begin_inset space ~
11935 inches less separation between the foilhead and the body.
11939 \begin_layout Standard
11940 One problem with the support for landscape foils is the requirement that
11941 you have to use the
11945 driver to generate the PostScript output otherwise the foils won't be rotated.
11946 It is possible to get landscape foils even if you haven't got the
11950 driver provided you can feed your foils sideways through your printer ;-)
11953 \begin_layout Subsubsection
11954 Theorems, Lemmas, Proofs and more
11957 \begin_layout Standard
11958 Due to a small bug in \SpecialChar LyX
11959 you can't have two of the same type of these environments
11960 directly following each other.
11961 They must be separated by something.
11962 If you try, you will just be extending the previous environment as if you
11963 had merged the two environments together.
11964 So, how do you get around this problem? The simplest option is to insert
11965 some text between the two environments or add a
11970 environment between the two with just a
11971 \begin_inset Quotes eld
11979 \begin_inset Quotes erd
11983 This will force \SpecialChar LyX
11984 to produce two separate environments and hence the correct
11987 An example is provided in the example file included with the \SpecialChar LyX
11989 Remember, this problem only occurs if you are trying to place two of the
11990 same type of theorem-like environments one directly after the other.
11993 \begin_layout Subsubsection
11997 \begin_layout Standard
11998 You get all the commonly supported list styles found in other classes as
11999 well as two new ones.
12000 I'll only describe the new ones here.
12001 If you want to find out more about the other list environments check out
12007 If you intend to use itemized lists you might also want to read about the
12011 \begin_inset space ~
12015 \begin_inset space ~
12020 dialog described above in section
12021 \begin_inset space ~
12025 \begin_inset CommandInset ref
12027 reference "sec:bullet"
12034 \begin_layout Standard
12035 The two new list styles,
12043 , are designed to make it easier for you to create lists of do's and don'ts
12044 or right and wrong by providing dedicated environments that use a tick
12045 or a cross as the label of the list.
12046 These lists are in fact dedicated variants of the
12051 They do however require that you have the
12055 packages installed.
12058 \begin_layout Subsubsection
12062 \begin_layout Standard
12065 Foil\SpecialChar TeX
12068 redefines the floating tables and figures so that they appear exactly where
12069 they are in the text rather than pushing them to the top of the page or
12070 to some user specified location.
12071 In fact if you change the float placement settings they are simply ignored.
12074 \begin_layout Subsubsection
12075 Page Headers and Footers
12076 \begin_inset CommandInset label
12078 name "sec:foilfoot"
12085 \begin_layout Standard
12089 \begin_inset space ~
12098 are two commands used to control the left-footer text string.
12099 The first is meant to allow you to include a graphic logo on your foils
12101 \begin_inset Quotes eld
12106 Foil\SpecialChar TeX
12110 \begin_inset Quotes erd
12114 While the second is meant to provide a classification for the audience,
12118 \begin_inset space \thinspace{}
12124 \begin_inset space \space{}
12128 It is empty by default.
12131 \begin_layout Standard
12132 The remaining page corners can be filled by
12135 \begin_inset space ~
12140 (which defaults to page numbers),
12143 \begin_inset space ~
12151 \begin_inset space ~
12159 \begin_layout Subsection
12162 Foil\SpecialChar TeX
12166 \begin_inset CommandInset label
12168 name "sec:unsuppfoils"
12175 \begin_layout Standard
12176 All the commands mentioned below need to be set in a
12186 within another environment.
12189 \begin_layout Subsubsection
12193 \begin_layout Standard
12194 All lengths are adjusted using the
12217 should be replaced by the name given to the length you want to change and
12222 is the length value.
12223 All lengths should be specified in units of length such as inches (
12235 ) or relative to some document or font-based length such as
12245 \begin_layout Standard
12246 It's possible to change the spacing between a foilhead and the body of the
12247 foil by adjusting the length specified by
12254 For example, to make
12259 \begin_inset space \space{}
12262 in closer to their bodies put the following in the preamble:
12268 foilheadskip}{-0.5in}
12271 \begin_layout Standard
12272 The spacings around floats can be adjusted by setting these lengths:
12275 \begin_layout Labeling
12276 \labelwidthstring MMMMMMMMMMM
12283 Separation between the text and the top of the float
12286 \begin_layout Labeling
12287 \labelwidthstring MMMMMMMMMMM
12294 Separation between the float and the caption
12297 \begin_layout Labeling
12298 \labelwidthstring MMMMMMMMMMM
12305 Separation between the caption and the following text
12308 \begin_layout Labeling
12309 \labelwidthstring MMMMMMMMMMM
12316 You can make the captions narrower than the surrounding text by adjusting
12318 Best done relative to
12327 \begin_layout Standard
12328 There are also several title page related lengths that you may find useful
12329 if you have a long title or several authors:
12332 \begin_layout Labeling
12333 \labelwidthstring MMMMMMMMMMM
12340 Separation from headers to
12345 \begin_layout Labeling
12346 \labelwidthstring MMMMMMMMMMM
12364 \begin_layout Labeling
12365 \labelwidthstring MMMMMMMMMMM
12379 \begin_layout Labeling
12380 \labelwidthstring MMMMMMMMMMM
12396 \begin_layout Labeling
12397 \labelwidthstring MMMMMMMMMMM
12413 \begin_layout Standard
12414 The last length related command affects all the list environments.
12425 a list environment then all the vertical spacing between the list items
12427 Note that this is a command not a length so it doesn't require
12433 like the stuff mentioned above.
12436 \begin_layout Subsubsection
12437 Headers and Footers
12440 \begin_layout Standard
12453 commands control whether the logo in the
12457 definition appear on a given page.
12464 in the preamble then none of the foils will have the logo on them.
12465 If you don't want the logo on a particular page place the
12471 directly after the foilhead of that page and the
12477 directly after the next foilhead.
12480 \begin_layout Standard
12481 If you decide to use the
12485 page style setting in the
12488 \begin_inset space ~
12493 dialog you should probably add
12503 to your preamble so headers and footers on landscape pages are correctly
12504 placed when rotated.
12505 This is due to some clashes between the page layouts provided by the
12516 \begin_layout Section
12517 Hollywood (Hollywood spec scripts)
12520 \begin_layout Standard
12526 \begin_layout Subsection
12530 \begin_layout Standard
12531 Getting the format of a Hollywood script right is a
12532 \begin_inset Quotes eld
12536 \begin_inset Quotes erd
12539 It is designed to make the readers focus on content and to be easy and
12540 familiar for the actors to read.
12541 Each page of a script should be one minute of film.
12542 Nothing goes in a script that you cannot see or hear on screen.
12543 The courier 12 pt font should be used throughout.
12547 \begin_layout Subsection
12551 \begin_layout Standard
12552 Speakers' lines should NEVER break in mid-sentence.
12553 If a speaker's lines continue over a page break, repeat the
12557 title followed by (Cont'd).
12560 \begin_layout Subsection
12564 \begin_layout Standard
12569 names as labels then cross-reference the label to insert the name.
12570 The cross-reference dialog will show the current cast of characters.
12571 You can use this to insert the speaker name in narratives also.
12574 \begin_layout Subsection
12575 Paper size and Margins
12578 \begin_layout Standard
12579 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12582 \begin_layout Subsection
12586 \begin_layout Standard
12587 The following environments are available.
12588 You can use hollywood.bind to get the bind keys shown at the right.
12591 \begin_layout Itemize
12595 \begin_inset Newline newline
12600 Used where nothing else works.
12604 \begin_layout Itemize
12610 \begin_inset space \hfill{}
12618 \begin_inset Newline newline
12621 Usually followed by something like
12622 \begin_inset Quotes eld
12625 on Sally waking up.
12626 \begin_inset Quotes erd
12632 \begin_layout Itemize
12636 \begin_inset space \hfill{}
12640 \begin_inset Newline newline
12645 Introduces a new INTERIOR camera set-up.
12646 Always followed by DAY or NIGHT, or something similar to define the lighting
12648 Everthing on this line in CAPS.
12651 \begin_layout Itemize
12655 \begin_inset space \hfill{}
12659 \begin_inset Newline newline
12664 Introduces a new EXTERIOR camera set-up.
12665 Everthing on this line in CAPS.
12668 \begin_layout Itemize
12672 \begin_inset space \hfill{}
12676 \begin_inset Newline newline
12681 The character speaking.
12684 \begin_layout Itemize
12688 \begin_inset space \hfill{}
12692 \begin_inset Newline newline
12697 Instructions to the speaker.
12698 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12700 Both will be printed.
12703 \begin_layout Itemize
12707 \begin_inset space \hfill{}
12711 \begin_inset Newline newline
12723 \begin_layout Itemize
12727 \begin_inset space \hfill{}
12731 \begin_inset Newline newline
12736 Camera movement instruction.
12738 \begin_inset space \thinspace{}
12742 \begin_inset space \space{}
12748 \begin_layout Itemize
12752 \begin_inset space \hfill{}
12758 \begin_layout Itemize
12762 \begin_inset space \hfill{}
12768 \begin_layout Itemize
12772 \begin_inset space \hfill{}
12778 \begin_layout Itemize
12782 \begin_inset space \hfill{}
12788 \begin_layout Subsection
12792 \begin_layout Itemize
12796 \begin_layout Itemize
12800 \begin_layout Itemize
12802 \begin_inset space \thinspace{}
12809 \begin_layout Itemize
12814 \begin_layout Itemize
12815 PAN — camera movement
12818 \begin_layout Itemize
12819 INSERT — cut to close-up of
12822 \begin_layout Section
12826 \begin_layout Standard
12829 Panayotis Papasotiriou
12832 \begin_layout Subsection
12836 \begin_layout Standard
12837 The ijmpc package is a set of macros that facilitates electronic manuscript
12840 International Journal of Modern Physics C
12843 Similarly, the ijmpd package is for creating manuscripts to be submitted
12846 International Journal of Modern Physics D
12849 Both journals are published by World Scientific.
12850 The corresponding document classes are named
12859 These files, together with instructions for the authors, can be downloaded
12861 \begin_inset Flex URL
12864 \begin_layout Plain Layout
12866 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12872 \begin_inset Flex URL
12875 \begin_layout Plain Layout
12877 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12883 Both packages are modified versions of the standard
12884 \begin_inset Quotes eld
12888 \begin_inset Quotes erd
12891 package, and they are almost (but not exactly) identical.
12892 Most of their features are supported by \SpecialChar LyX
12894 I have used \SpecialChar LyX
12895 successfully to write articles submitted to both journals
12896 without any problem.
12899 \begin_layout Subsection
12903 \begin_layout Standard
12904 As usual, the easiest way to write a paper is to start with a template.
12907 File\SpecialChar menuseparator
12923 This will give an (almost) empty document that includes the most common
12924 fields found in a manuscript.
12925 Simply overwrite the existing text (including the brackets,
12930 You should keep in mind the following remarks.
12933 \begin_layout Enumerate
12935 won't let you change the font size and the page style of the document,
12936 because such modifications are not allowed by both packages.
12939 \begin_layout Enumerate
12940 The language of the document should not be changed.
12941 Before previewing your paper, be sure that the babel package is not used.
12942 To do this, click on
12944 Tools\SpecialChar menuseparator
12955 checkbox in the language settings, and click on
12963 , if you wish to make this change permanent).
12966 \begin_layout Enumerate
12968 \begin_inset Quotes eld
12972 \begin_inset Quotes erd
12975 style must be used to define keywords.
12978 \begin_layout Enumerate
12979 The ijmpc package provides a style named
12980 \begin_inset Quotes eld
12983 Classification Codes
12984 \begin_inset Quotes erd
12987 , which can be used to define classification codes, such as PACS numbers.
12988 Note that this facility is not supported by the ijmpd package.
12991 \begin_layout Enumerate
12992 Several new environments are available:
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 \begin_inset Quotes eld
13101 \begin_inset Quotes erd
13105 Their use is more or less obvious.
13107 supports all these environments; it will use the proper label, text style,
13108 and numbering scheme for each of them.
13111 \begin_layout Enumerate
13112 Both packages use basic citations; the natbib package should not be used.
13113 In \SpecialChar LyX
13114 , citation references are shown as usual; in the output, citations are
13115 shown as superscripts.
13116 If you want to use a citation as normal text, you should use the
13121 \begin_inset space \thinspace{}
13125 \begin_inset space \space{}
13129 \begin_inset Quotes eld
13133 \begin_inset space \space{}
13143 \begin_inset Quotes erd
13149 \begin_layout Enumerate
13151 \begin_inset Quotes eld
13155 \begin_inset Quotes erd
13158 section in both packages.
13159 To put acknowledgments, just use the
13160 \begin_inset Quotes eld
13164 \begin_inset Quotes erd
13170 \begin_layout Enumerate
13171 Appendices may be added to the paper,
13175 the Acknowledgments and
13181 provides a special environment, called
13182 \begin_inset Quotes eld
13186 \begin_inset Quotes erd
13189 which marks the beginning of the appendices.
13190 This environment should be left blank; it just sends a \SpecialChar LaTeX
13191 command, but nothing
13193 In \SpecialChar LyX
13195 \begin_inset Quotes eld
13199 \begin_inset Quotes erd
13202 is printed with blue letters, as a signal that all sections after that
13203 point are appendices.
13204 To write an appendix, use the
13205 \begin_inset Quotes eld
13209 \begin_inset Quotes erd
13214 will number each appendix with capital letters, as required by both journals.
13216 \begin_inset Quotes eld
13220 \begin_inset Quotes erd
13227 be present before the first appendix; if not, all appendices will be numbered
13228 as normal sections in the output.
13231 \begin_layout Enumerate
13232 The ijmpc and the ijmpd packages use the
13236 command to implement table captions.
13237 As a result, a table created by \SpecialChar LyX
13238 is printed correctly, but its caption
13240 However, you can use some \SpecialChar TeX
13241 code to overcome this problem, so that captions
13242 are printed as expected.
13243 To do so, create a float table as usual, remove the caption, and replace
13244 it with the \SpecialChar TeX
13255 (sic); you must also the \SpecialChar TeX
13260 immediately after the tabular material.
13261 Study the example table included in the template files to see how this
13262 trick is implemented.
13263 Alternatively, If you need table captions, you should implement the whole
13268 file, then include this file to the \SpecialChar LyX
13271 Insert\SpecialChar menuseparator
13272 File\SpecialChar menuseparator
13274 \begin_inset space ~
13280 Details on how to create a table float can be found in the files
13288 , included in the corresponding packages.
13291 \begin_layout Subsection
13292 Preparing a paper for submission
13295 \begin_layout Standard
13296 Before you submit your paper you must export the \SpecialChar LyX
13297 document as a \SpecialChar LaTeX
13300 File\SpecialChar menuseparator
13301 Export\SpecialChar menuseparator
13309 \begin_layout Plain Layout
13310 Actually you have the choice between \SpecialChar LaTeX
13311 (plain) and pdflatex.
13312 If you intend to use pdflatex to prepare the paper, you should use the
13313 pdflatex option so that included graphics are converted to PDF format,
13314 ready for use by pdflatex.
13319 , then make the following changes to the resulting
13326 \begin_layout Enumerate
13327 Remove the comment lines before the
13336 \begin_layout Enumerate
13337 Remove everything between (and including) the
13349 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13353 \begin_layout Standard
13358 file should be saved and processed through \SpecialChar LaTeX
13359 as many times as necessary.
13360 You may also want to check the resulting
13367 \begin_layout Subsection
13368 Use of \SpecialChar TeX
13372 \begin_layout Standard
13373 The use of \SpecialChar TeX
13374 code is reduced to two commands, which must be placed at the
13375 top of the document.
13376 If you started writing your paper by using the
13384 template, the \SpecialChar TeX
13385 code needed is already in its place; you usually don't need
13387 You may only modify the first \SpecialChar TeX
13388 code to specify the information printed
13389 to the top of odd and even pages (authors' names and short paper's title,
13391 This \SpecialChar TeX
13392 code must have the form
13396 markboth{Authors' Names}{Short Paper's Title}
13401 \begin_layout Section
13405 \begin_layout Standard
13411 \begin_layout Subsection
13415 \begin_layout Standard
13416 The iopart package provides a document class to create electronic manuscript
13417 submission to the journals published by the Institute of Physics.
13418 Instructions for the authors how to create a paper using the iopart class
13419 can be downloaded together with the iopart package from the site
13420 \begin_inset Flex URL
13423 \begin_layout Plain Layout
13425 ftp://ftp.iop.org/pub/journals/latex2e
13433 \begin_layout Subsection
13437 \begin_layout Standard
13438 The easiest way to write a paper is to start with the file
13442 that is available in \SpecialChar LyX
13443 's examples files folder.
13444 Open this file, save it under a new name, and start writing.
13445 The example file explains how to use the special text environments.
13446 Here are the most important advices:
13449 \begin_layout Itemize
13450 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13453 Use AMS math package
13455 in the document settings under
13462 \begin_layout Itemize
13465 The title environment defines the kind of your paper.
13466 So use one of the following environments for the title:
13470 \begin_layout Itemize
13479 \begin_layout Itemize
13488 \begin_layout Itemize
13494 for a Topical review
13497 \begin_layout Itemize
13506 \begin_layout Itemize
13515 \begin_layout Itemize
13521 for a Paper (same as Title)
13524 \begin_layout Itemize
13530 for a Preliminary communication
13533 \begin_layout Itemize
13539 for a Rapid communication
13542 \begin_layout Itemize
13548 for a Letter to the editor
13552 \begin_layout Itemize
13555 All title environments except of
13559 can have an optional short title.
13562 \begin_layout Itemize
13563 There is a general title environment
13567 which is not directly supported by the \SpecialChar LyX
13569 This can be used as \SpecialChar TeX
13570 code when your document doesn't fit into one of the
13574 \begin_layout Standard
13575 For more informations like hints for special table and formula formatting,
13576 look at the IOP author guidelines.
13579 \begin_layout Section
13583 \begin_layout Standard
13586 Panayotis Papasotiriou
13589 \begin_layout Subsection
13593 \begin_layout Standard
13594 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13595 that facilitates electronic manuscript submission to the journals they
13597 Most known of them (at least in my domain of interest) are
13599 Astrophysics and Space Science
13605 , but there are many others (see a complete list at
13606 \begin_inset Flex URL
13609 \begin_layout Plain Layout
13611 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13617 The Kluwer package may be downloaded from the site
13618 \begin_inset Flex URL
13621 \begin_layout Plain Layout
13623 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13629 A complete user guide is contained in that package (but it can also be
13630 downloaded separately).
13633 \begin_layout Standard
13635 supports many features of the package but not everything.
13636 However, the \SpecialChar TeX
13637 code needed is reduced to some
13638 \begin_inset Quotes eld
13642 \begin_inset Quotes erd
13645 commands of the package (see
13646 \begin_inset space ~
13650 \begin_inset CommandInset ref
13652 reference "subsec:kluwer_peculiarities"
13657 I have recently used \SpecialChar LyX
13658 to write an article submitted to the
13660 Astrophysics and Space Science
13662 without any problem.
13665 \begin_layout Subsection
13669 \begin_layout Standard
13670 The easiest way to write a paper is to start with the Kluwer template file.
13673 File\SpecialChar menuseparator
13685 This will give an (almost) empty document that includes the most common
13686 fields found in a manuscript and a short description of their use.
13687 As in most templates, simply overwrite the existing text (including the
13692 ) with the correct information.
13695 \begin_layout Subsection
13696 Preparing a paper for submission
13699 \begin_layout Standard
13700 As in the AAS\SpecialChar TeX
13701 package, before you submit your paper to a journal you must
13703 \begin_inset Quotes eld
13707 \begin_inset Quotes erd
13713 \begin_layout Enumerate
13714 Export your paper as a \SpecialChar LaTeX
13716 To do this, click on
13718 File\SpecialChar menuseparator
13719 Export\SpecialChar menuseparator
13727 \begin_layout Enumerate
13732 file with a text editor and make the following changes
13736 \begin_layout Enumerate
13737 remove the comment lines before the
13746 \begin_layout Enumerate
13747 remove everything between (and including) the
13759 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13763 \begin_layout Standard
13772 \begin_layout Enumerate
13777 file through \SpecialChar LaTeX
13778 as many times as necessary (usually up to three).
13781 \begin_layout Enumerate
13787 \begin_inset space \thinspace{}
13791 \begin_inset space \space{}
13798 , and check if everything is OK (it should, if you didn't make any mistake).
13801 \begin_layout Subsection
13802 \begin_inset Quotes eld
13806 \begin_inset Quotes erd
13809 of the Kluwer package
13810 \begin_inset CommandInset label
13812 name "subsec:kluwer_peculiarities"
13819 \begin_layout Standard
13820 The Kluwer package has the following
13821 \begin_inset Quotes eld
13825 \begin_inset Quotes erd
13831 \begin_layout Enumerate
13832 It is possible to write multiple articles in the same \SpecialChar LaTeX
13837 \begin_layout Plain Layout
13838 I can't imagine any good reason to do this.
13844 Each article must be included in the environment
13845 \begin_inset Quotes eld
13849 \begin_inset Quotes erd
13853 Unfortunately, this environment cannot be omitted, even if you write just
13855 Therefore, each article starts with the command
13861 and, obviously, ends with the command
13868 Although this can be implemented in \SpecialChar LyX
13869 , I didn't included it, since it looks
13870 ugly and can confuse the novice user.
13871 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13874 \begin_inset Quotes eld
13879 \begin_inset Quotes erd
13885 \begin_layout Enumerate
13886 Information given at the beginning of the article (i.
13887 \begin_inset space \thinspace{}
13891 \begin_inset space \space{}
13894 title, subtitle, author, institution, running title, running author, abstract
13895 and keywords) must be included in an environment called
13896 \begin_inset Quotes eld
13900 \begin_inset Quotes erd
13904 This is not implemented in \SpecialChar LyX
13905 , so you must enter title, subtitle etc.
13906 \begin_inset space ~
13909 between two \SpecialChar TeX
13925 \begin_layout Enumerate
13926 According to the user manual, the label of each bibliography item must be
13950 \begin_layout Standard
13955 template takes care of all these
13956 \begin_inset Quotes eld
13960 \begin_inset Quotes erd
13964 If you start a new paper using this template you don't need to do anything
13969 \begin_layout Enumerate
13970 don't delete the \SpecialChar TeX
13971 code included in the template, and
13974 \begin_layout Enumerate
13975 copy the example bibliography item included in the template and modify it
13976 as necessary to enter new bibliography items.
13979 \begin_layout Section
13983 \begin_layout Standard
13989 \begin_layout Subsection
13993 \begin_layout Standard
13994 The \SpecialChar LyX
13997 article (koma-script)
14001 report (koma-script)
14019 correspond to the \SpecialChar LaTeX
14037 \begin_inset space ~
14040 of the Koma-Script family.
14041 They are replacements for the standard document classes
14057 , resp., and fit better to European typography conventions in a number of
14061 \begin_layout Itemize
14062 Standard character size is 11pt in
14064 article (koma-script)
14068 report (koma-script)
14076 letter (koma-script)
14081 \begin_layout Itemize
14082 Headings, labels of the description environment, and a number of elements
14085 letter (koma-script)
14087 document class are set in a bold sans serif font.
14091 \begin_layout Plain Layout
14092 There is a big difference between the bold sans serif old cm fonts and new
14093 ec fonts, especially in the appearance of headings.
14094 In comparison, the ec bold sans serif fonts look a bit thin.
14095 Here the \SpecialChar LaTeX
14104 helps to produce the
14105 \begin_inset Quotes eld
14109 \begin_inset Quotes erd
14112 appearance when using the ec fonts.
14117 The numbering of chapter headings is made in the same way as the numbering
14118 of section headings, that is without the extra line
14119 \begin_inset Quotes eld
14122 Chapter\SpecialChar ldots
14124 \begin_inset Quotes erd
14128 In addition, the appearance of the headings can be modified by using a
14129 number of options (in \SpecialChar LyX
14130 to be entered in the field
14133 \begin_inset space ~
14140 Layout\SpecialChar menuseparator
14147 \begin_layout Itemize
14148 The main means in the Koma-Script document classes to design the type area
14157 (in \SpecialChar LyX
14158 to be entered in the extra class options field in the dialog
14160 Document\SpecialChar menuseparator
14164 They make a clearer modification of page margins possible as do the options
14167 Document\SpecialChar menuseparator
14174 \begin_layout Itemize
14175 The \SpecialChar LaTeX
14176 document classes of the Koma-Script family define a number of additional
14178 Those part of it which makes sense in \SpecialChar LyX
14179 is implemented in corresponding
14183 \begin_layout Standard
14184 Detailed descriptions of the \SpecialChar LaTeX
14185 document classes of the Koma-Script family
14186 can be found in the Koma-Script documentation
14197 \begin_layout Subsection
14198 article (koma-script), report (koma-script), and book (koma-script)
14201 \begin_layout Standard
14202 The document classes
14204 article (koma-script)
14208 report (koma-script)
14218 are implemented in the layout files
14231 They contain all the paragraph types of the corresponding standard document
14244 , resp., partly modified, with the exception of the \SpecialChar LyX
14249 -type, which is replaced by the new
14253 -type having the same functionality.
14258 -Type there is a number of new paragraph types added.
14265 letter (koma-script)
14270 \begin_layout Itemize
14279 : are equivalents to
14287 , resp., additionally inserting an entry in the table of contents.
14296 are not contained in
14298 article (koma-script)
14303 \begin_layout Itemize
14312 : behave exactly as
14320 , resp., additionally clearing running heads.
14325 is not contained in
14327 article (koma-script)
14333 \begin_layout Plain Layout
14346 report (koma-script)
14348 , but since this is identical to
14352 , is has not been implemented in \SpecialChar LyX
14361 \begin_layout Itemize
14366 : generates a heading directly above the following paragraph in the standard
14367 character size without affecting the structure of the document.
14370 \begin_layout Itemize
14379 are special captions which respect the different space settings needed
14380 for captions placed above or below an element (if you follow strict typographic
14381 rules, you might want to place table captions always above the table).
14382 You can also use the class option
14386 , which will switch
14399 You need at least Koma-Script version 2.8q to use this.
14402 \begin_layout Itemize
14407 : can be used to set a bonmot, e.
14408 \begin_inset space \thinspace{}
14412 \begin_inset space \space{}
14415 at the beginning of a chapter.
14416 If you use the optional argument (
14418 Insert\SpecialChar menuseparator
14420 \begin_inset space ~
14425 ), you can insert the dictum's author there.
14426 Dictum and author are separated by a line.
14427 You need at least Koma-Script version 2.8q to use this.
14432 is not contained in
14434 article (koma-script)
14439 \begin_layout Standard
14440 The following types, together with the standard types
14452 , form the title area of the document.
14453 They must be entered ahead of the first
14454 \begin_inset Quotes eld
14458 \begin_inset Quotes erd
14465 \begin_layout Plain Layout
14466 The corresponding \SpecialChar LaTeX
14467 commands must appear before the
14478 When such a type is used more than once, the latter usage overwrites the
14479 former one, that means, for every type only the latest usage is valid.
14480 The order of the different types however has, like
14492 , no effect on the appearance of the produced document.
14495 \begin_layout Itemize
14500 : produces a centered paragraph above the ordinary title (
14512 ) for the subject of the document.
14515 \begin_layout Itemize
14520 : produces a centered paragraph below the ordinary title (
14532 ) for the publishers' name.
14535 \begin_layout Itemize
14542 report (koma-script)
14548 produces a centered paragraph on its own page behind the title page, or
14551 article (koma-script)
14553 produces a centered paragraph below the ordinary title (
14569 ) for a dedication.
14572 \begin_layout Itemize
14577 : produces a left aligned paragraph above the ordinary title (
14593 ) for a document`s head.
14596 \begin_layout Itemize
14601 : produces in a double-sided print in
14603 report (koma-script)
14609 a left-aligned paragraph at the top of the title page`s back or has no
14610 effect in a single-sided print or in
14612 article (koma-script)
14617 \begin_layout Itemize
14622 : produces in a double-sided print in
14624 report (koma-script)
14630 a left-aligned paragraph at the bottom of the title page`s back or has
14631 no effect in a single-sided print or in
14633 article (koma-script)
14638 \begin_layout Itemize
14643 : produces a special
14644 \begin_inset Quotes eld
14648 \begin_inset Quotes erd
14651 page ahead of the actual document containing a paragraph without special
14655 \begin_layout Standard
14656 The layout files for the document classes
14658 article (koma-script)
14662 report (koma-script)
14668 do include the file
14673 This is thought of as a place to define your own types.
14678 in your personal layout directory and edit the file!
14681 \begin_layout Subsection
14682 letter (koma-script)
14685 \begin_layout Standard
14689 letter (koma-script)
14691 is implemented in the layout file
14696 It contains all the paragraph types of the corresponding standard document
14701 , partly modified, with the exception of the \SpecialChar LyX
14715 type, which is replaced by the new
14720 In addition, it contains, in contrast to the standard document class, the
14739 Furthermore, there are a number of new letter specific types.
14742 \begin_layout Standard
14743 The appearance of the letter produced by this document class can be controlled
14744 by a number of \SpecialChar LaTeX
14745 commands, which you can put in the \SpecialChar LaTeX
14750 \begin_layout Plain Layout
14751 For example, the standard appearance of the letter`s heading, consisting
14752 of name and address, is quite self-willed.
14754 \begin_inset Quotes eld
14758 \begin_inset Quotes erd
14761 heading is produced by the following \SpecialChar LaTeX
14762 commands in the preamble:
14765 \begin_layout LyX-Code
14775 \begin_layout LyX-Code
14791 \begin_layout LyX-Code
14801 \begin_layout LyX-Code
14821 A detailed German description of such \SpecialChar LaTeX
14822 commands can be found in the Koma-Script
14828 With it, the letter's author can produce his personal letter layout.
14831 \begin_layout Standard
14840 define the beginning of the letter and must be used in every letter.
14841 To emphasize them in the \SpecialChar LyX
14842 document class, they are marked with the letter
14852 \begin_inset space ~
14855 in the left margin.
14856 It is possible to write any number of letters in one file.
14861 type produces a new letter using the same addressee and a
14865 type produces a new addressee.
14882 are ordinary paragraph types and can also be used several times in one
14883 and the same letter.
14886 \begin_layout Itemize
14891 : produces a paragraph for the addressee and implicitly defines the beginning
14895 \begin_layout Itemize
14900 : produces a paragraph for the form of address and implicitly produces a
14904 \begin_layout Itemize
14909 : produces a paragraph for a close.
14912 \begin_layout Itemize
14917 : produces a paragraph for a postscript.
14920 \begin_layout Itemize
14925 : produces a paragraph for a distribution list.
14928 \begin_layout Itemize
14933 : produces a paragraph for enclosures.
14936 \begin_layout Standard
14977 are input types provided with a label to enter information, which will
14978 be processed by the document class.
14982 \begin_layout Plain Layout
14983 It could be seen as a matter of inconsequence, that the types
14991 described above are not such input types as well.
14992 Because of the special meaning of those types, however, I have implemented
14993 them as ordinary paragraph types with a one letter mark in the left margin.
14994 Moreover, it would affect my feeling of symmetry, if the
15002 type had such a serious different appearance.
15007 The types must be used ahead of the corresponding
15014 \begin_layout Standard
15015 An implementation of these types in a WYSIWYG fashion does not seem to make
15016 sense, because the real appearance of the produced letter does not only
15017 depend on the usage of the particular type, but also on other factors.
15018 For example, a signature entered in the
15022 type will in the standard behavior appear in the produced letter only,
15023 when in the same letter also a
15028 The entered value of the
15032 type will in the standard behavior not appear in the produced letter at
15034 The possibility to design the letter`s heading freely is already indicated
15035 in a footnote above.
15038 \begin_layout Standard
15039 The input types can also be used as empty paragraphs.
15040 This makes sense e.
15041 \begin_inset space \thinspace{}
15045 \begin_inset space \space{}
15057 type is not used at all, in the standard behavior the value of the
15061 type is used as signature, whereas if an empty
15065 type is used, no signature value is defined.
15068 \begin_layout Standard
15069 By using the input types it is possible to write a letter template, containing
15070 filled input types with your personal dates (name, address, etc.) and empty
15071 input types for other dates you want to enter.
15074 \begin_layout Itemize
15079 : sender's name, in the standard behavior appears as a centered paragraph
15080 in small caps in the letter`s heading.
15083 \begin_layout Itemize
15088 : sender's signature, in the standard behavior appears below the
15097 type is used, the value of the
15101 type appears instead.
15104 \begin_layout Itemize
15109 : sender's address, in the standard behavior appears in a centered paragraph
15110 in the letter`s heading below the sender's name.
15113 \begin_layout Itemize
15118 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15129 \begin_layout Itemize
15134 : place of the letter`s making.
15137 \begin_layout Itemize
15142 : date of the letter`s making.
15151 , in the standard behavior, produce the place and the date in a right-aligned
15152 line below the addressee's field.
15157 type is used, neither place nor date appear, independent of the value of
15167 type is used, the date of the letter `s production is used.
15170 \begin_layout Itemize
15175 : sender`s back address, in the standard behavior appears above the addressee's
15176 field in a small sans serif font.
15179 \begin_layout Itemize
15184 : special mail information, in the standard behavior appears underlined
15185 above the addressee's field below the back address.
15188 \begin_layout Itemize
15193 : additional information, in the standard behavior appears on right side
15194 below the addressee`s field.
15197 \begin_layout Itemize
15202 : the letter's title, in the standard behavior appears in a big, bold, sans
15203 serif font above the subject.
15206 \begin_layout Itemize
15211 : the letter's subject, in the standard behavior appears in a bold font
15219 \begin_layout Standard
15240 produce a business letter like line above the
15244 line containing the fields
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 \begin_inset Quotes eld
15289 \begin_inset Quotes erd
15293 For the date field, the value of the
15299 \begin_inset Quotes eld
15302 business letter types
15303 \begin_inset Quotes erd
15306 is used, the value of the
15310 type however does not appear, but only the \SpecialChar LaTeX
15318 The ordinary output of place and date in a right-aligned line below the
15319 addressee`s field is suppressed.
15320 The types are implemented as input types provided with a label and must
15321 be used ahead of the corresponding
15328 \begin_layout Itemize
15336 \begin_layout Itemize
15344 \begin_layout Itemize
15352 \begin_layout Itemize
15360 \begin_layout Itemize
15368 \begin_layout Subsection
15369 The new letter class: letter (koma-script v.2)
15372 \begin_layout Standard
15378 \begin_layout Standard
15379 \begin_inset VSpace medskip
15385 \begin_layout Standard
15387 Koma-Script version 2.8 has introduced a new letter class
15391 which supersedes the now unsupported
15396 It has — on the \SpecialChar LaTeX
15397 side — a completely new interface and is not compatible
15398 with the old class.
15399 Therefore, \SpecialChar LyX
15400 supports both, though it is recommended you use the new class.
15403 \begin_layout Standard
15404 This class covers the same functionality as
15406 letter (koma-script),
15409 The basic items are
15413 (receiver's address, same as
15417 in the old layout),
15430 will start a new letter (i.
15431 \begin_inset space \thinspace{}
15435 \begin_inset space \space{}
15438 you can write several letters per document).
15439 New elements are sender's
15455 and the possibility to use a
15461 Insert\SpecialChar menuseparator
15467 \begin_layout Standard
15468 The biggest improvement is, though, that the letter's layout is configurable
15469 to meet almost any needs.
15470 This can be done via the preamble or with a special style file (Letter
15471 Class Option, extension
15475 ), that will be read in as a class option.
15479 \begin_layout Plain Layout
15480 The KOMA package comes with some default
15485 There is, for instance, a
15489 file that follows german typesetting rules, or a
15493 that provides the default layout of the old
15498 The latter can be loaded with the class option
15504 Layout\SpecialChar menuseparator
15505 Document\SpecialChar menuseparator
15517 template that is included in \SpecialChar LyX
15519 A detailed description is to be found in the Koma-Script documentation
15527 \begin_layout Subsection
15531 \begin_layout Standard
15532 Visualizing the Koma-Script document classes in \SpecialChar LyX
15533 , the \SpecialChar LyX
15534 internals cause some
15538 \begin_layout Itemize
15539 The chapter number of a
15543 type appears on a line of its own above the chapter heading instead of
15544 appearing in the same line ahead of it.
15545 The cause for that is the \SpecialChar LyX
15546 internal behavior for the labeltype
15550 in the layout file.
15553 \begin_layout Itemize
15554 The headings of the types
15562 are only put in the
15563 \begin_inset Quotes eld
15567 \begin_inset Quotes erd
15571 table of contents, but not in the \SpecialChar LyX
15572 table of contents (
15574 Document\SpecialChar menuseparator
15576 \begin_inset space ~
15580 \begin_inset space ~
15588 \begin_layout Itemize
15589 The paragraphs in a
15593 document class appear in a skip separation mode, not indented.
15594 This is the standard behavior, no special \SpecialChar LaTeX
15595 commands are needed for that.
15598 Document\SpecialChar menuseparator
15601 dialog the corresponding radio button indicates
15610 value always has the effect that extra \SpecialChar LaTeX
15611 commands are inserted in the document
15612 to produce the gap, which is not what is wanted in this case.
15615 \begin_layout Section
15619 \begin_layout Standard
15625 \begin_layout Subsection
15629 \begin_layout Standard
15630 Memoir is a very powerful and constantly evolving class.
15631 It has been designed with regard to fictional and non-fictional literature.
15632 Its aim is to let the user have maximum control over the typesetting of
15634 Memoir is based on the standard book class, but it can also emulate the
15635 article class (see below).
15638 \begin_layout Standard
15639 Peter Wilson, the developer of Memoir, is known as the author of lots of
15640 useful packages in the \SpecialChar LaTeX
15642 Most of them have been merged with Memoir.
15643 Therefore, it is much easier to layout the table of contents, appendices,
15644 chapter designs and such.
15646 , though, does not support all of these goodies natively.
15647 Some of them might be added to forthcoming releases
15651 \begin_layout Plain Layout
15652 You are invited to send suggestions to
15653 \begin_inset Flex URL
15656 \begin_layout Plain Layout
15658 lyx-devel@lists.lyx.org
15668 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15670 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15672 commands (\SpecialChar TeX
15677 \begin_layout Plain Layout
15682 \begin_layout Plain Layout
15692 \begin_inset space ~
15696 \begin_inset CommandInset ref
15698 reference "sec:Inserting-TeX-Code"
15708 In this section, we can only list those features that are natively supported
15709 by \SpecialChar LyX
15711 For detailed descriptions (and for the rest of features) we recommend you
15712 have a look at the detailed manual of the Memoir class
15716 \begin_layout Plain Layout
15721 \begin_layout Plain Layout
15731 \begin_inset Flex URL
15734 \begin_layout Plain Layout
15736 CTAN:/macros/latex/memoir/memman.pdf
15746 , which is not only a user guide for the class, but also both a comprehensive
15747 description on good typesetting and a superb example for good typesetting
15751 \begin_layout Subsection
15752 Basic features and restrictions
15755 \begin_layout Standard
15756 Memoir supports basically all features of the standard book classes.
15757 There are, however, some differences, as follows:
15760 \begin_layout Description
15762 \begin_inset space ~
15765 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15768 \begin_layout Description
15770 \begin_inset space ~
15773 style: The fancy page style is not supported, due to a command clash between
15774 Memoir and the fancyhdr package (they both define a command with the same
15775 name, which confuses \SpecialChar LaTeX
15777 Instead, Memoir comes with a number of its own page styles (see
15779 Layout\SpecialChar menuseparator
15780 Document\SpecialChar menuseparator
15782 \begin_inset space ~
15788 If you want to use these for the chapter pages, you have to use the command
15795 in the main text or in preamble (e.
15796 \begin_inset space \thinspace{}
15800 \begin_inset space \space{}
15807 chapterstyle{companion}
15812 \begin_layout Description
15813 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15814 optional argument in the standard classes.
15815 With this, you can specify an alternative version of the title for the
15816 table of contents and the headers (for instance, if the title is too long).
15817 In \SpecialChar LyX
15818 , you can do this via
15820 Insert\SpecialChar menuseparator
15822 \begin_inset space ~
15827 at the beginning of a chapter/section.
15828 Memoir features a second optional argument and thus separates the table
15829 of contents from the header.
15830 You can define three variants of a title with this: one for the main text,
15831 one for the table of contents, and one for the headers.
15832 Simply insert two optional arguments if you need this feature, the first
15833 one containing the short title for the Table of Contents, the second one
15834 containing an alternative short title for the headers.
15837 \begin_layout Description
15838 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15839 of contents, the list of figures and the list of table start a new page
15841 Memoir does not follow this route.
15842 You have to insert a page break yourself, if you want to have one.
15845 \begin_layout Description
15846 Titlepage: For some unknown reason, Memoir uses pagination on the title
15847 page (in the standard classes, title pages are
15848 \begin_inset Quotes eld
15852 \begin_inset Quotes erd
15856 If you want an empty title page, type
15860 aliaspagestyle{title}{empty}
15865 \begin_layout Description
15866 Article: With the class option
15872 Layout\SpecialChar menuseparator
15873 Document\SpecialChar menuseparator
15875 \begin_inset space ~
15880 ), you can emulate article style.
15881 That is, counters (footnotes, figures, tables etc.) will not be reset on
15882 new chapters, chapters don't start a new page (but are—in contrary to
15883 \begin_inset Quotes eld
15887 \begin_inset Quotes erd
15890 article classes—still allowed), parts, though, use their own page, as in
15894 \begin_layout Description
15895 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15896 font commands, which have been used in the old \SpecialChar LaTeX
15898 \begin_inset space \thinspace{}
15902 \begin_inset space \space{}
15918 It produces an error and stops \SpecialChar LaTeX
15919 whenever such a command appears.
15924 reallows the commands and spits out warnings instead (which does at least
15925 not stop \SpecialChar LaTeX
15927 Since a lot of packages and particularly Bib\SpecialChar TeX
15928 style files are still using
15929 those commands, we have decided to use this option by default.
15932 \begin_layout Subsection
15936 \begin_layout Standard
15937 We will only describe the features supported by \SpecialChar LyX
15938 (which is not much currently).
15939 Please consult the Memoir manual
15943 \begin_layout Plain Layout
15948 \begin_layout Plain Layout
15958 \begin_inset Flex URL
15961 \begin_layout Plain Layout
15963 CTAN:/macros/latex/memoir/memman.pdf
15976 \begin_layout Description
15977 Abstract: You may wonder why an abstract is an extra feature.
15978 Well, it is in book class.
15979 Usually books don't have abstracts.
15980 Memoir, however, has.
15981 You can use it wherever and how often you like.
15984 \begin_layout Description
15985 Chapterprecis: You may know this older typesetting style: The contents of
15986 a chapter are summarized below the title and also in the table of contents
15988 \begin_inset space \thinspace{}
15992 \begin_inset space \space{}
15997 Our hero arrives in Troia; he loses some friends; he finds others
16000 Chapterprecis does exactly this.
16001 It is therefore only sensible below a chapter.
16004 \begin_layout Description
16005 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16006 The epigraph environment provides an elegant way of typesetting such a
16008 The motto itself (text) and its author (source) are divided by a short
16010 Unfortunately, we have to fool \SpecialChar LyX
16011 a bit here again, since the environment
16012 needs two arguments (text and source).
16013 In this case, we have to use curly brackets (in \SpecialChar TeX
16014 mode) between the two
16025 <author of the slogan>.
16028 \begin_layout Description
16029 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16030 complex figurative poems).
16032 can only support a few of them.
16033 One is poemtitle, which is a centered title for poems, which will also
16034 be added to the table of contents (verse is the standard environment for
16036 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16038 because they have to be nested inside regular verse environments, which
16039 is not possible with \SpecialChar LyX
16043 \begin_layout Description
16044 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16047 \begin_layout Section
16048 Article (mwart), book (mwbk) and report (mwrep)
16049 \begin_inset Argument status
16052 \begin_layout Plain Layout
16065 \begin_layout Standard
16071 \begin_layout Standard
16072 The \SpecialChar LyX
16089 correspond to the \SpecialChar LaTeX
16103 They are replacements for the standard document classes
16115 , resp., and fit better to Polish typography conventions in a number of points.
16119 \begin_layout Standard
16123 \begin_layout Itemize
16124 Unnumbered titles (with star, e.
16125 \begin_inset space \thinspace{}
16129 \begin_inset space \space{}
16136 ) are added into table of contents,
16139 \begin_layout Itemize
16140 Additional page styles:
16144 \begin_layout Description
16145 uheadings header with separated lines,
16148 \begin_layout Description
16149 myheadings custom header, contents headers via commands:
16164 \begin_layout Description
16165 myuheadings custom header with separated lines,
16168 \begin_layout Description
16169 outer page number is placed on outer side of page
16173 \begin_layout Itemize
16178 \begin_layout Description
16179 rmheadings serif titles — default,
16182 \begin_layout Description
16183 sfheadings sansserif titles,
16186 \begin_layout Description
16187 authortitle on title page first placed is author next title — default,
16190 \begin_layout Description
16191 titleauthor on title page first placed is title next author,
16194 \begin_layout Description
16195 withmarginpar reserve place on page for margins.
16199 \begin_layout Section
16203 \begin_layout Standard
16208 provides an alternative to the standard
16213 It provides similar functionality, but you might prefer this layout with
16214 sans serif sections, headings, and more.
16217 \begin_layout Section
16218 Rev\SpecialChar TeX
16222 \begin_layout Standard
16228 \begin_layout Standard
16229 \begin_inset VSpace bigskip
16235 \begin_layout Standard
16240 \begin_inset space ~
16245 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16247 \begin_inset Formula $\beta$
16250 release of May, 1999) class.
16253 \begin_layout Standard
16259 textclass, which works with Rev\SpecialChar TeX
16261 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16263 That means that it doesn't interact very well with \SpecialChar LyX
16264 , which requires \SpecialChar LaTeX2e
16266 it has been kludged to work.
16267 Since Rev\SpecialChar TeX
16268 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16273 Rev\SpecialChar TeX
16275 \begin_inset space ~
16280 textclass should also be pretty easy to use.
16283 \begin_layout Standard
16284 These documents are supposed to be used in
16288 to the Rev\SpecialChar TeX
16289 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16291 and assume you'll know what to put in the preamble if necessary.
16294 \begin_layout Subsection
16298 \begin_layout Standard
16299 All you need to do is install Rev\SpecialChar TeX
16300 4, as described in the package's README
16302 The package can be found at The Rev\SpecialChar TeX
16304 \begin_inset Flex URL
16307 \begin_layout Plain Layout
16309 http://publish.aps.org/revtex4/
16315 Install it somewhere that \SpecialChar LaTeX
16317 Test it by trying to \SpecialChar LaTeX
16318 a short Rev\SpecialChar TeX
16319 4 document in some random directory (i.
16320 \begin_inset space \thinspace{}
16324 \begin_inset space \space{}
16327 not the directory where you installed the class file.) Then, if you reconfigure
16329 , it will find the class file and let you use the Rev\SpecialChar TeX
16333 \begin_layout Standard
16334 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16343 \begin_inset space ~
16348 template, found in the templates directory.
16351 \begin_layout Subsection
16355 \begin_layout Standard
16356 Optional arguments to
16363 \begin_inset Quotes eld
16367 \begin_inset Quotes erd
16371 \begin_inset Quotes eld
16375 \begin_inset Quotes erd
16381 \begin_inset space ~
16389 \begin_inset space ~
16395 Remember that in Rev\SpecialChar TeX
16396 , at least one optional argument is required!
16399 \begin_layout Standard
16400 Other preamble matter, like
16407 \begin_inset space ~
16414 \begin_inset space ~
16419 dialog, also as usual.
16422 \begin_layout Subsection
16426 \begin_layout Standard
16427 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16429 For example, the Email layout corresponds to
16436 Note that (at least as of Rev\SpecialChar TeX
16445 layouts are exactly equivalent, so you shouldn't need to use both.
16449 \begin_layout Plain Layout
16450 In case you're curious, both were included so that
16454 would be able to translate both
16474 \begin_layout Subsection
16478 \begin_layout Standard
16479 There are a couple of important unique aspects of Rev\SpecialChar TeX
16480 4 which might cause
16481 bugs that will be even more confusing in \SpecialChar LyX
16485 \begin_layout Standard
16486 In Rev\SpecialChar TeX
16504 The \SpecialChar LyX
16505 equivalent is that there is a separate Thanks layout.
16510 write footnotes in the
16514 layout, or weird things may happen.
16515 See the Rev\SpecialChar TeX
16516 4 documentation for more details.
16519 \begin_layout Standard
16523 \begin_inset space ~
16531 \begin_inset space ~
16540 layouts must be placed
16548 layout and the corresponding
16565 , the \SpecialChar LaTeX
16569 \begin_layout Subsection
16573 \begin_layout Standard
16574 The main problem with this layout is that you can't use the optional arguments
16575 to layouts like Email and Title.
16576 (The problem is not unique to this layout; you can't use optional arguments
16577 to the Section layouts either.) This means that after you export that file
16578 to \SpecialChar LaTeX
16579 (which you'll need to do eventually to send it in to APS), you'll need
16580 to edit the \SpecialChar LaTeX
16581 file with a text editor to add the optional arguments to set,
16583 \begin_inset space \thinspace{}
16587 \begin_inset space \space{}
16590 the running title for the page headers.
16591 Lacking these layouts makes the
16597 (and the equivalent
16603 ) useless, so the corresponding layouts don't exist, and will have to be
16608 \begin_layout Plain Layout
16613 actually, \SpecialChar LyX
16614 1.3.0 supports some forms of optional arguments, but this layout
16615 has not been updated yet to take advantage of it.
16623 \begin_layout Section
16624 Springer Journals (
16631 \begin_layout Standard
16637 \begin_layout Subsection
16641 \begin_layout Standard
16642 These are the layout files for some of the journal formats used by Springer
16643 Verlag and listed on
16644 \begin_inset Flex URL
16647 \begin_layout Plain Layout
16649 http://www.springer.de/author/tex/help-journals.html
16654 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16656 It is a modular system: the things common to all journals are implemented
16661 , which journal-specific layout files (such as, e.
16662 \begin_inset space \thinspace{}
16666 \begin_inset space \space{}
16673 for Journal of Geodesy) can include.
16676 \begin_layout Standard
16677 This means that implementing support for any other Springer journal on this
16678 list is as simple as writing your own
16686 file following the outline given in
16694 \begin_layout Standard
16695 It is reasonably well tested only for the Journal of Geodesy.
16704 come with the standard \SpecialChar LyX
16706 Install the relevant class file (downloaded from Springer) in a proper
16707 directory, reconfigure \SpecialChar LaTeX
16708 (in the te\SpecialChar TeX
16713 , as root if necessary — doesn't \SpecialChar LyX
16714 take care of this?), reconfigure \SpecialChar LyX
16719 \begin_layout Subsection
16723 \begin_layout Standard
16724 A large number of theorem-like styles —
16736 \begin_layout Standard
16739 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16740 _Title, Author_Running, Institute,
16741 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16744 See the Springer class file documentation for details.
16747 \begin_layout Subsection
16751 \begin_layout Itemize
16763 \begin_layout Itemize
16766 Probability Theory and Related Fields
16772 — Jean-Marc Lasgouttes
16775 \begin_layout Standard
16776 Add your own, it isn't so hard!
16779 \begin_layout Subsection
16783 \begin_layout Standard
16784 These files are partly based on the older
16788 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16790 file from Springer.
16795 layout, are now defunct.
16796 Jean-Marc Lasgouttes helped out big in making me find my way around the
16798 layout file mechanism.
16801 \begin_layout Subsection
16805 \begin_layout Standard
16807 But probably less than in the old hacked-\SpecialChar LaTeX
16815 \begin_layout Standard
16817 \begin_inset space \thinspace{}
16820 g.: does not display the number for theorem-like layouts, just #.
16823 \begin_layout Section
16826 Sli\SpecialChar TeX
16830 \begin_inset CommandInset label
16839 \begin_layout Standard
16847 \begin_layout Subsection
16851 \begin_layout Standard
16852 This section describes how to use \SpecialChar LyX
16853 to make slides for overhead projectors.
16854 There are two document classes that can do this: the default slides class
16857 Foil\SpecialChar TeX
16861 This section documents the former.
16864 \begin_layout Standard
16865 I'm going to say this again, nice and clear, so that there's no misunderstanding
16869 \begin_layout Standard
16870 \begin_inset VSpace bigskip
16876 \begin_layout Standard
16880 This section documents the class
16881 \begin_inset Quotes eld
16889 \begin_inset Quotes erd
16897 \begin_layout Standard
16898 \begin_inset VSpace bigskip
16904 \begin_layout Standard
16905 If you're looking for the documentation for
16906 \begin_inset Quotes eld
16911 slides (Foil\SpecialChar TeX
16915 \begin_inset Quotes erd
16918 , check out section
16919 \begin_inset space ~
16923 \begin_inset CommandInset ref
16925 reference "sec:foiltex"
16935 \begin_inset Quotes eld
16940 slides (Foil\SpecialChar TeX
16944 \begin_inset Quotes erd
16947 ] is actually somewhat better than the default
16955 \begin_layout Plain Layout
16957 or so I've been told repeatedly by its advocates.
16958 Having never used it, I have no idea if this claim is true or not.
16963 which this section documents.
16966 \begin_layout Standard
16967 This class is the \SpecialChar LaTeX2e
16968 improvement of the old
16970 Sli\SpecialChar TeX
16974 Every \SpecialChar LaTeX2e
16975 distribution includes this class [which I'll just refer to as
16976 \begin_inset Quotes eld
16984 \begin_inset Quotes erd
16987 from now on], so you're bound to have it.
16988 As I noted earlier, there are other classes, such as
16992 , which also produce slides for overhead projectors and do a better job
16994 However, there are some things which
16998 can do which the others can't, such as generate overlays.
16999 Read on to learn more!
17002 \begin_layout Subsection
17004 \begin_inset CommandInset label
17006 name "sec:slidesetup"
17013 \begin_layout Standard
17014 Obviously, to use this document class, you need to select
17015 \begin_inset Quotes eld
17023 \begin_inset Quotes erd
17026 from the class list in the
17028 Document\SpecialChar menuseparator
17032 There are some other special things you should know about this class:
17035 \begin_layout Itemize
17036 Don't bother changing the options
17041 They're not supported by the
17048 \begin_layout Itemize
17052 \begin_inset space ~
17057 behaves a bit differently for this class.
17058 The possible choices and what they do are as follows:
17062 \begin_layout Description
17067 The final output contains page numbers in the lower right corner.
17070 \begin_layout Description
17079 , but also prints out any time markers you've put in.
17080 This is the default.
17083 \begin_layout Description
17088 The final output contains no page numbers, time markers, or alignment markers.
17092 \begin_layout Itemize
17097 class has an extra option:
17103 \begin_inset Quotes eld
17111 \begin_inset Quotes erd
17114 in the extra class options.
17118 \begin_layout Standard
17119 Using this options allows you to add time markers to
17125 \begin_inset space ~
17129 \begin_inset CommandInset ref
17131 reference "sec:slideNote"
17139 \begin_layout Standard
17140 You can also use the template file
17141 \begin_inset Quotes eld
17149 \begin_inset Quotes erd
17152 to automatically set up a document to use the
17158 File\SpecialChar menuseparator
17160 \begin_inset space ~
17164 \begin_inset space ~
17169 to open your new document].
17170 The template file also contains some examples of the special paragraph
17171 environments used by this class.
17172 I'll describe those next.
17175 \begin_layout Subsection
17176 Paragraph Environments
17179 \begin_layout Subsubsection
17180 Supported Environments
17183 \begin_layout Standard
17184 The first thing you'll notice when you start up a new
17188 document is the font size and type: it's the equivalent of the size
17189 \begin_inset Quotes eld
17197 \begin_inset Quotes erd
17203 \begin_inset space ~
17209 This is also what's used in the output.
17211 \begin_inset Quotes eld
17215 \begin_inset Quotes erd
17218 to remind you that this is a slide.
17219 Your final slides will use a larger font; ergo, you'll have less space.
17220 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17223 \begin_layout Standard
17224 The next thing that becomes obvious is the changes to the paragraph environment
17225 pull-down box [at the far-left end of the toolbar].
17226 Most of the paragraph environments you're used to seeing are missing.
17227 There are also five new ones.
17232 class itself only supports certain paragraph environments:
17235 \begin_layout Itemize
17241 \begin_layout Itemize
17247 \begin_layout Itemize
17253 \begin_layout Itemize
17259 \begin_layout Itemize
17265 \begin_layout Itemize
17271 \begin_layout Itemize
17277 \begin_layout Itemize
17283 \begin_layout Itemize
17289 \begin_layout Itemize
17296 \begin_layout Itemize
17302 \begin_layout Standard
17303 All of the other standard environments, including the section-heading environmen
17304 ts, aren't used in the
17311 \begin_layout Standard
17312 On the other hand, you'll notice the following new environments:
17315 \begin_layout Itemize
17321 \begin_layout Itemize
17327 \begin_layout Itemize
17333 \begin_layout Itemize
17339 \begin_layout Itemize
17345 \begin_layout Standard
17346 These five are kind of quirky, due to a
17347 \begin_inset Quotes eld
17351 \begin_inset Quotes erd
17354 in \SpecialChar LyX
17356 You see, \SpecialChar LyX
17357 doesn't permit you to nest any other paragraph environment into
17358 an empty environment.
17359 Now, that's fine and dandy, but it means that you wouldn't be able to start
17360 a slide with anything except plain text.
17361 To deal with this, I've performed a little
17362 \begin_inset Quotes eld
17367 \begin_inset Quotes erd
17373 \begin_layout Subsubsection
17374 Quirks of the New Environments
17375 \begin_inset CommandInset label
17377 name "sec:slideQuirk"
17384 \begin_layout Standard
17385 All five of the new paragraph environments are somewhat quirky due to inherent
17386 limitiations in the current version of \SpecialChar LyX
17388 As I just mentioned, \SpecialChar LyX
17389 forbids environments that begin with another environment.
17390 To get around this, the
17394 environment isn't a paragraph environment as described in the
17402 \begin_layout Standard
17403 You should consider
17416 \begin_inset Quotes eld
17419 pseudo-environments.
17420 \begin_inset Quotes erd
17423 They look like a section heading or a
17424 \begin_inset Quotes eld
17432 \begin_inset Quotes erd
17435 but really begin a [and, if necessary, end the previous] paragraph environment.
17445 \begin_inset Quotes eld
17449 \begin_inset Quotes erd
17452 These two perform some action.
17455 \begin_layout Standard
17456 A common feature of all five environments,
17476 , is a rather long-ish label.
17477 The text following this label — ordinarily the contents of the paragraph
17478 environment — is utterly irrelevant for
17500 completely ignores it.
17501 In fact, you can leave these five environments completely empty.
17505 \begin_layout Standard
17510 to put any text after the rather long-ish label, you might want to.
17511 This could be a short description of the contents of the
17516 In that case, enter your descriptive comment and hit
17520 as you normally would.
17523 \begin_layout Standard
17524 If, on the other hand, you don't want to enter any descriptive text, you'll
17525 hit another \SpecialChar LyX
17528 , like nature, abhors a vacuum, and will not let you start a new paragraph
17529 environment until you put something in the old one.
17533 \begin_layout Itemize
17534 Start entering the text that will
17562 \begin_layout Itemize
17563 Now move to the beginning of that paragraph.
17567 \begin_layout Itemize
17576 \begin_layout Itemize
17577 Finally, change this new, empty paragraph to a
17601 \begin_layout Standard
17602 Some future version of \SpecialChar LyX
17603 will, hopefully, resolve this quirkiness\SpecialChar ldots
17607 \begin_layout Subsection
17608 Making a Presentation with
17621 \begin_layout Subsubsection
17629 \begin_layout Standard
17630 If you're expecting this section to teach you how to actually make a presentatio
17631 n, you'll be sorely disappointed.
17632 Naturally, I'll describe all of the ways the
17636 class can assist you in preparing the materials for a presentation.
17637 Filling in the contents, however, is up to you.
17642 the \SpecialChar LyX
17646 \begin_layout Standard
17651 environment [in the manner described in section
17652 \begin_inset space ~
17656 \begin_inset CommandInset ref
17658 reference "sec:slideQuirk"
17662 ] tells \SpecialChar LyX
17663 to begin a new slide [duh].
17664 The label for this environment/
17665 \begin_inset Quotes erd
17669 \begin_inset Quotes erd
17673 \begin_inset Quotes eld
17677 \begin_inset Quotes erd
17680 in cool blue, followed by the label,
17681 \begin_inset Quotes eld
17685 \begin_inset Quotes erd
17689 Any text or paragraph environments that follow this one go on the new slide.
17693 \begin_layout Standard
17694 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17696 (this can be specified in the
17701 In fact, you'll want to, once you finish entering the contents of one slide.
17702 If you've entered more text than can physically fit on a slide, the extra
17703 overflows onto a new slide.
17704 I don't recommend doing this, however, since the overflow slide won't have
17705 any page number on it.
17706 Furthermore, it may interfere with any
17710 you've made to accompany the oversized
17717 \begin_layout Standard
17726 environments work the same way as the
17731 They both create an
17732 \begin_inset Quotes eld
17736 \begin_inset Quotes erd
17739 followed by a label [
17740 \begin_inset Quotes eld
17744 \begin_inset Quotes erd
17748 \begin_inset Quotes eld
17752 \begin_inset Quotes erd
17756 The color is a stunning magenta instead of blue, and the
17757 \begin_inset Quotes eld
17761 \begin_inset Quotes erd
17764 will look different, in style and in length.
17765 The label fonts of all three also differ from one another.
17768 \begin_layout Standard
17773 , if the contents of a
17781 exceed the physical size of a slide or sheet of paper, the extra will overflow
17783 Again, you should avoid this.
17784 It defeats the whole purpose of
17795 \begin_layout Subsubsection
17805 \begin_layout Standard
17810 is a slide that sits atop another slide.
17811 Perhaps you wish to discuss a figure on the main
17815 before displaying the text associated with it.
17816 One way to accomplish this is tape a flap of dark paper over the part of
17821 you want to display later.
17822 This method fails, however, if you wish to overlap one graph with another,
17824 You would then have to fumble while speaking to align the two separate,
17829 s to align the two graphs.
17834 environment in both cases makes life much easier.
17837 \begin_layout Standard
17842 receives the page number of its
17843 \begin_inset Quotes eld
17847 \begin_inset Quotes erd
17855 \begin_inset Quotes eld
17863 \begin_inset Quotes erd
17870 \begin_layout Plain Layout
17871 Presumably, mutliple
17876 \begin_inset Quotes eld
17884 \begin_inset Quotes erd
17888 \begin_inset Quotes eld
17896 \begin_inset Quotes erd
17900 \begin_inset Quotes eld
17908 \begin_inset Quotes erd
17912 \begin_inset space ~
17915 appended to the page number of the parent
17925 Clearly, you want the contents of both the
17933 to each fit on a single physical slide! You should probably consider an
17939 \begin_inset Quotes eld
17943 \begin_inset Quotes erd
17951 Indeed, the \SpecialChar LyX
17956 class provides a visual cue for this: the label at the start of an
17960 is shorter than that at the start of a
17965 Lastly, when you generate printable output, you'll find alignment markers
17966 in all four corners of both the
17970 page and its parent
17975 These will assist you in lining up the two physical slides.
17978 \begin_layout Standard
17979 The major problem in overlaying two slides is aligning the contents of the
17980 two transparencies.
17981 How much space should you leave for that graph on the second slide? Worse
17982 still, what if you want a graph and a sentence on second slide, but there
17983 is text on the main transparency that goes in between them? You could try
17984 and insert vertical space of the right size.
17985 The better way is to use
17996 \begin_layout Standard
17997 As their names imply,
18005 are two command-like paragraph environments that make all subsequent text
18006 invisible and visible, respectively.
18008 \begin_inset space ~
18012 \begin_inset CommandInset ref
18014 reference "sec:slideQuirk"
18018 that you don't place anything
18022 these two environments, however.
18027 , it inserts a centered, sky-blue label into the page reading
18028 \begin_inset Quotes eld
18031 <Invisible Text Follows>
18032 \begin_inset Quotes erd
18036 For paragraphs following this label, the parts of the
18044 ; it doesn't matter which] where they would be contain instead blank space.
18048 \begin_layout Standard
18053 , the corresponding centered label is
18054 \begin_inset Quotes eld
18057 <Visible Text Follows>
18058 \begin_inset Quotes erd
18062 Paragraphs following this label behave normally.
18063 Note that the beginning of a new
18075 automatically shuts off an
18080 It's therefore not necessary to use
18091 \begin_layout Standard
18092 By now, it should be obvious how to create overlay transparencies using
18093 the proper combination of
18112 \begin_layout Enumerate
18117 , including everything that will appear on it, whether on the main slide
18125 \begin_layout Enumerate
18126 Before each figure or paragraph that will appear only on the
18135 If necessary, insert a
18139 environment after the
18146 \begin_layout Enumerate
18151 immediately following the
18158 \begin_layout Enumerate
18159 Copy the contents of this
18170 \begin_layout Enumerate
18175 , change all of the
18186 \begin_layout Standard
18188 You've just made an
18195 \begin_layout Standard
18196 There's one problem with the way I've designed the \SpecialChar LyX
18201 class: you can't make text in the middle of a paragraph invisible, nor
18202 make text in the middle of an invisible paragraph visible again.
18203 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18208 \begin_layout Plain Layout
18209 The commands of interest are:
18212 \begin_layout Itemize
18217 invisible \SpecialChar ldots
18221 \begin_layout Itemize
18226 visible \SpecialChar ldots
18230 \begin_layout Plain Layout
18232 and need to be marked as \SpecialChar TeX
18235 \begin_inset Quotes eld
18239 \begin_inset Quotes erd
18242 you wish to change goes in between the brackets [and after the
18255 If you don't know how to mark text as \SpecialChar TeX
18256 , see the appropriate section of
18269 \begin_layout Subsubsection
18279 \begin_inset CommandInset label
18281 name "sec:slideNote"
18288 \begin_layout Standard
18297 is associated with a
18298 \begin_inset Quotes eld
18302 \begin_inset Quotes erd
18310 Here, too, the \SpecialChar LyX
18315 class provides visual cues.
18320 is shorter than that of a
18324 [yet longer than that of an
18328 ] and, like the label of an
18332 is shockingly magenta.
18333 Additionally, the printed
18337 has the page number of its
18338 \begin_inset Quotes eld
18342 \begin_inset Quotes erd
18350 \begin_inset Quotes eld
18358 \begin_inset Quotes erd
18362 \begin_inset Quotes eld
18370 \begin_inset Quotes erd
18374 \begin_inset Quotes eld
18382 \begin_inset Quotes erd
18386 You can have multiple
18390 s associated with a single
18402 , you'll probably want to break up long
18406 s so that they fit on a single sheet of paper.
18409 \begin_layout Standard
18414 is obvious: it contains anything additional you might want to say about
18420 It could also be used as a sheet of reminders for a particular
18425 In the case of the latter, you might want to make use of time markers.
18426 Currently, the \SpecialChar LyX
18432 \begin_inset Quotes eld
18436 \begin_inset Quotes erd
18439 support for time markers, a
18441 Sli\SpecialChar TeX
18445 So, you'll have to resort to using the \SpecialChar LaTeX
18449 \begin_layout Standard
18450 To use time markers, you'll need to specify the extra class option
18451 \begin_inset Quotes eld
18459 \begin_inset Quotes erd
18463 \begin_inset space ~
18467 \begin_inset CommandInset ref
18469 reference "sec:slidesetup"
18474 This option turns on timing marks, which will appear in the lower-left-hand
18480 To set what appears in the time marker, you use the \SpecialChar LaTeX
18482 \begin_inset Quotes eld
18492 \begin_inset Quotes erd
18496 \begin_inset Quotes eld
18506 \begin_inset Quotes erd
18510 The arguments of both commands are time measured in seconds.
18512 \begin_inset Quotes eld
18522 \begin_inset Quotes erd
18525 sets the time marker to a given time.
18527 \begin_inset Quotes eld
18537 \begin_inset Quotes erd
18540 increments the time marker by the specified amount.
18541 Using time markers and
18545 s in this fashion, you can remind yourself how much time to spend on a particula
18553 \begin_layout Standard
18554 There's one last feature to describe.
18555 Clearly, you'd like to print out all of your
18563 s on transparencies while printing all of your
18580 with which it is associated.
18581 What's a person to do?
18584 \begin_layout Standard
18585 Luckily, there are two \SpecialChar LaTeX
18586 commands that allow you to select what to print
18588 Both must be placed into the preamble of your document.
18590 \begin_inset Quotes eld
18602 \begin_inset Quotes erd
18605 will cause the output to contain only the
18614 Correspondingly, the command
18615 \begin_inset Quotes eld
18627 \begin_inset Quotes erd
18630 prevents the output of anything but
18635 I'd advise placing both commands in the preamble and initially comment
18637 You can then preview your entire presentation as you write.
18638 When you're done writing, you can then uncomment one of the two to select
18639 what you want to print.
18640 I like to uncomment
18641 \begin_inset Quotes eld
18653 \begin_inset Quotes erd
18656 , print to a file with
18657 \begin_inset Quotes eld
18665 \begin_inset Quotes erd
18668 in its name, comment it back out, then uncomment
18669 \begin_inset Quotes eld
18681 \begin_inset Quotes erd
18685 \begin_inset Quotes eld
18693 \begin_inset Quotes erd
18697 I can then send either file to a printer, loading transparencies or plain
18698 paper as appropriate.
18701 \begin_layout Standard
18702 You can also provide other arguments to the
18703 \begin_inset Quotes eld
18713 \begin_inset Quotes erd
18717 \begin_inset Quotes eld
18727 \begin_inset Quotes erd
18731 See a good \SpecialChar LaTeX
18735 \begin_layout Subsection
18740 Class Template File
18743 \begin_layout Standard
18744 I have also provided a template file,
18745 \begin_inset Quotes eld
18753 \begin_inset Quotes erd
18761 To use it, begin your new presentation with
18763 File\SpecialChar menuseparator
18765 \begin_inset space ~
18769 \begin_inset space ~
18775 Your new \SpecialChar LyX
18776 presentation file will contain an example
18797 additionally contain an example of the use of
18806 Lastly, the preamble will contain:
18809 \begin_layout LyX-Code
18810 % Uncomment to print out only slides and overlays
18813 \begin_layout LyX-Code
18817 \begin_layout LyX-Code
18823 \begin_inset Newline newline
18829 \begin_layout LyX-Code
18830 % Uncomment to print out only notes
18833 \begin_layout LyX-Code
18837 \begin_layout LyX-Code
18845 \begin_layout Standard
18846 One final thing: I created this class to support the \SpecialChar LaTeX2e
18848 \begin_inset Quotes eld
18853 Sli\SpecialChar TeX
18857 \begin_inset Quotes erd
18860 class, one of the built-in \SpecialChar LaTeX2e
18862 Neither I nor the rest of the \SpecialChar LyX
18863 Team endorse or oppose the use of this built-in
18865 It's here if you want it or need it.
18866 There exist other \SpecialChar LaTeX2e
18867 classes for creating presentations, such as the
18872 \begin_inset space ~
18876 \begin_inset CommandInset ref
18878 reference "sec:foiltex"
18883 \begin_inset Quotes eld
18891 \begin_inset Quotes erd
18894 package [present on some \SpecialChar TeX
18896 The latter is not yet supported under \SpecialChar LyX
18901 \begin_layout Plain Layout
18902 Perhaps you can take on the task\SpecialChar ldots
18908 I know nothing about these other classes.
18909 Try them out to see what sort of alternative they provide.
18912 \begin_layout Chapter
18914 Features needing Extra Software
18917 \begin_layout Section
18918 Checking \SpecialChar TeX
18922 \begin_layout Standard
18928 \begin_layout Subsection
18932 \begin_layout Standard
18941 \begin_layout Plain Layout
18946 is not yet available when you are using the \SpecialChar LaTeX
18947 distribution MiK\SpecialChar TeX
18953 , you'll find in the
18960 \begin_inset space ~
18971 \begin_inset Newline newline
18975 \begin_inset CommandInset href
18977 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18985 \begin_layout Standard
18988 Chk\SpecialChar TeX
18991 package is a program that was written by
18992 \begin_inset Flex Noun
18995 \begin_layout Plain Layout
18997 \begin_inset space ~
19005 in frustration because some constructs in \SpecialChar LaTeX
19006 are sometimes non-intuitive,
19007 and easy to forget.
19008 The program runs over your \SpecialChar LaTeX
19009 file, checks the integrity of the file, and
19010 flags some common errors.
19011 In other technical words, it is
19015 for \SpecialChar LaTeX
19019 \begin_layout Standard
19020 Well, what is a syntax checker doing in \SpecialChar LyX
19021 which is supposed to produce correct
19023 anyways? The answer is simple: Just as
19027 not only checks the
19031 of C programs, but also does
19035 checks for type-errors,
19037 Chk\SpecialChar TeX
19040 catches some common
19044 errors, in addition to the syntactical ones.
19047 Chk\SpecialChar TeX
19050 is capable of detecting several common errors, such as
19053 \begin_layout Itemize
19054 Ellipsis detection:
19055 \begin_inset Newline newline
19058 Use \SpecialChar ldots
19062 \begin_layout Itemize
19063 No space in front of/after parenthesis:
19064 \begin_inset Newline newline
19070 \begin_layout Itemize
19071 Enforcement of normal space after common abbreviations:
19072 \begin_inset Newline newline
19076 \begin_inset space \thinspace{}
19080 \begin_inset space \space{}
19083 is too wide spacing.
19086 \begin_layout Itemize
19087 Enforcement of end-of-sentence space when the last sentence ends with a
19089 \begin_inset Newline newline
19093 And this is wrong spacing.
19096 \begin_layout Itemize
19097 Space in front of labels and similar commands:
19098 \begin_inset Newline newline
19101 The label should stick right up to the text to avoid falling to a wrong
19104 \begin_inset CommandInset label
19114 \begin_layout Plain Layout
19115 This footnote is in danger of falling off to a wrong page
19120 The label is separated too much.
19123 \begin_layout Itemize
19124 Space in front of references, instead of hard spaces:
19125 \begin_inset Newline newline
19128 If you have bad luck, the text will break right between the referenced text
19129 and reference number, and that's a pity.
19131 \begin_inset CommandInset ref
19133 reference "sec:chktex"
19140 \begin_layout Itemize
19142 \begin_inset Quotes eld
19146 \begin_inset Quotes erd
19150 \begin_inset Formula $\times$
19154 \begin_inset Newline newline
19157 2x2 looks cheap compared to
19158 \begin_inset Formula $2\times2$
19164 \begin_layout Standard
19165 and more \SpecialChar ldots
19166 It is an invaluable tool when you are
19167 \begin_inset Quotes eld
19171 \begin_inset Quotes erd
19174 your document before printing, and you should run it right after the obligatory
19175 spelling check, and before you go fine tuning the typesetting.
19178 \begin_layout Subsection
19182 \begin_layout Standard
19183 If you have the program installed, usage is as simple as choosing
19185 Tools\SpecialChar menuseparator
19187 \begin_inset space ~
19193 This will make \SpecialChar LyX
19194 generate a \SpecialChar LaTeX
19195 file of your document, start
19197 Chk\SpecialChar TeX
19200 to check it, and then make \SpecialChar LyX
19202 \begin_inset Quotes eld
19206 \begin_inset Quotes erd
19209 with the warnings from
19211 Chk\SpecialChar TeX
19214 , if there were any.
19215 The warnings will be placed close to the point of the mistake, and you
19216 can quickly find them by using the
19218 Navigate\SpecialChar menuseparator
19221 menu item, or the shortcut key
19230 Open the error boxes by clicking on them with the mouse, or use the shortcut
19239 bindings, or the corresponding
19248 Read the warning and correct the mistake, if it is a mistake.
19249 If you have trouble understanding what the warning is about, you can safely
19251 Remember that there is a hidden layer between the document on screen and
19252 the technical details in invoking
19254 Chk\SpecialChar TeX
19257 , and this gap can make some warnings seem arcane or just plain silly.
19260 \begin_layout Standard
19261 This document is an excellent testing bed for the feature, and it should
19262 provide quite a few warnings for you to fiddle with.
19263 Since computers are only so smart, expect most of the warnings to be false
19267 \begin_layout Subsection
19268 How to fine tune it
19271 \begin_layout Standard
19272 Sometimes, you'll find that
19274 Chk\SpecialChar TeX
19277 makes more noise than suits your mood.
19278 Then you can choose not to use it, wait until your mood changes, or try
19281 Chk\SpecialChar TeX
19284 to get better along with you.
19287 \begin_layout Standard
19290 Chk\SpecialChar TeX
19297 very configurable and extensible, you should not expect to solve all problems
19300 Chk\SpecialChar TeX
19303 in \SpecialChar LyX
19305 Since \SpecialChar LyX
19306 has to generate a somewhat special \SpecialChar LaTeX
19307 file to be able to match the
19308 line numbers from the
19310 Chk\SpecialChar TeX
19317 \begin_layout Plain Layout
19318 You can inspect the specific output from
19324 Document\SpecialChar menuseparator
19327 \begin_inset space ~
19341 to the internal document structure, some of the warnings will not appear
19343 There are two things you can do about this:
19346 \begin_layout Itemize
19349 Chk\SpecialChar TeX
19352 invocation command line in
19353 \begin_inset Flex Noun
19356 \begin_layout Plain Layout
19357 Tools\SpecialChar menuseparator
19358 Preferences\SpecialChar menuseparator
19359 Output\SpecialChar menuseparator
19360 LaTeX\SpecialChar menuseparator
19368 Chk\SpecialChar TeX
19371 installation configuration file (usually with the file
19376 See below to learn what warnings can be enabled and disabled on the command
19380 \begin_layout Itemize
19381 Export your document as a raw \SpecialChar LaTeX
19384 File\SpecialChar menuseparator
19385 Export\SpecialChar menuseparator
19394 Invoked in this way, it can be a hassle to find the corresponding place
19395 in the document inside \SpecialChar LyX
19396 , but with a little patience, you should be able
19400 \begin_layout Standard
19401 Here follows the warning messages that can be enabled and disabled in
19410 to disable a warning, and
19414 to enable a warning.
19415 The emphasized entries are disabled by default, because the default is
19418 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19423 \begin_layout Standard
19424 Notice that you should only use the options that enable and disable warnings,
19425 because \SpecialChar LyX
19426 relies on some of the other command line parameters to be set
19427 in a specific way to have a chance to communicate with
19434 \begin_layout Enumerate
19438 Command terminated with space.
19441 \begin_layout Enumerate
19444 Non-breaking space (
19445 \begin_inset Quotes eld
19453 \begin_inset Quotes erd
19456 ) should have been used.
19459 \begin_layout Enumerate
19463 You should enclose the previous parenthesis with
19464 \begin_inset Quotes eld
19472 \begin_inset Quotes erd
19478 \begin_layout Enumerate
19481 Italic correction (
19482 \begin_inset Quotes eld
19492 \begin_inset Quotes erd
19495 ) found in non-italic buffer.
19498 \begin_layout Enumerate
19501 Italic correction (
19502 \begin_inset Quotes eld
19512 \begin_inset Quotes erd
19515 ) found more than once.
19518 \begin_layout Enumerate
19522 No italic correction (
19523 \begin_inset Quotes eld
19533 \begin_inset Quotes erd
19539 \begin_layout Enumerate
19543 \begin_inset Quotes eld
19551 \begin_inset Quotes erd
19555 \begin_inset Quotes eld
19563 \begin_inset Quotes erd
19569 \begin_layout Enumerate
19572 Wrong length of dash may have been used.
19575 \begin_layout Enumerate
19579 \begin_inset Quotes eld
19587 \begin_inset Quotes erd
19591 \begin_inset Quotes eld
19599 \begin_inset Quotes erd
19605 \begin_layout Enumerate
19609 \begin_inset Quotes eld
19617 \begin_inset Quotes erd
19623 \begin_layout Enumerate
19627 \begin_inset Quotes eld
19635 \begin_inset Quotes erd
19638 to achieve an ellipsis.
19641 \begin_layout Enumerate
19644 Inter-word spacing (
19645 \begin_inset Quotes eld
19655 \begin_inset Quotes eld
19658 ) should perhaps be used.
19661 \begin_layout Enumerate
19664 Inter-sentence spacing (
19665 \begin_inset Quotes eld
19675 \begin_inset Quotes erd
19678 ) should perhaps be used.
19681 \begin_layout Enumerate
19684 Could not find argument for command.
19687 \begin_layout Enumerate
19691 \begin_inset Quotes eld
19699 \begin_inset Quotes erd
19705 \begin_layout Enumerate
19708 Math mode still on at end of \SpecialChar LaTeX
19712 \begin_layout Enumerate
19716 \begin_inset Quotes eld
19724 \begin_inset Quotes erd
19727 doesn't match the number of
19728 \begin_inset Quotes eld
19736 \begin_inset Quotes erd
19742 \begin_layout Enumerate
19745 You should use either
19748 \begin_inset Quotes eld
19756 \begin_inset Quotes erd
19761 as an alternative to
19762 \begin_inset Quotes eld
19770 \begin_inset Quotes erd
19776 \begin_layout Enumerate
19783 " (ASCII 39) instead of "
19790 \begin_layout Enumerate
19793 User-specified pattern found.
19796 \begin_layout Enumerate
19799 This command might not be intended.
19802 \begin_layout Enumerate
19809 \begin_layout Enumerate
19827 \begin_layout Enumerate
19830 Delete this space to maintain correct page references.
19833 \begin_layout Enumerate
19837 You might wish to put this between a pair of
19838 \begin_inset Quotes eld
19846 \begin_inset Quotes erd
19852 \begin_layout Enumerate
19855 You ought to remove spaces in front of punctuation.
19858 \begin_layout Enumerate
19861 Could not execute \SpecialChar LaTeX
19865 \begin_layout Enumerate
19874 in front of small punctuation.
19877 \begin_layout Enumerate
19885 may look prettier here.
19888 \begin_layout Enumerate
19892 Multiple spaces detected in output.
19895 \begin_layout Enumerate
19898 This text may be ignored.
19901 \begin_layout Enumerate
19907 \begin_inset Quotes eld
19912 to begin quotation, not
19919 \begin_layout Enumerate
19926 to end quotation, not
19929 \begin_inset Quotes eld
19937 \begin_layout Enumerate
19943 \begin_layout Enumerate
19946 You should perhaps use
19947 \begin_inset Quotes eld
19955 \begin_inset Quotes erd
19961 \begin_layout Enumerate
19964 You should put a space in front of/after parenthesis.
19967 \begin_layout Enumerate
19970 You should avoid spaces in front of/after parenthesis.
19973 \begin_layout Enumerate
19977 You should not use punctuation in front of/after quotes.
19980 \begin_layout Enumerate
19983 Double space found.
19986 \begin_layout Enumerate
19989 You should put punctuation outside inner/inside display math mode.
19992 \begin_layout Enumerate
19995 You ought to not use primitive \SpecialChar TeX
19996 in \SpecialChar LaTeX
20000 \begin_layout Enumerate
20003 You should remove spaces in front of
20004 \begin_inset Quotes eld
20012 \begin_inset Quotes erd
20018 \begin_layout Enumerate
20021 \begin_inset Quotes eld
20029 \begin_inset Quotes erd
20032 is normally not followed by
20033 \begin_inset Quotes eld
20041 \begin_inset Quotes erd
20047 \begin_layout Standard
20048 In later versions of \SpecialChar LyX
20049 , we hope to provide a more complete interface to this
20050 tool (and it's smaller cousin
20054 ) to exploit the full power of it.
20055 But it's not exactly useless as it is now: go try it on one of your existing
20056 documents of a certain length and be surprised.
20059 \begin_layout Section
20060 Version Control in \SpecialChar LyX
20064 \begin_layout Standard
20067 Lars Gullik Bjønnes
20074 \begin_layout Subsection
20078 \begin_layout Standard
20080 supports some of the most basic RCS/CVS/SVN/GIT commands.
20081 If you need something a bit more sophisticated you will have to do that
20082 manually in a terminal.
20085 \begin_layout Standard
20086 Also note that CVS support is not as good as subversion support so we advise
20088 A good place to start learning Subversion is SVN Book
20092 \begin_layout Plain Layout
20093 \begin_inset CommandInset href
20095 target "http://svnbook.red-bean.com/"
20106 In the case of RCS you should read
20107 \begin_inset Quotes eld
20111 \begin_inset Quotes erd
20114 (a man file, read it with
20119 This file describes all the basic features of RCS.
20120 You should especially notice the comment about a RCS directory, and the
20121 notion of a master RCS file (the file ending in
20128 \begin_layout Standard
20129 Before you begin to use the version control features in \SpecialChar LyX
20131 familiar with RCS/CVS/SVN/GIT usage.
20132 The implementation in \SpecialChar LyX
20133 assumes a recent version of the GNU RCS or CVS/SVN
20134 package — no guarantees are made for older versions.
20135 Most of the log messages are not currently displayed after operations —
20136 you can check them in the Messages pane if unsure.
20137 Regular users of version control will appreciate VC toolbar, which can
20140 View\SpecialChar menuseparator
20141 Toolbars\SpecialChar menuseparator
20143 \begin_inset space ~
20151 \begin_layout Standard
20152 For introducing your own external commands consult vc-command in the manual
20153 of \SpecialChar LyX
20157 \begin_layout Standard
20158 It is strongly recommended to store documents in uncompressed format if
20159 using version control (uncheck
20161 Document\SpecialChar menuseparator
20164 if it is checked): Uncompressed LyX documents are text files and therefore
20165 for merging two different versions by version control systems.
20166 Compressed LyX documents are binary files, which cannot be merged by version
20170 \begin_layout Subsection
20171 RCS commands in \SpecialChar LyX
20175 \begin_layout Standard
20176 The following sections describe the RCS commands supported by \SpecialChar LyX
20178 You can find them in the
20180 File\SpecialChar menuseparator
20182 \begin_inset space ~
20189 was tested against RCS 5.7/5.8.
20192 \begin_layout Subsubsection
20198 \begin_layout Standard
20199 If your document is not under revision control, this is the only item shown
20201 And if it is under revision control, the
20205 item is not visible.
20209 \begin_layout Standard
20210 This command registers your document with RCS (unless you are under the
20211 directory managed by CVS)\SpecialChar endofsentence
20212 You are asked interactively to supply an initial
20213 description of the document.
20214 The document is now set in Read-Only mode and you have to
20217 \begin_inset space ~
20221 \begin_inset space ~
20225 \begin_inset space ~
20230 , before making any changes to it.
20231 A document under revision control has a
20232 \begin_inset Quotes eld
20235 [RCS:<version> <locker>]
20236 \begin_inset Quotes erd
20239 item tagged to the filename in the minibuffer.
20242 \begin_layout Standard
20243 RCS command that is run:
20245 ci -q -u -i -t-"<initial description>" <file-name>
20248 \begin_layout Standard
20253 to understand the switches.
20257 \begin_layout Subsubsection
20263 \begin_layout Standard
20264 When you are finished editing a file, you check in your changes.
20265 When you do this, you are asked for a description of the changes.
20266 This is stored in the history log.
20267 The version number is bumped, your changes are applied to the master RCS
20268 file, the document is unlocked and set to Read-Only mode.
20271 \begin_layout Standard
20274 ci -q -u -m"<description>" <file-name>
20277 \begin_layout Subsubsection
20283 \begin_layout Standard
20284 By doing this you lock the document so that only you can edit it.
20285 This will also make the document Read-Write only for you.
20286 You will usually continue editing for a while and when you are finished
20287 you check in your changes.
20288 The status line is changed to reflect that you have locked the file.
20291 \begin_layout Standard
20294 co -q -l <file-name>
20297 \begin_layout Subsubsection
20300 Revert To Repository Version
20303 \begin_layout Standard
20304 This will discard all changes made to the document since the last check
20306 You get a warning before changes are discarded.
20309 \begin_layout Standard
20312 co -f -u<version> <file-name>
20315 \begin_layout Subsubsection
20321 \begin_layout Standard
20322 This will create a copy of the current document.
20323 Since RCS does not support copy operations natively, the version history
20324 is not preserved, and the copy is added as a new file.
20325 It requires a clean document without any changes since the last checkin.
20326 You are asked for a file name and a description of the copy operation.
20327 After that the copy is created, both locally and in the repository.
20328 If the parent directories of the copied and original document differ, all
20329 relative paths of included files of the copy are adjusted (like in
20331 File\SpecialChar menuseparator
20336 Finally, the copy is loaded instead of the original document.
20339 \begin_layout Labeling
20340 \labelwidthstring 00.00.0000
20342 \begin_inset space ~
20346 \begin_inset space ~
20350 \begin_inset Newline newline
20354 \begin_inset Flex Code
20357 \begin_layout Plain Layout
20360 \begin_inset Quotes eld
20364 \begin_inset Quotes erd
20373 \begin_inset Flex Code
20376 \begin_layout Plain Layout
20379 \begin_inset Quotes eld
20383 \begin_inset Quotes erd
20392 \begin_inset Newline newline
20396 \begin_inset Flex Code
20399 \begin_layout Plain Layout
20403 \begin_inset Quotes eld
20407 \begin_inset Quotes erd
20418 \begin_layout Subsubsection
20424 \begin_layout Standard
20425 This makes as if the last check in never happened.
20426 No changes are made to the document loaded into \SpecialChar LyX
20427 , but the last version
20428 is removed from the master RCS file.
20431 \begin_layout Standard
20434 rcs -o<version> <file-name>
20437 \begin_layout Subsubsection
20443 \begin_layout Standard
20444 This shows the complete history of the RCS document.
20449 is shown in a browser.
20457 \begin_layout Subsubsection
20461 \begin_layout Standard
20463 supports RCS version number, author name, date and time of last commit.
20464 All those are extracted from
20466 rlog -r <file-name>
20470 \begin_inset CommandInset ref
20472 reference "subsec:VCS-Revision-Information"
20479 \begin_layout Subsection
20480 CVS commands in \SpecialChar LyX
20484 \begin_layout Standard
20485 A subset of CVS operations is supported by \SpecialChar LyX
20487 You can find the commands in the
20489 File\SpecialChar menuseparator
20491 \begin_inset space ~
20497 The version control system SVN is more powerful, so please use it instead
20498 of CVS if possible.
20501 \begin_layout Subsubsection
20507 \begin_layout Standard
20508 If you start from scratch with CVS you have to create your repository and
20509 checkout the working copy with external tools.
20510 If you're using a client-server setup you may need to login before doing
20511 the first repository checkout.
20514 \begin_layout Standard
20515 If your documents are under revision control and others are using the same
20516 repository problems arise when different changes to the same document at
20517 the same location happen.
20518 Standard CVS repositories don't operate with a file locking mechanism.
20519 This may be surprising, but conflicts only occur if people disagree on
20520 the proper content of the same part of a document.
20521 So, if co-workers are used to communicate regularly, these conflicts occur
20523 If they don't communicate they have a fundamental problem anyway.
20524 Nevertheless some people like to work with so called
20525 \begin_inset Quotes eld
20529 \begin_inset Quotes erd
20533 If they do so the working copy of all files is readonly when checked out
20534 first and the user starts editing after using a special command to make
20535 the working copy writable.
20536 When the changes are checked in the working copy returns to readonly state.
20537 With \SpecialChar LyX
20538 one has to edit the
20539 \begin_inset Flex Code
20542 \begin_layout Plain Layout
20548 file and add the line
20549 \begin_inset Flex Code
20552 \begin_layout Plain Layout
20558 to work with reserved checkouts.
20559 The benefit is the possibility to see who is using a writable copy of some
20561 It's not guaranteed only one user makes a copy writable.
20564 \begin_layout Standard
20566 tries to guess if you're using reserved or non-reserved checkouts.
20567 If your working copy is readonly or it is writable and an additional copy
20568 of your document exists in the CVS/Base sub-directory a reserved otherwise
20569 a non-reserved checkout is assumed.
20570 When a reserved checkout is detected you have to use
20571 \begin_inset Flex Noun
20574 \begin_layout Plain Layout
20580 to make your working copy writable if it's readonly.
20582 \begin_inset Flex Noun
20585 \begin_layout Plain Layout
20591 operation is possible and that makes your working copy readonly again after
20592 transferring your changes to the repository.
20595 \begin_layout Standard
20596 More information about CVS can be found here
20597 \begin_inset Flex URL
20600 \begin_layout Plain Layout
20602 http://www.nongnu.org/cvs
20608 \begin_inset Flex URL
20611 \begin_layout Plain Layout
20613 http://ximbiot.com/cvs
20621 \begin_layout Standard
20626 to understand the sub-commands and the switches mentioned below.
20629 \begin_layout Subsubsection
20635 \begin_layout Standard
20636 If your document is not under revision control, this is the only item shown
20638 And if it is under revision control, the
20642 item is not visible.
20646 \begin_layout Standard
20647 This command registers in CVS your document
20648 \begin_inset Flex Strong
20651 \begin_layout Plain Layout
20659 in the case you have already the documents directory under CVS control
20665 This means you have to create or checkout the archive by yourself using
20667 (In case you forget that step \SpecialChar LyX
20668 registers the document with RCS.)
20671 \begin_layout Standard
20672 Then you are asked interactively to supply an initial description of the
20674 Don't forget that registered file is not yet checked in.
20677 \begin_layout Standard
20678 CVS command that is run:
20680 cvs -q add -m"<entered message>" "<file-name>"
20683 \begin_layout Standard
20688 above and for all other CVS commands is an abbreviation for
20689 \begin_inset Quotes eld
20692 change the current working directory to file location and use the file name
20693 without path component as argument
20694 \begin_inset Quotes erd
20700 \begin_layout Subsubsection
20706 \begin_layout Standard
20707 When you are finished editing a file, you commit your changes.
20708 When you do this and you had changed the document, you are asked for a
20709 description of the changes.
20710 After that changes are written to the repository.
20711 In case you didn't change the document and a reserved checkout is detected
20712 the reservation made on
20713 \begin_inset Flex Noun
20716 \begin_layout Plain Layout
20725 \begin_layout Labeling
20726 \labelwidthstring 00.00.0000
20728 \begin_inset space ~
20732 \begin_inset space ~
20736 \begin_inset Newline newline
20740 \begin_inset Flex Code
20743 \begin_layout Plain Layout
20746 -q commit -m"<description>" "<file-name>"
20752 \begin_inset Newline newline
20756 \begin_inset Flex Code
20759 \begin_layout Plain Layout
20770 \begin_layout Subsubsection
20776 \begin_layout Standard
20777 When you are sharing a repository with others, you may have to incorporate
20778 their changes into your working copy.
20781 \begin_layout Standard
20784 cvs -q update "<file-name>"
20787 \begin_layout Standard
20788 If a readonly checkout is detected the working copy is made writable and
20792 \begin_layout Standard
20795 cvs -q edit "<file-name>"
20798 \begin_layout Subsubsection
20801 Revert To Repository Version
20804 \begin_layout Standard
20805 This will discard all changes made to the document since the last check
20807 You get a warning before changes are discarded.
20808 Firstly the file is deleted, secondly CVS update command is run.
20811 \begin_layout Standard
20814 cvs -q update "<file-name>"
20817 \begin_layout Standard
20818 If a reserved checkout is detected and the working copy has no changes only
20819 the reservation is undone.
20822 \begin_layout Standard
20825 cvs -q unedit "<file-name>"
20828 \begin_layout Subsubsection
20834 \begin_layout Standard
20835 This will create a copy of the current document.
20836 Since CVS does not support copy operations natively, the version history
20837 is not preserved, and the copy is added as a new file.
20838 It requires a clean document without any changes since the last checkin.
20839 You are asked for a file name and a description of the copy operation.
20840 After that the copy is created, both locally and in the repository.
20841 If the parent directories of the copied and original document differ, all
20842 relative paths of included files of the copy are adjusted (like in
20844 File\SpecialChar menuseparator
20849 Finally, the copy is loaded instead of the original document.
20852 \begin_layout Labeling
20853 \labelwidthstring 00.00.0000
20855 \begin_inset space ~
20859 \begin_inset space ~
20863 \begin_inset Newline newline
20867 \begin_inset Flex Code
20870 \begin_layout Plain Layout
20873 \begin_inset Quotes eld
20877 \begin_inset Quotes erd
20886 \begin_inset Flex Code
20889 \begin_layout Plain Layout
20892 \begin_inset Quotes eld
20896 \begin_inset Quotes erd
20905 \begin_inset Newline newline
20909 \begin_inset Flex Code
20912 \begin_layout Plain Layout
20916 \begin_inset Quotes eld
20920 \begin_inset Quotes erd
20931 \begin_layout Subsubsection
20937 \begin_layout Standard
20938 This will rename the current document.
20939 Since CVS does not support rename operations natively, the version history
20940 is not preserved, the renamed document is added as a new file, and the
20941 original document is deleted.
20942 It requires a clean document without any changes since the last checkin.
20943 You are asked for a file name and a description of the rename operation.
20944 After that the document is renamed, both locally and in the repository.
20945 If the parent directories of the new and old file names differ, all relative
20946 paths of included files are adjusted (like in
20948 File\SpecialChar menuseparator
20953 Finally, the document is reloaded using the new name.
20956 \begin_layout Labeling
20957 \labelwidthstring 00.00.0000
20959 \begin_inset space ~
20963 \begin_inset space ~
20967 \begin_inset Newline newline
20971 \begin_inset Flex Code
20974 \begin_layout Plain Layout
20977 \begin_inset Quotes eld
20981 \begin_inset Quotes erd
20990 \begin_inset Flex Code
20993 \begin_layout Plain Layout
20996 \begin_inset Quotes eld
21000 \begin_inset Quotes erd
21009 \begin_inset Newline newline
21013 \begin_inset Flex Code
21016 \begin_layout Plain Layout
21020 \begin_inset Quotes eld
21024 \begin_inset Quotes erd
21033 \begin_inset Newline newline
21037 \begin_inset Flex Code
21040 \begin_layout Plain Layout
21044 \begin_inset Quotes eld
21048 \begin_inset Quotes erd
21059 \begin_layout Subsubsection
21060 Update of the local directory checkout from repository
21063 \begin_layout Standard
21064 Once your documents gets more complex, containing sub-documents and pictures,
21066 \begin_inset Flex Code
21069 \begin_layout Plain Layout
21075 files and so on using version control becomes more complicated.
21077 supports updating the whole tree in which resides the document.
21078 This become especially useful once you cooperate with people which neither
21079 have detailed knowledge about CVS usage nor they have ambition to commit
21080 additional material to the repository.
21081 You have to organize the files structure so that all external files are
21082 in the same directory or subdirectories of the document.
21083 It's good practice anyway to store multipart documents in an extra directory.
21086 \begin_layout Standard
21088 \begin_inset Flex Code
21091 \begin_layout Plain Layout
21092 Update local directory from repository
21097 command updates the whole directory.
21098 If local changes are detected user is warned before update starts.
21099 In case of merge conflicts both versions of the conflicting document parts
21100 are placed in the final document.
21101 You have to review and correct the result of the merge.
21102 You'll find the conflicts enclosed in pairs of
21103 \begin_inset Flex Code
21106 \begin_layout Plain Layout
21113 \begin_inset Flex Code
21116 \begin_layout Plain Layout
21123 \begin_inset Flex Code
21126 \begin_layout Plain Layout
21133 The first part is your version as before the update operation with the
21134 document name prepended.
21135 The second one is the repository version with the version number after
21137 \begin_inset Flex Code
21140 \begin_layout Plain Layout
21149 \begin_layout Labeling
21150 \labelwidthstring 00.00.0000
21152 \begin_inset space ~
21156 \begin_inset space ~
21160 \begin_inset Newline newline
21164 \begin_inset Flex Code
21167 \begin_layout Plain Layout
21175 (Ask if changes are detected.)
21176 \begin_inset Newline newline
21180 \begin_inset Flex Code
21183 \begin_layout Plain Layout
21184 cd $path; cvs -q update
21194 \begin_layout Standard
21196 \begin_inset Flex Code
21199 \begin_layout Plain Layout
21205 stands for the path to the document.
21208 \begin_layout Subsubsection
21214 \begin_layout Standard
21215 This shows the complete history of the CVS document.
21218 cvs log "<file-name>"
21220 is shown in a browser.
21223 \begin_layout Subsubsection
21227 \begin_layout Standard
21229 supports CVS version number, author name, date and time of last commit.
21230 All those are extracted from
21232 cvs log -r <file-name>
21236 \begin_inset CommandInset ref
21238 reference "subsec:VCS-Revision-Information"
21245 \begin_layout Subsection
21246 SVN commands in \SpecialChar LyX
21250 \begin_layout Standard
21251 SVN is now partially supported by \SpecialChar LyX
21253 You can find the commands in the
21255 File\SpecialChar menuseparator
21257 \begin_inset space ~
21263 Please note that if you use password protected access to repository via
21264 ssh, you will be asked in terminal window.
21266 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21270 \begin_layout Plain Layout
21271 Most of the commands will work with 1.4 too, see
21272 \begin_inset CommandInset ref
21274 reference "subsec:SVN-Repo-Update"
21279 There seems to be currently unresolved permissions problem under SVN 1.8
21280 with reverting changes when file is locked.
21288 \begin_layout Subsubsection
21294 \begin_layout Standard
21295 If your document is not under revision control, this is the only item shown
21297 And if it is under revision control, the
21301 item is not visible.
21304 \begin_layout Standard
21305 This command registers in SVN your document ONLY in case you have already
21306 the documents directory under SVN control (in particular
21311 This means you have to checkout the archive by yourself.
21314 \begin_layout Standard
21315 Then you are asked interactively to supply an initial description of the
21317 Don't forget that registered file is not yet commited.
21320 \begin_layout Standard
21321 SVN command that is run:
21324 \begin_inset Quotes eld
21328 \begin_inset Quotes erd
21334 \begin_layout Standard
21339 to understand the switches.
21342 \begin_layout Subsubsection
21348 \begin_layout Standard
21349 When you are finished editing a file, you commit your changes.
21350 When you do this, you are asked for a description of the changes.
21351 After that changes are commited.
21354 \begin_layout Standard
21359 \begin_layout Plain Layout
21360 In case locking is not enabled.
21362 \begin_inset CommandInset ref
21364 reference "subsec:SVN-File-Locking"
21375 svn commit -q -m"<description>" <file-name>
21378 \begin_layout Subsubsection
21384 \begin_layout Standard
21385 Updates the changes of this file from the repository.
21386 Be sure you understand SVN merging and conflicts resolving before using
21387 this function, because all conflicts has to be resolved manually by you!
21390 \begin_layout Standard
21395 \begin_layout Plain Layout
21403 svn update --non-interactive
21404 \begin_inset Quotes eld
21408 \begin_inset Quotes erd
21414 \begin_layout Subsubsection
21417 Revert To Repository Version
21420 \begin_layout Standard
21421 This will discard all changes made to the document since the last check
21423 You get a warning before changes are discarded.
21426 \begin_layout Standard
21430 \begin_inset Quotes eld
21434 \begin_inset Quotes erd
21440 \begin_layout Subsubsection
21446 \begin_layout Standard
21447 This will create a copy of the current document including the version history.
21448 It requires a clean document without any changes since the last checkin.
21449 You are asked for a file name and a description of the copy operation.
21450 After that the copy is created, both locally and in the repository.
21451 If the parent directories of the copied and original document differ, all
21452 relative paths of included files of the copy are adjusted (like in
21454 File\SpecialChar menuseparator
21459 Finally, the copy is loaded instead of the original document.
21462 \begin_layout Labeling
21463 \labelwidthstring 00.00.0000
21465 \begin_inset space ~
21469 \begin_inset space ~
21473 \begin_inset Newline newline
21477 \begin_inset Flex Code
21480 \begin_layout Plain Layout
21484 \begin_inset Quotes eld
21488 \begin_inset Quotes erd
21492 \begin_inset Quotes eld
21496 \begin_inset Quotes erd
21505 \begin_inset Newline newline
21509 \begin_inset Flex Code
21512 \begin_layout Plain Layout
21521 \begin_layout Subsubsection
21527 \begin_layout Standard
21528 This will rename the current document including the version history.
21529 It requires a clean document without any changes since the last checkin.
21530 You are asked for a file name and a description of the rename operation.
21531 After that the document is renamed, both locally and in the repository.
21532 If the parent directories of the new and old file names differ, all relative
21533 paths of included files are adjusted (like in
21535 File\SpecialChar menuseparator
21540 Finally, the document is reloaded using the new name.
21543 \begin_layout Labeling
21544 \labelwidthstring 00.00.0000
21546 \begin_inset space ~
21550 \begin_inset space ~
21554 \begin_inset Newline newline
21558 \begin_inset Flex Code
21561 \begin_layout Plain Layout
21565 \begin_inset Quotes eld
21569 \begin_inset Quotes erd
21573 \begin_inset Quotes eld
21577 \begin_inset Quotes erd
21586 \begin_inset Newline newline
21590 \begin_inset Flex Code
21593 \begin_layout Plain Layout
21602 \begin_layout Subsubsection
21603 \begin_inset CommandInset label
21605 name "subsec:SVN-Repo-Update"
21609 Update of the local directory checkout from repository
21613 \begin_layout Plain Layout
21614 Note that this command will work only with subversion
21615 \begin_inset Formula $\geqq1.5$
21626 \begin_layout Standard
21627 All the commands above have one shortcomming - they deal with the current
21629 Once your document contains pictures, includes external
21630 \begin_inset Flex Code
21633 \begin_layout Plain Layout
21639 files and so on administration becomes more complicated.
21641 now supports updating the whole tree in which resides the document
21645 \begin_layout Plain Layout
21646 One need to organize the files structure so that all external files are
21647 in the same directory or subdirectories of the document.
21654 This become especially useful once you cooperate with people which neither
21655 know about subversion management nor they have ambition to commit additional
21656 material to the repository.
21660 \begin_layout Standard
21661 \begin_inset Flex Code
21664 \begin_layout Plain Layout
21665 Update local directory from repository
21670 command updates the whole directory and in case of merge conflicts local
21671 version of the files are left, so no unintended data loss occurs.
21672 If local changes are detected user is warned before update starts.
21675 \begin_layout Labeling
21676 \labelwidthstring 00.00.0000
21678 \begin_inset space ~
21682 \begin_inset space ~
21686 \begin_inset Newline newline
21690 \begin_inset Flex Code
21693 \begin_layout Plain Layout
21699 (Ask if changes are detected.)
21700 \begin_inset Newline newline
21704 \begin_inset Flex Code
21707 \begin_layout Plain Layout
21708 svn update –accept mine-full $path
21716 \begin_layout Standard
21718 \begin_inset Flex Code
21721 \begin_layout Plain Layout
21727 stands for the path to the document.
21730 \begin_layout Subsubsection
21736 \begin_layout Standard
21737 This shows the complete history of the SVN document.
21741 \begin_inset Quotes eld
21745 \begin_inset Quotes erd
21750 is shown in a browser.
21753 \begin_layout Subsubsection
21755 \begin_inset CommandInset label
21757 name "subsec:SVN-File-Locking"
21764 \begin_layout Standard
21765 The file exchange through various revision control systems brings the problem
21766 of merge conflicts in case two different users try to edit the same (parts
21768 When such a conflict happens it needs manual resolving and one reasonable
21769 alternative is to provide some kind of locking mechanism, which guarantees
21770 that only one user is allowed to edit file at the given time.
21773 \begin_layout Standard
21774 SVN has two such mechanisms to provide mutual exclusivity for file access
21775 - locks and automatic setting of write permissions (see sec.
21777 \begin_inset CommandInset ref
21779 reference "subsec:Automatical-Locking-Property"
21784 \begin_inset Flex Code
21787 \begin_layout Plain Layout
21797 \begin_layout Plain Layout
21798 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21804 If this property is detected for a given document \SpecialChar LyX
21805 starts to use SVN locks
21806 for document editing automatically and the whole check-in/out mechanism
21807 switches to the same regimen as for RCS.
21808 This in particular means there are two different modes of file use in \SpecialChar LyX
21812 \begin_layout Itemize
21814 The loaded file is in the read-only mode.
21815 For editing on needs to check-out.
21820 consists of updating from the repository and gaining write lock.
21821 If the lock is not possible to obtain, we remain in unlocked state.
21824 \begin_layout Itemize
21826 The loaded file is in the 'normal' edit mode.
21827 No other user is allowed to edit the file.
21832 consists of commiting changes and releasing write-lock.
21833 If no changes have been made to the document, no commit will be produced
21837 \begin_layout Plain Layout
21838 Don't be puzzled by the fact that you will be asked for commit message anyway.
21843 and only the write-lock will be released.
21846 \begin_layout Standard
21850 \begin_layout Labeling
21851 \labelwidthstring 00.00.0000
21854 svn commit -q -m"<description>" "<file-name>"
21855 \begin_inset Newline newline
21858 svn unlock "<file-name>"
21861 \begin_layout Labeling
21862 \labelwidthstring 00.00.0000
21865 svn update "<file-name>"
21866 \begin_inset Newline newline
21869 svn lock "<file-name>"
21872 \begin_layout Subsubsection
21875 \begin_inset CommandInset label
21877 name "subsec:Automatical-Locking-Property"
21883 Automatic Locking Property
21886 \begin_layout Standard
21887 The above mentioned automatic setting of write permissions of the .lyx file
21890 File\SpecialChar menuseparator
21892 \begin_inset space ~
21895 Control\SpecialChar menuseparator
21896 Toggle locking property
21899 This command is active only when the file is not locked on the svn server
21901 you need to check-out before proceeding).
21904 \begin_layout Labeling
21905 \labelwidthstring 00.00.0000
21907 \begin_inset space ~
21913 \begin_layout Labeling
21914 \labelwidthstring 00.00.0000
21917 svn propset svn:needs-lock ON "<file-name>"
21920 \begin_layout Labeling
21921 \labelwidthstring 00.00.0000
21924 svn propdel svn:needs-lock "<file-name>"
21927 \begin_layout Subsubsection
21928 \begin_inset CommandInset label
21930 name "subsec:VCS-Revision-Information"
21934 Revision Information in Documents
21937 \begin_layout Standard
21938 There are more possibilities how to activate revision information in our
21942 \begin_layout Itemize
21948 \begin_layout Itemize
21949 tree revision information (
21950 \begin_inset Flex Code
21953 \begin_layout Plain Layout
21960 The result is the output of the
21961 \begin_inset Flex Code
21964 \begin_layout Plain Layout
21970 command, the following table gives you an idea, how to read the results.
21973 \begin_layout Standard
21975 \begin_inset Tabular
21976 <lyxtabular version="3" rows="6" columns="2">
21977 <features tabularvalignment="middle">
21978 <column alignment="center" valignment="top">
21979 <column alignment="center" valignment="top">
21981 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21984 \begin_layout Plain Layout
21990 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21993 \begin_layout Plain Layout
22001 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22004 \begin_layout Plain Layout
22010 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22013 \begin_layout Plain Layout
22014 mixed revision working copy
22021 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22024 \begin_layout Plain Layout
22030 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22033 \begin_layout Plain Layout
22034 modified working copy
22041 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22044 \begin_layout Plain Layout
22050 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22053 \begin_layout Plain Layout
22054 switched working copy
22061 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22064 \begin_layout Plain Layout
22070 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22073 \begin_layout Plain Layout
22074 partial working copy, from a sparse checkout
22081 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22084 \begin_layout Plain Layout
22090 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22093 \begin_layout Plain Layout
22094 mixed revision, modified, switched working copy
22107 \begin_layout Itemize
22108 file revision information.
22109 The result comes from parsing the output of
22110 \begin_inset Flex Code
22113 \begin_layout Plain Layout
22115 \begin_inset space ~
22119 \begin_inset space ~
22123 \begin_inset space ~
22132 Supported flags are:
22136 \begin_layout Itemize
22137 version number of the last commit (
22138 \begin_inset Flex Code
22141 \begin_layout Plain Layout
22150 \begin_layout Itemize
22151 author of the last commit (
22152 \begin_inset Flex Code
22155 \begin_layout Plain Layout
22164 \begin_layout Itemize
22165 date of the last commit (
22166 \begin_inset Flex Code
22169 \begin_layout Plain Layout
22178 \begin_layout Itemize
22179 time of the last commit (
22180 \begin_inset Flex Code
22183 \begin_layout Plain Layout
22193 \begin_layout Standard
22194 You can obtain this info via InsetInfo (e.g.
22196 \begin_inset Flex Code
22199 \begin_layout Plain Layout
22200 info-insert buffer vcs-date
22206 The information will be available only when you have the file stored under
22207 svn managment (i.e.
22209 \begin_inset Flex Code
22212 \begin_layout Plain Layout
22218 directory is available with your document).
22222 \begin_layout Itemize
22223 Another—a hacking one—possibility is to use svn keywords
22227 \begin_layout Plain Layout
22228 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22234 In short – you set file keywords property (e.g.
22237 svn propset svn:keywords 'Rev' file.lyx
22239 ) and then paste keyword \SpecialChar TeX
22244 \begin_layout Plain Layout
22245 This is an easy way how to ensure that \SpecialChar LyX
22246 won't break the line in the middle
22252 tag in your document (e.g.
22257 \begin_layout Plain Layout
22265 This way svn client will automatically substitute revision number (e.g.
22270 \begin_layout Plain Layout
22277 ) after each update and commit.
22278 There are more problems with this approach.
22279 Firstly, the '$' character is used in \SpecialChar TeX
22280 world for math equations, so any
22281 occurence of math formula
22282 \begin_inset Formula $Rev$
22286 \begin_inset Formula $Rev:59$
22289 in your \SpecialChar LyX
22291 Similarly for other keywords like Id, Date, Author, etc.
22292 Secondly svn output is dependent on your locales, so its very easy that
22293 svn would produce some problematic strings once Date is used.
22294 Thirdly you get the whole 'Rev: 59' string in your document instead of
22296 Until subversion implements user's custom keywords it will be hard to use
22297 this approach reliably or let \SpecialChar LyX
22298 to support it directly.
22301 \begin_layout Subsection
22302 SVN and Windows Environment
22305 \begin_layout Quote
22306 My inclination is to say that if the user cannot figure out the command
22307 line operations on their own fairly quickly, they would be well advised
22308 to use TortoiseSVN.
22314 \begin_layout Subsubsection
22318 \begin_layout Standard
22319 In addition to installing \SpecialChar LyX
22320 , and having access to a Subversion repository,
22321 the user will need to install the Subversion client program.
22322 A Windows installer for the client program is available from
22323 \begin_inset CommandInset href
22326 target "http://www.collab.net/nonav/downloads/subversion/"
22332 The user may also want to install
22333 \begin_inset CommandInset href
22336 target "http://tortoisesvn.tigris.org/"
22341 , which integrates Subversion operations into the context (rightclick) menu
22342 of Windows Explorer.
22343 Operations done outside \SpecialChar LyX
22344 will typically be more convenient using the Explorer
22346 Note that TortoiseSVN is not a replacement for the client program, which
22347 is what \SpecialChar LyX
22351 \begin_layout Subsubsection
22352 Bringing a document under Subversion control
22355 \begin_layout Standard
22356 Before a \SpecialChar LyX
22357 document can be brought under version control in Subversion, its
22358 parent directory needs to be under version control.
22359 If the document is being added to a project already in the repository,
22360 this is accomplished by checking the project out to the directory where
22361 the new document will be placed.
22362 If the project itself is not yet under version control (for instance, if
22363 this document starts a new project), the directory must be imported into
22365 This is done outside \SpecialChar LyX
22367 Both import and checkout are easily accomplished from the Explorer context
22368 menu using TortoiseSVN, or alternatively can be done using the command
22369 line client at a DOS prompt.
22370 The procedure for importing the project using TortoiseSVN is described
22371 below, assuming an existing repository and a new project being started
22379 For information on using the Subversion client program, run
22386 \begin_layout Enumerate
22393 in Windows Explorer, right click it, and select
22395 TortoiseSVN\SpecialChar menuseparator
22399 If necessary, adjust the URL for the repository, then click OK.
22402 \begin_layout Enumerate
22403 Right click the level of the repository under which you want to place the
22404 new project folder (typically the top level) and click
22408 Supply a name for the project folder and click OK.
22409 Add a message for the log file if desired, then click OK again.
22410 The new project folder should appear in the repository.
22411 Finally, click OK again to exit the repository browser.
22414 \begin_layout Enumerate
22415 Once again right click
22421 , this time selecting SVN Checkout\SpecialChar ldots
22422 Select the URL of the project folder
22423 you just created in the repository, and set the checkout directory to
22431 You will be warned about a non-empty folder; click OK to proceed.
22432 You should now have a
22443 \begin_layout Enumerate
22444 Create or open your document in \SpecialChar LyX
22447 File\SpecialChar menuseparator
22449 \begin_inset space ~
22452 Control\SpecialChar menuseparator
22456 Add a log message and click OK to commit the document to version control.
22459 \begin_layout Standard
22460 From this point onward, you should have full functionality in the
22462 File\SpecialChar menuseparator
22464 \begin_inset space ~
22470 You also have the option of checking the document in and out, viewing its
22472 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22473 client program from a command prompt.
22476 \begin_layout Subsubsection
22477 SSH tunnel used with SVN under Windows
22480 \begin_layout Standard
22481 Compared with Linux setting up an svn client to communicate over ssh under
22482 Windows is a rather troublesome task.
22483 We will at least offer some hints how to setup the client side but prior
22484 knowledge about ssh and the Windows command line is needed, also be prepared
22485 for a great deal of frustration\SpecialChar ldots
22489 \begin_layout Enumerate
22490 Get an svn client for windows, as described in the previous sections.
22491 When it is a fresh install run some svn command (e.g.
22493 \begin_inset Flex Code
22496 \begin_layout Plain Layout
22502 ) to create config files, which you will need to change later on.
22505 \begin_layout Enumerate
22506 Choose an ssh client for Windows.
22507 There are several possibilities, we will use the one from Putty tools
22511 \begin_layout Plain Layout
22512 \begin_inset Flex URL
22515 \begin_layout Plain Layout
22517 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22528 You will need to set the connection up so that the client doesn't ask for
22529 any password from you.
22530 To keep things easy we will use only keys without any additional password
22535 \begin_layout Enumerate
22537 \begin_inset Flex Code
22540 \begin_layout Plain Layout
22547 Save your private .ppk key file and put the public one on the server side.
22548 If the SVN server runs on Linux, note that the format of the public key
22549 is not compatible with Linux openssh and you will need to direcly copy-paste
22552 Public key for pasting into OpenSSH authorized_keys file
22554 :” edit field into the server's
22555 \begin_inset Flex Code
22558 \begin_layout Plain Layout
22559 ~/.ssh/authorized_keys
22565 \begin_inset Flex Code
22568 \begin_layout Plain Layout
22577 \begin_layout Enumerate
22579 \begin_inset Flex Code
22582 \begin_layout Plain Layout
22589 In the SVN config file
22593 \begin_layout Plain Layout
22594 Exact path depends on Windows version, usually somewhere around
22595 \begin_inset Flex Code
22598 \begin_layout Plain Layout
22601 Documents and Settings
22615 \begin_inset Flex Code
22618 \begin_layout Plain Layout
22633 , section [tunnels], setup ssh command, e.g.
22635 \begin_inset Flex Code
22638 \begin_layout Plain Layout
22639 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22648 \begin_layout Plain Layout
22649 It will usually take a lot of time to get exact command right and it depends
22651 For example do not have some remote server saved as a default session in
22653 If things fail, try to connect via plink without SVN first.
22662 \begin_layout Enumerate
22663 Checkout the SVN archive, e.
22664 \begin_inset space \thinspace{}
22668 \begin_inset Newline newline
22672 \begin_inset Flex Code
22675 \begin_layout Plain Layout
22676 svn co svn+ssh://user@server/repository_path
22684 \begin_layout Subsubsection
22685 End-of-Line Conversions
22688 \begin_layout Standard
22689 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22691 use different line endings inside the .lyx files.
22692 This is not a problem as far as \SpecialChar LyX
22693 functionality is concerned, but the commit
22694 diffs will be huge and merge-conflicts prone.
22695 Fortunately SVN itself knows
22699 \begin_layout Plain Layout
22700 \begin_inset Flex URL
22703 \begin_layout Plain Layout
22705 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22715 how to deal with CR/LF problems when switching .lyx files to the
22716 \begin_inset Flex Code
22719 \begin_layout Plain Layout
22729 \begin_layout Plain Layout
22731 \begin_inset Flex Code
22734 \begin_layout Plain Layout
22735 svn propset svn:eol-style native FILE_NAME
22748 \begin_layout Subsection
22749 GIT commands in \SpecialChar LyX
22753 \begin_layout Standard
22754 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22756 You can find the commands in the
22758 File\SpecialChar menuseparator
22760 \begin_inset space ~
22766 Please note that if you use password protected access to repository via
22767 ssh, you will be asked in terminal window.
22769 was tested against GIT 1.7.
22773 \begin_layout Plain Layout
22774 Windows users please note that you need to ensure that git is on the path.
22775 This can be set from within \SpecialChar LyX
22778 Tools\SpecialChar menuseparator
22779 Preferences\SpecialChar menuseparator
22780 Paths\SpecialChar menuseparator
22791 \begin_layout Standard
22792 One big difference of GIT and the other supported version control systems
22793 is the distributed nature of GIT: With traditional version control systems
22794 there is one central server which hosts the repository.
22795 Users commit their changes to the server, and get updates made by other
22797 With GIT, users commit to a local repository.
22798 The local repository can be synchronized with one or more remote repositories
22800 \begin_inset Flex Code
22803 \begin_layout Plain Layout
22810 \begin_inset Flex Code
22813 \begin_layout Plain Layout
22821 does not interact in any way with remote GIT repositories.
22822 It works exclusively with the local repository in a very similar way as
22823 with a central CVS or SVN repository.
22824 If you use remote GIT repositories you need to do the
22825 \begin_inset Flex Code
22828 \begin_layout Plain Layout
22835 \begin_inset Flex Code
22838 \begin_layout Plain Layout
22844 operations with your favourite GIT client.
22847 \begin_layout Subsubsection
22853 \begin_layout Standard
22854 If your document is not under revision control, this is the only item shown
22856 And if it is under revision control, the
22860 item is not visible.
22863 \begin_layout Standard
22864 This command registers in GIT your document ONLY in case you have already
22865 the documents directory under GIT control (in particular
22870 This means you have to checkout the archive by yourself.
22873 \begin_layout Standard
22874 Then you are asked interactively to supply an initial description of the
22876 Don't forget that registered file is not yet commited.
22879 \begin_layout Standard
22880 GIT command that is run:
22883 \begin_inset Quotes eld
22887 \begin_inset Quotes erd
22893 \begin_layout Standard
22898 to understand the switches.
22901 \begin_layout Subsubsection
22907 \begin_layout Standard
22908 When you are finished editing a file, you commit your changes.
22909 When you do this, you are asked for a description of the changes.
22910 After that changes are commited.
22913 \begin_layout Standard
22916 git commit -q -m"<description>" <file-name>
22919 \begin_layout Subsubsection
22922 Revert To Repository Version
22925 \begin_layout Standard
22926 This will discard all changes made to the document since the last check
22928 You get a warning before changes are discarded.
22931 \begin_layout Standard
22935 \begin_inset Quotes eld
22939 \begin_inset Quotes erd
22945 \begin_layout Subsubsection
22951 \begin_layout Standard
22952 This will rename the current document including the version history.
22953 It requires a clean document without any changes since the last checkin.
22954 You are asked for a file name and a description of the rename operation.
22955 After that the document is renamed, both locally and in the repository.
22956 If the parent directories of the new and old file names differ, all relative
22957 paths of included files are adjusted (like in
22959 File\SpecialChar menuseparator
22964 Finally, the document is reloaded using the new name.
22967 \begin_layout Labeling
22968 \labelwidthstring 00.00.0000
22970 \begin_inset space ~
22974 \begin_inset space ~
22978 \begin_inset Newline newline
22982 \begin_inset Flex Code
22985 \begin_layout Plain Layout
22989 \begin_inset Quotes eld
22993 \begin_inset Quotes erd
22997 \begin_inset Quotes eld
23001 \begin_inset Quotes erd
23010 \begin_inset Newline newline
23014 \begin_inset Flex Code
23017 \begin_layout Plain Layout
23026 \begin_layout Subsubsection
23032 \begin_layout Standard
23033 This shows the complete history of the GIT document.
23037 \begin_inset Quotes eld
23041 \begin_inset Quotes erd
23046 is shown in a browser.
23049 \begin_layout Subsubsection
23053 \begin_layout Standard
23055 supports GIT hash number of the last commit to the file, author name, date
23056 and time of last commit.
23057 All those are extracted from
23059 git log -n 1 --pretty=format:%H%n%an%n%ai
23062 Tree version information is obtained via
23064 git describe --abbrev --dirty --long
23068 \begin_inset CommandInset ref
23070 reference "subsec:VCS-Revision-Information"
23077 \begin_layout Subsection
23081 \begin_layout Standard
23082 With the recent addition of the vc-command function \SpecialChar LyX
23083 power users are allowed
23084 to create their own commands for revision control.
23087 \begin_layout Standard
23088 As an example you can see how two TortoiseSVN commands could be integrated
23092 \begin_layout Description
23094 \begin_inset Flex Code
23097 \begin_layout Plain Layout
23098 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23106 \begin_layout Description
23108 \begin_inset Flex Code
23111 \begin_layout Plain Layout
23112 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23120 \begin_layout Subsection
23121 Version control and Document comparison
23124 \begin_layout Standard
23125 One of the typical uses of version control is to inspect the changes between
23126 revisions, usually by creating
23127 \begin_inset Flex Code
23130 \begin_layout Plain Layout
23137 While this is useful for plain text files, it is much less useful in the
23138 case of \SpecialChar LyX
23139 files, which have more a complicated structure.
23140 Hence we provide binding to the Document comparison feature.
23141 There are two ways of calling this feature - either by direct call of
23142 \begin_inset Flex Code
23145 \begin_layout Plain Layout
23152 function (for details see \SpecialChar LyX
23153 functions manual) or by icon/menu item
23154 \begin_inset Flex Noun
23157 \begin_layout Plain Layout
23158 Compare with older revision...
23164 One can either compare two chosen revisions of the document or he can simply
23165 compare the current version of edited text with older revisions (where
23167 \begin_inset Flex Noun
23170 \begin_layout Plain Layout
23176 ' revisions back means comparison of the edited file with last commited
23181 \begin_layout Standard
23182 This feature is supported for SVN and RCS though due to the more complicated
23183 versioning scheme of RCS there is a constraint – when addressing the revisions
23184 in dialog, numbers always point to the last number in RCS revision number,
23187 We don't currently support GIT addressing of revisions, one can just compare
23188 edited document with its revision X steps backs, where X is addressed as
23192 \begin_layout Section
23193 Literate Programming
23196 \begin_layout Standard
23201 (kayvan@sylvan.com)
23205 original documentation written by
23207 Edmar Wienskoski Jr.
23210 (edmar-w-jr@technologist.com)
23213 \begin_layout Subsection
23217 \begin_layout Standard
23218 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23220 programming, where it is assumed that you are familiar with this programming
23221 technique, and know what
23222 \begin_inset Quotes eld
23226 \begin_inset Quotes erd
23230 \begin_inset Quotes eld
23234 \begin_inset Quotes erd
23238 If that is not the case, please follow the web links provided in the following
23240 There is a lot of good documentation out there covering old development
23241 history to the latest tools tips.
23244 \begin_layout Standard
23245 It is also assumed that you are familiar with \SpecialChar LyX
23246 itself to a point that you
23247 are comfortable changing your \SpecialChar LyX
23248 preferences, and X resources file.
23249 If that is not the case please refer to other \SpecialChar LyX
23250 documentation to cover your
23254 \begin_layout Subsection
23255 Literate Programming
23258 \begin_layout Standard
23259 From the Literate Programming FAQ:
23262 \begin_layout Quotation
23263 Literate programming is the combination of documentation and source together
23264 in a fashion suited for reading by human beings.
23265 In fact, literate programs should be enjoyable reading, even inviting!
23266 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23267 and documentation in a single file.
23268 Literate programming tools then parse the file to produce either readable
23269 documentation or compilable source.
23270 The WEB style of literate programming was created by D.
23271 \begin_inset space \thinspace{}
23275 Knuth during the development of his \SpecialChar TeX
23276 typesetting software.
23280 \begin_layout Standard
23281 Another excerpt says:
23284 \begin_layout Quotation
23287 How is literate programming different from verbose commenting?
23290 \begin_layout Quotation
23291 There are three distinguishing characteristics.
23292 In order of importance, they are:
23296 \begin_layout Itemize
23297 flexible order of elaboration
23300 \begin_layout Itemize
23301 automatic support for browsing
23304 \begin_layout Itemize
23305 typeset documentation, especially diagrams and mathematics
23309 \begin_layout Standard
23310 Now that I sparked your curiosity, take a look in the references.
23313 \begin_layout Subsubsection
23317 \begin_layout Standard
23318 The complete Literate Programming FAQ can be found at:
23321 \begin_layout Quote
23322 Literate Programming FAQ
23323 \begin_inset Flex URL
23326 \begin_layout Plain Layout
23328 http://www.literateprogramming.com/lpfaq.pdf
23336 \begin_layout Standard
23337 The FAQ lists 23 (twenty three!) different literate programming tools.
23338 Where some are specialized or
23339 \begin_inset Quotes eld
23343 \begin_inset Quotes erd
23346 for particular programming languages, while other have general scope.
23351 for my own use for several reasons:
23354 \begin_layout Itemize
23355 It can generate the documentation either in \SpecialChar LaTeX
23359 \begin_layout Itemize
23360 It has a open architecture, i.
23361 \begin_inset space \thinspace{}
23365 \begin_inset space \space{}
23368 it is easy to plug in new filters and to perform special processing that
23373 \begin_layout Itemize
23374 There is a good selection of filters available already (the HTML is one
23378 \begin_layout Itemize
23382 \begin_layout Standard
23383 The Noweb web page can be found at:
23386 \begin_layout Quote
23388 \begin_inset Flex URL
23391 \begin_layout Plain Layout
23393 http://www.cs.virginia.edu/~nr/noweb/
23401 \begin_layout Standard
23402 Starting from there you can reach many other interesting links and even
23403 some literate program examples.
23406 \begin_layout Subsection
23408 and Literate Programming with Noweb
23411 \begin_layout Standard
23412 The \SpecialChar LyX
23413 support for Literate Programming is provided by using the generic \SpecialChar LyX
23415 converters mechanism.
23416 This support is provided in a
23417 \begin_inset Quotes eld
23421 \begin_inset Quotes erd
23425 \begin_inset space \thinspace{}
23429 \begin_inset space \space{}
23432 you will be able to use this new \SpecialChar LyX
23433 feature with some other literate programming
23434 tool of your choice by just changing your \SpecialChar LyX
23438 \begin_layout Subsubsection
23439 Generating documents and code (weaving and tangling)
23442 \begin_layout Paragraph
23443 Using the noweb module
23446 \begin_layout Standard
23447 If you have installed Noweb and \SpecialChar LyX
23448 successfully, whenever you open a new document,
23449 after you have chosen its document class, use the Document->Settings menu
23451 \begin_inset Quotes eld
23455 \begin_inset Quotes erd
23459 If Noweb is correctly installed, when you click on the
23460 \begin_inset Quotes eld
23464 \begin_inset Quotes erd
23467 link, you will see the
23468 \begin_inset Quotes eld
23472 \begin_inset Quotes erd
23475 module in the available list and you can add it to your document.
23478 \begin_layout Paragraph
23482 \begin_layout Standard
23484 enables you to write code with a layout named
23485 \begin_inset Flex Noun
23488 \begin_layout Plain Layout
23495 Noweb delimits chunks like this:
23498 \begin_layout LyX-Code
23502 \begin_layout LyX-Code
23506 \begin_layout LyX-Code
23510 \begin_layout LyX-Code
23514 \begin_layout LyX-Code
23518 \begin_layout Standard
23519 The problem is that whatever is written in between the << and the
23523 must be taken literally, i.
23524 \begin_inset space \thinspace{}
23528 \begin_inset space \space{}
23532 should be prevented from making any special interpretation of what has
23534 This is also handled by
23535 \begin_inset Flex Noun
23538 \begin_layout Plain Layout
23544 , that works like a normal paragraph but has a free spacing capability.
23547 \begin_layout Standard
23548 As a special note, you can also use the
23549 \begin_inset Quotes eld
23553 \begin_inset Quotes erd
23556 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23560 \begin_layout LyX-Code
23564 \begin_layout LyX-Code
23565 def some_function(args):
23568 \begin_layout LyX-Code
23569 "This is the doc string for this function."
23572 \begin_layout LyX-Code
23573 print "My args: ", args
23576 \begin_layout LyX-Code
23577 @ %def some_function
23580 \begin_layout Standard
23581 For an example of this usage and the resulting cross-reference output, look
23582 at the Literate python program in
23584 LIBDIR/examples/listerrors.lyx
23586 which should make this all clear.
23589 \begin_layout Paragraph
23590 Generating the documentation
23593 \begin_layout Standard
23594 At this point you already have a new document file with a proper document
23595 class, and with some code and text on it.
23596 How do I print it? The answer is simple, you select
23598 View\SpecialChar menuseparator
23602 Just like you would do for a plain document.
23603 No special procedure is required.
23606 \begin_layout Standard
23607 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23611 \begin_layout Enumerate
23614 Update\SpecialChar menuseparator
23617 menu option is chosen, a \SpecialChar LaTeX
23623 \begin_layout Standard
23624 If the document is of any literate class the generated file will be named
23625 with an extension name defined by the
23626 \begin_inset Quotes eld
23630 \begin_inset Quotes erd
23633 format (defined in the Preferences panel), otherwise the file will have
23642 \begin_layout Enumerate
23643 Note that the only difference so far is in the name of the file, no special
23644 processing is required by \SpecialChar LyX
23646 Given that you formatted the code using the
23647 \begin_inset Flex Noun
23650 \begin_layout Plain Layout
23656 layout that, by itself, takes care of the business.
23659 \begin_layout Enumerate
23660 If the document is of any literate class \SpecialChar LyX
23661 will then use the internal \SpecialChar LyX
23663 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23668 \begin_layout Plain Layout
23669 The converters are defined in the
23671 Tools\SpecialChar menuseparator
23675 \begin_inset Quotes eld
23679 \begin_inset Quotes erd
23691 manual for general information about converters.
23696 to generate the \SpecialChar LaTeX
23701 \begin_layout Standard
23702 Otherwise it will just skip this step.
23706 \begin_layout Enumerate
23707 Finally, \SpecialChar LaTeX
23708 is invoked and the regular post processing continues as in a plain
23712 \begin_layout Standard
23713 Independence from a particular
23714 \begin_inset Quotes eld
23718 \begin_inset Quotes erd
23721 is easily achieved by changing the commands that are run by the various
23725 \begin_layout Paragraph
23726 Generating the code
23729 \begin_layout Standard
23730 When the build menu option is chosen or the corresponding button in the
23731 toolbar is pressed, a \SpecialChar LaTeX
23732 file is generated just like step 1 above.
23733 Next, \SpecialChar LyX
23739 This converter needs to be defined by the user and is not installed by
23740 default, though the Program format is.
23741 This converter (like any other converter) will have two parts:
23744 \begin_layout Enumerate
23745 The converter program itself.
23746 This program performs the conversion from the one format to the other (in
23747 this case, from the Noweb format to the Program pseudo-format).
23750 \begin_layout Enumerate
23751 The error log parser.
23752 This is a program whose sole purpose is to rewrite error messages in a
23753 format that \SpecialChar LyX
23755 This makes it possible for \SpecialChar LyX
23756 to place error boxes in the right places in
23760 \begin_layout Standard
23761 The first part, the
23762 \begin_inset Quotes eld
23766 \begin_inset Quotes erd
23769 setting, should be set to
23770 \begin_inset Newline newline
23774 \begin_inset Quotes eld
23782 \begin_inset Quotes erd
23786 \begin_inset Newline newline
23789 This basically means that \SpecialChar LyX
23791 \begin_inset Quotes eld
23795 \begin_inset Quotes erd
23798 (a program or script) with the name of the Noweb file (normally a file
23799 in the \SpecialChar LyX
23800 temp directory) and the directory path of the original \SpecialChar LyX
23805 \begin_layout Standard
23806 This is an implementation of
23807 \begin_inset Quotes eld
23811 \begin_inset Quotes erd
23814 that you can place in a directory on your path:
23817 \begin_layout Standard
23818 \begin_inset VSpace defskip
23824 \begin_layout Standard
23825 \begin_inset Newpage pagebreak
23831 \begin_layout Standard
23837 \begin_layout Standard
23843 \begin_layout Standard
23846 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23849 \begin_layout Standard
23850 \begin_inset VSpace defskip
23856 \begin_layout Standard
23857 The next part of the converter setting is the
23858 \begin_inset Quotes eld
23862 \begin_inset Quotes erd
23865 which is to be set to
23866 \begin_inset Newline newline
23870 \begin_inset Quotes eld
23875 parselog=$$s/scripts/listerrors
23878 \begin_inset Quotes erd
23882 \begin_inset Newline newline
23885 This will run any errors that are generated by the
23886 \begin_inset Quotes eld
23890 \begin_inset Quotes erd
23893 process through the
23894 \begin_inset Quotes eld
23898 \begin_inset Quotes erd
23904 \begin_layout Standard
23905 The build will normally take place in \SpecialChar LyX
23906 's temporary directory, so the files
23907 produced by the conversion will be in that directory.
23909 will copy out what it regards as the `main' file, but the
23913 conversion may produce several files, and so most of these would then be
23914 deleted when \SpecialChar LyX
23916 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23917 the build-script chunk can place the generated files in that location.
23920 \begin_layout Paragraph
23921 Build instructions in the document
23924 \begin_layout Standard
23925 The last piece of the integration between \SpecialChar LyX
23927 \begin_inset Quotes eld
23931 \begin_inset Quotes erd
23935 Generally, the instructions for building your program should be embedded
23936 in a chunk of its own.
23938 \begin_inset Quotes eld
23942 \begin_inset Quotes erd
23945 above uses the notangle command to look for this chunk (called
23946 \begin_inset Quotes eld
23950 \begin_inset Quotes erd
23953 ) and runs its contents through
23954 \begin_inset Quotes eld
23958 \begin_inset Quotes erd
23964 \begin_layout Standard
23965 Typically, such a chunk would look something like this:
23968 \begin_layout LyX-Code
23972 \begin_layout LyX-Code
23974 \begin_inset Newline newline
23977 if [ -z "${NOWEB_SOURCE}" ]
23978 \begin_inset Newline newline
23984 \begin_layout LyX-Code
23985 NOWEB_SOURCE=myfile.nw
23986 \begin_inset Newline newline
23990 \begin_inset Newline newline
23994 code to extract files ...
23995 use NOWEB_OUTPUT_DIR here ...]
23996 \begin_inset Newline newline
24000 code to compile files ...]
24001 \begin_inset Newline newline
24007 \begin_layout Standard
24010 LIBDIR/examples/listerrors.lyx
24014 LIBDIR/examples/Literate.lyx
24016 which implement two versions of the
24017 \begin_inset Quotes eld
24021 \begin_inset Quotes erd
24024 program for some illustrations of how all of these pieces go together or
24027 LIBDIR/examples/noweb2lyx.lyx.
24030 Interestingly, these three files show off the language-indepence of the
24032 literate programming support since they are written in Python, C and Perl
24036 \begin_layout Subsubsection
24037 Configuring \SpecialChar LyX
24041 \begin_layout Standard
24042 All the Literate Programming support is configured by the
24044 Tools\SpecialChar menuseparator
24048 \begin_inset Quotes eld
24052 \begin_inset Quotes erd
24056 The important parts are:
24059 \begin_layout Description
24061 \begin_inset space ~
24065 \begin_inset Quotes eld
24069 \begin_inset Quotes erd
24073 \begin_inset space ~
24076 format Set up via the File Formats tab, this is where the Noweb-specific
24086 , the file extension is set to
24091 This tells \SpecialChar LyX
24092 to create a file with a
24096 extension in the first step of the conversion process.
24099 \begin_layout Description
24101 \begin_inset space ~
24109 \begin_inset space ~
24112 format This is an empty format whose sole purpose is to be the endpoint
24113 of a conversion (which then allows us to set up a converter for it).
24116 \begin_layout Description
24126 This converter performs the
24127 \begin_inset Quotes eld
24131 \begin_inset Quotes erd
24134 of the literate document.
24135 For Noweb, it is set to
24136 \begin_inset Quotes eld
24141 noweave -delay -index $$i > $$o
24144 \begin_inset Quotes erd
24150 \begin_layout Description
24160 \begin_inset Quotes eld
24164 \begin_inset Quotes erd
24168 As stated above, the Converter is set to
24169 \begin_inset Quotes eld
24177 \begin_inset Quotes erd
24180 , with Flags set to
24181 \begin_inset Newline newline
24185 \begin_inset Quotes eld
24190 parselog=$$s/scripts/listerrors
24193 \begin_inset Quotes erd
24199 \begin_layout Subsubsection
24203 \begin_layout Standard
24204 There is also a new function implemented in the \SpecialChar LyX
24206 \begin_inset Quotes eld
24209 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24213 \begin_layout Standard
24214 When debugging code with ddd/gdb, it is possible to invoke a text editor
24215 at the current execution position with a single key stroke.
24216 The default ddd configuration for that is shift-ctrl-V.
24217 It happens that you can define the editor command line invocation in ddd
24220 Edit\SpecialChar menuseparator
24221 Preferences\SpecialChar menuseparator
24224 dialog and changing the "Edit Sources" entry.
24227 \begin_layout Standard
24228 I take advantage of the newly created \SpecialChar LyX
24229 server function and this ddd feature,
24231 \begin_inset Quotes eld
24235 \begin_inset Quotes erd
24241 \begin_layout Standard
24242 \begin_inset VSpace defskip
24248 \begin_layout Standard
24251 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24254 \begin_layout Standard
24255 \begin_inset VSpace defskip
24261 \begin_layout Standard
24262 With this, whenever you are using ddd and find a point in the program that
24263 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24264 ddd will forward this information to \SpecialChar LyX
24265 through the \SpecialChar LyX
24266 server and then the
24268 window will show the same file with the cursor at the same position ddd
24270 No more guessing or long scrolling to locate a point in the program back
24274 \begin_layout Standard
24275 Note however that you must enable the \SpecialChar LyX
24276 server to get this feature working
24277 (it is disabled by default).
24278 You can enable it in
24290 ) by entering in the
24296 \begin_inset Quotes eld
24301 /home/<your-home-directory>/.lyx/lyxpipe
24304 \begin_inset Quotes erd
24310 \begin_layout Standard
24311 Read the \SpecialChar LyX
24312 server documentation in the
24314 Customization Manual
24316 for further information.
24319 \begin_layout Subsubsection
24323 \begin_layout Standard
24324 There are six new buttons that can be added to your \SpecialChar LyX
24326 Five of these buttons are short cuts to layout styles:
24349 The last one is a short cut to the
24350 \begin_inset Quotes eld
24354 \begin_inset Quotes erd
24361 \begin_layout Standard
24363 has a range of buttons that are available for tool bar customization.
24364 In my toolbar I like to combine the six short cuts above with two more:
24369 \SpecialChar menuseparator
24374 \SpecialChar menuseparator
24381 Document\SpecialChar menuseparator
24382 View\SpecialChar menuseparator
24386 Here is how it looks like:
24389 \begin_layout LyX-Code
24393 \begin_layout LyX-Code
24397 \begin_layout LyX-Code
24398 Icon "layout Standard"
24401 \begin_layout LyX-Code
24402 Icon "layout Section"
24405 \begin_layout LyX-Code
24406 Icon "layout \SpecialChar LaTeX
24410 \begin_layout LyX-Code
24411 Icon "layout \SpecialChar LyX
24415 \begin_layout LyX-Code
24416 Icon "layout Chunk"
24419 \begin_layout LyX-Code
24423 \begin_layout LyX-Code
24427 \begin_layout LyX-Code
24428 Icon "buffer-typeset"
24431 \begin_layout LyX-Code
24432 Icon "build-program"
24435 \begin_layout LyX-Code
24439 \begin_layout LyX-Code
24443 \begin_layout LyX-Code
24447 \begin_layout LyX-Code
24451 \begin_layout LyX-Code
24455 \begin_layout Subsubsection
24456 Colors customization
24459 \begin_layout Standard
24460 There are a number of colors in \SpecialChar LyX
24461 that can be customized in
24466 One of the things that bothers people is the \SpecialChar LaTeX
24468 The default color is red, since the chunks uses \SpecialChar LaTeX
24469 font, and there is a lot
24470 of chunks in literate documents, you may get tired of seeing everything
24472 You can change it by going to the tabs
24481 \begin_layout Standard
24482 The next thing is the visible presence of the newline character in the screen.
24483 You can choose the color of this particular character and make it blend
24485 I recommend you choosing a color that is close to the background but not
24486 equal, that way you still can see it is there, but it is not bothering
24490 \begin_layout Subsection
24495 \begin_layout Standard
24504 is documented in the
24508 example file and in the Sweave manual (menu
24510 Help\SpecialChar menuseparator
24516 \begin_layout Chapter
24520 \begin_layout Standard
24521 You can do everything with \SpecialChar LyX
24522 that you can do with \SpecialChar LaTeX
24524 However, \SpecialChar LyX
24525 cannot support every \SpecialChar LaTeX
24527 But you can always use \SpecialChar TeX
24529 This chapter shows you some more special things you might want to use.
24530 For other special things you can do with figures, tables, floats, boxes
24531 and notes, have a look at the
24534 \begin_inset space ~
24542 \begin_layout Section
24543 Multiple Text Columns
24546 \begin_layout Standard
24547 This feature is independent of the option
24549 Two-column document
24551 in the document settings under
24556 If you want to have 2
24557 \begin_inset space ~
24560 columns for the whole document, it is recommended to use the
24562 Two-column document
24565 For all other cases use this feature.
24568 \begin_layout Standard
24569 To use multiple text columns in your document, you have to load the module
24576 Document\SpecialChar menuseparator
24577 Settings\SpecialChar menuseparator
24580 ) and must have the \SpecialChar LaTeX
24588 \begin_layout Standard
24589 Footnotes within multiple columns will be placed at the bottom of the page
24590 and not under each column.
24591 Within the different columns you can use everything, with the limitation
24592 that for floats you need to use the float option
24599 \begin_layout Subsection
24603 \begin_layout Standard
24604 If you want to have 2
24605 \begin_inset space ~
24608 columns in your text, insert a multicolumn inset via the menu
24610 Insert\SpecialChar menuseparator
24612 \begin_inset space ~
24615 Insets\SpecialChar menuseparator
24617 \begin_inset space ~
24622 where the columns should start.
24623 Write all text that should be printed in 2
24624 \begin_inset space ~
24627 columns into this inset.
24630 \begin_layout Standard
24631 Here is an example:
24634 \begin_layout Standard
24636 \begin_inset Flex Multiple Columns
24639 \begin_layout Plain Layout
24644 The Adventure of the Empty House
24647 \begin_inset Newline newline
24650 by Sir Arthur Conan Doyle
24653 \begin_layout Plain Layout
24656 It was in the spring of the year 1894 that all London was interested, and
24657 the fashionable world dismayed, by the murder of the Honourable Ronald
24658 Adair under most unusual and inexplicable circumstances.
24659 The public has already learned those particulars of the crime which came
24660 out in the police investigation, but a good deal was suppressed upon that
24661 occasion, since the case for the prosecution was so overwhelmingly strong
24662 that it was not necessary to bring forward all the facts.
24663 Only now, at the end of nearly ten years, am I allowed to supply those
24664 missing links which make up the whole of that remarkable chain.
24665 The crime was of interest in itself, but that interest was as nothing to
24666 me compared to the inconceivable sequel, which afforded me the greatest
24667 shock and surprise of any event in my adventurous life.
24668 Even now, after this long interval, I find myself thrilling as I think
24669 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24670 ty which utterly submerged my mind.
24671 Let me say to that public, which has shown some interest in those glimpses
24672 which I have occasionally given them of the thoughts and actions of a very
24673 remarkable man, that they are not to blame me if I have not shared my knowledge
24674 with them, for I should have considered it my first duty to do so, had
24675 I not been barred by a positive prohibition from his own lips, which was
24676 only withdrawn upon the third of last month.
24684 \begin_layout Standard
24685 To get 3 or more columns, set the cursor into the multicolumn inset and
24688 Insert\SpecialChar menuseparator
24690 \begin_inset space ~
24694 \begin_inset space ~
24700 The number of the desired columns is written into that inset (for 3
24701 \begin_inset space ~
24705 \begin_inset Quotes eld
24709 \begin_inset Quotes erd
24713 \begin_inset Newline newline
24716 Here is an example with 3
24717 \begin_inset space ~
24723 \begin_layout Standard
24724 \begin_inset Flex Multiple Columns
24727 \begin_layout Plain Layout
24730 \begin_inset Argument 1
24733 \begin_layout Plain Layout
24739 It can be imagined that my close intimacy with Sherlock Holmes had interested
24740 me deeply in crime, and that after his disappearance I never failed to
24741 read with care the various problems which came before the public.
24742 And I even attempted, more than once, for my own private satisfaction,
24743 to employ his methods in their solution, though with indifferent success.
24744 There was none, however, which appealed to me like this tragedy of Ronald
24746 As I read the evidence at the inquest, which led up to a verdict of willful
24747 murder against some person or persons unknown, I realized more clearly
24748 than I had ever done the loss which the community had sustained by the
24749 death of Sherlock Holmes.
24750 There were points about this strange business which would, I was sure,
24751 have specially appealed to him, and the efforts of the police would have
24752 been supplemented, or more probably anticipated, by the trained observation
24753 and the alert mind of the first criminal agent in Europe.
24754 All day, as I drove upon my round, I turned over the case in my mind and
24755 found no explanation which appeared to me to be adequate.
24756 At the risk of telling a twice-told tale, I will recapitulate the facts
24757 as they were known to the public at the conclusion of the inquest.
24765 \begin_layout Standard
24766 You can have up to 10
24767 \begin_inset space ~
24770 columns if you want to, but that might not be very pleasant for the readers
24774 \begin_layout Standard
24775 \begin_inset Newpage newpage
24781 \begin_layout Subsection
24782 Columns inside Columns
24785 \begin_layout Standard
24786 You can also have columns inside columns:
24789 \begin_layout Standard
24790 \begin_inset Flex Multiple Columns
24793 \begin_layout Plain Layout
24796 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24797 at that time governor of one of the Australian colonies.
24798 Adair's mother had returned from Australia to undergo the operation for
24799 cataract, and she, her son Ronald, and her daughter Hilda were living together
24803 \begin_layout Plain Layout
24804 \begin_inset Flex Multiple Columns
24807 \begin_layout Plain Layout
24810 The youth moved in the best society–had, so far as was known, no enemies
24811 and no particular vices.
24812 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24813 had been broken off by mutual consent some months before, and there was
24814 no sign that it had left any very profound feeling behind it.
24815 For the rest {sic} the man's life moved in a narrow and conventional circle,
24816 for his habits were quiet and his nature unemotional.
24817 Yet it was upon this easy-going young aristocrat that death came, in most
24818 strange and unexpected form, between the hours of ten and eleven-twenty
24819 on the night of March 30, 1894.
24827 \begin_layout Plain Layout
24830 Ronald Adair was fond of cards–playing continually, but never for such stakes
24832 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24833 It was shown that, after dinner on the day of his death, he had played
24834 a rubber of whist at the latter club.
24835 He had also played there in the afternoon.
24840 The evidence of those who had played with him– Mr.
24841 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24842 and that there was a fairly equal fall of the cards.
24843 Adair might have lost five pounds, but not more.
24844 His fortune was a considerable one, and such a loss could not in any way
24846 He had played nearly every day at one club or other, but he was a cautious
24847 player, and usually rose a winner.
24848 It came out in evidence that, in partnership with Colonel Moran, he had
24849 actually won as much as four hundred and twenty pounds in a sitting, some
24850 weeks before, from Godfrey Milner and Lord Balmoral.
24851 So much for his recent history as it came out at the inquest.
24859 \begin_layout Subsection
24863 \begin_layout Standard
24864 The examples in this section show some more special features of multiple
24868 \begin_layout Standard
24869 For more features of multiple columns, have a look at the documentation
24870 of the \SpecialChar LaTeX
24876 \begin_inset CommandInset citation
24886 \begin_layout Subsubsection
24890 \begin_layout Standard
24891 To add a preface text for multiple columns, set the cursor into the multicolumn
24892 inset and use the menu
24894 Insert\SpecialChar menuseparator
24898 Write your preface text into that inset.
24899 \begin_inset Newline newline
24902 This is an example with some preface text:
24905 \begin_layout Standard
24906 \begin_inset VSpace bigskip
24912 \begin_layout Standard
24913 \begin_inset Flex Multiple Columns
24916 \begin_layout Plain Layout
24917 \begin_inset Argument 2
24920 \begin_layout Plain Layout
24921 And the story continues and continues and continues and continues\SpecialChar ldots
24929 On the evening of the crime, he returned from the club exactly at ten.
24930 His mother and sister were out spending the evening with a relation.
24931 The servant deposed that she heard him enter the front room on the second
24932 floor, generally used as his sitting-room.
24933 She had lit a fire there, and as it smoked she had opened the window.
24934 No sound was heard from the room until eleven-twenty, the hour of the return
24935 of Lady Maynooth and her daughter.
24936 Desiring to say good-night, she attempted to enter her son's room.
24937 The door was locked on the inside, and no answer could be got to their
24938 cries and knocking.
24939 Help was obtained, and the door forced.
24940 The unfortunate young man was found lying near the table.
24941 His head had been horribly mutilated by an expanding revolver bullet, but
24942 no weapon of any sort was to be found in the room.
24950 \begin_layout Standard
24951 You can also use a section heading as the preface if you use a section command
24952 as \SpecialChar TeX
24954 For example the command
24957 \begin_layout Standard
24962 subsection{subsection title}
24965 \begin_layout Standard
24966 creates a subsection.
24967 In this example the preface is a subsubsection:
24970 \begin_layout Standard
24971 \begin_inset Flex Multiple Columns
24974 \begin_layout Plain Layout
24975 \begin_inset Argument 2
24978 \begin_layout Plain Layout
24982 \begin_layout Plain Layout
24991 This is a subsubsection heading as a preface
24995 \begin_layout Plain Layout
25009 A minute examination of the circumstances served only to make the case more
25011 In the first place, no reason could be given why the young man should have
25012 fastened the door upon the inside.
25013 There was the possibility that the murderer had done this, and had afterwards
25014 escaped by the window.
25015 The drop was at least twenty feet, however, and a bed of crocuses in full
25017 Neither the flowers nor the earth showed any sign of having been disturbed,
25018 nor were there any marks upon the narrow strip of grass which separated
25019 the house from the road.
25020 Apparently, therefore, it was the young man himself who had fastened the
25022 But how did he come by his death? No one could have climbed up to the window
25023 without leaving traces.
25024 Suppose a man had fired through the window, he would indeed be a remarkable
25025 shot who could with a revolver inflict so deadly a wound.
25026 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
25027 a hundred yards of the house.
25028 No one had heard a shot.
25036 \begin_layout Standard
25037 If there is less vertical space than 6
25038 \begin_inset space ~
25041 text lines is left on the page at the beginning of the multiple columns,
25042 a page break will be inserted before the multiple columns.
25043 Depending on the number of lines of the preface text, you might want to
25045 This is done by setting the cursor into the mulitcolumn inset behind the
25046 preface (if there is any) and using the menu
25048 Insert\SpecialChar menuseparator
25050 \begin_inset space ~
25054 \begin_inset space ~
25058 \begin_inset space ~
25064 Insert into that inset the amount of space like e.
25065 \begin_inset space \thinspace{}
25069 \begin_inset space \space{}
25073 \begin_inset Quotes eld
25077 \begin_inset Quotes erd
25081 \begin_inset Newline newline
25084 In this example the space is set to 7
25085 \begin_inset space ~
25088 text lines by using
25089 \begin_inset Quotes eld
25095 \begin_inset Quotes erd
25104 needs to be inserted as \SpecialChar TeX
25108 \begin_layout Standard
25109 \begin_inset Flex Multiple Columns
25112 \begin_layout Plain Layout
25113 \begin_inset Argument 3
25116 \begin_layout Plain Layout
25121 \begin_layout Plain Layout
25137 On the evening of the crime, he returned from the club exactly at ten.
25138 His mother and sister were out spending the evening with a relation.
25139 The servant deposed that she heard him enter the front room on the second
25140 floor, generally used as his sitting-room.
25141 She had lit a fire there, and as it smoked she had opened the window.
25142 No sound was heard from the room until eleven-twenty, the hour of the return
25143 of Lady Maynooth and her daughter.
25144 Desiring to say good-night, she attempted to enter her son's room.
25145 The door was locked on the inside, and no answer could be got to their
25146 cries and knocking.
25147 Help was obtained, and the door forced.
25148 The unfortunate young man was found lying near the table.
25149 His head had been horribly mutilated by an expanding revolver bullet, but
25150 no weapon of any sort was to be found in the room.
25158 \begin_layout Subsubsection
25162 \begin_layout Standard
25163 The amount of space before and after multiple columns can be changed by
25164 changing the length
25171 For example the command
25174 \begin_layout Standard
25184 \begin_layout Standard
25185 in \SpecialChar TeX
25186 Code changes its value to 3
25187 \begin_inset space \thinspace{}
25191 The change must be made before the multiple columns' start.
25192 The predefined value is 13
25193 \begin_inset space \thinspace{}
25199 \begin_layout Standard
25207 \begin_inset space \thinspace{}
25213 \begin_layout Standard
25217 \begin_layout Plain Layout
25223 multicolsep}{2.5cm}
25231 \begin_layout Standard
25232 \begin_inset Flex Multiple Columns
25235 \begin_layout Plain Layout
25238 All day I turned these facts over in my mind, endeavouring to hit upon some
25239 theory which could reconcile them all, and to find that line of least resistanc
25240 e which my poor friend had declared to be the starting-point of every investigat
25242 I confess that I made little progress.
25243 In the evening I strolled across the Park, and found myself about six o'clock
25244 at the Oxford Street end of Park Lane.
25245 A group of loafers upon the pavements, all staring up at a particular window,
25246 directed me to the house which I had come to see.
25247 A tall, thin man with coloured glasses, whom I strongly suspected of being
25248 a plain-clothes detective, was pointing out some theory of his own, while
25249 the others crowded round to listen to what he said.
25250 I got as near him as I could, but his observations seemed to me to be absurd,
25251 so I withdrew again in some disgust.
25252 As I did so I struck against an elderly, deformed man, who had been behind
25253 me, and I knocked down several books which he was carrying.
25261 \begin_layout Standard
25262 \begin_inset Note Greyedout
25265 \begin_layout Plain Layout
25270 The values you set with
25276 will be used for all following multiple columns until you change them again.
25284 \begin_layout Standard
25288 \begin_layout Plain Layout
25300 \begin_inset Note Note
25303 \begin_layout Plain Layout
25304 go back to the default
25312 \begin_layout Standard
25313 \begin_inset Newpage newpage
25319 \begin_layout Subsubsection
25323 \begin_layout Standard
25324 A column break can be forced by inserting the command
25330 as \SpecialChar TeX
25331 Code to that position in the text where the column should be broken.
25332 Note that this leads in most cases to whitespace in the text.
25333 \begin_inset Newline newline
25336 Here is an example:
25339 \begin_layout Standard
25340 \begin_inset Flex Multiple Columns
25343 \begin_layout Plain Layout
25346 \begin_inset Quotes eld
25349 You're surprised to see me, sir,
25350 \begin_inset Quotes erd
25353 said he, in a strange, croaking voice.
25356 \begin_layout Plain Layout
25359 I acknowledged that I was.
25362 \begin_layout Plain Layout
25365 \begin_inset Quotes eld
25368 Well, I've a conscience, sir, and when I chanced to see you go into this
25369 house, as I came hobbling after you, I thought to myself, I'll just step
25370 in and see that kind gentleman, and tell him that if I was a bit gruff
25371 in my manner there was not any harm meant, and that I am much obliged to
25372 him for picking up my books.
25373 \begin_inset Quotes erd
25379 \begin_layout Plain Layout
25382 \begin_inset Quotes eld
25385 You make too much of a trifle,
25386 \begin_inset Quotes erd
25391 \begin_inset Quotes eld
25394 May I ask how you knew who I was?
25395 \begin_inset Quotes erd
25398 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25402 \begin_layout Plain Layout
25414 \begin_layout Plain Layout
25417 \begin_inset Quotes eld
25420 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25421 you'll find my little bookshop at the corner of Church Street, and very
25422 happy to see you, I am sure.
25423 Maybe you collect yourself, sir.
25427 \begin_inset space ~
25440 –a bargain, every one of them.
25441 With five volumes you could just fill that gap on that second shelf.
25442 It looks untidy, does it not, sir?
25443 \begin_inset Quotes erd
25454 \begin_layout Subsubsection
25458 \begin_layout Standard
25459 The width of the columns is automatically calculated, but you can modify
25460 the space between the columns.
25461 This is done by changing the length
25468 Its predefined value is 10
25469 \begin_inset space \thinspace{}
25473 Here is an example where
25480 \begin_inset space \thinspace{}
25486 \begin_layout Standard
25490 \begin_layout Plain Layout
25504 \begin_layout Standard
25505 \begin_inset Flex Multiple Columns
25508 \begin_layout Plain Layout
25511 My observations of No.
25512 \begin_inset space \space{}
25515 427 Park Lane did little to clear up the problem in which I was interested.
25516 The house was separated from the street by a low wall and railing, the
25517 whole not more than five feet high.
25518 It was perfectly easy, therefore, for anyone to get into the garden, but
25519 the window was entirely inaccessible, since there was no water pipe or
25520 anything which could help the most active man to climb it.
25521 More puzzled than ever, I retraced my steps to Kensington.
25522 I had not been in my study five minutes when the maid entered to say that
25523 a person desired to see me.
25524 To my astonishment it was none other than my strange old book collector,
25525 his sharp, wizened face peering out from a frame of white hair, and his
25526 precious volumes, a dozen of them at least, wedged under his right arm.
25534 \begin_layout Standard
25538 \begin_layout Plain Layout
25550 \begin_inset Note Note
25553 \begin_layout Plain Layout
25554 go back to the default
25562 \begin_layout Subsubsection
25566 \begin_layout Standard
25567 Between the columns a rule with a width of the length
25574 If this rule width is set to 0
25575 \begin_inset space \thinspace{}
25578 pt (this is the default), the rule is suppressed.
25579 In the following example the rule is 2
25580 \begin_inset space \thinspace{}
25586 \begin_layout Standard
25590 \begin_layout Plain Layout
25596 columnseprule}{2pt}
25604 \begin_layout Standard
25605 \begin_inset Flex Multiple Columns
25608 \begin_layout Plain Layout
25611 \begin_inset Quotes eld
25614 You're surprised to see me, sir,
25615 \begin_inset Quotes erd
25618 said he, in a strange, croaking voice.
25621 \begin_layout Plain Layout
25624 I acknowledged that I was.
25627 \begin_layout Plain Layout
25630 \begin_inset Quotes eld
25633 Well, I've a conscience, sir, and when I chanced to see you go into this
25634 house, as I came hobbling after you, I thought to myself, I'll just step
25635 in and see that kind gentleman, and tell him that if I was a bit gruff
25636 in my manner there was not any harm meant, and that I am much obliged to
25637 him for picking up my books.
25638 \begin_inset Quotes erd
25644 \begin_layout Plain Layout
25647 \begin_inset Quotes eld
25650 You make too much of a trifle,
25651 \begin_inset Quotes erd
25656 \begin_inset Quotes eld
25659 May I ask how you knew who I was?
25660 \begin_inset Quotes erd
25666 \begin_layout Plain Layout
25669 \begin_inset Quotes eld
25672 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25673 you'll find my little bookshop at the corner of Church Street, and very
25674 happy to see you, I am sure.
25675 Maybe you collect yourself, sir.
25679 \begin_inset space ~
25692 –a bargain, every one of them.
25693 With five volumes you could just fill that gap on that second shelf.
25694 It looks untidy, does it not, sir?
25695 \begin_inset Quotes erd
25706 \begin_layout Standard
25707 \begin_inset VSpace defskip
25713 \begin_layout Standard
25714 The rule can be colored by redefining the command
25721 This is done by inserting the command
25722 \begin_inset Newline newline
25731 columnseprulecolor}{
25736 \begin_inset Newline newline
25739 as \SpecialChar TeX
25740 Code before the multicolumn inset.
25745 in this command by a color of your choice.
25746 You can use all pre- and self-defined colors.
25754 \begin_inset space ~
25759 for more information about pre- and self-defined colors.
25760 To go back to the default color insert the command
25761 \begin_inset Newline newline
25770 columnseprulecolor}{
25775 \begin_inset Newline newline
25778 Here is the example with a cyan rule and 1
25779 \begin_inset space \thinspace{}
25782 cm column separation:
25785 \begin_layout Standard
25789 \begin_layout Plain Layout
25798 \begin_layout Plain Layout
25804 columnseprulecolor}{
25814 \begin_layout Standard
25815 \begin_inset Flex Multiple Columns
25818 \begin_layout Plain Layout
25821 \begin_inset Quotes eld
25824 You're surprised to see me, sir,
25825 \begin_inset Quotes erd
25828 said he, in a strange, croaking voice.
25831 \begin_layout Plain Layout
25834 I acknowledged that I was.
25837 \begin_layout Plain Layout
25840 \begin_inset Quotes eld
25843 Well, I've a conscience, sir, and when I chanced to see you go into this
25844 house, as I came hobbling after you, I thought to myself, I'll just step
25845 in and see that kind gentleman, and tell him that if I was a bit gruff
25846 in my manner there was not any harm meant, and that I am much obliged to
25847 him for picking up my books.
25848 \begin_inset Quotes erd
25854 \begin_layout Plain Layout
25857 \begin_inset Quotes eld
25860 You make too much of a trifle,
25861 \begin_inset Quotes erd
25866 \begin_inset Quotes eld
25869 May I ask how you knew who I was?
25870 \begin_inset Quotes erd
25876 \begin_layout Plain Layout
25879 \begin_inset Quotes eld
25882 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25883 you'll find my little bookshop at the corner of Church Street, and very
25884 happy to see you, I am sure.
25885 Maybe you collect yourself, sir.
25889 \begin_inset space ~
25902 –a bargain, every one of them.
25903 With five volumes you could just fill that gap on that second shelf.
25904 It looks untidy, does it not, sir?
25905 \begin_inset Quotes erd
25916 \begin_layout Standard
25920 \begin_layout Plain Layout
25926 columnseprule}{0pt}
25929 \begin_layout Plain Layout
25935 columnseprulecolor}{
25943 \begin_inset Note Note
25946 \begin_layout Plain Layout
25947 go back to the default
25955 \begin_layout Section
25956 Non-standard Paragraph Shapes
25959 \begin_layout Standard
25962 as well as any other text processor uses by default rectangular paragraphs.
25963 For special cases like for example posters, invitation cards or poems you
25964 can modify the paragraph shape to one of your choice.
25965 This can be done by using the \SpecialChar LaTeX
25970 which is loaded by using in the document settings the module
25972 Custom paragraph shapes
25977 \begin_layout Subsection
25981 \begin_layout Standard
25986 provides the following shapes:
25989 \begin_layout Standard
25990 \begin_inset Tabular
25991 <lyxtabular version="3" rows="13" columns="3">
25992 <features booktabs="true" islongtable="true" longtabularalignment="center">
25993 <column alignment="center" valignment="middle" width="16col%">
25994 <column alignment="center" valignment="middle" width="40col%">
25995 <column alignment="center" valignment="middle" width="35col%">
25996 <row endhead="true">
25997 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26000 \begin_layout Plain Layout
26006 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26009 \begin_layout Plain Layout
26015 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26018 \begin_layout Plain Layout
26026 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26029 \begin_layout Plain Layout
26035 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26038 \begin_layout Plain Layout
26039 Circle with circular hole (in the size of a CD/DVD)
26044 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26047 \begin_layout Plain Layout
26048 Cannot be scaled, take care there is not too much text
26055 <cell alignment="center" valignment="top" topline="true" usebox="none">
26058 \begin_layout Plain Layout
26064 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26067 \begin_layout Plain Layout
26073 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26076 \begin_layout Plain Layout
26077 Fragile, calculation might fail
26084 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26087 \begin_layout Plain Layout
26093 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26096 \begin_layout Plain Layout
26097 Rhomboid (symbolizing a
26098 \begin_inset Quotes eld
26102 \begin_inset Quotes erd
26110 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26113 \begin_layout Plain Layout
26121 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26124 \begin_layout Plain Layout
26130 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26133 \begin_layout Plain Layout
26139 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26142 \begin_layout Plain Layout
26150 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26153 \begin_layout Plain Layout
26159 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26162 \begin_layout Plain Layout
26168 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26171 \begin_layout Plain Layout
26179 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26182 \begin_layout Plain Layout
26188 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26191 \begin_layout Plain Layout
26192 Nut for bolt (hexagon with circular hole)
26197 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26200 \begin_layout Plain Layout
26208 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26211 \begin_layout Plain Layout
26217 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26220 \begin_layout Plain Layout
26226 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26229 \begin_layout Plain Layout
26237 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26240 \begin_layout Plain Layout
26246 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26249 \begin_layout Plain Layout
26255 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26258 \begin_layout Plain Layout
26266 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26269 \begin_layout Plain Layout
26275 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26278 \begin_layout Plain Layout
26284 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26287 \begin_layout Plain Layout
26295 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26298 \begin_layout Plain Layout
26304 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26307 \begin_layout Plain Layout
26308 Normal/reversed rain drop
26313 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26316 \begin_layout Plain Layout
26317 Fragile, calculation might fail
26324 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26327 \begin_layout Plain Layout
26334 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26337 \begin_layout Plain Layout
26338 The \SpecialChar TeX
26344 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26347 \begin_layout Plain Layout
26355 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26358 \begin_layout Plain Layout
26360 \begin_inset Newline newline
26368 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26371 \begin_layout Plain Layout
26372 Triangles in different orientations
26377 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26380 \begin_layout Plain Layout
26394 \begin_layout Standard
26395 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26397 for environments in the toolbar.
26400 \begin_layout Standard
26401 \begin_inset Newpage newpage
26407 \begin_layout Standard
26408 Here is an example paragraph in the shape of a nut:
26411 \begin_layout Standard
26412 \begin_inset VSpace bigskip
26421 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26422 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26424 At vero eos et accusam et justo duo dolores et ea rebum.
26425 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26427 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26428 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26432 \begin_layout Standard
26433 \begin_inset VSpace bigskip
26439 \begin_layout Standard
26440 \begin_inset Note Greyedout
26443 \begin_layout Plain Layout
26448 : shapepar paragraphs cannot run over a page break.
26456 \begin_layout Standard
26457 \begin_inset VSpace bigskip
26463 \begin_layout Standard
26468 takes care that the shape will always be preserved, no matter how much
26469 text is in the paragraph.
26470 Therefore the paragraph size changes with the amount of contained text.
26471 This can lead to paragraph sizes exceeding the page margins.
26472 To demonstrate the size scaling, here is the same example paragraph but
26473 with twice as much text:
26476 \begin_layout Standard
26477 \begin_inset Newpage newpage
26486 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26487 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26489 At vero eos et accusam et justo duo dolores et ea rebum.
26490 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26492 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26493 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26495 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26496 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26498 At vero eos et accusam et justo duo dolores et ea rebum.
26499 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26501 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26502 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26506 \begin_layout Standard
26507 \begin_inset VSpace bigskip
26513 \begin_layout Standard
26514 An exception is the shape
26519 It cannot be scaled because it must fit the size of a CD/DVD.
26520 Therefore the amount of text that fits into the shape is limited.
26521 \begin_inset Newline newline
26532 shape are fragile, meaning that the calculation of their size can fail,
26533 depending on the amount of text.
26534 You will then get the \SpecialChar LaTeX
26536 \begin_inset Quotes eld
26539 Arithmetic overflow
26540 \begin_inset Quotes erd
26544 In this case one can try to remove or add some text; if nothing works one
26545 has to use another shape.
26548 \begin_layout Standard
26549 \begin_inset VSpace bigskip
26555 \begin_layout Standard
26556 For shapes with tips you will maybe see that \SpecialChar LaTeX
26557 's hyphenation routine fails
26558 for text in the tips.
26559 Therefore it is often necessary to add hyphenation points
26564 arg "specialchar-insert hyphenation"
26569 ) to the corresponding text parts.
26572 \begin_layout Standard
26573 \begin_inset VSpace bigskip
26579 \begin_layout Standard
26580 Shapepar paragraphs are either always centered or placed on the page so
26581 that their left border touches the left page margin.
26582 You can therefore not use the paragraph dialog to align such paragraphs.
26583 A solution is to put the paragraph into a minipage or parbox and align
26585 The problem is hereby to find the right width for the box.
26586 Because if it is too wide and you center the box, the paragraph is not
26587 centered too because it sticks at the left side of the box.
26588 So you might have to play a bit with the width until it fits.
26589 Here are two heart-shaped paragraphs, the first one is not aligned, the
26590 second one is right-aligned:
26593 \begin_layout Standard
26594 \begin_inset Newpage newpage
26600 \begin_layout Heart
26604 Lo\SpecialChar softhyphen
26605 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26606 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26608 At vero eos et accusam et justo duo dolores et ea rebum.
26609 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26613 \begin_layout Standard
26614 \begin_inset VSpace bigskip
26620 \begin_layout Standard
26623 \begin_inset Box Frameless
26633 height_special "totalheight"
26638 backgroundcolor "none"
26641 \begin_layout Heart
26645 Lo\SpecialChar softhyphen
26646 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26647 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26649 At vero eos et accusam et justo duo dolores et ea rebum.
26650 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26659 \begin_layout Subsection
26663 \begin_layout Standard
26664 You can define any shape you want.
26665 Doing this manually is a lot of work because every coordinate must be specified.
26666 But there is a way to let the computer calculate the coordinates:
26669 \begin_layout Enumerate
26670 Install the program
26671 \begin_inset CommandInset href
26674 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26682 \begin_layout Enumerate
26689 TeX/LaTeX\SpecialChar menuseparator
26690 Settings\SpecialChar menuseparator
26693 and select the font size you are using in your document.
26694 For example this document uses the size 12
26695 \begin_inset space \thinspace{}
26701 \begin_layout Enumerate
26705 \begin_layout Enumerate
26708 TeX/LaTeX\SpecialChar menuseparator
26711 to export the shape to coordinates.
26712 In the appearing dialog use either the outline of your shape for the coordinate
26713 s or the path itself.
26717 \begin_layout Plain Layout
26718 For more information see
26719 \begin_inset CommandInset href
26721 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26734 \begin_layout Standard
26735 The coordinates are written into a \SpecialChar TeX
26737 To use it for your \SpecialChar LyX
26741 \begin_layout Enumerate
26742 Place the cursor before the first character of your paragraph (or into a
26746 \begin_layout Enumerate
26747 Open in \SpecialChar LyX
26750 Insert\SpecialChar menuseparator
26751 File\SpecialChar menuseparator
26753 \begin_inset space ~
26758 , select the file and use
26767 \begin_layout Standard
26768 \begin_inset VSpace defskip
26774 \begin_layout Standard
26775 \begin_inset Note Greyedout
26778 \begin_layout Plain Layout
26783 : The changed shape only applies to the current paragraph; everything is
26784 reset to normal for the next paragraph.
26785 Therefore the shape definition file must be input into every paragraph
26786 with the desired shape.
26794 \begin_layout Standard
26795 \begin_inset VSpace bigskip
26801 \begin_layout Standard
26802 Here is an example:
26805 \begin_layout Standard
26806 \begin_inset VSpace bigskip
26812 \begin_layout Standard
26813 \begin_inset CommandInset include
26815 filename "SpecialParagraphShape.tex"
26821 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26822 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26824 At vero eos et accusam et justo duo dolores et ea rebum.
26825 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26827 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26828 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26832 \begin_layout Standard
26833 \begin_inset VSpace bigskip
26839 \begin_layout Standard
26844 to draw complexer shapes in
26848 you can draw the shape in a program of your choice and import the resulting
26854 Then you only need to draw a line or spline along the outline of the image.
26857 \begin_layout Standard
26858 \begin_inset VSpace bigskip
26864 \begin_layout Standard
26867 Custom paragraph shapes
26869 also provides the two commands
26877 which can be used to define custom shapes coordinate by coordinate.
26881 \begin_layout Plain Layout
26882 These commands are internally used for all shapes described here.
26887 For information how these styles are used and about further customization
26888 possibilities, have a look at the documentation of the package
26893 \begin_inset CommandInset citation
26903 \begin_layout Bibliography
26904 \begin_inset CommandInset bibitem
26905 LatexCommand bibitem
26911 Documentation of the \SpecialChar LaTeX
26913 \begin_inset CommandInset href
26916 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26924 \begin_layout Bibliography
26925 \begin_inset CommandInset bibitem
26926 LatexCommand bibitem
26932 Documentation of the \SpecialChar LaTeX
26934 \begin_inset CommandInset href
26937 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"