1 #LyX 2.3 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
40 \maintain_unincluded_children false
42 \language_package default
45 \font_roman "lmodern" "default"
46 \font_sans "lmss" "default"
47 \font_typewriter "lmtt" "default"
48 \font_math "auto" "auto"
49 \font_default_family default
50 \use_non_tex_fonts false
53 \font_sf_scale 100 100
54 \font_tt_scale 100 100
56 \use_dash_ligatures true
58 \default_output_format pdf2
60 \bibtex_command default
61 \index_command default
65 \pdf_title "LyX's Additional Features manual"
66 \pdf_author "LyX Team"
67 \pdf_subject "LyX's additional features documentation"
68 \pdf_keywords "LyX, Documentation, Additional"
70 \pdf_bookmarksnumbered true
71 \pdf_bookmarksopen false
72 \pdf_bookmarksopenlevel 1
77 \pdf_pdfusetitle false
78 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
81 \use_package amsmath 1
82 \use_package amssymb 1
85 \use_package mathdots 1
86 \use_package mathtools 0
88 \use_package stackrel 0
89 \use_package stmaryrd 0
90 \use_package undertilde 0
92 \cite_engine_type default
96 \paperorientation portrait
101 \notefontcolor #0000ff
108 \paragraph_separation indent
109 \paragraph_indentation default
111 \math_indentation default
112 \math_numbering_side default
113 \quotes_style english
117 \paperpagestyle headings
118 \tracking_changes true
119 \output_changes false
123 \author -712698321 "Jürgen Spitzmüller"
129 Additional \SpecialChar LyX
133 \begin_layout Subtitle
138 by the \SpecialChar LyX
143 \begin_layout Plain Layout
145 Principal maintainer of this file is
150 If you have comments or error corrections, please send them to the \SpecialChar LyX
153 \begin_inset Flex Code
156 \begin_layout Plain Layout
158 <lyx-docs@lists.lyx.org>
171 \begin_layout Standard
172 \begin_inset CommandInset toc
173 LatexCommand tableofcontents
180 \begin_layout Chapter
184 \begin_layout Standard
185 This manual is essentially Part II of the
187 User's Guide\SpecialChar endofsentence
190 The reason for separating the two documents is simple: the
194 is already quite lengthy, and it contains information on all of the basic
195 features one needs to know in order to prepare most documents.
196 However, the \SpecialChar LyX
197 Team has worked to make \SpecialChar LyX
198 extensible through various configuration
199 files and external packages.
200 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
202 create a layout file (or module) for it without having to alter \SpecialChar LyX
204 We've already had contributions of several new features this way, and some
205 of them are documented here.
206 There are also some more `advanced' features, such as how to control the
207 presentation of bibliographies and how to work with multi-part documents,
208 that are not covered in the
212 and are discussed here.
215 \begin_layout Standard
216 This manual also documents some special features, like fax support, version
217 control, and SGML support, which require additional software to work properly.
218 There is also a chapter on \SpecialChar LyX
220 And lastly, there's a chapter of \SpecialChar LaTeX
221 tools and tips, things you can use to
222 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
224 After all, \SpecialChar LyX
229 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
233 \begin_layout Standard
234 If you haven't read the
238 yet, you are definitely in the wrong manual.
243 is the first place to go, since it describes the notation and format of
245 You should also be thoroughly familiar with the
249 and all of the basic features of \SpecialChar LyX
250 before attempting to read this one.
253 \begin_layout Standard
254 Since many of the topics in this manual depend heavily on \SpecialChar LyX
256 with \SpecialChar LaTeX
257 , this first chapter covers the inner workings of \SpecialChar LyX
260 to generate exactly the \SpecialChar LaTeX
262 It is obviously for more seasoned \SpecialChar LyX
266 \begin_layout Chapter
268 and \SpecialChar LaTeX
272 \begin_layout Section
274 Uses \SpecialChar LaTeX
278 \begin_layout Standard
279 This chapter is for both \SpecialChar TeX
280 -nicians and the \SpecialChar LaTeX
282 In it, we'll explain how \SpecialChar LyX
283 and \SpecialChar LaTeX
284 work together to produce printable output.
285 This is the only place in any of the manuals where we assume you know something
286 about \SpecialChar LaTeX
290 \begin_layout Standard
291 At one time, \SpecialChar LyX
293 \begin_inset Quotes eld
296 WYSIWYM frontend to \SpecialChar LaTeX
298 \begin_inset Quotes erd
301 but that's no longer true.
302 There are frontends to \SpecialChar LaTeX
307 \begin_layout Plain Layout
308 Some familar ones are \SpecialChar TeX
309 maker and kile, on Linux, and \SpecialChar TeX
311 There are also the \SpecialChar LaTeX
312 modes for vi and emacs, of course.
317 These are basically text editors with the ability to run \SpecialChar LaTeX
319 errors in the file you're editing.
320 Although \SpecialChar LyX
329 run \SpecialChar LaTeX
330 , and it also indicates errors in the file, it also does much, much
332 For one thing, you don't need to know \SpecialChar LaTeX
333 to use \SpecialChar LyX
336 has added its own extensions to \SpecialChar LaTeX
338 Try the following sometime: select
339 \begin_inset Flex Noun
342 \begin_layout Plain Layout
343 Export\SpecialChar menuseparator
350 \begin_inset Flex Noun
353 \begin_layout Plain Layout
360 \begin_inset Flex Noun
363 \begin_layout Plain Layout
364 View\SpecialChar menuseparator
374 ), then look at the preamble of the resulting
375 \begin_inset Flex Code
378 \begin_layout Plain Layout
385 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
387 These macros are defined automatically, according to the features you use
391 \begin_layout Standard
392 There are several commands that automatically invoke \SpecialChar LaTeX
397 \begin_layout Itemize
398 \begin_inset Flex Noun
401 \begin_layout Plain Layout
402 Document\SpecialChar menuseparator
411 \begin_layout Itemize
412 \begin_inset Flex Noun
415 \begin_layout Plain Layout
416 Document\SpecialChar menuseparator
425 \begin_layout Standard
426 They will only invoke \SpecialChar LaTeX
427 if the file has changed since the last time \SpecialChar LaTeX
433 \begin_layout Standard
434 When \SpecialChar LyX
435 runs \SpecialChar LaTeX
436 on the file you're editing, it performs these steps:
439 \begin_layout Enumerate
440 Convert the document to \SpecialChar LaTeX
441 and save to a file with the extension
442 \begin_inset Flex Code
445 \begin_layout Plain Layout
452 \begin_inset Flex Code
455 \begin_layout Plain Layout
464 \begin_layout Enumerate
465 Run \SpecialChar LaTeX
467 \begin_inset Flex Code
470 \begin_layout Plain Layout
476 file (maybe several times), and run any other commands (such as
477 \begin_inset Flex Code
480 \begin_layout Plain Layout
487 \begin_inset Flex Code
490 \begin_layout Plain Layout
496 ) needed to compile the \SpecialChar LaTeX
500 \begin_layout Enumerate
501 If there are any errors, show the error log.
504 \begin_layout Standard
505 If you have run \SpecialChar LaTeX
507 \begin_inset Flex Noun
510 \begin_layout Plain Layout
511 View\SpecialChar menuseparator
518 then runs a DVI viewer to display the DVI-file.
520 \begin_inset Flex Noun
523 \begin_layout Plain Layout
524 View\SpecialChar menuseparator
531 performs further steps:
534 \begin_layout Itemize
536 \begin_inset Flex Code
539 \begin_layout Plain Layout
545 to convert the DVI file to PostScript.
548 \begin_layout Itemize
549 Run a PostScript viewer, such as
550 \begin_inset Flex Code
553 \begin_layout Plain Layout
559 , to display the PostScript file.
562 \begin_layout Standard
564 does similar things when viewing, or exporting, other formats.
567 \begin_layout Section
568 Translating \SpecialChar LaTeX
569 files into \SpecialChar LyX
573 \begin_layout Standard
574 You can import a \SpecialChar LaTeX
575 file into \SpecialChar LyX
577 \begin_inset Flex Noun
580 \begin_layout Plain Layout
581 File\SpecialChar menuseparator
582 Import\SpecialChar menuseparator
588 command in \SpecialChar LyX
590 This will call a program named
591 \begin_inset Flex Code
594 \begin_layout Plain Layout
600 which will create a file
601 \begin_inset Flex Code
604 \begin_layout Plain Layout
611 \begin_inset Flex Code
614 \begin_layout Plain Layout
622 will then open that file.
626 \begin_layout Plain Layout
627 \begin_inset Flex Code
630 \begin_layout Plain Layout
636 can also be run from the command line, of course.
644 \begin_layout Standard
645 \begin_inset Flex Code
648 \begin_layout Plain Layout
654 will translate most legal \SpecialChar LaTeX
655 , but not everything.
656 It will put things it doesn't understand into \SpecialChar TeX
657 code, so after translating
659 \begin_inset Flex Code
662 \begin_layout Plain Layout
668 , you can look for \SpecialChar TeX
669 code and hand-edit it until it looks right.
672 \begin_layout Standard
673 If you don't know what \SpecialChar TeX
674 code is, read the next section.
677 \begin_layout Section
678 \begin_inset CommandInset label
680 name "sec:Inserting-TeX-Code"
684 Inserting \SpecialChar TeX
685 Code into \SpecialChar LyX
689 \begin_layout Standard
690 Anything you can do in \SpecialChar LaTeX
691 you can do in \SpecialChar LyX
692 , for a very simple reason: You can
693 always insert \SpecialChar TeX
694 code into any \SpecialChar LyX
697 cannot, and will never be able to, display every possible \SpecialChar LaTeX
699 If ever you need to insert \SpecialChar LaTeX
700 commands into your \SpecialChar LyX
701 document, you can use the
703 \begin_inset Flex Code
706 \begin_layout Plain Layout
713 box, which you can insert into your document with
714 \begin_inset Flex Noun
717 \begin_layout Plain Layout
718 Insert\SpecialChar menuseparator
728 or the keyboard shortcut
737 \begin_layout Standard
738 Here's an example of inserting \SpecialChar LaTeX
739 commands in a \SpecialChar LyX
741 The code looks like this:
744 \begin_layout LyX-Code
748 \begin_inset Newline newline
754 \begin_inset Newline newline
757 This is an example of a minipage environment.
759 \begin_inset Newline newline
762 can put nearly everything in it, even (non-floating)
763 \begin_inset Newline newline
768 \begin_inset Newline newline
774 \begin_inset Newline newline
778 \begin_inset Newline newline
784 \begin_inset Newline newline
790 \begin_inset Newline newline
796 \begin_inset Newline newline
801 \begin_inset Newline newline
807 \begin_inset Newline newline
813 \begin_inset Newline newline
819 \begin_inset Newline newline
827 \begin_layout LyX-Code
831 \begin_layout Standard
833 \begin_inset Flex Code
836 \begin_layout Plain Layout
843 box containing this text is directly after this paragraph.
844 Those of you reading the manual in \SpecialChar LyX
845 will only see the \SpecialChar TeX
847 Those reading a printed version of the manuals will see the actual results:
848 \begin_inset VSpace bigskip
854 \begin_layout Standard
858 \begin_layout Plain Layout
865 \begin_layout Plain Layout
872 \begin_layout Plain Layout
874 This is an example of a minipage environment.
875 You can put nearly everything in it, even (non-floating) figures and tables.
879 \begin_layout Plain Layout
886 \begin_layout Plain Layout
891 \begin_layout Plain Layout
898 \begin_layout Plain Layout
905 \begin_layout Plain Layout
912 \begin_layout Plain Layout
918 \begin_layout Plain Layout
925 \begin_layout Plain Layout
932 \begin_layout Plain Layout
939 \begin_layout Plain Layout
949 \begin_inset VSpace bigskip
955 \begin_layout Standard
956 In addition to using \SpecialChar TeX
957 code, you can also create a separate file containing
958 some complex \SpecialChar LaTeX
959 structure and then use
960 \begin_inset Flex Noun
963 \begin_layout Plain Layout
964 Insert\SpecialChar menuseparator
974 to include your file (you should select the type
975 \begin_inset Flex Code
978 \begin_layout Plain Layout
985 We recommend that you only do this if you have a
986 \begin_inset Flex Code
989 \begin_layout Plain Layout
1000 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1004 \begin_layout Standard
1005 There are a few last points to emphasize:
1008 \begin_layout Itemize
1014 check if your \SpecialChar LaTeX
1018 \begin_layout Itemize
1019 Beware of reinventing the wheel.
1022 \begin_layout Standard
1023 On that last point, \SpecialChar LyX
1024 does have quite a few features tucked into it, and
1026 Be sure to check the manuals to make sure that \SpecialChar LyX
1027 doesn't have such-and-such
1028 feature before you decide you have to do it by hand.
1029 Moreover, there are numerous \SpecialChar LaTeX
1030 packages out there to do all sorts of things,
1031 from labels to envelopes to fancy multipage tables.
1033 \begin_inset CommandInset href
1036 target "http://www.ctan.org/"
1044 \begin_layout Standard
1045 If you do need to do some wild and fancy things within your document, be
1046 sure to check out a good \SpecialChar LaTeX
1047 book for assistance.
1048 There are a number of them listed in the bibliography of the
1055 \begin_layout Section
1057 and the \SpecialChar LaTeX
1061 \begin_layout Subsection
1062 About the \SpecialChar LaTeX
1066 \begin_layout Standard
1067 If you already know \SpecialChar LaTeX
1068 , there is no need to explain here what the preamble
1070 If you don't, the following will give you some ideas—we recommend again
1071 that you consult a \SpecialChar LaTeX
1072 book for further information.
1073 In any case, you should read the points below, because they explain what
1074 you can do and what you don't need to do in the \SpecialChar LaTeX
1075 preamble of a \SpecialChar LyX
1079 \begin_layout Standard
1080 The \SpecialChar LaTeX
1081 preamble comes at the very beginning of a document,
1089 \begin_layout Itemize
1090 Declare the document class.
1092 \begin_inset Newline newline
1096 already does this for you.
1097 If you're a seasoned \SpecialChar LaTeX
1098 -nician, and you have a custom document class you
1099 want to use, check out the
1101 Customization Manual
1103 for information on how to make \SpecialChar LyX
1107 \begin_layout Itemize
1108 Declare the usage of packages.
1110 \begin_inset Newline newline
1114 packages provide special commands, which are only available within a document
1115 when the package has been declared in the preamble.
1116 In addition to providing special commands, the inclusion of a package can
1117 change the document.
1118 For example, the package
1119 \begin_inset Flex Code
1122 \begin_layout Plain Layout
1128 forces all paragraphs to be indented.
1129 There are other packages for labels, envelopes, margins, etc.
1133 \begin_layout Itemize
1134 Set counters, variables, lengths and widths.
1136 \begin_inset Newline newline
1139 There are several \SpecialChar LaTeX
1140 counters and variables that
1144 be set globally from within the preamble in order to have the desired effect.
1145 (There are variables that you can set and reset inside the document, too.)
1146 Margins are a good example of something that must be set in the preamble.
1147 Another example is the label format for lists.
1148 You can actually set these just about anywhere, but it's best to do it
1149 just once, inside the preamble.
1152 \begin_layout Itemize
1153 Declare user defined commands (with
1154 \begin_inset Flex Code
1157 \begin_layout Plain Layout
1166 \begin_inset Flex Code
1169 \begin_layout Plain Layout
1178 \begin_inset Newline newline
1181 These are abbreviations for \SpecialChar LaTeX
1182 commands which appear very often inside a document.
1183 Although the preamble is a good place to declare such commands, they
1187 be declared anywhere (before they are used for the first time, of course).
1188 This can be useful if there is a lot of raw \SpecialChar LaTeX
1189 code in your document, which
1190 normally should not be the case.
1193 \begin_layout Standard
1195 adds its own set of definitions to the preamble of the
1196 \begin_inset Flex Code
1199 \begin_layout Plain Layout
1206 This makes \SpecialChar LaTeX
1207 files generated by \SpecialChar LyX
1211 \begin_layout Subsection
1212 Changing the Preamble
1215 \begin_layout Standard
1216 The commands which \SpecialChar LyX
1217 adds to the preamble of a \SpecialChar LaTeX
1218 file are fixed; you can't
1219 change them without patching \SpecialChar LyX
1221 You can, however, add your own stuff to the preamble by selecting
1222 \begin_inset Flex Noun
1225 \begin_layout Plain Layout
1228 \begin_inset space ~
1237 \begin_inset Flex Noun
1240 \begin_layout Plain Layout
1241 Document\SpecialChar menuseparator
1249 adds anything in the
1250 \begin_inset Flex Noun
1253 \begin_layout Plain Layout
1259 dialog to its own built-in preamble.
1260 Before adding your own declarations in the preamble, you should make sure
1261 that \SpecialChar LyX
1262 doesn't already support what you want to do.
1263 (Remember what we said about reinventing the wheel?) Also,
1265 make sure your preamble code is correct
1269 doesn't check it for you.
1270 If there is an error, you're likely to get an error like
1271 \begin_inset Quotes eld
1275 \begin_inset Flex Code
1278 \begin_layout Plain Layout
1287 \begin_inset Quotes erd
1291 If you see this error, check your preamble.
1294 \begin_layout Subsection
1298 \begin_layout Standard
1299 Here are some examples of what you can add to a preamble, and what they
1303 \begin_layout Subsubsection
1307 \begin_layout Standard
1308 There are two variables under \SpecialChar LaTeX
1309 that control page position:
1310 \begin_inset Flex Code
1313 \begin_layout Plain Layout
1322 \begin_inset Flex Code
1325 \begin_layout Plain Layout
1334 Their names should be self-explanatory.
1335 These variables are useful if you think for a moment about computer labels.
1336 Sometimes, the size of a print medium and the area of the medium that you
1337 can actually print on aren't the same.
1339 \begin_inset Flex Code
1342 \begin_layout Plain Layout
1351 \begin_inset Flex Code
1354 \begin_layout Plain Layout
1365 \begin_layout Standard
1366 The default values for
1367 \begin_inset Flex Code
1370 \begin_layout Plain Layout
1379 \begin_inset Flex Code
1382 \begin_layout Plain Layout
1391 \begin_inset space \thinspace{}
1395 \begin_inset space \thinspace{}
1399 \begin_inset space \space{}
1402 the page isn't shifted.
1403 Unfortunately, some DVI drivers always seem to shift the page.
1404 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1405 If you're using \SpecialChar LyX
1406 on a system that you don't personally maintain, and your
1407 sysadmin is a doofus,
1408 \begin_inset Flex Code
1411 \begin_layout Plain Layout
1420 \begin_inset Flex Code
1423 \begin_layout Plain Layout
1432 Suppose your left and top margins are always 0.5
1433 \begin_inset space \thinspace{}
1437 You can add this to the preamble:
1440 \begin_layout LyX-Code
1448 \begin_layout LyX-Code
1456 \begin_layout Standard
1457 and your margins should now be correct.
1460 \begin_layout Subsubsection
1464 \begin_layout Standard
1465 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1466 There's a rather nice package, available at your nearest CTAN archive,
1467 for printing sheets of labels:
1468 \begin_inset Flex Code
1471 \begin_layout Plain Layout
1478 Now, your system may not have this package installed by default.
1479 We leave that up to you to check.
1480 You'll also want to read the documentation for it; we're not going to do
1482 Since this is an example, however, we'll give you an example of how you
1486 \begin_layout Standard
1487 First, make sure you're using the
1488 \begin_inset Flex Code
1491 \begin_layout Plain Layout
1498 Next, you need to put the following in your preamble:
1501 \begin_layout LyX-Code
1507 \begin_layout LyX-Code
1513 \begin_layout LyX-Code
1519 \begin_layout LyX-Code
1525 \begin_layout LyX-Code
1531 \begin_layout LyX-Code
1537 \begin_layout LyX-Code
1543 \begin_layout Standard
1544 This sets things up for Avery label sheets, stock #5360.
1545 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1548 \begin_inset Flex Code
1551 \begin_layout Plain Layout
1560 \begin_inset Flex Code
1563 \begin_layout Plain Layout
1571 around each label text.
1572 This and other special features of
1573 \begin_inset Flex Code
1576 \begin_layout Plain Layout
1582 are explained in its documentation.
1585 \begin_layout Standard
1586 Someday, someone may write a \SpecialChar LyX
1587 layout file to support this package directly.
1588 Maybe that someone is you.
1591 \begin_layout Subsubsection
1592 Example #3: Paragraph Indentation
1595 \begin_layout Standard
1596 Americans are trained to indent the first line of
1601 As with all of their other weird quirks, most Americans will whine and
1602 moan until they can have their way and indent the first line of all paragraphs.
1611 \begin_layout Standard
1612 Of course, this behavior isn't standard typography.
1613 In books, you typically only indent the first line of a paragraph
1617 it follows another one.
1618 The idea behind indenting the first line of a paragraph is to distinguish
1619 neighboring paragraphs from one another.
1620 If there is no previous paragraph—for example, if it follows a figure or
1621 is the first paragraph in a section—then there is no need for indentation.
1625 \begin_layout Standard
1626 If you're a typical American (we're still joking!), though, you don't care
1627 about such esoteric things; you want your indentation! Add this to the
1631 \begin_layout LyX-Code
1634 usepackage{indentfirst}
1637 \begin_layout Standard
1638 If your \SpecialChar TeX
1639 distribution isn't braindead, you'll have this package, and all
1640 of your paragraphs will get the indentation the Founding Fathers intended
1644 \begin_layout Subsubsection
1645 Example #4: This Document
1648 \begin_layout Standard
1649 You can also check out the preamble of this document to get an idea of some
1650 of the advanced things you can do.
1653 \begin_layout Section
1655 and \SpecialChar LaTeX
1659 \begin_layout Standard
1660 When \SpecialChar LyX
1661 calls \SpecialChar LaTeX
1662 , it tells \SpecialChar LaTeX
1663 to blithely ignore any errors and keep going.
1664 It then uses the logfile from the \SpecialChar LaTeX
1665 run to do a post-mortem.
1666 After analyzing the logfile, \SpecialChar LyX
1667 displays a dialog listing the errors.
1668 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1670 where the error occurred.
1674 \begin_layout Plain Layout
1676 Analyzing the logfile is a tough job, and \SpecialChar LyX
1677 doesn't always go to the right
1679 There are also cases where \SpecialChar LaTeX
1680 reports the error on one line, but the actual
1682 This is not unlike forgetting a closing brace in a program: You'll get
1683 an error, but only later.
1691 \begin_layout Standard
1692 Some folks also like to look at the log file directly: It is available from
1694 \begin_inset Flex Noun
1697 \begin_layout Plain Layout
1698 Document\SpecialChar menuseparator
1700 \begin_inset space ~
1709 There are some fairly common error messages and warnings.
1710 We'll cover those here.
1711 You should look at a good \SpecialChar LaTeX
1712 book for a complete listing.
1715 \begin_layout Itemize
1716 \begin_inset Flex Code
1719 \begin_layout Plain Layout
1726 \begin_inset Newline newline
1729 Anything beginning with these words is a warning message for the purpose
1731 \begin_inset Quotes eld
1735 \begin_inset Quotes erd
1738 the \SpecialChar LaTeX
1740 You'll get messages like this if you added or changed cross-references
1741 or bibliography entries, in which case, \SpecialChar LaTeX
1742 is trying to tell you that you
1743 need to make another run.
1744 You can by-and-large ignore these.
1747 \begin_layout Itemize
1748 \begin_inset Flex Code
1751 \begin_layout Plain Layout
1758 \begin_inset Newline newline
1761 Another warning message, this time about fonts which \SpecialChar LaTeX
1763 The rest of the message will often say something about a replacement font
1764 that \SpecialChar LaTeX
1766 You can safely ignore these, too.
1769 \begin_layout Itemize
1770 \begin_inset Flex Code
1773 \begin_layout Plain Layout
1782 \begin_inset Newline newline
1791 They are warnings about lines that were too long and run past the right
1793 Almost always, this is unnoticeable in the final output.
1794 (It can be just a point or two.) Or, only one or two characters extend past
1797 seems to generate at least one of these messages for just about any document
1799 \begin_inset Newline newline
1802 You can ignore these messages.
1803 Your eyes will tell you if there's a problem with something that's too
1804 wide; just look at the output.
1808 \begin_layout Plain Layout
1809 You can also enable the `draft' option in
1810 \begin_inset Flex Noun
1813 \begin_layout Plain Layout
1814 Document\SpecialChar menuseparator
1820 , and then \SpecialChar LaTeX
1821 will draw a black box in the margin of lines that are overfull.
1829 \begin_layout Itemize
1830 \begin_inset Flex Code
1833 \begin_layout Plain Layout
1842 \begin_inset Newline newline
1845 Not quite as common as its cousin.
1847 seems to like to print lines that are a bit too wide as opposed to ones
1848 that are a bit too narrow.
1849 We have no idea why.
1852 \begin_layout Itemize
1853 \begin_inset Flex Code
1856 \begin_layout Plain Layout
1865 \begin_inset Flex Code
1868 \begin_layout Plain Layout
1877 \begin_inset Newline newline
1880 Warnings about troubles breaking the page.
1881 Once again, just look at the output.
1882 Your eyes will tell you where something has gone wrong.
1885 \begin_layout Itemize
1886 \begin_inset Flex Code
1889 \begin_layout Plain Layout
1891 \begin_inset Quotes els
1895 \begin_inset Quotes ers
1904 \begin_inset Newline newline
1908 \begin_inset Quotes eld
1912 \begin_inset Quotes erd
1915 isn't installed on this system.
1916 This usually appears because some package your document needs isn't installed.
1917 If you didn't touch the preamble or didn't use the
1918 \begin_inset Flex Code
1921 \begin_layout Plain Layout
1929 command, then one of the packages \SpecialChar LyX
1930 tried to load is missing.
1932 \begin_inset Flex Noun
1935 \begin_layout Plain Layout
1936 Help\SpecialChar menuseparator
1943 to get a list of packages that \SpecialChar LyX
1945 This file is updated whenever you reconfigure \SpecialChar LyX
1947 \begin_inset Flex Noun
1950 \begin_layout Plain Layout
1951 Tools\SpecialChar menuseparator
1957 ) and tells you which packages have been detected and what they do.
1958 \begin_inset Newline newline
1962 \begin_inset Flex Code
1965 \begin_layout Plain Layout
1973 command and the package in question isn't installed, then you'll need to
1974 install it yourself.
1977 \begin_layout Itemize
1978 \begin_inset Flex Code
1981 \begin_layout Plain Layout
1982 LaTeX Error: Unknown option
1988 \begin_inset Newline newline
1991 Error messages beginning with this are trying to tell you that you specified
1992 a bad or undefined option to a package.
1993 Check the package's documentation.
1996 \begin_layout Itemize
1997 \begin_inset Flex Code
2000 \begin_layout Plain Layout
2001 Undefined control sequence
2007 \begin_inset Newline newline
2010 If you've inserted \SpecialChar LaTeX
2011 code into your document, but made a typo, you'll get
2013 You may have forgotten to load a package.
2014 In any case, this error message usually means that you used an undefined
2019 \begin_layout Standard
2020 There are other error and warning messages.
2021 Some are self-explanatory.
2022 These are usually \SpecialChar LaTeX
2024 Others are downright cryptic.
2025 These are usually \SpecialChar TeX
2026 error messages, and we really have
2030 what they mean or how to decipher them.
2034 \begin_layout Standard
2035 There's a general sequence you should follow if you get error messages:
2038 \begin_layout Enumerate
2039 Look at the \SpecialChar LaTeX
2040 code you inserted for typos.
2043 \begin_layout Enumerate
2044 If there are no typos, check that you used the command(s) correctly.
2047 \begin_layout Enumerate
2048 If you get a bunch of error boxes piled up at the very top of the document—and
2049 especially if you see a
2050 \begin_inset Quotes eld
2054 \begin_inset Flex Code
2057 \begin_layout Plain Layout
2066 \begin_inset Quotes erd
2069 error—it means that there are errors in the preamble.
2070 Start debugging your preamble.
2073 \begin_layout Enumerate
2074 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2076 document, the first suspect is your \SpecialChar LaTeX
2077 distribution itself.
2078 Check for missing packages and install them.
2081 \begin_layout Enumerate
2082 Okay, so there are no missing packages.
2083 Did you use any of the fine-tuning options in \SpecialChar LyX
2084 ? Specifically, did you
2088 any of them, like trying to manually insert lots of
2089 \begin_inset Flex Code
2092 \begin_layout Plain Layout
2094 \begin_inset space ~
2103 \begin_inset Flex Code
2106 \begin_layout Plain Layout
2113 \begin_inset Flex Code
2116 \begin_layout Plain Layout
2122 ? Did you try to kludge something together with these instead of using the
2123 appropriate paragraph environment?
2126 \begin_layout Enumerate
2127 All right, you didn't use any of the fine-tuning options, you played by
2129 Did you try to pull a fancy maneuver? Did you do something funky inside
2130 a table or an equation, like inserting a graphic into a table cell?
2133 \begin_layout Enumerate
2134 Do you have long sections of text where \SpecialChar LaTeX
2135 cannot find a place to break a
2136 line? By default, \SpecialChar LaTeX
2137 is rather strict about how much extra inter-word spacing
2138 it will add in order to break a line.
2139 Preferably, you should rework the paragraph to avoid the problem.
2142 \begin_layout Enumerate
2143 Did you go overboard with the nesting? \SpecialChar LyX
2144 (currently) doesn't check to make
2145 sure you're in the limits for nesting environments.
2146 If you nested a bunch of environments to the
2147 \begin_inset Formula $17^{\mathrm{th}}$
2150 level, that's the problem.
2151 (The limit in \SpecialChar LaTeX
2155 \begin_layout Enumerate
2156 Okay, you didn't get any error messages, but your output looks awful.
2157 If you have a table or figure that's too wide or long for the page, you
2162 \begin_layout Enumerate
2163 rescale the figure so it fits.
2166 \begin_layout Enumerate
2167 trim down the table so it fits.
2171 \begin_layout Enumerate
2172 If something else is wrong with the output, and you didn't try to pull anything
2173 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2176 \begin_layout Standard
2177 If all this doesn't help—well, then
2181 you might have found a bug in \SpecialChar LyX
2186 \begin_layout Chapter
2190 \begin_layout Section
2191 Customizing Bibliographies with Bib\SpecialChar TeX
2195 \begin_layout Standard
2196 The most basic information about how to use Bib\SpecialChar TeX
2201 with \SpecialChar LyX
2202 is contained in the section
2204 Bibliography databases
2211 The following subsections explain special bibliography features supported
2216 \begin_layout Subsection
2217 Alternative Citation Styles
2220 \begin_layout Standard
2221 Standard Bib\SpecialChar TeX
2223 \begin_inset space \thinspace{}
2227 \begin_inset space \space{}
2231 \begin_inset Quotes eld
2235 \begin_inset Quotes erd
2238 ) to refer to a cited work.
2239 However, in many scientific disciplines, other citation styles are in use.
2240 The most common one is the author-year style (e.
2241 \begin_inset space \thinspace{}
2245 \begin_inset space \space{}
2249 \begin_inset Quotes eld
2253 \begin_inset Quotes erd
2258 supports three packages that provide this style,
2259 \begin_inset Flex Code
2262 \begin_layout Plain Layout
2269 \begin_inset Flex Code
2272 \begin_layout Plain Layout
2279 \begin_inset Flex Code
2282 \begin_layout Plain Layout
2289 Each of these packages has their pros and cons, which cannot be listed
2291 If you only want to have simple author-year (or author-numerical) style,
2292 or if you want to use one of the countless style files for
2293 \begin_inset Flex Code
2296 \begin_layout Plain Layout
2302 , then the established
2303 \begin_inset Flex Code
2306 \begin_layout Plain Layout
2312 package is probably your choice.
2313 If you look for specific citation styles common in law studies, you might
2315 \begin_inset Flex Code
2318 \begin_layout Plain Layout
2325 If you want to have full control over the formatting or look for advanced
2326 features such as ibidem, footnote citations, full title citations, advanced
2327 date formats (such as 400 BC) or full localization to other languages than
2328 English, you should definitely consider
2329 \begin_inset Flex Code
2332 \begin_layout Plain Layout
2338 , which exceeds all other packages in terms of features, but is also quite
2339 heavy and more resource-hungry.
2342 \begin_layout Standard
2343 The handling of these packages in \SpecialChar LyX
2344 is basically the same.
2346 \begin_inset Flex Noun
2349 \begin_layout Plain Layout
2350 Document\SpecialChar menuseparator
2357 \begin_inset Flex Noun
2360 \begin_layout Plain Layout
2367 \begin_inset Flex Noun
2370 \begin_layout Plain Layout
2377 \begin_inset Flex Noun
2380 \begin_layout Plain Layout
2387 \begin_inset Flex Noun
2390 \begin_layout Plain Layout
2391 Biblatex (Natbib mode)
2397 \begin_inset Flex Noun
2400 \begin_layout Plain Layout
2407 \begin_inset Flex Noun
2410 \begin_layout Plain Layout
2417 \begin_inset space ~
2420 6.5.3 in the User's Guide for more information on these choices).
2421 With all these packages, you will get some extra features in the citation
2422 dialog and you can select the style of the reference (
2423 \begin_inset Quotes eld
2427 \begin_inset Quotes erd
2431 \begin_inset Quotes eld
2435 \begin_inset Quotes erd
2439 \begin_inset Quotes eld
2443 \begin_inset Quotes erd
2447 \begin_inset Quotes eld
2451 \begin_inset Quotes erd
2455 Note that either package needs specifically designed style files.
2456 They all ship their own, but there are lots of additional style files,
2457 and there is even an interactive style file builder
2461 \begin_layout Plain Layout
2463 \begin_inset Flex URL
2466 \begin_layout Plain Layout
2468 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2479 \begin_inset Flex Code
2482 \begin_layout Plain Layout
2491 \begin_layout Subsection
2492 Subdivided Bibliographies
2495 \begin_layout Standard
2496 Sometimes you might need to divide your bibliography into several sections.
2497 If you are for instance a historian, the possibility to separate sources
2498 and scientific works is most likely a
2499 \begin_inset Quotes eld
2503 \begin_inset Quotes erd
2507 Unfortunately, Bib\SpecialChar TeX
2508 itself does not allow you to do this.
2509 But with the help of some \SpecialChar LaTeX
2510 packages, Bib\SpecialChar TeX
2511 can be extended to fit your needs.
2514 \begin_layout Standard
2516 provides native support for one of these packages,
2524 \begin_layout Plain Layout
2526 \begin_inset Flex URL
2529 \begin_layout Plain Layout
2531 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2541 The advantage of this package (compared to other packages such as
2545 ) is that you don't need to define new citation commands.
2546 Instead, you need to prepare different bibliographic databases which include
2547 the entries for the different sections of the bibliography.
2548 For example: If you want to divide your bibliography into the sections
2550 \begin_inset Quotes eld
2554 \begin_inset Quotes erd
2558 \begin_inset Quotes eld
2562 \begin_inset Quotes erd
2565 , you first need to create two bibliographic databases, e.
2566 \begin_inset space \thinspace{}
2570 \begin_inset space \space{}
2574 \begin_inset Flex Code
2577 \begin_layout Plain Layout
2584 \begin_inset Flex Code
2587 \begin_layout Plain Layout
2597 \begin_layout Standard
2599 \begin_inset Flex Noun
2602 \begin_layout Plain Layout
2603 Document\SpecialChar menuseparator
2610 \begin_inset Flex Noun
2613 \begin_layout Plain Layout
2620 \begin_inset Flex Noun
2623 \begin_layout Plain Layout
2624 Subdivided bibliography
2630 Now you can insert multiple Bib\SpecialChar TeX
2631 bibliographies, one for each section of
2633 Returning to our example: Insert the Bib\SpecialChar TeX
2635 \begin_inset Flex Code
2638 \begin_layout Plain Layout
2644 and a second one for the database
2645 \begin_inset Flex Code
2648 \begin_layout Plain Layout
2655 You are free to use the same or different styles for each section.
2656 Additionally, you can choose if the bibliography section should contain
2658 \begin_inset Quotes eld
2661 all cited references
2662 \begin_inset Quotes erd
2665 of the specified database(s) (which is the default),
2666 \begin_inset Quotes eld
2669 all uncited references
2670 \begin_inset Quotes erd
2674 \begin_inset Quotes eld
2678 \begin_inset Quotes erd
2682 This might be useful if you would like to separate your bibliography into
2684 \begin_inset Quotes eld
2688 \begin_inset Quotes erd
2692 \begin_inset Quotes eld
2696 \begin_inset Quotes erd
2700 \begin_inset Quotes eld
2704 \begin_inset Quotes erd
2708 The titles for the sections can be added as ordinary sections or subsections.
2710 \begin_inset Flex Code
2713 \begin_layout Plain Layout
2719 removes the bibliography title, you have to manually re-add that, too (as
2720 a chapter* or section*, for instance).
2723 \begin_layout Standard
2728 , the procedure is a bit different.
2737 , the aforementioned
2738 \begin_inset Flex Noun
2741 \begin_layout Plain Layout
2742 Subdivided bibliography
2747 option is disabled if you use
2756 provides its own means to generate subdivided bibliographies.
2757 You can either add keywords to bibliography entries via the
2758 \begin_inset Flex Code
2761 \begin_layout Plain Layout
2767 entry option and then filter bibliography sections by keyword (by adding
2769 \begin_inset Flex Code
2772 \begin_layout Plain Layout
2779 \begin_inset Flex Noun
2782 \begin_layout Plain Layout
2788 field of the dialog that opens if you right-click on the
2789 \begin_inset Flex Noun
2792 \begin_layout Plain Layout
2793 Biblatex Generated Bibliography
2798 button), or you can filter by entry types (such as
2807 \begin_inset space \thinspace{}
2812 \begin_inset Flex Code
2815 \begin_layout Plain Layout
2822 \begin_inset Flex Code
2825 \begin_layout Plain Layout
2832 \begin_inset Flex Noun
2835 \begin_layout Plain Layout
2841 field, or you can create so-called
2842 \begin_inset Quotes eld
2845 Bibliography Categories
2846 \begin_inset Quotes erd
2849 to which you can assign individual entries.
2850 Please refer to the Biblatex manual, section
2852 Subdivided Bibliographies
2857 \begin_layout Subsection
2858 Multiple Bibliographies
2861 \begin_layout Standard
2862 Multiple bibliographies, e.
2863 \begin_inset space \thinspace{}
2867 \begin_inset space \space{}
2870 a bibliography for each part, chapter, section, subsection or child (sub-documen
2871 t) of the document, are also supported by \SpecialChar LyX
2873 In order to enable it, go to
2874 \begin_inset Flex Noun
2877 \begin_layout Plain Layout
2878 Document\SpecialChar menuseparator
2879 Settings\SpecialChar menuseparator
2885 and select the relevant unit (e.
2886 \begin_inset space \thinspace{}
2890 \begin_inset Quotes eld
2894 \begin_inset Quotes erd
2898 \begin_inset Flex Noun
2901 \begin_layout Plain Layout
2902 Multiple Bibliographies
2908 Then add a Bib(la)\SpecialChar TeX
2909 bibliography to each unit (e.
2910 \begin_inset space \thinspace{}
2913 g., section) of your document.
2914 In the output, a separate bibliography, containing only the references
2915 done in the current unit is generated.
2918 \begin_layout Standard
2919 If you use Bib\SpecialChar TeX
2921 \begin_inset Flex Code
2924 \begin_layout Plain Layout
2931 \change_deleted -712698321 1501067466
2933 \change_inserted -712698321 1501067466
2937 \begin_inset Flex Code
2940 \begin_layout Plain Layout
2946 package is used to create multiple bibliographies.
2947 The former package is used if you select
2948 \begin_inset Quotes eld
2952 \begin_inset Quotes erd
2960 \begin_inset Flex Noun
2963 \begin_layout Plain Layout
2964 Sectioned Bibliography
2971 \begin_inset Flex Code
2974 \begin_layout Plain Layout
2984 \begin_layout Plain Layout
2985 An alternative approach, if you are willing to use some
2986 \begin_inset Flex Noun
2989 \begin_layout Plain Layout
2997 \begin_inset space ~
3001 \begin_inset CommandInset ref
3003 reference "sec:Inserting-TeX-Code"
3008 \begin_inset Flex Code
3011 \begin_layout Plain Layout
3023 \begin_inset Flex Code
3026 \begin_layout Plain Layout
3032 is used, \SpecialChar LyX
3033 encloses the specified units in
3034 \begin_inset Flex Code
3037 \begin_layout Plain Layout
3044 \begin_inset Flex Code
3047 \begin_layout Plain Layout
3056 \begin_inset Flex Code
3059 \begin_layout Plain Layout
3067 in order to create the units.
3068 Note that this approach has some limitations.
3069 First, every citation reference has to be inside some
3070 \begin_inset Flex Code
3073 \begin_layout Plain Layout
3080 So citations outside a defined unit (e.
3081 \begin_inset space \thinspace{}
3084 g., before the first section if you use
3085 \begin_inset Quotes eld
3089 \begin_inset Quotes erd
3093 \begin_inset Quotes eld
3097 \begin_inset Quotes erd
3101 You can also create your own units by entering
3102 \begin_inset Flex Code
3105 \begin_layout Plain Layout
3114 \begin_inset Flex Code
3117 \begin_layout Plain Layout
3126 code (for instance to work around the mentioned limitation).
3128 \begin_inset Flex Code
3131 \begin_layout Plain Layout
3138 A second limitation is that
3139 \begin_inset Flex Code
3142 \begin_layout Plain Layout
3148 always processes all references of a bibliography database, even if they
3150 This can result in odd labels (e.
3151 \begin_inset space \thinspace{}
3156 \begin_inset Quotes eld
3160 \begin_inset Quotes erd
3163 if two works of this author from 2014 are in the database, even if only
3167 \begin_layout Standard
3173 \begin_inset Flex Code
3176 \begin_layout Plain Layout
3182 option is used instead.
3183 If you need specific units, you can start them with the \SpecialChar TeX
3185 \begin_inset Flex Code
3188 \begin_layout Plain Layout
3197 \begin_inset Flex Code
3200 \begin_layout Plain Layout
3209 If you also want to control the end of the unit, use the environment
3210 \begin_inset Flex Code
3213 \begin_layout Plain Layout
3223 \begin_inset Flex Code
3226 \begin_layout Plain Layout
3236 \begin_inset Flex Code
3239 \begin_layout Plain Layout
3246 In addition to the individual bibliography of the current unit,
3250 also provides an easy way to output all bibliographies, subsequently, at
3252 \begin_inset space \thinspace{}
3255 g., at the end of the document).
3257 \begin_inset Quotes eld
3261 \begin_inset Quotes erd
3264 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3270 manual for more information on this topic.
3273 \begin_layout Section
3277 \begin_layout Subsection
3281 \begin_layout Standard
3282 When you are working on a large file with many sections, it is often convenient
3283 to break up the document into several files, or perhaps you have something
3284 where a table may change from time to time, but the preceding text does
3286 In these cases, you should seriously consider using multipart documents.
3287 For example, scientific papers often have five major sections: the introduction
3288 , observations, results, discussion, and conclusion.
3289 Each of these could be its own separate \SpecialChar LyX
3291 \begin_inset Quotes eld
3295 \begin_inset Quotes erd
3298 file which contains the title, authors, abstract, references, etc., plus
3299 the five included files.
3300 It is important to note that each of these files is a full \SpecialChar LyX
3302 can be formatted and printed on its own, as well as included in a master
3304 Each of these files must have the same document class, however—don't attempt
3305 to mix book classes with article classes.
3306 You may also include \SpecialChar LaTeX
3307 files; however, these files must not have their own
3309 \begin_inset space \thinspace{}
3313 \begin_inset space \space{}
3316 everything up to and including the
3317 \begin_inset Flex Code
3320 \begin_layout Plain Layout
3329 \begin_inset Flex Code
3332 \begin_layout Plain Layout
3340 line must be deleted) or else errors will be generated when you try to
3344 \begin_layout Standard
3346 allows you to include files quite easily with
3347 \begin_inset Flex Noun
3350 \begin_layout Plain Layout
3351 Insert\SpecialChar menuseparator
3353 \begin_inset space ~
3362 When you click on this selection a small box is inserted into the file
3363 at the current cursor location.
3364 Clicking on the box raises a dialog which allows you to select the file
3365 to be included, and the method of its inclusion.
3369 \begin_layout Standard
3370 The file selection box should by now be obvious.
3371 The three inclusion methods are
3372 \begin_inset Quotes eld
3376 \begin_inset Quotes erd
3380 \begin_inset Quotes eld
3384 \begin_inset Quotes erd
3388 \begin_inset Quotes eld
3392 \begin_inset Quotes erd
3396 The difference between
3397 \begin_inset Quotes eld
3401 \begin_inset Quotes erd
3405 \begin_inset Quotes eld
3409 \begin_inset Quotes erd
3412 is really only meaningful to \SpecialChar LaTeX
3413 perts, but the practical difference is that
3415 \begin_inset Quotes eld
3419 \begin_inset Quotes erd
3422 are typeset beginning on a new page, while files that are
3423 \begin_inset Quotes eld
3427 \begin_inset Quotes erd
3430 are typeset starting on the current page.
3433 \begin_layout Standard
3434 Generally, the master file is converted into a full \SpecialChar LaTeX
3435 file before typesetting,
3436 while the included files are converted to \SpecialChar LaTeX
3437 files that do not have all the
3438 preamble information.
3441 \begin_layout Standard
3443 \begin_inset Quotes eld
3447 \begin_inset Quotes erd
3450 included file allows you to include a file typeset exactly as it appears
3452 \begin_inset space \thinspace{}
3456 \begin_inset space \space{}
3460 \begin_inset Flex Code
3463 \begin_layout Plain Layout
3469 mode, with the characters set in a fixed-width typewriter font.
3470 Normally, spaces in this file are invisible, though two consecutive spaces
3471 are conserved, unlike \SpecialChar LyX
3472 's normal treatment of spaces.
3473 However, setting the
3474 \begin_inset Flex Noun
3477 \begin_layout Plain Layout
3479 \begin_inset space ~
3483 \begin_inset space ~
3487 \begin_inset space ~
3495 checkbox typesets a mark to unambiguously define the presence of a space.
3499 \begin_layout Subsection
3500 Cross-References Between Files
3503 \begin_layout Standard
3504 \begin_inset Box Shadowbox
3514 height_special "totalheight"
3519 backgroundcolor "none"
3522 \begin_layout Plain Layout
3523 This section is somewhat out of date.
3524 Need to describe default master documents and how children are opened when
3534 \begin_layout Standard
3535 It is possible to set up cross-references between the different files.
3536 First, open all the files in question: let's call them A and B in a two
3537 file example, where B is included in A.
3538 Let's say you insert a label in A, then want to reference it in B.
3539 Open the cross-reference dialog whilst in document B, and you can select
3541 \begin_inset Quotes eld
3545 \begin_inset Quotes erd
3551 \begin_layout Subsection
3552 Bibliography Lists in all Subdocuments
3555 \begin_layout Standard
3556 \begin_inset Box Frameless
3566 height_special "totalheight"
3571 backgroundcolor "none"
3574 \begin_layout Plain Layout
3575 This section also needs updating.
3576 There is now material about this on the wiki, and it could be copied here.
3584 \begin_layout Standard
3585 Copy the bibliography list with all entries to all subdocuments and transform
3587 This way \SpecialChar LyX
3589 \begin_inset Flex Code
3592 \begin_layout Plain Layout
3598 -files and you can easily insert references without making the bibliography
3602 \begin_layout Standard
3603 As the bibliography list is in a comment, \SpecialChar LaTeX
3604 won't use it and the references
3605 will look like this: [?], instead of like this: [1].
3606 One solution is to use the \SpecialChar LaTeX
3608 \begin_inset Flex Code
3611 \begin_layout Plain Layout
3617 that will only include comments by processing the files separately.
3618 To do this, add in the \SpecialChar LaTeX
3619 preamble of every subdocument the following:
3622 \begin_layout LyX-Code
3628 \begin_layout LyX-Code
3631 includecomment{comment}
3634 \begin_layout Standard
3636 \begin_inset Flex URL
3639 \begin_layout Plain Layout
3641 http://wiki.lyx.org/FAQ/Unsorted#toc31
3649 \begin_layout Section
3654 \begin_layout Standard
3655 Users sometimes need to be able to
3656 \begin_inset Quotes eld
3660 \begin_inset Quotes erd
3664 file together with all the images (and other files) on which it depends,
3665 either for sending to a publisher or for sharing with a co-author.
3667 2.0 includes a Python script (
3668 \begin_inset Flex Code
3671 \begin_layout Plain Layout
3677 ) that automates this process.
3678 To use it, you must have either the
3679 \begin_inset Flex Code
3682 \begin_layout Plain Layout
3689 \begin_inset Flex Code
3692 \begin_layout Plain Layout
3698 python modules installed on your system.
3699 By default, the script prefers the
3700 \begin_inset Flex Code
3703 \begin_layout Plain Layout
3710 \begin_inset Flex Code
3713 \begin_layout Plain Layout
3719 format on Unix-like systems and the
3720 \begin_inset Flex Code
3723 \begin_layout Plain Layout
3732 \begin_layout Standard
3734 's configuration process will set the script up to export a `\SpecialChar LyX
3736 and this format will then be available under
3737 \begin_inset Flex Code
3740 \begin_layout Plain Layout
3741 File\SpecialChar menuseparator
3750 \begin_layout Standard
3751 Independently of the platform, the generation of a particular archive format
3752 can be forced by adding either the
3753 \begin_inset Flex Code
3756 \begin_layout Plain Layout
3763 \begin_inset Flex Code
3766 \begin_layout Plain Layout
3773 \begin_inset Flex Code
3776 \begin_layout Plain Layout
3783 \begin_inset Flex Code
3786 \begin_layout Plain Layout
3792 format) switch to the
3793 \begin_inset Flex Code
3796 \begin_layout Plain Layout
3798 \SpecialChar menuseparator
3806 \begin_inset Flex Code
3809 \begin_layout Plain Layout
3810 Tools\SpecialChar menuseparator
3811 Preferences\SpecialChar menuseparator
3812 File Handling\SpecialChar menuseparator
3819 (Make sure you add the switch after the script name, not before it.)
3822 \begin_layout Section
3823 Fancy Headers and Footers
3826 \begin_layout Standard
3827 The default page layout is rather plain; for an
3828 \begin_inset Flex Code
3831 \begin_layout Plain Layout
3837 document class, all you get is a centered page number at the bottom of
3839 This document uses KOMA-script's book class, so it appears to be a bit
3841 But to really put on a show, you need to set the document page style to
3843 \begin_inset Quotes eld
3847 \begin_inset Quotes erd
3850 , as mentioned in the
3855 This section describes the \SpecialChar LaTeX
3856 code you need to insert in your \SpecialChar LaTeX
3858 order to get the desired effects.
3861 \begin_layout Standard
3862 For more information on fancy headers, see the
3863 \begin_inset Flex Code
3866 \begin_layout Plain Layout
3872 package documentation.
3874 \begin_inset Flex URL
3877 \begin_layout Plain Layout
3879 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3887 \begin_layout Standard
3888 The page header is divided into three fields, not surprisingly labeled
3889 \begin_inset Quotes eld
3893 \begin_inset Quotes erd
3897 \begin_inset Quotes eld
3901 \begin_inset Quotes erd
3905 \begin_inset Quotes eld
3909 \begin_inset Quotes erd
3913 The footer is also divided into these three fields.
3914 The \SpecialChar LaTeX
3915 commands to set these fields in the simplest manner are
3916 \begin_inset Flex Code
3919 \begin_layout Plain Layout
3928 \begin_inset Flex Code
3931 \begin_layout Plain Layout
3940 \begin_inset Flex Code
3943 \begin_layout Plain Layout
3952 \begin_inset Flex Code
3955 \begin_layout Plain Layout
3964 Suppose you wish to put your name in the upper left hand corner of each
3966 Simply insert the following command in the preamble:
3969 \begin_layout Standard
3978 \begin_layout Standard
3979 You will now see your name in the upper left.
3980 If a field has a default entry that you would like to get rid of (often
3981 the page number appears in the central footer) simply include a command
3982 with a blank argument, e.
3983 \begin_inset space \thinspace{}
3989 \begin_layout Standard
3997 \begin_layout Standard
3998 Let's get really fancy: lets put the section number with the word
3999 \begin_inset Quotes eld
4003 \begin_inset Quotes erd
4007 \begin_inset space \thinspace{}
4011 \begin_inset space \space{}
4014 Section 3) in the upper left, the page number (e.
4015 \begin_inset space \thinspace{}
4019 \begin_inset space \space{}
4022 Page 4) in the upper right, your name in the lower left, and the date in
4024 The following commands should now appear in the preamble:
4027 \begin_layout Standard
4037 \begin_layout Standard
4045 \begin_layout Standard
4055 \begin_layout Standard
4064 \begin_layout Standard
4072 \begin_layout Standard
4082 \begin_layout Standard
4084 \begin_inset Flex Code
4087 \begin_layout Plain Layout
4096 \begin_inset Flex Code
4099 \begin_layout Plain Layout
4107 access \SpecialChar LaTeX
4108 's section and page counters, and so print out the current section
4111 \begin_inset Flex Code
4114 \begin_layout Plain Layout
4122 simply prints out today's date.
4125 \begin_layout Standard
4126 The thicknesses of the horizontal rules drawn beneath the header and above
4127 the footer can also be modified.
4128 If you don't want one of the rules, set its thickness to 0.
4129 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4135 \begin_inset Flex Code
4138 \begin_layout Plain Layout
4143 headrulewidth}{0.4pt}
4149 \begin_inset Flex Code
4152 \begin_layout Plain Layout
4157 footrulewidth}{0.4pt}
4162 to set the thicknesses.
4165 \begin_layout Standard
4166 You can switch the header/footer settings on and off for individual pages
4168 \begin_inset Flex Code
4171 \begin_layout Plain Layout
4174 thispagestyle{empty}
4180 \begin_inset Flex Code
4183 \begin_layout Plain Layout
4186 thispagestyle{plain}
4192 \begin_inset Flex Code
4195 \begin_layout Plain Layout
4198 thispagestyle{fancy}
4204 Simply insert them in the text on the page you want changed and mark them
4207 In fact, title pages are marked as plain by default, while following pages
4208 are marked fancy when using the global fancy setting.
4211 \begin_layout Standard
4212 As a final example, it is possible to include an image in the header or
4214 Suppose you want to put a company logo in the upper lefthand corner.
4215 You might try something like
4218 \begin_layout Standard
4227 includegraphics{logo.eps}}}
4230 \begin_layout Standard
4232 (you may need to preface this with
4233 \begin_inset Flex Code
4236 \begin_layout Plain Layout
4240 usepackage{graphics}
4245 if you don't include graphics elsewhere in your document).
4248 \begin_layout Section
4249 Itemize Bullet Selection
4250 \begin_inset CommandInset label
4259 \begin_layout Standard
4265 \begin_layout Subsection
4269 \begin_layout Standard
4271 provides 216 bullet shapes that can be accessed from a simple dialog.
4272 Using this dialog you can easily specify what bullet shape to use at each
4273 level of an itemized list.
4274 These settings are document-wide so you won't be able to specify different
4275 sets of bullets for different paragraphs.
4279 \begin_layout Plain Layout
4280 Well, actually you can but you'll have to do it by hand.
4288 \begin_layout Subsection
4292 \begin_layout Standard
4293 Open the dialog by selecting the
4294 \begin_inset Flex Noun
4297 \begin_layout Plain Layout
4298 Document\SpecialChar menuseparator
4304 menu item and then select the
4305 \begin_inset Flex Noun
4308 \begin_layout Plain Layout
4317 \begin_layout Standard
4318 The dialog provides you with a table of bullet shapes.
4319 A column of buttons on the left of the table provides access to the six
4320 different panels of bullet shapes.
4321 The row of buttons across the top is used to select which bullet depth
4323 A text entry under the table shows the currently selected bullet shape's
4325 equivalent and this can be edited if desired.
4326 If you do modify the text you will also need to specify any needed packages
4327 in the \SpecialChar LaTeX
4331 \begin_layout Standard
4332 The six panels are divided up by the packages they require.
4333 The following table shows the mappings from button name to \SpecialChar LaTeX
4337 \begin_layout Standard
4339 \begin_inset Tabular
4340 <lyxtabular version="3" rows="7" columns="2">
4341 <features tabularvalignment="middle">
4342 <column alignment="center" valignment="top" width="0pt">
4343 <column alignment="center" valignment="top" width="0pt">
4345 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4348 \begin_layout Plain Layout
4363 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4366 \begin_layout Plain Layout
4383 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4386 \begin_layout Plain Layout
4401 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4404 \begin_layout Plain Layout
4413 base \SpecialChar LaTeX
4421 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4424 \begin_layout Plain Layout
4439 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4442 \begin_layout Plain Layout
4459 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4462 \begin_layout Plain Layout
4477 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4480 \begin_layout Plain Layout
4497 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4500 \begin_layout Plain Layout
4515 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4518 \begin_layout Plain Layout
4535 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4538 \begin_layout Plain Layout
4553 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4556 \begin_layout Plain Layout
4573 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4576 \begin_layout Plain Layout
4591 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4594 \begin_layout Plain Layout
4617 \begin_layout Standard
4619 doesn't stop you using bullets from packages you don't have.
4620 If you get errors from \SpecialChar LaTeX
4621 when you try to view or print the file, then it
4622 is likely you are missing a package.
4626 \begin_layout Plain Layout
4628 doesn't restrict your use since you may be editing locally and exporting
4637 \begin_layout Subsection
4641 \begin_layout Standard
4642 Select which bullet depth you want to change then select the bullet shape
4644 Any changes will not be visible in \SpecialChar LyX
4645 , but are visible when viewing the document.
4648 \begin_layout Standard
4649 You can reset a bullet shape to the default simply by clicking your right
4650 mouse button on the appropriate bullet depth button.
4654 \begin_layout Plain Layout
4659 want to have multiple sets of paragraphs with different sets of bullets
4660 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4662 The bullet selection dialog can help though because it provides you with
4663 the \SpecialChar LaTeX
4664 code for a wide range of bullet shapes.
4665 To make your own custom paragraphs you have the following options:
4668 \begin_layout Plain Layout
4672 \begin_layout Plain Layout
4688 \begin_layout Plain Layout
4692 \begin_layout Plain Layout
4714 \begin_layout Itemize
4715 Use the \SpecialChar LaTeX
4717 \begin_inset Flex Code
4720 \begin_layout Plain Layout
4728 to specify a new bullet shape for a given depth.
4729 You'll also need to save the current bullet shape so you can restore it
4731 In this itemized list the following \SpecialChar LaTeX
4732 code was used to change the bullet
4733 used for the first depth.
4737 \begin_layout LyX-Code
4747 \begin_layout LyX-Code
4764 \begin_layout Itemize
4765 Note that the itemize depth is specified in Roman numerals as part of the
4775 \begin_layout Itemize
4779 \begin_layout Plain Layout
4792 Specify each individual entry by starting each item with the bullet shape
4793 enclosed in square brackets and set as
4794 \begin_inset Flex Noun
4797 \begin_layout Plain Layout
4805 For example, this item was started with
4806 \begin_inset Flex Code
4809 \begin_layout Plain Layout
4824 \begin_layout Plain Layout
4828 \begin_layout Plain Layout
4844 \begin_layout Plain Layout
4845 You'll also need to revert the labelitem back to its previous setting for
4846 the global bullet shape settings to remain in effect.
4847 The way used here was:
4850 \begin_layout LyX-Code
4865 \begin_layout Chapter
4867 and the World Wide Web
4870 \begin_layout Standard
4872 has long supported the export of documents to various web-friendly formats,
4875 \change_inserted -712698321 1501076595
4878 on 2.0, however, HTML export was always accomplished by the use of external
4883 \begin_layout Plain Layout
4884 For details on the use of external converters with \SpecialChar LyX
4889 section of the Customization manual.
4894 These fall into two large groups: there are converters that use \SpecialChar LaTeX
4896 intermediate format, such as
4897 \begin_inset Flex Code
4900 \begin_layout Plain Layout
4907 \begin_inset Flex Code
4910 \begin_layout Plain Layout
4917 \begin_inset Flex Code
4920 \begin_layout Plain Layout
4926 , relying upon \SpecialChar LyX
4927 to produce the \SpecialChar LaTeX
4928 ; and there is a converter that works directly
4931 \begin_inset Flex Code
4934 \begin_layout Plain Layout
4942 All of these have different advantages and disadvantages.
4946 \begin_layout Standard
4947 The \SpecialChar LaTeX
4948 -based converters have the advantage that, in principle, they know everythin
4949 g about the exported document that \SpecialChar LaTeX
4951 Such converters do not care, for example, if a certain block of code was
4952 produced by \SpecialChar LyX
4953 or was Evil Red Text.
4954 These converters know about
4955 \begin_inset Flex Code
4958 \begin_layout Plain Layout
4964 files, counters, and references, and can often make use of the
4965 \begin_inset Flex Code
4968 \begin_layout Plain Layout
4974 files generated by Bib\SpecialChar TeX
4976 On the other hand, \SpecialChar LaTeX
4977 is a very hard language to parse—it is sometimes said
4978 that only \SpecialChar TeX
4979 itself understands \SpecialChar TeX
4980 —and \SpecialChar LaTeX
4981 -based converters will often choke on
4982 what seem to be quite simple constructs; complex ones can throw them completely
4983 , and as of this writing, for example, the
4987 manual will not export with
4988 \begin_inset Flex Code
4991 \begin_layout Plain Layout
4997 , though the others will.
4998 The other issue concerns how math is handled.
4999 These converters typically convert the formulae into little pictures that
5000 are then linked from the HTML document.
5001 Since these are actually generated by \SpecialChar LaTeX
5002 , they are accurate.
5003 But they do not scale well, and just getting them to look as if they are
5004 actually meant to be in your document—so that the font sizes seem to be
5005 roughly the same—can be a challenge.
5008 \begin_layout Standard
5010 \begin_inset Flex Code
5013 \begin_layout Plain Layout
5021 \begin_inset CommandInset href
5023 name "http://elyxer.nongnu.org/"
5024 target "http://elyxer.nongnu.org/"
5029 ) solves some of these problems.
5030 In particular, the formulae it produces scale perfectly, since it renders
5031 math using a combination of HTML and CSS rather than converting the formulae
5033 But even moderately complex formula are rendered less well than with
5034 \begin_inset Flex Code
5037 \begin_layout Plain Layout
5043 ; this reflects the limitations of HTML.
5047 \begin_layout Plain Layout
5049 \begin_inset Flex Code
5052 \begin_layout Plain Layout
5059 can also use jsMath and MathJax for equations, but this setting is only
5060 available globally and requires one to have access to a server that runs
5066 More importantly (as of version 1.1.1, at least),
5067 \begin_inset Flex Code
5070 \begin_layout Plain Layout
5077 has limited support for math macros and no support for user-defined paragraph
5078 or character styles.
5079 These limitations make
5080 \begin_inset Flex Code
5083 \begin_layout Plain Layout
5090 unsuitable for many of the documents \SpecialChar LyX
5092 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5094 have decided to follow a different path and have made \SpecialChar LyX
5096 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5097 , DocBook, and plaintext.
5100 \begin_layout Standard
5101 As of this writing, XHTML output remains under development and should probably
5103 \begin_inset Quotes eld
5107 \begin_inset Quotes erd
5114 \begin_layout Plain Layout
5116 \begin_inset Flex Code
5119 \begin_layout Plain Layout
5121 \change_inserted -712698321 1501078933
5129 , which can be found in the \SpecialChar LyX
5131 \begin_inset CommandInset href
5133 name "accessed online"
5134 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5139 , usually contains up-to-date information about the state of XHTML output.
5140 See also the list of XHTML bugs on
5141 \begin_inset CommandInset href
5143 name "the bug tracker"
5144 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"
5154 Still, the developers have chosen this approach because it has several
5155 potential advantages over the other two.
5158 \begin_layout Standard
5159 These advantages are primarily due to the fact that the XHTML output routines,
5160 since they are part of \SpecialChar LyX
5161 , know everything \SpecialChar LyX
5162 knows about the document being
5167 \begin_layout Plain Layout
5168 Another advantage is that, since these routines are internal to \SpecialChar LyX
5170 immune to changes in \SpecialChar LyX
5171 's file format, or to changes in the semantics of
5177 So they know about the table of contents (as displayed in the outline),
5178 about the counters associated with different paragraph styles, and about
5179 user-defined styles.
5180 The XHTML output routines know what \SpecialChar LyX
5181 knows about internationalization,
5182 too, so they will output
5183 \begin_inset Quotes eld
5187 \begin_inset Quotes erd
5191 \begin_inset Quotes eld
5199 \begin_inset Quotes erd
5202 , depending upon the language in effect at the time.
5206 \begin_layout Standard
5207 Quite generally, the output routines know what \SpecialChar LyX
5208 knows about document layout,
5209 that is, about how the document is to be rendered on screen.
5210 We use this information when we output the document as XHTML.
5211 In particular, \SpecialChar LyX
5216 generates CSS style information corresponding to the layout information
5217 it uses to render the document on screen: if section headings are supposed
5218 to be sans-serif and bold as seen in \SpecialChar LyX
5219 , then (by default) they will be sans-seri
5220 f and bold when viewed in a web browser, too.
5221 And this is true not just for pre-defined styles, like Section, but for
5222 any style, including user-defined styles.
5223 Indeed, the XHTML output routines make no distinction between user-defined
5224 paragraph and character styles and \SpecialChar LyX
5225 's own pre-defined styles: in each case,
5226 everything \SpecialChar LyX
5227 knows about the styles is contained in the layout files.
5228 And much the same is true as regards pre-defined textual insets, such as
5229 footnotes, and various custom insets.
5233 \begin_layout Standard
5234 The result is that XHTML output can be customized and extended in exactly
5235 the same way \SpecialChar LaTeX
5236 output can be customized and extended: through layout files
5238 See chapter five of the
5242 manual for the details.
5245 \begin_layout Standard
5246 The remainder of this chapter contains more detailed information on XHTML
5247 output, its limitations, and ways to work around those limitations.
5250 \begin_layout Section
5251 Math Output in XHTML
5254 \begin_layout Standard
5256 offers four choices for how math is rendered.
5257 These have various advantages and disadvantages:
5260 \begin_layout Itemize
5262 \begin_inset Newline newline
5265 MathML is a dialect of XML designed specifically for mathematics on the
5266 web, and it typically renders very well in browsers that support it.
5267 The disadvantage is that not all browsers support MathML, and support is
5268 not complete even in the Gecko-based browsers, such as Firefox.
5269 \begin_inset Newline newline
5273 is unable to render a formula as MathML—for example, if the formula
5275 \begin_inset Flex Code
5278 \begin_layout Plain Layout
5284 package or ERT—then it will instead output the formula as an image.
5288 \begin_layout Itemize
5290 \begin_inset Newline newline
5294 \begin_inset Flex Code
5297 \begin_layout Plain Layout
5303 outputs math as HTML, styled by CSS.
5307 \begin_layout Plain Layout
5309 has borrowed some of the CSS for its HTML output from
5310 \begin_inset Flex Code
5313 \begin_layout Plain Layout
5324 For simple formulae, this can work quite well, though with more complicated
5325 formulae it tends to break down.
5326 Still, this method has the advantage that it is very widely supported and
5327 so it may be appropriate for documents that contain only a little, fairly
5329 \begin_inset Newline newline
5332 If Lyx is unable to render a formula as HTML—for example, if the formula
5334 \begin_inset Flex Code
5337 \begin_layout Plain Layout
5343 package or ERT—then it will instead output the formula as an image.
5347 \begin_layout Itemize
5349 \begin_inset Newline newline
5353 \begin_inset Flex Code
5356 \begin_layout Plain Layout
5363 will output formulae as images, the very same images, in fact, that are
5364 used for instant preview.
5368 \begin_layout Plain Layout
5369 Instant preview does
5373 have to be on for images to be output, however.
5378 The advantage to this method is that the images are simply generated by
5380 , so they are very accurate.
5381 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5382 so they do not scale terribly well, and one cannot copy them, etc.
5384 \change_deleted -712698321 1501075981
5385 (As of this writing, there are also problems about equation numbering.
5387 \begin_inset CommandInset href
5390 target "http://www.lyx.org/trac/ticket/6894"
5398 \begin_inset Newline newline
5401 The size of the images can be controlled by setting the
5402 \begin_inset Quotes eld
5406 \begin_inset Quotes erd
5410 \begin_inset Flex Noun
5413 \begin_layout Plain Layout
5414 Document\SpecialChar menuseparator
5415 Settings\SpecialChar menuseparator
5417 \change_deleted -712698321 1501076136
5419 \change_inserted -712698321 1501076137
5431 \begin_layout Plain Layout
5432 For those who want to know, this controls the resolution of the image in
5433 dots per inch and is based upon a default of 75 dpi.
5439 \begin_inset Newline newline
5443 for some reason fails to create an image for a formula (e.g., if a required
5445 package is not installed), then it will fall back to outputing the raw
5450 \begin_layout Itemize
5453 \begin_inset Newline newline
5456 Finally, \SpecialChar LyX
5457 will happily output math as \SpecialChar LaTeX
5459 As well as being the output of last resort, this method can be used with
5461 \begin_inset CommandInset href
5464 target "http://www.math.union.edu/~dpvc/jsMath/"
5469 , which uses JavaScript to render \SpecialChar LaTeX
5470 embedded in HTML documents.
5472 wraps the \SpecialChar LaTeX
5474 \begin_inset Flex Code
5477 \begin_layout Plain Layout
5483 (for inline formulas) or
5484 \begin_inset Flex Code
5487 \begin_layout Plain Layout
5493 (for displayed formulas) with
5494 \begin_inset Flex Code
5497 \begin_layout Plain Layout
5503 , as is required for jsMath.
5506 \begin_layout Standard
5507 One of these output methods must be selected under
5508 \begin_inset Flex Noun
5511 \begin_layout Plain Layout
5512 Document\SpecialChar menuseparator
5513 Settings\SpecialChar menuseparator
5515 \change_deleted -712698321 1501076586
5517 \change_inserted -712698321 1501076587
5526 By default, \SpecialChar LyX
5528 This is a document-wide setting, therefore.
5531 \begin_layout Standard
5532 Eventually, \SpecialChar LyX
5533 will offer the user the option to select an alternate output
5534 method for a particular inset, say, one that isn't being rendered very
5539 \begin_layout Plain Layout
5540 That said, since \SpecialChar LyX
5541 falls back to images if the inset contains ERT, then one
5542 can force output as an image by putting some harmless ERT into the math,
5544 \begin_inset Formula $a=b\relax$
5555 \begin_layout Section
5556 Bibliography and Citations
5559 \begin_layout Standard
5560 XHTML output fully supports bibliographies and citations.
5564 \begin_layout Standard
5565 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5567 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5570 If you are using numerical citations, then \SpecialChar LyX
5571 will output numerical labels,
5572 such as [1] or [17], rather than simply showing the citation key in square
5573 brackets, as it does on-screen.
5574 If you are using author-year citations, then \SpecialChar LyX
5575 will add lowercase letters
5576 to the years, just as Bib\SpecialChar TeX
5577 does, if it finds more than one citation for
5578 a given author-year combination.
5579 The labels will be printed with the bibliography entries.
5580 Note that there is, at present, no way to customize the appearance of the
5581 labels, for example, to choose between square brackets and parentheses.
5584 \begin_layout Standard
5585 Bibliography output is handled by the same machinery that handles the presentati
5586 on of reference information in the citation dialog, so you will see in the
5587 XHTML output pretty much what you would see if you were to look at a given
5588 entry in the citation dialog.
5589 The formatting can be customized in your layout file or, preferably, in
5595 manual for the details.
5598 \begin_layout Standard
5599 The main defect at present is that cross-referenced information is printed
5600 with every entry with which it is associated.
5601 So you can see things like this:
5606 \begin_inset Quotes eld
5609 Context and Logical Form
5610 \begin_inset Quotes erd
5615 Language in Context: Selected Essays
5617 (Oxford: Oxford University Press, 2007), pp.
5623 \begin_inset Quotes eld
5626 Semantics in Context
5627 \begin_inset Quotes erd
5632 Language in Context: Selected Essays
5634 (Oxford: Oxford University Press, 2007), pp.
5638 \begin_layout Standard
5639 This should be fixed before long.
5642 \begin_layout Standard
5643 There is no support at present for sectioned bibliographies.
5644 If you have multiple bibliographies, then \SpecialChar LyX
5645 will print the same bibliography
5649 \begin_layout Section
5653 \begin_layout Standard
5655 will happily export indexes as XHTML, but with certain limitations at the
5659 \begin_layout Standard
5660 Index export will be most reliable when you do not attempt to use the fancy
5661 constructs that are described in the section on indexes in the
5669 \begin_layout Plain Layout
5670 The main issue here is that \SpecialChar LyX
5671 itself does not really handle these.
5672 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5678 We'll describe how they are handled using the subsection headings from
5682 \begin_layout Itemize
5683 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5684 makes an effort to support these,
5685 but the entries must be separated by
5686 \begin_inset Quotes eld
5690 \begin_inset Quotes erd
5693 , that is, there must be spaces around the exclamation point.
5694 This is because it is otherwise too difficult to check for escaped exclamation
5695 points, ones in math, and so forth.
5698 \begin_layout Itemize
5699 Page Ranges: There is no support at all for page ranges, since these make
5700 no sense with XHMTL.
5701 Instead, you will just get two index entries, one at either end.
5704 \begin_layout Itemize
5705 Cross-referencing: There is no support for cross-referencing.
5707 finds an entry containing the
5708 \begin_inset Quotes eld
5711 |see\SpecialChar ldots
5713 \begin_inset Quotes erd
5716 construct, it is just dropped, and the rest is treated as an ordinary index
5720 \begin_layout Itemize
5721 Index Entry Order: \SpecialChar LyX
5722 does support attempts to fix the sorting order.
5723 It will take what is before the first `@' it finds and use that for sorting,
5724 taking what follows the first `@' to be the actual entry.
5725 At present, \SpecialChar LyX
5726 does not check for escaped `@', so do not try to index email
5730 \begin_layout Itemize
5731 Index Entry Layout: You can format entries by using the text style dialog,
5732 or by using any other method available within \SpecialChar LyX
5734 There is no support for constructs like:
5735 \begin_inset Quotes eld
5739 \begin_inset Quotes erd
5743 Indeed, if \SpecialChar LyX
5744 finds a pipe symbol, `|', in an entry, it will delete it and
5745 everything that follows it.
5748 \begin_layout Itemize
5749 Multiple Indexes: There is no support for multiple indexes.
5750 Rather, all index entries will be printed as one large index.
5751 To avoid our printing several versions of the index, we print only the
5752 main index, so make sure you have one.
5755 \begin_layout Section
5756 Nomenclature and Glossary
5759 \begin_layout Standard
5760 There is at present no support for glossaries.
5761 Adding it would be fairly trivial, and welcome.
5764 \begin_layout Chapter
5765 The \SpecialChar LyX
5769 \begin_layout Section
5773 \begin_layout Standard
5774 The `\SpecialChar LyX
5775 server' allows other programs to talk to \SpecialChar LyX
5776 , invoke \SpecialChar LyX
5777 commands, and retrieve
5778 information about the \SpecialChar LyX
5780 This is only intended for advanced users, but they should find it useful.
5781 It is by writing to the \SpecialChar LyX
5782 server, for example, that bibliography managers,
5783 such as JabRef, are able to
5784 \begin_inset Quotes eld
5788 \begin_inset Quotes erd
5791 citations to \SpecialChar LyX
5795 \begin_layout Section
5796 Starting the \SpecialChar LyX
5800 \begin_layout Standard
5801 The \SpecialChar LyX
5802 server works through the use of a pair of named pipes.
5803 These are usually located in
5804 \begin_inset Flex Code
5807 \begin_layout Plain Layout
5813 , (except on Windows, where
5817 named pipes are special objects located in
5818 \begin_inset Flex Code
5821 \begin_layout Plain Layout
5833 ) and have the names
5834 \begin_inset Quotes eld
5838 \begin_inset Flex Code
5841 \begin_layout Plain Layout
5848 \begin_inset Quotes erd
5852 \begin_inset Quotes eld
5856 \begin_inset Flex Code
5859 \begin_layout Plain Layout
5866 \begin_inset Quotes erd
5870 External programs write into
5871 \begin_inset Flex Code
5874 \begin_layout Plain Layout
5880 and read back data from
5881 \begin_inset Flex Code
5884 \begin_layout Plain Layout
5891 The stem of the pipe names can be defined in the
5892 \begin_inset Flex Noun
5895 \begin_layout Plain Layout
5896 Tools\SpecialChar menuseparator
5903 \begin_inset Flex Code
5906 \begin_layout Plain Layout
5907 "/home/myhome/lyxpipe"
5913 \begin_inset Flex Code
5916 \begin_layout Plain Layout
5930 on Windows (where any working path instead of lyxpipe can be used, for
5932 \begin_inset Flex Code
5935 \begin_layout Plain Layout
5958 configure this manually in order for the server to start.
5961 \begin_layout Standard
5964 \begin_inset Flex Code
5967 \begin_layout Plain Layout
5974 \begin_inset Flex Code
5977 \begin_layout Plain Layout
5983 ' to create the pipes.
5984 If one of the pipes already exists, \SpecialChar LyX
5985 will assume that another \SpecialChar LyX
5987 is already running and will not start the server.
5988 On POSIX (Unix like) systems, if for some other reason, an unused
5989 \begin_inset Quotes eld
5993 \begin_inset Quotes erd
5996 pipe is left in existence when \SpecialChar LyX
5997 closes, then \SpecialChar LyX
5998 will try to delete it.
5999 If this fails for some reason, you will need to delete the pipes manually
6000 and then restart \SpecialChar LyX
6002 On Windows, pipes are deleted by the OS on program termination or crash,
6004 \begin_inset Quotes eld
6008 \begin_inset Quotes erd
6011 pipes should not be possible.
6014 \begin_layout Standard
6015 To have several \SpecialChar LyX
6016 processes with servers at the same time, you have to use
6017 different configurations, perhaps by using separate user directories, each
6019 \begin_inset Flex Code
6022 \begin_layout Plain Layout
6028 file, for each process.
6031 \begin_layout Standard
6032 If you are developing a client program, you might find it useful to enable
6033 debugging information from the \SpecialChar LyX
6035 Do this by starting \SpecialChar LyX
6037 \begin_inset Flex Code
6040 \begin_layout Plain Layout
6049 \begin_layout Standard
6050 You can find a complete example client written in C++ in the source distribution
6052 \begin_inset Flex Code
6055 \begin_layout Plain Layout
6056 development/lyxserver/server_monitor.cpp
6064 \begin_layout Standard
6065 Another useful tool is the command-line based client found in
6066 \begin_inset Flex Code
6069 \begin_layout Plain Layout
6070 src/client/lyxclient
6078 \begin_layout Section
6079 Normal communication
6082 \begin_layout Standard
6083 To issue a \SpecialChar LyX
6084 call, the client writes a line of ASCII text into the input
6086 This line has the following format:
6103 \begin_layout Description
6104 clientname is a name that the client can choose arbitrarily.
6105 Its only use is that \SpecialChar LyX
6106 will echo it if it sends an answer—so a client can
6107 dispatch results from different requesters.
6110 \begin_layout Description
6111 function is the function you want \SpecialChar LyX
6113 It is the same as the commands you'd use in the minibuffer.
6116 \begin_layout Description
6117 argument is an optional argument which is meaningful only to some functions
6119 \begin_inset Quotes eld
6123 \begin_inset Quotes erd
6126 LFUN will insert the argument as text at the cursor position).
6129 \begin_layout Standard
6130 The answer from \SpecialChar LyX
6131 will arrive in the output pipe and be of the form
6148 \begin_layout Standard
6157 are just echoed from the command request, while
6161 is more or less useful information filled according to how the command
6162 execution worked out.
6163 Some commands, such as
6164 \begin_inset Quotes eld
6168 \begin_inset Quotes erd
6171 , will return information about the internal state of \SpecialChar LyX
6173 return an empty data-response.
6174 This means that the command execution went fine.
6177 \begin_layout Standard
6178 In case of errors, the response from \SpecialChar LyX
6196 \begin_layout Standard
6201 should contain an explanation of why the command failed.
6204 \begin_layout Standard
6208 \begin_layout LyX-Code
6209 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6210 \begin_inset Newline newline
6213 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6214 \begin_inset Newline newline
6217 read a <~/.lyxpipe.out
6218 \begin_inset Newline newline
6224 \begin_layout Subsection
6225 AppleScript (Mac OS X)
6228 \begin_layout Standard
6229 Since \SpecialChar LyX
6230 2.1, \SpecialChar LyX
6231 supports basic interactions with AppleScript for normal communicatio
6232 n through the command run.
6233 This command takes a direct argument (the
6237 to perform) and an optional argument.
6238 It either returns the output of the function or triggers an error with
6239 the error message and code.
6242 \begin_layout Standard
6246 \begin_layout LyX-Code
6247 tell application "\SpecialChar LyX
6251 \begin_layout LyX-Code
6255 \begin_layout LyX-Code
6256 -- Stores the current file name into f
6259 \begin_layout LyX-Code
6260 set f to (run "server-get-filename" with argument "")
6263 \begin_layout LyX-Code
6264 on error the error_message number the error_number
6267 \begin_layout LyX-Code
6268 display dialog "Error: " & the error_number & ".
6272 \begin_layout LyX-Code
6273 & the error_message buttons {"OK"} default button 1
6276 \begin_layout LyX-Code
6280 \begin_layout LyX-Code
6284 \begin_layout Section
6288 \begin_layout Standard
6290 can notify clients of events going on asynchronously.
6291 Currently it will only do this if the user binds a key sequence with the
6293 \begin_inset Quotes eld
6297 \begin_inset Quotes erd
6301 The format of the string \SpecialChar LyX
6302 sends is as follows:
6306 \begin_inset Flex Code
6309 \begin_layout Plain Layout
6320 \begin_layout Standard
6325 is the printed representation of the key sequence that was actually typed
6329 \begin_layout Standard
6330 This mechanism can be used to extend \SpecialChar LyX
6331 's command set and implement macros.
6332 Bind some key sequence to
6333 \begin_inset Quotes eld
6337 \begin_inset Quotes erd
6341 Then start a client that listens on the output pipe, dispatches the command
6342 according to the sequence, and starts a function that may use \SpecialChar LyX
6345 requests to issue a command or a series of commands to \SpecialChar LyX
6349 \begin_layout Section
6350 The simple \SpecialChar LyX
6354 \begin_layout Standard
6356 implements a simple protocol that can be used for session management.
6357 All messages are of the form
6370 \begin_layout Standard
6376 \begin_inset Quotes eld
6380 \begin_inset Quotes erd
6384 \begin_inset Quotes eld
6388 \begin_inset Quotes erd
6393 \begin_inset Quotes eld
6397 \begin_inset Quotes erd
6400 is received from a client, \SpecialChar LyX
6401 will report back to inform the client that
6402 it's listening to it's messages, while
6403 \begin_inset Quotes eld
6407 \begin_inset Quotes erd
6410 sent from \SpecialChar LyX
6411 will inform clients that \SpecialChar LyX
6415 \begin_layout Section
6416 Reverse DVI/PDF search
6419 \begin_layout Standard
6420 Some DVI/PDF viewers
6424 \begin_layout Plain Layout
6425 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6426 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6435 facility (also called
6440 This means that you can tell \SpecialChar LyX
6441 to put the cursor to a specific line in the
6442 document by clicking at the respective position in the DVI/PDF output.
6443 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6445 This is done via the \SpecialChar LyX
6446 server either by using the named pipe (
6450 ), or the UNIX domain socket (
6454 ) that \SpecialChar LyX
6455 creates in its temporary directory (this is the way the
6456 \begin_inset Flex Code
6459 \begin_layout Plain Layout
6465 program communicates with \SpecialChar LyX
6467 In some cases, you need a helper script that mediates between the viewer
6468 and \SpecialChar LyX
6469 , in others, the viewer can communicate with \SpecialChar LyX
6471 This depends on the selected viewer and on your operating system.
6472 The same applies to the way viewers need to be configured and the way the
6473 reverse search is actually performed.
6474 In what follows, we will thus describe how to setup reverse search for
6476 Before we turn to this, though, we will explain what needs to be done generally
6477 to enable reverse search in the DVI/PDF output.
6480 \begin_layout Subsection
6482 \begin_inset CommandInset label
6484 name "subsec:rev-search"
6491 \begin_layout Standard
6492 In most cases \SpecialChar LyX
6493 will do the work for you by
6494 \change_inserted -712698321 1500975045
6495 pressing the following button in the toolbar:
6498 arg "buffer-toggle-output-sync"
6502 Alternatively, you can also enable the feature by checking
6504 Synchronize with Output
6507 \begin_inset Flex Noun
6510 \begin_layout Plain Layout
6512 \change_inserted -712698321 1500975071
6513 Document\SpecialChar menuseparator
6514 Settings\SpecialChar menuseparator
6521 \change_deleted -712698321 1500974764
6523 \begin_inset Flex Noun
6526 \begin_layout Plain Layout
6527 Synchronize with Output
6533 \begin_inset Flex Noun
6536 \begin_layout Plain Layout
6537 Document\SpecialChar menuseparator
6538 Settings\SpecialChar menuseparator
6547 In such a case \SpecialChar LyX
6548 will automatically insert the necessary Sync\SpecialChar TeX
6550 PDF) or load the srcltx package (for DVI) respectively.
6551 This option can be easily reached also on
6552 \begin_inset Flex Code
6555 \begin_layout Plain Layout
6564 \begin_layout Standard
6565 If you need a different setting, you can select or input a custom macro
6566 from the drop down box just below
6567 \begin_inset Flex Noun
6570 \begin_layout Plain Layout
6571 Document\SpecialChar menuseparator
6572 Settings\SpecialChar menuseparator
6573 Output\SpecialChar menuseparator
6574 Synchronize with Output
6582 \begin_layout Standard
6583 Note that the method
6584 \begin_inset Flex Code
6587 \begin_layout Plain Layout
6595 enables gzip compression.
6596 If your viewer does not support it, you should instead use
6597 \begin_inset Flex Code
6600 \begin_layout Plain Layout
6611 \begin_layout Standard
6612 Please also note that including the
6613 \begin_inset Flex Code
6616 \begin_layout Plain Layout
6623 \begin_inset Flex Code
6626 \begin_layout Plain Layout
6632 sometimes has an undesired impact on the typesetting.
6633 Thus, you should switch output synchronization off for the final typesetting
6635 \begin_inset Flex Code
6638 \begin_layout Plain Layout
6645 \begin_inset Flex Code
6648 \begin_layout Plain Layout
6658 \begin_layout Standard
6659 In case you need some more special settings that are not covered by the
6660 automatic settings, read the next section about how to set up output synchroniz
6662 If the automatic setup suits your needs, you can readily jump to section
6663 \begin_inset space ~
6667 \begin_inset CommandInset ref
6669 reference "subsec:configuring-viewers"
6673 , where the necessary configuration steps in your viewer – needed both with
6674 the automatic and the manual setup – are described.
6677 \begin_layout Subsection
6681 \begin_layout Standard
6683 provides several different methods for reverse search.
6684 Some are built-in in the
6685 \begin_inset Flex Code
6688 \begin_layout Plain Layout
6694 program, some are provided by external packages.
6695 Your choice depends on whether your \SpecialChar LaTeX
6696 distribution already provides a given
6697 method (the built-in methods are rather new) and whether your viewer can
6699 The available methods are described in the following.
6702 \begin_layout Subsubsection*
6703 Built-in DVI-search via src-specials (DVI only)
6706 \begin_layout Standard
6707 This method provides the DVI file with the necessary information for reverse
6709 It is available in \SpecialChar LaTeX
6710 since quite some time (any somewhat recent \SpecialChar LaTeX
6712 should include it), and it works reliably.
6713 To enable it, change the
6714 \begin_inset Flex Noun
6717 \begin_layout Plain Layout
6728 \begin_inset Flex Noun
6731 \begin_layout Plain Layout
6742 \begin_inset Flex Noun
6745 \begin_layout Plain Layout
6746 Preferences\SpecialChar menuseparator
6747 File Handling\SpecialChar menuseparator
6754 \begin_inset Flex Code
6757 \begin_layout Plain Layout
6758 latex -src-specials $$i
6764 If this doesn't work, check if your \SpecialChar TeX
6765 engine needs different options (the
6766 syntax might differ in some distributions).
6769 \begin_layout Subsubsection*
6770 External Packages (PDFSync and scrltx)
6773 \begin_layout Standard
6782 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6784 In order to enable it, load the packages in the \SpecialChar LyX
6788 \begin_layout Itemize
6789 \begin_inset Flex Code
6792 \begin_layout Plain Layout
6800 for reverse PDF search,
6803 \begin_layout Itemize
6804 \begin_inset Flex Code
6807 \begin_layout Plain Layout
6810 usepackage[active]{srcltx}
6815 for reverse DVI search.
6818 \begin_layout Standard
6819 If you want to be able to perform both DVI and PDF reverse searches, you
6820 can also insert in the preamble the following lines
6823 \begin_layout LyX-Code
6827 \begin_inset Newline newline
6833 \begin_inset Newline newline
6839 \begin_inset Newline newline
6845 \begin_inset Newline newline
6850 usepackage[active]{srcltx}
6851 \begin_inset Newline newline
6859 \begin_layout Standard
6860 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6861 right package will be used.
6864 \begin_layout Standard
6865 Note that PDFSync might affect the output layout of your document.
6866 It is therefore advised to disable PDFsync for final documents.
6869 \begin_layout Subsubsection*
6870 Built-in reverse search via Sync\SpecialChar TeX
6874 \begin_layout Standard
6876 \begin_inset Flex Code
6879 \begin_layout Plain Layout
6885 have built-in support for both PDF and DVI reverse search.
6888 Sync\SpecialChar TeX
6891 facility is basically the result of the integration of the PDFSync package
6892 to the pdftex program and its merge with the
6897 You need at least \SpecialChar TeX
6898 Live 2008 or a recent Mik\SpecialChar TeX
6899 distribution in order to use
6904 \begin_layout Plain Layout
6905 For some reason, Mik\SpecialChar TeX
6906 does not understand/obey the command \SpecialChar LyX
6908 the preamble when you check the "Enable Forward/Reverse Search" button
6909 in the toolbar and does not generate the necessary info.
6912 \begin_layout Plain Layout
6913 The generation of the required info can be forced by changing the converter
6915 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
6916 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
6917 the -synctex=1 switch).
6922 Also note that only a few PDF viewers (
6923 \change_inserted -712698321 1500977288
6926 Okular and Qpdfview on Unix, Skim on the Mac, SumatraPDF on Windows
6927 \change_inserted -712698321 1500977299
6928 ; see the next section for details
6930 ) already provide Sync\SpecialChar TeX
6934 \begin_layout Standard
6935 To enable Sync\SpecialChar TeX
6936 for DVI output, change the
6937 \begin_inset Flex Noun
6940 \begin_layout Plain Layout
6951 \begin_inset Flex Noun
6954 \begin_layout Plain Layout
6965 \begin_inset Flex Noun
6968 \begin_layout Plain Layout
6969 Preferences\SpecialChar menuseparator
6970 File Handling\SpecialChar menuseparator
6977 \begin_inset Flex Code
6980 \begin_layout Plain Layout
6981 latex -synctex=1 $$i
6986 , and for PDF output, change the
6987 \begin_inset Flex Noun
6990 \begin_layout Plain Layout
6995 (pdflatex) -> PDF (pdflatex)
7001 \change_deleted -712698321 1500977453
7005 \begin_inset Flex Code
7008 \begin_layout Plain Layout
7009 pdflatex -synctex=1 $$i
7016 \change_inserted -712698321 1500977740
7017 Should your viewer not be considered in the following description, or in
7018 case of missing success, please
7019 \change_deleted -712698321 1500977741
7021 \change_inserted -712698321 1500977744
7024 heck the documentation of your viewer whether the viewer needs to be configured
7025 for the use with Sync\SpecialChar TeX
7030 \begin_layout Plain Layout
7031 Note that the option
7032 \begin_inset Flex Code
7035 \begin_layout Plain Layout
7041 option enables gzip compression.
7042 If your viewer does not support it, you should instead use
7043 \begin_inset Flex Code
7046 \begin_layout Plain Layout
7060 \begin_layout Subsection
7061 Configuring and using specific viewers
7062 \begin_inset CommandInset label
7064 name "subsec:configuring-viewers"
7071 \begin_layout Subsubsection*
7072 Xdvi (all platforms)
7075 \begin_layout Standard
7077 \begin_inset Flex Code
7080 \begin_layout Plain Layout
7086 , you don't need to do anything else for performing a reverse DVI search,
7088 already provides the necessary hooks for automatically using the
7089 \begin_inset Flex Code
7092 \begin_layout Plain Layout
7099 Just setup your document as described above (reverse search is triggered
7100 by Ctrl-click or Alt-click on Mac OSX, respectively).
7103 \begin_layout Standard
7104 However, if for whatever reason you want to use the named pipe instead of
7105 the socket for communicating with \SpecialChar LyX
7106 , simply change the DVI viewer in
7107 \begin_inset Flex Noun
7110 \begin_layout Plain Layout
7111 Preferences\SpecialChar menuseparator
7112 File Handling\SpecialChar menuseparator
7122 \begin_layout Plain Layout
7123 On Mac OSX you have to use
7124 \begin_inset Flex Code
7127 \begin_layout Plain Layout
7128 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7139 \begin_inset Flex Code
7142 \begin_layout Plain Layout
7143 xdvi -editor "lyxeditor.sh %f %l"
7149 \begin_inset Flex Code
7152 \begin_layout Plain Layout
7158 is a suitable script.
7159 For example, a minimal shell script is the following one:
7162 \begin_layout LyX-Code
7164 \begin_inset Newline newline
7167 LYXPIPE="/path/to/lyxpipe"
7168 \begin_inset Newline newline
7171 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7172 \begin_inset Newline newline
7175 echo "$COMMAND" > "${LYXPIPE}".in || exit
7176 \begin_inset Newline newline
7179 read TMP < "${LYXPIPE}".out || exit
7182 \begin_layout Standard
7184 \begin_inset Flex Code
7187 \begin_layout Plain Layout
7193 is the LyXServer pipe path specified in
7194 \begin_inset Flex Noun
7197 \begin_layout Plain Layout
7198 Preferences\SpecialChar menuseparator
7208 \begin_layout Plain Layout
7210 \begin_inset Flex Code
7213 \begin_layout Plain Layout
7219 folder of a source distribution you can find a
7220 \begin_inset Flex Code
7223 \begin_layout Plain Layout
7229 script which is able to locate the
7233 based on your preferences.
7241 \begin_layout Subsubsection*
7245 \begin_layout Standard
7247 \begin_inset Flex Code
7250 \begin_layout Plain Layout
7251 /Applications/MacDviX_Folder/calleditor.script
7256 , add the following lines:
7259 \begin_layout LyX-Code
7260 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7261 \begin_inset Newline newline
7267 \begin_layout Standard
7268 Modify the lines accordingly if you install \SpecialChar LyX
7269 somewhere else than in the
7270 Applications folder.
7273 \begin_layout Standard
7274 Reverse search is triggered by Alt-click (OPTION-click).
7277 \begin_layout Subsubsection*
7281 \begin_layout Standard
7283 \begin_inset Flex Code
7286 \begin_layout Plain Layout
7287 open -a Skim.app $$i
7292 to the viewer setting in
7293 \begin_inset Flex Noun
7296 \begin_layout Plain Layout
7297 Preferences\SpecialChar menuseparator
7298 File Handling\SpecialChar menuseparator
7299 File formats\SpecialChar menuseparator
7306 \begin_inset Flex Noun
7309 \begin_layout Plain Layout
7310 Skim\SpecialChar menuseparator
7311 Preferences\SpecialChar menuseparator
7318 \begin_inset Flex Noun
7321 \begin_layout Plain Layout
7327 preset and enter command
7328 \begin_inset Flex Noun
7331 \begin_layout Plain Layout
7332 /Applications/\SpecialChar LyX
7333 .app/Contents/MacOS/lyxeditor
7341 \begin_layout Standard
7342 Reverse search is triggered by COMMAND-SHIFT-click
7345 \begin_layout Subsubsection*
7349 \begin_layout Standard
7350 Reverse search with evince does not work out of the box, but it can be achieved
7351 by means of some third party helper scripts.
7353 \begin_inset CommandInset href
7355 target "http://wiki.lyx.org/LyX/SyncTeX"
7363 \begin_layout Subsubsection*
7367 \begin_layout Standard
7369 \begin_inset Flex Noun
7372 \begin_layout Plain Layout
7373 Settings\SpecialChar menuseparator
7374 Configure Okular\SpecialChar menuseparator
7381 \change_inserted -712698321 1500981642
7383 \change_deleted -712698321 1500981641
7387 \change_deleted -712698321 1500981634
7389 \begin_inset Quotes eld
7393 \change_inserted -712698321 1500981635
7397 \begin_inset Quotes erd
7401 \change_inserted -712698321 1500981659
7403 This inserts the appropriate
7404 \change_deleted -712698321 1500981663
7408 \change_inserted -712698321 1500981665
7412 \begin_inset Flex Code
7415 \begin_layout Plain Layout
7422 \change_inserted -712698321 1500981668
7428 \begin_layout Standard
7429 Reverse search is triggered by SHIFT-click.
7432 \begin_layout Subsubsection*
7436 \begin_layout Standard
7437 Qpdfview supports Sync\SpecialChar TeX
7438 since version 0.3.5.
7440 \begin_inset Flex Noun
7443 \begin_layout Plain Layout
7444 Edit\SpecialChar menuseparator
7445 Settings\SpecialChar menuseparator
7451 , click on the input field of the
7452 \begin_inset Quotes eld
7456 \begin_inset Quotes erd
7459 item and add the command
7460 \begin_inset Flex Code
7463 \begin_layout Plain Layout
7472 \begin_layout Standard
7473 Reverse search is triggered by double-click or, in more recent versions,
7477 \begin_layout Subsubsection*
7481 \begin_layout Standard
7482 Launch yap, choose its
7483 \begin_inset Flex Noun
7486 \begin_layout Plain Layout
7487 View\SpecialChar menuseparator
7494 \begin_inset Quotes eld
7498 \begin_inset Quotes erd
7503 \begin_inset Quotes eld
7506 New\SpecialChar ldots
7508 \begin_inset Quotes erd
7511 button and, in the window that opens, enter
7512 \begin_inset Quotes eld
7517 \begin_inset Quotes erd
7520 (or any other name you like) in the
7521 \begin_inset Quotes eld
7525 \begin_inset Quotes erd
7529 Now click on the button labeled
7530 \begin_inset Quotes eld
7535 \begin_inset Quotes erd
7538 to open a file dialog and navigate to the directory containing the batch
7540 \begin_inset Flex Code
7543 \begin_layout Plain Layout
7551 \begin_inset Flex Code
7554 \begin_layout Plain Layout
7560 and then specify the program arguments as
7561 \begin_inset Flex Code
7564 \begin_layout Plain Layout
7572 \begin_inset Flex Code
7575 \begin_layout Plain Layout
7581 wrapper is used for communicating with \SpecialChar LyX
7589 \begin_layout LyX-Code
7591 \begin_inset Newline newline
7594 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
7603 \begin_inset Newline newline
7617 \begin_layout Standard
7618 Make sure that the \SpecialChar LyX
7619 Server pipe path you specified in \SpecialChar LyX
7621 \begin_inset Flex Code
7624 \begin_layout Plain Layout
7638 , otherwise change the
7639 \begin_inset Flex Code
7642 \begin_layout Plain Layout
7648 wrapper accordingly.
7651 \begin_layout Standard
7652 In yap, reverse search is triggered by double-click.
7655 \begin_layout Subsubsection*
7656 SumatraPDF (Windows)
7659 \begin_layout Standard
7660 In order to use SumatraPDF for inverse search, enter
7661 \begin_inset Flex Code
7664 \begin_layout Plain Layout
7665 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
7670 in the viewer setting in
7671 \begin_inset Flex Noun
7674 \begin_layout Plain Layout
7675 Preferences\SpecialChar menuseparator
7676 File Handling\SpecialChar menuseparator
7677 File formats\SpecialChar menuseparator
7684 \begin_inset Flex Code
7687 \begin_layout Plain Layout
7693 is the previous wrapper.
7694 If SumatraPDF.exe is not in your command PATH, use its full file name.
7697 \begin_layout Standard
7698 Reverse search is triggered by double-click.
7701 \begin_layout Subsubsection*
7705 \begin_layout Standard
7706 First of all, make sure that yap is your default DVI viewer in the Windows
7707 environment, then launch it, choose its
7708 \begin_inset Flex Noun
7711 \begin_layout Plain Layout
7712 View\SpecialChar menuseparator
7719 \begin_inset Quotes eld
7723 \begin_inset Quotes erd
7728 \begin_inset Quotes eld
7731 New\SpecialChar ldots
7733 \begin_inset Quotes erd
7736 button and, in the window that opens, enter
7737 \begin_inset Quotes eld
7742 \begin_inset Quotes erd
7745 (or any other name you like) in the
7746 \begin_inset Quotes eld
7750 \begin_inset Quotes erd
7754 Now click on the button labeled
7755 \begin_inset Quotes eld
7760 \begin_inset Quotes erd
7763 to open a file dialog and navigate to the directory containing the
7764 \begin_inset Flex Code
7767 \begin_layout Plain Layout
7773 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7776 \begin_inset Flex Code
7779 \begin_layout Plain Layout
7785 and then specify the program arguments as
7786 \begin_inset Flex Code
7789 \begin_layout Plain Layout
7796 In this way, you will be using the
7800 for communicating with \SpecialChar LyX
7802 If, for whatever reason, you want to use the
7807 \begin_inset Flex Code
7810 \begin_layout Plain Layout
7816 option and be sure to specify the \SpecialChar LyX
7817 Server pipe path in the \SpecialChar LyX
7821 \begin_layout Standard
7822 In yap, reverse search is triggered by double-click.
7825 \begin_layout Subsubsection*
7829 \begin_layout Standard
7830 In order to use SumatraPDF for inverse search, enter
7831 \begin_inset Flex Code
7834 \begin_layout Plain Layout
7835 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7840 in the viewer setting in
7841 \begin_inset Flex Noun
7844 \begin_layout Plain Layout
7845 Preferences\SpecialChar menuseparator
7846 File Handling\SpecialChar menuseparator
7847 File formats\SpecialChar menuseparator
7854 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7856 \begin_inset Flex Code
7859 \begin_layout Plain Layout
7865 enables communication via the
7871 \begin_inset Flex Code
7874 \begin_layout Plain Layout
7880 option if you want to use the
7884 , and be sure to specify the \SpecialChar LyX
7885 Server pipe path in the \SpecialChar LyX
7889 \begin_layout Standard
7890 Reverse search is triggered by double-click.
7893 \begin_layout Section
7897 \begin_layout Standard
7898 Forward search is, as the name implies, in a sense the
7899 \begin_inset Quotes eld
7903 \begin_inset Quotes erd
7907 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7909 If forward search is set up (as described in what follows), you can put
7910 the cursor anywhere in your \SpecialChar LyX
7912 \begin_inset Flex Noun
7915 \begin_layout Plain Layout
7916 Navigate\SpecialChar menuseparator
7923 \begin_inset Flex Noun
7926 \begin_layout Plain Layout
7932 in the context menu via right mouse click), and then the viewer will jump
7933 to that position as well.
7934 This implies, of course, that your viewer supports this function.
7937 \begin_layout Standard
7938 To make forward search possible, you first need to provide the generated
7939 output PDF/DVI file with additional information about the \SpecialChar TeX
7941 This can be done via the methods described in the section
7942 \begin_inset CommandInset ref
7944 reference "subsec:rev-search"
7951 \begin_layout Standard
7952 Additionally, you need to configure \SpecialChar LyX
7953 for using your viewers in
7954 \begin_inset Flex Noun
7957 \begin_layout Plain Layout
7958 Tools\SpecialChar menuseparator
7959 Preferences\SpecialChar menuseparator
7960 Output\SpecialChar menuseparator
7967 We provide a range of tested configurations for some viewers, which you
7968 can select from the drop down list.
7969 If none of these configurations suits you, you have to find out and enter
7970 a suitable configuration yourself.
7971 The definition syntax uses the following placeholders:
7974 \begin_layout Itemize
7976 \begin_inset Flex Code
7979 \begin_layout Plain Layout
7988 \begin_layout Itemize
7990 \begin_inset Flex Code
7993 \begin_layout Plain Layout
7999 : name of the (temporary) exported .tex file (without path)
8002 \begin_layout Itemize
8004 \begin_inset Flex Code
8007 \begin_layout Plain Layout
8013 : name of the (temporary) exported .tex file (including path)
8016 \begin_layout Itemize
8018 \begin_inset Flex Code
8021 \begin_layout Plain Layout
8027 : name of the exported output file (either dvi or pdf, depending on which
8028 one exists in the temporary directory)
8031 \begin_layout Standard
8032 Note that only some of the viewers provide full and usable forward search
8033 functionality out of the box, among them yap, xdvi, okular
8037 \begin_layout Plain Layout
8038 You might want to set
8039 \begin_inset Flex Code
8042 \begin_layout Plain Layout
8049 \begin_inset Flex Noun
8052 \begin_layout Plain Layout
8053 Tools\SpecialChar menuseparator
8054 Preferences\SpecialChar menuseparator
8055 File Handling\SpecialChar menuseparator
8057 \begin_inset space ~
8070 , qpdfview, and SumatraPDF
8074 \begin_layout Plain Layout
8075 SumatraPDF can also use DDE commands through the external program CMCDDE
8077 \begin_inset CommandInset href
8079 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8090 Others, such as evince
8094 \begin_layout Plain Layout
8095 Forward search with evince can be achieved by means of third party helper
8098 \begin_inset CommandInset href
8100 target "http://wiki.lyx.org/LyX/SyncTeX"
8110 , require some extra tools in order to use forward search.
8111 While many of the widespread PDF viewers (most notably Adobe Reader) do
8112 not support forward search at all, some other viewers – e.
8113 \begin_inset space \thinspace{}
8117 xpdf – allow at least to reload the document and jump to a specific page
8118 of the file, so you can at least navigate
8119 \begin_inset Quotes eld
8123 \begin_inset Quotes erd
8127 This latter functionality is provided by an external call of synctex (see
8128 the predefined example configurations).
8132 \begin_layout Standard
8133 Forward search works both with DVI and PDF output.
8135 simply checks which preview format you have used before (i.
8136 \begin_inset space \thinspace{}
8139 e., which format is already there in the temporary directory) and chooses
8140 the appropriate configuration for the respective format.
8143 \begin_layout Chapter
8144 Special Document Classes
8147 \begin_layout Section
8151 \begin_layout Standard
8157 \begin_layout Subsection
8161 \begin_layout Standard
8162 This section describes how \SpecialChar LyX
8163 can be used to write articles for submission
8164 to the scientific journal
8166 Astronomy and Astrophysics
8169 \begin_inset Flex URL
8172 \begin_layout Plain Layout
8174 http://www.edpsciences.fr/aa/
8179 ) using Version 5.01 of the document class
8184 This package can be downloaded from the ftp site
8187 \begin_layout Standard
8188 \begin_inset VSpace medskip
8194 \begin_layout Standard
8196 \begin_inset Flex URL
8199 \begin_layout Plain Layout
8201 ftp://ftp.edpsciences.org/pub/aa/readme.html
8209 \begin_layout Standard
8210 \begin_inset VSpace medskip
8216 \begin_layout Standard
8217 A manual comes together with that package, and this text is not meant to
8218 replace the original manual but is merely a short guide in how to realize
8219 the correct form of your paper.
8223 \begin_layout Standard
8224 Please note that the publisher of the journal was changed from Springer
8225 to EDP Sciences starting January 1, 2001.
8226 That change involved also some slight changes to the style files, namely
8227 the removal of the thesaurus command.
8228 The \SpecialChar LyX
8229 class aa supports the newest version of these style files, V 5.01.
8230 If you have an older version installed, please upgrade.
8231 For compatibility, the old (version 4) layout has been kept as
8236 Please refer to the comments in
8239 Dir/layouts/aapaper.layout
8244 \begin_layout Subsection
8248 \begin_layout Standard
8249 It is recommended you start from the example template distributed with \SpecialChar LyX
8251 If you are not using a template, note the following settings:
8254 \begin_layout Itemize
8261 Document\SpecialChar menuseparator
8264 dialog (OK, that one was obvious).
8267 \begin_layout Itemize
8268 Don't change the option
8271 \begin_inset space ~
8281 The whole layout is done by the macros, you shouldn't change anything.
8284 \begin_layout Subsection
8288 \begin_layout Standard
8289 First thing to enter is the header information.
8290 It consists of seven entries, of which some are optional.
8294 \begin_layout Itemize
8302 \begin_layout Itemize
8310 \begin_layout Itemize
8318 \begin_layout Itemize
8326 \begin_layout Itemize
8331 : [optional] if more than one author: whom to contact for offprint requests.
8334 \begin_layout Itemize
8339 : [optional] mail address for contacts.
8342 \begin_layout Itemize
8350 Received: <date>; Accepted <date>
8353 \begin_layout Standard
8354 There is no need to issue the
8360 command, this is done automatically by \SpecialChar LyX
8361 when the header is finished.
8362 Although the order of the single header entries doesn't matter it is advised
8363 to keep the above sequence, just to get the best optics and meets the layout
8364 of the real document.
8367 \begin_layout Standard
8368 If you want to place footnotes in the header block, e.
8369 \begin_inset space \thinspace{}
8373 \begin_inset space \space{}
8376 to state your present address, just use the standard footnote via the menu
8379 Insert\SpecialChar menuseparator
8384 will automagically use the term
8393 \begin_layout Standard
8394 In addition to these topics, the macros use three additional \SpecialChar LaTeX
8396 have no counterpart in \SpecialChar LyX
8400 \begin_layout Itemize
8407 to separate different names for more than one author and institute, respectivel
8411 \begin_layout Itemize
8418 to mark corresponding author/institute pairs.
8419 The institutes are numbered sequentially as they appear in the
8423 field, so you have to put a marker to each author.
8426 \begin_layout Itemize
8433 to supply an email address for fast contact.
8436 \begin_layout Standard
8437 In all cases, the appropriate command has to be entered in \SpecialChar LyX
8445 \begin_layout Subsection
8449 \begin_layout Standard
8450 The abstract should immediately follow the header block.
8451 With version 5 the abstract environment was changed to a command, and there
8452 is now a resctriction to only one paragraph.
8453 In addition, it should contain an entry with the keywords.
8454 This is not yet implemented for \SpecialChar LyX
8455 , therefore you have to enter the \SpecialChar LaTeX
8463 by hand and mark it as \SpecialChar LaTeX
8465 Refer to the example paper.
8468 \begin_layout Subsection
8469 Supported environments
8472 \begin_layout Standard
8473 The A&A paper layout supports the following environments for structuring
8477 \begin_layout Itemize
8483 \begin_layout Itemize
8489 \begin_layout Itemize
8495 \begin_layout Itemize
8501 \begin_layout Itemize
8507 \begin_layout Itemize
8513 \begin_layout Itemize
8519 \begin_layout Itemize
8525 \begin_layout Itemize
8531 \begin_layout Itemize
8537 \begin_layout Itemize
8543 \begin_layout Itemize
8550 \begin_layout Subsection
8551 Commands not supported by \SpecialChar LyX
8555 \begin_layout Standard
8556 Some commands are not yet supported by the
8560 layout for \SpecialChar LyX
8562 Some have already been mentioned.
8563 For the sake of completeness, they are listed all together here:
8566 \begin_layout Itemize
8574 \begin_layout Itemize
8582 \begin_layout Itemize
8590 \begin_layout Itemize
8598 \begin_layout Itemize
8606 \begin_layout Itemize
8614 \begin_layout Itemize
8622 \begin_layout Itemize
8630 \begin_layout Standard
8631 If you want to use any of these commands, you have to enter them yourself.
8634 Do not forget to mark them as \SpecialChar LaTeX
8638 \begin_layout Subsection
8639 Figure and Table Floats
8642 \begin_layout Standard
8644 provides support for the necessary float environments
8646 figure, figure*, table
8652 , therefore we won't tell much about it here.
8656 \begin_inset space ~
8662 Just remember that tables should be left-aligned.
8663 For that, select the table and change the alignment in
8665 Edit\SpecialChar menuseparator
8667 \begin_inset space ~
8673 \begin_layout Standard
8674 There is only one special thing: the figures with caption besides the figure.
8675 To create such a figure, you have to do the following:
8678 \begin_layout Enumerate
8679 Create a wide figure float:
8681 Insert\SpecialChar menuseparator
8682 Float\SpecialChar menuseparator
8685 , then right click in the figure and select
8688 \begin_inset space ~
8696 \begin_layout Enumerate
8697 Enter your caption text.
8700 \begin_layout Enumerate
8705 to move the cursor above the caption.
8708 \begin_layout Enumerate
8712 \begin_layout Enumerate
8713 Position the cursor behind the figure and insert a horizontal fill:
8715 Insert\SpecialChar menuseparator
8717 \begin_inset space ~
8720 Character\SpecialChar menuseparator
8722 \begin_inset space ~
8730 \begin_layout Enumerate
8731 Switch to \SpecialChar LaTeX
8735 \begin_inset space ~
8743 \begin_layout Enumerate
8753 Do not close the brace!
8756 \begin_layout Enumerate
8757 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8762 \begin_inset space ~
8774 \begin_layout Standard
8775 Also, refer to the figures in the example paper.
8778 \begin_layout Subsection
8782 \begin_layout Standard
8783 For submission, the paper has to be formated in a special double-spacing
8785 For this purpose, you have to give the option
8789 to the documentclass.
8790 This must be done using the extra class options field in the
8792 Document\SpecialChar menuseparator
8796 Just enter the string
8803 \begin_layout Subsection
8807 \begin_layout Standard
8812 directory contains an example paper written with \SpecialChar LyX
8814 It is the example paper from the original macro package, translated to
8817 Use it for inspiration, and compare the original \SpecialChar LaTeX
8818 code with \SpecialChar LyX
8822 \begin_layout Section
8827 \begin_layout Standard
8833 \begin_layout Subsection
8837 \begin_layout Standard
8839 is a set of macros produced by the American Astronomical Society to
8840 facilitate electronic manuscript submission to the three journals they
8841 publish: the Astrophysical Journal (including the Letters and Supplement),
8842 the Astronomical Journal, and the Publications of the Astronomical Society
8845 has proven to be an excellent tool for generating these documents, especially
8846 given its equation, citation, and figure handling capabilities.
8848 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8849 is the version described here, or higher.
8850 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8851 2.09 and are fundamentally
8852 incompatible with \SpecialChar LyX
8854 The AAS\SpecialChar TeX
8855 package may be downloaded from the AAS\SpecialChar TeX
8859 \begin_layout Standard
8860 \begin_inset VSpace medskip
8866 \begin_layout Standard
8868 \begin_inset Flex URL
8871 \begin_layout Plain Layout
8873 https://aas.org/aastex/aastex-downloads
8881 \begin_layout Standard
8882 \begin_inset VSpace medskip
8888 \begin_layout Standard
8889 A complete user guide is contained in that package and you should familiarize
8890 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8893 will not reduce the need to figure out all the AAS\SpecialChar TeX
8894 commands, it will only
8895 reduce the drudgery of typing everything in.
8896 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8898 completely to the requirements of the journal to which you are submitting
8902 \begin_layout Subsection
8903 Starting a New Paper
8906 \begin_layout Standard
8907 I strongly suggest that you start with the AAS\SpecialChar TeX
8911 File\SpecialChar menuseparator
8918 , enter the new file name, then choose the
8923 This will show the most common fields found in a manuscript.
8924 Simply overwrite the existing text (including the brackets,
8928 ) with the correct information.
8929 Many of the AAS\SpecialChar TeX
8930 commands and environments can be implemented directly in
8932 , but some cannot: most noticeably
8944 , which should stick out like a sore thumb if you actually just opened the
8946 For commands such as these, the \SpecialChar LaTeX
8947 code must be entered directly and marked
8949 Such commands are referred to as \SpecialChar TeX
8950 code, or Evil Red Text.
8951 I tried to minimize the amount of \SpecialChar TeX
8952 code needed in an AAS\SpecialChar TeX
8954 there is still a bit more required than any of us would like.
8957 \begin_layout Subsection
8958 Finishing Your Paper
8961 \begin_layout Standard
8962 When the paper is finished to your satisfaction and previews/prints correctly,
8964 \begin_inset Quotes eld
8968 \begin_inset Quotes erd
8971 actions which need to be done before you submit it to the journals.
8975 \begin_layout Enumerate
8976 Export your paper as a \SpecialChar LaTeX
8979 File\SpecialChar menuseparator
8980 Export\SpecialChar menuseparator
8988 \begin_layout Enumerate
8993 file with your favorite text editor
8997 \begin_layout Enumerate
8998 remove the comment lines before the
9007 \begin_layout Enumerate
9012 usepackage...{fontenc}
9014 line if it appears (usually just after
9029 \begin_layout Enumerate
9030 remove everything between (and including) the
9042 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9044 (which should appear immediately after the
9045 \begin_inset Quotes eld
9048 User specified \SpecialChar LaTeX
9050 \begin_inset Quotes erd
9061 \begin_layout Enumerate
9062 Run the resulting file through \SpecialChar LaTeX
9063 to make sure it still processes correctly.
9066 \begin_layout Enumerate
9067 Reread the journal requirements to make sure your filenames and formats
9071 \begin_layout Enumerate
9075 \begin_layout Subsection
9076 Comments On Specific Commands
9079 \begin_layout Standard
9080 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9087 ) gives a good description of each.
9088 Thus it's probably easiest for me to go down the list as found in the guide
9089 and offer comments where necessary.
9090 So let's begin \SpecialChar ldots
9094 \begin_layout Subsubsection
9095 Things that work as expected
9098 \begin_layout Standard
9099 Because they work as you might expect, I simply list them and the section
9200 begin{thebibliography}
9208 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9209 graphicx figure commands (2.14.1),
9233 (2.15.4, amongst other places),
9260 \begin_layout Standard
9261 The following style options also work correctly:
9282 Simply put them in the
9288 Layout\SpecialChar menuseparator
9294 \begin_layout Subsubsection
9295 Things that work, but require more comment
9298 \begin_layout Standard
9299 The following items work, but require a little more discussion:
9302 \begin_layout Itemize
9303 These items are reserved for use by the journal editors, but you can put
9304 them into the \SpecialChar LaTeX
9305 preamble if you feel compelled to do so:
9338 \begin_layout Itemize
9339 These items may be placed in the \SpecialChar LaTeX
9340 preamble, and are included as blanks in
9362 \begin_layout Itemize
9369 (2.3) – can only be used
9370 \begin_inset Quotes eld
9374 \begin_inset Quotes erd
9377 , not in the middle of a paragraph.
9378 Use \SpecialChar TeX
9379 code if you need to embed it.
9382 \begin_layout Itemize
9389 (2.3) – will have extra {} after it.
9390 This should not cause an error.
9393 \begin_layout Itemize
9400 (2.6) – can only be used
9401 \begin_inset Quotes eld
9405 \begin_inset Quotes erd
9408 , not in the middle of a paragraph.
9409 Use \SpecialChar TeX
9410 code if you need to embed it.
9413 \begin_layout Itemize
9420 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9424 \begin_layout Itemize
9438 \begin_layout Itemize
9445 (2.9) – will have extra {} after it.
9446 This should not cause an error.
9449 \begin_layout Itemize
9456 (2.11) – will have extra {} after it.
9457 This should not cause an error.
9460 \begin_layout Itemize
9467 (2.14.2) – you can insert an optional filename argument by placing the cursor
9468 at the beginning of the text and selecting
9470 Insert\SpecialChar menuseparator
9475 \begin_inset Quotes eld
9479 \begin_inset Quotes erd
9482 inserts an optional argument of the type needed by
9489 Hopefully it will be renamed someday.
9492 \begin_layout Itemize
9505 for the catalog ID optional parameter
9508 \begin_layout Itemize
9521 for the catalog ID optional parameter
9524 \begin_layout Subsubsection
9525 Things not implemented, use \SpecialChar TeX
9529 \begin_layout Standard
9552 setcounter{equation}
9554 (2.12), Journal name abbreviations (2.13.4),
9590 (2.15.4, insert it as the first element in the lefthand cell after where
9592 Don't use any of \SpecialChar LyX
9593 's rules in the table),
9605 (2.15.5), much of Misc (2.17, except
9656 \begin_layout Subsubsection
9657 Things that cannot be implemented
9660 \begin_layout Standard
9662 at least in any meaningful sort of way, so I suggest ignoring them.
9663 They are the references environment (2.13.3), and the deluxetable environment
9665 If you really, really need to use deluxetable, I suggest editing it in
9666 a separate file with a text editor, then using
9668 Insert\SpecialChar menuseparator
9670 \begin_inset space ~
9675 to include it in your \SpecialChar LyX
9681 file to see an example of this.
9684 \begin_layout Subsection
9685 FAQs, Tips, Tricks, and Other Ruminations
9688 \begin_layout Subsubsection
9689 Getting \SpecialChar LyX
9690 and AAS\SpecialChar TeX
9694 \begin_layout Standard
9695 It can be a bit tricky to get \SpecialChar LyX
9696 to recognize a new layout and document class.
9697 When all else fails, do this:
9700 \begin_layout Enumerate
9701 Make certain that \SpecialChar LaTeX
9702 can find AAS\SpecialChar TeX
9704 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9706 directory completely unrelated to \SpecialChar LaTeX
9707 or AAS\SpecialChar TeX
9708 and run \SpecialChar LaTeX
9716 \begin_layout Enumerate
9721 appears in \SpecialChar LyX
9729 \begin_layout Enumerate
9732 Tools\SpecialChar menuseparator
9736 , then restart \SpecialChar LyX
9740 \begin_layout Enumerate
9741 Open a regular new file, not from a template.
9742 Does AAS\SpecialChar TeX
9743 appear in the class list in
9745 Document\SpecialChar menuseparator
9751 \begin_layout Standard
9752 If you get a warning from an existing AAS\SpecialChar TeX
9753 document about not being able
9754 to find the AAS\SpecialChar TeX
9755 layout or a message about
9756 \begin_inset Quotes eld
9759 You should not mix title layouts with normal ones
9760 \begin_inset Quotes erd
9763 , things haven't been installed correctly.
9766 \begin_layout Subsubsection
9768 error processing a table
9771 \begin_layout Standard
9773 , by default, attempts to center the table caption/title.
9774 This seems to produce a bad interaction in AAS\SpecialChar TeX
9775 so you should click somewhere
9776 in the caption/title, then select
9778 Edit\SpecialChar menuseparator
9780 \begin_inset space ~
9794 This took care of it for me.
9797 \begin_layout Subsubsection
9801 \begin_layout Standard
9802 A couple of things: 1) I have noticed some funny spacing in the reference
9803 entries in the text.
9804 When you enter the bibliography item data, make sure their is
9808 space between the last author and the parenthesis setting off the year;
9812 \begin_inset space \thinspace{}
9816 \begin_inset space \space{}
9830 2) Entering the references at all is not obvious.
9831 The easiest thing is to start typing your first reference at the end of
9832 the document, then mark it as type
9837 That will put a small gray box in front of what you just typed.
9838 Click on the box to fill in the rest of the information.
9839 For new references, go to the end of an existing reference and press return.
9840 That will create a new line with its own box, etc.
9843 \begin_layout Subsubsection
9847 \begin_layout Standard
9848 Even though AAS\SpecialChar TeX
9849 provides its own figure commands (
9855 , for example), I much prefer \SpecialChar LaTeX
9856 's standard figure commands (with the default
9865 \begin_inset space ~
9868 commands as \SpecialChar TeX
9869 code into a Figure Float box if you desire, but I never have
9870 much luck getting the layout right.
9871 With the standard graphics, \SpecialChar LyX
9876 usepackage{graphicx}
9878 command into the \SpecialChar LaTeX
9879 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9881 interspersing the figures in the text.
9882 I believe ApJ accepts figures exactly this way now; AJ might still use
9884 \begin_inset Quotes eld
9887 stack everything at the end
9888 \begin_inset Quotes erd
9894 \begin_layout Subsubsection
9895 Things I could have done, but didn't
9898 \begin_layout Standard
9900 \begin_inset Quotes eld
9904 \begin_inset Quotes erd
9907 things I could have implemented, but chose not to.
9908 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9910 even though it is double-spaced in the paper manuscript.
9911 Also, I chose not to make separate layouts for the preprint and preprint2
9913 Since I assume you will spend most of your time in the plain manuscript
9914 mode anyway, I decided not to chew up more disk space with this.
9918 \begin_layout Subsection
9922 \begin_layout Standard
9923 Your mileage may vary.
9924 I've now had papers published by both ApJ and AJ that have had 98% of the
9925 effort done in \SpecialChar LyX
9926 ; the last 2% was the \SpecialChar LaTeX
9927 post-processing and a few cleanups.
9928 I have had no trouble with the submission process, and I'm sure the journals
9929 were never aware that there might be a difference.
9930 So, go forth and publish!
9933 \begin_layout Section
9934 AMS \SpecialChar LaTeX
9938 \begin_layout Standard
9948 \begin_layout Standard
9949 \begin_inset VSpace bigskip
9955 \begin_layout Standard
9957 The AMS \SpecialChar LaTeX
9958 layouts are set up to conform to suggested styles for mathematical
9959 papers to be submitted to American Mathematical Society publications.
9960 The layouts are not tailored to a specific journal, but easily can be.
9961 You should refer to the AMS documentation for specific instructions for
9962 each journal (usually it will entail only changing a single line in the
9965 That documentation is available on the Web at
9966 \begin_inset Flex URL
9969 \begin_layout Plain Layout
9977 \begin_inset Flex URL
9980 \begin_layout Plain Layout
9982 ftp://ftp.ams.org/pub/tex/amslatex/
9988 These layouts are appropriate, and useful, for any mathematical writing.
9992 \begin_layout Standard
9993 There are two basic AMS \SpecialChar LaTeX
9997 \begin_layout Itemize
9998 amsart: The standard AMS article format.
10001 \begin_layout Itemize
10002 amsbook: the standard AMS book (really, monograph) format.
10006 \begin_layout Standard
10007 The layouts themselves contain only the minimum necessary to use the AMS
10009 They do not, in particular, contain any of the `theorem' environments used
10010 for setting theorems, lemmas, and the like.
10011 These are contained, instead, in the
10012 \begin_inset Flex Code
10015 \begin_layout Plain Layout
10021 module, which is loaded by default when you select one of the AMS classes.
10022 (It can also be used with other classes and can be removed, if you would
10023 rather use something else.) Less commonly used environments are in the
10024 \begin_inset Flex Code
10027 \begin_layout Plain Layout
10028 Theorems (AMS-Extended)
10033 module, which must be loaded manually.
10036 \begin_layout Standard
10037 By default, theorems and the like are numbered consecutively throughout
10038 the document, but this may be modified by loading the module
10039 \begin_inset Flex Code
10042 \begin_layout Plain Layout
10043 Theorems (Order by Section)
10048 or, if you are using
10049 \begin_inset Flex Code
10052 \begin_layout Plain Layout
10059 \begin_inset Flex Code
10062 \begin_layout Plain Layout
10063 Theorems (Order by Chapter)
10069 These will number the results as
10070 \begin_inset Formula $n.m$
10073 , where the first number refers to the section (or chapter) and the second
10074 refers to the total number of results so far in that section (or chapter).
10075 Many environments are also available unnumbered.
10076 These are indicated by an asterisk at the end.
10077 If you happen to want
10081 unnumbered results, the module
10082 \begin_inset Flex Code
10085 \begin_layout Plain Layout
10091 provides that option.
10094 \begin_layout Standard
10095 Note that these modules do not
10099 to be used with the AMS classes.
10100 It is perfectly possible to use the
10101 \begin_inset Flex Code
10104 \begin_layout Plain Layout
10110 module, and the others mentioned, with other classes, such as
10111 \begin_inset Flex Code
10114 \begin_layout Plain Layout
10121 \begin_inset Flex Code
10124 \begin_layout Plain Layout
10131 \begin_inset Flex Code
10134 \begin_layout Plain Layout
10143 \begin_layout Subsection
10144 What these layouts provide
10147 \begin_layout Standard
10148 There is a long list of included environments provided by these layouts.
10149 In AMS-\SpecialChar LaTeX
10150 , there is, in fact, an opportunity to define an unlimited variety
10151 of `theorem' environments.
10152 However, the AMS recommends the environments that are available in \SpecialChar LyX
10157 \begin_layout Standard
10158 The following environments—as well as the standard environments, such as
10160 \begin_inset Flex Noun
10163 \begin_layout Plain Layout
10170 \begin_inset Flex Noun
10173 \begin_layout Plain Layout
10180 \begin_inset Flex Noun
10183 \begin_layout Plain Layout
10190 \begin_inset Flex Noun
10193 \begin_layout Plain Layout
10200 \begin_inset Flex Noun
10203 \begin_layout Plain Layout
10210 \begin_inset Flex Code
10213 \begin_layout Plain Layout
10220 \begin_inset Flex Code
10223 \begin_layout Plain Layout
10232 \begin_layout Description
10233 Address This should be the author's permanent address.
10236 \begin_layout Description
10238 \begin_inset space ~
10241 Address This should be the author's temporary address at the time of submission,
10242 if different from the Address.
10245 \begin_layout Description
10246 Email Author's e-mail address
10249 \begin_layout Description
10250 URL Author's Web address, if desired.
10253 \begin_layout Description
10254 Keywords Key words or phrases used to identify specific topics discussed
10258 \begin_layout Description
10259 Subjectclass These refer to the AMS Subject Classifications, published and
10262 Mathematical Reviews
10265 These are also available online at the AMS cites listed above.
10268 \begin_layout Description
10272 \begin_layout Description
10276 \begin_layout Description
10280 \begin_layout Standard
10281 The following environments are provided by both the
10282 \begin_inset Flex Code
10285 \begin_layout Plain Layout
10292 \begin_inset Flex Code
10295 \begin_layout Plain Layout
10301 modules, in the latter case in both starred (unnumbered) and unstarred
10302 (numbered) versions.
10303 These same environments are provided only in the starred versions by the
10305 \begin_inset Flex Code
10308 \begin_layout Plain Layout
10317 \begin_layout Theorem
10318 This is typically used for the statements of major results.
10322 \begin_layout Corollary*
10323 This is used for statements which follow fairly directly from previous statement
10325 Again, these can be major results.
10329 \begin_layout Lemma
10330 These are smaller results needed to prove other statements.
10333 \begin_layout Proposition
10334 These are less major results which (hopefully) add to the general theory
10338 \begin_layout Conjecture
10339 These are statements provided without justification, which the author does
10340 not know how to prove, but which seem to be true (to the author, at least).
10343 \begin_layout Definition*
10344 Guess what this is for.
10345 The font is different for this environment than for the previous ones.
10349 \begin_layout Example*
10350 Used for examples illustrating proven results.
10353 \begin_layout Problem
10354 It's not really known what this is for.
10355 You should figure it out.
10358 \begin_layout Exercise*
10359 Write a description for this one.
10362 \begin_layout Remark
10363 This environment is also a type of theorem, usually a lesser sort of observation.
10366 \begin_layout Claim*
10367 Often used in the course of giving a proof of a larger result.
10371 Generally, these are used to break up long arguments, using specific instances
10377 The numbering scheme for cases is on its own, not together with other numbered
10382 \begin_layout Proof
10383 At the end of this environment, a QED symbol (usually a square, but it can
10384 vary with different styles) is placed.
10385 If you want to have other environments within this one—for example, Case
10386 environments—and have the QED symbol appear only after them, then the other
10387 environments need to be nested within the proof environment.
10390 Nesting Environments
10396 for information on nesting.
10399 \begin_layout Standard
10400 And these environments are provided by
10401 \begin_inset Flex Code
10404 \begin_layout Plain Layout
10405 Theorems (AMS-Extended)
10413 \begin_layout Criterion*
10414 A required condition.
10417 \begin_layout Algorithm*
10418 A general procedure to be used.
10421 \begin_layout Axiom*
10422 This is a property or statement taken as true within the system being discussed.
10425 \begin_layout Condition*
10426 Sometimes used to state a condition assumed within the present context of
10430 \begin_layout Note*
10431 Similar to a Remark.
10434 \begin_layout Notation*
10435 Used for the explanation of, yes, notation.
10438 \begin_layout Summary
10439 Do we really need to tell you?
10442 \begin_layout Acknowledgement*
10446 \begin_layout Conclusion*
10447 Sometimes used at the end of a long train of argument.
10451 Used in a way similar to Proposition, though perhaps lower on the scale.
10454 \begin_layout Standard
10455 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10458 They need to be available on your system in order to use these environments.
10461 \begin_layout Section
10469 \begin_layout Standard
10475 \begin_layout Subsection
10479 \begin_layout Standard
10480 These are the layout files for some of the journals of the American Geophysical
10482 It is assumed that you have both the AGU's own class files and AGUplus
10483 installed (everything to be found at
10484 \begin_inset Flex URL
10487 \begin_layout Plain Layout
10489 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10497 \begin_layout Subsection
10501 \begin_layout Standard
10511 They are still called this in the \SpecialChar LyX
10512 GUI, though their \SpecialChar LaTeX
10525 \begin_layout Standard
10526 Newly defined styles are
10563 These are mostly manuscript attributes and defined in the AGU class documentati
10567 \begin_layout Standard
10568 I suspect this is still badly incomplete.
10571 \begin_layout Subsection
10575 \begin_layout Standard
10592 \begin_layout Subsection
10596 \begin_layout Itemize
10599 Journal of Geophysical Research
10608 \begin_layout Standard
10609 Add your own, it isn't so hard! Look at the
10620 \begin_layout Subsection
10621 Bugs and things to remember
10624 \begin_layout Standard
10625 In order to use the new layouts, you must remember to do the following for
10629 \begin_layout Enumerate
10635 This can be done in the
10637 Layout\SpecialChar menuseparator
10642 Document\SpecialChar menuseparator
10646 (AGU articles are always in English, right? So
10650 choose a language.)
10653 \begin_layout Enumerate
10658 into the document's
10663 (Yes, this is a bug.)
10666 \begin_layout Enumerate
10667 Make sure you use the
10671 bibliography style, by entering
10675 into the second field of the Bib\SpecialChar TeX
10677 None of the standard styles will do.
10680 \begin_layout Section
10684 \begin_layout Standard
10690 \begin_layout Subsection
10694 \begin_layout Standard
10695 Broadway is for writing plays.
10696 The format is more decorative than Hollywood, and much less standardized.
10697 This format should be suitable for workshops.
10700 \begin_layout Subsection
10704 \begin_layout Standard
10705 The same as in Hollywood.
10708 \begin_layout Subsection
10712 \begin_layout Standard
10717 names as labels then cross-reference the label to insert the name.
10718 The cross-reference dialog will show the current cast of characters.
10721 \begin_layout Subsection
10722 Paper size and Margins
10725 \begin_layout Standard
10726 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10729 \begin_layout Subsection
10733 \begin_layout Standard
10734 The following environments are available.
10735 You can use broadway.bind to get the bind keys shown at the right.
10738 \begin_layout Itemize
10742 \begin_inset Newline newline
10747 You should not have to use this, but it is here for anything that does not
10751 \begin_layout Itemize
10755 \begin_inset space \hfill{}
10759 \begin_inset Newline newline
10764 Used to describe stage setting and the action.
10765 First use of speaker names in all CAPs.
10768 \begin_layout Itemize
10772 \begin_inset space \hfill{}
10776 \begin_inset Newline newline
10781 Automatically numbered.
10782 On screen it will be arabic, but will print as Roman.
10785 \begin_layout Itemize
10789 \begin_inset space \hfill{}
10793 \begin_inset Newline newline
10803 It is just centered text.
10806 \begin_layout Itemize
10810 \begin_inset space \hfill{}
10814 \begin_inset Newline newline
10819 Not automatically numbered.
10820 You supply the number.
10821 This is because I couldn't figure out how.
10824 \begin_layout Itemize
10828 \begin_inset space \hfill{}
10832 \begin_inset Newline newline
10837 A special case of Narrative to describe the setting and action as the curtain
10841 \begin_layout Itemize
10845 \begin_inset space \hfill{}
10849 \begin_inset Newline newline
10854 The speaker's (actor's) title, centered in all CAPS.
10857 \begin_layout Itemize
10861 \begin_inset space \hfill{}
10865 \begin_inset Newline newline
10870 Instructions to the speaker.
10871 The parentheses are automatically inserted.
10872 The ( will appear on screen, but both will be in the printed play.
10873 This environment is only used within
10880 \begin_layout Itemize
10884 \begin_inset space \hfill{}
10888 \begin_inset Newline newline
10893 What the Speaker says.
10896 \begin_layout Itemize
10900 \begin_inset space \hfill{}
10904 \begin_inset Newline newline
10909 The curtain comes down.
10912 \begin_layout Itemize
10916 \begin_inset space \hfill{}
10922 \begin_layout Itemize
10926 \begin_inset space \hfill{}
10932 \begin_layout Itemize
10936 \begin_inset space \hfill{}
10942 \begin_layout Standard
10946 \begin_layout Section
10950 \begin_layout Standard
10955 can be used to type letters according to German conventions.
10956 A template file is included in
10958 .../lyx/share/templates
10960 for you to use as a starting point.
10963 \begin_layout Section
10971 \begin_layout Standard
10977 \begin_layout Subsection
10981 \begin_layout Standard
10982 This is the layout file for the European Geophysical Society journals.
10987 can be downloaded from the web site of the EGS under
10988 \begin_inset Flex URL
10991 \begin_layout Plain Layout
11001 \begin_layout Subsection
11005 \begin_layout Standard
11008 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
11016 The current layout file is unfortunately very unmodular and would benefit
11017 from using the various
11024 \begin_layout Section
11028 \begin_layout Standard
11029 See the \SpecialChar LyX
11035 It contains all infos you need.
11038 \begin_layout Section
11041 Foil\SpecialChar TeX
11045 \begin_inset CommandInset label
11054 \begin_layout Standard
11060 \begin_layout Subsection
11064 \begin_layout Standard
11065 This section describes how to use \SpecialChar LyX
11066 to make slides for overhead projectors.
11067 There are two document classes that can do this: the default slides class
11070 Foil\SpecialChar TeX
11074 This section documents the latter.
11077 \begin_layout Standard
11078 I'm going to say this again, nice and clear, so that there's no misunderstanding
11082 \begin_layout Standard
11083 \begin_inset VSpace bigskip
11089 \begin_layout Standard
11093 This section documents the class
11094 \begin_inset Quotes eld
11102 \begin_inset Quotes erd
11110 \begin_layout Standard
11111 \begin_inset VSpace bigskip
11117 \begin_layout Standard
11118 If you're looking for the documentation for
11119 \begin_inset Quotes eld
11127 \begin_inset Quotes erd
11130 , check out section
11131 \begin_inset space ~
11135 \begin_inset CommandInset ref
11137 reference "sec:slitex"
11142 If your machine doesn't have the
11150 installed, you'll probably have to use the default
11154 class, which isn't quite as good as
11159 \begin_layout Standard
11164 class is designed for use with version
11165 \begin_inset space ~
11173 class file which is now an integral part of \SpecialChar LaTeX2e
11177 \begin_layout Subsection
11181 \begin_layout Standard
11182 Obviously, to use this document class, you need to select
11193 \begin_inset space ~
11199 There are some settings in the
11202 \begin_inset space ~
11207 dialog that you should know about that are specific to this class:
11210 \begin_layout Itemize
11211 Don't change the options
11222 \begin_inset space ~
11228 They're ignored by the
11235 \begin_layout Itemize
11236 The default font size is 20
11237 \begin_inset space \thinspace{}
11240 pt with the other options being 17
11241 \begin_inset space \thinspace{}
11245 \begin_inset space \thinspace{}
11249 \begin_inset space \thinspace{}
11255 \begin_layout Itemize
11256 The default font is
11264 but all math equations are still typeset in the usual roman font.
11267 \begin_layout Itemize
11270 Foil\SpecialChar TeX
11273 supports A4 and Letter paper sizes as well as a special size for working
11275 \begin_inset space \thinspace{}
11279 It doesn't support A5, B5, legal or executive paper sizes.
11282 \begin_layout Itemize
11283 Don't bother changing the
11287 settings because they are ignored anyway.
11288 All floats appear where they are defined in the text.
11291 \begin_layout Itemize
11296 setting behaves a bit differently for this class.
11299 Foil\SpecialChar TeX
11302 provides extensive footer and header capabilities including a user-defined
11305 \begin_inset space ~
11309 \begin_inset CommandInset ref
11311 reference "sec:foilfoot"
11316 The title page is treated differently to all other pages in the document
11325 has the logo centered at the bottom of the page (if one is defined).
11326 The possible page style choices and what they do are as follows:
11330 \begin_layout Labeling
11331 \labelwidthstring MMMMMMM
11338 The final output contains no page numbers, or other headers or footers
11339 (except footnotes of course).
11343 \begin_layout Labeling
11344 \labelwidthstring MMMMMMM
11351 The final output contains page numbers centered at the bottom of the page.
11352 No other headings or footers (other than footnotes).
11355 \begin_layout Labeling
11356 \labelwidthstring MMMMMMM
11361 Page numbers in lower right corner.
11362 Additional headers and footers are also shown.
11363 This is also the default.
11366 \begin_layout Labeling
11367 \labelwidthstring MMMMMMM
11372 Gives you access to the
11376 package although its use with
11378 Foil\SpecialChar TeX
11381 is discouraged by the writer of the
11383 Foil\SpecialChar TeX
11386 package because of some potential page layout clashes.
11390 \begin_layout Subsubsection
11394 \begin_layout Standard
11395 The following options may be used in the extra class options in the
11397 Document\SpecialChar menuseparator
11403 \begin_layout Labeling
11404 \labelwidthstring MMMMMMx
11409 This sets up the page layout for 7.33
11410 \begin_inset space \thinspace{}
11414 \begin_inset space \thinspace{}
11417 in paper, which is about the same aspect ratio as a 35
11418 \begin_inset space \thinspace{}
11421 mm slide, making it a bit easier to work with this medium.
11424 \begin_layout Labeling
11425 \labelwidthstring MMMMMMx
11430 Places a rule across the page below the header on every page except the
11434 \begin_layout Labeling
11435 \labelwidthstring MMMMMMx
11440 Places a rule across the page above the footer on every page except the
11444 \begin_layout Labeling
11445 \labelwidthstring MMMMMMx
11450 This is automatically set each time you create a new
11457 Foil\SpecialChar TeX
11460 to use the dvips driver to rotate those pages that are set as landscape
11464 \begin_layout Labeling
11465 \labelwidthstring MMMMMMx
11470 Simply changes the page dimensions to those of a landscape page but doesn't
11472 Thus if you use this option you need to use an external program to rotate
11473 each page or feed your paper through your printer as landscape.
11474 Note that this option effectively reverses the roles of the
11482 environments (don't worry these are described in the next section).
11485 \begin_layout Labeling
11486 \labelwidthstring MMMMMMx
11491 Equation numbers on the left.
11494 \begin_layout Labeling
11495 \labelwidthstring MMMMMMx
11500 Flush-left equations.
11503 \begin_layout Subsection
11504 Supported Environments
11507 \begin_layout Standard
11508 Most of the environments commonly supported in other classes are also supported
11514 There are several additional environments provided by
11516 Foil\SpecialChar TeX
11519 as well as a couple added by \SpecialChar LyX
11521 The following environments are shared with other classes:
11524 \begin_layout Standard
11525 \begin_inset Flex Multiple Columns
11528 \begin_layout Itemize
11534 \begin_layout Itemize
11540 \begin_layout Itemize
11546 \begin_layout Itemize
11552 \begin_layout Itemize
11558 \begin_layout Itemize
11565 \begin_layout Itemize
11571 \begin_layout Itemize
11577 \begin_layout Itemize
11583 \begin_layout Itemize
11589 \begin_layout Itemize
11595 \begin_layout Itemize
11601 \begin_layout Itemize
11607 \begin_layout Itemize
11613 \begin_layout Itemize
11619 \begin_layout Itemize
11625 \begin_layout Itemize
11631 \begin_layout Itemize
11642 \begin_layout Standard
11643 That is, all the major environments apart from the sectioning environments.
11644 Since foils are essentially self-contained sections, with a title and body,
11647 Foil\SpecialChar TeX
11650 provides specific commands for starting new foils and these are:
11653 \begin_layout Itemize
11659 \begin_layout Itemize
11665 \begin_layout Standard
11667 also provides slightly modified versions of these two environments called:
11670 \begin_layout Itemize
11676 \begin_layout Itemize
11679 ShortRotatefoilhead
11682 \begin_layout Standard
11683 and the differences will be explained in the next section.
11686 \begin_layout Standard
11687 Since foils are often used in presenting ideas or new theorems and such
11690 Foil\SpecialChar TeX
11693 also provides a comprehensive box of goodies for presenting them:
11696 \begin_layout Standard
11697 \begin_inset Flex Multiple Columns
11700 \begin_layout Itemize
11706 \begin_layout Itemize
11712 \begin_layout Itemize
11718 \begin_layout Itemize
11724 \begin_layout Itemize
11730 \begin_layout Itemize
11736 \begin_layout Itemize
11742 \begin_layout Itemize
11748 \begin_layout Itemize
11754 \begin_layout Itemize
11760 \begin_layout Itemize
11771 \begin_layout Standard
11772 The starred versions are unnumbered while the unstarred versions are numbered.
11773 There are also two list environments added by \SpecialChar LyX
11777 \begin_layout Itemize
11783 \begin_layout Itemize
11789 \begin_layout Standard
11792 Foil\SpecialChar TeX
11795 provides some powerful header and footer capabilities that are best set
11796 in the preamble although they may be set at any point in a document.
11797 If you want to change these settings in your document the best place to
11798 do so is at the very top of a foil, i.
11799 \begin_inset space \thinspace{}
11805 \begin_inset space \space{}
11810 straight after the foilhead.
11813 \begin_layout Standard
11814 For this purpose, the following command styles are provided [
11821 \begin_layout Standard
11822 \begin_inset Flex Multiple Columns
11825 \begin_layout Itemize
11829 \begin_inset space ~
11835 \begin_layout Itemize
11841 \begin_layout Itemize
11845 \begin_inset space ~
11851 \begin_layout Itemize
11855 \begin_inset space ~
11861 \begin_layout Itemize
11865 \begin_inset space ~
11872 \begin_layout Plain Layout
11873 \begin_inset space ~
11885 \begin_layout Standard
11886 There are also a few commands provided by
11888 Foil\SpecialChar TeX
11891 that aren't directly supported by \SpecialChar LyX
11892 but I'll tell you what they do and how
11893 to use them in section
11894 \begin_inset space ~
11898 \begin_inset CommandInset ref
11900 reference "sec:unsuppfoils"
11907 \begin_layout Subsection
11908 Building a Set of Foils
11911 \begin_layout Standard
11912 This section will give a simple introduction to using the different environments
11913 to build a set of foils.
11914 If you want to see an example set of foils, take a look at the
11918 file you find in \SpecialChar LyX
11926 \begin_layout Subsubsection
11927 Give It a Title Page
11930 \begin_layout Standard
11931 Unlike other classes that provide
11951 creates the title on a page of its own.
11952 If you leave out the
11956 environment \SpecialChar LaTeX
11957 will substitute the current date (every time you regenerate
11961 \begin_layout Subsubsection
11965 \begin_layout Standard
11966 As I mentioned earlier, there are four ways of starting a new foil.
11967 For portrait foils you should use
11976 The difference between these two environments is the amount of space between
11977 the title of the foil (the foilhead) and the body of the foil.
11980 \begin_layout Standard
11981 Landscape foils are generated using the
11987 ShortRotatefoilhead
11990 Again the only difference is the spacing between foilhead and body.
11991 Both of the short versions have 0.5
11992 \begin_inset space ~
11995 inches less separation between the foilhead and the body.
11999 \begin_layout Standard
12000 One problem with the support for landscape foils is the requirement that
12001 you have to use the
12005 driver to generate the PostScript output otherwise the foils won't be rotated.
12006 It is possible to get landscape foils even if you haven't got the
12010 driver provided you can feed your foils sideways through your printer ;-)
12013 \begin_layout Subsubsection
12014 Theorems, Lemmas, Proofs and more
12017 \begin_layout Standard
12018 Due to a small bug in \SpecialChar LyX
12019 you can't have two of the same type of these environments
12020 directly following each other.
12021 They must be separated by something.
12022 If you try, you will just be extending the previous environment as if you
12023 had merged the two environments together.
12024 So, how do you get around this problem? The simplest option is to insert
12025 some text between the two environments or add a
12030 environment between the two with just a
12031 \begin_inset Quotes eld
12039 \begin_inset Quotes erd
12043 This will force \SpecialChar LyX
12044 to produce two separate environments and hence the correct
12047 An example is provided in the example file included with the \SpecialChar LyX
12049 Remember, this problem only occurs if you are trying to place two of the
12050 same type of theorem-like environments one directly after the other.
12053 \begin_layout Subsubsection
12057 \begin_layout Standard
12058 You get all the commonly supported list styles found in other classes as
12059 well as two new ones.
12060 I'll only describe the new ones here.
12061 If you want to find out more about the other list environments check out
12067 If you intend to use itemized lists you might also want to read about the
12071 \begin_inset space ~
12075 \begin_inset space ~
12080 dialog described above in section
12081 \begin_inset space ~
12085 \begin_inset CommandInset ref
12087 reference "sec:bullet"
12094 \begin_layout Standard
12095 The two new list styles,
12103 , are designed to make it easier for you to create lists of do's and don'ts
12104 or right and wrong by providing dedicated environments that use a tick
12105 or a cross as the label of the list.
12106 These lists are in fact dedicated variants of the
12111 They do however require that you have the
12115 packages installed.
12118 \begin_layout Subsubsection
12122 \begin_layout Standard
12125 Foil\SpecialChar TeX
12128 redefines the floating tables and figures so that they appear exactly where
12129 they are in the text rather than pushing them to the top of the page or
12130 to some user specified location.
12131 In fact if you change the float placement settings they are simply ignored.
12134 \begin_layout Subsubsection
12135 Page Headers and Footers
12136 \begin_inset CommandInset label
12138 name "sec:foilfoot"
12145 \begin_layout Standard
12149 \begin_inset space ~
12158 are two commands used to control the left-footer text string.
12159 The first is meant to allow you to include a graphic logo on your foils
12161 \begin_inset Quotes eld
12166 Foil\SpecialChar TeX
12170 \begin_inset Quotes erd
12174 While the second is meant to provide a classification for the audience,
12178 \begin_inset space \thinspace{}
12184 \begin_inset space \space{}
12188 It is empty by default.
12191 \begin_layout Standard
12192 The remaining page corners can be filled by
12195 \begin_inset space ~
12200 (which defaults to page numbers),
12203 \begin_inset space ~
12211 \begin_inset space ~
12219 \begin_layout Subsection
12222 Foil\SpecialChar TeX
12226 \begin_inset CommandInset label
12228 name "sec:unsuppfoils"
12235 \begin_layout Standard
12236 All the commands mentioned below need to be set in a
12246 within another environment.
12249 \begin_layout Subsubsection
12253 \begin_layout Standard
12254 All lengths are adjusted using the
12277 should be replaced by the name given to the length you want to change and
12282 is the length value.
12283 All lengths should be specified in units of length such as inches (
12295 ) or relative to some document or font-based length such as
12305 \begin_layout Standard
12306 It's possible to change the spacing between a foilhead and the body of the
12307 foil by adjusting the length specified by
12314 For example, to make
12319 \begin_inset space \space{}
12322 in closer to their bodies put the following in the preamble:
12328 foilheadskip}{-0.5in}
12331 \begin_layout Standard
12332 The spacings around floats can be adjusted by setting these lengths:
12335 \begin_layout Labeling
12336 \labelwidthstring MMMMMMMMMMM
12343 Separation between the text and the top of the float
12346 \begin_layout Labeling
12347 \labelwidthstring MMMMMMMMMMM
12354 Separation between the float and the caption
12357 \begin_layout Labeling
12358 \labelwidthstring MMMMMMMMMMM
12365 Separation between the caption and the following text
12368 \begin_layout Labeling
12369 \labelwidthstring MMMMMMMMMMM
12376 You can make the captions narrower than the surrounding text by adjusting
12378 Best done relative to
12387 \begin_layout Standard
12388 There are also several title page related lengths that you may find useful
12389 if you have a long title or several authors:
12392 \begin_layout Labeling
12393 \labelwidthstring MMMMMMMMMMM
12400 Separation from headers to
12405 \begin_layout Labeling
12406 \labelwidthstring MMMMMMMMMMM
12424 \begin_layout Labeling
12425 \labelwidthstring MMMMMMMMMMM
12439 \begin_layout Labeling
12440 \labelwidthstring MMMMMMMMMMM
12456 \begin_layout Labeling
12457 \labelwidthstring MMMMMMMMMMM
12473 \begin_layout Standard
12474 The last length related command affects all the list environments.
12485 a list environment then all the vertical spacing between the list items
12487 Note that this is a command not a length so it doesn't require
12493 like the stuff mentioned above.
12496 \begin_layout Subsubsection
12497 Headers and Footers
12500 \begin_layout Standard
12513 commands control whether the logo in the
12517 definition appear on a given page.
12524 in the preamble then none of the foils will have the logo on them.
12525 If you don't want the logo on a particular page place the
12531 directly after the foilhead of that page and the
12537 directly after the next foilhead.
12540 \begin_layout Standard
12541 If you decide to use the
12545 page style setting in the
12548 \begin_inset space ~
12553 dialog you should probably add
12563 to your preamble so headers and footers on landscape pages are correctly
12564 placed when rotated.
12565 This is due to some clashes between the page layouts provided by the
12576 \begin_layout Section
12577 Hollywood (Hollywood spec scripts)
12580 \begin_layout Standard
12586 \begin_layout Subsection
12590 \begin_layout Standard
12591 Getting the format of a Hollywood script right is a
12592 \begin_inset Quotes eld
12596 \begin_inset Quotes erd
12599 It is designed to make the readers focus on content and to be easy and
12600 familiar for the actors to read.
12601 Each page of a script should be one minute of film.
12602 Nothing goes in a script that you cannot see or hear on screen.
12603 The courier 12 pt font should be used throughout.
12607 \begin_layout Subsection
12611 \begin_layout Standard
12612 Speakers' lines should NEVER break in mid-sentence.
12613 If a speaker's lines continue over a page break, repeat the
12617 title followed by (Cont'd).
12620 \begin_layout Subsection
12624 \begin_layout Standard
12629 names as labels then cross-reference the label to insert the name.
12630 The cross-reference dialog will show the current cast of characters.
12631 You can use this to insert the speaker name in narratives also.
12634 \begin_layout Subsection
12635 Paper size and Margins
12638 \begin_layout Standard
12639 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12642 \begin_layout Subsection
12646 \begin_layout Standard
12647 The following environments are available.
12648 You can use hollywood.bind to get the bind keys shown at the right.
12651 \begin_layout Itemize
12655 \begin_inset Newline newline
12660 Used where nothing else works.
12664 \begin_layout Itemize
12670 \begin_inset space \hfill{}
12678 \begin_inset Newline newline
12681 Usually followed by something like
12682 \begin_inset Quotes eld
12685 on Sally waking up.
12686 \begin_inset Quotes erd
12692 \begin_layout Itemize
12696 \begin_inset space \hfill{}
12700 \begin_inset Newline newline
12705 Introduces a new INTERIOR camera set-up.
12706 Always followed by DAY or NIGHT, or something similar to define the lighting
12708 Everthing on this line in CAPS.
12711 \begin_layout Itemize
12715 \begin_inset space \hfill{}
12719 \begin_inset Newline newline
12724 Introduces a new EXTERIOR camera set-up.
12725 Everthing on this line in CAPS.
12728 \begin_layout Itemize
12732 \begin_inset space \hfill{}
12736 \begin_inset Newline newline
12741 The character speaking.
12744 \begin_layout Itemize
12748 \begin_inset space \hfill{}
12752 \begin_inset Newline newline
12757 Instructions to the speaker.
12758 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12760 Both will be printed.
12763 \begin_layout Itemize
12767 \begin_inset space \hfill{}
12771 \begin_inset Newline newline
12783 \begin_layout Itemize
12787 \begin_inset space \hfill{}
12791 \begin_inset Newline newline
12796 Camera movement instruction.
12798 \begin_inset space \thinspace{}
12802 \begin_inset space \space{}
12808 \begin_layout Itemize
12812 \begin_inset space \hfill{}
12818 \begin_layout Itemize
12822 \begin_inset space \hfill{}
12828 \begin_layout Itemize
12832 \begin_inset space \hfill{}
12838 \begin_layout Itemize
12842 \begin_inset space \hfill{}
12848 \begin_layout Subsection
12852 \begin_layout Itemize
12856 \begin_layout Itemize
12860 \begin_layout Itemize
12862 \begin_inset space \thinspace{}
12869 \begin_layout Itemize
12874 \begin_layout Itemize
12875 PAN — camera movement
12878 \begin_layout Itemize
12879 INSERT — cut to close-up of
12882 \begin_layout Section
12886 \begin_layout Standard
12889 Panayotis Papasotiriou
12892 \begin_layout Subsection
12896 \begin_layout Standard
12897 The ijmpc package is a set of macros that facilitates electronic manuscript
12900 International Journal of Modern Physics C
12903 Similarly, the ijmpd package is for creating manuscripts to be submitted
12906 International Journal of Modern Physics D
12909 Both journals are published by World Scientific.
12910 The corresponding document classes are named
12919 These files, together with instructions for the authors, can be downloaded
12921 \begin_inset Flex URL
12924 \begin_layout Plain Layout
12926 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12932 \begin_inset Flex URL
12935 \begin_layout Plain Layout
12937 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12943 Both packages are modified versions of the standard
12944 \begin_inset Quotes eld
12948 \begin_inset Quotes erd
12951 package, and they are almost (but not exactly) identical.
12952 Most of their features are supported by \SpecialChar LyX
12954 I have used \SpecialChar LyX
12955 successfully to write articles submitted to both journals
12956 without any problem.
12959 \begin_layout Subsection
12963 \begin_layout Standard
12964 As usual, the easiest way to write a paper is to start with a template.
12967 File\SpecialChar menuseparator
12983 This will give an (almost) empty document that includes the most common
12984 fields found in a manuscript.
12985 Simply overwrite the existing text (including the brackets,
12990 You should keep in mind the following remarks.
12993 \begin_layout Enumerate
12995 won't let you change the font size and the page style of the document,
12996 because such modifications are not allowed by both packages.
12999 \begin_layout Enumerate
13000 The language of the document should not be changed.
13001 Before previewing your paper, be sure that the babel package is not used.
13002 To do this, click on
13003 \change_inserted -712698321 1501082726
13007 arg "dialog-show document"
13013 \change_deleted -712698321 1501082743
13018 \SpecialChar menuseparator
13020 \change_deleted -712698321 1501082747
13022 \change_inserted -712698321 1501082748
13028 \change_deleted -712698321 1501082762
13037 checkbox in the language settings, and click on
13045 , if you wish to make this change permanent)
13046 \change_inserted -712698321 1501082770
13048 \begin_inset Quotes eld
13052 \begin_inset Quotes erd
13064 \begin_layout Enumerate
13066 \begin_inset Quotes eld
13070 \begin_inset Quotes erd
13073 style must be used to define keywords.
13076 \begin_layout Enumerate
13077 The ijmpc package provides a style named
13078 \begin_inset Quotes eld
13081 Classification Codes
13082 \begin_inset Quotes erd
13085 , which can be used to define classification codes, such as PACS numbers.
13086 Note that this facility is not supported by the ijmpd package.
13089 \begin_layout Enumerate
13090 Several new environments are available:
13091 \begin_inset Quotes eld
13095 \begin_inset Quotes erd
13099 \begin_inset Quotes eld
13103 \begin_inset Quotes erd
13107 \begin_inset Quotes eld
13111 \begin_inset Quotes erd
13115 \begin_inset Quotes eld
13119 \begin_inset Quotes erd
13123 \begin_inset Quotes eld
13127 \begin_inset Quotes erd
13131 \begin_inset Quotes eld
13135 \begin_inset Quotes erd
13139 \begin_inset Quotes eld
13143 \begin_inset Quotes erd
13147 \begin_inset Quotes eld
13151 \begin_inset Quotes erd
13155 \begin_inset Quotes eld
13159 \begin_inset Quotes erd
13163 \begin_inset Quotes eld
13167 \begin_inset Quotes erd
13171 \begin_inset Quotes eld
13175 \begin_inset Quotes erd
13179 \begin_inset Quotes eld
13183 \begin_inset Quotes erd
13187 \begin_inset Quotes eld
13191 \begin_inset Quotes erd
13195 \begin_inset Quotes eld
13199 \begin_inset Quotes erd
13203 Their use is more or less obvious.
13205 supports all these environments; it will use the proper label, text style,
13206 and numbering scheme for each of them.
13209 \begin_layout Enumerate
13210 Both packages use basic citations; the natbib package should not be used.
13211 In \SpecialChar LyX
13212 , citation references are shown as usual; in the output, citations are
13213 shown as superscripts.
13214 If you want to use a citation as normal text, you should use the
13219 \begin_inset space \thinspace{}
13223 \begin_inset space \space{}
13227 \begin_inset Quotes eld
13231 \begin_inset space \space{}
13241 \begin_inset Quotes erd
13247 \begin_layout Enumerate
13249 \begin_inset Quotes eld
13253 \begin_inset Quotes erd
13256 section in both packages.
13257 To put acknowledgments, just use the
13258 \begin_inset Quotes eld
13262 \begin_inset Quotes erd
13268 \begin_layout Enumerate
13269 Appendices may be added to the paper,
13273 the Acknowledgments and
13279 provides a special environment, called
13280 \begin_inset Quotes eld
13284 \begin_inset Quotes erd
13287 which marks the beginning of the appendices.
13288 This environment should be left blank; it just sends a \SpecialChar LaTeX
13289 command, but nothing
13291 In \SpecialChar LyX
13293 \begin_inset Quotes eld
13297 \begin_inset Quotes erd
13300 is printed with blue letters, as a signal that all sections after that
13301 point are appendices.
13302 To write an appendix, use the
13303 \begin_inset Quotes eld
13307 \begin_inset Quotes erd
13312 will number each appendix with capital letters, as required by both journals.
13314 \begin_inset Quotes eld
13318 \begin_inset Quotes erd
13325 be present before the first appendix; if not, all appendices will be numbered
13326 as normal sections in the output.
13329 \begin_layout Enumerate
13330 The ijmpc and the ijmpd packages use the
13334 command to implement table captions.
13335 As a result, a table created by \SpecialChar LyX
13336 is printed correctly, but its caption
13338 However, you can use some \SpecialChar TeX
13339 code to overcome this problem, so that captions
13340 are printed as expected.
13341 To do so, create a float table as usual, remove the caption, and replace
13342 it with the \SpecialChar TeX
13353 (sic); you must also the \SpecialChar TeX
13358 immediately after the tabular material.
13359 Study the example table included in the template files to see how this
13360 trick is implemented.
13361 Alternatively, If you need table captions, you should implement the whole
13366 file, then include this file to the \SpecialChar LyX
13369 Insert\SpecialChar menuseparator
13370 File\SpecialChar menuseparator
13372 \begin_inset space ~
13378 Details on how to create a table float can be found in the files
13386 , included in the corresponding packages.
13389 \begin_layout Subsection
13390 Preparing a paper for submission
13393 \begin_layout Standard
13394 Before you submit your paper you must export the \SpecialChar LyX
13395 document as a \SpecialChar LaTeX
13398 File\SpecialChar menuseparator
13399 Export\SpecialChar menuseparator
13407 \begin_layout Plain Layout
13408 Actually you have the choice between \SpecialChar LaTeX
13409 (plain) and pdflatex.
13410 If you intend to use pdflatex to prepare the paper, you should use the
13411 pdflatex option so that included graphics are converted to PDF format,
13412 ready for use by pdflatex.
13417 , then make the following changes to the resulting
13424 \begin_layout Enumerate
13425 Remove the comment lines before the
13434 \begin_layout Enumerate
13435 Remove everything between (and including) the
13447 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13451 \begin_layout Standard
13456 file should be saved and processed through \SpecialChar LaTeX
13457 as many times as necessary.
13458 You may also want to check the resulting
13465 \begin_layout Subsection
13467 \change_deleted -712698321 1501082212
13468 Use of \SpecialChar TeX
13472 \begin_layout Standard
13474 \change_deleted -712698321 1501082212
13475 The use of \SpecialChar TeX
13476 code is reduced to two commands, which must be placed at the
13477 top of the document.
13478 If you started writing your paper by using the
13486 template, the \SpecialChar TeX
13487 code needed is already in its place; you usually don't need
13489 You may only modify the first \SpecialChar TeX
13490 code to specify the information printed
13491 to the top of odd and even pages (authors' names and short paper's title,
13493 This \SpecialChar TeX
13494 code must have the form
13498 markboth{Authors' Names}{Short Paper's Title}
13505 \begin_layout Section
13509 \begin_layout Standard
13515 \begin_layout Subsection
13519 \begin_layout Standard
13520 The iopart package provides a document class to create electronic manuscript
13521 submission to the journals published by the Institute of Physics.
13522 Instructions for the authors how to create a paper using the iopart class
13523 can be downloaded together with the iopart package from the site
13524 \begin_inset Flex URL
13527 \begin_layout Plain Layout
13529 ftp://ftp.iop.org/pub/journals/latex2e
13537 \begin_layout Subsection
13541 \begin_layout Standard
13542 The easiest way to write a paper is to start with the file
13546 that is available in \SpecialChar LyX
13547 's examples files folder.
13548 Open this file, save it under a new name, and start writing.
13549 The example file explains how to use the special text environments.
13550 Here are the most important advices:
13553 \begin_layout Itemize
13554 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13557 Use AMS math package
13559 in the document settings under
13566 \begin_layout Itemize
13569 The title environment defines the kind of your paper.
13570 So use one of the following environments for the title:
13574 \begin_layout Itemize
13583 \begin_layout Itemize
13592 \begin_layout Itemize
13598 for a Topical review
13601 \begin_layout Itemize
13610 \begin_layout Itemize
13619 \begin_layout Itemize
13625 for a Paper (same as Title)
13628 \begin_layout Itemize
13634 for a Preliminary communication
13637 \begin_layout Itemize
13643 for a Rapid communication
13646 \begin_layout Itemize
13652 for a Letter to the editor
13656 \begin_layout Itemize
13659 All title environments except of
13663 can have an optional short title.
13666 \begin_layout Itemize
13667 There is a general title environment
13671 which is not directly supported by the \SpecialChar LyX
13673 This can be used as \SpecialChar TeX
13674 code when your document doesn't fit into one of the
13678 \begin_layout Standard
13679 For more informations like hints for special table and formula formatting,
13680 look at the IOP author guidelines.
13683 \begin_layout Section
13687 \begin_layout Standard
13690 Panayotis Papasotiriou
13693 \begin_layout Subsection
13697 \begin_layout Standard
13698 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13699 that facilitates electronic manuscript submission to the journals they
13701 Most known of them (at least in my domain of interest) are
13703 Astrophysics and Space Science
13709 , but there are many others (see a complete list at
13710 \begin_inset Flex URL
13713 \begin_layout Plain Layout
13715 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13721 The Kluwer package may be downloaded from the site
13722 \begin_inset Flex URL
13725 \begin_layout Plain Layout
13727 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13733 A complete user guide is contained in that package (but it can also be
13734 downloaded separately).
13737 \begin_layout Standard
13739 supports many features of the package but not everything.
13740 However, the \SpecialChar TeX
13741 code needed is reduced to some
13742 \begin_inset Quotes eld
13746 \begin_inset Quotes erd
13749 commands of the package (see
13750 \begin_inset space ~
13754 \begin_inset CommandInset ref
13756 reference "subsec:kluwer_peculiarities"
13761 I have recently used \SpecialChar LyX
13762 to write an article submitted to the
13764 Astrophysics and Space Science
13766 without any problem.
13769 \begin_layout Subsection
13773 \begin_layout Standard
13774 The easiest way to write a paper is to start with the Kluwer template file.
13777 File\SpecialChar menuseparator
13789 This will give an (almost) empty document that includes the most common
13790 fields found in a manuscript and a short description of their use.
13791 As in most templates, simply overwrite the existing text (including the
13796 ) with the correct information.
13799 \begin_layout Subsection
13800 Preparing a paper for submission
13803 \begin_layout Standard
13804 As in the AAS\SpecialChar TeX
13805 package, before you submit your paper to a journal you must
13807 \begin_inset Quotes eld
13811 \begin_inset Quotes erd
13817 \begin_layout Enumerate
13818 Export your paper as a \SpecialChar LaTeX
13820 To do this, click on
13822 File\SpecialChar menuseparator
13823 Export\SpecialChar menuseparator
13831 \begin_layout Enumerate
13836 file with a text editor and make the following changes
13840 \begin_layout Enumerate
13841 remove the comment lines before the
13850 \begin_layout Enumerate
13851 remove everything between (and including) the
13863 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13867 \begin_layout Standard
13876 \begin_layout Enumerate
13881 file through \SpecialChar LaTeX
13882 as many times as necessary (usually up to three).
13885 \begin_layout Enumerate
13891 \begin_inset space \thinspace{}
13895 \begin_inset space \space{}
13902 , and check if everything is OK (it should, if you didn't make any mistake).
13905 \begin_layout Subsection
13906 \begin_inset Quotes eld
13910 \begin_inset Quotes erd
13913 of the Kluwer package
13914 \begin_inset CommandInset label
13916 name "subsec:kluwer_peculiarities"
13923 \begin_layout Standard
13924 The Kluwer package has the following
13925 \begin_inset Quotes eld
13929 \begin_inset Quotes erd
13935 \begin_layout Enumerate
13936 It is possible to write multiple articles in the same \SpecialChar LaTeX
13941 \begin_layout Plain Layout
13942 I can't imagine any good reason to do this.
13948 Each article must be included in the environment
13949 \begin_inset Quotes eld
13953 \begin_inset Quotes erd
13957 Unfortunately, this environment cannot be omitted, even if you write just
13959 Therefore, each article starts with the command
13965 and, obviously, ends with the command
13972 Although this can be implemented in \SpecialChar LyX
13973 , I didn't included it, since it looks
13974 ugly and can confuse the novice user.
13975 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13978 \begin_inset Quotes eld
13983 \begin_inset Quotes erd
13989 \begin_layout Enumerate
13990 Information given at the beginning of the article (i.
13991 \begin_inset space \thinspace{}
13995 \begin_inset space \space{}
13998 title, subtitle, author, institution, running title, running author, abstract
13999 and keywords) must be included in an environment called
14000 \begin_inset Quotes eld
14004 \begin_inset Quotes erd
14008 This is not implemented in \SpecialChar LyX
14009 , so you must enter title, subtitle etc.
14010 \begin_inset space ~
14013 between two \SpecialChar TeX
14029 \begin_layout Enumerate
14030 According to the user manual, the label of each bibliography item must be
14054 \begin_layout Standard
14059 template takes care of all these
14060 \begin_inset Quotes eld
14064 \begin_inset Quotes erd
14068 If you start a new paper using this template you don't need to do anything
14073 \begin_layout Enumerate
14074 don't delete the \SpecialChar TeX
14075 code included in the template, and
14078 \begin_layout Enumerate
14079 copy the example bibliography item included in the template and modify it
14080 as necessary to enter new bibliography items.
14083 \begin_layout Section
14087 \begin_layout Standard
14093 \begin_layout Subsection
14097 \begin_layout Standard
14098 The \SpecialChar LyX
14101 article (koma-script)
14105 report (koma-script)
14123 correspond to the \SpecialChar LaTeX
14141 \begin_inset space ~
14144 of the Koma-Script family.
14145 They are replacements for the standard document classes
14161 , resp., and fit better to European typography conventions in a number of
14165 \begin_layout Itemize
14166 Standard character size is 11pt in
14168 article (koma-script)
14172 report (koma-script)
14180 letter (koma-script)
14185 \begin_layout Itemize
14186 Headings, labels of the description environment, and a number of elements
14189 letter (koma-script)
14191 document class are set in a bold sans serif font.
14195 \begin_layout Plain Layout
14196 There is a big difference between the bold sans serif old cm fonts and new
14197 ec fonts, especially in the appearance of headings.
14198 In comparison, the ec bold sans serif fonts look a bit thin.
14199 Here the \SpecialChar LaTeX
14208 helps to produce the
14209 \begin_inset Quotes eld
14213 \begin_inset Quotes erd
14216 appearance when using the ec fonts.
14221 The numbering of chapter headings is made in the same way as the numbering
14222 of section headings, that is without the extra line
14223 \begin_inset Quotes eld
14226 Chapter\SpecialChar ldots
14228 \begin_inset Quotes erd
14232 In addition, the appearance of the headings can be modified by using a
14233 number of options (in \SpecialChar LyX
14234 to be entered in the field
14237 \begin_inset space ~
14244 Layout\SpecialChar menuseparator
14251 \begin_layout Itemize
14252 The main means in the Koma-Script document classes to design the type area
14261 (in \SpecialChar LyX
14262 to be entered in the extra class options field in the dialog
14264 Document\SpecialChar menuseparator
14268 They make a clearer modification of page margins possible as do the options
14271 Document\SpecialChar menuseparator
14278 \begin_layout Itemize
14279 The \SpecialChar LaTeX
14280 document classes of the Koma-Script family define a number of additional
14282 Those part of it which makes sense in \SpecialChar LyX
14283 is implemented in corresponding
14287 \begin_layout Standard
14288 Detailed descriptions of the \SpecialChar LaTeX
14289 document classes of the Koma-Script family
14290 can be found in the Koma-Script documentation
14301 \begin_layout Subsection
14302 article (koma-script), report (koma-script), and book (koma-script)
14305 \begin_layout Standard
14306 The document classes
14308 article (koma-script)
14312 report (koma-script)
14322 are implemented in the layout files
14335 They contain all the paragraph types of the corresponding standard document
14348 , resp., partly modified, with the exception of the \SpecialChar LyX
14353 -type, which is replaced by the new
14357 -type having the same functionality.
14362 -Type there is a number of new paragraph types added.
14369 letter (koma-script)
14374 \begin_layout Itemize
14383 : are equivalents to
14391 , resp., additionally inserting an entry in the table of contents.
14400 are not contained in
14402 article (koma-script)
14407 \begin_layout Itemize
14416 : behave exactly as
14424 , resp., additionally clearing running heads.
14429 is not contained in
14431 article (koma-script)
14437 \begin_layout Plain Layout
14450 report (koma-script)
14452 , but since this is identical to
14456 , is has not been implemented in \SpecialChar LyX
14465 \begin_layout Itemize
14470 : generates a heading directly above the following paragraph in the standard
14471 character size without affecting the structure of the document.
14474 \begin_layout Itemize
14483 are special captions which respect the different space settings needed
14484 for captions placed above or below an element (if you follow strict typographic
14485 rules, you might want to place table captions always above the table).
14486 You can also use the class option
14490 , which will switch
14503 You need at least Koma-Script version 2.8q to use this.
14506 \begin_layout Itemize
14511 : can be used to set a bonmot, e.
14512 \begin_inset space \thinspace{}
14516 \begin_inset space \space{}
14519 at the beginning of a chapter.
14520 If you use the optional argument (
14522 Insert\SpecialChar menuseparator
14524 \begin_inset space ~
14529 ), you can insert the dictum's author there.
14530 Dictum and author are separated by a line.
14531 You need at least Koma-Script version 2.8q to use this.
14536 is not contained in
14538 article (koma-script)
14543 \begin_layout Standard
14544 The following types, together with the standard types
14556 , form the title area of the document.
14557 They must be entered ahead of the first
14558 \begin_inset Quotes eld
14562 \begin_inset Quotes erd
14569 \begin_layout Plain Layout
14570 The corresponding \SpecialChar LaTeX
14571 commands must appear before the
14582 When such a type is used more than once, the latter usage overwrites the
14583 former one, that means, for every type only the latest usage is valid.
14584 The order of the different types however has, like
14596 , no effect on the appearance of the produced document.
14599 \begin_layout Itemize
14604 : produces a centered paragraph above the ordinary title (
14616 ) for the subject of the document.
14619 \begin_layout Itemize
14624 : produces a centered paragraph below the ordinary title (
14636 ) for the publishers' name.
14639 \begin_layout Itemize
14646 report (koma-script)
14652 produces a centered paragraph on its own page behind the title page, or
14655 article (koma-script)
14657 produces a centered paragraph below the ordinary title (
14673 ) for a dedication.
14676 \begin_layout Itemize
14681 : produces a left aligned paragraph above the ordinary title (
14697 ) for a document`s head.
14700 \begin_layout Itemize
14705 : produces in a double-sided print in
14707 report (koma-script)
14713 a left-aligned paragraph at the top of the title page`s back or has no
14714 effect in a single-sided print or in
14716 article (koma-script)
14721 \begin_layout Itemize
14726 : produces in a double-sided print in
14728 report (koma-script)
14734 a left-aligned paragraph at the bottom of the title page`s back or has
14735 no effect in a single-sided print or in
14737 article (koma-script)
14742 \begin_layout Itemize
14747 : produces a special
14748 \begin_inset Quotes eld
14752 \begin_inset Quotes erd
14755 page ahead of the actual document containing a paragraph without special
14759 \begin_layout Standard
14760 The layout files for the document classes
14762 article (koma-script)
14766 report (koma-script)
14772 do include the file
14777 This is thought of as a place to define your own types.
14782 in your personal layout directory and edit the file!
14785 \begin_layout Subsection
14786 letter (koma-script)
14789 \begin_layout Standard
14793 letter (koma-script)
14795 is implemented in the layout file
14800 It contains all the paragraph types of the corresponding standard document
14805 , partly modified, with the exception of the \SpecialChar LyX
14819 type, which is replaced by the new
14824 In addition, it contains, in contrast to the standard document class, the
14843 Furthermore, there are a number of new letter specific types.
14846 \begin_layout Standard
14847 The appearance of the letter produced by this document class can be controlled
14848 by a number of \SpecialChar LaTeX
14849 commands, which you can put in the \SpecialChar LaTeX
14854 \begin_layout Plain Layout
14855 For example, the standard appearance of the letter`s heading, consisting
14856 of name and address, is quite self-willed.
14858 \begin_inset Quotes eld
14862 \begin_inset Quotes erd
14865 heading is produced by the following \SpecialChar LaTeX
14866 commands in the preamble:
14869 \begin_layout LyX-Code
14879 \begin_layout LyX-Code
14895 \begin_layout LyX-Code
14905 \begin_layout LyX-Code
14925 A detailed German description of such \SpecialChar LaTeX
14926 commands can be found in the Koma-Script
14932 With it, the letter's author can produce his personal letter layout.
14935 \begin_layout Standard
14944 define the beginning of the letter and must be used in every letter.
14945 To emphasize them in the \SpecialChar LyX
14946 document class, they are marked with the letter
14956 \begin_inset space ~
14959 in the left margin.
14960 It is possible to write any number of letters in one file.
14965 type produces a new letter using the same addressee and a
14969 type produces a new addressee.
14986 are ordinary paragraph types and can also be used several times in one
14987 and the same letter.
14990 \begin_layout Itemize
14995 : produces a paragraph for the addressee and implicitly defines the beginning
14999 \begin_layout Itemize
15004 : produces a paragraph for the form of address and implicitly produces a
15008 \begin_layout Itemize
15013 : produces a paragraph for a close.
15016 \begin_layout Itemize
15021 : produces a paragraph for a postscript.
15024 \begin_layout Itemize
15029 : produces a paragraph for a distribution list.
15032 \begin_layout Itemize
15037 : produces a paragraph for enclosures.
15040 \begin_layout Standard
15081 are input types provided with a label to enter information, which will
15082 be processed by the document class.
15086 \begin_layout Plain Layout
15087 It could be seen as a matter of inconsequence, that the types
15095 described above are not such input types as well.
15096 Because of the special meaning of those types, however, I have implemented
15097 them as ordinary paragraph types with a one letter mark in the left margin.
15098 Moreover, it would affect my feeling of symmetry, if the
15106 type had such a serious different appearance.
15111 The types must be used ahead of the corresponding
15118 \begin_layout Standard
15119 An implementation of these types in a WYSIWYG fashion does not seem to make
15120 sense, because the real appearance of the produced letter does not only
15121 depend on the usage of the particular type, but also on other factors.
15122 For example, a signature entered in the
15126 type will in the standard behavior appear in the produced letter only,
15127 when in the same letter also a
15132 The entered value of the
15136 type will in the standard behavior not appear in the produced letter at
15138 The possibility to design the letter`s heading freely is already indicated
15139 in a footnote above.
15142 \begin_layout Standard
15143 The input types can also be used as empty paragraphs.
15144 This makes sense e.
15145 \begin_inset space \thinspace{}
15149 \begin_inset space \space{}
15161 type is not used at all, in the standard behavior the value of the
15165 type is used as signature, whereas if an empty
15169 type is used, no signature value is defined.
15172 \begin_layout Standard
15173 By using the input types it is possible to write a letter template, containing
15174 filled input types with your personal dates (name, address, etc.) and empty
15175 input types for other dates you want to enter.
15178 \begin_layout Itemize
15183 : sender's name, in the standard behavior appears as a centered paragraph
15184 in small caps in the letter`s heading.
15187 \begin_layout Itemize
15192 : sender's signature, in the standard behavior appears below the
15201 type is used, the value of the
15205 type appears instead.
15208 \begin_layout Itemize
15213 : sender's address, in the standard behavior appears in a centered paragraph
15214 in the letter`s heading below the sender's name.
15217 \begin_layout Itemize
15222 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15233 \begin_layout Itemize
15238 : place of the letter`s making.
15241 \begin_layout Itemize
15246 : date of the letter`s making.
15255 , in the standard behavior, produce the place and the date in a right-aligned
15256 line below the addressee's field.
15261 type is used, neither place nor date appear, independent of the value of
15271 type is used, the date of the letter `s production is used.
15274 \begin_layout Itemize
15279 : sender`s back address, in the standard behavior appears above the addressee's
15280 field in a small sans serif font.
15283 \begin_layout Itemize
15288 : special mail information, in the standard behavior appears underlined
15289 above the addressee's field below the back address.
15292 \begin_layout Itemize
15297 : additional information, in the standard behavior appears on right side
15298 below the addressee`s field.
15301 \begin_layout Itemize
15306 : the letter's title, in the standard behavior appears in a big, bold, sans
15307 serif font above the subject.
15310 \begin_layout Itemize
15315 : the letter's subject, in the standard behavior appears in a bold font
15323 \begin_layout Standard
15344 produce a business letter like line above the
15348 line containing the fields
15349 \begin_inset Quotes eld
15353 \begin_inset Quotes erd
15357 \begin_inset Quotes eld
15361 \begin_inset Quotes erd
15365 \begin_inset Quotes eld
15369 \begin_inset Quotes erd
15373 \begin_inset Quotes eld
15377 \begin_inset Quotes erd
15381 \begin_inset Quotes eld
15385 \begin_inset Quotes erd
15389 \begin_inset Quotes eld
15393 \begin_inset Quotes erd
15397 For the date field, the value of the
15403 \begin_inset Quotes eld
15406 business letter types
15407 \begin_inset Quotes erd
15410 is used, the value of the
15414 type however does not appear, but only the \SpecialChar LaTeX
15422 The ordinary output of place and date in a right-aligned line below the
15423 addressee`s field is suppressed.
15424 The types are implemented as input types provided with a label and must
15425 be used ahead of the corresponding
15432 \begin_layout Itemize
15440 \begin_layout Itemize
15448 \begin_layout Itemize
15456 \begin_layout Itemize
15464 \begin_layout Itemize
15472 \begin_layout Subsection
15473 The new letter class: letter (koma-script v.2)
15476 \begin_layout Standard
15482 \begin_layout Standard
15483 \begin_inset VSpace medskip
15489 \begin_layout Standard
15491 Koma-Script version 2.8 has introduced a new letter class
15495 which supersedes the now unsupported
15500 It has — on the \SpecialChar LaTeX
15501 side — a completely new interface and is not compatible
15502 with the old class.
15503 Therefore, \SpecialChar LyX
15504 supports both, though it is recommended you use the new class.
15507 \begin_layout Standard
15508 This class covers the same functionality as
15510 letter (koma-script),
15513 The basic items are
15517 (receiver's address, same as
15521 in the old layout),
15534 will start a new letter (i.
15535 \begin_inset space \thinspace{}
15539 \begin_inset space \space{}
15542 you can write several letters per document).
15543 New elements are sender's
15559 and the possibility to use a
15565 Insert\SpecialChar menuseparator
15571 \begin_layout Standard
15572 The biggest improvement is, though, that the letter's layout is configurable
15573 to meet almost any needs.
15574 This can be done via the preamble or with a special style file (Letter
15575 Class Option, extension
15579 ), that will be read in as a class option.
15583 \begin_layout Plain Layout
15584 The KOMA package comes with some default
15589 There is, for instance, a
15593 file that follows german typesetting rules, or a
15597 that provides the default layout of the old
15602 The latter can be loaded with the class option
15608 Layout\SpecialChar menuseparator
15609 Document\SpecialChar menuseparator
15621 template that is included in \SpecialChar LyX
15623 A detailed description is to be found in the Koma-Script documentation
15631 \begin_layout Subsection
15635 \begin_layout Standard
15636 Visualizing the Koma-Script document classes in \SpecialChar LyX
15637 , the \SpecialChar LyX
15638 internals cause some
15642 \begin_layout Itemize
15643 The chapter number of a
15647 type appears on a line of its own above the chapter heading instead of
15648 appearing in the same line ahead of it.
15649 The cause for that is the \SpecialChar LyX
15650 internal behavior for the labeltype
15654 in the layout file.
15657 \begin_layout Itemize
15658 The headings of the types
15666 are only put in the
15667 \begin_inset Quotes eld
15671 \begin_inset Quotes erd
15675 table of contents, but not in the \SpecialChar LyX
15676 table of contents (
15678 Document\SpecialChar menuseparator
15680 \begin_inset space ~
15684 \begin_inset space ~
15692 \begin_layout Itemize
15693 The paragraphs in a
15697 document class appear in a skip separation mode, not indented.
15698 This is the standard behavior, no special \SpecialChar LaTeX
15699 commands are needed for that.
15702 Document\SpecialChar menuseparator
15705 dialog the corresponding radio button indicates
15714 value always has the effect that extra \SpecialChar LaTeX
15715 commands are inserted in the document
15716 to produce the gap, which is not what is wanted in this case.
15719 \begin_layout Section
15723 \begin_layout Standard
15729 \begin_layout Subsection
15733 \begin_layout Standard
15734 Memoir is a very powerful and constantly evolving class.
15735 It has been designed with regard to fictional and non-fictional literature.
15736 Its aim is to let the user have maximum control over the typesetting of
15738 Memoir is based on the standard book class, but it can also emulate the
15739 article class (see below).
15742 \begin_layout Standard
15743 Peter Wilson, the developer of Memoir, is known as the author of lots of
15744 useful packages in the \SpecialChar LaTeX
15746 Most of them have been merged with Memoir.
15747 Therefore, it is much easier to layout the table of contents, appendices,
15748 chapter designs and such.
15750 , though, does not support all of these goodies natively.
15751 Some of them might be added to forthcoming releases
15755 \begin_layout Plain Layout
15756 You are invited to send suggestions to
15757 \begin_inset Flex URL
15760 \begin_layout Plain Layout
15762 lyx-devel@lists.lyx.org
15772 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15774 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15776 commands (\SpecialChar TeX
15781 \begin_layout Plain Layout
15786 \begin_layout Plain Layout
15796 \begin_inset space ~
15800 \begin_inset CommandInset ref
15802 reference "sec:Inserting-TeX-Code"
15812 In this section, we can only list those features that are natively supported
15813 by \SpecialChar LyX
15815 For detailed descriptions (and for the rest of features) we recommend you
15816 have a look at the detailed manual of the Memoir class
15820 \begin_layout Plain Layout
15825 \begin_layout Plain Layout
15835 \begin_inset Flex URL
15838 \begin_layout Plain Layout
15840 CTAN:/macros/latex/memoir/memman.pdf
15850 , which is not only a user guide for the class, but also both a comprehensive
15851 description on good typesetting and a superb example for good typesetting
15855 \begin_layout Subsection
15856 Basic features and restrictions
15859 \begin_layout Standard
15860 Memoir supports basically all features of the standard book classes.
15861 There are, however, some differences, as follows:
15864 \begin_layout Description
15866 \begin_inset space ~
15869 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15872 \begin_layout Description
15874 \begin_inset space ~
15877 style: The fancy page style is not supported, due to a command clash between
15878 Memoir and the fancyhdr package (they both define a command with the same
15879 name, which confuses \SpecialChar LaTeX
15881 Instead, Memoir comes with a number of its own page styles (see
15883 Layout\SpecialChar menuseparator
15884 Document\SpecialChar menuseparator
15886 \begin_inset space ~
15892 If you want to use these for the chapter pages, you have to use the command
15899 in the main text or in preamble (e.
15900 \begin_inset space \thinspace{}
15904 \begin_inset space \space{}
15911 chapterstyle{companion}
15916 \begin_layout Description
15917 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15918 optional argument in the standard classes.
15919 With this, you can specify an alternative version of the title for the
15920 table of contents and the headers (for instance, if the title is too long).
15921 In \SpecialChar LyX
15922 , you can do this via
15924 Insert\SpecialChar menuseparator
15926 \begin_inset space ~
15931 at the beginning of a chapter/section.
15932 Memoir features a second optional argument and thus separates the table
15933 of contents from the header.
15934 You can define three variants of a title with this: one for the main text,
15935 one for the table of contents, and one for the headers.
15936 Simply insert two optional arguments if you need this feature, the first
15937 one containing the short title for the Table of Contents, the second one
15938 containing an alternative short title for the headers.
15941 \begin_layout Description
15942 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15943 of contents, the list of figures and the list of table start a new page
15945 Memoir does not follow this route.
15946 You have to insert a page break yourself, if you want to have one.
15949 \begin_layout Description
15950 Titlepage: For some unknown reason, Memoir uses pagination on the title
15951 page (in the standard classes, title pages are
15952 \begin_inset Quotes eld
15956 \begin_inset Quotes erd
15960 If you want an empty title page, type
15964 aliaspagestyle{title}{empty}
15969 \begin_layout Description
15970 Article: With the class option
15976 Layout\SpecialChar menuseparator
15977 Document\SpecialChar menuseparator
15979 \begin_inset space ~
15984 ), you can emulate article style.
15985 That is, counters (footnotes, figures, tables etc.) will not be reset on
15986 new chapters, chapters don't start a new page (but are—in contrary to
15987 \begin_inset Quotes eld
15991 \begin_inset Quotes erd
15994 article classes—still allowed), parts, though, use their own page, as in
15998 \begin_layout Description
15999 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
16000 font commands, which have been used in the old \SpecialChar LaTeX
16002 \begin_inset space \thinspace{}
16006 \begin_inset space \space{}
16022 It produces an error and stops \SpecialChar LaTeX
16023 whenever such a command appears.
16028 reallows the commands and spits out warnings instead (which does at least
16029 not stop \SpecialChar LaTeX
16031 Since a lot of packages and particularly Bib\SpecialChar TeX
16032 style files are still using
16033 those commands, we have decided to use this option by default.
16036 \begin_layout Subsection
16040 \begin_layout Standard
16041 We will only describe the features supported by \SpecialChar LyX
16042 (which is not much currently).
16043 Please consult the Memoir manual
16047 \begin_layout Plain Layout
16052 \begin_layout Plain Layout
16062 \begin_inset Flex URL
16065 \begin_layout Plain Layout
16067 CTAN:/macros/latex/memoir/memman.pdf
16080 \begin_layout Description
16081 Abstract: You may wonder why an abstract is an extra feature.
16082 Well, it is in book class.
16083 Usually books don't have abstracts.
16084 Memoir, however, has.
16085 You can use it wherever and how often you like.
16088 \begin_layout Description
16089 Chapterprecis: You may know this older typesetting style: The contents of
16090 a chapter are summarized below the title and also in the table of contents
16092 \begin_inset space \thinspace{}
16096 \begin_inset space \space{}
16101 Our hero arrives in Troia; he loses some friends; he finds others
16104 Chapterprecis does exactly this.
16105 It is therefore only sensible below a chapter.
16108 \begin_layout Description
16109 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16110 The epigraph environment provides an elegant way of typesetting such a
16112 The motto itself (text) and its author (source) are divided by a short
16114 Unfortunately, we have to fool \SpecialChar LyX
16115 a bit here again, since the environment
16116 needs two arguments (text and source).
16117 In this case, we have to use curly brackets (in \SpecialChar TeX
16118 mode) between the two
16129 <author of the slogan>.
16132 \begin_layout Description
16133 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16134 complex figurative poems).
16136 can only support a few of them.
16137 One is poemtitle, which is a centered title for poems, which will also
16138 be added to the table of contents (verse is the standard environment for
16140 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16142 because they have to be nested inside regular verse environments, which
16143 is not possible with \SpecialChar LyX
16147 \begin_layout Description
16148 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16151 \begin_layout Section
16152 Article (mwart), book (mwbk) and report (mwrep)
16153 \begin_inset Argument status
16156 \begin_layout Plain Layout
16169 \begin_layout Standard
16175 \begin_layout Standard
16176 The \SpecialChar LyX
16193 correspond to the \SpecialChar LaTeX
16207 They are replacements for the standard document classes
16219 , resp., and fit better to Polish typography conventions in a number of points.
16223 \begin_layout Standard
16227 \begin_layout Itemize
16228 Unnumbered titles (with star, e.
16229 \begin_inset space \thinspace{}
16233 \begin_inset space \space{}
16240 ) are added into table of contents,
16243 \begin_layout Itemize
16244 Additional page styles:
16248 \begin_layout Description
16249 uheadings header with separated lines,
16252 \begin_layout Description
16253 myheadings custom header, contents headers via commands:
16268 \begin_layout Description
16269 myuheadings custom header with separated lines,
16272 \begin_layout Description
16273 outer page number is placed on outer side of page
16277 \begin_layout Itemize
16282 \begin_layout Description
16283 rmheadings serif titles — default,
16286 \begin_layout Description
16287 sfheadings sansserif titles,
16290 \begin_layout Description
16291 authortitle on title page first placed is author next title — default,
16294 \begin_layout Description
16295 titleauthor on title page first placed is title next author,
16298 \begin_layout Description
16299 withmarginpar reserve place on page for margins.
16303 \begin_layout Section
16307 \begin_layout Standard
16312 provides an alternative to the standard
16317 It provides similar functionality, but you might prefer this layout with
16318 sans serif sections, headings, and more.
16321 \begin_layout Section
16322 Rev\SpecialChar TeX
16326 \begin_layout Standard
16332 \begin_layout Standard
16333 \begin_inset VSpace bigskip
16339 \begin_layout Standard
16344 \begin_inset space ~
16349 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16351 \begin_inset Formula $\beta$
16354 release of May, 1999) class.
16357 \begin_layout Standard
16363 textclass, which works with Rev\SpecialChar TeX
16365 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16367 That means that it doesn't interact very well with \SpecialChar LyX
16368 , which requires \SpecialChar LaTeX2e
16370 it has been kludged to work.
16371 Since Rev\SpecialChar TeX
16372 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16377 Rev\SpecialChar TeX
16379 \begin_inset space ~
16384 textclass should also be pretty easy to use.
16387 \begin_layout Standard
16388 These documents are supposed to be used in
16392 to the Rev\SpecialChar TeX
16393 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16395 and assume you'll know what to put in the preamble if necessary.
16398 \begin_layout Subsection
16402 \begin_layout Standard
16403 All you need to do is install Rev\SpecialChar TeX
16404 4, as described in the package's README
16406 The package can be found at The Rev\SpecialChar TeX
16408 \begin_inset Flex URL
16411 \begin_layout Plain Layout
16413 http://publish.aps.org/revtex4/
16419 Install it somewhere that \SpecialChar LaTeX
16421 Test it by trying to \SpecialChar LaTeX
16422 a short Rev\SpecialChar TeX
16423 4 document in some random directory (i.
16424 \begin_inset space \thinspace{}
16428 \begin_inset space \space{}
16431 not the directory where you installed the class file.) Then, if you reconfigure
16433 , it will find the class file and let you use the Rev\SpecialChar TeX
16437 \begin_layout Standard
16438 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16447 \begin_inset space ~
16452 template, found in the templates directory.
16455 \begin_layout Subsection
16459 \begin_layout Standard
16460 Optional arguments to
16467 \begin_inset Quotes eld
16471 \begin_inset Quotes erd
16475 \begin_inset Quotes eld
16479 \begin_inset Quotes erd
16485 \begin_inset space ~
16493 \begin_inset space ~
16499 Remember that in Rev\SpecialChar TeX
16500 , at least one optional argument is required!
16503 \begin_layout Standard
16504 Other preamble matter, like
16511 \begin_inset space ~
16518 \begin_inset space ~
16523 dialog, also as usual.
16526 \begin_layout Subsection
16530 \begin_layout Standard
16531 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16533 For example, the Email layout corresponds to
16540 Note that (at least as of Rev\SpecialChar TeX
16549 layouts are exactly equivalent, so you shouldn't need to use both.
16553 \begin_layout Plain Layout
16554 In case you're curious, both were included so that
16558 would be able to translate both
16578 \begin_layout Subsection
16582 \begin_layout Standard
16583 There are a couple of important unique aspects of Rev\SpecialChar TeX
16584 4 which might cause
16585 bugs that will be even more confusing in \SpecialChar LyX
16589 \begin_layout Standard
16590 In Rev\SpecialChar TeX
16608 The \SpecialChar LyX
16609 equivalent is that there is a separate Thanks layout.
16614 write footnotes in the
16618 layout, or weird things may happen.
16619 See the Rev\SpecialChar TeX
16620 4 documentation for more details.
16623 \begin_layout Standard
16627 \begin_inset space ~
16635 \begin_inset space ~
16644 layouts must be placed
16652 layout and the corresponding
16669 , the \SpecialChar LaTeX
16673 \begin_layout Subsection
16677 \begin_layout Standard
16678 The main problem with this layout is that you can't use the optional arguments
16679 to layouts like Email and Title.
16680 (The problem is not unique to this layout; you can't use optional arguments
16681 to the Section layouts either.) This means that after you export that file
16682 to \SpecialChar LaTeX
16683 (which you'll need to do eventually to send it in to APS), you'll need
16684 to edit the \SpecialChar LaTeX
16685 file with a text editor to add the optional arguments to set,
16687 \begin_inset space \thinspace{}
16691 \begin_inset space \space{}
16694 the running title for the page headers.
16695 Lacking these layouts makes the
16701 (and the equivalent
16707 ) useless, so the corresponding layouts don't exist, and will have to be
16712 \begin_layout Plain Layout
16717 actually, \SpecialChar LyX
16718 1.3.0 supports some forms of optional arguments, but this layout
16719 has not been updated yet to take advantage of it.
16727 \begin_layout Section
16728 Springer Journals (
16735 \begin_layout Standard
16741 \begin_layout Subsection
16745 \begin_layout Standard
16746 These are the layout files for some of the journal formats used by Springer
16747 Verlag and listed on
16748 \begin_inset Flex URL
16751 \begin_layout Plain Layout
16753 http://www.springer.de/author/tex/help-journals.html
16758 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16760 It is a modular system: the things common to all journals are implemented
16765 , which journal-specific layout files (such as, e.
16766 \begin_inset space \thinspace{}
16770 \begin_inset space \space{}
16777 for Journal of Geodesy) can include.
16780 \begin_layout Standard
16781 This means that implementing support for any other Springer journal on this
16782 list is as simple as writing your own
16790 file following the outline given in
16798 \begin_layout Standard
16799 It is reasonably well tested only for the Journal of Geodesy.
16808 come with the standard \SpecialChar LyX
16810 Install the relevant class file (downloaded from Springer) in a proper
16811 directory, reconfigure \SpecialChar LaTeX
16812 (in the te\SpecialChar TeX
16817 , as root if necessary — doesn't \SpecialChar LyX
16818 take care of this?), reconfigure \SpecialChar LyX
16823 \begin_layout Subsection
16827 \begin_layout Standard
16828 A large number of theorem-like styles —
16840 \begin_layout Standard
16843 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16844 _Title, Author_Running, Institute,
16845 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16848 See the Springer class file documentation for details.
16851 \begin_layout Subsection
16855 \begin_layout Itemize
16867 \begin_layout Itemize
16870 Probability Theory and Related Fields
16876 — Jean-Marc Lasgouttes
16879 \begin_layout Standard
16880 Add your own, it isn't so hard!
16883 \begin_layout Subsection
16887 \begin_layout Standard
16888 These files are partly based on the older
16892 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16894 file from Springer.
16899 layout, are now defunct.
16900 Jean-Marc Lasgouttes helped out big in making me find my way around the
16902 layout file mechanism.
16905 \begin_layout Subsection
16909 \begin_layout Standard
16911 But probably less than in the old hacked-\SpecialChar LaTeX
16919 \begin_layout Standard
16921 \begin_inset space \thinspace{}
16924 g.: does not display the number for theorem-like layouts, just #.
16927 \begin_layout Section
16930 Sli\SpecialChar TeX
16934 \begin_inset CommandInset label
16943 \begin_layout Standard
16951 \begin_layout Subsection
16955 \begin_layout Standard
16956 This section describes how to use \SpecialChar LyX
16957 to make slides for overhead projectors.
16958 There are two document classes that can do this: the default slides class
16961 Foil\SpecialChar TeX
16965 This section documents the former.
16968 \begin_layout Standard
16969 I'm going to say this again, nice and clear, so that there's no misunderstanding
16973 \begin_layout Standard
16974 \begin_inset VSpace bigskip
16980 \begin_layout Standard
16984 This section documents the class
16985 \begin_inset Quotes eld
16993 \begin_inset Quotes erd
17001 \begin_layout Standard
17002 \begin_inset VSpace bigskip
17008 \begin_layout Standard
17009 If you're looking for the documentation for
17010 \begin_inset Quotes eld
17015 slides (Foil\SpecialChar TeX
17019 \begin_inset Quotes erd
17022 , check out section
17023 \begin_inset space ~
17027 \begin_inset CommandInset ref
17029 reference "sec:foiltex"
17039 \begin_inset Quotes eld
17044 slides (Foil\SpecialChar TeX
17048 \begin_inset Quotes erd
17051 ] is actually somewhat better than the default
17059 \begin_layout Plain Layout
17061 or so I've been told repeatedly by its advocates.
17062 Having never used it, I have no idea if this claim is true or not.
17067 which this section documents.
17070 \begin_layout Standard
17071 This class is the \SpecialChar LaTeX2e
17072 improvement of the old
17074 Sli\SpecialChar TeX
17078 Every \SpecialChar LaTeX2e
17079 distribution includes this class [which I'll just refer to as
17080 \begin_inset Quotes eld
17088 \begin_inset Quotes erd
17091 from now on], so you're bound to have it.
17092 As I noted earlier, there are other classes, such as
17096 , which also produce slides for overhead projectors and do a better job
17098 However, there are some things which
17102 can do which the others can't, such as generate overlays.
17103 Read on to learn more!
17106 \begin_layout Subsection
17108 \begin_inset CommandInset label
17110 name "sec:slidesetup"
17117 \begin_layout Standard
17118 Obviously, to use this document class, you need to select
17119 \begin_inset Quotes eld
17127 \begin_inset Quotes erd
17130 from the class list in the
17132 Document\SpecialChar menuseparator
17136 There are some other special things you should know about this class:
17139 \begin_layout Itemize
17140 Don't bother changing the options
17145 They're not supported by the
17152 \begin_layout Itemize
17156 \begin_inset space ~
17161 behaves a bit differently for this class.
17162 The possible choices and what they do are as follows:
17166 \begin_layout Description
17171 The final output contains page numbers in the lower right corner.
17174 \begin_layout Description
17183 , but also prints out any time markers you've put in.
17184 This is the default.
17187 \begin_layout Description
17192 The final output contains no page numbers, time markers, or alignment markers.
17196 \begin_layout Itemize
17201 class has an extra option:
17207 \begin_inset Quotes eld
17215 \begin_inset Quotes erd
17218 in the extra class options.
17222 \begin_layout Standard
17223 Using this options allows you to add time markers to
17229 \begin_inset space ~
17233 \begin_inset CommandInset ref
17235 reference "sec:slideNote"
17243 \begin_layout Standard
17244 You can also use the template file
17245 \begin_inset Quotes eld
17253 \begin_inset Quotes erd
17256 to automatically set up a document to use the
17262 File\SpecialChar menuseparator
17264 \begin_inset space ~
17268 \begin_inset space ~
17273 to open your new document].
17274 The template file also contains some examples of the special paragraph
17275 environments used by this class.
17276 I'll describe those next.
17279 \begin_layout Subsection
17280 Paragraph Environments
17283 \begin_layout Subsubsection
17284 Supported Environments
17287 \begin_layout Standard
17288 The first thing you'll notice when you start up a new
17292 document is the font size and type: it's the equivalent of the size
17293 \begin_inset Quotes eld
17301 \begin_inset Quotes erd
17307 \begin_inset space ~
17313 This is also what's used in the output.
17315 \begin_inset Quotes eld
17319 \begin_inset Quotes erd
17322 to remind you that this is a slide.
17323 Your final slides will use a larger font; ergo, you'll have less space.
17324 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17327 \begin_layout Standard
17328 The next thing that becomes obvious is the changes to the paragraph environment
17329 pull-down box [at the far-left end of the toolbar].
17330 Most of the paragraph environments you're used to seeing are missing.
17331 There are also five new ones.
17336 class itself only supports certain paragraph environments:
17339 \begin_layout Itemize
17345 \begin_layout Itemize
17351 \begin_layout Itemize
17357 \begin_layout Itemize
17363 \begin_layout Itemize
17369 \begin_layout Itemize
17375 \begin_layout Itemize
17381 \begin_layout Itemize
17387 \begin_layout Itemize
17393 \begin_layout Itemize
17400 \begin_layout Itemize
17406 \begin_layout Standard
17407 All of the other standard environments, including the section-heading environmen
17408 ts, aren't used in the
17415 \begin_layout Standard
17416 On the other hand, you'll notice the following new environments:
17419 \begin_layout Itemize
17425 \begin_layout Itemize
17431 \begin_layout Itemize
17437 \begin_layout Itemize
17443 \begin_layout Itemize
17449 \begin_layout Standard
17450 These five are kind of quirky, due to a
17451 \begin_inset Quotes eld
17455 \begin_inset Quotes erd
17458 in \SpecialChar LyX
17460 You see, \SpecialChar LyX
17461 doesn't permit you to nest any other paragraph environment into
17462 an empty environment.
17463 Now, that's fine and dandy, but it means that you wouldn't be able to start
17464 a slide with anything except plain text.
17465 To deal with this, I've performed a little
17466 \begin_inset Quotes eld
17471 \begin_inset Quotes erd
17477 \begin_layout Subsubsection
17478 Quirks of the New Environments
17479 \begin_inset CommandInset label
17481 name "sec:slideQuirk"
17488 \begin_layout Standard
17489 All five of the new paragraph environments are somewhat quirky due to inherent
17490 limitiations in the current version of \SpecialChar LyX
17492 As I just mentioned, \SpecialChar LyX
17493 forbids environments that begin with another environment.
17494 To get around this, the
17498 environment isn't a paragraph environment as described in the
17506 \begin_layout Standard
17507 You should consider
17520 \begin_inset Quotes eld
17523 pseudo-environments.
17524 \begin_inset Quotes erd
17527 They look like a section heading or a
17528 \begin_inset Quotes eld
17536 \begin_inset Quotes erd
17539 but really begin a [and, if necessary, end the previous] paragraph environment.
17549 \begin_inset Quotes eld
17553 \begin_inset Quotes erd
17556 These two perform some action.
17559 \begin_layout Standard
17560 A common feature of all five environments,
17580 , is a rather long-ish label.
17581 The text following this label — ordinarily the contents of the paragraph
17582 environment — is utterly irrelevant for
17604 completely ignores it.
17605 In fact, you can leave these five environments completely empty.
17609 \begin_layout Standard
17614 to put any text after the rather long-ish label, you might want to.
17615 This could be a short description of the contents of the
17620 In that case, enter your descriptive comment and hit
17624 as you normally would.
17627 \begin_layout Standard
17628 If, on the other hand, you don't want to enter any descriptive text, you'll
17629 hit another \SpecialChar LyX
17632 , like nature, abhors a vacuum, and will not let you start a new paragraph
17633 environment until you put something in the old one.
17637 \begin_layout Itemize
17638 Start entering the text that will
17666 \begin_layout Itemize
17667 Now move to the beginning of that paragraph.
17671 \begin_layout Itemize
17680 \begin_layout Itemize
17681 Finally, change this new, empty paragraph to a
17705 \begin_layout Standard
17706 Some future version of \SpecialChar LyX
17707 will, hopefully, resolve this quirkiness\SpecialChar ldots
17711 \begin_layout Subsection
17712 Making a Presentation with
17725 \begin_layout Subsubsection
17733 \begin_layout Standard
17734 If you're expecting this section to teach you how to actually make a presentatio
17735 n, you'll be sorely disappointed.
17736 Naturally, I'll describe all of the ways the
17740 class can assist you in preparing the materials for a presentation.
17741 Filling in the contents, however, is up to you.
17746 the \SpecialChar LyX
17750 \begin_layout Standard
17755 environment [in the manner described in section
17756 \begin_inset space ~
17760 \begin_inset CommandInset ref
17762 reference "sec:slideQuirk"
17766 ] tells \SpecialChar LyX
17767 to begin a new slide [duh].
17768 The label for this environment/
17769 \begin_inset Quotes erd
17773 \begin_inset Quotes erd
17777 \begin_inset Quotes eld
17781 \begin_inset Quotes erd
17784 in cool blue, followed by the label,
17785 \begin_inset Quotes eld
17789 \begin_inset Quotes erd
17793 Any text or paragraph environments that follow this one go on the new slide.
17797 \begin_layout Standard
17798 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17800 (this can be specified in the
17805 In fact, you'll want to, once you finish entering the contents of one slide.
17806 If you've entered more text than can physically fit on a slide, the extra
17807 overflows onto a new slide.
17808 I don't recommend doing this, however, since the overflow slide won't have
17809 any page number on it.
17810 Furthermore, it may interfere with any
17814 you've made to accompany the oversized
17821 \begin_layout Standard
17830 environments work the same way as the
17835 They both create an
17836 \begin_inset Quotes eld
17840 \begin_inset Quotes erd
17843 followed by a label [
17844 \begin_inset Quotes eld
17848 \begin_inset Quotes erd
17852 \begin_inset Quotes eld
17856 \begin_inset Quotes erd
17860 The color is a stunning magenta instead of blue, and the
17861 \begin_inset Quotes eld
17865 \begin_inset Quotes erd
17868 will look different, in style and in length.
17869 The label fonts of all three also differ from one another.
17872 \begin_layout Standard
17877 , if the contents of a
17885 exceed the physical size of a slide or sheet of paper, the extra will overflow
17887 Again, you should avoid this.
17888 It defeats the whole purpose of
17899 \begin_layout Subsubsection
17909 \begin_layout Standard
17914 is a slide that sits atop another slide.
17915 Perhaps you wish to discuss a figure on the main
17919 before displaying the text associated with it.
17920 One way to accomplish this is tape a flap of dark paper over the part of
17925 you want to display later.
17926 This method fails, however, if you wish to overlap one graph with another,
17928 You would then have to fumble while speaking to align the two separate,
17933 s to align the two graphs.
17938 environment in both cases makes life much easier.
17941 \begin_layout Standard
17946 receives the page number of its
17947 \begin_inset Quotes eld
17951 \begin_inset Quotes erd
17959 \begin_inset Quotes eld
17967 \begin_inset Quotes erd
17974 \begin_layout Plain Layout
17975 Presumably, mutliple
17980 \begin_inset Quotes eld
17988 \begin_inset Quotes erd
17992 \begin_inset Quotes eld
18000 \begin_inset Quotes erd
18004 \begin_inset Quotes eld
18012 \begin_inset Quotes erd
18016 \begin_inset space ~
18019 appended to the page number of the parent
18029 Clearly, you want the contents of both the
18037 to each fit on a single physical slide! You should probably consider an
18043 \begin_inset Quotes eld
18047 \begin_inset Quotes erd
18055 Indeed, the \SpecialChar LyX
18060 class provides a visual cue for this: the label at the start of an
18064 is shorter than that at the start of a
18069 Lastly, when you generate printable output, you'll find alignment markers
18070 in all four corners of both the
18074 page and its parent
18079 These will assist you in lining up the two physical slides.
18082 \begin_layout Standard
18083 The major problem in overlaying two slides is aligning the contents of the
18084 two transparencies.
18085 How much space should you leave for that graph on the second slide? Worse
18086 still, what if you want a graph and a sentence on second slide, but there
18087 is text on the main transparency that goes in between them? You could try
18088 and insert vertical space of the right size.
18089 The better way is to use
18100 \begin_layout Standard
18101 As their names imply,
18109 are two command-like paragraph environments that make all subsequent text
18110 invisible and visible, respectively.
18112 \begin_inset space ~
18116 \begin_inset CommandInset ref
18118 reference "sec:slideQuirk"
18122 that you don't place anything
18126 these two environments, however.
18131 , it inserts a centered, sky-blue label into the page reading
18132 \begin_inset Quotes eld
18135 <Invisible Text Follows>
18136 \begin_inset Quotes erd
18140 For paragraphs following this label, the parts of the
18148 ; it doesn't matter which] where they would be contain instead blank space.
18152 \begin_layout Standard
18157 , the corresponding centered label is
18158 \begin_inset Quotes eld
18161 <Visible Text Follows>
18162 \begin_inset Quotes erd
18166 Paragraphs following this label behave normally.
18167 Note that the beginning of a new
18179 automatically shuts off an
18184 It's therefore not necessary to use
18195 \begin_layout Standard
18196 By now, it should be obvious how to create overlay transparencies using
18197 the proper combination of
18216 \begin_layout Enumerate
18221 , including everything that will appear on it, whether on the main slide
18229 \begin_layout Enumerate
18230 Before each figure or paragraph that will appear only on the
18239 If necessary, insert a
18243 environment after the
18250 \begin_layout Enumerate
18255 immediately following the
18262 \begin_layout Enumerate
18263 Copy the contents of this
18274 \begin_layout Enumerate
18279 , change all of the
18290 \begin_layout Standard
18292 You've just made an
18299 \begin_layout Standard
18300 There's one problem with the way I've designed the \SpecialChar LyX
18305 class: you can't make text in the middle of a paragraph invisible, nor
18306 make text in the middle of an invisible paragraph visible again.
18307 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18312 \begin_layout Plain Layout
18313 The commands of interest are:
18316 \begin_layout Itemize
18321 invisible \SpecialChar ldots
18325 \begin_layout Itemize
18330 visible \SpecialChar ldots
18334 \begin_layout Plain Layout
18336 and need to be marked as \SpecialChar TeX
18339 \begin_inset Quotes eld
18343 \begin_inset Quotes erd
18346 you wish to change goes in between the brackets [and after the
18359 If you don't know how to mark text as \SpecialChar TeX
18360 , see the appropriate section of
18373 \begin_layout Subsubsection
18383 \begin_inset CommandInset label
18385 name "sec:slideNote"
18392 \begin_layout Standard
18401 is associated with a
18402 \begin_inset Quotes eld
18406 \begin_inset Quotes erd
18414 Here, too, the \SpecialChar LyX
18419 class provides visual cues.
18424 is shorter than that of a
18428 [yet longer than that of an
18432 ] and, like the label of an
18436 is shockingly magenta.
18437 Additionally, the printed
18441 has the page number of its
18442 \begin_inset Quotes eld
18446 \begin_inset Quotes erd
18454 \begin_inset Quotes eld
18462 \begin_inset Quotes erd
18466 \begin_inset Quotes eld
18474 \begin_inset Quotes erd
18478 \begin_inset Quotes eld
18486 \begin_inset Quotes erd
18490 You can have multiple
18494 s associated with a single
18506 , you'll probably want to break up long
18510 s so that they fit on a single sheet of paper.
18513 \begin_layout Standard
18518 is obvious: it contains anything additional you might want to say about
18524 It could also be used as a sheet of reminders for a particular
18529 In the case of the latter, you might want to make use of time markers.
18530 Currently, the \SpecialChar LyX
18536 \begin_inset Quotes eld
18540 \begin_inset Quotes erd
18543 support for time markers, a
18545 Sli\SpecialChar TeX
18549 So, you'll have to resort to using the \SpecialChar LaTeX
18553 \begin_layout Standard
18554 To use time markers, you'll need to specify the extra class option
18555 \begin_inset Quotes eld
18563 \begin_inset Quotes erd
18567 \begin_inset space ~
18571 \begin_inset CommandInset ref
18573 reference "sec:slidesetup"
18578 This option turns on timing marks, which will appear in the lower-left-hand
18584 To set what appears in the time marker, you use the \SpecialChar LaTeX
18586 \begin_inset Quotes eld
18596 \begin_inset Quotes erd
18600 \begin_inset Quotes eld
18610 \begin_inset Quotes erd
18614 The arguments of both commands are time measured in seconds.
18616 \begin_inset Quotes eld
18626 \begin_inset Quotes erd
18629 sets the time marker to a given time.
18631 \begin_inset Quotes eld
18641 \begin_inset Quotes erd
18644 increments the time marker by the specified amount.
18645 Using time markers and
18649 s in this fashion, you can remind yourself how much time to spend on a particula
18657 \begin_layout Standard
18658 There's one last feature to describe.
18659 Clearly, you'd like to print out all of your
18667 s on transparencies while printing all of your
18684 with which it is associated.
18685 What's a person to do?
18688 \begin_layout Standard
18689 Luckily, there are two \SpecialChar LaTeX
18690 commands that allow you to select what to print
18692 Both must be placed into the preamble of your document.
18694 \begin_inset Quotes eld
18706 \begin_inset Quotes erd
18709 will cause the output to contain only the
18718 Correspondingly, the command
18719 \begin_inset Quotes eld
18731 \begin_inset Quotes erd
18734 prevents the output of anything but
18739 I'd advise placing both commands in the preamble and initially comment
18741 You can then preview your entire presentation as you write.
18742 When you're done writing, you can then uncomment one of the two to select
18743 what you want to print.
18744 I like to uncomment
18745 \begin_inset Quotes eld
18757 \begin_inset Quotes erd
18760 , print to a file with
18761 \begin_inset Quotes eld
18769 \begin_inset Quotes erd
18772 in its name, comment it back out, then uncomment
18773 \begin_inset Quotes eld
18785 \begin_inset Quotes erd
18789 \begin_inset Quotes eld
18797 \begin_inset Quotes erd
18801 I can then send either file to a printer, loading transparencies or plain
18802 paper as appropriate.
18805 \begin_layout Standard
18806 You can also provide other arguments to the
18807 \begin_inset Quotes eld
18817 \begin_inset Quotes erd
18821 \begin_inset Quotes eld
18831 \begin_inset Quotes erd
18835 See a good \SpecialChar LaTeX
18839 \begin_layout Subsection
18844 Class Template File
18847 \begin_layout Standard
18848 I have also provided a template file,
18849 \begin_inset Quotes eld
18857 \begin_inset Quotes erd
18865 To use it, begin your new presentation with
18867 File\SpecialChar menuseparator
18869 \begin_inset space ~
18873 \begin_inset space ~
18879 Your new \SpecialChar LyX
18880 presentation file will contain an example
18901 additionally contain an example of the use of
18910 Lastly, the preamble will contain:
18913 \begin_layout LyX-Code
18914 % Uncomment to print out only slides and overlays
18917 \begin_layout LyX-Code
18921 \begin_layout LyX-Code
18927 \begin_inset Newline newline
18933 \begin_layout LyX-Code
18934 % Uncomment to print out only notes
18937 \begin_layout LyX-Code
18941 \begin_layout LyX-Code
18949 \begin_layout Standard
18950 One final thing: I created this class to support the \SpecialChar LaTeX2e
18952 \begin_inset Quotes eld
18957 Sli\SpecialChar TeX
18961 \begin_inset Quotes erd
18964 class, one of the built-in \SpecialChar LaTeX2e
18966 Neither I nor the rest of the \SpecialChar LyX
18967 Team endorse or oppose the use of this built-in
18969 It's here if you want it or need it.
18970 There exist other \SpecialChar LaTeX2e
18971 classes for creating presentations, such as the
18976 \begin_inset space ~
18980 \begin_inset CommandInset ref
18982 reference "sec:foiltex"
18987 \begin_inset Quotes eld
18995 \begin_inset Quotes erd
18998 package [present on some \SpecialChar TeX
19000 The latter is not yet supported under \SpecialChar LyX
19005 \begin_layout Plain Layout
19006 Perhaps you can take on the task\SpecialChar ldots
19012 I know nothing about these other classes.
19013 Try them out to see what sort of alternative they provide.
19016 \begin_layout Chapter
19018 Features needing Extra Software
19021 \begin_layout Section
19022 Checking \SpecialChar TeX
19026 \begin_layout Standard
19032 \begin_layout Subsection
19036 \begin_layout Standard
19045 \begin_layout Plain Layout
19050 is not yet available when you are using the \SpecialChar LaTeX
19051 distribution MiK\SpecialChar TeX
19057 , you'll find in the
19064 \begin_inset space ~
19075 \begin_inset Newline newline
19079 \begin_inset CommandInset href
19081 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
19089 \begin_layout Standard
19092 Chk\SpecialChar TeX
19095 package is a program that was written by
19096 \begin_inset Flex Noun
19099 \begin_layout Plain Layout
19101 \begin_inset space ~
19109 in frustration because some constructs in \SpecialChar LaTeX
19110 are sometimes non-intuitive,
19111 and easy to forget.
19112 The program runs over your \SpecialChar LaTeX
19113 file, checks the integrity of the file, and
19114 flags some common errors.
19115 In other technical words, it is
19119 for \SpecialChar LaTeX
19123 \begin_layout Standard
19124 Well, what is a syntax checker doing in \SpecialChar LyX
19125 which is supposed to produce correct
19127 anyways? The answer is simple: Just as
19131 not only checks the
19135 of C programs, but also does
19139 checks for type-errors,
19141 Chk\SpecialChar TeX
19144 catches some common
19148 errors, in addition to the syntactical ones.
19151 Chk\SpecialChar TeX
19154 is capable of detecting several common errors, such as
19157 \begin_layout Itemize
19158 Ellipsis detection:
19159 \begin_inset Newline newline
19162 Use \SpecialChar ldots
19166 \begin_layout Itemize
19167 No space in front of/after parenthesis:
19168 \begin_inset Newline newline
19174 \begin_layout Itemize
19175 Enforcement of normal space after common abbreviations:
19176 \begin_inset Newline newline
19180 \begin_inset space \thinspace{}
19184 \begin_inset space \space{}
19187 is too wide spacing.
19190 \begin_layout Itemize
19191 Enforcement of end-of-sentence space when the last sentence ends with a
19193 \begin_inset Newline newline
19197 And this is wrong spacing.
19200 \begin_layout Itemize
19201 Space in front of labels and similar commands:
19202 \begin_inset Newline newline
19205 The label should stick right up to the text to avoid falling to a wrong
19208 \begin_inset CommandInset label
19218 \begin_layout Plain Layout
19219 This footnote is in danger of falling off to a wrong page
19224 The label is separated too much.
19227 \begin_layout Itemize
19228 Space in front of references, instead of hard spaces:
19229 \begin_inset Newline newline
19232 If you have bad luck, the text will break right between the referenced text
19233 and reference number, and that's a pity.
19235 \begin_inset CommandInset ref
19237 reference "sec:chktex"
19244 \begin_layout Itemize
19246 \begin_inset Quotes eld
19250 \begin_inset Quotes erd
19254 \begin_inset Formula $\times$
19258 \begin_inset Newline newline
19261 2x2 looks cheap compared to
19262 \begin_inset Formula $2\times2$
19268 \begin_layout Standard
19269 and more \SpecialChar ldots
19270 It is an invaluable tool when you are
19271 \begin_inset Quotes eld
19275 \begin_inset Quotes erd
19278 your document before printing, and you should run it right after the obligatory
19279 spelling check, and before you go fine tuning the typesetting.
19282 \begin_layout Subsection
19286 \begin_layout Standard
19287 If you have the program installed, usage is as simple as choosing
19289 Tools\SpecialChar menuseparator
19291 \begin_inset space ~
19297 This will make \SpecialChar LyX
19298 generate a \SpecialChar LaTeX
19299 file of your document, start
19301 Chk\SpecialChar TeX
19304 to check it, and then make \SpecialChar LyX
19306 \begin_inset Quotes eld
19310 \begin_inset Quotes erd
19313 with the warnings from
19315 Chk\SpecialChar TeX
19318 , if there were any.
19319 The warnings will be placed close to the point of the mistake, and you
19320 can quickly find them by using the
19322 Navigate\SpecialChar menuseparator
19325 menu item, or the shortcut key
19334 Open the error boxes by clicking on them with the mouse, or use the shortcut
19343 bindings, or the corresponding
19352 Read the warning and correct the mistake, if it is a mistake.
19353 If you have trouble understanding what the warning is about, you can safely
19355 Remember that there is a hidden layer between the document on screen and
19356 the technical details in invoking
19358 Chk\SpecialChar TeX
19361 , and this gap can make some warnings seem arcane or just plain silly.
19364 \begin_layout Standard
19365 This document is an excellent testing bed for the feature, and it should
19366 provide quite a few warnings for you to fiddle with.
19367 Since computers are only so smart, expect most of the warnings to be false
19371 \begin_layout Subsection
19372 How to fine tune it
19375 \begin_layout Standard
19376 Sometimes, you'll find that
19378 Chk\SpecialChar TeX
19381 makes more noise than suits your mood.
19382 Then you can choose not to use it, wait until your mood changes, or try
19385 Chk\SpecialChar TeX
19388 to get better along with you.
19391 \begin_layout Standard
19394 Chk\SpecialChar TeX
19401 very configurable and extensible, you should not expect to solve all problems
19404 Chk\SpecialChar TeX
19407 in \SpecialChar LyX
19409 Since \SpecialChar LyX
19410 has to generate a somewhat special \SpecialChar LaTeX
19411 file to be able to match the
19412 line numbers from the
19414 Chk\SpecialChar TeX
19421 \begin_layout Plain Layout
19422 You can inspect the specific output from
19428 Document\SpecialChar menuseparator
19431 \begin_inset space ~
19445 to the internal document structure, some of the warnings will not appear
19447 There are two things you can do about this:
19450 \begin_layout Itemize
19453 Chk\SpecialChar TeX
19456 invocation command line in
19457 \begin_inset Flex Noun
19460 \begin_layout Plain Layout
19461 Tools\SpecialChar menuseparator
19462 Preferences\SpecialChar menuseparator
19463 Output\SpecialChar menuseparator
19464 LaTeX\SpecialChar menuseparator
19472 Chk\SpecialChar TeX
19475 installation configuration file (usually with the file
19480 See below to learn what warnings can be enabled and disabled on the command
19484 \begin_layout Itemize
19485 Export your document as a raw \SpecialChar LaTeX
19488 File\SpecialChar menuseparator
19489 Export\SpecialChar menuseparator
19498 Invoked in this way, it can be a hassle to find the corresponding place
19499 in the document inside \SpecialChar LyX
19500 , but with a little patience, you should be able
19504 \begin_layout Standard
19505 Here follows the warning messages that can be enabled and disabled in
19514 to disable a warning, and
19518 to enable a warning.
19519 The emphasized entries are disabled by default, because the default is
19522 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19527 \begin_layout Standard
19528 Notice that you should only use the options that enable and disable warnings,
19529 because \SpecialChar LyX
19530 relies on some of the other command line parameters to be set
19531 in a specific way to have a chance to communicate with
19538 \begin_layout Enumerate
19542 Command terminated with space.
19545 \begin_layout Enumerate
19548 Non-breaking space (
19549 \begin_inset Quotes eld
19557 \begin_inset Quotes erd
19560 ) should have been used.
19563 \begin_layout Enumerate
19567 You should enclose the previous parenthesis with
19568 \begin_inset Quotes eld
19576 \begin_inset Quotes erd
19582 \begin_layout Enumerate
19585 Italic correction (
19586 \begin_inset Quotes eld
19596 \begin_inset Quotes erd
19599 ) found in non-italic buffer.
19602 \begin_layout Enumerate
19605 Italic correction (
19606 \begin_inset Quotes eld
19616 \begin_inset Quotes erd
19619 ) found more than once.
19622 \begin_layout Enumerate
19626 No italic correction (
19627 \begin_inset Quotes eld
19637 \begin_inset Quotes erd
19643 \begin_layout Enumerate
19647 \begin_inset Quotes eld
19655 \begin_inset Quotes erd
19659 \begin_inset Quotes eld
19667 \begin_inset Quotes erd
19673 \begin_layout Enumerate
19676 Wrong length of dash may have been used.
19679 \begin_layout Enumerate
19683 \begin_inset Quotes eld
19691 \begin_inset Quotes erd
19695 \begin_inset Quotes eld
19703 \begin_inset Quotes erd
19709 \begin_layout Enumerate
19713 \begin_inset Quotes eld
19721 \begin_inset Quotes erd
19727 \begin_layout Enumerate
19731 \begin_inset Quotes eld
19739 \begin_inset Quotes erd
19742 to achieve an ellipsis.
19745 \begin_layout Enumerate
19748 Inter-word spacing (
19749 \begin_inset Quotes eld
19759 \begin_inset Quotes eld
19762 ) should perhaps be used.
19765 \begin_layout Enumerate
19768 Inter-sentence spacing (
19769 \begin_inset Quotes eld
19779 \begin_inset Quotes erd
19782 ) should perhaps be used.
19785 \begin_layout Enumerate
19788 Could not find argument for command.
19791 \begin_layout Enumerate
19795 \begin_inset Quotes eld
19803 \begin_inset Quotes erd
19809 \begin_layout Enumerate
19812 Math mode still on at end of \SpecialChar LaTeX
19816 \begin_layout Enumerate
19820 \begin_inset Quotes eld
19828 \begin_inset Quotes erd
19831 doesn't match the number of
19832 \begin_inset Quotes eld
19840 \begin_inset Quotes erd
19846 \begin_layout Enumerate
19849 You should use either
19852 \begin_inset Quotes eld
19860 \begin_inset Quotes erd
19865 as an alternative to
19866 \begin_inset Quotes eld
19874 \begin_inset Quotes erd
19880 \begin_layout Enumerate
19887 " (ASCII 39) instead of "
19894 \begin_layout Enumerate
19897 User-specified pattern found.
19900 \begin_layout Enumerate
19903 This command might not be intended.
19906 \begin_layout Enumerate
19913 \begin_layout Enumerate
19931 \begin_layout Enumerate
19934 Delete this space to maintain correct page references.
19937 \begin_layout Enumerate
19941 You might wish to put this between a pair of
19942 \begin_inset Quotes eld
19950 \begin_inset Quotes erd
19956 \begin_layout Enumerate
19959 You ought to remove spaces in front of punctuation.
19962 \begin_layout Enumerate
19965 Could not execute \SpecialChar LaTeX
19969 \begin_layout Enumerate
19978 in front of small punctuation.
19981 \begin_layout Enumerate
19989 may look prettier here.
19992 \begin_layout Enumerate
19996 Multiple spaces detected in output.
19999 \begin_layout Enumerate
20002 This text may be ignored.
20005 \begin_layout Enumerate
20011 \begin_inset Quotes eld
20016 to begin quotation, not
20023 \begin_layout Enumerate
20030 to end quotation, not
20033 \begin_inset Quotes eld
20041 \begin_layout Enumerate
20047 \begin_layout Enumerate
20050 You should perhaps use
20051 \begin_inset Quotes eld
20059 \begin_inset Quotes erd
20065 \begin_layout Enumerate
20068 You should put a space in front of/after parenthesis.
20071 \begin_layout Enumerate
20074 You should avoid spaces in front of/after parenthesis.
20077 \begin_layout Enumerate
20081 You should not use punctuation in front of/after quotes.
20084 \begin_layout Enumerate
20087 Double space found.
20090 \begin_layout Enumerate
20093 You should put punctuation outside inner/inside display math mode.
20096 \begin_layout Enumerate
20099 You ought to not use primitive \SpecialChar TeX
20100 in \SpecialChar LaTeX
20104 \begin_layout Enumerate
20107 You should remove spaces in front of
20108 \begin_inset Quotes eld
20116 \begin_inset Quotes erd
20122 \begin_layout Enumerate
20125 \begin_inset Quotes eld
20133 \begin_inset Quotes erd
20136 is normally not followed by
20137 \begin_inset Quotes eld
20145 \begin_inset Quotes erd
20151 \begin_layout Standard
20152 In later versions of \SpecialChar LyX
20153 , we hope to provide a more complete interface to this
20154 tool (and it's smaller cousin
20158 ) to exploit the full power of it.
20159 But it's not exactly useless as it is now: go try it on one of your existing
20160 documents of a certain length and be surprised.
20163 \begin_layout Section
20164 Version Control in \SpecialChar LyX
20168 \begin_layout Standard
20171 Lars Gullik Bjønnes
20178 \begin_layout Subsection
20182 \begin_layout Standard
20184 supports some of the most basic RCS/CVS/SVN/GIT commands.
20185 If you need something a bit more sophisticated you will have to do that
20186 manually in a terminal.
20189 \begin_layout Standard
20190 Also note that CVS support is not as good as subversion support so we advise
20192 A good place to start learning Subversion is SVN Book
20196 \begin_layout Plain Layout
20197 \begin_inset CommandInset href
20199 target "http://svnbook.red-bean.com/"
20210 In the case of RCS you should read
20211 \begin_inset Quotes eld
20215 \begin_inset Quotes erd
20218 (a man file, read it with
20223 This file describes all the basic features of RCS.
20224 You should especially notice the comment about a RCS directory, and the
20225 notion of a master RCS file (the file ending in
20232 \begin_layout Standard
20233 Before you begin to use the version control features in \SpecialChar LyX
20235 familiar with RCS/CVS/SVN/GIT usage.
20236 The implementation in \SpecialChar LyX
20237 assumes a recent version of the GNU RCS or CVS/SVN
20238 package — no guarantees are made for older versions.
20239 Most of the log messages are not currently displayed after operations —
20240 you can check them in the Messages pane if unsure.
20241 Regular users of version control will appreciate VC toolbar, which can
20244 View\SpecialChar menuseparator
20245 Toolbars\SpecialChar menuseparator
20247 \begin_inset space ~
20255 \begin_layout Standard
20256 For introducing your own external commands consult vc-command in the manual
20257 of \SpecialChar LyX
20261 \begin_layout Standard
20262 It is strongly recommended to store documents in uncompressed format if
20263 using version control (uncheck
20265 Document\SpecialChar menuseparator
20268 if it is checked): Uncompressed LyX documents are text files and therefore
20269 for merging two different versions by version control systems.
20270 Compressed LyX documents are binary files, which cannot be merged by version
20274 \begin_layout Subsection
20275 RCS commands in \SpecialChar LyX
20279 \begin_layout Standard
20280 The following sections describe the RCS commands supported by \SpecialChar LyX
20282 You can find them in the
20284 File\SpecialChar menuseparator
20286 \begin_inset space ~
20293 was tested against RCS 5.7/5.8.
20296 \begin_layout Subsubsection
20302 \begin_layout Standard
20303 If your document is not under revision control, this is the only item shown
20305 And if it is under revision control, the
20309 item is not visible.
20313 \begin_layout Standard
20314 This command registers your document with RCS (unless you are under the
20315 directory managed by CVS)\SpecialChar endofsentence
20316 You are asked interactively to supply an initial
20317 description of the document.
20318 The document is now set in Read-Only mode and you have to
20321 \begin_inset space ~
20325 \begin_inset space ~
20329 \begin_inset space ~
20334 , before making any changes to it.
20335 A document under revision control has a
20336 \begin_inset Quotes eld
20339 [RCS:<version> <locker>]
20340 \begin_inset Quotes erd
20343 item tagged to the filename in the minibuffer.
20346 \begin_layout Standard
20347 RCS command that is run:
20349 ci -q -u -i -t-"<initial description>" <file-name>
20352 \begin_layout Standard
20357 to understand the switches.
20361 \begin_layout Subsubsection
20367 \begin_layout Standard
20368 When you are finished editing a file, you check in your changes.
20369 When you do this, you are asked for a description of the changes.
20370 This is stored in the history log.
20371 The version number is bumped, your changes are applied to the master RCS
20372 file, the document is unlocked and set to Read-Only mode.
20375 \begin_layout Standard
20378 ci -q -u -m"<description>" <file-name>
20381 \begin_layout Subsubsection
20387 \begin_layout Standard
20388 By doing this you lock the document so that only you can edit it.
20389 This will also make the document Read-Write only for you.
20390 You will usually continue editing for a while and when you are finished
20391 you check in your changes.
20392 The status line is changed to reflect that you have locked the file.
20395 \begin_layout Standard
20398 co -q -l <file-name>
20401 \begin_layout Subsubsection
20404 Revert To Repository Version
20407 \begin_layout Standard
20408 This will discard all changes made to the document since the last check
20410 You get a warning before changes are discarded.
20413 \begin_layout Standard
20416 co -f -u<version> <file-name>
20419 \begin_layout Subsubsection
20425 \begin_layout Standard
20426 This will create a copy of the current document.
20427 Since RCS does not support copy operations natively, the version history
20428 is not preserved, and the copy is added as a new file.
20429 It requires a clean document without any changes since the last checkin.
20430 You are asked for a file name and a description of the copy operation.
20431 After that the copy is created, both locally and in the repository.
20432 If the parent directories of the copied and original document differ, all
20433 relative paths of included files of the copy are adjusted (like in
20435 File\SpecialChar menuseparator
20440 Finally, the copy is loaded instead of the original document.
20443 \begin_layout Labeling
20444 \labelwidthstring 00.00.0000
20446 \begin_inset space ~
20450 \begin_inset space ~
20454 \begin_inset Newline newline
20458 \begin_inset Flex Code
20461 \begin_layout Plain Layout
20464 \begin_inset Quotes eld
20468 \begin_inset Quotes erd
20477 \begin_inset Flex Code
20480 \begin_layout Plain Layout
20483 \begin_inset Quotes eld
20487 \begin_inset Quotes erd
20496 \begin_inset Newline newline
20500 \begin_inset Flex Code
20503 \begin_layout Plain Layout
20507 \begin_inset Quotes eld
20511 \begin_inset Quotes erd
20522 \begin_layout Subsubsection
20528 \begin_layout Standard
20529 This makes as if the last check in never happened.
20530 No changes are made to the document loaded into \SpecialChar LyX
20531 , but the last version
20532 is removed from the master RCS file.
20535 \begin_layout Standard
20538 rcs -o<version> <file-name>
20541 \begin_layout Subsubsection
20547 \begin_layout Standard
20548 This shows the complete history of the RCS document.
20553 is shown in a browser.
20561 \begin_layout Subsubsection
20565 \begin_layout Standard
20567 supports RCS version number, author name, date and time of last commit.
20568 All those are extracted from
20570 rlog -r <file-name>
20574 \begin_inset CommandInset ref
20576 reference "subsec:VCS-Revision-Information"
20583 \begin_layout Subsection
20584 CVS commands in \SpecialChar LyX
20588 \begin_layout Standard
20589 A subset of CVS operations is supported by \SpecialChar LyX
20591 You can find the commands in the
20593 File\SpecialChar menuseparator
20595 \begin_inset space ~
20601 The version control system SVN is more powerful, so please use it instead
20602 of CVS if possible.
20605 \begin_layout Subsubsection
20611 \begin_layout Standard
20612 If you start from scratch with CVS you have to create your repository and
20613 checkout the working copy with external tools.
20614 If you're using a client-server setup you may need to login before doing
20615 the first repository checkout.
20618 \begin_layout Standard
20619 If your documents are under revision control and others are using the same
20620 repository problems arise when different changes to the same document at
20621 the same location happen.
20622 Standard CVS repositories don't operate with a file locking mechanism.
20623 This may be surprising, but conflicts only occur if people disagree on
20624 the proper content of the same part of a document.
20625 So, if co-workers are used to communicate regularly, these conflicts occur
20627 If they don't communicate they have a fundamental problem anyway.
20628 Nevertheless some people like to work with so called
20629 \begin_inset Quotes eld
20633 \begin_inset Quotes erd
20637 If they do so the working copy of all files is readonly when checked out
20638 first and the user starts editing after using a special command to make
20639 the working copy writable.
20640 When the changes are checked in the working copy returns to readonly state.
20641 With \SpecialChar LyX
20642 one has to edit the
20643 \begin_inset Flex Code
20646 \begin_layout Plain Layout
20652 file and add the line
20653 \begin_inset Flex Code
20656 \begin_layout Plain Layout
20662 to work with reserved checkouts.
20663 The benefit is the possibility to see who is using a writable copy of some
20665 It's not guaranteed only one user makes a copy writable.
20668 \begin_layout Standard
20670 tries to guess if you're using reserved or non-reserved checkouts.
20671 If your working copy is readonly or it is writable and an additional copy
20672 of your document exists in the CVS/Base sub-directory a reserved otherwise
20673 a non-reserved checkout is assumed.
20674 When a reserved checkout is detected you have to use
20675 \begin_inset Flex Noun
20678 \begin_layout Plain Layout
20684 to make your working copy writable if it's readonly.
20686 \begin_inset Flex Noun
20689 \begin_layout Plain Layout
20695 operation is possible and that makes your working copy readonly again after
20696 transferring your changes to the repository.
20699 \begin_layout Standard
20700 More information about CVS can be found here
20701 \begin_inset Flex URL
20704 \begin_layout Plain Layout
20706 http://www.nongnu.org/cvs
20712 \begin_inset Flex URL
20715 \begin_layout Plain Layout
20717 http://ximbiot.com/cvs
20725 \begin_layout Standard
20730 to understand the sub-commands and the switches mentioned below.
20733 \begin_layout Subsubsection
20739 \begin_layout Standard
20740 If your document is not under revision control, this is the only item shown
20742 And if it is under revision control, the
20746 item is not visible.
20750 \begin_layout Standard
20751 This command registers in CVS your document
20752 \begin_inset Flex Strong
20755 \begin_layout Plain Layout
20763 in the case you have already the documents directory under CVS control
20769 This means you have to create or checkout the archive by yourself using
20771 (In case you forget that step \SpecialChar LyX
20772 registers the document with RCS.)
20775 \begin_layout Standard
20776 Then you are asked interactively to supply an initial description of the
20778 Don't forget that registered file is not yet checked in.
20781 \begin_layout Standard
20782 CVS command that is run:
20784 cvs -q add -m"<entered message>" "<file-name>"
20787 \begin_layout Standard
20792 above and for all other CVS commands is an abbreviation for
20793 \begin_inset Quotes eld
20796 change the current working directory to file location and use the file name
20797 without path component as argument
20798 \begin_inset Quotes erd
20804 \begin_layout Subsubsection
20810 \begin_layout Standard
20811 When you are finished editing a file, you commit your changes.
20812 When you do this and you had changed the document, you are asked for a
20813 description of the changes.
20814 After that changes are written to the repository.
20815 In case you didn't change the document and a reserved checkout is detected
20816 the reservation made on
20817 \begin_inset Flex Noun
20820 \begin_layout Plain Layout
20829 \begin_layout Labeling
20830 \labelwidthstring 00.00.0000
20832 \begin_inset space ~
20836 \begin_inset space ~
20840 \begin_inset Newline newline
20844 \begin_inset Flex Code
20847 \begin_layout Plain Layout
20850 -q commit -m"<description>" "<file-name>"
20856 \begin_inset Newline newline
20860 \begin_inset Flex Code
20863 \begin_layout Plain Layout
20874 \begin_layout Subsubsection
20880 \begin_layout Standard
20881 When you are sharing a repository with others, you may have to incorporate
20882 their changes into your working copy.
20885 \begin_layout Standard
20888 cvs -q update "<file-name>"
20891 \begin_layout Standard
20892 If a readonly checkout is detected the working copy is made writable and
20896 \begin_layout Standard
20899 cvs -q edit "<file-name>"
20902 \begin_layout Subsubsection
20905 Revert To Repository Version
20908 \begin_layout Standard
20909 This will discard all changes made to the document since the last check
20911 You get a warning before changes are discarded.
20912 Firstly the file is deleted, secondly CVS update command is run.
20915 \begin_layout Standard
20918 cvs -q update "<file-name>"
20921 \begin_layout Standard
20922 If a reserved checkout is detected and the working copy has no changes only
20923 the reservation is undone.
20926 \begin_layout Standard
20929 cvs -q unedit "<file-name>"
20932 \begin_layout Subsubsection
20938 \begin_layout Standard
20939 This will create a copy of the current document.
20940 Since CVS does not support copy operations natively, the version history
20941 is not preserved, and the copy is added as a new file.
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 copy operation.
20944 After that the copy is created, both locally and in the repository.
20945 If the parent directories of the copied and original document differ, all
20946 relative paths of included files of the copy are adjusted (like in
20948 File\SpecialChar menuseparator
20953 Finally, the copy is loaded instead of the original document.
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
21035 \begin_layout Subsubsection
21041 \begin_layout Standard
21042 This will rename the current document.
21043 Since CVS does not support rename operations natively, the version history
21044 is not preserved, the renamed document is added as a new file, and the
21045 original document is deleted.
21046 It requires a clean document without any changes since the last checkin.
21047 You are asked for a file name and a description of the rename operation.
21048 After that the document is renamed, both locally and in the repository.
21049 If the parent directories of the new and old file names differ, all relative
21050 paths of included files are adjusted (like in
21052 File\SpecialChar menuseparator
21057 Finally, the document is reloaded using the new name.
21060 \begin_layout Labeling
21061 \labelwidthstring 00.00.0000
21063 \begin_inset space ~
21067 \begin_inset space ~
21071 \begin_inset Newline newline
21075 \begin_inset Flex Code
21078 \begin_layout Plain Layout
21081 \begin_inset Quotes eld
21085 \begin_inset Quotes erd
21094 \begin_inset Flex Code
21097 \begin_layout Plain Layout
21100 \begin_inset Quotes eld
21104 \begin_inset Quotes erd
21113 \begin_inset Newline newline
21117 \begin_inset Flex Code
21120 \begin_layout Plain Layout
21124 \begin_inset Quotes eld
21128 \begin_inset Quotes erd
21137 \begin_inset Newline newline
21141 \begin_inset Flex Code
21144 \begin_layout Plain Layout
21148 \begin_inset Quotes eld
21152 \begin_inset Quotes erd
21163 \begin_layout Subsubsection
21164 Update of the local directory checkout from repository
21167 \begin_layout Standard
21168 Once your documents gets more complex, containing sub-documents and pictures,
21170 \begin_inset Flex Code
21173 \begin_layout Plain Layout
21179 files and so on using version control becomes more complicated.
21181 supports updating the whole tree in which resides the document.
21182 This become especially useful once you cooperate with people which neither
21183 have detailed knowledge about CVS usage nor they have ambition to commit
21184 additional material to the repository.
21185 You have to organize the files structure so that all external files are
21186 in the same directory or subdirectories of the document.
21187 It's good practice anyway to store multipart documents in an extra directory.
21190 \begin_layout Standard
21192 \begin_inset Flex Code
21195 \begin_layout Plain Layout
21196 Update local directory from repository
21201 command updates the whole directory.
21202 If local changes are detected user is warned before update starts.
21203 In case of merge conflicts both versions of the conflicting document parts
21204 are placed in the final document.
21205 You have to review and correct the result of the merge.
21206 You'll find the conflicts enclosed in pairs of
21207 \begin_inset Flex Code
21210 \begin_layout Plain Layout
21217 \begin_inset Flex Code
21220 \begin_layout Plain Layout
21227 \begin_inset Flex Code
21230 \begin_layout Plain Layout
21237 The first part is your version as before the update operation with the
21238 document name prepended.
21239 The second one is the repository version with the version number after
21241 \begin_inset Flex Code
21244 \begin_layout Plain Layout
21253 \begin_layout Labeling
21254 \labelwidthstring 00.00.0000
21256 \begin_inset space ~
21260 \begin_inset space ~
21264 \begin_inset Newline newline
21268 \begin_inset Flex Code
21271 \begin_layout Plain Layout
21279 (Ask if changes are detected.)
21280 \begin_inset Newline newline
21284 \begin_inset Flex Code
21287 \begin_layout Plain Layout
21288 cd $path; cvs -q update
21298 \begin_layout Standard
21300 \begin_inset Flex Code
21303 \begin_layout Plain Layout
21309 stands for the path to the document.
21312 \begin_layout Subsubsection
21318 \begin_layout Standard
21319 This shows the complete history of the CVS document.
21322 cvs log "<file-name>"
21324 is shown in a browser.
21327 \begin_layout Subsubsection
21331 \begin_layout Standard
21333 supports CVS version number, author name, date and time of last commit.
21334 All those are extracted from
21336 cvs log -r <file-name>
21340 \begin_inset CommandInset ref
21342 reference "subsec:VCS-Revision-Information"
21349 \begin_layout Subsection
21350 SVN commands in \SpecialChar LyX
21354 \begin_layout Standard
21355 SVN is now partially supported by \SpecialChar LyX
21357 You can find the commands in the
21359 File\SpecialChar menuseparator
21361 \begin_inset space ~
21367 Please note that if you use password protected access to repository via
21368 ssh, you will be asked in terminal window.
21370 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21374 \begin_layout Plain Layout
21375 Most of the commands will work with 1.4 too, see
21376 \begin_inset CommandInset ref
21378 reference "subsec:SVN-Repo-Update"
21383 There seems to be currently unresolved permissions problem under SVN 1.8
21384 with reverting changes when file is locked.
21392 \begin_layout Subsubsection
21398 \begin_layout Standard
21399 If your document is not under revision control, this is the only item shown
21401 And if it is under revision control, the
21405 item is not visible.
21408 \begin_layout Standard
21409 This command registers in SVN your document ONLY in case you have already
21410 the documents directory under SVN control (in particular
21415 This means you have to checkout the archive by yourself.
21418 \begin_layout Standard
21419 Then you are asked interactively to supply an initial description of the
21421 Don't forget that registered file is not yet commited.
21424 \begin_layout Standard
21425 SVN command that is run:
21428 \begin_inset Quotes eld
21432 \begin_inset Quotes erd
21438 \begin_layout Standard
21443 to understand the switches.
21446 \begin_layout Subsubsection
21452 \begin_layout Standard
21453 When you are finished editing a file, you commit your changes.
21454 When you do this, you are asked for a description of the changes.
21455 After that changes are commited.
21458 \begin_layout Standard
21463 \begin_layout Plain Layout
21464 In case locking is not enabled.
21466 \begin_inset CommandInset ref
21468 reference "subsec:SVN-File-Locking"
21479 svn commit -q -m"<description>" <file-name>
21482 \begin_layout Subsubsection
21488 \begin_layout Standard
21489 Updates the changes of this file from the repository.
21490 Be sure you understand SVN merging and conflicts resolving before using
21491 this function, because all conflicts has to be resolved manually by you!
21494 \begin_layout Standard
21499 \begin_layout Plain Layout
21507 svn update --non-interactive
21508 \begin_inset Quotes eld
21512 \begin_inset Quotes erd
21518 \begin_layout Subsubsection
21521 Revert To Repository Version
21524 \begin_layout Standard
21525 This will discard all changes made to the document since the last check
21527 You get a warning before changes are discarded.
21530 \begin_layout Standard
21534 \begin_inset Quotes eld
21538 \begin_inset Quotes erd
21544 \begin_layout Subsubsection
21550 \begin_layout Standard
21551 This will create a copy of the current document including the version history.
21552 It requires a clean document without any changes since the last checkin.
21553 You are asked for a file name and a description of the copy operation.
21554 After that the copy is created, both locally and in the repository.
21555 If the parent directories of the copied and original document differ, all
21556 relative paths of included files of the copy are adjusted (like in
21558 File\SpecialChar menuseparator
21563 Finally, the copy is loaded instead of the original document.
21566 \begin_layout Labeling
21567 \labelwidthstring 00.00.0000
21569 \begin_inset space ~
21573 \begin_inset space ~
21577 \begin_inset Newline newline
21581 \begin_inset Flex Code
21584 \begin_layout Plain Layout
21588 \begin_inset Quotes eld
21592 \begin_inset Quotes erd
21596 \begin_inset Quotes eld
21600 \begin_inset Quotes erd
21609 \begin_inset Newline newline
21613 \begin_inset Flex Code
21616 \begin_layout Plain Layout
21625 \begin_layout Subsubsection
21631 \begin_layout Standard
21632 This will rename the current document including the version history.
21633 It requires a clean document without any changes since the last checkin.
21634 You are asked for a file name and a description of the rename operation.
21635 After that the document is renamed, both locally and in the repository.
21636 If the parent directories of the new and old file names differ, all relative
21637 paths of included files are adjusted (like in
21639 File\SpecialChar menuseparator
21644 Finally, the document is reloaded using the new name.
21647 \begin_layout Labeling
21648 \labelwidthstring 00.00.0000
21650 \begin_inset space ~
21654 \begin_inset space ~
21658 \begin_inset Newline newline
21662 \begin_inset Flex Code
21665 \begin_layout Plain Layout
21669 \begin_inset Quotes eld
21673 \begin_inset Quotes erd
21677 \begin_inset Quotes eld
21681 \begin_inset Quotes erd
21690 \begin_inset Newline newline
21694 \begin_inset Flex Code
21697 \begin_layout Plain Layout
21706 \begin_layout Subsubsection
21707 \begin_inset CommandInset label
21709 name "subsec:SVN-Repo-Update"
21713 Update of the local directory checkout from repository
21717 \begin_layout Plain Layout
21718 Note that this command will work only with subversion
21719 \begin_inset Formula $\geqq1.5$
21730 \begin_layout Standard
21731 All the commands above have one shortcomming - they deal with the current
21733 Once your document contains pictures, includes external
21734 \begin_inset Flex Code
21737 \begin_layout Plain Layout
21743 files and so on administration becomes more complicated.
21745 now supports updating the whole tree in which resides the document
21749 \begin_layout Plain Layout
21750 One need to organize the files structure so that all external files are
21751 in the same directory or subdirectories of the document.
21758 This become especially useful once you cooperate with people which neither
21759 know about subversion management nor they have ambition to commit additional
21760 material to the repository.
21764 \begin_layout Standard
21765 \begin_inset Flex Code
21768 \begin_layout Plain Layout
21769 Update local directory from repository
21774 command updates the whole directory and in case of merge conflicts local
21775 version of the files are left, so no unintended data loss occurs.
21776 If local changes are detected user is warned before update starts.
21779 \begin_layout Labeling
21780 \labelwidthstring 00.00.0000
21782 \begin_inset space ~
21786 \begin_inset space ~
21790 \begin_inset Newline newline
21794 \begin_inset Flex Code
21797 \begin_layout Plain Layout
21803 (Ask if changes are detected.)
21804 \begin_inset Newline newline
21808 \begin_inset Flex Code
21811 \begin_layout Plain Layout
21812 svn update –accept mine-full $path
21820 \begin_layout Standard
21822 \begin_inset Flex Code
21825 \begin_layout Plain Layout
21831 stands for the path to the document.
21834 \begin_layout Subsubsection
21840 \begin_layout Standard
21841 This shows the complete history of the SVN document.
21845 \begin_inset Quotes eld
21849 \begin_inset Quotes erd
21854 is shown in a browser.
21857 \begin_layout Subsubsection
21859 \begin_inset CommandInset label
21861 name "subsec:SVN-File-Locking"
21868 \begin_layout Standard
21869 The file exchange through various revision control systems brings the problem
21870 of merge conflicts in case two different users try to edit the same (parts
21872 When such a conflict happens it needs manual resolving and one reasonable
21873 alternative is to provide some kind of locking mechanism, which guarantees
21874 that only one user is allowed to edit file at the given time.
21877 \begin_layout Standard
21878 SVN has two such mechanisms to provide mutual exclusivity for file access
21879 - locks and automatic setting of write permissions (see sec.
21881 \begin_inset CommandInset ref
21883 reference "subsec:Automatical-Locking-Property"
21888 \begin_inset Flex Code
21891 \begin_layout Plain Layout
21901 \begin_layout Plain Layout
21902 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21908 If this property is detected for a given document \SpecialChar LyX
21909 starts to use SVN locks
21910 for document editing automatically and the whole check-in/out mechanism
21911 switches to the same regimen as for RCS.
21912 This in particular means there are two different modes of file use in \SpecialChar LyX
21916 \begin_layout Itemize
21918 The loaded file is in the read-only mode.
21919 For editing on needs to check-out.
21924 consists of updating from the repository and gaining write lock.
21925 If the lock is not possible to obtain, we remain in unlocked state.
21928 \begin_layout Itemize
21930 The loaded file is in the 'normal' edit mode.
21931 No other user is allowed to edit the file.
21936 consists of commiting changes and releasing write-lock.
21937 If no changes have been made to the document, no commit will be produced
21941 \begin_layout Plain Layout
21942 Don't be puzzled by the fact that you will be asked for commit message anyway.
21947 and only the write-lock will be released.
21950 \begin_layout Standard
21954 \begin_layout Labeling
21955 \labelwidthstring 00.00.0000
21958 svn commit -q -m"<description>" "<file-name>"
21959 \begin_inset Newline newline
21962 svn unlock "<file-name>"
21965 \begin_layout Labeling
21966 \labelwidthstring 00.00.0000
21969 svn update "<file-name>"
21970 \begin_inset Newline newline
21973 svn lock "<file-name>"
21976 \begin_layout Subsubsection
21979 \begin_inset CommandInset label
21981 name "subsec:Automatical-Locking-Property"
21987 Automatic Locking Property
21990 \begin_layout Standard
21991 The above mentioned automatic setting of write permissions of the .lyx file
21994 File\SpecialChar menuseparator
21996 \begin_inset space ~
21999 Control\SpecialChar menuseparator
22000 Toggle locking property
22003 This command is active only when the file is not locked on the svn server
22005 you need to check-out before proceeding).
22008 \begin_layout Labeling
22009 \labelwidthstring 00.00.0000
22011 \begin_inset space ~
22017 \begin_layout Labeling
22018 \labelwidthstring 00.00.0000
22021 svn propset svn:needs-lock ON "<file-name>"
22024 \begin_layout Labeling
22025 \labelwidthstring 00.00.0000
22028 svn propdel svn:needs-lock "<file-name>"
22031 \begin_layout Subsubsection
22032 \begin_inset CommandInset label
22034 name "subsec:VCS-Revision-Information"
22038 Revision Information in Documents
22041 \begin_layout Standard
22042 There are more possibilities how to activate revision information in our
22046 \begin_layout Itemize
22052 \begin_layout Itemize
22053 tree revision information (
22054 \begin_inset Flex Code
22057 \begin_layout Plain Layout
22064 The result is the output of the
22065 \begin_inset Flex Code
22068 \begin_layout Plain Layout
22074 command, the following table gives you an idea, how to read the results.
22077 \begin_layout Standard
22079 \begin_inset Tabular
22080 <lyxtabular version="3" rows="6" columns="2">
22081 <features tabularvalignment="middle">
22082 <column alignment="center" valignment="top">
22083 <column alignment="center" valignment="top">
22085 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22088 \begin_layout Plain Layout
22094 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22097 \begin_layout Plain Layout
22105 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22108 \begin_layout Plain Layout
22114 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22117 \begin_layout Plain Layout
22118 mixed revision working copy
22125 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22128 \begin_layout Plain Layout
22134 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22137 \begin_layout Plain Layout
22138 modified working copy
22145 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22148 \begin_layout Plain Layout
22154 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22157 \begin_layout Plain Layout
22158 switched working copy
22165 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22168 \begin_layout Plain Layout
22174 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22177 \begin_layout Plain Layout
22178 partial working copy, from a sparse checkout
22185 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22188 \begin_layout Plain Layout
22194 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22197 \begin_layout Plain Layout
22198 mixed revision, modified, switched working copy
22211 \begin_layout Itemize
22212 file revision information.
22213 The result comes from parsing the output of
22214 \begin_inset Flex Code
22217 \begin_layout Plain Layout
22219 \begin_inset space ~
22223 \begin_inset space ~
22227 \begin_inset space ~
22236 Supported flags are:
22240 \begin_layout Itemize
22241 version number of the last commit (
22242 \begin_inset Flex Code
22245 \begin_layout Plain Layout
22254 \begin_layout Itemize
22255 author of the last commit (
22256 \begin_inset Flex Code
22259 \begin_layout Plain Layout
22268 \begin_layout Itemize
22269 date of the last commit (
22270 \begin_inset Flex Code
22273 \begin_layout Plain Layout
22282 \begin_layout Itemize
22283 time of the last commit (
22284 \begin_inset Flex Code
22287 \begin_layout Plain Layout
22297 \begin_layout Standard
22298 You can obtain this info via InsetInfo (e.g.
22300 \begin_inset Flex Code
22303 \begin_layout Plain Layout
22304 info-insert buffer vcs-date
22310 The information will be available only when you have the file stored under
22311 svn managment (i.e.
22313 \begin_inset Flex Code
22316 \begin_layout Plain Layout
22322 directory is available with your document).
22326 \begin_layout Itemize
22327 Another—a hacking one—possibility is to use svn keywords
22331 \begin_layout Plain Layout
22332 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22338 In short – you set file keywords property (e.g.
22341 svn propset svn:keywords 'Rev' file.lyx
22343 ) and then paste keyword \SpecialChar TeX
22348 \begin_layout Plain Layout
22349 This is an easy way how to ensure that \SpecialChar LyX
22350 won't break the line in the middle
22356 tag in your document (e.g.
22361 \begin_layout Plain Layout
22369 This way svn client will automatically substitute revision number (e.g.
22374 \begin_layout Plain Layout
22381 ) after each update and commit.
22382 There are more problems with this approach.
22383 Firstly, the '$' character is used in \SpecialChar TeX
22384 world for math equations, so any
22385 occurence of math formula
22386 \begin_inset Formula $Rev$
22390 \begin_inset Formula $Rev:59$
22393 in your \SpecialChar LyX
22395 Similarly for other keywords like Id, Date, Author, etc.
22396 Secondly svn output is dependent on your locales, so its very easy that
22397 svn would produce some problematic strings once Date is used.
22398 Thirdly you get the whole 'Rev: 59' string in your document instead of
22400 Until subversion implements user's custom keywords it will be hard to use
22401 this approach reliably or let \SpecialChar LyX
22402 to support it directly.
22405 \begin_layout Subsection
22406 SVN and Windows Environment
22409 \begin_layout Quote
22410 My inclination is to say that if the user cannot figure out the command
22411 line operations on their own fairly quickly, they would be well advised
22412 to use TortoiseSVN.
22418 \begin_layout Subsubsection
22422 \begin_layout Standard
22423 In addition to installing \SpecialChar LyX
22424 , and having access to a Subversion repository,
22425 the user will need to install the Subversion client program.
22426 A Windows installer for the client program is available from
22427 \begin_inset CommandInset href
22430 target "http://www.collab.net/nonav/downloads/subversion/"
22436 The user may also want to install
22437 \begin_inset CommandInset href
22440 target "http://tortoisesvn.tigris.org/"
22445 , which integrates Subversion operations into the context (rightclick) menu
22446 of Windows Explorer.
22447 Operations done outside \SpecialChar LyX
22448 will typically be more convenient using the Explorer
22450 Note that TortoiseSVN is not a replacement for the client program, which
22451 is what \SpecialChar LyX
22455 \begin_layout Subsubsection
22456 Bringing a document under Subversion control
22459 \begin_layout Standard
22460 Before a \SpecialChar LyX
22461 document can be brought under version control in Subversion, its
22462 parent directory needs to be under version control.
22463 If the document is being added to a project already in the repository,
22464 this is accomplished by checking the project out to the directory where
22465 the new document will be placed.
22466 If the project itself is not yet under version control (for instance, if
22467 this document starts a new project), the directory must be imported into
22469 This is done outside \SpecialChar LyX
22471 Both import and checkout are easily accomplished from the Explorer context
22472 menu using TortoiseSVN, or alternatively can be done using the command
22473 line client at a DOS prompt.
22474 The procedure for importing the project using TortoiseSVN is described
22475 below, assuming an existing repository and a new project being started
22483 For information on using the Subversion client program, run
22490 \begin_layout Enumerate
22497 in Windows Explorer, right click it, and select
22499 TortoiseSVN\SpecialChar menuseparator
22503 If necessary, adjust the URL for the repository, then click OK.
22506 \begin_layout Enumerate
22507 Right click the level of the repository under which you want to place the
22508 new project folder (typically the top level) and click
22512 Supply a name for the project folder and click OK.
22513 Add a message for the log file if desired, then click OK again.
22514 The new project folder should appear in the repository.
22515 Finally, click OK again to exit the repository browser.
22518 \begin_layout Enumerate
22519 Once again right click
22525 , this time selecting SVN Checkout\SpecialChar ldots
22526 Select the URL of the project folder
22527 you just created in the repository, and set the checkout directory to
22535 You will be warned about a non-empty folder; click OK to proceed.
22536 You should now have a
22547 \begin_layout Enumerate
22548 Create or open your document in \SpecialChar LyX
22551 File\SpecialChar menuseparator
22553 \begin_inset space ~
22556 Control\SpecialChar menuseparator
22560 Add a log message and click OK to commit the document to version control.
22563 \begin_layout Standard
22564 From this point onward, you should have full functionality in the
22566 File\SpecialChar menuseparator
22568 \begin_inset space ~
22574 You also have the option of checking the document in and out, viewing its
22576 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22577 client program from a command prompt.
22580 \begin_layout Subsubsection
22581 SSH tunnel used with SVN under Windows
22584 \begin_layout Standard
22585 Compared with Linux setting up an svn client to communicate over ssh under
22586 Windows is a rather troublesome task.
22587 We will at least offer some hints how to setup the client side but prior
22588 knowledge about ssh and the Windows command line is needed, also be prepared
22589 for a great deal of frustration\SpecialChar ldots
22593 \begin_layout Enumerate
22594 Get an svn client for windows, as described in the previous sections.
22595 When it is a fresh install run some svn command (e.g.
22597 \begin_inset Flex Code
22600 \begin_layout Plain Layout
22606 ) to create config files, which you will need to change later on.
22609 \begin_layout Enumerate
22610 Choose an ssh client for Windows.
22611 There are several possibilities, we will use the one from Putty tools
22615 \begin_layout Plain Layout
22616 \begin_inset Flex URL
22619 \begin_layout Plain Layout
22621 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22632 You will need to set the connection up so that the client doesn't ask for
22633 any password from you.
22634 To keep things easy we will use only keys without any additional password
22639 \begin_layout Enumerate
22641 \begin_inset Flex Code
22644 \begin_layout Plain Layout
22651 Save your private .ppk key file and put the public one on the server side.
22652 If the SVN server runs on Linux, note that the format of the public key
22653 is not compatible with Linux openssh and you will need to direcly copy-paste
22656 Public key for pasting into OpenSSH authorized_keys file
22658 :” edit field into the server's
22659 \begin_inset Flex Code
22662 \begin_layout Plain Layout
22663 ~/.ssh/authorized_keys
22669 \begin_inset Flex Code
22672 \begin_layout Plain Layout
22681 \begin_layout Enumerate
22683 \begin_inset Flex Code
22686 \begin_layout Plain Layout
22693 In the SVN config file
22697 \begin_layout Plain Layout
22698 Exact path depends on Windows version, usually somewhere around
22699 \begin_inset Flex Code
22702 \begin_layout Plain Layout
22705 Documents and Settings
22719 \begin_inset Flex Code
22722 \begin_layout Plain Layout
22737 , section [tunnels], setup ssh command, e.g.
22739 \begin_inset Flex Code
22742 \begin_layout Plain Layout
22743 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22752 \begin_layout Plain Layout
22753 It will usually take a lot of time to get exact command right and it depends
22755 For example do not have some remote server saved as a default session in
22757 If things fail, try to connect via plink without SVN first.
22766 \begin_layout Enumerate
22767 Checkout the SVN archive, e.
22768 \begin_inset space \thinspace{}
22772 \begin_inset Newline newline
22776 \begin_inset Flex Code
22779 \begin_layout Plain Layout
22780 svn co svn+ssh://user@server/repository_path
22788 \begin_layout Subsubsection
22789 End-of-Line Conversions
22792 \begin_layout Standard
22793 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22795 use different line endings inside the .lyx files.
22796 This is not a problem as far as \SpecialChar LyX
22797 functionality is concerned, but the commit
22798 diffs will be huge and merge-conflicts prone.
22799 Fortunately SVN itself knows
22803 \begin_layout Plain Layout
22804 \begin_inset Flex URL
22807 \begin_layout Plain Layout
22809 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22819 how to deal with CR/LF problems when switching .lyx files to the
22820 \begin_inset Flex Code
22823 \begin_layout Plain Layout
22833 \begin_layout Plain Layout
22835 \begin_inset Flex Code
22838 \begin_layout Plain Layout
22839 svn propset svn:eol-style native FILE_NAME
22852 \begin_layout Subsection
22853 GIT commands in \SpecialChar LyX
22857 \begin_layout Standard
22858 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22860 You can find the commands in the
22862 File\SpecialChar menuseparator
22864 \begin_inset space ~
22870 Please note that if you use password protected access to repository via
22871 ssh, you will be asked in terminal window.
22873 was tested against GIT 1.7.
22877 \begin_layout Plain Layout
22878 Windows users please note that you need to ensure that git is on the path.
22879 This can be set from within \SpecialChar LyX
22882 Tools\SpecialChar menuseparator
22883 Preferences\SpecialChar menuseparator
22884 Paths\SpecialChar menuseparator
22895 \begin_layout Standard
22896 One big difference of GIT and the other supported version control systems
22897 is the distributed nature of GIT: With traditional version control systems
22898 there is one central server which hosts the repository.
22899 Users commit their changes to the server, and get updates made by other
22901 With GIT, users commit to a local repository.
22902 The local repository can be synchronized with one or more remote repositories
22904 \begin_inset Flex Code
22907 \begin_layout Plain Layout
22914 \begin_inset Flex Code
22917 \begin_layout Plain Layout
22925 does not interact in any way with remote GIT repositories.
22926 It works exclusively with the local repository in a very similar way as
22927 with a central CVS or SVN repository.
22928 If you use remote GIT repositories you need to do the
22929 \begin_inset Flex Code
22932 \begin_layout Plain Layout
22939 \begin_inset Flex Code
22942 \begin_layout Plain Layout
22948 operations with your favourite GIT client.
22951 \begin_layout Subsubsection
22957 \begin_layout Standard
22958 If your document is not under revision control, this is the only item shown
22960 And if it is under revision control, the
22964 item is not visible.
22967 \begin_layout Standard
22968 This command registers in GIT your document ONLY in case you have already
22969 the documents directory under GIT control (in particular
22974 This means you have to checkout the archive by yourself.
22977 \begin_layout Standard
22978 Then you are asked interactively to supply an initial description of the
22980 Don't forget that registered file is not yet commited.
22983 \begin_layout Standard
22984 GIT command that is run:
22987 \begin_inset Quotes eld
22991 \begin_inset Quotes erd
22997 \begin_layout Standard
23002 to understand the switches.
23005 \begin_layout Subsubsection
23011 \begin_layout Standard
23012 When you are finished editing a file, you commit your changes.
23013 When you do this, you are asked for a description of the changes.
23014 After that changes are commited.
23017 \begin_layout Standard
23020 git commit -q -m"<description>" <file-name>
23023 \begin_layout Subsubsection
23026 Revert To Repository Version
23029 \begin_layout Standard
23030 This will discard all changes made to the document since the last check
23032 You get a warning before changes are discarded.
23035 \begin_layout Standard
23039 \begin_inset Quotes eld
23043 \begin_inset Quotes erd
23049 \begin_layout Subsubsection
23055 \begin_layout Standard
23056 This will rename the current document including the version history.
23057 It requires a clean document without any changes since the last checkin.
23058 You are asked for a file name and a description of the rename operation.
23059 After that the document is renamed, both locally and in the repository.
23060 If the parent directories of the new and old file names differ, all relative
23061 paths of included files are adjusted (like in
23063 File\SpecialChar menuseparator
23068 Finally, the document is reloaded using the new name.
23071 \begin_layout Labeling
23072 \labelwidthstring 00.00.0000
23074 \begin_inset space ~
23078 \begin_inset space ~
23082 \begin_inset Newline newline
23086 \begin_inset Flex Code
23089 \begin_layout Plain Layout
23093 \begin_inset Quotes eld
23097 \begin_inset Quotes erd
23101 \begin_inset Quotes eld
23105 \begin_inset Quotes erd
23114 \begin_inset Newline newline
23118 \begin_inset Flex Code
23121 \begin_layout Plain Layout
23130 \begin_layout Subsubsection
23136 \begin_layout Standard
23137 This shows the complete history of the GIT document.
23141 \begin_inset Quotes eld
23145 \begin_inset Quotes erd
23150 is shown in a browser.
23153 \begin_layout Subsubsection
23157 \begin_layout Standard
23159 supports GIT hash number of the last commit to the file, author name, date
23160 and time of last commit.
23161 All those are extracted from
23163 git log -n 1 --pretty=format:%H%n%an%n%ai
23166 Tree version information is obtained via
23168 git describe --abbrev --dirty --long
23172 \begin_inset CommandInset ref
23174 reference "subsec:VCS-Revision-Information"
23181 \begin_layout Subsection
23185 \begin_layout Standard
23186 With the recent addition of the vc-command function \SpecialChar LyX
23187 power users are allowed
23188 to create their own commands for revision control.
23191 \begin_layout Standard
23192 As an example you can see how two TortoiseSVN commands could be integrated
23196 \begin_layout Description
23198 \begin_inset Flex Code
23201 \begin_layout Plain Layout
23202 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23210 \begin_layout Description
23212 \begin_inset Flex Code
23215 \begin_layout Plain Layout
23216 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23224 \begin_layout Subsection
23225 Version control and Document comparison
23228 \begin_layout Standard
23229 One of the typical uses of version control is to inspect the changes between
23230 revisions, usually by creating
23231 \begin_inset Flex Code
23234 \begin_layout Plain Layout
23241 While this is useful for plain text files, it is much less useful in the
23242 case of \SpecialChar LyX
23243 files, which have more a complicated structure.
23244 Hence we provide binding to the Document comparison feature.
23245 There are two ways of calling this feature - either by direct call of
23246 \begin_inset Flex Code
23249 \begin_layout Plain Layout
23256 function (for details see \SpecialChar LyX
23257 functions manual) or by icon/menu item
23258 \begin_inset Flex Noun
23261 \begin_layout Plain Layout
23262 Compare with older revision...
23268 One can either compare two chosen revisions of the document or he can simply
23269 compare the current version of edited text with older revisions (where
23271 \begin_inset Flex Noun
23274 \begin_layout Plain Layout
23280 ' revisions back means comparison of the edited file with last commited
23285 \begin_layout Standard
23286 This feature is supported for SVN and RCS though due to the more complicated
23287 versioning scheme of RCS there is a constraint – when addressing the revisions
23288 in dialog, numbers always point to the last number in RCS revision number,
23291 We don't currently support GIT addressing of revisions, one can just compare
23292 edited document with its revision X steps backs, where X is addressed as
23296 \begin_layout Section
23297 Literate Programming
23300 \begin_layout Standard
23305 (kayvan@sylvan.com)
23309 original documentation written by
23311 Edmar Wienskoski Jr.
23314 (edmar-w-jr@technologist.com)
23317 \begin_layout Subsection
23321 \begin_layout Standard
23322 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23324 programming, where it is assumed that you are familiar with this programming
23325 technique, and know what
23326 \begin_inset Quotes eld
23330 \begin_inset Quotes erd
23334 \begin_inset Quotes eld
23338 \begin_inset Quotes erd
23342 If that is not the case, please follow the web links provided in the following
23344 There is a lot of good documentation out there covering old development
23345 history to the latest tools tips.
23348 \begin_layout Standard
23349 It is also assumed that you are familiar with \SpecialChar LyX
23350 itself to a point that you
23351 are comfortable changing your \SpecialChar LyX
23352 preferences, and X resources file.
23353 If that is not the case please refer to other \SpecialChar LyX
23354 documentation to cover your
23358 \begin_layout Subsection
23359 Literate Programming
23362 \begin_layout Standard
23363 From the Literate Programming FAQ:
23366 \begin_layout Quotation
23367 Literate programming is the combination of documentation and source together
23368 in a fashion suited for reading by human beings.
23369 In fact, literate programs should be enjoyable reading, even inviting!
23370 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23371 and documentation in a single file.
23372 Literate programming tools then parse the file to produce either readable
23373 documentation or compilable source.
23374 The WEB style of literate programming was created by D.
23375 \begin_inset space \thinspace{}
23379 Knuth during the development of his \SpecialChar TeX
23380 typesetting software.
23384 \begin_layout Standard
23385 Another excerpt says:
23388 \begin_layout Quotation
23391 How is literate programming different from verbose commenting?
23394 \begin_layout Quotation
23395 There are three distinguishing characteristics.
23396 In order of importance, they are:
23400 \begin_layout Itemize
23401 flexible order of elaboration
23404 \begin_layout Itemize
23405 automatic support for browsing
23408 \begin_layout Itemize
23409 typeset documentation, especially diagrams and mathematics
23413 \begin_layout Standard
23414 Now that I sparked your curiosity, take a look in the references.
23417 \begin_layout Subsubsection
23421 \begin_layout Standard
23422 The complete Literate Programming FAQ can be found at:
23425 \begin_layout Quote
23426 Literate Programming FAQ
23427 \begin_inset Flex URL
23430 \begin_layout Plain Layout
23432 http://www.literateprogramming.com/lpfaq.pdf
23440 \begin_layout Standard
23441 The FAQ lists 23 (twenty three!) different literate programming tools.
23442 Where some are specialized or
23443 \begin_inset Quotes eld
23447 \begin_inset Quotes erd
23450 for particular programming languages, while other have general scope.
23455 for my own use for several reasons:
23458 \begin_layout Itemize
23459 It can generate the documentation either in \SpecialChar LaTeX
23463 \begin_layout Itemize
23464 It has a open architecture, i.
23465 \begin_inset space \thinspace{}
23469 \begin_inset space \space{}
23472 it is easy to plug in new filters and to perform special processing that
23477 \begin_layout Itemize
23478 There is a good selection of filters available already (the HTML is one
23482 \begin_layout Itemize
23486 \begin_layout Standard
23487 The Noweb web page can be found at:
23490 \begin_layout Quote
23492 \begin_inset Flex URL
23495 \begin_layout Plain Layout
23497 http://www.cs.virginia.edu/~nr/noweb/
23505 \begin_layout Standard
23506 Starting from there you can reach many other interesting links and even
23507 some literate program examples.
23510 \begin_layout Subsection
23512 and Literate Programming with Noweb
23515 \begin_layout Standard
23516 The \SpecialChar LyX
23517 support for Literate Programming is provided by using the generic \SpecialChar LyX
23519 converters mechanism.
23520 This support is provided in a
23521 \begin_inset Quotes eld
23525 \begin_inset Quotes erd
23529 \begin_inset space \thinspace{}
23533 \begin_inset space \space{}
23536 you will be able to use this new \SpecialChar LyX
23537 feature with some other literate programming
23538 tool of your choice by just changing your \SpecialChar LyX
23542 \begin_layout Subsubsection
23543 Generating documents and code (weaving and tangling)
23546 \begin_layout Paragraph
23547 Using the noweb module
23550 \begin_layout Standard
23551 If you have installed Noweb and \SpecialChar LyX
23552 successfully, whenever you open a new document,
23553 after you have chosen its document class, use the Document->Settings menu
23555 \begin_inset Quotes eld
23559 \begin_inset Quotes erd
23563 If Noweb is correctly installed, when you click on the
23564 \begin_inset Quotes eld
23568 \begin_inset Quotes erd
23571 link, you will see the
23572 \begin_inset Quotes eld
23576 \begin_inset Quotes erd
23579 module in the available list and you can add it to your document.
23582 \begin_layout Paragraph
23586 \begin_layout Standard
23588 enables you to write code with a layout named
23589 \begin_inset Flex Noun
23592 \begin_layout Plain Layout
23599 Noweb delimits chunks like this:
23602 \begin_layout LyX-Code
23606 \begin_layout LyX-Code
23610 \begin_layout LyX-Code
23614 \begin_layout LyX-Code
23618 \begin_layout LyX-Code
23622 \begin_layout Standard
23623 The problem is that whatever is written in between the << and the
23627 must be taken literally, i.
23628 \begin_inset space \thinspace{}
23632 \begin_inset space \space{}
23636 should be prevented from making any special interpretation of what has
23638 This is also handled by
23639 \begin_inset Flex Noun
23642 \begin_layout Plain Layout
23648 , that works like a normal paragraph but has a free spacing capability.
23651 \begin_layout Standard
23652 As a special note, you can also use the
23653 \begin_inset Quotes eld
23657 \begin_inset Quotes erd
23660 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23664 \begin_layout LyX-Code
23668 \begin_layout LyX-Code
23669 def some_function(args):
23672 \begin_layout LyX-Code
23673 "This is the doc string for this function."
23676 \begin_layout LyX-Code
23677 print "My args: ", args
23680 \begin_layout LyX-Code
23681 @ %def some_function
23684 \begin_layout Standard
23685 For an example of this usage and the resulting cross-reference output, look
23686 at the Literate python program in
23688 LIBDIR/examples/listerrors.lyx
23690 which should make this all clear.
23693 \begin_layout Paragraph
23694 Generating the documentation
23697 \begin_layout Standard
23698 At this point you already have a new document file with a proper document
23699 class, and with some code and text on it.
23700 How do I print it? The answer is simple, you select
23702 View\SpecialChar menuseparator
23706 Just like you would do for a plain document.
23707 No special procedure is required.
23710 \begin_layout Standard
23711 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23715 \begin_layout Enumerate
23718 Update\SpecialChar menuseparator
23721 menu option is chosen, a \SpecialChar LaTeX
23727 \begin_layout Standard
23728 If the document is of any literate class the generated file will be named
23729 with an extension name defined by the
23730 \begin_inset Quotes eld
23734 \begin_inset Quotes erd
23737 format (defined in the Preferences panel), otherwise the file will have
23746 \begin_layout Enumerate
23747 Note that the only difference so far is in the name of the file, no special
23748 processing is required by \SpecialChar LyX
23750 Given that you formatted the code using the
23751 \begin_inset Flex Noun
23754 \begin_layout Plain Layout
23760 layout that, by itself, takes care of the business.
23763 \begin_layout Enumerate
23764 If the document is of any literate class \SpecialChar LyX
23765 will then use the internal \SpecialChar LyX
23767 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23772 \begin_layout Plain Layout
23773 The converters are defined in the
23775 Tools\SpecialChar menuseparator
23779 \begin_inset Quotes eld
23783 \begin_inset Quotes erd
23795 manual for general information about converters.
23800 to generate the \SpecialChar LaTeX
23805 \begin_layout Standard
23806 Otherwise it will just skip this step.
23810 \begin_layout Enumerate
23811 Finally, \SpecialChar LaTeX
23812 is invoked and the regular post processing continues as in a plain
23816 \begin_layout Standard
23817 Independence from a particular
23818 \begin_inset Quotes eld
23822 \begin_inset Quotes erd
23825 is easily achieved by changing the commands that are run by the various
23829 \begin_layout Paragraph
23830 Generating the code
23833 \begin_layout Standard
23834 When the build menu option is chosen or the corresponding button in the
23835 toolbar is pressed, a \SpecialChar LaTeX
23836 file is generated just like step 1 above.
23837 Next, \SpecialChar LyX
23843 This converter needs to be defined by the user and is not installed by
23844 default, though the Program format is.
23845 This converter (like any other converter) will have two parts:
23848 \begin_layout Enumerate
23849 The converter program itself.
23850 This program performs the conversion from the one format to the other (in
23851 this case, from the Noweb format to the Program pseudo-format).
23854 \begin_layout Enumerate
23855 The error log parser.
23856 This is a program whose sole purpose is to rewrite error messages in a
23857 format that \SpecialChar LyX
23859 This makes it possible for \SpecialChar LyX
23860 to place error boxes in the right places in
23864 \begin_layout Standard
23865 The first part, the
23866 \begin_inset Quotes eld
23870 \begin_inset Quotes erd
23873 setting, should be set to
23874 \begin_inset Newline newline
23878 \begin_inset Quotes eld
23886 \begin_inset Quotes erd
23890 \begin_inset Newline newline
23893 This basically means that \SpecialChar LyX
23895 \begin_inset Quotes eld
23899 \begin_inset Quotes erd
23902 (a program or script) with the name of the Noweb file (normally a file
23903 in the \SpecialChar LyX
23904 temp directory) and the directory path of the original \SpecialChar LyX
23909 \begin_layout Standard
23910 This is an implementation of
23911 \begin_inset Quotes eld
23915 \begin_inset Quotes erd
23918 that you can place in a directory on your path:
23921 \begin_layout Standard
23922 \begin_inset VSpace defskip
23928 \begin_layout Standard
23929 \begin_inset Newpage pagebreak
23935 \begin_layout Standard
23941 \begin_layout Standard
23947 \begin_layout Standard
23950 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23953 \begin_layout Standard
23954 \begin_inset VSpace defskip
23960 \begin_layout Standard
23961 The next part of the converter setting is the
23962 \begin_inset Quotes eld
23966 \begin_inset Quotes erd
23969 which is to be set to
23970 \begin_inset Newline newline
23974 \begin_inset Quotes eld
23979 parselog=$$s/scripts/listerrors
23982 \begin_inset Quotes erd
23986 \begin_inset Newline newline
23989 This will run any errors that are generated by the
23990 \begin_inset Quotes eld
23994 \begin_inset Quotes erd
23997 process through the
23998 \begin_inset Quotes eld
24002 \begin_inset Quotes erd
24008 \begin_layout Standard
24009 The build will normally take place in \SpecialChar LyX
24010 's temporary directory, so the files
24011 produced by the conversion will be in that directory.
24013 will copy out what it regards as the `main' file, but the
24017 conversion may produce several files, and so most of these would then be
24018 deleted when \SpecialChar LyX
24020 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
24021 the build-script chunk can place the generated files in that location.
24024 \begin_layout Paragraph
24025 Build instructions in the document
24028 \begin_layout Standard
24029 The last piece of the integration between \SpecialChar LyX
24031 \begin_inset Quotes eld
24035 \begin_inset Quotes erd
24039 Generally, the instructions for building your program should be embedded
24040 in a chunk of its own.
24042 \begin_inset Quotes eld
24046 \begin_inset Quotes erd
24049 above uses the notangle command to look for this chunk (called
24050 \begin_inset Quotes eld
24054 \begin_inset Quotes erd
24057 ) and runs its contents through
24058 \begin_inset Quotes eld
24062 \begin_inset Quotes erd
24068 \begin_layout Standard
24069 Typically, such a chunk would look something like this:
24072 \begin_layout LyX-Code
24076 \begin_layout LyX-Code
24078 \begin_inset Newline newline
24081 if [ -z "${NOWEB_SOURCE}" ]
24082 \begin_inset Newline newline
24088 \begin_layout LyX-Code
24089 NOWEB_SOURCE=myfile.nw
24090 \begin_inset Newline newline
24094 \begin_inset Newline newline
24098 code to extract files ...
24099 use NOWEB_OUTPUT_DIR here ...]
24100 \begin_inset Newline newline
24104 code to compile files ...]
24105 \begin_inset Newline newline
24111 \begin_layout Standard
24114 LIBDIR/examples/listerrors.lyx
24118 LIBDIR/examples/Literate.lyx
24120 which implement two versions of the
24121 \begin_inset Quotes eld
24125 \begin_inset Quotes erd
24128 program for some illustrations of how all of these pieces go together or
24131 LIBDIR/examples/noweb2lyx.lyx.
24134 Interestingly, these three files show off the language-indepence of the
24136 literate programming support since they are written in Python, C and Perl
24140 \begin_layout Subsubsection
24141 Configuring \SpecialChar LyX
24145 \begin_layout Standard
24146 All the Literate Programming support is configured by the
24148 Tools\SpecialChar menuseparator
24152 \begin_inset Quotes eld
24156 \begin_inset Quotes erd
24160 The important parts are:
24163 \begin_layout Description
24165 \begin_inset space ~
24169 \begin_inset Quotes eld
24173 \begin_inset Quotes erd
24177 \begin_inset space ~
24180 format Set up via the File Formats tab, this is where the Noweb-specific
24190 , the file extension is set to
24195 This tells \SpecialChar LyX
24196 to create a file with a
24200 extension in the first step of the conversion process.
24203 \begin_layout Description
24205 \begin_inset space ~
24213 \begin_inset space ~
24216 format This is an empty format whose sole purpose is to be the endpoint
24217 of a conversion (which then allows us to set up a converter for it).
24220 \begin_layout Description
24230 This converter performs the
24231 \begin_inset Quotes eld
24235 \begin_inset Quotes erd
24238 of the literate document.
24239 For Noweb, it is set to
24240 \begin_inset Quotes eld
24245 noweave -delay -index $$i > $$o
24248 \begin_inset Quotes erd
24254 \begin_layout Description
24264 \begin_inset Quotes eld
24268 \begin_inset Quotes erd
24272 As stated above, the Converter is set to
24273 \begin_inset Quotes eld
24281 \begin_inset Quotes erd
24284 , with Flags set to
24285 \begin_inset Newline newline
24289 \begin_inset Quotes eld
24294 parselog=$$s/scripts/listerrors
24297 \begin_inset Quotes erd
24303 \begin_layout Subsubsection
24307 \begin_layout Standard
24308 There is also a new function implemented in the \SpecialChar LyX
24310 \begin_inset Quotes eld
24313 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24317 \begin_layout Standard
24318 When debugging code with ddd/gdb, it is possible to invoke a text editor
24319 at the current execution position with a single key stroke.
24320 The default ddd configuration for that is shift-ctrl-V.
24321 It happens that you can define the editor command line invocation in ddd
24324 Edit\SpecialChar menuseparator
24325 Preferences\SpecialChar menuseparator
24328 dialog and changing the "Edit Sources" entry.
24331 \begin_layout Standard
24332 I take advantage of the newly created \SpecialChar LyX
24333 server function and this ddd feature,
24335 \begin_inset Quotes eld
24339 \begin_inset Quotes erd
24345 \begin_layout Standard
24346 \begin_inset VSpace defskip
24352 \begin_layout Standard
24355 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24358 \begin_layout Standard
24359 \begin_inset VSpace defskip
24365 \begin_layout Standard
24366 With this, whenever you are using ddd and find a point in the program that
24367 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24368 ddd will forward this information to \SpecialChar LyX
24369 through the \SpecialChar LyX
24370 server and then the
24372 window will show the same file with the cursor at the same position ddd
24374 No more guessing or long scrolling to locate a point in the program back
24378 \begin_layout Standard
24379 Note however that you must enable the \SpecialChar LyX
24380 server to get this feature working
24381 (it is disabled by default).
24382 You can enable it in
24394 ) by entering in the
24400 \begin_inset Quotes eld
24405 /home/<your-home-directory>/.lyx/lyxpipe
24408 \begin_inset Quotes erd
24414 \begin_layout Standard
24415 Read the \SpecialChar LyX
24416 server documentation in the
24418 Customization Manual
24420 for further information.
24423 \begin_layout Subsubsection
24427 \begin_layout Standard
24428 There are six new buttons that can be added to your \SpecialChar LyX
24430 Five of these buttons are short cuts to layout styles:
24453 The last one is a short cut to the
24454 \begin_inset Quotes eld
24458 \begin_inset Quotes erd
24465 \begin_layout Standard
24467 has a range of buttons that are available for tool bar customization.
24468 In my toolbar I like to combine the six short cuts above with two more:
24473 \SpecialChar menuseparator
24478 \SpecialChar menuseparator
24485 Document\SpecialChar menuseparator
24486 View\SpecialChar menuseparator
24490 Here is how it looks like:
24493 \begin_layout LyX-Code
24497 \begin_layout LyX-Code
24501 \begin_layout LyX-Code
24502 Icon "layout Standard"
24505 \begin_layout LyX-Code
24506 Icon "layout Section"
24509 \begin_layout LyX-Code
24510 Icon "layout \SpecialChar LaTeX
24514 \begin_layout LyX-Code
24515 Icon "layout \SpecialChar LyX
24519 \begin_layout LyX-Code
24520 Icon "layout Chunk"
24523 \begin_layout LyX-Code
24527 \begin_layout LyX-Code
24531 \begin_layout LyX-Code
24532 Icon "buffer-typeset"
24535 \begin_layout LyX-Code
24536 Icon "build-program"
24539 \begin_layout LyX-Code
24543 \begin_layout LyX-Code
24547 \begin_layout LyX-Code
24551 \begin_layout LyX-Code
24555 \begin_layout LyX-Code
24559 \begin_layout Subsubsection
24560 Colors customization
24563 \begin_layout Standard
24564 There are a number of colors in \SpecialChar LyX
24565 that can be customized in
24570 One of the things that bothers people is the \SpecialChar LaTeX
24572 The default color is red, since the chunks uses \SpecialChar LaTeX
24573 font, and there is a lot
24574 of chunks in literate documents, you may get tired of seeing everything
24576 You can change it by going to the tabs
24585 \begin_layout Standard
24586 The next thing is the visible presence of the newline character in the screen.
24587 You can choose the color of this particular character and make it blend
24589 I recommend you choosing a color that is close to the background but not
24590 equal, that way you still can see it is there, but it is not bothering
24594 \begin_layout Subsection
24599 \begin_layout Standard
24608 is documented in the
24612 example file and in the Sweave manual (menu
24614 Help\SpecialChar menuseparator
24620 \begin_layout Chapter
24624 \begin_layout Standard
24625 You can do everything with \SpecialChar LyX
24626 that you can do with \SpecialChar LaTeX
24628 However, \SpecialChar LyX
24629 cannot support every \SpecialChar LaTeX
24631 But you can always use \SpecialChar TeX
24633 This chapter shows you some more special things you might want to use.
24634 For other special things you can do with figures, tables, floats, boxes
24635 and notes, have a look at the
24638 \begin_inset space ~
24646 \begin_layout Section
24647 Multiple Text Columns
24650 \begin_layout Standard
24651 This feature is independent of the option
24653 Two-column document
24655 in the document settings under
24660 If you want to have 2
24661 \begin_inset space ~
24664 columns for the whole document, it is recommended to use the
24666 Two-column document
24669 For all other cases use this feature.
24672 \begin_layout Standard
24673 To use multiple text columns in your document, you have to load the module
24680 Document\SpecialChar menuseparator
24681 Settings\SpecialChar menuseparator
24684 ) and must have the \SpecialChar LaTeX
24692 \begin_layout Standard
24693 Footnotes within multiple columns will be placed at the bottom of the page
24694 and not under each column.
24695 Within the different columns you can use everything, with the limitation
24696 that for floats you need to use the float option
24703 \begin_layout Subsection
24707 \begin_layout Standard
24708 If you want to have 2
24709 \begin_inset space ~
24712 columns in your text, insert a multicolumn inset via the menu
24714 Insert\SpecialChar menuseparator
24716 \begin_inset space ~
24719 Insets\SpecialChar menuseparator
24721 \begin_inset space ~
24726 where the columns should start.
24727 Write all text that should be printed in 2
24728 \begin_inset space ~
24731 columns into this inset.
24734 \begin_layout Standard
24735 Here is an example:
24738 \begin_layout Standard
24740 \begin_inset Flex Multiple Columns
24743 \begin_layout Plain Layout
24748 The Adventure of the Empty House
24751 \begin_inset Newline newline
24754 by Sir Arthur Conan Doyle
24757 \begin_layout Plain Layout
24760 It was in the spring of the year 1894 that all London was interested, and
24761 the fashionable world dismayed, by the murder of the Honourable Ronald
24762 Adair under most unusual and inexplicable circumstances.
24763 The public has already learned those particulars of the crime which came
24764 out in the police investigation, but a good deal was suppressed upon that
24765 occasion, since the case for the prosecution was so overwhelmingly strong
24766 that it was not necessary to bring forward all the facts.
24767 Only now, at the end of nearly ten years, am I allowed to supply those
24768 missing links which make up the whole of that remarkable chain.
24769 The crime was of interest in itself, but that interest was as nothing to
24770 me compared to the inconceivable sequel, which afforded me the greatest
24771 shock and surprise of any event in my adventurous life.
24772 Even now, after this long interval, I find myself thrilling as I think
24773 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24774 ty which utterly submerged my mind.
24775 Let me say to that public, which has shown some interest in those glimpses
24776 which I have occasionally given them of the thoughts and actions of a very
24777 remarkable man, that they are not to blame me if I have not shared my knowledge
24778 with them, for I should have considered it my first duty to do so, had
24779 I not been barred by a positive prohibition from his own lips, which was
24780 only withdrawn upon the third of last month.
24788 \begin_layout Standard
24789 To get 3 or more columns, set the cursor into the multicolumn inset and
24792 Insert\SpecialChar menuseparator
24794 \begin_inset space ~
24798 \begin_inset space ~
24804 The number of the desired columns is written into that inset (for 3
24805 \begin_inset space ~
24809 \begin_inset Quotes eld
24813 \begin_inset Quotes erd
24817 \begin_inset Newline newline
24820 Here is an example with 3
24821 \begin_inset space ~
24827 \begin_layout Standard
24828 \begin_inset Flex Multiple Columns
24831 \begin_layout Plain Layout
24834 \begin_inset Argument 1
24837 \begin_layout Plain Layout
24843 It can be imagined that my close intimacy with Sherlock Holmes had interested
24844 me deeply in crime, and that after his disappearance I never failed to
24845 read with care the various problems which came before the public.
24846 And I even attempted, more than once, for my own private satisfaction,
24847 to employ his methods in their solution, though with indifferent success.
24848 There was none, however, which appealed to me like this tragedy of Ronald
24850 As I read the evidence at the inquest, which led up to a verdict of willful
24851 murder against some person or persons unknown, I realized more clearly
24852 than I had ever done the loss which the community had sustained by the
24853 death of Sherlock Holmes.
24854 There were points about this strange business which would, I was sure,
24855 have specially appealed to him, and the efforts of the police would have
24856 been supplemented, or more probably anticipated, by the trained observation
24857 and the alert mind of the first criminal agent in Europe.
24858 All day, as I drove upon my round, I turned over the case in my mind and
24859 found no explanation which appeared to me to be adequate.
24860 At the risk of telling a twice-told tale, I will recapitulate the facts
24861 as they were known to the public at the conclusion of the inquest.
24869 \begin_layout Standard
24870 You can have up to 10
24871 \begin_inset space ~
24874 columns if you want to, but that might not be very pleasant for the readers
24878 \begin_layout Standard
24879 \begin_inset Newpage newpage
24885 \begin_layout Subsection
24886 Columns inside Columns
24889 \begin_layout Standard
24890 You can also have columns inside columns:
24893 \begin_layout Standard
24894 \begin_inset Flex Multiple Columns
24897 \begin_layout Plain Layout
24900 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24901 at that time governor of one of the Australian colonies.
24902 Adair's mother had returned from Australia to undergo the operation for
24903 cataract, and she, her son Ronald, and her daughter Hilda were living together
24907 \begin_layout Plain Layout
24908 \begin_inset Flex Multiple Columns
24911 \begin_layout Plain Layout
24914 The youth moved in the best society–had, so far as was known, no enemies
24915 and no particular vices.
24916 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24917 had been broken off by mutual consent some months before, and there was
24918 no sign that it had left any very profound feeling behind it.
24919 For the rest {sic} the man's life moved in a narrow and conventional circle,
24920 for his habits were quiet and his nature unemotional.
24921 Yet it was upon this easy-going young aristocrat that death came, in most
24922 strange and unexpected form, between the hours of ten and eleven-twenty
24923 on the night of March 30, 1894.
24931 \begin_layout Plain Layout
24934 Ronald Adair was fond of cards–playing continually, but never for such stakes
24936 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24937 It was shown that, after dinner on the day of his death, he had played
24938 a rubber of whist at the latter club.
24939 He had also played there in the afternoon.
24944 The evidence of those who had played with him– Mr.
24945 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24946 and that there was a fairly equal fall of the cards.
24947 Adair might have lost five pounds, but not more.
24948 His fortune was a considerable one, and such a loss could not in any way
24950 He had played nearly every day at one club or other, but he was a cautious
24951 player, and usually rose a winner.
24952 It came out in evidence that, in partnership with Colonel Moran, he had
24953 actually won as much as four hundred and twenty pounds in a sitting, some
24954 weeks before, from Godfrey Milner and Lord Balmoral.
24955 So much for his recent history as it came out at the inquest.
24963 \begin_layout Subsection
24967 \begin_layout Standard
24968 The examples in this section show some more special features of multiple
24972 \begin_layout Standard
24973 For more features of multiple columns, have a look at the documentation
24974 of the \SpecialChar LaTeX
24980 \begin_inset CommandInset citation
24990 \begin_layout Subsubsection
24994 \begin_layout Standard
24995 To add a preface text for multiple columns, set the cursor into the multicolumn
24996 inset and use the menu
24998 Insert\SpecialChar menuseparator
25002 Write your preface text into that inset.
25003 \begin_inset Newline newline
25006 This is an example with some preface text:
25009 \begin_layout Standard
25010 \begin_inset VSpace bigskip
25016 \begin_layout Standard
25017 \begin_inset Flex Multiple Columns
25020 \begin_layout Plain Layout
25021 \begin_inset Argument 2
25024 \begin_layout Plain Layout
25025 And the story continues and continues and continues and continues\SpecialChar ldots
25033 On the evening of the crime, he returned from the club exactly at ten.
25034 His mother and sister were out spending the evening with a relation.
25035 The servant deposed that she heard him enter the front room on the second
25036 floor, generally used as his sitting-room.
25037 She had lit a fire there, and as it smoked she had opened the window.
25038 No sound was heard from the room until eleven-twenty, the hour of the return
25039 of Lady Maynooth and her daughter.
25040 Desiring to say good-night, she attempted to enter her son's room.
25041 The door was locked on the inside, and no answer could be got to their
25042 cries and knocking.
25043 Help was obtained, and the door forced.
25044 The unfortunate young man was found lying near the table.
25045 His head had been horribly mutilated by an expanding revolver bullet, but
25046 no weapon of any sort was to be found in the room.
25054 \begin_layout Standard
25055 You can also use a section heading as the preface if you use a section command
25056 as \SpecialChar TeX
25058 For example the command
25061 \begin_layout Standard
25066 subsection{subsection title}
25069 \begin_layout Standard
25070 creates a subsection.
25071 In this example the preface is a subsubsection:
25074 \begin_layout Standard
25075 \begin_inset Flex Multiple Columns
25078 \begin_layout Plain Layout
25079 \begin_inset Argument 2
25082 \begin_layout Plain Layout
25086 \begin_layout Plain Layout
25095 This is a subsubsection heading as a preface
25099 \begin_layout Plain Layout
25113 A minute examination of the circumstances served only to make the case more
25115 In the first place, no reason could be given why the young man should have
25116 fastened the door upon the inside.
25117 There was the possibility that the murderer had done this, and had afterwards
25118 escaped by the window.
25119 The drop was at least twenty feet, however, and a bed of crocuses in full
25121 Neither the flowers nor the earth showed any sign of having been disturbed,
25122 nor were there any marks upon the narrow strip of grass which separated
25123 the house from the road.
25124 Apparently, therefore, it was the young man himself who had fastened the
25126 But how did he come by his death? No one could have climbed up to the window
25127 without leaving traces.
25128 Suppose a man had fired through the window, he would indeed be a remarkable
25129 shot who could with a revolver inflict so deadly a wound.
25130 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
25131 a hundred yards of the house.
25132 No one had heard a shot.
25140 \begin_layout Standard
25141 If there is less vertical space than 6
25142 \begin_inset space ~
25145 text lines is left on the page at the beginning of the multiple columns,
25146 a page break will be inserted before the multiple columns.
25147 Depending on the number of lines of the preface text, you might want to
25149 This is done by setting the cursor into the mulitcolumn inset behind the
25150 preface (if there is any) and using the menu
25152 Insert\SpecialChar menuseparator
25154 \begin_inset space ~
25158 \begin_inset space ~
25162 \begin_inset space ~
25168 Insert into that inset the amount of space like e.
25169 \begin_inset space \thinspace{}
25173 \begin_inset space \space{}
25177 \begin_inset Quotes eld
25181 \begin_inset Quotes erd
25185 \begin_inset Newline newline
25188 In this example the space is set to 7
25189 \begin_inset space ~
25192 text lines by using
25193 \begin_inset Quotes eld
25199 \begin_inset Quotes erd
25208 needs to be inserted as \SpecialChar TeX
25212 \begin_layout Standard
25213 \begin_inset Flex Multiple Columns
25216 \begin_layout Plain Layout
25217 \begin_inset Argument 3
25220 \begin_layout Plain Layout
25225 \begin_layout Plain Layout
25241 On the evening of the crime, he returned from the club exactly at ten.
25242 His mother and sister were out spending the evening with a relation.
25243 The servant deposed that she heard him enter the front room on the second
25244 floor, generally used as his sitting-room.
25245 She had lit a fire there, and as it smoked she had opened the window.
25246 No sound was heard from the room until eleven-twenty, the hour of the return
25247 of Lady Maynooth and her daughter.
25248 Desiring to say good-night, she attempted to enter her son's room.
25249 The door was locked on the inside, and no answer could be got to their
25250 cries and knocking.
25251 Help was obtained, and the door forced.
25252 The unfortunate young man was found lying near the table.
25253 His head had been horribly mutilated by an expanding revolver bullet, but
25254 no weapon of any sort was to be found in the room.
25262 \begin_layout Subsubsection
25266 \begin_layout Standard
25267 The amount of space before and after multiple columns can be changed by
25268 changing the length
25275 For example the command
25278 \begin_layout Standard
25288 \begin_layout Standard
25289 in \SpecialChar TeX
25290 Code changes its value to 3
25291 \begin_inset space \thinspace{}
25295 The change must be made before the multiple columns' start.
25296 The predefined value is 13
25297 \begin_inset space \thinspace{}
25303 \begin_layout Standard
25311 \begin_inset space \thinspace{}
25317 \begin_layout Standard
25321 \begin_layout Plain Layout
25327 multicolsep}{2.5cm}
25335 \begin_layout Standard
25336 \begin_inset Flex Multiple Columns
25339 \begin_layout Plain Layout
25342 All day I turned these facts over in my mind, endeavouring to hit upon some
25343 theory which could reconcile them all, and to find that line of least resistanc
25344 e which my poor friend had declared to be the starting-point of every investigat
25346 I confess that I made little progress.
25347 In the evening I strolled across the Park, and found myself about six o'clock
25348 at the Oxford Street end of Park Lane.
25349 A group of loafers upon the pavements, all staring up at a particular window,
25350 directed me to the house which I had come to see.
25351 A tall, thin man with coloured glasses, whom I strongly suspected of being
25352 a plain-clothes detective, was pointing out some theory of his own, while
25353 the others crowded round to listen to what he said.
25354 I got as near him as I could, but his observations seemed to me to be absurd,
25355 so I withdrew again in some disgust.
25356 As I did so I struck against an elderly, deformed man, who had been behind
25357 me, and I knocked down several books which he was carrying.
25365 \begin_layout Standard
25366 \begin_inset Note Greyedout
25369 \begin_layout Plain Layout
25374 The values you set with
25380 will be used for all following multiple columns until you change them again.
25388 \begin_layout Standard
25392 \begin_layout Plain Layout
25404 \begin_inset Note Note
25407 \begin_layout Plain Layout
25408 go back to the default
25416 \begin_layout Standard
25417 \begin_inset Newpage newpage
25423 \begin_layout Subsubsection
25427 \begin_layout Standard
25428 A column break can be forced by inserting the command
25434 as \SpecialChar TeX
25435 Code to that position in the text where the column should be broken.
25436 Note that this leads in most cases to whitespace in the text.
25437 \begin_inset Newline newline
25440 Here is an example:
25443 \begin_layout Standard
25444 \begin_inset Flex Multiple Columns
25447 \begin_layout Plain Layout
25450 \begin_inset Quotes eld
25453 You're surprised to see me, sir,
25454 \begin_inset Quotes erd
25457 said he, in a strange, croaking voice.
25460 \begin_layout Plain Layout
25463 I acknowledged that I was.
25466 \begin_layout Plain Layout
25469 \begin_inset Quotes eld
25472 Well, I've a conscience, sir, and when I chanced to see you go into this
25473 house, as I came hobbling after you, I thought to myself, I'll just step
25474 in and see that kind gentleman, and tell him that if I was a bit gruff
25475 in my manner there was not any harm meant, and that I am much obliged to
25476 him for picking up my books.
25477 \begin_inset Quotes erd
25483 \begin_layout Plain Layout
25486 \begin_inset Quotes eld
25489 You make too much of a trifle,
25490 \begin_inset Quotes erd
25495 \begin_inset Quotes eld
25498 May I ask how you knew who I was?
25499 \begin_inset Quotes erd
25502 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25506 \begin_layout Plain Layout
25518 \begin_layout Plain Layout
25521 \begin_inset Quotes eld
25524 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25525 you'll find my little bookshop at the corner of Church Street, and very
25526 happy to see you, I am sure.
25527 Maybe you collect yourself, sir.
25531 \begin_inset space ~
25544 –a bargain, every one of them.
25545 With five volumes you could just fill that gap on that second shelf.
25546 It looks untidy, does it not, sir?
25547 \begin_inset Quotes erd
25558 \begin_layout Subsubsection
25562 \begin_layout Standard
25563 The width of the columns is automatically calculated, but you can modify
25564 the space between the columns.
25565 This is done by changing the length
25572 Its predefined value is 10
25573 \begin_inset space \thinspace{}
25577 Here is an example where
25584 \begin_inset space \thinspace{}
25590 \begin_layout Standard
25594 \begin_layout Plain Layout
25608 \begin_layout Standard
25609 \begin_inset Flex Multiple Columns
25612 \begin_layout Plain Layout
25615 My observations of No.
25616 \begin_inset space \space{}
25619 427 Park Lane did little to clear up the problem in which I was interested.
25620 The house was separated from the street by a low wall and railing, the
25621 whole not more than five feet high.
25622 It was perfectly easy, therefore, for anyone to get into the garden, but
25623 the window was entirely inaccessible, since there was no water pipe or
25624 anything which could help the most active man to climb it.
25625 More puzzled than ever, I retraced my steps to Kensington.
25626 I had not been in my study five minutes when the maid entered to say that
25627 a person desired to see me.
25628 To my astonishment it was none other than my strange old book collector,
25629 his sharp, wizened face peering out from a frame of white hair, and his
25630 precious volumes, a dozen of them at least, wedged under his right arm.
25638 \begin_layout Standard
25642 \begin_layout Plain Layout
25654 \begin_inset Note Note
25657 \begin_layout Plain Layout
25658 go back to the default
25666 \begin_layout Subsubsection
25670 \begin_layout Standard
25671 Between the columns a rule with a width of the length
25678 If this rule width is set to 0
25679 \begin_inset space \thinspace{}
25682 pt (this is the default), the rule is suppressed.
25683 In the following example the rule is 2
25684 \begin_inset space \thinspace{}
25690 \begin_layout Standard
25694 \begin_layout Plain Layout
25700 columnseprule}{2pt}
25708 \begin_layout Standard
25709 \begin_inset Flex Multiple Columns
25712 \begin_layout Plain Layout
25715 \begin_inset Quotes eld
25718 You're surprised to see me, sir,
25719 \begin_inset Quotes erd
25722 said he, in a strange, croaking voice.
25725 \begin_layout Plain Layout
25728 I acknowledged that I was.
25731 \begin_layout Plain Layout
25734 \begin_inset Quotes eld
25737 Well, I've a conscience, sir, and when I chanced to see you go into this
25738 house, as I came hobbling after you, I thought to myself, I'll just step
25739 in and see that kind gentleman, and tell him that if I was a bit gruff
25740 in my manner there was not any harm meant, and that I am much obliged to
25741 him for picking up my books.
25742 \begin_inset Quotes erd
25748 \begin_layout Plain Layout
25751 \begin_inset Quotes eld
25754 You make too much of a trifle,
25755 \begin_inset Quotes erd
25760 \begin_inset Quotes eld
25763 May I ask how you knew who I was?
25764 \begin_inset Quotes erd
25770 \begin_layout Plain Layout
25773 \begin_inset Quotes eld
25776 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25777 you'll find my little bookshop at the corner of Church Street, and very
25778 happy to see you, I am sure.
25779 Maybe you collect yourself, sir.
25783 \begin_inset space ~
25796 –a bargain, every one of them.
25797 With five volumes you could just fill that gap on that second shelf.
25798 It looks untidy, does it not, sir?
25799 \begin_inset Quotes erd
25810 \begin_layout Standard
25811 \begin_inset VSpace defskip
25817 \begin_layout Standard
25818 The rule can be colored by redefining the command
25825 This is done by inserting the command
25826 \begin_inset Newline newline
25835 columnseprulecolor}{
25840 \begin_inset Newline newline
25843 as \SpecialChar TeX
25844 Code before the multicolumn inset.
25849 in this command by a color of your choice.
25850 You can use all pre- and self-defined colors.
25858 \begin_inset space ~
25863 for more information about pre- and self-defined colors.
25864 To go back to the default color insert the command
25865 \begin_inset Newline newline
25874 columnseprulecolor}{
25879 \begin_inset Newline newline
25882 Here is the example with a cyan rule and 1
25883 \begin_inset space \thinspace{}
25886 cm column separation:
25889 \begin_layout Standard
25893 \begin_layout Plain Layout
25902 \begin_layout Plain Layout
25908 columnseprulecolor}{
25918 \begin_layout Standard
25919 \begin_inset Flex Multiple Columns
25922 \begin_layout Plain Layout
25925 \begin_inset Quotes eld
25928 You're surprised to see me, sir,
25929 \begin_inset Quotes erd
25932 said he, in a strange, croaking voice.
25935 \begin_layout Plain Layout
25938 I acknowledged that I was.
25941 \begin_layout Plain Layout
25944 \begin_inset Quotes eld
25947 Well, I've a conscience, sir, and when I chanced to see you go into this
25948 house, as I came hobbling after you, I thought to myself, I'll just step
25949 in and see that kind gentleman, and tell him that if I was a bit gruff
25950 in my manner there was not any harm meant, and that I am much obliged to
25951 him for picking up my books.
25952 \begin_inset Quotes erd
25958 \begin_layout Plain Layout
25961 \begin_inset Quotes eld
25964 You make too much of a trifle,
25965 \begin_inset Quotes erd
25970 \begin_inset Quotes eld
25973 May I ask how you knew who I was?
25974 \begin_inset Quotes erd
25980 \begin_layout Plain Layout
25983 \begin_inset Quotes eld
25986 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25987 you'll find my little bookshop at the corner of Church Street, and very
25988 happy to see you, I am sure.
25989 Maybe you collect yourself, sir.
25993 \begin_inset space ~
26006 –a bargain, every one of them.
26007 With five volumes you could just fill that gap on that second shelf.
26008 It looks untidy, does it not, sir?
26009 \begin_inset Quotes erd
26020 \begin_layout Standard
26024 \begin_layout Plain Layout
26030 columnseprule}{0pt}
26033 \begin_layout Plain Layout
26039 columnseprulecolor}{
26047 \begin_inset Note Note
26050 \begin_layout Plain Layout
26051 go back to the default
26059 \begin_layout Section
26060 Non-standard Paragraph Shapes
26063 \begin_layout Standard
26066 as well as any other text processor uses by default rectangular paragraphs.
26067 For special cases like for example posters, invitation cards or poems you
26068 can modify the paragraph shape to one of your choice.
26069 This can be done by using the \SpecialChar LaTeX
26074 which is loaded by using in the document settings the module
26076 Custom paragraph shapes
26081 \begin_layout Subsection
26085 \begin_layout Standard
26090 provides the following shapes:
26093 \begin_layout Standard
26094 \begin_inset Tabular
26095 <lyxtabular version="3" rows="13" columns="3">
26096 <features booktabs="true" islongtable="true" longtabularalignment="center">
26097 <column alignment="center" valignment="middle" width="16col%">
26098 <column alignment="center" valignment="middle" width="40col%">
26099 <column alignment="center" valignment="middle" width="35col%">
26100 <row endhead="true">
26101 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26104 \begin_layout Plain Layout
26110 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26113 \begin_layout Plain Layout
26119 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26122 \begin_layout Plain Layout
26130 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26133 \begin_layout Plain Layout
26139 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26142 \begin_layout Plain Layout
26143 Circle with circular hole (in the size of a CD/DVD)
26148 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26151 \begin_layout Plain Layout
26152 Cannot be scaled, take care there is not too much text
26159 <cell alignment="center" valignment="top" topline="true" usebox="none">
26162 \begin_layout Plain Layout
26168 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26171 \begin_layout Plain Layout
26177 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26180 \begin_layout Plain Layout
26181 Fragile, calculation might fail
26188 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26191 \begin_layout Plain Layout
26197 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26200 \begin_layout Plain Layout
26201 Rhomboid (symbolizing a
26202 \begin_inset Quotes eld
26206 \begin_inset Quotes erd
26214 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26217 \begin_layout Plain Layout
26225 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26228 \begin_layout Plain Layout
26234 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26237 \begin_layout Plain Layout
26243 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26246 \begin_layout Plain Layout
26254 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26257 \begin_layout Plain Layout
26263 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26266 \begin_layout Plain Layout
26272 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26275 \begin_layout Plain Layout
26283 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26286 \begin_layout Plain Layout
26292 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26295 \begin_layout Plain Layout
26296 Nut for bolt (hexagon with circular hole)
26301 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26304 \begin_layout Plain Layout
26312 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26315 \begin_layout Plain Layout
26321 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26324 \begin_layout Plain Layout
26330 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26333 \begin_layout Plain Layout
26341 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26344 \begin_layout Plain Layout
26350 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26353 \begin_layout Plain Layout
26359 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26362 \begin_layout Plain Layout
26370 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26373 \begin_layout Plain Layout
26379 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26382 \begin_layout Plain Layout
26388 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26391 \begin_layout Plain Layout
26399 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26402 \begin_layout Plain Layout
26408 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26411 \begin_layout Plain Layout
26412 Normal/reversed rain drop
26417 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26420 \begin_layout Plain Layout
26421 Fragile, calculation might fail
26428 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26431 \begin_layout Plain Layout
26438 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26441 \begin_layout Plain Layout
26442 The \SpecialChar TeX
26448 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26451 \begin_layout Plain Layout
26459 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26462 \begin_layout Plain Layout
26464 \begin_inset Newline newline
26472 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26475 \begin_layout Plain Layout
26476 Triangles in different orientations
26481 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26484 \begin_layout Plain Layout
26498 \begin_layout Standard
26499 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26501 for environments in the toolbar.
26504 \begin_layout Standard
26505 \begin_inset Newpage newpage
26511 \begin_layout Standard
26512 Here is an example paragraph in the shape of a nut:
26515 \begin_layout Standard
26516 \begin_inset VSpace bigskip
26525 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26526 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26528 At vero eos et accusam et justo duo dolores et ea rebum.
26529 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26531 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26532 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26536 \begin_layout Standard
26537 \begin_inset VSpace bigskip
26543 \begin_layout Standard
26544 \begin_inset Note Greyedout
26547 \begin_layout Plain Layout
26552 : shapepar paragraphs cannot run over a page break.
26560 \begin_layout Standard
26561 \begin_inset VSpace bigskip
26567 \begin_layout Standard
26572 takes care that the shape will always be preserved, no matter how much
26573 text is in the paragraph.
26574 Therefore the paragraph size changes with the amount of contained text.
26575 This can lead to paragraph sizes exceeding the page margins.
26576 To demonstrate the size scaling, here is the same example paragraph but
26577 with twice as much text:
26580 \begin_layout Standard
26581 \begin_inset Newpage newpage
26590 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26591 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26593 At vero eos et accusam et justo duo dolores et ea rebum.
26594 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26596 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26597 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26599 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26600 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26602 At vero eos et accusam et justo duo dolores et ea rebum.
26603 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26605 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26606 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26610 \begin_layout Standard
26611 \begin_inset VSpace bigskip
26617 \begin_layout Standard
26618 An exception is the shape
26623 It cannot be scaled because it must fit the size of a CD/DVD.
26624 Therefore the amount of text that fits into the shape is limited.
26625 \begin_inset Newline newline
26636 shape are fragile, meaning that the calculation of their size can fail,
26637 depending on the amount of text.
26638 You will then get the \SpecialChar LaTeX
26640 \begin_inset Quotes eld
26643 Arithmetic overflow
26644 \begin_inset Quotes erd
26648 In this case one can try to remove or add some text; if nothing works one
26649 has to use another shape.
26652 \begin_layout Standard
26653 \begin_inset VSpace bigskip
26659 \begin_layout Standard
26660 For shapes with tips you will maybe see that \SpecialChar LaTeX
26661 's hyphenation routine fails
26662 for text in the tips.
26663 Therefore it is often necessary to add hyphenation points
26668 arg "specialchar-insert hyphenation"
26673 ) to the corresponding text parts.
26676 \begin_layout Standard
26677 \begin_inset VSpace bigskip
26683 \begin_layout Standard
26684 Shapepar paragraphs are either always centered or placed on the page so
26685 that their left border touches the left page margin.
26686 You can therefore not use the paragraph dialog to align such paragraphs.
26687 A solution is to put the paragraph into a minipage or parbox and align
26689 The problem is hereby to find the right width for the box.
26690 Because if it is too wide and you center the box, the paragraph is not
26691 centered too because it sticks at the left side of the box.
26692 So you might have to play a bit with the width until it fits.
26693 Here are two heart-shaped paragraphs, the first one is not aligned, the
26694 second one is right-aligned:
26697 \begin_layout Standard
26698 \begin_inset Newpage newpage
26704 \begin_layout Heart
26708 Lo\SpecialChar softhyphen
26709 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26710 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26712 At vero eos et accusam et justo duo dolores et ea rebum.
26713 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26717 \begin_layout Standard
26718 \begin_inset VSpace bigskip
26724 \begin_layout Standard
26727 \begin_inset Box Frameless
26737 height_special "totalheight"
26742 backgroundcolor "none"
26745 \begin_layout Heart
26749 Lo\SpecialChar softhyphen
26750 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26751 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26753 At vero eos et accusam et justo duo dolores et ea rebum.
26754 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26763 \begin_layout Subsection
26767 \begin_layout Standard
26768 You can define any shape you want.
26769 Doing this manually is a lot of work because every coordinate must be specified.
26770 But there is a way to let the computer calculate the coordinates:
26773 \begin_layout Enumerate
26774 Install the program
26775 \begin_inset CommandInset href
26778 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26786 \begin_layout Enumerate
26793 TeX/LaTeX\SpecialChar menuseparator
26794 Settings\SpecialChar menuseparator
26797 and select the font size you are using in your document.
26798 For example this document uses the size 12
26799 \begin_inset space \thinspace{}
26805 \begin_layout Enumerate
26809 \begin_layout Enumerate
26812 TeX/LaTeX\SpecialChar menuseparator
26815 to export the shape to coordinates.
26816 In the appearing dialog use either the outline of your shape for the coordinate
26817 s or the path itself.
26821 \begin_layout Plain Layout
26822 For more information see
26823 \begin_inset CommandInset href
26825 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26838 \begin_layout Standard
26839 The coordinates are written into a \SpecialChar TeX
26841 To use it for your \SpecialChar LyX
26845 \begin_layout Enumerate
26846 Place the cursor before the first character of your paragraph (or into a
26850 \begin_layout Enumerate
26851 Open in \SpecialChar LyX
26854 Insert\SpecialChar menuseparator
26855 File\SpecialChar menuseparator
26857 \begin_inset space ~
26862 , select the file and use
26871 \begin_layout Standard
26872 \begin_inset VSpace defskip
26878 \begin_layout Standard
26879 \begin_inset Note Greyedout
26882 \begin_layout Plain Layout
26887 : The changed shape only applies to the current paragraph; everything is
26888 reset to normal for the next paragraph.
26889 Therefore the shape definition file must be input into every paragraph
26890 with the desired shape.
26898 \begin_layout Standard
26899 \begin_inset VSpace bigskip
26905 \begin_layout Standard
26906 Here is an example:
26909 \begin_layout Standard
26910 \begin_inset VSpace bigskip
26916 \begin_layout Standard
26917 \begin_inset CommandInset include
26919 filename "SpecialParagraphShape.tex"
26925 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26926 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26928 At vero eos et accusam et justo duo dolores et ea rebum.
26929 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26931 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26932 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26936 \begin_layout Standard
26937 \begin_inset VSpace bigskip
26943 \begin_layout Standard
26948 to draw complexer shapes in
26952 you can draw the shape in a program of your choice and import the resulting
26958 Then you only need to draw a line or spline along the outline of the image.
26961 \begin_layout Standard
26962 \begin_inset VSpace bigskip
26968 \begin_layout Standard
26971 Custom paragraph shapes
26973 also provides the two commands
26981 which can be used to define custom shapes coordinate by coordinate.
26985 \begin_layout Plain Layout
26986 These commands are internally used for all shapes described here.
26991 For information how these styles are used and about further customization
26992 possibilities, have a look at the documentation of the package
26997 \begin_inset CommandInset citation
27007 \begin_layout Bibliography
27008 \begin_inset CommandInset bibitem
27009 LatexCommand bibitem
27015 Documentation of the \SpecialChar LaTeX
27017 \begin_inset CommandInset href
27020 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
27028 \begin_layout Bibliography
27029 \begin_inset CommandInset bibitem
27030 LatexCommand bibitem
27036 Documentation of the \SpecialChar LaTeX
27038 \begin_inset CommandInset href
27041 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"