1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
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
17 % the pages of the TOC are numbered roman
18 % and a PDF-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand{\tableofcontents}{%
22 \pdfbookmark[1]{\contentsname}{}
25 \pagenumbering{arabic}}
27 % extra space for tables
28 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
30 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
31 \use_default_options false
39 \maintain_unincluded_children false
41 \language_package default
44 \font_roman "lmodern" "default"
45 \font_sans "lmss" "default"
46 \font_typewriter "lmtt" "default"
47 \font_math "auto" "auto"
48 \font_default_family default
49 \use_non_tex_fonts false
52 \font_sf_scale 100 100
53 \font_tt_scale 100 100
55 \default_output_format default
57 \bibtex_command default
58 \index_command default
62 \pdf_title "LyX's Additional Features manual"
63 \pdf_author "LyX Team"
64 \pdf_subject "LyX's additional features documentation"
65 \pdf_keywords "LyX, Documentation, Additional"
67 \pdf_bookmarksnumbered true
68 \pdf_bookmarksopen false
69 \pdf_bookmarksopenlevel 1
74 \pdf_pdfusetitle false
75 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
78 \use_package amsmath 1
79 \use_package amssymb 1
82 \use_package mathdots 1
83 \use_package mathtools 0
85 \use_package stackrel 0
86 \use_package stmaryrd 0
87 \use_package undertilde 0
89 \cite_engine_type default
93 \paperorientation portrait
97 \notefontcolor #0000ff
104 \paragraph_separation indent
105 \paragraph_indentation default
106 \quotes_language english
109 \paperpagestyle headings
110 \tracking_changes false
111 \output_changes false
120 Additional \SpecialChar LyX
124 \begin_layout Subtitle
129 by the \SpecialChar LyX
134 \begin_layout Plain Layout
136 Principal maintainer of this file is
141 If you have comments or error corrections, please send them to the \SpecialChar LyX
144 \begin_inset Flex Code
147 \begin_layout Plain Layout
149 <lyx-docs@lists.lyx.org>
162 \begin_layout Standard
163 \begin_inset CommandInset toc
164 LatexCommand tableofcontents
171 \begin_layout Chapter
175 \begin_layout Standard
176 This manual is essentially Part II of the
178 User's Guide\SpecialChar endofsentence
181 The reason for separating the two documents is simple: the
185 is already quite lengthy, and it contains information on all of the basic
186 features one needs to know in order to prepare most documents.
187 However, the \SpecialChar LyX
188 Team has worked to make \SpecialChar LyX
189 extensible through various configuration
190 files and external packages.
191 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
193 create a layout file (or module) for it without having to alter \SpecialChar LyX
195 We've already had contributions of several new features this way, and some
196 of them are documented here.
197 There are also some more `advanced' features, such as how to control the
198 presentation of bibliographies and how to work with multi-part documents,
199 that are not covered in the
203 and are discussed here.
206 \begin_layout Standard
207 This manual also documents some special features, like fax support, version
208 control, and SGML support, which require additional software to work properly.
209 There is also a chapter on \SpecialChar LyX
211 And lastly, there's a chapter of \SpecialChar LaTeX
212 tools and tips, things you can use to
213 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
215 After all, \SpecialChar LyX
220 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
224 \begin_layout Standard
225 If you haven't read the
229 yet, you are definitely in the wrong manual.
234 is the first place to go, since it describes the notation and format of
236 You should also be thoroughly familiar with the
240 and all of the basic features of \SpecialChar LyX
241 before attempting to read this one.
244 \begin_layout Standard
245 Since many of the topics in this manual depend heavily on \SpecialChar LyX
247 with \SpecialChar LaTeX
248 , this first chapter covers the inner workings of \SpecialChar LyX
251 to generate exactly the \SpecialChar LaTeX
253 It is obviously for more seasoned \SpecialChar LyX
257 \begin_layout Chapter
259 and \SpecialChar LaTeX
263 \begin_layout Section
265 Uses \SpecialChar LaTeX
269 \begin_layout Standard
270 This chapter is for both \SpecialChar TeX
271 -nicians and the \SpecialChar LaTeX
273 In it, we'll explain how \SpecialChar LyX
274 and \SpecialChar LaTeX
275 work together to produce printable output.
276 This is the only place in any of the manuals where we assume you know something
277 about \SpecialChar LaTeX
281 \begin_layout Standard
282 At one time, \SpecialChar LyX
284 \begin_inset Quotes eld
287 WYSIWYM frontend to \SpecialChar LaTeX
289 \begin_inset Quotes erd
292 but that's no longer true.
293 There are frontends to \SpecialChar LaTeX
298 \begin_layout Plain Layout
299 Some familar ones are \SpecialChar TeX
300 maker and kile, on Linux, and \SpecialChar TeX
302 There are also the \SpecialChar LaTeX
303 modes for vi and emacs, of course.
308 These are basically text editors with the ability to run \SpecialChar LaTeX
310 errors in the file you're editing.
311 Although \SpecialChar LyX
320 run \SpecialChar LaTeX
321 , and it also indicates errors in the file, it also does much, much
323 For one thing, you don't need to know \SpecialChar LaTeX
324 to use \SpecialChar LyX
327 has added its own extensions to \SpecialChar LaTeX
329 Try the following sometime: select
330 \begin_inset Flex Noun
333 \begin_layout Plain Layout
334 Export\SpecialChar menuseparator
342 \begin_inset Flex Noun
345 \begin_layout Plain Layout
352 \begin_inset Flex Noun
355 \begin_layout Plain Layout
356 View\SpecialChar menuseparator
366 ), then look at the preamble of the resulting
367 \begin_inset Flex Code
370 \begin_layout Plain Layout
377 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
379 These macros are defined automatically, according to the features you use
383 \begin_layout Standard
384 There are several commands that automatically invoke \SpecialChar LaTeX
389 \begin_layout Itemize
390 \begin_inset Flex Noun
393 \begin_layout Plain Layout
394 Document\SpecialChar menuseparator
403 \begin_layout Itemize
404 \begin_inset Flex Noun
407 \begin_layout Plain Layout
408 Document\SpecialChar menuseparator
417 \begin_layout Itemize
418 \begin_inset Flex Noun
421 \begin_layout Plain Layout
422 File\SpecialChar menuseparator
431 \begin_layout Itemize
432 \begin_inset Flex Noun
435 \begin_layout Plain Layout
436 File\SpecialChar menuseparator
445 \begin_layout Standard
446 They will only invoke \SpecialChar LaTeX
447 if the file has changed since the last time \SpecialChar LaTeX
453 \begin_layout Standard
454 When \SpecialChar LyX
455 runs \SpecialChar LaTeX
456 on the file you're editing, it performs these steps:
459 \begin_layout Enumerate
460 Convert the document to \SpecialChar LaTeX
461 and save to a file with the extension
462 \begin_inset Flex Code
465 \begin_layout Plain Layout
472 \begin_inset Flex Code
475 \begin_layout Plain Layout
484 \begin_layout Enumerate
485 Run \SpecialChar LaTeX
487 \begin_inset Flex Code
490 \begin_layout Plain Layout
496 file (maybe several times), and run any other commands (such as
497 \begin_inset Flex Code
500 \begin_layout Plain Layout
507 \begin_inset Flex Code
510 \begin_layout Plain Layout
516 ) needed to compile the \SpecialChar LaTeX
520 \begin_layout Enumerate
521 If there are any errors, show the error log.
524 \begin_layout Standard
525 If you have run \SpecialChar LaTeX
527 \begin_inset Flex Noun
530 \begin_layout Plain Layout
533 \SpecialChar menuseparator
542 then runs a DVI viewer to display the DVI-file.
544 \begin_inset Flex Noun
547 \begin_layout Plain Layout
550 \SpecialChar menuseparator
559 performs further steps:
562 \begin_layout Itemize
564 \begin_inset Flex Code
567 \begin_layout Plain Layout
573 to convert the DVI file to PostScript.
576 \begin_layout Itemize
577 Run a PostScript viewer, such as
578 \begin_inset Flex Code
581 \begin_layout Plain Layout
587 , to display the PostScript file.
590 \begin_layout Standard
592 does similar things when viewing, or exporting, other formats.
595 \begin_layout Section
596 Translating \SpecialChar LaTeX
597 files into \SpecialChar LyX
601 \begin_layout Standard
602 You can import a \SpecialChar LaTeX
603 file into \SpecialChar LyX
605 \begin_inset Flex Noun
608 \begin_layout Plain Layout
609 File\SpecialChar menuseparator
610 Import\SpecialChar menuseparator
617 command in \SpecialChar LyX
619 This will call a program named
620 \begin_inset Flex Code
623 \begin_layout Plain Layout
629 which will create a file
630 \begin_inset Flex Code
633 \begin_layout Plain Layout
640 \begin_inset Flex Code
643 \begin_layout Plain Layout
651 will then open that file.
655 \begin_layout Plain Layout
656 \begin_inset Flex Code
659 \begin_layout Plain Layout
665 can also be run from the command line, of course.
673 \begin_layout Standard
674 \begin_inset Flex Code
677 \begin_layout Plain Layout
683 will translate most legal \SpecialChar LaTeX
684 , but not everything.
685 It will put things it doesn't understand into \SpecialChar TeX
686 code, so after translating
688 \begin_inset Flex Code
691 \begin_layout Plain Layout
697 , you can look for \SpecialChar TeX
698 code and hand-edit it until it looks right.
701 \begin_layout Standard
702 If you don't know what \SpecialChar TeX
703 code is, read the next section.
706 \begin_layout Section
707 \begin_inset CommandInset label
709 name "sec:Inserting-TeX-Code"
713 Inserting \SpecialChar TeX
714 Code into \SpecialChar LyX
718 \begin_layout Standard
719 Anything you can do in \SpecialChar LaTeX
720 you can do in \SpecialChar LyX
721 , for a very simple reason: You can
722 always insert \SpecialChar TeX
723 code into any \SpecialChar LyX
726 cannot, and will never be able to, display every possible \SpecialChar LaTeX
728 If ever you need to insert \SpecialChar LaTeX
729 commands into your \SpecialChar LyX
730 document, you can use the
732 \begin_inset Flex Code
735 \begin_layout Plain Layout
742 box, which you can insert into your document with
743 \begin_inset Flex Noun
746 \begin_layout Plain Layout
747 Insert\SpecialChar menuseparator
757 or the keyboard shortcut
766 \begin_layout Standard
767 Here's an example of inserting \SpecialChar LaTeX
768 commands in a \SpecialChar LyX
770 The code looks like this:
773 \begin_layout LyX-Code
777 \begin_inset Newline newline
783 \begin_inset Newline newline
786 This is an example of a minipage environment.
788 \begin_inset Newline newline
791 can put nearly everything in it, even (non-floating)
792 \begin_inset Newline newline
797 \begin_inset Newline newline
803 \begin_inset Newline newline
807 \begin_inset Newline newline
813 \begin_inset Newline newline
819 \begin_inset Newline newline
825 \begin_inset Newline newline
830 \begin_inset Newline newline
836 \begin_inset Newline newline
842 \begin_inset Newline newline
848 \begin_inset Newline newline
856 \begin_layout LyX-Code
860 \begin_layout Standard
862 \begin_inset Flex Code
865 \begin_layout Plain Layout
872 box containing this text is directly after this paragraph.
873 Those of you reading the manual in \SpecialChar LyX
874 will only see the \SpecialChar TeX
876 Those reading a printed version of the manuals will see the actual results:
877 \begin_inset VSpace bigskip
883 \begin_layout Standard
887 \begin_layout Plain Layout
894 \begin_layout Plain Layout
901 \begin_layout Plain Layout
903 This is an example of a minipage environment.
904 You can put nearly everything in it, even (non-floating) figures and tables.
908 \begin_layout Plain Layout
915 \begin_layout Plain Layout
920 \begin_layout Plain Layout
927 \begin_layout Plain Layout
934 \begin_layout Plain Layout
941 \begin_layout Plain Layout
947 \begin_layout Plain Layout
954 \begin_layout Plain Layout
961 \begin_layout Plain Layout
968 \begin_layout Plain Layout
978 \begin_inset VSpace bigskip
984 \begin_layout Standard
985 In addition to using \SpecialChar TeX
986 code, you can also create a separate file containing
987 some complex \SpecialChar LaTeX
988 structure and then use
989 \begin_inset Flex Noun
992 \begin_layout Plain Layout
993 Insert\SpecialChar menuseparator
1003 to include your file (you should select the type
1004 \begin_inset Flex Code
1007 \begin_layout Plain Layout
1014 We recommend that you only do this if you have a
1015 \begin_inset Flex Code
1018 \begin_layout Plain Layout
1029 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1033 \begin_layout Standard
1034 There are a few last points to emphasize:
1037 \begin_layout Itemize
1043 check if your \SpecialChar LaTeX
1047 \begin_layout Itemize
1048 Beware of reinventing the wheel.
1051 \begin_layout Standard
1052 On that last point, \SpecialChar LyX
1053 does have quite a few features tucked into it, and
1055 Be sure to check the manuals to make sure that \SpecialChar LyX
1056 doesn't have such-and-such
1057 feature before you decide you have to do it by hand.
1058 Moreover, there are numerous \SpecialChar LaTeX
1059 packages out there to do all sorts of things,
1060 from labels to envelopes to fancy multipage tables.
1062 \begin_inset CommandInset href
1065 target "http://www.ctan.org/"
1072 \begin_layout Standard
1073 If you do need to do some wild and fancy things within your document, be
1074 sure to check out a good \SpecialChar LaTeX
1075 book for assistance.
1076 There are a number of them listed in the bibliography of the
1083 \begin_layout Section
1085 and the \SpecialChar LaTeX
1089 \begin_layout Subsection
1090 About the \SpecialChar LaTeX
1094 \begin_layout Standard
1095 If you already know \SpecialChar LaTeX
1096 , there is no need to explain here what the preamble
1098 If you don't, the following will give you some ideas—we recommend again
1099 that you consult a \SpecialChar LaTeX
1100 book for further information.
1101 In any case, you should read the points below, because they explain what
1102 you can do and what you don't need to do in the \SpecialChar LaTeX
1103 preamble of a \SpecialChar LyX
1107 \begin_layout Standard
1108 The \SpecialChar LaTeX
1109 preamble comes at the very beginning of a document,
1117 \begin_layout Itemize
1118 Declare the document class.
1120 \begin_inset Newline newline
1124 already does this for you.
1125 If you're a seasoned \SpecialChar LaTeX
1126 -nician, and you have a custom document class you
1127 want to use, check out the
1129 Customization Manual
1131 for information on how to make \SpecialChar LyX
1135 \begin_layout Itemize
1136 Declare the usage of packages.
1138 \begin_inset Newline newline
1142 packages provide special commands, which are only available within a document
1143 when the package has been declared in the preamble.
1144 In addition to providing special commands, the inclusion of a package can
1145 change the document.
1146 For example, the package
1147 \begin_inset Flex Code
1150 \begin_layout Plain Layout
1156 forces all paragraphs to be indented.
1157 There are other packages for labels, envelopes, margins, etc.
1161 \begin_layout Itemize
1162 Set counters, variables, lengths and widths.
1164 \begin_inset Newline newline
1167 There are several \SpecialChar LaTeX
1168 counters and variables that
1172 be set globally from within the preamble in order to have the desired effect.
1173 (There are variables that you can set and reset inside the document, too.)
1174 Margins are a good example of something that must be set in the preamble.
1175 Another example is the label format for lists.
1176 You can actually set these just about anywhere, but it's best to do it
1177 just once, inside the preamble.
1180 \begin_layout Itemize
1181 Declare user defined commands (with
1182 \begin_inset Flex Code
1185 \begin_layout Plain Layout
1194 \begin_inset Flex Code
1197 \begin_layout Plain Layout
1206 \begin_inset Newline newline
1209 These are abbreviations for \SpecialChar LaTeX
1210 commands which appear very often inside a document.
1211 Although the preamble is a good place to declare such commands, they
1215 be declared anywhere (before they are used for the first time, of course).
1216 This can be useful if there is a lot of raw \SpecialChar LaTeX
1217 code in your document, which
1218 normally should not be the case.
1221 \begin_layout Standard
1223 adds its own set of definitions to the preamble of the
1224 \begin_inset Flex Code
1227 \begin_layout Plain Layout
1234 This makes \SpecialChar LaTeX
1235 files generated by \SpecialChar LyX
1239 \begin_layout Subsection
1240 Changing the Preamble
1243 \begin_layout Standard
1244 The commands which \SpecialChar LyX
1245 adds to the preamble of a \SpecialChar LaTeX
1246 file are fixed; you can't
1247 change them without patching \SpecialChar LyX
1249 You can, however, add your own stuff to the preamble by selecting
1250 \begin_inset Flex Noun
1253 \begin_layout Plain Layout
1256 \begin_inset space ~
1265 \begin_inset Flex Noun
1268 \begin_layout Plain Layout
1269 Document\SpecialChar menuseparator
1277 adds anything in the
1278 \begin_inset Flex Noun
1281 \begin_layout Plain Layout
1287 dialog to its own built-in preamble.
1288 Before adding your own declarations in the preamble, you should make sure
1289 that \SpecialChar LyX
1290 doesn't already support what you want to do.
1291 (Remember what we said about reinventing the wheel?) Also,
1293 make sure your preamble code is correct
1297 doesn't check it for you.
1298 If there is an error, you're likely to get an error like
1299 \begin_inset Quotes eld
1303 \begin_inset Flex Code
1306 \begin_layout Plain Layout
1315 \begin_inset Quotes erd
1319 If you see this error, check your preamble.
1322 \begin_layout Subsection
1326 \begin_layout Standard
1327 Here are some examples of what you can add to a preamble, and what they
1331 \begin_layout Subsubsection
1335 \begin_layout Standard
1336 There are two variables under \SpecialChar LaTeX
1337 that control page position:
1338 \begin_inset Flex Code
1341 \begin_layout Plain Layout
1350 \begin_inset Flex Code
1353 \begin_layout Plain Layout
1362 Their names should be self-explanatory.
1363 These variables are useful if you think for a moment about computer labels.
1364 Sometimes, the size of a print medium and the area of the medium that you
1365 can actually print on aren't the same.
1367 \begin_inset Flex Code
1370 \begin_layout Plain Layout
1379 \begin_inset Flex Code
1382 \begin_layout Plain Layout
1393 \begin_layout Standard
1394 The default values for
1395 \begin_inset Flex Code
1398 \begin_layout Plain Layout
1407 \begin_inset Flex Code
1410 \begin_layout Plain Layout
1419 \begin_inset space \thinspace{}
1423 \begin_inset space \thinspace{}
1427 \begin_inset space \space{}
1430 the page isn't shifted.
1431 Unfortunately, some DVI drivers always seem to shift the page.
1432 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1433 If you're using \SpecialChar LyX
1434 on a system that you don't personally maintain, and your
1435 sysadmin is a doofus,
1436 \begin_inset Flex Code
1439 \begin_layout Plain Layout
1448 \begin_inset Flex Code
1451 \begin_layout Plain Layout
1460 Suppose your left and top margins are always 0.5
1461 \begin_inset space \thinspace{}
1465 You can add this to the preamble:
1468 \begin_layout LyX-Code
1476 \begin_layout LyX-Code
1484 \begin_layout Standard
1485 and your margins should now be correct.
1488 \begin_layout Subsubsection
1492 \begin_layout Standard
1493 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1494 There's a rather nice package, available at your nearest CTAN archive,
1495 for printing sheets of labels:
1496 \begin_inset Flex Code
1499 \begin_layout Plain Layout
1506 Now, your system may not have this package installed by default.
1507 We leave that up to you to check.
1508 You'll also want to read the documentation for it; we're not going to do
1510 Since this is an example, however, we'll give you an example of how you
1514 \begin_layout Standard
1515 First, make sure you're using the
1516 \begin_inset Flex Code
1519 \begin_layout Plain Layout
1526 Next, you need to put the following in your preamble:
1529 \begin_layout LyX-Code
1535 \begin_layout LyX-Code
1541 \begin_layout LyX-Code
1547 \begin_layout LyX-Code
1553 \begin_layout LyX-Code
1559 \begin_layout LyX-Code
1565 \begin_layout LyX-Code
1571 \begin_layout Standard
1572 This sets things up for Avery label sheets, stock #5360.
1573 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1576 \begin_inset Flex Code
1579 \begin_layout Plain Layout
1588 \begin_inset Flex Code
1591 \begin_layout Plain Layout
1599 around each label text.
1600 This and other special features of
1601 \begin_inset Flex Code
1604 \begin_layout Plain Layout
1610 are explained in its documentation.
1613 \begin_layout Standard
1614 Someday, someone may write a \SpecialChar LyX
1615 layout file to support this package directly.
1616 Maybe that someone is you.
1619 \begin_layout Subsubsection
1620 Example #3: Paragraph Indentation
1623 \begin_layout Standard
1624 Americans are trained to indent the first line of
1629 As with all of their other weird quirks, most Americans will whine and
1630 moan until they can have their way and indent the first line of all paragraphs.
1639 \begin_layout Standard
1640 Of course, this behavior isn't standard typography.
1641 In books, you typically only indent the first line of a paragraph
1645 it follows another one.
1646 The idea behind indenting the first line of a paragraph is to distinguish
1647 neighboring paragraphs from one another.
1648 If there is no previous paragraph—for example, if it follows a figure or
1649 is the first paragraph in a section—then there is no need for indentation.
1653 \begin_layout Standard
1654 If you're a typical American (we're still joking!), though, you don't care
1655 about such esoteric things; you want your indentation! Add this to the
1659 \begin_layout LyX-Code
1662 usepackage{indentfirst}
1665 \begin_layout Standard
1666 If your \SpecialChar TeX
1667 distribution isn't braindead, you'll have this package, and all
1668 of your paragraphs will get the indentation the Founding Fathers intended
1672 \begin_layout Subsubsection
1673 Example #4: This Document
1676 \begin_layout Standard
1677 You can also check out the preamble of this document to get an idea of some
1678 of the advanced things you can do.
1681 \begin_layout Section
1683 and \SpecialChar LaTeX
1687 \begin_layout Standard
1688 When \SpecialChar LyX
1689 calls \SpecialChar LaTeX
1690 , it tells \SpecialChar LaTeX
1691 to blithely ignore any errors and keep going.
1692 It then uses the logfile from the \SpecialChar LaTeX
1693 run to do a post-mortem.
1694 After analyzing the logfile, \SpecialChar LyX
1695 displays a dialog listing the errors.
1696 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1698 where the error occurred.
1702 \begin_layout Plain Layout
1704 Analyzing the logfile is a tough job, and \SpecialChar LyX
1705 doesn't always go to the right
1707 There are also cases where \SpecialChar LaTeX
1708 reports the error on one line, but the actual
1710 This is not unlike forgetting a closing brace in a program: You'll get
1711 an error, but only later.
1719 \begin_layout Standard
1720 Some folks also like to look at the log file directly: It is available from
1722 \begin_inset Flex Noun
1725 \begin_layout Plain Layout
1728 \SpecialChar menuseparator
1732 \begin_inset space ~
1741 There are some fairly common error messages and warnings.
1742 We'll cover those here.
1743 You should look at a good \SpecialChar LaTeX
1744 book for a complete listing.
1747 \begin_layout Itemize
1748 \begin_inset Flex Code
1751 \begin_layout Plain Layout
1759 \begin_inset Newline newline
1762 Anything beginning with these words is a warning message for the purpose
1764 \begin_inset Quotes eld
1768 \begin_inset Quotes erd
1771 the \SpecialChar LaTeX
1773 You'll get messages like this if you added or changed cross-references
1774 or bibliography entries, in which case, \SpecialChar LaTeX
1775 is trying to tell you that you
1776 need to make another run.
1777 You can by-and-large ignore these.
1780 \begin_layout Itemize
1781 \begin_inset Flex Code
1784 \begin_layout Plain Layout
1792 \begin_inset Newline newline
1795 Another warning message, this time about fonts which \SpecialChar LaTeX
1797 The rest of the message will often say something about a replacement font
1798 that \SpecialChar LaTeX
1800 You can safely ignore these, too.
1803 \begin_layout Itemize
1804 \begin_inset Flex Code
1807 \begin_layout Plain Layout
1816 \begin_inset Newline newline
1825 They are warnings about lines that were too long and run past the right
1827 Almost always, this is unnoticeable in the final output.
1828 (It can be just a point or two.) Or, only one or two characters extend past
1831 seems to generate at least one of these messages for just about any document
1833 \begin_inset Newline newline
1836 You can ignore these messages.
1837 Your eyes will tell you if there's a problem with something that's too
1838 wide; just look at the output.
1842 \begin_layout Plain Layout
1843 You can also enable the `draft' option in
1844 \begin_inset Flex Noun
1847 \begin_layout Plain Layout
1850 \SpecialChar menuseparator
1858 , and then \SpecialChar LaTeX
1859 will draw a black box in the margin of lines that are overfull.
1867 \begin_layout Itemize
1868 \begin_inset Flex Code
1871 \begin_layout Plain Layout
1880 \begin_inset Newline newline
1883 Not quite as common as its cousin.
1885 seems to like to print lines that are a bit too wide as opposed to ones
1886 that are a bit too narrow.
1887 We have no idea why.
1890 \begin_layout Itemize
1891 \begin_inset Flex Code
1894 \begin_layout Plain Layout
1903 \begin_inset Flex Code
1906 \begin_layout Plain Layout
1915 \begin_inset Newline newline
1918 Warnings about troubles breaking the page.
1919 Once again, just look at the output.
1920 Your eyes will tell you where something has gone wrong.
1923 \begin_layout Itemize
1924 \begin_inset Flex Code
1927 \begin_layout Plain Layout
1930 \begin_inset Quotes els
1934 \begin_inset Quotes ers
1943 \begin_inset Newline newline
1947 \begin_inset Quotes eld
1951 \begin_inset Quotes erd
1954 isn't installed on this system.
1955 This usually appears because some package your document needs isn't installed.
1956 If you didn't touch the preamble or didn't use the
1957 \begin_inset Flex Code
1960 \begin_layout Plain Layout
1968 command, then one of the packages \SpecialChar LyX
1969 tried to load is missing.
1971 \begin_inset Flex Noun
1974 \begin_layout Plain Layout
1975 Help\SpecialChar menuseparator
1982 to get a list of packages that \SpecialChar LyX
1984 This file is updated whenever you reconfigure \SpecialChar LyX
1986 \begin_inset Flex Noun
1989 \begin_layout Plain Layout
1990 Tools\SpecialChar menuseparator
1996 ) and tells you which packages have been detected and what they do.
1997 \begin_inset Newline newline
2001 \begin_inset Flex Code
2004 \begin_layout Plain Layout
2012 command and the package in question isn't installed, then you'll need to
2013 install it yourself.
2016 \begin_layout Itemize
2017 \begin_inset Flex Code
2020 \begin_layout Plain Layout
2022 Error: Unknown option
2028 \begin_inset Newline newline
2031 Error messages beginning with this are trying to tell you that you specified
2032 a bad or undefined option to a package.
2033 Check the package's documentation.
2036 \begin_layout Itemize
2037 \begin_inset Flex Code
2040 \begin_layout Plain Layout
2041 Undefined control sequence
2047 \begin_inset Newline newline
2050 If you've inserted \SpecialChar LaTeX
2051 code into your document, but made a typo, you'll get
2053 You may have forgotten to load a package.
2054 In any case, this error message usually means that you used an undefined
2059 \begin_layout Standard
2060 There are other error and warning messages.
2061 Some are self-explanatory.
2062 These are usually \SpecialChar LaTeX
2064 Others are downright cryptic.
2065 These are usually \SpecialChar TeX
2066 error messages, and we really have
2070 what they mean or how to decipher them.
2074 \begin_layout Standard
2075 There's a general sequence you should follow if you get error messages:
2078 \begin_layout Enumerate
2079 Look at the \SpecialChar LaTeX
2080 code you inserted for typos.
2083 \begin_layout Enumerate
2084 If there are no typos, check that you used the command(s) correctly.
2087 \begin_layout Enumerate
2088 If you get a bunch of error boxes piled up at the very top of the document—and
2089 especially if you see a
2090 \begin_inset Quotes eld
2094 \begin_inset Flex Code
2097 \begin_layout Plain Layout
2106 \begin_inset Quotes erd
2109 error—it means that there are errors in the preamble.
2110 Start debugging your preamble.
2113 \begin_layout Enumerate
2114 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2116 document, the first suspect is your \SpecialChar LaTeX
2117 distribution itself.
2118 Check for missing packages and install them.
2121 \begin_layout Enumerate
2122 Okay, so there are no missing packages.
2123 Did you use any of the fine-tuning options in \SpecialChar LyX
2124 ? Specifically, did you
2128 any of them, like trying to manually insert lots of
2129 \begin_inset Flex Code
2132 \begin_layout Plain Layout
2134 \begin_inset space ~
2143 \begin_inset Flex Code
2146 \begin_layout Plain Layout
2153 \begin_inset Flex Code
2156 \begin_layout Plain Layout
2162 ? Did you try to kludge something together with these instead of using the
2163 appropriate paragraph environment?
2166 \begin_layout Enumerate
2167 All right, you didn't use any of the fine-tuning options, you played by
2169 Did you try to pull a fancy maneuver? Did you do something funky inside
2170 a table or an equation, like inserting a graphic into a table cell?
2173 \begin_layout Enumerate
2174 Do you have long sections of text where \SpecialChar LaTeX
2175 cannot find a place to break a
2176 line? By default, \SpecialChar LaTeX
2177 is rather strict about how much extra inter-word spacing
2178 it will add in order to break a line.
2179 Preferably, you should rework the paragraph to avoid the problem.
2182 \begin_layout Enumerate
2183 Did you go overboard with the nesting? \SpecialChar LyX
2184 (currently) doesn't check to make
2185 sure you're in the limits for nesting environments.
2186 If you nested a bunch of environments to the
2187 \begin_inset Formula $17^{\mathrm{th}}$
2190 level, that's the problem.
2191 (The limit in \SpecialChar LaTeX
2195 \begin_layout Enumerate
2196 Okay, you didn't get any error messages, but your output looks awful.
2197 If you have a table or figure that's too wide or long for the page, you
2199 \begin_inset Separator parbreak
2206 \begin_layout Enumerate
2207 rescale the figure so it fits.
2210 \begin_layout Enumerate
2211 trim down the table so it fits.
2215 \begin_layout Enumerate
2216 If something else is wrong with the output, and you didn't try to pull anything
2217 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2220 \begin_layout Standard
2221 If all this doesn't help—well, then
2225 you might have found a bug in \SpecialChar LyX
2230 \begin_layout Chapter
2234 \begin_layout Section
2235 Customizing Bibliographies with Bib\SpecialChar TeX
2239 \begin_layout Standard
2240 The most basic information about how to use Bib\SpecialChar TeX
2241 with \SpecialChar LyX
2245 Bibliography databases (Bib\SpecialChar TeX
2253 The following subsections explain special bibliography features supported
2258 \begin_layout Subsection
2259 Alternative Citation Styles
2262 \begin_layout Standard
2263 Standard Bib\SpecialChar TeX
2265 \begin_inset space \thinspace{}
2269 \begin_inset space \space{}
2273 \begin_inset Quotes eld
2277 \begin_inset Quotes erd
2280 ) to refer to a cited work.
2281 However, in many scientific disciplines, other citation styles are in use.
2282 The most common one is the author-year style (e.
2283 \begin_inset space \thinspace{}
2287 \begin_inset space \space{}
2291 \begin_inset Quotes eld
2295 \begin_inset Quotes erd
2300 supports two packages that provide this style,
2301 \begin_inset Flex Code
2304 \begin_layout Plain Layout
2311 \begin_inset Flex Code
2314 \begin_layout Plain Layout
2321 Both packages have their pros and cons, which cannot be listed in detail.
2322 If you only want to have simple author-year (or author-numerical) style,
2323 or if you want to use one of the countless style files for
2324 \begin_inset Flex Code
2327 \begin_layout Plain Layout
2333 , then the established
2334 \begin_inset Flex Code
2337 \begin_layout Plain Layout
2343 package is probably your choice.
2344 If you need special features like short title references, ibidem etc., you
2346 \begin_inset Flex Code
2349 \begin_layout Plain Layout
2358 \begin_layout Standard
2359 The handling of both packages in \SpecialChar LyX
2360 is basically the same.
2362 \begin_inset Flex Noun
2365 \begin_layout Plain Layout
2366 Document\SpecialChar menuseparator
2373 \begin_inset Flex Noun
2376 \begin_layout Plain Layout
2383 \begin_inset Flex Noun
2386 \begin_layout Plain Layout
2393 \begin_inset Flex Noun
2396 \begin_layout Plain Layout
2403 With both packages, you will get some extra features in the citation dialog
2404 and you can select the style of the reference (
2405 \begin_inset Quotes eld
2409 \begin_inset Quotes erd
2413 \begin_inset Quotes eld
2417 \begin_inset Quotes erd
2421 \begin_inset Quotes eld
2425 \begin_inset Quotes erd
2429 \begin_inset Quotes eld
2433 \begin_inset Quotes erd
2437 Note that both packages need specifically designed style files.
2438 They both ship their own, but there are lots of additional style files,
2439 and there is even an interactive style file builder
2443 \begin_layout Plain Layout
2445 \begin_inset Flex URL
2448 \begin_layout Plain Layout
2450 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2461 \begin_inset Flex Code
2464 \begin_layout Plain Layout
2473 \begin_layout Subsection
2474 Sectioned Bibliographies
2477 \begin_layout Standard
2478 Sometimes you might need to divide your bibliography into several sections.
2479 If you are for instance a historian, the possibility to separate sources
2480 and scientific works is most likely a
2481 \begin_inset Quotes eld
2485 \begin_inset Quotes erd
2489 Unfortunately, Bib\SpecialChar TeX
2490 itself does not allow you to do this.
2491 But with the help of some \SpecialChar LaTeX
2492 packages, Bib\SpecialChar TeX
2493 can be extended to fit your needs.
2496 \begin_layout Standard
2498 provides native support for one of these packages,
2506 \begin_layout Plain Layout
2508 \begin_inset Flex URL
2511 \begin_layout Plain Layout
2513 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2523 The advantage of this package (compared to other packages like
2527 ) is that you don't need to define new citation commands.
2528 Instead, you need to prepare different bibliographic databases which include
2529 the entries for the different sections of the bibliography.
2530 For example: If you want to divide your bibliography into the sections
2532 \begin_inset Quotes eld
2536 \begin_inset Quotes erd
2540 \begin_inset Quotes eld
2544 \begin_inset Quotes erd
2547 , you first need to create two bibliographic databases, e.
2548 \begin_inset space \thinspace{}
2552 \begin_inset space \space{}
2556 \begin_inset Flex Code
2559 \begin_layout Plain Layout
2566 \begin_inset Flex Code
2569 \begin_layout Plain Layout
2579 \begin_layout Standard
2581 \begin_inset Flex Noun
2584 \begin_layout Plain Layout
2585 Document\SpecialChar menuseparator
2592 \begin_inset Flex Noun
2595 \begin_layout Plain Layout
2602 \begin_inset Flex Noun
2605 \begin_layout Plain Layout
2606 Sectioned bibliography
2612 Now you can insert multiple Bib\SpecialChar TeX
2613 bibliographies, one for each section of
2615 Returning to our example: Insert the Bib\SpecialChar TeX
2617 \begin_inset Flex Code
2620 \begin_layout Plain Layout
2626 and a second one for the database
2627 \begin_inset Flex Code
2630 \begin_layout Plain Layout
2637 You are free to use the same or different styles for each section.
2638 Additionally, you can choose if the bibliography section should contain
2640 \begin_inset Quotes eld
2643 all cited references
2644 \begin_inset Quotes erd
2647 of the specified database(s) (which is the default),
2648 \begin_inset Quotes eld
2651 all uncited references
2652 \begin_inset Quotes erd
2656 \begin_inset Quotes eld
2660 \begin_inset Quotes erd
2664 This might be useful if you would like to separate your bibliography into
2666 \begin_inset Quotes eld
2670 \begin_inset Quotes erd
2674 \begin_inset Quotes eld
2678 \begin_inset Quotes erd
2682 \begin_inset Quotes eld
2686 \begin_inset Quotes erd
2690 The titles for the sections can be added as ordinary sections or subsections.
2692 \begin_inset Flex Code
2695 \begin_layout Plain Layout
2701 removes the bibliography title, you have to manually re-add that, too (as
2702 a chapter* or section*, for instance).
2705 \begin_layout Subsection
2706 Multiple Bibliographies
2709 \begin_layout Standard
2710 Multiple bibliographies, e.
2711 \begin_inset space \thinspace{}
2715 \begin_inset space \space{}
2718 a bibliography for each section or chapter of the document, are not supported
2719 by Bib\SpecialChar TeX
2722 \begin_inset Flex Code
2725 \begin_layout Plain Layout
2731 package, which is used for the creation of sectioned bibliographies in
2733 (see the previous section), provides an easy way to solve this task, if
2734 you are willing to use some
2735 \begin_inset Flex Noun
2738 \begin_layout Plain Layout
2746 \begin_inset space ~
2750 \begin_inset CommandInset ref
2752 reference "sec:Inserting-TeX-Code"
2760 \begin_layout Plain Layout
2761 An alternative approach is to use the
2762 \begin_inset Flex Code
2765 \begin_layout Plain Layout
2772 \begin_inset Flex Code
2775 \begin_layout Plain Layout
2781 package, respectively.
2789 \begin_layout Standard
2791 \begin_inset Flex Noun
2794 \begin_layout Plain Layout
2795 Document\SpecialChar menuseparator
2802 \begin_inset Flex Noun
2805 \begin_layout Plain Layout
2812 \begin_inset Flex Noun
2815 \begin_layout Plain Layout
2816 Sectioned bibliography
2822 In the document, you have to enclose the sections, which shall contain
2823 their own bibliography (including the Bib\SpecialChar TeX
2824 bibliography itself), between
2826 \begin_inset Flex Code
2829 \begin_layout Plain Layout
2838 \begin_inset Flex Code
2841 \begin_layout Plain Layout
2849 (those commands have to be inserted as \SpecialChar TeX
2851 The bibliography will contain all references that have been cited in the
2853 \begin_inset Flex Code
2856 \begin_layout Plain Layout
2867 If you are using this approach, then every citation reference has to be
2869 \begin_inset Flex Code
2872 \begin_layout Plain Layout
2880 \begin_inset Flex Code
2883 \begin_layout Plain Layout
2892 \begin_layout Section
2896 \begin_layout Subsection
2900 \begin_layout Standard
2901 When you are working on a large file with many sections, it is often convenient
2902 to break up the document into several files, or perhaps you have something
2903 where a table may change from time to time, but the preceding text does
2905 In these cases, you should seriously consider using multipart documents.
2906 For example, scientific papers often have five major sections: the introduction
2907 , observations, results, discussion, and conclusion.
2908 Each of these could be its own separate \SpecialChar LyX
2910 \begin_inset Quotes eld
2914 \begin_inset Quotes erd
2917 file which contains the title, authors, abstract, references, etc., plus
2918 the five included files.
2919 It is important to note that each of these files is a full \SpecialChar LyX
2921 can be formatted and printed on its own, as well as included in a master
2923 Each of these files must have the same document class, however—don't attempt
2924 to mix book classes with article classes.
2925 You may also include \SpecialChar LaTeX
2926 files; however, these files must not have their own
2928 \begin_inset space \thinspace{}
2932 \begin_inset space \space{}
2935 everything up to and including the
2936 \begin_inset Flex Code
2939 \begin_layout Plain Layout
2948 \begin_inset Flex Code
2951 \begin_layout Plain Layout
2959 line must be deleted) or else errors will be generated when you try to
2963 \begin_layout Standard
2965 allows you to include files quite easily with
2966 \begin_inset Flex Noun
2969 \begin_layout Plain Layout
2970 Insert\SpecialChar menuseparator
2972 \begin_inset space ~
2981 When you click on this selection a small box is inserted into the file
2982 at the current cursor location.
2983 Clicking on the box raises a dialog which allows you to select the file
2984 to be included, and the method of its inclusion.
2988 \begin_layout Standard
2989 The file selection box should by now be obvious.
2990 The three inclusion methods are
2991 \begin_inset Quotes eld
2995 \begin_inset Quotes erd
2999 \begin_inset Quotes eld
3003 \begin_inset Quotes erd
3007 \begin_inset Quotes eld
3011 \begin_inset Quotes erd
3015 The difference between
3016 \begin_inset Quotes eld
3020 \begin_inset Quotes erd
3024 \begin_inset Quotes eld
3028 \begin_inset Quotes erd
3031 is really only meaningful to \SpecialChar LaTeX
3032 perts, but the practical difference is that
3034 \begin_inset Quotes eld
3038 \begin_inset Quotes erd
3041 are typeset beginning on a new page, while files that are
3042 \begin_inset Quotes eld
3046 \begin_inset Quotes erd
3049 are typeset starting on the current page.
3052 \begin_layout Standard
3053 Generally, the master file is converted into a full \SpecialChar LaTeX
3054 file before typesetting,
3055 while the included files are converted to \SpecialChar LaTeX
3056 files that do not have all the
3057 preamble information.
3060 \begin_layout Standard
3062 \begin_inset Quotes eld
3066 \begin_inset Quotes erd
3069 included file allows you to include a file typeset exactly as it appears
3071 \begin_inset space \thinspace{}
3075 \begin_inset space \space{}
3079 \begin_inset Flex Code
3082 \begin_layout Plain Layout
3088 mode, with the characters set in a fixed-width typewriter font.
3089 Normally, spaces in this file are invisible, though two consecutive spaces
3090 are conserved, unlike \SpecialChar LyX
3091 's normal treatment of spaces.
3092 However, setting the
3093 \begin_inset Flex Noun
3096 \begin_layout Plain Layout
3098 \begin_inset space ~
3102 \begin_inset space ~
3106 \begin_inset space ~
3114 checkbox typesets a mark to unambiguously define the presence of a space.
3118 \begin_layout Subsection
3119 Cross-References Between Files
3122 \begin_layout Standard
3123 \begin_inset Box Shadowbox
3133 height_special "totalheight"
3138 backgroundcolor "none"
3141 \begin_layout Plain Layout
3142 This section is somewhat out of date.
3143 Need to describe default master documents and how children are opened when
3153 \begin_layout Standard
3154 It is possible to set up cross-references between the different files.
3155 First, open all the files in question: let's call them A and B in a two
3156 file example, where B is included in A.
3157 Let's say you insert a label in A, then want to reference it in B.
3158 Open the cross-reference dialog whilst in document B, and you can select
3160 \begin_inset Quotes eld
3164 \begin_inset Quotes erd
3170 \begin_layout Subsection
3171 Bibliography Lists in all Subdocuments
3174 \begin_layout Standard
3175 \begin_inset Box Frameless
3185 height_special "totalheight"
3190 backgroundcolor "none"
3193 \begin_layout Plain Layout
3194 This section also needs updating.
3195 There is now material about this on the wiki, and it could be copied here.
3203 \begin_layout Standard
3204 Copy the bibliography list with all entries to all subdocuments and transform
3206 This way \SpecialChar LyX
3208 \begin_inset Flex Code
3211 \begin_layout Plain Layout
3217 -files and you can easily insert references without making the bibliography
3221 \begin_layout Standard
3222 As the bibliography list is in a comment, \SpecialChar LaTeX
3223 won't use it and the references
3224 will look like this: [?], instead of like this: [1].
3225 One solution is to use the \SpecialChar LaTeX
3227 \begin_inset Flex Code
3230 \begin_layout Plain Layout
3236 that will only include comments by processing the files separately.
3237 To do this, add in the \SpecialChar LaTeX
3238 preamble of every subdocument the following:
3241 \begin_layout LyX-Code
3247 \begin_layout LyX-Code
3250 includecomment{comment}
3253 \begin_layout Standard
3255 \begin_inset Flex URL
3258 \begin_layout Plain Layout
3260 http://wiki.lyx.org/FAQ/Unsorted#toc31
3268 \begin_layout Section
3273 \begin_layout Standard
3274 Users sometimes need to be able to
3275 \begin_inset Quotes eld
3279 \begin_inset Quotes erd
3283 file together with all the images (and other files) on which it depends,
3284 either for sending to a publisher or for sharing with a co-author.
3286 2.0 includes a Python script (
3287 \begin_inset Flex Code
3290 \begin_layout Plain Layout
3296 ) that automates this process.
3297 To use it, you must have either the
3298 \begin_inset Flex Code
3301 \begin_layout Plain Layout
3308 \begin_inset Flex Code
3311 \begin_layout Plain Layout
3317 python modules installed on your system.
3318 By default, the script prefers the
3319 \begin_inset Flex Code
3322 \begin_layout Plain Layout
3329 \begin_inset Flex Code
3332 \begin_layout Plain Layout
3338 format on Unix-like systems and the
3339 \begin_inset Flex Code
3342 \begin_layout Plain Layout
3351 \begin_layout Standard
3353 's configuration process will set the script up to export a `\SpecialChar LyX
3355 and this format will then be available under
3356 \begin_inset Flex Code
3359 \begin_layout Plain Layout
3360 File\SpecialChar menuseparator
3369 \begin_layout Standard
3370 Independently of the platform, the generation of a particular archive format
3371 can be forced by adding either the
3372 \begin_inset Flex Code
3375 \begin_layout Plain Layout
3382 \begin_inset Flex Code
3385 \begin_layout Plain Layout
3392 \begin_inset Flex Code
3395 \begin_layout Plain Layout
3402 \begin_inset Flex Code
3405 \begin_layout Plain Layout
3411 format) switch to the
3412 \begin_inset Flex Code
3415 \begin_layout Plain Layout
3417 \SpecialChar menuseparator
3425 \begin_inset Flex Code
3428 \begin_layout Plain Layout
3429 Tools\SpecialChar menuseparator
3430 Preferences\SpecialChar menuseparator
3431 File Handling\SpecialChar menuseparator
3438 (Make sure you add the switch after the script name, not before it.)
3441 \begin_layout Section
3442 Fancy Headers and Footers
3445 \begin_layout Standard
3446 The default page layout is rather plain; for an
3447 \begin_inset Flex Code
3450 \begin_layout Plain Layout
3456 document class, all you get is a centered page number at the bottom of
3458 This document uses KOMA-script's book class, so it appears to be a bit
3460 But to really put on a show, you need to set the document page style to
3462 \begin_inset Quotes eld
3466 \begin_inset Quotes erd
3469 , as mentioned in the
3474 This section describes the \SpecialChar LaTeX
3475 code you need to insert in your \SpecialChar LaTeX
3477 order to get the desired effects.
3480 \begin_layout Standard
3481 For more information on fancy headers, see the
3482 \begin_inset Flex Code
3485 \begin_layout Plain Layout
3491 package documentation.
3493 \begin_inset Flex URL
3496 \begin_layout Plain Layout
3498 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3506 \begin_layout Standard
3507 The page header is divided into three fields, not surprisingly labeled
3508 \begin_inset Quotes eld
3512 \begin_inset Quotes erd
3516 \begin_inset Quotes eld
3520 \begin_inset Quotes erd
3524 \begin_inset Quotes eld
3528 \begin_inset Quotes erd
3532 The footer is also divided into these three fields.
3533 The \SpecialChar LaTeX
3534 commands to set these fields in the simplest manner are
3535 \begin_inset Flex Code
3538 \begin_layout Plain Layout
3547 \begin_inset Flex Code
3550 \begin_layout Plain Layout
3559 \begin_inset Flex Code
3562 \begin_layout Plain Layout
3571 \begin_inset Flex Code
3574 \begin_layout Plain Layout
3583 Suppose you wish to put your name in the upper left hand corner of each
3585 Simply insert the following command in the preamble:
3588 \begin_layout Standard
3597 \begin_layout Standard
3598 You will now see your name in the upper left.
3599 If a field has a default entry that you would like to get rid of (often
3600 the page number appears in the central footer) simply include a command
3601 with a blank argument, e.
3602 \begin_inset space \thinspace{}
3608 \begin_layout Standard
3616 \begin_layout Standard
3617 Let's get really fancy: lets put the section number with the word
3618 \begin_inset Quotes eld
3622 \begin_inset Quotes erd
3626 \begin_inset space \thinspace{}
3630 \begin_inset space \space{}
3633 Section 3) in the upper left, the page number (e.
3634 \begin_inset space \thinspace{}
3638 \begin_inset space \space{}
3641 Page 4) in the upper right, your name in the lower left, and the date in
3643 The following commands should now appear in the preamble:
3646 \begin_layout Standard
3656 \begin_layout Standard
3664 \begin_layout Standard
3674 \begin_layout Standard
3683 \begin_layout Standard
3691 \begin_layout Standard
3701 \begin_layout Standard
3703 \begin_inset Flex Code
3706 \begin_layout Plain Layout
3715 \begin_inset Flex Code
3718 \begin_layout Plain Layout
3726 access \SpecialChar LaTeX
3727 's section and page counters, and so print out the current section
3730 \begin_inset Flex Code
3733 \begin_layout Plain Layout
3741 simply prints out today's date.
3744 \begin_layout Standard
3745 The thicknesses of the horizontal rules drawn beneath the header and above
3746 the footer can also be modified.
3747 If you don't want one of the rules, set its thickness to 0.
3748 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3754 \begin_inset Flex Code
3757 \begin_layout Plain Layout
3762 headrulewidth}{0.4pt}
3768 \begin_inset Flex Code
3771 \begin_layout Plain Layout
3776 footrulewidth}{0.4pt}
3781 to set the thicknesses.
3784 \begin_layout Standard
3785 You can switch the header/footer settings on and off for individual pages
3787 \begin_inset Flex Code
3790 \begin_layout Plain Layout
3793 thispagestyle{empty}
3799 \begin_inset Flex Code
3802 \begin_layout Plain Layout
3805 thispagestyle{plain}
3811 \begin_inset Flex Code
3814 \begin_layout Plain Layout
3817 thispagestyle{fancy}
3823 Simply insert them in the text on the page you want changed and mark them
3826 In fact, title pages are marked as plain by default, while following pages
3827 are marked fancy when using the global fancy setting.
3830 \begin_layout Standard
3831 As a final example, it is possible to include an image in the header or
3833 Suppose you want to put a company logo in the upper lefthand corner.
3834 You might try something like
3837 \begin_layout Standard
3846 includegraphics{logo.eps}}}
3849 \begin_layout Standard
3851 (you may need to preface this with
3852 \begin_inset Flex Code
3855 \begin_layout Plain Layout
3859 usepackage{graphics}
3864 if you don't include graphics elsewhere in your document).
3867 \begin_layout Section
3868 Itemize Bullet Selection
3869 \begin_inset CommandInset label
3878 \begin_layout Standard
3884 \begin_layout Subsection
3888 \begin_layout Standard
3890 provides 216 bullet shapes that can be accessed from a simple dialog.
3891 Using this dialog you can easily specify what bullet shape to use at each
3892 level of an itemized list.
3893 These settings are document-wide so you won't be able to specify different
3894 sets of bullets for different paragraphs.
3898 \begin_layout Plain Layout
3899 Well, actually you can but you'll have to do it by hand.
3907 \begin_layout Subsection
3911 \begin_layout Standard
3912 Open the dialog by selecting the
3913 \begin_inset Flex Noun
3916 \begin_layout Plain Layout
3917 Document\SpecialChar menuseparator
3923 menu item and then select the
3924 \begin_inset Flex Noun
3927 \begin_layout Plain Layout
3936 \begin_layout Standard
3937 The dialog provides you with a table of bullet shapes.
3938 A column of buttons on the left of the table provides access to the six
3939 different panels of bullet shapes.
3940 The row of buttons across the top is used to select which bullet depth
3942 A text entry under the table shows the currently selected bullet shape's
3944 equivalent and this can be edited if desired.
3945 If you do modify the text you will also need to specify any needed packages
3946 in the \SpecialChar LaTeX
3950 \begin_layout Standard
3951 The six panels are divided up by the packages they require.
3952 The following table shows the mappings from button name to \SpecialChar LaTeX
3954 \begin_inset Separator parbreak
3960 \begin_layout Standard
3962 \begin_inset Tabular
3963 <lyxtabular version="3" rows="7" columns="2">
3964 <features tabularvalignment="middle">
3965 <column alignment="center" valignment="top" width="0pt">
3966 <column alignment="center" valignment="top" width="0pt">
3968 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3971 \begin_layout Plain Layout
3986 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3989 \begin_layout Plain Layout
4006 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4009 \begin_layout Plain Layout
4024 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4027 \begin_layout Plain Layout
4036 base \SpecialChar LaTeX
4044 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4047 \begin_layout Plain Layout
4062 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4065 \begin_layout Plain Layout
4082 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4085 \begin_layout Plain Layout
4100 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4103 \begin_layout Plain Layout
4120 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4123 \begin_layout Plain Layout
4138 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4141 \begin_layout Plain Layout
4158 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4161 \begin_layout Plain Layout
4176 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4179 \begin_layout Plain Layout
4196 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4199 \begin_layout Plain Layout
4214 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4217 \begin_layout Plain Layout
4240 \begin_layout Standard
4242 doesn't stop you using bullets from packages you don't have.
4243 If you get errors from \SpecialChar LaTeX
4244 when you try to view or print the file, then it
4245 is likely you are missing a package.
4249 \begin_layout Plain Layout
4251 doesn't restrict your use since you may be editing locally and exporting
4260 \begin_layout Subsection
4264 \begin_layout Standard
4265 Select which bullet depth you want to change then select the bullet shape
4267 Any changes will not be visible in \SpecialChar LyX
4268 , but are visible when viewing the document.
4271 \begin_layout Standard
4272 You can reset a bullet shape to the default simply by clicking your right
4273 mouse button on the appropriate bullet depth button.
4277 \begin_layout Plain Layout
4282 want to have multiple sets of paragraphs with different sets of bullets
4283 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4285 The bullet selection dialog can help though because it provides you with
4286 the \SpecialChar LaTeX
4287 code for a wide range of bullet shapes.
4288 To make your own custom paragraphs you have the following options:
4291 \begin_layout Plain Layout
4295 \begin_layout Plain Layout
4311 \begin_layout Plain Layout
4315 \begin_layout Plain Layout
4337 \begin_layout Itemize
4338 Use the \SpecialChar LaTeX
4340 \begin_inset Flex Code
4343 \begin_layout Plain Layout
4351 to specify a new bullet shape for a given depth.
4352 You'll also need to save the current bullet shape so you can restore it
4354 In this itemized list the following \SpecialChar LaTeX
4355 code was used to change the bullet
4356 used for the first depth.
4357 \begin_inset Separator parbreak
4364 \begin_layout LyX-Code
4374 \begin_layout LyX-Code
4391 \begin_layout Itemize
4392 Note that the itemize depth is specified in Roman numerals as part of the
4402 \begin_layout Itemize
4406 \begin_layout Plain Layout
4419 Specify each individual entry by starting each item with the bullet shape
4420 enclosed in square brackets and set as
4421 \begin_inset Flex Noun
4424 \begin_layout Plain Layout
4432 For example, this item was started with
4433 \begin_inset Flex Code
4436 \begin_layout Plain Layout
4451 \begin_layout Plain Layout
4455 \begin_layout Plain Layout
4471 \begin_layout Plain Layout
4472 You'll also need to revert the labelitem back to its previous setting for
4473 the global bullet shape settings to remain in effect.
4474 The way used here was:
4477 \begin_layout LyX-Code
4492 \begin_layout Chapter
4494 and the World Wide Web
4497 \begin_layout Standard
4499 has long supported the export of documents to various web-friendly formats,
4501 Before verson 2.0, however, HTML export was always accomplished by the use
4502 of external converters.
4506 \begin_layout Plain Layout
4507 For details on the use of external converters with \SpecialChar LyX
4512 section of the Customization manual.
4517 These fall into two large groups: there are converters that use \SpecialChar LaTeX
4519 intermediate format, such as
4520 \begin_inset Flex Code
4523 \begin_layout Plain Layout
4530 \begin_inset Flex Code
4533 \begin_layout Plain Layout
4540 \begin_inset Flex Code
4543 \begin_layout Plain Layout
4549 , relying upon \SpecialChar LyX
4550 to produce the \SpecialChar LaTeX
4551 ; and there is a converter that works directly
4554 \begin_inset Flex Code
4557 \begin_layout Plain Layout
4565 All of these have different advantages and disadvantages.
4569 \begin_layout Standard
4570 The \SpecialChar LaTeX
4571 -based converters have the advantage that, in principle, they know everythin
4572 g about the exported document that \SpecialChar LaTeX
4574 Such converters do not care, for example, if a certain block of code was
4575 produced by \SpecialChar LyX
4576 or was Evil Red Text.
4577 These converters know about
4578 \begin_inset Flex Code
4581 \begin_layout Plain Layout
4587 files, counters, and references, and can often make use of the
4588 \begin_inset Flex Code
4591 \begin_layout Plain Layout
4597 files generated by Bib\SpecialChar TeX
4599 On the other hand, \SpecialChar LaTeX
4600 is a very hard language to parse—it is sometimes said
4601 that only \SpecialChar TeX
4602 itself understands \SpecialChar TeX
4603 —and \SpecialChar LaTeX
4604 -based converters will often choke on
4605 what seem to be quite simple constructs; complex ones can throw them completely
4606 , and as of this writing, for example, the
4610 manual will not export with
4611 \begin_inset Flex Code
4614 \begin_layout Plain Layout
4620 , though the others will.
4621 The other issue concerns how math is handled.
4622 These converters typically convert the formulae into little pictures that
4623 are then linked from the HTML document.
4624 Since these are actually generated by \SpecialChar LaTeX
4625 , they are accurate.
4626 But they do not scale well, and just getting them to look as if they are
4627 actually meant to be in your document—so that the font sizes seem to be
4628 roughly the same—can be a challenge.
4631 \begin_layout Standard
4633 \begin_inset Flex Code
4636 \begin_layout Plain Layout
4644 \begin_inset CommandInset href
4646 name "http://elyxer.nongnu.org/"
4647 target "http://elyxer.nongnu.org/"
4651 ) solves some of these problems.
4652 In particular, the formulae it produces scale perfectly, since it renders
4653 math using a combination of HTML and CSS rather than converting the formulae
4655 But even moderately complex formula are rendered less well than with
4656 \begin_inset Flex Code
4659 \begin_layout Plain Layout
4665 ; this reflects the limitations of HTML.
4669 \begin_layout Plain Layout
4671 \begin_inset Flex Code
4674 \begin_layout Plain Layout
4681 can also use jsMath and MathJax for equations, but this setting is only
4682 available globally and requires one to have access to a server that runs
4688 More importantly (as of version 1.1.1, at least),
4689 \begin_inset Flex Code
4692 \begin_layout Plain Layout
4699 has limited support for math macros and no support for user-defined paragraph
4700 or character styles.
4701 These limitations make
4702 \begin_inset Flex Code
4705 \begin_layout Plain Layout
4712 unsuitable for many of the documents \SpecialChar LyX
4714 In principle, of course, these problems could be solved, but the \SpecialChar LyX
4716 have decided to follow a different path and have made \SpecialChar LyX
4718 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
4719 , DocBook, and plaintext.
4722 \begin_layout Standard
4723 As of this writing, XHTML output remains under development and should probably
4725 \begin_inset Quotes eld
4729 \begin_inset Quotes erd
4736 \begin_layout Plain Layout
4738 \begin_inset Flex Code
4741 \begin_layout Plain Layout
4742 development/HTML.notes
4747 , which can be found in the \SpecialChar LyX
4749 \begin_inset CommandInset href
4751 name "accessed online"
4752 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
4756 , usually contains up-to-date information about the state of XHTML output.
4757 See also the list of XHTML bugs on
4758 \begin_inset CommandInset href
4760 name "the bug tracker"
4761 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"
4770 Still, the developers have chosen this approach because it has several
4771 potential advantages over the other two.
4774 \begin_layout Standard
4775 These advantages are primarily due to the fact that the XHTML output routines,
4776 since they are part of \SpecialChar LyX
4777 , know everything \SpecialChar LyX
4778 knows about the document being
4783 \begin_layout Plain Layout
4784 Another advantage is that, since these routines are internal to \SpecialChar LyX
4786 immune to changes in \SpecialChar LyX
4787 's file format, or to changes in the semantics of
4793 So they know about the table of contents (as displayed in the outline),
4794 about the counters associated with different paragraph styles, and about
4795 user-defined styles.
4796 The XHTML output routines know what \SpecialChar LyX
4797 knows about internationalization,
4798 too, so they will output
4799 \begin_inset Quotes eld
4803 \begin_inset Quotes erd
4807 \begin_inset Quotes eld
4815 \begin_inset Quotes erd
4818 , depending upon the language in effect at the time.
4822 \begin_layout Standard
4823 Quite generally, the output routines know what \SpecialChar LyX
4824 knows about document layout,
4825 that is, about how the document is to be rendered on screen.
4826 We use this information when we output the document as XHTML.
4827 In particular, \SpecialChar LyX
4832 generates CSS style information corresponding to the layout information
4833 it uses to render the document on screen: if section headings are supposed
4834 to be sans-serif and bold as seen in \SpecialChar LyX
4835 , then (by default) they will be sans-seri
4836 f and bold when viewed in a web browser, too.
4837 And this is true not just for pre-defined styles, like Section, but for
4838 any style, including user-defined styles.
4839 Indeed, the XHTML output routines make no distinction between user-defined
4840 paragraph and character styles and \SpecialChar LyX
4841 's own pre-defined styles: in each case,
4842 everything \SpecialChar LyX
4843 knows about the styles is contained in the layout files.
4844 And much the same is true as regards pre-defined textual insets, such as
4845 footnotes, and various custom insets.
4849 \begin_layout Standard
4850 The result is that XHTML output can be customized and extended in exactly
4851 the same way \SpecialChar LaTeX
4852 output can be customized and extended: through layout files
4854 See chapter five of the
4858 manual for the details.
4861 \begin_layout Standard
4862 The remainder of this chapter contains more detailed information on XHTML
4863 output, its limitations, and ways to work around those limitations.
4866 \begin_layout Section
4867 Math Output in XHTML
4870 \begin_layout Standard
4872 offers four choices for how math is rendered.
4873 These have various advantages and disadvantages:
4876 \begin_layout Itemize
4878 \begin_inset Newline newline
4881 MathML is a dialect of XML designed specifically for mathematics on the
4882 web, and it typically renders very well in browsers that support it.
4883 The disadvantage is that not all browsers support MathML, and support is
4884 not complete even in the Gecko-based browsers, such as Firefox.
4885 \begin_inset Newline newline
4889 is unable to render a formula as MathML—for example, if the formula
4891 \begin_inset Flex Code
4894 \begin_layout Plain Layout
4900 package or ERT—then it will instead output the formula as an image.
4904 \begin_layout Itemize
4906 \begin_inset Newline newline
4910 \begin_inset Flex Code
4913 \begin_layout Plain Layout
4919 outputs math as HTML, styled by CSS.
4923 \begin_layout Plain Layout
4925 has borrowed some of the CSS for its HTML output from
4926 \begin_inset Flex Code
4929 \begin_layout Plain Layout
4940 For simple formulae, this can work quite well, though with more complicated
4941 formulae it tends to break down.
4942 Still, this method has the advantage that it is very widely supported and
4943 so it may be appropriate for documents that contain only a little, fairly
4945 \begin_inset Newline newline
4948 If Lyx is unable to render a formula as HTML—for example, if the formula
4950 \begin_inset Flex Code
4953 \begin_layout Plain Layout
4959 package or ERT—then it will instead output the formula as an image.
4963 \begin_layout Itemize
4965 \begin_inset Newline newline
4969 \begin_inset Flex Code
4972 \begin_layout Plain Layout
4979 will output formulae as images, the very same images, in fact, that are
4980 used for instant preview.
4984 \begin_layout Plain Layout
4985 Instant preview does
4989 have to be on for images to be output, however.
4994 The advantage to this method is that the images are simply generated by
4996 , so they are very accurate.
4997 The disadvantage, as mentioned earlier, is that these are bitmapped images,
4998 so they do not scale terribly well, and one cannot copy them, etc.
4999 (As of this writing, there are also problems about equation numbering.
5001 \begin_inset CommandInset href
5004 target "http://www.lyx.org/trac/ticket/6894"
5009 \begin_inset Newline newline
5012 The size of the images can be controlled by setting the
5013 \begin_inset Quotes eld
5017 \begin_inset Quotes erd
5021 \begin_inset Flex Noun
5024 \begin_layout Plain Layout
5025 Document\SpecialChar menuseparator
5026 Settings\SpecialChar menuseparator
5036 \begin_layout Plain Layout
5037 For those who want to know, this controls the resolution of the image in
5038 dots per inch and is based upon a default of 75 dpi.
5044 \begin_inset Newline newline
5048 for some reason fails to create an image for a formula (e.g., if a required
5050 package is not installed), then it will fall back to outputing the raw
5055 \begin_layout Itemize
5058 \begin_inset Newline newline
5061 Finally, \SpecialChar LyX
5062 will happily output math as \SpecialChar LaTeX
5064 As well as being the output of last resort, this method can be used with
5066 \begin_inset CommandInset href
5069 target "http://www.math.union.edu/~dpvc/jsMath/"
5073 , which uses JavaScript to render \SpecialChar LaTeX
5074 embedded in HTML documents.
5076 wraps the \SpecialChar LaTeX
5078 \begin_inset Flex Code
5081 \begin_layout Plain Layout
5087 (for inline formulas) or
5088 \begin_inset Flex Code
5091 \begin_layout Plain Layout
5097 (for displayed formulas) with
5098 \begin_inset Flex Code
5101 \begin_layout Plain Layout
5107 , as is required for jsMath.
5110 \begin_layout Standard
5111 One of these output methods must be selected under
5112 \begin_inset Flex Noun
5115 \begin_layout Plain Layout
5116 Document\SpecialChar menuseparator
5117 Settings\SpecialChar menuseparator
5124 By default, \SpecialChar LyX
5126 This is a document-wide setting, therefore.
5129 \begin_layout Standard
5130 Eventually, \SpecialChar LyX
5131 will offer the user the option to select an alternate output
5132 method for a particular inset, say, one that isn't being rendered very
5137 \begin_layout Plain Layout
5138 That said, since \SpecialChar LyX
5139 falls back to images if the inset contains ERT, then one
5140 can force output as an image by putting some harmless ERT into the math,
5142 \begin_inset Formula $a=b\relax$
5153 \begin_layout Section
5154 Bibliography and Citations
5157 \begin_layout Standard
5158 XHTML output fully supports bibliographies and citations.
5162 \begin_layout Standard
5163 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5165 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5168 If you are using numerical citations, then \SpecialChar LyX
5169 will output numerical labels,
5170 such as [1] or [17], rather than simply showing the citation key in square
5171 brackets, as it does on-screen.
5172 If you are using author-year citations, then \SpecialChar LyX
5173 will add lowercase letters
5174 to the years, just as Bib\SpecialChar TeX
5175 does, if it finds more than one citation for
5176 a given author-year combination.
5177 The labels will be printed with the bibliography entries.
5178 Note that there is, at present, no way to customize the appearance of the
5179 labels, for example, to choose between square brackets and parentheses.
5182 \begin_layout Standard
5183 Bibliography output is handled by the same machinery that handles the presentati
5184 on of reference information in the citation dialog, so you will see in the
5185 XHTML output pretty much what you would see if you were to look at a given
5186 entry in the citation dialog.
5187 The formatting can be customized in your layout file or, preferably, in
5193 manual for the details.
5196 \begin_layout Standard
5197 The main defect at present is that cross-referenced information is printed
5198 with every entry with which it is associated.
5199 So you can see things like this:
5204 \begin_inset Quotes eld
5207 Context and Logical Form
5208 \begin_inset Quotes erd
5213 Language in Context: Selected Essays
5215 (Oxford: Oxford University Press, 2007), pp.
5221 \begin_inset Quotes eld
5224 Semantics in Context
5225 \begin_inset Quotes erd
5230 Language in Context: Selected Essays
5232 (Oxford: Oxford University Press, 2007), pp.
5236 \begin_layout Standard
5237 This should be fixed before long.
5240 \begin_layout Standard
5241 There is no support at present for sectioned bibliographies.
5242 If you have multiple bibliographies, then \SpecialChar LyX
5243 will print the same bibliography
5247 \begin_layout Section
5251 \begin_layout Standard
5253 will happily export indexes as XHTML, but with certain limitations at the
5257 \begin_layout Standard
5258 Index export will be most reliable when you do not attempt to use the fancy
5259 constructs that are described in the section on indexes in the
5267 \begin_layout Plain Layout
5268 The main issue here is that \SpecialChar LyX
5269 itself does not really handle these.
5270 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5276 We'll describe how they are handled using the subsection headings from
5280 \begin_layout Itemize
5281 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5282 makes an effort to support these,
5283 but the entries must be separated by
5284 \begin_inset Quotes eld
5288 \begin_inset Quotes erd
5291 , that is, there must be spaces around the exclamation point.
5292 This is because it is otherwise too difficult to check for escaped exclamation
5293 points, ones in math, and so forth.
5296 \begin_layout Itemize
5297 Page Ranges: There is no support at all for page ranges, since these make
5298 no sense with XHMTL.
5299 Instead, you will just get two index entries, one at either end.
5302 \begin_layout Itemize
5303 Cross-referencing: There is no support for cross-referencing.
5305 finds an entry containing the
5306 \begin_inset Quotes eld
5309 |see\SpecialChar ldots
5311 \begin_inset Quotes erd
5314 construct, it is just dropped, and the rest is treated as an ordinary index
5318 \begin_layout Itemize
5319 Index Entry Order: \SpecialChar LyX
5320 does support attempts to fix the sorting order.
5321 It will take what is before the first `@' it finds and use that for sorting,
5322 taking what follows the first `@' to be the actual entry.
5323 At present, \SpecialChar LyX
5324 does not check for escaped `@', so do not try to index email
5328 \begin_layout Itemize
5329 Index Entry Layout: You can format entries by using the text style dialog,
5330 or by using any other method available within \SpecialChar LyX
5332 There is no support for constructs like:
5333 \begin_inset Quotes eld
5337 \begin_inset Quotes erd
5341 Indeed, if \SpecialChar LyX
5342 finds a pipe symbol, `|', in an entry, it will delete it and
5343 everything that follows it.
5346 \begin_layout Itemize
5347 Multiple Indexes: There is no support for multiple indexes.
5348 Rather, all index entries will be printed as one large index.
5349 To avoid our printing several versions of the index, we print only the
5350 main index, so make sure you have one.
5353 \begin_layout Section
5354 Nomenclature and Glossary
5357 \begin_layout Standard
5358 There is at present no support for glossaries.
5359 Adding it would be fairly trivial, and welcome.
5362 \begin_layout Chapter
5363 The \SpecialChar LyX
5367 \begin_layout Section
5371 \begin_layout Standard
5372 The `\SpecialChar LyX
5373 server' allows other programs to talk to \SpecialChar LyX
5374 , invoke \SpecialChar LyX
5375 commands, and retrieve
5376 information about the \SpecialChar LyX
5378 This is only intended for advanced users, but they should find it useful.
5379 It is by writing to the \SpecialChar LyX
5380 server, for example, that bibliography managers,
5381 such as JabRef, are able to
5382 \begin_inset Quotes eld
5386 \begin_inset Quotes erd
5389 citations to \SpecialChar LyX
5393 \begin_layout Section
5394 Starting the \SpecialChar LyX
5398 \begin_layout Standard
5399 The \SpecialChar LyX
5400 server works through the use of a pair of named pipes.
5401 These are usually located in
5402 \begin_inset Flex Code
5405 \begin_layout Plain Layout
5411 , (except on Windows, where
5415 named pipes are special objects located in
5416 \begin_inset Flex Code
5419 \begin_layout Plain Layout
5431 ) and have the names
5432 \begin_inset Quotes eld
5436 \begin_inset Flex Code
5439 \begin_layout Plain Layout
5446 \begin_inset Quotes erd
5450 \begin_inset Quotes eld
5454 \begin_inset Flex Code
5457 \begin_layout Plain Layout
5464 \begin_inset Quotes erd
5468 External programs write into
5469 \begin_inset Flex Code
5472 \begin_layout Plain Layout
5478 and read back data from
5479 \begin_inset Flex Code
5482 \begin_layout Plain Layout
5489 The stem of the pipe names can be defined in the
5490 \begin_inset Flex Noun
5493 \begin_layout Plain Layout
5494 Tools\SpecialChar menuseparator
5501 \begin_inset Flex Code
5504 \begin_layout Plain Layout
5505 "/home/myhome/lyxpipe"
5511 \begin_inset Flex Code
5514 \begin_layout Plain Layout
5528 on Windows (where any working path instead of lyxpipe can be used, for
5530 \begin_inset Flex Code
5533 \begin_layout Plain Layout
5556 configure this manually in order for the server to start.
5559 \begin_layout Standard
5562 \begin_inset Flex Code
5565 \begin_layout Plain Layout
5572 \begin_inset Flex Code
5575 \begin_layout Plain Layout
5581 ' to create the pipes.
5582 If one of the pipes already exists, \SpecialChar LyX
5583 will assume that another \SpecialChar LyX
5585 is already running and will not start the server.
5586 On POSIX (Unix like) systems, if for some other reason, an unused
5587 \begin_inset Quotes eld
5591 \begin_inset Quotes erd
5594 pipe is left in existence when \SpecialChar LyX
5595 closes, then \SpecialChar LyX
5596 will try to delete it.
5597 If this fails for some reason, you will need to delete the pipes manually
5598 and then restart \SpecialChar LyX
5600 On Windows, pipes are deleted by the OS on program termination or crash,
5602 \begin_inset Quotes eld
5606 \begin_inset Quotes erd
5609 pipes should not be possible.
5612 \begin_layout Standard
5613 To have several \SpecialChar LyX
5614 processes with servers at the same time, you have to use
5615 different configurations, perhaps by using separate user directories, each
5617 \begin_inset Flex Code
5620 \begin_layout Plain Layout
5626 file, for each process.
5629 \begin_layout Standard
5630 If you are developing a client program, you might find it useful to enable
5631 debugging information from the \SpecialChar LyX
5633 Do this by starting \SpecialChar LyX
5635 \begin_inset Flex Code
5638 \begin_layout Plain Layout
5647 \begin_layout Standard
5648 You can find a complete example client written in C++ in the source distribution
5650 \begin_inset Flex Code
5653 \begin_layout Plain Layout
5654 development/lyxserver/server_monitor.cpp
5662 \begin_layout Standard
5663 Another useful tool is the command-line based client found in
5664 \begin_inset Flex Code
5667 \begin_layout Plain Layout
5668 src/client/lyxclient
5676 \begin_layout Section
5677 Normal communication
5680 \begin_layout Standard
5681 To issue a \SpecialChar LyX
5682 call, the client writes a line of ASCII text into the input
5684 This line has the following format:
5701 \begin_layout Description
5702 clientname is a name that the client can choose arbitrarily.
5703 Its only use is that \SpecialChar LyX
5704 will echo it if it sends an answer—so a client can
5705 dispatch results from different requesters.
5708 \begin_layout Description
5709 function is the function you want \SpecialChar LyX
5711 It is the same as the commands you'd use in the minibuffer.
5714 \begin_layout Description
5715 argument is an optional argument which is meaningful only to some functions
5717 \begin_inset Quotes eld
5721 \begin_inset Quotes erd
5724 LFUN will insert the argument as text at the cursor position).
5727 \begin_layout Standard
5728 The answer from \SpecialChar LyX
5729 will arrive in the output pipe and be of the form
5746 \begin_layout Standard
5755 are just echoed from the command request, while
5759 is more or less useful information filled according to how the command
5760 execution worked out.
5761 Some commands, such as
5762 \begin_inset Quotes eld
5766 \begin_inset Quotes erd
5769 , will return information about the internal state of \SpecialChar LyX
5771 return an empty data-response.
5772 This means that the command execution went fine.
5775 \begin_layout Standard
5776 In case of errors, the response from \SpecialChar LyX
5794 \begin_layout Standard
5799 should contain an explanation of why the command failed.
5802 \begin_layout Standard
5806 \begin_layout LyX-Code
5807 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
5808 \begin_inset Newline newline
5811 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
5812 \begin_inset Newline newline
5815 read a <~/.lyxpipe.out
5816 \begin_inset Newline newline
5822 \begin_layout Subsection
5823 AppleScript (Mac OS X)
5826 \begin_layout Standard
5827 Since \SpecialChar LyX
5828 2.1, \SpecialChar LyX
5829 supports basic interactions with AppleScript for normal communicatio
5830 n through the command run.
5831 This command takes a direct argument (the
5835 to perform) and an optional argument.
5836 It either returns the output of the function or triggers an error with
5837 the error message and code.
5840 \begin_layout Standard
5844 \begin_layout LyX-Code
5845 tell application "\SpecialChar LyX
5849 \begin_layout LyX-Code
5853 \begin_layout LyX-Code
5854 -- Stores the current file name into f
5857 \begin_layout LyX-Code
5858 set f to (run "server-get-filename" with argument "")
5861 \begin_layout LyX-Code
5862 on error the error_message number the error_number
5865 \begin_layout LyX-Code
5866 display dialog "Error: " & the error_number & ".
5870 \begin_layout LyX-Code
5871 & the error_message buttons {"OK"} default button 1
5874 \begin_layout LyX-Code
5878 \begin_layout LyX-Code
5882 \begin_layout Section
5886 \begin_layout Standard
5888 can notify clients of events going on asynchronously.
5889 Currently it will only do this if the user binds a key sequence with the
5891 \begin_inset Quotes eld
5895 \begin_inset Quotes erd
5899 The format of the string \SpecialChar LyX
5900 sends is as follows:
5904 \begin_inset Flex Code
5907 \begin_layout Plain Layout
5918 \begin_layout Standard
5923 is the printed representation of the key sequence that was actually typed
5927 \begin_layout Standard
5928 This mechanism can be used to extend \SpecialChar LyX
5929 's command set and implement macros.
5930 Bind some key sequence to
5931 \begin_inset Quotes eld
5935 \begin_inset Quotes erd
5939 Then start a client that listens on the output pipe, dispatches the command
5940 according to the sequence, and starts a function that may use \SpecialChar LyX
5943 requests to issue a command or a series of commands to \SpecialChar LyX
5947 \begin_layout Section
5948 The simple \SpecialChar LyX
5952 \begin_layout Standard
5954 implements a simple protocol that can be used for session management.
5955 All messages are of the form
5968 \begin_layout Standard
5974 \begin_inset Quotes eld
5978 \begin_inset Quotes erd
5982 \begin_inset Quotes eld
5986 \begin_inset Quotes erd
5991 \begin_inset Quotes eld
5995 \begin_inset Quotes erd
5998 is received from a client, \SpecialChar LyX
5999 will report back to inform the client that
6000 it's listening to it's messages, while
6001 \begin_inset Quotes eld
6005 \begin_inset Quotes erd
6008 sent from \SpecialChar LyX
6009 will inform clients that \SpecialChar LyX
6013 \begin_layout Section
6014 Reverse DVI/PDF search
6017 \begin_layout Standard
6018 Some DVI/PDF viewers
6022 \begin_layout Plain Layout
6023 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6024 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6033 facility (also called
6038 This means that you can tell \SpecialChar LyX
6039 to put the cursor to a specific line in the
6040 document by clicking at the respective position in the DVI/PDF output.
6041 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6043 This is done via the \SpecialChar LyX
6044 server either by using the named pipe (
6048 ), or the UNIX domain socket (
6052 ) that \SpecialChar LyX
6053 creates in its temporary directory (this is the way the
6054 \begin_inset Flex Code
6057 \begin_layout Plain Layout
6063 program communicates with \SpecialChar LyX
6065 In some cases, you need a helper script that mediates between the viewer
6066 and \SpecialChar LyX
6067 , in others, the viewer can communicate with \SpecialChar LyX
6069 This depends on the selected viewer and on your operating system.
6070 The same applies to the way viewers need to be configured and the way the
6071 reverse search is actually performed.
6072 In what follows, we will thus describe how to setup reverse search for
6074 Before we turn to this, though, we will explain what needs to be done generally
6075 to enable reverse search in the DVI/PDF output.
6078 \begin_layout Subsection
6080 \begin_inset CommandInset label
6082 name "subsec:rev-search"
6089 \begin_layout Standard
6090 In most cases \SpecialChar LyX
6091 will do the work for you by enabling the option
6092 \begin_inset Flex Noun
6095 \begin_layout Plain Layout
6096 Synchronize with Output
6102 \begin_inset Flex Noun
6105 \begin_layout Plain Layout
6106 Document\SpecialChar menuseparator
6107 Settings\SpecialChar menuseparator
6114 In such a case \SpecialChar LyX
6115 will automatically insert the necessary Sync\SpecialChar TeX
6117 PDF) or load the srcltx package (for DVI) respectively.
6118 This option can be easily reached also on
6119 \begin_inset Flex Code
6122 \begin_layout Plain Layout
6131 \begin_layout Standard
6132 If you need a different setting, you can select or input a custom macro
6133 from the drop down box just below
6134 \begin_inset Flex Noun
6137 \begin_layout Plain Layout
6138 Document\SpecialChar menuseparator
6139 Settings\SpecialChar menuseparator
6140 Output\SpecialChar menuseparator
6141 Synchronize with Output
6149 \begin_layout Standard
6150 Note that the method
6151 \begin_inset Flex Code
6154 \begin_layout Plain Layout
6162 enables gzip compression.
6163 If your viewer does not support it, you should instead use
6164 \begin_inset Flex Code
6167 \begin_layout Plain Layout
6178 \begin_layout Standard
6179 Please also note that including the
6180 \begin_inset Flex Code
6183 \begin_layout Plain Layout
6190 \begin_inset Flex Code
6193 \begin_layout Plain Layout
6199 sometimes has an undesired impact on the typesetting.
6200 Thus, you should switch output synchronization off for the final typesetting
6202 \begin_inset Flex Code
6205 \begin_layout Plain Layout
6212 \begin_inset Flex Code
6215 \begin_layout Plain Layout
6225 \begin_layout Standard
6226 In case you need some more special settings that are not covered by the
6227 automatic settings, read the next section about how to set up output synchroniz
6229 If the automatic setup suits your needs, you can readily jump to section
6230 \begin_inset space ~
6234 \begin_inset CommandInset ref
6236 reference "subsec:configuring-viewers"
6240 , where the necessary configuration steps in your viewer – needed both with
6241 the automatic and the manual setup – are described.
6244 \begin_layout Subsection
6248 \begin_layout Standard
6250 provides several different methods for reverse search.
6251 Some are built-in in the
6252 \begin_inset Flex Code
6255 \begin_layout Plain Layout
6261 program, some are provided by external packages.
6262 Your choice depends on whether your \SpecialChar LaTeX
6263 distribution already provides a given
6264 method (the built-in methods are rather new) and whether your viewer can
6266 The available methods are described in the following.
6269 \begin_layout Subsubsection*
6270 Built-in DVI-search via src-specials (DVI only)
6273 \begin_layout Standard
6274 This method provides the DVI file with the necessary information for reverse
6276 It is available in \SpecialChar LaTeX
6277 since quite some time (any somewhat recent \SpecialChar LaTeX
6279 should include it), and it works reliably.
6280 To enable it, change the
6281 \begin_inset Flex Noun
6284 \begin_layout Plain Layout
6295 \begin_inset Flex Noun
6298 \begin_layout Plain Layout
6309 \begin_inset Flex Noun
6312 \begin_layout Plain Layout
6313 Preferences\SpecialChar menuseparator
6314 File Handling\SpecialChar menuseparator
6321 \begin_inset Flex Code
6324 \begin_layout Plain Layout
6325 latex -src-specials $$i
6331 If this doesn't work, check if your \SpecialChar TeX
6332 engine needs different options (the
6333 syntax might differ in some distributions).
6336 \begin_layout Subsubsection*
6337 External Packages (PDFSync and scrltx)
6340 \begin_layout Standard
6349 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6351 In order to enable it, load the packages in the \SpecialChar LyX
6355 \begin_layout Itemize
6356 \begin_inset Flex Code
6359 \begin_layout Plain Layout
6367 for reverse PDF search,
6370 \begin_layout Itemize
6371 \begin_inset Flex Code
6374 \begin_layout Plain Layout
6377 usepackage[active]{srcltx}
6382 for reverse DVI search.
6385 \begin_layout Standard
6386 If you want to be able to perform both DVI and PDF reverse searches, you
6387 can also insert in the preamble the following lines
6390 \begin_layout LyX-Code
6394 \begin_inset Newline newline
6400 \begin_inset Newline newline
6406 \begin_inset Newline newline
6412 \begin_inset Newline newline
6417 usepackage[active]{srcltx}
6418 \begin_inset Newline newline
6426 \begin_layout Standard
6427 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6428 right package will be used.
6431 \begin_layout Standard
6432 Note that PDFSync might affect the output layout of your document.
6433 It is therefore advised to disable PDFsync for final documents.
6436 \begin_layout Subsubsection*
6437 Built-in reverse search via Sync\SpecialChar TeX
6441 \begin_layout Standard
6443 \begin_inset Flex Code
6446 \begin_layout Plain Layout
6452 have built-in support for both PDF and DVI reverse search.
6455 Sync\SpecialChar TeX
6458 facility is basically the result of the integration of the PDFSync package
6459 to the pdftex program and its merge with the
6464 You need at least \SpecialChar TeX
6465 Live 2008 or a recent Mik\SpecialChar TeX
6466 distribution in order to use
6471 \begin_layout Plain Layout
6472 For some reason, Mik\SpecialChar TeX
6473 does not understand/obey the command \SpecialChar LyX
6475 the preamble when you check the "Enable Forward/Reverse Search" button
6476 in the toolbar and does not generate the necessary info.
6479 \begin_layout Plain Layout
6480 The generation of the required info can be forced by changing the converter
6482 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
6483 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
6484 the -synctex=1 switch).
6489 Also note that only a few PDF viewers (Okular and Qpdfview on Unix, Skim
6490 on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
6494 \begin_layout Standard
6495 To enable Sync\SpecialChar TeX
6496 for DVI output, change the
6497 \begin_inset Flex Noun
6500 \begin_layout Plain Layout
6511 \begin_inset Flex Noun
6514 \begin_layout Plain Layout
6525 \begin_inset Flex Noun
6528 \begin_layout Plain Layout
6529 Preferences\SpecialChar menuseparator
6530 File Handling\SpecialChar menuseparator
6537 \begin_inset Flex Code
6540 \begin_layout Plain Layout
6541 latex -synctex=1 $$i
6546 , and for PDF output, change the
6547 \begin_inset Flex Noun
6550 \begin_layout Plain Layout
6555 (pdflatex) -> PDF (pdflatex)
6561 \begin_inset Flex Code
6564 \begin_layout Plain Layout
6565 pdflatex -synctex=1 $$i
6571 Check the documentation of your viewer whether the viewer needs to be configure
6572 d for the use with Sync\SpecialChar TeX
6577 \begin_layout Plain Layout
6578 Note that the option
6579 \begin_inset Flex Code
6582 \begin_layout Plain Layout
6588 option enables gzip compression.
6589 If your viewer does not support it, you should instead use
6590 \begin_inset Flex Code
6593 \begin_layout Plain Layout
6607 \begin_layout Subsection
6608 Configuring and using specific viewers
6609 \begin_inset CommandInset label
6611 name "subsec:configuring-viewers"
6618 \begin_layout Subsubsection*
6619 Xdvi (all platforms)
6622 \begin_layout Standard
6624 \begin_inset Flex Code
6627 \begin_layout Plain Layout
6633 , you don't need to do anything else for performing a reverse DVI search,
6635 already provides the necessary hooks for automatically using the
6636 \begin_inset Flex Code
6639 \begin_layout Plain Layout
6646 Just setup your document as described above (reverse search is triggered
6647 by Ctrl-click or Alt-click on Mac OSX, respectively).
6650 \begin_layout Standard
6651 However, if for whatever reason you want to use the named pipe instead of
6652 the socket for communicating with \SpecialChar LyX
6653 , simply change the DVI viewer in
6654 \begin_inset Flex Noun
6657 \begin_layout Plain Layout
6658 Preferences\SpecialChar menuseparator
6659 File Handling\SpecialChar menuseparator
6669 \begin_layout Plain Layout
6670 On Mac OSX you have to use
6671 \begin_inset Flex Code
6674 \begin_layout Plain Layout
6675 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
6686 \begin_inset Flex Code
6689 \begin_layout Plain Layout
6690 xdvi -editor "lyxeditor.sh %f %l"
6696 \begin_inset Flex Code
6699 \begin_layout Plain Layout
6705 is a suitable script.
6706 For example, a minimal shell script is the following one:
6709 \begin_layout LyX-Code
6711 \begin_inset Newline newline
6714 LYXPIPE="/path/to/lyxpipe"
6715 \begin_inset Newline newline
6718 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
6719 \begin_inset Newline newline
6722 echo "$COMMAND" > "${LYXPIPE}".in || exit
6723 \begin_inset Newline newline
6726 read TMP < "${LYXPIPE}".out || exit
6729 \begin_layout Standard
6731 \begin_inset Flex Code
6734 \begin_layout Plain Layout
6744 \begin_layout Plain Layout
6751 XServer pipe path specified in
6752 \begin_inset Flex Noun
6755 \begin_layout Plain Layout
6756 Preferences\SpecialChar menuseparator
6766 \begin_layout Plain Layout
6768 \begin_inset Flex Code
6771 \begin_layout Plain Layout
6777 folder of a source distribution you can find a
6778 \begin_inset Flex Code
6781 \begin_layout Plain Layout
6787 script which is able to locate the
6791 based on your preferences.
6799 \begin_layout Subsubsection*
6803 \begin_layout Standard
6805 \begin_inset Flex Code
6808 \begin_layout Plain Layout
6809 /Applications/MacDviX_Folder/calleditor.script
6814 , add the following lines:
6817 \begin_layout LyX-Code
6822 \begin_layout Plain Layout
6829 X.app/Contents/MacOS/lyxeditor "$2" $1
6830 \begin_inset Newline newline
6836 \begin_layout Standard
6837 Modify the lines accordingly if you install \SpecialChar LyX
6838 somewhere else than in the
6839 Applications folder.
6842 \begin_layout Standard
6843 Reverse search is triggered by Alt-click (OPTION-click).
6846 \begin_layout Subsubsection*
6850 \begin_layout Standard
6852 \begin_inset Flex Code
6855 \begin_layout Plain Layout
6856 open -a Skim.app $$i
6861 to the viewer setting in
6862 \begin_inset Flex Noun
6865 \begin_layout Plain Layout
6866 Preferences\SpecialChar menuseparator
6867 File Handling\SpecialChar menuseparator
6868 File formats\SpecialChar menuseparator
6875 \begin_inset Flex Noun
6878 \begin_layout Plain Layout
6879 Skim\SpecialChar menuseparator
6880 Preferences\SpecialChar menuseparator
6887 \begin_inset Flex Noun
6890 \begin_layout Plain Layout
6896 preset and enter command
6897 \begin_inset Flex Noun
6900 \begin_layout Plain Layout
6901 /Applications/\SpecialChar LyX
6902 .app/Contents/MacOS/lyxeditor
6910 \begin_layout Standard
6911 Reverse search is triggered by COMMAND-SHIFT-click
6914 \begin_layout Subsubsection*
6918 \begin_layout Standard
6920 \begin_inset Flex Noun
6923 \begin_layout Plain Layout
6924 Settings\SpecialChar menuseparator
6925 Configure Okular\SpecialChar menuseparator
6932 \begin_inset Quotes eld
6936 \begin_inset Quotes erd
6940 \begin_inset Flex Code
6943 \begin_layout Plain Layout
6952 \begin_layout Standard
6953 Reverse search is triggered by SHIFT-click.
6956 \begin_layout Subsubsection*
6960 \begin_layout Standard
6961 Qpdfview supports Sync\SpecialChar TeX
6962 since version 0.3.5.
6964 \begin_inset Flex Noun
6967 \begin_layout Plain Layout
6968 Edit\SpecialChar menuseparator
6969 Settings\SpecialChar menuseparator
6975 , click on the input field of the
6976 \begin_inset Quotes eld
6980 \begin_inset Quotes erd
6983 item and add the command
6984 \begin_inset Flex Code
6987 \begin_layout Plain Layout
6996 \begin_layout Standard
6997 Reverse search is triggered by double-click.
7000 \begin_layout Subsubsection*
7004 \begin_layout Standard
7005 Launch yap, choose its
7006 \begin_inset Flex Noun
7009 \begin_layout Plain Layout
7010 View\SpecialChar menuseparator
7017 \begin_inset Quotes eld
7021 \begin_inset Quotes erd
7026 \begin_inset Quotes eld
7029 New\SpecialChar ldots
7031 \begin_inset Quotes erd
7034 button and, in the window that opens, enter
7035 \begin_inset Quotes eld
7040 \begin_inset Quotes erd
7043 (or any other name you like) in the
7044 \begin_inset Quotes eld
7048 \begin_inset Quotes erd
7052 Now click on the button labeled
7053 \begin_inset Quotes eld
7058 \begin_inset Quotes erd
7061 to open a file dialog and navigate to the directory containing the batch
7063 \begin_inset Flex Code
7066 \begin_layout Plain Layout
7074 \begin_inset Flex Code
7077 \begin_layout Plain Layout
7083 and then specify the program arguments as
7084 \begin_inset Flex Code
7087 \begin_layout Plain Layout
7095 \begin_inset Flex Code
7098 \begin_layout Plain Layout
7104 wrapper is used for communicating with \SpecialChar LyX
7112 \begin_layout LyX-Code
7114 \begin_inset Newline newline
7117 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
7126 \begin_inset Newline newline
7140 \begin_layout Standard
7141 Make sure that the \SpecialChar LyX
7142 Server pipe path you specified in \SpecialChar LyX
7144 \begin_inset Flex Code
7147 \begin_layout Plain Layout
7161 , otherwise change the
7162 \begin_inset Flex Code
7165 \begin_layout Plain Layout
7171 wrapper accordingly.
7174 \begin_layout Standard
7175 In yap, reverse search is triggered by double-click.
7178 \begin_layout Subsubsection*
7179 SumatraPDF (Windows)
7182 \begin_layout Standard
7183 In order to use SumatraPDF for inverse search, enter
7184 \begin_inset Flex Code
7187 \begin_layout Plain Layout
7188 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
7193 in the viewer setting in
7194 \begin_inset Flex Noun
7197 \begin_layout Plain Layout
7198 Preferences\SpecialChar menuseparator
7199 File Handling\SpecialChar menuseparator
7200 File formats\SpecialChar menuseparator
7207 \begin_inset Flex Code
7210 \begin_layout Plain Layout
7216 is the previous wrapper.
7217 If SumatraPDF.exe is not in your command PATH, use its full file name.
7220 \begin_layout Standard
7221 Reverse search is triggered by double-click.
7224 \begin_layout Subsubsection*
7228 \begin_layout Standard
7229 First of all, make sure that yap is your default DVI viewer in the Windows
7230 environment, then launch it, choose its
7231 \begin_inset Flex Noun
7234 \begin_layout Plain Layout
7235 View\SpecialChar menuseparator
7242 \begin_inset Quotes eld
7246 \begin_inset Quotes erd
7251 \begin_inset Quotes eld
7254 New\SpecialChar ldots
7256 \begin_inset Quotes erd
7259 button and, in the window that opens, enter
7260 \begin_inset Quotes eld
7265 \begin_inset Quotes erd
7268 (or any other name you like) in the
7269 \begin_inset Quotes eld
7273 \begin_inset Quotes erd
7277 Now click on the button labeled
7278 \begin_inset Quotes eld
7283 \begin_inset Quotes erd
7286 to open a file dialog and navigate to the directory containing the
7287 \begin_inset Flex Code
7290 \begin_layout Plain Layout
7296 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7299 \begin_inset Flex Code
7302 \begin_layout Plain Layout
7308 and then specify the program arguments as
7309 \begin_inset Flex Code
7312 \begin_layout Plain Layout
7319 In this way, you will be using the
7323 for communicating with \SpecialChar LyX
7325 If, for whatever reason, you want to use the
7330 \begin_inset Flex Code
7333 \begin_layout Plain Layout
7339 option and be sure to specify the \SpecialChar LyX
7340 Server pipe path in the \SpecialChar LyX
7344 \begin_layout Standard
7345 In yap, reverse search is triggered by double-click.
7348 \begin_layout Subsubsection*
7352 \begin_layout Standard
7353 In order to use SumatraPDF for inverse search, enter
7354 \begin_inset Flex Code
7357 \begin_layout Plain Layout
7358 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7363 in the viewer setting in
7364 \begin_inset Flex Noun
7367 \begin_layout Plain Layout
7368 Preferences\SpecialChar menuseparator
7369 File Handling\SpecialChar menuseparator
7370 File formats\SpecialChar menuseparator
7377 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7379 \begin_inset Flex Code
7382 \begin_layout Plain Layout
7388 enables communication via the
7394 \begin_inset Flex Code
7397 \begin_layout Plain Layout
7403 option if you want to use the
7407 , and be sure to specify the \SpecialChar LyX
7408 Server pipe path in the \SpecialChar LyX
7412 \begin_layout Standard
7413 Reverse search is triggered by double-click.
7416 \begin_layout Section
7420 \begin_layout Standard
7421 Forward search is, as the name implies, in a sense the
7422 \begin_inset Quotes eld
7426 \begin_inset Quotes erd
7430 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7432 If forward search is set up (as described in what follows), you can put
7433 the cursor anywhere in your \SpecialChar LyX
7435 \begin_inset Flex Noun
7438 \begin_layout Plain Layout
7439 Navigate\SpecialChar menuseparator
7446 \begin_inset Flex Noun
7449 \begin_layout Plain Layout
7455 in the context menu via right mouse click), and then the viewer will jump
7456 to that position as well.
7457 This implies, of course, that your viewer supports this function.
7460 \begin_layout Standard
7461 To make forward search possible, you first need to provide the generated
7462 output PDF/DVI file with additional information about the \SpecialChar TeX
7464 This can be done via the methods described in the section
7465 \begin_inset CommandInset ref
7467 reference "subsec:rev-search"
7474 \begin_layout Standard
7475 Additionally, you need to configure \SpecialChar LyX
7476 for using your viewers in
7477 \begin_inset Flex Noun
7480 \begin_layout Plain Layout
7481 Tools\SpecialChar menuseparator
7482 Preferences\SpecialChar menuseparator
7483 Output\SpecialChar menuseparator
7490 We provide a range of tested configurations for some viewers, which you
7491 can select from the drop down list.
7492 If none of these configurations suits you, you have to find out and enter
7493 a suitable configuration yourself.
7494 The definition syntax uses the following placeholders:
7497 \begin_layout Itemize
7499 \begin_inset Flex Code
7502 \begin_layout Plain Layout
7511 \begin_layout Itemize
7513 \begin_inset Flex Code
7516 \begin_layout Plain Layout
7522 : name of the (temporary) exported .tex file (without path)
7525 \begin_layout Itemize
7527 \begin_inset Flex Code
7530 \begin_layout Plain Layout
7536 : name of the (temporary) exported .tex file (including path)
7539 \begin_layout Itemize
7541 \begin_inset Flex Code
7544 \begin_layout Plain Layout
7550 : name of the exported output file (either dvi or pdf, depending on which
7551 one exists in the temporary directory)
7554 \begin_layout Standard
7555 Note that only some of the viewers provide full forward search functionality,
7556 among them yap, xdvi, okular
7560 \begin_layout Plain Layout
7561 You might want to set
7562 \begin_inset Flex Code
7565 \begin_layout Plain Layout
7572 \begin_inset Flex Noun
7575 \begin_layout Plain Layout
7576 Tools\SpecialChar menuseparator
7577 Preferences\SpecialChar menuseparator
7578 File Handling\SpecialChar menuseparator
7580 \begin_inset space ~
7593 , qpdfview and SumatraPDF
7597 \begin_layout Plain Layout
7598 SumatraPDF can also use DDE commands through the external program CMCDDE
7600 \begin_inset CommandInset href
7602 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
7612 While many of the widespread PDF viewers (most notably Adobe Reader) do
7613 not support forward search at all, some other viewers – e.
7614 \begin_inset space \thinspace{}
7618 evince and xpdf – allow at least to reload the document and jump to a specific
7619 page of the file, so you can at least navigate
7620 \begin_inset Quotes eld
7624 \begin_inset Quotes erd
7628 This latter functionality is provided by an external call of synctex (see
7629 the predefined example configurations).
7633 \begin_layout Standard
7634 Forward search works both with DVI and PDF output.
7636 simply checks which preview format you have used before (i.
7637 \begin_inset space \thinspace{}
7640 e., which format is already there in the temporary directory) and chooses
7641 the appropriate configuration for the respective format.
7644 \begin_layout Chapter
7645 Special Document Classes
7648 \begin_layout Section
7652 \begin_layout Standard
7658 \begin_layout Subsection
7662 \begin_layout Standard
7663 This section describes how \SpecialChar LyX
7664 can be used to write articles for submission
7665 to the scientific journal
7667 Astronomy and Astrophysics
7670 \begin_inset Flex URL
7673 \begin_layout Plain Layout
7675 http://www.edpsciences.fr/aa/
7680 ) using Version 5.01 of the document class
7685 This package can be downloaded from the ftp site
7688 \begin_layout Standard
7689 \begin_inset VSpace medskip
7695 \begin_layout Standard
7697 \begin_inset Flex URL
7700 \begin_layout Plain Layout
7702 ftp://ftp.edpsciences.org/pub/aa/readme.html
7710 \begin_layout Standard
7711 \begin_inset VSpace medskip
7717 \begin_layout Standard
7718 A manual comes together with that package, and this text is not meant to
7719 replace the original manual but is merely a short guide in how to realize
7720 the correct form of your paper.
7724 \begin_layout Standard
7725 Please note that the publisher of the journal was changed from Springer
7726 to EDP Sciences starting January 1, 2001.
7727 That change involved also some slight changes to the style files, namely
7728 the removal of the thesaurus command.
7729 The \SpecialChar LyX
7730 class aa supports the newest version of these style files, V 5.01.
7731 If you have an older version installed, please upgrade.
7732 For compatibility, the old (version 4) layout has been kept as
7737 Please refer to the comments in
7740 Dir/layouts/aapaper.layout
7745 \begin_layout Subsection
7749 \begin_layout Standard
7750 It is recommended you start from the example template distributed with \SpecialChar LyX
7752 If you are not using a template, note the following settings:
7755 \begin_layout Itemize
7762 Document\SpecialChar menuseparator
7765 dialog (OK, that one was obvious).
7768 \begin_layout Itemize
7769 Don't change the option
7772 \begin_inset space ~
7782 The whole layout is done by the macros, you shouldn't change anything.
7785 \begin_layout Subsection
7789 \begin_layout Standard
7790 First thing to enter is the header information.
7791 It consists of seven entries, of which some are optional.
7795 \begin_layout Itemize
7803 \begin_layout Itemize
7811 \begin_layout Itemize
7819 \begin_layout Itemize
7827 \begin_layout Itemize
7832 : [optional] if more than one author: whom to contact for offprint requests.
7835 \begin_layout Itemize
7840 : [optional] mail address for contacts.
7843 \begin_layout Itemize
7851 Received: <date>; Accepted <date>
7854 \begin_layout Standard
7855 There is no need to issue the
7861 command, this is done automatically by \SpecialChar LyX
7862 when the header is finished.
7863 Although the order of the single header entries doesn't matter it is advised
7864 to keep the above sequence, just to get the best optics and meets the layout
7865 of the real document.
7868 \begin_layout Standard
7869 If you want to place footnotes in the header block, e.
7870 \begin_inset space \thinspace{}
7874 \begin_inset space \space{}
7877 to state your present address, just use the standard footnote via the menu
7880 Insert\SpecialChar menuseparator
7885 will automagically use the term
7894 \begin_layout Standard
7895 In addition to these topics, the macros use three additional \SpecialChar LaTeX
7897 have no counterpart in \SpecialChar LyX
7901 \begin_layout Itemize
7908 to separate different names for more than one author and institute, respectivel
7912 \begin_layout Itemize
7919 to mark corresponding author/institute pairs.
7920 The institutes are numbered sequentially as they appear in the
7924 field, so you have to put a marker to each author.
7927 \begin_layout Itemize
7934 to supply an email address for fast contact.
7937 \begin_layout Standard
7938 In all cases, the appropriate command has to be entered in \SpecialChar LyX
7946 \begin_layout Subsection
7950 \begin_layout Standard
7951 The abstract should immediately follow the header block.
7952 With version 5 the abstract environment was changed to a command, and there
7953 is now a resctriction to only one paragraph.
7954 In addition, it should contain an entry with the keywords.
7955 This is not yet implemented for \SpecialChar LyX
7956 , therefore you have to enter the \SpecialChar LaTeX
7964 by hand and mark it as \SpecialChar LaTeX
7966 Refer to the example paper.
7969 \begin_layout Subsection
7970 Supported environments
7973 \begin_layout Standard
7974 The A&A paper layout supports the following environments for structuring
7978 \begin_layout Itemize
7984 \begin_layout Itemize
7990 \begin_layout Itemize
7996 \begin_layout Itemize
8002 \begin_layout Itemize
8008 \begin_layout Itemize
8014 \begin_layout Itemize
8020 \begin_layout Itemize
8026 \begin_layout Itemize
8032 \begin_layout Itemize
8038 \begin_layout Itemize
8044 \begin_layout Itemize
8051 \begin_layout Subsection
8052 Commands not supported by \SpecialChar LyX
8056 \begin_layout Standard
8057 Some commands are not yet supported by the
8061 layout for \SpecialChar LyX
8063 Some have already been mentioned.
8064 For the sake of completeness, they are listed all together here:
8067 \begin_layout Itemize
8075 \begin_layout Itemize
8083 \begin_layout Itemize
8091 \begin_layout Itemize
8099 \begin_layout Itemize
8107 \begin_layout Itemize
8115 \begin_layout Itemize
8123 \begin_layout Itemize
8131 \begin_layout Standard
8132 If you want to use any of these commands, you have to enter them yourself.
8135 Do not forget to mark them as \SpecialChar LaTeX
8139 \begin_layout Subsection
8140 Figure and Table Floats
8143 \begin_layout Standard
8145 provides support for the necessary float environments
8147 figure, figure*, table
8153 , therefore we won't tell much about it here.
8157 \begin_inset space ~
8163 Just remember that tables should be left-aligned.
8164 For that, select the table and change the alignment in
8166 Edit\SpecialChar menuseparator
8168 \begin_inset space ~
8174 \begin_layout Standard
8175 There is only one special thing: the figures with caption besides the figure.
8176 To create such a figure, you have to do the following:
8179 \begin_layout Enumerate
8180 Create a wide figure float:
8182 Insert\SpecialChar menuseparator
8183 Float\SpecialChar menuseparator
8186 , then right click in the figure and select
8192 \begin_inset space ~
8200 \begin_layout Enumerate
8201 Enter your caption text.
8204 \begin_layout Enumerate
8209 to move the cursor above the caption.
8212 \begin_layout Enumerate
8216 \begin_layout Enumerate
8217 Position the cursor behind the figure and insert a horizontal fill:
8219 Insert\SpecialChar menuseparator
8221 \begin_inset space ~
8224 Character\SpecialChar menuseparator
8226 \begin_inset space ~
8234 \begin_layout Enumerate
8235 Switch to \SpecialChar LaTeX
8239 \begin_inset space ~
8247 \begin_layout Enumerate
8257 Do not close the brace!
8260 \begin_layout Enumerate
8261 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8266 \begin_inset space ~
8278 \begin_layout Standard
8279 Also, refer to the figures in the example paper.
8282 \begin_layout Subsection
8286 \begin_layout Standard
8287 For submission, the paper has to be formated in a special double-spacing
8289 For this purpose, you have to give the option
8293 to the documentclass.
8294 This must be done using the extra class options field in the
8296 Document\SpecialChar menuseparator
8300 Just enter the string
8307 \begin_layout Subsection
8311 \begin_layout Standard
8316 directory contains an example paper written with \SpecialChar LyX
8318 It is the example paper from the original macro package, translated to
8321 Use it for inspiration, and compare the original \SpecialChar LaTeX
8322 code with \SpecialChar LyX
8326 \begin_layout Section
8331 \begin_layout Standard
8337 \begin_layout Subsection
8341 \begin_layout Standard
8343 is a set of macros produced by the American Astronomical Society to
8344 facilitate electronic manuscript submission to the three journals they
8345 publish: the Astrophysical Journal (including the Letters and Supplement),
8346 the Astronomical Journal, and the Publications of the Astronomical Society
8349 has proven to be an excellent tool for generating these documents, especially
8350 given its equation, citation, and figure handling capabilities.
8352 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8353 is the version described here, or higher.
8354 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8355 2.09 and are fundamentally
8356 incompatible with \SpecialChar LyX
8358 The AAS\SpecialChar TeX
8359 package may be downloaded from the AAS\SpecialChar TeX
8363 \begin_layout Standard
8364 \begin_inset VSpace medskip
8370 \begin_layout Standard
8372 \begin_inset Flex URL
8375 \begin_layout Plain Layout
8377 http://www.journals.uchicago.edu/AAS/AASTeX
8385 \begin_layout Standard
8386 \begin_inset VSpace medskip
8392 \begin_layout Standard
8393 A complete user guide is contained in that package and you should familiarize
8394 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8397 will not reduce the need to figure out all the AAS\SpecialChar TeX
8398 commands, it will only
8399 reduce the drudgery of typing everything in.
8400 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8402 completely to the requirements of the journal to which you are submitting
8406 \begin_layout Subsection
8407 Starting a New Paper
8410 \begin_layout Standard
8411 I strongly suggest that you start with the AAS\SpecialChar TeX
8415 File\SpecialChar menuseparator
8422 , enter the new file name, then choose the
8427 This will show the most common fields found in a manuscript.
8428 Simply overwrite the existing text (including the brackets,
8432 ) with the correct information.
8433 Many of the AAS\SpecialChar TeX
8434 commands and environments can be implemented directly in
8436 , but some cannot: most noticeably
8448 , which should stick out like a sore thumb if you actually just opened the
8450 For commands such as these, the \SpecialChar LaTeX
8451 code must be entered directly and marked
8453 Such commands are referred to as \SpecialChar TeX
8454 code, or Evil Red Text.
8455 I tried to minimize the amount of \SpecialChar TeX
8456 code needed in an AAS\SpecialChar TeX
8458 there is still a bit more required than any of us would like.
8461 \begin_layout Subsection
8462 Finishing Your Paper
8465 \begin_layout Standard
8466 When the paper is finished to your satisfaction and previews/prints correctly,
8468 \begin_inset Quotes eld
8472 \begin_inset Quotes erd
8475 actions which need to be done before you submit it to the journals.
8479 \begin_layout Enumerate
8480 Export your paper as a \SpecialChar LaTeX
8483 File\SpecialChar menuseparator
8484 Export\SpecialChar menuseparator
8492 \begin_layout Enumerate
8497 file with your favorite text editor
8498 \begin_inset Separator parbreak
8505 \begin_layout Enumerate
8506 remove the comment lines before the
8515 \begin_layout Enumerate
8520 usepackage...{fontenc}
8522 line if it appears (usually just after
8537 \begin_layout Enumerate
8538 remove everything between (and including) the
8550 commands, except for any commands you specifically put into the \SpecialChar LaTeX
8552 (which should appear immediately after the
8553 \begin_inset Quotes eld
8556 User specified \SpecialChar LaTeX
8558 \begin_inset Quotes erd
8569 \begin_layout Enumerate
8570 Run the resulting file through \SpecialChar LaTeX
8571 to make sure it still processes correctly.
8574 \begin_layout Enumerate
8575 Reread the journal requirements to make sure your filenames and formats
8579 \begin_layout Enumerate
8583 \begin_layout Subsection
8584 Comments On Specific Commands
8587 \begin_layout Standard
8588 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8595 ) gives a good description of each.
8596 Thus it's probably easiest for me to go down the list as found in the guide
8597 and offer comments where necessary.
8598 So let's begin \SpecialChar ldots
8602 \begin_layout Subsubsection
8603 Things that work as expected
8606 \begin_layout Standard
8607 Because they work as you might expect, I simply list them and the section
8708 begin{thebibliography}
8716 (2.13.2), all the cite commands and their variations (2.13.2), the generic
8717 graphicx figure commands (2.14.1),
8741 (2.15.4, amongst other places),
8768 \begin_layout Standard
8769 The following style options also work correctly:
8790 Simply put them in the
8796 Layout\SpecialChar menuseparator
8802 \begin_layout Subsubsection
8803 Things that work, but require more comment
8806 \begin_layout Standard
8807 The following items work, but require a little more discussion:
8810 \begin_layout Itemize
8811 These items are reserved for use by the journal editors, but you can put
8812 them into the \SpecialChar LaTeX
8813 preamble if you feel compelled to do so:
8846 \begin_layout Itemize
8847 These items may be placed in the \SpecialChar LaTeX
8848 preamble, and are included as blanks in
8870 \begin_layout Itemize
8877 (2.3) – can only be used
8878 \begin_inset Quotes eld
8882 \begin_inset Quotes erd
8885 , not in the middle of a paragraph.
8886 Use \SpecialChar TeX
8887 code if you need to embed it.
8890 \begin_layout Itemize
8897 (2.3) – will have extra {} after it.
8898 This should not cause an error.
8901 \begin_layout Itemize
8908 (2.6) – can only be used
8909 \begin_inset Quotes eld
8913 \begin_inset Quotes erd
8916 , not in the middle of a paragraph.
8917 Use \SpecialChar TeX
8918 code if you need to embed it.
8921 \begin_layout Itemize
8928 (2.8) – can't insert a cross-reference tag, you must type the tag name by
8932 \begin_layout Itemize
8946 \begin_layout Itemize
8953 (2.9) – will have extra {} after it.
8954 This should not cause an error.
8957 \begin_layout Itemize
8964 (2.11) – will have extra {} after it.
8965 This should not cause an error.
8968 \begin_layout Itemize
8975 (2.14.2) – you can insert an optional filename argument by placing the cursor
8976 at the beginning of the text and selecting
8978 Insert\SpecialChar menuseparator
8983 \begin_inset Quotes eld
8987 \begin_inset Quotes erd
8990 inserts an optional argument of the type needed by
8997 Hopefully it will be renamed someday.
9000 \begin_layout Itemize
9013 for the catalog ID optional parameter
9016 \begin_layout Itemize
9029 for the catalog ID optional parameter
9032 \begin_layout Subsubsection
9033 Things not implemented, use \SpecialChar TeX
9037 \begin_layout Standard
9060 setcounter{equation}
9062 (2.12), Journal name abbreviations (2.13.4),
9098 (2.15.4, insert it as the first element in the lefthand cell after where
9100 Don't use any of \SpecialChar LyX
9101 's rules in the table),
9113 (2.15.5), much of Misc (2.17, except
9164 \begin_layout Subsubsection
9165 Things that cannot be implemented
9168 \begin_layout Standard
9170 at least in any meaningful sort of way, so I suggest ignoring them.
9171 They are the references environment (2.13.3), and the deluxetable environment
9173 If you really, really need to use deluxetable, I suggest editing it in
9174 a separate file with a text editor, then using
9176 Insert\SpecialChar menuseparator
9178 \begin_inset space ~
9183 to include it in your \SpecialChar LyX
9189 file to see an example of this.
9192 \begin_layout Subsection
9193 FAQs, Tips, Tricks, and Other Ruminations
9196 \begin_layout Subsubsection
9197 Getting \SpecialChar LyX
9198 and AAS\SpecialChar TeX
9202 \begin_layout Standard
9203 It can be a bit tricky to get \SpecialChar LyX
9204 to recognize a new layout and document class.
9205 When all else fails, do this:
9208 \begin_layout Enumerate
9209 Make certain that \SpecialChar LaTeX
9210 can find AAS\SpecialChar TeX
9212 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9214 directory completely unrelated to \SpecialChar LaTeX
9215 or AAS\SpecialChar TeX
9216 and run \SpecialChar LaTeX
9224 \begin_layout Enumerate
9229 appears in \SpecialChar LyX
9237 \begin_layout Enumerate
9240 Tools\SpecialChar menuseparator
9244 , then restart \SpecialChar LyX
9248 \begin_layout Enumerate
9249 Open a regular new file, not from a template.
9250 Does AAS\SpecialChar TeX
9251 appear in the class list in
9253 Document\SpecialChar menuseparator
9259 \begin_layout Standard
9260 If you get a warning from an existing AAS\SpecialChar TeX
9261 document about not being able
9262 to find the AAS\SpecialChar TeX
9263 layout or a message about
9264 \begin_inset Quotes eld
9267 You should not mix title layouts with normal ones
9268 \begin_inset Quotes erd
9271 , things haven't been installed correctly.
9274 \begin_layout Subsubsection
9276 error processing a table
9279 \begin_layout Standard
9281 , by default, attempts to center the table caption/title.
9282 This seems to produce a bad interaction in AAS\SpecialChar TeX
9283 so you should click somewhere
9284 in the caption/title, then select
9286 Edit\SpecialChar menuseparator
9288 \begin_inset space ~
9302 This took care of it for me.
9305 \begin_layout Subsubsection
9309 \begin_layout Standard
9310 A couple of things: 1) I have noticed some funny spacing in the reference
9311 entries in the text.
9312 When you enter the bibliography item data, make sure their is
9316 space between the last author and the parenthesis setting off the year;
9320 \begin_inset space \thinspace{}
9324 \begin_inset space \space{}
9338 2) Entering the references at all is not obvious.
9339 The easiest thing is to start typing your first reference at the end of
9340 the document, then mark it as type
9345 That will put a small gray box in front of what you just typed.
9346 Click on the box to fill in the rest of the information.
9347 For new references, go to the end of an existing reference and press return.
9348 That will create a new line with its own box, etc.
9351 \begin_layout Subsubsection
9355 \begin_layout Standard
9356 Even though AAS\SpecialChar TeX
9357 provides its own figure commands (
9363 , for example), I much prefer \SpecialChar LaTeX
9364 's standard figure commands (with the default
9373 \begin_inset space ~
9376 commands as \SpecialChar TeX
9377 code into a Figure Float box if you desire, but I never have
9378 much luck getting the layout right.
9379 With the standard graphics, \SpecialChar LyX
9384 usepackage{graphicx}
9386 command into the \SpecialChar LaTeX
9387 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9389 interspersing the figures in the text.
9390 I believe ApJ accepts figures exactly this way now; AJ might still use
9392 \begin_inset Quotes eld
9395 stack everything at the end
9396 \begin_inset Quotes erd
9402 \begin_layout Subsubsection
9403 Things I could have done, but didn't
9406 \begin_layout Standard
9408 \begin_inset Quotes eld
9412 \begin_inset Quotes erd
9415 things I could have implemented, but chose not to.
9416 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9418 even though it is double-spaced in the paper manuscript.
9419 Also, I chose not to make separate layouts for the preprint and preprint2
9421 Since I assume you will spend most of your time in the plain manuscript
9422 mode anyway, I decided not to chew up more disk space with this.
9426 \begin_layout Subsection
9430 \begin_layout Standard
9431 Your mileage may vary.
9432 I've now had papers published by both ApJ and AJ that have had 98% of the
9433 effort done in \SpecialChar LyX
9434 ; the last 2% was the \SpecialChar LaTeX
9435 post-processing and a few cleanups.
9436 I have had no trouble with the submission process, and I'm sure the journals
9437 were never aware that there might be a difference.
9438 So, go forth and publish!
9441 \begin_layout Section
9442 AMS \SpecialChar LaTeX
9446 \begin_layout Standard
9456 \begin_layout Standard
9457 \begin_inset VSpace bigskip
9463 \begin_layout Standard
9465 The AMS \SpecialChar LaTeX
9466 layouts are set up to conform to suggested styles for mathematical
9467 papers to be submitted to American Mathematical Society publications.
9468 The layouts are not tailored to a specific journal, but easily can be.
9469 You should refer to the AMS documentation for specific instructions for
9470 each journal (usually it will entail only changing a single line in the
9473 That documentation is available on the Web at
9474 \begin_inset Flex URL
9477 \begin_layout Plain Layout
9485 \begin_inset Flex URL
9488 \begin_layout Plain Layout
9490 ftp://ftp.ams.org/pub/tex/amslatex/
9496 These layouts are appropriate, and useful, for any mathematical writing.
9500 \begin_layout Standard
9501 There are two basic AMS \SpecialChar LaTeX
9505 \begin_layout Itemize
9506 amsart: The standard AMS article format.
9509 \begin_layout Itemize
9510 amsbook: the standard AMS book (really, monograph) format.
9514 \begin_layout Standard
9515 The layouts themselves contain only the minimum necessary to use the AMS
9517 They do not, in particular, contain any of the `theorem' environments used
9518 for setting theorems, lemmas, and the like.
9519 These are contained, instead, in the
9520 \begin_inset Flex Code
9523 \begin_layout Plain Layout
9529 module, which is loaded by default when you select one of the AMS classes.
9530 (It can also be used with other classes and can be removed, if you would
9531 rather use something else.) Less commonly used environments are in the
9532 \begin_inset Flex Code
9535 \begin_layout Plain Layout
9536 Theorems (AMS-Extended)
9541 module, which must be loaded manually.
9544 \begin_layout Standard
9545 By default, theorems and the like are numbered consecutively throughout
9546 the document, but this may be modified by loading the module
9547 \begin_inset Flex Code
9550 \begin_layout Plain Layout
9551 Theorems (Order by Section)
9556 or, if you are using
9557 \begin_inset Flex Code
9560 \begin_layout Plain Layout
9567 \begin_inset Flex Code
9570 \begin_layout Plain Layout
9571 Theorems (Order by Chapter)
9577 These will number the results as
9578 \begin_inset Formula $n.m$
9581 , where the first number refers to the section (or chapter) and the second
9582 refers to the total number of results so far in that section (or chapter).
9583 Many environments are also available unnumbered.
9584 These are indicated by an asterisk at the end.
9585 If you happen to want
9589 unnumbered results, the module
9590 \begin_inset Flex Code
9593 \begin_layout Plain Layout
9599 provides that option.
9602 \begin_layout Standard
9603 Note that these modules do not
9607 to be used with the AMS classes.
9608 It is perfectly possible to use the
9609 \begin_inset Flex Code
9612 \begin_layout Plain Layout
9618 module, and the others mentioned, with other classes, such as
9619 \begin_inset Flex Code
9622 \begin_layout Plain Layout
9629 \begin_inset Flex Code
9632 \begin_layout Plain Layout
9639 \begin_inset Flex Code
9642 \begin_layout Plain Layout
9651 \begin_layout Subsection
9652 What these layouts provide
9655 \begin_layout Standard
9656 There is a long list of included environments provided by these layouts.
9657 In AMS-\SpecialChar LaTeX
9658 , there is, in fact, an opportunity to define an unlimited variety
9659 of `theorem' environments.
9660 However, the AMS recommends the environments that are available in \SpecialChar LyX
9665 \begin_layout Standard
9666 The following environments—as well as the standard environments, such as
9668 \begin_inset Flex Noun
9671 \begin_layout Plain Layout
9678 \begin_inset Flex Noun
9681 \begin_layout Plain Layout
9688 \begin_inset Flex Noun
9691 \begin_layout Plain Layout
9698 \begin_inset Flex Noun
9701 \begin_layout Plain Layout
9708 \begin_inset Flex Noun
9711 \begin_layout Plain Layout
9718 \begin_inset Flex Code
9721 \begin_layout Plain Layout
9728 \begin_inset Flex Code
9731 \begin_layout Plain Layout
9740 \begin_layout Description
9741 Address This should be the author's permanent address.
9744 \begin_layout Description
9746 \begin_inset space ~
9749 Address This should be the author's temporary address at the time of submission,
9750 if different from the Address.
9753 \begin_layout Description
9754 Email Author's e-mail address
9757 \begin_layout Description
9758 URL Author's Web address, if desired.
9761 \begin_layout Description
9762 Keywords Key words or phrases used to identify specific topics discussed
9766 \begin_layout Description
9767 Subjectclass These refer to the AMS Subject Classifications, published and
9770 Mathematical Reviews
9773 These are also available online at the AMS cites listed above.
9776 \begin_layout Description
9780 \begin_layout Description
9784 \begin_layout Description
9788 \begin_layout Standard
9789 The following environments are provided by both the
9790 \begin_inset Flex Code
9793 \begin_layout Plain Layout
9800 \begin_inset Flex Code
9803 \begin_layout Plain Layout
9809 modules, in the latter case in both starred (unnumbered) and unstarred
9810 (numbered) versions.
9811 These same environments are provided only in the starred versions by the
9813 \begin_inset Flex Code
9816 \begin_layout Plain Layout
9825 \begin_layout Theorem
9826 This is typically used for the statements of major results.
9830 \begin_layout Corollary*
9831 This is used for statements which follow fairly directly from previous statement
9833 Again, these can be major results.
9838 These are smaller results needed to prove other statements.
9841 \begin_layout Proposition
9842 These are less major results which (hopefully) add to the general theory
9846 \begin_layout Conjecture
9847 These are statements provided without justification, which the author does
9848 not know how to prove, but which seem to be true (to the author, at least).
9851 \begin_layout Definition*
9852 Guess what this is for.
9853 The font is different for this environment than for the previous ones.
9857 \begin_layout Example*
9858 Used for examples illustrating proven results.
9861 \begin_layout Problem
9862 It's not really known what this is for.
9863 You should figure it out.
9866 \begin_layout Exercise*
9867 Write a description for this one.
9870 \begin_layout Remark
9871 This environment is also a type of theorem, usually a lesser sort of observation.
9874 \begin_layout Claim*
9875 Often used in the course of giving a proof of a larger result.
9879 Generally, these are used to break up long arguments, using specific instances
9885 The numbering scheme for cases is on its own, not together with other numbered
9891 At the end of this environment, a QED symbol (usually a square, but it can
9892 vary with different styles) is placed.
9893 If you want to have other environments within this one—for example, Case
9894 environments—and have the QED symbol appear only after them, then the other
9895 environments need to be nested within the proof environment.
9898 Nesting Environments
9904 for information on nesting.
9907 \begin_layout Standard
9908 And these environments are provided by
9909 \begin_inset Flex Code
9912 \begin_layout Plain Layout
9913 Theorems (AMS-Extended)
9921 \begin_layout Criterion*
9922 A required condition.
9925 \begin_layout Algorithm*
9926 A general procedure to be used.
9929 \begin_layout Axiom*
9930 This is a property or statement taken as true within the system being discussed.
9933 \begin_layout Condition*
9934 Sometimes used to state a condition assumed within the present context of
9939 Similar to a Remark.
9942 \begin_layout Notation*
9943 Used for the explanation of, yes, notation.
9946 \begin_layout Summary
9947 Do we really need to tell you?
9950 \begin_layout Acknowledgement*
9954 \begin_layout Conclusion*
9955 Sometimes used at the end of a long train of argument.
9959 Used in a way similar to Proposition, though perhaps lower on the scale.
9962 \begin_layout Standard
9963 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
9966 They need to be available on your system in order to use these environments.
9969 \begin_layout Section
9977 \begin_layout Standard
9983 \begin_layout Subsection
9987 \begin_layout Standard
9988 These are the layout files for some of the journals of the American Geophysical
9990 It is assumed that you have both the AGU's own class files and AGUplus
9991 installed (everything to be found at
9992 \begin_inset Flex URL
9995 \begin_layout Plain Layout
9997 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10005 \begin_layout Subsection
10009 \begin_layout Standard
10019 They are still called this in the \SpecialChar LyX
10020 GUI, though their \SpecialChar LaTeX
10033 \begin_layout Standard
10034 Newly defined styles are
10071 These are mostly manuscript attributes and defined in the AGU class documentati
10075 \begin_layout Standard
10076 I suspect this is still badly incomplete.
10079 \begin_layout Subsection
10083 \begin_layout Standard
10100 \begin_layout Subsection
10104 \begin_layout Itemize
10107 Journal of Geophysical Research
10116 \begin_layout Standard
10117 Add your own, it isn't so hard! Look at the
10128 \begin_layout Subsection
10129 Bugs and things to remember
10132 \begin_layout Standard
10133 In order to use the new layouts, you must remember to do the following for
10137 \begin_layout Enumerate
10143 This can be done in the
10145 Layout\SpecialChar menuseparator
10150 Document\SpecialChar menuseparator
10154 (AGU articles are always in English, right? So
10158 choose a language.)
10161 \begin_layout Enumerate
10166 into the document's
10171 (Yes, this is a bug.)
10174 \begin_layout Enumerate
10175 Make sure you use the
10179 bibliography style, by entering
10183 into the second field of the Bib\SpecialChar TeX
10185 None of the standard styles will do.
10188 \begin_layout Section
10192 \begin_layout Standard
10198 \begin_layout Subsection
10202 \begin_layout Standard
10203 Broadway is for writing plays.
10204 The format is more decorative than Hollywood, and much less standardized.
10205 This format should be suitable for workshops.
10208 \begin_layout Subsection
10212 \begin_layout Standard
10213 The same as in Hollywood.
10216 \begin_layout Subsection
10220 \begin_layout Standard
10225 names as labels then cross-reference the label to insert the name.
10226 The cross-reference dialog will show the current cast of characters.
10229 \begin_layout Subsection
10230 Paper size and Margins
10233 \begin_layout Standard
10234 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10237 \begin_layout Subsection
10241 \begin_layout Standard
10242 The following environments are available.
10243 You can use broadway.bind to get the bind keys shown at the right.
10246 \begin_layout Itemize
10250 \begin_inset Newline newline
10255 You should not have to use this, but it is here for anything that does not
10259 \begin_layout Itemize
10263 \begin_inset space \hfill{}
10267 \begin_inset Newline newline
10272 Used to describe stage setting and the action.
10273 First use of speaker names in all CAPs.
10276 \begin_layout Itemize
10280 \begin_inset space \hfill{}
10284 \begin_inset Newline newline
10289 Automatically numbered.
10290 On screen it will be arabic, but will print as Roman.
10293 \begin_layout Itemize
10297 \begin_inset space \hfill{}
10301 \begin_inset Newline newline
10311 It is just centered text.
10314 \begin_layout Itemize
10318 \begin_inset space \hfill{}
10322 \begin_inset Newline newline
10327 Not automatically numbered.
10328 You supply the number.
10329 This is because I couldn't figure out how.
10332 \begin_layout Itemize
10336 \begin_inset space \hfill{}
10340 \begin_inset Newline newline
10345 A special case of Narrative to describe the setting and action as the curtain
10349 \begin_layout Itemize
10353 \begin_inset space \hfill{}
10357 \begin_inset Newline newline
10362 The speaker's (actor's) title, centered in all CAPS.
10365 \begin_layout Itemize
10369 \begin_inset space \hfill{}
10373 \begin_inset Newline newline
10378 Instructions to the speaker.
10379 The parentheses are automatically inserted.
10380 The ( will appear on screen, but both will be in the printed play.
10381 This environment is only used within
10388 \begin_layout Itemize
10392 \begin_inset space \hfill{}
10396 \begin_inset Newline newline
10401 What the Speaker says.
10404 \begin_layout Itemize
10408 \begin_inset space \hfill{}
10412 \begin_inset Newline newline
10417 The curtain comes down.
10420 \begin_layout Itemize
10424 \begin_inset space \hfill{}
10430 \begin_layout Itemize
10434 \begin_inset space \hfill{}
10440 \begin_layout Itemize
10444 \begin_inset space \hfill{}
10450 \begin_layout Standard
10454 \begin_layout Section
10458 \begin_layout Standard
10463 can be used to type letters according to German conventions.
10464 A template file is included in
10466 .../lyx/share/templates
10468 for you to use as a starting point.
10471 \begin_layout Section
10479 \begin_layout Standard
10485 \begin_layout Subsection
10489 \begin_layout Standard
10490 This is the layout file for the European Geophysical Society journals.
10495 can be downloaded from the web site of the EGS under
10496 \begin_inset Flex URL
10499 \begin_layout Plain Layout
10509 \begin_layout Subsection
10513 \begin_layout Standard
10516 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10524 The current layout file is unfortunately very unmodular and would benefit
10525 from using the various
10532 \begin_layout Section
10536 \begin_layout Standard
10537 See the \SpecialChar LyX
10543 It contains all infos you need.
10546 \begin_layout Section
10549 Foil\SpecialChar TeX
10553 \begin_inset CommandInset label
10562 \begin_layout Standard
10568 \begin_layout Subsection
10572 \begin_layout Standard
10573 This section describes how to use \SpecialChar LyX
10574 to make slides for overhead projectors.
10575 There are two document classes that can do this: the default slides class
10578 Foil\SpecialChar TeX
10582 This section documents the latter.
10585 \begin_layout Standard
10586 I'm going to say this again, nice and clear, so that there's no misunderstanding
10590 \begin_layout Standard
10591 \begin_inset VSpace bigskip
10597 \begin_layout Standard
10601 This section documents the class
10602 \begin_inset Quotes eld
10610 \begin_inset Quotes erd
10618 \begin_layout Standard
10619 \begin_inset VSpace bigskip
10625 \begin_layout Standard
10626 If you're looking for the documentation for
10627 \begin_inset Quotes eld
10635 \begin_inset Quotes erd
10638 , check out section
10639 \begin_inset space ~
10643 \begin_inset CommandInset ref
10645 reference "sec:slitex"
10650 If your machine doesn't have the
10655 \begin_inset Quotes eld
10663 \begin_inset Quotes erd
10666 ] installed, you'll probably have to use the default
10670 class, which isn't quite as good as
10675 \begin_layout Standard
10680 class is designed for use with version 2.1 of the
10685 class file which is now an integral part of \SpecialChar LaTeX2e
10689 \begin_layout Subsection
10693 \begin_layout Standard
10694 Obviously, to use this document class, you need to select
10695 \begin_inset Quotes eld
10703 \begin_inset Quotes erd
10713 \begin_inset space ~
10719 There are some settings in the
10722 \begin_inset space ~
10727 dialog that you should know about that are specific to this class:
10730 \begin_layout Itemize
10731 Don't change the options
10742 \begin_inset space ~
10748 They're ignored by the
10755 \begin_layout Itemize
10756 The default font size is 20
10757 \begin_inset space \thinspace{}
10760 pt with the other options being 17
10761 \begin_inset space \thinspace{}
10765 \begin_inset space \thinspace{}
10769 \begin_inset space \thinspace{}
10775 \begin_layout Itemize
10776 The default font is
10784 but all math equations are still typeset in the usual roman font.
10787 \begin_layout Itemize
10790 Foil\SpecialChar TeX
10793 supports A4 and Letter paper sizes as well as a special size for working
10795 \begin_inset space \thinspace{}
10799 It doesn't support A5, B5, legal or executive paper sizes.
10802 \begin_layout Itemize
10803 Don't bother changing the
10807 settings because they are ignored anyway.
10808 All floats appear where they are defined in the text.
10811 \begin_layout Itemize
10816 setting behaves a bit differently for this class.
10819 Foil\SpecialChar TeX
10822 provides extensive footer and header capabilities including a user-defined
10825 \begin_inset space ~
10829 \begin_inset CommandInset ref
10831 reference "sec:foilfoot"
10836 The title page is treated differently to all other pages in the document
10845 has the logo centered at the bottom of the page (if one is defined).
10846 The possible page style choices and what they do are as follows:
10847 \begin_inset Separator parbreak
10854 \begin_layout Labeling
10855 \labelwidthstring MMMMMMM
10862 The final output contains no page numbers, or other headers or footers
10863 (except footnotes of course).
10867 \begin_layout Labeling
10868 \labelwidthstring MMMMMMM
10875 The final output contains page numbers centered at the bottom of the page.
10876 No other headings or footers (other than footnotes).
10879 \begin_layout Labeling
10880 \labelwidthstring MMMMMMM
10885 Page numbers in lower right corner.
10886 Additional headers and footers are also shown.
10887 This is also the default.
10890 \begin_layout Labeling
10891 \labelwidthstring MMMMMMM
10896 Gives you access to the
10900 package although its use with
10902 Foil\SpecialChar TeX
10905 is discouraged by the writer of the
10907 Foil\SpecialChar TeX
10910 package because of some potential page layout clashes.
10914 \begin_layout Subsubsection
10918 \begin_layout Standard
10919 The following options may be used in the extra class options in the
10921 Document\SpecialChar menuseparator
10927 \begin_layout Labeling
10928 \labelwidthstring MMMMMMx
10933 This sets up the page layout for 7.33
10934 \begin_inset space \thinspace{}
10938 \begin_inset space \thinspace{}
10941 in paper, which is about the same aspect ratio as a 35
10942 \begin_inset space \thinspace{}
10945 mm slide, making it a bit easier to work with this medium.
10948 \begin_layout Labeling
10949 \labelwidthstring MMMMMMx
10954 Places a rule across the page below the header on every page except the
10958 \begin_layout Labeling
10959 \labelwidthstring MMMMMMx
10964 Places a rule across the page above the footer on every page except the
10968 \begin_layout Labeling
10969 \labelwidthstring MMMMMMx
10974 This is automatically set each time you create a new
10981 Foil\SpecialChar TeX
10984 to use the dvips driver to rotate those pages that are set as landscape
10988 \begin_layout Labeling
10989 \labelwidthstring MMMMMMx
10994 Simply changes the page dimensions to those of a landscape page but doesn't
10996 Thus if you use this option you need to use an external program to rotate
10997 each page or feed your paper through your printer as landscape.
10998 Note that this option effectively reverses the roles of the
11006 environments (don't worry these are described in the next section).
11009 \begin_layout Labeling
11010 \labelwidthstring MMMMMMx
11015 Equation numbers on the left.
11018 \begin_layout Labeling
11019 \labelwidthstring MMMMMMx
11024 Flush-left equations.
11027 \begin_layout Subsection
11028 Supported Environments
11031 \begin_layout Standard
11032 Most of the environments commonly supported in other classes are also supported
11038 There are several additional environments provided by
11040 Foil\SpecialChar TeX
11043 as well as a couple added by \SpecialChar LyX
11045 The following environments are shared with other classes:
11048 \begin_layout Standard
11049 \begin_inset Flex Multiple Columns
11052 \begin_layout Itemize
11058 \begin_layout Itemize
11064 \begin_layout Itemize
11070 \begin_layout Itemize
11076 \begin_layout Itemize
11082 \begin_layout Itemize
11089 \begin_layout Itemize
11095 \begin_layout Itemize
11101 \begin_layout Itemize
11107 \begin_layout Itemize
11113 \begin_layout Itemize
11119 \begin_layout Itemize
11125 \begin_layout Itemize
11131 \begin_layout Itemize
11137 \begin_layout Itemize
11143 \begin_layout Itemize
11149 \begin_layout Itemize
11155 \begin_layout Itemize
11166 \begin_layout Standard
11167 That is, all the major environments apart from the sectioning environments.
11168 Since foils are essentially self-contained sections, with a title and body,
11171 Foil\SpecialChar TeX
11174 provides specific commands for starting new foils and these are:
11177 \begin_layout Itemize
11183 \begin_layout Itemize
11189 \begin_layout Standard
11191 also provides slightly modified versions of these two environments called:
11194 \begin_layout Itemize
11200 \begin_layout Itemize
11203 ShortRotatefoilhead
11206 \begin_layout Standard
11207 and the differences will be explained in the next section.
11210 \begin_layout Standard
11211 Since foils are often used in presenting ideas or new theorems and such
11214 Foil\SpecialChar TeX
11217 also provides a comprehensive box of goodies for presenting them:
11220 \begin_layout Standard
11221 \begin_inset Flex Multiple Columns
11224 \begin_layout Itemize
11230 \begin_layout Itemize
11236 \begin_layout Itemize
11242 \begin_layout Itemize
11248 \begin_layout Itemize
11254 \begin_layout Itemize
11260 \begin_layout Itemize
11266 \begin_layout Itemize
11272 \begin_layout Itemize
11278 \begin_layout Itemize
11284 \begin_layout Itemize
11295 \begin_layout Standard
11296 The starred versions are unnumbered while the unstarred versions are numbered.
11297 There are also two list environments added by \SpecialChar LyX
11301 \begin_layout Itemize
11307 \begin_layout Itemize
11313 \begin_layout Standard
11316 Foil\SpecialChar TeX
11319 provides some powerful header and footer capabilities that are best set
11320 in the preamble although they may be set at any point in a document.
11321 If you want to change these settings in your document the best place to
11322 do so is at the very top of a foil, i.
11323 \begin_inset space \thinspace{}
11329 \begin_inset space \space{}
11334 straight after the foilhead.
11337 \begin_layout Standard
11338 For this purpose, the following command styles are provided [
11345 \begin_layout Standard
11346 \begin_inset Flex Multiple Columns
11349 \begin_layout Itemize
11353 \begin_inset space ~
11359 \begin_layout Itemize
11365 \begin_layout Itemize
11369 \begin_inset space ~
11375 \begin_layout Itemize
11379 \begin_inset space ~
11385 \begin_layout Itemize
11389 \begin_inset space ~
11395 \begin_inset Separator parbreak
11402 \begin_layout Plain Layout
11403 \begin_inset space ~
11415 \begin_layout Standard
11416 There are also a few commands provided by
11418 Foil\SpecialChar TeX
11421 that aren't directly supported by \SpecialChar LyX
11422 but I'll tell you what they do and how
11423 to use them in section
11424 \begin_inset space ~
11428 \begin_inset CommandInset ref
11430 reference "sec:unsuppfoils"
11437 \begin_layout Subsection
11438 Building a Set of Foils
11441 \begin_layout Standard
11442 This section will give a simple introduction to using the different environments
11443 to build a set of foils.
11444 If you want to see an example set of foils, take a look at the
11448 file you find in \SpecialChar LyX
11456 \begin_layout Subsubsection
11457 Give It a Title Page
11460 \begin_layout Standard
11461 Unlike other classes that provide
11481 creates the title on a page of its own.
11482 If you leave out the
11486 environment \SpecialChar LaTeX
11487 will substitute the current date (every time you regenerate
11491 \begin_layout Subsubsection
11495 \begin_layout Standard
11496 As I mentioned earlier, there are four ways of starting a new foil.
11497 For portrait foils you should use
11506 The difference between these two environments is the amount of space between
11507 the title of the foil (the foilhead) and the body of the foil.
11510 \begin_layout Standard
11511 Landscape foils are generated using the
11517 ShortRotatefoilhead
11520 Again the only difference is the spacing between foilhead and body.
11521 Both of the short versions have 0.5
11522 \begin_inset space ~
11525 inches less separation between the foilhead and the body.
11529 \begin_layout Standard
11530 One problem with the support for landscape foils is the requirement that
11531 you have to use the
11535 driver to generate the PostScript output otherwise the foils won't be rotated.
11536 It is possible to get landscape foils even if you haven't got the
11540 driver provided you can feed your foils sideways through your printer ;-)
11543 \begin_layout Subsubsection
11544 Theorems, Lemmas, Proofs and more
11547 \begin_layout Standard
11548 Due to a small bug in \SpecialChar LyX
11549 you can't have two of the same type of these environments
11550 directly following each other.
11551 They must be separated by something.
11552 If you try, you will just be extending the previous environment as if you
11553 had merged the two environments together.
11554 So, how do you get around this problem? The simplest option is to insert
11555 some text between the two environments or add a
11560 environment between the two with just a
11561 \begin_inset Quotes eld
11569 \begin_inset Quotes erd
11573 This will force \SpecialChar LyX
11574 to produce two separate environments and hence the correct
11577 An example is provided in the example file included with the \SpecialChar LyX
11579 Remember, this problem only occurs if you are trying to place two of the
11580 same type of theorem-like environments one directly after the other.
11583 \begin_layout Subsubsection
11587 \begin_layout Standard
11588 You get all the commonly supported list styles found in other classes as
11589 well as two new ones.
11590 I'll only describe the new ones here.
11591 If you want to find out more about the other list environments check out
11597 If you intend to use itemized lists you might also want to read about the
11601 \begin_inset space ~
11605 \begin_inset space ~
11610 dialog described above in section
11611 \begin_inset space ~
11615 \begin_inset CommandInset ref
11617 reference "sec:bullet"
11624 \begin_layout Standard
11625 The two new list styles,
11633 , are designed to make it easier for you to create lists of do's and don'ts
11634 or right and wrong by providing dedicated environments that use a tick
11635 or a cross as the label of the list.
11636 These lists are in fact dedicated variants of the
11641 They do however require that you have the
11645 packages installed.
11648 \begin_layout Subsubsection
11652 \begin_layout Standard
11655 Foil\SpecialChar TeX
11658 redefines the floating tables and figures so that they appear exactly where
11659 they are in the text rather than pushing them to the top of the page or
11660 to some user specified location.
11661 In fact if you change the float placement settings they are simply ignored.
11664 \begin_layout Subsubsection
11665 Page Headers and Footers
11666 \begin_inset CommandInset label
11668 name "sec:foilfoot"
11675 \begin_layout Standard
11679 \begin_inset space ~
11688 are two commands used to control the left-footer text string.
11689 The first is meant to allow you to include a graphic logo on your foils
11691 \begin_inset Quotes eld
11696 Foil\SpecialChar TeX
11700 \begin_inset Quotes erd
11704 While the second is meant to provide a classification for the audience,
11708 \begin_inset space \thinspace{}
11714 \begin_inset space \space{}
11718 It is empty by default.
11721 \begin_layout Standard
11722 The remaining page corners can be filled by
11725 \begin_inset space ~
11730 (which defaults to page numbers),
11733 \begin_inset space ~
11741 \begin_inset space ~
11749 \begin_layout Subsection
11752 Foil\SpecialChar TeX
11756 \begin_inset CommandInset label
11758 name "sec:unsuppfoils"
11765 \begin_layout Standard
11766 All the commands mentioned below need to be set in a
11776 within another environment.
11779 \begin_layout Subsubsection
11783 \begin_layout Standard
11784 All lengths are adjusted using the
11807 should be replaced by the name given to the length you want to change and
11812 is the length value.
11813 All lengths should be specified in units of length such as inches (
11825 ) or relative to some document or font-based length such as
11835 \begin_layout Standard
11836 It's possible to change the spacing between a foilhead and the body of the
11837 foil by adjusting the length specified by
11844 For example, to make
11849 \begin_inset space \space{}
11852 in closer to their bodies put the following in the preamble:
11858 foilheadskip}{-0.5in}
11861 \begin_layout Standard
11862 The spacings around floats can be adjusted by setting these lengths:
11865 \begin_layout Labeling
11866 \labelwidthstring MMMMMMMMMMM
11873 Separation between the text and the top of the float
11876 \begin_layout Labeling
11877 \labelwidthstring MMMMMMMMMMM
11884 Separation between the float and the caption
11887 \begin_layout Labeling
11888 \labelwidthstring MMMMMMMMMMM
11895 Separation between the caption and the following text
11898 \begin_layout Labeling
11899 \labelwidthstring MMMMMMMMMMM
11906 You can make the captions narrower than the surrounding text by adjusting
11908 Best done relative to
11917 \begin_layout Standard
11918 There are also several title page related lengths that you may find useful
11919 if you have a long title or several authors:
11922 \begin_layout Labeling
11923 \labelwidthstring MMMMMMMMMMM
11930 Separation from headers to
11935 \begin_layout Labeling
11936 \labelwidthstring MMMMMMMMMMM
11954 \begin_layout Labeling
11955 \labelwidthstring MMMMMMMMMMM
11969 \begin_layout Labeling
11970 \labelwidthstring MMMMMMMMMMM
11986 \begin_layout Labeling
11987 \labelwidthstring MMMMMMMMMMM
12003 \begin_layout Standard
12004 The last length related command affects all the list environments.
12015 a list environment then all the vertical spacing between the list items
12017 Note that this is a command not a length so it doesn't require
12023 like the stuff mentioned above.
12026 \begin_layout Subsubsection
12027 Headers and Footers
12030 \begin_layout Standard
12043 commands control whether the logo in the
12047 definition appear on a given page.
12054 in the preamble then none of the foils will have the logo on them.
12055 If you don't want the logo on a particular page place the
12061 directly after the foilhead of that page and the
12067 directly after the next foilhead.
12070 \begin_layout Standard
12071 If you decide to use the
12075 page style setting in the
12078 \begin_inset space ~
12083 dialog you should probably add
12093 to your preamble so headers and footers on landscape pages are correctly
12094 placed when rotated.
12095 This is due to some clashes between the page layouts provided by the
12106 \begin_layout Section
12107 Hollywood (Hollywood spec scripts)
12110 \begin_layout Standard
12116 \begin_layout Subsection
12120 \begin_layout Standard
12121 Getting the format of a Hollywood script right is a
12122 \begin_inset Quotes eld
12126 \begin_inset Quotes erd
12129 It is designed to make the readers focus on content and to be easy and
12130 familiar for the actors to read.
12131 Each page of a script should be one minute of film.
12132 Nothing goes in a script that you cannot see or hear on screen.
12133 The courier 12 pt font should be used throughout.
12137 \begin_layout Subsection
12141 \begin_layout Standard
12142 Speakers' lines should NEVER break in mid-sentence.
12143 If a speaker's lines continue over a page break, repeat the
12147 title followed by (Cont'd).
12150 \begin_layout Subsection
12154 \begin_layout Standard
12159 names as labels then cross-reference the label to insert the name.
12160 The cross-reference dialog will show the current cast of characters.
12161 You can use this to insert the speaker name in narratives also.
12164 \begin_layout Subsection
12165 Paper size and Margins
12168 \begin_layout Standard
12169 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12172 \begin_layout Subsection
12176 \begin_layout Standard
12177 The following environments are available.
12178 You can use hollywood.bind to get the bind keys shown at the right.
12181 \begin_layout Itemize
12185 \begin_inset Newline newline
12190 Used where nothing else works.
12194 \begin_layout Itemize
12200 \begin_inset space \hfill{}
12208 \begin_inset Newline newline
12211 Usually followed by something like
12212 \begin_inset Quotes eld
12215 on Sally waking up.
12216 \begin_inset Quotes erd
12222 \begin_layout Itemize
12226 \begin_inset space \hfill{}
12230 \begin_inset Newline newline
12235 Introduces a new INTERIOR camera set-up.
12236 Always followed by DAY or NIGHT, or something similar to define the lighting
12238 Everthing on this line in CAPS.
12241 \begin_layout Itemize
12245 \begin_inset space \hfill{}
12249 \begin_inset Newline newline
12254 Introduces a new EXTERIOR camera set-up.
12255 Everthing on this line in CAPS.
12258 \begin_layout Itemize
12262 \begin_inset space \hfill{}
12266 \begin_inset Newline newline
12271 The character speaking.
12274 \begin_layout Itemize
12278 \begin_inset space \hfill{}
12282 \begin_inset Newline newline
12287 Instructions to the speaker.
12288 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12290 Both will be printed.
12293 \begin_layout Itemize
12297 \begin_inset space \hfill{}
12301 \begin_inset Newline newline
12313 \begin_layout Itemize
12317 \begin_inset space \hfill{}
12321 \begin_inset Newline newline
12326 Camera movement instruction.
12328 \begin_inset space \thinspace{}
12332 \begin_inset space \space{}
12338 \begin_layout Itemize
12342 \begin_inset space \hfill{}
12348 \begin_layout Itemize
12352 \begin_inset space \hfill{}
12358 \begin_layout Itemize
12362 \begin_inset space \hfill{}
12368 \begin_layout Itemize
12372 \begin_inset space \hfill{}
12378 \begin_layout Subsection
12382 \begin_layout Itemize
12386 \begin_layout Itemize
12390 \begin_layout Itemize
12392 \begin_inset space \thinspace{}
12399 \begin_layout Itemize
12404 \begin_layout Itemize
12405 PAN — camera movement
12408 \begin_layout Itemize
12409 INSERT — cut to close-up of
12412 \begin_layout Section
12416 \begin_layout Standard
12419 Panayotis Papasotiriou
12422 \begin_layout Subsection
12426 \begin_layout Standard
12427 The ijmpc package is a set of macros that facilitates electronic manuscript
12430 International Journal of Modern Physics C
12433 Similarly, the ijmpd package is for creating manuscripts to be submitted
12436 International Journal of Modern Physics D
12439 Both journals are published by World Scientific.
12440 The corresponding document classes are named
12449 These files, together with instructions for the authors, can be downloaded
12451 \begin_inset Flex URL
12454 \begin_layout Plain Layout
12456 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12462 \begin_inset Flex URL
12465 \begin_layout Plain Layout
12467 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12473 Both packages are modified versions of the standard
12474 \begin_inset Quotes eld
12478 \begin_inset Quotes erd
12481 package, and they are almost (but not exactly) identical.
12482 Most of their features are supported by \SpecialChar LyX
12484 I have used \SpecialChar LyX
12485 successfully to write articles submitted to both journals
12486 without any problem.
12489 \begin_layout Subsection
12493 \begin_layout Standard
12494 As usual, the easiest way to write a paper is to start with a template.
12497 File\SpecialChar menuseparator
12516 This will give an (almost) empty document that includes the most common
12517 fields found in a manuscript.
12518 Simply overwrite the existing text (including the brackets,
12523 You should keep in mind the following remarks.
12526 \begin_layout Enumerate
12528 won't let you change the font size and the page style of the document,
12529 because such modifications are not allowed by both packages.
12532 \begin_layout Enumerate
12533 The language of the document should not be changed.
12534 Before previewing your paper, be sure that the babel package is not used.
12535 To do this, click on
12537 Tools\SpecialChar menuseparator
12548 checkbox in the language settings, and click on
12556 , if you wish to make this change permanent).
12559 \begin_layout Enumerate
12561 \begin_inset Quotes eld
12565 \begin_inset Quotes erd
12568 style must be used to define keywords.
12571 \begin_layout Enumerate
12572 The ijmpc package provides a style named
12573 \begin_inset Quotes eld
12576 Classification Codes
12577 \begin_inset Quotes erd
12580 , which can be used to define classification codes, such as PACS numbers.
12581 Note that this facility is not supported by the ijmpd package.
12584 \begin_layout Enumerate
12585 Several new environments are available:
12586 \begin_inset Quotes eld
12590 \begin_inset Quotes erd
12594 \begin_inset Quotes eld
12598 \begin_inset Quotes erd
12602 \begin_inset Quotes eld
12606 \begin_inset Quotes erd
12610 \begin_inset Quotes eld
12614 \begin_inset Quotes erd
12618 \begin_inset Quotes eld
12622 \begin_inset Quotes erd
12626 \begin_inset Quotes eld
12630 \begin_inset Quotes erd
12634 \begin_inset Quotes eld
12638 \begin_inset Quotes erd
12642 \begin_inset Quotes eld
12646 \begin_inset Quotes erd
12650 \begin_inset Quotes eld
12654 \begin_inset Quotes erd
12658 \begin_inset Quotes eld
12662 \begin_inset Quotes erd
12666 \begin_inset Quotes eld
12670 \begin_inset Quotes erd
12674 \begin_inset Quotes eld
12678 \begin_inset Quotes erd
12682 \begin_inset Quotes eld
12686 \begin_inset Quotes erd
12690 \begin_inset Quotes eld
12694 \begin_inset Quotes erd
12698 Their use is more or less obvious.
12700 supports all these environments; it will use the proper label, text style,
12701 and numbering scheme for each of them.
12704 \begin_layout Enumerate
12705 Both packages use basic citations; the natbib package should not be used.
12706 In \SpecialChar LyX
12707 , citation references are shown as usual; in the output, citations are
12708 shown as superscripts.
12709 If you want to use a citation as normal text, you should use the
12714 \begin_inset space \thinspace{}
12718 \begin_inset space \space{}
12722 \begin_inset Quotes eld
12726 \begin_inset space \space{}
12736 \begin_inset Quotes erd
12742 \begin_layout Enumerate
12744 \begin_inset Quotes eld
12748 \begin_inset Quotes erd
12751 section in both packages.
12752 To put acknowledgments, just use the
12753 \begin_inset Quotes eld
12757 \begin_inset Quotes erd
12763 \begin_layout Enumerate
12764 Appendices may be added to the paper,
12768 the Acknowledgments and
12774 provides a special environment, called
12775 \begin_inset Quotes eld
12779 \begin_inset Quotes erd
12782 which marks the beginning of the appendices.
12783 This environment should be left blank; it just sends a \SpecialChar LaTeX
12784 command, but nothing
12786 In \SpecialChar LyX
12788 \begin_inset Quotes eld
12792 \begin_inset Quotes erd
12795 is printed with blue letters, as a signal that all sections after that
12796 point are appendices.
12797 To write an appendix, use the
12798 \begin_inset Quotes eld
12802 \begin_inset Quotes erd
12807 will number each appendix with capital letters, as required by both journals.
12809 \begin_inset Quotes eld
12813 \begin_inset Quotes erd
12820 be present before the first appendix; if not, all appendices will be numbered
12821 as normal sections in the output.
12824 \begin_layout Enumerate
12825 The ijmpc and the ijmpd packages use the
12829 command to implement table captions.
12830 As a result, a table created by \SpecialChar LyX
12831 is printed correctly, but its caption
12833 However, you can use some \SpecialChar TeX
12834 code to overcome this problem, so that captions
12835 are printed as expected.
12836 To do so, create a float table as usual, remove the caption, and replace
12837 it with the \SpecialChar TeX
12848 (sic); you must also the \SpecialChar TeX
12853 immediately after the tabular material.
12854 Study the example table included in the template files to see how this
12855 trick is implemented.
12856 Alternatively, If you need table captions, you should implement the whole
12861 file, then include this file to the \SpecialChar LyX
12864 Insert\SpecialChar menuseparator
12865 File\SpecialChar menuseparator
12867 \begin_inset space ~
12873 Details on how to create a table float can be found in the files
12881 , included in the corresponding packages.
12884 \begin_layout Subsection
12885 Preparing a paper for submission
12888 \begin_layout Standard
12889 Before you submit your paper you must export the \SpecialChar LyX
12890 document as a \SpecialChar LaTeX
12893 File\SpecialChar menuseparator
12894 Export\SpecialChar menuseparator
12902 \begin_layout Plain Layout
12903 Actually you have the choice between \SpecialChar LaTeX
12904 (plain) and pdflatex.
12905 If you intend to use pdflatex to prepare the paper, you should use the
12906 pdflatex option so that included graphics are converted to PDF format,
12907 ready for use by pdflatex.
12912 , then make the following changes to the resulting
12919 \begin_layout Enumerate
12920 Remove the comment lines before the
12929 \begin_layout Enumerate
12930 Remove everything between (and including) the
12942 commands, except for any commands you specifically put into the \SpecialChar LaTeX
12946 \begin_layout Standard
12951 file should be saved and processed through \SpecialChar LaTeX
12952 as many times as necessary.
12953 You may also want to check the resulting
12960 \begin_layout Subsection
12961 Use of \SpecialChar TeX
12965 \begin_layout Standard
12966 The use of \SpecialChar TeX
12967 code is reduced to two commands, which must be placed at the
12968 top of the document.
12969 If you started writing your paper by using the
12977 template, the \SpecialChar TeX
12978 code needed is already in its place; you usually don't need
12980 You may only modify the first \SpecialChar TeX
12981 code to specify the information printed
12982 to the top of odd and even pages (authors' names and short paper's title,
12984 This \SpecialChar TeX
12985 code must have the form
12989 markboth{Authors' Names}{Short Paper's Title}
12994 \begin_layout Section
12998 \begin_layout Standard
13004 \begin_layout Subsection
13008 \begin_layout Standard
13009 The iopart package provides a document class to create electronic manuscript
13010 submission to the journals published by the Institute of Physics.
13011 Instructions for the authors how to create a paper using the iopart class
13012 can be downloaded together with the iopart package from the site
13013 \begin_inset Flex URL
13016 \begin_layout Plain Layout
13018 ftp://ftp.iop.org/pub/journals/latex2e
13026 \begin_layout Subsection
13030 \begin_layout Standard
13031 The easiest way to write a paper is to start with the file
13035 that is available in \SpecialChar LyX
13036 's examples files folder.
13037 Open this file, save it under a new name, and start writing.
13038 The example file explains how to use the special text environments.
13039 Here are the most important advices:
13042 \begin_layout Itemize
13043 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13046 Use AMS math package
13048 in the document settings under
13055 \begin_layout Itemize
13058 The title environment defines the kind of your paper.
13059 So use one of the following environments for the title:
13062 \begin_inset Separator parbreak
13069 \begin_layout Itemize
13078 \begin_layout Itemize
13087 \begin_layout Itemize
13093 for a Topical review
13096 \begin_layout Itemize
13105 \begin_layout Itemize
13114 \begin_layout Itemize
13120 for a Paper (same as Title)
13123 \begin_layout Itemize
13129 for a Preliminary communication
13132 \begin_layout Itemize
13138 for a Rapid communication
13141 \begin_layout Itemize
13147 for a Letter to the editor
13151 \begin_layout Itemize
13154 All title environments except of
13158 can have an optional short title.
13161 \begin_layout Itemize
13162 There is a general title environment
13166 which is not directly supported by the \SpecialChar LyX
13168 This can be used as \SpecialChar TeX
13169 code when your document doesn't fit into one of the
13173 \begin_layout Standard
13174 For more informations like hints for special table and formula formatting,
13175 look at the IOP author guidelines.
13178 \begin_layout Section
13182 \begin_layout Standard
13185 Panayotis Papasotiriou
13188 \begin_layout Subsection
13192 \begin_layout Standard
13193 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13194 that facilitates electronic manuscript submission to the journals they
13196 Most known of them (at least in my domain of interest) are
13198 Astrophysics and Space Science
13204 , but there are many others (see a complete list at
13205 \begin_inset Flex URL
13208 \begin_layout Plain Layout
13210 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13216 The Kluwer package may be downloaded from the site
13217 \begin_inset Flex URL
13220 \begin_layout Plain Layout
13222 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13228 A complete user guide is contained in that package (but it can also be
13229 downloaded separately).
13232 \begin_layout Standard
13234 supports many features of the package but not everything.
13235 However, the \SpecialChar TeX
13236 code needed is reduced to some
13237 \begin_inset Quotes eld
13241 \begin_inset Quotes erd
13244 commands of the package (see
13245 \begin_inset space ~
13249 \begin_inset CommandInset ref
13251 reference "subsec:kluwer_peculiarities"
13256 I have recently used \SpecialChar LyX
13257 to write an article submitted to the
13259 Astrophysics and Space Science
13261 without any problem.
13264 \begin_layout Subsection
13268 \begin_layout Standard
13269 The easiest way to write a paper is to start with the Kluwer template file.
13272 File\SpecialChar menuseparator
13284 This will give an (almost) empty document that includes the most common
13285 fields found in a manuscript and a short description of their use.
13286 As in most templates, simply overwrite the existing text (including the
13291 ) with the correct information.
13294 \begin_layout Subsection
13295 Preparing a paper for submission
13298 \begin_layout Standard
13299 As in the AAS\SpecialChar TeX
13300 package, before you submit your paper to a journal you must
13302 \begin_inset Quotes eld
13306 \begin_inset Quotes erd
13312 \begin_layout Enumerate
13313 Export your paper as a \SpecialChar LaTeX
13315 To do this, click on
13317 File\SpecialChar menuseparator
13318 Export\SpecialChar menuseparator
13326 \begin_layout Enumerate
13331 file with a text editor and make the following changes
13332 \begin_inset Separator parbreak
13339 \begin_layout Enumerate
13340 remove the comment lines before the
13349 \begin_layout Enumerate
13350 remove everything between (and including) the
13362 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13366 \begin_layout Standard
13375 \begin_layout Enumerate
13380 file through \SpecialChar LaTeX
13381 as many times as necessary (usually up to three).
13384 \begin_layout Enumerate
13390 \begin_inset space \thinspace{}
13394 \begin_inset space \space{}
13401 , and check if everything is OK (it should, if you didn't make any mistake).
13404 \begin_layout Subsection
13405 \begin_inset Quotes eld
13409 \begin_inset Quotes erd
13412 of the Kluwer package
13413 \begin_inset CommandInset label
13415 name "subsec:kluwer_peculiarities"
13422 \begin_layout Standard
13423 The Kluwer package has the following
13424 \begin_inset Quotes eld
13428 \begin_inset Quotes erd
13434 \begin_layout Enumerate
13435 It is possible to write multiple articles in the same \SpecialChar LaTeX
13440 \begin_layout Plain Layout
13441 I can't imagine any good reason to do this.
13447 Each article must be included in the environment
13448 \begin_inset Quotes eld
13452 \begin_inset Quotes erd
13456 Unfortunately, this environment cannot be omitted, even if you write just
13458 Therefore, each article starts with the command
13464 and, obviously, ends with the command
13471 Although this can be implemented in \SpecialChar LyX
13472 , I didn't included it, since it looks
13473 ugly and can confuse the novice user.
13474 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13477 \begin_inset Quotes eld
13482 \begin_inset Quotes erd
13488 \begin_layout Enumerate
13489 Information given at the beginning of the article (i.
13490 \begin_inset space \thinspace{}
13494 \begin_inset space \space{}
13497 title, subtitle, author, institution, running title, running author, abstract
13498 and keywords) must be included in an environment called
13499 \begin_inset Quotes eld
13503 \begin_inset Quotes erd
13507 This is not implemented in \SpecialChar LyX
13508 , so you must enter title, subtitle etc.
13509 \begin_inset space ~
13512 between two \SpecialChar TeX
13528 \begin_layout Enumerate
13529 According to the user manual, the label of each bibliography item must be
13553 \begin_layout Standard
13558 template takes care of all these
13559 \begin_inset Quotes eld
13563 \begin_inset Quotes erd
13567 If you start a new paper using this template you don't need to do anything
13572 \begin_layout Enumerate
13573 don't delete the \SpecialChar TeX
13574 code included in the template, and
13577 \begin_layout Enumerate
13578 copy the example bibliography item included in the template and modify it
13579 as necessary to enter new bibliography items.
13582 \begin_layout Section
13586 \begin_layout Standard
13592 \begin_layout Subsection
13596 \begin_layout Standard
13597 The \SpecialChar LyX
13600 article (koma-script)
13604 report (koma-script)
13622 correspond to the \SpecialChar LaTeX
13640 \begin_inset space ~
13643 of the Koma-Script family.
13644 They are replacements for the standard document classes
13660 , resp., and fit better to European typography conventions in a number of
13664 \begin_layout Itemize
13665 Standard character size is 11pt in
13667 article (koma-script)
13671 report (koma-script)
13679 letter (koma-script)
13684 \begin_layout Itemize
13685 Headings, labels of the description environment, and a number of elements
13688 letter (koma-script)
13690 document class are set in a bold sans serif font.
13694 \begin_layout Plain Layout
13695 There is a big difference between the bold sans serif old cm fonts and new
13696 ec fonts, especially in the appearance of headings.
13697 In comparison, the ec bold sans serif fonts look a bit thin.
13698 Here the \SpecialChar LaTeX
13707 helps to produce the
13708 \begin_inset Quotes eld
13712 \begin_inset Quotes erd
13715 appearance when using the ec fonts.
13720 The numbering of chapter headings is made in the same way as the numbering
13721 of section headings, that is without the extra line
13722 \begin_inset Quotes eld
13725 Chapter\SpecialChar ldots
13727 \begin_inset Quotes erd
13731 In addition, the appearance of the headings can be modified by using a
13732 number of options (in \SpecialChar LyX
13733 to be entered in the field
13736 \begin_inset space ~
13743 Layout\SpecialChar menuseparator
13750 \begin_layout Itemize
13751 The main means in the Koma-Script document classes to design the type area
13760 (in \SpecialChar LyX
13761 to be entered in the extra class options field in the dialog
13763 Document\SpecialChar menuseparator
13767 They make a clearer modification of page margins possible as do the options
13770 Document\SpecialChar menuseparator
13777 \begin_layout Itemize
13778 The \SpecialChar LaTeX
13779 document classes of the Koma-Script family define a number of additional
13781 Those part of it which makes sense in \SpecialChar LyX
13782 is implemented in corresponding
13786 \begin_layout Standard
13787 Detailed descriptions of the \SpecialChar LaTeX
13788 document classes of the Koma-Script family
13789 can be found in the Koma-Script documentation
13800 \begin_layout Subsection
13801 article (koma-script), report (koma-script), and book (koma-script)
13804 \begin_layout Standard
13805 The document classes
13807 article (koma-script)
13811 report (koma-script)
13821 are implemented in the layout files
13834 They contain all the paragraph types of the corresponding standard document
13847 , resp., partly modified, with the exception of the \SpecialChar LyX
13852 -type, which is replaced by the new
13856 -type having the same functionality.
13861 -Type there is a number of new paragraph types added.
13868 letter (koma-script)
13873 \begin_layout Itemize
13882 : are equivalents to
13890 , resp., additionally inserting an entry in the table of contents.
13899 are not contained in
13901 article (koma-script)
13906 \begin_layout Itemize
13915 : behave exactly as
13923 , resp., additionally clearing running heads.
13928 is not contained in
13930 article (koma-script)
13936 \begin_layout Plain Layout
13949 report (koma-script)
13951 , but since this is identical to
13955 , is has not been implemented in \SpecialChar LyX
13964 \begin_layout Itemize
13969 : generates a heading directly above the following paragraph in the standard
13970 character size without affecting the structure of the document.
13973 \begin_layout Itemize
13982 are special captions which respect the different space settings needed
13983 for captions placed above or below an element (if you follow strict typographic
13984 rules, you might want to place table captions always above the table).
13985 You can also use the class option
13989 , which will switch
14002 You need at least Koma-Script version 2.8q to use this.
14005 \begin_layout Itemize
14010 : can be used to set a bonmot, e.
14011 \begin_inset space \thinspace{}
14015 \begin_inset space \space{}
14018 at the beginning of a chapter.
14019 If you use the optional argument (
14021 Insert\SpecialChar menuseparator
14023 \begin_inset space ~
14028 ), you can insert the dictum's author there.
14029 Dictum and author are separated by a line.
14030 You need at least Koma-Script version 2.8q to use this.
14035 is not contained in
14037 article (koma-script)
14042 \begin_layout Standard
14043 The following types, together with the standard types
14055 , form the title area of the document.
14056 They must be entered ahead of the first
14057 \begin_inset Quotes eld
14061 \begin_inset Quotes erd
14068 \begin_layout Plain Layout
14069 The corresponding \SpecialChar LaTeX
14070 commands must appear before the
14081 When such a type is used more than once, the latter usage overwrites the
14082 former one, that means, for every type only the latest usage is valid.
14083 The order of the different types however has, like
14095 , no effect on the appearance of the produced document.
14098 \begin_layout Itemize
14103 : produces a centered paragraph above the ordinary title (
14115 ) for the subject of the document.
14118 \begin_layout Itemize
14123 : produces a centered paragraph below the ordinary title (
14135 ) for the publishers' name.
14138 \begin_layout Itemize
14145 report (koma-script)
14151 produces a centered paragraph on its own page behind the title page, or
14154 article (koma-script)
14156 produces a centered paragraph below the ordinary title (
14172 ) for a dedication.
14175 \begin_layout Itemize
14180 : produces a left aligned paragraph above the ordinary title (
14196 ) for a document`s head.
14199 \begin_layout Itemize
14204 : produces in a double-sided print in
14206 report (koma-script)
14212 a left-aligned paragraph at the top of the title page`s back or has no
14213 effect in a single-sided print or in
14215 article (koma-script)
14220 \begin_layout Itemize
14225 : produces in a double-sided print in
14227 report (koma-script)
14233 a left-aligned paragraph at the bottom of the title page`s back or has
14234 no effect in a single-sided print or in
14236 article (koma-script)
14241 \begin_layout Itemize
14246 : produces a special
14247 \begin_inset Quotes eld
14251 \begin_inset Quotes erd
14254 page ahead of the actual document containing a paragraph without special
14258 \begin_layout Standard
14259 The layout files for the document classes
14261 article (koma-script)
14265 report (koma-script)
14271 do include the file
14276 This is thought of as a place to define your own types.
14281 in your personal layout directory and edit the file!
14284 \begin_layout Subsection
14285 letter (koma-script)
14288 \begin_layout Standard
14292 letter (koma-script)
14294 is implemented in the layout file
14299 It contains all the paragraph types of the corresponding standard document
14304 , partly modified, with the exception of the \SpecialChar LyX
14318 type, which is replaced by the new
14323 In addition, it contains, in contrast to the standard document class, the
14342 Furthermore, there are a number of new letter specific types.
14345 \begin_layout Standard
14346 The appearance of the letter produced by this document class can be controlled
14347 by a number of \SpecialChar LaTeX
14348 commands, which you can put in the \SpecialChar LaTeX
14353 \begin_layout Plain Layout
14354 For example, the standard appearance of the letter`s heading, consisting
14355 of name and address, is quite self-willed.
14357 \begin_inset Quotes eld
14361 \begin_inset Quotes erd
14364 heading is produced by the following \SpecialChar LaTeX
14365 commands in the preamble:
14368 \begin_layout LyX-Code
14378 \begin_layout LyX-Code
14394 \begin_layout LyX-Code
14404 \begin_layout LyX-Code
14424 A detailed German description of such \SpecialChar LaTeX
14425 commands can be found in the Koma-Script
14431 With it, the letter's author can produce his personal letter layout.
14434 \begin_layout Standard
14443 define the beginning of the letter and must be used in every letter.
14444 To emphasize them in the \SpecialChar LyX
14445 document class, they are marked with the letter
14455 \begin_inset space ~
14458 in the left margin.
14459 It is possible to write any number of letters in one file.
14464 type produces a new letter using the same addressee and a
14468 type produces a new addressee.
14485 are ordinary paragraph types and can also be used several times in one
14486 and the same letter.
14489 \begin_layout Itemize
14494 : produces a paragraph for the addressee and implicitly defines the beginning
14498 \begin_layout Itemize
14503 : produces a paragraph for the form of address and implicitly produces a
14507 \begin_layout Itemize
14512 : produces a paragraph for a close.
14515 \begin_layout Itemize
14520 : produces a paragraph for a postscript.
14523 \begin_layout Itemize
14528 : produces a paragraph for a distribution list.
14531 \begin_layout Itemize
14536 : produces a paragraph for enclosures.
14539 \begin_layout Standard
14580 are input types provided with a label to enter information, which will
14581 be processed by the document class.
14585 \begin_layout Plain Layout
14586 It could be seen as a matter of inconsequence, that the types
14594 described above are not such input types as well.
14595 Because of the special meaning of those types, however, I have implemented
14596 them as ordinary paragraph types with a one letter mark in the left margin.
14597 Moreover, it would affect my feeling of symmetry, if the
14605 type had such a serious different appearance.
14610 The types must be used ahead of the corresponding
14617 \begin_layout Standard
14618 An implementation of these types in a WYSIWYG fashion does not seem to make
14619 sense, because the real appearance of the produced letter does not only
14620 depend on the usage of the particular type, but also on other factors.
14621 For example, a signature entered in the
14625 type will in the standard behavior appear in the produced letter only,
14626 when in the same letter also a
14631 The entered value of the
14635 type will in the standard behavior not appear in the produced letter at
14637 The possibility to design the letter`s heading freely is already indicated
14638 in a footnote above.
14641 \begin_layout Standard
14642 The input types can also be used as empty paragraphs.
14643 This makes sense e.
14644 \begin_inset space \thinspace{}
14648 \begin_inset space \space{}
14660 type is not used at all, in the standard behavior the value of the
14664 type is used as signature, whereas if an empty
14668 type is used, no signature value is defined.
14671 \begin_layout Standard
14672 By using the input types it is possible to write a letter template, containing
14673 filled input types with your personal dates (name, address, etc.) and empty
14674 input types for other dates you want to enter.
14677 \begin_layout Itemize
14682 : sender's name, in the standard behavior appears as a centered paragraph
14683 in small caps in the letter`s heading.
14686 \begin_layout Itemize
14691 : sender's signature, in the standard behavior appears below the
14700 type is used, the value of the
14704 type appears instead.
14707 \begin_layout Itemize
14712 : sender's address, in the standard behavior appears in a centered paragraph
14713 in the letter`s heading below the sender's name.
14716 \begin_layout Itemize
14721 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
14732 \begin_layout Itemize
14737 : place of the letter`s making.
14740 \begin_layout Itemize
14745 : date of the letter`s making.
14754 , in the standard behavior, produce the place and the date in a right-aligned
14755 line below the addressee's field.
14760 type is used, neither place nor date appear, independent of the value of
14770 type is used, the date of the letter `s production is used.
14773 \begin_layout Itemize
14778 : sender`s back address, in the standard behavior appears above the addressee's
14779 field in a small sans serif font.
14782 \begin_layout Itemize
14787 : special mail information, in the standard behavior appears underlined
14788 above the addressee's field below the back address.
14791 \begin_layout Itemize
14796 : additional information, in the standard behavior appears on right side
14797 below the addressee`s field.
14800 \begin_layout Itemize
14805 : the letter's title, in the standard behavior appears in a big, bold, sans
14806 serif font above the subject.
14809 \begin_layout Itemize
14814 : the letter's subject, in the standard behavior appears in a bold font
14822 \begin_layout Standard
14843 produce a business letter like line above the
14847 line containing the fields
14848 \begin_inset Quotes eld
14852 \begin_inset Quotes erd
14856 \begin_inset Quotes eld
14860 \begin_inset Quotes erd
14864 \begin_inset Quotes eld
14868 \begin_inset Quotes erd
14872 \begin_inset Quotes eld
14876 \begin_inset Quotes erd
14880 \begin_inset Quotes eld
14884 \begin_inset Quotes erd
14888 \begin_inset Quotes eld
14892 \begin_inset Quotes erd
14896 For the date field, the value of the
14902 \begin_inset Quotes eld
14905 business letter types
14906 \begin_inset Quotes erd
14909 is used, the value of the
14913 type however does not appear, but only the \SpecialChar LaTeX
14921 The ordinary output of place and date in a right-aligned line below the
14922 addressee`s field is suppressed.
14923 The types are implemented as input types provided with a label and must
14924 be used ahead of the corresponding
14931 \begin_layout Itemize
14939 \begin_layout Itemize
14947 \begin_layout Itemize
14955 \begin_layout Itemize
14963 \begin_layout Itemize
14971 \begin_layout Subsection
14972 The new letter class: letter (koma-script v.2)
14975 \begin_layout Standard
14981 \begin_layout Standard
14982 \begin_inset VSpace medskip
14988 \begin_layout Standard
14990 Koma-Script version 2.8 has introduced a new letter class
14994 which supersedes the now unsupported
14999 It has — on the \SpecialChar LaTeX
15000 side — a completely new interface and is not compatible
15001 with the old class.
15002 Therefore, \SpecialChar LyX
15003 supports both, though it is recommended you use the new class.
15006 \begin_layout Standard
15007 This class covers the same functionality as
15009 letter (koma-script),
15012 The basic items are
15016 (receiver's address, same as
15020 in the old layout),
15033 will start a new letter (i.
15034 \begin_inset space \thinspace{}
15038 \begin_inset space \space{}
15041 you can write several letters per document).
15042 New elements are sender's
15058 and the possibility to use a
15064 Insert\SpecialChar menuseparator
15070 \begin_layout Standard
15071 The biggest improvement is, though, that the letter's layout is configurable
15072 to meet almost any needs.
15073 This can be done via the preamble or with a special style file (Letter
15074 Class Option, extension
15078 ), that will be read in as a class option.
15082 \begin_layout Plain Layout
15083 The KOMA package comes with some default
15088 There is, for instance, a
15092 file that follows german typesetting rules, or a
15096 that provides the default layout of the old
15101 The latter can be loaded with the class option
15110 ayout\SpecialChar menuseparator
15115 ocument\SpecialChar menuseparator
15127 template that is included in \SpecialChar LyX
15129 A detailed description is to be found in the Koma-Script documentation
15137 \begin_layout Subsection
15141 \begin_layout Standard
15142 Visualizing the Koma-Script document classes in \SpecialChar LyX
15143 , the \SpecialChar LyX
15144 internals cause some
15148 \begin_layout Itemize
15149 The chapter number of a
15153 type appears on a line of its own above the chapter heading instead of
15154 appearing in the same line ahead of it.
15155 The cause for that is the \SpecialChar LyX
15156 internal behavior for the labeltype
15160 in the layout file.
15163 \begin_layout Itemize
15164 The headings of the types
15172 are only put in the
15173 \begin_inset Quotes eld
15177 \begin_inset Quotes erd
15181 table of contents, but not in the \SpecialChar LyX
15182 table of contents (
15184 Document\SpecialChar menuseparator
15186 \begin_inset space ~
15190 \begin_inset space ~
15198 \begin_layout Itemize
15199 The paragraphs in a
15203 document class appear in a skip separation mode, not indented.
15204 This is the standard behavior, no special \SpecialChar LaTeX
15205 commands are needed for that.
15208 Document\SpecialChar menuseparator
15211 dialog the corresponding radio button indicates
15220 value always has the effect that extra \SpecialChar LaTeX
15221 commands are inserted in the document
15222 to produce the gap, which is not what is wanted in this case.
15225 \begin_layout Section
15229 \begin_layout Standard
15235 \begin_layout Subsection
15239 \begin_layout Standard
15240 Memoir is a very powerful and constantly evolving class.
15241 It has been designed with regard to fictional and non-fictional literature.
15242 Its aim is to let the user have maximum control over the typesetting of
15244 Memoir is based on the standard book class, but it can also emulate the
15245 article class (see below).
15248 \begin_layout Standard
15249 Peter Wilson, the developer of Memoir, is known as the author of lots of
15250 useful packages in the \SpecialChar LaTeX
15252 Most of them have been merged with Memoir.
15253 Therefore, it is much easier to layout the table of contents, appendices,
15254 chapter designs and such.
15256 , though, does not support all of these goodies natively.
15257 Some of them might be added to forthcoming releases
15261 \begin_layout Plain Layout
15262 You are invited to send suggestions to
15263 \begin_inset Flex URL
15266 \begin_layout Plain Layout
15268 lyx-devel@lists.lyx.org
15278 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15280 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15282 commands (\SpecialChar TeX
15287 \begin_layout Plain Layout
15292 \begin_layout Plain Layout
15302 \begin_inset space ~
15306 \begin_inset CommandInset ref
15308 reference "sec:Inserting-TeX-Code"
15318 In this section, we can only list those features that are natively supported
15319 by \SpecialChar LyX
15321 For detailed descriptions (and for the rest of features) we recommend you
15322 have a look at the detailed manual of the Memoir class
15326 \begin_layout Plain Layout
15331 \begin_layout Plain Layout
15341 \begin_inset Flex URL
15344 \begin_layout Plain Layout
15346 CTAN:/macros/latex/memoir/memman.pdf
15356 , which is not only a user guide for the class, but also both a comprehensive
15357 description on good typesetting and a superb example for good typesetting
15361 \begin_layout Subsection
15362 Basic features and restrictions
15365 \begin_layout Standard
15366 Memoir supports basically all features of the standard book classes.
15367 There are, however, some differences, as follows:
15370 \begin_layout Description
15372 \begin_inset space ~
15375 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15378 \begin_layout Description
15380 \begin_inset space ~
15383 style: The fancy page style is not supported, due to a command clash between
15384 Memoir and the fancyhdr package (they both define a command with the same
15385 name, which confuses \SpecialChar LaTeX
15387 Instead, Memoir comes with a number of its own page styles (see
15389 Layout\SpecialChar menuseparator
15390 Document\SpecialChar menuseparator
15392 \begin_inset space ~
15398 If you want to use these for the chapter pages, you have to use the command
15405 in the main text or in preamble (e.
15406 \begin_inset space \thinspace{}
15410 \begin_inset space \space{}
15417 chapterstyle{companion}
15422 \begin_layout Description
15423 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15424 optional argument in the standard classes.
15425 With this, you can specify an alternative version of the title for the
15426 table of contents and the headers (for instance, if the title is too long).
15427 In \SpecialChar LyX
15428 , you can do this via
15430 Insert\SpecialChar menuseparator
15432 \begin_inset space ~
15437 at the beginning of a chapter/section.
15438 Memoir features a second optional argument and thus separates the table
15439 of contents from the header.
15440 You can define three variants of a title with this: one for the main text,
15441 one for the table of contents, and one for the headers.
15442 Simply insert two optional arguments if you need this feature, the first
15443 one containing the short title for the Table of Contents, the second one
15444 containing an alternative short title for the headers.
15447 \begin_layout Description
15448 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15449 of contents, the list of figures and the list of table start a new page
15451 Memoir does not follow this route.
15452 You have to insert a page break yourself, if you want to have one.
15455 \begin_layout Description
15456 Titlepage: For some unknown reason, Memoir uses pagination on the title
15457 page (in the standard classes, title pages are
15458 \begin_inset Quotes eld
15462 \begin_inset Quotes erd
15466 If you want an empty title page, type
15470 aliaspagestyle{title}{empty}
15475 \begin_layout Description
15476 Article: With the class option
15482 Layout\SpecialChar menuseparator
15483 Document\SpecialChar menuseparator
15485 \begin_inset space ~
15490 ), you can emulate article style.
15491 That is, counters (footnotes, figures, tables etc.) will not be reset on
15492 new chapters, chapters don't start a new page (but are—in contrary to
15493 \begin_inset Quotes eld
15497 \begin_inset Quotes erd
15500 article classes—still allowed), parts, though, use their own page, as in
15504 \begin_layout Description
15505 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15506 font commands, which have been used in the old \SpecialChar LaTeX
15508 \begin_inset space \thinspace{}
15512 \begin_inset space \space{}
15528 It produces an error and stops \SpecialChar LaTeX
15529 whenever such a command appears.
15534 reallows the commands and spits out warnings instead (which does at least
15535 not stop \SpecialChar LaTeX
15537 Since a lot of packages and particularly Bib\SpecialChar TeX
15538 style files are still using
15539 those commands, we have decided to use this option by default.
15542 \begin_layout Subsection
15546 \begin_layout Standard
15547 We will only describe the features supported by \SpecialChar LyX
15548 (which is not much currently).
15549 Please consult the Memoir manual
15553 \begin_layout Plain Layout
15558 \begin_layout Plain Layout
15568 \begin_inset Flex URL
15571 \begin_layout Plain Layout
15573 CTAN:/macros/latex/memoir/memman.pdf
15586 \begin_layout Description
15587 Abstract: You may wonder why an abstract is an extra feature.
15588 Well, it is in book class.
15589 Usually books don't have abstracts.
15590 Memoir, however, has.
15591 You can use it wherever and how often you like.
15594 \begin_layout Description
15595 Chapterprecis: You may know this older typesetting style: The contents of
15596 a chapter are summarized below the title and also in the table of contents
15598 \begin_inset space \thinspace{}
15602 \begin_inset space \space{}
15607 Our hero arrives in Troia; he loses some friends; he finds others
15610 Chapterprecis does exactly this.
15611 It is therefore only sensible below a chapter.
15614 \begin_layout Description
15615 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15616 The epigraph environment provides an elegant way of typesetting such a
15618 The motto itself (text) and its author (source) are divided by a short
15620 Unfortunately, we have to fool \SpecialChar LyX
15621 a bit here again, since the environment
15622 needs two arguments (text and source).
15623 In this case, we have to use curly brackets (in \SpecialChar TeX
15624 mode) between the two
15635 <author of the slogan>.
15638 \begin_layout Description
15639 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15640 complex figurative poems).
15642 can only support a few of them.
15643 One is poemtitle, which is a centered title for poems, which will also
15644 be added to the table of contents (verse is the standard environment for
15646 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
15648 because they have to be nested inside regular verse environments, which
15649 is not possible with \SpecialChar LyX
15653 \begin_layout Description
15654 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15657 \begin_layout Section
15658 Article (mwart), book (mwbk) and report (mwrep)
15659 \begin_inset Argument status
15662 \begin_layout Plain Layout
15675 \begin_layout Standard
15681 \begin_layout Standard
15682 The \SpecialChar LyX
15699 correspond to the \SpecialChar LaTeX
15713 They are replacements for the standard document classes
15725 , resp., and fit better to Polish typography conventions in a number of points.
15729 \begin_layout Standard
15733 \begin_layout Itemize
15734 Unnumbered titles (with star, e.
15735 \begin_inset space \thinspace{}
15739 \begin_inset space \space{}
15746 ) are added into table of contents,
15749 \begin_layout Itemize
15750 Additional page styles:
15751 \begin_inset Separator parbreak
15758 \begin_layout Description
15759 uheadings header with separated lines,
15762 \begin_layout Description
15763 myheadings custom header, contents headers via commands:
15778 \begin_layout Description
15779 myuheadings custom header with separated lines,
15782 \begin_layout Description
15783 outer page number is placed on outer side of page
15787 \begin_layout Itemize
15789 \begin_inset Separator parbreak
15796 \begin_layout Description
15797 rmheadings serif titles — default,
15800 \begin_layout Description
15801 sfheadings sansserif titles,
15804 \begin_layout Description
15805 authortitle on title page first placed is author next title — default,
15808 \begin_layout Description
15809 titleauthor on title page first placed is title next author,
15812 \begin_layout Description
15813 withmarginpar reserve place on page for margins.
15817 \begin_layout Section
15821 \begin_layout Standard
15826 provides an alternative to the standard
15831 It provides similar functionality, but you might prefer this layout with
15832 sans serif sections, headings, and more.
15835 \begin_layout Section
15836 Rev\SpecialChar TeX
15840 \begin_layout Standard
15846 \begin_layout Standard
15847 \begin_inset VSpace bigskip
15853 \begin_layout Standard
15858 \begin_inset space ~
15863 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
15865 \begin_inset Formula $\beta$
15868 release of May, 1999) class.
15871 \begin_layout Standard
15877 textclass, which works with Rev\SpecialChar TeX
15879 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
15881 That means that it doesn't interact very well with \SpecialChar LyX
15882 , which requires \SpecialChar LaTeX2e
15884 it has been kludged to work.
15885 Since Rev\SpecialChar TeX
15886 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
15891 Rev\SpecialChar TeX
15893 \begin_inset space ~
15898 textclass should also be pretty easy to use.
15901 \begin_layout Standard
15902 These documents are supposed to be used in
15906 to the Rev\SpecialChar TeX
15907 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
15909 and assume you'll know what to put in the preamble if necessary.
15912 \begin_layout Subsection
15916 \begin_layout Standard
15917 All you need to do is install Rev\SpecialChar TeX
15918 4, as described in the package's README
15920 The package can be found at The Rev\SpecialChar TeX
15922 \begin_inset Flex URL
15925 \begin_layout Plain Layout
15927 http://publish.aps.org/revtex4/
15933 Install it somewhere that \SpecialChar LaTeX
15935 Test it by trying to \SpecialChar LaTeX
15936 a short Rev\SpecialChar TeX
15937 4 document in some random directory (i.
15938 \begin_inset space \thinspace{}
15942 \begin_inset space \space{}
15945 not the directory where you installed the class file.) Then, if you reconfigure
15947 , it will find the class file and let you use the Rev\SpecialChar TeX
15951 \begin_layout Standard
15952 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
15961 \begin_inset space ~
15966 template, found in the templates directory.
15969 \begin_layout Subsection
15973 \begin_layout Standard
15974 Optional arguments to
15981 \begin_inset Quotes eld
15985 \begin_inset Quotes erd
15989 \begin_inset Quotes eld
15993 \begin_inset Quotes erd
16003 \begin_inset space ~
16011 \begin_inset space ~
16017 Remember that in Rev\SpecialChar TeX
16018 , at least one optional argument is required!
16021 \begin_layout Standard
16022 Other preamble matter, like
16029 \begin_inset space ~
16036 \begin_inset space ~
16041 dialog, also as usual.
16044 \begin_layout Subsection
16048 \begin_layout Standard
16049 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16051 For example, the Email layout corresponds to
16058 Note that (at least as of Rev\SpecialChar TeX
16067 layouts are exactly equivalent, so you shouldn't need to use both.
16071 \begin_layout Plain Layout
16072 In case you're curious, both were included so that
16076 would be able to translate both
16096 \begin_layout Subsection
16100 \begin_layout Standard
16101 There are a couple of important unique aspects of Rev\SpecialChar TeX
16102 4 which might cause
16103 bugs that will be even more confusing in \SpecialChar LyX
16107 \begin_layout Standard
16108 In Rev\SpecialChar TeX
16126 The \SpecialChar LyX
16127 equivalent is that there is a separate Thanks layout.
16132 write footnotes in the
16136 layout, or weird things may happen.
16137 See the Rev\SpecialChar TeX
16138 4 documentation for more details.
16141 \begin_layout Standard
16145 \begin_inset space ~
16153 \begin_inset space ~
16162 layouts must be placed
16170 layout and the corresponding
16187 , the \SpecialChar LaTeX
16191 \begin_layout Subsection
16195 \begin_layout Standard
16196 The main problem with this layout is that you can't use the optional arguments
16197 to layouts like Email and Title.
16198 (The problem is not unique to this layout; you can't use optional arguments
16199 to the Section layouts either.) This means that after you export that file
16200 to \SpecialChar LaTeX
16201 (which you'll need to do eventually to send it in to APS), you'll need
16202 to edit the \SpecialChar LaTeX
16203 file with a text editor to add the optional arguments to set,
16205 \begin_inset space \thinspace{}
16209 \begin_inset space \space{}
16212 the running title for the page headers.
16213 Lacking these layouts makes the
16219 (and the equivalent
16225 ) useless, so the corresponding layouts don't exist, and will have to be
16230 \begin_layout Plain Layout
16235 actually, \SpecialChar LyX
16236 1.3.0 supports some forms of optional arguments, but this layout
16237 has not been updated yet to take advantage of it.
16245 \begin_layout Section
16246 Springer Journals (
16253 \begin_layout Standard
16259 \begin_layout Subsection
16263 \begin_layout Standard
16264 These are the layout files for some of the journal formats used by Springer
16265 Verlag and listed on
16266 \begin_inset Flex URL
16269 \begin_layout Plain Layout
16271 http://www.springer.de/author/tex/help-journals.html
16276 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16278 It is a modular system: the things common to all journals are implemented
16283 , which journal-specific layout files (such as, e.
16284 \begin_inset space \thinspace{}
16288 \begin_inset space \space{}
16295 for Journal of Geodesy) can include.
16298 \begin_layout Standard
16299 This means that implementing support for any other Springer journal on this
16300 list is as simple as writing your own
16308 file following the outline given in
16316 \begin_layout Standard
16317 It is reasonably well tested only for the Journal of Geodesy.
16326 come with the standard \SpecialChar LyX
16328 Install the relevant class file (downloaded from Springer) in a proper
16329 directory, reconfigure \SpecialChar LaTeX
16330 (in the te\SpecialChar TeX
16335 , as root if necessary — doesn't \SpecialChar LyX
16336 take care of this?), reconfigure \SpecialChar LyX
16341 \begin_layout Subsection
16345 \begin_layout Standard
16346 A large number of theorem-like styles —
16358 \begin_layout Standard
16361 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16362 _Title, Author_Running, Institute,
16363 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16366 See the Springer class file documentation for details.
16369 \begin_layout Subsection
16373 \begin_layout Itemize
16385 \begin_layout Itemize
16388 Probability Theory and Related Fields
16394 — Jean-Marc Lasgouttes
16397 \begin_layout Standard
16398 Add your own, it isn't so hard!
16401 \begin_layout Subsection
16405 \begin_layout Standard
16406 These files are partly based on the older
16410 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16412 file from Springer.
16417 layout, are now defunct.
16418 Jean-Marc Lasgouttes helped out big in making me find my way around the
16420 layout file mechanism.
16423 \begin_layout Subsection
16427 \begin_layout Standard
16429 But probably less than in the old hacked-\SpecialChar LaTeX
16437 \begin_layout Standard
16439 \begin_inset space \thinspace{}
16442 g.: does not display the number for theorem-like layouts, just #.
16445 \begin_layout Section
16448 Sli\SpecialChar TeX
16452 \begin_inset CommandInset label
16461 \begin_layout Standard
16469 \begin_layout Subsection
16473 \begin_layout Standard
16474 This section describes how to use \SpecialChar LyX
16475 to make slides for overhead projectors.
16476 There are two document classes that can do this: the default slides class
16479 Foil\SpecialChar TeX
16483 This section documents the former.
16486 \begin_layout Standard
16487 I'm going to say this again, nice and clear, so that there's no misunderstanding
16491 \begin_layout Standard
16492 \begin_inset VSpace bigskip
16498 \begin_layout Standard
16502 This section documents the class
16503 \begin_inset Quotes eld
16511 \begin_inset Quotes erd
16519 \begin_layout Standard
16520 \begin_inset VSpace bigskip
16526 \begin_layout Standard
16527 If you're looking for the documentation for
16528 \begin_inset Quotes eld
16533 slides (Foil\SpecialChar TeX
16537 \begin_inset Quotes erd
16540 , check out section
16541 \begin_inset space ~
16545 \begin_inset CommandInset ref
16547 reference "sec:foiltex"
16557 \begin_inset Quotes eld
16562 slides (Foil\SpecialChar TeX
16566 \begin_inset Quotes erd
16569 ] is actually somewhat better than the default
16577 \begin_layout Plain Layout
16579 or so I've been told repeatedly by its advocates.
16580 Having never used it, I have no idea if this claim is true or not.
16585 which this section documents.
16588 \begin_layout Standard
16589 This class is the \SpecialChar LaTeX2e
16590 improvement of the old
16592 Sli\SpecialChar TeX
16596 Every \SpecialChar LaTeX2e
16597 distribution includes this class [which I'll just refer to as
16598 \begin_inset Quotes eld
16606 \begin_inset Quotes erd
16609 from now on], so you're bound to have it.
16610 As I noted earlier, there are other classes, such as
16614 , which also produce slides for overhead projectors and do a better job
16616 However, there are some things which
16620 can do which the others can't, such as generate overlays.
16621 Read on to learn more!
16624 \begin_layout Subsection
16626 \begin_inset CommandInset label
16628 name "sec:slidesetup"
16635 \begin_layout Standard
16636 Obviously, to use this document class, you need to select
16637 \begin_inset Quotes eld
16645 \begin_inset Quotes erd
16648 from the class list in the
16650 Document\SpecialChar menuseparator
16654 There are some other special things you should know about this class:
16657 \begin_layout Itemize
16658 Don't bother changing the options
16663 They're not supported by the
16670 \begin_layout Itemize
16674 \begin_inset space ~
16679 behaves a bit differently for this class.
16680 The possible choices and what they do are as follows:
16681 \begin_inset Separator parbreak
16688 \begin_layout Description
16693 The final output contains page numbers in the lower right corner.
16696 \begin_layout Description
16705 , but also prints out any time markers you've put in.
16706 This is the default.
16709 \begin_layout Description
16714 The final output contains no page numbers, time markers, or alignment markers.
16718 \begin_layout Itemize
16723 class has an extra option:
16729 \begin_inset Quotes eld
16737 \begin_inset Quotes erd
16740 in the extra class options.
16741 \begin_inset Separator parbreak
16748 \begin_layout Standard
16749 Using this options allows you to add time markers to
16755 \begin_inset space ~
16759 \begin_inset CommandInset ref
16761 reference "sec:slideNote"
16769 \begin_layout Standard
16770 You can also use the template file
16771 \begin_inset Quotes eld
16779 \begin_inset Quotes erd
16782 to automatically set up a document to use the
16788 File\SpecialChar menuseparator
16790 \begin_inset space ~
16794 \begin_inset space ~
16799 to open your new document].
16800 The template file also contains some examples of the special paragraph
16801 environments used by this class.
16802 I'll describe those next.
16805 \begin_layout Subsection
16806 Paragraph Environments
16809 \begin_layout Subsubsection
16810 Supported Environments
16813 \begin_layout Standard
16814 The first thing you'll notice when you start up a new
16818 document is the font size and type: it's the equivalent of the size
16819 \begin_inset Quotes eld
16827 \begin_inset Quotes erd
16833 \begin_inset space ~
16839 This is also what's used in the output.
16841 \begin_inset Quotes eld
16845 \begin_inset Quotes erd
16848 to remind you that this is a slide.
16849 Your final slides will use a larger font; ergo, you'll have less space.
16850 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
16853 \begin_layout Standard
16854 The next thing that becomes obvious is the changes to the paragraph environment
16855 pull-down box [at the far-left end of the toolbar].
16856 Most of the paragraph environments you're used to seeing are missing.
16857 There are also five new ones.
16862 class itself only supports certain paragraph environments:
16865 \begin_layout Itemize
16871 \begin_layout Itemize
16877 \begin_layout Itemize
16883 \begin_layout Itemize
16889 \begin_layout Itemize
16895 \begin_layout Itemize
16901 \begin_layout Itemize
16907 \begin_layout Itemize
16913 \begin_layout Itemize
16919 \begin_layout Itemize
16926 \begin_layout Itemize
16932 \begin_layout Standard
16933 All of the other standard environments, including the section-heading environmen
16934 ts, aren't used in the
16941 \begin_layout Standard
16942 On the other hand, you'll notice the following new environments:
16945 \begin_layout Itemize
16951 \begin_layout Itemize
16957 \begin_layout Itemize
16963 \begin_layout Itemize
16969 \begin_layout Itemize
16975 \begin_layout Standard
16976 These five are kind of quirky, due to a
16977 \begin_inset Quotes eld
16981 \begin_inset Quotes erd
16984 in \SpecialChar LyX
16986 You see, \SpecialChar LyX
16987 doesn't permit you to nest any other paragraph environment into
16988 an empty environment.
16989 Now, that's fine and dandy, but it means that you wouldn't be able to start
16990 a slide with anything except plain text.
16991 To deal with this, I've performed a little
16992 \begin_inset Quotes eld
16997 \begin_inset Quotes erd
17003 \begin_layout Subsubsection
17004 Quirks of the New Environments
17005 \begin_inset CommandInset label
17007 name "sec:slideQuirk"
17014 \begin_layout Standard
17015 All five of the new paragraph environments are somewhat quirky due to inherent
17016 limitiations in the current version of \SpecialChar LyX
17018 As I just mentioned, \SpecialChar LyX
17019 forbids environments that begin with another environment.
17020 To get around this, the
17024 environment isn't a paragraph environment as described in the
17032 \begin_layout Standard
17033 You should consider
17046 \begin_inset Quotes eld
17049 pseudo-environments.
17050 \begin_inset Quotes erd
17053 They look like a section heading or a
17054 \begin_inset Quotes eld
17062 \begin_inset Quotes erd
17065 but really begin a [and, if necessary, end the previous] paragraph environment.
17075 \begin_inset Quotes eld
17079 \begin_inset Quotes erd
17082 These two perform some action.
17085 \begin_layout Standard
17086 A common feature of all five environments,
17106 , is a rather long-ish label.
17107 The text following this label — ordinarily the contents of the paragraph
17108 environment — is utterly irrelevant for
17130 completely ignores it.
17131 In fact, you can leave these five environments completely empty.
17135 \begin_layout Standard
17140 to put any text after the rather long-ish label, you might want to.
17141 This could be a short description of the contents of the
17146 In that case, enter your descriptive comment and hit
17150 as you normally would.
17153 \begin_layout Standard
17154 If, on the other hand, you don't want to enter any descriptive text, you'll
17155 hit another \SpecialChar LyX
17158 , like nature, abhors a vacuum, and will not let you start a new paragraph
17159 environment until you put something in the old one.
17163 \begin_layout Itemize
17164 Start entering the text that will
17192 \begin_layout Itemize
17193 Now move to the beginning of that paragraph.
17197 \begin_layout Itemize
17206 \begin_layout Itemize
17207 Finally, change this new, empty paragraph to a
17231 \begin_layout Standard
17232 Some future version of \SpecialChar LyX
17233 will, hopefully, resolve this quirkiness\SpecialChar ldots
17237 \begin_layout Subsection
17238 Making a Presentation with
17251 \begin_layout Subsubsection
17259 \begin_layout Standard
17260 If you're expecting this section to teach you how to actually make a presentatio
17261 n, you'll be sorely disappointed.
17262 Naturally, I'll describe all of the ways the
17266 class can assist you in preparing the materials for a presentation.
17267 Filling in the contents, however, is up to you.
17272 the \SpecialChar LyX
17276 \begin_layout Standard
17281 environment [in the manner described in section
17282 \begin_inset space ~
17286 \begin_inset CommandInset ref
17288 reference "sec:slideQuirk"
17292 ] tells \SpecialChar LyX
17293 to begin a new slide [duh].
17294 The label for this environment/
17295 \begin_inset Quotes erd
17299 \begin_inset Quotes erd
17303 \begin_inset Quotes eld
17307 \begin_inset Quotes erd
17310 in cool blue, followed by the label,
17311 \begin_inset Quotes eld
17315 \begin_inset Quotes erd
17319 Any text or paragraph environments that follow this one go on the new slide.
17323 \begin_layout Standard
17324 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17326 (this can be specified in the
17331 In fact, you'll want to, once you finish entering the contents of one slide.
17332 If you've entered more text than can physically fit on a slide, the extra
17333 overflows onto a new slide.
17334 I don't recommend doing this, however, since the overflow slide won't have
17335 any page number on it.
17336 Furthermore, it may interfere with any
17340 you've made to accompany the oversized
17347 \begin_layout Standard
17356 environments work the same way as the
17361 They both create an
17362 \begin_inset Quotes eld
17366 \begin_inset Quotes erd
17369 followed by a label [
17370 \begin_inset Quotes eld
17374 \begin_inset Quotes erd
17378 \begin_inset Quotes eld
17382 \begin_inset Quotes erd
17386 The color is a stunning magenta instead of blue, and the
17387 \begin_inset Quotes eld
17391 \begin_inset Quotes erd
17394 will look different, in style and in length.
17395 The label fonts of all three also differ from one another.
17398 \begin_layout Standard
17403 , if the contents of a
17411 exceed the physical size of a slide or sheet of paper, the extra will overflow
17413 Again, you should avoid this.
17414 It defeats the whole purpose of
17425 \begin_layout Subsubsection
17435 \begin_layout Standard
17440 is a slide that sits atop another slide.
17441 Perhaps you wish to discuss a figure on the main
17445 before displaying the text associated with it.
17446 One way to accomplish this is tape a flap of dark paper over the part of
17451 you want to display later.
17452 This method fails, however, if you wish to overlap one graph with another,
17454 You would then have to fumble while speaking to align the two separate,
17459 s to align the two graphs.
17464 environment in both cases makes life much easier.
17467 \begin_layout Standard
17472 receives the page number of its
17473 \begin_inset Quotes eld
17477 \begin_inset Quotes erd
17485 \begin_inset Quotes eld
17493 \begin_inset Quotes erd
17500 \begin_layout Plain Layout
17501 Presumably, mutliple
17506 \begin_inset Quotes eld
17514 \begin_inset Quotes erd
17518 \begin_inset Quotes eld
17526 \begin_inset Quotes erd
17530 \begin_inset Quotes eld
17538 \begin_inset Quotes erd
17542 \begin_inset space ~
17545 appended to the page number of the parent
17555 Clearly, you want the contents of both the
17563 to each fit on a single physical slide! You should probably consider an
17569 \begin_inset Quotes eld
17573 \begin_inset Quotes erd
17581 Indeed, the \SpecialChar LyX
17586 class provides a visual cue for this: the label at the start of an
17590 is shorter than that at the start of a
17595 Lastly, when you generate printable output, you'll find alignment markers
17596 in all four corners of both the
17600 page and its parent
17605 These will assist you in lining up the two physical slides.
17608 \begin_layout Standard
17609 The major problem in overlaying two slides is aligning the contents of the
17610 two transparencies.
17611 How much space should you leave for that graph on the second slide? Worse
17612 still, what if you want a graph and a sentence on second slide, but there
17613 is text on the main transparency that goes in between them? You could try
17614 and insert vertical space of the right size.
17615 The better way is to use
17626 \begin_layout Standard
17627 As their names imply,
17635 are two command-like paragraph environments that make all subsequent text
17636 invisible and visible, respectively.
17638 \begin_inset space ~
17642 \begin_inset CommandInset ref
17644 reference "sec:slideQuirk"
17648 that you don't place anything
17652 these two environments, however.
17657 , it inserts a centered, sky-blue label into the page reading
17658 \begin_inset Quotes eld
17661 <Invisible Text Follows>
17662 \begin_inset Quotes erd
17666 For paragraphs following this label, the parts of the
17674 ; it doesn't matter which] where they would be contain instead blank space.
17678 \begin_layout Standard
17683 , the corresponding centered label is
17684 \begin_inset Quotes eld
17687 <Visible Text Follows>
17688 \begin_inset Quotes erd
17692 Paragraphs following this label behave normally.
17693 Note that the beginning of a new
17705 automatically shuts off an
17710 It's therefore not necessary to use
17721 \begin_layout Standard
17722 By now, it should be obvious how to create overlay transparencies using
17723 the proper combination of
17742 \begin_layout Enumerate
17747 , including everything that will appear on it, whether on the main slide
17755 \begin_layout Enumerate
17756 Before each figure or paragraph that will appear only on the
17765 If necessary, insert a
17769 environment after the
17776 \begin_layout Enumerate
17781 immediately following the
17788 \begin_layout Enumerate
17789 Copy the contents of this
17800 \begin_layout Enumerate
17805 , change all of the
17816 \begin_layout Standard
17818 You've just made an
17825 \begin_layout Standard
17826 There's one problem with the way I've designed the \SpecialChar LyX
17831 class: you can't make text in the middle of a paragraph invisible, nor
17832 make text in the middle of an invisible paragraph visible again.
17833 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
17838 \begin_layout Plain Layout
17839 The commands of interest are:
17842 \begin_layout Itemize
17847 invisible \SpecialChar ldots
17851 \begin_layout Itemize
17856 visible \SpecialChar ldots
17860 \begin_layout Plain Layout
17862 and need to be marked as \SpecialChar TeX
17865 \begin_inset Quotes eld
17869 \begin_inset Quotes erd
17872 you wish to change goes in between the brackets [and after the
17885 If you don't know how to mark text as \SpecialChar TeX
17886 , see the appropriate section of
17899 \begin_layout Subsubsection
17909 \begin_inset CommandInset label
17911 name "sec:slideNote"
17918 \begin_layout Standard
17927 is associated with a
17928 \begin_inset Quotes eld
17932 \begin_inset Quotes erd
17940 Here, too, the \SpecialChar LyX
17945 class provides visual cues.
17950 is shorter than that of a
17954 [yet longer than that of an
17958 ] and, like the label of an
17962 is shockingly magenta.
17963 Additionally, the printed
17967 has the page number of its
17968 \begin_inset Quotes eld
17972 \begin_inset Quotes erd
17980 \begin_inset Quotes eld
17988 \begin_inset Quotes erd
17992 \begin_inset Quotes eld
18000 \begin_inset Quotes erd
18004 \begin_inset Quotes eld
18012 \begin_inset Quotes erd
18016 You can have multiple
18020 s associated with a single
18032 , you'll probably want to break up long
18036 s so that they fit on a single sheet of paper.
18039 \begin_layout Standard
18044 is obvious: it contains anything additional you might want to say about
18050 It could also be used as a sheet of reminders for a particular
18055 In the case of the latter, you might want to make use of time markers.
18056 Currently, the \SpecialChar LyX
18062 \begin_inset Quotes eld
18066 \begin_inset Quotes erd
18069 support for time markers, a
18071 Sli\SpecialChar TeX
18075 So, you'll have to resort to using the \SpecialChar LaTeX
18079 \begin_layout Standard
18080 To use time markers, you'll need to specify the extra class option
18081 \begin_inset Quotes eld
18089 \begin_inset Quotes erd
18093 \begin_inset space ~
18097 \begin_inset CommandInset ref
18099 reference "sec:slidesetup"
18104 This option turns on timing marks, which will appear in the lower-left-hand
18110 To set what appears in the time marker, you use the \SpecialChar LaTeX
18112 \begin_inset Quotes eld
18122 \begin_inset Quotes erd
18126 \begin_inset Quotes eld
18136 \begin_inset Quotes erd
18140 The arguments of both commands are time measured in seconds.
18142 \begin_inset Quotes eld
18152 \begin_inset Quotes erd
18155 sets the time marker to a given time.
18157 \begin_inset Quotes eld
18167 \begin_inset Quotes erd
18170 increments the time marker by the specified amount.
18171 Using time markers and
18175 s in this fashion, you can remind yourself how much time to spend on a particula
18183 \begin_layout Standard
18184 There's one last feature to describe.
18185 Clearly, you'd like to print out all of your
18193 s on transparencies while printing all of your
18210 with which it is associated.
18211 What's a person to do?
18214 \begin_layout Standard
18215 Luckily, there are two \SpecialChar LaTeX
18216 commands that allow you to select what to print
18218 Both must be placed into the preamble of your document.
18220 \begin_inset Quotes eld
18232 \begin_inset Quotes erd
18235 will cause the output to contain only the
18244 Correspondingly, the command
18245 \begin_inset Quotes eld
18257 \begin_inset Quotes erd
18260 prevents the output of anything but
18265 I'd advise placing both commands in the preamble and initially comment
18267 You can then preview your entire presentation as you write.
18268 When you're done writing, you can then uncomment one of the two to select
18269 what you want to print.
18270 I like to uncomment
18271 \begin_inset Quotes eld
18283 \begin_inset Quotes erd
18286 , print to a file with
18287 \begin_inset Quotes eld
18295 \begin_inset Quotes erd
18298 in its name, comment it back out, then uncomment
18299 \begin_inset Quotes eld
18311 \begin_inset Quotes erd
18315 \begin_inset Quotes eld
18323 \begin_inset Quotes erd
18327 I can then send either file to a printer, loading transparencies or plain
18328 paper as appropriate.
18331 \begin_layout Standard
18332 You can also provide other arguments to the
18333 \begin_inset Quotes eld
18343 \begin_inset Quotes erd
18347 \begin_inset Quotes eld
18357 \begin_inset Quotes erd
18361 See a good \SpecialChar LaTeX
18365 \begin_layout Subsection
18370 Class Template File
18373 \begin_layout Standard
18374 I have also provided a template file,
18375 \begin_inset Quotes eld
18383 \begin_inset Quotes erd
18391 To use it, begin your new presentation with
18396 ile\SpecialChar menuseparator
18398 \begin_inset space ~
18402 \begin_inset space ~
18412 Your new \SpecialChar LyX
18413 presentation file will contain an example
18434 additionally contain an example of the use of
18443 Lastly, the preamble will contain:
18446 \begin_layout LyX-Code
18447 % Uncomment to print out only slides and overlays
18450 \begin_layout LyX-Code
18454 \begin_layout LyX-Code
18460 \begin_inset Newline newline
18466 \begin_layout LyX-Code
18467 % Uncomment to print out only notes
18470 \begin_layout LyX-Code
18474 \begin_layout LyX-Code
18482 \begin_layout Standard
18483 One final thing: I created this class to support the \SpecialChar LaTeX2e
18485 \begin_inset Quotes eld
18490 Sli\SpecialChar TeX
18494 \begin_inset Quotes erd
18497 class, one of the built-in \SpecialChar LaTeX2e
18499 Neither I nor the rest of the \SpecialChar LyX
18500 Team endorse or oppose the use of this built-in
18502 It's here if you want it or need it.
18503 There exist other \SpecialChar LaTeX2e
18504 classes for creating presentations, such as the
18509 \begin_inset space ~
18513 \begin_inset CommandInset ref
18515 reference "sec:foiltex"
18520 \begin_inset Quotes eld
18528 \begin_inset Quotes erd
18531 package [present on some \SpecialChar TeX
18533 The latter is not yet supported under \SpecialChar LyX
18538 \begin_layout Plain Layout
18539 Perhaps you can take on the task\SpecialChar ldots
18545 I know nothing about these other classes.
18546 Try them out to see what sort of alternative they provide.
18549 \begin_layout Chapter
18551 Features needing Extra Software
18554 \begin_layout Section
18555 Checking \SpecialChar TeX
18559 \begin_layout Standard
18565 \begin_layout Subsection
18569 \begin_layout Standard
18578 \begin_layout Plain Layout
18583 is not yet available when you are using the \SpecialChar LaTeX
18584 distribution MiK\SpecialChar TeX
18590 , you'll find in the
18597 \begin_inset space ~
18608 \begin_inset Newline newline
18612 \begin_inset CommandInset href
18614 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18621 \begin_layout Standard
18624 Chk\SpecialChar TeX
18627 package is a program that was written by
18628 \begin_inset Flex Noun
18631 \begin_layout Plain Layout
18633 \begin_inset space ~
18641 in frustration because some constructs in \SpecialChar LaTeX
18642 are sometimes non-intuitive,
18643 and easy to forget.
18644 The program runs over your \SpecialChar LaTeX
18645 file, checks the integrity of the file, and
18646 flags some common errors.
18647 In other technical words, it is
18651 for \SpecialChar LaTeX
18655 \begin_layout Standard
18656 Well, what is a syntax checker doing in \SpecialChar LyX
18657 which is supposed to produce correct
18659 anyways? The answer is simple: Just as
18663 not only checks the
18667 of C programs, but also does
18671 checks for type-errors,
18673 Chk\SpecialChar TeX
18676 catches some common
18680 errors, in addition to the syntactical ones.
18683 Chk\SpecialChar TeX
18686 is capable of detecting several common errors, such as
18689 \begin_layout Itemize
18690 Ellipsis detection:
18691 \begin_inset Newline newline
18694 Use \SpecialChar ldots
18698 \begin_layout Itemize
18699 No space in front of/after parenthesis:
18700 \begin_inset Newline newline
18706 \begin_layout Itemize
18707 Enforcement of normal space after common abbreviations:
18708 \begin_inset Newline newline
18712 \begin_inset space \thinspace{}
18716 \begin_inset space \space{}
18719 is too wide spacing.
18722 \begin_layout Itemize
18723 Enforcement of end-of-sentence space when the last sentence ends with a
18725 \begin_inset Newline newline
18729 And this is wrong spacing.
18732 \begin_layout Itemize
18733 Space in front of labels and similar commands:
18734 \begin_inset Newline newline
18737 The label should stick right up to the text to avoid falling to a wrong
18740 \begin_inset CommandInset label
18750 \begin_layout Plain Layout
18751 This footnote is in danger of falling off to a wrong page
18756 The label is separated too much.
18759 \begin_layout Itemize
18760 Space in front of references, instead of hard spaces:
18761 \begin_inset Newline newline
18764 If you have bad luck, the text will break right between the referenced text
18765 and reference number, and that's a pity.
18767 \begin_inset CommandInset ref
18769 reference "sec:chktex"
18776 \begin_layout Itemize
18778 \begin_inset Quotes eld
18782 \begin_inset Quotes erd
18786 \begin_inset Formula $\times$
18790 \begin_inset Newline newline
18793 2x2 looks cheap compared to
18794 \begin_inset Formula $2\times2$
18800 \begin_layout Standard
18801 and more \SpecialChar ldots
18802 It is an invaluable tool when you are
18803 \begin_inset Quotes eld
18807 \begin_inset Quotes erd
18810 your document before printing, and you should run it right after the obligatory
18811 spelling check, and before you go fine tuning the typesetting.
18814 \begin_layout Subsection
18818 \begin_layout Standard
18819 If you have the program installed, usage is as simple as choosing
18821 Tools\SpecialChar menuseparator
18823 \begin_inset space ~
18829 This will make \SpecialChar LyX
18830 generate a \SpecialChar LaTeX
18831 file of your document, start
18833 Chk\SpecialChar TeX
18836 to check it, and then make \SpecialChar LyX
18838 \begin_inset Quotes eld
18842 \begin_inset Quotes erd
18845 with the warnings from
18847 Chk\SpecialChar TeX
18850 , if there were any.
18851 The warnings will be placed close to the point of the mistake, and you
18852 can quickly find them by using the
18854 Navigate\SpecialChar menuseparator
18857 menu item, or the shortcut key
18866 Open the error boxes by clicking on them with the mouse, or use the shortcut
18875 bindings, or the corresponding
18884 Read the warning and correct the mistake, if it is a mistake.
18885 If you have trouble understanding what the warning is about, you can safely
18887 Remember that there is a hidden layer between the document on screen and
18888 the technical details in invoking
18890 Chk\SpecialChar TeX
18893 , and this gap can make some warnings seem arcane or just plain silly.
18896 \begin_layout Standard
18897 This document is an excellent testing bed for the feature, and it should
18898 provide quite a few warnings for you to fiddle with.
18899 Since computers are only so smart, expect most of the warnings to be false
18903 \begin_layout Subsection
18904 How to fine tune it
18907 \begin_layout Standard
18908 Sometimes, you'll find that
18910 Chk\SpecialChar TeX
18913 makes more noise than suits your mood.
18914 Then you can choose not to use it, wait until your mood changes, or try
18917 Chk\SpecialChar TeX
18920 to get better along with you.
18923 \begin_layout Standard
18926 Chk\SpecialChar TeX
18933 very configurable and extensible, you should not expect to solve all problems
18936 Chk\SpecialChar TeX
18939 in \SpecialChar LyX
18941 Since \SpecialChar LyX
18942 has to generate a somewhat special \SpecialChar LaTeX
18943 file to be able to match the
18944 line numbers from the
18946 Chk\SpecialChar TeX
18953 \begin_layout Plain Layout
18954 You can inspect the specific output from
18960 Document\SpecialChar menuseparator
18963 \begin_inset space ~
18977 to the internal document structure, some of the warnings will not appear
18979 There are two things you can do about this:
18982 \begin_layout Itemize
18985 Chk\SpecialChar TeX
18988 invocation command line in
18989 \begin_inset Flex Noun
18992 \begin_layout Plain Layout
18993 Tools\SpecialChar menuseparator
18994 Preferences\SpecialChar menuseparator
18995 Output\SpecialChar menuseparator
18996 LaTeX\SpecialChar menuseparator
19004 Chk\SpecialChar TeX
19007 installation configuration file (usually with the file
19012 See below to learn what warnings can be enabled and disabled on the command
19016 \begin_layout Itemize
19017 Export your document as a raw \SpecialChar LaTeX
19020 File\SpecialChar menuseparator
19021 Export\SpecialChar menuseparator
19030 Invoked in this way, it can be a hassle to find the corresponding place
19031 in the document inside \SpecialChar LyX
19032 , but with a little patience, you should be able
19036 \begin_layout Standard
19037 Here follows the warning messages that can be enabled and disabled in
19046 to disable a warning, and
19050 to enable a warning.
19051 The emphasized entries are disabled by default, because the default is
19054 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19059 \begin_layout Standard
19060 Notice that you should only use the options that enable and disable warnings,
19061 because \SpecialChar LyX
19062 relies on some of the other command line parameters to be set
19063 in a specific way to have a chance to communicate with
19070 \begin_layout Enumerate
19074 Command terminated with space.
19077 \begin_layout Enumerate
19080 Non-breaking space (
19081 \begin_inset Quotes eld
19089 \begin_inset Quotes erd
19092 ) should have been used.
19095 \begin_layout Enumerate
19099 You should enclose the previous parenthesis with
19100 \begin_inset Quotes eld
19108 \begin_inset Quotes erd
19114 \begin_layout Enumerate
19117 Italic correction (
19118 \begin_inset Quotes eld
19128 \begin_inset Quotes erd
19131 ) found in non-italic buffer.
19134 \begin_layout Enumerate
19137 Italic correction (
19138 \begin_inset Quotes eld
19148 \begin_inset Quotes erd
19151 ) found more than once.
19154 \begin_layout Enumerate
19158 No italic correction (
19159 \begin_inset Quotes eld
19169 \begin_inset Quotes erd
19175 \begin_layout Enumerate
19179 \begin_inset Quotes eld
19187 \begin_inset Quotes erd
19191 \begin_inset Quotes eld
19199 \begin_inset Quotes erd
19205 \begin_layout Enumerate
19208 Wrong length of dash may have been used.
19211 \begin_layout Enumerate
19215 \begin_inset Quotes eld
19223 \begin_inset Quotes erd
19227 \begin_inset Quotes eld
19235 \begin_inset Quotes erd
19241 \begin_layout Enumerate
19245 \begin_inset Quotes eld
19253 \begin_inset Quotes erd
19259 \begin_layout Enumerate
19263 \begin_inset Quotes eld
19271 \begin_inset Quotes erd
19274 to achieve an ellipsis.
19277 \begin_layout Enumerate
19280 Inter-word spacing (
19281 \begin_inset Quotes eld
19291 \begin_inset Quotes eld
19294 ) should perhaps be used.
19297 \begin_layout Enumerate
19300 Inter-sentence spacing (
19301 \begin_inset Quotes eld
19311 \begin_inset Quotes erd
19314 ) should perhaps be used.
19317 \begin_layout Enumerate
19320 Could not find argument for command.
19323 \begin_layout Enumerate
19327 \begin_inset Quotes eld
19335 \begin_inset Quotes erd
19341 \begin_layout Enumerate
19344 Math mode still on at end of \SpecialChar LaTeX
19348 \begin_layout Enumerate
19352 \begin_inset Quotes eld
19360 \begin_inset Quotes erd
19363 doesn't match the number of
19364 \begin_inset Quotes eld
19372 \begin_inset Quotes erd
19378 \begin_layout Enumerate
19381 You should use either
19384 \begin_inset Quotes eld
19392 \begin_inset Quotes erd
19397 as an alternative to
19398 \begin_inset Quotes eld
19406 \begin_inset Quotes erd
19412 \begin_layout Enumerate
19419 " (ASCII 39) instead of "
19426 \begin_layout Enumerate
19429 User-specified pattern found.
19432 \begin_layout Enumerate
19435 This command might not be intended.
19438 \begin_layout Enumerate
19445 \begin_layout Enumerate
19463 \begin_layout Enumerate
19466 Delete this space to maintain correct page references.
19469 \begin_layout Enumerate
19473 You might wish to put this between a pair of
19474 \begin_inset Quotes eld
19482 \begin_inset Quotes erd
19488 \begin_layout Enumerate
19491 You ought to remove spaces in front of punctuation.
19494 \begin_layout Enumerate
19497 Could not execute \SpecialChar LaTeX
19501 \begin_layout Enumerate
19510 in front of small punctuation.
19513 \begin_layout Enumerate
19521 may look prettier here.
19524 \begin_layout Enumerate
19528 Multiple spaces detected in output.
19531 \begin_layout Enumerate
19534 This text may be ignored.
19537 \begin_layout Enumerate
19543 \begin_inset Quotes eld
19548 to begin quotation, not
19555 \begin_layout Enumerate
19562 to end quotation, not
19565 \begin_inset Quotes eld
19573 \begin_layout Enumerate
19579 \begin_layout Enumerate
19582 You should perhaps use
19583 \begin_inset Quotes eld
19591 \begin_inset Quotes erd
19597 \begin_layout Enumerate
19600 You should put a space in front of/after parenthesis.
19603 \begin_layout Enumerate
19606 You should avoid spaces in front of/after parenthesis.
19609 \begin_layout Enumerate
19613 You should not use punctuation in front of/after quotes.
19616 \begin_layout Enumerate
19619 Double space found.
19622 \begin_layout Enumerate
19625 You should put punctuation outside inner/inside display math mode.
19628 \begin_layout Enumerate
19631 You ought to not use primitive \SpecialChar TeX
19632 in \SpecialChar LaTeX
19636 \begin_layout Enumerate
19639 You should remove spaces in front of
19640 \begin_inset Quotes eld
19648 \begin_inset Quotes erd
19654 \begin_layout Enumerate
19657 \begin_inset Quotes eld
19665 \begin_inset Quotes erd
19668 is normally not followed by
19669 \begin_inset Quotes eld
19677 \begin_inset Quotes erd
19683 \begin_layout Standard
19684 In later versions of \SpecialChar LyX
19685 , we hope to provide a more complete interface to this
19686 tool (and it's smaller cousin
19690 ) to exploit the full power of it.
19691 But it's not exactly useless as it is now: go try it on one of your existing
19692 documents of a certain length and be surprised.
19695 \begin_layout Section
19696 Version Control in \SpecialChar LyX
19700 \begin_layout Standard
19703 Lars Gullik Bjønnes
19710 \begin_layout Subsection
19714 \begin_layout Standard
19716 supports some of the most basic RCS/CVS/SVN/GIT commands.
19717 If you need something a bit more sophisticated you will have to do that
19718 manually in a terminal.
19721 \begin_layout Standard
19722 Also note that CVS support is not as good as subversion support so we advise
19724 A good place to start learning Subversion is SVN Book
19728 \begin_layout Plain Layout
19729 \begin_inset CommandInset href
19731 target "http://svnbook.red-bean.com/"
19741 In the case of RCS you should read
19742 \begin_inset Quotes eld
19746 \begin_inset Quotes erd
19749 (a man file, read it with
19754 This file describes all the basic features of RCS.
19755 You should especially notice the comment about a RCS directory, and the
19756 notion of a master RCS file (the file ending in
19763 \begin_layout Standard
19764 Before you begin to use the version control features in \SpecialChar LyX
19766 familiar with RCS/CVS/SVN/GIT usage.
19767 The implementation in \SpecialChar LyX
19768 assumes a recent version of the GNU RCS or CVS/SVN
19769 package — no guarantees are made for older versions.
19770 Most of the log messages are not currently displayed after operations —
19771 you can check them in the Messages pane if unsure.
19772 Regular users of version control will appreciate VC toolbar, which can
19775 View\SpecialChar menuseparator
19776 Toolbars\SpecialChar menuseparator
19778 \begin_inset space ~
19786 \begin_layout Standard
19787 For introducing your own external commands consult vc-command in the manual
19788 of \SpecialChar LyX
19792 \begin_layout Standard
19793 It is strongly recommended to store documents in uncompressed format if
19794 using version control (uncheck
19796 Document\SpecialChar menuseparator
19799 if it is checked): Uncompressed LyX documents are text files and therefore
19800 for merging two different versions by version control systems.
19801 Compressed LyX documents are binary files, which cannot be merged by version
19805 \begin_layout Subsection
19806 RCS commands in \SpecialChar LyX
19810 \begin_layout Standard
19811 The following sections describe the RCS commands supported by \SpecialChar LyX
19813 You can find them in the
19815 File\SpecialChar menuseparator
19817 \begin_inset space ~
19824 was tested against RCS 5.7/5.8.
19827 \begin_layout Subsubsection
19833 \begin_layout Standard
19834 If your document is not under revision control, this is the only item shown
19836 And if it is under revision control, the
19840 item is not visible.
19844 \begin_layout Standard
19845 This command registers your document with RCS (unless you are under the
19846 directory managed by CVS)\SpecialChar endofsentence
19847 You are asked interactively to supply an initial
19848 description of the document.
19849 The document is now set in Read-Only mode and you have to
19852 \begin_inset space ~
19856 \begin_inset space ~
19860 \begin_inset space ~
19865 , before making any changes to it.
19866 A document under revision control has a
19867 \begin_inset Quotes eld
19870 [RCS:<version> <locker>]
19871 \begin_inset Quotes erd
19874 item tagged to the filename in the minibuffer.
19877 \begin_layout Standard
19878 RCS command that is run:
19880 ci -q -u -i -t-"<initial description>" <file-name>
19883 \begin_layout Standard
19888 to understand the switches.
19892 \begin_layout Subsubsection
19898 \begin_layout Standard
19899 When you are finished editing a file, you check in your changes.
19900 When you do this, you are asked for a description of the changes.
19901 This is stored in the history log.
19902 The version number is bumped, your changes are applied to the master RCS
19903 file, the document is unlocked and set to Read-Only mode.
19906 \begin_layout Standard
19909 ci -q -u -m"<description>" <file-name>
19912 \begin_layout Subsubsection
19918 \begin_layout Standard
19919 By doing this you lock the document so that only you can edit it.
19920 This will also make the document Read-Write only for you.
19921 You will usually continue editing for a while and when you are finished
19922 you check in your changes.
19923 The status line is changed to reflect that you have locked the file.
19926 \begin_layout Standard
19929 co -q -l <file-name>
19932 \begin_layout Subsubsection
19935 Revert To Repository Version
19938 \begin_layout Standard
19939 This will discard all changes made to the document since the last check
19941 You get a warning before changes are discarded.
19944 \begin_layout Standard
19947 co -f -u<version> <file-name>
19950 \begin_layout Subsubsection
19956 \begin_layout Standard
19957 This will create a copy of the current document.
19958 Since RCS does not support copy operations natively, the version history
19959 is not preserved, and the copy is added as a new file.
19960 It requires a clean document without any changes since the last checkin.
19961 You are asked for a file name and a description of the copy operation.
19962 After that the copy is created, both locally and in the repository.
19963 If the parent directories of the copied and original document differ, all
19964 relative paths of included files of the copy are adjusted (like in
19966 File\SpecialChar menuseparator
19971 Finally, the copy is loaded instead of the original document.
19974 \begin_layout Labeling
19975 \labelwidthstring 00.00.0000
19977 \begin_inset space ~
19981 \begin_inset space ~
19985 \begin_inset Newline newline
19989 \begin_inset Flex Code
19992 \begin_layout Plain Layout
19995 \begin_inset Quotes eld
19999 \begin_inset Quotes erd
20008 \begin_inset Flex Code
20011 \begin_layout Plain Layout
20014 \begin_inset Quotes eld
20018 \begin_inset Quotes erd
20027 \begin_inset Newline newline
20031 \begin_inset Flex Code
20034 \begin_layout Plain Layout
20038 \begin_inset Quotes eld
20042 \begin_inset Quotes erd
20053 \begin_layout Subsubsection
20059 \begin_layout Standard
20060 This makes as if the last check in never happened.
20061 No changes are made to the document loaded into \SpecialChar LyX
20062 , but the last version
20063 is removed from the master RCS file.
20066 \begin_layout Standard
20069 rcs -o<version> <file-name>
20072 \begin_layout Subsubsection
20078 \begin_layout Standard
20079 This shows the complete history of the RCS document.
20084 is shown in a browser.
20092 \begin_layout Subsubsection
20096 \begin_layout Standard
20098 supports RCS version number, author name, date and time of last commit.
20099 All those are extracted from
20101 rlog -r <file-name>
20105 \begin_inset CommandInset ref
20107 reference "subsec:VCS-Revision-Information"
20114 \begin_layout Subsection
20115 CVS commands in \SpecialChar LyX
20119 \begin_layout Standard
20120 A subset of CVS operations is supported by \SpecialChar LyX
20122 You can find the commands in the
20124 File\SpecialChar menuseparator
20126 \begin_inset space ~
20132 The version control system SVN is more powerful, so please use it instead
20133 of CVS if possible.
20136 \begin_layout Subsubsection
20142 \begin_layout Standard
20143 If you start from scratch with CVS you have to create your repository and
20144 checkout the working copy with external tools.
20145 If you're using a client-server setup you may need to login before doing
20146 the first repository checkout.
20149 \begin_layout Standard
20150 If your documents are under revision control and others are using the same
20151 repository problems arise when different changes to the same document at
20152 the same location happen.
20153 Standard CVS repositories don't operate with a file locking mechanism.
20154 This may be surprising, but conflicts only occur if people disagree on
20155 the proper content of the same part of a document.
20156 So, if co-workers are used to communicate regularly, these conflicts occur
20158 If they don't communicate they have a fundamental problem anyway.
20159 Nevertheless some people like to work with so called
20160 \begin_inset Quotes eld
20164 \begin_inset Quotes erd
20168 If they do so the working copy of all files is readonly when checked out
20169 first and the user starts editing after using a special command to make
20170 the working copy writable.
20171 When the changes are checked in the working copy returns to readonly state.
20172 With \SpecialChar LyX
20173 one has to edit the
20174 \begin_inset Flex Code
20177 \begin_layout Plain Layout
20183 file and add the line
20184 \begin_inset Flex Code
20187 \begin_layout Plain Layout
20193 to work with reserved checkouts.
20194 The benefit is the possibility to see who is using a writable copy of some
20196 It's not guaranteed only one user makes a copy writable.
20199 \begin_layout Standard
20201 tries to guess if you're using reserved or non-reserved checkouts.
20202 If your working copy is readonly or it is writable and an additional copy
20203 of your document exists in the CVS/Base sub-directory a reserved otherwise
20204 a non-reserved checkout is assumed.
20205 When a reserved checkout is detected you have to use
20206 \begin_inset Flex Noun
20209 \begin_layout Plain Layout
20215 to make your working copy writable if it's readonly.
20217 \begin_inset Flex Noun
20220 \begin_layout Plain Layout
20226 operation is possible and that makes your working copy readonly again after
20227 transferring your changes to the repository.
20230 \begin_layout Standard
20231 More information about CVS can be found here
20232 \begin_inset Flex URL
20235 \begin_layout Plain Layout
20237 http://www.nongnu.org/cvs
20243 \begin_inset Flex URL
20246 \begin_layout Plain Layout
20248 http://ximbiot.com/cvs
20256 \begin_layout Standard
20261 to understand the sub-commands and the switches mentioned below.
20264 \begin_layout Subsubsection
20270 \begin_layout Standard
20271 If your document is not under revision control, this is the only item shown
20273 And if it is under revision control, the
20280 item is not visible.
20284 \begin_layout Standard
20285 This command registers in CVS your document
20286 \begin_inset Flex Strong
20289 \begin_layout Plain Layout
20297 in the case you have already the documents directory under CVS control
20303 This means you have to create or checkout the archive by yourself using
20305 (In case you forget that step \SpecialChar LyX
20306 registers the document with RCS.)
20309 \begin_layout Standard
20310 Then you are asked interactively to supply an initial description of the
20312 Don't forget that registered file is not yet checked in.
20315 \begin_layout Standard
20316 CVS command that is run:
20318 cvs -q add -m"<entered message>" "<file-name>"
20321 \begin_layout Standard
20326 above and for all other CVS commands is an abbreviation for
20327 \begin_inset Quotes eld
20330 change the current working directory to file location and use the file name
20331 without path component as argument
20332 \begin_inset Quotes erd
20338 \begin_layout Subsubsection
20344 \begin_layout Standard
20345 When you are finished editing a file, you commit your changes.
20346 When you do this and you had changed the document, you are asked for a
20347 description of the changes.
20348 After that changes are written to the repository.
20349 In case you didn't change the document and a reserved checkout is detected
20350 the reservation made on
20351 \begin_inset Flex Noun
20354 \begin_layout Plain Layout
20363 \begin_layout Labeling
20364 \labelwidthstring 00.00.0000
20366 \begin_inset space ~
20370 \begin_inset space ~
20374 \begin_inset Newline newline
20378 \begin_inset Flex Code
20381 \begin_layout Plain Layout
20384 -q commit -m"<description>" "<file-name>"
20390 \begin_inset Newline newline
20394 \begin_inset Flex Code
20397 \begin_layout Plain Layout
20408 \begin_layout Subsubsection
20414 \begin_layout Standard
20415 When you are sharing a repository with others, you may have to incorporate
20416 their changes into your working copy.
20419 \begin_layout Standard
20422 cvs -q update "<file-name>"
20425 \begin_layout Standard
20426 If a readonly checkout is detected the working copy is made writable and
20430 \begin_layout Standard
20433 cvs -q edit "<file-name>"
20436 \begin_layout Subsubsection
20439 Revert To Repository Version
20442 \begin_layout Standard
20443 This will discard all changes made to the document since the last check
20445 You get a warning before changes are discarded.
20446 Firstly the file is deleted, secondly CVS update command is run.
20449 \begin_layout Standard
20452 cvs -q update "<file-name>"
20455 \begin_layout Standard
20456 If a reserved checkout is detected and the working copy has no changes only
20457 the reservation is undone.
20460 \begin_layout Standard
20463 cvs -q unedit "<file-name>"
20466 \begin_layout Subsubsection
20472 \begin_layout Standard
20473 This will create a copy of the current document.
20474 Since CVS does not support copy operations natively, the version history
20475 is not preserved, and the copy is added as a new file.
20476 It requires a clean document without any changes since the last checkin.
20477 You are asked for a file name and a description of the copy operation.
20478 After that the copy is created, both locally and in the repository.
20479 If the parent directories of the copied and original document differ, all
20480 relative paths of included files of the copy are adjusted (like in
20482 File\SpecialChar menuseparator
20487 Finally, the copy is loaded instead of the original document.
20490 \begin_layout Labeling
20491 \labelwidthstring 00.00.0000
20493 \begin_inset space ~
20497 \begin_inset space ~
20501 \begin_inset Newline newline
20505 \begin_inset Flex Code
20508 \begin_layout Plain Layout
20511 \begin_inset Quotes eld
20515 \begin_inset Quotes erd
20524 \begin_inset Flex Code
20527 \begin_layout Plain Layout
20530 \begin_inset Quotes eld
20534 \begin_inset Quotes erd
20543 \begin_inset Newline newline
20547 \begin_inset Flex Code
20550 \begin_layout Plain Layout
20554 \begin_inset Quotes eld
20558 \begin_inset Quotes erd
20569 \begin_layout Subsubsection
20575 \begin_layout Standard
20576 This will rename the current document.
20577 Since CVS does not support rename operations natively, the version history
20578 is not preserved, the renamed document is added as a new file, and the
20579 original document is deleted.
20580 It requires a clean document without any changes since the last checkin.
20581 You are asked for a file name and a description of the rename operation.
20582 After that the document is renamed, both locally and in the repository.
20583 If the parent directories of the new and old file names differ, all relative
20584 paths of included files are adjusted (like in
20586 File\SpecialChar menuseparator
20591 Finally, the document is reloaded using the new name.
20594 \begin_layout Labeling
20595 \labelwidthstring 00.00.0000
20597 \begin_inset space ~
20601 \begin_inset space ~
20605 \begin_inset Newline newline
20609 \begin_inset Flex Code
20612 \begin_layout Plain Layout
20615 \begin_inset Quotes eld
20619 \begin_inset Quotes erd
20628 \begin_inset Flex Code
20631 \begin_layout Plain Layout
20634 \begin_inset Quotes eld
20638 \begin_inset Quotes erd
20647 \begin_inset Newline newline
20651 \begin_inset Flex Code
20654 \begin_layout Plain Layout
20658 \begin_inset Quotes eld
20662 \begin_inset Quotes erd
20671 \begin_inset Newline newline
20675 \begin_inset Flex Code
20678 \begin_layout Plain Layout
20682 \begin_inset Quotes eld
20686 \begin_inset Quotes erd
20697 \begin_layout Subsubsection
20698 Update of the local directory checkout from repository
20701 \begin_layout Standard
20702 Once your documents gets more complex, containing sub-documents and pictures,
20704 \begin_inset Flex Code
20707 \begin_layout Plain Layout
20713 files and so on using version control becomes more complicated.
20715 supports updating the whole tree in which resides the document.
20716 This become especially useful once you cooperate with people which neither
20717 have detailed knowledge about CVS usage nor they have ambition to commit
20718 additional material to the repository.
20719 You have to organize the files structure so that all external files are
20720 in the same directory or subdirectories of the document.
20721 It's good practice anyway to store multipart documents in an extra directory.
20724 \begin_layout Standard
20726 \begin_inset Flex Code
20729 \begin_layout Plain Layout
20730 Update local directory from repository
20735 command updates the whole directory.
20736 If local changes are detected user is warned before update starts.
20737 In case of merge conflicts both versions of the conflicting document parts
20738 are placed in the final document.
20739 You have to review and correct the result of the merge.
20740 You'll find the conflicts enclosed in pairs of
20741 \begin_inset Flex Code
20744 \begin_layout Plain Layout
20751 \begin_inset Flex Code
20754 \begin_layout Plain Layout
20761 \begin_inset Flex Code
20764 \begin_layout Plain Layout
20771 The first part is your version as before the update operation with the
20772 document name prepended.
20773 The second one is the repository version with the version number after
20775 \begin_inset Flex Code
20778 \begin_layout Plain Layout
20787 \begin_layout Labeling
20788 \labelwidthstring 00.00.0000
20790 \begin_inset space ~
20794 \begin_inset space ~
20798 \begin_inset Newline newline
20802 \begin_inset Flex Code
20805 \begin_layout Plain Layout
20813 (Ask if changes are detected.)
20814 \begin_inset Newline newline
20818 \begin_inset Flex Code
20821 \begin_layout Plain Layout
20822 cd $path; cvs -q update
20832 \begin_layout Standard
20834 \begin_inset Flex Code
20837 \begin_layout Plain Layout
20843 stands for the path to the document.
20846 \begin_layout Subsubsection
20852 \begin_layout Standard
20853 This shows the complete history of the CVS document.
20856 cvs log "<file-name>"
20858 is shown in a browser.
20861 \begin_layout Subsubsection
20865 \begin_layout Standard
20867 supports CVS version number, author name, date and time of last commit.
20868 All those are extracted from
20870 cvs log -r <file-name>
20874 \begin_inset CommandInset ref
20876 reference "subsec:VCS-Revision-Information"
20883 \begin_layout Subsection
20884 SVN commands in \SpecialChar LyX
20888 \begin_layout Standard
20889 SVN is now partially supported by \SpecialChar LyX
20891 You can find the commands in the
20893 File\SpecialChar menuseparator
20895 \begin_inset space ~
20901 Please note that if you use password protected access to repository via
20902 ssh, you will be asked in terminal window.
20904 was tested against SVN 1.5, 1.6, 1.7 and 1.8
20908 \begin_layout Plain Layout
20909 Most of the commands will work with 1.4 too, see
20910 \begin_inset CommandInset ref
20912 reference "subsec:SVN-Repo-Update"
20917 There seems to be currently unresolved permissions problem under SVN 1.8
20918 with reverting changes when file is locked.
20926 \begin_layout Subsubsection
20932 \begin_layout Standard
20933 If your document is not under revision control, this is the only item shown
20935 And if it is under revision control, the
20942 item is not visible.
20945 \begin_layout Standard
20946 This command registers in SVN your document ONLY in case you have already
20947 the documents directory under SVN control (in particular
20952 This means you have to checkout the archive by yourself.
20955 \begin_layout Standard
20956 Then you are asked interactively to supply an initial description of the
20958 Don't forget that registered file is not yet commited.
20961 \begin_layout Standard
20962 SVN command that is run:
20965 \begin_inset Quotes eld
20969 \begin_inset Quotes erd
20975 \begin_layout Standard
20980 to understand the switches.
20983 \begin_layout Subsubsection
20989 \begin_layout Standard
20990 When you are finished editing a file, you commit your changes.
20991 When you do this, you are asked for a description of the changes.
20992 After that changes are commited.
20995 \begin_layout Standard
21000 \begin_layout Plain Layout
21001 In case locking is not enabled.
21003 \begin_inset CommandInset ref
21005 reference "subsec:SVN-File-Locking"
21016 svn commit -q -m"<description>" <file-name>
21019 \begin_layout Subsubsection
21025 \begin_layout Standard
21026 Updates the changes of this file from the repository.
21027 Be sure you understand SVN merging and conflicts resolving before using
21028 this function, because all conflicts has to be resolved manually by you!
21031 \begin_layout Standard
21036 \begin_layout Plain Layout
21044 svn update --non-interactive
21045 \begin_inset Quotes eld
21049 \begin_inset Quotes erd
21055 \begin_layout Subsubsection
21058 Revert To Repository Version
21061 \begin_layout Standard
21062 This will discard all changes made to the document since the last check
21064 You get a warning before changes are discarded.
21067 \begin_layout Standard
21071 \begin_inset Quotes eld
21075 \begin_inset Quotes erd
21081 \begin_layout Subsubsection
21087 \begin_layout Standard
21088 This will create a copy of the current document including the version history.
21089 It requires a clean document without any changes since the last checkin.
21090 You are asked for a file name and a description of the copy operation.
21091 After that the copy is created, both locally and in the repository.
21092 If the parent directories of the copied and original document differ, all
21093 relative paths of included files of the copy are adjusted (like in
21095 File\SpecialChar menuseparator
21100 Finally, the copy is loaded instead of the original document.
21103 \begin_layout Labeling
21104 \labelwidthstring 00.00.0000
21106 \begin_inset space ~
21110 \begin_inset space ~
21114 \begin_inset Newline newline
21118 \begin_inset Flex Code
21121 \begin_layout Plain Layout
21125 \begin_inset Quotes eld
21129 \begin_inset Quotes erd
21133 \begin_inset Quotes eld
21137 \begin_inset Quotes erd
21146 \begin_inset Newline newline
21150 \begin_inset Flex Code
21153 \begin_layout Plain Layout
21162 \begin_layout Subsubsection
21168 \begin_layout Standard
21169 This will rename the current document including the version history.
21170 It requires a clean document without any changes since the last checkin.
21171 You are asked for a file name and a description of the rename operation.
21172 After that the document is renamed, both locally and in the repository.
21173 If the parent directories of the new and old file names differ, all relative
21174 paths of included files are adjusted (like in
21176 File\SpecialChar menuseparator
21181 Finally, the document is reloaded using the new name.
21184 \begin_layout Labeling
21185 \labelwidthstring 00.00.0000
21187 \begin_inset space ~
21191 \begin_inset space ~
21195 \begin_inset Newline newline
21199 \begin_inset Flex Code
21202 \begin_layout Plain Layout
21206 \begin_inset Quotes eld
21210 \begin_inset Quotes erd
21214 \begin_inset Quotes eld
21218 \begin_inset Quotes erd
21227 \begin_inset Newline newline
21231 \begin_inset Flex Code
21234 \begin_layout Plain Layout
21243 \begin_layout Subsubsection
21244 \begin_inset CommandInset label
21246 name "subsec:SVN-Repo-Update"
21250 Update of the local directory checkout from repository
21254 \begin_layout Plain Layout
21255 Note that this command will work only with subversion
21256 \begin_inset Formula $\geqq1.5$
21267 \begin_layout Standard
21268 All the commands above have one shortcomming - they deal with the current
21270 Once your document contains pictures, includes external
21271 \begin_inset Flex Code
21274 \begin_layout Plain Layout
21280 files and so on administration becomes more complicated.
21282 now supports updating the whole tree in which resides the document
21286 \begin_layout Plain Layout
21287 One need to organize the files structure so that all external files are
21288 in the same directory or subdirectories of the document.
21295 This become especially useful once you cooperate with people which neither
21296 know about subversion management nor they have ambition to commit additional
21297 material to the repository.
21301 \begin_layout Standard
21302 \begin_inset Flex Code
21305 \begin_layout Plain Layout
21306 Update local directory from repository
21311 command updates the whole directory and in case of merge conflicts local
21312 version of the files are left, so no unintended data loss occurs.
21313 If local changes are detected user is warned before update starts.
21316 \begin_layout Labeling
21317 \labelwidthstring 00.00.0000
21319 \begin_inset space ~
21323 \begin_inset space ~
21327 \begin_inset Newline newline
21331 \begin_inset Flex Code
21334 \begin_layout Plain Layout
21340 (Ask if changes are detected.)
21341 \begin_inset Newline newline
21345 \begin_inset Flex Code
21348 \begin_layout Plain Layout
21349 svn update –accept mine-full $path
21357 \begin_layout Standard
21359 \begin_inset Flex Code
21362 \begin_layout Plain Layout
21368 stands for the path to the document.
21371 \begin_layout Subsubsection
21377 \begin_layout Standard
21378 This shows the complete history of the SVN document.
21382 \begin_inset Quotes eld
21386 \begin_inset Quotes erd
21391 is shown in a browser.
21394 \begin_layout Subsubsection
21396 \begin_inset CommandInset label
21398 name "subsec:SVN-File-Locking"
21405 \begin_layout Standard
21406 The file exchange through various revision control systems brings the problem
21407 of merge conflicts in case two different users try to edit the same (parts
21409 When such a conflict happens it needs manual resolving and one reasonable
21410 alternative is to provide some kind of locking mechanism, which guarantees
21411 that only one user is allowed to edit file at the given time.
21414 \begin_layout Standard
21415 SVN has two such mechanisms to provide mutual exclusivity for file access
21416 - locks and automatic setting of write permissions (see sec.
21418 \begin_inset CommandInset ref
21420 reference "subsec:Automatical-Locking-Property"
21425 \begin_inset Flex Code
21428 \begin_layout Plain Layout
21438 \begin_layout Plain Layout
21439 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21445 If this property is detected for a given document \SpecialChar LyX
21446 starts to use SVN locks
21447 for document editing automatically and the whole check-in/out mechanism
21448 switches to the same regimen as for RCS.
21449 This in particular means there are two different modes of file use in \SpecialChar LyX
21453 \begin_layout Itemize
21455 The loaded file is in the read-only mode.
21456 For editing on needs to check-out.
21461 consists of updating from the repository and gaining write lock.
21462 If the lock is not possible to obtain, we remain in unlocked state.
21465 \begin_layout Itemize
21467 The loaded file is in the 'normal' edit mode.
21468 No other user is allowed to edit the file.
21473 consists of commiting changes and releasing write-lock.
21474 If no changes have been made to the document, no commit will be produced
21478 \begin_layout Plain Layout
21479 Don't be puzzled by the fact that you will be asked for commit message anyway.
21484 and only the write-lock will be released.
21487 \begin_layout Standard
21491 \begin_layout Labeling
21492 \labelwidthstring 00.00.0000
21495 svn commit -q -m"<description>" "<file-name>"
21496 \begin_inset Newline newline
21499 svn unlock "<file-name>"
21502 \begin_layout Labeling
21503 \labelwidthstring 00.00.0000
21506 svn update "<file-name>"
21507 \begin_inset Newline newline
21510 svn lock "<file-name>"
21513 \begin_layout Subsubsection
21516 \begin_inset CommandInset label
21518 name "subsec:Automatical-Locking-Property"
21524 Automatic Locking Property
21527 \begin_layout Standard
21528 The above mentioned automatic setting of write permissions of the .lyx file
21534 ile\SpecialChar menuseparator
21540 \begin_inset space ~
21543 Control\SpecialChar menuseparator
21548 oggle locking property
21551 This command is active only when the file is not locked on the svn server
21553 you need to check-out before proceeding).
21556 \begin_layout Labeling
21557 \labelwidthstring 00.00.0000
21559 \begin_inset space ~
21565 \begin_layout Labeling
21566 \labelwidthstring 00.00.0000
21569 svn propset svn:needs-lock ON "<file-name>"
21572 \begin_layout Labeling
21573 \labelwidthstring 00.00.0000
21576 svn propdel svn:needs-lock "<file-name>"
21579 \begin_layout Subsubsection
21580 \begin_inset CommandInset label
21582 name "subsec:VCS-Revision-Information"
21586 Revision Information in Documents
21589 \begin_layout Standard
21590 There are more possibilities how to activate revision information in our
21594 \begin_layout Itemize
21597 \begin_inset Separator parbreak
21604 \begin_layout Itemize
21605 tree revision information (
21606 \begin_inset Flex Code
21609 \begin_layout Plain Layout
21616 The result is the output of the
21617 \begin_inset Flex Code
21620 \begin_layout Plain Layout
21626 command, the following table gives you an idea, how to read the results.
21629 \begin_layout Standard
21631 \begin_inset Tabular
21632 <lyxtabular version="3" rows="6" columns="2">
21633 <features tabularvalignment="middle">
21634 <column alignment="center" valignment="top">
21635 <column alignment="center" valignment="top">
21637 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21640 \begin_layout Plain Layout
21646 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21649 \begin_layout Plain Layout
21657 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21660 \begin_layout Plain Layout
21666 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21669 \begin_layout Plain Layout
21670 mixed revision working copy
21677 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21680 \begin_layout Plain Layout
21686 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21689 \begin_layout Plain Layout
21690 modified working copy
21697 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21700 \begin_layout Plain Layout
21706 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21709 \begin_layout Plain Layout
21710 switched working copy
21717 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21720 \begin_layout Plain Layout
21726 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21729 \begin_layout Plain Layout
21730 partial working copy, from a sparse checkout
21737 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21740 \begin_layout Plain Layout
21746 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21749 \begin_layout Plain Layout
21750 mixed revision, modified, switched working copy
21763 \begin_layout Itemize
21764 file revision information.
21765 The result comes from parsing the output of
21766 \begin_inset Flex Code
21769 \begin_layout Plain Layout
21771 \begin_inset space ~
21775 \begin_inset space ~
21779 \begin_inset space ~
21788 Supported flags are:
21789 \begin_inset Separator parbreak
21796 \begin_layout Itemize
21797 version number of the last commit (
21798 \begin_inset Flex Code
21801 \begin_layout Plain Layout
21810 \begin_layout Itemize
21811 author of the last commit (
21812 \begin_inset Flex Code
21815 \begin_layout Plain Layout
21824 \begin_layout Itemize
21825 date of the last commit (
21826 \begin_inset Flex Code
21829 \begin_layout Plain Layout
21838 \begin_layout Itemize
21839 time of the last commit (
21840 \begin_inset Flex Code
21843 \begin_layout Plain Layout
21853 \begin_layout Standard
21854 You can obtain this info via InsetInfo (e.g.
21856 \begin_inset Flex Code
21859 \begin_layout Plain Layout
21860 info-insert buffer vcs-date
21866 The information will be available only when you have the file stored under
21867 svn managment (i.e.
21869 \begin_inset Flex Code
21872 \begin_layout Plain Layout
21878 directory is available with your document).
21882 \begin_layout Itemize
21883 Another—a hacking one—possibility is to use svn keywords
21887 \begin_layout Plain Layout
21888 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
21894 In short – you set file keywords property (e.g.
21897 svn propset svn:keywords 'Rev' file.lyx
21899 ) and then paste keyword \SpecialChar TeX
21904 \begin_layout Plain Layout
21905 This is an easy way how to ensure that \SpecialChar LyX
21906 won't break the line in the middle
21912 tag in your document (e.g.
21917 \begin_layout Plain Layout
21925 This way svn client will automatically substitute revision number (e.g.
21930 \begin_layout Plain Layout
21937 ) after each update and commit.
21938 There are more problems with this approach.
21939 Firstly, the '$' character is used in \SpecialChar TeX
21940 world for math equations, so any
21941 occurence of math formula
21942 \begin_inset Formula $Rev$
21946 \begin_inset Formula $Rev:59$
21949 in your \SpecialChar LyX
21951 Similarly for other keywords like Id, Date, Author, etc.
21952 Secondly svn output is dependent on your locales, so its very easy that
21953 svn would produce some problematic strings once Date is used.
21954 Thirdly you get the whole 'Rev: 59' string in your document instead of
21956 Until subversion implements user's custom keywords it will be hard to use
21957 this approach reliably or let \SpecialChar LyX
21958 to support it directly.
21961 \begin_layout Subsection
21962 SVN and Windows Environment
21965 \begin_layout Quote
21966 My inclination is to say that if the user cannot figure out the command
21967 line operations on their own fairly quickly, they would be well advised
21968 to use TortoiseSVN.
21974 \begin_layout Subsubsection
21978 \begin_layout Standard
21979 In addition to installing \SpecialChar LyX
21980 , and having access to a Subversion repository,
21981 the user will need to install the Subversion client program.
21982 A Windows installer for the client program is available from
21983 \begin_inset CommandInset href
21986 target "http://www.collab.net/nonav/downloads/subversion/"
21991 The user may also want to install
21992 \begin_inset CommandInset href
21995 target "http://tortoisesvn.tigris.org/"
21999 , which integrates Subversion operations into the context (rightclick) menu
22000 of Windows Explorer.
22001 Operations done outside \SpecialChar LyX
22002 will typically be more convenient using the Explorer
22004 Note that TortoiseSVN is not a replacement for the client program, which
22005 is what \SpecialChar LyX
22009 \begin_layout Subsubsection
22010 Bringing a document under Subversion control
22013 \begin_layout Standard
22014 Before a \SpecialChar LyX
22015 document can be brought under version control in Subversion, its
22016 parent directory needs to be under version control.
22017 If the document is being added to a project already in the repository,
22018 this is accomplished by checking the project out to the directory where
22019 the new document will be placed.
22020 If the project itself is not yet under version control (for instance, if
22021 this document starts a new project), the directory must be imported into
22023 This is done outside \SpecialChar LyX
22025 Both import and checkout are easily accomplished from the Explorer context
22026 menu using TortoiseSVN, or alternatively can be done using the command
22027 line client at a DOS prompt.
22028 The procedure for importing the project using TortoiseSVN is described
22029 below, assuming an existing repository and a new project being started
22037 For information on using the Subversion client program, run
22044 \begin_layout Enumerate
22051 in Windows Explorer, right click it, and select
22053 TortoiseSVN\SpecialChar menuseparator
22057 If necessary, adjust the URL for the repository, then click OK.
22060 \begin_layout Enumerate
22061 Right click the level of the repository under which you want to place the
22062 new project folder (typically the top level) and click
22066 Supply a name for the project folder and click OK.
22067 Add a message for the log file if desired, then click OK again.
22068 The new project folder should appear in the repository.
22069 Finally, click OK again to exit the repository browser.
22072 \begin_layout Enumerate
22073 Once again right click
22079 , this time selecting SVN Checkout\SpecialChar ldots
22080 Select the URL of the project folder
22081 you just created in the repository, and set the checkout directory to
22089 You will be warned about a non-empty folder; click OK to proceed.
22090 You should now have a
22101 \begin_layout Enumerate
22102 Create or open your document in \SpecialChar LyX
22105 File\SpecialChar menuseparator
22107 \begin_inset space ~
22110 Control\SpecialChar menuseparator
22114 Add a log message and click OK to commit the document to version control.
22117 \begin_layout Standard
22118 From this point onward, you should have full functionality in the
22120 File\SpecialChar menuseparator
22122 \begin_inset space ~
22128 You also have the option of checking the document in and out, viewing its
22130 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22131 client program from a command prompt.
22134 \begin_layout Subsubsection
22135 SSH tunnel used with SVN under Windows
22138 \begin_layout Standard
22139 Compared with Linux setting up an svn client to communicate over ssh under
22140 Windows is a rather troublesome task.
22141 We will at least offer some hints how to setup the client side but prior
22142 knowledge about ssh and the Windows command line is needed, also be prepared
22143 for a great deal of frustration\SpecialChar ldots
22147 \begin_layout Enumerate
22148 Get an svn client for windows, as described in the previous sections.
22149 When it is a fresh install run some svn command (e.g.
22151 \begin_inset Flex Code
22154 \begin_layout Plain Layout
22160 ) to create config files, which you will need to change later on.
22163 \begin_layout Enumerate
22164 Choose an ssh client for Windows.
22165 There are several possibilities, we will use the one from Putty tools
22169 \begin_layout Plain Layout
22170 \begin_inset Flex URL
22173 \begin_layout Plain Layout
22175 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22186 You will need to set the connection up so that the client doesn't ask for
22187 any password from you.
22188 To keep things easy we will use only keys without any additional password
22190 \begin_inset Separator parbreak
22197 \begin_layout Enumerate
22199 \begin_inset Flex Code
22202 \begin_layout Plain Layout
22209 Save your private .ppk key file and put the public one on the server side.
22210 If the SVN server runs on Linux, note that the format of the public key
22211 is not compatible with Linux openssh and you will need to direcly copy-paste
22214 Public key for pasting into OpenSSH authorized_keys file
22216 :” edit field into the server's
22217 \begin_inset Flex Code
22220 \begin_layout Plain Layout
22221 ~/.ssh/authorized_keys
22227 \begin_inset Flex Code
22230 \begin_layout Plain Layout
22239 \begin_layout Enumerate
22241 \begin_inset Flex Code
22244 \begin_layout Plain Layout
22251 In the SVN config file
22255 \begin_layout Plain Layout
22256 Exact path depends on Windows version, usually somewhere around
22257 \begin_inset Flex Code
22260 \begin_layout Plain Layout
22263 Documents and Settings
22277 \begin_inset Flex Code
22280 \begin_layout Plain Layout
22295 , section [tunnels], setup ssh command, e.g.
22297 \begin_inset Flex Code
22300 \begin_layout Plain Layout
22301 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22310 \begin_layout Plain Layout
22311 It will usually take a lot of time to get exact command right and it depends
22313 For example do not have some remote server saved as a default session in
22315 If things fail, try to connect via plink without SVN first.
22324 \begin_layout Enumerate
22325 Checkout the SVN archive, e.
22326 \begin_inset space \thinspace{}
22330 \begin_inset Newline newline
22334 \begin_inset Flex Code
22337 \begin_layout Plain Layout
22338 svn co svn+ssh://user@server/repository_path
22346 \begin_layout Subsubsection
22347 End-of-Line Conversions
22350 \begin_layout Standard
22351 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22353 use different line endings inside the .lyx files.
22354 This is not a problem as far as \SpecialChar LyX
22355 functionality is concerned, but the commit
22356 diffs will be huge and merge-conflicts prone.
22357 Fortunately SVN itself knows
22361 \begin_layout Plain Layout
22362 \begin_inset Flex URL
22365 \begin_layout Plain Layout
22367 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22377 how to deal with CR/LF problems when switching .lyx files to the
22378 \begin_inset Flex Code
22381 \begin_layout Plain Layout
22391 \begin_layout Plain Layout
22393 \begin_inset Flex Code
22396 \begin_layout Plain Layout
22397 svn propset svn:eol-style native FILE_NAME
22410 \begin_layout Subsection
22411 GIT commands in \SpecialChar LyX
22415 \begin_layout Standard
22416 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22418 You can find the commands in the
22420 File\SpecialChar menuseparator
22422 \begin_inset space ~
22428 Please note that if you use password protected access to repository via
22429 ssh, you will be asked in terminal window.
22431 was tested against GIT 1.7.
22435 \begin_layout Plain Layout
22436 Windows users please note that you need to ensure that git is on the path.
22437 This can be set from within \SpecialChar LyX
22440 Tools\SpecialChar menuseparator
22441 Preferences\SpecialChar menuseparator
22442 Paths\SpecialChar menuseparator
22453 \begin_layout Standard
22454 One big difference of GIT and the other supported version control systems
22455 is the distributed nature of GIT: With traditional version control systems
22456 there is one central server which hosts the repository.
22457 Users commit their changes to the server, and get updates made by other
22459 With GIT, users commit to a local repository.
22460 The local repository can be synchronized with one or more remote repositories
22462 \begin_inset Flex Code
22465 \begin_layout Plain Layout
22472 \begin_inset Flex Code
22475 \begin_layout Plain Layout
22483 does not interact in any way with remote GIT repositories.
22484 It works exclusively with the local repository in a very similar way as
22485 with a central CVS or SVN repository.
22486 If you use remote GIT repositories you need to do the
22487 \begin_inset Flex Code
22490 \begin_layout Plain Layout
22497 \begin_inset Flex Code
22500 \begin_layout Plain Layout
22506 operations with your favourite GIT client.
22509 \begin_layout Subsubsection
22515 \begin_layout Standard
22516 If your document is not under revision control, this is the only item shown
22518 And if it is under revision control, the
22525 item is not visible.
22528 \begin_layout Standard
22529 This command registers in GIT your document ONLY in case you have already
22530 the documents directory under GIT control (in particular
22535 This means you have to checkout the archive by yourself.
22538 \begin_layout Standard
22539 Then you are asked interactively to supply an initial description of the
22541 Don't forget that registered file is not yet commited.
22544 \begin_layout Standard
22545 GIT command that is run:
22548 \begin_inset Quotes eld
22552 \begin_inset Quotes erd
22558 \begin_layout Standard
22563 to understand the switches.
22566 \begin_layout Subsubsection
22572 \begin_layout Standard
22573 When you are finished editing a file, you commit your changes.
22574 When you do this, you are asked for a description of the changes.
22575 After that changes are commited.
22578 \begin_layout Standard
22581 git commit -q -m"<description>" <file-name>
22584 \begin_layout Subsubsection
22587 Revert To Repository Version
22590 \begin_layout Standard
22591 This will discard all changes made to the document since the last check
22593 You get a warning before changes are discarded.
22596 \begin_layout Standard
22600 \begin_inset Quotes eld
22604 \begin_inset Quotes erd
22610 \begin_layout Subsubsection
22616 \begin_layout Standard
22617 This will rename the current document including the version history.
22618 It requires a clean document without any changes since the last checkin.
22619 You are asked for a file name and a description of the rename operation.
22620 After that the document is renamed, both locally and in the repository.
22621 If the parent directories of the new and old file names differ, all relative
22622 paths of included files are adjusted (like in
22624 File\SpecialChar menuseparator
22629 Finally, the document is reloaded using the new name.
22632 \begin_layout Labeling
22633 \labelwidthstring 00.00.0000
22635 \begin_inset space ~
22639 \begin_inset space ~
22643 \begin_inset Newline newline
22647 \begin_inset Flex Code
22650 \begin_layout Plain Layout
22654 \begin_inset Quotes eld
22658 \begin_inset Quotes erd
22662 \begin_inset Quotes eld
22666 \begin_inset Quotes erd
22675 \begin_inset Newline newline
22679 \begin_inset Flex Code
22682 \begin_layout Plain Layout
22691 \begin_layout Subsubsection
22697 \begin_layout Standard
22698 This shows the complete history of the GIT document.
22702 \begin_inset Quotes eld
22706 \begin_inset Quotes erd
22711 is shown in a browser.
22714 \begin_layout Subsubsection
22718 \begin_layout Standard
22720 supports GIT hash number of the last commit to the file, author name, date
22721 and time of last commit.
22722 All those are extracted from
22724 git log -n 1 --pretty=format:%H%n%an%n%ai
22727 Tree version information is obtained via
22729 git describe --abbrev --dirty --long
22733 \begin_inset CommandInset ref
22735 reference "subsec:VCS-Revision-Information"
22742 \begin_layout Subsection
22746 \begin_layout Standard
22747 With the recent addition of the vc-command function \SpecialChar LyX
22748 power users are allowed
22749 to create their own commands for revision control.
22752 \begin_layout Standard
22753 As an example you can see how two TortoiseSVN commands could be integrated
22757 \begin_layout Description
22759 \begin_inset Flex Code
22762 \begin_layout Plain Layout
22763 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
22771 \begin_layout Description
22773 \begin_inset Flex Code
22776 \begin_layout Plain Layout
22777 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
22785 \begin_layout Subsection
22786 Version control and Document comparison
22789 \begin_layout Standard
22790 One of the typical uses of version control is to inspect the changes between
22791 revisions, usually by creating
22792 \begin_inset Flex Code
22795 \begin_layout Plain Layout
22802 While this is useful for plain text files, it is much less useful in the
22803 case of \SpecialChar LyX
22804 files, which have more a complicated structure.
22805 Hence we provide binding to the Document comparison feature.
22806 There are two ways of calling this feature - either by direct call of
22807 \begin_inset Flex Code
22810 \begin_layout Plain Layout
22817 function (for details see \SpecialChar LyX
22818 functions manual) or by icon/menu item
22819 \begin_inset Flex Noun
22822 \begin_layout Plain Layout
22823 Compare with older revision...
22829 One can either compare two chosen revisions of the document or he can simply
22830 compare the current version of edited text with older revisions (where
22832 \begin_inset Flex Noun
22835 \begin_layout Plain Layout
22841 ' revisions back means comparison of the edited file with last commited
22846 \begin_layout Standard
22847 This feature is supported for SVN and RCS though due to the more complicated
22848 versioning scheme of RCS there is a constraint – when addressing the revisions
22849 in dialog, numbers always point to the last number in RCS revision number,
22852 We don't currently support GIT addressing of revisions, one can just compare
22853 edited document with its revision X steps backs, where X is addressed as
22857 \begin_layout Section
22858 Literate Programming
22861 \begin_layout Standard
22866 (kayvan@sylvan.com)
22870 original documentation written by
22872 Edmar Wienskoski Jr.
22875 (edmar-w-jr@technologist.com)
22878 \begin_layout Subsection
22882 \begin_layout Standard
22883 The main purpose of this documentation is to show you how to use \SpecialChar LyX
22885 programming, where it is assumed that you are familiar with this programming
22886 technique, and know what
22887 \begin_inset Quotes eld
22891 \begin_inset Quotes erd
22895 \begin_inset Quotes eld
22899 \begin_inset Quotes erd
22903 If that is not the case, please follow the web links provided in the following
22905 There is a lot of good documentation out there covering old development
22906 history to the latest tools tips.
22909 \begin_layout Standard
22910 It is also assumed that you are familiar with \SpecialChar LyX
22911 itself to a point that you
22912 are comfortable changing your \SpecialChar LyX
22913 preferences, and X resources file.
22914 If that is not the case please refer to other \SpecialChar LyX
22915 documentation to cover your
22919 \begin_layout Subsection
22920 Literate Programming
22923 \begin_layout Standard
22924 From the Literate Programming FAQ:
22927 \begin_layout Quotation
22928 Literate programming is the combination of documentation and source together
22929 in a fashion suited for reading by human beings.
22930 In fact, literate programs should be enjoyable reading, even inviting!
22931 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
22932 and documentation in a single file.
22933 Literate programming tools then parse the file to produce either readable
22934 documentation or compilable source.
22935 The WEB style of literate programming was created by D.
22936 \begin_inset space \thinspace{}
22940 Knuth during the development of his \SpecialChar TeX
22941 typesetting software.
22945 \begin_layout Standard
22946 Another excerpt says:
22949 \begin_layout Quotation
22952 How is literate programming different from verbose commenting?
22955 \begin_layout Quotation
22956 There are three distinguishing characteristics.
22957 In order of importance, they are:
22958 \begin_inset Separator parbreak
22965 \begin_layout Itemize
22966 flexible order of elaboration
22969 \begin_layout Itemize
22970 automatic support for browsing
22973 \begin_layout Itemize
22974 typeset documentation, especially diagrams and mathematics
22978 \begin_layout Standard
22979 Now that I sparked your curiosity, take a look in the references.
22982 \begin_layout Subsubsection
22986 \begin_layout Standard
22987 The complete Literate Programming FAQ can be found at:
22990 \begin_layout Quote
22991 Literate Programming FAQ
22992 \begin_inset Flex URL
22995 \begin_layout Plain Layout
22997 http://www.literateprogramming.com/lpfaq.pdf
23005 \begin_layout Standard
23006 The FAQ lists 23 (twenty three!) different literate programming tools.
23007 Where some are specialized or
23008 \begin_inset Quotes eld
23012 \begin_inset Quotes erd
23015 for particular programming languages, while other have general scope.
23020 for my own use for several reasons:
23023 \begin_layout Itemize
23024 It can generate the documentation either in \SpecialChar LaTeX
23028 \begin_layout Itemize
23029 It has a open architecture, i.
23030 \begin_inset space \thinspace{}
23034 \begin_inset space \space{}
23037 it is easy to plug in new filters and to perform special processing that
23042 \begin_layout Itemize
23043 There is a good selection of filters available already (the HTML is one
23047 \begin_layout Itemize
23051 \begin_layout Standard
23052 The Noweb web page can be found at:
23055 \begin_layout Quote
23057 \begin_inset Flex URL
23060 \begin_layout Plain Layout
23062 http://www.cs.virginia.edu/~nr/noweb/
23070 \begin_layout Standard
23071 Starting from there you can reach many other interesting links and even
23072 some literate program examples.
23075 \begin_layout Subsection
23077 and Literate Programming with Noweb
23080 \begin_layout Standard
23081 The \SpecialChar LyX
23082 support for Literate Programming is provided by using the generic \SpecialChar LyX
23084 converters mechanism.
23085 This support is provided in a
23086 \begin_inset Quotes eld
23090 \begin_inset Quotes erd
23094 \begin_inset space \thinspace{}
23098 \begin_inset space \space{}
23101 you will be able to use this new \SpecialChar LyX
23102 feature with some other literate programming
23103 tool of your choice by just changing your \SpecialChar LyX
23107 \begin_layout Subsubsection
23108 Generating documents and code (weaving and tangling)
23111 \begin_layout Paragraph
23112 Using the noweb module
23115 \begin_layout Standard
23116 If you have installed Noweb and \SpecialChar LyX
23117 successfully, whenever you open a new document,
23118 after you have chosen its document class, use the Document->Settings menu
23120 \begin_inset Quotes eld
23124 \begin_inset Quotes erd
23128 If Noweb is correctly installed, when you click on the
23129 \begin_inset Quotes eld
23133 \begin_inset Quotes erd
23136 link, you will see the
23137 \begin_inset Quotes eld
23141 \begin_inset Quotes erd
23144 module in the available list and you can add it to your document.
23147 \begin_layout Paragraph
23151 \begin_layout Standard
23153 enables you to write code with a layout named
23154 \begin_inset Flex Noun
23157 \begin_layout Plain Layout
23164 Noweb delimits chunks like this:
23167 \begin_layout LyX-Code
23171 \begin_layout LyX-Code
23175 \begin_layout LyX-Code
23179 \begin_layout LyX-Code
23183 \begin_layout LyX-Code
23187 \begin_layout Standard
23188 The problem is that whatever is written in between the << and the
23192 must be taken literally, i.
23193 \begin_inset space \thinspace{}
23197 \begin_inset space \space{}
23201 should be prevented from making any special interpretation of what has
23203 This is also handled by
23204 \begin_inset Flex Noun
23207 \begin_layout Plain Layout
23213 , that works like a normal paragraph but has a free spacing capability.
23216 \begin_layout Standard
23217 As a special note, you can also use the
23218 \begin_inset Quotes eld
23222 \begin_inset Quotes erd
23225 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23229 \begin_layout LyX-Code
23233 \begin_layout LyX-Code
23234 def some_function(args):
23237 \begin_layout LyX-Code
23238 "This is the doc string for this function."
23241 \begin_layout LyX-Code
23242 print "My args: ", args
23245 \begin_layout LyX-Code
23246 @ %def some_function
23249 \begin_layout Standard
23250 For an example of this usage and the resulting cross-reference output, look
23251 at the Literate python program in
23253 LIBDIR/examples/listerrors.lyx
23255 which should make this all clear.
23258 \begin_layout Paragraph
23259 Generating the documentation
23262 \begin_layout Standard
23263 At this point you already have a new document file with a proper document
23264 class, and with some code and text on it.
23265 How do I print it? The answer is simple, you select
23267 View\SpecialChar menuseparator
23271 Just like you would do for a plain document.
23272 No special procedure is required.
23275 \begin_layout Standard
23276 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23280 \begin_layout Enumerate
23283 Update\SpecialChar menuseparator
23286 menu option is chosen, a \SpecialChar LaTeX
23289 \begin_inset Separator parbreak
23296 \begin_layout Standard
23297 If the document is of any literate class the generated file will be named
23298 with an extension name defined by the
23299 \begin_inset Quotes eld
23303 \begin_inset Quotes erd
23306 format (defined in the Preferences panel), otherwise the file will have
23315 \begin_layout Enumerate
23316 Note that the only difference so far is in the name of the file, no special
23317 processing is required by \SpecialChar LyX
23319 Given that you formatted the code using the
23320 \begin_inset Flex Noun
23323 \begin_layout Plain Layout
23329 layout that, by itself, takes care of the business.
23332 \begin_layout Enumerate
23333 If the document is of any literate class \SpecialChar LyX
23334 will then use the internal \SpecialChar LyX
23336 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23341 \begin_layout Plain Layout
23342 The converters are defined in the
23344 Tools\SpecialChar menuseparator
23348 \begin_inset Quotes eld
23352 \begin_inset Quotes erd
23364 manual for general information about converters.
23369 to generate the \SpecialChar LaTeX
23371 \begin_inset Separator parbreak
23378 \begin_layout Standard
23379 Otherwise it will just skip this step.
23383 \begin_layout Enumerate
23384 Finally, \SpecialChar LaTeX
23385 is invoked and the regular post processing continues as in a plain
23389 \begin_layout Standard
23390 Independence from a particular
23391 \begin_inset Quotes eld
23395 \begin_inset Quotes erd
23398 is easily achieved by changing the commands that are run by the various
23402 \begin_layout Paragraph
23403 Generating the code
23406 \begin_layout Standard
23407 When the build menu option is chosen or the corresponding button in the
23408 toolbar is pressed, a \SpecialChar LaTeX
23409 file is generated just like step 1 above.
23410 Next, \SpecialChar LyX
23416 This converter needs to be defined by the user and is not installed by
23417 default, though the Program format is.
23418 This converter (like any other converter) will have two parts:
23421 \begin_layout Enumerate
23422 The converter program itself.
23423 This program performs the conversion from the one format to the other (in
23424 this case, from the Noweb format to the Program pseudo-format).
23427 \begin_layout Enumerate
23428 The error log parser.
23429 This is a program whose sole purpose is to rewrite error messages in a
23430 format that \SpecialChar LyX
23432 This makes it possible for \SpecialChar LyX
23433 to place error boxes in the right places in
23437 \begin_layout Standard
23438 The first part, the
23439 \begin_inset Quotes eld
23443 \begin_inset Quotes erd
23446 setting, should be set to
23447 \begin_inset Newline newline
23451 \begin_inset Quotes eld
23459 \begin_inset Quotes erd
23463 \begin_inset Newline newline
23466 This basically means that \SpecialChar LyX
23468 \begin_inset Quotes eld
23472 \begin_inset Quotes erd
23475 (a program or script) with the name of the Noweb file (normally a file
23476 in the \SpecialChar LyX
23477 temp directory) and the directory path of the original \SpecialChar LyX
23482 \begin_layout Standard
23483 This is an implementation of
23484 \begin_inset Quotes eld
23488 \begin_inset Quotes erd
23491 that you can place in a directory on your path:
23494 \begin_layout Standard
23495 \begin_inset VSpace defskip
23501 \begin_layout Standard
23502 \begin_inset Newpage pagebreak
23508 \begin_layout Standard
23514 \begin_layout Standard
23520 \begin_layout Standard
23523 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23526 \begin_layout Standard
23527 \begin_inset VSpace defskip
23533 \begin_layout Standard
23534 The next part of the converter setting is the
23535 \begin_inset Quotes eld
23539 \begin_inset Quotes erd
23542 which is to be set to
23543 \begin_inset Newline newline
23547 \begin_inset Quotes eld
23552 parselog=$$s/scripts/listerrors
23555 \begin_inset Quotes erd
23559 \begin_inset Newline newline
23562 This will run any errors that are generated by the
23563 \begin_inset Quotes eld
23567 \begin_inset Quotes erd
23570 process through the
23571 \begin_inset Quotes eld
23575 \begin_inset Quotes erd
23581 \begin_layout Standard
23582 The build will normally take place in \SpecialChar LyX
23583 's temporary directory, so the files
23584 produced by the conversion will be in that directory.
23586 will copy out what it regards as the `main' file, but the
23590 conversion may produce several files, and so most of these would then be
23591 deleted when \SpecialChar LyX
23593 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23594 the build-script chunk can place the generated files in that location.
23597 \begin_layout Paragraph
23598 Build instructions in the document
23601 \begin_layout Standard
23602 The last piece of the integration between \SpecialChar LyX
23604 \begin_inset Quotes eld
23608 \begin_inset Quotes erd
23612 Generally, the instructions for building your program should be embedded
23613 in a chunk of its own.
23615 \begin_inset Quotes eld
23619 \begin_inset Quotes erd
23622 above uses the notangle command to look for this chunk (called
23623 \begin_inset Quotes eld
23627 \begin_inset Quotes erd
23630 ) and runs its contents through
23631 \begin_inset Quotes eld
23635 \begin_inset Quotes erd
23641 \begin_layout Standard
23642 Typically, such a chunk would look something like this:
23645 \begin_layout LyX-Code
23649 \begin_layout LyX-Code
23651 \begin_inset Newline newline
23654 if [ -z "${NOWEB_SOURCE}" ]
23655 \begin_inset Newline newline
23661 \begin_layout LyX-Code
23662 NOWEB_SOURCE=myfile.nw
23663 \begin_inset Newline newline
23667 \begin_inset Newline newline
23671 code to extract files ...
23672 use NOWEB_OUTPUT_DIR here ...]
23673 \begin_inset Newline newline
23677 code to compile files ...]
23678 \begin_inset Newline newline
23684 \begin_layout Standard
23687 LIBDIR/examples/listerrors.lyx
23691 LIBDIR/examples/Literate.lyx
23693 which implement two versions of the
23694 \begin_inset Quotes eld
23698 \begin_inset Quotes erd
23701 program for some illustrations of how all of these pieces go together or
23704 LIBDIR/examples/noweb2lyx.lyx.
23707 Interestingly, these three files show off the language-indepence of the
23709 literate programming support since they are written in Python, C and Perl
23713 \begin_layout Subsubsection
23714 Configuring \SpecialChar LyX
23718 \begin_layout Standard
23719 All the Literate Programming support is configured by the
23721 Tools\SpecialChar menuseparator
23725 \begin_inset Quotes eld
23729 \begin_inset Quotes erd
23733 The important parts are:
23736 \begin_layout Description
23738 \begin_inset space ~
23742 \begin_inset Quotes eld
23746 \begin_inset Quotes erd
23750 \begin_inset space ~
23753 format Set up via the File Formats tab, this is where the Noweb-specific
23763 , the file extension is set to
23768 This tells \SpecialChar LyX
23769 to create a file with a
23773 extension in the first step of the conversion process.
23776 \begin_layout Description
23778 \begin_inset space ~
23786 \begin_inset space ~
23789 format This is an empty format whose sole purpose is to be the endpoint
23790 of a conversion (which then allows us to set up a converter for it).
23793 \begin_layout Description
23803 This converter performs the
23804 \begin_inset Quotes eld
23808 \begin_inset Quotes erd
23811 of the literate document.
23812 For Noweb, it is set to
23813 \begin_inset Quotes eld
23818 noweave -delay -index $$i > $$o
23821 \begin_inset Quotes erd
23827 \begin_layout Description
23837 \begin_inset Quotes eld
23841 \begin_inset Quotes erd
23845 As stated above, the Converter is set to
23846 \begin_inset Quotes eld
23854 \begin_inset Quotes erd
23857 , with Flags set to
23858 \begin_inset Newline newline
23862 \begin_inset Quotes eld
23867 parselog=$$s/scripts/listerrors
23870 \begin_inset Quotes erd
23876 \begin_layout Subsubsection
23880 \begin_layout Standard
23881 There is also a new function implemented in the \SpecialChar LyX
23883 \begin_inset Quotes eld
23886 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
23890 \begin_layout Standard
23891 When debugging code with ddd/gdb, it is possible to invoke a text editor
23892 at the current execution position with a single key stroke.
23893 The default ddd configuration for that is shift-ctrl-V.
23894 It happens that you can define the editor command line invocation in ddd
23897 Edit\SpecialChar menuseparator
23898 Preferences\SpecialChar menuseparator
23901 dialog and changing the "Edit Sources" entry.
23904 \begin_layout Standard
23905 I take advantage of the newly created \SpecialChar LyX
23906 server function and this ddd feature,
23908 \begin_inset Quotes eld
23912 \begin_inset Quotes erd
23918 \begin_layout Standard
23919 \begin_inset VSpace defskip
23925 \begin_layout Standard
23928 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
23931 \begin_layout Standard
23932 \begin_inset VSpace defskip
23938 \begin_layout Standard
23939 With this, whenever you are using ddd and find a point in the program that
23940 you want to edit, you just press shift-ctrl-V (in the ddd window), and
23941 ddd will forward this information to \SpecialChar LyX
23942 through the \SpecialChar LyX
23943 server and then the
23945 window will show the same file with the cursor at the same position ddd
23947 No more guessing or long scrolling to locate a point in the program back
23951 \begin_layout Standard
23952 Note however that you must enable the \SpecialChar LyX
23953 server to get this feature working
23954 (it is disabled by default).
23955 You can enable it in
23967 ) by entering in the
23973 \begin_inset Quotes eld
23978 /home/<your-home-directory>/.lyx/lyxpipe
23981 \begin_inset Quotes erd
23987 \begin_layout Standard
23988 Read the \SpecialChar LyX
23989 server documentation in the
23991 Customization Manual
23993 for further information.
23996 \begin_layout Subsubsection
24000 \begin_layout Standard
24001 There are six new buttons that can be added to your \SpecialChar LyX
24003 Five of these buttons are short cuts to layout styles:
24026 The last one is a short cut to the
24027 \begin_inset Quotes eld
24031 \begin_inset Quotes erd
24038 \begin_layout Standard
24040 has a range of buttons that are available for tool bar customization.
24041 In my toolbar I like to combine the six short cuts above with two more:
24046 \SpecialChar menuseparator
24051 \SpecialChar menuseparator
24058 Document\SpecialChar menuseparator
24059 View\SpecialChar menuseparator
24063 Here is how it looks like:
24066 \begin_layout LyX-Code
24070 \begin_layout LyX-Code
24074 \begin_layout LyX-Code
24075 Icon "layout Standard"
24078 \begin_layout LyX-Code
24079 Icon "layout Section"
24082 \begin_layout LyX-Code
24083 Icon "layout \SpecialChar LaTeX
24087 \begin_layout LyX-Code
24088 Icon "layout \SpecialChar LyX
24092 \begin_layout LyX-Code
24093 Icon "layout Chunk"
24096 \begin_layout LyX-Code
24100 \begin_layout LyX-Code
24104 \begin_layout LyX-Code
24105 Icon "buffer-typeset"
24108 \begin_layout LyX-Code
24109 Icon "build-program"
24112 \begin_layout LyX-Code
24116 \begin_layout LyX-Code
24120 \begin_layout LyX-Code
24124 \begin_layout LyX-Code
24128 \begin_layout LyX-Code
24132 \begin_layout Subsubsection
24133 Colors customization
24136 \begin_layout Standard
24137 There are a number of colors in \SpecialChar LyX
24138 that can be customized in
24143 One of the things that bothers people is the \SpecialChar LaTeX
24145 The default color is red, since the chunks uses \SpecialChar LaTeX
24146 font, and there is a lot
24147 of chunks in literate documents, you may get tired of seeing everything
24149 You can change it by going to the tabs
24158 \begin_layout Standard
24159 The next thing is the visible presence of the newline character in the screen.
24160 You can choose the color of this particular character and make it blend
24162 I recommend you choosing a color that is close to the background but not
24163 equal, that way you still can see it is there, but it is not bothering
24167 \begin_layout Subsection
24172 \begin_layout Standard
24181 is documented in the
24185 example file and in the Sweave manual (menu
24187 Help\SpecialChar menuseparator
24193 \begin_layout Chapter
24197 \begin_layout Standard
24198 You can do everything with \SpecialChar LyX
24199 that you can do with \SpecialChar LaTeX
24201 However, \SpecialChar LyX
24202 cannot support every \SpecialChar LaTeX
24204 But you can always use \SpecialChar TeX
24206 This chapter shows you some more special things you might want to use.
24207 For other special things you can do with figures, tables, floats, boxes
24208 and notes, have a look at the
24211 \begin_inset space ~
24219 \begin_layout Section
24220 Multiple Text Columns
24223 \begin_layout Standard
24224 This feature is independent of the option
24226 Two-column document
24228 in the document settings under
24233 If you want to have 2
24234 \begin_inset space ~
24237 columns for the whole document, it is recommended to use the
24239 Two-column document
24242 For all other cases use this feature.
24245 \begin_layout Standard
24246 To use multiple text columns in your document, you have to load the module
24253 Document\SpecialChar menuseparator
24254 Settings\SpecialChar menuseparator
24257 ) and must have the \SpecialChar LaTeX
24265 \begin_layout Standard
24266 Footnotes within multiple columns will be placed at the bottom of the page
24267 and not under each column.
24268 Within the different columns you can use everything, with the limitation
24269 that for floats you need to use the float option
24276 \begin_layout Subsection
24280 \begin_layout Standard
24281 If you want to have 2
24282 \begin_inset space ~
24285 columns in your text, insert a multicolumn inset via the menu
24287 Insert\SpecialChar menuseparator
24289 \begin_inset space ~
24292 Insets\SpecialChar menuseparator
24294 \begin_inset space ~
24299 where the columns should start.
24300 Write all text that should be printed in 2
24301 \begin_inset space ~
24304 columns into this inset.
24307 \begin_layout Standard
24308 Here is an example:
24311 \begin_layout Standard
24313 \begin_inset Flex Multiple Columns
24316 \begin_layout Plain Layout
24321 The Adventure of the Empty House
24324 \begin_inset Newline newline
24327 by Sir Arthur Conan Doyle
24330 \begin_layout Plain Layout
24333 It was in the spring of the year 1894 that all London was interested, and
24334 the fashionable world dismayed, by the murder of the Honourable Ronald
24335 Adair under most unusual and inexplicable circumstances.
24336 The public has already learned those particulars of the crime which came
24337 out in the police investigation, but a good deal was suppressed upon that
24338 occasion, since the case for the prosecution was so overwhelmingly strong
24339 that it was not necessary to bring forward all the facts.
24340 Only now, at the end of nearly ten years, am I allowed to supply those
24341 missing links which make up the whole of that remarkable chain.
24342 The crime was of interest in itself, but that interest was as nothing to
24343 me compared to the inconceivable sequel, which afforded me the greatest
24344 shock and surprise of any event in my adventurous life.
24345 Even now, after this long interval, I find myself thrilling as I think
24346 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24347 ty which utterly submerged my mind.
24348 Let me say to that public, which has shown some interest in those glimpses
24349 which I have occasionally given them of the thoughts and actions of a very
24350 remarkable man, that they are not to blame me if I have not shared my knowledge
24351 with them, for I should have considered it my first duty to do so, had
24352 I not been barred by a positive prohibition from his own lips, which was
24353 only withdrawn upon the third of last month.
24361 \begin_layout Standard
24362 To get 3 or more columns, set the cursor into the multicolumn inset and
24365 Insert\SpecialChar menuseparator
24367 \begin_inset space ~
24371 \begin_inset space ~
24377 The number of the desired columns is written into that inset (for 3
24378 \begin_inset space ~
24382 \begin_inset Quotes eld
24386 \begin_inset Quotes erd
24390 \begin_inset Newline newline
24393 Here is an example with 3
24394 \begin_inset space ~
24400 \begin_layout Standard
24401 \begin_inset Flex Multiple Columns
24404 \begin_layout Plain Layout
24407 \begin_inset Argument 1
24410 \begin_layout Plain Layout
24416 It can be imagined that my close intimacy with Sherlock Holmes had interested
24417 me deeply in crime, and that after his disappearance I never failed to
24418 read with care the various problems which came before the public.
24419 And I even attempted, more than once, for my own private satisfaction,
24420 to employ his methods in their solution, though with indifferent success.
24421 There was none, however, which appealed to me like this tragedy of Ronald
24423 As I read the evidence at the inquest, which led up to a verdict of willful
24424 murder against some person or persons unknown, I realized more clearly
24425 than I had ever done the loss which the community had sustained by the
24426 death of Sherlock Holmes.
24427 There were points about this strange business which would, I was sure,
24428 have specially appealed to him, and the efforts of the police would have
24429 been supplemented, or more probably anticipated, by the trained observation
24430 and the alert mind of the first criminal agent in Europe.
24431 All day, as I drove upon my round, I turned over the case in my mind and
24432 found no explanation which appeared to me to be adequate.
24433 At the risk of telling a twice-told tale, I will recapitulate the facts
24434 as they were known to the public at the conclusion of the inquest.
24442 \begin_layout Standard
24443 You can have up to 10
24444 \begin_inset space ~
24447 columns if you want to, but that might not be very pleasant for the readers
24451 \begin_layout Standard
24452 \begin_inset Newpage newpage
24458 \begin_layout Subsection
24459 Columns inside Columns
24462 \begin_layout Standard
24463 You can also have columns inside columns:
24466 \begin_layout Standard
24467 \begin_inset Flex Multiple Columns
24470 \begin_layout Plain Layout
24473 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24474 at that time governor of one of the Australian colonies.
24475 Adair's mother had returned from Australia to undergo the operation for
24476 cataract, and she, her son Ronald, and her daughter Hilda were living together
24480 \begin_layout Plain Layout
24481 \begin_inset Flex Multiple Columns
24484 \begin_layout Plain Layout
24487 The youth moved in the best society–had, so far as was known, no enemies
24488 and no particular vices.
24489 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24490 had been broken off by mutual consent some months before, and there was
24491 no sign that it had left any very profound feeling behind it.
24492 For the rest {sic} the man's life moved in a narrow and conventional circle,
24493 for his habits were quiet and his nature unemotional.
24494 Yet it was upon this easy-going young aristocrat that death came, in most
24495 strange and unexpected form, between the hours of ten and eleven-twenty
24496 on the night of March 30, 1894.
24504 \begin_layout Plain Layout
24507 Ronald Adair was fond of cards–playing continually, but never for such stakes
24509 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24510 It was shown that, after dinner on the day of his death, he had played
24511 a rubber of whist at the latter club.
24512 He had also played there in the afternoon.
24517 The evidence of those who had played with him– Mr.
24518 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24519 and that there was a fairly equal fall of the cards.
24520 Adair might have lost five pounds, but not more.
24521 His fortune was a considerable one, and such a loss could not in any way
24523 He had played nearly every day at one club or other, but he was a cautious
24524 player, and usually rose a winner.
24525 It came out in evidence that, in partnership with Colonel Moran, he had
24526 actually won as much as four hundred and twenty pounds in a sitting, some
24527 weeks before, from Godfrey Milner and Lord Balmoral.
24528 So much for his recent history as it came out at the inquest.
24536 \begin_layout Subsection
24540 \begin_layout Standard
24541 The examples in this section show some more special features of multiple
24545 \begin_layout Standard
24546 For more features of multiple columns, have a look at the documentation
24547 of the \SpecialChar LaTeX
24553 \begin_inset CommandInset citation
24562 \begin_layout Subsubsection
24566 \begin_layout Standard
24567 To add a preface text for multiple columns, set the cursor into the multicolumn
24568 inset and use the menu
24570 Insert\SpecialChar menuseparator
24574 Write your preface text into that inset.
24575 \begin_inset Newline newline
24578 This is an example with some preface text:
24581 \begin_layout Standard
24582 \begin_inset VSpace bigskip
24588 \begin_layout Standard
24589 \begin_inset Flex Multiple Columns
24592 \begin_layout Plain Layout
24593 \begin_inset Argument 2
24596 \begin_layout Plain Layout
24597 And the story continues and continues and continues and continues\SpecialChar ldots
24605 On the evening of the crime, he returned from the club exactly at ten.
24606 His mother and sister were out spending the evening with a relation.
24607 The servant deposed that she heard him enter the front room on the second
24608 floor, generally used as his sitting-room.
24609 She had lit a fire there, and as it smoked she had opened the window.
24610 No sound was heard from the room until eleven-twenty, the hour of the return
24611 of Lady Maynooth and her daughter.
24612 Desiring to say good-night, she attempted to enter her son's room.
24613 The door was locked on the inside, and no answer could be got to their
24614 cries and knocking.
24615 Help was obtained, and the door forced.
24616 The unfortunate young man was found lying near the table.
24617 His head had been horribly mutilated by an expanding revolver bullet, but
24618 no weapon of any sort was to be found in the room.
24626 \begin_layout Standard
24627 You can also use a section heading as the preface if you use a section command
24628 as \SpecialChar TeX
24630 For example the command
24633 \begin_layout Standard
24638 subsection{subsection title}
24641 \begin_layout Standard
24642 creates a subsection.
24643 In this example the preface is a subsubsection:
24646 \begin_layout Standard
24647 \begin_inset Flex Multiple Columns
24650 \begin_layout Plain Layout
24651 \begin_inset Argument 2
24654 \begin_layout Plain Layout
24658 \begin_layout Plain Layout
24667 This is a subsubsection heading as a preface
24671 \begin_layout Plain Layout
24685 A minute examination of the circumstances served only to make the case more
24687 In the first place, no reason could be given why the young man should have
24688 fastened the door upon the inside.
24689 There was the possibility that the murderer had done this, and had afterwards
24690 escaped by the window.
24691 The drop was at least twenty feet, however, and a bed of crocuses in full
24693 Neither the flowers nor the earth showed any sign of having been disturbed,
24694 nor were there any marks upon the narrow strip of grass which separated
24695 the house from the road.
24696 Apparently, therefore, it was the young man himself who had fastened the
24698 But how did he come by his death? No one could have climbed up to the window
24699 without leaving traces.
24700 Suppose a man had fired through the window, he would indeed be a remarkable
24701 shot who could with a revolver inflict so deadly a wound.
24702 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24703 a hundred yards of the house.
24704 No one had heard a shot.
24712 \begin_layout Standard
24713 If there is less vertical space than 6
24714 \begin_inset space ~
24717 text lines is left on the page at the beginning of the multiple columns,
24718 a page break will be inserted before the multiple columns.
24719 Depending on the number of lines of the preface text, you might want to
24721 This is done by setting the cursor into the mulitcolumn inset behind the
24722 preface (if there is any) and using the menu
24724 Insert\SpecialChar menuseparator
24726 \begin_inset space ~
24730 \begin_inset space ~
24734 \begin_inset space ~
24740 Insert into that inset the amount of space like e.
24741 \begin_inset space \thinspace{}
24745 \begin_inset space \space{}
24749 \begin_inset Quotes eld
24753 \begin_inset Quotes erd
24757 \begin_inset Newline newline
24760 In this example the space is set to 7
24761 \begin_inset space ~
24764 text lines by using
24765 \begin_inset Quotes eld
24771 \begin_inset Quotes erd
24780 needs to be inserted as \SpecialChar TeX
24784 \begin_layout Standard
24785 \begin_inset Flex Multiple Columns
24788 \begin_layout Plain Layout
24789 \begin_inset Argument 3
24792 \begin_layout Plain Layout
24797 \begin_layout Plain Layout
24813 On the evening of the crime, he returned from the club exactly at ten.
24814 His mother and sister were out spending the evening with a relation.
24815 The servant deposed that she heard him enter the front room on the second
24816 floor, generally used as his sitting-room.
24817 She had lit a fire there, and as it smoked she had opened the window.
24818 No sound was heard from the room until eleven-twenty, the hour of the return
24819 of Lady Maynooth and her daughter.
24820 Desiring to say good-night, she attempted to enter her son's room.
24821 The door was locked on the inside, and no answer could be got to their
24822 cries and knocking.
24823 Help was obtained, and the door forced.
24824 The unfortunate young man was found lying near the table.
24825 His head had been horribly mutilated by an expanding revolver bullet, but
24826 no weapon of any sort was to be found in the room.
24834 \begin_layout Subsubsection
24838 \begin_layout Standard
24839 The amount of space before and after multiple columns can be changed by
24840 changing the length
24847 For example the command
24850 \begin_layout Standard
24860 \begin_layout Standard
24861 in \SpecialChar TeX
24862 Code changes its value to 3
24863 \begin_inset space \thinspace{}
24867 The change must be made before the multiple columns' start.
24868 The predefined value is 13
24869 \begin_inset space \thinspace{}
24875 \begin_layout Standard
24883 \begin_inset space \thinspace{}
24889 \begin_layout Standard
24893 \begin_layout Plain Layout
24899 multicolsep}{2.5cm}
24907 \begin_layout Standard
24908 \begin_inset Flex Multiple Columns
24911 \begin_layout Plain Layout
24914 All day I turned these facts over in my mind, endeavouring to hit upon some
24915 theory which could reconcile them all, and to find that line of least resistanc
24916 e which my poor friend had declared to be the starting-point of every investigat
24918 I confess that I made little progress.
24919 In the evening I strolled across the Park, and found myself about six o'clock
24920 at the Oxford Street end of Park Lane.
24921 A group of loafers upon the pavements, all staring up at a particular window,
24922 directed me to the house which I had come to see.
24923 A tall, thin man with coloured glasses, whom I strongly suspected of being
24924 a plain-clothes detective, was pointing out some theory of his own, while
24925 the others crowded round to listen to what he said.
24926 I got as near him as I could, but his observations seemed to me to be absurd,
24927 so I withdrew again in some disgust.
24928 As I did so I struck against an elderly, deformed man, who had been behind
24929 me, and I knocked down several books which he was carrying.
24937 \begin_layout Standard
24938 \begin_inset Note Greyedout
24941 \begin_layout Plain Layout
24946 The values you set with
24952 will be used for all following multiple columns until you change them again.
24960 \begin_layout Standard
24964 \begin_layout Plain Layout
24976 \begin_inset Note Note
24979 \begin_layout Plain Layout
24980 go back to the default
24988 \begin_layout Standard
24989 \begin_inset Newpage newpage
24995 \begin_layout Subsubsection
24999 \begin_layout Standard
25000 A column break can be forced by inserting the command
25006 as \SpecialChar TeX
25007 Code to that position in the text where the column should be broken.
25008 Note that this leads in most cases to whitespace in the text.
25009 \begin_inset Newline newline
25012 Here is an example:
25015 \begin_layout Standard
25016 \begin_inset Flex Multiple Columns
25019 \begin_layout Plain Layout
25022 \begin_inset Quotes eld
25025 You're surprised to see me, sir,
25026 \begin_inset Quotes erd
25029 said he, in a strange, croaking voice.
25032 \begin_layout Plain Layout
25035 I acknowledged that I was.
25038 \begin_layout Plain Layout
25041 \begin_inset Quotes eld
25044 Well, I've a conscience, sir, and when I chanced to see you go into this
25045 house, as I came hobbling after you, I thought to myself, I'll just step
25046 in and see that kind gentleman, and tell him that if I was a bit gruff
25047 in my manner there was not any harm meant, and that I am much obliged to
25048 him for picking up my books.
25049 \begin_inset Quotes erd
25055 \begin_layout Plain Layout
25058 \begin_inset Quotes eld
25061 You make too much of a trifle,
25062 \begin_inset Quotes erd
25067 \begin_inset Quotes eld
25070 May I ask how you knew who I was?
25071 \begin_inset Quotes erd
25074 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25078 \begin_layout Plain Layout
25090 \begin_layout Plain Layout
25093 \begin_inset Quotes eld
25096 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25097 you'll find my little bookshop at the corner of Church Street, and very
25098 happy to see you, I am sure.
25099 Maybe you collect yourself, sir.
25103 \begin_inset space ~
25116 –a bargain, every one of them.
25117 With five volumes you could just fill that gap on that second shelf.
25118 It looks untidy, does it not, sir?
25119 \begin_inset Quotes erd
25130 \begin_layout Subsubsection
25134 \begin_layout Standard
25135 The width of the columns is automatically calculated, but you can modify
25136 the space between the columns.
25137 This is done by changing the length
25144 Its predefined value is 10
25145 \begin_inset space \thinspace{}
25149 Here is an example where
25156 \begin_inset space \thinspace{}
25162 \begin_layout Standard
25166 \begin_layout Plain Layout
25180 \begin_layout Standard
25181 \begin_inset Flex Multiple Columns
25184 \begin_layout Plain Layout
25187 My observations of No.
25188 \begin_inset space \space{}
25191 427 Park Lane did little to clear up the problem in which I was interested.
25192 The house was separated from the street by a low wall and railing, the
25193 whole not more than five feet high.
25194 It was perfectly easy, therefore, for anyone to get into the garden, but
25195 the window was entirely inaccessible, since there was no water pipe or
25196 anything which could help the most active man to climb it.
25197 More puzzled than ever, I retraced my steps to Kensington.
25198 I had not been in my study five minutes when the maid entered to say that
25199 a person desired to see me.
25200 To my astonishment it was none other than my strange old book collector,
25201 his sharp, wizened face peering out from a frame of white hair, and his
25202 precious volumes, a dozen of them at least, wedged under his right arm.
25210 \begin_layout Standard
25214 \begin_layout Plain Layout
25226 \begin_inset Note Note
25229 \begin_layout Plain Layout
25230 go back to the default
25238 \begin_layout Subsubsection
25242 \begin_layout Standard
25243 Between the columns a rule with a width of the length
25250 If this rule width is set to 0
25251 \begin_inset space \thinspace{}
25254 pt (this is the default), the rule is suppressed.
25255 In the following example the rule is 2
25256 \begin_inset space \thinspace{}
25262 \begin_layout Standard
25266 \begin_layout Plain Layout
25272 columnseprule}{2pt}
25280 \begin_layout Standard
25281 \begin_inset Flex Multiple Columns
25284 \begin_layout Plain Layout
25287 \begin_inset Quotes eld
25290 You're surprised to see me, sir,
25291 \begin_inset Quotes erd
25294 said he, in a strange, croaking voice.
25297 \begin_layout Plain Layout
25300 I acknowledged that I was.
25303 \begin_layout Plain Layout
25306 \begin_inset Quotes eld
25309 Well, I've a conscience, sir, and when I chanced to see you go into this
25310 house, as I came hobbling after you, I thought to myself, I'll just step
25311 in and see that kind gentleman, and tell him that if I was a bit gruff
25312 in my manner there was not any harm meant, and that I am much obliged to
25313 him for picking up my books.
25314 \begin_inset Quotes erd
25320 \begin_layout Plain Layout
25323 \begin_inset Quotes eld
25326 You make too much of a trifle,
25327 \begin_inset Quotes erd
25332 \begin_inset Quotes eld
25335 May I ask how you knew who I was?
25336 \begin_inset Quotes erd
25342 \begin_layout Plain Layout
25345 \begin_inset Quotes eld
25348 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25349 you'll find my little bookshop at the corner of Church Street, and very
25350 happy to see you, I am sure.
25351 Maybe you collect yourself, sir.
25355 \begin_inset space ~
25368 –a bargain, every one of them.
25369 With five volumes you could just fill that gap on that second shelf.
25370 It looks untidy, does it not, sir?
25371 \begin_inset Quotes erd
25382 \begin_layout Standard
25383 \begin_inset VSpace defskip
25389 \begin_layout Standard
25390 The rule can be colored by redefining the command
25397 This is done by inserting the command
25398 \begin_inset Newline newline
25407 columnseprulecolor}{
25412 \begin_inset Newline newline
25415 as \SpecialChar TeX
25416 Code before the multicolumn inset.
25421 in this command by a color of your choice.
25422 You can use all pre- and self-defined colors.
25430 \begin_inset space ~
25435 for more information about pre- and self-defined colors.
25436 To go back to the default color insert the command
25437 \begin_inset Newline newline
25446 columnseprulecolor}{
25451 \begin_inset Newline newline
25454 Here is the example with a cyan rule and 1
25455 \begin_inset space \thinspace{}
25458 cm column separation:
25461 \begin_layout Standard
25465 \begin_layout Plain Layout
25474 \begin_layout Plain Layout
25480 columnseprulecolor}{
25490 \begin_layout Standard
25491 \begin_inset Flex Multiple Columns
25494 \begin_layout Plain Layout
25497 \begin_inset Quotes eld
25500 You're surprised to see me, sir,
25501 \begin_inset Quotes erd
25504 said he, in a strange, croaking voice.
25507 \begin_layout Plain Layout
25510 I acknowledged that I was.
25513 \begin_layout Plain Layout
25516 \begin_inset Quotes eld
25519 Well, I've a conscience, sir, and when I chanced to see you go into this
25520 house, as I came hobbling after you, I thought to myself, I'll just step
25521 in and see that kind gentleman, and tell him that if I was a bit gruff
25522 in my manner there was not any harm meant, and that I am much obliged to
25523 him for picking up my books.
25524 \begin_inset Quotes erd
25530 \begin_layout Plain Layout
25533 \begin_inset Quotes eld
25536 You make too much of a trifle,
25537 \begin_inset Quotes erd
25542 \begin_inset Quotes eld
25545 May I ask how you knew who I was?
25546 \begin_inset Quotes erd
25552 \begin_layout Plain Layout
25555 \begin_inset Quotes eld
25558 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25559 you'll find my little bookshop at the corner of Church Street, and very
25560 happy to see you, I am sure.
25561 Maybe you collect yourself, sir.
25565 \begin_inset space ~
25578 –a bargain, every one of them.
25579 With five volumes you could just fill that gap on that second shelf.
25580 It looks untidy, does it not, sir?
25581 \begin_inset Quotes erd
25592 \begin_layout Standard
25596 \begin_layout Plain Layout
25602 columnseprule}{0pt}
25605 \begin_layout Plain Layout
25611 columnseprulecolor}{
25619 \begin_inset Note Note
25622 \begin_layout Plain Layout
25623 go back to the default
25631 \begin_layout Section
25632 Non-standard Paragraph Shapes
25635 \begin_layout Standard
25638 as well as any other text processor uses by default rectangular paragraphs.
25639 For special cases like for example posters, invitation cards or poems you
25640 can modify the paragraph shape to one of your choice.
25641 This can be done by using the \SpecialChar LaTeX
25646 which is loaded by using in the document settings the module
25648 Custom paragraph shapes
25653 \begin_layout Subsection
25657 \begin_layout Standard
25662 provides the following shapes:
25665 \begin_layout Standard
25666 \begin_inset Tabular
25667 <lyxtabular version="3" rows="13" columns="3">
25668 <features booktabs="true" islongtable="true" longtabularalignment="center">
25669 <column alignment="center" valignment="middle" width="16col%">
25670 <column alignment="center" valignment="middle" width="40col%">
25671 <column alignment="center" valignment="middle" width="35col%">
25672 <row endhead="true">
25673 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25676 \begin_layout Plain Layout
25682 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25685 \begin_layout Plain Layout
25691 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25694 \begin_layout Plain Layout
25702 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25705 \begin_layout Plain Layout
25711 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25714 \begin_layout Plain Layout
25715 Circle with circular hole (in the size of a CD/DVD)
25720 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25723 \begin_layout Plain Layout
25724 Cannot be scaled, take care there is not too much text
25731 <cell alignment="center" valignment="top" topline="true" usebox="none">
25734 \begin_layout Plain Layout
25740 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25743 \begin_layout Plain Layout
25749 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25752 \begin_layout Plain Layout
25753 Fragile, calculation might fail
25760 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25763 \begin_layout Plain Layout
25769 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25772 \begin_layout Plain Layout
25773 Rhomboid (symbolizing a
25774 \begin_inset Quotes eld
25778 \begin_inset Quotes erd
25786 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25789 \begin_layout Plain Layout
25797 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25800 \begin_layout Plain Layout
25806 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25809 \begin_layout Plain Layout
25815 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25818 \begin_layout Plain Layout
25826 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25829 \begin_layout Plain Layout
25835 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25838 \begin_layout Plain Layout
25844 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25847 \begin_layout Plain Layout
25855 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25858 \begin_layout Plain Layout
25864 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25867 \begin_layout Plain Layout
25868 Nut for bolt (hexagon with circular hole)
25873 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25876 \begin_layout Plain Layout
25884 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25887 \begin_layout Plain Layout
25893 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25896 \begin_layout Plain Layout
25902 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25905 \begin_layout Plain Layout
25913 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25916 \begin_layout Plain Layout
25922 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25925 \begin_layout Plain Layout
25931 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25934 \begin_layout Plain Layout
25942 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25945 \begin_layout Plain Layout
25951 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25954 \begin_layout Plain Layout
25960 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25963 \begin_layout Plain Layout
25971 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25974 \begin_layout Plain Layout
25980 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25983 \begin_layout Plain Layout
25984 Normal/reversed rain drop
25989 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25992 \begin_layout Plain Layout
25993 Fragile, calculation might fail
26000 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26003 \begin_layout Plain Layout
26010 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26013 \begin_layout Plain Layout
26014 The \SpecialChar TeX
26020 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26023 \begin_layout Plain Layout
26031 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26034 \begin_layout Plain Layout
26036 \begin_inset Newline newline
26044 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26047 \begin_layout Plain Layout
26048 Triangles in different orientations
26053 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26056 \begin_layout Plain Layout
26070 \begin_layout Standard
26071 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26073 for environments in the toolbar.
26076 \begin_layout Standard
26077 \begin_inset Newpage newpage
26083 \begin_layout Standard
26084 Here is an example paragraph in the shape of a nut:
26087 \begin_layout Standard
26088 \begin_inset VSpace bigskip
26097 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26098 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26100 At vero eos et accusam et justo duo dolores et ea rebum.
26101 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26103 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26104 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26108 \begin_layout Standard
26109 \begin_inset VSpace bigskip
26115 \begin_layout Standard
26116 \begin_inset Note Greyedout
26119 \begin_layout Plain Layout
26124 : shapepar paragraphs cannot run over a page break.
26132 \begin_layout Standard
26133 \begin_inset VSpace bigskip
26139 \begin_layout Standard
26144 takes care that the shape will always be preserved, no matter how much
26145 text is in the paragraph.
26146 Therefore the paragraph size changes with the amount of contained text.
26147 This can lead to paragraph sizes exceeding the page margins.
26148 To demonstrate the size scaling, here is the same example paragraph but
26149 with twice as much text:
26152 \begin_layout Standard
26153 \begin_inset Newpage newpage
26162 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26163 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26165 At vero eos et accusam et justo duo dolores et ea rebum.
26166 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26168 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26169 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26171 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26172 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26174 At vero eos et accusam et justo duo dolores et ea rebum.
26175 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26177 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26178 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26182 \begin_layout Standard
26183 \begin_inset VSpace bigskip
26189 \begin_layout Standard
26190 An exception is the shape
26195 It cannot be scaled because it must fit the size of a CD/DVD.
26196 Therefore the amount of text that fits into the shape is limited.
26197 \begin_inset Newline newline
26208 shape are fragile, meaning that the calculation of their size can fail,
26209 depending on the amount of text.
26210 You will then get the \SpecialChar LaTeX
26212 \begin_inset Quotes eld
26215 Arithmetic overflow
26216 \begin_inset Quotes erd
26220 In this case one can try to remove or add some text; if nothing works one
26221 has to use another shape.
26224 \begin_layout Standard
26225 \begin_inset VSpace bigskip
26231 \begin_layout Standard
26232 For shapes with tips you will maybe see that \SpecialChar LaTeX
26233 's hyphenation routine fails
26234 for text in the tips.
26235 Therefore it is often necessary to add hyphenation points
26240 arg "specialchar-insert hyphenation"
26245 ) to the corresponding text parts.
26248 \begin_layout Standard
26249 \begin_inset VSpace bigskip
26255 \begin_layout Standard
26256 Shapepar paragraphs are either always centered or placed on the page so
26257 that their left border touches the left page margin.
26258 You can therefore not use the paragraph dialog to align such paragraphs.
26259 A solution is to put the paragraph into a minipage or parbox and align
26261 The problem is hereby to find the right width for the box.
26262 Because if it is too wide and you center the box, the paragraph is not
26263 centered too because it sticks at the left side of the box.
26264 So you might have to play a bit with the width until it fits.
26265 Here are two heart-shaped paragraphs, the first one is not aligned, the
26266 second one is right-aligned:
26269 \begin_layout Standard
26270 \begin_inset Newpage newpage
26276 \begin_layout Heart
26280 Lo\SpecialChar softhyphen
26281 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26282 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26284 At vero eos et accusam et justo duo dolores et ea rebum.
26285 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26289 \begin_layout Standard
26290 \begin_inset VSpace bigskip
26296 \begin_layout Standard
26299 \begin_inset Box Frameless
26309 height_special "totalheight"
26314 backgroundcolor "none"
26317 \begin_layout Heart
26321 Lo\SpecialChar softhyphen
26322 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26323 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26325 At vero eos et accusam et justo duo dolores et ea rebum.
26326 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26335 \begin_layout Subsection
26339 \begin_layout Standard
26340 You can define any shape you want.
26341 Doing this manually is a lot of work because every coordinate must be specified.
26342 But there is a way to let the computer calculate the coordinates:
26345 \begin_layout Enumerate
26346 Install the program
26347 \begin_inset CommandInset href
26350 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26357 \begin_layout Enumerate
26364 TeX/LaTeX\SpecialChar menuseparator
26365 Settings\SpecialChar menuseparator
26368 and select the font size you are using in your document.
26369 For example this document uses the size 12
26370 \begin_inset space \thinspace{}
26376 \begin_layout Enumerate
26380 \begin_layout Enumerate
26383 TeX/LaTeX\SpecialChar menuseparator
26386 to export the shape to coordinates.
26387 In the appearing dialog use either the outline of your shape for the coordinate
26388 s or the path itself.
26392 \begin_layout Plain Layout
26393 For more information see
26394 \begin_inset CommandInset href
26396 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26408 \begin_layout Standard
26409 The coordinates are written into a \SpecialChar TeX
26411 To use it for your \SpecialChar LyX
26415 \begin_layout Enumerate
26416 Place the cursor before the first character of your paragraph (or into a
26420 \begin_layout Enumerate
26421 Open in \SpecialChar LyX
26424 Insert\SpecialChar menuseparator
26425 File\SpecialChar menuseparator
26427 \begin_inset space ~
26432 , select the file and use
26441 \begin_layout Standard
26442 \begin_inset VSpace defskip
26448 \begin_layout Standard
26449 \begin_inset Note Greyedout
26452 \begin_layout Plain Layout
26457 : The changed shape only applies to the current paragraph; everything is
26458 reset to normal for the next paragraph.
26459 Therefore the shape definition file must be input into every paragraph
26460 with the desired shape.
26468 \begin_layout Standard
26469 \begin_inset VSpace bigskip
26475 \begin_layout Standard
26476 Here is an example:
26479 \begin_layout Standard
26480 \begin_inset VSpace bigskip
26486 \begin_layout Standard
26487 \begin_inset CommandInset include
26489 filename "SpecialParagraphShape.tex"
26495 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26496 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26498 At vero eos et accusam et justo duo dolores et ea rebum.
26499 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26501 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26502 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26506 \begin_layout Standard
26507 \begin_inset VSpace bigskip
26513 \begin_layout Standard
26518 to draw complexer shapes in
26522 you can draw the shape in a program of your choice and import the resulting
26528 Then you only need to draw a line or spline along the outline of the image.
26531 \begin_layout Standard
26532 \begin_inset VSpace bigskip
26538 \begin_layout Standard
26541 Custom paragraph shapes
26543 also provides the two commands
26551 which can be used to define custom shapes coordinate by coordinate.
26555 \begin_layout Plain Layout
26556 These commands are internally used for all shapes described here.
26561 For information how these styles are used and about further customization
26562 possibilities, have a look at the documentation of the package
26567 \begin_inset CommandInset citation
26576 \begin_layout Bibliography
26577 \begin_inset CommandInset bibitem
26578 LatexCommand bibitem
26583 Documentation of the \SpecialChar LaTeX
26585 \begin_inset CommandInset href
26588 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26595 \begin_layout Bibliography
26596 \begin_inset CommandInset bibitem
26597 LatexCommand bibitem
26602 Documentation of the \SpecialChar LaTeX
26604 \begin_inset CommandInset href
26607 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"