1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
5 \origin /systemlyxdir/doc/
8 % DO NOT ALTER THIS PREAMBLE!!!
10 % This preamble is designed to ensure that the manual prints
11 % out as advertised. If you mess with this preamble,
12 % parts of the manual may not print out as expected. If you
13 % have problems LaTeXing this file, please contact
14 % the documentation team
15 % email: lyx-docs@lists.lyx.org
21 % set fonts for nicer pdf view
22 \IfFileExists{lmodern.sty}
23 {\usepackage{lmodern}}{}
25 \fi % end if pdflatex is used
27 % the pages of the TOC are numbered roman
28 % and a PDF-bookmark for the TOC is added
30 \let\myTOC\tableofcontents
31 \renewcommand{\tableofcontents}{%
32 \pdfbookmark[1]{\contentsname}{}
35 \pagenumbering{arabic}}
37 % extra space for tables
38 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
40 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
41 \use_default_options false
49 \maintain_unincluded_children false
52 InsetLayout CharStyle:MenuItem
61 \newcommand*{\menuitem}[1]{{\sffamily #1}}
66 \language_package default
69 \font_roman "default" "default"
70 \font_sans "default" "default"
71 \font_typewriter "default" "default"
72 \font_math "auto" "auto"
73 \font_default_family default
74 \use_non_tex_fonts false
77 \font_sf_scale 100 100
78 \font_tt_scale 100 100
80 \default_output_format default
82 \bibtex_command default
83 \index_command default
87 \pdf_title "LyX's Additional Features manual"
88 \pdf_author "LyX Team"
89 \pdf_subject "LyX's additional features documentation"
90 \pdf_keywords "LyX, Documentation, Additional"
92 \pdf_bookmarksnumbered true
93 \pdf_bookmarksopen false
94 \pdf_bookmarksopenlevel 1
99 \pdf_pdfusetitle false
100 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
103 \use_package amsmath 1
104 \use_package amssymb 1
105 \use_package cancel 0
107 \use_package mathdots 1
108 \use_package mathtools 0
109 \use_package mhchem 1
110 \use_package stackrel 0
111 \use_package stmaryrd 0
112 \use_package undertilde 0
114 \cite_engine_type default
118 \paperorientation portrait
122 \notefontcolor #0000ff
129 \paragraph_separation indent
130 \paragraph_indentation default
131 \quotes_language english
134 \paperpagestyle headings
135 \tracking_changes true
136 \output_changes false
140 \author -712698321 "Jürgen Spitzmüller"
141 \author -195340706 "Georg Baum"
142 \author 274215730 "scott"
143 \author 711066561 "Enrico Forestieri"
149 Additional \SpecialChar LyX
153 \begin_layout Subtitle
158 by the \SpecialChar LyX
163 \begin_layout Plain Layout
165 Principal maintainer of this file is
170 If you have comments or error corrections, please send them to the \SpecialChar LyX
173 \begin_inset Flex Code
176 \begin_layout Plain Layout
178 <lyx-docs@lists.lyx.org>
191 \begin_layout Standard
192 \begin_inset CommandInset toc
193 LatexCommand tableofcontents
200 \begin_layout Chapter
204 \begin_layout Standard
205 This manual is essentially Part II of the
207 User's Guide\SpecialChar endofsentence
210 The reason for separating the two documents is simple: the
214 is already quite lengthy, and it contains information on all of the basic
215 features one needs to know in order to prepare most documents.
216 However, the \SpecialChar LyX
217 Team has worked to make \SpecialChar LyX
218 extensible through various configuration
219 files and external packages.
220 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
222 create a layout file (or module) for it without having to alter \SpecialChar LyX
224 We've already had contributions of several new features this way, and some
225 of them are documented here.
226 There are also some more `advanced' features, such as how to control the
227 presentation of bibliographies and how to work with multi-part documents,
228 that are not covered in the
232 and are discussed here.
235 \begin_layout Standard
236 This manual also documents some special features, like fax support, version
237 control, and SGML support, which require additional software to work properly.
238 There is also a chapter on \SpecialChar LyX
240 And lastly, there's a chapter of \SpecialChar LaTeX
241 tools and tips, things you can use to
242 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
244 After all, \SpecialChar LyX
249 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
253 \begin_layout Standard
254 If you haven't read the
258 yet, you are definitely in the wrong manual.
263 is the first place to go, since it describes the notation and format of
265 You should also be thoroughly familiar with the
269 and all of the basic features of \SpecialChar LyX
270 before attempting to read this one.
273 \begin_layout Standard
274 Since many of the topics in this manual depend heavily on \SpecialChar LyX
276 with \SpecialChar LaTeX
277 , this first chapter covers the inner workings of \SpecialChar LyX
280 to generate exactly the \SpecialChar LaTeX
282 It is obviously for more seasoned \SpecialChar LyX
286 \begin_layout Chapter
288 and \SpecialChar LaTeX
292 \begin_layout Section
294 Uses \SpecialChar LaTeX
298 \begin_layout Standard
299 This chapter is for both \SpecialChar TeX
300 -nicians and the \SpecialChar LaTeX
302 In it, we'll explain how \SpecialChar LyX
303 and \SpecialChar LaTeX
304 work together to produce printable output.
305 This is the only place in any of the manuals where we assume you know something
306 about \SpecialChar LaTeX
310 \begin_layout Standard
311 At one time, \SpecialChar LyX
313 \begin_inset Quotes eld
316 WYSIWYM frontend to \SpecialChar LaTeX
318 \begin_inset Quotes erd
321 but that's no longer true.
322 There are frontends to \SpecialChar LaTeX
327 \begin_layout Plain Layout
328 Some familar ones are \SpecialChar TeX
329 maker and kile, on Linux, and \SpecialChar TeX
331 There are also the \SpecialChar LaTeX
332 modes for vi and emacs, of course.
337 These are basically text editors with the ability to run \SpecialChar LaTeX
339 errors in the file you're editing.
340 Although \SpecialChar LyX
349 run \SpecialChar LaTeX
350 , and it also indicates errors in the file, it also does much, much
352 For one thing, you don't need to know \SpecialChar LaTeX
353 to use \SpecialChar LyX
356 has added its own extensions to \SpecialChar LaTeX
358 Try the following sometime: select
359 \begin_inset Flex MenuItem
362 \begin_layout Plain Layout
363 Export\SpecialChar menuseparator
371 \begin_inset Flex MenuItem
374 \begin_layout Plain Layout
381 \begin_inset Flex MenuItem
384 \begin_layout Plain Layout
385 View\SpecialChar menuseparator
395 ), then look at the preamble of the resulting
396 \begin_inset Flex Code
399 \begin_layout Plain Layout
406 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
408 These macros are defined automatically, according to the features you use
412 \begin_layout Standard
413 There are several commands that automatically invoke \SpecialChar LaTeX
418 \begin_layout Itemize
419 \begin_inset Flex MenuItem
422 \begin_layout Plain Layout
423 Document\SpecialChar menuseparator
432 \begin_layout Itemize
433 \begin_inset Flex MenuItem
436 \begin_layout Plain Layout
437 Document\SpecialChar menuseparator
446 \begin_layout Itemize
447 \begin_inset Flex MenuItem
450 \begin_layout Plain Layout
451 File\SpecialChar menuseparator
460 \begin_layout Itemize
461 \begin_inset Flex MenuItem
464 \begin_layout Plain Layout
465 File\SpecialChar menuseparator
474 \begin_layout Standard
475 They will only invoke \SpecialChar LaTeX
476 if the file has changed since the last time \SpecialChar LaTeX
482 \begin_layout Standard
483 When \SpecialChar LyX
484 runs \SpecialChar LaTeX
485 on the file you're editing, it performs these steps:
488 \begin_layout Enumerate
489 Convert the document to \SpecialChar LaTeX
490 and save to a file with the extension
491 \begin_inset Flex Code
494 \begin_layout Plain Layout
501 \begin_inset Flex Code
504 \begin_layout Plain Layout
513 \begin_layout Enumerate
514 Run \SpecialChar LaTeX
516 \begin_inset Flex Code
519 \begin_layout Plain Layout
525 file (maybe several times), and run any other commands (such as
526 \begin_inset Flex Code
529 \begin_layout Plain Layout
536 \begin_inset Flex Code
539 \begin_layout Plain Layout
545 ) needed to compile the \SpecialChar LaTeX
549 \begin_layout Enumerate
550 If there are any errors, show the error log.
553 \begin_layout Standard
554 If you have run \SpecialChar LaTeX
556 \begin_inset Flex MenuItem
559 \begin_layout Plain Layout
562 \SpecialChar menuseparator
571 then runs a DVI viewer to display the DVI-file.
573 \begin_inset Flex MenuItem
576 \begin_layout Plain Layout
579 \SpecialChar menuseparator
588 performs further steps:
591 \begin_layout Itemize
593 \begin_inset Flex Code
596 \begin_layout Plain Layout
602 to convert the DVI file to PostScript.
605 \begin_layout Itemize
606 Run a PostScript viewer, such as
607 \begin_inset Flex Code
610 \begin_layout Plain Layout
616 , to display the PostScript file.
619 \begin_layout Standard
621 does similar things when viewing, or exporting, other formats.
624 \begin_layout Section
625 Translating \SpecialChar LaTeX
626 files into \SpecialChar LyX
630 \begin_layout Standard
631 You can import a \SpecialChar LaTeX
632 file into \SpecialChar LyX
634 \begin_inset Flex MenuItem
637 \begin_layout Plain Layout
638 File\SpecialChar menuseparator
639 Import\SpecialChar menuseparator
646 command in \SpecialChar LyX
648 This will call a program named
649 \begin_inset Flex Code
652 \begin_layout Plain Layout
658 which will create a file
659 \begin_inset Flex Code
662 \begin_layout Plain Layout
669 \begin_inset Flex Code
672 \begin_layout Plain Layout
680 will then open that file.
684 \begin_layout Plain Layout
685 \begin_inset Flex Code
688 \begin_layout Plain Layout
694 can also be run from the command line, of course.
702 \begin_layout Standard
703 \begin_inset Flex Code
706 \begin_layout Plain Layout
712 will translate most legal \SpecialChar LaTeX
713 , but not everything.
714 It will put things it doesn't understand into \SpecialChar TeX
715 code, so after translating
717 \begin_inset Flex Code
720 \begin_layout Plain Layout
726 , you can look for \SpecialChar TeX
727 code and hand-edit it until it looks right.
730 \begin_layout Standard
731 If you don't know what \SpecialChar TeX
732 code is, read the next section.
735 \begin_layout Section
736 \begin_inset CommandInset label
738 name "sec:Inserting-TeX-Code"
742 Inserting \SpecialChar TeX
743 Code into \SpecialChar LyX
747 \begin_layout Standard
748 Anything you can do in \SpecialChar LaTeX
749 you can do in \SpecialChar LyX
750 , for a very simple reason: You can
751 always insert \SpecialChar TeX
752 code into any \SpecialChar LyX
755 cannot, and will never be able to, display every possible \SpecialChar LaTeX
757 If ever you need to insert \SpecialChar LaTeX
758 commands into your \SpecialChar LyX
759 document, you can use the
761 \begin_inset Flex Code
764 \begin_layout Plain Layout
771 box, which you can insert into your document with
772 \begin_inset Flex MenuItem
775 \begin_layout Plain Layout
776 Insert\SpecialChar menuseparator
778 \change_deleted -712698321 1437633182
781 \change_inserted -712698321 1437633182
793 or the keyboard shortcut
802 \begin_layout Standard
803 Here's an example of inserting \SpecialChar LaTeX
804 commands in a \SpecialChar LyX
806 The code looks like this:
809 \begin_layout LyX-Code
813 \begin_inset Newline newline
819 \begin_inset Newline newline
822 This is an example of a minipage environment.
824 \begin_inset Newline newline
827 can put nearly everything in it, even (non-floating)
828 \begin_inset Newline newline
833 \begin_inset Newline newline
839 \begin_inset Newline newline
843 \begin_inset Newline newline
849 \begin_inset Newline newline
855 \begin_inset Newline newline
861 \begin_inset Newline newline
866 \begin_inset Newline newline
872 \begin_inset Newline newline
878 \begin_inset Newline newline
884 \begin_inset Newline newline
892 \begin_layout LyX-Code
896 \begin_layout Standard
898 \begin_inset Flex Code
901 \begin_layout Plain Layout
908 box containing this text is directly after this paragraph.
909 Those of you reading the manual in \SpecialChar LyX
910 will only see the \SpecialChar TeX
912 Those reading a printed version of the manuals will see the actual results:
913 \begin_inset VSpace bigskip
919 \begin_layout Standard
923 \begin_layout Plain Layout
930 \begin_layout Plain Layout
937 \begin_layout Plain Layout
939 This is an example of a minipage environment.
940 You can put nearly everything in it, even (non-floating) figures and tables.
944 \begin_layout Plain Layout
951 \begin_layout Plain Layout
956 \begin_layout Plain Layout
963 \begin_layout Plain Layout
970 \begin_layout Plain Layout
977 \begin_layout Plain Layout
983 \begin_layout Plain Layout
990 \begin_layout Plain Layout
997 \begin_layout Plain Layout
1004 \begin_layout Plain Layout
1014 \begin_inset VSpace bigskip
1020 \begin_layout Standard
1021 In addition to using \SpecialChar TeX
1022 code, you can also create a separate file containing
1023 some complex \SpecialChar LaTeX
1024 structure and then use
1025 \begin_inset Flex MenuItem
1028 \begin_layout Plain Layout
1029 Insert\SpecialChar menuseparator
1031 \begin_inset space ~
1039 to include your file (you should select the type
1040 \begin_inset Flex Code
1043 \begin_layout Plain Layout
1050 We recommend that you only do this if you have a
1051 \begin_inset Flex Code
1054 \begin_layout Plain Layout
1065 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1069 \begin_layout Standard
1070 There are a few last points to emphasize:
1073 \begin_layout Itemize
1079 check if your \SpecialChar LaTeX
1083 \begin_layout Itemize
1084 Beware of reinventing the wheel.
1087 \begin_layout Standard
1088 On that last point, \SpecialChar LyX
1089 does have quite a few features tucked into it, and
1091 Be sure to check the manuals to make sure that \SpecialChar LyX
1092 doesn't have such-and-such
1093 feature before you decide you have to do it by hand.
1094 Moreover, there are numerous \SpecialChar LaTeX
1095 packages out there to do all sorts of things,
1096 from labels to envelopes to fancy multipage tables.
1098 \begin_inset CommandInset href
1101 target "http://www.ctan.org/"
1108 \begin_layout Standard
1109 If you do need to do some wild and fancy things within your document, be
1110 sure to check out a good \SpecialChar LaTeX
1111 book for assistance.
1112 There are a number of them listed in the bibliography of the
1119 \begin_layout Section
1121 and the \SpecialChar LaTeX
1125 \begin_layout Subsection
1126 About the \SpecialChar LaTeX
1130 \begin_layout Standard
1131 If you already know \SpecialChar LaTeX
1132 , there is no need to explain here what the preamble
1134 If you don't, the following will give you some ideas—we recommend again
1135 that you consult a \SpecialChar LaTeX
1136 book for further information.
1137 In any case, you should read the points below, because they explain what
1138 you can do and what you don't need to do in the \SpecialChar LaTeX
1139 preamble of a \SpecialChar LyX
1143 \begin_layout Standard
1144 The \SpecialChar LaTeX
1145 preamble comes at the very beginning of a document,
1153 \begin_layout Itemize
1154 Declare the document class.
1156 \begin_inset Newline newline
1160 already does this for you.
1161 If you're a seasoned \SpecialChar LaTeX
1162 -nician, and you have a custom document class you
1163 want to use, check out the
1165 Customization Manual
1167 for information on how to make \SpecialChar LyX
1171 \begin_layout Itemize
1172 Declare the usage of packages.
1174 \begin_inset Newline newline
1178 packages provide special commands, which are only available within a document
1179 when the package has been declared in the preamble.
1180 In addition to providing special commands, the inclusion of a package can
1181 change the document.
1182 For example, the package
1183 \begin_inset Flex Code
1186 \begin_layout Plain Layout
1192 forces all paragraphs to be indented.
1193 There are other packages for labels, envelopes, margins, etc.
1197 \begin_layout Itemize
1198 Set counters, variables, lengths and widths.
1200 \begin_inset Newline newline
1203 There are several \SpecialChar LaTeX
1204 counters and variables that
1208 be set globally from within the preamble in order to have the desired effect.
1209 (There are variables that you can set and reset inside the document, too.)
1210 Margins are a good example of something that must be set in the preamble.
1211 Another example is the label format for lists.
1212 You can actually set these just about anywhere, but it's best to do it
1213 just once, inside the preamble.
1216 \begin_layout Itemize
1217 Declare user defined commands (with
1218 \begin_inset Flex Code
1221 \begin_layout Plain Layout
1230 \begin_inset Flex Code
1233 \begin_layout Plain Layout
1242 \begin_inset Newline newline
1245 These are abbreviations for \SpecialChar LaTeX
1246 commands which appear very often inside a document.
1247 Although the preamble is a good place to declare such commands, they
1251 be declared anywhere (before they are used for the first time, of course).
1252 This can be useful if there is a lot of raw \SpecialChar LaTeX
1253 code in your document, which
1254 normally should not be the case.
1257 \begin_layout Standard
1259 adds its own set of definitions to the preamble of the
1260 \begin_inset Flex Code
1263 \begin_layout Plain Layout
1270 This makes \SpecialChar LaTeX
1271 files generated by \SpecialChar LyX
1275 \begin_layout Subsection
1276 Changing the Preamble
1279 \begin_layout Standard
1280 The commands which \SpecialChar LyX
1281 adds to the preamble of a \SpecialChar LaTeX
1282 file are fixed; you can't
1283 change them without patching \SpecialChar LyX
1285 You can, however, add your own stuff to the preamble by selecting
1286 \begin_inset Flex MenuItem
1289 \begin_layout Plain Layout
1292 \begin_inset space ~
1301 \begin_inset Flex MenuItem
1304 \begin_layout Plain Layout
1305 Document\SpecialChar menuseparator
1313 adds anything in the
1314 \begin_inset Flex MenuItem
1317 \begin_layout Plain Layout
1323 dialog to its own built-in preamble.
1324 Before adding your own declarations in the preamble, you should make sure
1325 that \SpecialChar LyX
1326 doesn't already support what you want to do.
1327 (Remember what we said about reinventing the wheel?) Also,
1329 make sure your preamble code is correct
1333 doesn't check it for you.
1334 If there is an error, you're likely to get an error like
1335 \begin_inset Quotes eld
1339 \begin_inset Flex Code
1342 \begin_layout Plain Layout
1351 \begin_inset Quotes erd
1355 If you see this error, check your preamble.
1358 \begin_layout Subsection
1362 \begin_layout Standard
1363 Here are some examples of what you can add to a preamble, and what they
1367 \begin_layout Subsubsection
1371 \begin_layout Standard
1372 There are two variables under \SpecialChar LaTeX
1373 that control page position:
1374 \begin_inset Flex Code
1377 \begin_layout Plain Layout
1386 \begin_inset Flex Code
1389 \begin_layout Plain Layout
1398 Their names should be self-explanatory.
1399 These variables are useful if you think for a moment about computer labels.
1400 Sometimes, the size of a print medium and the area of the medium that you
1401 can actually print on aren't the same.
1403 \begin_inset Flex Code
1406 \begin_layout Plain Layout
1415 \begin_inset Flex Code
1418 \begin_layout Plain Layout
1429 \begin_layout Standard
1430 The default values for
1431 \begin_inset Flex Code
1434 \begin_layout Plain Layout
1443 \begin_inset Flex Code
1446 \begin_layout Plain Layout
1455 \begin_inset space \thinspace{}
1459 \begin_inset space \thinspace{}
1463 \begin_inset space \space{}
1466 the page isn't shifted.
1467 Unfortunately, some DVI drivers always seem to shift the page.
1468 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1469 If you're using \SpecialChar LyX
1470 on a system that you don't personally maintain, and your
1471 sysadmin is a doofus,
1472 \begin_inset Flex Code
1475 \begin_layout Plain Layout
1484 \begin_inset Flex Code
1487 \begin_layout Plain Layout
1496 Suppose your left and top margins are always 0.5
1497 \begin_inset space \thinspace{}
1501 You can add this to the preamble:
1504 \begin_layout LyX-Code
1512 \begin_layout LyX-Code
1520 \begin_layout Standard
1521 and your margins should now be correct.
1524 \begin_layout Subsubsection
1528 \begin_layout Standard
1529 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1530 There's a rather nice package, available at your nearest CTAN archive,
1531 for printing sheets of labels:
1532 \begin_inset Flex Code
1535 \begin_layout Plain Layout
1542 Now, your system may not have this package installed by default.
1543 We leave that up to you to check.
1544 You'll also want to read the documentation for it; we're not going to do
1546 Since this is an example, however, we'll give you an example of how you
1550 \begin_layout Standard
1551 First, make sure you're using the
1552 \begin_inset Flex Code
1555 \begin_layout Plain Layout
1562 Next, you need to put the following in your preamble:
1565 \begin_layout LyX-Code
1571 \begin_layout LyX-Code
1577 \begin_layout LyX-Code
1583 \begin_layout LyX-Code
1589 \begin_layout LyX-Code
1595 \begin_layout LyX-Code
1601 \begin_layout LyX-Code
1607 \begin_layout Standard
1608 This sets things up for Avery label sheets, stock #5360.
1609 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1612 \begin_inset Flex Code
1615 \begin_layout Plain Layout
1624 \begin_inset Flex Code
1627 \begin_layout Plain Layout
1635 around each label text.
1636 This and other special features of
1637 \begin_inset Flex Code
1640 \begin_layout Plain Layout
1646 are explained in its documentation.
1649 \begin_layout Standard
1650 Someday, someone may write a \SpecialChar LyX
1651 layout file to support this package directly.
1652 Maybe that someone is you.
1655 \begin_layout Subsubsection
1656 Example #3: Paragraph Indentation
1659 \begin_layout Standard
1660 Americans are trained to indent the first line of
1665 As with all of their other weird quirks, most Americans will whine and
1666 moan until they can have their way and indent the first line of all paragraphs.
1675 \begin_layout Standard
1676 Of course, this behavior isn't standard typography.
1677 In books, you typically only indent the first line of a paragraph
1681 it follows another one.
1682 The idea behind indenting the first line of a paragraph is to distinguish
1683 neighboring paragraphs from one another.
1684 If there is no previous paragraph—for example, if it follows a figure or
1685 is the first paragraph in a section—then there is no need for indentation.
1689 \begin_layout Standard
1690 If you're a typical American (we're still joking!), though, you don't care
1691 about such esoteric things; you want your indentation! Add this to the
1695 \begin_layout LyX-Code
1698 usepackage{indentfirst}
1701 \begin_layout Standard
1702 If your \SpecialChar TeX
1703 distribution isn't braindead, you'll have this package, and all
1704 of your paragraphs will get the indentation the Founding Fathers intended
1708 \begin_layout Subsubsection
1709 Example #4: This Document
1712 \begin_layout Standard
1713 You can also check out the preamble of this document to get an idea of some
1714 of the advanced things you can do.
1717 \begin_layout Section
1719 and \SpecialChar LaTeX
1723 \begin_layout Standard
1724 When \SpecialChar LyX
1725 calls \SpecialChar LaTeX
1726 , it tells \SpecialChar LaTeX
1727 to blithely ignore any errors and keep going.
1728 It then uses the logfile from the \SpecialChar LaTeX
1729 run to do a post-mortem.
1730 After analyzing the logfile, \SpecialChar LyX
1731 displays a dialog listing the errors.
1732 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1734 where the error occurred.
1738 \begin_layout Plain Layout
1740 Analyzing the logfile is a tough job, and \SpecialChar LyX
1741 doesn't always go to the right
1743 There are also cases where \SpecialChar LaTeX
1744 reports the error on one line, but the actual
1746 This is not unlike forgetting a closing brace in a program: You'll get
1747 an error, but only later.
1755 \begin_layout Standard
1756 Some folks also like to look at the log file directly: It is available from
1758 \begin_inset Flex MenuItem
1761 \begin_layout Plain Layout
1764 \SpecialChar menuseparator
1768 \begin_inset space ~
1777 There are some fairly common error messages and warnings.
1778 We'll cover those here.
1779 You should look at a good \SpecialChar LaTeX
1780 book for a complete listing.
1783 \begin_layout Itemize
1784 \begin_inset Flex Code
1787 \begin_layout Plain Layout
1795 \begin_inset Newline newline
1798 Anything beginning with these words is a warning message for the purpose
1800 \begin_inset Quotes eld
1804 \begin_inset Quotes erd
1807 the \SpecialChar LaTeX
1809 You'll get messages like this if you added or changed cross-references
1810 or bibliography entries, in which case, \SpecialChar LaTeX
1811 is trying to tell you that you
1812 need to make another run.
1813 You can by-and-large ignore these.
1816 \begin_layout Itemize
1817 \begin_inset Flex Code
1820 \begin_layout Plain Layout
1828 \begin_inset Newline newline
1831 Another warning message, this time about fonts which \SpecialChar LaTeX
1833 The rest of the message will often say something about a replacement font
1834 that \SpecialChar LaTeX
1836 You can safely ignore these, too.
1839 \begin_layout Itemize
1840 \begin_inset Flex Code
1843 \begin_layout Plain Layout
1852 \begin_inset Newline newline
1861 They are warnings about lines that were too long and run past the right
1863 Almost always, this is unnoticeable in the final output.
1864 (It can be just a point or two.) Or, only one or two characters extend past
1867 seems to generate at least one of these messages for just about any document
1869 \begin_inset Newline newline
1872 You can ignore these messages.
1873 Your eyes will tell you if there's a problem with something that's too
1874 wide; just look at the output.
1878 \begin_layout Plain Layout
1879 You can also enable the `draft' option in
1880 \begin_inset Flex MenuItem
1883 \begin_layout Plain Layout
1886 \SpecialChar menuseparator
1894 , and then \SpecialChar LaTeX
1895 will draw a black box in the margin of lines that are overfull.
1903 \begin_layout Itemize
1904 \begin_inset Flex Code
1907 \begin_layout Plain Layout
1916 \begin_inset Newline newline
1919 Not quite as common as its cousin.
1921 seems to like to print lines that are a bit too wide as opposed to ones
1922 that are a bit too narrow.
1923 We have no idea why.
1926 \begin_layout Itemize
1927 \begin_inset Flex Code
1930 \begin_layout Plain Layout
1939 \begin_inset Flex Code
1942 \begin_layout Plain Layout
1951 \begin_inset Newline newline
1954 Warnings about troubles breaking the page.
1955 Once again, just look at the output.
1956 Your eyes will tell you where something has gone wrong.
1959 \begin_layout Itemize
1960 \begin_inset Flex Code
1963 \begin_layout Plain Layout
1966 \begin_inset Quotes els
1970 \begin_inset Quotes ers
1979 \begin_inset Newline newline
1983 \begin_inset Quotes eld
1987 \begin_inset Quotes erd
1990 isn't installed on this system.
1991 This usually appears because some package your document needs isn't installed.
1992 If you didn't touch the preamble or didn't use the
1993 \begin_inset Flex Code
1996 \begin_layout Plain Layout
2004 command, then one of the packages \SpecialChar LyX
2005 tried to load is missing.
2007 \begin_inset Flex MenuItem
2010 \begin_layout Plain Layout
2011 Help\SpecialChar menuseparator
2018 to get a list of packages that \SpecialChar LyX
2020 This file is updated whenever you reconfigure \SpecialChar LyX
2022 \begin_inset Flex MenuItem
2025 \begin_layout Plain Layout
2026 Tools\SpecialChar menuseparator
2032 ) and tells you which packages have been detected and what they do.
2033 \begin_inset Newline newline
2037 \begin_inset Flex Code
2040 \begin_layout Plain Layout
2048 command and the package in question isn't installed, then you'll need to
2049 install it yourself.
2052 \begin_layout Itemize
2053 \begin_inset Flex Code
2056 \begin_layout Plain Layout
2058 Error: Unknown option
2064 \begin_inset Newline newline
2067 Error messages beginning with this are trying to tell you that you specified
2068 a bad or undefined option to a package.
2069 Check the package's documentation.
2072 \begin_layout Itemize
2073 \begin_inset Flex Code
2076 \begin_layout Plain Layout
2077 Undefined control sequence
2083 \begin_inset Newline newline
2086 If you've inserted \SpecialChar LaTeX
2087 code into your document, but made a typo, you'll get
2089 You may have forgotten to load a package.
2090 In any case, this error message usually means that you used an undefined
2095 \begin_layout Standard
2096 There are other error and warning messages.
2097 Some are self-explanatory.
2098 These are usually \SpecialChar LaTeX
2100 Others are downright cryptic.
2101 These are usually \SpecialChar TeX
2102 error messages, and we really have
2106 what they mean or how to decipher them.
2110 \begin_layout Standard
2111 There's a general sequence you should follow if you get error messages:
2114 \begin_layout Enumerate
2115 Look at the \SpecialChar LaTeX
2116 code you inserted for typos.
2119 \begin_layout Enumerate
2120 If there are no typos, check that you used the command(s) correctly.
2123 \begin_layout Enumerate
2124 If you get a bunch of error boxes piled up at the very top of the document—and
2125 especially if you see a
2126 \begin_inset Quotes eld
2130 \begin_inset Flex Code
2133 \begin_layout Plain Layout
2142 \begin_inset Quotes erd
2145 error—it means that there are errors in the preamble.
2146 Start debugging your preamble.
2149 \begin_layout Enumerate
2150 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2152 document, the first suspect is your \SpecialChar LaTeX
2153 distribution itself.
2154 Check for missing packages and install them.
2157 \begin_layout Enumerate
2158 Okay, so there are no missing packages.
2159 Did you use any of the fine-tuning options in \SpecialChar LyX
2160 ? Specifically, did you
2164 any of them, like trying to manually insert lots of
2165 \begin_inset Flex Code
2168 \begin_layout Plain Layout
2170 \begin_inset space ~
2179 \begin_inset Flex Code
2182 \begin_layout Plain Layout
2189 \begin_inset Flex Code
2192 \begin_layout Plain Layout
2198 ? Did you try to kludge something together with these instead of using the
2199 appropriate paragraph environment?
2202 \begin_layout Enumerate
2203 All right, you didn't use any of the fine-tuning options, you played by
2205 Did you try to pull a fancy maneuver? Did you do something funky inside
2206 a table or an equation, like inserting a graphic into a table cell?
2209 \begin_layout Enumerate
2210 Do you have long sections of text where \SpecialChar LaTeX
2211 cannot find a place to break a
2212 line? By default, \SpecialChar LaTeX
2213 is rather strict about how much extra inter-word spacing
2214 it will add in order to break a line.
2215 Preferably, you should rework the paragraph to avoid the problem.
2216 If this isn't an option, you can wrap your text in
2217 \begin_inset Flex Code
2220 \begin_layout Plain Layout
2228 to make \SpecialChar LaTeX
2229 's line breaking more, well, sloppy.
2232 \begin_layout Enumerate
2233 Did you go overboard with the nesting? \SpecialChar LyX
2234 (currently) doesn't check to make
2235 sure you're in the limits for nesting environments.
2236 If you nested a bunch of environments to the
2237 \begin_inset Formula $17^{\mathrm{th}}$
2240 level, that's the problem.
2241 (The limit in \SpecialChar LaTeX
2245 \begin_layout Enumerate
2246 Okay, you didn't get any error messages, but your output looks awful.
2247 If you have a table or figure that's too wide or long for the page, you
2249 \begin_inset Separator parbreak
2256 \begin_layout Enumerate
2257 rescale the figure so it fits.
2260 \begin_layout Enumerate
2261 trim down the table so it fits.
2265 \begin_layout Enumerate
2266 If something else is wrong with the output, and you didn't try to pull anything
2267 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2270 \begin_layout Standard
2271 If all this doesn't help—well, then
2275 you might have found a bug in \SpecialChar LyX
2280 \begin_layout Chapter
2284 \begin_layout Section
2285 Customizing Bibliographies with Bib\SpecialChar TeX
2289 \begin_layout Standard
2290 The most basic information about how to use Bib\SpecialChar TeX
2291 with \SpecialChar LyX
2295 Bibliography databases (Bib\SpecialChar TeX
2303 The following subsections explain special bibliography features supported
2308 \begin_layout Subsection
2309 Alternative Citation Styles
2312 \begin_layout Standard
2313 Standard Bib\SpecialChar TeX
2315 \begin_inset space \thinspace{}
2319 \begin_inset space \space{}
2323 \begin_inset Quotes eld
2327 \begin_inset Quotes erd
2330 ) to refer to a cited work.
2331 However, in many scientific disciplines, other citation styles are in use.
2332 The most common one is the author-year style (e.
2333 \begin_inset space \thinspace{}
2337 \begin_inset space \space{}
2341 \begin_inset Quotes eld
2345 \begin_inset Quotes erd
2350 supports two packages that provide this style,
2351 \begin_inset Flex Code
2354 \begin_layout Plain Layout
2361 \begin_inset Flex Code
2364 \begin_layout Plain Layout
2371 Both packages have their pros and cons, which cannot be listed in detail.
2372 If you only want to have simple author-year (or author-numerical) style,
2373 or if you want to use one of the countless style files for
2374 \begin_inset Flex Code
2377 \begin_layout Plain Layout
2383 , then the established
2384 \begin_inset Flex Code
2387 \begin_layout Plain Layout
2393 package is probably your choice.
2394 If you need special features like short title references, ibidem etc., you
2396 \begin_inset Flex Code
2399 \begin_layout Plain Layout
2408 \begin_layout Standard
2409 The handling of both packages in \SpecialChar LyX
2410 is basically the same.
2412 \begin_inset Flex MenuItem
2415 \begin_layout Plain Layout
2416 Document\SpecialChar menuseparator
2423 \begin_inset Flex MenuItem
2426 \begin_layout Plain Layout
2433 \begin_inset Flex MenuItem
2436 \begin_layout Plain Layout
2443 \begin_inset Flex MenuItem
2446 \begin_layout Plain Layout
2453 With both packages, you will get some extra features in the citation dialog
2454 and you can select the style of the reference (
2455 \begin_inset Quotes eld
2459 \begin_inset Quotes erd
2463 \begin_inset Quotes eld
2467 \begin_inset Quotes erd
2471 \begin_inset Quotes eld
2475 \begin_inset Quotes erd
2479 \begin_inset Quotes eld
2483 \begin_inset Quotes erd
2487 Note that both packages need specifically designed style files.
2488 They both ship their own, but there are lots of additional style files,
2489 and there is even an interactive style file builder
2493 \begin_layout Plain Layout
2495 \begin_inset Flex URL
2498 \begin_layout Plain Layout
2500 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2511 \begin_inset Flex Code
2514 \begin_layout Plain Layout
2523 \begin_layout Subsection
2524 Sectioned Bibliographies
2527 \begin_layout Standard
2528 Sometimes you might need to divide your bibliography into several sections.
2529 If you are for instance a historian, the possibility to separate sources
2530 and scientific works is most likely a
2531 \begin_inset Quotes eld
2535 \begin_inset Quotes erd
2539 Unfortunately, Bib\SpecialChar TeX
2540 itself does not allow you to do this.
2541 But with the help of some \SpecialChar LaTeX
2542 packages, Bib\SpecialChar TeX
2543 can be extended to fit your needs.
2546 \begin_layout Standard
2548 provides native support for one of these packages,
2556 \begin_layout Plain Layout
2558 \begin_inset Flex URL
2561 \begin_layout Plain Layout
2563 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2573 The advantage of this package (compared to other packages like
2577 ) is that you don't need to define new citation commands.
2578 Instead, you need to prepare different bibliographic databases which include
2579 the entries for the different sections of the bibliography.
2580 For example: If you want to divide your bibliography into the sections
2582 \begin_inset Quotes eld
2586 \begin_inset Quotes erd
2590 \begin_inset Quotes eld
2594 \begin_inset Quotes erd
2597 , you first need to create two bibliographic databases, e.
2598 \begin_inset space \thinspace{}
2602 \begin_inset space \space{}
2606 \begin_inset Flex Code
2609 \begin_layout Plain Layout
2616 \begin_inset Flex Code
2619 \begin_layout Plain Layout
2629 \begin_layout Standard
2631 \begin_inset Flex MenuItem
2634 \begin_layout Plain Layout
2635 Document\SpecialChar menuseparator
2642 \begin_inset Flex MenuItem
2645 \begin_layout Plain Layout
2652 \begin_inset Flex MenuItem
2655 \begin_layout Plain Layout
2656 Sectioned bibliography
2662 Now you can insert multiple Bib\SpecialChar TeX
2663 bibliographies, one for each section of
2665 Returning to our example: Insert the Bib\SpecialChar TeX
2667 \begin_inset Flex Code
2670 \begin_layout Plain Layout
2676 and a second one for the database
2677 \begin_inset Flex Code
2680 \begin_layout Plain Layout
2687 You are free to use the same or different styles for each section.
2688 Additionally, you can choose if the bibliography section should contain
2690 \begin_inset Quotes eld
2693 all cited references
2694 \begin_inset Quotes erd
2697 of the specified database(s) (which is the default),
2698 \begin_inset Quotes eld
2701 all uncited references
2702 \begin_inset Quotes erd
2706 \begin_inset Quotes eld
2710 \begin_inset Quotes erd
2714 This might be useful if you would like to separate your bibliography into
2716 \begin_inset Quotes eld
2720 \begin_inset Quotes erd
2724 \begin_inset Quotes eld
2728 \begin_inset Quotes erd
2732 \begin_inset Quotes eld
2736 \begin_inset Quotes erd
2740 The titles for the sections can be added as ordinary sections or subsections.
2742 \begin_inset Flex Code
2745 \begin_layout Plain Layout
2751 removes the bibliography title, you have to manually re-add that, too (as
2752 a chapter* or section*, for instance).
2755 \begin_layout Subsection
2756 Multiple Bibliographies
2759 \begin_layout Standard
2760 Multiple bibliographies, e.
2761 \begin_inset space \thinspace{}
2765 \begin_inset space \space{}
2768 a bibliography for each section or chapter of the document, are not supported
2769 by Bib\SpecialChar TeX
2772 \begin_inset Flex Code
2775 \begin_layout Plain Layout
2781 package, which is used for the creation of sectioned bibliographies in
2783 (see the previous section), provides an easy way to solve this task, if
2784 you are willing to use some
2785 \begin_inset Flex MenuItem
2788 \begin_layout Plain Layout
2796 \begin_inset space ~
2800 \begin_inset CommandInset ref
2802 reference "sec:Inserting-TeX-Code"
2810 \begin_layout Plain Layout
2811 An alternative approach is to use the
2812 \begin_inset Flex Code
2815 \begin_layout Plain Layout
2822 \begin_inset Flex Code
2825 \begin_layout Plain Layout
2831 package, respectively.
2839 \begin_layout Standard
2841 \begin_inset Flex MenuItem
2844 \begin_layout Plain Layout
2845 Document\SpecialChar menuseparator
2852 \begin_inset Flex MenuItem
2855 \begin_layout Plain Layout
2862 \begin_inset Flex MenuItem
2865 \begin_layout Plain Layout
2866 Sectioned bibliography
2872 In the document, you have to enclose the sections, which shall contain
2873 their own bibliography (including the Bib\SpecialChar TeX
2874 bibliography itself), between
2876 \begin_inset Flex Code
2879 \begin_layout Plain Layout
2888 \begin_inset Flex Code
2891 \begin_layout Plain Layout
2899 (those commands have to be inserted as \SpecialChar TeX
2901 The bibliography will contain all references that have been cited in the
2903 \begin_inset Flex Code
2906 \begin_layout Plain Layout
2917 If you are using this approach, then every citation reference has to be
2919 \begin_inset Flex Code
2922 \begin_layout Plain Layout
2930 \begin_inset Flex Code
2933 \begin_layout Plain Layout
2942 \begin_layout Section
2946 \begin_layout Subsection
2950 \begin_layout Standard
2951 When you are working on a large file with many sections, it is often convenient
2952 to break up the document into several files, or perhaps you have something
2953 where a table may change from time to time, but the preceding text does
2955 In these cases, you should seriously consider using multipart documents.
2956 For example, scientific papers often have five major sections: the introduction
2957 , observations, results, discussion, and conclusion.
2958 Each of these could be its own separate \SpecialChar LyX
2960 \begin_inset Quotes eld
2964 \begin_inset Quotes erd
2967 file which contains the title, authors, abstract, references, etc., plus
2968 the five included files.
2969 It is important to note that each of these files is a full \SpecialChar LyX
2971 can be formatted and printed on its own, as well as included in a master
2973 Each of these files must have the same document class, however—don't attempt
2974 to mix book classes with article classes.
2975 You may also include \SpecialChar LaTeX
2976 files; however, these files must not have their own
2978 \begin_inset space \thinspace{}
2982 \begin_inset space \space{}
2985 everything up to and including the
2986 \begin_inset Flex Code
2989 \begin_layout Plain Layout
2998 \begin_inset Flex Code
3001 \begin_layout Plain Layout
3009 line must be deleted) or else errors will be generated when you try to
3013 \begin_layout Standard
3015 allows you to include files quite easily with
3016 \begin_inset Flex MenuItem
3019 \begin_layout Plain Layout
3020 Insert\SpecialChar menuseparator
3022 \begin_inset space ~
3031 When you click on this selection a small box is inserted into the file
3032 at the current cursor location.
3033 Clicking on the box raises a dialog which allows you to select the file
3034 to be included, and the method of its inclusion.
3038 \begin_layout Standard
3039 The file selection box should by now be obvious.
3040 The three inclusion methods are
3041 \begin_inset Quotes eld
3045 \begin_inset Quotes erd
3049 \begin_inset Quotes eld
3053 \begin_inset Quotes erd
3057 \begin_inset Quotes eld
3061 \begin_inset Quotes erd
3065 The difference between
3066 \begin_inset Quotes eld
3070 \begin_inset Quotes erd
3074 \begin_inset Quotes eld
3078 \begin_inset Quotes erd
3081 is really only meaningful to \SpecialChar LaTeX
3082 perts, but the practical difference is that
3084 \begin_inset Quotes eld
3088 \begin_inset Quotes erd
3091 are typeset beginning on a new page, while files that are
3092 \begin_inset Quotes eld
3096 \begin_inset Quotes erd
3099 are typeset starting on the current page.
3102 \begin_layout Standard
3103 Generally, the master file is converted into a full \SpecialChar LaTeX
3104 file before typesetting,
3105 while the included files are converted to \SpecialChar LaTeX
3106 files that do not have all the
3107 preamble information.
3110 \begin_layout Standard
3112 \begin_inset Quotes eld
3116 \begin_inset Quotes erd
3119 included file allows you to include a file typeset exactly as it appears
3121 \begin_inset space \thinspace{}
3125 \begin_inset space \space{}
3129 \begin_inset Flex Code
3132 \begin_layout Plain Layout
3138 mode, with the characters set in a fixed-width typewriter font.
3139 Normally, spaces in this file are invisible, though two consecutive spaces
3140 are conserved, unlike \SpecialChar LyX
3141 's normal treatment of spaces.
3142 However, setting the
3143 \begin_inset Flex MenuItem
3146 \begin_layout Plain Layout
3148 \begin_inset space ~
3152 \begin_inset space ~
3156 \begin_inset space ~
3164 checkbox typesets a mark to unambiguously define the presence of a space.
3168 \begin_layout Subsection
3169 Cross-References Between Files
3172 \begin_layout Standard
3173 \begin_inset Box Shadowbox
3183 height_special "totalheight"
3188 backgroundcolor "none"
3191 \begin_layout Plain Layout
3192 This section is somewhat out of date.
3193 Need to describe default master documents and how children are opened when
3203 \begin_layout Standard
3204 It is possible to set up cross-references between the different files.
3205 First, open all the files in question: let's call them A and B in a two
3206 file example, where B is included in A.
3207 Let's say you insert a label in A, then want to reference it in B.
3208 Open the cross-reference dialog whilst in document B, and you can select
3210 \begin_inset Quotes eld
3214 \begin_inset Quotes erd
3220 \begin_layout Subsection
3221 Bibliography Lists in all Subdocuments
3224 \begin_layout Standard
3225 \begin_inset Box Frameless
3235 height_special "totalheight"
3240 backgroundcolor "none"
3243 \begin_layout Plain Layout
3244 This section also needs updating.
3245 There is now material about this on the wiki, and it could be copied here.
3253 \begin_layout Standard
3254 Copy the bibliography list with all entries to all subdocuments and transform
3256 This way \SpecialChar LyX
3258 \begin_inset Flex Code
3261 \begin_layout Plain Layout
3267 -files and you can easily insert references without making the bibliography
3271 \begin_layout Standard
3272 As the bibliography list is in a comment, \SpecialChar LaTeX
3273 won't use it and the references
3274 will look like this: [?], instead of like this: [1].
3275 One solution is to use the \SpecialChar LaTeX
3277 \begin_inset Flex Code
3280 \begin_layout Plain Layout
3286 that will only include comments by processing the files separately.
3287 To do this, add in the \SpecialChar LaTeX
3288 preamble of every subdocument the following:
3291 \begin_layout LyX-Code
3297 \begin_layout LyX-Code
3300 includecomment{comment}
3303 \begin_layout Standard
3305 \begin_inset Flex URL
3308 \begin_layout Plain Layout
3310 http://wiki.lyx.org/FAQ/Unsorted#toc31
3318 \begin_layout Section
3323 \begin_layout Standard
3324 Users sometimes need to be able to
3325 \begin_inset Quotes eld
3329 \begin_inset Quotes erd
3333 file together with all the images (and other files) on which it depends,
3334 either for sending to a publisher or for sharing with a co-author.
3336 2.0 includes a Python script (
3337 \begin_inset Flex Code
3340 \begin_layout Plain Layout
3346 ) that automates this process.
3347 To use it, you must have either the
3348 \begin_inset Flex Code
3351 \begin_layout Plain Layout
3358 \begin_inset Flex Code
3361 \begin_layout Plain Layout
3367 python modules installed on your system.
3368 By default, the script prefers the
3369 \begin_inset Flex Code
3372 \begin_layout Plain Layout
3379 \begin_inset Flex Code
3382 \begin_layout Plain Layout
3388 format on Unix-like systems and the
3389 \begin_inset Flex Code
3392 \begin_layout Plain Layout
3401 \begin_layout Standard
3403 's configuration process will set the script up to export a `\SpecialChar LyX
3405 and this format will then be available under
3406 \begin_inset Flex Code
3409 \begin_layout Plain Layout
3410 File\SpecialChar menuseparator
3419 \begin_layout Standard
3420 Independently of the platform, the generation of a particular archive format
3421 can be forced by adding either the
3422 \begin_inset Flex Code
3425 \begin_layout Plain Layout
3432 \begin_inset Flex Code
3435 \begin_layout Plain Layout
3442 \begin_inset Flex Code
3445 \begin_layout Plain Layout
3452 \begin_inset Flex Code
3455 \begin_layout Plain Layout
3461 format) switch to the
3462 \begin_inset Flex Code
3465 \begin_layout Plain Layout
3467 \SpecialChar menuseparator
3475 \begin_inset Flex Code
3478 \begin_layout Plain Layout
3479 Tools\SpecialChar menuseparator
3480 Preferences\SpecialChar menuseparator
3481 File Handling\SpecialChar menuseparator
3488 (Make sure you add the switch after the script name, not before it.)
3491 \begin_layout Section
3492 Fancy Headers and Footers
3495 \begin_layout Standard
3496 The default page layout is rather plain; for an
3497 \begin_inset Flex Code
3500 \begin_layout Plain Layout
3506 document class, all you get is a centered page number at the bottom of
3508 This document uses KOMA-script's book class, so it appears to be a bit
3510 But to really put on a show, you need to set the document page style to
3512 \begin_inset Quotes eld
3516 \begin_inset Quotes erd
3519 , as mentioned in the
3524 This section describes the \SpecialChar LaTeX
3525 code you need to insert in your \SpecialChar LaTeX
3527 order to get the desired effects.
3530 \begin_layout Standard
3531 For more information on fancy headers, see the
3532 \begin_inset Flex Code
3535 \begin_layout Plain Layout
3541 package documentation.
3543 \begin_inset Flex URL
3546 \begin_layout Plain Layout
3548 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3556 \begin_layout Standard
3557 The page header is divided into three fields, not surprisingly labeled
3558 \begin_inset Quotes eld
3562 \begin_inset Quotes erd
3566 \begin_inset Quotes eld
3570 \begin_inset Quotes erd
3574 \begin_inset Quotes eld
3578 \begin_inset Quotes erd
3582 The footer is also divided into these three fields.
3583 The \SpecialChar LaTeX
3584 commands to set these fields in the simplest manner are
3585 \begin_inset Flex Code
3588 \begin_layout Plain Layout
3597 \begin_inset Flex Code
3600 \begin_layout Plain Layout
3609 \begin_inset Flex Code
3612 \begin_layout Plain Layout
3621 \begin_inset Flex Code
3624 \begin_layout Plain Layout
3633 Suppose you wish to put your name in the upper left hand corner of each
3635 Simply insert the following command in the preamble:
3638 \begin_layout Standard
3647 \begin_layout Standard
3648 You will now see your name in the upper left.
3649 If a field has a default entry that you would like to get rid of (often
3650 the page number appears in the central footer) simply include a command
3651 with a blank argument, e.
3652 \begin_inset space \thinspace{}
3658 \begin_layout Standard
3666 \begin_layout Standard
3667 Let's get really fancy: lets put the section number with the word
3668 \begin_inset Quotes eld
3672 \begin_inset Quotes erd
3676 \begin_inset space \thinspace{}
3680 \begin_inset space \space{}
3683 Section 3) in the upper left, the page number (e.
3684 \begin_inset space \thinspace{}
3688 \begin_inset space \space{}
3691 Page 4) in the upper right, your name in the lower left, and the date in
3693 The following commands should now appear in the preamble:
3696 \begin_layout Standard
3706 \begin_layout Standard
3714 \begin_layout Standard
3724 \begin_layout Standard
3733 \begin_layout Standard
3741 \begin_layout Standard
3751 \begin_layout Standard
3753 \begin_inset Flex Code
3756 \begin_layout Plain Layout
3765 \begin_inset Flex Code
3768 \begin_layout Plain Layout
3776 access \SpecialChar LaTeX
3777 's section and page counters, and so print out the current section
3780 \begin_inset Flex Code
3783 \begin_layout Plain Layout
3791 simply prints out today's date.
3794 \begin_layout Standard
3795 The thicknesses of the horizontal rules drawn beneath the header and above
3796 the footer can also be modified.
3797 If you don't want one of the rules, set its thickness to 0.
3798 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3804 \begin_inset Flex Code
3807 \begin_layout Plain Layout
3812 headrulewidth}{0.4pt}
3818 \begin_inset Flex Code
3821 \begin_layout Plain Layout
3826 footrulewidth}{0.4pt}
3831 to set the thicknesses.
3834 \begin_layout Standard
3835 You can switch the header/footer settings on and off for individual pages
3837 \begin_inset Flex Code
3840 \begin_layout Plain Layout
3843 thispagestyle{empty}
3849 \begin_inset Flex Code
3852 \begin_layout Plain Layout
3855 thispagestyle{plain}
3861 \begin_inset Flex Code
3864 \begin_layout Plain Layout
3867 thispagestyle{fancy}
3873 Simply insert them in the text on the page you want changed and mark them
3876 In fact, title pages are marked as plain by default, while following pages
3877 are marked fancy when using the global fancy setting.
3880 \begin_layout Standard
3881 As a final example, it is possible to include an image in the header or
3883 Suppose you want to put a company logo in the upper lefthand corner.
3884 You might try something like
3887 \begin_layout Standard
3896 includegraphics{logo.eps}}}
3899 \begin_layout Standard
3901 (you may need to preface this with
3902 \begin_inset Flex Code
3905 \begin_layout Plain Layout
3909 usepackage{graphics}
3914 if you don't include graphics elsewhere in your document).
3917 \begin_layout Section
3918 Itemize Bullet Selection
3919 \begin_inset CommandInset label
3928 \begin_layout Standard
3934 \begin_layout Subsection
3938 \begin_layout Standard
3940 provides 216 bullet shapes that can be accessed from a simple dialog.
3941 Using this dialog you can easily specify what bullet shape to use at each
3942 level of an itemized list.
3943 These settings are document-wide so you won't be able to specify different
3944 sets of bullets for different paragraphs.
3948 \begin_layout Plain Layout
3949 Well, actually you can but you'll have to do it by hand.
3957 \begin_layout Subsection
3961 \begin_layout Standard
3962 Open the dialog by selecting the
3963 \begin_inset Flex MenuItem
3966 \begin_layout Plain Layout
3967 Document\SpecialChar menuseparator
3973 menu item and then select the
3974 \begin_inset Flex MenuItem
3977 \begin_layout Plain Layout
3986 \begin_layout Standard
3987 The dialog provides you with a table of bullet shapes.
3988 A column of buttons on the left of the table provides access to the six
3989 different panels of bullet shapes.
3990 The row of buttons across the top is used to select which bullet depth
3992 A text entry under the table shows the currently selected bullet shape's
3994 equivalent and this can be edited if desired.
3995 If you do modify the text you will also need to specify any needed packages
3996 in the \SpecialChar LaTeX
4000 \begin_layout Standard
4001 The six panels are divided up by the packages they require.
4002 The following table shows the mappings from button name to \SpecialChar LaTeX
4004 \begin_inset Separator parbreak
4010 \begin_layout Standard
4012 \begin_inset Tabular
4013 <lyxtabular version="3" rows="7" columns="2">
4014 <features tabularvalignment="middle">
4015 <column alignment="center" valignment="top" width="0pt">
4016 <column alignment="center" valignment="top" width="0pt">
4018 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4021 \begin_layout Plain Layout
4036 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4039 \begin_layout Plain Layout
4056 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4059 \begin_layout Plain Layout
4074 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4077 \begin_layout Plain Layout
4086 base \SpecialChar LaTeX
4094 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4097 \begin_layout Plain Layout
4112 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4115 \begin_layout Plain Layout
4132 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4135 \begin_layout Plain Layout
4150 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4153 \begin_layout Plain Layout
4170 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4173 \begin_layout Plain Layout
4188 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4191 \begin_layout Plain Layout
4208 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4211 \begin_layout Plain Layout
4226 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4229 \begin_layout Plain Layout
4246 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4249 \begin_layout Plain Layout
4264 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4267 \begin_layout Plain Layout
4290 \begin_layout Standard
4292 doesn't stop you using bullets from packages you don't have.
4293 If you get errors from \SpecialChar LaTeX
4294 when you try to view or print the file, then it
4295 is likely you are missing a package.
4299 \begin_layout Plain Layout
4301 doesn't restrict your use since you may be editing locally and exporting
4310 \begin_layout Subsection
4314 \begin_layout Standard
4315 Select which bullet depth you want to change then select the bullet shape
4317 Any changes will not be visible in \SpecialChar LyX
4318 , but are visible when viewing the document.
4321 \begin_layout Standard
4322 You can reset a bullet shape to the default simply by clicking your right
4323 mouse button on the appropriate bullet depth button.
4327 \begin_layout Plain Layout
4332 want to have multiple sets of paragraphs with different sets of bullets
4333 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4335 The bullet selection dialog can help though because it provides you with
4336 the \SpecialChar LaTeX
4337 code for a wide range of bullet shapes.
4338 To make your own custom paragraphs you have the following options:
4341 \begin_layout Plain Layout
4345 \begin_layout Plain Layout
4361 \begin_layout Plain Layout
4365 \begin_layout Plain Layout
4387 \begin_layout Itemize
4388 Use the \SpecialChar LaTeX
4390 \begin_inset Flex Code
4393 \begin_layout Plain Layout
4401 to specify a new bullet shape for a given depth.
4402 You'll also need to save the current bullet shape so you can restore it
4404 In this itemized list the following \SpecialChar LaTeX
4405 code was used to change the bullet
4406 used for the first depth.
4407 \begin_inset Separator parbreak
4414 \begin_layout LyX-Code
4424 \begin_layout LyX-Code
4441 \begin_layout Itemize
4442 Note that the itemize depth is specified in Roman numerals as part of the
4452 \begin_layout Itemize
4456 \begin_layout Plain Layout
4469 Specify each individual entry by starting each item with the bullet shape
4470 enclosed in square brackets and set as
4471 \begin_inset Flex MenuItem
4474 \begin_layout Plain Layout
4482 For example, this item was started with
4483 \begin_inset Flex Code
4486 \begin_layout Plain Layout
4501 \begin_layout Plain Layout
4505 \begin_layout Plain Layout
4521 \begin_layout Plain Layout
4522 You'll also need to revert the labelitem back to its previous setting for
4523 the global bullet shape settings to remain in effect.
4524 The way used here was:
4527 \begin_layout LyX-Code
4542 \begin_layout Chapter
4544 and the World Wide Web
4547 \begin_layout Standard
4549 has long supported the export of documents to various web-friendly formats,
4551 Before verson 2.0, however, HTML export was always accomplished by the use
4552 of external converters.
4556 \begin_layout Plain Layout
4557 For details on the use of external converters with \SpecialChar LyX
4562 section of the Customization manual.
4567 These fall into two large groups: there are converters that use \SpecialChar LaTeX
4569 intermediate format, such as
4570 \begin_inset Flex Code
4573 \begin_layout Plain Layout
4580 \begin_inset Flex Code
4583 \begin_layout Plain Layout
4590 \begin_inset Flex Code
4593 \begin_layout Plain Layout
4599 , relying upon \SpecialChar LyX
4600 to produce the \SpecialChar LaTeX
4601 ; and there is a converter that works directly
4604 \begin_inset Flex Code
4607 \begin_layout Plain Layout
4615 All of these have different advantages and disadvantages.
4619 \begin_layout Standard
4620 The \SpecialChar LaTeX
4621 -based converters have the advantage that, in principle, they know everythin
4622 g about the exported document that \SpecialChar LaTeX
4624 Such converters do not care, for example, if a certain block of code was
4625 produced by \SpecialChar LyX
4626 or was Evil Red Text.
4627 These converters know about
4628 \begin_inset Flex Code
4631 \begin_layout Plain Layout
4637 files, counters, and references, and can often make use of the
4638 \begin_inset Flex Code
4641 \begin_layout Plain Layout
4647 files generated by Bib\SpecialChar TeX
4649 On the other hand, \SpecialChar LaTeX
4650 is a very hard language to parse—it is sometimes said
4651 that only \SpecialChar TeX
4652 itself understands \SpecialChar TeX
4653 —and \SpecialChar LaTeX
4654 -based converters will often choke on
4655 what seem to be quite simple constructs; complex ones can throw them completely
4656 , and as of this writing, for example, the
4660 manual will not export with
4661 \begin_inset Flex Code
4664 \begin_layout Plain Layout
4670 , though the others will.
4671 The other issue concerns how math is handled.
4672 These converters typically convert the formulae into little pictures that
4673 are then linked from the HTML document.
4674 Since these are actually generated by \SpecialChar LaTeX
4675 , they are accurate.
4676 But they do not scale well, and just getting them to look as if they are
4677 actually meant to be in your document—so that the font sizes seem to be
4678 roughly the same—can be a challenge.
4681 \begin_layout Standard
4683 \begin_inset Flex Code
4686 \begin_layout Plain Layout
4694 \begin_inset CommandInset href
4696 name "http://elyxer.nongnu.org/"
4697 target "http://elyxer.nongnu.org/"
4701 ) solves some of these problems.
4702 In particular, the formulae it produces scale perfectly, since it renders
4703 math using a combination of HTML and CSS rather than converting the formulae
4705 But even moderately complex formula are rendered less well than with
4706 \begin_inset Flex Code
4709 \begin_layout Plain Layout
4715 ; this reflects the limitations of HTML.
4719 \begin_layout Plain Layout
4721 \begin_inset Flex Code
4724 \begin_layout Plain Layout
4731 can also use jsMath and MathJax for equations, but this setting is only
4732 available globally and requires one to have access to a server that runs
4738 More importantly (as of version 1.1.1, at least),
4739 \begin_inset Flex Code
4742 \begin_layout Plain Layout
4749 has limited support for math macros and no support for user-defined paragraph
4750 or character styles.
4751 These limitations make
4752 \begin_inset Flex Code
4755 \begin_layout Plain Layout
4762 unsuitable for many of the documents \SpecialChar LyX
4764 In principle, of course, these problems could be solved, but the \SpecialChar LyX
4766 have decided to follow a different path and have made \SpecialChar LyX
4768 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
4769 , DocBook, and plaintext.
4772 \begin_layout Standard
4773 As of this writing, XHTML output remains under development and should probably
4775 \begin_inset Quotes eld
4779 \begin_inset Quotes erd
4786 \begin_layout Plain Layout
4788 \begin_inset Flex Code
4791 \begin_layout Plain Layout
4792 development/HTML.notes
4797 , which can be found in the \SpecialChar LyX
4799 \begin_inset CommandInset href
4801 name "accessed online"
4802 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
4806 , usually contains up-to-date information about the state of XHTML output.
4807 See also the list of XHTML bugs on
4808 \begin_inset CommandInset href
4810 name "the bug tracker"
4811 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"
4820 Still, the developers have chosen this approach because it has several
4821 potential advantages over the other two.
4824 \begin_layout Standard
4825 These advantages are primarily due to the fact that the XHTML output routines,
4826 since they are part of \SpecialChar LyX
4827 , know everything \SpecialChar LyX
4828 knows about the document being
4833 \begin_layout Plain Layout
4834 Another advantage is that, since these routines are internal to \SpecialChar LyX
4836 immune to changes in \SpecialChar LyX
4837 's file format, or to changes in the semantics of
4843 So they know about the table of contents (as displayed in the outline),
4844 about the counters associated with different paragraph styles, and about
4845 user-defined styles.
4846 The XHTML output routines know what \SpecialChar LyX
4847 knows about internationalization,
4848 too, so they will output
4849 \begin_inset Quotes eld
4853 \begin_inset Quotes erd
4857 \begin_inset Quotes eld
4865 \begin_inset Quotes erd
4868 , depending upon the language in effect at the time.
4872 \begin_layout Standard
4873 Quite generally, the output routines know what \SpecialChar LyX
4874 knows about document layout,
4875 that is, about how the document is to be rendered on screen.
4876 We use this information when we output the document as XHTML.
4877 In particular, \SpecialChar LyX
4882 generates CSS style information corresponding to the layout information
4883 it uses to render the document on screen: if section headings are supposed
4884 to be sans-serif and bold as seen in \SpecialChar LyX
4885 , then (by default) they will be sans-seri
4886 f and bold when viewed in a web browser, too.
4887 And this is true not just for pre-defined styles, like Section, but for
4888 any style, including user-defined styles.
4889 Indeed, the XHTML output routines make no distinction between user-defined
4890 paragraph and character styles and \SpecialChar LyX
4891 's own pre-defined styles: in each case,
4892 everything \SpecialChar LyX
4893 knows about the styles is contained in the layout files.
4894 And much the same is true as regards pre-defined textual insets, such as
4895 footnotes, and various custom insets.
4899 \begin_layout Standard
4900 The result is that XHTML output can be customized and extended in exactly
4901 the same way \SpecialChar LaTeX
4902 output can be customized and extended: through layout files
4904 See chapter five of the
4908 manual for the details.
4911 \begin_layout Standard
4912 The remainder of this chapter contains more detailed information on XHTML
4913 output, its limitations, and ways to work around those limitations.
4916 \begin_layout Section
4917 Math Output in XHTML
4920 \begin_layout Standard
4922 offers four choices for how math is rendered.
4923 These have various advantages and disadvantages:
4926 \begin_layout Itemize
4928 \begin_inset Newline newline
4931 MathML is a dialect of XML designed specifically for mathematics on the
4932 web, and it typically renders very well in browsers that support it.
4933 The disadvantage is that not all browsers support MathML, and support is
4934 not complete even in the Gecko-based browsers, such as Firefox.
4935 \begin_inset Newline newline
4939 is unable to render a formula as MathML—for example, if the formula
4941 \begin_inset Flex Code
4944 \begin_layout Plain Layout
4950 package or ERT—then it will instead output the formula as an image.
4954 \begin_layout Itemize
4956 \begin_inset Newline newline
4960 \begin_inset Flex Code
4963 \begin_layout Plain Layout
4969 outputs math as HTML, styled by CSS.
4973 \begin_layout Plain Layout
4975 has borrowed some of the CSS for its HTML output from
4976 \begin_inset Flex Code
4979 \begin_layout Plain Layout
4990 For simple formulae, this can work quite well, though with more complicated
4991 formulae it tends to break down.
4992 Still, this method has the advantage that it is very widely supported and
4993 so it may be appropriate for documents that contain only a little, fairly
4995 \begin_inset Newline newline
4998 If Lyx is unable to render a formula as HTML—for example, if the formula
5000 \begin_inset Flex Code
5003 \begin_layout Plain Layout
5009 package or ERT—then it will instead output the formula as an image.
5013 \begin_layout Itemize
5015 \begin_inset Newline newline
5019 \begin_inset Flex Code
5022 \begin_layout Plain Layout
5029 will output formulae as images, the very same images, in fact, that are
5030 used for instant preview.
5034 \begin_layout Plain Layout
5035 Instant preview does
5039 have to be on for images to be output, however.
5044 The advantage to this method is that the images are simply generated by
5046 , so they are very accurate.
5047 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5048 so they do not scale terribly well, and one cannot copy them, etc.
5049 (As of this writing, there are also problems about equation numbering.
5051 \begin_inset CommandInset href
5054 target "http://www.lyx.org/trac/ticket/6894"
5059 \begin_inset Newline newline
5062 The size of the images can be controlled by setting the
5063 \begin_inset Quotes eld
5067 \begin_inset Quotes erd
5071 \begin_inset Flex MenuItem
5074 \begin_layout Plain Layout
5075 Document\SpecialChar menuseparator
5076 Settings\SpecialChar menuseparator
5086 \begin_layout Plain Layout
5087 For those who want to know, this controls the resolution of the image in
5088 dots per inch and is based upon a default of 75 dpi.
5094 \begin_inset Newline newline
5098 for some reason fails to create an image for a formula (e.g., if a required
5100 package is not installed), then it will fall back to outputing the raw
5105 \begin_layout Itemize
5108 \begin_inset Newline newline
5111 Finally, \SpecialChar LyX
5112 will happily output math as \SpecialChar LaTeX
5114 As well as being the output of last resort, this method can be used with
5116 \begin_inset CommandInset href
5119 target "http://www.math.union.edu/~dpvc/jsMath/"
5123 , which uses JavaScript to render \SpecialChar LaTeX
5124 embedded in HTML documents.
5126 wraps the \SpecialChar LaTeX
5128 \begin_inset Flex Code
5131 \begin_layout Plain Layout
5137 (for inline formulas) or
5138 \begin_inset Flex Code
5141 \begin_layout Plain Layout
5147 (for displayed formulas) with
5148 \begin_inset Flex Code
5151 \begin_layout Plain Layout
5157 , as is required for jsMath.
5160 \begin_layout Standard
5161 One of these output methods must be selected under
5162 \begin_inset Flex MenuItem
5165 \begin_layout Plain Layout
5166 Document\SpecialChar menuseparator
5167 Settings\SpecialChar menuseparator
5174 By default, \SpecialChar LyX
5176 This is a document-wide setting, therefore.
5179 \begin_layout Standard
5180 Eventually, \SpecialChar LyX
5181 will offer the user the option to select an alternate output
5182 method for a particular inset, say, one that isn't being rendered very
5187 \begin_layout Plain Layout
5188 That said, since \SpecialChar LyX
5189 falls back to images if the inset contains ERT, then one
5190 can force output as an image by putting some harmless ERT into the math,
5192 \begin_inset Formula $a=b\relax$
5203 \begin_layout Section
5204 Bibliography and Citations
5207 \begin_layout Standard
5208 XHTML output fully supports bibliographies and citations.
5212 \begin_layout Standard
5213 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5215 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5218 If you are using numerical citations, then \SpecialChar LyX
5219 will output numerical labels,
5220 such as [1] or [17], rather than simply showing the citation key in square
5221 brackets, as it does on-screen.
5222 If you are using author-year citations, then \SpecialChar LyX
5223 will add lowercase letters
5224 to the years, just as Bib\SpecialChar TeX
5225 does, if it finds more than one citation for
5226 a given author-year combination.
5227 The labels will be printed with the bibliography entries.
5228 Note that there is, at present, no way to customize the appearance of the
5229 labels, for example, to choose between square brackets and parentheses.
5232 \begin_layout Standard
5233 Bibliography output is handled by the same machinery that handles the presentati
5234 on of reference information in the citation dialog, so you will see in the
5235 XHTML output pretty much what you would see if you were to look at a given
5236 entry in the citation dialog.
5237 The formatting can be customized in your layout file or, preferably, in
5243 manual for the details.
5246 \begin_layout Standard
5247 The main defect at present is that cross-referenced information is printed
5248 with every entry with which it is associated.
5249 So you can see things like this:
5254 \begin_inset Quotes eld
5257 Context and Logical Form
5258 \begin_inset Quotes erd
5263 Language in Context: Selected Essays
5265 (Oxford: Oxford University Press, 2007), pp.
5271 \begin_inset Quotes eld
5274 Semantics in Context
5275 \begin_inset Quotes erd
5280 Language in Context: Selected Essays
5282 (Oxford: Oxford University Press, 2007), pp.
5286 \begin_layout Standard
5287 This should be fixed before long.
5290 \begin_layout Standard
5291 There is no support at present for sectioned bibliographies.
5292 If you have multiple bibliographies, then \SpecialChar LyX
5293 will print the same bibliography
5297 \begin_layout Section
5301 \begin_layout Standard
5303 will happily export indexes as XHTML, but with certain limitations at the
5307 \begin_layout Standard
5308 Index export will be most reliable when you do not attempt to use the fancy
5309 constructs that are described in the section on indexes in the
5317 \begin_layout Plain Layout
5318 The main issue here is that \SpecialChar LyX
5319 itself does not really handle these.
5320 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5326 We'll describe how they are handled using the subsection headings from
5330 \begin_layout Itemize
5331 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5332 makes an effort to support these,
5333 but the entries must be separated by
5334 \begin_inset Quotes eld
5338 \begin_inset Quotes erd
5341 , that is, there must be spaces around the exclamation point.
5342 This is because it is otherwise too difficult to check for escaped exclamation
5343 points, ones in math, and so forth.
5346 \begin_layout Itemize
5347 Page Ranges: There is no support at all for page ranges, since these make
5348 no sense with XHMTL.
5349 Instead, you will just get two index entries, one at either end.
5352 \begin_layout Itemize
5353 Cross-referencing: There is no support for cross-referencing.
5355 finds an entry containing the
5356 \begin_inset Quotes eld
5359 |see\SpecialChar ldots
5361 \begin_inset Quotes erd
5364 construct, it is just dropped, and the rest is treated as an ordinary index
5368 \begin_layout Itemize
5369 Index Entry Order: \SpecialChar LyX
5370 does support attempts to fix the sorting order.
5371 It will take what is before the first `@' it finds and use that for sorting,
5372 taking what follows the first `@' to be the actual entry.
5373 At present, \SpecialChar LyX
5374 does not check for escaped `@', so do not try to index email
5378 \begin_layout Itemize
5379 Index Entry Layout: You can format entries by using the text style dialog,
5380 or by using any other method available within \SpecialChar LyX
5382 There is no support for constructs like:
5383 \begin_inset Quotes eld
5387 \begin_inset Quotes erd
5391 Indeed, if \SpecialChar LyX
5392 finds a pipe symbol, `|', in an entry, it will delete it and
5393 everything that follows it.
5396 \begin_layout Itemize
5397 Multiple Indexes: There is no support for multiple indexes.
5398 Rather, all index entries will be printed as one large index.
5399 To avoid our printing several versions of the index, we print only the
5400 main index, so make sure you have one.
5403 \begin_layout Section
5404 Nomenclature and Glossary
5407 \begin_layout Standard
5408 There is at present no support for glossaries.
5409 Adding it would be fairly trivial, and welcome.
5412 \begin_layout Chapter
5413 The \SpecialChar LyX
5417 \begin_layout Section
5421 \begin_layout Standard
5422 The `\SpecialChar LyX
5423 server' allows other programs to talk to \SpecialChar LyX
5424 , invoke \SpecialChar LyX
5425 commands, and retrieve
5426 information about the \SpecialChar LyX
5428 This is only intended for advanced users, but they should find it useful.
5429 It is by writing to the \SpecialChar LyX
5430 server, for example, that bibliography managers,
5431 such as JabRef, are able to
5432 \begin_inset Quotes eld
5436 \begin_inset Quotes erd
5439 citations to \SpecialChar LyX
5443 \begin_layout Section
5444 Starting the \SpecialChar LyX
5448 \begin_layout Standard
5449 The \SpecialChar LyX
5450 server works through the use of a pair of named pipes.
5451 These are usually located in
5452 \begin_inset Flex Code
5455 \begin_layout Plain Layout
5461 , (except on Windows, where
5465 named pipes are special objects located in
5466 \begin_inset Flex Code
5469 \begin_layout Plain Layout
5481 ) and have the names
5482 \begin_inset Quotes eld
5486 \begin_inset Flex Code
5489 \begin_layout Plain Layout
5496 \begin_inset Quotes erd
5500 \begin_inset Quotes eld
5504 \begin_inset Flex Code
5507 \begin_layout Plain Layout
5514 \begin_inset Quotes erd
5518 External programs write into
5519 \begin_inset Flex Code
5522 \begin_layout Plain Layout
5528 and read back data from
5529 \begin_inset Flex Code
5532 \begin_layout Plain Layout
5539 The stem of the pipe names can be defined in the
5540 \begin_inset Flex MenuItem
5543 \begin_layout Plain Layout
5544 Tools\SpecialChar menuseparator
5551 \begin_inset Flex Code
5554 \begin_layout Plain Layout
5555 "/home/myhome/lyxpipe"
5561 \begin_inset Flex Code
5564 \begin_layout Plain Layout
5579 \change_deleted 711066561 1405258697
5581 \change_inserted 711066561 1405258701
5585 \change_inserted 711066561 1405258613
5589 \change_inserted 711066561 1405258962
5591 \begin_inset Flex Code
5594 \begin_layout Plain Layout
5596 \change_inserted 711066561 1405258868
5623 configure this manually in order for the server to start.
5626 \begin_layout Standard
5629 \begin_inset Flex Code
5632 \begin_layout Plain Layout
5639 \begin_inset Flex Code
5642 \begin_layout Plain Layout
5648 ' to create the pipes.
5649 If one of the pipes already exists, \SpecialChar LyX
5650 will assume that another \SpecialChar LyX
5652 is already running and will not start the server.
5653 On POSIX (Unix like) systems, if for some other reason, an unused
5654 \begin_inset Quotes eld
5658 \begin_inset Quotes erd
5661 pipe is left in existence when \SpecialChar LyX
5662 closes, then \SpecialChar LyX
5663 will try to delete it.
5664 If this fails for some reason, you will need to delete the pipes manually
5665 and then restart \SpecialChar LyX
5667 On Windows, pipes are deleted by the OS on program termination or crash,
5669 \begin_inset Quotes eld
5673 \begin_inset Quotes erd
5676 pipes should not be possible.
5679 \begin_layout Standard
5680 To have several \SpecialChar LyX
5681 processes with servers at the same time, you have to use
5682 different configurations, perhaps by using separate user directories, each
5684 \begin_inset Flex Code
5687 \begin_layout Plain Layout
5693 file, for each process.
5696 \begin_layout Standard
5697 If you are developing a client program, you might find it useful to enable
5698 debugging information from the \SpecialChar LyX
5700 Do this by starting \SpecialChar LyX
5702 \begin_inset Flex Code
5705 \begin_layout Plain Layout
5714 \begin_layout Standard
5715 You can find a complete example client written in C
5716 \change_inserted 711066561 1405258366
5719 in the source distribution as
5720 \begin_inset Flex Code
5723 \begin_layout Plain Layout
5724 development/lyxserver/server_monitor.c
5725 \change_inserted 711066561 1405258386
5736 \begin_layout Standard
5737 Another useful tool is the command-line based client
5738 \change_inserted 711066561 1405258403
5742 \begin_inset Flex Code
5745 \begin_layout Plain Layout
5746 src/client/lyxclient
5754 \begin_layout Section
5755 Normal communication
5758 \begin_layout Standard
5759 To issue a \SpecialChar LyX
5760 call, the client writes a line of ASCII text into the input
5762 This line has the following format:
5779 \begin_layout Description
5780 clientname is a name that the client can choose arbitrarily.
5781 Its only use is that \SpecialChar LyX
5782 will echo it if it sends an answer—so a client can
5783 dispatch results from different requesters.
5786 \begin_layout Description
5787 function is the function you want \SpecialChar LyX
5789 It is the same as the commands you'd use in the minibuffer.
5792 \begin_layout Description
5793 argument is an optional argument which is meaningful only to some functions
5795 \begin_inset Quotes eld
5799 \begin_inset Quotes erd
5802 LFUN will insert the argument as text at the cursor position).
5805 \begin_layout Standard
5806 The answer from \SpecialChar LyX
5807 will arrive in the output pipe and be of the form
5824 \begin_layout Standard
5833 are just echoed from the command request, while
5837 is more or less useful information filled according to how the command
5838 execution worked out.
5839 Some commands, such as
5840 \begin_inset Quotes eld
5844 \begin_inset Quotes erd
5847 , will return information about the internal state of \SpecialChar LyX
5849 return an empty data-response.
5850 This means that the command execution went fine.
5853 \begin_layout Standard
5854 In case of errors, the response from \SpecialChar LyX
5872 \begin_layout Standard
5877 should contain an explanation of why the command failed.
5880 \begin_layout Standard
5884 \begin_layout LyX-Code
5885 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
5886 \begin_inset Newline newline
5889 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
5890 \begin_inset Newline newline
5893 read a <~/.lyxpipe.out
5894 \begin_inset Newline newline
5900 \begin_layout Subsection
5901 AppleScript (Mac OS X)
5904 \begin_layout Standard
5905 Since \SpecialChar LyX
5906 2.1, \SpecialChar LyX
5907 supports basic interactions with AppleScript for normal communicatio
5908 n through the command run.
5909 This command takes a direct argument (the
5913 to perform) and an optional argument.
5914 It either returns the output of the function or triggers an error with
5915 the error message and code.
5918 \begin_layout Standard
5922 \begin_layout LyX-Code
5923 tell application "\SpecialChar LyX
5927 \begin_layout LyX-Code
5931 \begin_layout LyX-Code
5932 -- Stores the current file name into f
5935 \begin_layout LyX-Code
5936 set f to (run "server-get-filename" with argument "")
5939 \begin_layout LyX-Code
5940 on error the error_message number the error_number
5943 \begin_layout LyX-Code
5944 display dialog "Error: " & the error_number & ".
5948 \begin_layout LyX-Code
5949 & the error_message buttons {"OK"} default button 1
5952 \begin_layout LyX-Code
5956 \begin_layout LyX-Code
5960 \begin_layout Section
5964 \begin_layout Standard
5966 can notify clients of events going on asynchronously.
5967 Currently it will only do this if the user binds a key sequence with the
5969 \begin_inset Quotes eld
5973 \begin_inset Quotes erd
5977 The format of the string \SpecialChar LyX
5978 sends is as follows:
5982 \begin_inset Flex Code
5985 \begin_layout Plain Layout
5996 \begin_layout Standard
6001 is the printed representation of the key sequence that was actually typed
6005 \begin_layout Standard
6006 This mechanism can be used to extend \SpecialChar LyX
6007 's command set and implement macros.
6008 Bind some key sequence to
6009 \begin_inset Quotes eld
6013 \begin_inset Quotes erd
6017 Then start a client that listens on the output pipe, dispatches the command
6018 according to the sequence, and starts a function that may use \SpecialChar LyX
6021 requests to issue a command or a series of commands to \SpecialChar LyX
6025 \begin_layout Section
6026 The simple \SpecialChar LyX
6030 \begin_layout Standard
6032 implements a simple protocol that can be used for session management.
6033 All messages are of the form
6046 \begin_layout Standard
6052 \begin_inset Quotes eld
6056 \begin_inset Quotes erd
6060 \begin_inset Quotes eld
6064 \begin_inset Quotes erd
6069 \begin_inset Quotes eld
6073 \begin_inset Quotes erd
6076 is received from a client, \SpecialChar LyX
6077 will report back to inform the client that
6078 it's listening to it's messages, while
6079 \begin_inset Quotes eld
6083 \begin_inset Quotes erd
6086 sent from \SpecialChar LyX
6087 will inform clients that \SpecialChar LyX
6091 \begin_layout Section
6092 Reverse DVI/PDF search
6095 \begin_layout Standard
6096 Some DVI/PDF viewers
6100 \begin_layout Plain Layout
6101 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux
6102 \change_inserted 711066561 1405273809
6105 , Skim on Mac OSX and SumatraPDF on Windows.
6114 facility (also called
6119 This means that you can tell \SpecialChar LyX
6120 to put the cursor to a specific line in the
6121 document by clicking at the respective position in the DVI/PDF output.
6122 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6124 This is done via the \SpecialChar LyX
6125 server either by using the named pipe (
6129 ), or the UNIX domain socket (
6133 ) that \SpecialChar LyX
6134 creates in its temporary directory (this is the way the
6135 \begin_inset Flex Code
6138 \begin_layout Plain Layout
6144 program communicates with \SpecialChar LyX
6146 In some cases, you need a helper script that mediates between the viewer
6147 and \SpecialChar LyX
6148 , in others, the viewer can communicate with \SpecialChar LyX
6150 This depends on the selected viewer and on your operating system.
6151 The same applies to the way viewers need to be configured and the way the
6152 reverse search is actually performed.
6153 In what follows, we will thus describe how to setup reverse search for
6155 Before we turn to this, though, we will explain what needs to be done generally
6156 to enable reverse search in the DVI/PDF output.
6159 \begin_layout Subsection
6161 \begin_inset CommandInset label
6163 name "subsec:rev-search"
6170 \begin_layout Standard
6171 In most cases \SpecialChar LyX
6172 will do the work for you by enabling the option
6173 \begin_inset Flex MenuItem
6176 \begin_layout Plain Layout
6177 Synchronize with Output
6183 \begin_inset Flex MenuItem
6186 \begin_layout Plain Layout
6187 Document\SpecialChar menuseparator
6188 Settings\SpecialChar menuseparator
6195 In such a case \SpecialChar LyX
6196 will automatically insert the necessary Sync\SpecialChar TeX
6198 PDF) or load the srcltx package (for DVI) respectively.
6199 This option can be easily reached also on
6200 \begin_inset Flex Code
6203 \begin_layout Plain Layout
6212 \begin_layout Standard
6213 If you need a different setting, you can select or input a custom macro
6214 from the drop down box just below
6215 \begin_inset Flex MenuItem
6218 \begin_layout Plain Layout
6219 Document\SpecialChar menuseparator
6220 Settings\SpecialChar menuseparator
6221 Output\SpecialChar menuseparator
6222 Synchronize with Output
6230 \begin_layout Standard
6231 Note that the method
6232 \begin_inset Flex Code
6235 \begin_layout Plain Layout
6243 enables gzip compression.
6244 If your viewer does not support it, you should instead use
6245 \begin_inset Flex Code
6248 \begin_layout Plain Layout
6259 \begin_layout Standard
6261 \change_deleted 711066561 1405259326
6263 \change_inserted 711066561 1405259326
6266 so note that including the
6267 \begin_inset Flex Code
6270 \begin_layout Plain Layout
6277 \begin_inset Flex Code
6280 \begin_layout Plain Layout
6286 sometimes has an undesired impact on the typesetting.
6287 Thus, you should switch output synchronization off for the final typesetting
6289 \begin_inset Flex Code
6292 \begin_layout Plain Layout
6299 \begin_inset Flex Code
6302 \begin_layout Plain Layout
6312 \begin_layout Standard
6313 In case you need some more special settings that are not covered by the
6314 automatic settings, read the next section about how to set up output synchroniz
6316 If the automatic setup suits your needs, you can readily jump to section
6317 \begin_inset space ~
6321 \begin_inset CommandInset ref
6323 reference "subsec:configuring-viewers"
6327 , where the necessary configuration steps in your viewer – needed both with
6328 the automatic and the manual setup – are described.
6331 \begin_layout Subsection
6335 \begin_layout Standard
6337 provides several different methods for reverse search.
6338 Some are built-in in the
6339 \begin_inset Flex Code
6342 \begin_layout Plain Layout
6348 program, some are provided by external packages.
6349 Your choice depends on whether your \SpecialChar LaTeX
6350 distribution already provides a given
6351 method (the built-in methods are rather new) and whether your viewer can
6353 The available methods are described in the following.
6356 \begin_layout Subsubsection*
6357 Built-in DVI-search via src-specials (DVI only)
6360 \begin_layout Standard
6361 This method provides the DVI file with the necessary information for reverse
6363 It is available in \SpecialChar LaTeX
6364 since quite some time (any somewhat recent \SpecialChar LaTeX
6366 should include it), and it works reliably.
6367 To enable it, change the
6368 \begin_inset Flex MenuItem
6371 \begin_layout Plain Layout
6373 \change_deleted -712698321 1437633234
6378 \begin_layout Plain Layout
6386 \change_inserted -712698321 1437633234
6399 \begin_inset Flex MenuItem
6402 \begin_layout Plain Layout
6404 \change_deleted -712698321 1437633251
6409 \begin_layout Plain Layout
6417 \change_inserted -712698321 1437633251
6430 \begin_inset Flex MenuItem
6433 \begin_layout Plain Layout
6434 Preferences\SpecialChar menuseparator
6435 File Handling\SpecialChar menuseparator
6442 \begin_inset Flex Code
6445 \begin_layout Plain Layout
6446 latex -src-specials $$i
6452 If this doesn't work, check if your \SpecialChar TeX
6453 engine needs different options (the
6454 syntax might differ in some distributions).
6457 \begin_layout Subsubsection*
6458 External Packages (PDFSync and scrltx)
6461 \begin_layout Standard
6470 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6472 In order to enable it, load the packages in the \SpecialChar LyX
6476 \begin_layout Itemize
6477 \begin_inset Flex Code
6480 \begin_layout Plain Layout
6488 for reverse PDF search,
6491 \begin_layout Itemize
6492 \begin_inset Flex Code
6495 \begin_layout Plain Layout
6498 usepackage[active]{srcltx}
6503 for reverse DVI search.
6506 \begin_layout Standard
6507 If you want to be able to perform both DVI and PDF reverse searches, you
6508 can also insert in the preamble the following lines
6511 \begin_layout LyX-Code
6515 \begin_inset Newline newline
6521 \begin_inset Newline newline
6527 \begin_inset Newline newline
6533 \begin_inset Newline newline
6538 usepackage[active]{srcltx}
6539 \begin_inset Newline newline
6547 \begin_layout Standard
6548 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6549 right package will be used.
6552 \begin_layout Standard
6553 Note that PDFSync might affect the output layout of your document.
6554 It is therefore advised to disable PDFsync for final documents.
6557 \begin_layout Subsubsection*
6558 Built-in reverse search via Sync\SpecialChar TeX
6562 \begin_layout Standard
6564 \begin_inset Flex Code
6567 \begin_layout Plain Layout
6573 have built-in support for both PDF and DVI reverse search.
6576 Sync\SpecialChar TeX
6579 facility is basically the result of the integration of the PDFSync package
6580 to the pdftex program and its merge with the
6585 You need at least \SpecialChar TeX
6586 Live 2008 or a recent Mik\SpecialChar TeX
6587 distribution in order to use
6592 \begin_layout Plain Layout
6593 For some reason, Mik\SpecialChar TeX
6594 does not understand/obey the command \SpecialChar LyX
6596 the preamble when you check the "Enable Forward/Reverse Search" button
6597 in the toolbar and does not generate the necessary info.
6600 \begin_layout Plain Layout
6601 The generation of the required info can be forced by changing the converter
6603 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
6604 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
6605 the -synctex=1 switch).
6611 Also note that only a few PDF viewers (
6612 \change_inserted 711066561 1405273879
6613 Okular and Qpdfview on Unix,
6615 Skim on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
6619 \begin_layout Standard
6620 To enable Sync\SpecialChar TeX
6621 for DVI output, change the
6622 \begin_inset Flex MenuItem
6625 \begin_layout Plain Layout
6627 \change_deleted -712698321 1437633274
6632 \begin_layout Plain Layout
6640 \change_inserted -712698321 1437633274
6653 \begin_inset Flex MenuItem
6656 \begin_layout Plain Layout
6658 \change_deleted -712698321 1437633275
6663 \begin_layout Plain Layout
6671 \change_inserted -712698321 1437633275
6684 \begin_inset Flex MenuItem
6687 \begin_layout Plain Layout
6688 Preferences\SpecialChar menuseparator
6689 File Handling\SpecialChar menuseparator
6696 \begin_inset Flex Code
6699 \begin_layout Plain Layout
6700 latex -synctex=1 $$i
6705 , and for PDF output, change the
6706 \begin_inset Flex MenuItem
6709 \begin_layout Plain Layout
6711 \change_deleted -712698321 1437633276
6716 \begin_layout Plain Layout
6724 \change_inserted -712698321 1437633276
6731 (pdflatex) -> PDF (pdflatex)
6737 \begin_inset Flex Code
6740 \begin_layout Plain Layout
6741 pdflatex -synctex=1 $$i
6747 Check the documentation of your viewer whether the viewer needs to be configure
6748 d for the use with Sync\SpecialChar TeX
6753 \begin_layout Plain Layout
6754 Note that the option
6755 \begin_inset Flex Code
6758 \begin_layout Plain Layout
6764 option enables gzip compression.
6765 If your viewer does not support it, you should instead use
6766 \begin_inset Flex Code
6769 \begin_layout Plain Layout
6783 \begin_layout Subsection
6784 Configuring and using specific viewers
6785 \begin_inset CommandInset label
6787 name "subsec:configuring-viewers"
6794 \begin_layout Subsubsection*
6795 Xdvi (all platforms)
6798 \begin_layout Standard
6800 \begin_inset Flex Code
6803 \begin_layout Plain Layout
6809 , you don't need to do anything else for performing a reverse DVI search,
6811 already provides the necessary hooks for automatically using the
6812 \begin_inset Flex Code
6815 \begin_layout Plain Layout
6822 Just setup your document as described above (reverse search is triggered
6823 by Ctrl-click or Alt-click on Mac OSX, respectively).
6826 \begin_layout Standard
6827 However, if for whatever reason you want to use the named pipe instead of
6828 the socket for communicating with \SpecialChar LyX
6829 , simply change the DVI viewer in
6830 \begin_inset Flex MenuItem
6833 \begin_layout Plain Layout
6834 Preferences\SpecialChar menuseparator
6835 File Handling\SpecialChar menuseparator
6845 \begin_layout Plain Layout
6846 On Mac OSX you have to use
6847 \begin_inset Flex Code
6850 \begin_layout Plain Layout
6851 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
6862 \begin_inset Flex Code
6865 \begin_layout Plain Layout
6866 xdvi -editor "lyxeditor.sh %f %l"
6872 \begin_inset Flex Code
6875 \begin_layout Plain Layout
6881 is a suitable script.
6882 For example, a minimal shell script is the following one:
6885 \begin_layout LyX-Code
6887 \begin_inset Newline newline
6890 LYXPIPE="/path/to/lyxpipe"
6891 \begin_inset Newline newline
6894 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
6895 \begin_inset Newline newline
6898 echo "$COMMAND" > "${LYXPIPE}".in || exit
6899 \begin_inset Newline newline
6902 read TMP < "${LYXPIPE}".out || exit
6905 \begin_layout Standard
6907 \begin_inset Flex Code
6910 \begin_layout Plain Layout
6920 \begin_layout Plain Layout
6927 XServer pipe path specified in
6928 \begin_inset Flex MenuItem
6931 \begin_layout Plain Layout
6932 Preferences\SpecialChar menuseparator
6942 \begin_layout Plain Layout
6944 \begin_inset Flex Code
6947 \begin_layout Plain Layout
6953 folder of a source distribution you can find a
6954 \begin_inset Flex Code
6957 \begin_layout Plain Layout
6963 script which is able to locate the
6967 based on your preferences.
6975 \begin_layout Subsubsection*
6979 \begin_layout Standard
6981 \begin_inset Flex Code
6984 \begin_layout Plain Layout
6985 /Applications/MacDviX_Folder/calleditor.script
6990 , add the following lines:
6993 \begin_layout LyX-Code
6998 \begin_layout Plain Layout
7005 X.app/Contents/MacOS/lyxeditor "$2" $1
7006 \begin_inset Newline newline
7012 \begin_layout Standard
7013 Modify the lines accordingly if you install \SpecialChar LyX
7014 somewhere else than in the
7015 Applications folder.
7018 \begin_layout Standard
7019 Reverse search is triggered by Alt-click (OPTION-click).
7022 \begin_layout Subsubsection*
7026 \begin_layout Standard
7028 \begin_inset Flex Code
7031 \begin_layout Plain Layout
7032 open -a Skim.app $$i
7037 to the viewer setting in
7038 \begin_inset Flex MenuItem
7041 \begin_layout Plain Layout
7042 Preferences\SpecialChar menuseparator
7043 File Handling\SpecialChar menuseparator
7044 File formats\SpecialChar menuseparator
7051 \begin_inset Flex MenuItem
7054 \begin_layout Plain Layout
7055 Skim\SpecialChar menuseparator
7056 Preferences\SpecialChar menuseparator
7063 \begin_inset Flex MenuItem
7066 \begin_layout Plain Layout
7072 preset and enter command
7073 \begin_inset Flex MenuItem
7076 \begin_layout Plain Layout
7077 /Applications/\SpecialChar LyX
7078 .app/Contents/MacOS/lyxeditor
7086 \begin_layout Standard
7087 Reverse search is triggered by COMMAND-SHIFT-click
7090 \begin_layout Subsubsection*
7094 \begin_layout Standard
7096 \begin_inset Flex MenuItem
7099 \begin_layout Plain Layout
7100 Settings\SpecialChar menuseparator
7101 Configure Okular\SpecialChar ldots
7102 \SpecialChar menuseparator
7109 \begin_inset Quotes eld
7113 \begin_inset Quotes erd
7117 \begin_inset Flex Code
7120 \begin_layout Plain Layout
7129 \begin_layout Standard
7130 Reverse search is triggered by SHIFT-click.
7131 \change_inserted 711066561 1405259853
7135 \begin_layout Subsubsection*
7137 \change_inserted 711066561 1405273730
7141 \begin_layout Standard
7143 \change_inserted 711066561 1405263147
7144 Qpdfview supports Sync\SpecialChar TeX
7145 since version 0.3.5.
7147 \begin_inset Flex MenuItem
7150 \begin_layout Plain Layout
7152 \change_inserted 711066561 1405260331
7153 Edit\SpecialChar menuseparator
7154 Settings\SpecialChar ldots
7155 \SpecialChar menuseparator
7163 , click on the input field of the
7164 \begin_inset Quotes eld
7168 \begin_inset Quotes erd
7171 item and add the command
7172 \begin_inset Flex Code
7175 \begin_layout Plain Layout
7177 \change_inserted 711066561 1405260473
7188 \begin_layout Standard
7190 \change_inserted 711066561 1405260506
7191 Reverse search is triggered by double-click.
7196 \begin_layout Subsubsection*
7200 \begin_layout Standard
7201 Launch yap, choose its
7202 \begin_inset Flex MenuItem
7205 \begin_layout Plain Layout
7206 View\SpecialChar menuseparator
7213 \begin_inset Quotes eld
7217 \begin_inset Quotes erd
7222 \begin_inset Quotes eld
7225 New\SpecialChar ldots
7227 \begin_inset Quotes erd
7230 button and, in the window that opens, enter
7231 \begin_inset Quotes eld
7236 \begin_inset Quotes erd
7239 (or any other name you like) in the
7240 \begin_inset Quotes eld
7244 \begin_inset Quotes erd
7248 Now click on the button labeled
7249 \begin_inset Quotes eld
7254 \begin_inset Quotes erd
7257 to open a file dialog and navigate to the directory containing the batch
7259 \begin_inset Flex Code
7262 \begin_layout Plain Layout
7270 \begin_inset Flex Code
7273 \begin_layout Plain Layout
7279 and then specify the program arguments as
7280 \begin_inset Flex Code
7283 \begin_layout Plain Layout
7291 \begin_inset Flex Code
7294 \begin_layout Plain Layout
7300 wrapper is used for communicating with \SpecialChar LyX
7308 \begin_layout LyX-Code
7310 \begin_inset Newline newline
7313 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
7322 \begin_inset Newline newline
7336 \begin_layout Standard
7337 Make sure that the \SpecialChar LyX
7338 Server pipe path you specified in \SpecialChar LyX
7340 \begin_inset Flex Code
7343 \begin_layout Plain Layout
7357 , otherwise change the
7358 \begin_inset Flex Code
7361 \begin_layout Plain Layout
7367 wrapper accordingly.
7370 \begin_layout Standard
7371 In yap, reverse search is triggered by double-click.
7374 \begin_layout Subsubsection*
7375 SumatraPDF (Windows)
7378 \begin_layout Standard
7379 In order to use SumatraPDF for inverse search, enter
7380 \begin_inset Flex Code
7383 \begin_layout Plain Layout
7384 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
7389 in the viewer setting in
7390 \begin_inset Flex MenuItem
7393 \begin_layout Plain Layout
7394 Preferences\SpecialChar menuseparator
7395 File Handling\SpecialChar menuseparator
7396 File formats\SpecialChar menuseparator
7403 \begin_inset Flex Code
7406 \begin_layout Plain Layout
7412 is the previous wrapper.
7413 If SumatraPDF.exe is not in your command PATH, use its full file name.
7416 \begin_layout Standard
7417 Reverse search is triggered by double-click.
7420 \begin_layout Subsubsection*
7424 \begin_layout Standard
7425 First of all, make sure that yap is your default DVI viewer in the Windows
7426 environment, then launch it, choose its
7427 \begin_inset Flex MenuItem
7430 \begin_layout Plain Layout
7431 View\SpecialChar menuseparator
7438 \begin_inset Quotes eld
7442 \begin_inset Quotes erd
7447 \begin_inset Quotes eld
7450 New\SpecialChar ldots
7452 \begin_inset Quotes erd
7455 button and, in the window that opens, enter
7456 \begin_inset Quotes eld
7461 \begin_inset Quotes erd
7464 (or any other name you like) in the
7465 \begin_inset Quotes eld
7469 \begin_inset Quotes erd
7473 Now click on the button labeled
7474 \begin_inset Quotes eld
7479 \begin_inset Quotes erd
7482 to open a file dialog and navigate to the directory containing the
7483 \begin_inset Flex Code
7486 \begin_layout Plain Layout
7492 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7495 \begin_inset Flex Code
7498 \begin_layout Plain Layout
7504 and then specify the program arguments as
7505 \begin_inset Flex Code
7508 \begin_layout Plain Layout
7515 In this way, you will be using the
7519 for communicating with \SpecialChar LyX
7521 If, for whatever reason, you want to use the
7526 \begin_inset Flex Code
7529 \begin_layout Plain Layout
7535 option and be sure to specify the \SpecialChar LyX
7536 Server pipe path in the \SpecialChar LyX
7540 \begin_layout Standard
7541 In yap, reverse search is triggered by double-click.
7544 \begin_layout Subsubsection*
7548 \begin_layout Standard
7549 In order to use SumatraPDF for inverse search, enter
7550 \begin_inset Flex Code
7553 \begin_layout Plain Layout
7554 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7559 in the viewer setting in
7560 \begin_inset Flex MenuItem
7563 \begin_layout Plain Layout
7564 Preferences\SpecialChar menuseparator
7565 File Handling\SpecialChar menuseparator
7566 File formats\SpecialChar menuseparator
7573 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7575 \begin_inset Flex Code
7578 \begin_layout Plain Layout
7584 enables communication via the
7590 \begin_inset Flex Code
7593 \begin_layout Plain Layout
7599 option if you want to use the
7603 , and be sure to specify the \SpecialChar LyX
7604 Server pipe path in the \SpecialChar LyX
7608 \begin_layout Standard
7609 Reverse search is triggered by double-click.
7612 \begin_layout Section
7616 \begin_layout Standard
7617 Forward search is, as the name implies, in a sense the
7618 \begin_inset Quotes eld
7622 \begin_inset Quotes erd
7626 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7628 If forward search is set up (as described in what follows), you can put
7629 the cursor anywhere in your \SpecialChar LyX
7631 \begin_inset Flex MenuItem
7634 \begin_layout Plain Layout
7635 Navigate\SpecialChar menuseparator
7642 \begin_inset Flex MenuItem
7645 \begin_layout Plain Layout
7651 in the context menu via right mouse click), and then the viewer will jump
7652 to that position as well.
7653 This implies, of course, that your viewer supports this function.
7656 \begin_layout Standard
7657 To make forward search possible, you first need to provide the generated
7658 output PDF/DVI file with additional information about the \SpecialChar TeX
7660 This can be done via the methods described in the section
7661 \begin_inset CommandInset ref
7663 reference "subsec:rev-search"
7670 \begin_layout Standard
7671 Additionally, you need to configure \SpecialChar LyX
7672 for using your viewers in
7673 \begin_inset Flex MenuItem
7676 \begin_layout Plain Layout
7677 Tools\SpecialChar menuseparator
7678 Preferences\SpecialChar menuseparator
7679 Output\SpecialChar menuseparator
7686 We provide a range of tested configurations for some viewers, which you
7687 can select from the drop down list.
7688 If none of these configurations suits you, you have to find out and enter
7689 a suitable configuration yourself.
7690 The definition syntax uses the following placeholders:
7693 \begin_layout Itemize
7695 \begin_inset Flex Code
7698 \begin_layout Plain Layout
7707 \begin_layout Itemize
7709 \begin_inset Flex Code
7712 \begin_layout Plain Layout
7718 : name of the (temporary) exported .tex file (without path)
7721 \begin_layout Itemize
7723 \begin_inset Flex Code
7726 \begin_layout Plain Layout
7732 : name of the (temporary) exported .tex file (including path)
7735 \begin_layout Itemize
7737 \begin_inset Flex Code
7740 \begin_layout Plain Layout
7746 : name of the exported output file (either dvi or pdf, depending on which
7747 one exists in the temporary directory)
7750 \begin_layout Standard
7751 Note that only some of the viewers provide full forward search functionality,
7752 among them yap, xdvi, okular
7756 \begin_layout Plain Layout
7757 You might want to set
7758 \begin_inset Flex Code
7761 \begin_layout Plain Layout
7768 \begin_inset Flex MenuItem
7771 \begin_layout Plain Layout
7772 Tools\SpecialChar menuseparator
7773 Preferences\SpecialChar menuseparator
7774 File Handling\SpecialChar menuseparator
7776 \begin_inset space ~
7790 \change_inserted 711066561 1405264317
7794 \change_deleted 711066561 1405264282
7801 \begin_layout Plain Layout
7803 \change_deleted 711066561 1405264216
7807 \change_inserted 711066561 1405264265
7808 PDF can also use DDE commands through the external program
7811 \change_deleted 711066561 1405264271
7815 \begin_inset CommandInset href
7817 target "ftp://ftp2.commence.com/pub/freebies/"
7827 While many of the widespread PDF viewers (most notably Adobe Reader) do
7828 not support forward search at all, some other viewers – e.
7829 \begin_inset space \thinspace{}
7833 evince and xpdf – allow at least to reload the document and jump to a specific
7834 page of the file, so you can at least navigate
7835 \begin_inset Quotes eld
7839 \begin_inset Quotes erd
7843 This latter functionality is provided by an external call of synctex (see
7844 the predefined example configurations).
7848 \begin_layout Standard
7849 Forward search works both with DVI and PDF output.
7851 simply checks which preview format you have used before (i.
7852 \begin_inset space \thinspace{}
7855 e., which format is already there in the temporary directory) and chooses
7856 the appropriate configuration for the respective format.
7859 \begin_layout Chapter
7860 Special Document Classes
7863 \begin_layout Section
7867 \begin_layout Standard
7873 \begin_layout Subsection
7877 \begin_layout Standard
7878 This section describes how \SpecialChar LyX
7879 can be used to write articles for submission
7880 to the scientific journal
7882 Astronomy and Astrophysics
7885 \change_deleted 274215730 1448595777
7886 www.edpsciences.fr/aa/
7889 \begin_inset Flex URL
7892 \begin_layout Plain Layout
7894 http://www.edpsciences.fr/aa/
7899 ) using Version 5.01 of the document class
7904 This package can be downloaded from the ftp site
7907 \begin_layout Standard
7908 \begin_inset VSpace medskip
7914 \begin_layout Standard
7916 \begin_inset Flex URL
7919 \begin_layout Plain Layout
7921 ftp://ftp.edpsciences.org/pub/aa/readme.html
7929 \begin_layout Standard
7930 \begin_inset VSpace medskip
7936 \begin_layout Standard
7937 A manual comes together with that package, and this text is not meant to
7938 replace the original manual but is merely a short guide in how to realize
7939 the correct form of your paper.
7943 \begin_layout Standard
7944 Please note that the publisher of the journal was changed from Springer
7945 to EDP Sciences starting January 1, 2001.
7946 That change involved also some slight changes to the style files, namely
7947 the removal of the thesaurus command.
7948 The \SpecialChar LyX
7949 class aa supports the newest version of these style files, V 5.01.
7950 If you have an older version installed, please upgrade.
7951 For compatibility, the old (version 4) layout has been kept as
7956 Please refer to the comments in
7959 Dir/layouts/aapaper.layout
7964 \begin_layout Subsection
7968 \begin_layout Standard
7969 It is recommended you start from the example template distributed with \SpecialChar LyX
7971 If you are not using a template, note the following settings:
7974 \begin_layout Itemize
7981 Document\SpecialChar menuseparator
7984 dialog (OK, that one was obvious).
7987 \begin_layout Itemize
7988 Don't change the option
7991 \begin_inset space ~
8001 The whole layout is done by the macros, you shouldn't change anything.
8004 \begin_layout Subsection
8008 \begin_layout Standard
8009 First thing to enter is the header information.
8010 It consists of seven entries, of which some are optional.
8014 \begin_layout Itemize
8022 \begin_layout Itemize
8030 \begin_layout Itemize
8038 \begin_layout Itemize
8046 \begin_layout Itemize
8051 : [optional] if more than one author: whom to contact for offprint requests.
8054 \begin_layout Itemize
8059 : [optional] mail address for contacts.
8062 \begin_layout Itemize
8070 Received: <date>; Accepted <date>
8073 \begin_layout Standard
8074 There is no need to issue the
8080 command, this is done automatically by \SpecialChar LyX
8081 when the header is finished.
8082 Although the order of the single header entries doesn't matter it is advised
8083 to keep the above sequence, just to get the best optics and meets the layout
8084 of the real document.
8087 \begin_layout Standard
8088 If you want to place footnotes in the header block, e.
8089 \begin_inset space \thinspace{}
8093 \begin_inset space \space{}
8096 to state your present address, just use the standard footnote via the menu
8099 Insert\SpecialChar menuseparator
8104 will automagically use the term
8113 \begin_layout Standard
8114 In addition to these topics, the macros use three additional \SpecialChar LaTeX
8116 have no counterpart in \SpecialChar LyX
8120 \begin_layout Itemize
8127 to separate different names for more than one author and institute, respectivel
8131 \begin_layout Itemize
8138 to mark corresponding author/institute pairs.
8139 The institutes are numbered sequentially as they appear in the
8143 field, so you have to put a marker to each author.
8146 \begin_layout Itemize
8153 to supply an email address for fast contact.
8156 \begin_layout Standard
8157 In all cases, the appropriate command has to be entered in \SpecialChar LyX
8165 \begin_layout Subsection
8169 \begin_layout Standard
8170 The abstract should immediately follow the header block.
8171 With version 5 the abstract environment was changed to a command, and there
8172 is now a resctriction to only one paragraph.
8173 In addition, it should contain an entry with the keywords.
8174 This is not yet implemented for \SpecialChar LyX
8175 , therefore you have to enter the \SpecialChar LaTeX
8183 by hand and mark it as \SpecialChar LaTeX
8185 Refer to the example paper.
8188 \begin_layout Subsection
8189 Supported environments
8192 \begin_layout Standard
8193 The A&A paper layout supports the following environments for structuring
8197 \begin_layout Itemize
8203 \begin_layout Itemize
8209 \begin_layout Itemize
8215 \begin_layout Itemize
8221 \begin_layout Itemize
8227 \begin_layout Itemize
8233 \begin_layout Itemize
8239 \begin_layout Itemize
8245 \begin_layout Itemize
8251 \begin_layout Itemize
8257 \begin_layout Itemize
8263 \begin_layout Itemize
8270 \begin_layout Subsection
8271 Commands not supported by \SpecialChar LyX
8275 \begin_layout Standard
8276 Some commands are not yet supported by the
8280 layout for \SpecialChar LyX
8282 Some have already been mentioned.
8283 For the sake of completeness, they are listed all together here:
8286 \begin_layout Itemize
8294 \begin_layout Itemize
8302 \begin_layout Itemize
8310 \begin_layout Itemize
8318 \begin_layout Itemize
8326 \begin_layout Itemize
8334 \begin_layout Itemize
8342 \begin_layout Itemize
8350 \begin_layout Standard
8351 If you want to use any of these commands, you have to enter them yourself.
8354 Do not forget to mark them as \SpecialChar LaTeX
8358 \begin_layout Subsection
8359 Figure and Table Floats
8362 \begin_layout Standard
8364 provides support for the necessary float environments
8366 figure, figure*, table
8372 , therefore we won't tell much about it here.
8376 \begin_inset space ~
8382 Just remember that tables should be left-aligned.
8383 For that, select the table and change the alignment in
8385 Edit\SpecialChar menuseparator
8387 \begin_inset space ~
8393 \begin_layout Standard
8394 There is only one special thing: the figures with caption besides the figure.
8395 To create such a figure, you have to do the following:
8398 \begin_layout Enumerate
8399 Create a wide figure float:
8401 Insert\SpecialChar menuseparator
8402 Float\SpecialChar menuseparator
8405 , then right click in the figure and select
8411 \begin_inset space ~
8419 \begin_layout Enumerate
8420 Enter your caption text.
8423 \begin_layout Enumerate
8428 to move the cursor above the caption.
8431 \begin_layout Enumerate
8435 \begin_layout Enumerate
8436 Position the cursor behind the figure and insert a horizontal fill:
8438 Insert\SpecialChar menuseparator
8440 \begin_inset space ~
8443 Character\SpecialChar menuseparator
8445 \begin_inset space ~
8453 \begin_layout Enumerate
8454 Switch to \SpecialChar LaTeX
8458 \begin_inset space ~
8466 \begin_layout Enumerate
8476 Do not close the brace!
8479 \begin_layout Enumerate
8480 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8485 \begin_inset space ~
8497 \begin_layout Standard
8498 Also, refer to the figures in the example paper.
8501 \begin_layout Subsection
8505 \begin_layout Standard
8506 For submission, the paper has to be formated in a special double-spacing
8508 For this purpose, you have to give the option
8512 to the documentclass.
8513 This must be done using the extra class options field in the
8515 Document\SpecialChar menuseparator
8519 Just enter the string
8526 \begin_layout Subsection
8530 \begin_layout Standard
8535 directory contains an example paper written with \SpecialChar LyX
8537 It is the example paper from the original macro package, translated to
8540 Use it for inspiration, and compare the original \SpecialChar LaTeX
8541 code with \SpecialChar LyX
8545 \begin_layout Section
8550 \begin_layout Standard
8556 \begin_layout Subsection
8560 \begin_layout Standard
8562 is a set of macros produced by the American Astronomical Society to
8563 facilitate electronic manuscript submission to the three journals they
8564 publish: the Astrophysical Journal (including the Letters and Supplement),
8565 the Astronomical Journal, and the Publications of the Astronomical Society
8568 has proven to be an excellent tool for generating these documents, especially
8569 given its equation, citation, and figure handling capabilities.
8571 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8572 is the version described here, or higher.
8573 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8574 2.09 and are fundamentally
8575 incompatible with \SpecialChar LyX
8577 The AAS\SpecialChar TeX
8578 package may be downloaded from the AAS\SpecialChar TeX
8582 \begin_layout Standard
8583 \begin_inset VSpace medskip
8589 \begin_layout Standard
8591 \begin_inset Flex URL
8594 \begin_layout Plain Layout
8596 http://www.journals.uchicago.edu/AAS/AASTeX
8604 \begin_layout Standard
8605 \begin_inset VSpace medskip
8611 \begin_layout Standard
8612 A complete user guide is contained in that package and you should familiarize
8613 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8616 will not reduce the need to figure out all the AAS\SpecialChar TeX
8617 commands, it will only
8618 reduce the drudgery of typing everything in.
8619 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8621 completely to the requirements of the journal to which you are submitting
8625 \begin_layout Subsection
8626 Starting a New Paper
8629 \begin_layout Standard
8630 I strongly suggest that you start with the AAS\SpecialChar TeX
8634 File\SpecialChar menuseparator
8641 , enter the new file name, then choose the
8646 This will show the most common fields found in a manuscript.
8647 Simply overwrite the existing text (including the brackets,
8651 ) with the correct information.
8652 Many of the AAS\SpecialChar TeX
8653 commands and environments can be implemented directly in
8655 , but some cannot: most noticeably
8667 , which should stick out like a sore thumb if you actually just opened the
8669 For commands such as these, the \SpecialChar LaTeX
8670 code must be entered directly and marked
8672 Such commands are referred to as \SpecialChar TeX
8673 code, or Evil Red Text.
8674 I tried to minimize the amount of \SpecialChar TeX
8675 code needed in an AAS\SpecialChar TeX
8677 there is still a bit more required than any of us would like.
8680 \begin_layout Subsection
8681 Finishing Your Paper
8684 \begin_layout Standard
8685 When the paper is finished to your satisfaction and previews/prints correctly,
8687 \begin_inset Quotes eld
8691 \begin_inset Quotes erd
8694 actions which need to be done before you submit it to the journals.
8698 \begin_layout Enumerate
8699 Export your paper as a \SpecialChar LaTeX
8702 File\SpecialChar menuseparator
8703 Export\SpecialChar menuseparator
8711 \begin_layout Enumerate
8716 file with your favorite text editor
8717 \begin_inset Separator parbreak
8724 \begin_layout Enumerate
8725 remove the comment lines before the
8734 \begin_layout Enumerate
8739 usepackage...{fontenc}
8741 line if it appears (usually just after
8756 \begin_layout Enumerate
8757 remove everything between (and including) the
8769 commands, except for any commands you specifically put into the \SpecialChar LaTeX
8771 (which should appear immediately after the
8772 \begin_inset Quotes eld
8775 User specified \SpecialChar LaTeX
8777 \begin_inset Quotes erd
8788 \begin_layout Enumerate
8789 Run the resulting file through \SpecialChar LaTeX
8790 to make sure it still processes correctly.
8793 \begin_layout Enumerate
8794 Reread the journal requirements to make sure your filenames and formats
8798 \begin_layout Enumerate
8802 \begin_layout Subsection
8803 Comments On Specific Commands
8806 \begin_layout Standard
8807 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8814 ) gives a good description of each.
8815 Thus it's probably easiest for me to go down the list as found in the guide
8816 and offer comments where necessary.
8817 So let's begin \SpecialChar ldots
8821 \begin_layout Subsubsection
8822 Things that work as expected
8825 \begin_layout Standard
8826 Because they work as you might expect, I simply list them and the section
8927 begin{thebibliography}
8935 (2.13.2), all the cite commands and their variations (2.13.2), the generic
8936 graphicx figure commands (2.14.1),
8960 (2.15.4, amongst other places),
8987 \begin_layout Standard
8988 The following style options also work correctly:
9009 Simply put them in the
9015 Layout\SpecialChar menuseparator
9021 \begin_layout Subsubsection
9022 Things that work, but require more comment
9025 \begin_layout Standard
9026 The following items work, but require a little more discussion:
9029 \begin_layout Itemize
9030 These items are reserved for use by the journal editors, but you can put
9031 them into the \SpecialChar LaTeX
9032 preamble if you feel compelled to do so:
9065 \begin_layout Itemize
9066 These items may be placed in the \SpecialChar LaTeX
9067 preamble, and are included as blanks in
9089 \begin_layout Itemize
9096 (2.3) – can only be used
9097 \begin_inset Quotes eld
9101 \begin_inset Quotes erd
9104 , not in the middle of a paragraph.
9105 Use \SpecialChar TeX
9106 code if you need to embed it.
9109 \begin_layout Itemize
9116 (2.3) – will have extra {} after it.
9117 This should not cause an error.
9120 \begin_layout Itemize
9127 (2.6) – can only be used
9128 \begin_inset Quotes eld
9132 \begin_inset Quotes erd
9135 , not in the middle of a paragraph.
9136 Use \SpecialChar TeX
9137 code if you need to embed it.
9140 \begin_layout Itemize
9147 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9151 \begin_layout Itemize
9165 \begin_layout Itemize
9172 (2.9) – will have extra {} after it.
9173 This should not cause an error.
9176 \begin_layout Itemize
9183 (2.11) – will have extra {} after it.
9184 This should not cause an error.
9187 \begin_layout Itemize
9194 (2.14.2) – you can insert an optional filename argument by placing the cursor
9195 at the beginning of the text and selecting
9197 Insert\SpecialChar menuseparator
9202 \begin_inset Quotes eld
9206 \begin_inset Quotes erd
9209 inserts an optional argument of the type needed by
9216 Hopefully it will be renamed someday.
9219 \begin_layout Itemize
9232 for the catalog ID optional parameter
9235 \begin_layout Itemize
9248 for the catalog ID optional parameter
9251 \begin_layout Subsubsection
9252 Things not implemented, use \SpecialChar TeX
9256 \begin_layout Standard
9279 setcounter{equation}
9281 (2.12), Journal name abbreviations (2.13.4),
9317 (2.15.4, insert it as the first element in the lefthand cell after where
9319 Don't use any of \SpecialChar LyX
9320 's rules in the table),
9332 (2.15.5), much of Misc (2.17, except
9383 \begin_layout Subsubsection
9384 Things that cannot be implemented
9387 \begin_layout Standard
9389 at least in any meaningful sort of way, so I suggest ignoring them.
9390 They are the references environment (2.13.3), and the deluxetable environment
9392 If you really, really need to use deluxetable, I suggest editing it in
9393 a separate file with a text editor, then using
9395 Insert\SpecialChar menuseparator
9397 \begin_inset space ~
9402 to include it in your \SpecialChar LyX
9408 file to see an example of this.
9411 \begin_layout Subsection
9412 FAQs, Tips, Tricks, and Other Ruminations
9415 \begin_layout Subsubsection
9416 Getting \SpecialChar LyX
9417 and AAS\SpecialChar TeX
9421 \begin_layout Standard
9422 It can be a bit tricky to get \SpecialChar LyX
9423 to recognize a new layout and document class.
9424 When all else fails, do this:
9427 \begin_layout Enumerate
9428 Make certain that \SpecialChar LaTeX
9429 can find AAS\SpecialChar TeX
9431 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9433 directory completely unrelated to \SpecialChar LaTeX
9434 or AAS\SpecialChar TeX
9435 and run \SpecialChar LaTeX
9443 \begin_layout Enumerate
9448 appears in \SpecialChar LyX
9456 \begin_layout Enumerate
9459 Tools\SpecialChar menuseparator
9463 , then restart \SpecialChar LyX
9467 \begin_layout Enumerate
9468 Open a regular new file, not from a template.
9469 Does AAS\SpecialChar TeX
9470 appear in the class list in
9472 Document\SpecialChar menuseparator
9478 \begin_layout Standard
9479 If you get a warning from an existing AAS\SpecialChar TeX
9480 document about not being able
9481 to find the AAS\SpecialChar TeX
9482 layout or a message about
9483 \begin_inset Quotes eld
9486 You should not mix title layouts with normal ones
9487 \begin_inset Quotes erd
9490 , things haven't been installed correctly.
9493 \begin_layout Subsubsection
9495 error processing a table
9498 \begin_layout Standard
9500 , by default, attempts to center the table caption/title.
9501 This seems to produce a bad interaction in AAS\SpecialChar TeX
9502 so you should click somewhere
9503 in the caption/title, then select
9505 Edit\SpecialChar menuseparator
9507 \begin_inset space ~
9521 This took care of it for me.
9524 \begin_layout Subsubsection
9528 \begin_layout Standard
9529 A couple of things: 1) I have noticed some funny spacing in the reference
9530 entries in the text.
9531 When you enter the bibliography item data, make sure their is
9535 space between the last author and the parenthesis setting off the year;
9539 \begin_inset space \thinspace{}
9543 \begin_inset space \space{}
9557 2) Entering the references at all is not obvious.
9558 The easiest thing is to start typing your first reference at the end of
9559 the document, then mark it as type
9564 That will put a small gray box in front of what you just typed.
9565 Click on the box to fill in the rest of the information.
9566 For new references, go to the end of an existing reference and press return.
9567 That will create a new line with its own box, etc.
9570 \begin_layout Subsubsection
9574 \begin_layout Standard
9575 Even though AAS\SpecialChar TeX
9576 provides its own figure commands (
9582 , for example), I much prefer \SpecialChar LaTeX
9583 's standard figure commands (with the default
9592 \begin_inset space ~
9595 commands as \SpecialChar TeX
9596 code into a Figure Float box if you desire, but I never have
9597 much luck getting the layout right.
9598 With the standard graphics, \SpecialChar LyX
9603 usepackage{graphicx}
9605 command into the \SpecialChar LaTeX
9606 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9608 interspersing the figures in the text.
9609 I believe ApJ accepts figures exactly this way now; AJ might still use
9611 \begin_inset Quotes eld
9614 stack everything at the end
9615 \begin_inset Quotes erd
9621 \begin_layout Subsubsection
9622 Things I could have done, but didn't
9625 \begin_layout Standard
9627 \begin_inset Quotes eld
9631 \begin_inset Quotes erd
9634 things I could have implemented, but chose not to.
9635 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9637 even though it is double-spaced in the paper manuscript.
9638 Also, I chose not to make separate layouts for the preprint and preprint2
9640 Since I assume you will spend most of your time in the plain manuscript
9641 mode anyway, I decided not to chew up more disk space with this.
9645 \begin_layout Subsection
9649 \begin_layout Standard
9650 Your mileage may vary.
9651 I've now had papers published by both ApJ and AJ that have had 98% of the
9652 effort done in \SpecialChar LyX
9653 ; the last 2% was the \SpecialChar LaTeX
9654 post-processing and a few cleanups.
9655 I have had no trouble with the submission process, and I'm sure the journals
9656 were never aware that there might be a difference.
9657 So, go forth and publish!
9660 \begin_layout Section
9661 AMS \SpecialChar LaTeX
9665 \begin_layout Standard
9675 \begin_layout Standard
9676 \begin_inset VSpace bigskip
9682 \begin_layout Standard
9684 The AMS \SpecialChar LaTeX
9685 layouts are set up to conform to suggested styles for mathematical
9686 papers to be submitted to American Mathematical Society publications.
9687 The layouts are not tailored to a specific journal, but easily can be.
9688 You should refer to the AMS documentation for specific instructions for
9689 each journal (usually it will entail only changing a single line in the
9692 That documentation is available on the Web at
9693 \begin_inset Flex URL
9696 \begin_layout Plain Layout
9704 \begin_inset Flex URL
9707 \begin_layout Plain Layout
9709 ftp://ftp.ams.org/pub/tex/amslatex/
9715 These layouts are appropriate, and useful, for any mathematical writing.
9719 \begin_layout Standard
9720 There are two basic AMS \SpecialChar LaTeX
9724 \begin_layout Itemize
9725 amsart: The standard AMS article format.
9728 \begin_layout Itemize
9729 amsbook: the standard AMS book (really, monograph) format.
9733 \begin_layout Standard
9734 The layouts themselves contain only the minimum necessary to use the AMS
9736 They do not, in particular, contain any of the `theorem' environments used
9737 for setting theorems, lemmas, and the like.
9738 These are contained, instead, in the
9739 \begin_inset Flex Code
9742 \begin_layout Plain Layout
9748 module, which is loaded by default when you select one of the AMS classes.
9749 (It can also be used with other classes and can be removed, if you would
9750 rather use something else.) Less commonly used environments are in the
9751 \begin_inset Flex Code
9754 \begin_layout Plain Layout
9755 Theorems (AMS-Extended)
9760 module, which must be loaded manually.
9763 \begin_layout Standard
9764 By default, theorems and the like are numbered consecutively throughout
9765 the document, but this may be modified by loading the module
9766 \begin_inset Flex Code
9769 \begin_layout Plain Layout
9770 Theorems (Order by Section)
9775 or, if you are using
9776 \begin_inset Flex Code
9779 \begin_layout Plain Layout
9786 \begin_inset Flex Code
9789 \begin_layout Plain Layout
9790 Theorems (Order by Chapter)
9796 These will number the results as
9797 \begin_inset Formula $n.m$
9800 , where the first number refers to the section (or chapter) and the second
9801 refers to the total number of results so far in that section (or chapter).
9802 Many environments are also available unnumbered.
9803 These are indicated by an asterisk at the end.
9804 If you happen to want
9808 unnumbered results, the module
9809 \begin_inset Flex Code
9812 \begin_layout Plain Layout
9818 provides that option.
9821 \begin_layout Standard
9822 Note that these modules do not
9826 to be used with the AMS classes.
9827 It is perfectly possible to use the
9828 \begin_inset Flex Code
9831 \begin_layout Plain Layout
9837 module, and the others mentioned, with other classes, such as
9838 \begin_inset Flex Code
9841 \begin_layout Plain Layout
9848 \begin_inset Flex Code
9851 \begin_layout Plain Layout
9858 \begin_inset Flex Code
9861 \begin_layout Plain Layout
9870 \begin_layout Subsection
9871 What these layouts provide
9874 \begin_layout Standard
9875 There is a long list of included environments provided by these layouts.
9876 In AMS-\SpecialChar LaTeX
9877 , there is, in fact, an opportunity to define an unlimited variety
9878 of `theorem' environments.
9879 However, the AMS recommends the environments that are available in \SpecialChar LyX
9884 \begin_layout Standard
9885 The following environments—as well as the standard environments, such as
9887 \begin_inset Flex Noun
9890 \begin_layout Plain Layout
9897 \begin_inset Flex Noun
9900 \begin_layout Plain Layout
9907 \begin_inset Flex Noun
9910 \begin_layout Plain Layout
9917 \begin_inset Flex Noun
9920 \begin_layout Plain Layout
9927 \begin_inset Flex Noun
9930 \begin_layout Plain Layout
9937 \begin_inset Flex Code
9940 \begin_layout Plain Layout
9947 \begin_inset Flex Code
9950 \begin_layout Plain Layout
9959 \begin_layout Description
9960 Address This should be the author's permanent address.
9963 \begin_layout Description
9965 \begin_inset space ~
9968 Address This should be the author's temporary address at the time of submission,
9969 if different from the Address.
9972 \begin_layout Description
9973 Email Author's e-mail address
9976 \begin_layout Description
9977 URL Author's Web address, if desired.
9980 \begin_layout Description
9981 Keywords Key words or phrases used to identify specific topics discussed
9985 \begin_layout Description
9986 Subjectclass These refer to the AMS Subject Classifications, published and
9989 Mathematical Reviews
9992 These are also available online at the AMS cites listed above.
9995 \begin_layout Description
9999 \begin_layout Description
10003 \begin_layout Description
10007 \begin_layout Standard
10008 The following environments are provided by both the
10009 \begin_inset Flex Code
10012 \begin_layout Plain Layout
10019 \begin_inset Flex Code
10022 \begin_layout Plain Layout
10028 modules, in the latter case in both starred (unnumbered) and unstarred
10029 (numbered) versions.
10030 These same environments are provided only in the starred versions by the
10032 \begin_inset Flex Code
10035 \begin_layout Plain Layout
10044 \begin_layout Theorem
10045 This is typically used for the statements of major results.
10049 \begin_layout Corollary*
10050 This is used for statements which follow fairly directly from previous statement
10052 Again, these can be major results.
10056 \begin_layout Lemma
10057 These are smaller results needed to prove other statements.
10060 \begin_layout Proposition
10061 These are less major results which (hopefully) add to the general theory
10065 \begin_layout Conjecture
10066 These are statements provided without justification, which the author does
10067 not know how to prove, but which seem to be true (to the author, at least).
10070 \begin_layout Definition*
10071 Guess what this is for.
10072 The font is different for this environment than for the previous ones.
10076 \begin_layout Example*
10077 Used for examples illustrating proven results.
10080 \begin_layout Problem
10081 It's not really known what this is for.
10082 You should figure it out.
10085 \begin_layout Exercise*
10086 Write a description for this one.
10089 \begin_layout Remark
10090 This environment is also a type of theorem, usually a lesser sort of observation.
10093 \begin_layout Claim*
10094 Often used in the course of giving a proof of a larger result.
10098 Generally, these are used to break up long arguments, using specific instances
10104 The numbering scheme for cases is on its own, not together with other numbered
10109 \begin_layout Proof
10110 At the end of this environment, a QED symbol (usually a square, but it can
10111 vary with different styles) is placed.
10112 If you want to have other environments within this one—for example, Case
10113 environments—and have the QED symbol appear only after them, then the other
10114 environments need to be nested within the proof environment.
10117 Nesting Environments
10123 for information on nesting.
10126 \begin_layout Standard
10127 And these environments are provided by
10128 \begin_inset Flex Code
10131 \begin_layout Plain Layout
10132 Theorems (AMS-Extended)
10140 \begin_layout Criterion*
10141 A required condition.
10144 \begin_layout Algorithm*
10145 A general procedure to be used.
10148 \begin_layout Axiom*
10149 This is a property or statement taken as true within the system being discussed.
10152 \begin_layout Condition*
10153 Sometimes used to state a condition assumed within the present context of
10157 \begin_layout Note*
10158 Similar to a Remark.
10161 \begin_layout Notation*
10162 Used for the explanation of, yes, notation.
10165 \begin_layout Summary
10166 Do we really need to tell you?
10169 \begin_layout Acknowledgement*
10173 \begin_layout Conclusion*
10174 Sometimes used at the end of a long train of argument.
10178 Used in a way similar to Proposition, though perhaps lower on the scale.
10181 \begin_layout Standard
10182 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10185 They need to be available on your system in order to use these environments.
10188 \begin_layout Section
10196 \begin_layout Standard
10202 \begin_layout Subsection
10206 \begin_layout Standard
10207 These are the layout files for some of the journals of the American Geophysical
10209 It is assumed that you have both the AGU's own class files and AGUplus
10210 installed (everything to be found at
10211 \begin_inset Flex URL
10214 \begin_layout Plain Layout
10216 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10224 \begin_layout Subsection
10228 \begin_layout Standard
10238 They are still called this in the \SpecialChar LyX
10239 GUI, though their \SpecialChar LaTeX
10252 \begin_layout Standard
10253 Newly defined styles are
10290 These are mostly manuscript attributes and defined in the AGU class documentati
10294 \begin_layout Standard
10295 I suspect this is still badly incomplete.
10298 \begin_layout Subsection
10302 \begin_layout Standard
10319 \begin_layout Subsection
10323 \begin_layout Itemize
10326 Journal of Geophysical Research
10335 \begin_layout Standard
10336 Add your own, it isn't so hard! Look at the
10347 \begin_layout Subsection
10348 Bugs and things to remember
10351 \begin_layout Standard
10352 In order to use the new layouts, you must remember to do the following for
10356 \begin_layout Enumerate
10362 This can be done in the
10364 Layout\SpecialChar menuseparator
10369 Document\SpecialChar menuseparator
10373 (AGU articles are always in English, right? So
10377 choose a language.)
10380 \begin_layout Enumerate
10385 into the document's
10390 (Yes, this is a bug.)
10393 \begin_layout Enumerate
10394 Make sure you use the
10398 bibliography style, by entering
10402 into the second field of the Bib\SpecialChar TeX
10404 None of the standard styles will do.
10407 \begin_layout Section
10411 \begin_layout Standard
10417 \begin_layout Subsection
10421 \begin_layout Standard
10422 Broadway is for writing plays.
10423 The format is more decorative than Hollywood, and much less standardized.
10424 This format should be suitable for workshops.
10427 \begin_layout Subsection
10431 \begin_layout Standard
10432 The same as in Hollywood.
10435 \begin_layout Subsection
10439 \begin_layout Standard
10444 names as labels then cross-reference the label to insert the name.
10445 The cross-reference dialog will show the current cast of characters.
10448 \begin_layout Subsection
10449 Paper size and Margins
10452 \begin_layout Standard
10453 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10456 \begin_layout Subsection
10460 \begin_layout Standard
10461 The following environments are available.
10462 You can use broadway.bind to get the bind keys shown at the right.
10465 \begin_layout Itemize
10469 \begin_inset Newline newline
10474 You should not have to use this, but it is here for anything that does not
10478 \begin_layout Itemize
10482 \begin_inset space \hfill{}
10486 \begin_inset Newline newline
10491 Used to describe stage setting and the action.
10492 First use of speaker names in all CAPs.
10495 \begin_layout Itemize
10499 \begin_inset space \hfill{}
10503 \begin_inset Newline newline
10508 Automatically numbered.
10509 On screen it will be arabic, but will print as Roman.
10512 \begin_layout Itemize
10516 \begin_inset space \hfill{}
10520 \begin_inset Newline newline
10530 It is just centered text.
10533 \begin_layout Itemize
10537 \begin_inset space \hfill{}
10541 \begin_inset Newline newline
10546 Not automatically numbered.
10547 You supply the number.
10548 This is because I couldn't figure out how.
10551 \begin_layout Itemize
10555 \begin_inset space \hfill{}
10559 \begin_inset Newline newline
10564 A special case of Narrative to describe the setting and action as the curtain
10568 \begin_layout Itemize
10572 \begin_inset space \hfill{}
10576 \begin_inset Newline newline
10581 The speaker's (actor's) title, centered in all CAPS.
10584 \begin_layout Itemize
10588 \begin_inset space \hfill{}
10592 \begin_inset Newline newline
10597 Instructions to the speaker.
10598 The parentheses are automatically inserted.
10599 The ( will appear on screen, but both will be in the printed play.
10600 This environment is only used within
10607 \begin_layout Itemize
10611 \begin_inset space \hfill{}
10615 \begin_inset Newline newline
10620 What the Speaker says.
10623 \begin_layout Itemize
10627 \begin_inset space \hfill{}
10631 \begin_inset Newline newline
10636 The curtain comes down.
10639 \begin_layout Itemize
10643 \begin_inset space \hfill{}
10649 \begin_layout Itemize
10653 \begin_inset space \hfill{}
10659 \begin_layout Itemize
10663 \begin_inset space \hfill{}
10669 \begin_layout Standard
10673 \begin_layout Section
10677 \begin_layout Standard
10682 can be used to type letters according to German conventions.
10683 A template file is included in
10685 .../lyx/share/templates
10687 for you to use as a starting point.
10690 \begin_layout Section
10698 \begin_layout Standard
10704 \begin_layout Subsection
10708 \begin_layout Standard
10709 This is the layout file for the European Geophysical Society journals.
10714 can be downloaded from the web site of the EGS under
10715 \begin_inset Flex URL
10718 \begin_layout Plain Layout
10728 \begin_layout Subsection
10732 \begin_layout Standard
10735 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10743 The current layout file is unfortunately very unmodular and would benefit
10744 from using the various
10751 \begin_layout Section
10755 \begin_layout Standard
10756 See the \SpecialChar LyX
10762 It contains all infos you need.
10765 \begin_layout Section
10768 Foil\SpecialChar TeX
10772 \begin_inset CommandInset label
10781 \begin_layout Standard
10787 \begin_layout Subsection
10791 \begin_layout Standard
10792 This section describes how to use \SpecialChar LyX
10793 to make slides for overhead projectors.
10794 There are two document classes that can do this: the default slides class
10797 Foil\SpecialChar TeX
10801 This section documents the latter.
10804 \begin_layout Standard
10805 I'm going to say this again, nice and clear, so that there's no misunderstanding
10809 \begin_layout Standard
10810 \begin_inset VSpace bigskip
10816 \begin_layout Standard
10820 This section documents the class
10821 \begin_inset Quotes eld
10827 \change_inserted -712698321 1437633339
10829 \change_deleted -712698321 1437633344
10836 \begin_inset Quotes erd
10844 \begin_layout Standard
10845 \begin_inset VSpace bigskip
10851 \begin_layout Standard
10852 If you're looking for the documentation for
10853 \begin_inset Quotes eld
10861 \begin_inset Quotes erd
10864 , check out section
10865 \begin_inset space ~
10869 \begin_inset CommandInset ref
10871 reference "sec:slitex"
10876 If your machine doesn't have the
10881 \begin_inset Quotes eld
10887 \change_inserted -712698321 1437633364
10889 \change_deleted -712698321 1437633362
10896 \begin_inset Quotes erd
10899 ] installed, you'll probably have to use the default
10903 class, which isn't quite as good as
10908 \begin_layout Standard
10913 class is designed for use with version 2.1 of the
10918 class file which is now an integral part of \SpecialChar LaTeX2e
10922 \begin_layout Subsection
10926 \begin_layout Standard
10927 Obviously, to use this document class, you need to select
10928 \begin_inset Quotes eld
10934 \change_inserted -712698321 1437633373
10936 \change_deleted -712698321 1437633373
10943 \begin_inset Quotes erd
10953 \begin_inset space ~
10959 There are some settings in the
10962 \begin_inset space ~
10967 dialog that you should know about that are specific to this class:
10970 \begin_layout Itemize
10971 Don't change the options
10982 \begin_inset space ~
10988 They're ignored by the
10995 \begin_layout Itemize
10996 The default font size is 20
10997 \begin_inset space \thinspace{}
11000 pt with the other options being 17
11001 \begin_inset space \thinspace{}
11005 \begin_inset space \thinspace{}
11009 \begin_inset space \thinspace{}
11015 \begin_layout Itemize
11016 The default font is
11024 but all math equations are still typeset in the usual roman font.
11027 \begin_layout Itemize
11030 Foil\SpecialChar TeX
11033 supports A4 and Letter paper sizes as well as a special size for working
11035 \begin_inset space \thinspace{}
11039 It doesn't support A5, B5, legal or executive paper sizes.
11042 \begin_layout Itemize
11043 Don't bother changing the
11047 settings because they are ignored anyway.
11048 All floats appear where they are defined in the text.
11051 \begin_layout Itemize
11056 setting behaves a bit differently for this class.
11059 Foil\SpecialChar TeX
11062 provides extensive footer and header capabilities including a user-defined
11065 \begin_inset space ~
11069 \begin_inset CommandInset ref
11071 reference "sec:foilfoot"
11076 The title page is treated differently to all other pages in the document
11085 has the logo centered at the bottom of the page (if one is defined).
11086 The possible page style choices and what they do are as follows:
11087 \begin_inset Separator parbreak
11094 \begin_layout Labeling
11095 \labelwidthstring MMMMMMM
11102 The final output contains no page numbers, or other headers or footers
11103 (except footnotes of course).
11107 \begin_layout Labeling
11108 \labelwidthstring MMMMMMM
11115 The final output contains page numbers centered at the bottom of the page.
11116 No other headings or footers (other than footnotes).
11119 \begin_layout Labeling
11120 \labelwidthstring MMMMMMM
11125 Page numbers in lower right corner.
11126 Additional headers and footers are also shown.
11127 This is also the default.
11130 \begin_layout Labeling
11131 \labelwidthstring MMMMMMM
11136 Gives you access to the
11140 package although its use with
11142 Foil\SpecialChar TeX
11145 is discouraged by the writer of the
11147 Foil\SpecialChar TeX
11150 package because of some potential page layout clashes.
11154 \begin_layout Subsubsection
11158 \begin_layout Standard
11159 The following options may be used in the extra class options in the
11161 Document\SpecialChar menuseparator
11167 \begin_layout Labeling
11168 \labelwidthstring MMMMMMx
11173 This sets up the page layout for 7.33
11174 \begin_inset space \thinspace{}
11178 \begin_inset space \thinspace{}
11181 in paper, which is about the same aspect ratio as a 35
11182 \begin_inset space \thinspace{}
11185 mm slide, making it a bit easier to work with this medium.
11188 \begin_layout Labeling
11189 \labelwidthstring MMMMMMx
11194 Places a rule across the page below the header on every page except the
11198 \begin_layout Labeling
11199 \labelwidthstring MMMMMMx
11204 Places a rule across the page above the footer on every page except the
11208 \begin_layout Labeling
11209 \labelwidthstring MMMMMMx
11214 This is automatically set each time you create a new
11221 Foil\SpecialChar TeX
11224 to use the dvips driver to rotate those pages that are set as landscape
11228 \begin_layout Labeling
11229 \labelwidthstring MMMMMMx
11234 Simply changes the page dimensions to those of a landscape page but doesn't
11236 Thus if you use this option you need to use an external program to rotate
11237 each page or feed your paper through your printer as landscape.
11238 Note that this option effectively reverses the roles of the
11246 environments (don't worry these are described in the next section).
11249 \begin_layout Labeling
11250 \labelwidthstring MMMMMMx
11255 Equation numbers on the left.
11258 \begin_layout Labeling
11259 \labelwidthstring MMMMMMx
11264 Flush-left equations.
11267 \begin_layout Subsection
11268 Supported Environments
11271 \begin_layout Standard
11272 Most of the environments commonly supported in other classes are also supported
11278 There are several additional environments provided by
11280 Foil\SpecialChar TeX
11283 as well as a couple added by \SpecialChar LyX
11285 The following environments are shared with other classes:
11288 \begin_layout Standard
11289 \begin_inset Flex Multiple Columns
11292 \begin_layout Itemize
11298 \begin_layout Itemize
11304 \begin_layout Itemize
11310 \begin_layout Itemize
11316 \begin_layout Itemize
11322 \begin_layout Itemize
11329 \begin_layout Itemize
11335 \begin_layout Itemize
11341 \begin_layout Itemize
11347 \begin_layout Itemize
11353 \begin_layout Itemize
11359 \begin_layout Itemize
11365 \begin_layout Itemize
11371 \begin_layout Itemize
11377 \begin_layout Itemize
11383 \begin_layout Itemize
11389 \begin_layout Itemize
11395 \begin_layout Itemize
11406 \begin_layout Standard
11407 That is, all the major environments apart from the sectioning environments.
11408 Since foils are essentially self-contained sections, with a title and body,
11411 Foil\SpecialChar TeX
11414 provides specific commands for starting new foils and these are:
11417 \begin_layout Itemize
11423 \begin_layout Itemize
11429 \begin_layout Standard
11431 also provides slightly modified versions of these two environments called:
11434 \begin_layout Itemize
11440 \begin_layout Itemize
11443 ShortRotatefoilhead
11446 \begin_layout Standard
11447 and the differences will be explained in the next section.
11450 \begin_layout Standard
11451 Since foils are often used in presenting ideas or new theorems and such
11454 Foil\SpecialChar TeX
11457 also provides a comprehensive box of goodies for presenting them:
11460 \begin_layout Standard
11461 \begin_inset Flex Multiple Columns
11464 \begin_layout Itemize
11470 \begin_layout Itemize
11476 \begin_layout Itemize
11482 \begin_layout Itemize
11488 \begin_layout Itemize
11494 \begin_layout Itemize
11500 \begin_layout Itemize
11506 \begin_layout Itemize
11512 \begin_layout Itemize
11518 \begin_layout Itemize
11524 \begin_layout Itemize
11535 \begin_layout Standard
11536 The starred versions are unnumbered while the unstarred versions are numbered.
11537 There are also two list environments added by \SpecialChar LyX
11541 \begin_layout Itemize
11547 \begin_layout Itemize
11553 \begin_layout Standard
11556 Foil\SpecialChar TeX
11559 provides some powerful header and footer capabilities that are best set
11560 in the preamble although they may be set at any point in a document.
11561 If you want to change these settings in your document the best place to
11562 do so is at the very top of a foil, i.
11563 \begin_inset space \thinspace{}
11569 \begin_inset space \space{}
11574 straight after the foilhead.
11577 \begin_layout Standard
11578 For this purpose, the following command styles are provided [
11585 \begin_layout Standard
11586 \begin_inset Flex Multiple Columns
11589 \begin_layout Itemize
11593 \begin_inset space ~
11599 \begin_layout Itemize
11605 \begin_layout Itemize
11609 \begin_inset space ~
11615 \begin_layout Itemize
11619 \begin_inset space ~
11625 \begin_layout Itemize
11629 \begin_inset space ~
11635 \begin_inset Separator parbreak
11642 \begin_layout Plain Layout
11643 \begin_inset space ~
11655 \begin_layout Standard
11656 There are also a few commands provided by
11658 Foil\SpecialChar TeX
11661 that aren't directly supported by \SpecialChar LyX
11662 but I'll tell you what they do and how
11663 to use them in section
11664 \begin_inset space ~
11668 \begin_inset CommandInset ref
11670 reference "sec:unsuppfoils"
11677 \begin_layout Subsection
11678 Building a Set of Foils
11681 \begin_layout Standard
11682 This section will give a simple introduction to using the different environments
11683 to build a set of foils.
11684 If you want to see an example set of foils, take a look at the
11688 file you find in \SpecialChar LyX
11696 \begin_layout Subsubsection
11697 Give It a Title Page
11700 \begin_layout Standard
11701 Unlike other classes that provide
11721 creates the title on a page of its own.
11722 If you leave out the
11726 environment \SpecialChar LaTeX
11727 will substitute the current date (every time you regenerate
11731 \begin_layout Subsubsection
11735 \begin_layout Standard
11736 As I mentioned earlier, there are four ways of starting a new foil.
11737 For portrait foils you should use
11746 The difference between these two environments is the amount of space between
11747 the title of the foil (the foilhead) and the body of the foil.
11750 \begin_layout Standard
11751 Landscape foils are generated using the
11757 ShortRotatefoilhead
11760 Again the only difference is the spacing between foilhead and body.
11761 Both of the short versions have 0.5
11762 \begin_inset space ~
11765 inches less separation between the foilhead and the body.
11769 \begin_layout Standard
11770 One problem with the support for landscape foils is the requirement that
11771 you have to use the
11775 driver to generate the PostScript output otherwise the foils won't be rotated.
11776 It is possible to get landscape foils even if you haven't got the
11780 driver provided you can feed your foils sideways through your printer ;-)
11783 \begin_layout Subsubsection
11784 Theorems, Lemmas, Proofs and more
11787 \begin_layout Standard
11788 Due to a small bug in \SpecialChar LyX
11789 you can't have two of the same type of these environments
11790 directly following each other.
11791 They must be separated by something.
11792 If you try, you will just be extending the previous environment as if you
11793 had merged the two environments together.
11794 So, how do you get around this problem? The simplest option is to insert
11795 some text between the two environments or add a
11800 environment between the two with just a
11801 \begin_inset Quotes eld
11809 \begin_inset Quotes erd
11813 This will force \SpecialChar LyX
11814 to produce two separate environments and hence the correct
11817 An example is provided in the example file included with the \SpecialChar LyX
11819 Remember, this problem only occurs if you are trying to place two of the
11820 same type of theorem-like environments one directly after the other.
11823 \begin_layout Subsubsection
11827 \begin_layout Standard
11828 You get all the commonly supported list styles found in other classes as
11829 well as two new ones.
11830 I'll only describe the new ones here.
11831 If you want to find out more about the other list environments check out
11837 If you intend to use itemized lists you might also want to read about the
11841 \begin_inset space ~
11845 \begin_inset space ~
11850 dialog described above in section
11851 \begin_inset space ~
11855 \begin_inset CommandInset ref
11857 reference "sec:bullet"
11864 \begin_layout Standard
11865 The two new list styles,
11873 , are designed to make it easier for you to create lists of do's and don'ts
11874 or right and wrong by providing dedicated environments that use a tick
11875 or a cross as the label of the list.
11876 These lists are in fact dedicated variants of the
11881 They do however require that you have the
11885 packages installed.
11888 \begin_layout Subsubsection
11892 \begin_layout Standard
11895 Foil\SpecialChar TeX
11898 redefines the floating tables and figures so that they appear exactly where
11899 they are in the text rather than pushing them to the top of the page or
11900 to some user specified location.
11901 In fact if you change the float placement settings they are simply ignored.
11904 \begin_layout Subsubsection
11905 Page Headers and Footers
11906 \begin_inset CommandInset label
11908 name "sec:foilfoot"
11915 \begin_layout Standard
11919 \begin_inset space ~
11928 are two commands used to control the left-footer text string.
11929 The first is meant to allow you to include a graphic logo on your foils
11931 \begin_inset Quotes eld
11936 Foil\SpecialChar TeX
11940 \begin_inset Quotes erd
11944 While the second is meant to provide a classification for the audience,
11948 \begin_inset space \thinspace{}
11954 \begin_inset space \space{}
11958 It is empty by default.
11961 \begin_layout Standard
11962 The remaining page corners can be filled by
11965 \begin_inset space ~
11970 (which defaults to page numbers),
11973 \begin_inset space ~
11981 \begin_inset space ~
11989 \begin_layout Subsection
11992 Foil\SpecialChar TeX
11996 \begin_inset CommandInset label
11998 name "sec:unsuppfoils"
12005 \begin_layout Standard
12006 All the commands mentioned below need to be set in a
12016 within another environment.
12019 \begin_layout Subsubsection
12023 \begin_layout Standard
12024 All lengths are adjusted using the
12047 should be replaced by the name given to the length you want to change and
12052 is the length value.
12053 All lengths should be specified in units of length such as inches (
12065 ) or relative to some document or font-based length such as
12075 \begin_layout Standard
12076 It's possible to change the spacing between a foilhead and the body of the
12077 foil by adjusting the length specified by
12084 For example, to make
12089 \begin_inset space \space{}
12092 in closer to their bodies put the following in the preamble:
12098 foilheadskip}{-0.5in}
12101 \begin_layout Standard
12102 The spacings around floats can be adjusted by setting these lengths:
12105 \begin_layout Labeling
12106 \labelwidthstring MMMMMMMMMMM
12113 Separation between the text and the top of the float
12116 \begin_layout Labeling
12117 \labelwidthstring MMMMMMMMMMM
12124 Separation between the float and the caption
12127 \begin_layout Labeling
12128 \labelwidthstring MMMMMMMMMMM
12135 Separation between the caption and the following text
12138 \begin_layout Labeling
12139 \labelwidthstring MMMMMMMMMMM
12146 You can make the captions narrower than the surrounding text by adjusting
12148 Best done relative to
12157 \begin_layout Standard
12158 There are also several title page related lengths that you may find useful
12159 if you have a long title or several authors:
12162 \begin_layout Labeling
12163 \labelwidthstring MMMMMMMMMMM
12170 Separation from headers to
12175 \begin_layout Labeling
12176 \labelwidthstring MMMMMMMMMMM
12194 \begin_layout Labeling
12195 \labelwidthstring MMMMMMMMMMM
12209 \begin_layout Labeling
12210 \labelwidthstring MMMMMMMMMMM
12226 \begin_layout Labeling
12227 \labelwidthstring MMMMMMMMMMM
12243 \begin_layout Standard
12244 The last length related command affects all the list environments.
12255 a list environment then all the vertical spacing between the list items
12257 Note that this is a command not a length so it doesn't require
12263 like the stuff mentioned above.
12266 \begin_layout Subsubsection
12267 Headers and Footers
12270 \begin_layout Standard
12283 commands control whether the logo in the
12287 definition appear on a given page.
12294 in the preamble then none of the foils will have the logo on them.
12295 If you don't want the logo on a particular page place the
12301 directly after the foilhead of that page and the
12307 directly after the next foilhead.
12310 \begin_layout Standard
12311 If you decide to use the
12315 page style setting in the
12318 \begin_inset space ~
12323 dialog you should probably add
12333 to your preamble so headers and footers on landscape pages are correctly
12334 placed when rotated.
12335 This is due to some clashes between the page layouts provided by the
12346 \begin_layout Section
12347 Hollywood (Hollywood spec scripts)
12350 \begin_layout Standard
12356 \begin_layout Subsection
12360 \begin_layout Standard
12361 Getting the format of a Hollywood script right is a
12362 \begin_inset Quotes eld
12366 \begin_inset Quotes erd
12369 It is designed to make the readers focus on content and to be easy and
12370 familiar for the actors to read.
12371 Each page of a script should be one minute of film.
12372 Nothing goes in a script that you cannot see or hear on screen.
12373 The courier 12 pt font should be used throughout.
12377 \begin_layout Subsection
12381 \begin_layout Standard
12382 Speakers' lines should NEVER break in mid-sentence.
12383 If a speaker's lines continue over a page break, repeat the
12387 title followed by (Cont'd).
12390 \begin_layout Subsection
12394 \begin_layout Standard
12399 names as labels then cross-reference the label to insert the name.
12400 The cross-reference dialog will show the current cast of characters.
12401 You can use this to insert the speaker name in narratives also.
12404 \begin_layout Subsection
12405 Paper size and Margins
12408 \begin_layout Standard
12409 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12412 \begin_layout Subsection
12416 \begin_layout Standard
12417 The following environments are available.
12418 You can use hollywood.bind to get the bind keys shown at the right.
12421 \begin_layout Itemize
12425 \begin_inset Newline newline
12430 Used where nothing else works.
12434 \begin_layout Itemize
12440 \begin_inset space \hfill{}
12448 \begin_inset Newline newline
12451 Usually followed by something like
12452 \begin_inset Quotes eld
12455 on Sally waking up.
12456 \begin_inset Quotes erd
12462 \begin_layout Itemize
12466 \begin_inset space \hfill{}
12470 \begin_inset Newline newline
12475 Introduces a new INTERIOR camera set-up.
12476 Always followed by DAY or NIGHT, or something similar to define the lighting
12478 Everthing on this line in CAPS.
12481 \begin_layout Itemize
12485 \begin_inset space \hfill{}
12489 \begin_inset Newline newline
12494 Introduces a new EXTERIOR camera set-up.
12495 Everthing on this line in CAPS.
12498 \begin_layout Itemize
12502 \begin_inset space \hfill{}
12506 \begin_inset Newline newline
12511 The character speaking.
12514 \begin_layout Itemize
12518 \begin_inset space \hfill{}
12522 \begin_inset Newline newline
12527 Instructions to the speaker.
12528 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12530 Both will be printed.
12533 \begin_layout Itemize
12537 \begin_inset space \hfill{}
12541 \begin_inset Newline newline
12553 \begin_layout Itemize
12557 \begin_inset space \hfill{}
12561 \begin_inset Newline newline
12566 Camera movement instruction.
12568 \begin_inset space \thinspace{}
12572 \begin_inset space \space{}
12578 \begin_layout Itemize
12582 \begin_inset space \hfill{}
12588 \begin_layout Itemize
12592 \begin_inset space \hfill{}
12598 \begin_layout Itemize
12602 \begin_inset space \hfill{}
12608 \begin_layout Itemize
12612 \begin_inset space \hfill{}
12618 \begin_layout Subsection
12622 \begin_layout Itemize
12626 \begin_layout Itemize
12630 \begin_layout Itemize
12632 \begin_inset space \thinspace{}
12639 \begin_layout Itemize
12644 \begin_layout Itemize
12645 PAN — camera movement
12648 \begin_layout Itemize
12649 INSERT — cut to close-up of
12652 \begin_layout Section
12656 \begin_layout Standard
12659 Panayotis Papasotiriou
12662 \begin_layout Subsection
12666 \begin_layout Standard
12667 The ijmpc package is a set of macros that facilitates electronic manuscript
12670 International Journal of Modern Physics C
12673 Similarly, the ijmpd package is for creating manuscripts to be submitted
12676 International Journal of Modern Physics D
12679 Both journals are published by World Scientific.
12680 The corresponding document classes are named
12689 These files, together with instructions for the authors, can be downloaded
12691 \begin_inset Flex URL
12694 \begin_layout Plain Layout
12696 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12702 \begin_inset Flex URL
12705 \begin_layout Plain Layout
12707 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12713 Both packages are modified versions of the standard
12714 \begin_inset Quotes eld
12718 \begin_inset Quotes erd
12721 package, and they are almost (but not exactly) identical.
12722 Most of their features are supported by \SpecialChar LyX
12724 I have used \SpecialChar LyX
12725 successfully to write articles submitted to both journals
12726 without any problem.
12729 \begin_layout Subsection
12733 \begin_layout Standard
12734 As usual, the easiest way to write a paper is to start with a template.
12737 File\SpecialChar menuseparator
12756 This will give an (almost) empty document that includes the most common
12757 fields found in a manuscript.
12758 Simply overwrite the existing text (including the brackets,
12763 You should keep in mind the following remarks.
12766 \begin_layout Enumerate
12768 won't let you change the font size and the page style of the document,
12769 because such modifications are not allowed by both packages.
12772 \begin_layout Enumerate
12773 The language of the document should not be changed.
12774 Before previewing your paper, be sure that the babel package is not used.
12775 To do this, click on
12777 Tools\SpecialChar menuseparator
12788 checkbox in the language settings, and click on
12796 , if you wish to make this change permanent).
12799 \begin_layout Enumerate
12801 \begin_inset Quotes eld
12805 \begin_inset Quotes erd
12808 style must be used to define keywords.
12811 \begin_layout Enumerate
12812 The ijmpc package provides a style named
12813 \begin_inset Quotes eld
12816 Classification Codes
12817 \begin_inset Quotes erd
12820 , which can be used to define classification codes, such as PACS numbers.
12821 Note that this facility is not supported by the ijmpd package.
12824 \begin_layout Enumerate
12825 Several new environments are available:
12826 \begin_inset Quotes eld
12830 \begin_inset Quotes erd
12834 \begin_inset Quotes eld
12838 \begin_inset Quotes erd
12842 \begin_inset Quotes eld
12846 \begin_inset Quotes erd
12850 \begin_inset Quotes eld
12854 \begin_inset Quotes erd
12858 \begin_inset Quotes eld
12862 \begin_inset Quotes erd
12866 \begin_inset Quotes eld
12870 \begin_inset Quotes erd
12874 \begin_inset Quotes eld
12878 \begin_inset Quotes erd
12882 \begin_inset Quotes eld
12886 \begin_inset Quotes erd
12890 \begin_inset Quotes eld
12894 \begin_inset Quotes erd
12898 \begin_inset Quotes eld
12902 \begin_inset Quotes erd
12906 \begin_inset Quotes eld
12910 \begin_inset Quotes erd
12914 \begin_inset Quotes eld
12918 \begin_inset Quotes erd
12922 \begin_inset Quotes eld
12926 \begin_inset Quotes erd
12930 \begin_inset Quotes eld
12934 \begin_inset Quotes erd
12938 Their use is more or less obvious.
12940 supports all these environments; it will use the proper label, text style,
12941 and numbering scheme for each of them.
12944 \begin_layout Enumerate
12945 Both packages use basic citations; the natbib package should not be used.
12946 In \SpecialChar LyX
12947 , citation references are shown as usual; in the output, citations are
12948 shown as superscripts.
12949 If you want to use a citation as normal text, you should use the
12954 \begin_inset space \thinspace{}
12958 \begin_inset space \space{}
12962 \begin_inset Quotes eld
12966 \begin_inset space \space{}
12976 \begin_inset Quotes erd
12982 \begin_layout Enumerate
12984 \begin_inset Quotes eld
12988 \begin_inset Quotes erd
12991 section in both packages.
12992 To put acknowledgments, just use the
12993 \begin_inset Quotes eld
12997 \begin_inset Quotes erd
13003 \begin_layout Enumerate
13004 Appendices may be added to the paper,
13008 the Acknowledgments and
13014 provides a special environment, called
13015 \begin_inset Quotes eld
13019 \begin_inset Quotes erd
13022 which marks the beginning of the appendices.
13023 This environment should be left blank; it just sends a \SpecialChar LaTeX
13024 command, but nothing
13026 In \SpecialChar LyX
13028 \begin_inset Quotes eld
13032 \begin_inset Quotes erd
13035 is printed with blue letters, as a signal that all sections after that
13036 point are appendices.
13037 To write an appendix, use the
13038 \begin_inset Quotes eld
13042 \begin_inset Quotes erd
13047 will number each appendix with capital letters, as required by both journals.
13049 \begin_inset Quotes eld
13053 \begin_inset Quotes erd
13060 be present before the first appendix; if not, all appendices will be numbered
13061 as normal sections in the output.
13064 \begin_layout Enumerate
13065 The ijmpc and the ijmpd packages use the
13069 command to implement table captions.
13070 As a result, a table created by \SpecialChar LyX
13071 is printed correctly, but its caption
13073 However, you can use some \SpecialChar TeX
13074 code to overcome this problem, so that captions
13075 are printed as expected.
13076 To do so, create a float table as usual, remove the caption, and replace
13077 it with the \SpecialChar TeX
13088 (sic); you must also the \SpecialChar TeX
13093 immediately after the tabular material.
13094 Study the example table included in the template files to see how this
13095 trick is implemented.
13096 Alternatively, If you need table captions, you should implement the whole
13101 file, then include this file to the \SpecialChar LyX
13104 Insert\SpecialChar menuseparator
13105 File\SpecialChar menuseparator
13107 \begin_inset space ~
13113 Details on how to create a table float can be found in the files
13121 , included in the corresponding packages.
13124 \begin_layout Subsection
13125 Preparing a paper for submission
13128 \begin_layout Standard
13129 Before you submit your paper you must export the \SpecialChar LyX
13130 document as a \SpecialChar LaTeX
13133 File\SpecialChar menuseparator
13134 Export\SpecialChar menuseparator
13142 \begin_layout Plain Layout
13143 Actually you have the choice between \SpecialChar LaTeX
13144 (plain) and pdflatex.
13145 If you intend to use pdflatex to prepare the paper, you should use the
13146 pdflatex option so that included graphics are converted to PDF format,
13147 ready for use by pdflatex.
13152 , then make the following changes to the resulting
13159 \begin_layout Enumerate
13160 Remove the comment lines before the
13169 \begin_layout Enumerate
13170 Remove everything between (and including) the
13182 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13186 \begin_layout Standard
13191 file should be saved and processed through \SpecialChar LaTeX
13192 as many times as necessary.
13193 You may also want to check the resulting
13200 \begin_layout Subsection
13201 Use of \SpecialChar TeX
13205 \begin_layout Standard
13206 The use of \SpecialChar TeX
13207 code is reduced to two commands, which must be placed at the
13208 top of the document.
13209 If you started writing your paper by using the
13217 template, the \SpecialChar TeX
13218 code needed is already in its place; you usually don't need
13220 You may only modify the first \SpecialChar TeX
13221 code to specify the information printed
13222 to the top of odd and even pages (authors' names and short paper's title,
13224 This \SpecialChar TeX
13225 code must have the form
13229 markboth{Authors' Names}{Short Paper's Title}
13234 \begin_layout Section
13238 \begin_layout Standard
13244 \begin_layout Subsection
13248 \begin_layout Standard
13249 The iopart package provides a document class to create electronic manuscript
13250 submission to the journals published by the Institute of Physics.
13251 Instructions for the authors how to create a paper using the iopart class
13252 can be downloaded together with the iopart package from the site
13253 \begin_inset Flex URL
13256 \begin_layout Plain Layout
13258 ftp://ftp.iop.org/pub/journals/latex2e
13266 \begin_layout Subsection
13270 \begin_layout Standard
13271 The easiest way to write a paper is to start with the file
13275 that is available in \SpecialChar LyX
13276 's examples files folder.
13277 Open this file, save it under a new name, and start writing.
13278 The example file explains how to use the special text environments.
13279 Here are the most important advices:
13282 \begin_layout Itemize
13283 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13286 Use AMS math package
13288 in the document settings under
13295 \begin_layout Itemize
13298 The title environment defines the kind of your paper.
13299 So use one of the following environments for the title:
13302 \begin_inset Separator parbreak
13309 \begin_layout Itemize
13318 \begin_layout Itemize
13327 \begin_layout Itemize
13333 for a Topical review
13336 \begin_layout Itemize
13345 \begin_layout Itemize
13354 \begin_layout Itemize
13360 for a Paper (same as Title)
13363 \begin_layout Itemize
13369 for a Preliminary communication
13372 \begin_layout Itemize
13378 for a Rapid communication
13381 \begin_layout Itemize
13387 for a Letter to the editor
13391 \begin_layout Itemize
13394 All title environments except of
13398 can have an optional short title.
13401 \begin_layout Itemize
13402 There is a general title environment
13406 which is not directly supported by the \SpecialChar LyX
13408 This can be used as \SpecialChar TeX
13409 code when your document doesn't fit into one of the
13413 \begin_layout Standard
13414 For more informations like hints for special table and formula formatting,
13415 look at the IOP author guidelines.
13418 \begin_layout Section
13422 \begin_layout Standard
13425 Panayotis Papasotiriou
13428 \begin_layout Subsection
13432 \begin_layout Standard
13433 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13434 that facilitates electronic manuscript submission to the journals they
13436 Most known of them (at least in my domain of interest) are
13438 Astrophysics and Space Science
13444 , but there are many others (see a complete list at
13445 \begin_inset Flex URL
13448 \begin_layout Plain Layout
13450 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13456 The Kluwer package may be downloaded from the site
13457 \begin_inset Flex URL
13460 \begin_layout Plain Layout
13462 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13468 A complete user guide is contained in that package (but it can also be
13469 downloaded separately).
13472 \begin_layout Standard
13474 supports many features of the package but not everything.
13475 However, the \SpecialChar TeX
13476 code needed is reduced to some
13477 \begin_inset Quotes eld
13481 \begin_inset Quotes erd
13484 commands of the package (see
13485 \begin_inset space ~
13489 \begin_inset CommandInset ref
13491 reference "subsec:kluwer_peculiarities"
13496 I have recently used \SpecialChar LyX
13497 to write an article submitted to the
13499 Astrophysics and Space Science
13501 without any problem.
13504 \begin_layout Subsection
13508 \begin_layout Standard
13509 The easiest way to write a paper is to start with the Kluwer template file.
13512 File\SpecialChar menuseparator
13524 This will give an (almost) empty document that includes the most common
13525 fields found in a manuscript and a short description of their use.
13526 As in most templates, simply overwrite the existing text (including the
13531 ) with the correct information.
13534 \begin_layout Subsection
13535 Preparing a paper for submission
13538 \begin_layout Standard
13539 As in the AAS\SpecialChar TeX
13540 package, before you submit your paper to a journal you must
13542 \begin_inset Quotes eld
13546 \begin_inset Quotes erd
13552 \begin_layout Enumerate
13553 Export your paper as a \SpecialChar LaTeX
13555 To do this, click on
13557 File\SpecialChar menuseparator
13558 Export\SpecialChar menuseparator
13566 \begin_layout Enumerate
13571 file with a text editor and make the following changes
13572 \begin_inset Separator parbreak
13579 \begin_layout Enumerate
13580 remove the comment lines before the
13589 \begin_layout Enumerate
13590 remove everything between (and including) the
13602 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13606 \begin_layout Standard
13615 \begin_layout Enumerate
13620 file through \SpecialChar LaTeX
13621 as many times as necessary (usually up to three).
13624 \begin_layout Enumerate
13630 \begin_inset space \thinspace{}
13634 \begin_inset space \space{}
13641 , and check if everything is OK (it should, if you didn't make any mistake).
13644 \begin_layout Subsection
13645 \begin_inset Quotes eld
13649 \begin_inset Quotes erd
13652 of the Kluwer package
13653 \begin_inset CommandInset label
13655 name "subsec:kluwer_peculiarities"
13662 \begin_layout Standard
13663 The Kluwer package has the following
13664 \begin_inset Quotes eld
13668 \begin_inset Quotes erd
13674 \begin_layout Enumerate
13675 It is possible to write multiple articles in the same \SpecialChar LaTeX
13680 \begin_layout Plain Layout
13681 I can't imagine any good reason to do this.
13687 Each article must be included in the environment
13688 \begin_inset Quotes eld
13692 \begin_inset Quotes erd
13696 Unfortunately, this environment cannot be omitted, even if you write just
13698 Therefore, each article starts with the command
13704 and, obviously, ends with the command
13711 Although this can be implemented in \SpecialChar LyX
13712 , I didn't included it, since it looks
13713 ugly and can confuse the novice user.
13714 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13717 \begin_inset Quotes eld
13722 \begin_inset Quotes erd
13728 \begin_layout Enumerate
13729 Information given at the beginning of the article (i.
13730 \begin_inset space \thinspace{}
13734 \begin_inset space \space{}
13737 title, subtitle, author, institution, running title, running author, abstract
13738 and keywords) must be included in an environment called
13739 \begin_inset Quotes eld
13743 \begin_inset Quotes erd
13747 This is not implemented in \SpecialChar LyX
13748 , so you must enter title, subtitle etc.
13749 \begin_inset space ~
13752 between two \SpecialChar TeX
13768 \begin_layout Enumerate
13769 According to the user manual, the label of each bibliography item must be
13793 \begin_layout Standard
13798 template takes care of all these
13799 \begin_inset Quotes eld
13803 \begin_inset Quotes erd
13807 If you start a new paper using this template you don't need to do anything
13812 \begin_layout Enumerate
13813 don't delete the \SpecialChar TeX
13814 code included in the template, and
13817 \begin_layout Enumerate
13818 copy the example bibliography item included in the template and modify it
13819 as necessary to enter new bibliography items.
13822 \begin_layout Section
13826 \begin_layout Standard
13832 \begin_layout Subsection
13836 \begin_layout Standard
13837 The \SpecialChar LyX
13840 article (koma-script)
13844 report (koma-script)
13862 correspond to the \SpecialChar LaTeX
13880 \begin_inset space ~
13883 of the Koma-Script family.
13884 They are replacements for the standard document classes
13900 , resp., and fit better to European typography conventions in a number of
13904 \begin_layout Itemize
13905 Standard character size is 11pt in
13907 article (koma-script)
13911 report (koma-script)
13919 letter (koma-script)
13924 \begin_layout Itemize
13925 Headings, labels of the description environment, and a number of elements
13928 letter (koma-script)
13930 document class are set in a bold sans serif font.
13934 \begin_layout Plain Layout
13935 There is a big difference between the bold sans serif old cm fonts and new
13936 ec fonts, especially in the appearance of headings.
13937 In comparison, the ec bold sans serif fonts look a bit thin.
13938 Here the \SpecialChar LaTeX
13947 helps to produce the
13948 \begin_inset Quotes eld
13952 \begin_inset Quotes erd
13955 appearance when using the ec fonts.
13960 The numbering of chapter headings is made in the same way as the numbering
13961 of section headings, that is without the extra line
13962 \begin_inset Quotes eld
13965 Chapter\SpecialChar ldots
13967 \begin_inset Quotes erd
13971 In addition, the appearance of the headings can be modified by using a
13972 number of options (in \SpecialChar LyX
13973 to be entered in the field
13976 \begin_inset space ~
13983 Layout\SpecialChar menuseparator
13990 \begin_layout Itemize
13991 The main means in the Koma-Script document classes to design the type area
14000 (in \SpecialChar LyX
14001 to be entered in the extra class options field in the dialog
14003 Document\SpecialChar menuseparator
14007 They make a clearer modification of page margins possible as do the options
14010 Document\SpecialChar menuseparator
14017 \begin_layout Itemize
14018 The \SpecialChar LaTeX
14019 document classes of the Koma-Script family define a number of additional
14021 Those part of it which makes sense in \SpecialChar LyX
14022 is implemented in corresponding
14026 \begin_layout Standard
14027 Detailed descriptions of the \SpecialChar LaTeX
14028 document classes of the Koma-Script family
14029 can be found in the Koma-Script documentation
14040 \begin_layout Subsection
14041 article (koma-script), report (koma-script), and book (koma-script)
14044 \begin_layout Standard
14045 The document classes
14047 article (koma-script)
14051 report (koma-script)
14061 are implemented in the layout files
14074 They contain all the paragraph types of the corresponding standard document
14087 , resp., partly modified, with the exception of the \SpecialChar LyX
14092 -type, which is replaced by the new
14096 -type having the same functionality.
14101 -Type there is a number of new paragraph types added.
14108 letter (koma-script)
14113 \begin_layout Itemize
14122 : are equivalents to
14130 , resp., additionally inserting an entry in the table of contents.
14139 are not contained in
14141 article (koma-script)
14146 \begin_layout Itemize
14155 : behave exactly as
14163 , resp., additionally clearing running heads.
14168 is not contained in
14170 article (koma-script)
14176 \begin_layout Plain Layout
14189 report (koma-script)
14191 , but since this is identical to
14195 , is has not been implemented in \SpecialChar LyX
14204 \begin_layout Itemize
14209 : generates a heading directly above the following paragraph in the standard
14210 character size without affecting the structure of the document.
14213 \begin_layout Itemize
14222 are special captions which respect the different space settings needed
14223 for captions placed above or below an element (if you follow strict typographic
14224 rules, you might want to place table captions always above the table).
14225 You can also use the class option
14229 , which will switch
14242 You need at least Koma-Script version 2.8q to use this.
14245 \begin_layout Itemize
14250 : can be used to set a bonmot, e.
14251 \begin_inset space \thinspace{}
14255 \begin_inset space \space{}
14258 at the beginning of a chapter.
14259 If you use the optional argument (
14261 Insert\SpecialChar menuseparator
14263 \begin_inset space ~
14268 ), you can insert the dictum's author there.
14269 Dictum and author are separated by a line.
14270 You need at least Koma-Script version 2.8q to use this.
14275 is not contained in
14277 article (koma-script)
14282 \begin_layout Standard
14283 The following types, together with the standard types
14295 , form the title area of the document.
14296 They must be entered ahead of the first
14297 \begin_inset Quotes eld
14301 \begin_inset Quotes erd
14308 \begin_layout Plain Layout
14309 The corresponding \SpecialChar LaTeX
14310 commands must appear before the
14321 When such a type is used more than once, the latter usage overwrites the
14322 former one, that means, for every type only the latest usage is valid.
14323 The order of the different types however has, like
14335 , no effect on the appearance of the produced document.
14338 \begin_layout Itemize
14343 : produces a centered paragraph above the ordinary title (
14355 ) for the subject of the document.
14358 \begin_layout Itemize
14363 : produces a centered paragraph below the ordinary title (
14375 ) for the publishers' name.
14378 \begin_layout Itemize
14385 report (koma-script)
14391 produces a centered paragraph on its own page behind the title page, or
14394 article (koma-script)
14396 produces a centered paragraph below the ordinary title (
14412 ) for a dedication.
14415 \begin_layout Itemize
14420 : produces a left aligned paragraph above the ordinary title (
14436 ) for a document`s head.
14439 \begin_layout Itemize
14444 : produces in a double-sided print in
14446 report (koma-script)
14452 a left-aligned paragraph at the top of the title page`s back or has no
14453 effect in a single-sided print or in
14455 article (koma-script)
14460 \begin_layout Itemize
14465 : produces in a double-sided print in
14467 report (koma-script)
14473 a left-aligned paragraph at the bottom of the title page`s back or has
14474 no effect in a single-sided print or in
14476 article (koma-script)
14481 \begin_layout Itemize
14486 : produces a special
14487 \begin_inset Quotes eld
14491 \begin_inset Quotes erd
14494 page ahead of the actual document containing a paragraph without special
14498 \begin_layout Standard
14499 The layout files for the document classes
14501 article (koma-script)
14505 report (koma-script)
14511 do include the file
14516 This is thought of as a place to define your own types.
14521 in your personal layout directory and edit the file!
14524 \begin_layout Subsection
14525 letter (koma-script)
14528 \begin_layout Standard
14532 letter (koma-script)
14534 is implemented in the layout file
14539 It contains all the paragraph types of the corresponding standard document
14544 , partly modified, with the exception of the \SpecialChar LyX
14558 type, which is replaced by the new
14563 In addition, it contains, in contrast to the standard document class, the
14582 Furthermore, there are a number of new letter specific types.
14585 \begin_layout Standard
14586 The appearance of the letter produced by this document class can be controlled
14587 by a number of \SpecialChar LaTeX
14588 commands, which you can put in the \SpecialChar LaTeX
14593 \begin_layout Plain Layout
14594 For example, the standard appearance of the letter`s heading, consisting
14595 of name and address, is quite self-willed.
14597 \begin_inset Quotes eld
14601 \begin_inset Quotes erd
14604 heading is produced by the following \SpecialChar LaTeX
14605 commands in the preamble:
14608 \begin_layout LyX-Code
14618 \begin_layout LyX-Code
14634 \begin_layout LyX-Code
14644 \begin_layout LyX-Code
14664 A detailed German description of such \SpecialChar LaTeX
14665 commands can be found in the Koma-Script
14671 With it, the letter's author can produce his personal letter layout.
14674 \begin_layout Standard
14683 define the beginning of the letter and must be used in every letter.
14684 To emphasize them in the \SpecialChar LyX
14685 document class, they are marked with the letter
14695 \begin_inset space ~
14698 in the left margin.
14699 It is possible to write any number of letters in one file.
14704 type produces a new letter using the same addressee and a
14708 type produces a new addressee.
14725 are ordinary paragraph types and can also be used several times in one
14726 and the same letter.
14729 \begin_layout Itemize
14734 : produces a paragraph for the addressee and implicitly defines the beginning
14738 \begin_layout Itemize
14743 : produces a paragraph for the form of address and implicitly produces a
14747 \begin_layout Itemize
14752 : produces a paragraph for a close.
14755 \begin_layout Itemize
14760 : produces a paragraph for a postscript.
14763 \begin_layout Itemize
14768 : produces a paragraph for a distribution list.
14771 \begin_layout Itemize
14776 : produces a paragraph for enclosures.
14779 \begin_layout Standard
14820 are input types provided with a label to enter information, which will
14821 be processed by the document class.
14825 \begin_layout Plain Layout
14826 It could be seen as a matter of inconsequence, that the types
14834 described above are not such input types as well.
14835 Because of the special meaning of those types, however, I have implemented
14836 them as ordinary paragraph types with a one letter mark in the left margin.
14837 Moreover, it would affect my feeling of symmetry, if the
14845 type had such a serious different appearance.
14850 The types must be used ahead of the corresponding
14857 \begin_layout Standard
14858 An implementation of these types in a WYSIWYG fashion does not seem to make
14859 sense, because the real appearance of the produced letter does not only
14860 depend on the usage of the particular type, but also on other factors.
14861 For example, a signature entered in the
14865 type will in the standard behavior appear in the produced letter only,
14866 when in the same letter also a
14871 The entered value of the
14875 type will in the standard behavior not appear in the produced letter at
14877 The possibility to design the letter`s heading freely is already indicated
14878 in a footnote above.
14881 \begin_layout Standard
14882 The input types can also be used as empty paragraphs.
14883 This makes sense e.
14884 \begin_inset space \thinspace{}
14888 \begin_inset space \space{}
14900 type is not used at all, in the standard behavior the value of the
14904 type is used as signature, whereas if an empty
14908 type is used, no signature value is defined.
14911 \begin_layout Standard
14912 By using the input types it is possible to write a letter template, containing
14913 filled input types with your personal dates (name, address, etc.) and empty
14914 input types for other dates you want to enter.
14917 \begin_layout Itemize
14922 : sender's name, in the standard behavior appears as a centered paragraph
14923 in small caps in the letter`s heading.
14926 \begin_layout Itemize
14931 : sender's signature, in the standard behavior appears below the
14940 type is used, the value of the
14944 type appears instead.
14947 \begin_layout Itemize
14952 : sender's address, in the standard behavior appears in a centered paragraph
14953 in the letter`s heading below the sender's name.
14956 \begin_layout Itemize
14961 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
14972 \begin_layout Itemize
14977 : place of the letter`s making.
14980 \begin_layout Itemize
14985 : date of the letter`s making.
14994 , in the standard behavior, produce the place and the date in a right-aligned
14995 line below the addressee's field.
15000 type is used, neither place nor date appear, independent of the value of
15010 type is used, the date of the letter `s production is used.
15013 \begin_layout Itemize
15018 : sender`s back address, in the standard behavior appears above the addressee's
15019 field in a small sans serif font.
15022 \begin_layout Itemize
15027 : special mail information, in the standard behavior appears underlined
15028 above the addressee's field below the back address.
15031 \begin_layout Itemize
15036 : additional information, in the standard behavior appears on right side
15037 below the addressee`s field.
15040 \begin_layout Itemize
15045 : the letter's title, in the standard behavior appears in a big, bold, sans
15046 serif font above the subject.
15049 \begin_layout Itemize
15054 : the letter's subject, in the standard behavior appears in a bold font
15062 \begin_layout Standard
15083 produce a business letter like line above the
15087 line containing the fields
15088 \begin_inset Quotes eld
15092 \begin_inset Quotes erd
15096 \begin_inset Quotes eld
15100 \begin_inset Quotes erd
15104 \begin_inset Quotes eld
15108 \begin_inset Quotes erd
15112 \begin_inset Quotes eld
15116 \begin_inset Quotes erd
15120 \begin_inset Quotes eld
15124 \begin_inset Quotes erd
15128 \begin_inset Quotes eld
15132 \begin_inset Quotes erd
15136 For the date field, the value of the
15142 \begin_inset Quotes eld
15145 business letter types
15146 \begin_inset Quotes erd
15149 is used, the value of the
15153 type however does not appear, but only the \SpecialChar LaTeX
15161 The ordinary output of place and date in a right-aligned line below the
15162 addressee`s field is suppressed.
15163 The types are implemented as input types provided with a label and must
15164 be used ahead of the corresponding
15171 \begin_layout Itemize
15179 \begin_layout Itemize
15187 \begin_layout Itemize
15195 \begin_layout Itemize
15203 \begin_layout Itemize
15211 \begin_layout Subsection
15212 The new letter class: letter (koma-script v.2)
15215 \begin_layout Standard
15221 \begin_layout Standard
15222 \begin_inset VSpace medskip
15228 \begin_layout Standard
15230 Koma-Script version 2.8 has introduced a new letter class
15234 which supersedes the now unsupported
15239 It has — on the \SpecialChar LaTeX
15240 side — a completely new interface and is not compatible
15241 with the old class.
15242 Therefore, \SpecialChar LyX
15243 supports both, though it is recommended you use the new class.
15246 \begin_layout Standard
15247 This class covers the same functionality as
15249 letter (koma-script),
15252 The basic items are
15256 (receiver's address, same as
15260 in the old layout),
15273 will start a new letter (i.
15274 \begin_inset space \thinspace{}
15278 \begin_inset space \space{}
15281 you can write several letters per document).
15282 New elements are sender's
15298 and the possibility to use a
15304 Insert\SpecialChar menuseparator
15310 \begin_layout Standard
15311 The biggest improvement is, though, that the letter's layout is configurable
15312 to meet almost any needs.
15313 This can be done via the preamble or with a special style file (Letter
15314 Class Option, extension
15318 ), that will be read in as a class option.
15322 \begin_layout Plain Layout
15323 The KOMA package comes with some default
15328 There is, for instance, a
15332 file that follows german typesetting rules, or a
15336 that provides the default layout of the old
15341 The latter can be loaded with the class option
15350 ayout\SpecialChar menuseparator
15355 ocument\SpecialChar menuseparator
15367 template that is included in \SpecialChar LyX
15369 A detailed description is to be found in the Koma-Script documentation
15377 \begin_layout Subsection
15381 \begin_layout Standard
15382 Visualizing the Koma-Script document classes in \SpecialChar LyX
15383 , the \SpecialChar LyX
15384 internals cause some
15388 \begin_layout Itemize
15389 The chapter number of a
15393 type appears on a line of its own above the chapter heading instead of
15394 appearing in the same line ahead of it.
15395 The cause for that is the \SpecialChar LyX
15396 internal behavior for the labeltype
15400 in the layout file.
15403 \begin_layout Itemize
15404 The headings of the types
15412 are only put in the
15413 \begin_inset Quotes eld
15417 \begin_inset Quotes erd
15421 table of contents, but not in the \SpecialChar LyX
15422 table of contents (
15424 Document\SpecialChar menuseparator
15426 \begin_inset space ~
15430 \begin_inset space ~
15438 \begin_layout Itemize
15439 The paragraphs in a
15443 document class appear in a skip separation mode, not indented.
15444 This is the standard behavior, no special \SpecialChar LaTeX
15445 commands are needed for that.
15448 Document\SpecialChar menuseparator
15451 dialog the corresponding radio button indicates
15460 value always has the effect that extra \SpecialChar LaTeX
15461 commands are inserted in the document
15462 to produce the gap, which is not what is wanted in this case.
15465 \begin_layout Section
15469 \begin_layout Standard
15475 \begin_layout Subsection
15479 \begin_layout Standard
15480 Memoir is a very powerful and constantly evolving class.
15481 It has been designed with regard to fictional and non-fictional literature.
15482 Its aim is to let the user have maximum control over the typesetting of
15484 Memoir is based on the standard book class, but it can also emulate the
15485 article class (see below).
15488 \begin_layout Standard
15489 Peter Wilson, the developer of Memoir, is known as the author of lots of
15490 useful packages in the \SpecialChar LaTeX
15492 Most of them have been merged with Memoir.
15493 Therefore, it is much easier to layout the table of contents, appendices,
15494 chapter designs and such.
15496 , though, does not support all of these goodies natively.
15497 Some of them might be added to forthcoming releases
15501 \begin_layout Plain Layout
15502 You are invited to send suggestions to
15503 \begin_inset Flex URL
15506 \begin_layout Plain Layout
15508 lyx-devel@lists.lyx.org
15518 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15520 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15522 commands (\SpecialChar TeX
15527 \begin_layout Plain Layout
15532 \begin_layout Plain Layout
15542 \begin_inset space ~
15546 \begin_inset CommandInset ref
15548 reference "sec:Inserting-TeX-Code"
15558 In this section, we can only list those features that are natively supported
15559 by \SpecialChar LyX
15561 For detailed descriptions (and for the rest of features) we recommend you
15562 have a look at the detailed manual of the Memoir class
15566 \begin_layout Plain Layout
15571 \begin_layout Plain Layout
15581 \begin_inset Flex URL
15584 \begin_layout Plain Layout
15586 CTAN:/macros/latex/memoir/memman.pdf
15596 , which is not only a user guide for the class, but also both a comprehensive
15597 description on good typesetting and a superb example for good typesetting
15601 \begin_layout Subsection
15602 Basic features and restrictions
15605 \begin_layout Standard
15606 Memoir supports basically all features of the standard book classes.
15607 There are, however, some differences, as follows:
15610 \begin_layout Description
15612 \begin_inset space ~
15615 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15618 \begin_layout Description
15620 \begin_inset space ~
15623 style: The fancy page style is not supported, due to a command clash between
15624 Memoir and the fancyhdr package (they both define a command with the same
15625 name, which confuses \SpecialChar LaTeX
15627 Instead, Memoir comes with a number of its own page styles (see
15629 Layout\SpecialChar menuseparator
15630 Document\SpecialChar menuseparator
15632 \begin_inset space ~
15638 If you want to use these for the chapter pages, you have to use the command
15645 in the main text or in preamble (e.
15646 \begin_inset space \thinspace{}
15650 \begin_inset space \space{}
15657 chapterstyle{companion}
15662 \begin_layout Description
15663 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15664 optional argument in the standard classes.
15665 With this, you can specify an alternative version of the title for the
15666 table of contents and the headers (for instance, if the title is too long).
15667 In \SpecialChar LyX
15668 , you can do this via
15670 Insert\SpecialChar menuseparator
15672 \begin_inset space ~
15677 at the beginning of a chapter/section.
15678 Memoir features a second optional argument and thus separates the table
15679 of contents from the header.
15680 You can define three variants of a title with this: one for the main text,
15681 one for the table of contents, and one for the headers.
15682 Simply insert two optional arguments if you need this feature, the first
15683 one containing the short title for the Table of Contents, the second one
15684 containing an alternative short title for the headers.
15687 \begin_layout Description
15688 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15689 of contents, the list of figures and the list of table start a new page
15691 Memoir does not follow this route.
15692 You have to insert a page break yourself, if you want to have one.
15695 \begin_layout Description
15696 Titlepage: For some unknown reason, Memoir uses pagination on the title
15697 page (in the standard classes, title pages are
15698 \begin_inset Quotes eld
15702 \begin_inset Quotes erd
15706 If you want an empty title page, type
15710 aliaspagestyle{title}{empty}
15715 \begin_layout Description
15716 Article: With the class option
15722 Layout\SpecialChar menuseparator
15723 Document\SpecialChar menuseparator
15725 \begin_inset space ~
15730 ), you can emulate article style.
15731 That is, counters (footnotes, figures, tables etc.) will not be reset on
15732 new chapters, chapters don't start a new page (but are—in contrary to
15733 \begin_inset Quotes eld
15737 \begin_inset Quotes erd
15740 article classes—still allowed), parts, though, use their own page, as in
15744 \begin_layout Description
15745 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15746 font commands, which have been used in the old \SpecialChar LaTeX
15748 \begin_inset space \thinspace{}
15752 \begin_inset space \space{}
15768 It produces an error and stops \SpecialChar LaTeX
15769 whenever such a command appears.
15774 reallows the commands and spits out warnings instead (which does at least
15775 not stop \SpecialChar LaTeX
15777 Since a lot of packages and particularly Bib\SpecialChar TeX
15778 style files are still using
15779 those commands, we have decided to use this option by default.
15782 \begin_layout Subsection
15786 \begin_layout Standard
15787 We will only describe the features supported by \SpecialChar LyX
15788 (which is not much currently).
15789 Please consult the Memoir manual
15793 \begin_layout Plain Layout
15798 \begin_layout Plain Layout
15808 \begin_inset Flex URL
15811 \begin_layout Plain Layout
15813 CTAN:/macros/latex/memoir/memman.pdf
15826 \begin_layout Description
15827 Abstract: You may wonder why an abstract is an extra feature.
15828 Well, it is in book class.
15829 Usually books don't have abstracts.
15830 Memoir, however, has.
15831 You can use it wherever and how often you like.
15834 \begin_layout Description
15835 Chapterprecis: You may know this older typesetting style: The contents of
15836 a chapter are summarized below the title and also in the table of contents
15838 \begin_inset space \thinspace{}
15842 \begin_inset space \space{}
15847 Our hero arrives in Troia; he loses some friends; he finds others
15850 Chapterprecis does exactly this.
15851 It is therefore only sensible below a chapter.
15854 \begin_layout Description
15855 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15856 The epigraph environment provides an elegant way of typesetting such a
15858 The motto itself (text) and its author (source) are divided by a short
15860 Unfortunately, we have to fool \SpecialChar LyX
15861 a bit here again, since the environment
15862 needs two arguments (text and source).
15863 In this case, we have to use curly brackets (in \SpecialChar TeX
15864 mode) between the two
15875 <author of the slogan>.
15878 \begin_layout Description
15879 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15880 complex figurative poems).
15882 can only support a few of them.
15883 One is poemtitle, which is a centered title for poems, which will also
15884 be added to the table of contents (verse is the standard environment for
15886 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
15888 because they have to be nested inside regular verse environments, which
15889 is not possible with \SpecialChar LyX
15893 \begin_layout Description
15894 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15897 \begin_layout Section
15898 Article (mwart), book (mwbk) and report (mwrep)
15899 \begin_inset Argument status
15902 \begin_layout Plain Layout
15915 \begin_layout Standard
15921 \begin_layout Standard
15922 The \SpecialChar LyX
15939 correspond to the \SpecialChar LaTeX
15953 They are replacements for the standard document classes
15965 , resp., and fit better to Polish typography conventions in a number of points.
15969 \begin_layout Standard
15973 \begin_layout Itemize
15974 Unnumbered titles (with star, e.
15975 \begin_inset space \thinspace{}
15979 \begin_inset space \space{}
15986 ) are added into table of contents,
15989 \begin_layout Itemize
15990 Additional page styles:
15991 \begin_inset Separator parbreak
15998 \begin_layout Description
15999 uheadings header with separated lines,
16002 \begin_layout Description
16003 myheadings custom header, contents headers via commands:
16018 \begin_layout Description
16019 myuheadings custom header with separated lines,
16022 \begin_layout Description
16023 outer page number is placed on outer side of page
16027 \begin_layout Itemize
16029 \begin_inset Separator parbreak
16036 \begin_layout Description
16037 rmheadings serif titles — default,
16040 \begin_layout Description
16041 sfheadings sansserif titles,
16044 \begin_layout Description
16045 authortitle on title page first placed is author next title — default,
16048 \begin_layout Description
16049 titleauthor on title page first placed is title next author,
16052 \begin_layout Description
16053 withmarginpar reserve place on page for margins.
16057 \begin_layout Section
16061 \begin_layout Standard
16066 provides an alternative to the standard
16071 It provides similar functionality, but you might prefer this layout with
16072 sans serif sections, headings, and more.
16075 \begin_layout Section
16076 Rev\SpecialChar TeX
16080 \begin_layout Standard
16086 \begin_layout Standard
16087 \begin_inset VSpace bigskip
16093 \begin_layout Standard
16098 \begin_inset space ~
16103 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16105 \begin_inset Formula $\beta$
16108 release of May, 1999) class.
16111 \begin_layout Standard
16117 textclass, which works with Rev\SpecialChar TeX
16119 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16121 That means that it doesn't interact very well with \SpecialChar LyX
16122 , which requires \SpecialChar LaTeX2e
16124 it has been kludged to work.
16125 Since Rev\SpecialChar TeX
16126 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16131 Rev\SpecialChar TeX
16133 \begin_inset space ~
16138 textclass should also be pretty easy to use.
16141 \begin_layout Standard
16142 These documents are supposed to be used in
16146 to the Rev\SpecialChar TeX
16147 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16149 and assume you'll know what to put in the preamble if necessary.
16152 \begin_layout Subsection
16156 \begin_layout Standard
16157 All you need to do is install Rev\SpecialChar TeX
16158 4, as described in the package's README
16160 The package can be found at The Rev\SpecialChar TeX
16162 \begin_inset Flex URL
16165 \begin_layout Plain Layout
16167 http://publish.aps.org/revtex4/
16173 Install it somewhere that \SpecialChar LaTeX
16175 Test it by trying to \SpecialChar LaTeX
16176 a short Rev\SpecialChar TeX
16177 4 document in some random directory (i.
16178 \begin_inset space \thinspace{}
16182 \begin_inset space \space{}
16185 not the directory where you installed the class file.) Then, if you reconfigure
16187 , it will find the class file and let you use the Rev\SpecialChar TeX
16191 \begin_layout Standard
16192 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16201 \begin_inset space ~
16206 template, found in the templates directory.
16209 \begin_layout Subsection
16213 \begin_layout Standard
16214 Optional arguments to
16221 \begin_inset Quotes eld
16225 \begin_inset Quotes erd
16229 \begin_inset Quotes eld
16233 \begin_inset Quotes erd
16243 \begin_inset space ~
16251 \begin_inset space ~
16257 Remember that in Rev\SpecialChar TeX
16258 , at least one optional argument is required!
16261 \begin_layout Standard
16262 Other preamble matter, like
16269 \begin_inset space ~
16276 \begin_inset space ~
16281 dialog, also as usual.
16284 \begin_layout Subsection
16288 \begin_layout Standard
16289 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16291 For example, the Email layout corresponds to
16298 Note that (at least as of Rev\SpecialChar TeX
16307 layouts are exactly equivalent, so you shouldn't need to use both.
16311 \begin_layout Plain Layout
16312 In case you're curious, both were included so that
16316 would be able to translate both
16336 \begin_layout Subsection
16340 \begin_layout Standard
16341 There are a couple of important unique aspects of Rev\SpecialChar TeX
16342 4 which might cause
16343 bugs that will be even more confusing in \SpecialChar LyX
16347 \begin_layout Standard
16348 In Rev\SpecialChar TeX
16366 The \SpecialChar LyX
16367 equivalent is that there is a separate Thanks layout.
16372 write footnotes in the
16376 layout, or weird things may happen.
16377 See the Rev\SpecialChar TeX
16378 4 documentation for more details.
16381 \begin_layout Standard
16385 \begin_inset space ~
16393 \begin_inset space ~
16402 layouts must be placed
16410 layout and the corresponding
16427 , the \SpecialChar LaTeX
16431 \begin_layout Subsection
16435 \begin_layout Standard
16436 The main problem with this layout is that you can't use the optional arguments
16437 to layouts like Email and Title.
16438 (The problem is not unique to this layout; you can't use optional arguments
16439 to the Section layouts either.) This means that after you export that file
16440 to \SpecialChar LaTeX
16441 (which you'll need to do eventually to send it in to APS), you'll need
16442 to edit the \SpecialChar LaTeX
16443 file with a text editor to add the optional arguments to set,
16445 \begin_inset space \thinspace{}
16449 \begin_inset space \space{}
16452 the running title for the page headers.
16453 Lacking these layouts makes the
16459 (and the equivalent
16465 ) useless, so the corresponding layouts don't exist, and will have to be
16470 \begin_layout Plain Layout
16475 actually, \SpecialChar LyX
16476 1.3.0 supports some forms of optional arguments, but this layout
16477 has not been updated yet to take advantage of it.
16485 \begin_layout Section
16486 Springer Journals (
16493 \begin_layout Standard
16499 \begin_layout Subsection
16503 \begin_layout Standard
16504 These are the layout files for some of the journal formats used by Springer
16505 Verlag and listed on
16506 \begin_inset Flex URL
16509 \begin_layout Plain Layout
16511 http://www.springer.de/author/tex/help-journals.html
16516 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16518 It is a modular system: the things common to all journals are implemented
16523 , which journal-specific layout files (such as, e.
16524 \begin_inset space \thinspace{}
16528 \begin_inset space \space{}
16535 for Journal of Geodesy) can include.
16538 \begin_layout Standard
16539 This means that implementing support for any other Springer journal on this
16540 list is as simple as writing your own
16548 file following the outline given in
16556 \begin_layout Standard
16557 It is reasonably well tested only for the Journal of Geodesy.
16566 come with the standard \SpecialChar LyX
16568 Install the relevant class file (downloaded from Springer) in a proper
16569 directory, reconfigure \SpecialChar LaTeX
16570 (in the te\SpecialChar TeX
16575 , as root if necessary — doesn't \SpecialChar LyX
16576 take care of this?), reconfigure \SpecialChar LyX
16581 \begin_layout Subsection
16585 \begin_layout Standard
16586 A large number of theorem-like styles —
16598 \begin_layout Standard
16601 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16602 _Title, Author_Running, Institute,
16603 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16606 See the Springer class file documentation for details.
16609 \begin_layout Subsection
16613 \begin_layout Itemize
16625 \begin_layout Itemize
16628 Probability Theory and Related Fields
16634 — Jean-Marc Lasgouttes
16637 \begin_layout Standard
16638 Add your own, it isn't so hard!
16641 \begin_layout Subsection
16645 \begin_layout Standard
16646 These files are partly based on the older
16650 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16652 file from Springer.
16657 layout, are now defunct.
16658 Jean-Marc Lasgouttes helped out big in making me find my way around the
16660 layout file mechanism.
16663 \begin_layout Subsection
16667 \begin_layout Standard
16669 But probably less than in the old hacked-\SpecialChar LaTeX
16677 \begin_layout Standard
16679 \begin_inset space \thinspace{}
16682 g.: does not display the number for theorem-like layouts, just #.
16685 \begin_layout Section
16688 Sli\SpecialChar TeX
16692 \begin_inset CommandInset label
16701 \begin_layout Standard
16709 \begin_layout Subsection
16713 \begin_layout Standard
16714 This section describes how to use \SpecialChar LyX
16715 to make slides for overhead projectors.
16716 There are two document classes that can do this: the default slides class
16719 Foil\SpecialChar TeX
16723 This section documents the former.
16726 \begin_layout Standard
16727 I'm going to say this again, nice and clear, so that there's no misunderstanding
16731 \begin_layout Standard
16732 \begin_inset VSpace bigskip
16738 \begin_layout Standard
16742 This section documents the class
16743 \begin_inset Quotes eld
16751 \begin_inset Quotes erd
16759 \begin_layout Standard
16760 \begin_inset VSpace bigskip
16766 \begin_layout Standard
16767 If you're looking for the documentation for
16768 \begin_inset Quotes eld
16773 slides (Foil\SpecialChar TeX
16777 \begin_inset Quotes erd
16780 , check out section
16781 \begin_inset space ~
16785 \begin_inset CommandInset ref
16787 reference "sec:foiltex"
16797 \begin_inset Quotes eld
16802 slides (Foil\SpecialChar TeX
16806 \begin_inset Quotes erd
16809 ] is actually somewhat better than the default
16817 \begin_layout Plain Layout
16819 or so I've been told repeatedly by its advocates.
16820 Having never used it, I have no idea if this claim is true or not.
16825 which this section documents.
16828 \begin_layout Standard
16829 This class is the \SpecialChar LaTeX2e
16830 improvement of the old
16832 Sli\SpecialChar TeX
16836 Every \SpecialChar LaTeX2e
16837 distribution includes this class [which I'll just refer to as
16838 \begin_inset Quotes eld
16846 \begin_inset Quotes erd
16849 from now on], so you're bound to have it.
16850 As I noted earlier, there are other classes, such as
16854 , which also produce slides for overhead projectors and do a better job
16856 However, there are some things which
16860 can do which the others can't, such as generate overlays.
16861 Read on to learn more!
16864 \begin_layout Subsection
16866 \begin_inset CommandInset label
16868 name "sec:slidesetup"
16875 \begin_layout Standard
16876 Obviously, to use this document class, you need to select
16877 \begin_inset Quotes eld
16885 \begin_inset Quotes erd
16888 from the class list in the
16890 Document\SpecialChar menuseparator
16894 There are some other special things you should know about this class:
16897 \begin_layout Itemize
16898 Don't bother changing the options
16903 They're not supported by the
16910 \begin_layout Itemize
16914 \begin_inset space ~
16919 behaves a bit differently for this class.
16920 The possible choices and what they do are as follows:
16921 \begin_inset Separator parbreak
16928 \begin_layout Description
16933 The final output contains page numbers in the lower right corner.
16936 \begin_layout Description
16945 , but also prints out any time markers you've put in.
16946 This is the default.
16949 \begin_layout Description
16954 The final output contains no page numbers, time markers, or alignment markers.
16958 \begin_layout Itemize
16963 class has an extra option:
16969 \begin_inset Quotes eld
16977 \begin_inset Quotes erd
16980 in the extra class options.
16981 \begin_inset Separator parbreak
16988 \begin_layout Standard
16989 Using this options allows you to add time markers to
16995 \begin_inset space ~
16999 \begin_inset CommandInset ref
17001 reference "sec:slideNote"
17009 \begin_layout Standard
17010 You can also use the template file
17011 \begin_inset Quotes eld
17019 \begin_inset Quotes erd
17022 to automatically set up a document to use the
17028 File\SpecialChar menuseparator
17030 \begin_inset space ~
17034 \begin_inset space ~
17039 to open your new document].
17040 The template file also contains some examples of the special paragraph
17041 environments used by this class.
17042 I'll describe those next.
17045 \begin_layout Subsection
17046 Paragraph Environments
17049 \begin_layout Subsubsection
17050 Supported Environments
17053 \begin_layout Standard
17054 The first thing you'll notice when you start up a new
17058 document is the font size and type: it's the equivalent of the size
17059 \begin_inset Quotes eld
17067 \begin_inset Quotes erd
17073 \begin_inset space ~
17079 This is also what's used in the output.
17081 \begin_inset Quotes eld
17085 \begin_inset Quotes erd
17088 to remind you that this is a slide.
17089 Your final slides will use a larger font; ergo, you'll have less space.
17090 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17093 \begin_layout Standard
17094 The next thing that becomes obvious is the changes to the paragraph environment
17095 pull-down box [at the far-left end of the toolbar].
17096 Most of the paragraph environments you're used to seeing are missing.
17097 There are also five new ones.
17102 class itself only supports certain paragraph environments:
17105 \begin_layout Itemize
17111 \begin_layout Itemize
17117 \begin_layout Itemize
17123 \begin_layout Itemize
17129 \begin_layout Itemize
17135 \begin_layout Itemize
17141 \begin_layout Itemize
17147 \begin_layout Itemize
17153 \begin_layout Itemize
17159 \begin_layout Itemize
17166 \begin_layout Itemize
17172 \begin_layout Standard
17173 All of the other standard environments, including the section-heading environmen
17174 ts, aren't used in the
17181 \begin_layout Standard
17182 On the other hand, you'll notice the following new environments:
17185 \begin_layout Itemize
17191 \begin_layout Itemize
17197 \begin_layout Itemize
17203 \begin_layout Itemize
17209 \begin_layout Itemize
17215 \begin_layout Standard
17216 These five are kind of quirky, due to a
17217 \begin_inset Quotes eld
17221 \begin_inset Quotes erd
17224 in \SpecialChar LyX
17226 You see, \SpecialChar LyX
17227 doesn't permit you to nest any other paragraph environment into
17228 an empty environment.
17229 Now, that's fine and dandy, but it means that you wouldn't be able to start
17230 a slide with anything except plain text.
17231 To deal with this, I've performed a little
17232 \begin_inset Quotes eld
17237 \begin_inset Quotes erd
17243 \begin_layout Subsubsection
17244 Quirks of the New Environments
17245 \begin_inset CommandInset label
17247 name "sec:slideQuirk"
17254 \begin_layout Standard
17255 All five of the new paragraph environments are somewhat quirky due to inherent
17256 limitiations in the current version of \SpecialChar LyX
17258 As I just mentioned, \SpecialChar LyX
17259 forbids environments that begin with another environment.
17260 To get around this, the
17264 environment isn't a paragraph environment as described in the
17272 \begin_layout Standard
17273 You should consider
17286 \begin_inset Quotes eld
17289 pseudo-environments.
17290 \begin_inset Quotes erd
17293 They look like a section heading or a
17294 \begin_inset Quotes eld
17302 \begin_inset Quotes erd
17305 but really begin a [and, if necessary, end the previous] paragraph environment.
17315 \begin_inset Quotes eld
17319 \begin_inset Quotes erd
17322 These two perform some action.
17325 \begin_layout Standard
17326 A common feature of all five environments,
17346 , is a rather long-ish label.
17347 The text following this label — ordinarily the contents of the paragraph
17348 environment — is utterly irrelevant for
17370 completely ignores it.
17371 In fact, you can leave these five environments completely empty.
17375 \begin_layout Standard
17380 to put any text after the rather long-ish label, you might want to.
17381 This could be a short description of the contents of the
17386 In that case, enter your descriptive comment and hit
17390 as you normally would.
17393 \begin_layout Standard
17394 If, on the other hand, you don't want to enter any descriptive text, you'll
17395 hit another \SpecialChar LyX
17398 , like nature, abhors a vacuum, and will not let you start a new paragraph
17399 environment until you put something in the old one.
17403 \begin_layout Itemize
17404 Start entering the text that will
17432 \begin_layout Itemize
17433 Now move to the beginning of that paragraph.
17437 \begin_layout Itemize
17446 \begin_layout Itemize
17447 Finally, change this new, empty paragraph to a
17471 \begin_layout Standard
17472 Some future version of \SpecialChar LyX
17473 will, hopefully, resolve this quirkiness\SpecialChar ldots
17477 \begin_layout Subsection
17478 Making a Presentation with
17491 \begin_layout Subsubsection
17499 \begin_layout Standard
17500 If you're expecting this section to teach you how to actually make a presentatio
17501 n, you'll be sorely disappointed.
17502 Naturally, I'll describe all of the ways the
17506 class can assist you in preparing the materials for a presentation.
17507 Filling in the contents, however, is up to you.
17512 the \SpecialChar LyX
17516 \begin_layout Standard
17521 environment [in the manner described in section
17522 \begin_inset space ~
17526 \begin_inset CommandInset ref
17528 reference "sec:slideQuirk"
17532 ] tells \SpecialChar LyX
17533 to begin a new slide [duh].
17534 The label for this environment/
17535 \begin_inset Quotes erd
17539 \begin_inset Quotes erd
17543 \begin_inset Quotes eld
17547 \begin_inset Quotes erd
17550 in cool blue, followed by the label,
17551 \begin_inset Quotes eld
17555 \begin_inset Quotes erd
17559 Any text or paragraph environments that follow this one go on the new slide.
17563 \begin_layout Standard
17564 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17566 (this can be specified in the
17571 In fact, you'll want to, once you finish entering the contents of one slide.
17572 If you've entered more text than can physically fit on a slide, the extra
17573 overflows onto a new slide.
17574 I don't recommend doing this, however, since the overflow slide won't have
17575 any page number on it.
17576 Furthermore, it may interfere with any
17580 you've made to accompany the oversized
17587 \begin_layout Standard
17596 environments work the same way as the
17601 They both create an
17602 \begin_inset Quotes eld
17606 \begin_inset Quotes erd
17609 followed by a label [
17610 \begin_inset Quotes eld
17614 \begin_inset Quotes erd
17618 \begin_inset Quotes eld
17622 \begin_inset Quotes erd
17626 The color is a stunning magenta instead of blue, and the
17627 \begin_inset Quotes eld
17631 \begin_inset Quotes erd
17634 will look different, in style and in length.
17635 The label fonts of all three also differ from one another.
17638 \begin_layout Standard
17643 , if the contents of a
17651 exceed the physical size of a slide or sheet of paper, the extra will overflow
17653 Again, you should avoid this.
17654 It defeats the whole purpose of
17665 \begin_layout Subsubsection
17675 \begin_layout Standard
17680 is a slide that sits atop another slide.
17681 Perhaps you wish to discuss a figure on the main
17685 before displaying the text associated with it.
17686 One way to accomplish this is tape a flap of dark paper over the part of
17691 you want to display later.
17692 This method fails, however, if you wish to overlap one graph with another,
17694 You would then have to fumble while speaking to align the two separate,
17699 s to align the two graphs.
17704 environment in both cases makes life much easier.
17707 \begin_layout Standard
17712 receives the page number of its
17713 \begin_inset Quotes eld
17717 \begin_inset Quotes erd
17725 \begin_inset Quotes eld
17733 \begin_inset Quotes erd
17740 \begin_layout Plain Layout
17741 Presumably, mutliple
17746 \begin_inset Quotes eld
17754 \begin_inset Quotes erd
17758 \begin_inset Quotes eld
17766 \begin_inset Quotes erd
17770 \begin_inset Quotes eld
17778 \begin_inset Quotes erd
17782 \begin_inset space ~
17785 appended to the page number of the parent
17795 Clearly, you want the contents of both the
17803 to each fit on a single physical slide! You should probably consider an
17809 \begin_inset Quotes eld
17813 \begin_inset Quotes erd
17821 Indeed, the \SpecialChar LyX
17826 class provides a visual cue for this: the label at the start of an
17830 is shorter than that at the start of a
17835 Lastly, when you generate printable output, you'll find alignment markers
17836 in all four corners of both the
17840 page and its parent
17845 These will assist you in lining up the two physical slides.
17848 \begin_layout Standard
17849 The major problem in overlaying two slides is aligning the contents of the
17850 two transparencies.
17851 How much space should you leave for that graph on the second slide? Worse
17852 still, what if you want a graph and a sentence on second slide, but there
17853 is text on the main transparency that goes in between them? You could try
17854 and insert vertical space of the right size.
17855 The better way is to use
17866 \begin_layout Standard
17867 As their names imply,
17875 are two command-like paragraph environments that make all subsequent text
17876 invisible and visible, respectively.
17878 \begin_inset space ~
17882 \begin_inset CommandInset ref
17884 reference "sec:slideQuirk"
17888 that you don't place anything
17892 these two environments, however.
17897 , it inserts a centered, sky-blue label into the page reading
17898 \begin_inset Quotes eld
17901 <Invisible Text Follows>
17902 \begin_inset Quotes erd
17906 For paragraphs following this label, the parts of the
17914 ; it doesn't matter which] where they would be contain instead blank space.
17918 \begin_layout Standard
17923 , the corresponding centered label is
17924 \begin_inset Quotes eld
17927 <Visible Text Follows>
17928 \begin_inset Quotes erd
17932 Paragraphs following this label behave normally.
17933 Note that the beginning of a new
17945 automatically shuts off an
17950 It's therefore not necessary to use
17961 \begin_layout Standard
17962 By now, it should be obvious how to create overlay transparencies using
17963 the proper combination of
17982 \begin_layout Enumerate
17987 , including everything that will appear on it, whether on the main slide
17995 \begin_layout Enumerate
17996 Before each figure or paragraph that will appear only on the
18005 If necessary, insert a
18009 environment after the
18016 \begin_layout Enumerate
18021 immediately following the
18028 \begin_layout Enumerate
18029 Copy the contents of this
18040 \begin_layout Enumerate
18045 , change all of the
18056 \begin_layout Standard
18058 You've just made an
18065 \begin_layout Standard
18066 There's one problem with the way I've designed the \SpecialChar LyX
18071 class: you can't make text in the middle of a paragraph invisible, nor
18072 make text in the middle of an invisible paragraph visible again.
18073 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18078 \begin_layout Plain Layout
18079 The commands of interest are:
18082 \begin_layout Itemize
18087 invisible \SpecialChar ldots
18091 \begin_layout Itemize
18096 visible \SpecialChar ldots
18100 \begin_layout Plain Layout
18102 and need to be marked as \SpecialChar TeX
18105 \begin_inset Quotes eld
18109 \begin_inset Quotes erd
18112 you wish to change goes in between the brackets [and after the
18125 If you don't know how to mark text as \SpecialChar TeX
18126 , see the appropriate section of
18139 \begin_layout Subsubsection
18149 \begin_inset CommandInset label
18151 name "sec:slideNote"
18158 \begin_layout Standard
18167 is associated with a
18168 \begin_inset Quotes eld
18172 \begin_inset Quotes erd
18180 Here, too, the \SpecialChar LyX
18185 class provides visual cues.
18190 is shorter than that of a
18194 [yet longer than that of an
18198 ] and, like the label of an
18202 is shockingly magenta.
18203 Additionally, the printed
18207 has the page number of its
18208 \begin_inset Quotes eld
18212 \begin_inset Quotes erd
18220 \begin_inset Quotes eld
18228 \begin_inset Quotes erd
18232 \begin_inset Quotes eld
18240 \begin_inset Quotes erd
18244 \begin_inset Quotes eld
18252 \begin_inset Quotes erd
18256 You can have multiple
18260 s associated with a single
18272 , you'll probably want to break up long
18276 s so that they fit on a single sheet of paper.
18279 \begin_layout Standard
18284 is obvious: it contains anything additional you might want to say about
18290 It could also be used as a sheet of reminders for a particular
18295 In the case of the latter, you might want to make use of time markers.
18296 Currently, the \SpecialChar LyX
18302 \begin_inset Quotes eld
18306 \begin_inset Quotes erd
18309 support for time markers, a
18311 Sli\SpecialChar TeX
18315 So, you'll have to resort to using the \SpecialChar LaTeX
18319 \begin_layout Standard
18320 To use time markers, you'll need to specify the extra class option
18321 \begin_inset Quotes eld
18329 \begin_inset Quotes erd
18333 \begin_inset space ~
18337 \begin_inset CommandInset ref
18339 reference "sec:slidesetup"
18344 This option turns on timing marks, which will appear in the lower-left-hand
18350 To set what appears in the time marker, you use the \SpecialChar LaTeX
18352 \begin_inset Quotes eld
18362 \begin_inset Quotes erd
18366 \begin_inset Quotes eld
18376 \begin_inset Quotes erd
18380 The arguments of both commands are time measured in seconds.
18382 \begin_inset Quotes eld
18392 \begin_inset Quotes erd
18395 sets the time marker to a given time.
18397 \begin_inset Quotes eld
18407 \begin_inset Quotes erd
18410 increments the time marker by the specified amount.
18411 Using time markers and
18415 s in this fashion, you can remind yourself how much time to spend on a particula
18423 \begin_layout Standard
18424 There's one last feature to describe.
18425 Clearly, you'd like to print out all of your
18433 s on transparencies while printing all of your
18450 with which it is associated.
18451 What's a person to do?
18454 \begin_layout Standard
18455 Luckily, there are two \SpecialChar LaTeX
18456 commands that allow you to select what to print
18458 Both must be placed into the preamble of your document.
18460 \begin_inset Quotes eld
18472 \begin_inset Quotes erd
18475 will cause the output to contain only the
18484 Correspondingly, the command
18485 \begin_inset Quotes eld
18497 \begin_inset Quotes erd
18500 prevents the output of anything but
18505 I'd advise placing both commands in the preamble and initially comment
18507 You can then preview your entire presentation as you write.
18508 When you're done writing, you can then uncomment one of the two to select
18509 what you want to print.
18510 I like to uncomment
18511 \begin_inset Quotes eld
18523 \begin_inset Quotes erd
18526 , print to a file with
18527 \begin_inset Quotes eld
18535 \begin_inset Quotes erd
18538 in its name, comment it back out, then uncomment
18539 \begin_inset Quotes eld
18551 \begin_inset Quotes erd
18555 \begin_inset Quotes eld
18563 \begin_inset Quotes erd
18567 I can then send either file to a printer, loading transparencies or plain
18568 paper as appropriate.
18571 \begin_layout Standard
18572 You can also provide other arguments to the
18573 \begin_inset Quotes eld
18583 \begin_inset Quotes erd
18587 \begin_inset Quotes eld
18597 \begin_inset Quotes erd
18601 See a good \SpecialChar LaTeX
18605 \begin_layout Subsection
18610 Class Template File
18613 \begin_layout Standard
18614 I have also provided a template file,
18615 \begin_inset Quotes eld
18623 \begin_inset Quotes erd
18631 To use it, begin your new presentation with
18636 ile\SpecialChar menuseparator
18638 \begin_inset space ~
18642 \begin_inset space ~
18652 Your new \SpecialChar LyX
18653 presentation file will contain an example
18674 additionally contain an example of the use of
18683 Lastly, the preamble will contain:
18686 \begin_layout LyX-Code
18687 % Uncomment to print out only slides and overlays
18690 \begin_layout LyX-Code
18694 \begin_layout LyX-Code
18700 \begin_inset Newline newline
18706 \begin_layout LyX-Code
18707 % Uncomment to print out only notes
18710 \begin_layout LyX-Code
18714 \begin_layout LyX-Code
18722 \begin_layout Standard
18723 One final thing: I created this class to support the \SpecialChar LaTeX2e
18725 \begin_inset Quotes eld
18730 Sli\SpecialChar TeX
18734 \begin_inset Quotes erd
18737 class, one of the built-in \SpecialChar LaTeX2e
18739 Neither I nor the rest of the \SpecialChar LyX
18740 Team endorse or oppose the use of this built-in
18742 It's here if you want it or need it.
18743 There exist other \SpecialChar LaTeX2e
18744 classes for creating presentations, such as the
18749 \begin_inset space ~
18753 \begin_inset CommandInset ref
18755 reference "sec:foiltex"
18760 \begin_inset Quotes eld
18768 \begin_inset Quotes erd
18771 package [present on some \SpecialChar TeX
18773 The latter is not yet supported under \SpecialChar LyX
18778 \begin_layout Plain Layout
18779 Perhaps you can take on the task\SpecialChar ldots
18785 I know nothing about these other classes.
18786 Try them out to see what sort of alternative they provide.
18789 \begin_layout Chapter
18791 Features needing Extra Software
18794 \begin_layout Section
18795 Checking \SpecialChar TeX
18799 \begin_layout Standard
18805 \begin_layout Subsection
18809 \begin_layout Standard
18818 \begin_layout Plain Layout
18823 is not yet available when you are using the \SpecialChar LaTeX
18824 distribution MiK\SpecialChar TeX
18830 , you'll find in the
18837 \begin_inset space ~
18841 \change_deleted -712698321 1437633476
18844 \change_inserted -712698321 1437633477
18855 \begin_inset Newline newline
18859 \begin_inset CommandInset href
18861 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18868 \begin_layout Standard
18871 Chk\SpecialChar TeX
18874 package is a program that was written by
18875 \begin_inset Flex Noun
18878 \begin_layout Plain Layout
18880 \begin_inset space ~
18888 in frustration because some constructs in \SpecialChar LaTeX
18889 are sometimes non-intuitive,
18890 and easy to forget.
18891 The program runs over your \SpecialChar LaTeX
18892 file, checks the integrity of the file, and
18893 flags some common errors.
18894 In other technical words, it is
18898 for \SpecialChar LaTeX
18902 \begin_layout Standard
18903 Well, what is a syntax checker doing in \SpecialChar LyX
18904 which is supposed to produce correct
18906 anyways? The answer is simple: Just as
18910 not only checks the
18914 of C programs, but also does
18918 checks for type-errors,
18920 Chk\SpecialChar TeX
18923 catches some common
18927 errors, in addition to the syntactical ones.
18930 Chk\SpecialChar TeX
18933 is capable of detecting several common errors, such as
18936 \begin_layout Itemize
18937 Ellipsis detection:
18938 \begin_inset Newline newline
18941 Use \SpecialChar ldots
18945 \begin_layout Itemize
18946 No space in front of/after parenthesis:
18947 \begin_inset Newline newline
18953 \begin_layout Itemize
18954 Enforcement of normal space after common abbreviations:
18955 \begin_inset Newline newline
18959 \begin_inset space \thinspace{}
18963 \begin_inset space \space{}
18966 is too wide spacing.
18969 \begin_layout Itemize
18970 Enforcement of end-of-sentence space when the last sentence ends with a
18972 \begin_inset Newline newline
18976 And this is wrong spacing.
18979 \begin_layout Itemize
18980 Space in front of labels and similar commands:
18981 \begin_inset Newline newline
18984 The label should stick right up to the text to avoid falling to a wrong
18987 \begin_inset CommandInset label
18997 \begin_layout Plain Layout
18998 This footnote is in danger of falling off to a wrong page
19003 The label is separated too much.
19006 \begin_layout Itemize
19007 Space in front of references, instead of hard spaces:
19008 \begin_inset Newline newline
19011 If you have bad luck, the text will break right between the referenced text
19012 and reference number, and that's a pity.
19014 \begin_inset CommandInset ref
19016 reference "sec:chktex"
19023 \begin_layout Itemize
19025 \begin_inset Quotes eld
19029 \begin_inset Quotes erd
19033 \begin_inset Formula $\times$
19037 \begin_inset Newline newline
19040 2x2 looks cheap compared to
19041 \begin_inset Formula $2\times2$
19047 \begin_layout Standard
19048 and more \SpecialChar ldots
19049 It is an invaluable tool when you are
19050 \begin_inset Quotes eld
19054 \begin_inset Quotes erd
19057 your document before printing, and you should run it right after the obligatory
19058 spelling check, and before you go fine tuning the typesetting.
19061 \begin_layout Subsection
19065 \begin_layout Standard
19066 If you have the program installed, usage is as simple as choosing
19068 Tools\SpecialChar menuseparator
19070 \begin_inset space ~
19074 \change_deleted -712698321 1437633488
19077 \change_inserted -712698321 1437633488
19083 This will make \SpecialChar LyX
19084 generate a \SpecialChar LaTeX
19085 file of your document, start
19087 Chk\SpecialChar TeX
19090 to check it, and then make \SpecialChar LyX
19092 \begin_inset Quotes eld
19096 \begin_inset Quotes erd
19099 with the warnings from
19101 Chk\SpecialChar TeX
19104 , if there were any.
19105 The warnings will be placed close to the point of the mistake, and you
19106 can quickly find them by using the
19108 Navigate\SpecialChar menuseparator
19111 menu item, or the shortcut key
19120 Open the error boxes by clicking on them with the mouse, or use the shortcut
19129 bindings, or the corresponding
19138 Read the warning and correct the mistake, if it is a mistake.
19139 If you have trouble understanding what the warning is about, you can safely
19141 Remember that there is a hidden layer between the document on screen and
19142 the technical details in invoking
19144 Chk\SpecialChar TeX
19147 , and this gap can make some warnings seem arcane or just plain silly.
19150 \begin_layout Standard
19151 This document is an excellent testing bed for the feature, and it should
19152 provide quite a few warnings for you to fiddle with.
19153 Since computers are only so smart, expect most of the warnings to be false
19157 \begin_layout Subsection
19158 How to fine tune it
19161 \begin_layout Standard
19162 Sometimes, you'll find that
19164 Chk\SpecialChar TeX
19167 makes more noise than suits your mood.
19168 Then you can choose not to use it, wait until your mood changes, or try
19171 Chk\SpecialChar TeX
19174 to get better along with you.
19177 \begin_layout Standard
19180 Chk\SpecialChar TeX
19187 very configurable and extensible, you should not expect to solve all problems
19190 Chk\SpecialChar TeX
19193 in \SpecialChar LyX
19195 Since \SpecialChar LyX
19196 has to generate a somewhat special \SpecialChar LaTeX
19197 file to be able to match the
19198 line numbers from the
19200 Chk\SpecialChar TeX
19207 \begin_layout Plain Layout
19208 You can inspect the specific output from
19214 Document\SpecialChar menuseparator
19217 \begin_inset space ~
19231 to the internal document structure, some of the warnings will not appear
19233 There are two things you can do about this:
19236 \begin_layout Itemize
19239 Chk\SpecialChar TeX
19242 invocation command line in
19243 \begin_inset Flex MenuItem
19246 \begin_layout Plain Layout
19247 Tools\SpecialChar menuseparator
19248 Preferences\SpecialChar menuseparator
19249 Output\SpecialChar menuseparator
19251 \change_deleted -712698321 1437633504
19254 \change_inserted -712698321 1437633507
19257 \SpecialChar menuseparator
19259 \change_deleted -712698321 1437633509
19262 \change_inserted -712698321 1437633511
19272 Chk\SpecialChar TeX
19275 installation configuration file (usually with the file
19280 See below to learn what warnings can be enabled and disabled on the command
19284 \begin_layout Itemize
19285 Export your document as a raw \SpecialChar LaTeX
19288 File\SpecialChar menuseparator
19289 Export\SpecialChar menuseparator
19298 Invoked in this way, it can be a hassle to find the corresponding place
19299 in the document inside \SpecialChar LyX
19300 , but with a little patience, you should be able
19304 \begin_layout Standard
19305 Here follows the warning messages that can be enabled and disabled in
19314 to disable a warning, and
19318 to enable a warning.
19319 The emphasized entries are disabled by default, because the default is
19322 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19327 \begin_layout Standard
19328 Notice that you should only use the options that enable and disable warnings,
19329 because \SpecialChar LyX
19330 relies on some of the other command line parameters to be set
19331 in a specific way to have a chance to communicate with
19338 \begin_layout Enumerate
19342 Command terminated with space.
19345 \begin_layout Enumerate
19348 Non-breaking space (
19349 \begin_inset Quotes eld
19357 \begin_inset Quotes erd
19360 ) should have been used.
19363 \begin_layout Enumerate
19367 You should enclose the previous parenthesis with
19368 \begin_inset Quotes eld
19376 \begin_inset Quotes erd
19382 \begin_layout Enumerate
19385 Italic correction (
19386 \begin_inset Quotes eld
19396 \begin_inset Quotes erd
19399 ) found in non-italic buffer.
19402 \begin_layout Enumerate
19405 Italic correction (
19406 \begin_inset Quotes eld
19416 \begin_inset Quotes erd
19419 ) found more than once.
19422 \begin_layout Enumerate
19426 No italic correction (
19427 \begin_inset Quotes eld
19437 \begin_inset Quotes erd
19443 \begin_layout Enumerate
19447 \begin_inset Quotes eld
19455 \begin_inset Quotes erd
19459 \begin_inset Quotes eld
19467 \begin_inset Quotes erd
19473 \begin_layout Enumerate
19476 Wrong length of dash may have been used.
19479 \begin_layout Enumerate
19483 \begin_inset Quotes eld
19491 \begin_inset Quotes erd
19495 \begin_inset Quotes eld
19503 \begin_inset Quotes erd
19509 \begin_layout Enumerate
19513 \begin_inset Quotes eld
19521 \begin_inset Quotes erd
19527 \begin_layout Enumerate
19531 \begin_inset Quotes eld
19539 \begin_inset Quotes erd
19542 to achieve an ellipsis.
19545 \begin_layout Enumerate
19548 Inter-word spacing (
19549 \begin_inset Quotes eld
19559 \begin_inset Quotes eld
19562 ) should perhaps be used.
19565 \begin_layout Enumerate
19568 Inter-sentence spacing (
19569 \begin_inset Quotes eld
19579 \begin_inset Quotes erd
19582 ) should perhaps be used.
19585 \begin_layout Enumerate
19588 Could not find argument for command.
19591 \begin_layout Enumerate
19595 \begin_inset Quotes eld
19603 \begin_inset Quotes erd
19609 \begin_layout Enumerate
19612 Math mode still on at end of \SpecialChar LaTeX
19616 \begin_layout Enumerate
19620 \begin_inset Quotes eld
19628 \begin_inset Quotes erd
19631 doesn't match the number of
19632 \begin_inset Quotes eld
19640 \begin_inset Quotes erd
19646 \begin_layout Enumerate
19649 You should use either
19652 \begin_inset Quotes eld
19660 \begin_inset Quotes erd
19665 as an alternative to
19666 \begin_inset Quotes eld
19674 \begin_inset Quotes erd
19680 \begin_layout Enumerate
19687 " (ASCII 39) instead of "
19694 \begin_layout Enumerate
19697 User-specified pattern found.
19700 \begin_layout Enumerate
19703 This command might not be intended.
19706 \begin_layout Enumerate
19713 \begin_layout Enumerate
19731 \begin_layout Enumerate
19734 Delete this space to maintain correct page references.
19737 \begin_layout Enumerate
19741 You might wish to put this between a pair of
19742 \begin_inset Quotes eld
19750 \begin_inset Quotes erd
19756 \begin_layout Enumerate
19759 You ought to remove spaces in front of punctuation.
19762 \begin_layout Enumerate
19765 Could not execute \SpecialChar LaTeX
19769 \begin_layout Enumerate
19778 in front of small punctuation.
19781 \begin_layout Enumerate
19789 may look prettier here.
19792 \begin_layout Enumerate
19796 Multiple spaces detected in output.
19799 \begin_layout Enumerate
19802 This text may be ignored.
19805 \begin_layout Enumerate
19811 \begin_inset Quotes eld
19816 to begin quotation, not
19823 \begin_layout Enumerate
19830 to end quotation, not
19833 \begin_inset Quotes eld
19841 \begin_layout Enumerate
19847 \begin_layout Enumerate
19850 You should perhaps use
19851 \begin_inset Quotes eld
19859 \begin_inset Quotes erd
19865 \begin_layout Enumerate
19868 You should put a space in front of/after parenthesis.
19871 \begin_layout Enumerate
19874 You should avoid spaces in front of/after parenthesis.
19877 \begin_layout Enumerate
19881 You should not use punctuation in front of/after quotes.
19884 \begin_layout Enumerate
19887 Double space found.
19890 \begin_layout Enumerate
19893 You should put punctuation outside inner/inside display math mode.
19896 \begin_layout Enumerate
19899 You ought to not use primitive \SpecialChar TeX
19900 in \SpecialChar LaTeX
19904 \begin_layout Enumerate
19907 You should remove spaces in front of
19908 \begin_inset Quotes eld
19916 \begin_inset Quotes erd
19922 \begin_layout Enumerate
19925 \begin_inset Quotes eld
19933 \begin_inset Quotes erd
19936 is normally not followed by
19937 \begin_inset Quotes eld
19945 \begin_inset Quotes erd
19951 \begin_layout Standard
19952 In later versions of \SpecialChar LyX
19953 , we hope to provide a more complete interface to this
19954 tool (and it's smaller cousin
19958 ) to exploit the full power of it.
19959 But it's not exactly useless as it is now: go try it on one of your existing
19960 documents of a certain length and be surprised.
19963 \begin_layout Section
19964 Version Control in \SpecialChar LyX
19968 \begin_layout Standard
19971 Lars Gullik Bjønnes
19978 \begin_layout Subsection
19982 \begin_layout Standard
19984 supports some of the most basic RCS/CVS/SVN/GIT commands.
19985 If you need something a bit more sophisticated you will have to do that
19986 manually in a terminal.
19989 \begin_layout Standard
19990 Also note that CVS support is not as good as subversion support so we advise
19992 A good place to start learning Subversion is SVN Book
19996 \begin_layout Plain Layout
19997 \begin_inset CommandInset href
19999 target "http://svnbook.red-bean.com/"
20009 In the case of RCS you should read
20010 \begin_inset Quotes eld
20014 \begin_inset Quotes erd
20017 (a man file, read it with
20022 This file describes all the basic features of RCS.
20023 You should especially notice the comment about a RCS directory, and the
20024 notion of a master RCS file (the file ending in
20031 \begin_layout Standard
20032 Before you begin to use the version control features in \SpecialChar LyX
20034 familiar with RCS/CVS/SVN/GIT usage.
20035 The implementation in \SpecialChar LyX
20036 assumes a recent version of the GNU RCS or CVS/SVN
20037 package — no guarantees are made for older versions.
20038 Most of the log messages are not currently displayed after operations —
20039 you can check them in the Messages pane if unsure.
20040 Regular users of version control will appreciate VC toolbar, which can
20043 View\SpecialChar menuseparator
20044 Toolbars\SpecialChar menuseparator
20046 \begin_inset space ~
20054 \begin_layout Standard
20055 For introducing your own external commands consult vc-command in the manual
20056 of \SpecialChar LyX
20058 \change_inserted -195340706 1447278952
20062 \begin_layout Standard
20064 \change_inserted -195340706 1447279250
20065 It is strongly recommended to store documents in uncompressed format if
20066 using version control (uncheck
20068 Document\SpecialChar menuseparator
20071 if it is checked): Uncompressed LyX documents are text files and therefore
20072 for merging two different versions by version control systems.
20073 Compressed LyX documents are binary files, which cannot be merged by version
20079 \begin_layout Subsection
20080 RCS commands in \SpecialChar LyX
20084 \begin_layout Standard
20085 The following sections describe the RCS commands supported by \SpecialChar LyX
20087 You can find them in the
20089 File\SpecialChar menuseparator
20091 \begin_inset space ~
20098 was tested against RCS 5.7/5.8
20102 \begin_layout Plain Layout
20103 Note that old DOS / MS Windows builds (5.7) need to setup environment variables
20104 in order to work properly with \SpecialChar LyX
20106 In particular time zone (TZ) should be set and more importantly RCSINIT
20107 in order to change default archive location ("SET RCSINIT=-x,v/") — \SpecialChar LyX
20109 archive to be found in file.lyx,v within the original document directory.
20110 See also README shipped with Windows RCS binaries.
20118 \begin_layout Subsubsection
20124 \begin_layout Standard
20125 If your document is not under revision control, this is the only item shown
20127 And if it is under revision control, the
20131 item is not visible.
20135 \begin_layout Standard
20136 This command registers your document with RCS (unless you are under the
20137 directory managed by CVS)\SpecialChar endofsentence
20138 You are asked interactively to supply an initial
20139 description of the document.
20140 The document is now set in Read-Only mode and you have to
20143 \begin_inset space ~
20147 \begin_inset space ~
20151 \begin_inset space ~
20156 , before making any changes to it.
20157 A document under revision control has a
20158 \begin_inset Quotes eld
20161 [RCS:<version> <locker>]
20162 \begin_inset Quotes erd
20165 item tagged to the filename in the minibuffer.
20168 \begin_layout Standard
20169 RCS command that is run:
20171 ci -q -u -i -t-"<initial description>" <file-name>
20174 \begin_layout Standard
20179 to understand the switches.
20183 \begin_layout Subsubsection
20189 \begin_layout Standard
20190 When you are finished editing a file, you check in your changes.
20191 When you do this, you are asked for a description of the changes.
20192 This is stored in the history log.
20193 The version number is bumped, your changes are applied to the master RCS
20194 file, the document is unlocked and set to Read-Only mode.
20197 \begin_layout Standard
20200 ci -q -u -m"<description>" <file-name>
20203 \begin_layout Subsubsection
20209 \begin_layout Standard
20210 By doing this you lock the document so that only you can edit it.
20211 This will also make the document Read-Write only for you.
20212 You will usually continue editing for a while and when you are finished
20213 you check in your changes.
20214 The status line is changed to reflect that you have locked the file.
20217 \begin_layout Standard
20220 co -q -l <file-name>
20223 \begin_layout Subsubsection
20226 Revert To Repository Version
20229 \begin_layout Standard
20230 This will discard all changes made to the document since the last check
20232 You get a warning before changes are discarded.
20235 \begin_layout Standard
20238 co -f -u<version> <file-name>
20241 \begin_layout Subsubsection
20247 \begin_layout Standard
20248 This will create a copy of the current document.
20249 Since RCS does not support copy operations natively, the version history
20250 is not preserved, and the copy is added as a new file.
20251 It requires a clean document without any changes since the last checkin.
20252 You are asked for a file name and a description of the copy operation.
20253 After that the copy is created, both locally and in the repository.
20254 If the parent directories of the copied and original document differ, all
20255 relative paths of included files of the copy are adjusted (like in
20257 File\SpecialChar menuseparator
20262 Finally, the copy is loaded instead of the original document.
20265 \begin_layout Labeling
20266 \labelwidthstring 00.00.0000
20268 \begin_inset space ~
20272 \begin_inset space ~
20276 \begin_inset Newline newline
20280 \begin_inset Flex Code
20283 \begin_layout Plain Layout
20286 \begin_inset Quotes eld
20290 \begin_inset Quotes erd
20299 \begin_inset Flex Code
20302 \begin_layout Plain Layout
20305 \begin_inset Quotes eld
20309 \begin_inset Quotes erd
20318 \begin_inset Newline newline
20322 \begin_inset Flex Code
20325 \begin_layout Plain Layout
20329 \begin_inset Quotes eld
20333 \begin_inset Quotes erd
20344 \begin_layout Subsubsection
20350 \begin_layout Standard
20351 This makes as if the last check in never happened.
20352 No changes are made to the document loaded into \SpecialChar LyX
20353 , but the last version
20354 is removed from the master RCS file.
20357 \begin_layout Standard
20360 rcs -o<version> <file-name>
20363 \begin_layout Subsubsection
20369 \begin_layout Standard
20370 This shows the complete history of the RCS document.
20375 is shown in a browser.
20383 \begin_layout Subsubsection
20387 \begin_layout Standard
20389 supports RCS version number, author name, date and time of last commit.
20390 All those are extracted from
20392 rlog -r <file-name>
20396 \begin_inset CommandInset ref
20398 reference "subsec:VCS-Revision-Information"
20405 \begin_layout Subsection
20406 CVS commands in \SpecialChar LyX
20410 \begin_layout Standard
20411 A subset of CVS operations is supported by \SpecialChar LyX
20413 You can find the commands in the
20415 File\SpecialChar menuseparator
20417 \begin_inset space ~
20423 The version control system SVN is more powerful, so please use it instead
20424 of CVS if possible.
20427 \begin_layout Subsubsection
20433 \begin_layout Standard
20434 If you start from scratch with CVS you have to create your repository and
20435 checkout the working copy with external tools.
20436 If you're using a client-server setup you may need to login before doing
20437 the first repository checkout.
20440 \begin_layout Standard
20441 If your documents are under revision control and others are using the same
20442 repository problems arise when different changes to the same document at
20443 the same location happen.
20444 Standard CVS repositories don't operate with a file locking mechanism.
20445 This may be surprising, but conflicts only occur if people disagree on
20446 the proper content of the same part of a document.
20447 So, if co-workers are used to communicate regularly, these conflicts occur
20449 If they don't communicate they have a fundamental problem anyway.
20450 Nevertheless some people like to work with so called
20451 \begin_inset Quotes eld
20455 \begin_inset Quotes erd
20459 If they do so the working copy of all files is readonly when checked out
20460 first and the user starts editing after using a special command to make
20461 the working copy writable.
20462 When the changes are checked in the working copy returns to readonly state.
20463 With \SpecialChar LyX
20464 one has to edit the
20465 \begin_inset Flex Code
20468 \begin_layout Plain Layout
20474 file and add the line
20475 \begin_inset Flex Code
20478 \begin_layout Plain Layout
20484 to work with reserved checkouts.
20485 The benefit is the possibility to see who is using a writable copy of some
20487 It's not guaranteed only one user makes a copy writable.
20490 \begin_layout Standard
20492 tries to guess if you're using reserved or non-reserved checkouts.
20493 If your working copy is readonly or it is writable and an additional copy
20494 of your document exists in the CVS/Base sub-directory a reserved otherwise
20495 a non-reserved checkout is assumed.
20496 When a reserved checkout is detected you have to use
20497 \begin_inset Flex MenuItem
20500 \begin_layout Plain Layout
20506 to make your working copy writable if it's readonly.
20508 \begin_inset Flex MenuItem
20511 \begin_layout Plain Layout
20517 operation is possible and that makes your working copy readonly again after
20518 transferring your changes to the repository.
20521 \begin_layout Standard
20522 More information about CVS can be found here
20523 \begin_inset Flex URL
20526 \begin_layout Plain Layout
20528 http://www.nongnu.org/cvs
20534 \begin_inset Flex URL
20537 \begin_layout Plain Layout
20539 http://ximbiot.com/cvs
20547 \begin_layout Standard
20552 to understand the sub-commands and the switches mentioned below.
20555 \begin_layout Subsubsection
20561 \begin_layout Standard
20562 If your document is not under revision control, this is the only item shown
20564 And if it is under revision control, the
20571 item is not visible.
20575 \begin_layout Standard
20576 This command registers in CVS your document
20577 \begin_inset Flex Strong
20580 \begin_layout Plain Layout
20588 in the case you have already the documents directory under CVS control
20594 This means you have to create or checkout the archive by yourself using
20596 (In case you forget that step \SpecialChar LyX
20597 registers the document with RCS.)
20600 \begin_layout Standard
20601 Then you are asked interactively to supply an initial description of the
20603 Don't forget that registered file is not yet checked in.
20606 \begin_layout Standard
20607 CVS command that is run:
20609 cvs -q add -m"<entered message>" "<file-name>"
20612 \begin_layout Standard
20617 above and for all other CVS commands is an abbreviation for
20618 \begin_inset Quotes eld
20621 change the current working directory to file location and use the file name
20622 without path component as argument
20623 \begin_inset Quotes erd
20629 \begin_layout Subsubsection
20635 \begin_layout Standard
20636 When you are finished editing a file, you commit your changes.
20637 When you do this and you had changed the document, you are asked for a
20638 description of the changes.
20639 After that changes are written to the repository.
20640 In case you didn't change the document and a reserved checkout is detected
20641 the reservation made on
20642 \begin_inset Flex MenuItem
20645 \begin_layout Plain Layout
20654 \begin_layout Labeling
20655 \labelwidthstring 00.00.0000
20657 \begin_inset space ~
20661 \begin_inset space ~
20665 \begin_inset Newline newline
20669 \begin_inset Flex Code
20672 \begin_layout Plain Layout
20675 -q commit -m"<description>" "<file-name>"
20681 \begin_inset Newline newline
20685 \begin_inset Flex Code
20688 \begin_layout Plain Layout
20699 \begin_layout Subsubsection
20705 \begin_layout Standard
20706 When you are sharing a repository with others, you may have to incorporate
20707 their changes into your working copy.
20710 \begin_layout Standard
20713 cvs -q update "<file-name>"
20716 \begin_layout Standard
20717 If a readonly checkout is detected the working copy is made writable and
20721 \begin_layout Standard
20724 cvs -q edit "<file-name>"
20727 \begin_layout Subsubsection
20730 Revert To Repository Version
20733 \begin_layout Standard
20734 This will discard all changes made to the document since the last check
20736 You get a warning before changes are discarded.
20737 Firstly the file is deleted, secondly CVS update command is run.
20740 \begin_layout Standard
20743 cvs -q update "<file-name>"
20746 \begin_layout Standard
20747 If a reserved checkout is detected and the working copy has no changes only
20748 the reservation is undone.
20751 \begin_layout Standard
20754 cvs -q unedit "<file-name>"
20757 \begin_layout Subsubsection
20763 \begin_layout Standard
20764 This will create a copy of the current document.
20765 Since CVS does not support copy operations natively, the version history
20766 is not preserved, and the copy is added as a new file.
20767 It requires a clean document without any changes since the last checkin.
20768 You are asked for a file name and a description of the copy operation.
20769 After that the copy is created, both locally and in the repository.
20770 If the parent directories of the copied and original document differ, all
20771 relative paths of included files of the copy are adjusted (like in
20773 File\SpecialChar menuseparator
20778 Finally, the copy is loaded instead of the original document.
20781 \begin_layout Labeling
20782 \labelwidthstring 00.00.0000
20784 \begin_inset space ~
20788 \begin_inset space ~
20792 \begin_inset Newline newline
20796 \begin_inset Flex Code
20799 \begin_layout Plain Layout
20802 \begin_inset Quotes eld
20806 \begin_inset Quotes erd
20815 \begin_inset Flex Code
20818 \begin_layout Plain Layout
20821 \begin_inset Quotes eld
20825 \begin_inset Quotes erd
20834 \begin_inset Newline newline
20838 \begin_inset Flex Code
20841 \begin_layout Plain Layout
20845 \begin_inset Quotes eld
20849 \begin_inset Quotes erd
20860 \begin_layout Subsubsection
20866 \begin_layout Standard
20867 This will rename the current document.
20868 Since CVS does not support rename operations natively, the version history
20869 is not preserved, the renamed document is added as a new file, and the
20870 original document is deleted.
20871 It requires a clean document without any changes since the last checkin.
20872 You are asked for a file name and a description of the rename operation.
20873 After that the document is renamed, both locally and in the repository.
20874 If the parent directories of the new and old file names differ, all relative
20875 paths of included files are adjusted (like in
20877 File\SpecialChar menuseparator
20882 Finally, the document is reloaded using the new name.
20885 \begin_layout Labeling
20886 \labelwidthstring 00.00.0000
20888 \begin_inset space ~
20892 \begin_inset space ~
20896 \begin_inset Newline newline
20900 \begin_inset Flex Code
20903 \begin_layout Plain Layout
20906 \begin_inset Quotes eld
20910 \begin_inset Quotes erd
20919 \begin_inset Flex Code
20922 \begin_layout Plain Layout
20925 \begin_inset Quotes eld
20929 \begin_inset Quotes erd
20938 \begin_inset Newline newline
20942 \begin_inset Flex Code
20945 \begin_layout Plain Layout
20949 \begin_inset Quotes eld
20953 \begin_inset Quotes erd
20962 \begin_inset Newline newline
20966 \begin_inset Flex Code
20969 \begin_layout Plain Layout
20973 \begin_inset Quotes eld
20977 \begin_inset Quotes erd
20988 \begin_layout Subsubsection
20989 Update of the local directory checkout from repository
20992 \begin_layout Standard
20993 Once your documents gets more complex, containing sub-documents and pictures,
20995 \begin_inset Flex Code
20998 \begin_layout Plain Layout
21004 files and so on using version control becomes more complicated.
21006 supports updating the whole tree in which resides the document.
21007 This become especially useful once you cooperate with people which neither
21008 have detailed knowledge about CVS usage nor they have ambition to commit
21009 additional material to the repository.
21010 You have to organize the files structure so that all external files are
21011 in the same directory or subdirectories of the document.
21012 It's good practice anyway to store multipart documents in an extra directory.
21015 \begin_layout Standard
21017 \begin_inset Flex Code
21020 \begin_layout Plain Layout
21021 Update local directory from repository
21026 command updates the whole directory.
21027 If local changes are detected user is warned before update starts.
21028 In case of merge conflicts both versions of the conflicting document parts
21029 are placed in the final document.
21030 You have to review and correct the result of the merge.
21031 You'll find the conflicts enclosed in pairs of
21032 \begin_inset Flex Code
21035 \begin_layout Plain Layout
21042 \begin_inset Flex Code
21045 \begin_layout Plain Layout
21052 \begin_inset Flex Code
21055 \begin_layout Plain Layout
21062 The first part is your version as before the update operation with the
21063 document name prepended.
21064 The second one is the repository version with the version number after
21066 \begin_inset Flex Code
21069 \begin_layout Plain Layout
21078 \begin_layout Labeling
21079 \labelwidthstring 00.00.0000
21081 \begin_inset space ~
21085 \begin_inset space ~
21089 \begin_inset Newline newline
21093 \begin_inset Flex Code
21096 \begin_layout Plain Layout
21104 (Ask if changes are detected.)
21105 \begin_inset Newline newline
21109 \begin_inset Flex Code
21112 \begin_layout Plain Layout
21113 cd $path; cvs -q update
21123 \begin_layout Standard
21125 \begin_inset Flex Code
21128 \begin_layout Plain Layout
21134 stands for the path to the document.
21137 \begin_layout Subsubsection
21143 \begin_layout Standard
21144 This shows the complete history of the CVS document.
21147 cvs log "<file-name>"
21149 is shown in a browser.
21152 \begin_layout Subsubsection
21156 \begin_layout Standard
21158 supports CVS version number, author name, date and time of last commit.
21159 All those are extracted from
21161 cvs log -r <file-name>
21165 \begin_inset CommandInset ref
21167 reference "subsec:VCS-Revision-Information"
21174 \begin_layout Subsection
21175 SVN commands in \SpecialChar LyX
21179 \begin_layout Standard
21180 SVN is now partially supported by \SpecialChar LyX
21182 You can find the commands in the
21184 File\SpecialChar menuseparator
21186 \begin_inset space ~
21192 Please note that if you use password protected access to repository via
21193 ssh, you will be asked in terminal window.
21195 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21199 \begin_layout Plain Layout
21200 Most of the commands will work with 1.4 too, see
21201 \begin_inset CommandInset ref
21203 reference "subsec:SVN-Repo-Update"
21208 There seems to be currently unresolved permissions problem under SVN 1.8
21209 with reverting changes when file is locked.
21217 \begin_layout Subsubsection
21223 \begin_layout Standard
21224 If your document is not under revision control, this is the only item shown
21226 And if it is under revision control, the
21233 item is not visible.
21236 \begin_layout Standard
21237 This command registers in SVN your document ONLY in case you have already
21238 the documents directory under SVN control (in particular
21243 This means you have to checkout the archive by yourself.
21246 \begin_layout Standard
21247 Then you are asked interactively to supply an initial description of the
21249 Don't forget that registered file is not yet commited.
21252 \begin_layout Standard
21253 SVN command that is run:
21256 \begin_inset Quotes eld
21260 \begin_inset Quotes erd
21266 \begin_layout Standard
21271 to understand the switches.
21274 \begin_layout Subsubsection
21280 \begin_layout Standard
21281 When you are finished editing a file, you commit your changes.
21282 When you do this, you are asked for a description of the changes.
21283 After that changes are commited.
21286 \begin_layout Standard
21291 \begin_layout Plain Layout
21292 In case locking is not enabled.
21294 \begin_inset CommandInset ref
21296 reference "subsec:SVN-File-Locking"
21307 svn commit -q -m"<description>" <file-name>
21310 \begin_layout Subsubsection
21316 \begin_layout Standard
21317 Updates the changes of this file from the repository.
21318 Be sure you understand SVN merging and conflicts resolving before using
21319 this function, because all conflicts has to be resolved manually by you!
21322 \begin_layout Standard
21327 \begin_layout Plain Layout
21335 svn update --non-interactive
21336 \begin_inset Quotes eld
21340 \begin_inset Quotes erd
21346 \begin_layout Subsubsection
21349 Revert To Repository Version
21352 \begin_layout Standard
21353 This will discard all changes made to the document since the last check
21355 You get a warning before changes are discarded.
21358 \begin_layout Standard
21362 \begin_inset Quotes eld
21366 \begin_inset Quotes erd
21372 \begin_layout Subsubsection
21378 \begin_layout Standard
21379 This will create a copy of the current document including the version history.
21380 It requires a clean document without any changes since the last checkin.
21381 You are asked for a file name and a description of the copy operation.
21382 After that the copy is created, both locally and in the repository.
21383 If the parent directories of the copied and original document differ, all
21384 relative paths of included files of the copy are adjusted (like in
21386 File\SpecialChar menuseparator
21391 Finally, the copy is loaded instead of the original document.
21394 \begin_layout Labeling
21395 \labelwidthstring 00.00.0000
21397 \begin_inset space ~
21401 \begin_inset space ~
21405 \begin_inset Newline newline
21409 \begin_inset Flex Code
21412 \begin_layout Plain Layout
21416 \begin_inset Quotes eld
21420 \begin_inset Quotes erd
21424 \begin_inset Quotes eld
21428 \begin_inset Quotes erd
21437 \begin_inset Newline newline
21441 \begin_inset Flex Code
21444 \begin_layout Plain Layout
21453 \begin_layout Subsubsection
21459 \begin_layout Standard
21460 This will rename the current document including the version history.
21461 It requires a clean document without any changes since the last checkin.
21462 You are asked for a file name and a description of the rename operation.
21463 After that the document is renamed, both locally and in the repository.
21464 If the parent directories of the new and old file names differ, all relative
21465 paths of included files are adjusted (like in
21467 File\SpecialChar menuseparator
21472 Finally, the document is reloaded using the new name.
21475 \begin_layout Labeling
21476 \labelwidthstring 00.00.0000
21478 \begin_inset space ~
21482 \begin_inset space ~
21486 \begin_inset Newline newline
21490 \begin_inset Flex Code
21493 \begin_layout Plain Layout
21497 \begin_inset Quotes eld
21501 \begin_inset Quotes erd
21505 \begin_inset Quotes eld
21509 \begin_inset Quotes erd
21518 \begin_inset Newline newline
21522 \begin_inset Flex Code
21525 \begin_layout Plain Layout
21534 \begin_layout Subsubsection
21535 \begin_inset CommandInset label
21537 name "subsec:SVN-Repo-Update"
21541 Update of the local directory checkout from repository
21545 \begin_layout Plain Layout
21546 Note that this command will work only with subversion
21547 \begin_inset Formula $\geqq1.5$
21558 \begin_layout Standard
21559 All the commands above have one shortcomming - they deal with the current
21561 Once your document contains pictures, includes external
21562 \begin_inset Flex Code
21565 \begin_layout Plain Layout
21571 files and so on administration becomes more complicated.
21573 now supports updating the whole tree in which resides the document
21577 \begin_layout Plain Layout
21578 One need to organize the files structure so that all external files are
21579 in the same directory or subdirectories of the document.
21586 This become especially useful once you cooperate with people which neither
21587 know about subversion management nor they have ambition to commit additional
21588 material to the repository.
21592 \begin_layout Standard
21593 \begin_inset Flex Code
21596 \begin_layout Plain Layout
21597 Update local directory from repository
21602 command updates the whole directory and in case of merge conflicts local
21603 version of the files are left, so no unintended data loss occurs.
21604 If local changes are detected user is warned before update starts.
21607 \begin_layout Labeling
21608 \labelwidthstring 00.00.0000
21610 \begin_inset space ~
21614 \begin_inset space ~
21618 \begin_inset Newline newline
21622 \begin_inset Flex Code
21625 \begin_layout Plain Layout
21631 (Ask if changes are detected.)
21632 \begin_inset Newline newline
21636 \begin_inset Flex Code
21639 \begin_layout Plain Layout
21640 svn update –accept mine-full $path
21648 \begin_layout Standard
21650 \begin_inset Flex Code
21653 \begin_layout Plain Layout
21659 stands for the path to the document.
21662 \begin_layout Subsubsection
21668 \begin_layout Standard
21669 This shows the complete history of the SVN document.
21673 \begin_inset Quotes eld
21677 \begin_inset Quotes erd
21682 is shown in a browser.
21685 \begin_layout Subsubsection
21687 \begin_inset CommandInset label
21689 name "subsec:SVN-File-Locking"
21696 \begin_layout Standard
21697 The file exchange through various revision control systems brings the problem
21698 of merge conflicts in case two different users try to edit the same (parts
21700 When such a conflict happens it needs manual resolving and one reasonable
21701 alternative is to provide some kind of locking mechanism, which guarantees
21702 that only one user is allowed to edit file at the given time.
21705 \begin_layout Standard
21706 SVN has two such mechanisms to provide mutual exclusivity for file access
21707 - locks and automatic setting of write permissions (see sec.
21709 \begin_inset CommandInset ref
21711 reference "subsec:Automatical-Locking-Property"
21716 \begin_inset Flex Code
21719 \begin_layout Plain Layout
21729 \begin_layout Plain Layout
21730 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21736 If this property is detected for a given document \SpecialChar LyX
21737 starts to use SVN locks
21738 for document editing automatically and the whole check-in/out mechanism
21739 switches to the same regimen as for RCS.
21740 This in particular means there are two different modes of file use in \SpecialChar LyX
21744 \begin_layout Itemize
21746 The loaded file is in the read-only mode.
21747 For editing on needs to check-out.
21752 consists of updating from the repository and gaining write lock.
21753 If the lock is not possible to obtain, we remain in unlocked state.
21756 \begin_layout Itemize
21758 The loaded file is in the 'normal' edit mode.
21759 No other user is allowed to edit the file.
21764 consists of commiting changes and releasing write-lock.
21765 If no changes have been made to the document, no commit will be produced
21769 \begin_layout Plain Layout
21770 Don't be puzzled by the fact that you will be asked for commit message anyway.
21775 and only the write-lock will be released.
21778 \begin_layout Standard
21782 \begin_layout Labeling
21783 \labelwidthstring 00.00.0000
21786 svn commit -q -m"<description>" "<file-name>"
21787 \begin_inset Newline newline
21790 svn unlock "<file-name>"
21793 \begin_layout Labeling
21794 \labelwidthstring 00.00.0000
21797 svn update "<file-name>"
21798 \begin_inset Newline newline
21801 svn lock "<file-name>"
21804 \begin_layout Subsubsection
21807 \begin_inset CommandInset label
21809 name "subsec:Automatical-Locking-Property"
21815 Automatic Locking Property
21818 \begin_layout Standard
21819 The above mentioned automatic setting of write permissions of the .lyx file
21825 ile\SpecialChar menuseparator
21831 \begin_inset space ~
21834 Control\SpecialChar menuseparator
21839 oggle locking property
21842 This command is active only when the file is not locked on the svn server
21844 you need to check-out before proceeding).
21847 \begin_layout Labeling
21848 \labelwidthstring 00.00.0000
21850 \begin_inset space ~
21856 \begin_layout Labeling
21857 \labelwidthstring 00.00.0000
21860 svn propset svn:needs-lock ON "<file-name>"
21863 \begin_layout Labeling
21864 \labelwidthstring 00.00.0000
21867 svn propdel svn:needs-lock "<file-name>"
21870 \begin_layout Subsubsection
21871 \begin_inset CommandInset label
21873 name "subsec:VCS-Revision-Information"
21877 Revision Information in Documents
21880 \begin_layout Standard
21881 There are more possibilities how to activate revision information in our
21885 \begin_layout Itemize
21888 \begin_inset Separator parbreak
21895 \begin_layout Itemize
21896 tree revision information (
21897 \begin_inset Flex Code
21900 \begin_layout Plain Layout
21907 The result is the output of the
21908 \begin_inset Flex Code
21911 \begin_layout Plain Layout
21917 command, the following table gives you an idea, how to read the results.
21920 \begin_layout Standard
21922 \begin_inset Tabular
21923 <lyxtabular version="3" rows="6" columns="2">
21924 <features tabularvalignment="middle">
21925 <column alignment="center" valignment="top">
21926 <column alignment="center" valignment="top">
21928 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21931 \begin_layout Plain Layout
21937 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21940 \begin_layout Plain Layout
21948 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21951 \begin_layout Plain Layout
21957 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21960 \begin_layout Plain Layout
21961 mixed revision working copy
21968 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21971 \begin_layout Plain Layout
21977 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21980 \begin_layout Plain Layout
21981 modified working copy
21988 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21991 \begin_layout Plain Layout
21997 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22000 \begin_layout Plain Layout
22001 switched working copy
22008 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22011 \begin_layout Plain Layout
22017 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22020 \begin_layout Plain Layout
22021 partial working copy, from a sparse checkout
22028 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22031 \begin_layout Plain Layout
22037 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22040 \begin_layout Plain Layout
22041 mixed revision, modified, switched working copy
22054 \begin_layout Itemize
22055 file revision information.
22056 The result comes from parsing the output of
22057 \begin_inset Flex Code
22060 \begin_layout Plain Layout
22062 \begin_inset space ~
22066 \begin_inset space ~
22070 \begin_inset space ~
22079 Supported flags are:
22080 \begin_inset Separator parbreak
22087 \begin_layout Itemize
22088 version number of the last commit (
22089 \begin_inset Flex Code
22092 \begin_layout Plain Layout
22101 \begin_layout Itemize
22102 author of the last commit (
22103 \begin_inset Flex Code
22106 \begin_layout Plain Layout
22115 \begin_layout Itemize
22116 date of the last commit (
22117 \begin_inset Flex Code
22120 \begin_layout Plain Layout
22129 \begin_layout Itemize
22130 time of the last commit (
22131 \begin_inset Flex Code
22134 \begin_layout Plain Layout
22144 \begin_layout Standard
22145 You can obtain this info via InsetInfo (e.g.
22147 \begin_inset Flex Code
22150 \begin_layout Plain Layout
22151 info-insert buffer vcs-date
22157 The information will be available only when you have the file stored under
22158 svn managment (i.e.
22160 \begin_inset Flex Code
22163 \begin_layout Plain Layout
22169 directory is available with your document).
22173 \begin_layout Itemize
22174 Another—a hacking one—possibility is to use svn keywords
22178 \begin_layout Plain Layout
22179 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22185 In short – you set file keywords property (e.g.
22188 svn propset svn:keywords 'Rev' file.lyx
22190 ) and then paste keyword \SpecialChar TeX
22195 \begin_layout Plain Layout
22196 This is an easy way how to ensure that \SpecialChar LyX
22197 won't break the line in the middle
22203 tag in your document (e.g.
22208 \begin_layout Plain Layout
22216 This way svn client will automatically substitute revision number (e.g.
22221 \begin_layout Plain Layout
22228 ) after each update and commit.
22229 There are more problems with this approach.
22230 Firstly, the '$' character is used in \SpecialChar TeX
22231 world for math equations, so any
22232 occurence of math formula
22233 \begin_inset Formula $Rev$
22237 \begin_inset Formula $Rev:59$
22240 in your \SpecialChar LyX
22242 Similarly for other keywords like Id, Date, Author, etc.
22243 Secondly svn output is dependent on your locales, so its very easy that
22244 svn would produce some problematic strings once Date is used.
22245 Thirdly you get the whole 'Rev: 59' string in your document instead of
22247 Until subversion implements user's custom keywords it will be hard to use
22248 this approach reliably or let \SpecialChar LyX
22249 to support it directly.
22252 \begin_layout Subsection
22253 SVN and Windows Environment
22256 \begin_layout Quote
22257 My inclination is to say that if the user cannot figure out the command
22258 line operations on their own fairly quickly, they would be well advised
22259 to use TortoiseSVN.
22265 \begin_layout Subsubsection
22269 \begin_layout Standard
22270 In addition to installing \SpecialChar LyX
22271 , and having access to a Subversion repository,
22272 the user will need to install the Subversion client program.
22273 A Windows installer for the client program is available from
22274 \begin_inset CommandInset href
22277 target "http://www.collab.net/nonav/downloads/subversion/"
22282 The user may also want to install
22283 \begin_inset CommandInset href
22286 target "http://tortoisesvn.tigris.org/"
22290 , which integrates Subversion operations into the context (rightclick) menu
22291 of Windows Explorer.
22292 Operations done outside \SpecialChar LyX
22293 will typically be more convenient using the Explorer
22295 Note that TortoiseSVN is not a replacement for the client program, which
22296 is what \SpecialChar LyX
22300 \begin_layout Subsubsection
22301 Bringing a document under Subversion control
22304 \begin_layout Standard
22305 Before a \SpecialChar LyX
22306 document can be brought under version control in Subversion, its
22307 parent directory needs to be under version control.
22308 If the document is being added to a project already in the repository,
22309 this is accomplished by checking the project out to the directory where
22310 the new document will be placed.
22311 If the project itself is not yet under version control (for instance, if
22312 this document starts a new project), the directory must be imported into
22314 This is done outside \SpecialChar LyX
22316 Both import and checkout are easily accomplished from the Explorer context
22317 menu using TortoiseSVN, or alternatively can be done using the command
22318 line client at a DOS prompt.
22319 The procedure for importing the project using TortoiseSVN is described
22320 below, assuming an existing repository and a new project being started
22328 For information on using the Subversion client program, run
22335 \begin_layout Enumerate
22342 in Windows Explorer, right click it, and select
22344 TortoiseSVN\SpecialChar menuseparator
22348 If necessary, adjust the URL for the repository, then click OK.
22351 \begin_layout Enumerate
22352 Right click the level of the repository under which you want to place the
22353 new project folder (typically the top level) and click
22357 Supply a name for the project folder and click OK.
22358 Add a message for the log file if desired, then click OK again.
22359 The new project folder should appear in the repository.
22360 Finally, click OK again to exit the repository browser.
22363 \begin_layout Enumerate
22364 Once again right click
22370 , this time selecting SVN Checkout\SpecialChar ldots
22371 Select the URL of the project folder
22372 you just created in the repository, and set the checkout directory to
22380 You will be warned about a non-empty folder; click OK to proceed.
22381 You should now have a
22392 \begin_layout Enumerate
22393 Create or open your document in \SpecialChar LyX
22396 File\SpecialChar menuseparator
22398 \begin_inset space ~
22401 Control\SpecialChar menuseparator
22405 Add a log message and click OK to commit the document to version control.
22408 \begin_layout Standard
22409 From this point onward, you should have full functionality in the
22411 File\SpecialChar menuseparator
22413 \begin_inset space ~
22419 You also have the option of checking the document in and out, viewing its
22421 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22422 client program from a command prompt.
22425 \begin_layout Subsubsection
22426 SSH tunnel used with SVN under Windows
22429 \begin_layout Standard
22430 Compared with Linux setting up an svn client to communicate over ssh under
22431 Windows is a rather troublesome task.
22432 We will at least offer some hints how to setup the client side but prior
22433 knowledge about ssh and the Windows command line is needed, also be prepared
22434 for a great deal of frustration\SpecialChar ldots
22438 \begin_layout Enumerate
22439 Get an svn client for windows, as described in the previous sections.
22440 When it is a fresh install run some svn command (e.g.
22442 \begin_inset Flex Code
22445 \begin_layout Plain Layout
22451 ) to create config files, which you will need to change later on.
22454 \begin_layout Enumerate
22455 Choose an ssh client for Windows.
22456 There are several possibilities, we will use the one from Putty tools
22460 \begin_layout Plain Layout
22461 \begin_inset Flex URL
22464 \begin_layout Plain Layout
22466 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22477 You will need to set the connection up so that the client doesn't ask for
22478 any password from you.
22479 To keep things easy we will use only keys without any additional password
22481 \begin_inset Separator parbreak
22488 \begin_layout Enumerate
22490 \begin_inset Flex Code
22493 \begin_layout Plain Layout
22500 Save your private .ppk key file and put the public one on the server side.
22501 If the SVN server runs on Linux, note that the format of the public key
22502 is not compatible with Linux openssh and you will need to direcly copy-paste
22505 Public key for pasting into OpenSSH authorized_keys file
22507 :” edit field into the server's
22508 \begin_inset Flex Code
22511 \begin_layout Plain Layout
22512 ~/.ssh/authorized_keys
22518 \begin_inset Flex Code
22521 \begin_layout Plain Layout
22530 \begin_layout Enumerate
22532 \begin_inset Flex Code
22535 \begin_layout Plain Layout
22542 In the SVN config file
22546 \begin_layout Plain Layout
22547 Exact path depends on Windows version, usually somewhere around
22548 \begin_inset Flex Code
22551 \begin_layout Plain Layout
22554 Documents and Settings
22568 \begin_inset Flex Code
22571 \begin_layout Plain Layout
22586 , section [tunnels], setup ssh command, e.g.
22588 \begin_inset Flex Code
22591 \begin_layout Plain Layout
22592 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22601 \begin_layout Plain Layout
22602 It will usually take a lot of time to get exact command right and it depends
22604 For example do not have some remote server saved as a default session in
22606 If things fail, try to connect via plink without SVN first.
22615 \begin_layout Enumerate
22616 Checkout the SVN archive, e.
22617 \begin_inset space \thinspace{}
22621 \begin_inset Newline newline
22625 \begin_inset Flex Code
22628 \begin_layout Plain Layout
22629 svn co svn+ssh://user@server/repository_path
22637 \begin_layout Subsubsection
22638 End-of-Line Conversions
22641 \begin_layout Standard
22642 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22644 use different line endings inside the .lyx files.
22645 This is not a problem as far as \SpecialChar LyX
22646 functionality is concerned, but the commit
22647 diffs will be huge and merge-conflicts prone.
22648 Fortunately SVN itself knows
22652 \begin_layout Plain Layout
22653 \begin_inset Flex URL
22656 \begin_layout Plain Layout
22658 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22668 how to deal with CR/LF problems when switching .lyx files to the
22669 \begin_inset Flex Code
22672 \begin_layout Plain Layout
22682 \begin_layout Plain Layout
22684 \begin_inset Flex Code
22687 \begin_layout Plain Layout
22688 svn propset svn:eol-style native FILE_NAME
22701 \begin_layout Subsection
22702 GIT commands in \SpecialChar LyX
22706 \begin_layout Standard
22707 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22709 You can find the commands in the
22711 File\SpecialChar menuseparator
22713 \begin_inset space ~
22719 Please note that if you use password protected access to repository via
22720 ssh, you will be asked in terminal window.
22722 was tested against GIT 1.7.
22726 \begin_layout Plain Layout
22727 Windows users please note that you need to ensure that git is on the path.
22728 This can be set from within \SpecialChar LyX
22731 Tools\SpecialChar menuseparator
22732 Preferences\SpecialChar menuseparator
22733 Paths\SpecialChar menuseparator
22744 \begin_layout Standard
22745 One big difference of GIT and the other supported version control systems
22746 is the distributed nature of GIT: With traditional version control systems
22747 there is one central server which hosts the repository.
22748 Users commit their changes to the server, and get updates made by other
22750 With GIT, users commit to a local repository.
22751 The local repository can be synchronized with one or more remote repositories
22753 \begin_inset Flex Code
22756 \begin_layout Plain Layout
22763 \begin_inset Flex Code
22766 \begin_layout Plain Layout
22774 does not interact in any way with remote GIT repositories.
22775 It works exclusively with the local repository in a very similar way as
22776 with a central CVS or SVN repository.
22777 If you use remote GIT repositories you need to do the
22778 \begin_inset Flex Code
22781 \begin_layout Plain Layout
22788 \begin_inset Flex Code
22791 \begin_layout Plain Layout
22797 operations with your favourite GIT client.
22800 \begin_layout Subsubsection
22806 \begin_layout Standard
22807 If your document is not under revision control, this is the only item shown
22809 And if it is under revision control, the
22816 item is not visible.
22819 \begin_layout Standard
22820 This command registers in GIT your document ONLY in case you have already
22821 the documents directory under GIT control (in particular
22826 This means you have to checkout the archive by yourself.
22829 \begin_layout Standard
22830 Then you are asked interactively to supply an initial description of the
22832 Don't forget that registered file is not yet commited.
22835 \begin_layout Standard
22836 GIT command that is run:
22839 \begin_inset Quotes eld
22843 \begin_inset Quotes erd
22849 \begin_layout Standard
22854 to understand the switches.
22857 \begin_layout Subsubsection
22863 \begin_layout Standard
22864 When you are finished editing a file, you commit your changes.
22865 When you do this, you are asked for a description of the changes.
22866 After that changes are commited.
22869 \begin_layout Standard
22872 git commit -q -m"<description>" <file-name>
22875 \begin_layout Subsubsection
22878 Revert To Repository Version
22881 \begin_layout Standard
22882 This will discard all changes made to the document since the last check
22884 You get a warning before changes are discarded.
22887 \begin_layout Standard
22891 \begin_inset Quotes eld
22895 \begin_inset Quotes erd
22901 \begin_layout Subsubsection
22907 \begin_layout Standard
22908 This will rename the current document including the version history.
22909 It requires a clean document without any changes since the last checkin.
22910 You are asked for a file name and a description of the rename operation.
22911 After that the document is renamed, both locally and in the repository.
22912 If the parent directories of the new and old file names differ, all relative
22913 paths of included files are adjusted (like in
22915 File\SpecialChar menuseparator
22920 Finally, the document is reloaded using the new name.
22923 \begin_layout Labeling
22924 \labelwidthstring 00.00.0000
22926 \begin_inset space ~
22930 \begin_inset space ~
22934 \begin_inset Newline newline
22938 \begin_inset Flex Code
22941 \begin_layout Plain Layout
22945 \begin_inset Quotes eld
22949 \begin_inset Quotes erd
22953 \begin_inset Quotes eld
22957 \begin_inset Quotes erd
22966 \begin_inset Newline newline
22970 \begin_inset Flex Code
22973 \begin_layout Plain Layout
22982 \begin_layout Subsubsection
22988 \begin_layout Standard
22989 This shows the complete history of the GIT document.
22993 \begin_inset Quotes eld
22997 \begin_inset Quotes erd
23002 is shown in a browser.
23005 \begin_layout Subsubsection
23009 \begin_layout Standard
23011 supports GIT hash number of the last commit to the file, author name, date
23012 and time of last commit.
23013 All those are extracted from
23015 git log -n 1 --pretty=format:%H%n%an%n%ai
23018 Tree version information is obtained via
23020 git describe --abbrev --dirty --long
23024 \begin_inset CommandInset ref
23026 reference "subsec:VCS-Revision-Information"
23033 \begin_layout Subsection
23037 \begin_layout Standard
23038 With the recent addition of the vc-command function \SpecialChar LyX
23039 power users are allowed
23040 to create their own commands for revision control.
23043 \begin_layout Standard
23044 As an example you can see how two TortoiseSVN commands could be integrated
23048 \begin_layout Description
23050 \begin_inset Flex Code
23053 \begin_layout Plain Layout
23054 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23062 \begin_layout Description
23064 \begin_inset Flex Code
23067 \begin_layout Plain Layout
23068 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23076 \begin_layout Subsection
23077 Version control and Document comparison
23080 \begin_layout Standard
23081 One of the typical uses of version control is to inspect the changes between
23082 revisions, usually by creating
23083 \begin_inset Flex Code
23086 \begin_layout Plain Layout
23093 While this is useful for plain text files, it is much less useful in the
23094 case of \SpecialChar LyX
23095 files, which have more a complicated structure.
23096 Hence we provide binding to the Document comparison feature.
23097 There are two ways of calling this feature - either by direct call of
23098 \begin_inset Flex Code
23101 \begin_layout Plain Layout
23108 function (for details see \SpecialChar LyX
23109 functions manual) or by icon/menu item
23110 \begin_inset Flex MenuItem
23113 \begin_layout Plain Layout
23114 Compare with older revision...
23120 One can either compare two chosen revisions of the document or he can simply
23121 compare the current version of edited text with older revisions (where
23123 \begin_inset Flex MenuItem
23126 \begin_layout Plain Layout
23132 ' revisions back means comparison of the edited file with last commited
23137 \begin_layout Standard
23138 This feature is supported for SVN and RCS though due to the more complicated
23139 versioning scheme of RCS there is a constraint – when addressing the revisions
23140 in dialog, numbers always point to the last number in RCS revision number,
23143 We don't currently support GIT addressing of revisions, one can just compare
23144 edited document with its revision X steps backs, where X is addressed as
23148 \begin_layout Section
23149 Literate Programming
23152 \begin_layout Standard
23157 (kayvan@sylvan.com)
23161 original documentation written by
23163 Edmar Wienskoski Jr.
23166 (edmar-w-jr@technologist.com)
23169 \begin_layout Subsection
23173 \begin_layout Standard
23174 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23176 programming, where it is assumed that you are familiar with this programming
23177 technique, and know what
23178 \begin_inset Quotes eld
23182 \begin_inset Quotes erd
23186 \begin_inset Quotes eld
23190 \begin_inset Quotes erd
23194 If that is not the case, please follow the web links provided in the following
23196 There is a lot of good documentation out there covering old development
23197 history to the latest tools tips.
23200 \begin_layout Standard
23201 It is also assumed that you are familiar with \SpecialChar LyX
23202 itself to a point that you
23203 are comfortable changing your \SpecialChar LyX
23204 preferences, and X resources file.
23205 If that is not the case please refer to other \SpecialChar LyX
23206 documentation to cover your
23210 \begin_layout Subsection
23211 Literate Programming
23214 \begin_layout Standard
23215 From the Literate Programming FAQ:
23218 \begin_layout Quotation
23219 Literate programming is the combination of documentation and source together
23220 in a fashion suited for reading by human beings.
23221 In fact, literate programs should be enjoyable reading, even inviting!
23222 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23223 and documentation in a single file.
23224 Literate programming tools then parse the file to produce either readable
23225 documentation or compilable source.
23226 The WEB style of literate programming was created by D.
23227 \begin_inset space \thinspace{}
23231 Knuth during the development of his \SpecialChar TeX
23232 typesetting software.
23236 \begin_layout Standard
23237 Another excerpt says:
23240 \begin_layout Quotation
23243 How is literate programming different from verbose commenting?
23246 \begin_layout Quotation
23247 There are three distinguishing characteristics.
23248 In order of importance, they are:
23249 \begin_inset Separator parbreak
23256 \begin_layout Itemize
23257 flexible order of elaboration
23260 \begin_layout Itemize
23261 automatic support for browsing
23264 \begin_layout Itemize
23265 typeset documentation, especially diagrams and mathematics
23269 \begin_layout Standard
23270 Now that I sparked your curiosity, take a look in the references.
23273 \begin_layout Subsubsection
23277 \begin_layout Standard
23278 The complete Literate Programming FAQ can be found at:
23281 \begin_layout Quote
23282 Literate Programming FAQ
23283 \begin_inset Flex URL
23286 \begin_layout Plain Layout
23288 http://www.literateprogramming.com/lpfaq.pdf
23296 \begin_layout Standard
23297 The FAQ lists 23 (twenty three!) different literate programming tools.
23298 Where some are specialized or
23299 \begin_inset Quotes eld
23303 \begin_inset Quotes erd
23306 for particular programming languages, while other have general scope.
23311 for my own use for several reasons:
23314 \begin_layout Itemize
23315 It can generate the documentation either in \SpecialChar LaTeX
23319 \begin_layout Itemize
23320 It has a open architecture, i.
23321 \begin_inset space \thinspace{}
23325 \begin_inset space \space{}
23328 it is easy to plug in new filters and to perform special processing that
23333 \begin_layout Itemize
23334 There is a good selection of filters available already (the HTML is one
23338 \begin_layout Itemize
23342 \begin_layout Standard
23343 The Noweb web page can be found at:
23346 \begin_layout Quote
23348 \begin_inset Flex URL
23351 \begin_layout Plain Layout
23353 http://www.cs.virginia.edu/~nr/noweb/
23361 \begin_layout Standard
23362 Starting from there you can reach many other interesting links and even
23363 some literate program examples.
23366 \begin_layout Subsection
23368 and Literate Programming with Noweb
23371 \begin_layout Standard
23372 The \SpecialChar LyX
23373 support for Literate Programming is provided by using the generic \SpecialChar LyX
23375 converters mechanism.
23376 This support is provided in a
23377 \begin_inset Quotes eld
23381 \begin_inset Quotes erd
23385 \begin_inset space \thinspace{}
23389 \begin_inset space \space{}
23392 you will be able to use this new \SpecialChar LyX
23393 feature with some other literate programming
23394 tool of your choice by just changing your \SpecialChar LyX
23398 \begin_layout Subsubsection
23399 Generating documents and code (weaving and tangling)
23402 \begin_layout Paragraph
23403 Using the noweb module
23406 \begin_layout Standard
23407 If you have installed Noweb and \SpecialChar LyX
23408 successfully, whenever you open a new document,
23409 after you have chosen its document class, use the Document->Settings menu
23411 \begin_inset Quotes eld
23415 \begin_inset Quotes erd
23419 If Noweb is correctly installed, when you click on the
23420 \begin_inset Quotes eld
23424 \begin_inset Quotes erd
23427 link, you will see the
23428 \begin_inset Quotes eld
23432 \begin_inset Quotes erd
23435 module in the available list and you can add it to your document.
23438 \begin_layout Paragraph
23442 \begin_layout Standard
23444 enables you to write code with a layout named
23445 \begin_inset Flex Noun
23448 \begin_layout Plain Layout
23455 Noweb delimits chunks like this:
23458 \begin_layout LyX-Code
23462 \begin_layout LyX-Code
23466 \begin_layout LyX-Code
23470 \begin_layout LyX-Code
23474 \begin_layout LyX-Code
23478 \begin_layout Standard
23479 The problem is that whatever is written in between the << and the
23483 must be taken literally, i.
23484 \begin_inset space \thinspace{}
23488 \begin_inset space \space{}
23492 should be prevented from making any special interpretation of what has
23494 This is also handled by
23495 \begin_inset Flex Noun
23498 \begin_layout Plain Layout
23504 , that works like a normal paragraph but has a free spacing capability.
23507 \begin_layout Standard
23508 As a special note, you can also use the
23509 \begin_inset Quotes eld
23513 \begin_inset Quotes erd
23516 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23520 \begin_layout LyX-Code
23524 \begin_layout LyX-Code
23525 def some_function(args):
23528 \begin_layout LyX-Code
23529 "This is the doc string for this function."
23532 \begin_layout LyX-Code
23533 print "My args: ", args
23536 \begin_layout LyX-Code
23537 @ %def some_function
23540 \begin_layout Standard
23541 For an example of this usage and the resulting cross-reference output, look
23542 at the Literate python program in
23544 LIBDIR/examples/listerrors.lyx
23546 which should make this all clear.
23549 \begin_layout Paragraph
23550 Generating the documentation
23553 \begin_layout Standard
23554 At this point you already have a new document file with a proper document
23555 class, and with some code and text on it.
23556 How do I print it? The answer is simple, you select
23558 View\SpecialChar menuseparator
23562 Just like you would do for a plain document.
23563 No special procedure is required.
23566 \begin_layout Standard
23567 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23571 \begin_layout Enumerate
23574 Update\SpecialChar menuseparator
23577 menu option is chosen, a \SpecialChar LaTeX
23580 \begin_inset Separator parbreak
23587 \begin_layout Standard
23588 If the document is of any literate class the generated file will be named
23589 with an extension name defined by the
23590 \begin_inset Quotes eld
23594 \begin_inset Quotes erd
23597 format (defined in the Preferences panel), otherwise the file will have
23606 \begin_layout Enumerate
23607 Note that the only difference so far is in the name of the file, no special
23608 processing is required by \SpecialChar LyX
23610 Given that you formatted the code using the
23611 \begin_inset Flex Noun
23614 \begin_layout Plain Layout
23620 layout that, by itself, takes care of the business.
23623 \begin_layout Enumerate
23624 If the document is of any literate class \SpecialChar LyX
23625 will then use the internal \SpecialChar LyX
23627 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23632 \begin_layout Plain Layout
23633 The converters are defined in the
23635 Tools\SpecialChar menuseparator
23639 \begin_inset Quotes eld
23643 \begin_inset Quotes erd
23655 manual for general information about converters.
23660 to generate the \SpecialChar LaTeX
23662 \begin_inset Separator parbreak
23669 \begin_layout Standard
23670 Otherwise it will just skip this step.
23674 \begin_layout Enumerate
23675 Finally, \SpecialChar LaTeX
23676 is invoked and the regular post processing continues as in a plain
23680 \begin_layout Standard
23681 Independence from a particular
23682 \begin_inset Quotes eld
23686 \begin_inset Quotes erd
23689 is easily achieved by changing the commands that are run by the various
23693 \begin_layout Paragraph
23694 Generating the code
23697 \begin_layout Standard
23698 When the build menu option is chosen or the corresponding button in the
23699 toolbar is pressed, a \SpecialChar LaTeX
23700 file is generated just like step 1 above.
23701 Next, \SpecialChar LyX
23707 This converter needs to be defined by the user and is not installed by
23708 default, though the Program format is.
23709 This converter (like any other converter) will have two parts:
23712 \begin_layout Enumerate
23713 The converter program itself.
23714 This program performs the conversion from the one format to the other (in
23715 this case, from the Noweb format to the Program pseudo-format).
23718 \begin_layout Enumerate
23719 The error log parser.
23720 This is a program whose sole purpose is to rewrite error messages in a
23721 format that \SpecialChar LyX
23723 This makes it possible for \SpecialChar LyX
23724 to place error boxes in the right places in
23728 \begin_layout Standard
23729 The first part, the
23730 \begin_inset Quotes eld
23734 \begin_inset Quotes erd
23737 setting, should be set to
23738 \begin_inset Newline newline
23742 \begin_inset Quotes eld
23750 \begin_inset Quotes erd
23754 \begin_inset Newline newline
23757 This basically means that \SpecialChar LyX
23759 \begin_inset Quotes eld
23763 \begin_inset Quotes erd
23766 (a program or script) with the name of the Noweb file (normally a file
23767 in the \SpecialChar LyX
23768 temp directory) and the directory path of the original \SpecialChar LyX
23773 \begin_layout Standard
23774 This is an implementation of
23775 \begin_inset Quotes eld
23779 \begin_inset Quotes erd
23782 that you can place in a directory on your path:
23785 \begin_layout Standard
23786 \begin_inset VSpace defskip
23792 \begin_layout Standard
23793 \begin_inset Newpage pagebreak
23799 \begin_layout Standard
23805 \begin_layout Standard
23811 \begin_layout Standard
23814 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23817 \begin_layout Standard
23818 \begin_inset VSpace defskip
23824 \begin_layout Standard
23825 The next part of the converter setting is the
23826 \begin_inset Quotes eld
23830 \begin_inset Quotes erd
23833 which is to be set to
23834 \begin_inset Newline newline
23838 \begin_inset Quotes eld
23843 parselog=$$s/scripts/listerrors
23846 \begin_inset Quotes erd
23850 \begin_inset Newline newline
23853 This will run any errors that are generated by the
23854 \begin_inset Quotes eld
23858 \begin_inset Quotes erd
23861 process through the
23862 \begin_inset Quotes eld
23866 \begin_inset Quotes erd
23872 \begin_layout Standard
23873 The build will normally take place in \SpecialChar LyX
23874 's temporary directory, so the files
23875 produced by the conversion will be in that directory.
23877 will copy out what it regards as the `main' file, but the
23881 conversion may produce several files, and so most of these would then be
23882 deleted when \SpecialChar LyX
23884 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23885 the build-script chunk can place the generated files in that location.
23888 \begin_layout Paragraph
23889 Build instructions in the document
23892 \begin_layout Standard
23893 The last piece of the integration between \SpecialChar LyX
23895 \begin_inset Quotes eld
23899 \begin_inset Quotes erd
23903 Generally, the instructions for building your program should be embedded
23904 in a chunk of its own.
23906 \begin_inset Quotes eld
23910 \begin_inset Quotes erd
23913 above uses the notangle command to look for this chunk (called
23914 \begin_inset Quotes eld
23918 \begin_inset Quotes erd
23921 ) and runs its contents through
23922 \begin_inset Quotes eld
23926 \begin_inset Quotes erd
23932 \begin_layout Standard
23933 Typically, such a chunk would look something like this:
23936 \begin_layout LyX-Code
23940 \begin_layout LyX-Code
23942 \begin_inset Newline newline
23945 if [ -z "${NOWEB_SOURCE}" ]
23946 \begin_inset Newline newline
23952 \begin_layout LyX-Code
23953 NOWEB_SOURCE=myfile.nw
23954 \begin_inset Newline newline
23958 \begin_inset Newline newline
23962 code to extract files ...
23963 use NOWEB_OUTPUT_DIR here ...]
23964 \begin_inset Newline newline
23968 code to compile files ...]
23969 \begin_inset Newline newline
23975 \begin_layout Standard
23978 LIBDIR/examples/listerrors.lyx
23982 LIBDIR/examples/Literate.lyx
23984 which implement two versions of the
23985 \begin_inset Quotes eld
23989 \begin_inset Quotes erd
23992 program for some illustrations of how all of these pieces go together or
23995 LIBDIR/examples/noweb2lyx.lyx.
23998 Interestingly, these three files show off the language-indepence of the
24000 literate programming support since they are written in Python, C and Perl
24004 \begin_layout Subsubsection
24005 Configuring \SpecialChar LyX
24009 \begin_layout Standard
24010 All the Literate Programming support is configured by the
24012 Tools\SpecialChar menuseparator
24016 \begin_inset Quotes eld
24020 \begin_inset Quotes erd
24024 The important parts are:
24027 \begin_layout Description
24029 \begin_inset space ~
24033 \begin_inset Quotes eld
24037 \begin_inset Quotes erd
24041 \begin_inset space ~
24044 format Set up via the File Formats tab, this is where the Noweb-specific
24054 , the file extension is set to
24059 This tells \SpecialChar LyX
24060 to create a file with a
24064 extension in the first step of the conversion process.
24067 \begin_layout Description
24069 \begin_inset space ~
24077 \begin_inset space ~
24080 format This is an empty format whose sole purpose is to be the endpoint
24081 of a conversion (which then allows us to set up a converter for it).
24084 \begin_layout Description
24094 This converter performs the
24095 \begin_inset Quotes eld
24099 \begin_inset Quotes erd
24102 of the literate document.
24103 For Noweb, it is set to
24104 \begin_inset Quotes eld
24109 noweave -delay -index $$i > $$o
24112 \begin_inset Quotes erd
24118 \begin_layout Description
24128 \begin_inset Quotes eld
24132 \begin_inset Quotes erd
24136 As stated above, the Converter is set to
24137 \begin_inset Quotes eld
24145 \begin_inset Quotes erd
24148 , with Flags set to
24149 \begin_inset Newline newline
24153 \begin_inset Quotes eld
24158 parselog=$$s/scripts/listerrors
24161 \begin_inset Quotes erd
24167 \begin_layout Subsubsection
24171 \begin_layout Standard
24172 There is also a new function implemented in the \SpecialChar LyX
24174 \begin_inset Quotes eld
24177 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24181 \begin_layout Standard
24182 When debugging code with ddd/gdb, it is possible to invoke a text editor
24183 at the current execution position with a single key stroke.
24184 The default ddd configuration for that is shift-ctrl-V.
24185 It happens that you can define the editor command line invocation in ddd
24188 Edit\SpecialChar menuseparator
24189 Preferences\SpecialChar menuseparator
24192 dialog and changing the "Edit Sources" entry.
24195 \begin_layout Standard
24196 I take advantage of the newly created \SpecialChar LyX
24197 server function and this ddd feature,
24199 \begin_inset Quotes eld
24203 \begin_inset Quotes erd
24209 \begin_layout Standard
24210 \begin_inset VSpace defskip
24216 \begin_layout Standard
24219 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24222 \begin_layout Standard
24223 \begin_inset VSpace defskip
24229 \begin_layout Standard
24230 With this, whenever you are using ddd and find a point in the program that
24231 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24232 ddd will forward this information to \SpecialChar LyX
24233 through the \SpecialChar LyX
24234 server and then the
24236 window will show the same file with the cursor at the same position ddd
24238 No more guessing or long scrolling to locate a point in the program back
24242 \begin_layout Standard
24243 Note however that you must enable the \SpecialChar LyX
24244 server to get this feature working
24245 (it is disabled by default).
24246 You can enable it in
24258 ) by entering in the
24264 \begin_inset Quotes eld
24269 /home/<your-home-directory>/.lyx/lyxpipe
24272 \begin_inset Quotes erd
24278 \begin_layout Standard
24279 Read the \SpecialChar LyX
24280 server documentation in the
24282 Customization Manual
24284 for further information.
24287 \begin_layout Subsubsection
24291 \begin_layout Standard
24292 There are six new buttons that can be added to your \SpecialChar LyX
24294 Five of these buttons are short cuts to layout styles:
24317 The last one is a short cut to the
24318 \begin_inset Quotes eld
24322 \begin_inset Quotes erd
24329 \begin_layout Standard
24331 has a range of buttons that are available for tool bar customization.
24332 In my toolbar I like to combine the six short cuts above with two more:
24337 \SpecialChar menuseparator
24342 \SpecialChar menuseparator
24349 Document\SpecialChar menuseparator
24350 View\SpecialChar menuseparator
24354 Here is how it looks like:
24357 \begin_layout LyX-Code
24361 \begin_layout LyX-Code
24365 \begin_layout LyX-Code
24366 Icon "layout Standard"
24369 \begin_layout LyX-Code
24370 Icon "layout Section"
24373 \begin_layout LyX-Code
24374 Icon "layout \SpecialChar LaTeX
24378 \begin_layout LyX-Code
24379 Icon "layout \SpecialChar LyX
24383 \begin_layout LyX-Code
24384 Icon "layout Chunk"
24387 \begin_layout LyX-Code
24391 \begin_layout LyX-Code
24395 \begin_layout LyX-Code
24396 Icon "buffer-typeset"
24399 \begin_layout LyX-Code
24400 Icon "build-program"
24403 \begin_layout LyX-Code
24407 \begin_layout LyX-Code
24411 \begin_layout LyX-Code
24415 \begin_layout LyX-Code
24419 \begin_layout LyX-Code
24423 \begin_layout Subsubsection
24424 Colors customization
24427 \begin_layout Standard
24428 There are a number of colors in \SpecialChar LyX
24429 that can be customized in
24434 One of the things that bothers people is the \SpecialChar LaTeX
24436 The default color is red, since the chunks uses \SpecialChar LaTeX
24437 font, and there is a lot
24438 of chunks in literate documents, you may get tired of seeing everything
24440 You can change it by going to the tabs
24449 \begin_layout Standard
24450 The next thing is the visible presence of the newline character in the screen.
24451 You can choose the color of this particular character and make it blend
24453 I recommend you choosing a color that is close to the background but not
24454 equal, that way you still can see it is there, but it is not bothering
24458 \begin_layout Subsection
24463 \begin_layout Standard
24472 is documented in the
24476 example file and in the Sweave manual (menu
24478 Help\SpecialChar menuseparator
24484 \begin_layout Chapter
24488 \begin_layout Standard
24489 You can do everything with \SpecialChar LyX
24490 that you can do with \SpecialChar LaTeX
24492 However, \SpecialChar LyX
24493 cannot support every \SpecialChar LaTeX
24495 But you can always use \SpecialChar TeX
24497 This chapter shows you some more special things you might want to use.
24498 For other special things you can do with figures, tables, floats, boxes
24499 and notes, have a look at the
24502 \begin_inset space ~
24510 \begin_layout Section
24511 Multiple Text Columns
24514 \begin_layout Standard
24515 This feature is independent of the option
24517 Two-column document
24519 in the document settings under
24524 If you want to have 2
24525 \begin_inset space ~
24528 columns for the whole document, it is recommended to use the
24530 Two-column document
24533 For all other cases use this feature.
24536 \begin_layout Standard
24537 To use multiple text columns in your document, you have to load the module
24544 Document\SpecialChar menuseparator
24545 Settings\SpecialChar menuseparator
24548 ) and must have the \SpecialChar LaTeX
24556 \begin_layout Standard
24557 Footnotes within multiple columns will be placed at the bottom of the page
24558 and not under each column.
24559 Within the different columns you can use everything, with the limitation
24560 that for floats you need to use the float option
24567 \begin_layout Subsection
24571 \begin_layout Standard
24572 If you want to have 2
24573 \begin_inset space ~
24576 columns in your text, insert a multicolumn inset via the menu
24578 Insert\SpecialChar menuseparator
24580 \begin_inset space ~
24583 Insets\SpecialChar menuseparator
24585 \begin_inset space ~
24590 where the columns should start.
24591 Write all text that should be printed in 2
24592 \begin_inset space ~
24595 columns into this inset.
24598 \begin_layout Standard
24599 Here is an example:
24602 \begin_layout Standard
24604 \begin_inset Flex Multiple Columns
24607 \begin_layout Plain Layout
24612 The Adventure of the Empty House
24615 \begin_inset Newline newline
24618 by Sir Arthur Conan Doyle
24621 \begin_layout Plain Layout
24624 It was in the spring of the year 1894 that all London was interested, and
24625 the fashionable world dismayed, by the murder of the Honourable Ronald
24626 Adair under most unusual and inexplicable circumstances.
24627 The public has already learned those particulars of the crime which came
24628 out in the police investigation, but a good deal was suppressed upon that
24629 occasion, since the case for the prosecution was so overwhelmingly strong
24630 that it was not necessary to bring forward all the facts.
24631 Only now, at the end of nearly ten years, am I allowed to supply those
24632 missing links which make up the whole of that remarkable chain.
24633 The crime was of interest in itself, but that interest was as nothing to
24634 me compared to the inconceivable sequel, which afforded me the greatest
24635 shock and surprise of any event in my adventurous life.
24636 Even now, after this long interval, I find myself thrilling as I think
24637 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24638 ty which utterly submerged my mind.
24639 Let me say to that public, which has shown some interest in those glimpses
24640 which I have occasionally given them of the thoughts and actions of a very
24641 remarkable man, that they are not to blame me if I have not shared my knowledge
24642 with them, for I should have considered it my first duty to do so, had
24643 I not been barred by a positive prohibition from his own lips, which was
24644 only withdrawn upon the third of last month.
24652 \begin_layout Standard
24653 To get 3 or more columns, set the cursor into the multicolumn inset and
24656 Insert\SpecialChar menuseparator
24658 \begin_inset space ~
24662 \begin_inset space ~
24668 The number of the desired columns is written into that inset (for 3
24669 \begin_inset space ~
24673 \begin_inset Quotes eld
24677 \begin_inset Quotes erd
24681 \begin_inset Newline newline
24684 Here is an example with 3
24685 \begin_inset space ~
24691 \begin_layout Standard
24692 \begin_inset Flex Multiple Columns
24695 \begin_layout Plain Layout
24698 \begin_inset Argument 1
24701 \begin_layout Plain Layout
24707 It can be imagined that my close intimacy with Sherlock Holmes had interested
24708 me deeply in crime, and that after his disappearance I never failed to
24709 read with care the various problems which came before the public.
24710 And I even attempted, more than once, for my own private satisfaction,
24711 to employ his methods in their solution, though with indifferent success.
24712 There was none, however, which appealed to me like this tragedy of Ronald
24714 As I read the evidence at the inquest, which led up to a verdict of willful
24715 murder against some person or persons unknown, I realized more clearly
24716 than I had ever done the loss which the community had sustained by the
24717 death of Sherlock Holmes.
24718 There were points about this strange business which would, I was sure,
24719 have specially appealed to him, and the efforts of the police would have
24720 been supplemented, or more probably anticipated, by the trained observation
24721 and the alert mind of the first criminal agent in Europe.
24722 All day, as I drove upon my round, I turned over the case in my mind and
24723 found no explanation which appeared to me to be adequate.
24724 At the risk of telling a twice-told tale, I will recapitulate the facts
24725 as they were known to the public at the conclusion of the inquest.
24733 \begin_layout Standard
24734 You can have up to 10
24735 \begin_inset space ~
24738 columns if you want to, but that might not be very pleasant for the readers
24742 \begin_layout Standard
24743 \begin_inset Newpage newpage
24749 \begin_layout Subsection
24750 Columns inside Columns
24753 \begin_layout Standard
24754 You can also have columns inside columns:
24757 \begin_layout Standard
24758 \begin_inset Flex Multiple Columns
24761 \begin_layout Plain Layout
24764 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24765 at that time governor of one of the Australian colonies.
24766 Adair's mother had returned from Australia to undergo the operation for
24767 cataract, and she, her son Ronald, and her daughter Hilda were living together
24771 \begin_layout Plain Layout
24772 \begin_inset Flex Multiple Columns
24775 \begin_layout Plain Layout
24778 The youth moved in the best society–had, so far as was known, no enemies
24779 and no particular vices.
24780 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24781 had been broken off by mutual consent some months before, and there was
24782 no sign that it had left any very profound feeling behind it.
24783 For the rest {sic} the man's life moved in a narrow and conventional circle,
24784 for his habits were quiet and his nature unemotional.
24785 Yet it was upon this easy-going young aristocrat that death came, in most
24786 strange and unexpected form, between the hours of ten and eleven-twenty
24787 on the night of March 30, 1894.
24795 \begin_layout Plain Layout
24798 Ronald Adair was fond of cards–playing continually, but never for such stakes
24800 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24801 It was shown that, after dinner on the day of his death, he had played
24802 a rubber of whist at the latter club.
24803 He had also played there in the afternoon.
24808 The evidence of those who had played with him– Mr.
24809 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24810 and that there was a fairly equal fall of the cards.
24811 Adair might have lost five pounds, but not more.
24812 His fortune was a considerable one, and such a loss could not in any way
24814 He had played nearly every day at one club or other, but he was a cautious
24815 player, and usually rose a winner.
24816 It came out in evidence that, in partnership with Colonel Moran, he had
24817 actually won as much as four hundred and twenty pounds in a sitting, some
24818 weeks before, from Godfrey Milner and Lord Balmoral.
24819 So much for his recent history as it came out at the inquest.
24827 \begin_layout Subsection
24831 \begin_layout Standard
24832 The examples in this section show some more special features of multiple
24836 \begin_layout Standard
24837 For more features of multiple columns, have a look at the documentation
24838 of the \SpecialChar LaTeX
24844 \begin_inset CommandInset citation
24853 \begin_layout Subsubsection
24857 \begin_layout Standard
24858 To add a preface text for multiple columns, set the cursor into the multicolumn
24859 inset and use the menu
24861 Insert\SpecialChar menuseparator
24865 Write your preface text into that inset.
24866 \begin_inset Newline newline
24869 This is an example with some preface text:
24872 \begin_layout Standard
24873 \begin_inset VSpace bigskip
24879 \begin_layout Standard
24880 \begin_inset Flex Multiple Columns
24883 \begin_layout Plain Layout
24884 \begin_inset Argument 2
24887 \begin_layout Plain Layout
24888 And the story continues and continues and continues and continues\SpecialChar ldots
24896 On the evening of the crime, he returned from the club exactly at ten.
24897 His mother and sister were out spending the evening with a relation.
24898 The servant deposed that she heard him enter the front room on the second
24899 floor, generally used as his sitting-room.
24900 She had lit a fire there, and as it smoked she had opened the window.
24901 No sound was heard from the room until eleven-twenty, the hour of the return
24902 of Lady Maynooth and her daughter.
24903 Desiring to say good-night, she attempted to enter her son's room.
24904 The door was locked on the inside, and no answer could be got to their
24905 cries and knocking.
24906 Help was obtained, and the door forced.
24907 The unfortunate young man was found lying near the table.
24908 His head had been horribly mutilated by an expanding revolver bullet, but
24909 no weapon of any sort was to be found in the room.
24917 \begin_layout Standard
24918 You can also use a section heading as the preface if you use a section command
24919 as \SpecialChar TeX
24921 For example the command
24924 \begin_layout Standard
24929 subsection{subsection title}
24932 \begin_layout Standard
24933 creates a subsection.
24934 In this example the preface is a subsubsection:
24937 \begin_layout Standard
24938 \begin_inset Flex Multiple Columns
24941 \begin_layout Plain Layout
24942 \begin_inset Argument 2
24945 \begin_layout Plain Layout
24949 \begin_layout Plain Layout
24958 This is a subsubsection heading as a preface
24962 \begin_layout Plain Layout
24976 A minute examination of the circumstances served only to make the case more
24978 In the first place, no reason could be given why the young man should have
24979 fastened the door upon the inside.
24980 There was the possibility that the murderer had done this, and had afterwards
24981 escaped by the window.
24982 The drop was at least twenty feet, however, and a bed of crocuses in full
24984 Neither the flowers nor the earth showed any sign of having been disturbed,
24985 nor were there any marks upon the narrow strip of grass which separated
24986 the house from the road.
24987 Apparently, therefore, it was the young man himself who had fastened the
24989 But how did he come by his death? No one could have climbed up to the window
24990 without leaving traces.
24991 Suppose a man had fired through the window, he would indeed be a remarkable
24992 shot who could with a revolver inflict so deadly a wound.
24993 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24994 a hundred yards of the house.
24995 No one had heard a shot.
25003 \begin_layout Standard
25004 If there is less vertical space than 6
25005 \begin_inset space ~
25008 text lines is left on the page at the beginning of the multiple columns,
25009 a page break will be inserted before the multiple columns.
25010 Depending on the number of lines of the preface text, you might want to
25012 This is done by setting the cursor into the mulitcolumn inset behind the
25013 preface (if there is any) and using the menu
25015 Insert\SpecialChar menuseparator
25017 \begin_inset space ~
25021 \begin_inset space ~
25025 \begin_inset space ~
25031 Insert into that inset the amount of space like e.
25032 \begin_inset space \thinspace{}
25036 \begin_inset space \space{}
25040 \begin_inset Quotes eld
25044 \begin_inset Quotes erd
25048 \begin_inset Newline newline
25051 In this example the space is set to 7
25052 \begin_inset space ~
25055 text lines by using
25056 \begin_inset Quotes eld
25062 \begin_inset Quotes erd
25071 needs to be inserted as \SpecialChar TeX
25075 \begin_layout Standard
25076 \begin_inset Flex Multiple Columns
25079 \begin_layout Plain Layout
25080 \begin_inset Argument 3
25083 \begin_layout Plain Layout
25088 \begin_layout Plain Layout
25104 On the evening of the crime, he returned from the club exactly at ten.
25105 His mother and sister were out spending the evening with a relation.
25106 The servant deposed that she heard him enter the front room on the second
25107 floor, generally used as his sitting-room.
25108 She had lit a fire there, and as it smoked she had opened the window.
25109 No sound was heard from the room until eleven-twenty, the hour of the return
25110 of Lady Maynooth and her daughter.
25111 Desiring to say good-night, she attempted to enter her son's room.
25112 The door was locked on the inside, and no answer could be got to their
25113 cries and knocking.
25114 Help was obtained, and the door forced.
25115 The unfortunate young man was found lying near the table.
25116 His head had been horribly mutilated by an expanding revolver bullet, but
25117 no weapon of any sort was to be found in the room.
25125 \begin_layout Subsubsection
25129 \begin_layout Standard
25130 The amount of space before and after multiple columns can be changed by
25131 changing the length
25138 For example the command
25141 \begin_layout Standard
25151 \begin_layout Standard
25152 in \SpecialChar TeX
25153 Code changes its value to 3
25154 \begin_inset space \thinspace{}
25158 The change must be made before the multiple columns' start.
25159 The predefined value is 13
25160 \begin_inset space \thinspace{}
25166 \begin_layout Standard
25174 \begin_inset space \thinspace{}
25180 \begin_layout Standard
25184 \begin_layout Plain Layout
25190 multicolsep}{2.5cm}
25198 \begin_layout Standard
25199 \begin_inset Flex Multiple Columns
25202 \begin_layout Plain Layout
25205 All day I turned these facts over in my mind, endeavouring to hit upon some
25206 theory which could reconcile them all, and to find that line of least resistanc
25207 e which my poor friend had declared to be the starting-point of every investigat
25209 I confess that I made little progress.
25210 In the evening I strolled across the Park, and found myself about six o'clock
25211 at the Oxford Street end of Park Lane.
25212 A group of loafers upon the pavements, all staring up at a particular window,
25213 directed me to the house which I had come to see.
25214 A tall, thin man with coloured glasses, whom I strongly suspected of being
25215 a plain-clothes detective, was pointing out some theory of his own, while
25216 the others crowded round to listen to what he said.
25217 I got as near him as I could, but his observations seemed to me to be absurd,
25218 so I withdrew again in some disgust.
25219 As I did so I struck against an elderly, deformed man, who had been behind
25220 me, and I knocked down several books which he was carrying.
25228 \begin_layout Standard
25229 \begin_inset Note Greyedout
25232 \begin_layout Plain Layout
25237 The values you set with
25243 will be used for all following multiple columns until you change them again.
25251 \begin_layout Standard
25255 \begin_layout Plain Layout
25267 \begin_inset Note Note
25270 \begin_layout Plain Layout
25271 go back to the default
25279 \begin_layout Standard
25280 \begin_inset Newpage newpage
25286 \begin_layout Subsubsection
25290 \begin_layout Standard
25291 A column break can be forced by inserting the command
25297 as \SpecialChar TeX
25299 \change_inserted -712698321 1437633561
25301 \change_deleted -712698321 1437633560
25304 Code to that position in the text where the column should be broken.
25305 Note that this leads in most cases to whitespace in the text.
25306 \begin_inset Newline newline
25309 Here is an example:
25312 \begin_layout Standard
25313 \begin_inset Flex Multiple Columns
25316 \begin_layout Plain Layout
25319 \begin_inset Quotes eld
25322 You're surprised to see me, sir,
25323 \begin_inset Quotes erd
25326 said he, in a strange, croaking voice.
25329 \begin_layout Plain Layout
25332 I acknowledged that I was.
25335 \begin_layout Plain Layout
25338 \begin_inset Quotes eld
25341 Well, I've a conscience, sir, and when I chanced to see you go into this
25342 house, as I came hobbling after you, I thought to myself, I'll just step
25343 in and see that kind gentleman, and tell him that if I was a bit gruff
25344 in my manner there was not any harm meant, and that I am much obliged to
25345 him for picking up my books.
25346 \begin_inset Quotes erd
25352 \begin_layout Plain Layout
25355 \begin_inset Quotes eld
25358 You make too much of a trifle,
25359 \begin_inset Quotes erd
25364 \begin_inset Quotes eld
25367 May I ask how you knew who I was?
25368 \begin_inset Quotes erd
25371 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25375 \begin_layout Plain Layout
25387 \begin_layout Plain Layout
25390 \begin_inset Quotes eld
25393 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25394 you'll find my little bookshop at the corner of Church Street, and very
25395 happy to see you, I am sure.
25396 Maybe you collect yourself, sir.
25400 \begin_inset space ~
25413 –a bargain, every one of them.
25414 With five volumes you could just fill that gap on that second shelf.
25415 It looks untidy, does it not, sir?
25416 \begin_inset Quotes erd
25427 \begin_layout Subsubsection
25431 \begin_layout Standard
25432 The width of the columns is automatically calculated, but you can modify
25433 the space between the columns.
25434 This is done by changing the length
25441 Its predefined value is 10
25442 \begin_inset space \thinspace{}
25446 Here is an example where
25453 \begin_inset space \thinspace{}
25459 \begin_layout Standard
25463 \begin_layout Plain Layout
25477 \begin_layout Standard
25478 \begin_inset Flex Multiple Columns
25481 \begin_layout Plain Layout
25484 My observations of No.
25485 \begin_inset space \space{}
25488 427 Park Lane did little to clear up the problem in which I was interested.
25489 The house was separated from the street by a low wall and railing, the
25490 whole not more than five feet high.
25491 It was perfectly easy, therefore, for anyone to get into the garden, but
25492 the window was entirely inaccessible, since there was no water pipe or
25493 anything which could help the most active man to climb it.
25494 More puzzled than ever, I retraced my steps to Kensington.
25495 I had not been in my study five minutes when the maid entered to say that
25496 a person desired to see me.
25497 To my astonishment it was none other than my strange old book collector,
25498 his sharp, wizened face peering out from a frame of white hair, and his
25499 precious volumes, a dozen of them at least, wedged under his right arm.
25507 \begin_layout Standard
25511 \begin_layout Plain Layout
25523 \begin_inset Note Note
25526 \begin_layout Plain Layout
25527 go back to the default
25535 \begin_layout Subsubsection
25539 \begin_layout Standard
25540 Between the columns a rule with a width of the length
25547 If this rule width is set to 0
25548 \begin_inset space \thinspace{}
25551 pt (this is the default), the rule is suppressed.
25552 In the following example the rule is 2
25553 \begin_inset space \thinspace{}
25559 \begin_layout Standard
25563 \begin_layout Plain Layout
25569 columnseprule}{2pt}
25577 \begin_layout Standard
25578 \begin_inset Flex Multiple Columns
25581 \begin_layout Plain Layout
25584 \begin_inset Quotes eld
25587 You're surprised to see me, sir,
25588 \begin_inset Quotes erd
25591 said he, in a strange, croaking voice.
25594 \begin_layout Plain Layout
25597 I acknowledged that I was.
25600 \begin_layout Plain Layout
25603 \begin_inset Quotes eld
25606 Well, I've a conscience, sir, and when I chanced to see you go into this
25607 house, as I came hobbling after you, I thought to myself, I'll just step
25608 in and see that kind gentleman, and tell him that if I was a bit gruff
25609 in my manner there was not any harm meant, and that I am much obliged to
25610 him for picking up my books.
25611 \begin_inset Quotes erd
25617 \begin_layout Plain Layout
25620 \begin_inset Quotes eld
25623 You make too much of a trifle,
25624 \begin_inset Quotes erd
25629 \begin_inset Quotes eld
25632 May I ask how you knew who I was?
25633 \begin_inset Quotes erd
25639 \begin_layout Plain Layout
25642 \begin_inset Quotes eld
25645 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25646 you'll find my little bookshop at the corner of Church Street, and very
25647 happy to see you, I am sure.
25648 Maybe you collect yourself, sir.
25652 \begin_inset space ~
25665 –a bargain, every one of them.
25666 With five volumes you could just fill that gap on that second shelf.
25667 It looks untidy, does it not, sir?
25668 \begin_inset Quotes erd
25679 \begin_layout Standard
25680 \begin_inset VSpace defskip
25686 \begin_layout Standard
25687 The rule can be colored by redefining the command
25694 This is done by inserting the command
25695 \begin_inset Newline newline
25704 columnseprulecolor}{
25709 \begin_inset Newline newline
25712 as \SpecialChar TeX
25714 \change_inserted -712698321 1437633567
25716 \change_deleted -712698321 1437633567
25719 Code before the multicolumn inset.
25724 in this command by a color of your choice.
25725 You can use all pre- and self-defined colors.
25733 \begin_inset space ~
25738 for more information about pre- and self-defined colors.
25739 To go back to the default color insert the command
25740 \begin_inset Newline newline
25749 columnseprulecolor}{
25754 \begin_inset Newline newline
25757 Here is the example with a cyan rule and 1
25758 \begin_inset space \thinspace{}
25761 cm column separation:
25764 \begin_layout Standard
25768 \begin_layout Plain Layout
25777 \begin_layout Plain Layout
25783 columnseprulecolor}{
25793 \begin_layout Standard
25794 \begin_inset Flex Multiple Columns
25797 \begin_layout Plain Layout
25800 \begin_inset Quotes eld
25803 You're surprised to see me, sir,
25804 \begin_inset Quotes erd
25807 said he, in a strange, croaking voice.
25810 \begin_layout Plain Layout
25813 I acknowledged that I was.
25816 \begin_layout Plain Layout
25819 \begin_inset Quotes eld
25822 Well, I've a conscience, sir, and when I chanced to see you go into this
25823 house, as I came hobbling after you, I thought to myself, I'll just step
25824 in and see that kind gentleman, and tell him that if I was a bit gruff
25825 in my manner there was not any harm meant, and that I am much obliged to
25826 him for picking up my books.
25827 \begin_inset Quotes erd
25833 \begin_layout Plain Layout
25836 \begin_inset Quotes eld
25839 You make too much of a trifle,
25840 \begin_inset Quotes erd
25845 \begin_inset Quotes eld
25848 May I ask how you knew who I was?
25849 \begin_inset Quotes erd
25855 \begin_layout Plain Layout
25858 \begin_inset Quotes eld
25861 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25862 you'll find my little bookshop at the corner of Church Street, and very
25863 happy to see you, I am sure.
25864 Maybe you collect yourself, sir.
25868 \begin_inset space ~
25881 –a bargain, every one of them.
25882 With five volumes you could just fill that gap on that second shelf.
25883 It looks untidy, does it not, sir?
25884 \begin_inset Quotes erd
25895 \begin_layout Standard
25899 \begin_layout Plain Layout
25905 columnseprule}{0pt}
25908 \begin_layout Plain Layout
25914 columnseprulecolor}{
25922 \begin_inset Note Note
25925 \begin_layout Plain Layout
25926 go back to the default
25934 \begin_layout Section
25935 Non-standard Paragraph Shapes
25938 \begin_layout Standard
25941 as well as any other text processor uses by default rectangular paragraphs.
25942 For special cases like for example posters, invitation cards or poems you
25943 can modify the paragraph shape to one of your choice.
25944 This can be done by using the \SpecialChar LaTeX
25949 which is loaded by using in the document settings the module
25951 Custom paragraph shapes
25956 \begin_layout Subsection
25960 \begin_layout Standard
25965 provides the following shapes:
25968 \begin_layout Standard
25969 \begin_inset Tabular
25970 <lyxtabular version="3" rows="13" columns="3">
25971 <features booktabs="true" islongtable="true" longtabularalignment="center">
25972 <column alignment="center" valignment="middle" width="16col%">
25973 <column alignment="center" valignment="middle" width="40col%">
25974 <column alignment="center" valignment="middle" width="35col%">
25975 <row endhead="true">
25976 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25979 \begin_layout Plain Layout
25985 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25988 \begin_layout Plain Layout
25994 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25997 \begin_layout Plain Layout
26005 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26008 \begin_layout Plain Layout
26014 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26017 \begin_layout Plain Layout
26018 Circle with circular hole (in the size of a CD/DVD)
26023 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26026 \begin_layout Plain Layout
26027 Cannot be scaled, take care there is not too much text
26034 <cell alignment="center" valignment="top" topline="true" usebox="none">
26037 \begin_layout Plain Layout
26043 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26046 \begin_layout Plain Layout
26052 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26055 \begin_layout Plain Layout
26056 Fragile, calculation might fail
26063 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26066 \begin_layout Plain Layout
26072 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26075 \begin_layout Plain Layout
26076 Rhomboid (symbolizing a
26077 \begin_inset Quotes eld
26081 \begin_inset Quotes erd
26089 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26092 \begin_layout Plain Layout
26100 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26103 \begin_layout Plain Layout
26109 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26112 \begin_layout Plain Layout
26118 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26121 \begin_layout Plain Layout
26129 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26132 \begin_layout Plain Layout
26138 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26141 \begin_layout Plain Layout
26147 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26150 \begin_layout Plain Layout
26158 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26161 \begin_layout Plain Layout
26167 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26170 \begin_layout Plain Layout
26171 Nut for bolt (hexagon with circular hole)
26176 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26179 \begin_layout Plain Layout
26187 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26190 \begin_layout Plain Layout
26196 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26199 \begin_layout Plain Layout
26205 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26208 \begin_layout Plain Layout
26216 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26219 \begin_layout Plain Layout
26225 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26228 \begin_layout Plain Layout
26234 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26237 \begin_layout Plain Layout
26245 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26248 \begin_layout Plain Layout
26254 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26257 \begin_layout Plain Layout
26263 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26266 \begin_layout Plain Layout
26274 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26277 \begin_layout Plain Layout
26283 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26286 \begin_layout Plain Layout
26287 Normal/reversed rain drop
26292 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26295 \begin_layout Plain Layout
26296 Fragile, calculation might fail
26303 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26306 \begin_layout Plain Layout
26313 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26316 \begin_layout Plain Layout
26317 The \SpecialChar TeX
26323 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26326 \begin_layout Plain Layout
26334 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26337 \begin_layout Plain Layout
26339 \begin_inset Newline newline
26347 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26350 \begin_layout Plain Layout
26351 Triangles in different orientations
26356 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26359 \begin_layout Plain Layout
26373 \begin_layout Standard
26374 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26376 for environments in the toolbar.
26379 \begin_layout Standard
26380 \begin_inset Newpage newpage
26386 \begin_layout Standard
26387 Here is an example paragraph in the shape of a nut:
26390 \begin_layout Standard
26391 \begin_inset VSpace bigskip
26400 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26401 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26403 At vero eos et accusam et justo duo dolores et ea rebum.
26404 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26406 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26407 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26411 \begin_layout Standard
26412 \begin_inset VSpace bigskip
26418 \begin_layout Standard
26419 \begin_inset Note Greyedout
26422 \begin_layout Plain Layout
26427 : shapepar paragraphs cannot run over a page break.
26435 \begin_layout Standard
26436 \begin_inset VSpace bigskip
26442 \begin_layout Standard
26447 takes care that the shape will always be preserved, no matter how much
26448 text is in the paragraph.
26449 Therefore the paragraph size changes with the amount of contained text.
26450 This can lead to paragraph sizes exceeding the page margins.
26451 To demonstrate the size scaling, here is the same example paragraph but
26452 with twice as much text:
26455 \begin_layout Standard
26456 \begin_inset Newpage newpage
26465 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26466 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26468 At vero eos et accusam et justo duo dolores et ea rebum.
26469 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26471 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26472 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26474 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26475 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26477 At vero eos et accusam et justo duo dolores et ea rebum.
26478 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26480 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26481 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26485 \begin_layout Standard
26486 \begin_inset VSpace bigskip
26492 \begin_layout Standard
26493 An exception is the shape
26498 It cannot be scaled because it must fit the size of a CD/DVD.
26499 Therefore the amount of text that fits into the shape is limited.
26500 \begin_inset Newline newline
26511 shape are fragile, meaning that the calculation of their size can fail,
26512 depending on the amount of text.
26513 You will then get the \SpecialChar LaTeX
26515 \begin_inset Quotes eld
26518 Arithmetic overflow
26519 \begin_inset Quotes erd
26523 In this case one can try to remove or add some text; if nothing works one
26524 has to use another shape.
26527 \begin_layout Standard
26528 \begin_inset VSpace bigskip
26534 \begin_layout Standard
26535 For shapes with tips you will maybe see that \SpecialChar LaTeX
26536 's hyphenation routine fails
26537 for text in the tips.
26538 Therefore it is often necessary to add hyphenation points
26543 arg "specialchar-insert hyphenation"
26548 ) to the corresponding text parts.
26551 \begin_layout Standard
26552 \begin_inset VSpace bigskip
26558 \begin_layout Standard
26559 Shapepar paragraphs are either always centered or placed on the page so
26560 that their left border touches the left page margin.
26561 You can therefore not use the paragraph dialog to align such paragraphs.
26562 A solution is to put the paragraph into a minipage or parbox and align
26564 The problem is hereby to find the right width for the box.
26565 Because if it is too wide and you center the box, the paragraph is not
26566 centered too because it sticks at the left side of the box.
26567 So you might have to play a bit with the width until it fits.
26568 Here are two heart-shaped paragraphs, the first one is not aligned, the
26569 second one is right-aligned:
26572 \begin_layout Standard
26573 \begin_inset Newpage newpage
26579 \begin_layout Heart
26583 Lo\SpecialChar softhyphen
26584 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26585 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26587 At vero eos et accusam et justo duo dolores et ea rebum.
26588 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26592 \begin_layout Standard
26593 \begin_inset VSpace bigskip
26599 \begin_layout Standard
26602 \begin_inset Box Frameless
26612 height_special "totalheight"
26617 backgroundcolor "none"
26620 \begin_layout Heart
26624 Lo\SpecialChar softhyphen
26625 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26626 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26628 At vero eos et accusam et justo duo dolores et ea rebum.
26629 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26638 \begin_layout Subsection
26642 \begin_layout Standard
26643 You can define any shape you want.
26644 Doing this manually is a lot of work because every coordinate must be specified.
26645 But there is a way to let the computer calculate the coordinates:
26648 \begin_layout Enumerate
26649 Install the program
26650 \begin_inset CommandInset href
26653 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26660 \begin_layout Enumerate
26666 \change_deleted -712698321 1437633577
26673 \begin_layout Plain Layout
26681 \change_inserted -712698321 1437633577
26685 \change_deleted -712698321 1437633578
26690 \begin_layout Plain Layout
26698 \change_inserted -712698321 1437633578
26701 \SpecialChar menuseparator
26702 Settings\SpecialChar menuseparator
26705 and select the font size you are using in your document.
26706 For example this document uses the size 12
26707 \begin_inset space \thinspace{}
26713 \begin_layout Enumerate
26717 \begin_layout Enumerate
26719 \change_deleted -712698321 1437633580
26726 \begin_layout Plain Layout
26734 \change_inserted -712698321 1437633580
26738 \change_deleted -712698321 1437633581
26743 \begin_layout Plain Layout
26751 \change_inserted -712698321 1437633581
26754 \SpecialChar menuseparator
26757 to export the shape to coordinates.
26758 In the appearing dialog use either the outline of your shape for the coordinate
26759 s or the path itself.
26763 \begin_layout Plain Layout
26764 For more information see
26765 \begin_inset CommandInset href
26767 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26779 \begin_layout Standard
26780 The coordinates are written into a \SpecialChar TeX
26782 \change_inserted -712698321 1437633584
26784 \change_deleted -712698321 1437633584
26788 To use it for your \SpecialChar LyX
26792 \begin_layout Enumerate
26793 Place the cursor before the first character of your paragraph (or into a
26797 \begin_layout Enumerate
26798 Open in \SpecialChar LyX
26801 Insert\SpecialChar menuseparator
26802 File\SpecialChar menuseparator
26804 \begin_inset space ~
26809 , select the file and use
26818 \begin_layout Standard
26819 \begin_inset VSpace defskip
26825 \begin_layout Standard
26826 \begin_inset Note Greyedout
26829 \begin_layout Plain Layout
26834 : The changed shape only applies to the current paragraph; everything is
26835 reset to normal for the next paragraph.
26836 Therefore the shape definition file must be input into every paragraph
26837 with the desired shape.
26845 \begin_layout Standard
26846 \begin_inset VSpace bigskip
26852 \begin_layout Standard
26853 Here is an example:
26856 \begin_layout Standard
26857 \begin_inset VSpace bigskip
26863 \begin_layout Standard
26864 \begin_inset CommandInset include
26866 filename "SpecialParagraphShape.tex"
26872 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26873 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26875 At vero eos et accusam et justo duo dolores et ea rebum.
26876 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26878 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26879 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26883 \begin_layout Standard
26884 \begin_inset VSpace bigskip
26890 \begin_layout Standard
26895 to draw complexer shapes in
26899 you can draw the shape in a program of your choice and import the resulting
26905 Then you only need to draw a line or spline along the outline of the image.
26908 \begin_layout Standard
26909 \begin_inset VSpace bigskip
26915 \begin_layout Standard
26918 Custom paragraph shapes
26920 also provides the two commands
26928 which can be used to define custom shapes coordinate by coordinate.
26932 \begin_layout Plain Layout
26933 These commands are internally used for all shapes described here.
26938 For information how these styles are used and about further customization
26939 possibilities, have a look at the documentation of the package
26944 \begin_inset CommandInset citation
26953 \begin_layout Bibliography
26954 \begin_inset CommandInset bibitem
26955 LatexCommand bibitem
26960 Documentation of the \SpecialChar LaTeX
26962 \begin_inset CommandInset href
26965 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26972 \begin_layout Bibliography
26973 \begin_inset CommandInset bibitem
26974 LatexCommand bibitem
26979 Documentation of the \SpecialChar LaTeX
26981 \begin_inset CommandInset href
26984 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"