1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
5 \origin /systemlyxdir/doc/
8 % DO NOT ALTER THIS PREAMBLE!!!
10 % This preamble is designed to ensure that the manual prints
11 % out as advertised. If you mess with this preamble,
12 % parts of the manual may not print out as expected. If you
13 % have problems LaTeXing this file, please contact
14 % the documentation team
15 % email: lyx-docs@lists.lyx.org
21 % set fonts for nicer pdf view
22 \IfFileExists{lmodern.sty}
23 {\usepackage{lmodern}}{}
25 \fi % end if pdflatex is used
27 % the pages of the TOC are numbered roman
28 % and a PDF-bookmark for the TOC is added
30 \let\myTOC\tableofcontents
31 \renewcommand{\tableofcontents}{%
32 \pdfbookmark[1]{\contentsname}{}
35 \pagenumbering{arabic}}
37 % extra space for tables
38 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
40 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
41 \use_default_options false
49 \maintain_unincluded_children false
52 InsetLayout CharStyle:MenuItem
61 \newcommand*{\menuitem}[1]{{\sffamily #1}}
66 \language_package default
71 \font_typewriter default
73 \font_default_family default
74 \use_non_tex_fonts false
80 \default_output_format default
82 \bibtex_command default
83 \index_command default
87 \pdf_title "LyX's Additional Features manual"
88 \pdf_author "LyX Team"
89 \pdf_subject "LyX's additional features documentation"
90 \pdf_keywords "LyX, Documentation, Additional"
92 \pdf_bookmarksnumbered true
93 \pdf_bookmarksopen false
94 \pdf_bookmarksopenlevel 1
99 \pdf_pdfusetitle false
100 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
103 \use_package amsmath 1
104 \use_package amssymb 1
105 \use_package cancel 0
107 \use_package mathdots 1
108 \use_package mathtools 0
109 \use_package mhchem 1
110 \use_package stackrel 0
111 \use_package stmaryrd 0
112 \use_package undertilde 0
114 \cite_engine_type default
118 \paperorientation portrait
122 \notefontcolor #0000ff
129 \paragraph_separation indent
130 \paragraph_indentation default
131 \quotes_language english
134 \paperpagestyle headings
135 \tracking_changes true
136 \output_changes false
140 \author -712698321 "Jürgen Spitzmüller"
141 \author 711066561 "Enrico Forestieri"
147 Additional \SpecialChar LyX
151 \begin_layout Subtitle
156 by the \SpecialChar LyX
161 \begin_layout Plain Layout
163 Principal maintainer of this file is
168 If you have comments or error corrections, please send them to the \SpecialChar LyX
171 \begin_inset Flex Code
174 \begin_layout Plain Layout
176 <lyx-docs@lists.lyx.org>
189 \begin_layout Standard
190 \begin_inset CommandInset toc
191 LatexCommand tableofcontents
198 \begin_layout Chapter
202 \begin_layout Standard
203 This manual is essentially Part II of the
205 User's Guide\SpecialChar endofsentence
208 The reason for separating the two documents is simple: the
212 is already quite lengthy, and it contains information on all of the basic
213 features one needs to know in order to prepare most documents.
214 However, the \SpecialChar LyX
215 Team has worked to make \SpecialChar LyX
216 extensible through various configuration
217 files and external packages.
218 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
220 create a layout file (or module) for it without having to alter \SpecialChar LyX
222 We've already had contributions of several new features this way, and some
223 of them are documented here.
224 There are also some more `advanced' features, such as how to control the
225 presentation of bibliographies and how to work with multi-part documents,
226 that are not covered in the
230 and are discussed here.
233 \begin_layout Standard
234 This manual also documents some special features, like fax support, version
235 control, and SGML support, which require additional software to work properly.
236 There is also a chapter on \SpecialChar LyX
238 And lastly, there's a chapter of \SpecialChar LaTeX
239 tools and tips, things you can use to
240 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
242 After all, \SpecialChar LyX
247 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
251 \begin_layout Standard
252 If you haven't read the
256 yet, you are definitely in the wrong manual.
261 is the first place to go, since it describes the notation and format of
263 You should also be thoroughly familiar with the
267 and all of the basic features of \SpecialChar LyX
268 before attempting to read this one.
271 \begin_layout Standard
272 Since many of the topics in this manual depend heavily on \SpecialChar LyX
274 with \SpecialChar LaTeX
275 , this first chapter covers the inner workings of \SpecialChar LyX
278 to generate exactly the \SpecialChar LaTeX
280 It is obviously for more seasoned \SpecialChar LyX
284 \begin_layout Chapter
286 and \SpecialChar LaTeX
290 \begin_layout Section
292 Uses \SpecialChar LaTeX
296 \begin_layout Standard
297 This chapter is for both \SpecialChar TeX
298 -nicians and the \SpecialChar LaTeX
300 In it, we'll explain how \SpecialChar LyX
301 and \SpecialChar LaTeX
302 work together to produce printable output.
303 This is the only place in any of the manuals where we assume you know something
304 about \SpecialChar LaTeX
308 \begin_layout Standard
309 At one time, \SpecialChar LyX
311 \begin_inset Quotes eld
314 WYSIWYM frontend to \SpecialChar LaTeX
316 \begin_inset Quotes erd
319 but that's no longer true.
320 There are frontends to \SpecialChar LaTeX
325 \begin_layout Plain Layout
326 Some familar ones are \SpecialChar TeX
327 maker and kile, on Linux, and \SpecialChar TeX
329 There are also the \SpecialChar LaTeX
330 modes for vi and emacs, of course.
335 These are basically text editors with the ability to run \SpecialChar LaTeX
337 errors in the file you're editing.
338 Although \SpecialChar LyX
347 run \SpecialChar LaTeX
348 , and it also indicates errors in the file, it also does much, much
350 For one thing, you don't need to know \SpecialChar LaTeX
351 to use \SpecialChar LyX
354 has added its own extensions to \SpecialChar LaTeX
356 Try the following sometime: select
357 \begin_inset Flex MenuItem
360 \begin_layout Plain Layout
361 Export\SpecialChar menuseparator
369 \begin_inset Flex MenuItem
372 \begin_layout Plain Layout
379 \begin_inset Flex MenuItem
382 \begin_layout Plain Layout
383 View\SpecialChar menuseparator
393 ), then look at the preamble of the resulting
394 \begin_inset Flex Code
397 \begin_layout Plain Layout
404 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
406 These macros are defined automatically, according to the features you use
410 \begin_layout Standard
411 There are several commands that automatically invoke \SpecialChar LaTeX
416 \begin_layout Itemize
417 \begin_inset Flex MenuItem
420 \begin_layout Plain Layout
421 Document\SpecialChar menuseparator
430 \begin_layout Itemize
431 \begin_inset Flex MenuItem
434 \begin_layout Plain Layout
435 Document\SpecialChar menuseparator
444 \begin_layout Itemize
445 \begin_inset Flex MenuItem
448 \begin_layout Plain Layout
449 File\SpecialChar menuseparator
458 \begin_layout Itemize
459 \begin_inset Flex MenuItem
462 \begin_layout Plain Layout
463 File\SpecialChar menuseparator
472 \begin_layout Standard
473 They will only invoke \SpecialChar LaTeX
474 if the file has changed since the last time \SpecialChar LaTeX
480 \begin_layout Standard
481 When \SpecialChar LyX
482 runs \SpecialChar LaTeX
483 on the file you're editing, it performs these steps:
486 \begin_layout Enumerate
487 Convert the document to \SpecialChar LaTeX
488 and save to a file with the extension
489 \begin_inset Flex Code
492 \begin_layout Plain Layout
499 \begin_inset Flex Code
502 \begin_layout Plain Layout
511 \begin_layout Enumerate
512 Run \SpecialChar LaTeX
514 \begin_inset Flex Code
517 \begin_layout Plain Layout
523 file (maybe several times), and run any other commands (such as
524 \begin_inset Flex Code
527 \begin_layout Plain Layout
534 \begin_inset Flex Code
537 \begin_layout Plain Layout
543 ) needed to compile the \SpecialChar LaTeX
547 \begin_layout Enumerate
548 If there are any errors, show the error log.
551 \begin_layout Standard
552 If you have run \SpecialChar LaTeX
554 \begin_inset Flex MenuItem
557 \begin_layout Plain Layout
560 \SpecialChar menuseparator
569 then runs a DVI viewer to display the DVI-file.
571 \begin_inset Flex MenuItem
574 \begin_layout Plain Layout
577 \SpecialChar menuseparator
586 performs further steps:
589 \begin_layout Itemize
591 \begin_inset Flex Code
594 \begin_layout Plain Layout
600 to convert the DVI file to PostScript.
603 \begin_layout Itemize
604 Run a PostScript viewer, such as
605 \begin_inset Flex Code
608 \begin_layout Plain Layout
614 , to display the PostScript file.
617 \begin_layout Standard
619 does similar things when viewing, or exporting, other formats.
622 \begin_layout Section
623 Translating \SpecialChar LaTeX
624 files into \SpecialChar LyX
628 \begin_layout Standard
629 You can import a \SpecialChar LaTeX
630 file into \SpecialChar LyX
632 \begin_inset Flex MenuItem
635 \begin_layout Plain Layout
636 File\SpecialChar menuseparator
637 Import\SpecialChar menuseparator
644 command in \SpecialChar LyX
646 This will call a program named
647 \begin_inset Flex Code
650 \begin_layout Plain Layout
656 which will create a file
657 \begin_inset Flex Code
660 \begin_layout Plain Layout
667 \begin_inset Flex Code
670 \begin_layout Plain Layout
678 will then open that file.
682 \begin_layout Plain Layout
683 \begin_inset Flex Code
686 \begin_layout Plain Layout
692 can also be run from the command line, of course.
700 \begin_layout Standard
701 \begin_inset Flex Code
704 \begin_layout Plain Layout
710 will translate most legal \SpecialChar LaTeX
711 , but not everything.
712 It will put things it doesn't understand into \SpecialChar TeX
713 code, so after translating
715 \begin_inset Flex Code
718 \begin_layout Plain Layout
724 , you can look for \SpecialChar TeX
725 code and hand-edit it until it looks right.
728 \begin_layout Standard
729 If you don't know what \SpecialChar TeX
730 code is, read the next section.
733 \begin_layout Section
734 \begin_inset CommandInset label
736 name "sec:Inserting-TeX-Code"
740 Inserting \SpecialChar TeX
741 Code into \SpecialChar LyX
745 \begin_layout Standard
746 Anything you can do in \SpecialChar LaTeX
747 you can do in \SpecialChar LyX
748 , for a very simple reason: You can
749 always insert \SpecialChar TeX
750 code into any \SpecialChar LyX
753 cannot, and will never be able to, display every possible \SpecialChar LaTeX
755 If ever you need to insert \SpecialChar LaTeX
756 commands into your \SpecialChar LyX
757 document, you can use the
759 \begin_inset Flex Code
762 \begin_layout Plain Layout
769 box, which you can insert into your document with
770 \begin_inset Flex MenuItem
773 \begin_layout Plain Layout
774 Insert\SpecialChar menuseparator
776 \change_deleted -712698321 1437633182
779 \change_inserted -712698321 1437633182
791 or the keyboard shortcut
800 \begin_layout Standard
801 Here's an example of inserting \SpecialChar LaTeX
802 commands in a \SpecialChar LyX
804 The code looks like this:
807 \begin_layout LyX-Code
811 \begin_inset Newline newline
817 \begin_inset Newline newline
820 This is an example of a minipage environment.
822 \begin_inset Newline newline
825 can put nearly everything in it, even (non-floating)
826 \begin_inset Newline newline
831 \begin_inset Newline newline
837 \begin_inset Newline newline
841 \begin_inset Newline newline
847 \begin_inset Newline newline
853 \begin_inset Newline newline
859 \begin_inset Newline newline
864 \begin_inset Newline newline
870 \begin_inset Newline newline
876 \begin_inset Newline newline
882 \begin_inset Newline newline
890 \begin_layout LyX-Code
894 \begin_layout Standard
896 \begin_inset Flex Code
899 \begin_layout Plain Layout
906 box containing this text is directly after this paragraph.
907 Those of you reading the manual in \SpecialChar LyX
908 will only see the \SpecialChar TeX
910 Those reading a printed version of the manuals will see the actual results:
911 \begin_inset VSpace bigskip
917 \begin_layout Standard
921 \begin_layout Plain Layout
928 \begin_layout Plain Layout
935 \begin_layout Plain Layout
937 This is an example of a minipage environment.
938 You can put nearly everything in it, even (non-floating) figures and tables.
942 \begin_layout Plain Layout
949 \begin_layout Plain Layout
954 \begin_layout Plain Layout
961 \begin_layout Plain Layout
968 \begin_layout Plain Layout
975 \begin_layout Plain Layout
981 \begin_layout Plain Layout
988 \begin_layout Plain Layout
995 \begin_layout Plain Layout
1002 \begin_layout Plain Layout
1012 \begin_inset VSpace bigskip
1018 \begin_layout Standard
1019 In addition to using \SpecialChar TeX
1020 code, you can also create a separate file containing
1021 some complex \SpecialChar LaTeX
1022 structure and then use
1023 \begin_inset Flex MenuItem
1026 \begin_layout Plain Layout
1027 Insert\SpecialChar menuseparator
1029 \begin_inset space ~
1037 to include your file (you should select the type
1038 \begin_inset Flex Code
1041 \begin_layout Plain Layout
1048 We recommend that you only do this if you have a
1049 \begin_inset Flex Code
1052 \begin_layout Plain Layout
1063 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1067 \begin_layout Standard
1068 There are a few last points to emphasize:
1071 \begin_layout Itemize
1077 check if your \SpecialChar LaTeX
1081 \begin_layout Itemize
1082 Beware of reinventing the wheel.
1085 \begin_layout Standard
1086 On that last point, \SpecialChar LyX
1087 does have quite a few features tucked into it, and
1089 Be sure to check the manuals to make sure that \SpecialChar LyX
1090 doesn't have such-and-such
1091 feature before you decide you have to do it by hand.
1092 Moreover, there are numerous \SpecialChar LaTeX
1093 packages out there to do all sorts of things,
1094 from labels to envelopes to fancy multipage tables.
1096 \begin_inset CommandInset href
1099 target "http://www.ctan.org/"
1106 \begin_layout Standard
1107 If you do need to do some wild and fancy things within your document, be
1108 sure to check out a good \SpecialChar LaTeX
1109 book for assistance.
1110 There are a number of them listed in the bibliography of the
1117 \begin_layout Section
1119 and the \SpecialChar LaTeX
1123 \begin_layout Subsection
1124 About the \SpecialChar LaTeX
1128 \begin_layout Standard
1129 If you already know \SpecialChar LaTeX
1130 , there is no need to explain here what the preamble
1132 If you don't, the following will give you some ideas—we recommend again
1133 that you consult a \SpecialChar LaTeX
1134 book for further information.
1135 In any case, you should read the points below, because they explain what
1136 you can do and what you don't need to do in the \SpecialChar LaTeX
1137 preamble of a \SpecialChar LyX
1141 \begin_layout Standard
1142 The \SpecialChar LaTeX
1143 preamble comes at the very beginning of a document,
1151 \begin_layout Itemize
1152 Declare the document class.
1154 \begin_inset Newline newline
1158 already does this for you.
1159 If you're a seasoned \SpecialChar LaTeX
1160 -nician, and you have a custom document class you
1161 want to use, check out the
1163 Customization Manual
1165 for information on how to make \SpecialChar LyX
1169 \begin_layout Itemize
1170 Declare the usage of packages.
1172 \begin_inset Newline newline
1176 packages provide special commands, which are only available within a document
1177 when the package has been declared in the preamble.
1178 In addition to providing special commands, the inclusion of a package can
1179 change the document.
1180 For example, the package
1181 \begin_inset Flex Code
1184 \begin_layout Plain Layout
1190 forces all paragraphs to be indented.
1191 There are other packages for labels, envelopes, margins, etc.
1195 \begin_layout Itemize
1196 Set counters, variables, lengths and widths.
1198 \begin_inset Newline newline
1201 There are several \SpecialChar LaTeX
1202 counters and variables that
1206 be set globally from within the preamble in order to have the desired effect.
1207 (There are variables that you can set and reset inside the document, too.)
1208 Margins are a good example of something that must be set in the preamble.
1209 Another example is the label format for lists.
1210 You can actually set these just about anywhere, but it's best to do it
1211 just once, inside the preamble.
1214 \begin_layout Itemize
1215 Declare user defined commands (with
1216 \begin_inset Flex Code
1219 \begin_layout Plain Layout
1228 \begin_inset Flex Code
1231 \begin_layout Plain Layout
1240 \begin_inset Newline newline
1243 These are abbreviations for \SpecialChar LaTeX
1244 commands which appear very often inside a document.
1245 Although the preamble is a good place to declare such commands, they
1249 be declared anywhere (before they are used for the first time, of course).
1250 This can be useful if there is a lot of raw \SpecialChar LaTeX
1251 code in your document, which
1252 normally should not be the case.
1255 \begin_layout Standard
1257 adds its own set of definitions to the preamble of the
1258 \begin_inset Flex Code
1261 \begin_layout Plain Layout
1268 This makes \SpecialChar LaTeX
1269 files generated by \SpecialChar LyX
1273 \begin_layout Subsection
1274 Changing the Preamble
1277 \begin_layout Standard
1278 The commands which \SpecialChar LyX
1279 adds to the preamble of a \SpecialChar LaTeX
1280 file are fixed; you can't
1281 change them without patching \SpecialChar LyX
1283 You can, however, add your own stuff to the preamble by selecting
1284 \begin_inset Flex MenuItem
1287 \begin_layout Plain Layout
1290 \begin_inset space ~
1299 \begin_inset Flex MenuItem
1302 \begin_layout Plain Layout
1303 Document\SpecialChar menuseparator
1311 adds anything in the
1312 \begin_inset Flex MenuItem
1315 \begin_layout Plain Layout
1321 dialog to its own built-in preamble.
1322 Before adding your own declarations in the preamble, you should make sure
1323 that \SpecialChar LyX
1324 doesn't already support what you want to do.
1325 (Remember what we said about reinventing the wheel?) Also,
1327 make sure your preamble code is correct
1331 doesn't check it for you.
1332 If there is an error, you're likely to get an error like
1333 \begin_inset Quotes eld
1337 \begin_inset Flex Code
1340 \begin_layout Plain Layout
1349 \begin_inset Quotes erd
1353 If you see this error, check your preamble.
1356 \begin_layout Subsection
1360 \begin_layout Standard
1361 Here are some examples of what you can add to a preamble, and what they
1365 \begin_layout Subsubsection
1369 \begin_layout Standard
1370 There are two variables under \SpecialChar LaTeX
1371 that control page position:
1372 \begin_inset Flex Code
1375 \begin_layout Plain Layout
1384 \begin_inset Flex Code
1387 \begin_layout Plain Layout
1396 Their names should be self-explanatory.
1397 These variables are useful if you think for a moment about computer labels.
1398 Sometimes, the size of a print medium and the area of the medium that you
1399 can actually print on aren't the same.
1401 \begin_inset Flex Code
1404 \begin_layout Plain Layout
1413 \begin_inset Flex Code
1416 \begin_layout Plain Layout
1427 \begin_layout Standard
1428 The default values for
1429 \begin_inset Flex Code
1432 \begin_layout Plain Layout
1441 \begin_inset Flex Code
1444 \begin_layout Plain Layout
1453 \begin_inset space \thinspace{}
1457 \begin_inset space \thinspace{}
1461 \begin_inset space \space{}
1464 the page isn't shifted.
1465 Unfortunately, some DVI drivers always seem to shift the page.
1466 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1467 If you're using \SpecialChar LyX
1468 on a system that you don't personally maintain, and your
1469 sysadmin is a doofus,
1470 \begin_inset Flex Code
1473 \begin_layout Plain Layout
1482 \begin_inset Flex Code
1485 \begin_layout Plain Layout
1494 Suppose your left and top margins are always 0.5
1495 \begin_inset space \thinspace{}
1499 You can add this to the preamble:
1502 \begin_layout LyX-Code
1510 \begin_layout LyX-Code
1518 \begin_layout Standard
1519 and your margins should now be correct.
1522 \begin_layout Subsubsection
1526 \begin_layout Standard
1527 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1528 There's a rather nice package, available at your nearest CTAN archive,
1529 for printing sheets of labels:
1530 \begin_inset Flex Code
1533 \begin_layout Plain Layout
1540 Now, your system may not have this package installed by default.
1541 We leave that up to you to check.
1542 You'll also want to read the documentation for it; we're not going to do
1544 Since this is an example, however, we'll give you an example of how you
1548 \begin_layout Standard
1549 First, make sure you're using the
1550 \begin_inset Flex Code
1553 \begin_layout Plain Layout
1560 Next, you need to put the following in your preamble:
1563 \begin_layout LyX-Code
1569 \begin_layout LyX-Code
1575 \begin_layout LyX-Code
1581 \begin_layout LyX-Code
1587 \begin_layout LyX-Code
1593 \begin_layout LyX-Code
1599 \begin_layout LyX-Code
1605 \begin_layout Standard
1606 This sets things up for Avery label sheets, stock #5360.
1607 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1610 \begin_inset Flex Code
1613 \begin_layout Plain Layout
1622 \begin_inset Flex Code
1625 \begin_layout Plain Layout
1633 around each label text.
1634 This and other special features of
1635 \begin_inset Flex Code
1638 \begin_layout Plain Layout
1644 are explained in its documentation.
1647 \begin_layout Standard
1648 Someday, someone may write a \SpecialChar LyX
1649 layout file to support this package directly.
1650 Maybe that someone is you.
1653 \begin_layout Subsubsection
1654 Example #3: Paragraph Indentation
1657 \begin_layout Standard
1658 Americans are trained to indent the first line of
1663 As with all of their other weird quirks, most Americans will whine and
1664 moan until they can have their way and indent the first line of all paragraphs.
1673 \begin_layout Standard
1674 Of course, this behavior isn't standard typography.
1675 In books, you typically only indent the first line of a paragraph
1679 it follows another one.
1680 The idea behind indenting the first line of a paragraph is to distinguish
1681 neighboring paragraphs from one another.
1682 If there is no previous paragraph—for example, if it follows a figure or
1683 is the first paragraph in a section—then there is no need for indentation.
1687 \begin_layout Standard
1688 If you're a typical American (we're still joking!), though, you don't care
1689 about such esoteric things; you want your indentation! Add this to the
1693 \begin_layout LyX-Code
1696 usepackage{indentfirst}
1699 \begin_layout Standard
1700 If your \SpecialChar TeX
1701 distribution isn't braindead, you'll have this package, and all
1702 of your paragraphs will get the indentation the Founding Fathers intended
1706 \begin_layout Subsubsection
1707 Example #4: This Document
1710 \begin_layout Standard
1711 You can also check out the preamble of this document to get an idea of some
1712 of the advanced things you can do.
1715 \begin_layout Section
1717 and \SpecialChar LaTeX
1721 \begin_layout Standard
1722 When \SpecialChar LyX
1723 calls \SpecialChar LaTeX
1724 , it tells \SpecialChar LaTeX
1725 to blithely ignore any errors and keep going.
1726 It then uses the logfile from the \SpecialChar LaTeX
1727 run to do a post-mortem.
1728 After analyzing the logfile, \SpecialChar LyX
1729 displays a dialog listing the errors.
1730 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1732 where the error occurred.
1736 \begin_layout Plain Layout
1738 Analyzing the logfile is a tough job, and \SpecialChar LyX
1739 doesn't always go to the right
1741 There are also cases where \SpecialChar LaTeX
1742 reports the error on one line, but the actual
1744 This is not unlike forgetting a closing brace in a program: You'll get
1745 an error, but only later.
1753 \begin_layout Standard
1754 Some folks also like to look at the log file directly: It is available from
1756 \begin_inset Flex MenuItem
1759 \begin_layout Plain Layout
1762 \SpecialChar menuseparator
1766 \begin_inset space ~
1775 There are some fairly common error messages and warnings.
1776 We'll cover those here.
1777 You should look at a good \SpecialChar LaTeX
1778 book for a complete listing.
1781 \begin_layout Itemize
1782 \begin_inset Flex Code
1785 \begin_layout Plain Layout
1793 \begin_inset Newline newline
1796 Anything beginning with these words is a warning message for the purpose
1798 \begin_inset Quotes eld
1802 \begin_inset Quotes erd
1805 the \SpecialChar LaTeX
1807 You'll get messages like this if you added or changed cross-references
1808 or bibliography entries, in which case, \SpecialChar LaTeX
1809 is trying to tell you that you
1810 need to make another run.
1811 You can by-and-large ignore these.
1814 \begin_layout Itemize
1815 \begin_inset Flex Code
1818 \begin_layout Plain Layout
1826 \begin_inset Newline newline
1829 Another warning message, this time about fonts which \SpecialChar LaTeX
1831 The rest of the message will often say something about a replacement font
1832 that \SpecialChar LaTeX
1834 You can safely ignore these, too.
1837 \begin_layout Itemize
1838 \begin_inset Flex Code
1841 \begin_layout Plain Layout
1850 \begin_inset Newline newline
1859 They are warnings about lines that were too long and run past the right
1861 Almost always, this is unnoticeable in the final output.
1862 (It can be just a point or two.) Or, only one or two characters extend past
1865 seems to generate at least one of these messages for just about any document
1867 \begin_inset Newline newline
1870 You can ignore these messages.
1871 Your eyes will tell you if there's a problem with something that's too
1872 wide; just look at the output.
1876 \begin_layout Plain Layout
1877 You can also enable the `draft' option in
1878 \begin_inset Flex MenuItem
1881 \begin_layout Plain Layout
1884 \SpecialChar menuseparator
1892 , and then \SpecialChar LaTeX
1893 will draw a black box in the margin of lines that are overfull.
1901 \begin_layout Itemize
1902 \begin_inset Flex Code
1905 \begin_layout Plain Layout
1914 \begin_inset Newline newline
1917 Not quite as common as its cousin.
1919 seems to like to print lines that are a bit too wide as opposed to ones
1920 that are a bit too narrow.
1921 We have no idea why.
1924 \begin_layout Itemize
1925 \begin_inset Flex Code
1928 \begin_layout Plain Layout
1937 \begin_inset Flex Code
1940 \begin_layout Plain Layout
1949 \begin_inset Newline newline
1952 Warnings about troubles breaking the page.
1953 Once again, just look at the output.
1954 Your eyes will tell you where something has gone wrong.
1957 \begin_layout Itemize
1958 \begin_inset Flex Code
1961 \begin_layout Plain Layout
1964 \begin_inset Quotes els
1968 \begin_inset Quotes ers
1977 \begin_inset Newline newline
1981 \begin_inset Quotes eld
1985 \begin_inset Quotes erd
1988 isn't installed on this system.
1989 This usually appears because some package your document needs isn't installed.
1990 If you didn't touch the preamble or didn't use the
1991 \begin_inset Flex Code
1994 \begin_layout Plain Layout
2002 command, then one of the packages \SpecialChar LyX
2003 tried to load is missing.
2005 \begin_inset Flex MenuItem
2008 \begin_layout Plain Layout
2009 Help\SpecialChar menuseparator
2016 to get a list of packages that \SpecialChar LyX
2018 This file is updated whenever you reconfigure \SpecialChar LyX
2020 \begin_inset Flex MenuItem
2023 \begin_layout Plain Layout
2024 Tools\SpecialChar menuseparator
2030 ) and tells you which packages have been detected and what they do.
2031 \begin_inset Newline newline
2035 \begin_inset Flex Code
2038 \begin_layout Plain Layout
2046 command and the package in question isn't installed, then you'll need to
2047 install it yourself.
2050 \begin_layout Itemize
2051 \begin_inset Flex Code
2054 \begin_layout Plain Layout
2056 Error: Unknown option
2062 \begin_inset Newline newline
2065 Error messages beginning with this are trying to tell you that you specified
2066 a bad or undefined option to a package.
2067 Check the package's documentation.
2070 \begin_layout Itemize
2071 \begin_inset Flex Code
2074 \begin_layout Plain Layout
2075 Undefined control sequence
2081 \begin_inset Newline newline
2084 If you've inserted \SpecialChar LaTeX
2085 code into your document, but made a typo, you'll get
2087 You may have forgotten to load a package.
2088 In any case, this error message usually means that you used an undefined
2093 \begin_layout Standard
2094 There are other error and warning messages.
2095 Some are self-explanatory.
2096 These are usually \SpecialChar LaTeX
2098 Others are downright cryptic.
2099 These are usually \SpecialChar TeX
2100 error messages, and we really have
2104 what they mean or how to decipher them.
2108 \begin_layout Standard
2109 There's a general sequence you should follow if you get error messages:
2112 \begin_layout Enumerate
2113 Look at the \SpecialChar LaTeX
2114 code you inserted for typos.
2117 \begin_layout Enumerate
2118 If there are no typos, check that you used the command(s) correctly.
2121 \begin_layout Enumerate
2122 If you get a bunch of error boxes piled up at the very top of the document—and
2123 especially if you see a
2124 \begin_inset Quotes eld
2128 \begin_inset Flex Code
2131 \begin_layout Plain Layout
2140 \begin_inset Quotes erd
2143 error—it means that there are errors in the preamble.
2144 Start debugging your preamble.
2147 \begin_layout Enumerate
2148 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2150 document, the first suspect is your \SpecialChar LaTeX
2151 distribution itself.
2152 Check for missing packages and install them.
2155 \begin_layout Enumerate
2156 Okay, so there are no missing packages.
2157 Did you use any of the fine-tuning options in \SpecialChar LyX
2158 ? Specifically, did you
2162 any of them, like trying to manually insert lots of
2163 \begin_inset Flex Code
2166 \begin_layout Plain Layout
2168 \begin_inset space ~
2177 \begin_inset Flex Code
2180 \begin_layout Plain Layout
2187 \begin_inset Flex Code
2190 \begin_layout Plain Layout
2196 ? Did you try to kludge something together with these instead of using the
2197 appropriate paragraph environment?
2200 \begin_layout Enumerate
2201 All right, you didn't use any of the fine-tuning options, you played by
2203 Did you try to pull a fancy maneuver? Did you do something funky inside
2204 a table or an equation, like inserting a graphic into a table cell?
2207 \begin_layout Enumerate
2208 Do you have long sections of text where \SpecialChar LaTeX
2209 cannot find a place to break a
2210 line? By default, \SpecialChar LaTeX
2211 is rather strict about how much extra inter-word spacing
2212 it will add in order to break a line.
2213 Preferably, you should rework the paragraph to avoid the problem.
2214 If this isn't an option, you can wrap your text in
2215 \begin_inset Flex Code
2218 \begin_layout Plain Layout
2226 to make \SpecialChar LaTeX
2227 's line breaking more, well, sloppy.
2230 \begin_layout Enumerate
2231 Did you go overboard with the nesting? \SpecialChar LyX
2232 (currently) doesn't check to make
2233 sure you're in the limits for nesting environments.
2234 If you nested a bunch of environments to the
2235 \begin_inset Formula $17^{\mathrm{th}}$
2238 level, that's the problem.
2239 (The limit in \SpecialChar LaTeX
2243 \begin_layout Enumerate
2244 Okay, you didn't get any error messages, but your output looks awful.
2245 If you have a table or figure that's too wide or long for the page, you
2247 \begin_inset Separator parbreak
2254 \begin_layout Enumerate
2255 rescale the figure so it fits.
2258 \begin_layout Enumerate
2259 trim down the table so it fits.
2263 \begin_layout Enumerate
2264 If something else is wrong with the output, and you didn't try to pull anything
2265 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2268 \begin_layout Standard
2269 If all this doesn't help—well, then
2273 you might have found a bug in \SpecialChar LyX
2278 \begin_layout Chapter
2282 \begin_layout Section
2283 Customizing Bibliographies with Bib\SpecialChar TeX
2287 \begin_layout Standard
2288 The most basic information about how to use Bib\SpecialChar TeX
2289 with \SpecialChar LyX
2293 Bibliography databases (Bib\SpecialChar TeX
2301 The following subsections explain special bibliography features supported
2306 \begin_layout Subsection
2307 Alternative Citation Styles
2310 \begin_layout Standard
2311 Standard Bib\SpecialChar TeX
2313 \begin_inset space \thinspace{}
2317 \begin_inset space \space{}
2321 \begin_inset Quotes eld
2325 \begin_inset Quotes erd
2328 ) to refer to a cited work.
2329 However, in many scientific disciplines, other citation styles are in use.
2330 The most common one is the author-year style (e.
2331 \begin_inset space \thinspace{}
2335 \begin_inset space \space{}
2339 \begin_inset Quotes eld
2343 \begin_inset Quotes erd
2348 supports two packages that provide this style,
2349 \begin_inset Flex Code
2352 \begin_layout Plain Layout
2359 \begin_inset Flex Code
2362 \begin_layout Plain Layout
2369 Both packages have their pros and cons, which cannot be listed in detail.
2370 If you only want to have simple author-year (or author-numerical) style,
2371 or if you want to use one of the countless style files for
2372 \begin_inset Flex Code
2375 \begin_layout Plain Layout
2381 , then the established
2382 \begin_inset Flex Code
2385 \begin_layout Plain Layout
2391 package is probably your choice.
2392 If you need special features like short title references, ibidem etc., you
2394 \begin_inset Flex Code
2397 \begin_layout Plain Layout
2406 \begin_layout Standard
2407 The handling of both packages in \SpecialChar LyX
2408 is basically the same.
2410 \begin_inset Flex MenuItem
2413 \begin_layout Plain Layout
2414 Document\SpecialChar menuseparator
2421 \begin_inset Flex MenuItem
2424 \begin_layout Plain Layout
2431 \begin_inset Flex MenuItem
2434 \begin_layout Plain Layout
2441 \begin_inset Flex MenuItem
2444 \begin_layout Plain Layout
2451 With both packages, you will get some extra features in the citation dialog
2452 and you can select the style of the reference (
2453 \begin_inset Quotes eld
2457 \begin_inset Quotes erd
2461 \begin_inset Quotes eld
2465 \begin_inset Quotes erd
2469 \begin_inset Quotes eld
2473 \begin_inset Quotes erd
2477 \begin_inset Quotes eld
2481 \begin_inset Quotes erd
2485 Note that both packages need specifically designed style files.
2486 They both ship their own, but there are lots of additional style files,
2487 and there is even an interactive style file builder
2491 \begin_layout Plain Layout
2493 \begin_inset Flex URL
2496 \begin_layout Plain Layout
2498 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2509 \begin_inset Flex Code
2512 \begin_layout Plain Layout
2521 \begin_layout Subsection
2522 Sectioned Bibliographies
2525 \begin_layout Standard
2526 Sometimes you might need to divide your bibliography into several sections.
2527 If you are for instance a historian, the possibility to separate sources
2528 and scientific works is most likely a
2529 \begin_inset Quotes eld
2533 \begin_inset Quotes erd
2537 Unfortunately, Bib\SpecialChar TeX
2538 itself does not allow you to do this.
2539 But with the help of some \SpecialChar LaTeX
2540 packages, Bib\SpecialChar TeX
2541 can be extended to fit your needs.
2544 \begin_layout Standard
2546 provides native support for one of these packages,
2554 \begin_layout Plain Layout
2556 \begin_inset Flex URL
2559 \begin_layout Plain Layout
2561 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2571 The advantage of this package (compared to other packages like
2575 ) is that you don't need to define new citation commands.
2576 Instead, you need to prepare different bibliographic databases which include
2577 the entries for the different sections of the bibliography.
2578 For example: If you want to divide your bibliography into the sections
2580 \begin_inset Quotes eld
2584 \begin_inset Quotes erd
2588 \begin_inset Quotes eld
2592 \begin_inset Quotes erd
2595 , you first need to create two bibliographic databases, e.
2596 \begin_inset space \thinspace{}
2600 \begin_inset space \space{}
2604 \begin_inset Flex Code
2607 \begin_layout Plain Layout
2614 \begin_inset Flex Code
2617 \begin_layout Plain Layout
2627 \begin_layout Standard
2629 \begin_inset Flex MenuItem
2632 \begin_layout Plain Layout
2633 Document\SpecialChar menuseparator
2640 \begin_inset Flex MenuItem
2643 \begin_layout Plain Layout
2650 \begin_inset Flex MenuItem
2653 \begin_layout Plain Layout
2654 Sectioned bibliography
2660 Now you can insert multiple Bib\SpecialChar TeX
2661 bibliographies, one for each section of
2663 Returning to our example: Insert the Bib\SpecialChar TeX
2665 \begin_inset Flex Code
2668 \begin_layout Plain Layout
2674 and a second one for the database
2675 \begin_inset Flex Code
2678 \begin_layout Plain Layout
2685 You are free to use the same or different styles for each section.
2686 Additionally, you can choose if the bibliography section should contain
2688 \begin_inset Quotes eld
2691 all cited references
2692 \begin_inset Quotes erd
2695 of the specified database(s) (which is the default),
2696 \begin_inset Quotes eld
2699 all uncited references
2700 \begin_inset Quotes erd
2704 \begin_inset Quotes eld
2708 \begin_inset Quotes erd
2712 This might be useful if you would like to separate your bibliography into
2714 \begin_inset Quotes eld
2718 \begin_inset Quotes erd
2722 \begin_inset Quotes eld
2726 \begin_inset Quotes erd
2730 \begin_inset Quotes eld
2734 \begin_inset Quotes erd
2738 The titles for the sections can be added as ordinary sections or subsections.
2740 \begin_inset Flex Code
2743 \begin_layout Plain Layout
2749 removes the bibliography title, you have to manually re-add that, too (as
2750 a chapter* or section*, for instance).
2753 \begin_layout Subsection
2754 Multiple Bibliographies
2757 \begin_layout Standard
2758 Multiple bibliographies, e.
2759 \begin_inset space \thinspace{}
2763 \begin_inset space \space{}
2766 a bibliography for each section or chapter of the document, are not supported
2767 by Bib\SpecialChar TeX
2770 \begin_inset Flex Code
2773 \begin_layout Plain Layout
2779 package, which is used for the creation of sectioned bibliographies in
2781 (see the previous section), provides an easy way to solve this task, if
2782 you are willing to use some
2783 \begin_inset Flex MenuItem
2786 \begin_layout Plain Layout
2794 \begin_inset space ~
2798 \begin_inset CommandInset ref
2800 reference "sec:Inserting-TeX-Code"
2808 \begin_layout Plain Layout
2809 An alternative approach is to use the
2810 \begin_inset Flex Code
2813 \begin_layout Plain Layout
2820 \begin_inset Flex Code
2823 \begin_layout Plain Layout
2829 package, respectively.
2837 \begin_layout Standard
2839 \begin_inset Flex MenuItem
2842 \begin_layout Plain Layout
2843 Document\SpecialChar menuseparator
2850 \begin_inset Flex MenuItem
2853 \begin_layout Plain Layout
2860 \begin_inset Flex MenuItem
2863 \begin_layout Plain Layout
2864 Sectioned bibliography
2870 In the document, you have to enclose the sections, which shall contain
2871 their own bibliography (including the Bib\SpecialChar TeX
2872 bibliography itself), between
2874 \begin_inset Flex Code
2877 \begin_layout Plain Layout
2886 \begin_inset Flex Code
2889 \begin_layout Plain Layout
2897 (those commands have to be inserted as \SpecialChar TeX
2899 The bibliography will contain all references that have been cited in the
2901 \begin_inset Flex Code
2904 \begin_layout Plain Layout
2915 If you are using this approach, then every citation reference has to be
2917 \begin_inset Flex Code
2920 \begin_layout Plain Layout
2928 \begin_inset Flex Code
2931 \begin_layout Plain Layout
2940 \begin_layout Section
2944 \begin_layout Subsection
2948 \begin_layout Standard
2949 When you are working on a large file with many sections, it is often convenient
2950 to break up the document into several files, or perhaps you have something
2951 where a table may change from time to time, but the preceding text does
2953 In these cases, you should seriously consider using multipart documents.
2954 For example, scientific papers often have five major sections: the introduction
2955 , observations, results, discussion, and conclusion.
2956 Each of these could be its own separate \SpecialChar LyX
2958 \begin_inset Quotes eld
2962 \begin_inset Quotes erd
2965 file which contains the title, authors, abstract, references, etc., plus
2966 the five included files.
2967 It is important to note that each of these files is a full \SpecialChar LyX
2969 can be formatted and printed on its own, as well as included in a master
2971 Each of these files must have the same document class, however—don't attempt
2972 to mix book classes with article classes.
2973 You may also include \SpecialChar LaTeX
2974 files; however, these files must not have their own
2976 \begin_inset space \thinspace{}
2980 \begin_inset space \space{}
2983 everything up to and including the
2984 \begin_inset Flex Code
2987 \begin_layout Plain Layout
2996 \begin_inset Flex Code
2999 \begin_layout Plain Layout
3007 line must be deleted) or else errors will be generated when you try to
3011 \begin_layout Standard
3013 allows you to include files quite easily with
3014 \begin_inset Flex MenuItem
3017 \begin_layout Plain Layout
3018 Insert\SpecialChar menuseparator
3020 \begin_inset space ~
3029 When you click on this selection a small box is inserted into the file
3030 at the current cursor location.
3031 Clicking on the box raises a dialog which allows you to select the file
3032 to be included, and the method of its inclusion.
3036 \begin_layout Standard
3037 The file selection box should by now be obvious.
3038 The three inclusion methods are
3039 \begin_inset Quotes eld
3043 \begin_inset Quotes erd
3047 \begin_inset Quotes eld
3051 \begin_inset Quotes erd
3055 \begin_inset Quotes eld
3059 \begin_inset Quotes erd
3063 The difference between
3064 \begin_inset Quotes eld
3068 \begin_inset Quotes erd
3072 \begin_inset Quotes eld
3076 \begin_inset Quotes erd
3079 is really only meaningful to \SpecialChar LaTeX
3080 perts, but the practical difference is that
3082 \begin_inset Quotes eld
3086 \begin_inset Quotes erd
3089 are typeset beginning on a new page, while files that are
3090 \begin_inset Quotes eld
3094 \begin_inset Quotes erd
3097 are typeset starting on the current page.
3100 \begin_layout Standard
3101 Generally, the master file is converted into a full \SpecialChar LaTeX
3102 file before typesetting,
3103 while the included files are converted to \SpecialChar LaTeX
3104 files that do not have all the
3105 preamble information.
3108 \begin_layout Standard
3110 \begin_inset Quotes eld
3114 \begin_inset Quotes erd
3117 included file allows you to include a file typeset exactly as it appears
3119 \begin_inset space \thinspace{}
3123 \begin_inset space \space{}
3127 \begin_inset Flex Code
3130 \begin_layout Plain Layout
3136 mode, with the characters set in a fixed-width typewriter font.
3137 Normally, spaces in this file are invisible, though two consecutive spaces
3138 are conserved, unlike \SpecialChar LyX
3139 's normal treatment of spaces.
3140 However, setting the
3141 \begin_inset Flex MenuItem
3144 \begin_layout Plain Layout
3146 \begin_inset space ~
3150 \begin_inset space ~
3154 \begin_inset space ~
3162 checkbox typesets a mark to unambiguously define the presence of a space.
3166 \begin_layout Subsection
3167 Cross-References Between Files
3170 \begin_layout Standard
3171 \begin_inset Box Shadowbox
3181 height_special "totalheight"
3186 backgroundcolor "none"
3189 \begin_layout Plain Layout
3190 This section is somewhat out of date.
3191 Need to describe default master documents and how children are opened when
3201 \begin_layout Standard
3202 It is possible to set up cross-references between the different files.
3203 First, open all the files in question: let's call them A and B in a two
3204 file example, where B is included in A.
3205 Let's say you insert a label in A, then want to reference it in B.
3206 Open the cross-reference dialog whilst in document B, and you can select
3208 \begin_inset Quotes eld
3212 \begin_inset Quotes erd
3218 \begin_layout Subsection
3219 Bibliography Lists in all Subdocuments
3222 \begin_layout Standard
3223 \begin_inset Box Frameless
3233 height_special "totalheight"
3238 backgroundcolor "none"
3241 \begin_layout Plain Layout
3242 This section also needs updating.
3243 There is now material about this on the wiki, and it could be copied here.
3251 \begin_layout Standard
3252 Copy the bibliography list with all entries to all subdocuments and transform
3254 This way \SpecialChar LyX
3256 \begin_inset Flex Code
3259 \begin_layout Plain Layout
3265 -files and you can easily insert references without making the bibliography
3269 \begin_layout Standard
3270 As the bibliography list is in a comment, \SpecialChar LaTeX
3271 won't use it and the references
3272 will look like this: [?], instead of like this: [1].
3273 One solution is to use the \SpecialChar LaTeX
3275 \begin_inset Flex Code
3278 \begin_layout Plain Layout
3284 that will only include comments by processing the files separately.
3285 To do this, add in the \SpecialChar LaTeX
3286 preamble of every subdocument the following:
3289 \begin_layout LyX-Code
3295 \begin_layout LyX-Code
3298 includecomment{comment}
3301 \begin_layout Standard
3303 \begin_inset Flex URL
3306 \begin_layout Plain Layout
3308 http://wiki.lyx.org/FAQ/Unsorted#toc31
3316 \begin_layout Section
3321 \begin_layout Standard
3322 Users sometimes need to be able to
3323 \begin_inset Quotes eld
3327 \begin_inset Quotes erd
3331 file together with all the images (and other files) on which it depends,
3332 either for sending to a publisher or for sharing with a co-author.
3334 2.0 includes a Python script (
3335 \begin_inset Flex Code
3338 \begin_layout Plain Layout
3344 ) that automates this process.
3345 To use it, you must have either the
3346 \begin_inset Flex Code
3349 \begin_layout Plain Layout
3356 \begin_inset Flex Code
3359 \begin_layout Plain Layout
3365 python modules installed on your system.
3366 By default, the script prefers the
3367 \begin_inset Flex Code
3370 \begin_layout Plain Layout
3377 \begin_inset Flex Code
3380 \begin_layout Plain Layout
3386 format on Unix-like systems and the
3387 \begin_inset Flex Code
3390 \begin_layout Plain Layout
3399 \begin_layout Standard
3401 's configuration process will set the script up to export a `\SpecialChar LyX
3403 and this format will then be available under
3404 \begin_inset Flex Code
3407 \begin_layout Plain Layout
3408 File\SpecialChar menuseparator
3417 \begin_layout Standard
3418 Independently of the platform, the generation of a particular archive format
3419 can be forced by adding either the
3420 \begin_inset Flex Code
3423 \begin_layout Plain Layout
3430 \begin_inset Flex Code
3433 \begin_layout Plain Layout
3440 \begin_inset Flex Code
3443 \begin_layout Plain Layout
3450 \begin_inset Flex Code
3453 \begin_layout Plain Layout
3459 format) switch to the
3460 \begin_inset Flex Code
3463 \begin_layout Plain Layout
3465 \SpecialChar menuseparator
3473 \begin_inset Flex Code
3476 \begin_layout Plain Layout
3477 Tools\SpecialChar menuseparator
3478 Preferences\SpecialChar menuseparator
3479 File Handling\SpecialChar menuseparator
3486 (Make sure you add the switch after the script name, not before it.)
3489 \begin_layout Section
3490 Fancy Headers and Footers
3493 \begin_layout Standard
3494 The default page layout is rather plain; for an
3495 \begin_inset Flex Code
3498 \begin_layout Plain Layout
3504 document class, all you get is a centered page number at the bottom of
3506 This document uses KOMA-script's book class, so it appears to be a bit
3508 But to really put on a show, you need to set the document page style to
3510 \begin_inset Quotes eld
3514 \begin_inset Quotes erd
3517 , as mentioned in the
3522 This section describes the \SpecialChar LaTeX
3523 code you need to insert in your \SpecialChar LaTeX
3525 order to get the desired effects.
3528 \begin_layout Standard
3529 For more information on fancy headers, see the
3530 \begin_inset Flex Code
3533 \begin_layout Plain Layout
3539 package documentation.
3541 \begin_inset Flex URL
3544 \begin_layout Plain Layout
3546 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3554 \begin_layout Standard
3555 The page header is divided into three fields, not surprisingly labeled
3556 \begin_inset Quotes eld
3560 \begin_inset Quotes erd
3564 \begin_inset Quotes eld
3568 \begin_inset Quotes erd
3572 \begin_inset Quotes eld
3576 \begin_inset Quotes erd
3580 The footer is also divided into these three fields.
3581 The \SpecialChar LaTeX
3582 commands to set these fields in the simplest manner are
3583 \begin_inset Flex Code
3586 \begin_layout Plain Layout
3595 \begin_inset Flex Code
3598 \begin_layout Plain Layout
3607 \begin_inset Flex Code
3610 \begin_layout Plain Layout
3619 \begin_inset Flex Code
3622 \begin_layout Plain Layout
3631 Suppose you wish to put your name in the upper left hand corner of each
3633 Simply insert the following command in the preamble:
3636 \begin_layout Standard
3645 \begin_layout Standard
3646 You will now see your name in the upper left.
3647 If a field has a default entry that you would like to get rid of (often
3648 the page number appears in the central footer) simply include a command
3649 with a blank argument, e.
3650 \begin_inset space \thinspace{}
3656 \begin_layout Standard
3664 \begin_layout Standard
3665 Let's get really fancy: lets put the section number with the word
3666 \begin_inset Quotes eld
3670 \begin_inset Quotes erd
3674 \begin_inset space \thinspace{}
3678 \begin_inset space \space{}
3681 Section 3) in the upper left, the page number (e.
3682 \begin_inset space \thinspace{}
3686 \begin_inset space \space{}
3689 Page 4) in the upper right, your name in the lower left, and the date in
3691 The following commands should now appear in the preamble:
3694 \begin_layout Standard
3704 \begin_layout Standard
3712 \begin_layout Standard
3722 \begin_layout Standard
3731 \begin_layout Standard
3739 \begin_layout Standard
3749 \begin_layout Standard
3751 \begin_inset Flex Code
3754 \begin_layout Plain Layout
3763 \begin_inset Flex Code
3766 \begin_layout Plain Layout
3774 access \SpecialChar LaTeX
3775 's section and page counters, and so print out the current section
3778 \begin_inset Flex Code
3781 \begin_layout Plain Layout
3789 simply prints out today's date.
3792 \begin_layout Standard
3793 The thicknesses of the horizontal rules drawn beneath the header and above
3794 the footer can also be modified.
3795 If you don't want one of the rules, set its thickness to 0.
3796 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3802 \begin_inset Flex Code
3805 \begin_layout Plain Layout
3810 headrulewidth}{0.4pt}
3816 \begin_inset Flex Code
3819 \begin_layout Plain Layout
3824 footrulewidth}{0.4pt}
3829 to set the thicknesses.
3832 \begin_layout Standard
3833 You can switch the header/footer settings on and off for individual pages
3835 \begin_inset Flex Code
3838 \begin_layout Plain Layout
3841 thispagestyle{empty}
3847 \begin_inset Flex Code
3850 \begin_layout Plain Layout
3853 thispagestyle{plain}
3859 \begin_inset Flex Code
3862 \begin_layout Plain Layout
3865 thispagestyle{fancy}
3871 Simply insert them in the text on the page you want changed and mark them
3874 In fact, title pages are marked as plain by default, while following pages
3875 are marked fancy when using the global fancy setting.
3878 \begin_layout Standard
3879 As a final example, it is possible to include an image in the header or
3881 Suppose you want to put a company logo in the upper lefthand corner.
3882 You might try something like
3885 \begin_layout Standard
3894 includegraphics{logo.eps}}}
3897 \begin_layout Standard
3899 (you may need to preface this with
3900 \begin_inset Flex Code
3903 \begin_layout Plain Layout
3907 usepackage{graphics}
3912 if you don't include graphics elsewhere in your document).
3915 \begin_layout Section
3916 Itemize Bullet Selection
3917 \begin_inset CommandInset label
3926 \begin_layout Standard
3932 \begin_layout Subsection
3936 \begin_layout Standard
3938 provides 216 bullet shapes that can be accessed from a simple dialog.
3939 Using this dialog you can easily specify what bullet shape to use at each
3940 level of an itemized list.
3941 These settings are document-wide so you won't be able to specify different
3942 sets of bullets for different paragraphs.
3946 \begin_layout Plain Layout
3947 Well, actually you can but you'll have to do it by hand.
3955 \begin_layout Subsection
3959 \begin_layout Standard
3960 Open the dialog by selecting the
3961 \begin_inset Flex MenuItem
3964 \begin_layout Plain Layout
3965 Document\SpecialChar menuseparator
3971 menu item and then select the
3972 \begin_inset Flex MenuItem
3975 \begin_layout Plain Layout
3984 \begin_layout Standard
3985 The dialog provides you with a table of bullet shapes.
3986 A column of buttons on the left of the table provides access to the six
3987 different panels of bullet shapes.
3988 The row of buttons across the top is used to select which bullet depth
3990 A text entry under the table shows the currently selected bullet shape's
3992 equivalent and this can be edited if desired.
3993 If you do modify the text you will also need to specify any needed packages
3994 in the \SpecialChar LaTeX
3998 \begin_layout Standard
3999 The six panels are divided up by the packages they require.
4000 The following table shows the mappings from button name to \SpecialChar LaTeX
4002 \begin_inset Separator parbreak
4008 \begin_layout Standard
4010 \begin_inset Tabular
4011 <lyxtabular version="3" rows="7" columns="2">
4012 <features tabularvalignment="middle">
4013 <column alignment="center" valignment="top" width="0pt">
4014 <column alignment="center" valignment="top" width="0pt">
4016 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4019 \begin_layout Plain Layout
4034 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4037 \begin_layout Plain Layout
4054 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4057 \begin_layout Plain Layout
4072 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4075 \begin_layout Plain Layout
4084 base \SpecialChar LaTeX
4092 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4095 \begin_layout Plain Layout
4110 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4113 \begin_layout Plain Layout
4130 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4133 \begin_layout Plain Layout
4148 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4151 \begin_layout Plain Layout
4168 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4171 \begin_layout Plain Layout
4186 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4189 \begin_layout Plain Layout
4206 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4209 \begin_layout Plain Layout
4224 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4227 \begin_layout Plain Layout
4244 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4247 \begin_layout Plain Layout
4262 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4265 \begin_layout Plain Layout
4288 \begin_layout Standard
4290 doesn't stop you using bullets from packages you don't have.
4291 If you get errors from \SpecialChar LaTeX
4292 when you try to view or print the file, then it
4293 is likely you are missing a package.
4297 \begin_layout Plain Layout
4299 doesn't restrict your use since you may be editing locally and exporting
4308 \begin_layout Subsection
4312 \begin_layout Standard
4313 Select which bullet depth you want to change then select the bullet shape
4315 Any changes will not be visible in \SpecialChar LyX
4316 , but are visible when viewing the document.
4319 \begin_layout Standard
4320 You can reset a bullet shape to the default simply by clicking your right
4321 mouse button on the appropriate bullet depth button.
4325 \begin_layout Plain Layout
4330 want to have multiple sets of paragraphs with different sets of bullets
4331 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4333 The bullet selection dialog can help though because it provides you with
4334 the \SpecialChar LaTeX
4335 code for a wide range of bullet shapes.
4336 To make your own custom paragraphs you have the following options:
4339 \begin_layout Plain Layout
4343 \begin_layout Plain Layout
4359 \begin_layout Plain Layout
4363 \begin_layout Plain Layout
4385 \begin_layout Itemize
4386 Use the \SpecialChar LaTeX
4388 \begin_inset Flex Code
4391 \begin_layout Plain Layout
4399 to specify a new bullet shape for a given depth.
4400 You'll also need to save the current bullet shape so you can restore it
4402 In this itemized list the following \SpecialChar LaTeX
4403 code was used to change the bullet
4404 used for the first depth.
4405 \begin_inset Separator parbreak
4412 \begin_layout LyX-Code
4422 \begin_layout LyX-Code
4439 \begin_layout Itemize
4440 Note that the itemize depth is specified in Roman numerals as part of the
4450 \begin_layout Itemize
4454 \begin_layout Plain Layout
4467 Specify each individual entry by starting each item with the bullet shape
4468 enclosed in square brackets and set as
4469 \begin_inset Flex MenuItem
4472 \begin_layout Plain Layout
4480 For example, this item was started with
4481 \begin_inset Flex Code
4484 \begin_layout Plain Layout
4499 \begin_layout Plain Layout
4503 \begin_layout Plain Layout
4519 \begin_layout Plain Layout
4520 You'll also need to revert the labelitem back to its previous setting for
4521 the global bullet shape settings to remain in effect.
4522 The way used here was:
4525 \begin_layout LyX-Code
4540 \begin_layout Chapter
4542 and the World Wide Web
4545 \begin_layout Standard
4547 has long supported the export of documents to various web-friendly formats,
4549 Before verson 2.0, however, HTML export was always accomplished by the use
4550 of external converters.
4554 \begin_layout Plain Layout
4555 For details on the use of external converters with \SpecialChar LyX
4560 section of the Customization manual.
4565 These fall into two large groups: there are converters that use \SpecialChar LaTeX
4567 intermediate format, such as
4568 \begin_inset Flex Code
4571 \begin_layout Plain Layout
4578 \begin_inset Flex Code
4581 \begin_layout Plain Layout
4588 \begin_inset Flex Code
4591 \begin_layout Plain Layout
4597 , relying upon \SpecialChar LyX
4598 to produce the \SpecialChar LaTeX
4599 ; and there is a converter that works directly
4602 \begin_inset Flex Code
4605 \begin_layout Plain Layout
4613 All of these have different advantages and disadvantages.
4617 \begin_layout Standard
4618 The \SpecialChar LaTeX
4619 -based converters have the advantage that, in principle, they know everythin
4620 g about the exported document that \SpecialChar LaTeX
4622 Such converters do not care, for example, if a certain block of code was
4623 produced by \SpecialChar LyX
4624 or was Evil Red Text.
4625 These converters know about
4626 \begin_inset Flex Code
4629 \begin_layout Plain Layout
4635 files, counters, and references, and can often make use of the
4636 \begin_inset Flex Code
4639 \begin_layout Plain Layout
4645 files generated by Bib\SpecialChar TeX
4647 On the other hand, \SpecialChar LaTeX
4648 is a very hard language to parse—it is sometimes said
4649 that only \SpecialChar TeX
4650 itself understands \SpecialChar TeX
4651 —and \SpecialChar LaTeX
4652 -based converters will often choke on
4653 what seem to be quite simple constructs; complex ones can throw them completely
4654 , and as of this writing, for example, the
4658 manual will not export with
4659 \begin_inset Flex Code
4662 \begin_layout Plain Layout
4668 , though the others will.
4669 The other issue concerns how math is handled.
4670 These converters typically convert the formulae into little pictures that
4671 are then linked from the HTML document.
4672 Since these are actually generated by \SpecialChar LaTeX
4673 , they are accurate.
4674 But they do not scale well, and just getting them to look as if they are
4675 actually meant to be in your document—so that the font sizes seem to be
4676 roughly the same—can be a challenge.
4679 \begin_layout Standard
4681 \begin_inset Flex Code
4684 \begin_layout Plain Layout
4692 \begin_inset CommandInset href
4694 name "http://elyxer.nongnu.org/"
4695 target "http://elyxer.nongnu.org/"
4699 ) solves some of these problems.
4700 In particular, the formulae it produces scale perfectly, since it renders
4701 math using a combination of HTML and CSS rather than converting the formulae
4703 But even moderately complex formula are rendered less well than with
4704 \begin_inset Flex Code
4707 \begin_layout Plain Layout
4713 ; this reflects the limitations of HTML.
4717 \begin_layout Plain Layout
4719 \begin_inset Flex Code
4722 \begin_layout Plain Layout
4729 can also use jsMath and MathJax for equations, but this setting is only
4730 available globally and requires one to have access to a server that runs
4736 More importantly (as of version 1.1.1, at least),
4737 \begin_inset Flex Code
4740 \begin_layout Plain Layout
4747 has limited support for math macros and no support for user-defined paragraph
4748 or character styles.
4749 These limitations make
4750 \begin_inset Flex Code
4753 \begin_layout Plain Layout
4760 unsuitable for many of the documents \SpecialChar LyX
4762 In principle, of course, these problems could be solved, but the \SpecialChar LyX
4764 have decided to follow a different path and have made \SpecialChar LyX
4766 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
4767 , DocBook, and plaintext.
4770 \begin_layout Standard
4771 As of this writing, XHTML output remains under development and should probably
4773 \begin_inset Quotes eld
4777 \begin_inset Quotes erd
4784 \begin_layout Plain Layout
4786 \begin_inset Flex Code
4789 \begin_layout Plain Layout
4790 development/HTML.notes
4795 , which can be found in the \SpecialChar LyX
4797 \begin_inset CommandInset href
4799 name "accessed online"
4800 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
4804 , usually contains up-to-date information about the state of XHTML output.
4805 See also the list of XHTML bugs on
4806 \begin_inset CommandInset href
4808 name "the bug tracker"
4809 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"
4818 Still, the developers have chosen this approach because it has several
4819 potential advantages over the other two.
4822 \begin_layout Standard
4823 These advantages are primarily due to the fact that the XHTML output routines,
4824 since they are part of \SpecialChar LyX
4825 , know everything \SpecialChar LyX
4826 knows about the document being
4831 \begin_layout Plain Layout
4832 Another advantage is that, since these routines are internal to \SpecialChar LyX
4834 immune to changes in \SpecialChar LyX
4835 's file format, or to changes in the semantics of
4841 So they know about the table of contents (as displayed in the outline),
4842 about the counters associated with different paragraph styles, and about
4843 user-defined styles.
4844 The XHTML output routines know what \SpecialChar LyX
4845 knows about internationalization,
4846 too, so they will output
4847 \begin_inset Quotes eld
4851 \begin_inset Quotes erd
4855 \begin_inset Quotes eld
4863 \begin_inset Quotes erd
4866 , depending upon the language in effect at the time.
4870 \begin_layout Standard
4871 Quite generally, the output routines know what \SpecialChar LyX
4872 knows about document layout,
4873 that is, about how the document is to be rendered on screen.
4874 We use this information when we output the document as XHTML.
4875 In particular, \SpecialChar LyX
4880 generates CSS style information corresponding to the layout information
4881 it uses to render the document on screen: if section headings are supposed
4882 to be sans-serif and bold as seen in \SpecialChar LyX
4883 , then (by default) they will be sans-seri
4884 f and bold when viewed in a web browser, too.
4885 And this is true not just for pre-defined styles, like Section, but for
4886 any style, including user-defined styles.
4887 Indeed, the XHTML output routines make no distinction between user-defined
4888 paragraph and character styles and \SpecialChar LyX
4889 's own pre-defined styles: in each case,
4890 everything \SpecialChar LyX
4891 knows about the styles is contained in the layout files.
4892 And much the same is true as regards pre-defined textual insets, such as
4893 footnotes, and various custom insets.
4897 \begin_layout Standard
4898 The result is that XHTML output can be customized and extended in exactly
4899 the same way \SpecialChar LaTeX
4900 output can be customized and extended: through layout files
4902 See chapter five of the
4906 manual for the details.
4909 \begin_layout Standard
4910 The remainder of this chapter contains more detailed information on XHTML
4911 output, its limitations, and ways to work around those limitations.
4914 \begin_layout Section
4915 Math Output in XHTML
4918 \begin_layout Standard
4920 offers four choices for how math is rendered.
4921 These have various advantages and disadvantages:
4924 \begin_layout Itemize
4926 \begin_inset Newline newline
4929 MathML is a dialect of XML designed specifically for mathematics on the
4930 web, and it typically renders very well in browsers that support it.
4931 The disadvantage is that not all browsers support MathML, and support is
4932 not complete even in the Gecko-based browsers, such as Firefox.
4933 \begin_inset Newline newline
4937 is unable to render a formula as MathML—for example, if the formula
4939 \begin_inset Flex Code
4942 \begin_layout Plain Layout
4948 package or ERT—then it will instead output the formula as an image.
4952 \begin_layout Itemize
4954 \begin_inset Newline newline
4958 \begin_inset Flex Code
4961 \begin_layout Plain Layout
4967 outputs math as HTML, styled by CSS.
4971 \begin_layout Plain Layout
4973 has borrowed some of the CSS for its HTML output from
4974 \begin_inset Flex Code
4977 \begin_layout Plain Layout
4988 For simple formulae, this can work quite well, though with more complicated
4989 formulae it tends to break down.
4990 Still, this method has the advantage that it is very widely supported and
4991 so it may be appropriate for documents that contain only a little, fairly
4993 \begin_inset Newline newline
4996 If Lyx is unable to render a formula as HTML—for example, if the formula
4998 \begin_inset Flex Code
5001 \begin_layout Plain Layout
5007 package or ERT—then it will instead output the formula as an image.
5011 \begin_layout Itemize
5013 \begin_inset Newline newline
5017 \begin_inset Flex Code
5020 \begin_layout Plain Layout
5027 will output formulae as images, the very same images, in fact, that are
5028 used for instant preview.
5032 \begin_layout Plain Layout
5033 Instant preview does
5037 have to be on for images to be output, however.
5042 The advantage to this method is that the images are simply generated by
5044 , so they are very accurate.
5045 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5046 so they do not scale terribly well, and one cannot copy them, etc.
5047 (As of this writing, there are also problems about equation numbering.
5049 \begin_inset CommandInset href
5052 target "http://www.lyx.org/trac/ticket/6894"
5057 \begin_inset Newline newline
5060 The size of the images can be controlled by setting the
5061 \begin_inset Quotes eld
5065 \begin_inset Quotes erd
5069 \begin_inset Flex MenuItem
5072 \begin_layout Plain Layout
5073 Document\SpecialChar menuseparator
5074 Settings\SpecialChar menuseparator
5084 \begin_layout Plain Layout
5085 For those who want to know, this controls the resolution of the image in
5086 dots per inch and is based upon a default of 75 dpi.
5092 \begin_inset Newline newline
5096 for some reason fails to create an image for a formula (e.g., if a required
5098 package is not installed), then it will fall back to outputing the raw
5103 \begin_layout Itemize
5106 \begin_inset Newline newline
5109 Finally, \SpecialChar LyX
5110 will happily output math as \SpecialChar LaTeX
5112 As well as being the output of last resort, this method can be used with
5114 \begin_inset CommandInset href
5117 target "http://www.math.union.edu/~dpvc/jsMath/"
5121 , which uses JavaScript to render \SpecialChar LaTeX
5122 embedded in HTML documents.
5124 wraps the \SpecialChar LaTeX
5126 \begin_inset Flex Code
5129 \begin_layout Plain Layout
5135 (for inline formulas) or
5136 \begin_inset Flex Code
5139 \begin_layout Plain Layout
5145 (for displayed formulas) with
5146 \begin_inset Flex Code
5149 \begin_layout Plain Layout
5155 , as is required for jsMath.
5158 \begin_layout Standard
5159 One of these output methods must be selected under
5160 \begin_inset Flex MenuItem
5163 \begin_layout Plain Layout
5164 Document\SpecialChar menuseparator
5165 Settings\SpecialChar menuseparator
5172 By default, \SpecialChar LyX
5174 This is a document-wide setting, therefore.
5177 \begin_layout Standard
5178 Eventually, \SpecialChar LyX
5179 will offer the user the option to select an alternate output
5180 method for a particular inset, say, one that isn't being rendered very
5185 \begin_layout Plain Layout
5186 That said, since \SpecialChar LyX
5187 falls back to images if the inset contains ERT, then one
5188 can force output as an image by putting some harmless ERT into the math,
5190 \begin_inset Formula $a=b\relax$
5201 \begin_layout Section
5202 Bibliography and Citations
5205 \begin_layout Standard
5206 XHTML output fully supports bibliographies and citations.
5210 \begin_layout Standard
5211 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5213 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5216 If you are using numerical citations, then \SpecialChar LyX
5217 will output numerical labels,
5218 such as [1] or [17], rather than simply showing the citation key in square
5219 brackets, as it does on-screen.
5220 If you are using author-year citations, then \SpecialChar LyX
5221 will add lowercase letters
5222 to the years, just as Bib\SpecialChar TeX
5223 does, if it finds more than one citation for
5224 a given author-year combination.
5225 The labels will be printed with the bibliography entries.
5226 Note that there is, at present, no way to customize the appearance of the
5227 labels, for example, to choose between square brackets and parentheses.
5230 \begin_layout Standard
5231 Bibliography output is handled by the same machinery that handles the presentati
5232 on of reference information in the citation dialog, so you will see in the
5233 XHTML output pretty much what you would see if you were to look at a given
5234 entry in the citation dialog.
5235 The formatting can be customized in your layout file or, preferably, in
5241 manual for the details.
5244 \begin_layout Standard
5245 The main defect at present is that cross-referenced information is printed
5246 with every entry with which it is associated.
5247 So you can see things like this:
5252 \begin_inset Quotes eld
5255 Context and Logical Form
5256 \begin_inset Quotes erd
5261 Language in Context: Selected Essays
5263 (Oxford: Oxford University Press, 2007), pp.
5269 \begin_inset Quotes eld
5272 Semantics in Context
5273 \begin_inset Quotes erd
5278 Language in Context: Selected Essays
5280 (Oxford: Oxford University Press, 2007), pp.
5284 \begin_layout Standard
5285 This should be fixed before long.
5288 \begin_layout Standard
5289 There is no support at present for sectioned bibliographies.
5290 If you have multiple bibliographies, then \SpecialChar LyX
5291 will print the same bibliography
5295 \begin_layout Section
5299 \begin_layout Standard
5301 will happily export indexes as XHTML, but with certain limitations at the
5305 \begin_layout Standard
5306 Index export will be most reliable when you do not attempt to use the fancy
5307 constructs that are described in the section on indexes in the
5315 \begin_layout Plain Layout
5316 The main issue here is that \SpecialChar LyX
5317 itself does not really handle these.
5318 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5324 We'll describe how they are handled using the subsection headings from
5328 \begin_layout Itemize
5329 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5330 makes an effort to support these,
5331 but the entries must be separated by
5332 \begin_inset Quotes eld
5336 \begin_inset Quotes erd
5339 , that is, there must be spaces around the exclamation point.
5340 This is because it is otherwise too difficult to check for escaped exclamation
5341 points, ones in math, and so forth.
5344 \begin_layout Itemize
5345 Page Ranges: There is no support at all for page ranges, since these make
5346 no sense with XHMTL.
5347 Instead, you will just get two index entries, one at either end.
5350 \begin_layout Itemize
5351 Cross-referencing: There is no support for cross-referencing.
5353 finds an entry containing the
5354 \begin_inset Quotes eld
5357 |see\SpecialChar ldots
5359 \begin_inset Quotes erd
5362 construct, it is just dropped, and the rest is treated as an ordinary index
5366 \begin_layout Itemize
5367 Index Entry Order: \SpecialChar LyX
5368 does support attempts to fix the sorting order.
5369 It will take what is before the first `@' it finds and use that for sorting,
5370 taking what follows the first `@' to be the actual entry.
5371 At present, \SpecialChar LyX
5372 does not check for escaped `@', so do not try to index email
5376 \begin_layout Itemize
5377 Index Entry Layout: You can format entries by using the text style dialog,
5378 or by using any other method available within \SpecialChar LyX
5380 There is no support for constructs like:
5381 \begin_inset Quotes eld
5385 \begin_inset Quotes erd
5389 Indeed, if \SpecialChar LyX
5390 finds a pipe symbol, `|', in an entry, it will delete it and
5391 everything that follows it.
5394 \begin_layout Itemize
5395 Multiple Indexes: There is no support for multiple indexes.
5396 Rather, all index entries will be printed as one large index.
5397 To avoid our printing several versions of the index, we print only the
5398 main index, so make sure you have one.
5401 \begin_layout Section
5402 Nomenclature and Glossary
5405 \begin_layout Standard
5406 There is at present no support for glossaries.
5407 Adding it would be fairly trivial, and welcome.
5410 \begin_layout Chapter
5411 The \SpecialChar LyX
5415 \begin_layout Section
5419 \begin_layout Standard
5420 The `\SpecialChar LyX
5421 server' allows other programs to talk to \SpecialChar LyX
5422 , invoke \SpecialChar LyX
5423 commands, and retrieve
5424 information about the \SpecialChar LyX
5426 This is only intended for advanced users, but they should find it useful.
5427 It is by writing to the \SpecialChar LyX
5428 server, for example, that bibliography managers,
5429 such as JabRef, are able to
5430 \begin_inset Quotes eld
5434 \begin_inset Quotes erd
5437 citations to \SpecialChar LyX
5441 \begin_layout Section
5442 Starting the \SpecialChar LyX
5446 \begin_layout Standard
5447 The \SpecialChar LyX
5448 server works through the use of a pair of named pipes.
5449 These are usually located in
5450 \begin_inset Flex Code
5453 \begin_layout Plain Layout
5459 , (except on Windows, where
5463 named pipes are special objects located in
5464 \begin_inset Flex Code
5467 \begin_layout Plain Layout
5479 ) and have the names
5480 \begin_inset Quotes eld
5484 \begin_inset Flex Code
5487 \begin_layout Plain Layout
5494 \begin_inset Quotes erd
5498 \begin_inset Quotes eld
5502 \begin_inset Flex Code
5505 \begin_layout Plain Layout
5512 \begin_inset Quotes erd
5516 External programs write into
5517 \begin_inset Flex Code
5520 \begin_layout Plain Layout
5526 and read back data from
5527 \begin_inset Flex Code
5530 \begin_layout Plain Layout
5537 The stem of the pipe names can be defined in the
5538 \begin_inset Flex MenuItem
5541 \begin_layout Plain Layout
5542 Tools\SpecialChar menuseparator
5549 \begin_inset Flex Code
5552 \begin_layout Plain Layout
5553 "/home/myhome/lyxpipe"
5559 \begin_inset Flex Code
5562 \begin_layout Plain Layout
5577 \change_deleted 711066561 1405258697
5579 \change_inserted 711066561 1405258701
5583 \change_inserted 711066561 1405258613
5587 \change_inserted 711066561 1405258962
5589 \begin_inset Flex Code
5592 \begin_layout Plain Layout
5594 \change_inserted 711066561 1405258868
5621 configure this manually in order for the server to start.
5624 \begin_layout Standard
5627 \begin_inset Flex Code
5630 \begin_layout Plain Layout
5637 \begin_inset Flex Code
5640 \begin_layout Plain Layout
5646 ' to create the pipes.
5647 If one of the pipes already exists, \SpecialChar LyX
5648 will assume that another \SpecialChar LyX
5650 is already running and will not start the server.
5651 On POSIX (Unix like) systems, if for some other reason, an unused
5652 \begin_inset Quotes eld
5656 \begin_inset Quotes erd
5659 pipe is left in existence when \SpecialChar LyX
5660 closes, then \SpecialChar LyX
5661 will try to delete it.
5662 If this fails for some reason, you will need to delete the pipes manually
5663 and then restart \SpecialChar LyX
5665 On Windows, pipes are deleted by the OS on program termination or crash,
5667 \begin_inset Quotes eld
5671 \begin_inset Quotes erd
5674 pipes should not be possible.
5677 \begin_layout Standard
5678 To have several \SpecialChar LyX
5679 processes with servers at the same time, you have to use
5680 different configurations, perhaps by using separate user directories, each
5682 \begin_inset Flex Code
5685 \begin_layout Plain Layout
5691 file, for each process.
5694 \begin_layout Standard
5695 If you are developing a client program, you might find it useful to enable
5696 debugging information from the \SpecialChar LyX
5698 Do this by starting \SpecialChar LyX
5700 \begin_inset Flex Code
5703 \begin_layout Plain Layout
5712 \begin_layout Standard
5713 You can find a complete example client written in C
5714 \change_inserted 711066561 1405258366
5717 in the source distribution as
5718 \begin_inset Flex Code
5721 \begin_layout Plain Layout
5722 development/lyxserver/server_monitor.c
5723 \change_inserted 711066561 1405258386
5734 \begin_layout Standard
5735 Another useful tool is the command-line based client
5736 \change_inserted 711066561 1405258403
5740 \begin_inset Flex Code
5743 \begin_layout Plain Layout
5744 src/client/lyxclient
5752 \begin_layout Section
5753 Normal communication
5756 \begin_layout Standard
5757 To issue a \SpecialChar LyX
5758 call, the client writes a line of ASCII text into the input
5760 This line has the following format:
5777 \begin_layout Description
5778 clientname is a name that the client can choose arbitrarily.
5779 Its only use is that \SpecialChar LyX
5780 will echo it if it sends an answer—so a client can
5781 dispatch results from different requesters.
5784 \begin_layout Description
5785 function is the function you want \SpecialChar LyX
5787 It is the same as the commands you'd use in the minibuffer.
5790 \begin_layout Description
5791 argument is an optional argument which is meaningful only to some functions
5793 \begin_inset Quotes eld
5797 \begin_inset Quotes erd
5800 LFUN will insert the argument as text at the cursor position).
5803 \begin_layout Standard
5804 The answer from \SpecialChar LyX
5805 will arrive in the output pipe and be of the form
5822 \begin_layout Standard
5831 are just echoed from the command request, while
5835 is more or less useful information filled according to how the command
5836 execution worked out.
5837 Some commands, such as
5838 \begin_inset Quotes eld
5842 \begin_inset Quotes erd
5845 , will return information about the internal state of \SpecialChar LyX
5847 return an empty data-response.
5848 This means that the command execution went fine.
5851 \begin_layout Standard
5852 In case of errors, the response from \SpecialChar LyX
5870 \begin_layout Standard
5875 should contain an explanation of why the command failed.
5878 \begin_layout Standard
5882 \begin_layout LyX-Code
5883 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
5884 \begin_inset Newline newline
5887 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
5888 \begin_inset Newline newline
5891 read a <~/.lyxpipe.out
5892 \begin_inset Newline newline
5898 \begin_layout Subsection
5899 AppleScript (Mac OS X)
5902 \begin_layout Standard
5903 Since \SpecialChar LyX
5904 2.1, \SpecialChar LyX
5905 supports basic interactions with AppleScript for normal communicatio
5906 n through the command run.
5907 This command takes a direct argument (the
5911 to perform) and an optional argument.
5912 It either returns the output of the function or triggers an error with
5913 the error message and code.
5916 \begin_layout Standard
5920 \begin_layout LyX-Code
5921 tell application "\SpecialChar LyX
5925 \begin_layout LyX-Code
5929 \begin_layout LyX-Code
5930 -- Stores the current file name into f
5933 \begin_layout LyX-Code
5934 set f to (run "server-get-filename" with argument "")
5937 \begin_layout LyX-Code
5938 on error the error_message number the error_number
5941 \begin_layout LyX-Code
5942 display dialog "Error: " & the error_number & ".
5946 \begin_layout LyX-Code
5947 & the error_message buttons {"OK"} default button 1
5950 \begin_layout LyX-Code
5954 \begin_layout LyX-Code
5958 \begin_layout Section
5962 \begin_layout Standard
5964 can notify clients of events going on asynchronously.
5965 Currently it will only do this if the user binds a key sequence with the
5967 \begin_inset Quotes eld
5971 \begin_inset Quotes erd
5975 The format of the string \SpecialChar LyX
5976 sends is as follows:
5980 \begin_inset Flex Code
5983 \begin_layout Plain Layout
5994 \begin_layout Standard
5999 is the printed representation of the key sequence that was actually typed
6003 \begin_layout Standard
6004 This mechanism can be used to extend \SpecialChar LyX
6005 's command set and implement macros.
6006 Bind some key sequence to
6007 \begin_inset Quotes eld
6011 \begin_inset Quotes erd
6015 Then start a client that listens on the output pipe, dispatches the command
6016 according to the sequence, and starts a function that may use \SpecialChar LyX
6019 requests to issue a command or a series of commands to \SpecialChar LyX
6023 \begin_layout Section
6024 The simple \SpecialChar LyX
6028 \begin_layout Standard
6030 implements a simple protocol that can be used for session management.
6031 All messages are of the form
6044 \begin_layout Standard
6050 \begin_inset Quotes eld
6054 \begin_inset Quotes erd
6058 \begin_inset Quotes eld
6062 \begin_inset Quotes erd
6067 \begin_inset Quotes eld
6071 \begin_inset Quotes erd
6074 is received from a client, \SpecialChar LyX
6075 will report back to inform the client that
6076 it's listening to it's messages, while
6077 \begin_inset Quotes eld
6081 \begin_inset Quotes erd
6084 sent from \SpecialChar LyX
6085 will inform clients that \SpecialChar LyX
6089 \begin_layout Section
6090 Reverse DVI/PDF search
6093 \begin_layout Standard
6094 Some DVI/PDF viewers
6098 \begin_layout Plain Layout
6099 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux
6100 \change_inserted 711066561 1405273809
6103 , Skim on Mac OSX and SumatraPDF on Windows.
6112 facility (also called
6117 This means that you can tell \SpecialChar LyX
6118 to put the cursor to a specific line in the
6119 document by clicking at the respective position in the DVI/PDF output.
6120 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6122 This is done via the \SpecialChar LyX
6123 server either by using the named pipe (
6127 ), or the UNIX domain socket (
6131 ) that \SpecialChar LyX
6132 creates in its temporary directory (this is the way the
6133 \begin_inset Flex Code
6136 \begin_layout Plain Layout
6142 program communicates with \SpecialChar LyX
6144 In some cases, you need a helper script that mediates between the viewer
6145 and \SpecialChar LyX
6146 , in others, the viewer can communicate with \SpecialChar LyX
6148 This depends on the selected viewer and on your operating system.
6149 The same applies to the way viewers need to be configured and the way the
6150 reverse search is actually performed.
6151 In what follows, we will thus describe how to setup reverse search for
6153 Before we turn to this, though, we will explain what needs to be done generally
6154 to enable reverse search in the DVI/PDF output.
6157 \begin_layout Subsection
6159 \begin_inset CommandInset label
6161 name "subsec:rev-search"
6168 \begin_layout Standard
6169 In most cases \SpecialChar LyX
6170 will do the work for you by enabling the option
6171 \begin_inset Flex MenuItem
6174 \begin_layout Plain Layout
6175 Synchronize with Output
6181 \begin_inset Flex MenuItem
6184 \begin_layout Plain Layout
6185 Document\SpecialChar menuseparator
6186 Settings\SpecialChar menuseparator
6193 In such a case \SpecialChar LyX
6194 will automatically insert the necessary Sync\SpecialChar TeX
6196 PDF) or load the srcltx package (for DVI) respectively.
6197 This option can be easily reached also on
6198 \begin_inset Flex Code
6201 \begin_layout Plain Layout
6210 \begin_layout Standard
6211 If you need a different setting, you can select or input a custom macro
6212 from the drop down box just below
6213 \begin_inset Flex MenuItem
6216 \begin_layout Plain Layout
6217 Document\SpecialChar menuseparator
6218 Settings\SpecialChar menuseparator
6219 Output\SpecialChar menuseparator
6220 Synchronize with Output
6228 \begin_layout Standard
6229 Note that the method
6230 \begin_inset Flex Code
6233 \begin_layout Plain Layout
6241 enables gzip compression.
6242 If your viewer does not support it, you should instead use
6243 \begin_inset Flex Code
6246 \begin_layout Plain Layout
6257 \begin_layout Standard
6259 \change_deleted 711066561 1405259326
6261 \change_inserted 711066561 1405259326
6264 so note that including the
6265 \begin_inset Flex Code
6268 \begin_layout Plain Layout
6275 \begin_inset Flex Code
6278 \begin_layout Plain Layout
6284 sometimes has an undesired impact on the typesetting.
6285 Thus, you should switch output synchronization off for the final typesetting
6287 \begin_inset Flex Code
6290 \begin_layout Plain Layout
6297 \begin_inset Flex Code
6300 \begin_layout Plain Layout
6310 \begin_layout Standard
6311 In case you need some more special settings that are not covered by the
6312 automatic settings, read the next section about how to set up output synchroniz
6314 If the automatic setup suits your needs, you can readily jump to section
6315 \begin_inset space ~
6319 \begin_inset CommandInset ref
6321 reference "subsec:configuring-viewers"
6325 , where the necessary configuration steps in your viewer – needed both with
6326 the automatic and the manual setup – are described.
6329 \begin_layout Subsection
6333 \begin_layout Standard
6335 provides several different methods for reverse search.
6336 Some are built-in in the
6337 \begin_inset Flex Code
6340 \begin_layout Plain Layout
6346 program, some are provided by external packages.
6347 Your choice depends on whether your \SpecialChar LaTeX
6348 distribution already provides a given
6349 method (the built-in methods are rather new) and whether your viewer can
6351 The available methods are described in the following.
6354 \begin_layout Subsubsection*
6355 Built-in DVI-search via src-specials (DVI only)
6358 \begin_layout Standard
6359 This method provides the DVI file with the necessary information for reverse
6361 It is available in \SpecialChar LaTeX
6362 since quite some time (any somewhat recent \SpecialChar LaTeX
6364 should include it), and it works reliably.
6365 To enable it, change the
6366 \begin_inset Flex MenuItem
6369 \begin_layout Plain Layout
6371 \change_deleted -712698321 1437633234
6376 \begin_layout Plain Layout
6384 \change_inserted -712698321 1437633234
6397 \begin_inset Flex MenuItem
6400 \begin_layout Plain Layout
6402 \change_deleted -712698321 1437633251
6407 \begin_layout Plain Layout
6415 \change_inserted -712698321 1437633251
6428 \begin_inset Flex MenuItem
6431 \begin_layout Plain Layout
6432 Preferences\SpecialChar menuseparator
6433 File Handling\SpecialChar menuseparator
6440 \begin_inset Flex Code
6443 \begin_layout Plain Layout
6444 latex -src-specials $$i
6450 If this doesn't work, check if your \SpecialChar TeX
6451 engine needs different options (the
6452 syntax might differ in some distributions).
6455 \begin_layout Subsubsection*
6456 External Packages (PDFSync and scrltx)
6459 \begin_layout Standard
6468 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6470 In order to enable it, load the packages in the \SpecialChar LyX
6474 \begin_layout Itemize
6475 \begin_inset Flex Code
6478 \begin_layout Plain Layout
6486 for reverse PDF search,
6489 \begin_layout Itemize
6490 \begin_inset Flex Code
6493 \begin_layout Plain Layout
6496 usepackage[active]{srcltx}
6501 for reverse DVI search.
6504 \begin_layout Standard
6505 If you want to be able to perform both DVI and PDF reverse searches, you
6506 can also insert in the preamble the following lines
6509 \begin_layout LyX-Code
6513 \begin_inset Newline newline
6519 \begin_inset Newline newline
6525 \begin_inset Newline newline
6531 \begin_inset Newline newline
6536 usepackage[active]{srcltx}
6537 \begin_inset Newline newline
6545 \begin_layout Standard
6546 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6547 right package will be used.
6550 \begin_layout Standard
6551 Note that PDFSync might affect the output layout of your document.
6552 It is therefore advised to disable PDFsync for final documents.
6555 \begin_layout Subsubsection*
6556 Built-in reverse search via Sync\SpecialChar TeX
6560 \begin_layout Standard
6562 \begin_inset Flex Code
6565 \begin_layout Plain Layout
6571 have built-in support for both PDF and DVI reverse search.
6574 Sync\SpecialChar TeX
6577 facility is basically the result of the integration of the PDFSync package
6578 to the pdftex program and its merge with the
6583 You need at least \SpecialChar TeX
6584 Live 2008 or a recent Mik\SpecialChar TeX
6585 distribution in order to use
6590 \begin_layout Plain Layout
6591 For some reason, Mik\SpecialChar TeX
6592 does not understand/obey the command \SpecialChar LyX
6594 the preamble when you check the "Enable Forward/Reverse Search" button
6595 in the toolbar and does not generate the necessary info.
6598 \begin_layout Plain Layout
6599 The generation of the required info can be forced by changing the converter
6601 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
6602 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
6603 the -synctex=1 switch).
6609 Also note that only a few PDF viewers (
6610 \change_inserted 711066561 1405273879
6611 Okular and Qpdfview on Unix,
6613 Skim on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
6617 \begin_layout Standard
6618 To enable Sync\SpecialChar TeX
6619 for DVI output, change the
6620 \begin_inset Flex MenuItem
6623 \begin_layout Plain Layout
6625 \change_deleted -712698321 1437633274
6630 \begin_layout Plain Layout
6638 \change_inserted -712698321 1437633274
6651 \begin_inset Flex MenuItem
6654 \begin_layout Plain Layout
6656 \change_deleted -712698321 1437633275
6661 \begin_layout Plain Layout
6669 \change_inserted -712698321 1437633275
6682 \begin_inset Flex MenuItem
6685 \begin_layout Plain Layout
6686 Preferences\SpecialChar menuseparator
6687 File Handling\SpecialChar menuseparator
6694 \begin_inset Flex Code
6697 \begin_layout Plain Layout
6698 latex -synctex=1 $$i
6703 , and for PDF output, change the
6704 \begin_inset Flex MenuItem
6707 \begin_layout Plain Layout
6709 \change_deleted -712698321 1437633276
6714 \begin_layout Plain Layout
6722 \change_inserted -712698321 1437633276
6729 (pdflatex) -> PDF (pdflatex)
6735 \begin_inset Flex Code
6738 \begin_layout Plain Layout
6739 pdflatex -synctex=1 $$i
6745 Check the documentation of your viewer whether the viewer needs to be configure
6746 d for the use with Sync\SpecialChar TeX
6751 \begin_layout Plain Layout
6752 Note that the option
6753 \begin_inset Flex Code
6756 \begin_layout Plain Layout
6762 option enables gzip compression.
6763 If your viewer does not support it, you should instead use
6764 \begin_inset Flex Code
6767 \begin_layout Plain Layout
6781 \begin_layout Subsection
6782 Configuring and using specific viewers
6783 \begin_inset CommandInset label
6785 name "subsec:configuring-viewers"
6792 \begin_layout Subsubsection*
6793 Xdvi (all platforms)
6796 \begin_layout Standard
6798 \begin_inset Flex Code
6801 \begin_layout Plain Layout
6807 , you don't need to do anything else for performing a reverse DVI search,
6809 already provides the necessary hooks for automatically using the
6810 \begin_inset Flex Code
6813 \begin_layout Plain Layout
6820 Just setup your document as described above (reverse search is triggered
6821 by Ctrl-click or Alt-click on Mac OSX, respectively).
6824 \begin_layout Standard
6825 However, if for whatever reason you want to use the named pipe instead of
6826 the socket for communicating with \SpecialChar LyX
6827 , simply change the DVI viewer in
6828 \begin_inset Flex MenuItem
6831 \begin_layout Plain Layout
6832 Preferences\SpecialChar menuseparator
6833 File Handling\SpecialChar menuseparator
6843 \begin_layout Plain Layout
6844 On Mac OSX you have to use
6845 \begin_inset Flex Code
6848 \begin_layout Plain Layout
6849 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
6860 \begin_inset Flex Code
6863 \begin_layout Plain Layout
6864 xdvi -editor "lyxeditor.sh %f %l"
6870 \begin_inset Flex Code
6873 \begin_layout Plain Layout
6879 is a suitable script.
6880 For example, a minimal shell script is the following one:
6883 \begin_layout LyX-Code
6885 \begin_inset Newline newline
6888 LYXPIPE="/path/to/lyxpipe"
6889 \begin_inset Newline newline
6892 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
6893 \begin_inset Newline newline
6896 echo "$COMMAND" > "${LYXPIPE}".in || exit
6897 \begin_inset Newline newline
6900 read TMP < "${LYXPIPE}".out || exit
6903 \begin_layout Standard
6905 \begin_inset Flex Code
6908 \begin_layout Plain Layout
6918 \begin_layout Plain Layout
6925 XServer pipe path specified in
6926 \begin_inset Flex MenuItem
6929 \begin_layout Plain Layout
6930 Preferences\SpecialChar menuseparator
6940 \begin_layout Plain Layout
6942 \begin_inset Flex Code
6945 \begin_layout Plain Layout
6951 folder of a source distribution you can find a
6952 \begin_inset Flex Code
6955 \begin_layout Plain Layout
6961 script which is able to locate the
6965 based on your preferences.
6973 \begin_layout Subsubsection*
6977 \begin_layout Standard
6979 \begin_inset Flex Code
6982 \begin_layout Plain Layout
6983 /Applications/MacDviX_Folder/calleditor.script
6988 , add the following lines:
6991 \begin_layout LyX-Code
6996 \begin_layout Plain Layout
7003 X.app/Contents/MacOS/lyxeditor "$2" $1
7004 \begin_inset Newline newline
7010 \begin_layout Standard
7011 Modify the lines accordingly if you install \SpecialChar LyX
7012 somewhere else than in the
7013 Applications folder.
7016 \begin_layout Standard
7017 Reverse search is triggered by Alt-click (OPTION-click).
7020 \begin_layout Subsubsection*
7024 \begin_layout Standard
7026 \begin_inset Flex Code
7029 \begin_layout Plain Layout
7030 open -a Skim.app $$i
7035 to the viewer setting in
7036 \begin_inset Flex MenuItem
7039 \begin_layout Plain Layout
7040 Preferences\SpecialChar menuseparator
7041 File Handling\SpecialChar menuseparator
7042 File formats\SpecialChar menuseparator
7049 \begin_inset Flex MenuItem
7052 \begin_layout Plain Layout
7053 Skim\SpecialChar menuseparator
7054 Preferences\SpecialChar menuseparator
7061 \begin_inset Flex MenuItem
7064 \begin_layout Plain Layout
7070 preset and enter command
7071 \begin_inset Flex MenuItem
7074 \begin_layout Plain Layout
7075 /Applications/\SpecialChar LyX
7076 .app/Contents/MacOS/lyxeditor
7084 \begin_layout Standard
7085 Reverse search is triggered by COMMAND-SHIFT-click
7088 \begin_layout Subsubsection*
7092 \begin_layout Standard
7094 \begin_inset Flex MenuItem
7097 \begin_layout Plain Layout
7098 Settings\SpecialChar menuseparator
7099 Configure Okular\SpecialChar ldots
7100 \SpecialChar menuseparator
7107 \begin_inset Quotes eld
7111 \begin_inset Quotes erd
7115 \begin_inset Flex Code
7118 \begin_layout Plain Layout
7127 \begin_layout Standard
7128 Reverse search is triggered by SHIFT-click.
7129 \change_inserted 711066561 1405259853
7133 \begin_layout Subsubsection*
7135 \change_inserted 711066561 1405273730
7139 \begin_layout Standard
7141 \change_inserted 711066561 1405263147
7142 Qpdfview supports Sync\SpecialChar TeX
7143 since version 0.3.5.
7145 \begin_inset Flex MenuItem
7148 \begin_layout Plain Layout
7150 \change_inserted 711066561 1405260331
7151 Edit\SpecialChar menuseparator
7152 Settings\SpecialChar ldots
7153 \SpecialChar menuseparator
7161 , click on the input field of the
7162 \begin_inset Quotes eld
7166 \begin_inset Quotes erd
7169 item and add the command
7170 \begin_inset Flex Code
7173 \begin_layout Plain Layout
7175 \change_inserted 711066561 1405260473
7186 \begin_layout Standard
7188 \change_inserted 711066561 1405260506
7189 Reverse search is triggered by double-click.
7194 \begin_layout Subsubsection*
7198 \begin_layout Standard
7199 Launch yap, choose its
7200 \begin_inset Flex MenuItem
7203 \begin_layout Plain Layout
7204 View\SpecialChar menuseparator
7211 \begin_inset Quotes eld
7215 \begin_inset Quotes erd
7220 \begin_inset Quotes eld
7223 New\SpecialChar ldots
7225 \begin_inset Quotes erd
7228 button and, in the window that opens, enter
7229 \begin_inset Quotes eld
7234 \begin_inset Quotes erd
7237 (or any other name you like) in the
7238 \begin_inset Quotes eld
7242 \begin_inset Quotes erd
7246 Now click on the button labeled
7247 \begin_inset Quotes eld
7252 \begin_inset Quotes erd
7255 to open a file dialog and navigate to the directory containing the batch
7257 \begin_inset Flex Code
7260 \begin_layout Plain Layout
7268 \begin_inset Flex Code
7271 \begin_layout Plain Layout
7277 and then specify the program arguments as
7278 \begin_inset Flex Code
7281 \begin_layout Plain Layout
7289 \begin_inset Flex Code
7292 \begin_layout Plain Layout
7298 wrapper is used for communicating with \SpecialChar LyX
7306 \begin_layout LyX-Code
7308 \begin_inset Newline newline
7311 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
7320 \begin_inset Newline newline
7334 \begin_layout Standard
7335 Make sure that the \SpecialChar LyX
7336 Server pipe path you specified in \SpecialChar LyX
7338 \begin_inset Flex Code
7341 \begin_layout Plain Layout
7355 , otherwise change the
7356 \begin_inset Flex Code
7359 \begin_layout Plain Layout
7365 wrapper accordingly.
7368 \begin_layout Standard
7369 In yap, reverse search is triggered by double-click.
7372 \begin_layout Subsubsection*
7373 SumatraPDF (Windows)
7376 \begin_layout Standard
7377 In order to use SumatraPDF for inverse search, enter
7378 \begin_inset Flex Code
7381 \begin_layout Plain Layout
7382 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
7387 in the viewer setting in
7388 \begin_inset Flex MenuItem
7391 \begin_layout Plain Layout
7392 Preferences\SpecialChar menuseparator
7393 File Handling\SpecialChar menuseparator
7394 File formats\SpecialChar menuseparator
7401 \begin_inset Flex Code
7404 \begin_layout Plain Layout
7410 is the previous wrapper.
7411 If SumatraPDF.exe is not in your command PATH, use its full file name.
7414 \begin_layout Standard
7415 Reverse search is triggered by double-click.
7418 \begin_layout Subsubsection*
7422 \begin_layout Standard
7423 First of all, make sure that yap is your default DVI viewer in the Windows
7424 environment, then launch it, choose its
7425 \begin_inset Flex MenuItem
7428 \begin_layout Plain Layout
7429 View\SpecialChar menuseparator
7436 \begin_inset Quotes eld
7440 \begin_inset Quotes erd
7445 \begin_inset Quotes eld
7448 New\SpecialChar ldots
7450 \begin_inset Quotes erd
7453 button and, in the window that opens, enter
7454 \begin_inset Quotes eld
7459 \begin_inset Quotes erd
7462 (or any other name you like) in the
7463 \begin_inset Quotes eld
7467 \begin_inset Quotes erd
7471 Now click on the button labeled
7472 \begin_inset Quotes eld
7477 \begin_inset Quotes erd
7480 to open a file dialog and navigate to the directory containing the
7481 \begin_inset Flex Code
7484 \begin_layout Plain Layout
7490 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7493 \begin_inset Flex Code
7496 \begin_layout Plain Layout
7502 and then specify the program arguments as
7503 \begin_inset Flex Code
7506 \begin_layout Plain Layout
7513 In this way, you will be using the
7517 for communicating with \SpecialChar LyX
7519 If, for whatever reason, you want to use the
7524 \begin_inset Flex Code
7527 \begin_layout Plain Layout
7533 option and be sure to specify the \SpecialChar LyX
7534 Server pipe path in the \SpecialChar LyX
7538 \begin_layout Standard
7539 In yap, reverse search is triggered by double-click.
7542 \begin_layout Subsubsection*
7546 \begin_layout Standard
7547 In order to use SumatraPDF for inverse search, enter
7548 \begin_inset Flex Code
7551 \begin_layout Plain Layout
7552 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7557 in the viewer setting in
7558 \begin_inset Flex MenuItem
7561 \begin_layout Plain Layout
7562 Preferences\SpecialChar menuseparator
7563 File Handling\SpecialChar menuseparator
7564 File formats\SpecialChar menuseparator
7571 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7573 \begin_inset Flex Code
7576 \begin_layout Plain Layout
7582 enables communication via the
7588 \begin_inset Flex Code
7591 \begin_layout Plain Layout
7597 option if you want to use the
7601 , and be sure to specify the \SpecialChar LyX
7602 Server pipe path in the \SpecialChar LyX
7606 \begin_layout Standard
7607 Reverse search is triggered by double-click.
7610 \begin_layout Section
7614 \begin_layout Standard
7615 Forward search is, as the name implies, in a sense the
7616 \begin_inset Quotes eld
7620 \begin_inset Quotes erd
7624 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7626 If forward search is set up (as described in what follows), you can put
7627 the cursor anywhere in your \SpecialChar LyX
7629 \begin_inset Flex MenuItem
7632 \begin_layout Plain Layout
7633 Navigate\SpecialChar menuseparator
7640 \begin_inset Flex MenuItem
7643 \begin_layout Plain Layout
7649 in the context menu via right mouse click), and then the viewer will jump
7650 to that position as well.
7651 This implies, of course, that your viewer supports this function.
7654 \begin_layout Standard
7655 To make forward search possible, you first need to provide the generated
7656 output PDF/DVI file with additional information about the \SpecialChar TeX
7658 This can be done via the methods described in the section
7659 \begin_inset CommandInset ref
7661 reference "subsec:rev-search"
7668 \begin_layout Standard
7669 Additionally, you need to configure \SpecialChar LyX
7670 for using your viewers in
7671 \begin_inset Flex MenuItem
7674 \begin_layout Plain Layout
7675 Tools\SpecialChar menuseparator
7676 Preferences\SpecialChar menuseparator
7677 Output\SpecialChar menuseparator
7684 We provide a range of tested configurations for some viewers, which you
7685 can select from the drop down list.
7686 If none of these configurations suits you, you have to find out and enter
7687 a suitable configuration yourself.
7688 The definition syntax uses the following placeholders:
7691 \begin_layout Itemize
7693 \begin_inset Flex Code
7696 \begin_layout Plain Layout
7705 \begin_layout Itemize
7707 \begin_inset Flex Code
7710 \begin_layout Plain Layout
7716 : name of the (temporary) exported .tex file (without path)
7719 \begin_layout Itemize
7721 \begin_inset Flex Code
7724 \begin_layout Plain Layout
7730 : name of the (temporary) exported .tex file (including path)
7733 \begin_layout Itemize
7735 \begin_inset Flex Code
7738 \begin_layout Plain Layout
7744 : name of the exported output file (either dvi or pdf, depending on which
7745 one exists in the temporary directory)
7748 \begin_layout Standard
7749 Note that only some of the viewers provide full forward search functionality,
7750 among them yap, xdvi, okular
7754 \begin_layout Plain Layout
7755 You might want to set
7756 \begin_inset Flex Code
7759 \begin_layout Plain Layout
7766 \begin_inset Flex MenuItem
7769 \begin_layout Plain Layout
7770 Tools\SpecialChar menuseparator
7771 Preferences\SpecialChar menuseparator
7772 File Handling\SpecialChar menuseparator
7774 \begin_inset space ~
7788 \change_inserted 711066561 1405264317
7792 \change_deleted 711066561 1405264282
7799 \begin_layout Plain Layout
7801 \change_deleted 711066561 1405264216
7805 \change_inserted 711066561 1405264265
7806 PDF can also use DDE commands through the external program
7809 \change_deleted 711066561 1405264271
7813 \begin_inset CommandInset href
7815 target "ftp://ftp2.commence.com/pub/freebies/"
7825 While many of the widespread PDF viewers (most notably Adobe Reader) do
7826 not support forward search at all, some other viewers – e.
7827 \begin_inset space \thinspace{}
7831 evince and xpdf – allow at least to reload the document and jump to a specific
7832 page of the file, so you can at least navigate
7833 \begin_inset Quotes eld
7837 \begin_inset Quotes erd
7841 This latter functionality is provided by an external call of synctex (see
7842 the predefined example configurations).
7846 \begin_layout Standard
7847 Forward search works both with DVI and PDF output.
7849 simply checks which preview format you have used before (i.
7850 \begin_inset space \thinspace{}
7853 e., which format is already there in the temporary directory) and chooses
7854 the appropriate configuration for the respective format.
7857 \begin_layout Chapter
7858 Special Document Classes
7861 \begin_layout Section
7865 \begin_layout Standard
7871 \begin_layout Subsection
7875 \begin_layout Standard
7876 This section describes how \SpecialChar LyX
7877 can be used to write articles for submission
7878 to the scientific journal
7880 Astronomy and Astrophysics
7882 (www.edpsciences.fr/aa/
7883 \begin_inset Flex URL
7886 \begin_layout Plain Layout
7888 http://www.edpsciences.fr/aa/
7893 ) using Version 5.01 of the document class
7898 This package can be downloaded from the ftp site
7901 \begin_layout Standard
7902 \begin_inset VSpace medskip
7908 \begin_layout Standard
7910 \begin_inset Flex URL
7913 \begin_layout Plain Layout
7915 ftp://ftp.edpsciences.org/pub/aa/readme.html
7923 \begin_layout Standard
7924 \begin_inset VSpace medskip
7930 \begin_layout Standard
7931 A manual comes together with that package, and this text is not meant to
7932 replace the original manual but is merely a short guide in how to realize
7933 the correct form of your paper.
7937 \begin_layout Standard
7938 Please note that the publisher of the journal was changed from Springer
7939 to EDP Sciences starting January 1, 2001.
7940 That change involved also some slight changes to the style files, namely
7941 the removal of the thesaurus command.
7942 The \SpecialChar LyX
7943 class aa supports the newest version of these style files, V 5.01.
7944 If you have an older version installed, please upgrade.
7945 For compatibility, the old (version 4) layout has been kept as
7950 Please refer to the comments in
7953 Dir/layouts/aapaper.layout
7958 \begin_layout Subsection
7962 \begin_layout Standard
7963 It is recommended you start from the example template distributed with \SpecialChar LyX
7965 If you are not using a template, note the following settings:
7968 \begin_layout Itemize
7975 Document\SpecialChar menuseparator
7978 dialog (OK, that one was obvious).
7981 \begin_layout Itemize
7982 Don't change the option
7985 \begin_inset space ~
7995 The whole layout is done by the macros, you shouldn't change anything.
7998 \begin_layout Subsection
8002 \begin_layout Standard
8003 First thing to enter is the header information.
8004 It consists of seven entries, of which some are optional.
8008 \begin_layout Itemize
8016 \begin_layout Itemize
8024 \begin_layout Itemize
8032 \begin_layout Itemize
8040 \begin_layout Itemize
8045 : [optional] if more than one author: whom to contact for offprint requests.
8048 \begin_layout Itemize
8053 : [optional] mail address for contacts.
8056 \begin_layout Itemize
8064 Received: <date>; Accepted <date>
8067 \begin_layout Standard
8068 There is no need to issue the
8074 command, this is done automatically by \SpecialChar LyX
8075 when the header is finished.
8076 Although the order of the single header entries doesn't matter it is advised
8077 to keep the above sequence, just to get the best optics and meets the layout
8078 of the real document.
8081 \begin_layout Standard
8082 If you want to place footnotes in the header block, e.
8083 \begin_inset space \thinspace{}
8087 \begin_inset space \space{}
8090 to state your present address, just use the standard footnote via the menu
8093 Insert\SpecialChar menuseparator
8098 will automagically use the term
8107 \begin_layout Standard
8108 In addition to these topics, the macros use three additional \SpecialChar LaTeX
8110 have no counterpart in \SpecialChar LyX
8114 \begin_layout Itemize
8121 to separate different names for more than one author and institute, respectivel
8125 \begin_layout Itemize
8132 to mark corresponding author/institute pairs.
8133 The institutes are numbered sequentially as they appear in the
8137 field, so you have to put a marker to each author.
8140 \begin_layout Itemize
8147 to supply an email address for fast contact.
8150 \begin_layout Standard
8151 In all cases, the appropriate command has to be entered in \SpecialChar LyX
8159 \begin_layout Subsection
8163 \begin_layout Standard
8164 The abstract should immediately follow the header block.
8165 With version 5 the abstract environment was changed to a command, and there
8166 is now a resctriction to only one paragraph.
8167 In addition, it should contain an entry with the keywords.
8168 This is not yet implemented for \SpecialChar LyX
8169 , therefore you have to enter the \SpecialChar LaTeX
8177 by hand and mark it as \SpecialChar LaTeX
8179 Refer to the example paper.
8182 \begin_layout Subsection
8183 Supported environments
8186 \begin_layout Standard
8187 The A&A paper layout supports the following environments for structuring
8191 \begin_layout Itemize
8197 \begin_layout Itemize
8203 \begin_layout Itemize
8209 \begin_layout Itemize
8215 \begin_layout Itemize
8221 \begin_layout Itemize
8227 \begin_layout Itemize
8233 \begin_layout Itemize
8239 \begin_layout Itemize
8245 \begin_layout Itemize
8251 \begin_layout Itemize
8257 \begin_layout Itemize
8264 \begin_layout Subsection
8265 Commands not supported by \SpecialChar LyX
8269 \begin_layout Standard
8270 Some commands are not yet supported by the
8274 layout for \SpecialChar LyX
8276 Some have already been mentioned.
8277 For the sake of completeness, they are listed all together here:
8280 \begin_layout Itemize
8288 \begin_layout Itemize
8296 \begin_layout Itemize
8304 \begin_layout Itemize
8312 \begin_layout Itemize
8320 \begin_layout Itemize
8328 \begin_layout Itemize
8336 \begin_layout Itemize
8344 \begin_layout Standard
8345 If you want to use any of these commands, you have to enter them yourself.
8348 Do not forget to mark them as \SpecialChar LaTeX
8352 \begin_layout Subsection
8353 Figure and Table Floats
8356 \begin_layout Standard
8358 provides support for the necessary float environments
8360 figure, figure*, table
8366 , therefore we won't tell much about it here.
8370 \begin_inset space ~
8376 Just remember that tables should be left-aligned.
8377 For that, select the table and change the alignment in
8379 Edit\SpecialChar menuseparator
8381 \begin_inset space ~
8387 \begin_layout Standard
8388 There is only one special thing: the figures with caption besides the figure.
8389 To create such a figure, you have to do the following:
8392 \begin_layout Enumerate
8393 Create a wide figure float:
8395 Insert\SpecialChar menuseparator
8396 Float\SpecialChar menuseparator
8399 , then right click in the figure and select
8405 \begin_inset space ~
8413 \begin_layout Enumerate
8414 Enter your caption text.
8417 \begin_layout Enumerate
8422 to move the cursor above the caption.
8425 \begin_layout Enumerate
8429 \begin_layout Enumerate
8430 Position the cursor behind the figure and insert a horizontal fill:
8432 Insert\SpecialChar menuseparator
8434 \begin_inset space ~
8437 Character\SpecialChar menuseparator
8439 \begin_inset space ~
8447 \begin_layout Enumerate
8448 Switch to \SpecialChar LaTeX
8452 \begin_inset space ~
8460 \begin_layout Enumerate
8470 Do not close the brace!
8473 \begin_layout Enumerate
8474 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8479 \begin_inset space ~
8491 \begin_layout Standard
8492 Also, refer to the figures in the example paper.
8495 \begin_layout Subsection
8499 \begin_layout Standard
8500 For submission, the paper has to be formated in a special double-spacing
8502 For this purpose, you have to give the option
8506 to the documentclass.
8507 This must be done using the extra class options field in the
8509 Document\SpecialChar menuseparator
8513 Just enter the string
8520 \begin_layout Subsection
8524 \begin_layout Standard
8529 directory contains an example paper written with \SpecialChar LyX
8531 It is the example paper from the original macro package, translated to
8534 Use it for inspiration, and compare the original \SpecialChar LaTeX
8535 code with \SpecialChar LyX
8539 \begin_layout Section
8544 \begin_layout Standard
8550 \begin_layout Subsection
8554 \begin_layout Standard
8556 is a set of macros produced by the American Astronomical Society to
8557 facilitate electronic manuscript submission to the three journals they
8558 publish: the Astrophysical Journal (including the Letters and Supplement),
8559 the Astronomical Journal, and the Publications of the Astronomical Society
8562 has proven to be an excellent tool for generating these documents, especially
8563 given its equation, citation, and figure handling capabilities.
8565 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8566 is the version described here, or higher.
8567 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8568 2.09 and are fundamentally
8569 incompatible with \SpecialChar LyX
8571 The AAS\SpecialChar TeX
8572 package may be downloaded from the AAS\SpecialChar TeX
8576 \begin_layout Standard
8577 \begin_inset VSpace medskip
8583 \begin_layout Standard
8585 \begin_inset Flex URL
8588 \begin_layout Plain Layout
8590 http://www.journals.uchicago.edu/AAS/AASTeX
8598 \begin_layout Standard
8599 \begin_inset VSpace medskip
8605 \begin_layout Standard
8606 A complete user guide is contained in that package and you should familiarize
8607 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8610 will not reduce the need to figure out all the AAS\SpecialChar TeX
8611 commands, it will only
8612 reduce the drudgery of typing everything in.
8613 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8615 completely to the requirements of the journal to which you are submitting
8619 \begin_layout Subsection
8620 Starting a New Paper
8623 \begin_layout Standard
8624 I strongly suggest that you start with the AAS\SpecialChar TeX
8628 File\SpecialChar menuseparator
8635 , enter the new file name, then choose the
8640 This will show the most common fields found in a manuscript.
8641 Simply overwrite the existing text (including the brackets,
8645 ) with the correct information.
8646 Many of the AAS\SpecialChar TeX
8647 commands and environments can be implemented directly in
8649 , but some cannot: most noticeably
8661 , which should stick out like a sore thumb if you actually just opened the
8663 For commands such as these, the \SpecialChar LaTeX
8664 code must be entered directly and marked
8666 Such commands are referred to as \SpecialChar TeX
8667 code, or Evil Red Text.
8668 I tried to minimize the amount of \SpecialChar TeX
8669 code needed in an AAS\SpecialChar TeX
8671 there is still a bit more required than any of us would like.
8674 \begin_layout Subsection
8675 Finishing Your Paper
8678 \begin_layout Standard
8679 When the paper is finished to your satisfaction and previews/prints correctly,
8681 \begin_inset Quotes eld
8685 \begin_inset Quotes erd
8688 actions which need to be done before you submit it to the journals.
8692 \begin_layout Enumerate
8693 Export your paper as a \SpecialChar LaTeX
8696 File\SpecialChar menuseparator
8697 Export\SpecialChar menuseparator
8705 \begin_layout Enumerate
8710 file with your favorite text editor
8711 \begin_inset Separator parbreak
8718 \begin_layout Enumerate
8719 remove the comment lines before the
8728 \begin_layout Enumerate
8733 usepackage...{fontenc}
8735 line if it appears (usually just after
8750 \begin_layout Enumerate
8751 remove everything between (and including) the
8763 commands, except for any commands you specifically put into the \SpecialChar LaTeX
8765 (which should appear immediately after the
8766 \begin_inset Quotes eld
8769 User specified \SpecialChar LaTeX
8771 \begin_inset Quotes erd
8782 \begin_layout Enumerate
8783 Run the resulting file through \SpecialChar LaTeX
8784 to make sure it still processes correctly.
8787 \begin_layout Enumerate
8788 Reread the journal requirements to make sure your filenames and formats
8792 \begin_layout Enumerate
8796 \begin_layout Subsection
8797 Comments On Specific Commands
8800 \begin_layout Standard
8801 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8808 ) gives a good description of each.
8809 Thus it's probably easiest for me to go down the list as found in the guide
8810 and offer comments where necessary.
8811 So let's begin \SpecialChar ldots
8815 \begin_layout Subsubsection
8816 Things that work as expected
8819 \begin_layout Standard
8820 Because they work as you might expect, I simply list them and the section
8921 begin{thebibliography}
8929 (2.13.2), all the cite commands and their variations (2.13.2), the generic
8930 graphicx figure commands (2.14.1),
8954 (2.15.4, amongst other places),
8981 \begin_layout Standard
8982 The following style options also work correctly:
9003 Simply put them in the
9009 Layout\SpecialChar menuseparator
9015 \begin_layout Subsubsection
9016 Things that work, but require more comment
9019 \begin_layout Standard
9020 The following items work, but require a little more discussion:
9023 \begin_layout Itemize
9024 These items are reserved for use by the journal editors, but you can put
9025 them into the \SpecialChar LaTeX
9026 preamble if you feel compelled to do so:
9059 \begin_layout Itemize
9060 These items may be placed in the \SpecialChar LaTeX
9061 preamble, and are included as blanks in
9083 \begin_layout Itemize
9090 (2.3) – can only be used
9091 \begin_inset Quotes eld
9095 \begin_inset Quotes erd
9098 , not in the middle of a paragraph.
9099 Use \SpecialChar TeX
9100 code if you need to embed it.
9103 \begin_layout Itemize
9110 (2.3) – will have extra {} after it.
9111 This should not cause an error.
9114 \begin_layout Itemize
9121 (2.6) – can only be used
9122 \begin_inset Quotes eld
9126 \begin_inset Quotes erd
9129 , not in the middle of a paragraph.
9130 Use \SpecialChar TeX
9131 code if you need to embed it.
9134 \begin_layout Itemize
9141 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9145 \begin_layout Itemize
9159 \begin_layout Itemize
9166 (2.9) – will have extra {} after it.
9167 This should not cause an error.
9170 \begin_layout Itemize
9177 (2.11) – will have extra {} after it.
9178 This should not cause an error.
9181 \begin_layout Itemize
9188 (2.14.2) – you can insert an optional filename argument by placing the cursor
9189 at the beginning of the text and selecting
9191 Insert\SpecialChar menuseparator
9196 \begin_inset Quotes eld
9200 \begin_inset Quotes erd
9203 inserts an optional argument of the type needed by
9210 Hopefully it will be renamed someday.
9213 \begin_layout Itemize
9226 for the catalog ID optional parameter
9229 \begin_layout Itemize
9242 for the catalog ID optional parameter
9245 \begin_layout Subsubsection
9246 Things not implemented, use \SpecialChar TeX
9250 \begin_layout Standard
9273 setcounter{equation}
9275 (2.12), Journal name abbreviations (2.13.4),
9311 (2.15.4, insert it as the first element in the lefthand cell after where
9313 Don't use any of \SpecialChar LyX
9314 's rules in the table),
9326 (2.15.5), much of Misc (2.17, except
9377 \begin_layout Subsubsection
9378 Things that cannot be implemented
9381 \begin_layout Standard
9383 at least in any meaningful sort of way, so I suggest ignoring them.
9384 They are the references environment (2.13.3), and the deluxetable environment
9386 If you really, really need to use deluxetable, I suggest editing it in
9387 a separate file with a text editor, then using
9389 Insert\SpecialChar menuseparator
9391 \begin_inset space ~
9396 to include it in your \SpecialChar LyX
9402 file to see an example of this.
9405 \begin_layout Subsection
9406 FAQs, Tips, Tricks, and Other Ruminations
9409 \begin_layout Subsubsection
9410 Getting \SpecialChar LyX
9411 and AAS\SpecialChar TeX
9415 \begin_layout Standard
9416 It can be a bit tricky to get \SpecialChar LyX
9417 to recognize a new layout and document class.
9418 When all else fails, do this:
9421 \begin_layout Enumerate
9422 Make certain that \SpecialChar LaTeX
9423 can find AAS\SpecialChar TeX
9425 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9427 directory completely unrelated to \SpecialChar LaTeX
9428 or AAS\SpecialChar TeX
9429 and run \SpecialChar LaTeX
9437 \begin_layout Enumerate
9442 appears in \SpecialChar LyX
9450 \begin_layout Enumerate
9453 Tools\SpecialChar menuseparator
9457 , then restart \SpecialChar LyX
9461 \begin_layout Enumerate
9462 Open a regular new file, not from a template.
9463 Does AAS\SpecialChar TeX
9464 appear in the class list in
9466 Document\SpecialChar menuseparator
9472 \begin_layout Standard
9473 If you get a warning from an existing AAS\SpecialChar TeX
9474 document about not being able
9475 to find the AAS\SpecialChar TeX
9476 layout or a message about
9477 \begin_inset Quotes eld
9480 You should not mix title layouts with normal ones
9481 \begin_inset Quotes erd
9484 , things haven't been installed correctly.
9487 \begin_layout Subsubsection
9489 error processing a table
9492 \begin_layout Standard
9494 , by default, attempts to center the table caption/title.
9495 This seems to produce a bad interaction in AAS\SpecialChar TeX
9496 so you should click somewhere
9497 in the caption/title, then select
9499 Edit\SpecialChar menuseparator
9501 \begin_inset space ~
9515 This took care of it for me.
9518 \begin_layout Subsubsection
9522 \begin_layout Standard
9523 A couple of things: 1) I have noticed some funny spacing in the reference
9524 entries in the text.
9525 When you enter the bibliography item data, make sure their is
9529 space between the last author and the parenthesis setting off the year;
9533 \begin_inset space \thinspace{}
9537 \begin_inset space \space{}
9551 2) Entering the references at all is not obvious.
9552 The easiest thing is to start typing your first reference at the end of
9553 the document, then mark it as type
9558 That will put a small gray box in front of what you just typed.
9559 Click on the box to fill in the rest of the information.
9560 For new references, go to the end of an existing reference and press return.
9561 That will create a new line with its own box, etc.
9564 \begin_layout Subsubsection
9568 \begin_layout Standard
9569 Even though AAS\SpecialChar TeX
9570 provides its own figure commands (
9576 , for example), I much prefer \SpecialChar LaTeX
9577 's standard figure commands (with the default
9586 \begin_inset space ~
9589 commands as \SpecialChar TeX
9590 code into a Figure Float box if you desire, but I never have
9591 much luck getting the layout right.
9592 With the standard graphics, \SpecialChar LyX
9597 usepackage{graphicx}
9599 command into the \SpecialChar LaTeX
9600 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9602 interspersing the figures in the text.
9603 I believe ApJ accepts figures exactly this way now; AJ might still use
9605 \begin_inset Quotes eld
9608 stack everything at the end
9609 \begin_inset Quotes erd
9615 \begin_layout Subsubsection
9616 Things I could have done, but didn't
9619 \begin_layout Standard
9621 \begin_inset Quotes eld
9625 \begin_inset Quotes erd
9628 things I could have implemented, but chose not to.
9629 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9631 even though it is double-spaced in the paper manuscript.
9632 Also, I chose not to make separate layouts for the preprint and preprint2
9634 Since I assume you will spend most of your time in the plain manuscript
9635 mode anyway, I decided not to chew up more disk space with this.
9639 \begin_layout Subsection
9643 \begin_layout Standard
9644 Your mileage may vary.
9645 I've now had papers published by both ApJ and AJ that have had 98% of the
9646 effort done in \SpecialChar LyX
9647 ; the last 2% was the \SpecialChar LaTeX
9648 post-processing and a few cleanups.
9649 I have had no trouble with the submission process, and I'm sure the journals
9650 were never aware that there might be a difference.
9651 So, go forth and publish!
9654 \begin_layout Section
9655 AMS \SpecialChar LaTeX
9659 \begin_layout Standard
9669 \begin_layout Standard
9670 \begin_inset VSpace bigskip
9676 \begin_layout Standard
9678 The AMS \SpecialChar LaTeX
9679 layouts are set up to conform to suggested styles for mathematical
9680 papers to be submitted to American Mathematical Society publications.
9681 The layouts are not tailored to a specific journal, but easily can be.
9682 You should refer to the AMS documentation for specific instructions for
9683 each journal (usually it will entail only changing a single line in the
9686 That documentation is available on the Web at
9687 \begin_inset Flex URL
9690 \begin_layout Plain Layout
9698 \begin_inset Flex URL
9701 \begin_layout Plain Layout
9703 ftp://ftp.ams.org/pub/tex/amslatex/
9709 These layouts are appropriate, and useful, for any mathematical writing.
9713 \begin_layout Standard
9714 There are two basic AMS \SpecialChar LaTeX
9718 \begin_layout Itemize
9719 amsart: The standard AMS article format.
9722 \begin_layout Itemize
9723 amsbook: the standard AMS book (really, monograph) format.
9727 \begin_layout Standard
9728 The layouts themselves contain only the minimum necessary to use the AMS
9730 They do not, in particular, contain any of the `theorem' environments used
9731 for setting theorems, lemmas, and the like.
9732 These are contained, instead, in the
9733 \begin_inset Flex Code
9736 \begin_layout Plain Layout
9742 module, which is loaded by default when you select one of the AMS classes.
9743 (It can also be used with other classes and can be removed, if you would
9744 rather use something else.) Less commonly used environments are in the
9745 \begin_inset Flex Code
9748 \begin_layout Plain Layout
9749 Theorems (AMS-Extended)
9754 module, which must be loaded manually.
9757 \begin_layout Standard
9758 By default, theorems and the like are numbered consecutively throughout
9759 the document, but this may be modified by loading the module
9760 \begin_inset Flex Code
9763 \begin_layout Plain Layout
9764 Theorems (Order by Section)
9769 or, if you are using
9770 \begin_inset Flex Code
9773 \begin_layout Plain Layout
9780 \begin_inset Flex Code
9783 \begin_layout Plain Layout
9784 Theorems (Order by Chapter)
9790 These will number the results as
9791 \begin_inset Formula $n.m$
9794 , where the first number refers to the section (or chapter) and the second
9795 refers to the total number of results so far in that section (or chapter).
9796 Many environments are also available unnumbered.
9797 These are indicated by an asterisk at the end.
9798 If you happen to want
9802 unnumbered results, the module
9803 \begin_inset Flex Code
9806 \begin_layout Plain Layout
9812 provides that option.
9815 \begin_layout Standard
9816 Note that these modules do not
9820 to be used with the AMS classes.
9821 It is perfectly possible to use the
9822 \begin_inset Flex Code
9825 \begin_layout Plain Layout
9831 module, and the others mentioned, with other classes, such as
9832 \begin_inset Flex Code
9835 \begin_layout Plain Layout
9842 \begin_inset Flex Code
9845 \begin_layout Plain Layout
9852 \begin_inset Flex Code
9855 \begin_layout Plain Layout
9864 \begin_layout Subsection
9865 What these layouts provide
9868 \begin_layout Standard
9869 There is a long list of included environments provided by these layouts.
9870 In AMS-\SpecialChar LaTeX
9871 , there is, in fact, an opportunity to define an unlimited variety
9872 of `theorem' environments.
9873 However, the AMS recommends the environments that are available in \SpecialChar LyX
9878 \begin_layout Standard
9879 The following environments—as well as the standard environments, such as
9881 \begin_inset Flex Noun
9884 \begin_layout Plain Layout
9891 \begin_inset Flex Noun
9894 \begin_layout Plain Layout
9901 \begin_inset Flex Noun
9904 \begin_layout Plain Layout
9911 \begin_inset Flex Noun
9914 \begin_layout Plain Layout
9921 \begin_inset Flex Noun
9924 \begin_layout Plain Layout
9931 \begin_inset Flex Code
9934 \begin_layout Plain Layout
9941 \begin_inset Flex Code
9944 \begin_layout Plain Layout
9953 \begin_layout Description
9954 Address This should be the author's permanent address.
9957 \begin_layout Description
9959 \begin_inset space ~
9962 Address This should be the author's temporary address at the time of submission,
9963 if different from the Address.
9966 \begin_layout Description
9967 Email Author's e-mail address
9970 \begin_layout Description
9971 URL Author's Web address, if desired.
9974 \begin_layout Description
9975 Keywords Key words or phrases used to identify specific topics discussed
9979 \begin_layout Description
9980 Subjectclass These refer to the AMS Subject Classifications, published and
9983 Mathematical Reviews
9986 These are also available online at the AMS cites listed above.
9989 \begin_layout Description
9993 \begin_layout Description
9997 \begin_layout Description
10001 \begin_layout Standard
10002 The following environments are provided by both the
10003 \begin_inset Flex Code
10006 \begin_layout Plain Layout
10013 \begin_inset Flex Code
10016 \begin_layout Plain Layout
10022 modules, in the latter case in both starred (unnumbered) and unstarred
10023 (numbered) versions.
10024 These same environments are provided only in the starred versions by the
10026 \begin_inset Flex Code
10029 \begin_layout Plain Layout
10038 \begin_layout Theorem
10039 This is typically used for the statements of major results.
10043 \begin_layout Corollary*
10044 This is used for statements which follow fairly directly from previous statement
10046 Again, these can be major results.
10050 \begin_layout Lemma
10051 These are smaller results needed to prove other statements.
10054 \begin_layout Proposition
10055 These are less major results which (hopefully) add to the general theory
10059 \begin_layout Conjecture
10060 These are statements provided without justification, which the author does
10061 not know how to prove, but which seem to be true (to the author, at least).
10064 \begin_layout Definition*
10065 Guess what this is for.
10066 The font is different for this environment than for the previous ones.
10070 \begin_layout Example*
10071 Used for examples illustrating proven results.
10074 \begin_layout Problem
10075 It's not really known what this is for.
10076 You should figure it out.
10079 \begin_layout Exercise*
10080 Write a description for this one.
10083 \begin_layout Remark
10084 This environment is also a type of theorem, usually a lesser sort of observation.
10087 \begin_layout Claim*
10088 Often used in the course of giving a proof of a larger result.
10092 Generally, these are used to break up long arguments, using specific instances
10098 The numbering scheme for cases is on its own, not together with other numbered
10103 \begin_layout Proof
10104 At the end of this environment, a QED symbol (usually a square, but it can
10105 vary with different styles) is placed.
10106 If you want to have other environments within this one—for example, Case
10107 environments—and have the QED symbol appear only after them, then the other
10108 environments need to be nested within the proof environment.
10111 Nesting Environments
10117 for information on nesting.
10120 \begin_layout Standard
10121 And these environments are provided by
10122 \begin_inset Flex Code
10125 \begin_layout Plain Layout
10126 Theorems (AMS-Extended)
10134 \begin_layout Criterion*
10135 A required condition.
10138 \begin_layout Algorithm*
10139 A general procedure to be used.
10142 \begin_layout Axiom*
10143 This is a property or statement taken as true within the system being discussed.
10146 \begin_layout Condition*
10147 Sometimes used to state a condition assumed within the present context of
10151 \begin_layout Note*
10152 Similar to a Remark.
10155 \begin_layout Notation*
10156 Used for the explanation of, yes, notation.
10159 \begin_layout Summary
10160 Do we really need to tell you?
10163 \begin_layout Acknowledgement*
10167 \begin_layout Conclusion*
10168 Sometimes used at the end of a long train of argument.
10172 Used in a way similar to Proposition, though perhaps lower on the scale.
10175 \begin_layout Standard
10176 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10179 They need to be available on your system in order to use these environments.
10182 \begin_layout Section
10190 \begin_layout Standard
10196 \begin_layout Subsection
10200 \begin_layout Standard
10201 These are the layout files for some of the journals of the American Geophysical
10203 It is assumed that you have both the AGU's own class files and AGUplus
10204 installed (everything to be found at
10205 \begin_inset Flex URL
10208 \begin_layout Plain Layout
10210 ftp://ftp.agu.org/journals/latex/journals
10218 \begin_layout Subsection
10222 \begin_layout Standard
10232 They are still called this in the \SpecialChar LyX
10233 GUI, though their \SpecialChar LaTeX
10246 \begin_layout Standard
10247 Newly defined styles are
10284 These are mostly manuscript attributes and defined in the AGU class documentati
10288 \begin_layout Standard
10289 I suspect this is still badly incomplete.
10292 \begin_layout Subsection
10296 \begin_layout Standard
10313 \begin_layout Subsection
10317 \begin_layout Itemize
10320 Journal of Geophysical Research
10329 \begin_layout Standard
10330 Add your own, it isn't so hard! Look at the
10341 \begin_layout Subsection
10342 Bugs and things to remember
10345 \begin_layout Standard
10346 In order to use the new layouts, you must remember to do the following for
10350 \begin_layout Enumerate
10356 This can be done in the
10358 Layout\SpecialChar menuseparator
10363 Document\SpecialChar menuseparator
10367 (AGU articles are always in English, right? So
10371 choose a language.)
10374 \begin_layout Enumerate
10379 into the document's
10384 (Yes, this is a bug.)
10387 \begin_layout Enumerate
10388 Make sure you use the
10392 bibliography style, by entering
10396 into the second field of the Bib\SpecialChar TeX
10398 None of the standard styles will do.
10401 \begin_layout Section
10405 \begin_layout Standard
10411 \begin_layout Subsection
10415 \begin_layout Standard
10416 Broadway is for writing plays.
10417 The format is more decorative than Hollywood, and much less standardized.
10418 This format should be suitable for workshops.
10421 \begin_layout Subsection
10425 \begin_layout Standard
10426 The same as in Hollywood.
10429 \begin_layout Subsection
10433 \begin_layout Standard
10438 names as labels then cross-reference the label to insert the name.
10439 The cross-reference dialog will show the current cast of characters.
10442 \begin_layout Subsection
10443 Paper size and Margins
10446 \begin_layout Standard
10447 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10450 \begin_layout Subsection
10454 \begin_layout Standard
10455 The following environments are available.
10456 You can use broadway.bind to get the bind keys shown at the right.
10459 \begin_layout Itemize
10463 \begin_inset Newline newline
10468 You should not have to use this, but it is here for anything that does not
10472 \begin_layout Itemize
10476 \begin_inset space \hfill{}
10480 \begin_inset Newline newline
10485 Used to describe stage setting and the action.
10486 First use of speaker names in all CAPs.
10489 \begin_layout Itemize
10493 \begin_inset space \hfill{}
10497 \begin_inset Newline newline
10502 Automatically numbered.
10503 On screen it will be arabic, but will print as Roman.
10506 \begin_layout Itemize
10510 \begin_inset space \hfill{}
10514 \begin_inset Newline newline
10524 It is just centered text.
10527 \begin_layout Itemize
10531 \begin_inset space \hfill{}
10535 \begin_inset Newline newline
10540 Not automatically numbered.
10541 You supply the number.
10542 This is because I couldn't figure out how.
10545 \begin_layout Itemize
10549 \begin_inset space \hfill{}
10553 \begin_inset Newline newline
10558 A special case of Narrative to describe the setting and action as the curtain
10562 \begin_layout Itemize
10566 \begin_inset space \hfill{}
10570 \begin_inset Newline newline
10575 The speaker's (actor's) title, centered in all CAPS.
10578 \begin_layout Itemize
10582 \begin_inset space \hfill{}
10586 \begin_inset Newline newline
10591 Instructions to the speaker.
10592 The parentheses are automatically inserted.
10593 The ( will appear on screen, but both will be in the printed play.
10594 This environment is only used within
10601 \begin_layout Itemize
10605 \begin_inset space \hfill{}
10609 \begin_inset Newline newline
10614 What the Speaker says.
10617 \begin_layout Itemize
10621 \begin_inset space \hfill{}
10625 \begin_inset Newline newline
10630 The curtain comes down.
10633 \begin_layout Itemize
10637 \begin_inset space \hfill{}
10643 \begin_layout Itemize
10647 \begin_inset space \hfill{}
10653 \begin_layout Itemize
10657 \begin_inset space \hfill{}
10663 \begin_layout Standard
10667 \begin_layout Section
10671 \begin_layout Standard
10676 can be used to type letters according to German conventions.
10677 A template file is included in
10679 .../lyx/share/templates
10681 for you to use as a starting point.
10684 \begin_layout Section
10692 \begin_layout Standard
10698 \begin_layout Subsection
10702 \begin_layout Standard
10703 This is the layout file for the European Geophysical Society journals.
10708 can be downloaded from the web site of the EGS under
10709 \begin_inset Flex URL
10712 \begin_layout Plain Layout
10722 \begin_layout Subsection
10726 \begin_layout Standard
10729 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10737 The current layout file is unfortunately very unmodular and would benefit
10738 from using the various
10745 \begin_layout Section
10749 \begin_layout Standard
10750 See the \SpecialChar LyX
10756 It contains all infos you need.
10759 \begin_layout Section
10762 Foil\SpecialChar TeX
10766 \begin_inset CommandInset label
10775 \begin_layout Standard
10781 \begin_layout Subsection
10785 \begin_layout Standard
10786 This section describes how to use \SpecialChar LyX
10787 to make slides for overhead projectors.
10788 There are two document classes that can do this: the default slides class
10791 Foil\SpecialChar TeX
10795 This section documents the latter.
10798 \begin_layout Standard
10799 I'm going to say this again, nice and clear, so that there's no misunderstanding
10803 \begin_layout Standard
10804 \begin_inset VSpace bigskip
10810 \begin_layout Standard
10814 This section documents the class
10815 \begin_inset Quotes eld
10821 \change_inserted -712698321 1437633339
10823 \change_deleted -712698321 1437633344
10830 \begin_inset Quotes erd
10838 \begin_layout Standard
10839 \begin_inset VSpace bigskip
10845 \begin_layout Standard
10846 If you're looking for the documentation for
10847 \begin_inset Quotes eld
10855 \begin_inset Quotes erd
10858 , check out section
10859 \begin_inset space ~
10863 \begin_inset CommandInset ref
10865 reference "sec:slitex"
10870 If your machine doesn't have the
10875 \begin_inset Quotes eld
10881 \change_inserted -712698321 1437633364
10883 \change_deleted -712698321 1437633362
10890 \begin_inset Quotes erd
10893 ] installed, you'll probably have to use the default
10897 class, which isn't quite as good as
10902 \begin_layout Standard
10907 class is designed for use with version 2.1 of the
10912 class file which is now an integral part of \SpecialChar LaTeX2e
10916 \begin_layout Subsection
10920 \begin_layout Standard
10921 Obviously, to use this document class, you need to select
10922 \begin_inset Quotes eld
10928 \change_inserted -712698321 1437633373
10930 \change_deleted -712698321 1437633373
10937 \begin_inset Quotes erd
10947 \begin_inset space ~
10953 There are some settings in the
10956 \begin_inset space ~
10961 dialog that you should know about that are specific to this class:
10964 \begin_layout Itemize
10965 Don't change the options
10976 \begin_inset space ~
10982 They're ignored by the
10989 \begin_layout Itemize
10990 The default font size is 20
10991 \begin_inset space \thinspace{}
10994 pt with the other options being 17
10995 \begin_inset space \thinspace{}
10999 \begin_inset space \thinspace{}
11003 \begin_inset space \thinspace{}
11009 \begin_layout Itemize
11010 The default font is
11018 but all math equations are still typeset in the usual roman font.
11021 \begin_layout Itemize
11024 Foil\SpecialChar TeX
11027 supports A4 and Letter paper sizes as well as a special size for working
11029 \begin_inset space \thinspace{}
11033 It doesn't support A5, B5, legal or executive paper sizes.
11036 \begin_layout Itemize
11037 Don't bother changing the
11041 settings because they are ignored anyway.
11042 All floats appear where they are defined in the text.
11045 \begin_layout Itemize
11050 setting behaves a bit differently for this class.
11053 Foil\SpecialChar TeX
11056 provides extensive footer and header capabilities including a user-defined
11059 \begin_inset space ~
11063 \begin_inset CommandInset ref
11065 reference "sec:foilfoot"
11070 The title page is treated differently to all other pages in the document
11079 has the logo centered at the bottom of the page (if one is defined).
11080 The possible page style choices and what they do are as follows:
11081 \begin_inset Separator parbreak
11088 \begin_layout Labeling
11089 \labelwidthstring MMMMMMM
11096 The final output contains no page numbers, or other headers or footers
11097 (except footnotes of course).
11101 \begin_layout Labeling
11102 \labelwidthstring MMMMMMM
11109 The final output contains page numbers centered at the bottom of the page.
11110 No other headings or footers (other than footnotes).
11113 \begin_layout Labeling
11114 \labelwidthstring MMMMMMM
11119 Page numbers in lower right corner.
11120 Additional headers and footers are also shown.
11121 This is also the default.
11124 \begin_layout Labeling
11125 \labelwidthstring MMMMMMM
11130 Gives you access to the
11134 package although its use with
11136 Foil\SpecialChar TeX
11139 is discouraged by the writer of the
11141 Foil\SpecialChar TeX
11144 package because of some potential page layout clashes.
11148 \begin_layout Subsubsection
11152 \begin_layout Standard
11153 The following options may be used in the extra class options in the
11155 Document\SpecialChar menuseparator
11161 \begin_layout Labeling
11162 \labelwidthstring MMMMMMx
11167 This sets up the page layout for 7.33
11168 \begin_inset space \thinspace{}
11172 \begin_inset space \thinspace{}
11175 in paper, which is about the same aspect ratio as a 35
11176 \begin_inset space \thinspace{}
11179 mm slide, making it a bit easier to work with this medium.
11182 \begin_layout Labeling
11183 \labelwidthstring MMMMMMx
11188 Places a rule across the page below the header on every page except the
11192 \begin_layout Labeling
11193 \labelwidthstring MMMMMMx
11198 Places a rule across the page above the footer on every page except the
11202 \begin_layout Labeling
11203 \labelwidthstring MMMMMMx
11208 This is automatically set each time you create a new
11215 Foil\SpecialChar TeX
11218 to use the dvips driver to rotate those pages that are set as landscape
11222 \begin_layout Labeling
11223 \labelwidthstring MMMMMMx
11228 Simply changes the page dimensions to those of a landscape page but doesn't
11230 Thus if you use this option you need to use an external program to rotate
11231 each page or feed your paper through your printer as landscape.
11232 Note that this option effectively reverses the roles of the
11240 environments (don't worry these are described in the next section).
11243 \begin_layout Labeling
11244 \labelwidthstring MMMMMMx
11249 Equation numbers on the left.
11252 \begin_layout Labeling
11253 \labelwidthstring MMMMMMx
11258 Flush-left equations.
11261 \begin_layout Subsection
11262 Supported Environments
11265 \begin_layout Standard
11266 Most of the environments commonly supported in other classes are also supported
11272 There are several additional environments provided by
11274 Foil\SpecialChar TeX
11277 as well as a couple added by \SpecialChar LyX
11279 The following environments are shared with other classes:
11282 \begin_layout Standard
11283 \begin_inset Flex Multiple Columns
11286 \begin_layout Itemize
11292 \begin_layout Itemize
11298 \begin_layout Itemize
11304 \begin_layout Itemize
11310 \begin_layout Itemize
11316 \begin_layout Itemize
11323 \begin_layout Itemize
11329 \begin_layout Itemize
11335 \begin_layout Itemize
11341 \begin_layout Itemize
11347 \begin_layout Itemize
11353 \begin_layout Itemize
11359 \begin_layout Itemize
11365 \begin_layout Itemize
11371 \begin_layout Itemize
11377 \begin_layout Itemize
11383 \begin_layout Itemize
11389 \begin_layout Itemize
11400 \begin_layout Standard
11401 That is, all the major environments apart from the sectioning environments.
11402 Since foils are essentially self-contained sections, with a title and body,
11405 Foil\SpecialChar TeX
11408 provides specific commands for starting new foils and these are:
11411 \begin_layout Itemize
11417 \begin_layout Itemize
11423 \begin_layout Standard
11425 also provides slightly modified versions of these two environments called:
11428 \begin_layout Itemize
11434 \begin_layout Itemize
11437 ShortRotatefoilhead
11440 \begin_layout Standard
11441 and the differences will be explained in the next section.
11444 \begin_layout Standard
11445 Since foils are often used in presenting ideas or new theorems and such
11448 Foil\SpecialChar TeX
11451 also provides a comprehensive box of goodies for presenting them:
11454 \begin_layout Standard
11455 \begin_inset Flex Multiple Columns
11458 \begin_layout Itemize
11464 \begin_layout Itemize
11470 \begin_layout Itemize
11476 \begin_layout Itemize
11482 \begin_layout Itemize
11488 \begin_layout Itemize
11494 \begin_layout Itemize
11500 \begin_layout Itemize
11506 \begin_layout Itemize
11512 \begin_layout Itemize
11518 \begin_layout Itemize
11529 \begin_layout Standard
11530 The starred versions are unnumbered while the unstarred versions are numbered.
11531 There are also two list environments added by \SpecialChar LyX
11535 \begin_layout Itemize
11541 \begin_layout Itemize
11547 \begin_layout Standard
11550 Foil\SpecialChar TeX
11553 provides some powerful header and footer capabilities that are best set
11554 in the preamble although they may be set at any point in a document.
11555 If you want to change these settings in your document the best place to
11556 do so is at the very top of a foil, i.
11557 \begin_inset space \thinspace{}
11563 \begin_inset space \space{}
11568 straight after the foilhead.
11571 \begin_layout Standard
11572 For this purpose, the following command styles are provided [
11579 \begin_layout Standard
11580 \begin_inset Flex Multiple Columns
11583 \begin_layout Itemize
11587 \begin_inset space ~
11593 \begin_layout Itemize
11599 \begin_layout Itemize
11603 \begin_inset space ~
11609 \begin_layout Itemize
11613 \begin_inset space ~
11619 \begin_layout Itemize
11623 \begin_inset space ~
11629 \begin_inset Separator parbreak
11636 \begin_layout Plain Layout
11637 \begin_inset space ~
11649 \begin_layout Standard
11650 There are also a few commands provided by
11652 Foil\SpecialChar TeX
11655 that aren't directly supported by \SpecialChar LyX
11656 but I'll tell you what they do and how
11657 to use them in section
11658 \begin_inset space ~
11662 \begin_inset CommandInset ref
11664 reference "sec:unsuppfoils"
11671 \begin_layout Subsection
11672 Building a Set of Foils
11675 \begin_layout Standard
11676 This section will give a simple introduction to using the different environments
11677 to build a set of foils.
11678 If you want to see an example set of foils, take a look at the
11682 file you find in \SpecialChar LyX
11690 \begin_layout Subsubsection
11691 Give It a Title Page
11694 \begin_layout Standard
11695 Unlike other classes that provide
11715 creates the title on a page of its own.
11716 If you leave out the
11720 environment \SpecialChar LaTeX
11721 will substitute the current date (every time you regenerate
11725 \begin_layout Subsubsection
11729 \begin_layout Standard
11730 As I mentioned earlier, there are four ways of starting a new foil.
11731 For portrait foils you should use
11740 The difference between these two environments is the amount of space between
11741 the title of the foil (the foilhead) and the body of the foil.
11744 \begin_layout Standard
11745 Landscape foils are generated using the
11751 ShortRotatefoilhead
11754 Again the only difference is the spacing between foilhead and body.
11755 Both of the short versions have 0.5
11756 \begin_inset space ~
11759 inches less separation between the foilhead and the body.
11763 \begin_layout Standard
11764 One problem with the support for landscape foils is the requirement that
11765 you have to use the
11769 driver to generate the PostScript output otherwise the foils won't be rotated.
11770 It is possible to get landscape foils even if you haven't got the
11774 driver provided you can feed your foils sideways through your printer ;-)
11777 \begin_layout Subsubsection
11778 Theorems, Lemmas, Proofs and more
11781 \begin_layout Standard
11782 Due to a small bug in \SpecialChar LyX
11783 you can't have two of the same type of these environments
11784 directly following each other.
11785 They must be separated by something.
11786 If you try, you will just be extending the previous environment as if you
11787 had merged the two environments together.
11788 So, how do you get around this problem? The simplest option is to insert
11789 some text between the two environments or add a
11794 environment between the two with just a
11795 \begin_inset Quotes eld
11803 \begin_inset Quotes erd
11807 This will force \SpecialChar LyX
11808 to produce two separate environments and hence the correct
11811 An example is provided in the example file included with the \SpecialChar LyX
11813 Remember, this problem only occurs if you are trying to place two of the
11814 same type of theorem-like environments one directly after the other.
11817 \begin_layout Subsubsection
11821 \begin_layout Standard
11822 You get all the commonly supported list styles found in other classes as
11823 well as two new ones.
11824 I'll only describe the new ones here.
11825 If you want to find out more about the other list environments check out
11831 If you intend to use itemized lists you might also want to read about the
11835 \begin_inset space ~
11839 \begin_inset space ~
11844 dialog described above in section
11845 \begin_inset space ~
11849 \begin_inset CommandInset ref
11851 reference "sec:bullet"
11858 \begin_layout Standard
11859 The two new list styles,
11867 , are designed to make it easier for you to create lists of do's and don'ts
11868 or right and wrong by providing dedicated environments that use a tick
11869 or a cross as the label of the list.
11870 These lists are in fact dedicated variants of the
11875 They do however require that you have the
11879 packages installed.
11882 \begin_layout Subsubsection
11886 \begin_layout Standard
11889 Foil\SpecialChar TeX
11892 redefines the floating tables and figures so that they appear exactly where
11893 they are in the text rather than pushing them to the top of the page or
11894 to some user specified location.
11895 In fact if you change the float placement settings they are simply ignored.
11898 \begin_layout Subsubsection
11899 Page Headers and Footers
11900 \begin_inset CommandInset label
11902 name "sec:foilfoot"
11909 \begin_layout Standard
11913 \begin_inset space ~
11922 are two commands used to control the left-footer text string.
11923 The first is meant to allow you to include a graphic logo on your foils
11925 \begin_inset Quotes eld
11930 Foil\SpecialChar TeX
11934 \begin_inset Quotes erd
11938 While the second is meant to provide a classification for the audience,
11942 \begin_inset space \thinspace{}
11948 \begin_inset space \space{}
11952 It is empty by default.
11955 \begin_layout Standard
11956 The remaining page corners can be filled by
11959 \begin_inset space ~
11964 (which defaults to page numbers),
11967 \begin_inset space ~
11975 \begin_inset space ~
11983 \begin_layout Subsection
11986 Foil\SpecialChar TeX
11990 \begin_inset CommandInset label
11992 name "sec:unsuppfoils"
11999 \begin_layout Standard
12000 All the commands mentioned below need to be set in a
12010 within another environment.
12013 \begin_layout Subsubsection
12017 \begin_layout Standard
12018 All lengths are adjusted using the
12041 should be replaced by the name given to the length you want to change and
12046 is the length value.
12047 All lengths should be specified in units of length such as inches (
12059 ) or relative to some document or font-based length such as
12069 \begin_layout Standard
12070 It's possible to change the spacing between a foilhead and the body of the
12071 foil by adjusting the length specified by
12078 For example, to make
12083 \begin_inset space \space{}
12086 in closer to their bodies put the following in the preamble:
12092 foilheadskip}{-0.5in}
12095 \begin_layout Standard
12096 The spacings around floats can be adjusted by setting these lengths:
12099 \begin_layout Labeling
12100 \labelwidthstring MMMMMMMMMMM
12107 Separation between the text and the top of the float
12110 \begin_layout Labeling
12111 \labelwidthstring MMMMMMMMMMM
12118 Separation between the float and the caption
12121 \begin_layout Labeling
12122 \labelwidthstring MMMMMMMMMMM
12129 Separation between the caption and the following text
12132 \begin_layout Labeling
12133 \labelwidthstring MMMMMMMMMMM
12140 You can make the captions narrower than the surrounding text by adjusting
12142 Best done relative to
12151 \begin_layout Standard
12152 There are also several title page related lengths that you may find useful
12153 if you have a long title or several authors:
12156 \begin_layout Labeling
12157 \labelwidthstring MMMMMMMMMMM
12164 Separation from headers to
12169 \begin_layout Labeling
12170 \labelwidthstring MMMMMMMMMMM
12188 \begin_layout Labeling
12189 \labelwidthstring MMMMMMMMMMM
12203 \begin_layout Labeling
12204 \labelwidthstring MMMMMMMMMMM
12220 \begin_layout Labeling
12221 \labelwidthstring MMMMMMMMMMM
12237 \begin_layout Standard
12238 The last length related command affects all the list environments.
12249 a list environment then all the vertical spacing between the list items
12251 Note that this is a command not a length so it doesn't require
12257 like the stuff mentioned above.
12260 \begin_layout Subsubsection
12261 Headers and Footers
12264 \begin_layout Standard
12277 commands control whether the logo in the
12281 definition appear on a given page.
12288 in the preamble then none of the foils will have the logo on them.
12289 If you don't want the logo on a particular page place the
12295 directly after the foilhead of that page and the
12301 directly after the next foilhead.
12304 \begin_layout Standard
12305 If you decide to use the
12309 page style setting in the
12312 \begin_inset space ~
12317 dialog you should probably add
12327 to your preamble so headers and footers on landscape pages are correctly
12328 placed when rotated.
12329 This is due to some clashes between the page layouts provided by the
12340 \begin_layout Section
12341 Hollywood (Hollywood spec scripts)
12344 \begin_layout Standard
12350 \begin_layout Subsection
12354 \begin_layout Standard
12355 Getting the format of a Hollywood script right is a
12356 \begin_inset Quotes eld
12360 \begin_inset Quotes erd
12363 It is designed to make the readers focus on content and to be easy and
12364 familiar for the actors to read.
12365 Each page of a script should be one minute of film.
12366 Nothing goes in a script that you cannot see or hear on screen.
12367 The courier 12 pt font should be used throughout.
12371 \begin_layout Subsection
12375 \begin_layout Standard
12376 Speakers' lines should NEVER break in mid-sentence.
12377 If a speaker's lines continue over a page break, repeat the
12381 title followed by (Cont'd).
12384 \begin_layout Subsection
12388 \begin_layout Standard
12393 names as labels then cross-reference the label to insert the name.
12394 The cross-reference dialog will show the current cast of characters.
12395 You can use this to insert the speaker name in narratives also.
12398 \begin_layout Subsection
12399 Paper size and Margins
12402 \begin_layout Standard
12403 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12406 \begin_layout Subsection
12410 \begin_layout Standard
12411 The following environments are available.
12412 You can use hollywood.bind to get the bind keys shown at the right.
12415 \begin_layout Itemize
12419 \begin_inset Newline newline
12424 Used where nothing else works.
12428 \begin_layout Itemize
12434 \begin_inset space \hfill{}
12442 \begin_inset Newline newline
12445 Usually followed by something like
12446 \begin_inset Quotes eld
12449 on Sally waking up.
12450 \begin_inset Quotes erd
12456 \begin_layout Itemize
12460 \begin_inset space \hfill{}
12464 \begin_inset Newline newline
12469 Introduces a new INTERIOR camera set-up.
12470 Always followed by DAY or NIGHT, or something similar to define the lighting
12472 Everthing on this line in CAPS.
12475 \begin_layout Itemize
12479 \begin_inset space \hfill{}
12483 \begin_inset Newline newline
12488 Introduces a new EXTERIOR camera set-up.
12489 Everthing on this line in CAPS.
12492 \begin_layout Itemize
12496 \begin_inset space \hfill{}
12500 \begin_inset Newline newline
12505 The character speaking.
12508 \begin_layout Itemize
12512 \begin_inset space \hfill{}
12516 \begin_inset Newline newline
12521 Instructions to the speaker.
12522 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12524 Both will be printed.
12527 \begin_layout Itemize
12531 \begin_inset space \hfill{}
12535 \begin_inset Newline newline
12547 \begin_layout Itemize
12551 \begin_inset space \hfill{}
12555 \begin_inset Newline newline
12560 Camera movement instruction.
12562 \begin_inset space \thinspace{}
12566 \begin_inset space \space{}
12572 \begin_layout Itemize
12576 \begin_inset space \hfill{}
12582 \begin_layout Itemize
12586 \begin_inset space \hfill{}
12592 \begin_layout Itemize
12596 \begin_inset space \hfill{}
12602 \begin_layout Itemize
12606 \begin_inset space \hfill{}
12612 \begin_layout Subsection
12616 \begin_layout Itemize
12620 \begin_layout Itemize
12624 \begin_layout Itemize
12626 \begin_inset space \thinspace{}
12633 \begin_layout Itemize
12638 \begin_layout Itemize
12639 PAN — camera movement
12642 \begin_layout Itemize
12643 INSERT — cut to close-up of
12646 \begin_layout Section
12650 \begin_layout Standard
12653 Panayotis Papasotiriou
12656 \begin_layout Subsection
12660 \begin_layout Standard
12661 The ijmpc package is a set of macros that facilitates electronic manuscript
12664 International Journal of Modern Physics C
12667 Similarly, the ijmpd package is for creating manuscripts to be submitted
12670 International Journal of Modern Physics D
12673 Both journals are published by World Scientific.
12674 The corresponding document classes are named
12683 These files, together with instructions for the authors, can be downloaded
12685 \begin_inset Flex URL
12688 \begin_layout Plain Layout
12690 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12696 \begin_inset Flex URL
12699 \begin_layout Plain Layout
12701 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12707 Both packages are modified versions of the standard
12708 \begin_inset Quotes eld
12712 \begin_inset Quotes erd
12715 package, and they are almost (but not exactly) identical.
12716 Most of their features are supported by \SpecialChar LyX
12718 I have used \SpecialChar LyX
12719 successfully to write articles submitted to both journals
12720 without any problem.
12723 \begin_layout Subsection
12727 \begin_layout Standard
12728 As usual, the easiest way to write a paper is to start with a template.
12731 File\SpecialChar menuseparator
12750 This will give an (almost) empty document that includes the most common
12751 fields found in a manuscript.
12752 Simply overwrite the existing text (including the brackets,
12757 You should keep in mind the following remarks.
12760 \begin_layout Enumerate
12762 won't let you change the font size and the page style of the document,
12763 because such modifications are not allowed by both packages.
12766 \begin_layout Enumerate
12767 The language of the document should not be changed.
12768 Before previewing your paper, be sure that the babel package is not used.
12769 To do this, click on
12771 Tools\SpecialChar menuseparator
12782 checkbox in the language settings, and click on
12790 , if you wish to make this change permanent).
12793 \begin_layout Enumerate
12795 \begin_inset Quotes eld
12799 \begin_inset Quotes erd
12802 style must be used to define keywords.
12805 \begin_layout Enumerate
12806 The ijmpc package provides a style named
12807 \begin_inset Quotes eld
12810 Classification Codes
12811 \begin_inset Quotes erd
12814 , which can be used to define classification codes, such as PACS numbers.
12815 Note that this facility is not supported by the ijmpd package.
12818 \begin_layout Enumerate
12819 Several new environments are available:
12820 \begin_inset Quotes eld
12824 \begin_inset Quotes erd
12828 \begin_inset Quotes eld
12832 \begin_inset Quotes erd
12836 \begin_inset Quotes eld
12840 \begin_inset Quotes erd
12844 \begin_inset Quotes eld
12848 \begin_inset Quotes erd
12852 \begin_inset Quotes eld
12856 \begin_inset Quotes erd
12860 \begin_inset Quotes eld
12864 \begin_inset Quotes erd
12868 \begin_inset Quotes eld
12872 \begin_inset Quotes erd
12876 \begin_inset Quotes eld
12880 \begin_inset Quotes erd
12884 \begin_inset Quotes eld
12888 \begin_inset Quotes erd
12892 \begin_inset Quotes eld
12896 \begin_inset Quotes erd
12900 \begin_inset Quotes eld
12904 \begin_inset Quotes erd
12908 \begin_inset Quotes eld
12912 \begin_inset Quotes erd
12916 \begin_inset Quotes eld
12920 \begin_inset Quotes erd
12924 \begin_inset Quotes eld
12928 \begin_inset Quotes erd
12932 Their use is more or less obvious.
12934 supports all these environments; it will use the proper label, text style,
12935 and numbering scheme for each of them.
12938 \begin_layout Enumerate
12939 Both packages use basic citations; the natbib package should not be used.
12940 In \SpecialChar LyX
12941 , citation references are shown as usual; in the output, citations are
12942 shown as superscripts.
12943 If you want to use a citation as normal text, you should use the
12948 \begin_inset space \thinspace{}
12952 \begin_inset space \space{}
12956 \begin_inset Quotes eld
12960 \begin_inset space \space{}
12970 \begin_inset Quotes erd
12976 \begin_layout Enumerate
12978 \begin_inset Quotes eld
12982 \begin_inset Quotes erd
12985 section in both packages.
12986 To put acknowledgments, just use the
12987 \begin_inset Quotes eld
12991 \begin_inset Quotes erd
12997 \begin_layout Enumerate
12998 Appendices may be added to the paper,
13002 the Acknowledgments and
13008 provides a special environment, called
13009 \begin_inset Quotes eld
13013 \begin_inset Quotes erd
13016 which marks the beginning of the appendices.
13017 This environment should be left blank; it just sends a \SpecialChar LaTeX
13018 command, but nothing
13020 In \SpecialChar LyX
13022 \begin_inset Quotes eld
13026 \begin_inset Quotes erd
13029 is printed with blue letters, as a signal that all sections after that
13030 point are appendices.
13031 To write an appendix, use the
13032 \begin_inset Quotes eld
13036 \begin_inset Quotes erd
13041 will number each appendix with capital letters, as required by both journals.
13043 \begin_inset Quotes eld
13047 \begin_inset Quotes erd
13054 be present before the first appendix; if not, all appendices will be numbered
13055 as normal sections in the output.
13058 \begin_layout Enumerate
13059 The ijmpc and the ijmpd packages use the
13063 command to implement table captions.
13064 As a result, a table created by \SpecialChar LyX
13065 is printed correctly, but its caption
13067 However, you can use some \SpecialChar TeX
13068 code to overcome this problem, so that captions
13069 are printed as expected.
13070 To do so, create a float table as usual, remove the caption, and replace
13071 it with the \SpecialChar TeX
13082 (sic); you must also the \SpecialChar TeX
13087 immediately after the tabular material.
13088 Study the example table included in the template files to see how this
13089 trick is implemented.
13090 Alternatively, If you need table captions, you should implement the whole
13095 file, then include this file to the \SpecialChar LyX
13098 Insert\SpecialChar menuseparator
13099 File\SpecialChar menuseparator
13101 \begin_inset space ~
13107 Details on how to create a table float can be found in the files
13115 , included in the corresponding packages.
13118 \begin_layout Subsection
13119 Preparing a paper for submission
13122 \begin_layout Standard
13123 Before you submit your paper you must export the \SpecialChar LyX
13124 document as a \SpecialChar LaTeX
13127 File\SpecialChar menuseparator
13128 Export\SpecialChar menuseparator
13136 \begin_layout Plain Layout
13137 Actually you have the choice between \SpecialChar LaTeX
13138 (plain) and pdflatex.
13139 If you intend to use pdflatex to prepare the paper, you should use the
13140 pdflatex option so that included graphics are converted to PDF format,
13141 ready for use by pdflatex.
13146 , then make the following changes to the resulting
13153 \begin_layout Enumerate
13154 Remove the comment lines before the
13163 \begin_layout Enumerate
13164 Remove everything between (and including) the
13176 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13180 \begin_layout Standard
13185 file should be saved and processed through \SpecialChar LaTeX
13186 as many times as necessary.
13187 You may also want to check the resulting
13194 \begin_layout Subsection
13195 Use of \SpecialChar TeX
13199 \begin_layout Standard
13200 The use of \SpecialChar TeX
13201 code is reduced to two commands, which must be placed at the
13202 top of the document.
13203 If you started writing your paper by using the
13211 template, the \SpecialChar TeX
13212 code needed is already in its place; you usually don't need
13214 You may only modify the first \SpecialChar TeX
13215 code to specify the information printed
13216 to the top of odd and even pages (authors' names and short paper's title,
13218 This \SpecialChar TeX
13219 code must have the form
13223 markboth{Authors' Names}{Short Paper's Title}
13228 \begin_layout Section
13232 \begin_layout Standard
13238 \begin_layout Subsection
13242 \begin_layout Standard
13243 The iopart package provides a document class to create electronic manuscript
13244 submission to the journals published by the Institute of Physics.
13245 Instructions for the authors how to create a paper using the iopart class
13246 can be downloaded together with the iopart package from the site
13247 \begin_inset Flex URL
13250 \begin_layout Plain Layout
13252 ftp://ftp.iop.org/pub/journals/latex2e
13260 \begin_layout Subsection
13264 \begin_layout Standard
13265 The easiest way to write a paper is to start with the file
13269 that is available in \SpecialChar LyX
13270 's examples files folder.
13271 Open this file, save it under a new name, and start writing.
13272 The example file explains how to use the special text environments.
13273 Here are the most important advices:
13276 \begin_layout Itemize
13277 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13280 Use AMS math package
13282 in the document settings under
13289 \begin_layout Itemize
13292 The title environment defines the kind of your paper.
13293 So use one of the following environments for the title:
13296 \begin_inset Separator parbreak
13303 \begin_layout Itemize
13312 \begin_layout Itemize
13321 \begin_layout Itemize
13327 for a Topical review
13330 \begin_layout Itemize
13339 \begin_layout Itemize
13348 \begin_layout Itemize
13354 for a Paper (same as Title)
13357 \begin_layout Itemize
13363 for a Preliminary communication
13366 \begin_layout Itemize
13372 for a Rapid communication
13375 \begin_layout Itemize
13381 for a Letter to the editor
13385 \begin_layout Itemize
13388 All title environments except of
13392 can have an optional short title.
13395 \begin_layout Itemize
13396 There is a general title environment
13400 which is not directly supported by the \SpecialChar LyX
13402 This can be used as \SpecialChar TeX
13403 code when your document doesn't fit into one of the
13407 \begin_layout Standard
13408 For more informations like hints for special table and formula formatting,
13409 look at the IOP author guidelines.
13412 \begin_layout Section
13416 \begin_layout Standard
13419 Panayotis Papasotiriou
13422 \begin_layout Subsection
13426 \begin_layout Standard
13427 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13428 that facilitates electronic manuscript submission to the journals they
13430 Most known of them (at least in my domain of interest) are
13432 Astrophysics and Space Science
13438 , but there are many others (see a complete list at
13439 \begin_inset Flex URL
13442 \begin_layout Plain Layout
13444 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13450 The Kluwer package may be downloaded from the site
13451 \begin_inset Flex URL
13454 \begin_layout Plain Layout
13456 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13462 A complete user guide is contained in that package (but it can also be
13463 downloaded separately).
13466 \begin_layout Standard
13468 supports many features of the package but not everything.
13469 However, the \SpecialChar TeX
13470 code needed is reduced to some
13471 \begin_inset Quotes eld
13475 \begin_inset Quotes erd
13478 commands of the package (see
13479 \begin_inset space ~
13483 \begin_inset CommandInset ref
13485 reference "subsec:kluwer_peculiarities"
13490 I have recently used \SpecialChar LyX
13491 to write an article submitted to the
13493 Astrophysics and Space Science
13495 without any problem.
13498 \begin_layout Subsection
13502 \begin_layout Standard
13503 The easiest way to write a paper is to start with the Kluwer template file.
13506 File\SpecialChar menuseparator
13518 This will give an (almost) empty document that includes the most common
13519 fields found in a manuscript and a short description of their use.
13520 As in most templates, simply overwrite the existing text (including the
13525 ) with the correct information.
13528 \begin_layout Subsection
13529 Preparing a paper for submission
13532 \begin_layout Standard
13533 As in the AAS\SpecialChar TeX
13534 package, before you submit your paper to a journal you must
13536 \begin_inset Quotes eld
13540 \begin_inset Quotes erd
13546 \begin_layout Enumerate
13547 Export your paper as a \SpecialChar LaTeX
13549 To do this, click on
13551 File\SpecialChar menuseparator
13552 Export\SpecialChar menuseparator
13560 \begin_layout Enumerate
13565 file with a text editor and make the following changes
13566 \begin_inset Separator parbreak
13573 \begin_layout Enumerate
13574 remove the comment lines before the
13583 \begin_layout Enumerate
13584 remove everything between (and including) the
13596 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13600 \begin_layout Standard
13609 \begin_layout Enumerate
13614 file through \SpecialChar LaTeX
13615 as many times as necessary (usually up to three).
13618 \begin_layout Enumerate
13624 \begin_inset space \thinspace{}
13628 \begin_inset space \space{}
13635 , and check if everything is OK (it should, if you didn't make any mistake).
13638 \begin_layout Subsection
13639 \begin_inset Quotes eld
13643 \begin_inset Quotes erd
13646 of the Kluwer package
13647 \begin_inset CommandInset label
13649 name "subsec:kluwer_peculiarities"
13656 \begin_layout Standard
13657 The Kluwer package has the following
13658 \begin_inset Quotes eld
13662 \begin_inset Quotes erd
13668 \begin_layout Enumerate
13669 It is possible to write multiple articles in the same \SpecialChar LaTeX
13674 \begin_layout Plain Layout
13675 I can't imagine any good reason to do this.
13681 Each article must be included in the environment
13682 \begin_inset Quotes eld
13686 \begin_inset Quotes erd
13690 Unfortunately, this environment cannot be omitted, even if you write just
13692 Therefore, each article starts with the command
13698 and, obviously, ends with the command
13705 Although this can be implemented in \SpecialChar LyX
13706 , I didn't included it, since it looks
13707 ugly and can confuse the novice user.
13708 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13711 \begin_inset Quotes eld
13716 \begin_inset Quotes erd
13722 \begin_layout Enumerate
13723 Information given at the beginning of the article (i.
13724 \begin_inset space \thinspace{}
13728 \begin_inset space \space{}
13731 title, subtitle, author, institution, running title, running author, abstract
13732 and keywords) must be included in an environment called
13733 \begin_inset Quotes eld
13737 \begin_inset Quotes erd
13741 This is not implemented in \SpecialChar LyX
13742 , so you must enter title, subtitle etc.
13743 \begin_inset space ~
13746 between two \SpecialChar TeX
13762 \begin_layout Enumerate
13763 According to the user manual, the label of each bibliography item must be
13787 \begin_layout Standard
13792 template takes care of all these
13793 \begin_inset Quotes eld
13797 \begin_inset Quotes erd
13801 If you start a new paper using this template you don't need to do anything
13806 \begin_layout Enumerate
13807 don't delete the \SpecialChar TeX
13808 code included in the template, and
13811 \begin_layout Enumerate
13812 copy the example bibliography item included in the template and modify it
13813 as necessary to enter new bibliography items.
13816 \begin_layout Section
13820 \begin_layout Standard
13826 \begin_layout Subsection
13830 \begin_layout Standard
13831 The \SpecialChar LyX
13834 article (koma-script)
13838 report (koma-script)
13856 correspond to the \SpecialChar LaTeX
13874 \begin_inset space ~
13877 of the Koma-Script family.
13878 They are replacements for the standard document classes
13894 , resp., and fit better to European typography conventions in a number of
13898 \begin_layout Itemize
13899 Standard character size is 11pt in
13901 article (koma-script)
13905 report (koma-script)
13913 letter (koma-script)
13918 \begin_layout Itemize
13919 Headings, labels of the description environment, and a number of elements
13922 letter (koma-script)
13924 document class are set in a bold sans serif font.
13928 \begin_layout Plain Layout
13929 There is a big difference between the bold sans serif old cm fonts and new
13930 ec fonts, especially in the appearance of headings.
13931 In comparison, the ec bold sans serif fonts look a bit thin.
13932 Here the \SpecialChar LaTeX
13941 helps to produce the
13942 \begin_inset Quotes eld
13946 \begin_inset Quotes erd
13949 appearance when using the ec fonts.
13954 The numbering of chapter headings is made in the same way as the numbering
13955 of section headings, that is without the extra line
13956 \begin_inset Quotes eld
13959 Chapter\SpecialChar ldots
13961 \begin_inset Quotes erd
13965 In addition, the appearance of the headings can be modified by using a
13966 number of options (in \SpecialChar LyX
13967 to be entered in the field
13970 \begin_inset space ~
13977 Layout\SpecialChar menuseparator
13984 \begin_layout Itemize
13985 The main means in the Koma-Script document classes to design the type area
13994 (in \SpecialChar LyX
13995 to be entered in the extra class options field in the dialog
13997 Document\SpecialChar menuseparator
14001 They make a clearer modification of page margins possible as do the options
14004 Document\SpecialChar menuseparator
14011 \begin_layout Itemize
14012 The \SpecialChar LaTeX
14013 document classes of the Koma-Script family define a number of additional
14015 Those part of it which makes sense in \SpecialChar LyX
14016 is implemented in corresponding
14020 \begin_layout Standard
14021 Detailed descriptions of the \SpecialChar LaTeX
14022 document classes of the Koma-Script family
14023 can be found in the Koma-Script documentation
14034 \begin_layout Subsection
14035 article (koma-script), report (koma-script), and book (koma-script)
14038 \begin_layout Standard
14039 The document classes
14041 article (koma-script)
14045 report (koma-script)
14055 are implemented in the layout files
14068 They contain all the paragraph types of the corresponding standard document
14081 , resp., partly modified, with the exception of the \SpecialChar LyX
14086 -type, which is replaced by the new
14090 -type having the same functionality.
14095 -Type there is a number of new paragraph types added.
14102 letter (koma-script)
14107 \begin_layout Itemize
14116 : are equivalents to
14124 , resp., additionally inserting an entry in the table of contents.
14133 are not contained in
14135 article (koma-script)
14140 \begin_layout Itemize
14149 : behave exactly as
14157 , resp., additionally clearing running heads.
14162 is not contained in
14164 article (koma-script)
14170 \begin_layout Plain Layout
14183 report (koma-script)
14185 , but since this is identical to
14189 , is has not been implemented in \SpecialChar LyX
14198 \begin_layout Itemize
14203 : generates a heading directly above the following paragraph in the standard
14204 character size without affecting the structure of the document.
14207 \begin_layout Itemize
14216 are special captions which respect the different space settings needed
14217 for captions placed above or below an element (if you follow strict typographic
14218 rules, you might want to place table captions always above the table).
14219 You can also use the class option
14223 , which will switch
14236 You need at least Koma-Script version 2.8q to use this.
14239 \begin_layout Itemize
14244 : can be used to set a bonmot, e.
14245 \begin_inset space \thinspace{}
14249 \begin_inset space \space{}
14252 at the beginning of a chapter.
14253 If you use the optional argument (
14255 Insert\SpecialChar menuseparator
14257 \begin_inset space ~
14262 ), you can insert the dictum's author there.
14263 Dictum and author are separated by a line.
14264 You need at least Koma-Script version 2.8q to use this.
14269 is not contained in
14271 article (koma-script)
14276 \begin_layout Standard
14277 The following types, together with the standard types
14289 , form the title area of the document.
14290 They must be entered ahead of the first
14291 \begin_inset Quotes eld
14295 \begin_inset Quotes erd
14302 \begin_layout Plain Layout
14303 The corresponding \SpecialChar LaTeX
14304 commands must appear before the
14315 When such a type is used more than once, the latter usage overwrites the
14316 former one, that means, for every type only the latest usage is valid.
14317 The order of the different types however has, like
14329 , no effect on the appearance of the produced document.
14332 \begin_layout Itemize
14337 : produces a centered paragraph above the ordinary title (
14349 ) for the subject of the document.
14352 \begin_layout Itemize
14357 : produces a centered paragraph below the ordinary title (
14369 ) for the publishers' name.
14372 \begin_layout Itemize
14379 report (koma-script)
14385 produces a centered paragraph on its own page behind the title page, or
14388 article (koma-script)
14390 produces a centered paragraph below the ordinary title (
14406 ) for a dedication.
14409 \begin_layout Itemize
14414 : produces a left aligned paragraph above the ordinary title (
14430 ) for a document`s head.
14433 \begin_layout Itemize
14438 : produces in a double-sided print in
14440 report (koma-script)
14446 a left-aligned paragraph at the top of the title page`s back or has no
14447 effect in a single-sided print or in
14449 article (koma-script)
14454 \begin_layout Itemize
14459 : produces in a double-sided print in
14461 report (koma-script)
14467 a left-aligned paragraph at the bottom of the title page`s back or has
14468 no effect in a single-sided print or in
14470 article (koma-script)
14475 \begin_layout Itemize
14480 : produces a special
14481 \begin_inset Quotes eld
14485 \begin_inset Quotes erd
14488 page ahead of the actual document containing a paragraph without special
14492 \begin_layout Standard
14493 The layout files for the document classes
14495 article (koma-script)
14499 report (koma-script)
14505 do include the file
14510 This is thought of as a place to define your own types.
14515 in your personal layout directory and edit the file!
14518 \begin_layout Subsection
14519 letter (koma-script)
14522 \begin_layout Standard
14526 letter (koma-script)
14528 is implemented in the layout file
14533 It contains all the paragraph types of the corresponding standard document
14538 , partly modified, with the exception of the \SpecialChar LyX
14552 type, which is replaced by the new
14557 In addition, it contains, in contrast to the standard document class, the
14576 Furthermore, there are a number of new letter specific types.
14579 \begin_layout Standard
14580 The appearance of the letter produced by this document class can be controlled
14581 by a number of \SpecialChar LaTeX
14582 commands, which you can put in the \SpecialChar LaTeX
14587 \begin_layout Plain Layout
14588 For example, the standard appearance of the letter`s heading, consisting
14589 of name and address, is quite self-willed.
14591 \begin_inset Quotes eld
14595 \begin_inset Quotes erd
14598 heading is produced by the following \SpecialChar LaTeX
14599 commands in the preamble:
14602 \begin_layout LyX-Code
14612 \begin_layout LyX-Code
14628 \begin_layout LyX-Code
14638 \begin_layout LyX-Code
14658 A detailed German description of such \SpecialChar LaTeX
14659 commands can be found in the Koma-Script
14665 With it, the letter's author can produce his personal letter layout.
14668 \begin_layout Standard
14677 define the beginning of the letter and must be used in every letter.
14678 To emphasize them in the \SpecialChar LyX
14679 document class, they are marked with the letter
14689 \begin_inset space ~
14692 in the left margin.
14693 It is possible to write any number of letters in one file.
14698 type produces a new letter using the same addressee and a
14702 type produces a new addressee.
14719 are ordinary paragraph types and can also be used several times in one
14720 and the same letter.
14723 \begin_layout Itemize
14728 : produces a paragraph for the addressee and implicitly defines the beginning
14732 \begin_layout Itemize
14737 : produces a paragraph for the form of address and implicitly produces a
14741 \begin_layout Itemize
14746 : produces a paragraph for a close.
14749 \begin_layout Itemize
14754 : produces a paragraph for a postscript.
14757 \begin_layout Itemize
14762 : produces a paragraph for a distribution list.
14765 \begin_layout Itemize
14770 : produces a paragraph for enclosures.
14773 \begin_layout Standard
14814 are input types provided with a label to enter information, which will
14815 be processed by the document class.
14819 \begin_layout Plain Layout
14820 It could be seen as a matter of inconsequence, that the types
14828 described above are not such input types as well.
14829 Because of the special meaning of those types, however, I have implemented
14830 them as ordinary paragraph types with a one letter mark in the left margin.
14831 Moreover, it would affect my feeling of symmetry, if the
14839 type had such a serious different appearance.
14844 The types must be used ahead of the corresponding
14851 \begin_layout Standard
14852 An implementation of these types in a WYSIWYG fashion does not seem to make
14853 sense, because the real appearance of the produced letter does not only
14854 depend on the usage of the particular type, but also on other factors.
14855 For example, a signature entered in the
14859 type will in the standard behavior appear in the produced letter only,
14860 when in the same letter also a
14865 The entered value of the
14869 type will in the standard behavior not appear in the produced letter at
14871 The possibility to design the letter`s heading freely is already indicated
14872 in a footnote above.
14875 \begin_layout Standard
14876 The input types can also be used as empty paragraphs.
14877 This makes sense e.
14878 \begin_inset space \thinspace{}
14882 \begin_inset space \space{}
14894 type is not used at all, in the standard behavior the value of the
14898 type is used as signature, whereas if an empty
14902 type is used, no signature value is defined.
14905 \begin_layout Standard
14906 By using the input types it is possible to write a letter template, containing
14907 filled input types with your personal dates (name, address, etc.) and empty
14908 input types for other dates you want to enter.
14911 \begin_layout Itemize
14916 : sender's name, in the standard behavior appears as a centered paragraph
14917 in small caps in the letter`s heading.
14920 \begin_layout Itemize
14925 : sender's signature, in the standard behavior appears below the
14934 type is used, the value of the
14938 type appears instead.
14941 \begin_layout Itemize
14946 : sender's address, in the standard behavior appears in a centered paragraph
14947 in the letter`s heading below the sender's name.
14950 \begin_layout Itemize
14955 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
14966 \begin_layout Itemize
14971 : place of the letter`s making.
14974 \begin_layout Itemize
14979 : date of the letter`s making.
14988 , in the standard behavior, produce the place and the date in a right-aligned
14989 line below the addressee's field.
14994 type is used, neither place nor date appear, independent of the value of
15004 type is used, the date of the letter `s production is used.
15007 \begin_layout Itemize
15012 : sender`s back address, in the standard behavior appears above the addressee's
15013 field in a small sans serif font.
15016 \begin_layout Itemize
15021 : special mail information, in the standard behavior appears underlined
15022 above the addressee's field below the back address.
15025 \begin_layout Itemize
15030 : additional information, in the standard behavior appears on right side
15031 below the addressee`s field.
15034 \begin_layout Itemize
15039 : the letter's title, in the standard behavior appears in a big, bold, sans
15040 serif font above the subject.
15043 \begin_layout Itemize
15048 : the letter's subject, in the standard behavior appears in a bold font
15056 \begin_layout Standard
15077 produce a business letter like line above the
15081 line containing the fields
15082 \begin_inset Quotes eld
15086 \begin_inset Quotes erd
15090 \begin_inset Quotes eld
15094 \begin_inset Quotes erd
15098 \begin_inset Quotes eld
15102 \begin_inset Quotes erd
15106 \begin_inset Quotes eld
15110 \begin_inset Quotes erd
15114 \begin_inset Quotes eld
15118 \begin_inset Quotes erd
15122 \begin_inset Quotes eld
15126 \begin_inset Quotes erd
15130 For the date field, the value of the
15136 \begin_inset Quotes eld
15139 business letter types
15140 \begin_inset Quotes erd
15143 is used, the value of the
15147 type however does not appear, but only the \SpecialChar LaTeX
15155 The ordinary output of place and date in a right-aligned line below the
15156 addressee`s field is suppressed.
15157 The types are implemented as input types provided with a label and must
15158 be used ahead of the corresponding
15165 \begin_layout Itemize
15173 \begin_layout Itemize
15181 \begin_layout Itemize
15189 \begin_layout Itemize
15197 \begin_layout Itemize
15205 \begin_layout Subsection
15206 The new letter class: letter (koma-script v.2)
15209 \begin_layout Standard
15215 \begin_layout Standard
15216 \begin_inset VSpace medskip
15222 \begin_layout Standard
15224 Koma-Script version 2.8 has introduced a new letter class
15228 which supersedes the now unsupported
15233 It has — on the \SpecialChar LaTeX
15234 side — a completely new interface and is not compatible
15235 with the old class.
15236 Therefore, \SpecialChar LyX
15237 supports both, though it is recommended you use the new class.
15240 \begin_layout Standard
15241 This class covers the same functionality as
15243 letter (koma-script),
15246 The basic items are
15250 (receiver's address, same as
15254 in the old layout),
15267 will start a new letter (i.
15268 \begin_inset space \thinspace{}
15272 \begin_inset space \space{}
15275 you can write several letters per document).
15276 New elements are sender's
15292 and the possibility to use a
15298 Insert\SpecialChar menuseparator
15304 \begin_layout Standard
15305 The biggest improvement is, though, that the letter's layout is configurable
15306 to meet almost any needs.
15307 This can be done via the preamble or with a special style file (Letter
15308 Class Option, extension
15312 ), that will be read in as a class option.
15316 \begin_layout Plain Layout
15317 The KOMA package comes with some default
15322 There is, for instance, a
15326 file that follows german typesetting rules, or a
15330 that provides the default layout of the old
15335 The latter can be loaded with the class option
15344 ayout\SpecialChar menuseparator
15349 ocument\SpecialChar menuseparator
15361 template that is included in \SpecialChar LyX
15363 A detailed description is to be found in the Koma-Script documentation
15371 \begin_layout Subsection
15375 \begin_layout Standard
15376 Visualizing the Koma-Script document classes in \SpecialChar LyX
15377 , the \SpecialChar LyX
15378 internals cause some
15382 \begin_layout Itemize
15383 The chapter number of a
15387 type appears on a line of its own above the chapter heading instead of
15388 appearing in the same line ahead of it.
15389 The cause for that is the \SpecialChar LyX
15390 internal behavior for the labeltype
15394 in the layout file.
15397 \begin_layout Itemize
15398 The headings of the types
15406 are only put in the
15407 \begin_inset Quotes eld
15411 \begin_inset Quotes erd
15415 table of contents, but not in the \SpecialChar LyX
15416 table of contents (
15418 Document\SpecialChar menuseparator
15420 \begin_inset space ~
15424 \begin_inset space ~
15432 \begin_layout Itemize
15433 The paragraphs in a
15437 document class appear in a skip separation mode, not indented.
15438 This is the standard behavior, no special \SpecialChar LaTeX
15439 commands are needed for that.
15442 Document\SpecialChar menuseparator
15445 dialog the corresponding radio button indicates
15454 value always has the effect that extra \SpecialChar LaTeX
15455 commands are inserted in the document
15456 to produce the gap, which is not what is wanted in this case.
15459 \begin_layout Section
15463 \begin_layout Standard
15469 \begin_layout Subsection
15473 \begin_layout Standard
15474 Memoir is a very powerful and constantly evolving class.
15475 It has been designed with regard to fictional and non-fictional literature.
15476 Its aim is to let the user have maximum control over the typesetting of
15478 Memoir is based on the standard book class, but it can also emulate the
15479 article class (see below).
15482 \begin_layout Standard
15483 Peter Wilson, the developer of Memoir, is known as the author of lots of
15484 useful packages in the \SpecialChar LaTeX
15486 Most of them have been merged with Memoir.
15487 Therefore, it is much easier to layout the table of contents, appendices,
15488 chapter designs and such.
15490 , though, does not support all of these goodies natively.
15491 Some of them might be added to forthcoming releases
15495 \begin_layout Plain Layout
15496 You are invited to send suggestions to
15497 \begin_inset Flex URL
15500 \begin_layout Plain Layout
15502 lyx-devel@lists.lyx.org
15512 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15514 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15516 commands (\SpecialChar TeX
15521 \begin_layout Plain Layout
15526 \begin_layout Plain Layout
15536 \begin_inset space ~
15540 \begin_inset CommandInset ref
15542 reference "sec:Inserting-TeX-Code"
15552 In this section, we can only list those features that are natively supported
15553 by \SpecialChar LyX
15555 For detailed descriptions (and for the rest of features) we recommend you
15556 have a look at the detailed manual of the Memoir class
15560 \begin_layout Plain Layout
15565 \begin_layout Plain Layout
15575 \begin_inset Flex URL
15578 \begin_layout Plain Layout
15580 CTAN:/macros/latex/memoir/memman.pdf
15590 , which is not only a user guide for the class, but also both a comprehensive
15591 description on good typesetting and a superb example for good typesetting
15595 \begin_layout Subsection
15596 Basic features and restrictions
15599 \begin_layout Standard
15600 Memoir supports basically all features of the standard book classes.
15601 There are, however, some differences, as follows:
15604 \begin_layout Description
15606 \begin_inset space ~
15609 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15612 \begin_layout Description
15614 \begin_inset space ~
15617 style: The fancy page style is not supported, due to a command clash between
15618 Memoir and the fancyhdr package (they both define a command with the same
15619 name, which confuses \SpecialChar LaTeX
15621 Instead, Memoir comes with a number of its own page styles (see
15623 Layout\SpecialChar menuseparator
15624 Document\SpecialChar menuseparator
15626 \begin_inset space ~
15632 If you want to use these for the chapter pages, you have to use the command
15639 in the main text or in preamble (e.
15640 \begin_inset space \thinspace{}
15644 \begin_inset space \space{}
15651 chapterstyle{companion}
15656 \begin_layout Description
15657 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15658 optional argument in the standard classes.
15659 With this, you can specify an alternative version of the title for the
15660 table of contents and the headers (for instance, if the title is too long).
15661 In \SpecialChar LyX
15662 , you can do this via
15664 Insert\SpecialChar menuseparator
15666 \begin_inset space ~
15671 at the beginning of a chapter/section.
15672 Memoir features a second optional argument and thus separates the table
15673 of contents from the header.
15674 You can define three variants of a title with this: one for the main text,
15675 one for the table of contents, and one for the headers.
15676 Simply insert two optional arguments if you need this feature, the first
15677 one containing the short title for the Table of Contents, the second one
15678 containing an alternative short title for the headers.
15681 \begin_layout Description
15682 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15683 of contents, the list of figures and the list of table start a new page
15685 Memoir does not follow this route.
15686 You have to insert a page break yourself, if you want to have one.
15689 \begin_layout Description
15690 Titlepage: For some unknown reason, Memoir uses pagination on the title
15691 page (in the standard classes, title pages are
15692 \begin_inset Quotes eld
15696 \begin_inset Quotes erd
15700 If you want an empty title page, type
15704 aliaspagestyle{title}{empty}
15709 \begin_layout Description
15710 Article: With the class option
15716 Layout\SpecialChar menuseparator
15717 Document\SpecialChar menuseparator
15719 \begin_inset space ~
15724 ), you can emulate article style.
15725 That is, counters (footnotes, figures, tables etc.) will not be reset on
15726 new chapters, chapters don't start a new page (but are—in contrary to
15727 \begin_inset Quotes eld
15731 \begin_inset Quotes erd
15734 article classes—still allowed), parts, though, use their own page, as in
15738 \begin_layout Description
15739 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15740 font commands, which have been used in the old \SpecialChar LaTeX
15742 \begin_inset space \thinspace{}
15746 \begin_inset space \space{}
15762 It produces an error and stops \SpecialChar LaTeX
15763 whenever such a command appears.
15768 reallows the commands and spits out warnings instead (which does at least
15769 not stop \SpecialChar LaTeX
15771 Since a lot of packages and particularly Bib\SpecialChar TeX
15772 style files are still using
15773 those commands, we have decided to use this option by default.
15776 \begin_layout Subsection
15780 \begin_layout Standard
15781 We will only describe the features supported by \SpecialChar LyX
15782 (which is not much currently).
15783 Please consult the Memoir manual
15787 \begin_layout Plain Layout
15792 \begin_layout Plain Layout
15802 \begin_inset Flex URL
15805 \begin_layout Plain Layout
15807 CTAN:/macros/latex/memoir/memman.pdf
15820 \begin_layout Description
15821 Abstract: You may wonder why an abstract is an extra feature.
15822 Well, it is in book class.
15823 Usually books don't have abstracts.
15824 Memoir, however, has.
15825 You can use it wherever and how often you like.
15828 \begin_layout Description
15829 Chapterprecis: You may know this older typesetting style: The contents of
15830 a chapter are summarized below the title and also in the table of contents
15832 \begin_inset space \thinspace{}
15836 \begin_inset space \space{}
15841 Our hero arrives in Troia; he loses some friends; he finds others
15844 Chapterprecis does exactly this.
15845 It is therefore only sensible below a chapter.
15848 \begin_layout Description
15849 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15850 The epigraph environment provides an elegant way of typesetting such a
15852 The motto itself (text) and its author (source) are divided by a short
15854 Unfortunately, we have to fool \SpecialChar LyX
15855 a bit here again, since the environment
15856 needs two arguments (text and source).
15857 In this case, we have to use curly brackets (in \SpecialChar TeX
15858 mode) between the two
15869 <author of the slogan>.
15872 \begin_layout Description
15873 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15874 complex figurative poems).
15876 can only support a few of them.
15877 One is poemtitle, which is a centered title for poems, which will also
15878 be added to the table of contents (verse is the standard environment for
15880 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
15882 because they have to be nested inside regular verse environments, which
15883 is not possible with \SpecialChar LyX
15887 \begin_layout Description
15888 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15891 \begin_layout Section
15892 Article (mwart), book (mwbk) and report (mwrep)
15893 \begin_inset Argument status
15896 \begin_layout Plain Layout
15909 \begin_layout Standard
15915 \begin_layout Standard
15916 The \SpecialChar LyX
15933 correspond to the \SpecialChar LaTeX
15947 They are replacements for the standard document classes
15959 , resp., and fit better to Polish typography conventions in a number of points.
15963 \begin_layout Standard
15967 \begin_layout Itemize
15968 Unnumbered titles (with star, e.
15969 \begin_inset space \thinspace{}
15973 \begin_inset space \space{}
15980 ) are added into table of contents,
15983 \begin_layout Itemize
15984 Additional page styles:
15985 \begin_inset Separator parbreak
15992 \begin_layout Description
15993 uheadings header with separated lines,
15996 \begin_layout Description
15997 myheadings custom header, contents headers via commands:
16012 \begin_layout Description
16013 myuheadings custom header with separated lines,
16016 \begin_layout Description
16017 outer page number is placed on outer side of page
16021 \begin_layout Itemize
16023 \begin_inset Separator parbreak
16030 \begin_layout Description
16031 rmheadings serif titles — default,
16034 \begin_layout Description
16035 sfheadings sansserif titles,
16038 \begin_layout Description
16039 authortitle on title page first placed is author next title — default,
16042 \begin_layout Description
16043 titleauthor on title page first placed is title next author,
16046 \begin_layout Description
16047 withmarginpar reserve place on page for margins.
16051 \begin_layout Section
16055 \begin_layout Standard
16060 provides an alternative to the standard
16065 It provides similar functionality, but you might prefer this layout with
16066 sans serif sections, headings, and more.
16069 \begin_layout Section
16070 Rev\SpecialChar TeX
16074 \begin_layout Standard
16080 \begin_layout Standard
16081 \begin_inset VSpace bigskip
16087 \begin_layout Standard
16092 \begin_inset space ~
16097 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16099 \begin_inset Formula $\beta$
16102 release of May, 1999) class.
16105 \begin_layout Standard
16111 textclass, which works with Rev\SpecialChar TeX
16113 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16115 That means that it doesn't interact very well with \SpecialChar LyX
16116 , which requires \SpecialChar LaTeX2e
16118 it has been kludged to work.
16119 Since Rev\SpecialChar TeX
16120 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16125 Rev\SpecialChar TeX
16127 \begin_inset space ~
16132 textclass should also be pretty easy to use.
16135 \begin_layout Standard
16136 These documents are supposed to be used in
16140 to the Rev\SpecialChar TeX
16141 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16143 and assume you'll know what to put in the preamble if necessary.
16146 \begin_layout Subsection
16150 \begin_layout Standard
16151 All you need to do is install Rev\SpecialChar TeX
16152 4, as described in the package's README
16154 The package can be found at The Rev\SpecialChar TeX
16156 \begin_inset Flex URL
16159 \begin_layout Plain Layout
16161 http://publish.aps.org/revtex4/
16167 Install it somewhere that \SpecialChar LaTeX
16169 Test it by trying to \SpecialChar LaTeX
16170 a short Rev\SpecialChar TeX
16171 4 document in some random directory (i.
16172 \begin_inset space \thinspace{}
16176 \begin_inset space \space{}
16179 not the directory where you installed the class file.) Then, if you reconfigure
16181 , it will find the class file and let you use the Rev\SpecialChar TeX
16185 \begin_layout Standard
16186 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16195 \begin_inset space ~
16200 template, found in the templates directory.
16203 \begin_layout Subsection
16207 \begin_layout Standard
16208 Optional arguments to
16215 \begin_inset Quotes eld
16219 \begin_inset Quotes erd
16223 \begin_inset Quotes eld
16227 \begin_inset Quotes erd
16237 \begin_inset space ~
16245 \begin_inset space ~
16251 Remember that in Rev\SpecialChar TeX
16252 , at least one optional argument is required!
16255 \begin_layout Standard
16256 Other preamble matter, like
16263 \begin_inset space ~
16270 \begin_inset space ~
16275 dialog, also as usual.
16278 \begin_layout Subsection
16282 \begin_layout Standard
16283 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16285 For example, the Email layout corresponds to
16292 Note that (at least as of Rev\SpecialChar TeX
16301 layouts are exactly equivalent, so you shouldn't need to use both.
16305 \begin_layout Plain Layout
16306 In case you're curious, both were included so that
16310 would be able to translate both
16330 \begin_layout Subsection
16334 \begin_layout Standard
16335 There are a couple of important unique aspects of Rev\SpecialChar TeX
16336 4 which might cause
16337 bugs that will be even more confusing in \SpecialChar LyX
16341 \begin_layout Standard
16342 In Rev\SpecialChar TeX
16360 The \SpecialChar LyX
16361 equivalent is that there is a separate Thanks layout.
16366 write footnotes in the
16370 layout, or weird things may happen.
16371 See the Rev\SpecialChar TeX
16372 4 documentation for more details.
16375 \begin_layout Standard
16379 \begin_inset space ~
16387 \begin_inset space ~
16396 layouts must be placed
16404 layout and the corresponding
16421 , the \SpecialChar LaTeX
16425 \begin_layout Subsection
16429 \begin_layout Standard
16430 The main problem with this layout is that you can't use the optional arguments
16431 to layouts like Email and Title.
16432 (The problem is not unique to this layout; you can't use optional arguments
16433 to the Section layouts either.) This means that after you export that file
16434 to \SpecialChar LaTeX
16435 (which you'll need to do eventually to send it in to APS), you'll need
16436 to edit the \SpecialChar LaTeX
16437 file with a text editor to add the optional arguments to set,
16439 \begin_inset space \thinspace{}
16443 \begin_inset space \space{}
16446 the running title for the page headers.
16447 Lacking these layouts makes the
16453 (and the equivalent
16459 ) useless, so the corresponding layouts don't exist, and will have to be
16464 \begin_layout Plain Layout
16469 actually, \SpecialChar LyX
16470 1.3.0 supports some forms of optional arguments, but this layout
16471 has not been updated yet to take advantage of it.
16479 \begin_layout Section
16480 Springer Journals (
16487 \begin_layout Standard
16493 \begin_layout Subsection
16497 \begin_layout Standard
16498 These are the layout files for some of the journal formats used by Springer
16499 Verlag and listed on
16500 \begin_inset Flex URL
16503 \begin_layout Plain Layout
16505 http://www.springer.de/author/tex/help-journals.html
16510 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16512 It is a modular system: the things common to all journals are implemented
16517 , which journal-specific layout files (such as, e.
16518 \begin_inset space \thinspace{}
16522 \begin_inset space \space{}
16529 for Journal of Geodesy) can include.
16532 \begin_layout Standard
16533 This means that implementing support for any other Springer journal on this
16534 list is as simple as writing your own
16542 file following the outline given in
16550 \begin_layout Standard
16551 It is reasonably well tested only for the Journal of Geodesy.
16560 come with the standard \SpecialChar LyX
16562 Install the relevant class file (downloaded from Springer) in a proper
16563 directory, reconfigure \SpecialChar LaTeX
16564 (in the te\SpecialChar TeX
16569 , as root if necessary — doesn't \SpecialChar LyX
16570 take care of this?), reconfigure \SpecialChar LyX
16575 \begin_layout Subsection
16579 \begin_layout Standard
16580 A large number of theorem-like styles —
16592 \begin_layout Standard
16595 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16596 _Title, Author_Running, Institute,
16597 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16600 See the Springer class file documentation for details.
16603 \begin_layout Subsection
16607 \begin_layout Itemize
16619 \begin_layout Itemize
16622 Probability Theory and Related Fields
16628 — Jean-Marc Lasgouttes
16631 \begin_layout Standard
16632 Add your own, it isn't so hard!
16635 \begin_layout Subsection
16639 \begin_layout Standard
16640 These files are partly based on the older
16644 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16646 file from Springer.
16651 layout, are now defunct.
16652 Jean-Marc Lasgouttes helped out big in making me find my way around the
16654 layout file mechanism.
16657 \begin_layout Subsection
16661 \begin_layout Standard
16663 But probably less than in the old hacked-\SpecialChar LaTeX
16671 \begin_layout Standard
16673 \begin_inset space \thinspace{}
16676 g.: does not display the number for theorem-like layouts, just #.
16679 \begin_layout Section
16682 Sli\SpecialChar TeX
16686 \begin_inset CommandInset label
16695 \begin_layout Standard
16703 \begin_layout Subsection
16707 \begin_layout Standard
16708 This section describes how to use \SpecialChar LyX
16709 to make slides for overhead projectors.
16710 There are two document classes that can do this: the default slides class
16713 Foil\SpecialChar TeX
16717 This section documents the former.
16720 \begin_layout Standard
16721 I'm going to say this again, nice and clear, so that there's no misunderstanding
16725 \begin_layout Standard
16726 \begin_inset VSpace bigskip
16732 \begin_layout Standard
16736 This section documents the class
16737 \begin_inset Quotes eld
16745 \begin_inset Quotes erd
16753 \begin_layout Standard
16754 \begin_inset VSpace bigskip
16760 \begin_layout Standard
16761 If you're looking for the documentation for
16762 \begin_inset Quotes eld
16767 slides (Foil\SpecialChar TeX
16771 \begin_inset Quotes erd
16774 , check out section
16775 \begin_inset space ~
16779 \begin_inset CommandInset ref
16781 reference "sec:foiltex"
16791 \begin_inset Quotes eld
16796 slides (Foil\SpecialChar TeX
16800 \begin_inset Quotes erd
16803 ] is actually somewhat better than the default
16811 \begin_layout Plain Layout
16813 or so I've been told repeatedly by its advocates.
16814 Having never used it, I have no idea if this claim is true or not.
16819 which this section documents.
16822 \begin_layout Standard
16823 This class is the \SpecialChar LaTeX2e
16824 improvement of the old
16826 Sli\SpecialChar TeX
16830 Every \SpecialChar LaTeX2e
16831 distribution includes this class [which I'll just refer to as
16832 \begin_inset Quotes eld
16840 \begin_inset Quotes erd
16843 from now on], so you're bound to have it.
16844 As I noted earlier, there are other classes, such as
16848 , which also produce slides for overhead projectors and do a better job
16850 However, there are some things which
16854 can do which the others can't, such as generate overlays.
16855 Read on to learn more!
16858 \begin_layout Subsection
16860 \begin_inset CommandInset label
16862 name "sec:slidesetup"
16869 \begin_layout Standard
16870 Obviously, to use this document class, you need to select
16871 \begin_inset Quotes eld
16879 \begin_inset Quotes erd
16882 from the class list in the
16884 Document\SpecialChar menuseparator
16888 There are some other special things you should know about this class:
16891 \begin_layout Itemize
16892 Don't bother changing the options
16897 They're not supported by the
16904 \begin_layout Itemize
16908 \begin_inset space ~
16913 behaves a bit differently for this class.
16914 The possible choices and what they do are as follows:
16915 \begin_inset Separator parbreak
16922 \begin_layout Description
16927 The final output contains page numbers in the lower right corner.
16930 \begin_layout Description
16939 , but also prints out any time markers you've put in.
16940 This is the default.
16943 \begin_layout Description
16948 The final output contains no page numbers, time markers, or alignment markers.
16952 \begin_layout Itemize
16957 class has an extra option:
16963 \begin_inset Quotes eld
16971 \begin_inset Quotes erd
16974 in the extra class options.
16975 \begin_inset Separator parbreak
16982 \begin_layout Standard
16983 Using this options allows you to add time markers to
16989 \begin_inset space ~
16993 \begin_inset CommandInset ref
16995 reference "sec:slideNote"
17003 \begin_layout Standard
17004 You can also use the template file
17005 \begin_inset Quotes eld
17013 \begin_inset Quotes erd
17016 to automatically set up a document to use the
17022 File\SpecialChar menuseparator
17024 \begin_inset space ~
17028 \begin_inset space ~
17033 to open your new document].
17034 The template file also contains some examples of the special paragraph
17035 environments used by this class.
17036 I'll describe those next.
17039 \begin_layout Subsection
17040 Paragraph Environments
17043 \begin_layout Subsubsection
17044 Supported Environments
17047 \begin_layout Standard
17048 The first thing you'll notice when you start up a new
17052 document is the font size and type: it's the equivalent of the size
17053 \begin_inset Quotes eld
17061 \begin_inset Quotes erd
17067 \begin_inset space ~
17073 This is also what's used in the output.
17075 \begin_inset Quotes eld
17079 \begin_inset Quotes erd
17082 to remind you that this is a slide.
17083 Your final slides will use a larger font; ergo, you'll have less space.
17084 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17087 \begin_layout Standard
17088 The next thing that becomes obvious is the changes to the paragraph environment
17089 pull-down box [at the far-left end of the toolbar].
17090 Most of the paragraph environments you're used to seeing are missing.
17091 There are also five new ones.
17096 class itself only supports certain paragraph environments:
17099 \begin_layout Itemize
17105 \begin_layout Itemize
17111 \begin_layout Itemize
17117 \begin_layout Itemize
17123 \begin_layout Itemize
17129 \begin_layout Itemize
17135 \begin_layout Itemize
17141 \begin_layout Itemize
17147 \begin_layout Itemize
17153 \begin_layout Itemize
17160 \begin_layout Itemize
17166 \begin_layout Standard
17167 All of the other standard environments, including the section-heading environmen
17168 ts, aren't used in the
17175 \begin_layout Standard
17176 On the other hand, you'll notice the following new environments:
17179 \begin_layout Itemize
17185 \begin_layout Itemize
17191 \begin_layout Itemize
17197 \begin_layout Itemize
17203 \begin_layout Itemize
17209 \begin_layout Standard
17210 These five are kind of quirky, due to a
17211 \begin_inset Quotes eld
17215 \begin_inset Quotes erd
17218 in \SpecialChar LyX
17220 You see, \SpecialChar LyX
17221 doesn't permit you to nest any other paragraph environment into
17222 an empty environment.
17223 Now, that's fine and dandy, but it means that you wouldn't be able to start
17224 a slide with anything except plain text.
17225 To deal with this, I've performed a little
17226 \begin_inset Quotes eld
17231 \begin_inset Quotes erd
17237 \begin_layout Subsubsection
17238 Quirks of the New Environments
17239 \begin_inset CommandInset label
17241 name "sec:slideQuirk"
17248 \begin_layout Standard
17249 All five of the new paragraph environments are somewhat quirky due to inherent
17250 limitiations in the current version of \SpecialChar LyX
17252 As I just mentioned, \SpecialChar LyX
17253 forbids environments that begin with another environment.
17254 To get around this, the
17258 environment isn't a paragraph environment as described in the
17266 \begin_layout Standard
17267 You should consider
17280 \begin_inset Quotes eld
17283 pseudo-environments.
17284 \begin_inset Quotes erd
17287 They look like a section heading or a
17288 \begin_inset Quotes eld
17296 \begin_inset Quotes erd
17299 but really begin a [and, if necessary, end the previous] paragraph environment.
17309 \begin_inset Quotes eld
17313 \begin_inset Quotes erd
17316 These two perform some action.
17319 \begin_layout Standard
17320 A common feature of all five environments,
17340 , is a rather long-ish label.
17341 The text following this label — ordinarily the contents of the paragraph
17342 environment — is utterly irrelevant for
17364 completely ignores it.
17365 In fact, you can leave these five environments completely empty.
17369 \begin_layout Standard
17374 to put any text after the rather long-ish label, you might want to.
17375 This could be a short description of the contents of the
17380 In that case, enter your descriptive comment and hit
17384 as you normally would.
17387 \begin_layout Standard
17388 If, on the other hand, you don't want to enter any descriptive text, you'll
17389 hit another \SpecialChar LyX
17392 , like nature, abhors a vacuum, and will not let you start a new paragraph
17393 environment until you put something in the old one.
17397 \begin_layout Itemize
17398 Start entering the text that will
17426 \begin_layout Itemize
17427 Now move to the beginning of that paragraph.
17431 \begin_layout Itemize
17440 \begin_layout Itemize
17441 Finally, change this new, empty paragraph to a
17465 \begin_layout Standard
17466 Some future version of \SpecialChar LyX
17467 will, hopefully, resolve this quirkiness\SpecialChar ldots
17471 \begin_layout Subsection
17472 Making a Presentation with
17485 \begin_layout Subsubsection
17493 \begin_layout Standard
17494 If you're expecting this section to teach you how to actually make a presentatio
17495 n, you'll be sorely disappointed.
17496 Naturally, I'll describe all of the ways the
17500 class can assist you in preparing the materials for a presentation.
17501 Filling in the contents, however, is up to you.
17506 the \SpecialChar LyX
17510 \begin_layout Standard
17515 environment [in the manner described in section
17516 \begin_inset space ~
17520 \begin_inset CommandInset ref
17522 reference "sec:slideQuirk"
17526 ] tells \SpecialChar LyX
17527 to begin a new slide [duh].
17528 The label for this environment/
17529 \begin_inset Quotes erd
17533 \begin_inset Quotes erd
17537 \begin_inset Quotes eld
17541 \begin_inset Quotes erd
17544 in cool blue, followed by the label,
17545 \begin_inset Quotes eld
17549 \begin_inset Quotes erd
17553 Any text or paragraph environments that follow this one go on the new slide.
17557 \begin_layout Standard
17558 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17560 (this can be specified in the
17565 In fact, you'll want to, once you finish entering the contents of one slide.
17566 If you've entered more text than can physically fit on a slide, the extra
17567 overflows onto a new slide.
17568 I don't recommend doing this, however, since the overflow slide won't have
17569 any page number on it.
17570 Furthermore, it may interfere with any
17574 you've made to accompany the oversized
17581 \begin_layout Standard
17590 environments work the same way as the
17595 They both create an
17596 \begin_inset Quotes eld
17600 \begin_inset Quotes erd
17603 followed by a label [
17604 \begin_inset Quotes eld
17608 \begin_inset Quotes erd
17612 \begin_inset Quotes eld
17616 \begin_inset Quotes erd
17620 The color is a stunning magenta instead of blue, and the
17621 \begin_inset Quotes eld
17625 \begin_inset Quotes erd
17628 will look different, in style and in length.
17629 The label fonts of all three also differ from one another.
17632 \begin_layout Standard
17637 , if the contents of a
17645 exceed the physical size of a slide or sheet of paper, the extra will overflow
17647 Again, you should avoid this.
17648 It defeats the whole purpose of
17659 \begin_layout Subsubsection
17669 \begin_layout Standard
17674 is a slide that sits atop another slide.
17675 Perhaps you wish to discuss a figure on the main
17679 before displaying the text associated with it.
17680 One way to accomplish this is tape a flap of dark paper over the part of
17685 you want to display later.
17686 This method fails, however, if you wish to overlap one graph with another,
17688 You would then have to fumble while speaking to align the two separate,
17693 s to align the two graphs.
17698 environment in both cases makes life much easier.
17701 \begin_layout Standard
17706 receives the page number of its
17707 \begin_inset Quotes eld
17711 \begin_inset Quotes erd
17719 \begin_inset Quotes eld
17727 \begin_inset Quotes erd
17734 \begin_layout Plain Layout
17735 Presumably, mutliple
17740 \begin_inset Quotes eld
17748 \begin_inset Quotes erd
17752 \begin_inset Quotes eld
17760 \begin_inset Quotes erd
17764 \begin_inset Quotes eld
17772 \begin_inset Quotes erd
17776 \begin_inset space ~
17779 appended to the page number of the parent
17789 Clearly, you want the contents of both the
17797 to each fit on a single physical slide! You should probably consider an
17803 \begin_inset Quotes eld
17807 \begin_inset Quotes erd
17815 Indeed, the \SpecialChar LyX
17820 class provides a visual cue for this: the label at the start of an
17824 is shorter than that at the start of a
17829 Lastly, when you generate printable output, you'll find alignment markers
17830 in all four corners of both the
17834 page and its parent
17839 These will assist you in lining up the two physical slides.
17842 \begin_layout Standard
17843 The major problem in overlaying two slides is aligning the contents of the
17844 two transparencies.
17845 How much space should you leave for that graph on the second slide? Worse
17846 still, what if you want a graph and a sentence on second slide, but there
17847 is text on the main transparency that goes in between them? You could try
17848 and insert vertical space of the right size.
17849 The better way is to use
17860 \begin_layout Standard
17861 As their names imply,
17869 are two command-like paragraph environments that make all subsequent text
17870 invisible and visible, respectively.
17872 \begin_inset space ~
17876 \begin_inset CommandInset ref
17878 reference "sec:slideQuirk"
17882 that you don't place anything
17886 these two environments, however.
17891 , it inserts a centered, sky-blue label into the page reading
17892 \begin_inset Quotes eld
17895 <Invisible Text Follows>
17896 \begin_inset Quotes erd
17900 For paragraphs following this label, the parts of the
17908 ; it doesn't matter which] where they would be contain instead blank space.
17912 \begin_layout Standard
17917 , the corresponding centered label is
17918 \begin_inset Quotes eld
17921 <Visible Text Follows>
17922 \begin_inset Quotes erd
17926 Paragraphs following this label behave normally.
17927 Note that the beginning of a new
17939 automatically shuts off an
17944 It's therefore not necessary to use
17955 \begin_layout Standard
17956 By now, it should be obvious how to create overlay transparencies using
17957 the proper combination of
17976 \begin_layout Enumerate
17981 , including everything that will appear on it, whether on the main slide
17989 \begin_layout Enumerate
17990 Before each figure or paragraph that will appear only on the
17999 If necessary, insert a
18003 environment after the
18010 \begin_layout Enumerate
18015 immediately following the
18022 \begin_layout Enumerate
18023 Copy the contents of this
18034 \begin_layout Enumerate
18039 , change all of the
18050 \begin_layout Standard
18052 You've just made an
18059 \begin_layout Standard
18060 There's one problem with the way I've designed the \SpecialChar LyX
18065 class: you can't make text in the middle of a paragraph invisible, nor
18066 make text in the middle of an invisible paragraph visible again.
18067 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18072 \begin_layout Plain Layout
18073 The commands of interest are:
18076 \begin_layout Itemize
18081 invisible \SpecialChar ldots
18085 \begin_layout Itemize
18090 visible \SpecialChar ldots
18094 \begin_layout Plain Layout
18096 and need to be marked as \SpecialChar TeX
18099 \begin_inset Quotes eld
18103 \begin_inset Quotes erd
18106 you wish to change goes in between the brackets [and after the
18119 If you don't know how to mark text as \SpecialChar TeX
18120 , see the appropriate section of
18133 \begin_layout Subsubsection
18143 \begin_inset CommandInset label
18145 name "sec:slideNote"
18152 \begin_layout Standard
18161 is associated with a
18162 \begin_inset Quotes eld
18166 \begin_inset Quotes erd
18174 Here, too, the \SpecialChar LyX
18179 class provides visual cues.
18184 is shorter than that of a
18188 [yet longer than that of an
18192 ] and, like the label of an
18196 is shockingly magenta.
18197 Additionally, the printed
18201 has the page number of its
18202 \begin_inset Quotes eld
18206 \begin_inset Quotes erd
18214 \begin_inset Quotes eld
18222 \begin_inset Quotes erd
18226 \begin_inset Quotes eld
18234 \begin_inset Quotes erd
18238 \begin_inset Quotes eld
18246 \begin_inset Quotes erd
18250 You can have multiple
18254 s associated with a single
18266 , you'll probably want to break up long
18270 s so that they fit on a single sheet of paper.
18273 \begin_layout Standard
18278 is obvious: it contains anything additional you might want to say about
18284 It could also be used as a sheet of reminders for a particular
18289 In the case of the latter, you might want to make use of time markers.
18290 Currently, the \SpecialChar LyX
18296 \begin_inset Quotes eld
18300 \begin_inset Quotes erd
18303 support for time markers, a
18305 Sli\SpecialChar TeX
18309 So, you'll have to resort to using the \SpecialChar LaTeX
18313 \begin_layout Standard
18314 To use time markers, you'll need to specify the extra class option
18315 \begin_inset Quotes eld
18323 \begin_inset Quotes erd
18327 \begin_inset space ~
18331 \begin_inset CommandInset ref
18333 reference "sec:slidesetup"
18338 This option turns on timing marks, which will appear in the lower-left-hand
18344 To set what appears in the time marker, you use the \SpecialChar LaTeX
18346 \begin_inset Quotes eld
18356 \begin_inset Quotes erd
18360 \begin_inset Quotes eld
18370 \begin_inset Quotes erd
18374 The arguments of both commands are time measured in seconds.
18376 \begin_inset Quotes eld
18386 \begin_inset Quotes erd
18389 sets the time marker to a given time.
18391 \begin_inset Quotes eld
18401 \begin_inset Quotes erd
18404 increments the time marker by the specified amount.
18405 Using time markers and
18409 s in this fashion, you can remind yourself how much time to spend on a particula
18417 \begin_layout Standard
18418 There's one last feature to describe.
18419 Clearly, you'd like to print out all of your
18427 s on transparencies while printing all of your
18444 with which it is associated.
18445 What's a person to do?
18448 \begin_layout Standard
18449 Luckily, there are two \SpecialChar LaTeX
18450 commands that allow you to select what to print
18452 Both must be placed into the preamble of your document.
18454 \begin_inset Quotes eld
18466 \begin_inset Quotes erd
18469 will cause the output to contain only the
18478 Correspondingly, the command
18479 \begin_inset Quotes eld
18491 \begin_inset Quotes erd
18494 prevents the output of anything but
18499 I'd advise placing both commands in the preamble and initially comment
18501 You can then preview your entire presentation as you write.
18502 When you're done writing, you can then uncomment one of the two to select
18503 what you want to print.
18504 I like to uncomment
18505 \begin_inset Quotes eld
18517 \begin_inset Quotes erd
18520 , print to a file with
18521 \begin_inset Quotes eld
18529 \begin_inset Quotes erd
18532 in its name, comment it back out, then uncomment
18533 \begin_inset Quotes eld
18545 \begin_inset Quotes erd
18549 \begin_inset Quotes eld
18557 \begin_inset Quotes erd
18561 I can then send either file to a printer, loading transparencies or plain
18562 paper as appropriate.
18565 \begin_layout Standard
18566 You can also provide other arguments to the
18567 \begin_inset Quotes eld
18577 \begin_inset Quotes erd
18581 \begin_inset Quotes eld
18591 \begin_inset Quotes erd
18595 See a good \SpecialChar LaTeX
18599 \begin_layout Subsection
18604 Class Template File
18607 \begin_layout Standard
18608 I have also provided a template file,
18609 \begin_inset Quotes eld
18617 \begin_inset Quotes erd
18625 To use it, begin your new presentation with
18630 ile\SpecialChar menuseparator
18632 \begin_inset space ~
18636 \begin_inset space ~
18646 Your new \SpecialChar LyX
18647 presentation file will contain an example
18668 additionally contain an example of the use of
18677 Lastly, the preamble will contain:
18680 \begin_layout LyX-Code
18681 % Uncomment to print out only slides and overlays
18684 \begin_layout LyX-Code
18688 \begin_layout LyX-Code
18694 \begin_inset Newline newline
18700 \begin_layout LyX-Code
18701 % Uncomment to print out only notes
18704 \begin_layout LyX-Code
18708 \begin_layout LyX-Code
18716 \begin_layout Standard
18717 One final thing: I created this class to support the \SpecialChar LaTeX2e
18719 \begin_inset Quotes eld
18724 Sli\SpecialChar TeX
18728 \begin_inset Quotes erd
18731 class, one of the built-in \SpecialChar LaTeX2e
18733 Neither I nor the rest of the \SpecialChar LyX
18734 Team endorse or oppose the use of this built-in
18736 It's here if you want it or need it.
18737 There exist other \SpecialChar LaTeX2e
18738 classes for creating presentations, such as the
18743 \begin_inset space ~
18747 \begin_inset CommandInset ref
18749 reference "sec:foiltex"
18754 \begin_inset Quotes eld
18762 \begin_inset Quotes erd
18765 package [present on some \SpecialChar TeX
18767 The latter is not yet supported under \SpecialChar LyX
18772 \begin_layout Plain Layout
18773 Perhaps you can take on the task\SpecialChar ldots
18779 I know nothing about these other classes.
18780 Try them out to see what sort of alternative they provide.
18783 \begin_layout Chapter
18785 Features needing Extra Software
18788 \begin_layout Section
18789 Checking \SpecialChar TeX
18793 \begin_layout Standard
18799 \begin_layout Subsection
18803 \begin_layout Standard
18812 \begin_layout Plain Layout
18817 is not yet available when you are using the \SpecialChar LaTeX
18818 distribution MiK\SpecialChar TeX
18824 , you'll find in the
18831 \begin_inset space ~
18835 \change_deleted -712698321 1437633476
18838 \change_inserted -712698321 1437633477
18849 \begin_inset Newline newline
18853 \begin_inset CommandInset href
18855 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18862 \begin_layout Standard
18865 Chk\SpecialChar TeX
18868 package is a program that was written by
18869 \begin_inset Flex Noun
18872 \begin_layout Plain Layout
18874 \begin_inset space ~
18882 in frustration because some constructs in \SpecialChar LaTeX
18883 are sometimes non-intuitive,
18884 and easy to forget.
18885 The program runs over your \SpecialChar LaTeX
18886 file, checks the integrity of the file, and
18887 flags some common errors.
18888 In other technical words, it is
18892 for \SpecialChar LaTeX
18896 \begin_layout Standard
18897 Well, what is a syntax checker doing in \SpecialChar LyX
18898 which is supposed to produce correct
18900 anyways? The answer is simple: Just as
18904 not only checks the
18908 of C programs, but also does
18912 checks for type-errors,
18914 Chk\SpecialChar TeX
18917 catches some common
18921 errors, in addition to the syntactical ones.
18924 Chk\SpecialChar TeX
18927 is capable of detecting several common errors, such as
18930 \begin_layout Itemize
18931 Ellipsis detection:
18932 \begin_inset Newline newline
18935 Use \SpecialChar ldots
18939 \begin_layout Itemize
18940 No space in front of/after parenthesis:
18941 \begin_inset Newline newline
18947 \begin_layout Itemize
18948 Enforcement of normal space after common abbreviations:
18949 \begin_inset Newline newline
18953 \begin_inset space \thinspace{}
18957 \begin_inset space \space{}
18960 is too wide spacing.
18963 \begin_layout Itemize
18964 Enforcement of end-of-sentence space when the last sentence ends with a
18966 \begin_inset Newline newline
18970 And this is wrong spacing.
18973 \begin_layout Itemize
18974 Space in front of labels and similar commands:
18975 \begin_inset Newline newline
18978 The label should stick right up to the text to avoid falling to a wrong
18981 \begin_inset CommandInset label
18991 \begin_layout Plain Layout
18992 This footnote is in danger of falling off to a wrong page
18997 The label is separated too much.
19000 \begin_layout Itemize
19001 Space in front of references, instead of hard spaces:
19002 \begin_inset Newline newline
19005 If you have bad luck, the text will break right between the referenced text
19006 and reference number, and that's a pity.
19008 \begin_inset CommandInset ref
19010 reference "sec:chktex"
19017 \begin_layout Itemize
19019 \begin_inset Quotes eld
19023 \begin_inset Quotes erd
19027 \begin_inset Formula $\times$
19031 \begin_inset Newline newline
19034 2x2 looks cheap compared to
19035 \begin_inset Formula $2\times2$
19041 \begin_layout Standard
19042 and more \SpecialChar ldots
19043 It is an invaluable tool when you are
19044 \begin_inset Quotes eld
19048 \begin_inset Quotes erd
19051 your document before printing, and you should run it right after the obligatory
19052 spelling check, and before you go fine tuning the typesetting.
19055 \begin_layout Subsection
19059 \begin_layout Standard
19060 If you have the program installed, usage is as simple as choosing
19062 Tools\SpecialChar menuseparator
19064 \begin_inset space ~
19068 \change_deleted -712698321 1437633488
19071 \change_inserted -712698321 1437633488
19077 This will make \SpecialChar LyX
19078 generate a \SpecialChar LaTeX
19079 file of your document, start
19081 Chk\SpecialChar TeX
19084 to check it, and then make \SpecialChar LyX
19086 \begin_inset Quotes eld
19090 \begin_inset Quotes erd
19093 with the warnings from
19095 Chk\SpecialChar TeX
19098 , if there were any.
19099 The warnings will be placed close to the point of the mistake, and you
19100 can quickly find them by using the
19102 Navigate\SpecialChar menuseparator
19105 menu item, or the shortcut key
19114 Open the error boxes by clicking on them with the mouse, or use the shortcut
19123 bindings, or the corresponding
19132 Read the warning and correct the mistake, if it is a mistake.
19133 If you have trouble understanding what the warning is about, you can safely
19135 Remember that there is a hidden layer between the document on screen and
19136 the technical details in invoking
19138 Chk\SpecialChar TeX
19141 , and this gap can make some warnings seem arcane or just plain silly.
19144 \begin_layout Standard
19145 This document is an excellent testing bed for the feature, and it should
19146 provide quite a few warnings for you to fiddle with.
19147 Since computers are only so smart, expect most of the warnings to be false
19151 \begin_layout Subsection
19152 How to fine tune it
19155 \begin_layout Standard
19156 Sometimes, you'll find that
19158 Chk\SpecialChar TeX
19161 makes more noise than suits your mood.
19162 Then you can choose not to use it, wait until your mood changes, or try
19165 Chk\SpecialChar TeX
19168 to get better along with you.
19171 \begin_layout Standard
19174 Chk\SpecialChar TeX
19181 very configurable and extensible, you should not expect to solve all problems
19184 Chk\SpecialChar TeX
19187 in \SpecialChar LyX
19189 Since \SpecialChar LyX
19190 has to generate a somewhat special \SpecialChar LaTeX
19191 file to be able to match the
19192 line numbers from the
19194 Chk\SpecialChar TeX
19201 \begin_layout Plain Layout
19202 You can inspect the specific output from
19208 Document\SpecialChar menuseparator
19211 \begin_inset space ~
19225 to the internal document structure, some of the warnings will not appear
19227 There are two things you can do about this:
19230 \begin_layout Itemize
19233 Chk\SpecialChar TeX
19236 invocation command line in
19237 \begin_inset Flex MenuItem
19240 \begin_layout Plain Layout
19241 Tools\SpecialChar menuseparator
19242 Preferences\SpecialChar menuseparator
19243 Output\SpecialChar menuseparator
19245 \change_deleted -712698321 1437633504
19248 \change_inserted -712698321 1437633507
19251 \SpecialChar menuseparator
19253 \change_deleted -712698321 1437633509
19256 \change_inserted -712698321 1437633511
19266 Chk\SpecialChar TeX
19269 installation configuration file (usually with the file
19274 See below to learn what warnings can be enabled and disabled on the command
19278 \begin_layout Itemize
19279 Export your document as a raw \SpecialChar LaTeX
19282 File\SpecialChar menuseparator
19283 Export\SpecialChar menuseparator
19292 Invoked in this way, it can be a hassle to find the corresponding place
19293 in the document inside \SpecialChar LyX
19294 , but with a little patience, you should be able
19298 \begin_layout Standard
19299 Here follows the warning messages that can be enabled and disabled in
19308 to disable a warning, and
19312 to enable a warning.
19313 The emphasized entries are disabled by default, because the default is
19316 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19321 \begin_layout Standard
19322 Notice that you should only use the options that enable and disable warnings,
19323 because \SpecialChar LyX
19324 relies on some of the other command line parameters to be set
19325 in a specific way to have a chance to communicate with
19332 \begin_layout Enumerate
19336 Command terminated with space.
19339 \begin_layout Enumerate
19342 Non-breaking space (
19343 \begin_inset Quotes eld
19351 \begin_inset Quotes erd
19354 ) should have been used.
19357 \begin_layout Enumerate
19361 You should enclose the previous parenthesis with
19362 \begin_inset Quotes eld
19370 \begin_inset Quotes erd
19376 \begin_layout Enumerate
19379 Italic correction (
19380 \begin_inset Quotes eld
19390 \begin_inset Quotes erd
19393 ) found in non-italic buffer.
19396 \begin_layout Enumerate
19399 Italic correction (
19400 \begin_inset Quotes eld
19410 \begin_inset Quotes erd
19413 ) found more than once.
19416 \begin_layout Enumerate
19420 No italic correction (
19421 \begin_inset Quotes eld
19431 \begin_inset Quotes erd
19437 \begin_layout Enumerate
19441 \begin_inset Quotes eld
19449 \begin_inset Quotes erd
19453 \begin_inset Quotes eld
19461 \begin_inset Quotes erd
19467 \begin_layout Enumerate
19470 Wrong length of dash may have been used.
19473 \begin_layout Enumerate
19477 \begin_inset Quotes eld
19485 \begin_inset Quotes erd
19489 \begin_inset Quotes eld
19497 \begin_inset Quotes erd
19503 \begin_layout Enumerate
19507 \begin_inset Quotes eld
19515 \begin_inset Quotes erd
19521 \begin_layout Enumerate
19525 \begin_inset Quotes eld
19533 \begin_inset Quotes erd
19536 to achieve an ellipsis.
19539 \begin_layout Enumerate
19542 Inter-word spacing (
19543 \begin_inset Quotes eld
19553 \begin_inset Quotes eld
19556 ) should perhaps be used.
19559 \begin_layout Enumerate
19562 Inter-sentence spacing (
19563 \begin_inset Quotes eld
19573 \begin_inset Quotes erd
19576 ) should perhaps be used.
19579 \begin_layout Enumerate
19582 Could not find argument for command.
19585 \begin_layout Enumerate
19589 \begin_inset Quotes eld
19597 \begin_inset Quotes erd
19603 \begin_layout Enumerate
19606 Math mode still on at end of \SpecialChar LaTeX
19610 \begin_layout Enumerate
19614 \begin_inset Quotes eld
19622 \begin_inset Quotes erd
19625 doesn't match the number of
19626 \begin_inset Quotes eld
19634 \begin_inset Quotes erd
19640 \begin_layout Enumerate
19643 You should use either
19646 \begin_inset Quotes eld
19654 \begin_inset Quotes erd
19659 as an alternative to
19660 \begin_inset Quotes eld
19668 \begin_inset Quotes erd
19674 \begin_layout Enumerate
19681 " (ASCII 39) instead of "
19688 \begin_layout Enumerate
19691 User-specified pattern found.
19694 \begin_layout Enumerate
19697 This command might not be intended.
19700 \begin_layout Enumerate
19707 \begin_layout Enumerate
19725 \begin_layout Enumerate
19728 Delete this space to maintain correct page references.
19731 \begin_layout Enumerate
19735 You might wish to put this between a pair of
19736 \begin_inset Quotes eld
19744 \begin_inset Quotes erd
19750 \begin_layout Enumerate
19753 You ought to remove spaces in front of punctuation.
19756 \begin_layout Enumerate
19759 Could not execute \SpecialChar LaTeX
19763 \begin_layout Enumerate
19772 in front of small punctuation.
19775 \begin_layout Enumerate
19783 may look prettier here.
19786 \begin_layout Enumerate
19790 Multiple spaces detected in output.
19793 \begin_layout Enumerate
19796 This text may be ignored.
19799 \begin_layout Enumerate
19805 \begin_inset Quotes eld
19810 to begin quotation, not
19817 \begin_layout Enumerate
19824 to end quotation, not
19827 \begin_inset Quotes eld
19835 \begin_layout Enumerate
19841 \begin_layout Enumerate
19844 You should perhaps use
19845 \begin_inset Quotes eld
19853 \begin_inset Quotes erd
19859 \begin_layout Enumerate
19862 You should put a space in front of/after parenthesis.
19865 \begin_layout Enumerate
19868 You should avoid spaces in front of/after parenthesis.
19871 \begin_layout Enumerate
19875 You should not use punctuation in front of/after quotes.
19878 \begin_layout Enumerate
19881 Double space found.
19884 \begin_layout Enumerate
19887 You should put punctuation outside inner/inside display math mode.
19890 \begin_layout Enumerate
19893 You ought to not use primitive \SpecialChar TeX
19894 in \SpecialChar LaTeX
19898 \begin_layout Enumerate
19901 You should remove spaces in front of
19902 \begin_inset Quotes eld
19910 \begin_inset Quotes erd
19916 \begin_layout Enumerate
19919 \begin_inset Quotes eld
19927 \begin_inset Quotes erd
19930 is normally not followed by
19931 \begin_inset Quotes eld
19939 \begin_inset Quotes erd
19945 \begin_layout Standard
19946 In later versions of \SpecialChar LyX
19947 , we hope to provide a more complete interface to this
19948 tool (and it's smaller cousin
19952 ) to exploit the full power of it.
19953 But it's not exactly useless as it is now: go try it on one of your existing
19954 documents of a certain length and be surprised.
19957 \begin_layout Section
19958 Version Control in \SpecialChar LyX
19962 \begin_layout Standard
19965 Lars Gullik Bjønnes
19972 \begin_layout Subsection
19976 \begin_layout Standard
19978 supports some of the most basic RCS/CVS/SVN/GIT commands.
19979 If you need something a bit more sophisticated you will have to do that
19980 manually in a terminal.
19983 \begin_layout Standard
19984 Also note that CVS support is not as good as subversion support so we advise
19986 A good place to start learning Subversion is SVN Book
19990 \begin_layout Plain Layout
19991 \begin_inset CommandInset href
19993 target "http://svnbook.red-bean.com/"
20003 In the case of RCS you should read
20004 \begin_inset Quotes eld
20008 \begin_inset Quotes erd
20011 (a man file, read it with
20016 This file describes all the basic features of RCS.
20017 You should especially notice the comment about a RCS directory, and the
20018 notion of a master RCS file (the file ending in
20025 \begin_layout Standard
20026 Before you begin to use the version control features in \SpecialChar LyX
20028 familiar with RCS/CVS/SVN/GIT usage.
20029 The implementation in \SpecialChar LyX
20030 assumes a recent version of the GNU RCS or CVS/SVN
20031 package — no guarantees are made for older versions.
20032 Most of the log messages are not currently displayed after operations —
20033 you can check them in the Messages pane if unsure.
20034 Regular users of version control will appreciate VC toolbar, which can
20037 View\SpecialChar menuseparator
20038 Toolbars\SpecialChar menuseparator
20040 \begin_inset space ~
20048 \begin_layout Standard
20049 For introducing your own external commands consult vc-command in the manual
20050 of \SpecialChar LyX
20054 \begin_layout Subsection
20055 RCS commands in \SpecialChar LyX
20059 \begin_layout Standard
20060 The following sections describe the RCS commands supported by \SpecialChar LyX
20062 You can find them in the
20064 File\SpecialChar menuseparator
20066 \begin_inset space ~
20073 was tested against RCS 5.7/5.8
20077 \begin_layout Plain Layout
20078 Note that old DOS / MS Windows builds (5.7) need to setup environment variables
20079 in order to work properly with \SpecialChar LyX
20081 In particular time zone (TZ) should be set and more importantly RCSINIT
20082 in order to change default archive location ("SET RCSINIT=-x,v/") — \SpecialChar LyX
20084 archive to be found in file.lyx,v within the original document directory.
20085 See also README shipped with Windows RCS binaries.
20093 \begin_layout Subsubsection
20099 \begin_layout Standard
20100 If your document is not under revision control, this is the only item shown
20102 And if it is under revision control, the
20106 item is not visible.
20110 \begin_layout Standard
20111 This command registers your document with RCS (unless you are under the
20112 directory managed by CVS)\SpecialChar endofsentence
20113 You are asked interactively to supply an initial
20114 description of the document.
20115 The document is now set in Read-Only mode and you have to
20118 \begin_inset space ~
20122 \begin_inset space ~
20126 \begin_inset space ~
20131 , before making any changes to it.
20132 A document under revision control has a
20133 \begin_inset Quotes eld
20136 [RCS:<version> <locker>]
20137 \begin_inset Quotes erd
20140 item tagged to the filename in the minibuffer.
20143 \begin_layout Standard
20144 RCS command that is run:
20146 ci -q -u -i -t-"<initial description>" <file-name>
20149 \begin_layout Standard
20154 to understand the switches.
20158 \begin_layout Subsubsection
20164 \begin_layout Standard
20165 When you are finished editing a file, you check in your changes.
20166 When you do this, you are asked for a description of the changes.
20167 This is stored in the history log.
20168 The version number is bumped, your changes are applied to the master RCS
20169 file, the document is unlocked and set to Read-Only mode.
20172 \begin_layout Standard
20175 ci -q -u -m"<description>" <file-name>
20178 \begin_layout Subsubsection
20184 \begin_layout Standard
20185 By doing this you lock the document so that only you can edit it.
20186 This will also make the document Read-Write only for you.
20187 You will usually continue editing for a while and when you are finished
20188 you check in your changes.
20189 The status line is changed to reflect that you have locked the file.
20192 \begin_layout Standard
20195 co -q -l <file-name>
20198 \begin_layout Subsubsection
20201 Revert To Repository Version
20204 \begin_layout Standard
20205 This will discard all changes made to the document since the last check
20207 You get a warning before changes are discarded.
20210 \begin_layout Standard
20213 co -f -u<version> <file-name>
20216 \begin_layout Subsubsection
20222 \begin_layout Standard
20223 This will create a copy of the current document.
20224 Since RCS does not support copy operations natively, the version history
20225 is not preserved, and the copy is added as a new file.
20226 It requires a clean document without any changes since the last checkin.
20227 You are asked for a file name and a description of the copy operation.
20228 After that the copy is created, both locally and in the repository.
20229 If the parent directories of the copied and original document differ, all
20230 relative paths of included files of the copy are adjusted (like in
20232 File\SpecialChar menuseparator
20237 Finally, the copy is loaded instead of the original document.
20240 \begin_layout Labeling
20241 \labelwidthstring 00.00.0000
20243 \begin_inset space ~
20247 \begin_inset space ~
20251 \begin_inset Newline newline
20255 \begin_inset Flex Code
20258 \begin_layout Plain Layout
20261 \begin_inset Quotes eld
20265 \begin_inset Quotes erd
20274 \begin_inset Flex Code
20277 \begin_layout Plain Layout
20280 \begin_inset Quotes eld
20284 \begin_inset Quotes erd
20293 \begin_inset Newline newline
20297 \begin_inset Flex Code
20300 \begin_layout Plain Layout
20304 \begin_inset Quotes eld
20308 \begin_inset Quotes erd
20319 \begin_layout Subsubsection
20325 \begin_layout Standard
20326 This makes as if the last check in never happened.
20327 No changes are made to the document loaded into \SpecialChar LyX
20328 , but the last version
20329 is removed from the master RCS file.
20332 \begin_layout Standard
20335 rcs -o<version> <file-name>
20338 \begin_layout Subsubsection
20344 \begin_layout Standard
20345 This shows the complete history of the RCS document.
20350 is shown in a browser.
20358 \begin_layout Subsubsection
20362 \begin_layout Standard
20364 supports RCS version number, author name, date and time of last commit.
20365 All those are extracted from
20367 rlog -r <file-name>
20371 \begin_inset CommandInset ref
20373 reference "subsec:VCS-Revision-Information"
20380 \begin_layout Subsection
20381 CVS commands in \SpecialChar LyX
20385 \begin_layout Standard
20386 A subset of CVS operations is supported by \SpecialChar LyX
20388 You can find the commands in the
20390 File\SpecialChar menuseparator
20392 \begin_inset space ~
20398 The version control system SVN is more powerful, so please use it instead
20399 of CVS if possible.
20402 \begin_layout Subsubsection
20408 \begin_layout Standard
20409 If you start from scratch with CVS you have to create your repository and
20410 checkout the working copy with external tools.
20411 If you're using a client-server setup you may need to login before doing
20412 the first repository checkout.
20415 \begin_layout Standard
20416 If your documents are under revision control and others are using the same
20417 repository problems arise when different changes to the same document at
20418 the same location happen.
20419 Standard CVS repositories don't operate with a file locking mechanism.
20420 This may be surprising, but conflicts only occur if people disagree on
20421 the proper content of the same part of a document.
20422 So, if co-workers are used to communicate regularly, these conflicts occur
20424 If they don't communicate they have a fundamental problem anyway.
20425 Nevertheless some people like to work with so called
20426 \begin_inset Quotes eld
20430 \begin_inset Quotes erd
20434 If they do so the working copy of all files is readonly when checked out
20435 first and the user starts editing after using a special command to make
20436 the working copy writable.
20437 When the changes are checked in the working copy returns to readonly state.
20438 With \SpecialChar LyX
20439 one has to edit the
20440 \begin_inset Flex Code
20443 \begin_layout Plain Layout
20449 file and add the line
20450 \begin_inset Flex Code
20453 \begin_layout Plain Layout
20459 to work with reserved checkouts.
20460 The benefit is the possibility to see who is using a writable copy of some
20462 It's not guaranteed only one user makes a copy writable.
20465 \begin_layout Standard
20467 tries to guess if you're using reserved or non-reserved checkouts.
20468 If your working copy is readonly or it is writable and an additional copy
20469 of your document exists in the CVS/Base sub-directory a reserved otherwise
20470 a non-reserved checkout is assumed.
20471 When a reserved checkout is detected you have to use
20472 \begin_inset Flex MenuItem
20475 \begin_layout Plain Layout
20481 to make your working copy writable if it's readonly.
20483 \begin_inset Flex MenuItem
20486 \begin_layout Plain Layout
20492 operation is possible and that makes your working copy readonly again after
20493 transferring your changes to the repository.
20496 \begin_layout Standard
20497 More information about CVS can be found here
20498 \begin_inset Flex URL
20501 \begin_layout Plain Layout
20503 http://www.nongnu.org/cvs
20509 \begin_inset Flex URL
20512 \begin_layout Plain Layout
20514 http://ximbiot.com/cvs
20522 \begin_layout Standard
20527 to understand the sub-commands and the switches mentioned below.
20530 \begin_layout Subsubsection
20536 \begin_layout Standard
20537 If your document is not under revision control, this is the only item shown
20539 And if it is under revision control, the
20546 item is not visible.
20550 \begin_layout Standard
20551 This command registers in CVS your document
20552 \begin_inset Flex Strong
20555 \begin_layout Plain Layout
20563 in the case you have already the documents directory under CVS control
20569 This means you have to create or checkout the archive by yourself using
20571 (In case you forget that step \SpecialChar LyX
20572 registers the document with RCS.)
20575 \begin_layout Standard
20576 Then you are asked interactively to supply an initial description of the
20578 Don't forget that registered file is not yet checked in.
20581 \begin_layout Standard
20582 CVS command that is run:
20584 cvs -q add -m"<entered message>" "<file-name>"
20587 \begin_layout Standard
20592 above and for all other CVS commands is an abbreviation for
20593 \begin_inset Quotes eld
20596 change the current working directory to file location and use the file name
20597 without path component as argument
20598 \begin_inset Quotes erd
20604 \begin_layout Subsubsection
20610 \begin_layout Standard
20611 When you are finished editing a file, you commit your changes.
20612 When you do this and you had changed the document, you are asked for a
20613 description of the changes.
20614 After that changes are written to the repository.
20615 In case you didn't change the document and a reserved checkout is detected
20616 the reservation made on
20617 \begin_inset Flex MenuItem
20620 \begin_layout Plain Layout
20629 \begin_layout Labeling
20630 \labelwidthstring 00.00.0000
20632 \begin_inset space ~
20636 \begin_inset space ~
20640 \begin_inset Newline newline
20644 \begin_inset Flex Code
20647 \begin_layout Plain Layout
20650 -q commit -m"<description>" "<file-name>"
20656 \begin_inset Newline newline
20660 \begin_inset Flex Code
20663 \begin_layout Plain Layout
20674 \begin_layout Subsubsection
20680 \begin_layout Standard
20681 When you are sharing a repository with others, you may have to incorporate
20682 their changes into your working copy.
20685 \begin_layout Standard
20688 cvs -q update "<file-name>"
20691 \begin_layout Standard
20692 If a readonly checkout is detected the working copy is made writable and
20696 \begin_layout Standard
20699 cvs -q edit "<file-name>"
20702 \begin_layout Subsubsection
20705 Revert To Repository Version
20708 \begin_layout Standard
20709 This will discard all changes made to the document since the last check
20711 You get a warning before changes are discarded.
20712 Firstly the file is deleted, secondly CVS update command is run.
20715 \begin_layout Standard
20718 cvs -q update "<file-name>"
20721 \begin_layout Standard
20722 If a reserved checkout is detected and the working copy has no changes only
20723 the reservation is undone.
20726 \begin_layout Standard
20729 cvs -q unedit "<file-name>"
20732 \begin_layout Subsubsection
20738 \begin_layout Standard
20739 This will create a copy of the current document.
20740 Since CVS does not support copy operations natively, the version history
20741 is not preserved, and the copy is added as a new file.
20742 It requires a clean document without any changes since the last checkin.
20743 You are asked for a file name and a description of the copy operation.
20744 After that the copy is created, both locally and in the repository.
20745 If the parent directories of the copied and original document differ, all
20746 relative paths of included files of the copy are adjusted (like in
20748 File\SpecialChar menuseparator
20753 Finally, the copy is loaded instead of the original document.
20756 \begin_layout Labeling
20757 \labelwidthstring 00.00.0000
20759 \begin_inset space ~
20763 \begin_inset space ~
20767 \begin_inset Newline newline
20771 \begin_inset Flex Code
20774 \begin_layout Plain Layout
20777 \begin_inset Quotes eld
20781 \begin_inset Quotes erd
20790 \begin_inset Flex Code
20793 \begin_layout Plain Layout
20796 \begin_inset Quotes eld
20800 \begin_inset Quotes erd
20809 \begin_inset Newline newline
20813 \begin_inset Flex Code
20816 \begin_layout Plain Layout
20820 \begin_inset Quotes eld
20824 \begin_inset Quotes erd
20835 \begin_layout Subsubsection
20841 \begin_layout Standard
20842 This will rename the current document.
20843 Since CVS does not support rename operations natively, the version history
20844 is not preserved, the renamed document is added as a new file, and the
20845 original document is deleted.
20846 It requires a clean document without any changes since the last checkin.
20847 You are asked for a file name and a description of the rename operation.
20848 After that the document is renamed, both locally and in the repository.
20849 If the parent directories of the new and old file names differ, all relative
20850 paths of included files are adjusted (like in
20852 File\SpecialChar menuseparator
20857 Finally, the document is reloaded using the new name.
20860 \begin_layout Labeling
20861 \labelwidthstring 00.00.0000
20863 \begin_inset space ~
20867 \begin_inset space ~
20871 \begin_inset Newline newline
20875 \begin_inset Flex Code
20878 \begin_layout Plain Layout
20881 \begin_inset Quotes eld
20885 \begin_inset Quotes erd
20894 \begin_inset Flex Code
20897 \begin_layout Plain Layout
20900 \begin_inset Quotes eld
20904 \begin_inset Quotes erd
20913 \begin_inset Newline newline
20917 \begin_inset Flex Code
20920 \begin_layout Plain Layout
20924 \begin_inset Quotes eld
20928 \begin_inset Quotes erd
20937 \begin_inset Newline newline
20941 \begin_inset Flex Code
20944 \begin_layout Plain Layout
20948 \begin_inset Quotes eld
20952 \begin_inset Quotes erd
20963 \begin_layout Subsubsection
20964 Update of the local directory checkout from repository
20967 \begin_layout Standard
20968 Once your documents gets more complex, containing sub-documents and pictures,
20970 \begin_inset Flex Code
20973 \begin_layout Plain Layout
20979 files and so on using version control becomes more complicated.
20981 supports updating the whole tree in which resides the document.
20982 This become especially useful once you cooperate with people which neither
20983 have detailed knowledge about CVS usage nor they have ambition to commit
20984 additional material to the repository.
20985 You have to organize the files structure so that all external files are
20986 in the same directory or subdirectories of the document.
20987 It's good practice anyway to store multipart documents in an extra directory.
20990 \begin_layout Standard
20992 \begin_inset Flex Code
20995 \begin_layout Plain Layout
20996 Update local directory from repository
21001 command updates the whole directory.
21002 If local changes are detected user is warned before update starts.
21003 In case of merge conflicts both versions of the conflicting document parts
21004 are placed in the final document.
21005 You have to review and correct the result of the merge.
21006 You'll find the conflicts enclosed in pairs of
21007 \begin_inset Flex Code
21010 \begin_layout Plain Layout
21017 \begin_inset Flex Code
21020 \begin_layout Plain Layout
21027 \begin_inset Flex Code
21030 \begin_layout Plain Layout
21037 The first part is your version as before the update operation with the
21038 document name prepended.
21039 The second one is the repository version with the version number after
21041 \begin_inset Flex Code
21044 \begin_layout Plain Layout
21053 \begin_layout Labeling
21054 \labelwidthstring 00.00.0000
21056 \begin_inset space ~
21060 \begin_inset space ~
21064 \begin_inset Newline newline
21068 \begin_inset Flex Code
21071 \begin_layout Plain Layout
21079 (Ask if changes are detected.)
21080 \begin_inset Newline newline
21084 \begin_inset Flex Code
21087 \begin_layout Plain Layout
21088 cd $path; cvs -q update
21098 \begin_layout Standard
21100 \begin_inset Flex Code
21103 \begin_layout Plain Layout
21109 stands for the path to the document.
21112 \begin_layout Subsubsection
21118 \begin_layout Standard
21119 This shows the complete history of the CVS document.
21122 cvs log "<file-name>"
21124 is shown in a browser.
21127 \begin_layout Subsubsection
21131 \begin_layout Standard
21133 supports CVS version number, author name, date and time of last commit.
21134 All those are extracted from
21136 cvs log -r <file-name>
21140 \begin_inset CommandInset ref
21142 reference "subsec:VCS-Revision-Information"
21149 \begin_layout Subsection
21150 SVN commands in \SpecialChar LyX
21154 \begin_layout Standard
21155 SVN is now partially supported by \SpecialChar LyX
21157 You can find the commands in the
21159 File\SpecialChar menuseparator
21161 \begin_inset space ~
21167 Please note that if you use password protected access to repository via
21168 ssh, you will be asked in terminal window.
21170 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21174 \begin_layout Plain Layout
21175 Most of the commands will work with 1.4 too, see
21176 \begin_inset CommandInset ref
21178 reference "subsec:SVN-Repo-Update"
21183 There seems to be currently unresolved permissions problem under SVN 1.8
21184 with reverting changes when file is locked.
21192 \begin_layout Subsubsection
21198 \begin_layout Standard
21199 If your document is not under revision control, this is the only item shown
21201 And if it is under revision control, the
21208 item is not visible.
21211 \begin_layout Standard
21212 This command registers in SVN your document ONLY in case you have already
21213 the documents directory under SVN control (in particular
21218 This means you have to checkout the archive by yourself.
21221 \begin_layout Standard
21222 Then you are asked interactively to supply an initial description of the
21224 Don't forget that registered file is not yet commited.
21227 \begin_layout Standard
21228 SVN command that is run:
21231 \begin_inset Quotes eld
21235 \begin_inset Quotes erd
21241 \begin_layout Standard
21246 to understand the switches.
21249 \begin_layout Subsubsection
21255 \begin_layout Standard
21256 When you are finished editing a file, you commit your changes.
21257 When you do this, you are asked for a description of the changes.
21258 After that changes are commited.
21261 \begin_layout Standard
21266 \begin_layout Plain Layout
21267 In case locking is not enabled.
21269 \begin_inset CommandInset ref
21271 reference "subsec:SVN-File-Locking"
21282 svn commit -q -m"<description>" <file-name>
21285 \begin_layout Subsubsection
21291 \begin_layout Standard
21292 Updates the changes of this file from the repository.
21293 Be sure you understand SVN merging and conflicts resolving before using
21294 this function, because all conflicts has to be resolved manually by you!
21297 \begin_layout Standard
21302 \begin_layout Plain Layout
21310 svn update --non-interactive
21311 \begin_inset Quotes eld
21315 \begin_inset Quotes erd
21321 \begin_layout Subsubsection
21324 Revert To Repository Version
21327 \begin_layout Standard
21328 This will discard all changes made to the document since the last check
21330 You get a warning before changes are discarded.
21333 \begin_layout Standard
21337 \begin_inset Quotes eld
21341 \begin_inset Quotes erd
21347 \begin_layout Subsubsection
21353 \begin_layout Standard
21354 This will create a copy of the current document including the version history.
21355 It requires a clean document without any changes since the last checkin.
21356 You are asked for a file name and a description of the copy operation.
21357 After that the copy is created, both locally and in the repository.
21358 If the parent directories of the copied and original document differ, all
21359 relative paths of included files of the copy are adjusted (like in
21361 File\SpecialChar menuseparator
21366 Finally, the copy is loaded instead of the original document.
21369 \begin_layout Labeling
21370 \labelwidthstring 00.00.0000
21372 \begin_inset space ~
21376 \begin_inset space ~
21380 \begin_inset Newline newline
21384 \begin_inset Flex Code
21387 \begin_layout Plain Layout
21391 \begin_inset Quotes eld
21395 \begin_inset Quotes erd
21399 \begin_inset Quotes eld
21403 \begin_inset Quotes erd
21412 \begin_inset Newline newline
21416 \begin_inset Flex Code
21419 \begin_layout Plain Layout
21428 \begin_layout Subsubsection
21434 \begin_layout Standard
21435 This will rename the current document including the version history.
21436 It requires a clean document without any changes since the last checkin.
21437 You are asked for a file name and a description of the rename operation.
21438 After that the document is renamed, both locally and in the repository.
21439 If the parent directories of the new and old file names differ, all relative
21440 paths of included files are adjusted (like in
21442 File\SpecialChar menuseparator
21447 Finally, the document is reloaded using the new name.
21450 \begin_layout Labeling
21451 \labelwidthstring 00.00.0000
21453 \begin_inset space ~
21457 \begin_inset space ~
21461 \begin_inset Newline newline
21465 \begin_inset Flex Code
21468 \begin_layout Plain Layout
21472 \begin_inset Quotes eld
21476 \begin_inset Quotes erd
21480 \begin_inset Quotes eld
21484 \begin_inset Quotes erd
21493 \begin_inset Newline newline
21497 \begin_inset Flex Code
21500 \begin_layout Plain Layout
21509 \begin_layout Subsubsection
21510 \begin_inset CommandInset label
21512 name "subsec:SVN-Repo-Update"
21516 Update of the local directory checkout from repository
21520 \begin_layout Plain Layout
21521 Note that this command will work only with subversion
21522 \begin_inset Formula $\geqq1.5$
21533 \begin_layout Standard
21534 All the commands above have one shortcomming - they deal with the current
21536 Once your document contains pictures, includes external
21537 \begin_inset Flex Code
21540 \begin_layout Plain Layout
21546 files and so on administration becomes more complicated.
21548 now supports updating the whole tree in which resides the document
21552 \begin_layout Plain Layout
21553 One need to organize the files structure so that all external files are
21554 in the same directory or subdirectories of the document.
21561 This become especially useful once you cooperate with people which neither
21562 know about subversion management nor they have ambition to commit additional
21563 material to the repository.
21567 \begin_layout Standard
21568 \begin_inset Flex Code
21571 \begin_layout Plain Layout
21572 Update local directory from repository
21577 command updates the whole directory and in case of merge conflicts local
21578 version of the files are left, so no unintended data loss occurs.
21579 If local changes are detected user is warned before update starts.
21582 \begin_layout Labeling
21583 \labelwidthstring 00.00.0000
21585 \begin_inset space ~
21589 \begin_inset space ~
21593 \begin_inset Newline newline
21597 \begin_inset Flex Code
21600 \begin_layout Plain Layout
21606 (Ask if changes are detected.)
21607 \begin_inset Newline newline
21611 \begin_inset Flex Code
21614 \begin_layout Plain Layout
21615 svn update –accept mine-full $path
21623 \begin_layout Standard
21625 \begin_inset Flex Code
21628 \begin_layout Plain Layout
21634 stands for the path to the document.
21637 \begin_layout Subsubsection
21643 \begin_layout Standard
21644 This shows the complete history of the SVN document.
21648 \begin_inset Quotes eld
21652 \begin_inset Quotes erd
21657 is shown in a browser.
21660 \begin_layout Subsubsection
21662 \begin_inset CommandInset label
21664 name "subsec:SVN-File-Locking"
21671 \begin_layout Standard
21672 The file exchange through various revision control systems brings the problem
21673 of merge conflicts in case two different users try to edit the same (parts
21675 When such a conflict happens it needs manual resolving and one reasonable
21676 alternative is to provide some kind of locking mechanism, which guarantees
21677 that only one user is allowed to edit file at the given time.
21680 \begin_layout Standard
21681 SVN has two such mechanisms to provide mutual exclusivity for file access
21682 - locks and automatic setting of write permissions (see sec.
21684 \begin_inset CommandInset ref
21686 reference "subsec:Automatical-Locking-Property"
21691 \begin_inset Flex Code
21694 \begin_layout Plain Layout
21704 \begin_layout Plain Layout
21705 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21711 If this property is detected for a given document \SpecialChar LyX
21712 starts to use SVN locks
21713 for document editing automatically and the whole check-in/out mechanism
21714 switches to the same regimen as for RCS.
21715 This in particular means there are two different modes of file use in \SpecialChar LyX
21719 \begin_layout Itemize
21721 The loaded file is in the read-only mode.
21722 For editing on needs to check-out.
21727 consists of updating from the repository and gaining write lock.
21728 If the lock is not possible to obtain, we remain in unlocked state.
21731 \begin_layout Itemize
21733 The loaded file is in the 'normal' edit mode.
21734 No other user is allowed to edit the file.
21739 consists of commiting changes and releasing write-lock.
21740 If no changes have been made to the document, no commit will be produced
21744 \begin_layout Plain Layout
21745 Don't be puzzled by the fact that you will be asked for commit message anyway.
21750 and only the write-lock will be released.
21753 \begin_layout Standard
21757 \begin_layout Labeling
21758 \labelwidthstring 00.00.0000
21761 svn commit -q -m"<description>" "<file-name>"
21762 \begin_inset Newline newline
21765 svn unlock "<file-name>"
21768 \begin_layout Labeling
21769 \labelwidthstring 00.00.0000
21772 svn update "<file-name>"
21773 \begin_inset Newline newline
21776 svn lock "<file-name>"
21779 \begin_layout Subsubsection
21782 \begin_inset CommandInset label
21784 name "subsec:Automatical-Locking-Property"
21790 Automatic Locking Property
21793 \begin_layout Standard
21794 The above mentioned automatic setting of write permissions of the .lyx file
21800 ile\SpecialChar menuseparator
21806 \begin_inset space ~
21809 Control\SpecialChar menuseparator
21814 oggle locking property
21817 This command is active only when the file is not locked on the svn server
21819 you need to check-out before proceeding).
21822 \begin_layout Labeling
21823 \labelwidthstring 00.00.0000
21825 \begin_inset space ~
21831 \begin_layout Labeling
21832 \labelwidthstring 00.00.0000
21835 svn propset svn:needs-lock ON "<file-name>"
21838 \begin_layout Labeling
21839 \labelwidthstring 00.00.0000
21842 svn propdel svn:needs-lock "<file-name>"
21845 \begin_layout Subsubsection
21846 \begin_inset CommandInset label
21848 name "subsec:VCS-Revision-Information"
21852 Revision Information in Documents
21855 \begin_layout Standard
21856 There are more possibilities how to activate revision information in our
21860 \begin_layout Itemize
21863 \begin_inset Separator parbreak
21870 \begin_layout Itemize
21871 tree revision information (
21872 \begin_inset Flex Code
21875 \begin_layout Plain Layout
21882 The result is the output of the
21883 \begin_inset Flex Code
21886 \begin_layout Plain Layout
21892 command, the following table gives you an idea, how to read the results.
21895 \begin_layout Standard
21897 \begin_inset Tabular
21898 <lyxtabular version="3" rows="6" columns="2">
21899 <features tabularvalignment="middle">
21900 <column alignment="center" valignment="top">
21901 <column alignment="center" valignment="top">
21903 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21906 \begin_layout Plain Layout
21912 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21915 \begin_layout Plain Layout
21923 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21926 \begin_layout Plain Layout
21932 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21935 \begin_layout Plain Layout
21936 mixed revision working copy
21943 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21946 \begin_layout Plain Layout
21952 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21955 \begin_layout Plain Layout
21956 modified working copy
21963 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21966 \begin_layout Plain Layout
21972 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21975 \begin_layout Plain Layout
21976 switched working copy
21983 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21986 \begin_layout Plain Layout
21992 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21995 \begin_layout Plain Layout
21996 partial working copy, from a sparse checkout
22003 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22006 \begin_layout Plain Layout
22012 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22015 \begin_layout Plain Layout
22016 mixed revision, modified, switched working copy
22029 \begin_layout Itemize
22030 file revision information.
22031 The result comes from parsing the output of
22032 \begin_inset Flex Code
22035 \begin_layout Plain Layout
22037 \begin_inset space ~
22041 \begin_inset space ~
22045 \begin_inset space ~
22054 Supported flags are:
22055 \begin_inset Separator parbreak
22062 \begin_layout Itemize
22063 version number of the last commit (
22064 \begin_inset Flex Code
22067 \begin_layout Plain Layout
22076 \begin_layout Itemize
22077 author of the last commit (
22078 \begin_inset Flex Code
22081 \begin_layout Plain Layout
22090 \begin_layout Itemize
22091 date of the last commit (
22092 \begin_inset Flex Code
22095 \begin_layout Plain Layout
22104 \begin_layout Itemize
22105 time of the last commit (
22106 \begin_inset Flex Code
22109 \begin_layout Plain Layout
22119 \begin_layout Standard
22120 You can obtain this info via InsetInfo (e.g.
22122 \begin_inset Flex Code
22125 \begin_layout Plain Layout
22126 info-insert buffer vcs-date
22132 The information will be available only when you have the file stored under
22133 svn managment (i.e.
22135 \begin_inset Flex Code
22138 \begin_layout Plain Layout
22144 directory is available with your document).
22148 \begin_layout Itemize
22149 Another—a hacking one—possibility is to use svn keywords
22153 \begin_layout Plain Layout
22154 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22160 In short – you set file keywords property (e.g.
22163 svn propset svn:keywords 'Rev' file.lyx
22165 ) and then paste keyword \SpecialChar TeX
22170 \begin_layout Plain Layout
22171 This is an easy way how to ensure that \SpecialChar LyX
22172 won't break the line in the middle
22178 tag in your document (e.g.
22183 \begin_layout Plain Layout
22191 This way svn client will automatically substitute revision number (e.g.
22196 \begin_layout Plain Layout
22203 ) after each update and commit.
22204 There are more problems with this approach.
22205 Firstly, the '$' character is used in \SpecialChar TeX
22206 world for math equations, so any
22207 occurence of math formula
22208 \begin_inset Formula $Rev$
22212 \begin_inset Formula $Rev:59$
22215 in your \SpecialChar LyX
22217 Similarly for other keywords like Id, Date, Author, etc.
22218 Secondly svn output is dependent on your locales, so its very easy that
22219 svn would produce some problematic strings once Date is used.
22220 Thirdly you get the whole 'Rev: 59' string in your document instead of
22222 Until subversion implements user's custom keywords it will be hard to use
22223 this approach reliably or let \SpecialChar LyX
22224 to support it directly.
22227 \begin_layout Subsection
22228 SVN and Windows Environment
22231 \begin_layout Quote
22232 My inclination is to say that if the user cannot figure out the command
22233 line operations on their own fairly quickly, they would be well advised
22234 to use TortoiseSVN.
22240 \begin_layout Subsubsection
22244 \begin_layout Standard
22245 In addition to installing \SpecialChar LyX
22246 , and having access to a Subversion repository,
22247 the user will need to install the Subversion client program.
22248 A Windows installer for the client program is available from
22249 \begin_inset CommandInset href
22252 target "http://www.collab.net/nonav/downloads/subversion/"
22257 The user may also want to install
22258 \begin_inset CommandInset href
22261 target "http://tortoisesvn.tigris.org/"
22265 , which integrates Subversion operations into the context (rightclick) menu
22266 of Windows Explorer.
22267 Operations done outside \SpecialChar LyX
22268 will typically be more convenient using the Explorer
22270 Note that TortoiseSVN is not a replacement for the client program, which
22271 is what \SpecialChar LyX
22275 \begin_layout Subsubsection
22276 Bringing a document under Subversion control
22279 \begin_layout Standard
22280 Before a \SpecialChar LyX
22281 document can be brought under version control in Subversion, its
22282 parent directory needs to be under version control.
22283 If the document is being added to a project already in the repository,
22284 this is accomplished by checking the project out to the directory where
22285 the new document will be placed.
22286 If the project itself is not yet under version control (for instance, if
22287 this document starts a new project), the directory must be imported into
22289 This is done outside \SpecialChar LyX
22291 Both import and checkout are easily accomplished from the Explorer context
22292 menu using TortoiseSVN, or alternatively can be done using the command
22293 line client at a DOS prompt.
22294 The procedure for importing the project using TortoiseSVN is described
22295 below, assuming an existing repository and a new project being started
22303 For information on using the Subversion client program, run
22310 \begin_layout Enumerate
22317 in Windows Explorer, right click it, and select
22319 TortoiseSVN\SpecialChar menuseparator
22323 If necessary, adjust the URL for the repository, then click OK.
22326 \begin_layout Enumerate
22327 Right click the level of the repository under which you want to place the
22328 new project folder (typically the top level) and click
22332 Supply a name for the project folder and click OK.
22333 Add a message for the log file if desired, then click OK again.
22334 The new project folder should appear in the repository.
22335 Finally, click OK again to exit the repository browser.
22338 \begin_layout Enumerate
22339 Once again right click
22345 , this time selecting SVN Checkout\SpecialChar ldots
22346 Select the URL of the project folder
22347 you just created in the repository, and set the checkout directory to
22355 You will be warned about a non-empty folder; click OK to proceed.
22356 You should now have a
22367 \begin_layout Enumerate
22368 Create or open your document in \SpecialChar LyX
22371 File\SpecialChar menuseparator
22373 \begin_inset space ~
22376 Control\SpecialChar menuseparator
22380 Add a log message and click OK to commit the document to version control.
22383 \begin_layout Standard
22384 From this point onward, you should have full functionality in the
22386 File\SpecialChar menuseparator
22388 \begin_inset space ~
22394 You also have the option of checking the document in and out, viewing its
22396 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22397 client program from a command prompt.
22400 \begin_layout Subsubsection
22401 SSH tunnel used with SVN under Windows
22404 \begin_layout Standard
22405 Compared with Linux setting up an svn client to communicate over ssh under
22406 Windows is a rather troublesome task.
22407 We will at least offer some hints how to setup the client side but prior
22408 knowledge about ssh and the Windows command line is needed, also be prepared
22409 for a great deal of frustration\SpecialChar ldots
22413 \begin_layout Enumerate
22414 Get an svn client for windows, as described in the previous sections.
22415 When it is a fresh install run some svn command (e.g.
22417 \begin_inset Flex Code
22420 \begin_layout Plain Layout
22426 ) to create config files, which you will need to change later on.
22429 \begin_layout Enumerate
22430 Choose an ssh client for Windows.
22431 There are several possibilities, we will use the one from Putty tools
22435 \begin_layout Plain Layout
22436 \begin_inset Flex URL
22439 \begin_layout Plain Layout
22441 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22452 You will need to set the connection up so that the client doesn't ask for
22453 any password from you.
22454 To keep things easy we will use only keys without any additional password
22456 \begin_inset Separator parbreak
22463 \begin_layout Enumerate
22465 \begin_inset Flex Code
22468 \begin_layout Plain Layout
22475 Save your private .ppk key file and put the public one on the server side.
22476 If the SVN server runs on Linux, note that the format of the public key
22477 is not compatible with Linux openssh and you will need to direcly copy-paste
22480 Public key for pasting into OpenSSH authorized_keys file
22482 :” edit field into the server's
22483 \begin_inset Flex Code
22486 \begin_layout Plain Layout
22487 ~/.ssh/authorized_keys
22493 \begin_inset Flex Code
22496 \begin_layout Plain Layout
22505 \begin_layout Enumerate
22507 \begin_inset Flex Code
22510 \begin_layout Plain Layout
22517 In the SVN config file
22521 \begin_layout Plain Layout
22522 Exact path depends on Windows version, usually somewhere around
22523 \begin_inset Flex Code
22526 \begin_layout Plain Layout
22529 Documents and Settings
22543 \begin_inset Flex Code
22546 \begin_layout Plain Layout
22561 , section [tunnels], setup ssh command, e.g.
22563 \begin_inset Flex Code
22566 \begin_layout Plain Layout
22567 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22576 \begin_layout Plain Layout
22577 It will usually take a lot of time to get exact command right and it depends
22579 For example do not have some remote server saved as a default session in
22581 If things fail, try to connect via plink without SVN first.
22590 \begin_layout Enumerate
22591 Checkout the SVN archive, e.
22592 \begin_inset space \thinspace{}
22596 \begin_inset Newline newline
22600 \begin_inset Flex Code
22603 \begin_layout Plain Layout
22604 svn co svn+ssh://user@server/repository_path
22612 \begin_layout Subsubsection
22613 End-of-Line Conversions
22616 \begin_layout Standard
22617 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22619 use different line endings inside the .lyx files.
22620 This is not a problem as far as \SpecialChar LyX
22621 functionality is concerned, but the commit
22622 diffs will be huge and merge-conflicts prone.
22623 Fortunately SVN itself knows
22627 \begin_layout Plain Layout
22628 \begin_inset Flex URL
22631 \begin_layout Plain Layout
22633 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22643 how to deal with CR/LF problems when switching .lyx files to the
22644 \begin_inset Flex Code
22647 \begin_layout Plain Layout
22657 \begin_layout Plain Layout
22659 \begin_inset Flex Code
22662 \begin_layout Plain Layout
22663 svn propset svn:eol-style native FILE_NAME
22676 \begin_layout Subsection
22677 GIT commands in \SpecialChar LyX
22681 \begin_layout Standard
22682 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22684 You can find the commands in the
22686 File\SpecialChar menuseparator
22688 \begin_inset space ~
22694 Please note that if you use password protected access to repository via
22695 ssh, you will be asked in terminal window.
22697 was tested against GIT 1.7.
22701 \begin_layout Plain Layout
22702 Windows users please note that you need to ensure that git is on the path.
22703 This can be set from within \SpecialChar LyX
22706 Tools\SpecialChar menuseparator
22707 Preferences\SpecialChar menuseparator
22708 Paths\SpecialChar menuseparator
22719 \begin_layout Standard
22720 One big difference of GIT and the other supported version control systems
22721 is the distributed nature of GIT: With traditional version control systems
22722 there is one central server which hosts the repository.
22723 Users commit their changes to the server, and get updates made by other
22725 With GIT, users commit to a local repository.
22726 The local repository can be synchronized with one or more remote repositories
22728 \begin_inset Flex Code
22731 \begin_layout Plain Layout
22738 \begin_inset Flex Code
22741 \begin_layout Plain Layout
22749 does not interact in any way with remote GIT repositories.
22750 It works exclusively with the local repository in a very similar way as
22751 with a central CVS or SVN repository.
22752 If you use remote GIT repositories you need to do the
22753 \begin_inset Flex Code
22756 \begin_layout Plain Layout
22763 \begin_inset Flex Code
22766 \begin_layout Plain Layout
22772 operations with your favourite GIT client.
22775 \begin_layout Subsubsection
22781 \begin_layout Standard
22782 If your document is not under revision control, this is the only item shown
22784 And if it is under revision control, the
22791 item is not visible.
22794 \begin_layout Standard
22795 This command registers in GIT your document ONLY in case you have already
22796 the documents directory under GIT control (in particular
22801 This means you have to checkout the archive by yourself.
22804 \begin_layout Standard
22805 Then you are asked interactively to supply an initial description of the
22807 Don't forget that registered file is not yet commited.
22810 \begin_layout Standard
22811 GIT command that is run:
22814 \begin_inset Quotes eld
22818 \begin_inset Quotes erd
22824 \begin_layout Standard
22829 to understand the switches.
22832 \begin_layout Subsubsection
22838 \begin_layout Standard
22839 When you are finished editing a file, you commit your changes.
22840 When you do this, you are asked for a description of the changes.
22841 After that changes are commited.
22844 \begin_layout Standard
22847 git commit -q -m"<description>" <file-name>
22850 \begin_layout Subsubsection
22853 Revert To Repository Version
22856 \begin_layout Standard
22857 This will discard all changes made to the document since the last check
22859 You get a warning before changes are discarded.
22862 \begin_layout Standard
22866 \begin_inset Quotes eld
22870 \begin_inset Quotes erd
22876 \begin_layout Subsubsection
22882 \begin_layout Standard
22883 This will rename the current document including the version history.
22884 It requires a clean document without any changes since the last checkin.
22885 You are asked for a file name and a description of the rename operation.
22886 After that the document is renamed, both locally and in the repository.
22887 If the parent directories of the new and old file names differ, all relative
22888 paths of included files are adjusted (like in
22890 File\SpecialChar menuseparator
22895 Finally, the document is reloaded using the new name.
22898 \begin_layout Labeling
22899 \labelwidthstring 00.00.0000
22901 \begin_inset space ~
22905 \begin_inset space ~
22909 \begin_inset Newline newline
22913 \begin_inset Flex Code
22916 \begin_layout Plain Layout
22920 \begin_inset Quotes eld
22924 \begin_inset Quotes erd
22928 \begin_inset Quotes eld
22932 \begin_inset Quotes erd
22941 \begin_inset Newline newline
22945 \begin_inset Flex Code
22948 \begin_layout Plain Layout
22957 \begin_layout Subsubsection
22963 \begin_layout Standard
22964 This shows the complete history of the GIT document.
22968 \begin_inset Quotes eld
22972 \begin_inset Quotes erd
22977 is shown in a browser.
22980 \begin_layout Subsubsection
22984 \begin_layout Standard
22986 supports GIT hash number of the last commit to the file, author name, date
22987 and time of last commit.
22988 All those are extracted from
22990 git log -n 1 --pretty=format:%H%n%an%n%ai
22993 Tree version information is obtained via
22995 git describe --abbrev --dirty --long
22999 \begin_inset CommandInset ref
23001 reference "subsec:VCS-Revision-Information"
23008 \begin_layout Subsection
23012 \begin_layout Standard
23013 With the recent addition of the vc-command function \SpecialChar LyX
23014 power users are allowed
23015 to create their own commands for revision control.
23018 \begin_layout Standard
23019 As an example you can see how two TortoiseSVN commands could be integrated
23023 \begin_layout Description
23025 \begin_inset Flex Code
23028 \begin_layout Plain Layout
23029 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23037 \begin_layout Description
23039 \begin_inset Flex Code
23042 \begin_layout Plain Layout
23043 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23051 \begin_layout Subsection
23052 Version control and Document comparison
23055 \begin_layout Standard
23056 One of the typical uses of version control is to inspect the changes between
23057 revisions, usually by creating
23058 \begin_inset Flex Code
23061 \begin_layout Plain Layout
23068 While this is useful for plain text files, it is much less useful in the
23069 case of \SpecialChar LyX
23070 files, which have more a complicated structure.
23071 Hence we provide binding to the Document comparison feature.
23072 There are two ways of calling this feature - either by direct call of
23073 \begin_inset Flex Code
23076 \begin_layout Plain Layout
23083 function (for details see \SpecialChar LyX
23084 functions manual) or by icon/menu item
23085 \begin_inset Flex MenuItem
23088 \begin_layout Plain Layout
23089 Compare with older revision...
23095 One can either compare two chosen revisions of the document or he can simply
23096 compare the current version of edited text with older revisions (where
23098 \begin_inset Flex MenuItem
23101 \begin_layout Plain Layout
23107 ' revisions back means comparison of the edited file with last commited
23112 \begin_layout Standard
23113 This feature is supported for SVN and RCS though due to the more complicated
23114 versioning scheme of RCS there is a constraint – when addressing the revisions
23115 in dialog, numbers always point to the last number in RCS revision number,
23118 We don't currently support GIT addressing of revisions, one can just compare
23119 edited document with its revision X steps backs, where X is addressed as
23123 \begin_layout Section
23124 Literate Programming
23127 \begin_layout Standard
23132 (kayvan@sylvan.com)
23136 original documentation written by
23138 Edmar Wienskoski Jr.
23141 (edmar-w-jr@technologist.com)
23144 \begin_layout Subsection
23148 \begin_layout Standard
23149 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23151 programming, where it is assumed that you are familiar with this programming
23152 technique, and know what
23153 \begin_inset Quotes eld
23157 \begin_inset Quotes erd
23161 \begin_inset Quotes eld
23165 \begin_inset Quotes erd
23169 If that is not the case, please follow the web links provided in the following
23171 There is a lot of good documentation out there covering old development
23172 history to the latest tools tips.
23175 \begin_layout Standard
23176 It is also assumed that you are familiar with \SpecialChar LyX
23177 itself to a point that you
23178 are comfortable changing your \SpecialChar LyX
23179 preferences, and X resources file.
23180 If that is not the case please refer to other \SpecialChar LyX
23181 documentation to cover your
23185 \begin_layout Subsection
23186 Literate Programming
23189 \begin_layout Standard
23190 From the Literate Programming FAQ:
23193 \begin_layout Quotation
23194 Literate programming is the combination of documentation and source together
23195 in a fashion suited for reading by human beings.
23196 In fact, literate programs should be enjoyable reading, even inviting!
23197 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23198 and documentation in a single file.
23199 Literate programming tools then parse the file to produce either readable
23200 documentation or compilable source.
23201 The WEB style of literate programming was created by D.
23202 \begin_inset space \thinspace{}
23206 Knuth during the development of his \SpecialChar TeX
23207 typesetting software.
23211 \begin_layout Standard
23212 Another excerpt says:
23215 \begin_layout Quotation
23218 How is literate programming different from verbose commenting?
23221 \begin_layout Quotation
23222 There are three distinguishing characteristics.
23223 In order of importance, they are:
23224 \begin_inset Separator parbreak
23231 \begin_layout Itemize
23232 flexible order of elaboration
23235 \begin_layout Itemize
23236 automatic support for browsing
23239 \begin_layout Itemize
23240 typeset documentation, especially diagrams and mathematics
23244 \begin_layout Standard
23245 Now that I sparked your curiosity, take a look in the references.
23248 \begin_layout Subsubsection
23252 \begin_layout Standard
23253 The complete Literate Programming FAQ can be found at:
23256 \begin_layout Quote
23257 Literate Programming FAQ
23258 \begin_inset Flex URL
23261 \begin_layout Plain Layout
23263 http://www.literateprogramming.com/lpfaq.pdf
23271 \begin_layout Standard
23272 The FAQ lists 23 (twenty three!) different literate programming tools.
23273 Where some are specialized or
23274 \begin_inset Quotes eld
23278 \begin_inset Quotes erd
23281 for particular programming languages, while other have general scope.
23286 for my own use for several reasons:
23289 \begin_layout Itemize
23290 It can generate the documentation either in \SpecialChar LaTeX
23294 \begin_layout Itemize
23295 It has a open architecture, i.
23296 \begin_inset space \thinspace{}
23300 \begin_inset space \space{}
23303 it is easy to plug in new filters and to perform special processing that
23308 \begin_layout Itemize
23309 There is a good selection of filters available already (the HTML is one
23313 \begin_layout Itemize
23317 \begin_layout Standard
23318 The Noweb web page can be found at:
23321 \begin_layout Quote
23323 \begin_inset Flex URL
23326 \begin_layout Plain Layout
23328 http://www.cs.virginia.edu/~nr/noweb/
23336 \begin_layout Standard
23337 Starting from there you can reach many other interesting links and even
23338 some literate program examples.
23341 \begin_layout Subsection
23343 and Literate Programming with Noweb
23346 \begin_layout Standard
23347 The \SpecialChar LyX
23348 support for Literate Programming is provided by using the generic \SpecialChar LyX
23350 converters mechanism.
23351 This support is provided in a
23352 \begin_inset Quotes eld
23356 \begin_inset Quotes erd
23360 \begin_inset space \thinspace{}
23364 \begin_inset space \space{}
23367 you will be able to use this new \SpecialChar LyX
23368 feature with some other literate programming
23369 tool of your choice by just changing your \SpecialChar LyX
23373 \begin_layout Subsubsection
23374 Generating documents and code (weaving and tangling)
23377 \begin_layout Paragraph
23378 Using the noweb module
23381 \begin_layout Standard
23382 If you have installed Noweb and \SpecialChar LyX
23383 successfully, whenever you open a new document,
23384 after you have chosen its document class, use the Document->Settings menu
23386 \begin_inset Quotes eld
23390 \begin_inset Quotes erd
23394 If Noweb is correctly installed, when you click on the
23395 \begin_inset Quotes eld
23399 \begin_inset Quotes erd
23402 link, you will see the
23403 \begin_inset Quotes eld
23407 \begin_inset Quotes erd
23410 module in the available list and you can add it to your document.
23413 \begin_layout Paragraph
23417 \begin_layout Standard
23419 enables you to write code with a layout named
23420 \begin_inset Flex Noun
23423 \begin_layout Plain Layout
23430 Noweb delimits chunks like this:
23433 \begin_layout LyX-Code
23437 \begin_layout LyX-Code
23441 \begin_layout LyX-Code
23445 \begin_layout LyX-Code
23449 \begin_layout LyX-Code
23453 \begin_layout Standard
23454 The problem is that whatever is written in between the << and the
23458 must be taken literally, i.
23459 \begin_inset space \thinspace{}
23463 \begin_inset space \space{}
23467 should be prevented from making any special interpretation of what has
23469 This is also handled by
23470 \begin_inset Flex Noun
23473 \begin_layout Plain Layout
23479 , that works like a normal paragraph but has a free spacing capability.
23482 \begin_layout Standard
23483 As a special note, you can also use the
23484 \begin_inset Quotes eld
23488 \begin_inset Quotes erd
23491 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23495 \begin_layout LyX-Code
23499 \begin_layout LyX-Code
23500 def some_function(args):
23503 \begin_layout LyX-Code
23504 "This is the doc string for this function."
23507 \begin_layout LyX-Code
23508 print "My args: ", args
23511 \begin_layout LyX-Code
23512 @ %def some_function
23515 \begin_layout Standard
23516 For an example of this usage and the resulting cross-reference output, look
23517 at the Literate python program in
23519 LIBDIR/examples/listerrors.lyx
23521 which should make this all clear.
23524 \begin_layout Paragraph
23525 Generating the documentation
23528 \begin_layout Standard
23529 At this point you already have a new document file with a proper document
23530 class, and with some code and text on it.
23531 How do I print it? The answer is simple, you select
23533 View\SpecialChar menuseparator
23537 Just like you would do for a plain document.
23538 No special procedure is required.
23541 \begin_layout Standard
23542 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23546 \begin_layout Enumerate
23549 Update\SpecialChar menuseparator
23552 menu option is chosen, a \SpecialChar LaTeX
23555 \begin_inset Separator parbreak
23562 \begin_layout Standard
23563 If the document is of any literate class the generated file will be named
23564 with an extension name defined by the
23565 \begin_inset Quotes eld
23569 \begin_inset Quotes erd
23572 format (defined in the Preferences panel), otherwise the file will have
23581 \begin_layout Enumerate
23582 Note that the only difference so far is in the name of the file, no special
23583 processing is required by \SpecialChar LyX
23585 Given that you formatted the code using the
23586 \begin_inset Flex Noun
23589 \begin_layout Plain Layout
23595 layout that, by itself, takes care of the business.
23598 \begin_layout Enumerate
23599 If the document is of any literate class \SpecialChar LyX
23600 will then use the internal \SpecialChar LyX
23602 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23607 \begin_layout Plain Layout
23608 The converters are defined in the
23610 Tools\SpecialChar menuseparator
23614 \begin_inset Quotes eld
23618 \begin_inset Quotes erd
23630 manual for general information about converters.
23635 to generate the \SpecialChar LaTeX
23637 \begin_inset Separator parbreak
23644 \begin_layout Standard
23645 Otherwise it will just skip this step.
23649 \begin_layout Enumerate
23650 Finally, \SpecialChar LaTeX
23651 is invoked and the regular post processing continues as in a plain
23655 \begin_layout Standard
23656 Independence from a particular
23657 \begin_inset Quotes eld
23661 \begin_inset Quotes erd
23664 is easily achieved by changing the commands that are run by the various
23668 \begin_layout Paragraph
23669 Generating the code
23672 \begin_layout Standard
23673 When the build menu option is chosen or the corresponding button in the
23674 toolbar is pressed, a \SpecialChar LaTeX
23675 file is generated just like step 1 above.
23676 Next, \SpecialChar LyX
23682 This converter needs to be defined by the user and is not installed by
23683 default, though the Program format is.
23684 This converter (like any other converter) will have two parts:
23687 \begin_layout Enumerate
23688 The converter program itself.
23689 This program performs the conversion from the one format to the other (in
23690 this case, from the Noweb format to the Program pseudo-format).
23693 \begin_layout Enumerate
23694 The error log parser.
23695 This is a program whose sole purpose is to rewrite error messages in a
23696 format that \SpecialChar LyX
23698 This makes it possible for \SpecialChar LyX
23699 to place error boxes in the right places in
23703 \begin_layout Standard
23704 The first part, the
23705 \begin_inset Quotes eld
23709 \begin_inset Quotes erd
23712 setting, should be set to
23713 \begin_inset Newline newline
23717 \begin_inset Quotes eld
23725 \begin_inset Quotes erd
23729 \begin_inset Newline newline
23732 This basically means that \SpecialChar LyX
23734 \begin_inset Quotes eld
23738 \begin_inset Quotes erd
23741 (a program or script) with the name of the Noweb file (normally a file
23742 in the \SpecialChar LyX
23743 temp directory) and the directory path of the original \SpecialChar LyX
23748 \begin_layout Standard
23749 This is an implementation of
23750 \begin_inset Quotes eld
23754 \begin_inset Quotes erd
23757 that you can place in a directory on your path:
23760 \begin_layout Standard
23761 \begin_inset VSpace defskip
23767 \begin_layout Standard
23768 \begin_inset Newpage pagebreak
23774 \begin_layout Standard
23780 \begin_layout Standard
23786 \begin_layout Standard
23789 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23792 \begin_layout Standard
23793 \begin_inset VSpace defskip
23799 \begin_layout Standard
23800 The next part of the converter setting is the
23801 \begin_inset Quotes eld
23805 \begin_inset Quotes erd
23808 which is to be set to
23809 \begin_inset Newline newline
23813 \begin_inset Quotes eld
23818 parselog=$$s/scripts/listerrors
23821 \begin_inset Quotes erd
23825 \begin_inset Newline newline
23828 This will run any errors that are generated by the
23829 \begin_inset Quotes eld
23833 \begin_inset Quotes erd
23836 process through the
23837 \begin_inset Quotes eld
23841 \begin_inset Quotes erd
23847 \begin_layout Standard
23848 The build will normally take place in \SpecialChar LyX
23849 's temporary directory, so the files
23850 produced by the conversion will be in that directory.
23852 will copy out what it regards as the `main' file, but the
23856 conversion may produce several files, and so most of these would then be
23857 deleted when \SpecialChar LyX
23859 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23860 the build-script chunk can place the generated files in that location.
23863 \begin_layout Paragraph
23864 Build instructions in the document
23867 \begin_layout Standard
23868 The last piece of the integration between \SpecialChar LyX
23870 \begin_inset Quotes eld
23874 \begin_inset Quotes erd
23878 Generally, the instructions for building your program should be embedded
23879 in a chunk of its own.
23881 \begin_inset Quotes eld
23885 \begin_inset Quotes erd
23888 above uses the notangle command to look for this chunk (called
23889 \begin_inset Quotes eld
23893 \begin_inset Quotes erd
23896 ) and runs its contents through
23897 \begin_inset Quotes eld
23901 \begin_inset Quotes erd
23907 \begin_layout Standard
23908 Typically, such a chunk would look something like this:
23911 \begin_layout LyX-Code
23915 \begin_layout LyX-Code
23917 \begin_inset Newline newline
23920 if [ -z "${NOWEB_SOURCE}" ]
23921 \begin_inset Newline newline
23927 \begin_layout LyX-Code
23928 NOWEB_SOURCE=myfile.nw
23929 \begin_inset Newline newline
23933 \begin_inset Newline newline
23937 code to extract files ...
23938 use NOWEB_OUTPUT_DIR here ...]
23939 \begin_inset Newline newline
23943 code to compile files ...]
23944 \begin_inset Newline newline
23950 \begin_layout Standard
23953 LIBDIR/examples/listerrors.lyx
23957 LIBDIR/examples/Literate.lyx
23959 which implement two versions of the
23960 \begin_inset Quotes eld
23964 \begin_inset Quotes erd
23967 program for some illustrations of how all of these pieces go together or
23970 LIBDIR/examples/noweb2lyx.lyx.
23973 Interestingly, these three files show off the language-indepence of the
23975 literate programming support since they are written in Python, C and Perl
23979 \begin_layout Subsubsection
23980 Configuring \SpecialChar LyX
23984 \begin_layout Standard
23985 All the Literate Programming support is configured by the
23987 Tools\SpecialChar menuseparator
23991 \begin_inset Quotes eld
23995 \begin_inset Quotes erd
23999 The important parts are:
24002 \begin_layout Description
24004 \begin_inset space ~
24008 \begin_inset Quotes eld
24012 \begin_inset Quotes erd
24016 \begin_inset space ~
24019 format Set up via the File Formats tab, this is where the Noweb-specific
24029 , the file extension is set to
24034 This tells \SpecialChar LyX
24035 to create a file with a
24039 extension in the first step of the conversion process.
24042 \begin_layout Description
24044 \begin_inset space ~
24052 \begin_inset space ~
24055 format This is an empty format whose sole purpose is to be the endpoint
24056 of a conversion (which then allows us to set up a converter for it).
24059 \begin_layout Description
24069 This converter performs the
24070 \begin_inset Quotes eld
24074 \begin_inset Quotes erd
24077 of the literate document.
24078 For Noweb, it is set to
24079 \begin_inset Quotes eld
24084 noweave -delay -index $$i > $$o
24087 \begin_inset Quotes erd
24093 \begin_layout Description
24103 \begin_inset Quotes eld
24107 \begin_inset Quotes erd
24111 As stated above, the Converter is set to
24112 \begin_inset Quotes eld
24120 \begin_inset Quotes erd
24123 , with Flags set to
24124 \begin_inset Newline newline
24128 \begin_inset Quotes eld
24133 parselog=$$s/scripts/listerrors
24136 \begin_inset Quotes erd
24142 \begin_layout Subsubsection
24146 \begin_layout Standard
24147 There is also a new function implemented in the \SpecialChar LyX
24149 \begin_inset Quotes eld
24152 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24156 \begin_layout Standard
24157 When debugging code with ddd/gdb, it is possible to invoke a text editor
24158 at the current execution position with a single key stroke.
24159 The default ddd configuration for that is shift-ctrl-V.
24160 It happens that you can define the editor command line invocation in ddd
24163 Edit\SpecialChar menuseparator
24164 Preferences\SpecialChar menuseparator
24167 dialog and changing the "Edit Sources" entry.
24170 \begin_layout Standard
24171 I take advantage of the newly created \SpecialChar LyX
24172 server function and this ddd feature,
24174 \begin_inset Quotes eld
24178 \begin_inset Quotes erd
24184 \begin_layout Standard
24185 \begin_inset VSpace defskip
24191 \begin_layout Standard
24194 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24197 \begin_layout Standard
24198 \begin_inset VSpace defskip
24204 \begin_layout Standard
24205 With this, whenever you are using ddd and find a point in the program that
24206 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24207 ddd will forward this information to \SpecialChar LyX
24208 through the \SpecialChar LyX
24209 server and then the
24211 window will show the same file with the cursor at the same position ddd
24213 No more guessing or long scrolling to locate a point in the program back
24217 \begin_layout Standard
24218 Note however that you must enable the \SpecialChar LyX
24219 server to get this feature working
24220 (it is disabled by default).
24221 You can enable it in
24233 ) by entering in the
24239 \begin_inset Quotes eld
24244 /home/<your-home-directory>/.lyx/lyxpipe
24247 \begin_inset Quotes erd
24253 \begin_layout Standard
24254 Read the \SpecialChar LyX
24255 server documentation in the
24257 Customization Manual
24259 for further information.
24262 \begin_layout Subsubsection
24266 \begin_layout Standard
24267 There are six new buttons that can be added to your \SpecialChar LyX
24269 Five of these buttons are short cuts to layout styles:
24292 The last one is a short cut to the
24293 \begin_inset Quotes eld
24297 \begin_inset Quotes erd
24304 \begin_layout Standard
24306 has a range of buttons that are available for tool bar customization.
24307 In my toolbar I like to combine the six short cuts above with two more:
24312 \SpecialChar menuseparator
24317 \SpecialChar menuseparator
24324 Document\SpecialChar menuseparator
24325 View\SpecialChar menuseparator
24329 Here is how it looks like:
24332 \begin_layout LyX-Code
24336 \begin_layout LyX-Code
24340 \begin_layout LyX-Code
24341 Icon "layout Standard"
24344 \begin_layout LyX-Code
24345 Icon "layout Section"
24348 \begin_layout LyX-Code
24349 Icon "layout \SpecialChar LaTeX
24353 \begin_layout LyX-Code
24354 Icon "layout \SpecialChar LyX
24358 \begin_layout LyX-Code
24359 Icon "layout Chunk"
24362 \begin_layout LyX-Code
24366 \begin_layout LyX-Code
24370 \begin_layout LyX-Code
24371 Icon "buffer-typeset"
24374 \begin_layout LyX-Code
24375 Icon "build-program"
24378 \begin_layout LyX-Code
24382 \begin_layout LyX-Code
24386 \begin_layout LyX-Code
24390 \begin_layout LyX-Code
24394 \begin_layout LyX-Code
24398 \begin_layout Subsubsection
24399 Colors customization
24402 \begin_layout Standard
24403 There are a number of colors in \SpecialChar LyX
24404 that can be customized in
24409 One of the things that bothers people is the \SpecialChar LaTeX
24411 The default color is red, since the chunks uses \SpecialChar LaTeX
24412 font, and there is a lot
24413 of chunks in literate documents, you may get tired of seeing everything
24415 You can change it by going to the tabs
24424 \begin_layout Standard
24425 The next thing is the visible presence of the newline character in the screen.
24426 You can choose the color of this particular character and make it blend
24428 I recommend you choosing a color that is close to the background but not
24429 equal, that way you still can see it is there, but it is not bothering
24433 \begin_layout Subsection
24438 \begin_layout Standard
24447 is documented in the
24451 example file and in the Sweave manual (menu
24453 Help\SpecialChar menuseparator
24459 \begin_layout Chapter
24463 \begin_layout Standard
24464 You can do everything with \SpecialChar LyX
24465 that you can do with \SpecialChar LaTeX
24467 However, \SpecialChar LyX
24468 cannot support every \SpecialChar LaTeX
24470 But you can always use \SpecialChar TeX
24472 This chapter shows you some more special things you might want to use.
24473 For other special things you can do with figures, tables, floats, boxes
24474 and notes, have a look at the
24477 \begin_inset space ~
24485 \begin_layout Section
24486 Multiple Text Columns
24489 \begin_layout Standard
24490 This feature is independent of the option
24492 Two-column document
24494 in the document settings under
24499 If you want to have 2
24500 \begin_inset space ~
24503 columns for the whole document, it is recommended to use the
24505 Two-column document
24508 For all other cases use this feature.
24511 \begin_layout Standard
24512 To use multiple text columns in your document, you have to load the module
24519 Document\SpecialChar menuseparator
24520 Settings\SpecialChar menuseparator
24523 ) and must have the \SpecialChar LaTeX
24531 \begin_layout Standard
24532 Footnotes within multiple columns will be placed at the bottom of the page
24533 and not under each column.
24534 Within the different columns you can use everything, with the limitation
24535 that for floats you need to use the float option
24542 \begin_layout Subsection
24546 \begin_layout Standard
24547 If you want to have 2
24548 \begin_inset space ~
24551 columns in your text, insert a multicolumn inset via the menu
24553 Insert\SpecialChar menuseparator
24555 \begin_inset space ~
24558 Insets\SpecialChar menuseparator
24560 \begin_inset space ~
24565 where the columns should start.
24566 Write all text that should be printed in 2
24567 \begin_inset space ~
24570 columns into this inset.
24573 \begin_layout Standard
24574 Here is an example:
24577 \begin_layout Standard
24579 \begin_inset Flex Multiple Columns
24582 \begin_layout Plain Layout
24587 The Adventure of the Empty House
24590 \begin_inset Newline newline
24593 by Sir Arthur Conan Doyle
24596 \begin_layout Plain Layout
24599 It was in the spring of the year 1894 that all London was interested, and
24600 the fashionable world dismayed, by the murder of the Honourable Ronald
24601 Adair under most unusual and inexplicable circumstances.
24602 The public has already learned those particulars of the crime which came
24603 out in the police investigation, but a good deal was suppressed upon that
24604 occasion, since the case for the prosecution was so overwhelmingly strong
24605 that it was not necessary to bring forward all the facts.
24606 Only now, at the end of nearly ten years, am I allowed to supply those
24607 missing links which make up the whole of that remarkable chain.
24608 The crime was of interest in itself, but that interest was as nothing to
24609 me compared to the inconceivable sequel, which afforded me the greatest
24610 shock and surprise of any event in my adventurous life.
24611 Even now, after this long interval, I find myself thrilling as I think
24612 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24613 ty which utterly submerged my mind.
24614 Let me say to that public, which has shown some interest in those glimpses
24615 which I have occasionally given them of the thoughts and actions of a very
24616 remarkable man, that they are not to blame me if I have not shared my knowledge
24617 with them, for I should have considered it my first duty to do so, had
24618 I not been barred by a positive prohibition from his own lips, which was
24619 only withdrawn upon the third of last month.
24627 \begin_layout Standard
24628 To get 3 or more columns, set the cursor into the multicolumn inset and
24631 Insert\SpecialChar menuseparator
24633 \begin_inset space ~
24637 \begin_inset space ~
24643 The number of the desired columns is written into that inset (for 3
24644 \begin_inset space ~
24648 \begin_inset Quotes eld
24652 \begin_inset Quotes erd
24656 \begin_inset Newline newline
24659 Here is an example with 3
24660 \begin_inset space ~
24666 \begin_layout Standard
24667 \begin_inset Flex Multiple Columns
24670 \begin_layout Plain Layout
24673 \begin_inset Argument 1
24676 \begin_layout Plain Layout
24682 It can be imagined that my close intimacy with Sherlock Holmes had interested
24683 me deeply in crime, and that after his disappearance I never failed to
24684 read with care the various problems which came before the public.
24685 And I even attempted, more than once, for my own private satisfaction,
24686 to employ his methods in their solution, though with indifferent success.
24687 There was none, however, which appealed to me like this tragedy of Ronald
24689 As I read the evidence at the inquest, which led up to a verdict of willful
24690 murder against some person or persons unknown, I realized more clearly
24691 than I had ever done the loss which the community had sustained by the
24692 death of Sherlock Holmes.
24693 There were points about this strange business which would, I was sure,
24694 have specially appealed to him, and the efforts of the police would have
24695 been supplemented, or more probably anticipated, by the trained observation
24696 and the alert mind of the first criminal agent in Europe.
24697 All day, as I drove upon my round, I turned over the case in my mind and
24698 found no explanation which appeared to me to be adequate.
24699 At the risk of telling a twice-told tale, I will recapitulate the facts
24700 as they were known to the public at the conclusion of the inquest.
24708 \begin_layout Standard
24709 You can have up to 10
24710 \begin_inset space ~
24713 columns if you want to, but that might not be very pleasant for the readers
24717 \begin_layout Standard
24718 \begin_inset Newpage newpage
24724 \begin_layout Subsection
24725 Columns inside Columns
24728 \begin_layout Standard
24729 You can also have columns inside columns:
24732 \begin_layout Standard
24733 \begin_inset Flex Multiple Columns
24736 \begin_layout Plain Layout
24739 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24740 at that time governor of one of the Australian colonies.
24741 Adair's mother had returned from Australia to undergo the operation for
24742 cataract, and she, her son Ronald, and her daughter Hilda were living together
24746 \begin_layout Plain Layout
24747 \begin_inset Flex Multiple Columns
24750 \begin_layout Plain Layout
24753 The youth moved in the best society–had, so far as was known, no enemies
24754 and no particular vices.
24755 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24756 had been broken off by mutual consent some months before, and there was
24757 no sign that it had left any very profound feeling behind it.
24758 For the rest {sic} the man's life moved in a narrow and conventional circle,
24759 for his habits were quiet and his nature unemotional.
24760 Yet it was upon this easy-going young aristocrat that death came, in most
24761 strange and unexpected form, between the hours of ten and eleven-twenty
24762 on the night of March 30, 1894.
24770 \begin_layout Plain Layout
24773 Ronald Adair was fond of cards–playing continually, but never for such stakes
24775 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24776 It was shown that, after dinner on the day of his death, he had played
24777 a rubber of whist at the latter club.
24778 He had also played there in the afternoon.
24783 The evidence of those who had played with him– Mr.
24784 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24785 and that there was a fairly equal fall of the cards.
24786 Adair might have lost five pounds, but not more.
24787 His fortune was a considerable one, and such a loss could not in any way
24789 He had played nearly every day at one club or other, but he was a cautious
24790 player, and usually rose a winner.
24791 It came out in evidence that, in partnership with Colonel Moran, he had
24792 actually won as much as four hundred and twenty pounds in a sitting, some
24793 weeks before, from Godfrey Milner and Lord Balmoral.
24794 So much for his recent history as it came out at the inquest.
24802 \begin_layout Subsection
24806 \begin_layout Standard
24807 The examples in this section show some more special features of multiple
24811 \begin_layout Standard
24812 For more features of multiple columns, have a look at the documentation
24813 of the \SpecialChar LaTeX
24819 \begin_inset CommandInset citation
24828 \begin_layout Subsubsection
24832 \begin_layout Standard
24833 To add a preface text for multiple columns, set the cursor into the multicolumn
24834 inset and use the menu
24836 Insert\SpecialChar menuseparator
24840 Write your preface text into that inset.
24841 \begin_inset Newline newline
24844 This is an example with some preface text:
24847 \begin_layout Standard
24848 \begin_inset VSpace bigskip
24854 \begin_layout Standard
24855 \begin_inset Flex Multiple Columns
24858 \begin_layout Plain Layout
24859 \begin_inset Argument 2
24862 \begin_layout Plain Layout
24863 And the story continues and continues and continues and continues\SpecialChar ldots
24871 On the evening of the crime, he returned from the club exactly at ten.
24872 His mother and sister were out spending the evening with a relation.
24873 The servant deposed that she heard him enter the front room on the second
24874 floor, generally used as his sitting-room.
24875 She had lit a fire there, and as it smoked she had opened the window.
24876 No sound was heard from the room until eleven-twenty, the hour of the return
24877 of Lady Maynooth and her daughter.
24878 Desiring to say good-night, she attempted to enter her son's room.
24879 The door was locked on the inside, and no answer could be got to their
24880 cries and knocking.
24881 Help was obtained, and the door forced.
24882 The unfortunate young man was found lying near the table.
24883 His head had been horribly mutilated by an expanding revolver bullet, but
24884 no weapon of any sort was to be found in the room.
24892 \begin_layout Standard
24893 You can also use a section heading as the preface if you use a section command
24894 as \SpecialChar TeX
24896 For example the command
24899 \begin_layout Standard
24904 subsection{subsection title}
24907 \begin_layout Standard
24908 creates a subsection.
24909 In this example the preface is a subsubsection:
24912 \begin_layout Standard
24913 \begin_inset Flex Multiple Columns
24916 \begin_layout Plain Layout
24917 \begin_inset Argument 2
24920 \begin_layout Plain Layout
24924 \begin_layout Plain Layout
24933 This is a subsubsection heading as a preface
24937 \begin_layout Plain Layout
24951 A minute examination of the circumstances served only to make the case more
24953 In the first place, no reason could be given why the young man should have
24954 fastened the door upon the inside.
24955 There was the possibility that the murderer had done this, and had afterwards
24956 escaped by the window.
24957 The drop was at least twenty feet, however, and a bed of crocuses in full
24959 Neither the flowers nor the earth showed any sign of having been disturbed,
24960 nor were there any marks upon the narrow strip of grass which separated
24961 the house from the road.
24962 Apparently, therefore, it was the young man himself who had fastened the
24964 But how did he come by his death? No one could have climbed up to the window
24965 without leaving traces.
24966 Suppose a man had fired through the window, he would indeed be a remarkable
24967 shot who could with a revolver inflict so deadly a wound.
24968 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24969 a hundred yards of the house.
24970 No one had heard a shot.
24978 \begin_layout Standard
24979 If there is less vertical space than 6
24980 \begin_inset space ~
24983 text lines is left on the page at the beginning of the multiple columns,
24984 a page break will be inserted before the multiple columns.
24985 Depending on the number of lines of the preface text, you might want to
24987 This is done by setting the cursor into the mulitcolumn inset behind the
24988 preface (if there is any) and using the menu
24990 Insert\SpecialChar menuseparator
24992 \begin_inset space ~
24996 \begin_inset space ~
25000 \begin_inset space ~
25006 Insert into that inset the amount of space like e.
25007 \begin_inset space \thinspace{}
25011 \begin_inset space \space{}
25015 \begin_inset Quotes eld
25019 \begin_inset Quotes erd
25023 \begin_inset Newline newline
25026 In this example the space is set to 7
25027 \begin_inset space ~
25030 text lines by using
25031 \begin_inset Quotes eld
25037 \begin_inset Quotes erd
25046 needs to be inserted as \SpecialChar TeX
25050 \begin_layout Standard
25051 \begin_inset Flex Multiple Columns
25054 \begin_layout Plain Layout
25055 \begin_inset Argument 3
25058 \begin_layout Plain Layout
25063 \begin_layout Plain Layout
25079 On the evening of the crime, he returned from the club exactly at ten.
25080 His mother and sister were out spending the evening with a relation.
25081 The servant deposed that she heard him enter the front room on the second
25082 floor, generally used as his sitting-room.
25083 She had lit a fire there, and as it smoked she had opened the window.
25084 No sound was heard from the room until eleven-twenty, the hour of the return
25085 of Lady Maynooth and her daughter.
25086 Desiring to say good-night, she attempted to enter her son's room.
25087 The door was locked on the inside, and no answer could be got to their
25088 cries and knocking.
25089 Help was obtained, and the door forced.
25090 The unfortunate young man was found lying near the table.
25091 His head had been horribly mutilated by an expanding revolver bullet, but
25092 no weapon of any sort was to be found in the room.
25100 \begin_layout Subsubsection
25104 \begin_layout Standard
25105 The amount of space before and after multiple columns can be changed by
25106 changing the length
25113 For example the command
25116 \begin_layout Standard
25126 \begin_layout Standard
25127 in \SpecialChar TeX
25128 Code changes its value to 3
25129 \begin_inset space \thinspace{}
25133 The change must be made before the multiple columns' start.
25134 The predefined value is 13
25135 \begin_inset space \thinspace{}
25141 \begin_layout Standard
25149 \begin_inset space \thinspace{}
25155 \begin_layout Standard
25159 \begin_layout Plain Layout
25165 multicolsep}{2.5cm}
25173 \begin_layout Standard
25174 \begin_inset Flex Multiple Columns
25177 \begin_layout Plain Layout
25180 All day I turned these facts over in my mind, endeavouring to hit upon some
25181 theory which could reconcile them all, and to find that line of least resistanc
25182 e which my poor friend had declared to be the starting-point of every investigat
25184 I confess that I made little progress.
25185 In the evening I strolled across the Park, and found myself about six o'clock
25186 at the Oxford Street end of Park Lane.
25187 A group of loafers upon the pavements, all staring up at a particular window,
25188 directed me to the house which I had come to see.
25189 A tall, thin man with coloured glasses, whom I strongly suspected of being
25190 a plain-clothes detective, was pointing out some theory of his own, while
25191 the others crowded round to listen to what he said.
25192 I got as near him as I could, but his observations seemed to me to be absurd,
25193 so I withdrew again in some disgust.
25194 As I did so I struck against an elderly, deformed man, who had been behind
25195 me, and I knocked down several books which he was carrying.
25203 \begin_layout Standard
25204 \begin_inset Note Greyedout
25207 \begin_layout Plain Layout
25212 The values you set with
25218 will be used for all following multiple columns until you change them again.
25226 \begin_layout Standard
25230 \begin_layout Plain Layout
25242 \begin_inset Note Note
25245 \begin_layout Plain Layout
25246 go back to the default
25254 \begin_layout Standard
25255 \begin_inset Newpage newpage
25261 \begin_layout Subsubsection
25265 \begin_layout Standard
25266 A column break can be forced by inserting the command
25272 as \SpecialChar TeX
25274 \change_inserted -712698321 1437633561
25276 \change_deleted -712698321 1437633560
25279 Code to that position in the text where the column should be broken.
25280 Note that this leads in most cases to whitespace in the text.
25281 \begin_inset Newline newline
25284 Here is an example:
25287 \begin_layout Standard
25288 \begin_inset Flex Multiple Columns
25291 \begin_layout Plain Layout
25294 \begin_inset Quotes eld
25297 You're surprised to see me, sir,
25298 \begin_inset Quotes erd
25301 said he, in a strange, croaking voice.
25304 \begin_layout Plain Layout
25307 I acknowledged that I was.
25310 \begin_layout Plain Layout
25313 \begin_inset Quotes eld
25316 Well, I've a conscience, sir, and when I chanced to see you go into this
25317 house, as I came hobbling after you, I thought to myself, I'll just step
25318 in and see that kind gentleman, and tell him that if I was a bit gruff
25319 in my manner there was not any harm meant, and that I am much obliged to
25320 him for picking up my books.
25321 \begin_inset Quotes erd
25327 \begin_layout Plain Layout
25330 \begin_inset Quotes eld
25333 You make too much of a trifle,
25334 \begin_inset Quotes erd
25339 \begin_inset Quotes eld
25342 May I ask how you knew who I was?
25343 \begin_inset Quotes erd
25346 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25350 \begin_layout Plain Layout
25362 \begin_layout Plain Layout
25365 \begin_inset Quotes eld
25368 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25369 you'll find my little bookshop at the corner of Church Street, and very
25370 happy to see you, I am sure.
25371 Maybe you collect yourself, sir.
25375 \begin_inset space ~
25388 –a bargain, every one of them.
25389 With five volumes you could just fill that gap on that second shelf.
25390 It looks untidy, does it not, sir?
25391 \begin_inset Quotes erd
25402 \begin_layout Subsubsection
25406 \begin_layout Standard
25407 The width of the columns is automatically calculated, but you can modify
25408 the space between the columns.
25409 This is done by changing the length
25416 Its predefined value is 10
25417 \begin_inset space \thinspace{}
25421 Here is an example where
25428 \begin_inset space \thinspace{}
25434 \begin_layout Standard
25438 \begin_layout Plain Layout
25452 \begin_layout Standard
25453 \begin_inset Flex Multiple Columns
25456 \begin_layout Plain Layout
25459 My observations of No.
25460 \begin_inset space \space{}
25463 427 Park Lane did little to clear up the problem in which I was interested.
25464 The house was separated from the street by a low wall and railing, the
25465 whole not more than five feet high.
25466 It was perfectly easy, therefore, for anyone to get into the garden, but
25467 the window was entirely inaccessible, since there was no water pipe or
25468 anything which could help the most active man to climb it.
25469 More puzzled than ever, I retraced my steps to Kensington.
25470 I had not been in my study five minutes when the maid entered to say that
25471 a person desired to see me.
25472 To my astonishment it was none other than my strange old book collector,
25473 his sharp, wizened face peering out from a frame of white hair, and his
25474 precious volumes, a dozen of them at least, wedged under his right arm.
25482 \begin_layout Standard
25486 \begin_layout Plain Layout
25498 \begin_inset Note Note
25501 \begin_layout Plain Layout
25502 go back to the default
25510 \begin_layout Subsubsection
25514 \begin_layout Standard
25515 Between the columns a rule with a width of the length
25522 If this rule width is set to 0
25523 \begin_inset space \thinspace{}
25526 pt (this is the default), the rule is suppressed.
25527 In the following example the rule is 2
25528 \begin_inset space \thinspace{}
25534 \begin_layout Standard
25538 \begin_layout Plain Layout
25544 columnseprule}{2pt}
25552 \begin_layout Standard
25553 \begin_inset Flex Multiple Columns
25556 \begin_layout Plain Layout
25559 \begin_inset Quotes eld
25562 You're surprised to see me, sir,
25563 \begin_inset Quotes erd
25566 said he, in a strange, croaking voice.
25569 \begin_layout Plain Layout
25572 I acknowledged that I was.
25575 \begin_layout Plain Layout
25578 \begin_inset Quotes eld
25581 Well, I've a conscience, sir, and when I chanced to see you go into this
25582 house, as I came hobbling after you, I thought to myself, I'll just step
25583 in and see that kind gentleman, and tell him that if I was a bit gruff
25584 in my manner there was not any harm meant, and that I am much obliged to
25585 him for picking up my books.
25586 \begin_inset Quotes erd
25592 \begin_layout Plain Layout
25595 \begin_inset Quotes eld
25598 You make too much of a trifle,
25599 \begin_inset Quotes erd
25604 \begin_inset Quotes eld
25607 May I ask how you knew who I was?
25608 \begin_inset Quotes erd
25614 \begin_layout Plain Layout
25617 \begin_inset Quotes eld
25620 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25621 you'll find my little bookshop at the corner of Church Street, and very
25622 happy to see you, I am sure.
25623 Maybe you collect yourself, sir.
25627 \begin_inset space ~
25640 –a bargain, every one of them.
25641 With five volumes you could just fill that gap on that second shelf.
25642 It looks untidy, does it not, sir?
25643 \begin_inset Quotes erd
25654 \begin_layout Standard
25655 \begin_inset VSpace defskip
25661 \begin_layout Standard
25662 The rule can be colored by redefining the command
25669 This is done by inserting the command
25670 \begin_inset Newline newline
25679 columnseprulecolor}{
25684 \begin_inset Newline newline
25687 as \SpecialChar TeX
25689 \change_inserted -712698321 1437633567
25691 \change_deleted -712698321 1437633567
25694 Code before the multicolumn inset.
25699 in this command by a color of your choice.
25700 You can use all pre- and self-defined colors.
25708 \begin_inset space ~
25713 for more information about pre- and self-defined colors.
25714 To go back to the default color insert the command
25715 \begin_inset Newline newline
25724 columnseprulecolor}{
25729 \begin_inset Newline newline
25732 Here is the example with a cyan rule and 1
25733 \begin_inset space \thinspace{}
25736 cm column separation:
25739 \begin_layout Standard
25743 \begin_layout Plain Layout
25752 \begin_layout Plain Layout
25758 columnseprulecolor}{
25768 \begin_layout Standard
25769 \begin_inset Flex Multiple Columns
25772 \begin_layout Plain Layout
25775 \begin_inset Quotes eld
25778 You're surprised to see me, sir,
25779 \begin_inset Quotes erd
25782 said he, in a strange, croaking voice.
25785 \begin_layout Plain Layout
25788 I acknowledged that I was.
25791 \begin_layout Plain Layout
25794 \begin_inset Quotes eld
25797 Well, I've a conscience, sir, and when I chanced to see you go into this
25798 house, as I came hobbling after you, I thought to myself, I'll just step
25799 in and see that kind gentleman, and tell him that if I was a bit gruff
25800 in my manner there was not any harm meant, and that I am much obliged to
25801 him for picking up my books.
25802 \begin_inset Quotes erd
25808 \begin_layout Plain Layout
25811 \begin_inset Quotes eld
25814 You make too much of a trifle,
25815 \begin_inset Quotes erd
25820 \begin_inset Quotes eld
25823 May I ask how you knew who I was?
25824 \begin_inset Quotes erd
25830 \begin_layout Plain Layout
25833 \begin_inset Quotes eld
25836 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25837 you'll find my little bookshop at the corner of Church Street, and very
25838 happy to see you, I am sure.
25839 Maybe you collect yourself, sir.
25843 \begin_inset space ~
25856 –a bargain, every one of them.
25857 With five volumes you could just fill that gap on that second shelf.
25858 It looks untidy, does it not, sir?
25859 \begin_inset Quotes erd
25870 \begin_layout Standard
25874 \begin_layout Plain Layout
25880 columnseprule}{0pt}
25883 \begin_layout Plain Layout
25889 columnseprulecolor}{
25897 \begin_inset Note Note
25900 \begin_layout Plain Layout
25901 go back to the default
25909 \begin_layout Section
25910 Non-standard Paragraph Shapes
25913 \begin_layout Standard
25916 as well as any other text processor uses by default rectangular paragraphs.
25917 For special cases like for example posters, invitation cards or poems you
25918 can modify the paragraph shape to one of your choice.
25919 This can be done by using the \SpecialChar LaTeX
25924 which is loaded by using in the document settings the module
25926 Custom paragraph shapes
25931 \begin_layout Subsection
25935 \begin_layout Standard
25940 provides the following shapes:
25943 \begin_layout Standard
25944 \begin_inset Tabular
25945 <lyxtabular version="3" rows="13" columns="3">
25946 <features booktabs="true" islongtable="true" longtabularalignment="center">
25947 <column alignment="center" valignment="middle" width="16col%">
25948 <column alignment="center" valignment="middle" width="40col%">
25949 <column alignment="center" valignment="middle" width="35col%">
25950 <row endhead="true">
25951 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25954 \begin_layout Plain Layout
25960 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25963 \begin_layout Plain Layout
25969 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25972 \begin_layout Plain Layout
25980 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25983 \begin_layout Plain Layout
25989 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25992 \begin_layout Plain Layout
25993 Circle with circular hole (in the size of a CD/DVD)
25998 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26001 \begin_layout Plain Layout
26002 Cannot be scaled, take care there is not too much text
26009 <cell alignment="center" valignment="top" topline="true" usebox="none">
26012 \begin_layout Plain Layout
26018 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26021 \begin_layout Plain Layout
26027 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26030 \begin_layout Plain Layout
26031 Fragile, calculation might fail
26038 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26041 \begin_layout Plain Layout
26047 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26050 \begin_layout Plain Layout
26051 Rhomboid (symbolizing a
26052 \begin_inset Quotes eld
26056 \begin_inset Quotes erd
26064 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26067 \begin_layout Plain Layout
26075 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26078 \begin_layout Plain Layout
26084 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26087 \begin_layout Plain Layout
26093 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26096 \begin_layout Plain Layout
26104 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26107 \begin_layout Plain Layout
26113 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26116 \begin_layout Plain Layout
26122 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26125 \begin_layout Plain Layout
26133 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26136 \begin_layout Plain Layout
26142 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26145 \begin_layout Plain Layout
26146 Nut for bolt (hexagon with circular hole)
26151 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26154 \begin_layout Plain Layout
26162 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26165 \begin_layout Plain Layout
26171 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26174 \begin_layout Plain Layout
26180 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26183 \begin_layout Plain Layout
26191 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26194 \begin_layout Plain Layout
26200 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26203 \begin_layout Plain Layout
26209 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26212 \begin_layout Plain Layout
26220 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26223 \begin_layout Plain Layout
26229 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26232 \begin_layout Plain Layout
26238 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26241 \begin_layout Plain Layout
26249 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26252 \begin_layout Plain Layout
26258 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26261 \begin_layout Plain Layout
26262 Normal/reversed rain drop
26267 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26270 \begin_layout Plain Layout
26271 Fragile, calculation might fail
26278 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26281 \begin_layout Plain Layout
26288 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26291 \begin_layout Plain Layout
26292 The \SpecialChar TeX
26298 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26301 \begin_layout Plain Layout
26309 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26312 \begin_layout Plain Layout
26314 \begin_inset Newline newline
26322 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26325 \begin_layout Plain Layout
26326 Triangles in different orientations
26331 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26334 \begin_layout Plain Layout
26348 \begin_layout Standard
26349 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26351 for environments in the toolbar.
26354 \begin_layout Standard
26355 \begin_inset Newpage newpage
26361 \begin_layout Standard
26362 Here is an example paragraph in the shape of a nut:
26365 \begin_layout Standard
26366 \begin_inset VSpace bigskip
26375 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26376 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26378 At vero eos et accusam et justo duo dolores et ea rebum.
26379 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26381 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26382 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26386 \begin_layout Standard
26387 \begin_inset VSpace bigskip
26393 \begin_layout Standard
26394 \begin_inset Note Greyedout
26397 \begin_layout Plain Layout
26402 : shapepar paragraphs cannot run over a page break.
26410 \begin_layout Standard
26411 \begin_inset VSpace bigskip
26417 \begin_layout Standard
26422 takes care that the shape will always be preserved, no matter how much
26423 text is in the paragraph.
26424 Therefore the paragraph size changes with the amount of contained text.
26425 This can lead to paragraph sizes exceeding the page margins.
26426 To demonstrate the size scaling, here is the same example paragraph but
26427 with twice as much text:
26430 \begin_layout Standard
26431 \begin_inset Newpage newpage
26440 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26441 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26443 At vero eos et accusam et justo duo dolores et ea rebum.
26444 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26446 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26447 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26449 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26450 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26452 At vero eos et accusam et justo duo dolores et ea rebum.
26453 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26455 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26456 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26460 \begin_layout Standard
26461 \begin_inset VSpace bigskip
26467 \begin_layout Standard
26468 An exception is the shape
26473 It cannot be scaled because it must fit the size of a CD/DVD.
26474 Therefore the amount of text that fits into the shape is limited.
26475 \begin_inset Newline newline
26486 shape are fragile, meaning that the calculation of their size can fail,
26487 depending on the amount of text.
26488 You will then get the \SpecialChar LaTeX
26490 \begin_inset Quotes eld
26493 Arithmetic overflow
26494 \begin_inset Quotes erd
26498 In this case one can try to remove or add some text; if nothing works one
26499 has to use another shape.
26502 \begin_layout Standard
26503 \begin_inset VSpace bigskip
26509 \begin_layout Standard
26510 For shapes with tips you will maybe see that \SpecialChar LaTeX
26511 's hyphenation routine fails
26512 for text in the tips.
26513 Therefore it is often necessary to add hyphenation points
26518 arg "specialchar-insert hyphenation"
26523 ) to the corresponding text parts.
26526 \begin_layout Standard
26527 \begin_inset VSpace bigskip
26533 \begin_layout Standard
26534 Shapepar paragraphs are either always centered or placed on the page so
26535 that their left border touches the left page margin.
26536 You can therefore not use the paragraph dialog to align such paragraphs.
26537 A solution is to put the paragraph into a minipage or parbox and align
26539 The problem is hereby to find the right width for the box.
26540 Because if it is too wide and you center the box, the paragraph is not
26541 centered too because it sticks at the left side of the box.
26542 So you might have to play a bit with the width until it fits.
26543 Here are two heart-shaped paragraphs, the first one is not aligned, the
26544 second one is right-aligned:
26547 \begin_layout Standard
26548 \begin_inset Newpage newpage
26554 \begin_layout Heart
26558 Lo\SpecialChar softhyphen
26559 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26560 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26562 At vero eos et accusam et justo duo dolores et ea rebum.
26563 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26567 \begin_layout Standard
26568 \begin_inset VSpace bigskip
26574 \begin_layout Standard
26577 \begin_inset Box Frameless
26587 height_special "totalheight"
26592 backgroundcolor "none"
26595 \begin_layout Heart
26599 Lo\SpecialChar softhyphen
26600 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26601 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26603 At vero eos et accusam et justo duo dolores et ea rebum.
26604 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26613 \begin_layout Subsection
26617 \begin_layout Standard
26618 You can define any shape you want.
26619 Doing this manually is a lot of work because every coordinate must be specified.
26620 But there is a way to let the computer calculate the coordinates:
26623 \begin_layout Enumerate
26624 Install the program
26625 \begin_inset CommandInset href
26628 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26635 \begin_layout Enumerate
26641 \change_deleted -712698321 1437633577
26648 \begin_layout Plain Layout
26656 \change_inserted -712698321 1437633577
26660 \change_deleted -712698321 1437633578
26665 \begin_layout Plain Layout
26673 \change_inserted -712698321 1437633578
26676 \SpecialChar menuseparator
26677 Settings\SpecialChar menuseparator
26680 and select the font size you are using in your document.
26681 For example this document uses the size 12
26682 \begin_inset space \thinspace{}
26688 \begin_layout Enumerate
26692 \begin_layout Enumerate
26694 \change_deleted -712698321 1437633580
26701 \begin_layout Plain Layout
26709 \change_inserted -712698321 1437633580
26713 \change_deleted -712698321 1437633581
26718 \begin_layout Plain Layout
26726 \change_inserted -712698321 1437633581
26729 \SpecialChar menuseparator
26732 to export the shape to coordinates.
26733 In the appearing dialog use either the outline of your shape for the coordinate
26734 s or the path itself.
26738 \begin_layout Plain Layout
26739 For more information see
26740 \begin_inset CommandInset href
26742 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26754 \begin_layout Standard
26755 The coordinates are written into a \SpecialChar TeX
26757 \change_inserted -712698321 1437633584
26759 \change_deleted -712698321 1437633584
26763 To use it for your \SpecialChar LyX
26767 \begin_layout Enumerate
26768 Place the cursor before the first character of your paragraph (or into a
26772 \begin_layout Enumerate
26773 Open in \SpecialChar LyX
26776 Insert\SpecialChar menuseparator
26777 File\SpecialChar menuseparator
26779 \begin_inset space ~
26784 , select the file and use
26793 \begin_layout Standard
26794 \begin_inset VSpace defskip
26800 \begin_layout Standard
26801 \begin_inset Note Greyedout
26804 \begin_layout Plain Layout
26809 : The changed shape only applies to the current paragraph; everything is
26810 reset to normal for the next paragraph.
26811 Therefore the shape definition file must be input into every paragraph
26812 with the desired shape.
26820 \begin_layout Standard
26821 \begin_inset VSpace bigskip
26827 \begin_layout Standard
26828 Here is an example:
26831 \begin_layout Standard
26832 \begin_inset VSpace bigskip
26838 \begin_layout Standard
26839 \begin_inset CommandInset include
26841 filename "SpecialParagraphShape.tex"
26847 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26848 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26850 At vero eos et accusam et justo duo dolores et ea rebum.
26851 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26853 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26854 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26858 \begin_layout Standard
26859 \begin_inset VSpace bigskip
26865 \begin_layout Standard
26870 to draw complexer shapes in
26874 you can draw the shape in a program of your choice and import the resulting
26880 Then you only need to draw a line or spline along the outline of the image.
26883 \begin_layout Standard
26884 \begin_inset VSpace bigskip
26890 \begin_layout Standard
26893 Custom paragraph shapes
26895 also provides the two commands
26903 which can be used to define custom shapes coordinate by coordinate.
26907 \begin_layout Plain Layout
26908 These commands are internally used for all shapes described here.
26913 For information how these styles are used and about further customization
26914 possibilities, have a look at the documentation of the package
26919 \begin_inset CommandInset citation
26928 \begin_layout Bibliography
26929 \begin_inset CommandInset bibitem
26930 LatexCommand bibitem
26935 Documentation of the \SpecialChar LaTeX
26937 \begin_inset CommandInset href
26940 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26947 \begin_layout Bibliography
26948 \begin_inset CommandInset bibitem
26949 LatexCommand bibitem
26954 Documentation of the \SpecialChar LaTeX
26956 \begin_inset CommandInset href
26959 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"