1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
40 \maintain_unincluded_children false
42 \language_package default
45 \font_roman "lmodern" "default"
46 \font_sans "lmss" "default"
47 \font_typewriter "lmtt" "default"
48 \font_math "auto" "auto"
49 \font_default_family default
50 \use_non_tex_fonts false
53 \font_sf_scale 100 100
54 \font_tt_scale 100 100
56 \default_output_format pdf2
58 \bibtex_command default
59 \index_command default
63 \pdf_title "LyX's Additional Features manual"
64 \pdf_author "LyX Team"
65 \pdf_subject "LyX's additional features documentation"
66 \pdf_keywords "LyX, Documentation, Additional"
68 \pdf_bookmarksnumbered true
69 \pdf_bookmarksopen false
70 \pdf_bookmarksopenlevel 1
75 \pdf_pdfusetitle false
76 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
79 \use_package amsmath 1
80 \use_package amssymb 1
83 \use_package mathdots 1
84 \use_package mathtools 0
86 \use_package stackrel 0
87 \use_package stmaryrd 0
88 \use_package undertilde 0
90 \cite_engine_type default
94 \paperorientation portrait
98 \notefontcolor #0000ff
105 \paragraph_separation indent
106 \paragraph_indentation default
107 \quotes_language english
110 \paperpagestyle headings
111 \tracking_changes false
112 \output_changes false
121 Additional \SpecialChar LyX
125 \begin_layout Subtitle
130 by the \SpecialChar LyX
135 \begin_layout Plain Layout
137 Principal maintainer of this file is
142 If you have comments or error corrections, please send them to the \SpecialChar LyX
145 \begin_inset Flex Code
148 \begin_layout Plain Layout
150 <lyx-docs@lists.lyx.org>
163 \begin_layout Standard
164 \begin_inset CommandInset toc
165 LatexCommand tableofcontents
172 \begin_layout Chapter
176 \begin_layout Standard
177 This manual is essentially Part II of the
179 User's Guide\SpecialChar endofsentence
182 The reason for separating the two documents is simple: the
186 is already quite lengthy, and it contains information on all of the basic
187 features one needs to know in order to prepare most documents.
188 However, the \SpecialChar LyX
189 Team has worked to make \SpecialChar LyX
190 extensible through various configuration
191 files and external packages.
192 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
194 create a layout file (or module) for it without having to alter \SpecialChar LyX
196 We've already had contributions of several new features this way, and some
197 of them are documented here.
198 There are also some more `advanced' features, such as how to control the
199 presentation of bibliographies and how to work with multi-part documents,
200 that are not covered in the
204 and are discussed here.
207 \begin_layout Standard
208 This manual also documents some special features, like fax support, version
209 control, and SGML support, which require additional software to work properly.
210 There is also a chapter on \SpecialChar LyX
212 And lastly, there's a chapter of \SpecialChar LaTeX
213 tools and tips, things you can use to
214 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
216 After all, \SpecialChar LyX
221 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
225 \begin_layout Standard
226 If you haven't read the
230 yet, you are definitely in the wrong manual.
235 is the first place to go, since it describes the notation and format of
237 You should also be thoroughly familiar with the
241 and all of the basic features of \SpecialChar LyX
242 before attempting to read this one.
245 \begin_layout Standard
246 Since many of the topics in this manual depend heavily on \SpecialChar LyX
248 with \SpecialChar LaTeX
249 , this first chapter covers the inner workings of \SpecialChar LyX
252 to generate exactly the \SpecialChar LaTeX
254 It is obviously for more seasoned \SpecialChar LyX
258 \begin_layout Chapter
260 and \SpecialChar LaTeX
264 \begin_layout Section
266 Uses \SpecialChar LaTeX
270 \begin_layout Standard
271 This chapter is for both \SpecialChar TeX
272 -nicians and the \SpecialChar LaTeX
274 In it, we'll explain how \SpecialChar LyX
275 and \SpecialChar LaTeX
276 work together to produce printable output.
277 This is the only place in any of the manuals where we assume you know something
278 about \SpecialChar LaTeX
282 \begin_layout Standard
283 At one time, \SpecialChar LyX
285 \begin_inset Quotes eld
288 WYSIWYM frontend to \SpecialChar LaTeX
290 \begin_inset Quotes erd
293 but that's no longer true.
294 There are frontends to \SpecialChar LaTeX
299 \begin_layout Plain Layout
300 Some familar ones are \SpecialChar TeX
301 maker and kile, on Linux, and \SpecialChar TeX
303 There are also the \SpecialChar LaTeX
304 modes for vi and emacs, of course.
309 These are basically text editors with the ability to run \SpecialChar LaTeX
311 errors in the file you're editing.
312 Although \SpecialChar LyX
321 run \SpecialChar LaTeX
322 , and it also indicates errors in the file, it also does much, much
324 For one thing, you don't need to know \SpecialChar LaTeX
325 to use \SpecialChar LyX
328 has added its own extensions to \SpecialChar LaTeX
330 Try the following sometime: select
331 \begin_inset Flex Noun
334 \begin_layout Plain Layout
335 Export\SpecialChar menuseparator
343 \begin_inset Flex Noun
346 \begin_layout Plain Layout
353 \begin_inset Flex Noun
356 \begin_layout Plain Layout
357 View\SpecialChar menuseparator
367 ), then look at the preamble of the resulting
368 \begin_inset Flex Code
371 \begin_layout Plain Layout
378 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
380 These macros are defined automatically, according to the features you use
384 \begin_layout Standard
385 There are several commands that automatically invoke \SpecialChar LaTeX
390 \begin_layout Itemize
391 \begin_inset Flex Noun
394 \begin_layout Plain Layout
395 Document\SpecialChar menuseparator
404 \begin_layout Itemize
405 \begin_inset Flex Noun
408 \begin_layout Plain Layout
409 Document\SpecialChar menuseparator
418 \begin_layout Itemize
419 \begin_inset Flex Noun
422 \begin_layout Plain Layout
423 File\SpecialChar menuseparator
432 \begin_layout Itemize
433 \begin_inset Flex Noun
436 \begin_layout Plain Layout
437 File\SpecialChar menuseparator
446 \begin_layout Standard
447 They will only invoke \SpecialChar LaTeX
448 if the file has changed since the last time \SpecialChar LaTeX
454 \begin_layout Standard
455 When \SpecialChar LyX
456 runs \SpecialChar LaTeX
457 on the file you're editing, it performs these steps:
460 \begin_layout Enumerate
461 Convert the document to \SpecialChar LaTeX
462 and save to a file with the extension
463 \begin_inset Flex Code
466 \begin_layout Plain Layout
473 \begin_inset Flex Code
476 \begin_layout Plain Layout
485 \begin_layout Enumerate
486 Run \SpecialChar LaTeX
488 \begin_inset Flex Code
491 \begin_layout Plain Layout
497 file (maybe several times), and run any other commands (such as
498 \begin_inset Flex Code
501 \begin_layout Plain Layout
508 \begin_inset Flex Code
511 \begin_layout Plain Layout
517 ) needed to compile the \SpecialChar LaTeX
521 \begin_layout Enumerate
522 If there are any errors, show the error log.
525 \begin_layout Standard
526 If you have run \SpecialChar LaTeX
528 \begin_inset Flex Noun
531 \begin_layout Plain Layout
534 \SpecialChar menuseparator
543 then runs a DVI viewer to display the DVI-file.
545 \begin_inset Flex Noun
548 \begin_layout Plain Layout
551 \SpecialChar menuseparator
560 performs further steps:
563 \begin_layout Itemize
565 \begin_inset Flex Code
568 \begin_layout Plain Layout
574 to convert the DVI file to PostScript.
577 \begin_layout Itemize
578 Run a PostScript viewer, such as
579 \begin_inset Flex Code
582 \begin_layout Plain Layout
588 , to display the PostScript file.
591 \begin_layout Standard
593 does similar things when viewing, or exporting, other formats.
596 \begin_layout Section
597 Translating \SpecialChar LaTeX
598 files into \SpecialChar LyX
602 \begin_layout Standard
603 You can import a \SpecialChar LaTeX
604 file into \SpecialChar LyX
606 \begin_inset Flex Noun
609 \begin_layout Plain Layout
610 File\SpecialChar menuseparator
611 Import\SpecialChar menuseparator
618 command in \SpecialChar LyX
620 This will call a program named
621 \begin_inset Flex Code
624 \begin_layout Plain Layout
630 which will create a file
631 \begin_inset Flex Code
634 \begin_layout Plain Layout
641 \begin_inset Flex Code
644 \begin_layout Plain Layout
652 will then open that file.
656 \begin_layout Plain Layout
657 \begin_inset Flex Code
660 \begin_layout Plain Layout
666 can also be run from the command line, of course.
674 \begin_layout Standard
675 \begin_inset Flex Code
678 \begin_layout Plain Layout
684 will translate most legal \SpecialChar LaTeX
685 , but not everything.
686 It will put things it doesn't understand into \SpecialChar TeX
687 code, so after translating
689 \begin_inset Flex Code
692 \begin_layout Plain Layout
698 , you can look for \SpecialChar TeX
699 code and hand-edit it until it looks right.
702 \begin_layout Standard
703 If you don't know what \SpecialChar TeX
704 code is, read the next section.
707 \begin_layout Section
708 \begin_inset CommandInset label
710 name "sec:Inserting-TeX-Code"
714 Inserting \SpecialChar TeX
715 Code into \SpecialChar LyX
719 \begin_layout Standard
720 Anything you can do in \SpecialChar LaTeX
721 you can do in \SpecialChar LyX
722 , for a very simple reason: You can
723 always insert \SpecialChar TeX
724 code into any \SpecialChar LyX
727 cannot, and will never be able to, display every possible \SpecialChar LaTeX
729 If ever you need to insert \SpecialChar LaTeX
730 commands into your \SpecialChar LyX
731 document, you can use the
733 \begin_inset Flex Code
736 \begin_layout Plain Layout
743 box, which you can insert into your document with
744 \begin_inset Flex Noun
747 \begin_layout Plain Layout
748 Insert\SpecialChar menuseparator
758 or the keyboard shortcut
767 \begin_layout Standard
768 Here's an example of inserting \SpecialChar LaTeX
769 commands in a \SpecialChar LyX
771 The code looks like this:
774 \begin_layout LyX-Code
778 \begin_inset Newline newline
784 \begin_inset Newline newline
787 This is an example of a minipage environment.
789 \begin_inset Newline newline
792 can put nearly everything in it, even (non-floating)
793 \begin_inset Newline newline
798 \begin_inset Newline newline
804 \begin_inset Newline newline
808 \begin_inset Newline newline
814 \begin_inset Newline newline
820 \begin_inset Newline newline
826 \begin_inset Newline newline
831 \begin_inset Newline newline
837 \begin_inset Newline newline
843 \begin_inset Newline newline
849 \begin_inset Newline newline
857 \begin_layout LyX-Code
861 \begin_layout Standard
863 \begin_inset Flex Code
866 \begin_layout Plain Layout
873 box containing this text is directly after this paragraph.
874 Those of you reading the manual in \SpecialChar LyX
875 will only see the \SpecialChar TeX
877 Those reading a printed version of the manuals will see the actual results:
878 \begin_inset VSpace bigskip
884 \begin_layout Standard
888 \begin_layout Plain Layout
895 \begin_layout Plain Layout
902 \begin_layout Plain Layout
904 This is an example of a minipage environment.
905 You can put nearly everything in it, even (non-floating) figures and tables.
909 \begin_layout Plain Layout
916 \begin_layout Plain Layout
921 \begin_layout Plain Layout
928 \begin_layout Plain Layout
935 \begin_layout Plain Layout
942 \begin_layout Plain Layout
948 \begin_layout Plain Layout
955 \begin_layout Plain Layout
962 \begin_layout Plain Layout
969 \begin_layout Plain Layout
979 \begin_inset VSpace bigskip
985 \begin_layout Standard
986 In addition to using \SpecialChar TeX
987 code, you can also create a separate file containing
988 some complex \SpecialChar LaTeX
989 structure and then use
990 \begin_inset Flex Noun
993 \begin_layout Plain Layout
994 Insert\SpecialChar menuseparator
1004 to include your file (you should select the type
1005 \begin_inset Flex Code
1008 \begin_layout Plain Layout
1015 We recommend that you only do this if you have a
1016 \begin_inset Flex Code
1019 \begin_layout Plain Layout
1030 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1034 \begin_layout Standard
1035 There are a few last points to emphasize:
1038 \begin_layout Itemize
1044 check if your \SpecialChar LaTeX
1048 \begin_layout Itemize
1049 Beware of reinventing the wheel.
1052 \begin_layout Standard
1053 On that last point, \SpecialChar LyX
1054 does have quite a few features tucked into it, and
1056 Be sure to check the manuals to make sure that \SpecialChar LyX
1057 doesn't have such-and-such
1058 feature before you decide you have to do it by hand.
1059 Moreover, there are numerous \SpecialChar LaTeX
1060 packages out there to do all sorts of things,
1061 from labels to envelopes to fancy multipage tables.
1063 \begin_inset CommandInset href
1066 target "http://www.ctan.org/"
1073 \begin_layout Standard
1074 If you do need to do some wild and fancy things within your document, be
1075 sure to check out a good \SpecialChar LaTeX
1076 book for assistance.
1077 There are a number of them listed in the bibliography of the
1084 \begin_layout Section
1086 and the \SpecialChar LaTeX
1090 \begin_layout Subsection
1091 About the \SpecialChar LaTeX
1095 \begin_layout Standard
1096 If you already know \SpecialChar LaTeX
1097 , there is no need to explain here what the preamble
1099 If you don't, the following will give you some ideas—we recommend again
1100 that you consult a \SpecialChar LaTeX
1101 book for further information.
1102 In any case, you should read the points below, because they explain what
1103 you can do and what you don't need to do in the \SpecialChar LaTeX
1104 preamble of a \SpecialChar LyX
1108 \begin_layout Standard
1109 The \SpecialChar LaTeX
1110 preamble comes at the very beginning of a document,
1118 \begin_layout Itemize
1119 Declare the document class.
1121 \begin_inset Newline newline
1125 already does this for you.
1126 If you're a seasoned \SpecialChar LaTeX
1127 -nician, and you have a custom document class you
1128 want to use, check out the
1130 Customization Manual
1132 for information on how to make \SpecialChar LyX
1136 \begin_layout Itemize
1137 Declare the usage of packages.
1139 \begin_inset Newline newline
1143 packages provide special commands, which are only available within a document
1144 when the package has been declared in the preamble.
1145 In addition to providing special commands, the inclusion of a package can
1146 change the document.
1147 For example, the package
1148 \begin_inset Flex Code
1151 \begin_layout Plain Layout
1157 forces all paragraphs to be indented.
1158 There are other packages for labels, envelopes, margins, etc.
1162 \begin_layout Itemize
1163 Set counters, variables, lengths and widths.
1165 \begin_inset Newline newline
1168 There are several \SpecialChar LaTeX
1169 counters and variables that
1173 be set globally from within the preamble in order to have the desired effect.
1174 (There are variables that you can set and reset inside the document, too.)
1175 Margins are a good example of something that must be set in the preamble.
1176 Another example is the label format for lists.
1177 You can actually set these just about anywhere, but it's best to do it
1178 just once, inside the preamble.
1181 \begin_layout Itemize
1182 Declare user defined commands (with
1183 \begin_inset Flex Code
1186 \begin_layout Plain Layout
1195 \begin_inset Flex Code
1198 \begin_layout Plain Layout
1207 \begin_inset Newline newline
1210 These are abbreviations for \SpecialChar LaTeX
1211 commands which appear very often inside a document.
1212 Although the preamble is a good place to declare such commands, they
1216 be declared anywhere (before they are used for the first time, of course).
1217 This can be useful if there is a lot of raw \SpecialChar LaTeX
1218 code in your document, which
1219 normally should not be the case.
1222 \begin_layout Standard
1224 adds its own set of definitions to the preamble of the
1225 \begin_inset Flex Code
1228 \begin_layout Plain Layout
1235 This makes \SpecialChar LaTeX
1236 files generated by \SpecialChar LyX
1240 \begin_layout Subsection
1241 Changing the Preamble
1244 \begin_layout Standard
1245 The commands which \SpecialChar LyX
1246 adds to the preamble of a \SpecialChar LaTeX
1247 file are fixed; you can't
1248 change them without patching \SpecialChar LyX
1250 You can, however, add your own stuff to the preamble by selecting
1251 \begin_inset Flex Noun
1254 \begin_layout Plain Layout
1257 \begin_inset space ~
1266 \begin_inset Flex Noun
1269 \begin_layout Plain Layout
1270 Document\SpecialChar menuseparator
1278 adds anything in the
1279 \begin_inset Flex Noun
1282 \begin_layout Plain Layout
1288 dialog to its own built-in preamble.
1289 Before adding your own declarations in the preamble, you should make sure
1290 that \SpecialChar LyX
1291 doesn't already support what you want to do.
1292 (Remember what we said about reinventing the wheel?) Also,
1294 make sure your preamble code is correct
1298 doesn't check it for you.
1299 If there is an error, you're likely to get an error like
1300 \begin_inset Quotes eld
1304 \begin_inset Flex Code
1307 \begin_layout Plain Layout
1316 \begin_inset Quotes erd
1320 If you see this error, check your preamble.
1323 \begin_layout Subsection
1327 \begin_layout Standard
1328 Here are some examples of what you can add to a preamble, and what they
1332 \begin_layout Subsubsection
1336 \begin_layout Standard
1337 There are two variables under \SpecialChar LaTeX
1338 that control page position:
1339 \begin_inset Flex Code
1342 \begin_layout Plain Layout
1351 \begin_inset Flex Code
1354 \begin_layout Plain Layout
1363 Their names should be self-explanatory.
1364 These variables are useful if you think for a moment about computer labels.
1365 Sometimes, the size of a print medium and the area of the medium that you
1366 can actually print on aren't the same.
1368 \begin_inset Flex Code
1371 \begin_layout Plain Layout
1380 \begin_inset Flex Code
1383 \begin_layout Plain Layout
1394 \begin_layout Standard
1395 The default values for
1396 \begin_inset Flex Code
1399 \begin_layout Plain Layout
1408 \begin_inset Flex Code
1411 \begin_layout Plain Layout
1420 \begin_inset space \thinspace{}
1424 \begin_inset space \thinspace{}
1428 \begin_inset space \space{}
1431 the page isn't shifted.
1432 Unfortunately, some DVI drivers always seem to shift the page.
1433 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1434 If you're using \SpecialChar LyX
1435 on a system that you don't personally maintain, and your
1436 sysadmin is a doofus,
1437 \begin_inset Flex Code
1440 \begin_layout Plain Layout
1449 \begin_inset Flex Code
1452 \begin_layout Plain Layout
1461 Suppose your left and top margins are always 0.5
1462 \begin_inset space \thinspace{}
1466 You can add this to the preamble:
1469 \begin_layout LyX-Code
1477 \begin_layout LyX-Code
1485 \begin_layout Standard
1486 and your margins should now be correct.
1489 \begin_layout Subsubsection
1493 \begin_layout Standard
1494 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1495 There's a rather nice package, available at your nearest CTAN archive,
1496 for printing sheets of labels:
1497 \begin_inset Flex Code
1500 \begin_layout Plain Layout
1507 Now, your system may not have this package installed by default.
1508 We leave that up to you to check.
1509 You'll also want to read the documentation for it; we're not going to do
1511 Since this is an example, however, we'll give you an example of how you
1515 \begin_layout Standard
1516 First, make sure you're using the
1517 \begin_inset Flex Code
1520 \begin_layout Plain Layout
1527 Next, you need to put the following in your preamble:
1530 \begin_layout LyX-Code
1536 \begin_layout LyX-Code
1542 \begin_layout LyX-Code
1548 \begin_layout LyX-Code
1554 \begin_layout LyX-Code
1560 \begin_layout LyX-Code
1566 \begin_layout LyX-Code
1572 \begin_layout Standard
1573 This sets things up for Avery label sheets, stock #5360.
1574 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1577 \begin_inset Flex Code
1580 \begin_layout Plain Layout
1589 \begin_inset Flex Code
1592 \begin_layout Plain Layout
1600 around each label text.
1601 This and other special features of
1602 \begin_inset Flex Code
1605 \begin_layout Plain Layout
1611 are explained in its documentation.
1614 \begin_layout Standard
1615 Someday, someone may write a \SpecialChar LyX
1616 layout file to support this package directly.
1617 Maybe that someone is you.
1620 \begin_layout Subsubsection
1621 Example #3: Paragraph Indentation
1624 \begin_layout Standard
1625 Americans are trained to indent the first line of
1630 As with all of their other weird quirks, most Americans will whine and
1631 moan until they can have their way and indent the first line of all paragraphs.
1640 \begin_layout Standard
1641 Of course, this behavior isn't standard typography.
1642 In books, you typically only indent the first line of a paragraph
1646 it follows another one.
1647 The idea behind indenting the first line of a paragraph is to distinguish
1648 neighboring paragraphs from one another.
1649 If there is no previous paragraph—for example, if it follows a figure or
1650 is the first paragraph in a section—then there is no need for indentation.
1654 \begin_layout Standard
1655 If you're a typical American (we're still joking!), though, you don't care
1656 about such esoteric things; you want your indentation! Add this to the
1660 \begin_layout LyX-Code
1663 usepackage{indentfirst}
1666 \begin_layout Standard
1667 If your \SpecialChar TeX
1668 distribution isn't braindead, you'll have this package, and all
1669 of your paragraphs will get the indentation the Founding Fathers intended
1673 \begin_layout Subsubsection
1674 Example #4: This Document
1677 \begin_layout Standard
1678 You can also check out the preamble of this document to get an idea of some
1679 of the advanced things you can do.
1682 \begin_layout Section
1684 and \SpecialChar LaTeX
1688 \begin_layout Standard
1689 When \SpecialChar LyX
1690 calls \SpecialChar LaTeX
1691 , it tells \SpecialChar LaTeX
1692 to blithely ignore any errors and keep going.
1693 It then uses the logfile from the \SpecialChar LaTeX
1694 run to do a post-mortem.
1695 After analyzing the logfile, \SpecialChar LyX
1696 displays a dialog listing the errors.
1697 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1699 where the error occurred.
1703 \begin_layout Plain Layout
1705 Analyzing the logfile is a tough job, and \SpecialChar LyX
1706 doesn't always go to the right
1708 There are also cases where \SpecialChar LaTeX
1709 reports the error on one line, but the actual
1711 This is not unlike forgetting a closing brace in a program: You'll get
1712 an error, but only later.
1720 \begin_layout Standard
1721 Some folks also like to look at the log file directly: It is available from
1723 \begin_inset Flex Noun
1726 \begin_layout Plain Layout
1729 \SpecialChar menuseparator
1733 \begin_inset space ~
1742 There are some fairly common error messages and warnings.
1743 We'll cover those here.
1744 You should look at a good \SpecialChar LaTeX
1745 book for a complete listing.
1748 \begin_layout Itemize
1749 \begin_inset Flex Code
1752 \begin_layout Plain Layout
1760 \begin_inset Newline newline
1763 Anything beginning with these words is a warning message for the purpose
1765 \begin_inset Quotes eld
1769 \begin_inset Quotes erd
1772 the \SpecialChar LaTeX
1774 You'll get messages like this if you added or changed cross-references
1775 or bibliography entries, in which case, \SpecialChar LaTeX
1776 is trying to tell you that you
1777 need to make another run.
1778 You can by-and-large ignore these.
1781 \begin_layout Itemize
1782 \begin_inset Flex Code
1785 \begin_layout Plain Layout
1793 \begin_inset Newline newline
1796 Another warning message, this time about fonts which \SpecialChar LaTeX
1798 The rest of the message will often say something about a replacement font
1799 that \SpecialChar LaTeX
1801 You can safely ignore these, too.
1804 \begin_layout Itemize
1805 \begin_inset Flex Code
1808 \begin_layout Plain Layout
1817 \begin_inset Newline newline
1826 They are warnings about lines that were too long and run past the right
1828 Almost always, this is unnoticeable in the final output.
1829 (It can be just a point or two.) Or, only one or two characters extend past
1832 seems to generate at least one of these messages for just about any document
1834 \begin_inset Newline newline
1837 You can ignore these messages.
1838 Your eyes will tell you if there's a problem with something that's too
1839 wide; just look at the output.
1843 \begin_layout Plain Layout
1844 You can also enable the `draft' option in
1845 \begin_inset Flex Noun
1848 \begin_layout Plain Layout
1851 \SpecialChar menuseparator
1859 , and then \SpecialChar LaTeX
1860 will draw a black box in the margin of lines that are overfull.
1868 \begin_layout Itemize
1869 \begin_inset Flex Code
1872 \begin_layout Plain Layout
1881 \begin_inset Newline newline
1884 Not quite as common as its cousin.
1886 seems to like to print lines that are a bit too wide as opposed to ones
1887 that are a bit too narrow.
1888 We have no idea why.
1891 \begin_layout Itemize
1892 \begin_inset Flex Code
1895 \begin_layout Plain Layout
1904 \begin_inset Flex Code
1907 \begin_layout Plain Layout
1916 \begin_inset Newline newline
1919 Warnings about troubles breaking the page.
1920 Once again, just look at the output.
1921 Your eyes will tell you where something has gone wrong.
1924 \begin_layout Itemize
1925 \begin_inset Flex Code
1928 \begin_layout Plain Layout
1931 \begin_inset Quotes els
1935 \begin_inset Quotes ers
1944 \begin_inset Newline newline
1948 \begin_inset Quotes eld
1952 \begin_inset Quotes erd
1955 isn't installed on this system.
1956 This usually appears because some package your document needs isn't installed.
1957 If you didn't touch the preamble or didn't use the
1958 \begin_inset Flex Code
1961 \begin_layout Plain Layout
1969 command, then one of the packages \SpecialChar LyX
1970 tried to load is missing.
1972 \begin_inset Flex Noun
1975 \begin_layout Plain Layout
1976 Help\SpecialChar menuseparator
1983 to get a list of packages that \SpecialChar LyX
1985 This file is updated whenever you reconfigure \SpecialChar LyX
1987 \begin_inset Flex Noun
1990 \begin_layout Plain Layout
1991 Tools\SpecialChar menuseparator
1997 ) and tells you which packages have been detected and what they do.
1998 \begin_inset Newline newline
2002 \begin_inset Flex Code
2005 \begin_layout Plain Layout
2013 command and the package in question isn't installed, then you'll need to
2014 install it yourself.
2017 \begin_layout Itemize
2018 \begin_inset Flex Code
2021 \begin_layout Plain Layout
2023 Error: Unknown option
2029 \begin_inset Newline newline
2032 Error messages beginning with this are trying to tell you that you specified
2033 a bad or undefined option to a package.
2034 Check the package's documentation.
2037 \begin_layout Itemize
2038 \begin_inset Flex Code
2041 \begin_layout Plain Layout
2042 Undefined control sequence
2048 \begin_inset Newline newline
2051 If you've inserted \SpecialChar LaTeX
2052 code into your document, but made a typo, you'll get
2054 You may have forgotten to load a package.
2055 In any case, this error message usually means that you used an undefined
2060 \begin_layout Standard
2061 There are other error and warning messages.
2062 Some are self-explanatory.
2063 These are usually \SpecialChar LaTeX
2065 Others are downright cryptic.
2066 These are usually \SpecialChar TeX
2067 error messages, and we really have
2071 what they mean or how to decipher them.
2075 \begin_layout Standard
2076 There's a general sequence you should follow if you get error messages:
2079 \begin_layout Enumerate
2080 Look at the \SpecialChar LaTeX
2081 code you inserted for typos.
2084 \begin_layout Enumerate
2085 If there are no typos, check that you used the command(s) correctly.
2088 \begin_layout Enumerate
2089 If you get a bunch of error boxes piled up at the very top of the document—and
2090 especially if you see a
2091 \begin_inset Quotes eld
2095 \begin_inset Flex Code
2098 \begin_layout Plain Layout
2107 \begin_inset Quotes erd
2110 error—it means that there are errors in the preamble.
2111 Start debugging your preamble.
2114 \begin_layout Enumerate
2115 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2117 document, the first suspect is your \SpecialChar LaTeX
2118 distribution itself.
2119 Check for missing packages and install them.
2122 \begin_layout Enumerate
2123 Okay, so there are no missing packages.
2124 Did you use any of the fine-tuning options in \SpecialChar LyX
2125 ? Specifically, did you
2129 any of them, like trying to manually insert lots of
2130 \begin_inset Flex Code
2133 \begin_layout Plain Layout
2135 \begin_inset space ~
2144 \begin_inset Flex Code
2147 \begin_layout Plain Layout
2154 \begin_inset Flex Code
2157 \begin_layout Plain Layout
2163 ? Did you try to kludge something together with these instead of using the
2164 appropriate paragraph environment?
2167 \begin_layout Enumerate
2168 All right, you didn't use any of the fine-tuning options, you played by
2170 Did you try to pull a fancy maneuver? Did you do something funky inside
2171 a table or an equation, like inserting a graphic into a table cell?
2174 \begin_layout Enumerate
2175 Do you have long sections of text where \SpecialChar LaTeX
2176 cannot find a place to break a
2177 line? By default, \SpecialChar LaTeX
2178 is rather strict about how much extra inter-word spacing
2179 it will add in order to break a line.
2180 Preferably, you should rework the paragraph to avoid the problem.
2183 \begin_layout Enumerate
2184 Did you go overboard with the nesting? \SpecialChar LyX
2185 (currently) doesn't check to make
2186 sure you're in the limits for nesting environments.
2187 If you nested a bunch of environments to the
2188 \begin_inset Formula $17^{\mathrm{th}}$
2191 level, that's the problem.
2192 (The limit in \SpecialChar LaTeX
2196 \begin_layout Enumerate
2197 Okay, you didn't get any error messages, but your output looks awful.
2198 If you have a table or figure that's too wide or long for the page, you
2200 \begin_inset Separator parbreak
2207 \begin_layout Enumerate
2208 rescale the figure so it fits.
2211 \begin_layout Enumerate
2212 trim down the table so it fits.
2216 \begin_layout Enumerate
2217 If something else is wrong with the output, and you didn't try to pull anything
2218 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2221 \begin_layout Standard
2222 If all this doesn't help—well, then
2226 you might have found a bug in \SpecialChar LyX
2231 \begin_layout Chapter
2235 \begin_layout Section
2236 Customizing Bibliographies with Bib\SpecialChar TeX
2240 \begin_layout Standard
2241 The most basic information about how to use Bib\SpecialChar TeX
2242 with \SpecialChar LyX
2246 Bibliography databases (Bib\SpecialChar TeX
2254 The following subsections explain special bibliography features supported
2259 \begin_layout Subsection
2260 Alternative Citation Styles
2263 \begin_layout Standard
2264 Standard Bib\SpecialChar TeX
2266 \begin_inset space \thinspace{}
2270 \begin_inset space \space{}
2274 \begin_inset Quotes eld
2278 \begin_inset Quotes erd
2281 ) to refer to a cited work.
2282 However, in many scientific disciplines, other citation styles are in use.
2283 The most common one is the author-year style (e.
2284 \begin_inset space \thinspace{}
2288 \begin_inset space \space{}
2292 \begin_inset Quotes eld
2296 \begin_inset Quotes erd
2301 supports two packages that provide this style,
2302 \begin_inset Flex Code
2305 \begin_layout Plain Layout
2312 \begin_inset Flex Code
2315 \begin_layout Plain Layout
2322 Both packages have their pros and cons, which cannot be listed in detail.
2323 If you only want to have simple author-year (or author-numerical) style,
2324 or if you want to use one of the countless style files for
2325 \begin_inset Flex Code
2328 \begin_layout Plain Layout
2334 , then the established
2335 \begin_inset Flex Code
2338 \begin_layout Plain Layout
2344 package is probably your choice.
2345 If you need special features like short title references, ibidem etc., you
2347 \begin_inset Flex Code
2350 \begin_layout Plain Layout
2359 \begin_layout Standard
2360 The handling of both packages in \SpecialChar LyX
2361 is basically the same.
2363 \begin_inset Flex Noun
2366 \begin_layout Plain Layout
2367 Document\SpecialChar menuseparator
2374 \begin_inset Flex Noun
2377 \begin_layout Plain Layout
2384 \begin_inset Flex Noun
2387 \begin_layout Plain Layout
2394 \begin_inset Flex Noun
2397 \begin_layout Plain Layout
2404 With both packages, you will get some extra features in the citation dialog
2405 and you can select the style of the reference (
2406 \begin_inset Quotes eld
2410 \begin_inset Quotes erd
2414 \begin_inset Quotes eld
2418 \begin_inset Quotes erd
2422 \begin_inset Quotes eld
2426 \begin_inset Quotes erd
2430 \begin_inset Quotes eld
2434 \begin_inset Quotes erd
2438 Note that both packages need specifically designed style files.
2439 They both ship their own, but there are lots of additional style files,
2440 and there is even an interactive style file builder
2444 \begin_layout Plain Layout
2446 \begin_inset Flex URL
2449 \begin_layout Plain Layout
2451 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2462 \begin_inset Flex Code
2465 \begin_layout Plain Layout
2474 \begin_layout Subsection
2475 Sectioned Bibliographies
2478 \begin_layout Standard
2479 Sometimes you might need to divide your bibliography into several sections.
2480 If you are for instance a historian, the possibility to separate sources
2481 and scientific works is most likely a
2482 \begin_inset Quotes eld
2486 \begin_inset Quotes erd
2490 Unfortunately, Bib\SpecialChar TeX
2491 itself does not allow you to do this.
2492 But with the help of some \SpecialChar LaTeX
2493 packages, Bib\SpecialChar TeX
2494 can be extended to fit your needs.
2497 \begin_layout Standard
2499 provides native support for one of these packages,
2507 \begin_layout Plain Layout
2509 \begin_inset Flex URL
2512 \begin_layout Plain Layout
2514 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2524 The advantage of this package (compared to other packages like
2528 ) is that you don't need to define new citation commands.
2529 Instead, you need to prepare different bibliographic databases which include
2530 the entries for the different sections of the bibliography.
2531 For example: If you want to divide your bibliography into the sections
2533 \begin_inset Quotes eld
2537 \begin_inset Quotes erd
2541 \begin_inset Quotes eld
2545 \begin_inset Quotes erd
2548 , you first need to create two bibliographic databases, e.
2549 \begin_inset space \thinspace{}
2553 \begin_inset space \space{}
2557 \begin_inset Flex Code
2560 \begin_layout Plain Layout
2567 \begin_inset Flex Code
2570 \begin_layout Plain Layout
2580 \begin_layout Standard
2582 \begin_inset Flex Noun
2585 \begin_layout Plain Layout
2586 Document\SpecialChar menuseparator
2593 \begin_inset Flex Noun
2596 \begin_layout Plain Layout
2603 \begin_inset Flex Noun
2606 \begin_layout Plain Layout
2607 Sectioned bibliography
2613 Now you can insert multiple Bib\SpecialChar TeX
2614 bibliographies, one for each section of
2616 Returning to our example: Insert the Bib\SpecialChar TeX
2618 \begin_inset Flex Code
2621 \begin_layout Plain Layout
2627 and a second one for the database
2628 \begin_inset Flex Code
2631 \begin_layout Plain Layout
2638 You are free to use the same or different styles for each section.
2639 Additionally, you can choose if the bibliography section should contain
2641 \begin_inset Quotes eld
2644 all cited references
2645 \begin_inset Quotes erd
2648 of the specified database(s) (which is the default),
2649 \begin_inset Quotes eld
2652 all uncited references
2653 \begin_inset Quotes erd
2657 \begin_inset Quotes eld
2661 \begin_inset Quotes erd
2665 This might be useful if you would like to separate your bibliography into
2667 \begin_inset Quotes eld
2671 \begin_inset Quotes erd
2675 \begin_inset Quotes eld
2679 \begin_inset Quotes erd
2683 \begin_inset Quotes eld
2687 \begin_inset Quotes erd
2691 The titles for the sections can be added as ordinary sections or subsections.
2693 \begin_inset Flex Code
2696 \begin_layout Plain Layout
2702 removes the bibliography title, you have to manually re-add that, too (as
2703 a chapter* or section*, for instance).
2706 \begin_layout Subsection
2707 Multiple Bibliographies
2710 \begin_layout Standard
2711 Multiple bibliographies, e.
2712 \begin_inset space \thinspace{}
2716 \begin_inset space \space{}
2719 a bibliography for each section or chapter of the document, are not supported
2720 by Bib\SpecialChar TeX
2723 \begin_inset Flex Code
2726 \begin_layout Plain Layout
2732 package, which is used for the creation of sectioned bibliographies in
2734 (see the previous section), provides an easy way to solve this task, if
2735 you are willing to use some
2736 \begin_inset Flex Noun
2739 \begin_layout Plain Layout
2747 \begin_inset space ~
2751 \begin_inset CommandInset ref
2753 reference "sec:Inserting-TeX-Code"
2761 \begin_layout Plain Layout
2762 An alternative approach is to use the
2763 \begin_inset Flex Code
2766 \begin_layout Plain Layout
2773 \begin_inset Flex Code
2776 \begin_layout Plain Layout
2782 package, respectively.
2790 \begin_layout Standard
2792 \begin_inset Flex Noun
2795 \begin_layout Plain Layout
2796 Document\SpecialChar menuseparator
2803 \begin_inset Flex Noun
2806 \begin_layout Plain Layout
2813 \begin_inset Flex Noun
2816 \begin_layout Plain Layout
2817 Sectioned bibliography
2823 In the document, you have to enclose the sections, which shall contain
2824 their own bibliography (including the Bib\SpecialChar TeX
2825 bibliography itself), between
2827 \begin_inset Flex Code
2830 \begin_layout Plain Layout
2839 \begin_inset Flex Code
2842 \begin_layout Plain Layout
2850 (those commands have to be inserted as \SpecialChar TeX
2852 The bibliography will contain all references that have been cited in the
2854 \begin_inset Flex Code
2857 \begin_layout Plain Layout
2868 If you are using this approach, then every citation reference has to be
2870 \begin_inset Flex Code
2873 \begin_layout Plain Layout
2881 \begin_inset Flex Code
2884 \begin_layout Plain Layout
2893 \begin_layout Section
2897 \begin_layout Subsection
2901 \begin_layout Standard
2902 When you are working on a large file with many sections, it is often convenient
2903 to break up the document into several files, or perhaps you have something
2904 where a table may change from time to time, but the preceding text does
2906 In these cases, you should seriously consider using multipart documents.
2907 For example, scientific papers often have five major sections: the introduction
2908 , observations, results, discussion, and conclusion.
2909 Each of these could be its own separate \SpecialChar LyX
2911 \begin_inset Quotes eld
2915 \begin_inset Quotes erd
2918 file which contains the title, authors, abstract, references, etc., plus
2919 the five included files.
2920 It is important to note that each of these files is a full \SpecialChar LyX
2922 can be formatted and printed on its own, as well as included in a master
2924 Each of these files must have the same document class, however—don't attempt
2925 to mix book classes with article classes.
2926 You may also include \SpecialChar LaTeX
2927 files; however, these files must not have their own
2929 \begin_inset space \thinspace{}
2933 \begin_inset space \space{}
2936 everything up to and including the
2937 \begin_inset Flex Code
2940 \begin_layout Plain Layout
2949 \begin_inset Flex Code
2952 \begin_layout Plain Layout
2960 line must be deleted) or else errors will be generated when you try to
2964 \begin_layout Standard
2966 allows you to include files quite easily with
2967 \begin_inset Flex Noun
2970 \begin_layout Plain Layout
2971 Insert\SpecialChar menuseparator
2973 \begin_inset space ~
2982 When you click on this selection a small box is inserted into the file
2983 at the current cursor location.
2984 Clicking on the box raises a dialog which allows you to select the file
2985 to be included, and the method of its inclusion.
2989 \begin_layout Standard
2990 The file selection box should by now be obvious.
2991 The three inclusion methods are
2992 \begin_inset Quotes eld
2996 \begin_inset Quotes erd
3000 \begin_inset Quotes eld
3004 \begin_inset Quotes erd
3008 \begin_inset Quotes eld
3012 \begin_inset Quotes erd
3016 The difference between
3017 \begin_inset Quotes eld
3021 \begin_inset Quotes erd
3025 \begin_inset Quotes eld
3029 \begin_inset Quotes erd
3032 is really only meaningful to \SpecialChar LaTeX
3033 perts, but the practical difference is that
3035 \begin_inset Quotes eld
3039 \begin_inset Quotes erd
3042 are typeset beginning on a new page, while files that are
3043 \begin_inset Quotes eld
3047 \begin_inset Quotes erd
3050 are typeset starting on the current page.
3053 \begin_layout Standard
3054 Generally, the master file is converted into a full \SpecialChar LaTeX
3055 file before typesetting,
3056 while the included files are converted to \SpecialChar LaTeX
3057 files that do not have all the
3058 preamble information.
3061 \begin_layout Standard
3063 \begin_inset Quotes eld
3067 \begin_inset Quotes erd
3070 included file allows you to include a file typeset exactly as it appears
3072 \begin_inset space \thinspace{}
3076 \begin_inset space \space{}
3080 \begin_inset Flex Code
3083 \begin_layout Plain Layout
3089 mode, with the characters set in a fixed-width typewriter font.
3090 Normally, spaces in this file are invisible, though two consecutive spaces
3091 are conserved, unlike \SpecialChar LyX
3092 's normal treatment of spaces.
3093 However, setting the
3094 \begin_inset Flex Noun
3097 \begin_layout Plain Layout
3099 \begin_inset space ~
3103 \begin_inset space ~
3107 \begin_inset space ~
3115 checkbox typesets a mark to unambiguously define the presence of a space.
3119 \begin_layout Subsection
3120 Cross-References Between Files
3123 \begin_layout Standard
3124 \begin_inset Box Shadowbox
3134 height_special "totalheight"
3139 backgroundcolor "none"
3142 \begin_layout Plain Layout
3143 This section is somewhat out of date.
3144 Need to describe default master documents and how children are opened when
3154 \begin_layout Standard
3155 It is possible to set up cross-references between the different files.
3156 First, open all the files in question: let's call them A and B in a two
3157 file example, where B is included in A.
3158 Let's say you insert a label in A, then want to reference it in B.
3159 Open the cross-reference dialog whilst in document B, and you can select
3161 \begin_inset Quotes eld
3165 \begin_inset Quotes erd
3171 \begin_layout Subsection
3172 Bibliography Lists in all Subdocuments
3175 \begin_layout Standard
3176 \begin_inset Box Frameless
3186 height_special "totalheight"
3191 backgroundcolor "none"
3194 \begin_layout Plain Layout
3195 This section also needs updating.
3196 There is now material about this on the wiki, and it could be copied here.
3204 \begin_layout Standard
3205 Copy the bibliography list with all entries to all subdocuments and transform
3207 This way \SpecialChar LyX
3209 \begin_inset Flex Code
3212 \begin_layout Plain Layout
3218 -files and you can easily insert references without making the bibliography
3222 \begin_layout Standard
3223 As the bibliography list is in a comment, \SpecialChar LaTeX
3224 won't use it and the references
3225 will look like this: [?], instead of like this: [1].
3226 One solution is to use the \SpecialChar LaTeX
3228 \begin_inset Flex Code
3231 \begin_layout Plain Layout
3237 that will only include comments by processing the files separately.
3238 To do this, add in the \SpecialChar LaTeX
3239 preamble of every subdocument the following:
3242 \begin_layout LyX-Code
3248 \begin_layout LyX-Code
3251 includecomment{comment}
3254 \begin_layout Standard
3256 \begin_inset Flex URL
3259 \begin_layout Plain Layout
3261 http://wiki.lyx.org/FAQ/Unsorted#toc31
3269 \begin_layout Section
3274 \begin_layout Standard
3275 Users sometimes need to be able to
3276 \begin_inset Quotes eld
3280 \begin_inset Quotes erd
3284 file together with all the images (and other files) on which it depends,
3285 either for sending to a publisher or for sharing with a co-author.
3287 2.0 includes a Python script (
3288 \begin_inset Flex Code
3291 \begin_layout Plain Layout
3297 ) that automates this process.
3298 To use it, you must have either the
3299 \begin_inset Flex Code
3302 \begin_layout Plain Layout
3309 \begin_inset Flex Code
3312 \begin_layout Plain Layout
3318 python modules installed on your system.
3319 By default, the script prefers the
3320 \begin_inset Flex Code
3323 \begin_layout Plain Layout
3330 \begin_inset Flex Code
3333 \begin_layout Plain Layout
3339 format on Unix-like systems and the
3340 \begin_inset Flex Code
3343 \begin_layout Plain Layout
3352 \begin_layout Standard
3354 's configuration process will set the script up to export a `\SpecialChar LyX
3356 and this format will then be available under
3357 \begin_inset Flex Code
3360 \begin_layout Plain Layout
3361 File\SpecialChar menuseparator
3370 \begin_layout Standard
3371 Independently of the platform, the generation of a particular archive format
3372 can be forced by adding either the
3373 \begin_inset Flex Code
3376 \begin_layout Plain Layout
3383 \begin_inset Flex Code
3386 \begin_layout Plain Layout
3393 \begin_inset Flex Code
3396 \begin_layout Plain Layout
3403 \begin_inset Flex Code
3406 \begin_layout Plain Layout
3412 format) switch to the
3413 \begin_inset Flex Code
3416 \begin_layout Plain Layout
3418 \SpecialChar menuseparator
3426 \begin_inset Flex Code
3429 \begin_layout Plain Layout
3430 Tools\SpecialChar menuseparator
3431 Preferences\SpecialChar menuseparator
3432 File Handling\SpecialChar menuseparator
3439 (Make sure you add the switch after the script name, not before it.)
3442 \begin_layout Section
3443 Fancy Headers and Footers
3446 \begin_layout Standard
3447 The default page layout is rather plain; for an
3448 \begin_inset Flex Code
3451 \begin_layout Plain Layout
3457 document class, all you get is a centered page number at the bottom of
3459 This document uses KOMA-script's book class, so it appears to be a bit
3461 But to really put on a show, you need to set the document page style to
3463 \begin_inset Quotes eld
3467 \begin_inset Quotes erd
3470 , as mentioned in the
3475 This section describes the \SpecialChar LaTeX
3476 code you need to insert in your \SpecialChar LaTeX
3478 order to get the desired effects.
3481 \begin_layout Standard
3482 For more information on fancy headers, see the
3483 \begin_inset Flex Code
3486 \begin_layout Plain Layout
3492 package documentation.
3494 \begin_inset Flex URL
3497 \begin_layout Plain Layout
3499 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3507 \begin_layout Standard
3508 The page header is divided into three fields, not surprisingly labeled
3509 \begin_inset Quotes eld
3513 \begin_inset Quotes erd
3517 \begin_inset Quotes eld
3521 \begin_inset Quotes erd
3525 \begin_inset Quotes eld
3529 \begin_inset Quotes erd
3533 The footer is also divided into these three fields.
3534 The \SpecialChar LaTeX
3535 commands to set these fields in the simplest manner are
3536 \begin_inset Flex Code
3539 \begin_layout Plain Layout
3548 \begin_inset Flex Code
3551 \begin_layout Plain Layout
3560 \begin_inset Flex Code
3563 \begin_layout Plain Layout
3572 \begin_inset Flex Code
3575 \begin_layout Plain Layout
3584 Suppose you wish to put your name in the upper left hand corner of each
3586 Simply insert the following command in the preamble:
3589 \begin_layout Standard
3598 \begin_layout Standard
3599 You will now see your name in the upper left.
3600 If a field has a default entry that you would like to get rid of (often
3601 the page number appears in the central footer) simply include a command
3602 with a blank argument, e.
3603 \begin_inset space \thinspace{}
3609 \begin_layout Standard
3617 \begin_layout Standard
3618 Let's get really fancy: lets put the section number with the word
3619 \begin_inset Quotes eld
3623 \begin_inset Quotes erd
3627 \begin_inset space \thinspace{}
3631 \begin_inset space \space{}
3634 Section 3) in the upper left, the page number (e.
3635 \begin_inset space \thinspace{}
3639 \begin_inset space \space{}
3642 Page 4) in the upper right, your name in the lower left, and the date in
3644 The following commands should now appear in the preamble:
3647 \begin_layout Standard
3657 \begin_layout Standard
3665 \begin_layout Standard
3675 \begin_layout Standard
3684 \begin_layout Standard
3692 \begin_layout Standard
3702 \begin_layout Standard
3704 \begin_inset Flex Code
3707 \begin_layout Plain Layout
3716 \begin_inset Flex Code
3719 \begin_layout Plain Layout
3727 access \SpecialChar LaTeX
3728 's section and page counters, and so print out the current section
3731 \begin_inset Flex Code
3734 \begin_layout Plain Layout
3742 simply prints out today's date.
3745 \begin_layout Standard
3746 The thicknesses of the horizontal rules drawn beneath the header and above
3747 the footer can also be modified.
3748 If you don't want one of the rules, set its thickness to 0.
3749 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3755 \begin_inset Flex Code
3758 \begin_layout Plain Layout
3763 headrulewidth}{0.4pt}
3769 \begin_inset Flex Code
3772 \begin_layout Plain Layout
3777 footrulewidth}{0.4pt}
3782 to set the thicknesses.
3785 \begin_layout Standard
3786 You can switch the header/footer settings on and off for individual pages
3788 \begin_inset Flex Code
3791 \begin_layout Plain Layout
3794 thispagestyle{empty}
3800 \begin_inset Flex Code
3803 \begin_layout Plain Layout
3806 thispagestyle{plain}
3812 \begin_inset Flex Code
3815 \begin_layout Plain Layout
3818 thispagestyle{fancy}
3824 Simply insert them in the text on the page you want changed and mark them
3827 In fact, title pages are marked as plain by default, while following pages
3828 are marked fancy when using the global fancy setting.
3831 \begin_layout Standard
3832 As a final example, it is possible to include an image in the header or
3834 Suppose you want to put a company logo in the upper lefthand corner.
3835 You might try something like
3838 \begin_layout Standard
3847 includegraphics{logo.eps}}}
3850 \begin_layout Standard
3852 (you may need to preface this with
3853 \begin_inset Flex Code
3856 \begin_layout Plain Layout
3860 usepackage{graphics}
3865 if you don't include graphics elsewhere in your document).
3868 \begin_layout Section
3869 Itemize Bullet Selection
3870 \begin_inset CommandInset label
3879 \begin_layout Standard
3885 \begin_layout Subsection
3889 \begin_layout Standard
3891 provides 216 bullet shapes that can be accessed from a simple dialog.
3892 Using this dialog you can easily specify what bullet shape to use at each
3893 level of an itemized list.
3894 These settings are document-wide so you won't be able to specify different
3895 sets of bullets for different paragraphs.
3899 \begin_layout Plain Layout
3900 Well, actually you can but you'll have to do it by hand.
3908 \begin_layout Subsection
3912 \begin_layout Standard
3913 Open the dialog by selecting the
3914 \begin_inset Flex Noun
3917 \begin_layout Plain Layout
3918 Document\SpecialChar menuseparator
3924 menu item and then select the
3925 \begin_inset Flex Noun
3928 \begin_layout Plain Layout
3937 \begin_layout Standard
3938 The dialog provides you with a table of bullet shapes.
3939 A column of buttons on the left of the table provides access to the six
3940 different panels of bullet shapes.
3941 The row of buttons across the top is used to select which bullet depth
3943 A text entry under the table shows the currently selected bullet shape's
3945 equivalent and this can be edited if desired.
3946 If you do modify the text you will also need to specify any needed packages
3947 in the \SpecialChar LaTeX
3951 \begin_layout Standard
3952 The six panels are divided up by the packages they require.
3953 The following table shows the mappings from button name to \SpecialChar LaTeX
3955 \begin_inset Separator parbreak
3961 \begin_layout Standard
3963 \begin_inset Tabular
3964 <lyxtabular version="3" rows="7" columns="2">
3965 <features tabularvalignment="middle">
3966 <column alignment="center" valignment="top" width="0pt">
3967 <column alignment="center" valignment="top" width="0pt">
3969 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3972 \begin_layout Plain Layout
3987 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3990 \begin_layout Plain Layout
4007 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4010 \begin_layout Plain Layout
4025 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4028 \begin_layout Plain Layout
4037 base \SpecialChar LaTeX
4045 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4048 \begin_layout Plain Layout
4063 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4066 \begin_layout Plain Layout
4083 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4086 \begin_layout Plain Layout
4101 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4104 \begin_layout Plain Layout
4121 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4124 \begin_layout Plain Layout
4139 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4142 \begin_layout Plain Layout
4159 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4162 \begin_layout Plain Layout
4177 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4180 \begin_layout Plain Layout
4197 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4200 \begin_layout Plain Layout
4215 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4218 \begin_layout Plain Layout
4241 \begin_layout Standard
4243 doesn't stop you using bullets from packages you don't have.
4244 If you get errors from \SpecialChar LaTeX
4245 when you try to view or print the file, then it
4246 is likely you are missing a package.
4250 \begin_layout Plain Layout
4252 doesn't restrict your use since you may be editing locally and exporting
4261 \begin_layout Subsection
4265 \begin_layout Standard
4266 Select which bullet depth you want to change then select the bullet shape
4268 Any changes will not be visible in \SpecialChar LyX
4269 , but are visible when viewing the document.
4272 \begin_layout Standard
4273 You can reset a bullet shape to the default simply by clicking your right
4274 mouse button on the appropriate bullet depth button.
4278 \begin_layout Plain Layout
4283 want to have multiple sets of paragraphs with different sets of bullets
4284 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4286 The bullet selection dialog can help though because it provides you with
4287 the \SpecialChar LaTeX
4288 code for a wide range of bullet shapes.
4289 To make your own custom paragraphs you have the following options:
4292 \begin_layout Plain Layout
4296 \begin_layout Plain Layout
4312 \begin_layout Plain Layout
4316 \begin_layout Plain Layout
4338 \begin_layout Itemize
4339 Use the \SpecialChar LaTeX
4341 \begin_inset Flex Code
4344 \begin_layout Plain Layout
4352 to specify a new bullet shape for a given depth.
4353 You'll also need to save the current bullet shape so you can restore it
4355 In this itemized list the following \SpecialChar LaTeX
4356 code was used to change the bullet
4357 used for the first depth.
4358 \begin_inset Separator parbreak
4365 \begin_layout LyX-Code
4375 \begin_layout LyX-Code
4392 \begin_layout Itemize
4393 Note that the itemize depth is specified in Roman numerals as part of the
4403 \begin_layout Itemize
4407 \begin_layout Plain Layout
4420 Specify each individual entry by starting each item with the bullet shape
4421 enclosed in square brackets and set as
4422 \begin_inset Flex Noun
4425 \begin_layout Plain Layout
4433 For example, this item was started with
4434 \begin_inset Flex Code
4437 \begin_layout Plain Layout
4452 \begin_layout Plain Layout
4456 \begin_layout Plain Layout
4472 \begin_layout Plain Layout
4473 You'll also need to revert the labelitem back to its previous setting for
4474 the global bullet shape settings to remain in effect.
4475 The way used here was:
4478 \begin_layout LyX-Code
4493 \begin_layout Chapter
4495 and the World Wide Web
4498 \begin_layout Standard
4500 has long supported the export of documents to various web-friendly formats,
4502 Before verson 2.0, however, HTML export was always accomplished by the use
4503 of external converters.
4507 \begin_layout Plain Layout
4508 For details on the use of external converters with \SpecialChar LyX
4513 section of the Customization manual.
4518 These fall into two large groups: there are converters that use \SpecialChar LaTeX
4520 intermediate format, such as
4521 \begin_inset Flex Code
4524 \begin_layout Plain Layout
4531 \begin_inset Flex Code
4534 \begin_layout Plain Layout
4541 \begin_inset Flex Code
4544 \begin_layout Plain Layout
4550 , relying upon \SpecialChar LyX
4551 to produce the \SpecialChar LaTeX
4552 ; and there is a converter that works directly
4555 \begin_inset Flex Code
4558 \begin_layout Plain Layout
4566 All of these have different advantages and disadvantages.
4570 \begin_layout Standard
4571 The \SpecialChar LaTeX
4572 -based converters have the advantage that, in principle, they know everythin
4573 g about the exported document that \SpecialChar LaTeX
4575 Such converters do not care, for example, if a certain block of code was
4576 produced by \SpecialChar LyX
4577 or was Evil Red Text.
4578 These converters know about
4579 \begin_inset Flex Code
4582 \begin_layout Plain Layout
4588 files, counters, and references, and can often make use of the
4589 \begin_inset Flex Code
4592 \begin_layout Plain Layout
4598 files generated by Bib\SpecialChar TeX
4600 On the other hand, \SpecialChar LaTeX
4601 is a very hard language to parse—it is sometimes said
4602 that only \SpecialChar TeX
4603 itself understands \SpecialChar TeX
4604 —and \SpecialChar LaTeX
4605 -based converters will often choke on
4606 what seem to be quite simple constructs; complex ones can throw them completely
4607 , and as of this writing, for example, the
4611 manual will not export with
4612 \begin_inset Flex Code
4615 \begin_layout Plain Layout
4621 , though the others will.
4622 The other issue concerns how math is handled.
4623 These converters typically convert the formulae into little pictures that
4624 are then linked from the HTML document.
4625 Since these are actually generated by \SpecialChar LaTeX
4626 , they are accurate.
4627 But they do not scale well, and just getting them to look as if they are
4628 actually meant to be in your document—so that the font sizes seem to be
4629 roughly the same—can be a challenge.
4632 \begin_layout Standard
4634 \begin_inset Flex Code
4637 \begin_layout Plain Layout
4645 \begin_inset CommandInset href
4647 name "http://elyxer.nongnu.org/"
4648 target "http://elyxer.nongnu.org/"
4652 ) solves some of these problems.
4653 In particular, the formulae it produces scale perfectly, since it renders
4654 math using a combination of HTML and CSS rather than converting the formulae
4656 But even moderately complex formula are rendered less well than with
4657 \begin_inset Flex Code
4660 \begin_layout Plain Layout
4666 ; this reflects the limitations of HTML.
4670 \begin_layout Plain Layout
4672 \begin_inset Flex Code
4675 \begin_layout Plain Layout
4682 can also use jsMath and MathJax for equations, but this setting is only
4683 available globally and requires one to have access to a server that runs
4689 More importantly (as of version 1.1.1, at least),
4690 \begin_inset Flex Code
4693 \begin_layout Plain Layout
4700 has limited support for math macros and no support for user-defined paragraph
4701 or character styles.
4702 These limitations make
4703 \begin_inset Flex Code
4706 \begin_layout Plain Layout
4713 unsuitable for many of the documents \SpecialChar LyX
4715 In principle, of course, these problems could be solved, but the \SpecialChar LyX
4717 have decided to follow a different path and have made \SpecialChar LyX
4719 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
4720 , DocBook, and plaintext.
4723 \begin_layout Standard
4724 As of this writing, XHTML output remains under development and should probably
4726 \begin_inset Quotes eld
4730 \begin_inset Quotes erd
4737 \begin_layout Plain Layout
4739 \begin_inset Flex Code
4742 \begin_layout Plain Layout
4743 development/HTML.notes
4748 , which can be found in the \SpecialChar LyX
4750 \begin_inset CommandInset href
4752 name "accessed online"
4753 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
4757 , usually contains up-to-date information about the state of XHTML output.
4758 See also the list of XHTML bugs on
4759 \begin_inset CommandInset href
4761 name "the bug tracker"
4762 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"
4771 Still, the developers have chosen this approach because it has several
4772 potential advantages over the other two.
4775 \begin_layout Standard
4776 These advantages are primarily due to the fact that the XHTML output routines,
4777 since they are part of \SpecialChar LyX
4778 , know everything \SpecialChar LyX
4779 knows about the document being
4784 \begin_layout Plain Layout
4785 Another advantage is that, since these routines are internal to \SpecialChar LyX
4787 immune to changes in \SpecialChar LyX
4788 's file format, or to changes in the semantics of
4794 So they know about the table of contents (as displayed in the outline),
4795 about the counters associated with different paragraph styles, and about
4796 user-defined styles.
4797 The XHTML output routines know what \SpecialChar LyX
4798 knows about internationalization,
4799 too, so they will output
4800 \begin_inset Quotes eld
4804 \begin_inset Quotes erd
4808 \begin_inset Quotes eld
4816 \begin_inset Quotes erd
4819 , depending upon the language in effect at the time.
4823 \begin_layout Standard
4824 Quite generally, the output routines know what \SpecialChar LyX
4825 knows about document layout,
4826 that is, about how the document is to be rendered on screen.
4827 We use this information when we output the document as XHTML.
4828 In particular, \SpecialChar LyX
4833 generates CSS style information corresponding to the layout information
4834 it uses to render the document on screen: if section headings are supposed
4835 to be sans-serif and bold as seen in \SpecialChar LyX
4836 , then (by default) they will be sans-seri
4837 f and bold when viewed in a web browser, too.
4838 And this is true not just for pre-defined styles, like Section, but for
4839 any style, including user-defined styles.
4840 Indeed, the XHTML output routines make no distinction between user-defined
4841 paragraph and character styles and \SpecialChar LyX
4842 's own pre-defined styles: in each case,
4843 everything \SpecialChar LyX
4844 knows about the styles is contained in the layout files.
4845 And much the same is true as regards pre-defined textual insets, such as
4846 footnotes, and various custom insets.
4850 \begin_layout Standard
4851 The result is that XHTML output can be customized and extended in exactly
4852 the same way \SpecialChar LaTeX
4853 output can be customized and extended: through layout files
4855 See chapter five of the
4859 manual for the details.
4862 \begin_layout Standard
4863 The remainder of this chapter contains more detailed information on XHTML
4864 output, its limitations, and ways to work around those limitations.
4867 \begin_layout Section
4868 Math Output in XHTML
4871 \begin_layout Standard
4873 offers four choices for how math is rendered.
4874 These have various advantages and disadvantages:
4877 \begin_layout Itemize
4879 \begin_inset Newline newline
4882 MathML is a dialect of XML designed specifically for mathematics on the
4883 web, and it typically renders very well in browsers that support it.
4884 The disadvantage is that not all browsers support MathML, and support is
4885 not complete even in the Gecko-based browsers, such as Firefox.
4886 \begin_inset Newline newline
4890 is unable to render a formula as MathML—for example, if the formula
4892 \begin_inset Flex Code
4895 \begin_layout Plain Layout
4901 package or ERT—then it will instead output the formula as an image.
4905 \begin_layout Itemize
4907 \begin_inset Newline newline
4911 \begin_inset Flex Code
4914 \begin_layout Plain Layout
4920 outputs math as HTML, styled by CSS.
4924 \begin_layout Plain Layout
4926 has borrowed some of the CSS for its HTML output from
4927 \begin_inset Flex Code
4930 \begin_layout Plain Layout
4941 For simple formulae, this can work quite well, though with more complicated
4942 formulae it tends to break down.
4943 Still, this method has the advantage that it is very widely supported and
4944 so it may be appropriate for documents that contain only a little, fairly
4946 \begin_inset Newline newline
4949 If Lyx is unable to render a formula as HTML—for example, if the formula
4951 \begin_inset Flex Code
4954 \begin_layout Plain Layout
4960 package or ERT—then it will instead output the formula as an image.
4964 \begin_layout Itemize
4966 \begin_inset Newline newline
4970 \begin_inset Flex Code
4973 \begin_layout Plain Layout
4980 will output formulae as images, the very same images, in fact, that are
4981 used for instant preview.
4985 \begin_layout Plain Layout
4986 Instant preview does
4990 have to be on for images to be output, however.
4995 The advantage to this method is that the images are simply generated by
4997 , so they are very accurate.
4998 The disadvantage, as mentioned earlier, is that these are bitmapped images,
4999 so they do not scale terribly well, and one cannot copy them, etc.
5000 (As of this writing, there are also problems about equation numbering.
5002 \begin_inset CommandInset href
5005 target "http://www.lyx.org/trac/ticket/6894"
5010 \begin_inset Newline newline
5013 The size of the images can be controlled by setting the
5014 \begin_inset Quotes eld
5018 \begin_inset Quotes erd
5022 \begin_inset Flex Noun
5025 \begin_layout Plain Layout
5026 Document\SpecialChar menuseparator
5027 Settings\SpecialChar menuseparator
5037 \begin_layout Plain Layout
5038 For those who want to know, this controls the resolution of the image in
5039 dots per inch and is based upon a default of 75 dpi.
5045 \begin_inset Newline newline
5049 for some reason fails to create an image for a formula (e.g., if a required
5051 package is not installed), then it will fall back to outputing the raw
5056 \begin_layout Itemize
5059 \begin_inset Newline newline
5062 Finally, \SpecialChar LyX
5063 will happily output math as \SpecialChar LaTeX
5065 As well as being the output of last resort, this method can be used with
5067 \begin_inset CommandInset href
5070 target "http://www.math.union.edu/~dpvc/jsMath/"
5074 , which uses JavaScript to render \SpecialChar LaTeX
5075 embedded in HTML documents.
5077 wraps the \SpecialChar LaTeX
5079 \begin_inset Flex Code
5082 \begin_layout Plain Layout
5088 (for inline formulas) or
5089 \begin_inset Flex Code
5092 \begin_layout Plain Layout
5098 (for displayed formulas) with
5099 \begin_inset Flex Code
5102 \begin_layout Plain Layout
5108 , as is required for jsMath.
5111 \begin_layout Standard
5112 One of these output methods must be selected under
5113 \begin_inset Flex Noun
5116 \begin_layout Plain Layout
5117 Document\SpecialChar menuseparator
5118 Settings\SpecialChar menuseparator
5125 By default, \SpecialChar LyX
5127 This is a document-wide setting, therefore.
5130 \begin_layout Standard
5131 Eventually, \SpecialChar LyX
5132 will offer the user the option to select an alternate output
5133 method for a particular inset, say, one that isn't being rendered very
5138 \begin_layout Plain Layout
5139 That said, since \SpecialChar LyX
5140 falls back to images if the inset contains ERT, then one
5141 can force output as an image by putting some harmless ERT into the math,
5143 \begin_inset Formula $a=b\relax$
5154 \begin_layout Section
5155 Bibliography and Citations
5158 \begin_layout Standard
5159 XHTML output fully supports bibliographies and citations.
5163 \begin_layout Standard
5164 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5166 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5169 If you are using numerical citations, then \SpecialChar LyX
5170 will output numerical labels,
5171 such as [1] or [17], rather than simply showing the citation key in square
5172 brackets, as it does on-screen.
5173 If you are using author-year citations, then \SpecialChar LyX
5174 will add lowercase letters
5175 to the years, just as Bib\SpecialChar TeX
5176 does, if it finds more than one citation for
5177 a given author-year combination.
5178 The labels will be printed with the bibliography entries.
5179 Note that there is, at present, no way to customize the appearance of the
5180 labels, for example, to choose between square brackets and parentheses.
5183 \begin_layout Standard
5184 Bibliography output is handled by the same machinery that handles the presentati
5185 on of reference information in the citation dialog, so you will see in the
5186 XHTML output pretty much what you would see if you were to look at a given
5187 entry in the citation dialog.
5188 The formatting can be customized in your layout file or, preferably, in
5194 manual for the details.
5197 \begin_layout Standard
5198 The main defect at present is that cross-referenced information is printed
5199 with every entry with which it is associated.
5200 So you can see things like this:
5205 \begin_inset Quotes eld
5208 Context and Logical Form
5209 \begin_inset Quotes erd
5214 Language in Context: Selected Essays
5216 (Oxford: Oxford University Press, 2007), pp.
5222 \begin_inset Quotes eld
5225 Semantics in Context
5226 \begin_inset Quotes erd
5231 Language in Context: Selected Essays
5233 (Oxford: Oxford University Press, 2007), pp.
5237 \begin_layout Standard
5238 This should be fixed before long.
5241 \begin_layout Standard
5242 There is no support at present for sectioned bibliographies.
5243 If you have multiple bibliographies, then \SpecialChar LyX
5244 will print the same bibliography
5248 \begin_layout Section
5252 \begin_layout Standard
5254 will happily export indexes as XHTML, but with certain limitations at the
5258 \begin_layout Standard
5259 Index export will be most reliable when you do not attempt to use the fancy
5260 constructs that are described in the section on indexes in the
5268 \begin_layout Plain Layout
5269 The main issue here is that \SpecialChar LyX
5270 itself does not really handle these.
5271 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5277 We'll describe how they are handled using the subsection headings from
5281 \begin_layout Itemize
5282 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5283 makes an effort to support these,
5284 but the entries must be separated by
5285 \begin_inset Quotes eld
5289 \begin_inset Quotes erd
5292 , that is, there must be spaces around the exclamation point.
5293 This is because it is otherwise too difficult to check for escaped exclamation
5294 points, ones in math, and so forth.
5297 \begin_layout Itemize
5298 Page Ranges: There is no support at all for page ranges, since these make
5299 no sense with XHMTL.
5300 Instead, you will just get two index entries, one at either end.
5303 \begin_layout Itemize
5304 Cross-referencing: There is no support for cross-referencing.
5306 finds an entry containing the
5307 \begin_inset Quotes eld
5310 |see\SpecialChar ldots
5312 \begin_inset Quotes erd
5315 construct, it is just dropped, and the rest is treated as an ordinary index
5319 \begin_layout Itemize
5320 Index Entry Order: \SpecialChar LyX
5321 does support attempts to fix the sorting order.
5322 It will take what is before the first `@' it finds and use that for sorting,
5323 taking what follows the first `@' to be the actual entry.
5324 At present, \SpecialChar LyX
5325 does not check for escaped `@', so do not try to index email
5329 \begin_layout Itemize
5330 Index Entry Layout: You can format entries by using the text style dialog,
5331 or by using any other method available within \SpecialChar LyX
5333 There is no support for constructs like:
5334 \begin_inset Quotes eld
5338 \begin_inset Quotes erd
5342 Indeed, if \SpecialChar LyX
5343 finds a pipe symbol, `|', in an entry, it will delete it and
5344 everything that follows it.
5347 \begin_layout Itemize
5348 Multiple Indexes: There is no support for multiple indexes.
5349 Rather, all index entries will be printed as one large index.
5350 To avoid our printing several versions of the index, we print only the
5351 main index, so make sure you have one.
5354 \begin_layout Section
5355 Nomenclature and Glossary
5358 \begin_layout Standard
5359 There is at present no support for glossaries.
5360 Adding it would be fairly trivial, and welcome.
5363 \begin_layout Chapter
5364 The \SpecialChar LyX
5368 \begin_layout Section
5372 \begin_layout Standard
5373 The `\SpecialChar LyX
5374 server' allows other programs to talk to \SpecialChar LyX
5375 , invoke \SpecialChar LyX
5376 commands, and retrieve
5377 information about the \SpecialChar LyX
5379 This is only intended for advanced users, but they should find it useful.
5380 It is by writing to the \SpecialChar LyX
5381 server, for example, that bibliography managers,
5382 such as JabRef, are able to
5383 \begin_inset Quotes eld
5387 \begin_inset Quotes erd
5390 citations to \SpecialChar LyX
5394 \begin_layout Section
5395 Starting the \SpecialChar LyX
5399 \begin_layout Standard
5400 The \SpecialChar LyX
5401 server works through the use of a pair of named pipes.
5402 These are usually located in
5403 \begin_inset Flex Code
5406 \begin_layout Plain Layout
5412 , (except on Windows, where
5416 named pipes are special objects located in
5417 \begin_inset Flex Code
5420 \begin_layout Plain Layout
5432 ) and have the names
5433 \begin_inset Quotes eld
5437 \begin_inset Flex Code
5440 \begin_layout Plain Layout
5447 \begin_inset Quotes erd
5451 \begin_inset Quotes eld
5455 \begin_inset Flex Code
5458 \begin_layout Plain Layout
5465 \begin_inset Quotes erd
5469 External programs write into
5470 \begin_inset Flex Code
5473 \begin_layout Plain Layout
5479 and read back data from
5480 \begin_inset Flex Code
5483 \begin_layout Plain Layout
5490 The stem of the pipe names can be defined in the
5491 \begin_inset Flex Noun
5494 \begin_layout Plain Layout
5495 Tools\SpecialChar menuseparator
5502 \begin_inset Flex Code
5505 \begin_layout Plain Layout
5506 "/home/myhome/lyxpipe"
5512 \begin_inset Flex Code
5515 \begin_layout Plain Layout
5529 on Windows (where any working path instead of lyxpipe can be used, for
5531 \begin_inset Flex Code
5534 \begin_layout Plain Layout
5557 configure this manually in order for the server to start.
5560 \begin_layout Standard
5563 \begin_inset Flex Code
5566 \begin_layout Plain Layout
5573 \begin_inset Flex Code
5576 \begin_layout Plain Layout
5582 ' to create the pipes.
5583 If one of the pipes already exists, \SpecialChar LyX
5584 will assume that another \SpecialChar LyX
5586 is already running and will not start the server.
5587 On POSIX (Unix like) systems, if for some other reason, an unused
5588 \begin_inset Quotes eld
5592 \begin_inset Quotes erd
5595 pipe is left in existence when \SpecialChar LyX
5596 closes, then \SpecialChar LyX
5597 will try to delete it.
5598 If this fails for some reason, you will need to delete the pipes manually
5599 and then restart \SpecialChar LyX
5601 On Windows, pipes are deleted by the OS on program termination or crash,
5603 \begin_inset Quotes eld
5607 \begin_inset Quotes erd
5610 pipes should not be possible.
5613 \begin_layout Standard
5614 To have several \SpecialChar LyX
5615 processes with servers at the same time, you have to use
5616 different configurations, perhaps by using separate user directories, each
5618 \begin_inset Flex Code
5621 \begin_layout Plain Layout
5627 file, for each process.
5630 \begin_layout Standard
5631 If you are developing a client program, you might find it useful to enable
5632 debugging information from the \SpecialChar LyX
5634 Do this by starting \SpecialChar LyX
5636 \begin_inset Flex Code
5639 \begin_layout Plain Layout
5648 \begin_layout Standard
5649 You can find a complete example client written in C++ in the source distribution
5651 \begin_inset Flex Code
5654 \begin_layout Plain Layout
5655 development/lyxserver/server_monitor.cpp
5663 \begin_layout Standard
5664 Another useful tool is the command-line based client found in
5665 \begin_inset Flex Code
5668 \begin_layout Plain Layout
5669 src/client/lyxclient
5677 \begin_layout Section
5678 Normal communication
5681 \begin_layout Standard
5682 To issue a \SpecialChar LyX
5683 call, the client writes a line of ASCII text into the input
5685 This line has the following format:
5702 \begin_layout Description
5703 clientname is a name that the client can choose arbitrarily.
5704 Its only use is that \SpecialChar LyX
5705 will echo it if it sends an answer—so a client can
5706 dispatch results from different requesters.
5709 \begin_layout Description
5710 function is the function you want \SpecialChar LyX
5712 It is the same as the commands you'd use in the minibuffer.
5715 \begin_layout Description
5716 argument is an optional argument which is meaningful only to some functions
5718 \begin_inset Quotes eld
5722 \begin_inset Quotes erd
5725 LFUN will insert the argument as text at the cursor position).
5728 \begin_layout Standard
5729 The answer from \SpecialChar LyX
5730 will arrive in the output pipe and be of the form
5747 \begin_layout Standard
5756 are just echoed from the command request, while
5760 is more or less useful information filled according to how the command
5761 execution worked out.
5762 Some commands, such as
5763 \begin_inset Quotes eld
5767 \begin_inset Quotes erd
5770 , will return information about the internal state of \SpecialChar LyX
5772 return an empty data-response.
5773 This means that the command execution went fine.
5776 \begin_layout Standard
5777 In case of errors, the response from \SpecialChar LyX
5795 \begin_layout Standard
5800 should contain an explanation of why the command failed.
5803 \begin_layout Standard
5807 \begin_layout LyX-Code
5808 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
5809 \begin_inset Newline newline
5812 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
5813 \begin_inset Newline newline
5816 read a <~/.lyxpipe.out
5817 \begin_inset Newline newline
5823 \begin_layout Subsection
5824 AppleScript (Mac OS X)
5827 \begin_layout Standard
5828 Since \SpecialChar LyX
5829 2.1, \SpecialChar LyX
5830 supports basic interactions with AppleScript for normal communicatio
5831 n through the command run.
5832 This command takes a direct argument (the
5836 to perform) and an optional argument.
5837 It either returns the output of the function or triggers an error with
5838 the error message and code.
5841 \begin_layout Standard
5845 \begin_layout LyX-Code
5846 tell application "\SpecialChar LyX
5850 \begin_layout LyX-Code
5854 \begin_layout LyX-Code
5855 -- Stores the current file name into f
5858 \begin_layout LyX-Code
5859 set f to (run "server-get-filename" with argument "")
5862 \begin_layout LyX-Code
5863 on error the error_message number the error_number
5866 \begin_layout LyX-Code
5867 display dialog "Error: " & the error_number & ".
5871 \begin_layout LyX-Code
5872 & the error_message buttons {"OK"} default button 1
5875 \begin_layout LyX-Code
5879 \begin_layout LyX-Code
5883 \begin_layout Section
5887 \begin_layout Standard
5889 can notify clients of events going on asynchronously.
5890 Currently it will only do this if the user binds a key sequence with the
5892 \begin_inset Quotes eld
5896 \begin_inset Quotes erd
5900 The format of the string \SpecialChar LyX
5901 sends is as follows:
5905 \begin_inset Flex Code
5908 \begin_layout Plain Layout
5919 \begin_layout Standard
5924 is the printed representation of the key sequence that was actually typed
5928 \begin_layout Standard
5929 This mechanism can be used to extend \SpecialChar LyX
5930 's command set and implement macros.
5931 Bind some key sequence to
5932 \begin_inset Quotes eld
5936 \begin_inset Quotes erd
5940 Then start a client that listens on the output pipe, dispatches the command
5941 according to the sequence, and starts a function that may use \SpecialChar LyX
5944 requests to issue a command or a series of commands to \SpecialChar LyX
5948 \begin_layout Section
5949 The simple \SpecialChar LyX
5953 \begin_layout Standard
5955 implements a simple protocol that can be used for session management.
5956 All messages are of the form
5969 \begin_layout Standard
5975 \begin_inset Quotes eld
5979 \begin_inset Quotes erd
5983 \begin_inset Quotes eld
5987 \begin_inset Quotes erd
5992 \begin_inset Quotes eld
5996 \begin_inset Quotes erd
5999 is received from a client, \SpecialChar LyX
6000 will report back to inform the client that
6001 it's listening to it's messages, while
6002 \begin_inset Quotes eld
6006 \begin_inset Quotes erd
6009 sent from \SpecialChar LyX
6010 will inform clients that \SpecialChar LyX
6014 \begin_layout Section
6015 Reverse DVI/PDF search
6018 \begin_layout Standard
6019 Some DVI/PDF viewers
6023 \begin_layout Plain Layout
6024 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6025 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6034 facility (also called
6039 This means that you can tell \SpecialChar LyX
6040 to put the cursor to a specific line in the
6041 document by clicking at the respective position in the DVI/PDF output.
6042 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6044 This is done via the \SpecialChar LyX
6045 server either by using the named pipe (
6049 ), or the UNIX domain socket (
6053 ) that \SpecialChar LyX
6054 creates in its temporary directory (this is the way the
6055 \begin_inset Flex Code
6058 \begin_layout Plain Layout
6064 program communicates with \SpecialChar LyX
6066 In some cases, you need a helper script that mediates between the viewer
6067 and \SpecialChar LyX
6068 , in others, the viewer can communicate with \SpecialChar LyX
6070 This depends on the selected viewer and on your operating system.
6071 The same applies to the way viewers need to be configured and the way the
6072 reverse search is actually performed.
6073 In what follows, we will thus describe how to setup reverse search for
6075 Before we turn to this, though, we will explain what needs to be done generally
6076 to enable reverse search in the DVI/PDF output.
6079 \begin_layout Subsection
6081 \begin_inset CommandInset label
6083 name "subsec:rev-search"
6090 \begin_layout Standard
6091 In most cases \SpecialChar LyX
6092 will do the work for you by enabling the option
6093 \begin_inset Flex Noun
6096 \begin_layout Plain Layout
6097 Synchronize with Output
6103 \begin_inset Flex Noun
6106 \begin_layout Plain Layout
6107 Document\SpecialChar menuseparator
6108 Settings\SpecialChar menuseparator
6115 In such a case \SpecialChar LyX
6116 will automatically insert the necessary Sync\SpecialChar TeX
6118 PDF) or load the srcltx package (for DVI) respectively.
6119 This option can be easily reached also on
6120 \begin_inset Flex Code
6123 \begin_layout Plain Layout
6132 \begin_layout Standard
6133 If you need a different setting, you can select or input a custom macro
6134 from the drop down box just below
6135 \begin_inset Flex Noun
6138 \begin_layout Plain Layout
6139 Document\SpecialChar menuseparator
6140 Settings\SpecialChar menuseparator
6141 Output\SpecialChar menuseparator
6142 Synchronize with Output
6150 \begin_layout Standard
6151 Note that the method
6152 \begin_inset Flex Code
6155 \begin_layout Plain Layout
6163 enables gzip compression.
6164 If your viewer does not support it, you should instead use
6165 \begin_inset Flex Code
6168 \begin_layout Plain Layout
6179 \begin_layout Standard
6180 Please also note that including the
6181 \begin_inset Flex Code
6184 \begin_layout Plain Layout
6191 \begin_inset Flex Code
6194 \begin_layout Plain Layout
6200 sometimes has an undesired impact on the typesetting.
6201 Thus, you should switch output synchronization off for the final typesetting
6203 \begin_inset Flex Code
6206 \begin_layout Plain Layout
6213 \begin_inset Flex Code
6216 \begin_layout Plain Layout
6226 \begin_layout Standard
6227 In case you need some more special settings that are not covered by the
6228 automatic settings, read the next section about how to set up output synchroniz
6230 If the automatic setup suits your needs, you can readily jump to section
6231 \begin_inset space ~
6235 \begin_inset CommandInset ref
6237 reference "subsec:configuring-viewers"
6241 , where the necessary configuration steps in your viewer – needed both with
6242 the automatic and the manual setup – are described.
6245 \begin_layout Subsection
6249 \begin_layout Standard
6251 provides several different methods for reverse search.
6252 Some are built-in in the
6253 \begin_inset Flex Code
6256 \begin_layout Plain Layout
6262 program, some are provided by external packages.
6263 Your choice depends on whether your \SpecialChar LaTeX
6264 distribution already provides a given
6265 method (the built-in methods are rather new) and whether your viewer can
6267 The available methods are described in the following.
6270 \begin_layout Subsubsection*
6271 Built-in DVI-search via src-specials (DVI only)
6274 \begin_layout Standard
6275 This method provides the DVI file with the necessary information for reverse
6277 It is available in \SpecialChar LaTeX
6278 since quite some time (any somewhat recent \SpecialChar LaTeX
6280 should include it), and it works reliably.
6281 To enable it, change the
6282 \begin_inset Flex Noun
6285 \begin_layout Plain Layout
6296 \begin_inset Flex Noun
6299 \begin_layout Plain Layout
6310 \begin_inset Flex Noun
6313 \begin_layout Plain Layout
6314 Preferences\SpecialChar menuseparator
6315 File Handling\SpecialChar menuseparator
6322 \begin_inset Flex Code
6325 \begin_layout Plain Layout
6326 latex -src-specials $$i
6332 If this doesn't work, check if your \SpecialChar TeX
6333 engine needs different options (the
6334 syntax might differ in some distributions).
6337 \begin_layout Subsubsection*
6338 External Packages (PDFSync and scrltx)
6341 \begin_layout Standard
6350 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6352 In order to enable it, load the packages in the \SpecialChar LyX
6356 \begin_layout Itemize
6357 \begin_inset Flex Code
6360 \begin_layout Plain Layout
6368 for reverse PDF search,
6371 \begin_layout Itemize
6372 \begin_inset Flex Code
6375 \begin_layout Plain Layout
6378 usepackage[active]{srcltx}
6383 for reverse DVI search.
6386 \begin_layout Standard
6387 If you want to be able to perform both DVI and PDF reverse searches, you
6388 can also insert in the preamble the following lines
6391 \begin_layout LyX-Code
6395 \begin_inset Newline newline
6401 \begin_inset Newline newline
6407 \begin_inset Newline newline
6413 \begin_inset Newline newline
6418 usepackage[active]{srcltx}
6419 \begin_inset Newline newline
6427 \begin_layout Standard
6428 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6429 right package will be used.
6432 \begin_layout Standard
6433 Note that PDFSync might affect the output layout of your document.
6434 It is therefore advised to disable PDFsync for final documents.
6437 \begin_layout Subsubsection*
6438 Built-in reverse search via Sync\SpecialChar TeX
6442 \begin_layout Standard
6444 \begin_inset Flex Code
6447 \begin_layout Plain Layout
6453 have built-in support for both PDF and DVI reverse search.
6456 Sync\SpecialChar TeX
6459 facility is basically the result of the integration of the PDFSync package
6460 to the pdftex program and its merge with the
6465 You need at least \SpecialChar TeX
6466 Live 2008 or a recent Mik\SpecialChar TeX
6467 distribution in order to use
6472 \begin_layout Plain Layout
6473 For some reason, Mik\SpecialChar TeX
6474 does not understand/obey the command \SpecialChar LyX
6476 the preamble when you check the "Enable Forward/Reverse Search" button
6477 in the toolbar and does not generate the necessary info.
6480 \begin_layout Plain Layout
6481 The generation of the required info can be forced by changing the converter
6483 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
6484 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
6485 the -synctex=1 switch).
6490 Also note that only a few PDF viewers (Okular and Qpdfview on Unix, Skim
6491 on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
6495 \begin_layout Standard
6496 To enable Sync\SpecialChar TeX
6497 for DVI output, change the
6498 \begin_inset Flex Noun
6501 \begin_layout Plain Layout
6512 \begin_inset Flex Noun
6515 \begin_layout Plain Layout
6526 \begin_inset Flex Noun
6529 \begin_layout Plain Layout
6530 Preferences\SpecialChar menuseparator
6531 File Handling\SpecialChar menuseparator
6538 \begin_inset Flex Code
6541 \begin_layout Plain Layout
6542 latex -synctex=1 $$i
6547 , and for PDF output, change the
6548 \begin_inset Flex Noun
6551 \begin_layout Plain Layout
6556 (pdflatex) -> PDF (pdflatex)
6562 \begin_inset Flex Code
6565 \begin_layout Plain Layout
6566 pdflatex -synctex=1 $$i
6572 Check the documentation of your viewer whether the viewer needs to be configure
6573 d for the use with Sync\SpecialChar TeX
6578 \begin_layout Plain Layout
6579 Note that the option
6580 \begin_inset Flex Code
6583 \begin_layout Plain Layout
6589 option enables gzip compression.
6590 If your viewer does not support it, you should instead use
6591 \begin_inset Flex Code
6594 \begin_layout Plain Layout
6608 \begin_layout Subsection
6609 Configuring and using specific viewers
6610 \begin_inset CommandInset label
6612 name "subsec:configuring-viewers"
6619 \begin_layout Subsubsection*
6620 Xdvi (all platforms)
6623 \begin_layout Standard
6625 \begin_inset Flex Code
6628 \begin_layout Plain Layout
6634 , you don't need to do anything else for performing a reverse DVI search,
6636 already provides the necessary hooks for automatically using the
6637 \begin_inset Flex Code
6640 \begin_layout Plain Layout
6647 Just setup your document as described above (reverse search is triggered
6648 by Ctrl-click or Alt-click on Mac OSX, respectively).
6651 \begin_layout Standard
6652 However, if for whatever reason you want to use the named pipe instead of
6653 the socket for communicating with \SpecialChar LyX
6654 , simply change the DVI viewer in
6655 \begin_inset Flex Noun
6658 \begin_layout Plain Layout
6659 Preferences\SpecialChar menuseparator
6660 File Handling\SpecialChar menuseparator
6670 \begin_layout Plain Layout
6671 On Mac OSX you have to use
6672 \begin_inset Flex Code
6675 \begin_layout Plain Layout
6676 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
6687 \begin_inset Flex Code
6690 \begin_layout Plain Layout
6691 xdvi -editor "lyxeditor.sh %f %l"
6697 \begin_inset Flex Code
6700 \begin_layout Plain Layout
6706 is a suitable script.
6707 For example, a minimal shell script is the following one:
6710 \begin_layout LyX-Code
6712 \begin_inset Newline newline
6715 LYXPIPE="/path/to/lyxpipe"
6716 \begin_inset Newline newline
6719 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
6720 \begin_inset Newline newline
6723 echo "$COMMAND" > "${LYXPIPE}".in || exit
6724 \begin_inset Newline newline
6727 read TMP < "${LYXPIPE}".out || exit
6730 \begin_layout Standard
6732 \begin_inset Flex Code
6735 \begin_layout Plain Layout
6745 \begin_layout Plain Layout
6752 XServer pipe path specified in
6753 \begin_inset Flex Noun
6756 \begin_layout Plain Layout
6757 Preferences\SpecialChar menuseparator
6767 \begin_layout Plain Layout
6769 \begin_inset Flex Code
6772 \begin_layout Plain Layout
6778 folder of a source distribution you can find a
6779 \begin_inset Flex Code
6782 \begin_layout Plain Layout
6788 script which is able to locate the
6792 based on your preferences.
6800 \begin_layout Subsubsection*
6804 \begin_layout Standard
6806 \begin_inset Flex Code
6809 \begin_layout Plain Layout
6810 /Applications/MacDviX_Folder/calleditor.script
6815 , add the following lines:
6818 \begin_layout LyX-Code
6823 \begin_layout Plain Layout
6830 X.app/Contents/MacOS/lyxeditor "$2" $1
6831 \begin_inset Newline newline
6837 \begin_layout Standard
6838 Modify the lines accordingly if you install \SpecialChar LyX
6839 somewhere else than in the
6840 Applications folder.
6843 \begin_layout Standard
6844 Reverse search is triggered by Alt-click (OPTION-click).
6847 \begin_layout Subsubsection*
6851 \begin_layout Standard
6853 \begin_inset Flex Code
6856 \begin_layout Plain Layout
6857 open -a Skim.app $$i
6862 to the viewer setting in
6863 \begin_inset Flex Noun
6866 \begin_layout Plain Layout
6867 Preferences\SpecialChar menuseparator
6868 File Handling\SpecialChar menuseparator
6869 File formats\SpecialChar menuseparator
6876 \begin_inset Flex Noun
6879 \begin_layout Plain Layout
6880 Skim\SpecialChar menuseparator
6881 Preferences\SpecialChar menuseparator
6888 \begin_inset Flex Noun
6891 \begin_layout Plain Layout
6897 preset and enter command
6898 \begin_inset Flex Noun
6901 \begin_layout Plain Layout
6902 /Applications/\SpecialChar LyX
6903 .app/Contents/MacOS/lyxeditor
6911 \begin_layout Standard
6912 Reverse search is triggered by COMMAND-SHIFT-click
6915 \begin_layout Subsubsection*
6919 \begin_layout Standard
6921 \begin_inset Flex Noun
6924 \begin_layout Plain Layout
6925 Settings\SpecialChar menuseparator
6926 Configure Okular\SpecialChar menuseparator
6933 \begin_inset Quotes eld
6937 \begin_inset Quotes erd
6941 \begin_inset Flex Code
6944 \begin_layout Plain Layout
6953 \begin_layout Standard
6954 Reverse search is triggered by SHIFT-click.
6957 \begin_layout Subsubsection*
6961 \begin_layout Standard
6962 Qpdfview supports Sync\SpecialChar TeX
6963 since version 0.3.5.
6965 \begin_inset Flex Noun
6968 \begin_layout Plain Layout
6969 Edit\SpecialChar menuseparator
6970 Settings\SpecialChar menuseparator
6976 , click on the input field of the
6977 \begin_inset Quotes eld
6981 \begin_inset Quotes erd
6984 item and add the command
6985 \begin_inset Flex Code
6988 \begin_layout Plain Layout
6997 \begin_layout Standard
6998 Reverse search is triggered by double-click.
7001 \begin_layout Subsubsection*
7005 \begin_layout Standard
7006 Launch yap, choose its
7007 \begin_inset Flex Noun
7010 \begin_layout Plain Layout
7011 View\SpecialChar menuseparator
7018 \begin_inset Quotes eld
7022 \begin_inset Quotes erd
7027 \begin_inset Quotes eld
7030 New\SpecialChar ldots
7032 \begin_inset Quotes erd
7035 button and, in the window that opens, enter
7036 \begin_inset Quotes eld
7041 \begin_inset Quotes erd
7044 (or any other name you like) in the
7045 \begin_inset Quotes eld
7049 \begin_inset Quotes erd
7053 Now click on the button labeled
7054 \begin_inset Quotes eld
7059 \begin_inset Quotes erd
7062 to open a file dialog and navigate to the directory containing the batch
7064 \begin_inset Flex Code
7067 \begin_layout Plain Layout
7075 \begin_inset Flex Code
7078 \begin_layout Plain Layout
7084 and then specify the program arguments as
7085 \begin_inset Flex Code
7088 \begin_layout Plain Layout
7096 \begin_inset Flex Code
7099 \begin_layout Plain Layout
7105 wrapper is used for communicating with \SpecialChar LyX
7113 \begin_layout LyX-Code
7115 \begin_inset Newline newline
7118 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
7127 \begin_inset Newline newline
7141 \begin_layout Standard
7142 Make sure that the \SpecialChar LyX
7143 Server pipe path you specified in \SpecialChar LyX
7145 \begin_inset Flex Code
7148 \begin_layout Plain Layout
7162 , otherwise change the
7163 \begin_inset Flex Code
7166 \begin_layout Plain Layout
7172 wrapper accordingly.
7175 \begin_layout Standard
7176 In yap, reverse search is triggered by double-click.
7179 \begin_layout Subsubsection*
7180 SumatraPDF (Windows)
7183 \begin_layout Standard
7184 In order to use SumatraPDF for inverse search, enter
7185 \begin_inset Flex Code
7188 \begin_layout Plain Layout
7189 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
7194 in the viewer setting in
7195 \begin_inset Flex Noun
7198 \begin_layout Plain Layout
7199 Preferences\SpecialChar menuseparator
7200 File Handling\SpecialChar menuseparator
7201 File formats\SpecialChar menuseparator
7208 \begin_inset Flex Code
7211 \begin_layout Plain Layout
7217 is the previous wrapper.
7218 If SumatraPDF.exe is not in your command PATH, use its full file name.
7221 \begin_layout Standard
7222 Reverse search is triggered by double-click.
7225 \begin_layout Subsubsection*
7229 \begin_layout Standard
7230 First of all, make sure that yap is your default DVI viewer in the Windows
7231 environment, then launch it, choose its
7232 \begin_inset Flex Noun
7235 \begin_layout Plain Layout
7236 View\SpecialChar menuseparator
7243 \begin_inset Quotes eld
7247 \begin_inset Quotes erd
7252 \begin_inset Quotes eld
7255 New\SpecialChar ldots
7257 \begin_inset Quotes erd
7260 button and, in the window that opens, enter
7261 \begin_inset Quotes eld
7266 \begin_inset Quotes erd
7269 (or any other name you like) in the
7270 \begin_inset Quotes eld
7274 \begin_inset Quotes erd
7278 Now click on the button labeled
7279 \begin_inset Quotes eld
7284 \begin_inset Quotes erd
7287 to open a file dialog and navigate to the directory containing the
7288 \begin_inset Flex Code
7291 \begin_layout Plain Layout
7297 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7300 \begin_inset Flex Code
7303 \begin_layout Plain Layout
7309 and then specify the program arguments as
7310 \begin_inset Flex Code
7313 \begin_layout Plain Layout
7320 In this way, you will be using the
7324 for communicating with \SpecialChar LyX
7326 If, for whatever reason, you want to use the
7331 \begin_inset Flex Code
7334 \begin_layout Plain Layout
7340 option and be sure to specify the \SpecialChar LyX
7341 Server pipe path in the \SpecialChar LyX
7345 \begin_layout Standard
7346 In yap, reverse search is triggered by double-click.
7349 \begin_layout Subsubsection*
7353 \begin_layout Standard
7354 In order to use SumatraPDF for inverse search, enter
7355 \begin_inset Flex Code
7358 \begin_layout Plain Layout
7359 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7364 in the viewer setting in
7365 \begin_inset Flex Noun
7368 \begin_layout Plain Layout
7369 Preferences\SpecialChar menuseparator
7370 File Handling\SpecialChar menuseparator
7371 File formats\SpecialChar menuseparator
7378 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7380 \begin_inset Flex Code
7383 \begin_layout Plain Layout
7389 enables communication via the
7395 \begin_inset Flex Code
7398 \begin_layout Plain Layout
7404 option if you want to use the
7408 , and be sure to specify the \SpecialChar LyX
7409 Server pipe path in the \SpecialChar LyX
7413 \begin_layout Standard
7414 Reverse search is triggered by double-click.
7417 \begin_layout Section
7421 \begin_layout Standard
7422 Forward search is, as the name implies, in a sense the
7423 \begin_inset Quotes eld
7427 \begin_inset Quotes erd
7431 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7433 If forward search is set up (as described in what follows), you can put
7434 the cursor anywhere in your \SpecialChar LyX
7436 \begin_inset Flex Noun
7439 \begin_layout Plain Layout
7440 Navigate\SpecialChar menuseparator
7447 \begin_inset Flex Noun
7450 \begin_layout Plain Layout
7456 in the context menu via right mouse click), and then the viewer will jump
7457 to that position as well.
7458 This implies, of course, that your viewer supports this function.
7461 \begin_layout Standard
7462 To make forward search possible, you first need to provide the generated
7463 output PDF/DVI file with additional information about the \SpecialChar TeX
7465 This can be done via the methods described in the section
7466 \begin_inset CommandInset ref
7468 reference "subsec:rev-search"
7475 \begin_layout Standard
7476 Additionally, you need to configure \SpecialChar LyX
7477 for using your viewers in
7478 \begin_inset Flex Noun
7481 \begin_layout Plain Layout
7482 Tools\SpecialChar menuseparator
7483 Preferences\SpecialChar menuseparator
7484 Output\SpecialChar menuseparator
7491 We provide a range of tested configurations for some viewers, which you
7492 can select from the drop down list.
7493 If none of these configurations suits you, you have to find out and enter
7494 a suitable configuration yourself.
7495 The definition syntax uses the following placeholders:
7498 \begin_layout Itemize
7500 \begin_inset Flex Code
7503 \begin_layout Plain Layout
7512 \begin_layout Itemize
7514 \begin_inset Flex Code
7517 \begin_layout Plain Layout
7523 : name of the (temporary) exported .tex file (without path)
7526 \begin_layout Itemize
7528 \begin_inset Flex Code
7531 \begin_layout Plain Layout
7537 : name of the (temporary) exported .tex file (including path)
7540 \begin_layout Itemize
7542 \begin_inset Flex Code
7545 \begin_layout Plain Layout
7551 : name of the exported output file (either dvi or pdf, depending on which
7552 one exists in the temporary directory)
7555 \begin_layout Standard
7556 Note that only some of the viewers provide full forward search functionality,
7557 among them yap, xdvi, okular
7561 \begin_layout Plain Layout
7562 You might want to set
7563 \begin_inset Flex Code
7566 \begin_layout Plain Layout
7573 \begin_inset Flex Noun
7576 \begin_layout Plain Layout
7577 Tools\SpecialChar menuseparator
7578 Preferences\SpecialChar menuseparator
7579 File Handling\SpecialChar menuseparator
7581 \begin_inset space ~
7594 , qpdfview and SumatraPDF
7598 \begin_layout Plain Layout
7599 SumatraPDF can also use DDE commands through the external program CMCDDE
7601 \begin_inset CommandInset href
7603 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
7613 While many of the widespread PDF viewers (most notably Adobe Reader) do
7614 not support forward search at all, some other viewers – e.
7615 \begin_inset space \thinspace{}
7619 evince and xpdf – allow at least to reload the document and jump to a specific
7620 page of the file, so you can at least navigate
7621 \begin_inset Quotes eld
7625 \begin_inset Quotes erd
7629 This latter functionality is provided by an external call of synctex (see
7630 the predefined example configurations).
7634 \begin_layout Standard
7635 Forward search works both with DVI and PDF output.
7637 simply checks which preview format you have used before (i.
7638 \begin_inset space \thinspace{}
7641 e., which format is already there in the temporary directory) and chooses
7642 the appropriate configuration for the respective format.
7645 \begin_layout Chapter
7646 Special Document Classes
7649 \begin_layout Section
7653 \begin_layout Standard
7659 \begin_layout Subsection
7663 \begin_layout Standard
7664 This section describes how \SpecialChar LyX
7665 can be used to write articles for submission
7666 to the scientific journal
7668 Astronomy and Astrophysics
7671 \begin_inset Flex URL
7674 \begin_layout Plain Layout
7676 http://www.edpsciences.fr/aa/
7681 ) using Version 5.01 of the document class
7686 This package can be downloaded from the ftp site
7689 \begin_layout Standard
7690 \begin_inset VSpace medskip
7696 \begin_layout Standard
7698 \begin_inset Flex URL
7701 \begin_layout Plain Layout
7703 ftp://ftp.edpsciences.org/pub/aa/readme.html
7711 \begin_layout Standard
7712 \begin_inset VSpace medskip
7718 \begin_layout Standard
7719 A manual comes together with that package, and this text is not meant to
7720 replace the original manual but is merely a short guide in how to realize
7721 the correct form of your paper.
7725 \begin_layout Standard
7726 Please note that the publisher of the journal was changed from Springer
7727 to EDP Sciences starting January 1, 2001.
7728 That change involved also some slight changes to the style files, namely
7729 the removal of the thesaurus command.
7730 The \SpecialChar LyX
7731 class aa supports the newest version of these style files, V 5.01.
7732 If you have an older version installed, please upgrade.
7733 For compatibility, the old (version 4) layout has been kept as
7738 Please refer to the comments in
7741 Dir/layouts/aapaper.layout
7746 \begin_layout Subsection
7750 \begin_layout Standard
7751 It is recommended you start from the example template distributed with \SpecialChar LyX
7753 If you are not using a template, note the following settings:
7756 \begin_layout Itemize
7763 Document\SpecialChar menuseparator
7766 dialog (OK, that one was obvious).
7769 \begin_layout Itemize
7770 Don't change the option
7773 \begin_inset space ~
7783 The whole layout is done by the macros, you shouldn't change anything.
7786 \begin_layout Subsection
7790 \begin_layout Standard
7791 First thing to enter is the header information.
7792 It consists of seven entries, of which some are optional.
7796 \begin_layout Itemize
7804 \begin_layout Itemize
7812 \begin_layout Itemize
7820 \begin_layout Itemize
7828 \begin_layout Itemize
7833 : [optional] if more than one author: whom to contact for offprint requests.
7836 \begin_layout Itemize
7841 : [optional] mail address for contacts.
7844 \begin_layout Itemize
7852 Received: <date>; Accepted <date>
7855 \begin_layout Standard
7856 There is no need to issue the
7862 command, this is done automatically by \SpecialChar LyX
7863 when the header is finished.
7864 Although the order of the single header entries doesn't matter it is advised
7865 to keep the above sequence, just to get the best optics and meets the layout
7866 of the real document.
7869 \begin_layout Standard
7870 If you want to place footnotes in the header block, e.
7871 \begin_inset space \thinspace{}
7875 \begin_inset space \space{}
7878 to state your present address, just use the standard footnote via the menu
7881 Insert\SpecialChar menuseparator
7886 will automagically use the term
7895 \begin_layout Standard
7896 In addition to these topics, the macros use three additional \SpecialChar LaTeX
7898 have no counterpart in \SpecialChar LyX
7902 \begin_layout Itemize
7909 to separate different names for more than one author and institute, respectivel
7913 \begin_layout Itemize
7920 to mark corresponding author/institute pairs.
7921 The institutes are numbered sequentially as they appear in the
7925 field, so you have to put a marker to each author.
7928 \begin_layout Itemize
7935 to supply an email address for fast contact.
7938 \begin_layout Standard
7939 In all cases, the appropriate command has to be entered in \SpecialChar LyX
7947 \begin_layout Subsection
7951 \begin_layout Standard
7952 The abstract should immediately follow the header block.
7953 With version 5 the abstract environment was changed to a command, and there
7954 is now a resctriction to only one paragraph.
7955 In addition, it should contain an entry with the keywords.
7956 This is not yet implemented for \SpecialChar LyX
7957 , therefore you have to enter the \SpecialChar LaTeX
7965 by hand and mark it as \SpecialChar LaTeX
7967 Refer to the example paper.
7970 \begin_layout Subsection
7971 Supported environments
7974 \begin_layout Standard
7975 The A&A paper layout supports the following environments for structuring
7979 \begin_layout Itemize
7985 \begin_layout Itemize
7991 \begin_layout Itemize
7997 \begin_layout Itemize
8003 \begin_layout Itemize
8009 \begin_layout Itemize
8015 \begin_layout Itemize
8021 \begin_layout Itemize
8027 \begin_layout Itemize
8033 \begin_layout Itemize
8039 \begin_layout Itemize
8045 \begin_layout Itemize
8052 \begin_layout Subsection
8053 Commands not supported by \SpecialChar LyX
8057 \begin_layout Standard
8058 Some commands are not yet supported by the
8062 layout for \SpecialChar LyX
8064 Some have already been mentioned.
8065 For the sake of completeness, they are listed all together here:
8068 \begin_layout Itemize
8076 \begin_layout Itemize
8084 \begin_layout Itemize
8092 \begin_layout Itemize
8100 \begin_layout Itemize
8108 \begin_layout Itemize
8116 \begin_layout Itemize
8124 \begin_layout Itemize
8132 \begin_layout Standard
8133 If you want to use any of these commands, you have to enter them yourself.
8136 Do not forget to mark them as \SpecialChar LaTeX
8140 \begin_layout Subsection
8141 Figure and Table Floats
8144 \begin_layout Standard
8146 provides support for the necessary float environments
8148 figure, figure*, table
8154 , therefore we won't tell much about it here.
8158 \begin_inset space ~
8164 Just remember that tables should be left-aligned.
8165 For that, select the table and change the alignment in
8167 Edit\SpecialChar menuseparator
8169 \begin_inset space ~
8175 \begin_layout Standard
8176 There is only one special thing: the figures with caption besides the figure.
8177 To create such a figure, you have to do the following:
8180 \begin_layout Enumerate
8181 Create a wide figure float:
8183 Insert\SpecialChar menuseparator
8184 Float\SpecialChar menuseparator
8187 , then right click in the figure and select
8193 \begin_inset space ~
8201 \begin_layout Enumerate
8202 Enter your caption text.
8205 \begin_layout Enumerate
8210 to move the cursor above the caption.
8213 \begin_layout Enumerate
8217 \begin_layout Enumerate
8218 Position the cursor behind the figure and insert a horizontal fill:
8220 Insert\SpecialChar menuseparator
8222 \begin_inset space ~
8225 Character\SpecialChar menuseparator
8227 \begin_inset space ~
8235 \begin_layout Enumerate
8236 Switch to \SpecialChar LaTeX
8240 \begin_inset space ~
8248 \begin_layout Enumerate
8258 Do not close the brace!
8261 \begin_layout Enumerate
8262 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8267 \begin_inset space ~
8279 \begin_layout Standard
8280 Also, refer to the figures in the example paper.
8283 \begin_layout Subsection
8287 \begin_layout Standard
8288 For submission, the paper has to be formated in a special double-spacing
8290 For this purpose, you have to give the option
8294 to the documentclass.
8295 This must be done using the extra class options field in the
8297 Document\SpecialChar menuseparator
8301 Just enter the string
8308 \begin_layout Subsection
8312 \begin_layout Standard
8317 directory contains an example paper written with \SpecialChar LyX
8319 It is the example paper from the original macro package, translated to
8322 Use it for inspiration, and compare the original \SpecialChar LaTeX
8323 code with \SpecialChar LyX
8327 \begin_layout Section
8332 \begin_layout Standard
8338 \begin_layout Subsection
8342 \begin_layout Standard
8344 is a set of macros produced by the American Astronomical Society to
8345 facilitate electronic manuscript submission to the three journals they
8346 publish: the Astrophysical Journal (including the Letters and Supplement),
8347 the Astronomical Journal, and the Publications of the Astronomical Society
8350 has proven to be an excellent tool for generating these documents, especially
8351 given its equation, citation, and figure handling capabilities.
8353 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8354 is the version described here, or higher.
8355 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8356 2.09 and are fundamentally
8357 incompatible with \SpecialChar LyX
8359 The AAS\SpecialChar TeX
8360 package may be downloaded from the AAS\SpecialChar TeX
8364 \begin_layout Standard
8365 \begin_inset VSpace medskip
8371 \begin_layout Standard
8373 \begin_inset Flex URL
8376 \begin_layout Plain Layout
8378 https://aas.org/aastex/aastex-downloads
8386 \begin_layout Standard
8387 \begin_inset VSpace medskip
8393 \begin_layout Standard
8394 A complete user guide is contained in that package and you should familiarize
8395 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8398 will not reduce the need to figure out all the AAS\SpecialChar TeX
8399 commands, it will only
8400 reduce the drudgery of typing everything in.
8401 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8403 completely to the requirements of the journal to which you are submitting
8407 \begin_layout Subsection
8408 Starting a New Paper
8411 \begin_layout Standard
8412 I strongly suggest that you start with the AAS\SpecialChar TeX
8416 File\SpecialChar menuseparator
8423 , enter the new file name, then choose the
8428 This will show the most common fields found in a manuscript.
8429 Simply overwrite the existing text (including the brackets,
8433 ) with the correct information.
8434 Many of the AAS\SpecialChar TeX
8435 commands and environments can be implemented directly in
8437 , but some cannot: most noticeably
8449 , which should stick out like a sore thumb if you actually just opened the
8451 For commands such as these, the \SpecialChar LaTeX
8452 code must be entered directly and marked
8454 Such commands are referred to as \SpecialChar TeX
8455 code, or Evil Red Text.
8456 I tried to minimize the amount of \SpecialChar TeX
8457 code needed in an AAS\SpecialChar TeX
8459 there is still a bit more required than any of us would like.
8462 \begin_layout Subsection
8463 Finishing Your Paper
8466 \begin_layout Standard
8467 When the paper is finished to your satisfaction and previews/prints correctly,
8469 \begin_inset Quotes eld
8473 \begin_inset Quotes erd
8476 actions which need to be done before you submit it to the journals.
8480 \begin_layout Enumerate
8481 Export your paper as a \SpecialChar LaTeX
8484 File\SpecialChar menuseparator
8485 Export\SpecialChar menuseparator
8493 \begin_layout Enumerate
8498 file with your favorite text editor
8499 \begin_inset Separator parbreak
8506 \begin_layout Enumerate
8507 remove the comment lines before the
8516 \begin_layout Enumerate
8521 usepackage...{fontenc}
8523 line if it appears (usually just after
8538 \begin_layout Enumerate
8539 remove everything between (and including) the
8551 commands, except for any commands you specifically put into the \SpecialChar LaTeX
8553 (which should appear immediately after the
8554 \begin_inset Quotes eld
8557 User specified \SpecialChar LaTeX
8559 \begin_inset Quotes erd
8570 \begin_layout Enumerate
8571 Run the resulting file through \SpecialChar LaTeX
8572 to make sure it still processes correctly.
8575 \begin_layout Enumerate
8576 Reread the journal requirements to make sure your filenames and formats
8580 \begin_layout Enumerate
8584 \begin_layout Subsection
8585 Comments On Specific Commands
8588 \begin_layout Standard
8589 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8596 ) gives a good description of each.
8597 Thus it's probably easiest for me to go down the list as found in the guide
8598 and offer comments where necessary.
8599 So let's begin \SpecialChar ldots
8603 \begin_layout Subsubsection
8604 Things that work as expected
8607 \begin_layout Standard
8608 Because they work as you might expect, I simply list them and the section
8709 begin{thebibliography}
8717 (2.13.2), all the cite commands and their variations (2.13.2), the generic
8718 graphicx figure commands (2.14.1),
8742 (2.15.4, amongst other places),
8769 \begin_layout Standard
8770 The following style options also work correctly:
8791 Simply put them in the
8797 Layout\SpecialChar menuseparator
8803 \begin_layout Subsubsection
8804 Things that work, but require more comment
8807 \begin_layout Standard
8808 The following items work, but require a little more discussion:
8811 \begin_layout Itemize
8812 These items are reserved for use by the journal editors, but you can put
8813 them into the \SpecialChar LaTeX
8814 preamble if you feel compelled to do so:
8847 \begin_layout Itemize
8848 These items may be placed in the \SpecialChar LaTeX
8849 preamble, and are included as blanks in
8871 \begin_layout Itemize
8878 (2.3) – can only be used
8879 \begin_inset Quotes eld
8883 \begin_inset Quotes erd
8886 , not in the middle of a paragraph.
8887 Use \SpecialChar TeX
8888 code if you need to embed it.
8891 \begin_layout Itemize
8898 (2.3) – will have extra {} after it.
8899 This should not cause an error.
8902 \begin_layout Itemize
8909 (2.6) – can only be used
8910 \begin_inset Quotes eld
8914 \begin_inset Quotes erd
8917 , not in the middle of a paragraph.
8918 Use \SpecialChar TeX
8919 code if you need to embed it.
8922 \begin_layout Itemize
8929 (2.8) – can't insert a cross-reference tag, you must type the tag name by
8933 \begin_layout Itemize
8947 \begin_layout Itemize
8954 (2.9) – will have extra {} after it.
8955 This should not cause an error.
8958 \begin_layout Itemize
8965 (2.11) – will have extra {} after it.
8966 This should not cause an error.
8969 \begin_layout Itemize
8976 (2.14.2) – you can insert an optional filename argument by placing the cursor
8977 at the beginning of the text and selecting
8979 Insert\SpecialChar menuseparator
8984 \begin_inset Quotes eld
8988 \begin_inset Quotes erd
8991 inserts an optional argument of the type needed by
8998 Hopefully it will be renamed someday.
9001 \begin_layout Itemize
9014 for the catalog ID optional parameter
9017 \begin_layout Itemize
9030 for the catalog ID optional parameter
9033 \begin_layout Subsubsection
9034 Things not implemented, use \SpecialChar TeX
9038 \begin_layout Standard
9061 setcounter{equation}
9063 (2.12), Journal name abbreviations (2.13.4),
9099 (2.15.4, insert it as the first element in the lefthand cell after where
9101 Don't use any of \SpecialChar LyX
9102 's rules in the table),
9114 (2.15.5), much of Misc (2.17, except
9165 \begin_layout Subsubsection
9166 Things that cannot be implemented
9169 \begin_layout Standard
9171 at least in any meaningful sort of way, so I suggest ignoring them.
9172 They are the references environment (2.13.3), and the deluxetable environment
9174 If you really, really need to use deluxetable, I suggest editing it in
9175 a separate file with a text editor, then using
9177 Insert\SpecialChar menuseparator
9179 \begin_inset space ~
9184 to include it in your \SpecialChar LyX
9190 file to see an example of this.
9193 \begin_layout Subsection
9194 FAQs, Tips, Tricks, and Other Ruminations
9197 \begin_layout Subsubsection
9198 Getting \SpecialChar LyX
9199 and AAS\SpecialChar TeX
9203 \begin_layout Standard
9204 It can be a bit tricky to get \SpecialChar LyX
9205 to recognize a new layout and document class.
9206 When all else fails, do this:
9209 \begin_layout Enumerate
9210 Make certain that \SpecialChar LaTeX
9211 can find AAS\SpecialChar TeX
9213 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9215 directory completely unrelated to \SpecialChar LaTeX
9216 or AAS\SpecialChar TeX
9217 and run \SpecialChar LaTeX
9225 \begin_layout Enumerate
9230 appears in \SpecialChar LyX
9238 \begin_layout Enumerate
9241 Tools\SpecialChar menuseparator
9245 , then restart \SpecialChar LyX
9249 \begin_layout Enumerate
9250 Open a regular new file, not from a template.
9251 Does AAS\SpecialChar TeX
9252 appear in the class list in
9254 Document\SpecialChar menuseparator
9260 \begin_layout Standard
9261 If you get a warning from an existing AAS\SpecialChar TeX
9262 document about not being able
9263 to find the AAS\SpecialChar TeX
9264 layout or a message about
9265 \begin_inset Quotes eld
9268 You should not mix title layouts with normal ones
9269 \begin_inset Quotes erd
9272 , things haven't been installed correctly.
9275 \begin_layout Subsubsection
9277 error processing a table
9280 \begin_layout Standard
9282 , by default, attempts to center the table caption/title.
9283 This seems to produce a bad interaction in AAS\SpecialChar TeX
9284 so you should click somewhere
9285 in the caption/title, then select
9287 Edit\SpecialChar menuseparator
9289 \begin_inset space ~
9303 This took care of it for me.
9306 \begin_layout Subsubsection
9310 \begin_layout Standard
9311 A couple of things: 1) I have noticed some funny spacing in the reference
9312 entries in the text.
9313 When you enter the bibliography item data, make sure their is
9317 space between the last author and the parenthesis setting off the year;
9321 \begin_inset space \thinspace{}
9325 \begin_inset space \space{}
9339 2) Entering the references at all is not obvious.
9340 The easiest thing is to start typing your first reference at the end of
9341 the document, then mark it as type
9346 That will put a small gray box in front of what you just typed.
9347 Click on the box to fill in the rest of the information.
9348 For new references, go to the end of an existing reference and press return.
9349 That will create a new line with its own box, etc.
9352 \begin_layout Subsubsection
9356 \begin_layout Standard
9357 Even though AAS\SpecialChar TeX
9358 provides its own figure commands (
9364 , for example), I much prefer \SpecialChar LaTeX
9365 's standard figure commands (with the default
9374 \begin_inset space ~
9377 commands as \SpecialChar TeX
9378 code into a Figure Float box if you desire, but I never have
9379 much luck getting the layout right.
9380 With the standard graphics, \SpecialChar LyX
9385 usepackage{graphicx}
9387 command into the \SpecialChar LaTeX
9388 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9390 interspersing the figures in the text.
9391 I believe ApJ accepts figures exactly this way now; AJ might still use
9393 \begin_inset Quotes eld
9396 stack everything at the end
9397 \begin_inset Quotes erd
9403 \begin_layout Subsubsection
9404 Things I could have done, but didn't
9407 \begin_layout Standard
9409 \begin_inset Quotes eld
9413 \begin_inset Quotes erd
9416 things I could have implemented, but chose not to.
9417 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9419 even though it is double-spaced in the paper manuscript.
9420 Also, I chose not to make separate layouts for the preprint and preprint2
9422 Since I assume you will spend most of your time in the plain manuscript
9423 mode anyway, I decided not to chew up more disk space with this.
9427 \begin_layout Subsection
9431 \begin_layout Standard
9432 Your mileage may vary.
9433 I've now had papers published by both ApJ and AJ that have had 98% of the
9434 effort done in \SpecialChar LyX
9435 ; the last 2% was the \SpecialChar LaTeX
9436 post-processing and a few cleanups.
9437 I have had no trouble with the submission process, and I'm sure the journals
9438 were never aware that there might be a difference.
9439 So, go forth and publish!
9442 \begin_layout Section
9443 AMS \SpecialChar LaTeX
9447 \begin_layout Standard
9457 \begin_layout Standard
9458 \begin_inset VSpace bigskip
9464 \begin_layout Standard
9466 The AMS \SpecialChar LaTeX
9467 layouts are set up to conform to suggested styles for mathematical
9468 papers to be submitted to American Mathematical Society publications.
9469 The layouts are not tailored to a specific journal, but easily can be.
9470 You should refer to the AMS documentation for specific instructions for
9471 each journal (usually it will entail only changing a single line in the
9474 That documentation is available on the Web at
9475 \begin_inset Flex URL
9478 \begin_layout Plain Layout
9486 \begin_inset Flex URL
9489 \begin_layout Plain Layout
9491 ftp://ftp.ams.org/pub/tex/amslatex/
9497 These layouts are appropriate, and useful, for any mathematical writing.
9501 \begin_layout Standard
9502 There are two basic AMS \SpecialChar LaTeX
9506 \begin_layout Itemize
9507 amsart: The standard AMS article format.
9510 \begin_layout Itemize
9511 amsbook: the standard AMS book (really, monograph) format.
9515 \begin_layout Standard
9516 The layouts themselves contain only the minimum necessary to use the AMS
9518 They do not, in particular, contain any of the `theorem' environments used
9519 for setting theorems, lemmas, and the like.
9520 These are contained, instead, in the
9521 \begin_inset Flex Code
9524 \begin_layout Plain Layout
9530 module, which is loaded by default when you select one of the AMS classes.
9531 (It can also be used with other classes and can be removed, if you would
9532 rather use something else.) Less commonly used environments are in the
9533 \begin_inset Flex Code
9536 \begin_layout Plain Layout
9537 Theorems (AMS-Extended)
9542 module, which must be loaded manually.
9545 \begin_layout Standard
9546 By default, theorems and the like are numbered consecutively throughout
9547 the document, but this may be modified by loading the module
9548 \begin_inset Flex Code
9551 \begin_layout Plain Layout
9552 Theorems (Order by Section)
9557 or, if you are using
9558 \begin_inset Flex Code
9561 \begin_layout Plain Layout
9568 \begin_inset Flex Code
9571 \begin_layout Plain Layout
9572 Theorems (Order by Chapter)
9578 These will number the results as
9579 \begin_inset Formula $n.m$
9582 , where the first number refers to the section (or chapter) and the second
9583 refers to the total number of results so far in that section (or chapter).
9584 Many environments are also available unnumbered.
9585 These are indicated by an asterisk at the end.
9586 If you happen to want
9590 unnumbered results, the module
9591 \begin_inset Flex Code
9594 \begin_layout Plain Layout
9600 provides that option.
9603 \begin_layout Standard
9604 Note that these modules do not
9608 to be used with the AMS classes.
9609 It is perfectly possible to use the
9610 \begin_inset Flex Code
9613 \begin_layout Plain Layout
9619 module, and the others mentioned, with other classes, such as
9620 \begin_inset Flex Code
9623 \begin_layout Plain Layout
9630 \begin_inset Flex Code
9633 \begin_layout Plain Layout
9640 \begin_inset Flex Code
9643 \begin_layout Plain Layout
9652 \begin_layout Subsection
9653 What these layouts provide
9656 \begin_layout Standard
9657 There is a long list of included environments provided by these layouts.
9658 In AMS-\SpecialChar LaTeX
9659 , there is, in fact, an opportunity to define an unlimited variety
9660 of `theorem' environments.
9661 However, the AMS recommends the environments that are available in \SpecialChar LyX
9666 \begin_layout Standard
9667 The following environments—as well as the standard environments, such as
9669 \begin_inset Flex Noun
9672 \begin_layout Plain Layout
9679 \begin_inset Flex Noun
9682 \begin_layout Plain Layout
9689 \begin_inset Flex Noun
9692 \begin_layout Plain Layout
9699 \begin_inset Flex Noun
9702 \begin_layout Plain Layout
9709 \begin_inset Flex Noun
9712 \begin_layout Plain Layout
9719 \begin_inset Flex Code
9722 \begin_layout Plain Layout
9729 \begin_inset Flex Code
9732 \begin_layout Plain Layout
9741 \begin_layout Description
9742 Address This should be the author's permanent address.
9745 \begin_layout Description
9747 \begin_inset space ~
9750 Address This should be the author's temporary address at the time of submission,
9751 if different from the Address.
9754 \begin_layout Description
9755 Email Author's e-mail address
9758 \begin_layout Description
9759 URL Author's Web address, if desired.
9762 \begin_layout Description
9763 Keywords Key words or phrases used to identify specific topics discussed
9767 \begin_layout Description
9768 Subjectclass These refer to the AMS Subject Classifications, published and
9771 Mathematical Reviews
9774 These are also available online at the AMS cites listed above.
9777 \begin_layout Description
9781 \begin_layout Description
9785 \begin_layout Description
9789 \begin_layout Standard
9790 The following environments are provided by both the
9791 \begin_inset Flex Code
9794 \begin_layout Plain Layout
9801 \begin_inset Flex Code
9804 \begin_layout Plain Layout
9810 modules, in the latter case in both starred (unnumbered) and unstarred
9811 (numbered) versions.
9812 These same environments are provided only in the starred versions by the
9814 \begin_inset Flex Code
9817 \begin_layout Plain Layout
9826 \begin_layout Theorem
9827 This is typically used for the statements of major results.
9831 \begin_layout Corollary*
9832 This is used for statements which follow fairly directly from previous statement
9834 Again, these can be major results.
9839 These are smaller results needed to prove other statements.
9842 \begin_layout Proposition
9843 These are less major results which (hopefully) add to the general theory
9847 \begin_layout Conjecture
9848 These are statements provided without justification, which the author does
9849 not know how to prove, but which seem to be true (to the author, at least).
9852 \begin_layout Definition*
9853 Guess what this is for.
9854 The font is different for this environment than for the previous ones.
9858 \begin_layout Example*
9859 Used for examples illustrating proven results.
9862 \begin_layout Problem
9863 It's not really known what this is for.
9864 You should figure it out.
9867 \begin_layout Exercise*
9868 Write a description for this one.
9871 \begin_layout Remark
9872 This environment is also a type of theorem, usually a lesser sort of observation.
9875 \begin_layout Claim*
9876 Often used in the course of giving a proof of a larger result.
9880 Generally, these are used to break up long arguments, using specific instances
9886 The numbering scheme for cases is on its own, not together with other numbered
9892 At the end of this environment, a QED symbol (usually a square, but it can
9893 vary with different styles) is placed.
9894 If you want to have other environments within this one—for example, Case
9895 environments—and have the QED symbol appear only after them, then the other
9896 environments need to be nested within the proof environment.
9899 Nesting Environments
9905 for information on nesting.
9908 \begin_layout Standard
9909 And these environments are provided by
9910 \begin_inset Flex Code
9913 \begin_layout Plain Layout
9914 Theorems (AMS-Extended)
9922 \begin_layout Criterion*
9923 A required condition.
9926 \begin_layout Algorithm*
9927 A general procedure to be used.
9930 \begin_layout Axiom*
9931 This is a property or statement taken as true within the system being discussed.
9934 \begin_layout Condition*
9935 Sometimes used to state a condition assumed within the present context of
9940 Similar to a Remark.
9943 \begin_layout Notation*
9944 Used for the explanation of, yes, notation.
9947 \begin_layout Summary
9948 Do we really need to tell you?
9951 \begin_layout Acknowledgement*
9955 \begin_layout Conclusion*
9956 Sometimes used at the end of a long train of argument.
9960 Used in a way similar to Proposition, though perhaps lower on the scale.
9963 \begin_layout Standard
9964 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
9967 They need to be available on your system in order to use these environments.
9970 \begin_layout Section
9978 \begin_layout Standard
9984 \begin_layout Subsection
9988 \begin_layout Standard
9989 These are the layout files for some of the journals of the American Geophysical
9991 It is assumed that you have both the AGU's own class files and AGUplus
9992 installed (everything to be found at
9993 \begin_inset Flex URL
9996 \begin_layout Plain Layout
9998 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10006 \begin_layout Subsection
10010 \begin_layout Standard
10020 They are still called this in the \SpecialChar LyX
10021 GUI, though their \SpecialChar LaTeX
10034 \begin_layout Standard
10035 Newly defined styles are
10072 These are mostly manuscript attributes and defined in the AGU class documentati
10076 \begin_layout Standard
10077 I suspect this is still badly incomplete.
10080 \begin_layout Subsection
10084 \begin_layout Standard
10101 \begin_layout Subsection
10105 \begin_layout Itemize
10108 Journal of Geophysical Research
10117 \begin_layout Standard
10118 Add your own, it isn't so hard! Look at the
10129 \begin_layout Subsection
10130 Bugs and things to remember
10133 \begin_layout Standard
10134 In order to use the new layouts, you must remember to do the following for
10138 \begin_layout Enumerate
10144 This can be done in the
10146 Layout\SpecialChar menuseparator
10151 Document\SpecialChar menuseparator
10155 (AGU articles are always in English, right? So
10159 choose a language.)
10162 \begin_layout Enumerate
10167 into the document's
10172 (Yes, this is a bug.)
10175 \begin_layout Enumerate
10176 Make sure you use the
10180 bibliography style, by entering
10184 into the second field of the Bib\SpecialChar TeX
10186 None of the standard styles will do.
10189 \begin_layout Section
10193 \begin_layout Standard
10199 \begin_layout Subsection
10203 \begin_layout Standard
10204 Broadway is for writing plays.
10205 The format is more decorative than Hollywood, and much less standardized.
10206 This format should be suitable for workshops.
10209 \begin_layout Subsection
10213 \begin_layout Standard
10214 The same as in Hollywood.
10217 \begin_layout Subsection
10221 \begin_layout Standard
10226 names as labels then cross-reference the label to insert the name.
10227 The cross-reference dialog will show the current cast of characters.
10230 \begin_layout Subsection
10231 Paper size and Margins
10234 \begin_layout Standard
10235 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10238 \begin_layout Subsection
10242 \begin_layout Standard
10243 The following environments are available.
10244 You can use broadway.bind to get the bind keys shown at the right.
10247 \begin_layout Itemize
10251 \begin_inset Newline newline
10256 You should not have to use this, but it is here for anything that does not
10260 \begin_layout Itemize
10264 \begin_inset space \hfill{}
10268 \begin_inset Newline newline
10273 Used to describe stage setting and the action.
10274 First use of speaker names in all CAPs.
10277 \begin_layout Itemize
10281 \begin_inset space \hfill{}
10285 \begin_inset Newline newline
10290 Automatically numbered.
10291 On screen it will be arabic, but will print as Roman.
10294 \begin_layout Itemize
10298 \begin_inset space \hfill{}
10302 \begin_inset Newline newline
10312 It is just centered text.
10315 \begin_layout Itemize
10319 \begin_inset space \hfill{}
10323 \begin_inset Newline newline
10328 Not automatically numbered.
10329 You supply the number.
10330 This is because I couldn't figure out how.
10333 \begin_layout Itemize
10337 \begin_inset space \hfill{}
10341 \begin_inset Newline newline
10346 A special case of Narrative to describe the setting and action as the curtain
10350 \begin_layout Itemize
10354 \begin_inset space \hfill{}
10358 \begin_inset Newline newline
10363 The speaker's (actor's) title, centered in all CAPS.
10366 \begin_layout Itemize
10370 \begin_inset space \hfill{}
10374 \begin_inset Newline newline
10379 Instructions to the speaker.
10380 The parentheses are automatically inserted.
10381 The ( will appear on screen, but both will be in the printed play.
10382 This environment is only used within
10389 \begin_layout Itemize
10393 \begin_inset space \hfill{}
10397 \begin_inset Newline newline
10402 What the Speaker says.
10405 \begin_layout Itemize
10409 \begin_inset space \hfill{}
10413 \begin_inset Newline newline
10418 The curtain comes down.
10421 \begin_layout Itemize
10425 \begin_inset space \hfill{}
10431 \begin_layout Itemize
10435 \begin_inset space \hfill{}
10441 \begin_layout Itemize
10445 \begin_inset space \hfill{}
10451 \begin_layout Standard
10455 \begin_layout Section
10459 \begin_layout Standard
10464 can be used to type letters according to German conventions.
10465 A template file is included in
10467 .../lyx/share/templates
10469 for you to use as a starting point.
10472 \begin_layout Section
10480 \begin_layout Standard
10486 \begin_layout Subsection
10490 \begin_layout Standard
10491 This is the layout file for the European Geophysical Society journals.
10496 can be downloaded from the web site of the EGS under
10497 \begin_inset Flex URL
10500 \begin_layout Plain Layout
10510 \begin_layout Subsection
10514 \begin_layout Standard
10517 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10525 The current layout file is unfortunately very unmodular and would benefit
10526 from using the various
10533 \begin_layout Section
10537 \begin_layout Standard
10538 See the \SpecialChar LyX
10544 It contains all infos you need.
10547 \begin_layout Section
10550 Foil\SpecialChar TeX
10554 \begin_inset CommandInset label
10563 \begin_layout Standard
10569 \begin_layout Subsection
10573 \begin_layout Standard
10574 This section describes how to use \SpecialChar LyX
10575 to make slides for overhead projectors.
10576 There are two document classes that can do this: the default slides class
10579 Foil\SpecialChar TeX
10583 This section documents the latter.
10586 \begin_layout Standard
10587 I'm going to say this again, nice and clear, so that there's no misunderstanding
10591 \begin_layout Standard
10592 \begin_inset VSpace bigskip
10598 \begin_layout Standard
10602 This section documents the class
10603 \begin_inset Quotes eld
10611 \begin_inset Quotes erd
10619 \begin_layout Standard
10620 \begin_inset VSpace bigskip
10626 \begin_layout Standard
10627 If you're looking for the documentation for
10628 \begin_inset Quotes eld
10636 \begin_inset Quotes erd
10639 , check out section
10640 \begin_inset space ~
10644 \begin_inset CommandInset ref
10646 reference "sec:slitex"
10651 If your machine doesn't have the
10656 \begin_inset Quotes eld
10664 \begin_inset Quotes erd
10667 ] installed, you'll probably have to use the default
10671 class, which isn't quite as good as
10676 \begin_layout Standard
10681 class is designed for use with version 2.1 of the
10686 class file which is now an integral part of \SpecialChar LaTeX2e
10690 \begin_layout Subsection
10694 \begin_layout Standard
10695 Obviously, to use this document class, you need to select
10696 \begin_inset Quotes eld
10704 \begin_inset Quotes erd
10714 \begin_inset space ~
10720 There are some settings in the
10723 \begin_inset space ~
10728 dialog that you should know about that are specific to this class:
10731 \begin_layout Itemize
10732 Don't change the options
10743 \begin_inset space ~
10749 They're ignored by the
10756 \begin_layout Itemize
10757 The default font size is 20
10758 \begin_inset space \thinspace{}
10761 pt with the other options being 17
10762 \begin_inset space \thinspace{}
10766 \begin_inset space \thinspace{}
10770 \begin_inset space \thinspace{}
10776 \begin_layout Itemize
10777 The default font is
10785 but all math equations are still typeset in the usual roman font.
10788 \begin_layout Itemize
10791 Foil\SpecialChar TeX
10794 supports A4 and Letter paper sizes as well as a special size for working
10796 \begin_inset space \thinspace{}
10800 It doesn't support A5, B5, legal or executive paper sizes.
10803 \begin_layout Itemize
10804 Don't bother changing the
10808 settings because they are ignored anyway.
10809 All floats appear where they are defined in the text.
10812 \begin_layout Itemize
10817 setting behaves a bit differently for this class.
10820 Foil\SpecialChar TeX
10823 provides extensive footer and header capabilities including a user-defined
10826 \begin_inset space ~
10830 \begin_inset CommandInset ref
10832 reference "sec:foilfoot"
10837 The title page is treated differently to all other pages in the document
10846 has the logo centered at the bottom of the page (if one is defined).
10847 The possible page style choices and what they do are as follows:
10848 \begin_inset Separator parbreak
10855 \begin_layout Labeling
10856 \labelwidthstring MMMMMMM
10863 The final output contains no page numbers, or other headers or footers
10864 (except footnotes of course).
10868 \begin_layout Labeling
10869 \labelwidthstring MMMMMMM
10876 The final output contains page numbers centered at the bottom of the page.
10877 No other headings or footers (other than footnotes).
10880 \begin_layout Labeling
10881 \labelwidthstring MMMMMMM
10886 Page numbers in lower right corner.
10887 Additional headers and footers are also shown.
10888 This is also the default.
10891 \begin_layout Labeling
10892 \labelwidthstring MMMMMMM
10897 Gives you access to the
10901 package although its use with
10903 Foil\SpecialChar TeX
10906 is discouraged by the writer of the
10908 Foil\SpecialChar TeX
10911 package because of some potential page layout clashes.
10915 \begin_layout Subsubsection
10919 \begin_layout Standard
10920 The following options may be used in the extra class options in the
10922 Document\SpecialChar menuseparator
10928 \begin_layout Labeling
10929 \labelwidthstring MMMMMMx
10934 This sets up the page layout for 7.33
10935 \begin_inset space \thinspace{}
10939 \begin_inset space \thinspace{}
10942 in paper, which is about the same aspect ratio as a 35
10943 \begin_inset space \thinspace{}
10946 mm slide, making it a bit easier to work with this medium.
10949 \begin_layout Labeling
10950 \labelwidthstring MMMMMMx
10955 Places a rule across the page below the header on every page except the
10959 \begin_layout Labeling
10960 \labelwidthstring MMMMMMx
10965 Places a rule across the page above the footer on every page except the
10969 \begin_layout Labeling
10970 \labelwidthstring MMMMMMx
10975 This is automatically set each time you create a new
10982 Foil\SpecialChar TeX
10985 to use the dvips driver to rotate those pages that are set as landscape
10989 \begin_layout Labeling
10990 \labelwidthstring MMMMMMx
10995 Simply changes the page dimensions to those of a landscape page but doesn't
10997 Thus if you use this option you need to use an external program to rotate
10998 each page or feed your paper through your printer as landscape.
10999 Note that this option effectively reverses the roles of the
11007 environments (don't worry these are described in the next section).
11010 \begin_layout Labeling
11011 \labelwidthstring MMMMMMx
11016 Equation numbers on the left.
11019 \begin_layout Labeling
11020 \labelwidthstring MMMMMMx
11025 Flush-left equations.
11028 \begin_layout Subsection
11029 Supported Environments
11032 \begin_layout Standard
11033 Most of the environments commonly supported in other classes are also supported
11039 There are several additional environments provided by
11041 Foil\SpecialChar TeX
11044 as well as a couple added by \SpecialChar LyX
11046 The following environments are shared with other classes:
11049 \begin_layout Standard
11050 \begin_inset Flex Multiple Columns
11053 \begin_layout Itemize
11059 \begin_layout Itemize
11065 \begin_layout Itemize
11071 \begin_layout Itemize
11077 \begin_layout Itemize
11083 \begin_layout Itemize
11090 \begin_layout Itemize
11096 \begin_layout Itemize
11102 \begin_layout Itemize
11108 \begin_layout Itemize
11114 \begin_layout Itemize
11120 \begin_layout Itemize
11126 \begin_layout Itemize
11132 \begin_layout Itemize
11138 \begin_layout Itemize
11144 \begin_layout Itemize
11150 \begin_layout Itemize
11156 \begin_layout Itemize
11167 \begin_layout Standard
11168 That is, all the major environments apart from the sectioning environments.
11169 Since foils are essentially self-contained sections, with a title and body,
11172 Foil\SpecialChar TeX
11175 provides specific commands for starting new foils and these are:
11178 \begin_layout Itemize
11184 \begin_layout Itemize
11190 \begin_layout Standard
11192 also provides slightly modified versions of these two environments called:
11195 \begin_layout Itemize
11201 \begin_layout Itemize
11204 ShortRotatefoilhead
11207 \begin_layout Standard
11208 and the differences will be explained in the next section.
11211 \begin_layout Standard
11212 Since foils are often used in presenting ideas or new theorems and such
11215 Foil\SpecialChar TeX
11218 also provides a comprehensive box of goodies for presenting them:
11221 \begin_layout Standard
11222 \begin_inset Flex Multiple Columns
11225 \begin_layout Itemize
11231 \begin_layout Itemize
11237 \begin_layout Itemize
11243 \begin_layout Itemize
11249 \begin_layout Itemize
11255 \begin_layout Itemize
11261 \begin_layout Itemize
11267 \begin_layout Itemize
11273 \begin_layout Itemize
11279 \begin_layout Itemize
11285 \begin_layout Itemize
11296 \begin_layout Standard
11297 The starred versions are unnumbered while the unstarred versions are numbered.
11298 There are also two list environments added by \SpecialChar LyX
11302 \begin_layout Itemize
11308 \begin_layout Itemize
11314 \begin_layout Standard
11317 Foil\SpecialChar TeX
11320 provides some powerful header and footer capabilities that are best set
11321 in the preamble although they may be set at any point in a document.
11322 If you want to change these settings in your document the best place to
11323 do so is at the very top of a foil, i.
11324 \begin_inset space \thinspace{}
11330 \begin_inset space \space{}
11335 straight after the foilhead.
11338 \begin_layout Standard
11339 For this purpose, the following command styles are provided [
11346 \begin_layout Standard
11347 \begin_inset Flex Multiple Columns
11350 \begin_layout Itemize
11354 \begin_inset space ~
11360 \begin_layout Itemize
11366 \begin_layout Itemize
11370 \begin_inset space ~
11376 \begin_layout Itemize
11380 \begin_inset space ~
11386 \begin_layout Itemize
11390 \begin_inset space ~
11396 \begin_inset Separator parbreak
11403 \begin_layout Plain Layout
11404 \begin_inset space ~
11416 \begin_layout Standard
11417 There are also a few commands provided by
11419 Foil\SpecialChar TeX
11422 that aren't directly supported by \SpecialChar LyX
11423 but I'll tell you what they do and how
11424 to use them in section
11425 \begin_inset space ~
11429 \begin_inset CommandInset ref
11431 reference "sec:unsuppfoils"
11438 \begin_layout Subsection
11439 Building a Set of Foils
11442 \begin_layout Standard
11443 This section will give a simple introduction to using the different environments
11444 to build a set of foils.
11445 If you want to see an example set of foils, take a look at the
11449 file you find in \SpecialChar LyX
11457 \begin_layout Subsubsection
11458 Give It a Title Page
11461 \begin_layout Standard
11462 Unlike other classes that provide
11482 creates the title on a page of its own.
11483 If you leave out the
11487 environment \SpecialChar LaTeX
11488 will substitute the current date (every time you regenerate
11492 \begin_layout Subsubsection
11496 \begin_layout Standard
11497 As I mentioned earlier, there are four ways of starting a new foil.
11498 For portrait foils you should use
11507 The difference between these two environments is the amount of space between
11508 the title of the foil (the foilhead) and the body of the foil.
11511 \begin_layout Standard
11512 Landscape foils are generated using the
11518 ShortRotatefoilhead
11521 Again the only difference is the spacing between foilhead and body.
11522 Both of the short versions have 0.5
11523 \begin_inset space ~
11526 inches less separation between the foilhead and the body.
11530 \begin_layout Standard
11531 One problem with the support for landscape foils is the requirement that
11532 you have to use the
11536 driver to generate the PostScript output otherwise the foils won't be rotated.
11537 It is possible to get landscape foils even if you haven't got the
11541 driver provided you can feed your foils sideways through your printer ;-)
11544 \begin_layout Subsubsection
11545 Theorems, Lemmas, Proofs and more
11548 \begin_layout Standard
11549 Due to a small bug in \SpecialChar LyX
11550 you can't have two of the same type of these environments
11551 directly following each other.
11552 They must be separated by something.
11553 If you try, you will just be extending the previous environment as if you
11554 had merged the two environments together.
11555 So, how do you get around this problem? The simplest option is to insert
11556 some text between the two environments or add a
11561 environment between the two with just a
11562 \begin_inset Quotes eld
11570 \begin_inset Quotes erd
11574 This will force \SpecialChar LyX
11575 to produce two separate environments and hence the correct
11578 An example is provided in the example file included with the \SpecialChar LyX
11580 Remember, this problem only occurs if you are trying to place two of the
11581 same type of theorem-like environments one directly after the other.
11584 \begin_layout Subsubsection
11588 \begin_layout Standard
11589 You get all the commonly supported list styles found in other classes as
11590 well as two new ones.
11591 I'll only describe the new ones here.
11592 If you want to find out more about the other list environments check out
11598 If you intend to use itemized lists you might also want to read about the
11602 \begin_inset space ~
11606 \begin_inset space ~
11611 dialog described above in section
11612 \begin_inset space ~
11616 \begin_inset CommandInset ref
11618 reference "sec:bullet"
11625 \begin_layout Standard
11626 The two new list styles,
11634 , are designed to make it easier for you to create lists of do's and don'ts
11635 or right and wrong by providing dedicated environments that use a tick
11636 or a cross as the label of the list.
11637 These lists are in fact dedicated variants of the
11642 They do however require that you have the
11646 packages installed.
11649 \begin_layout Subsubsection
11653 \begin_layout Standard
11656 Foil\SpecialChar TeX
11659 redefines the floating tables and figures so that they appear exactly where
11660 they are in the text rather than pushing them to the top of the page or
11661 to some user specified location.
11662 In fact if you change the float placement settings they are simply ignored.
11665 \begin_layout Subsubsection
11666 Page Headers and Footers
11667 \begin_inset CommandInset label
11669 name "sec:foilfoot"
11676 \begin_layout Standard
11680 \begin_inset space ~
11689 are two commands used to control the left-footer text string.
11690 The first is meant to allow you to include a graphic logo on your foils
11692 \begin_inset Quotes eld
11697 Foil\SpecialChar TeX
11701 \begin_inset Quotes erd
11705 While the second is meant to provide a classification for the audience,
11709 \begin_inset space \thinspace{}
11715 \begin_inset space \space{}
11719 It is empty by default.
11722 \begin_layout Standard
11723 The remaining page corners can be filled by
11726 \begin_inset space ~
11731 (which defaults to page numbers),
11734 \begin_inset space ~
11742 \begin_inset space ~
11750 \begin_layout Subsection
11753 Foil\SpecialChar TeX
11757 \begin_inset CommandInset label
11759 name "sec:unsuppfoils"
11766 \begin_layout Standard
11767 All the commands mentioned below need to be set in a
11777 within another environment.
11780 \begin_layout Subsubsection
11784 \begin_layout Standard
11785 All lengths are adjusted using the
11808 should be replaced by the name given to the length you want to change and
11813 is the length value.
11814 All lengths should be specified in units of length such as inches (
11826 ) or relative to some document or font-based length such as
11836 \begin_layout Standard
11837 It's possible to change the spacing between a foilhead and the body of the
11838 foil by adjusting the length specified by
11845 For example, to make
11850 \begin_inset space \space{}
11853 in closer to their bodies put the following in the preamble:
11859 foilheadskip}{-0.5in}
11862 \begin_layout Standard
11863 The spacings around floats can be adjusted by setting these lengths:
11866 \begin_layout Labeling
11867 \labelwidthstring MMMMMMMMMMM
11874 Separation between the text and the top of the float
11877 \begin_layout Labeling
11878 \labelwidthstring MMMMMMMMMMM
11885 Separation between the float and the caption
11888 \begin_layout Labeling
11889 \labelwidthstring MMMMMMMMMMM
11896 Separation between the caption and the following text
11899 \begin_layout Labeling
11900 \labelwidthstring MMMMMMMMMMM
11907 You can make the captions narrower than the surrounding text by adjusting
11909 Best done relative to
11918 \begin_layout Standard
11919 There are also several title page related lengths that you may find useful
11920 if you have a long title or several authors:
11923 \begin_layout Labeling
11924 \labelwidthstring MMMMMMMMMMM
11931 Separation from headers to
11936 \begin_layout Labeling
11937 \labelwidthstring MMMMMMMMMMM
11955 \begin_layout Labeling
11956 \labelwidthstring MMMMMMMMMMM
11970 \begin_layout Labeling
11971 \labelwidthstring MMMMMMMMMMM
11987 \begin_layout Labeling
11988 \labelwidthstring MMMMMMMMMMM
12004 \begin_layout Standard
12005 The last length related command affects all the list environments.
12016 a list environment then all the vertical spacing between the list items
12018 Note that this is a command not a length so it doesn't require
12024 like the stuff mentioned above.
12027 \begin_layout Subsubsection
12028 Headers and Footers
12031 \begin_layout Standard
12044 commands control whether the logo in the
12048 definition appear on a given page.
12055 in the preamble then none of the foils will have the logo on them.
12056 If you don't want the logo on a particular page place the
12062 directly after the foilhead of that page and the
12068 directly after the next foilhead.
12071 \begin_layout Standard
12072 If you decide to use the
12076 page style setting in the
12079 \begin_inset space ~
12084 dialog you should probably add
12094 to your preamble so headers and footers on landscape pages are correctly
12095 placed when rotated.
12096 This is due to some clashes between the page layouts provided by the
12107 \begin_layout Section
12108 Hollywood (Hollywood spec scripts)
12111 \begin_layout Standard
12117 \begin_layout Subsection
12121 \begin_layout Standard
12122 Getting the format of a Hollywood script right is a
12123 \begin_inset Quotes eld
12127 \begin_inset Quotes erd
12130 It is designed to make the readers focus on content and to be easy and
12131 familiar for the actors to read.
12132 Each page of a script should be one minute of film.
12133 Nothing goes in a script that you cannot see or hear on screen.
12134 The courier 12 pt font should be used throughout.
12138 \begin_layout Subsection
12142 \begin_layout Standard
12143 Speakers' lines should NEVER break in mid-sentence.
12144 If a speaker's lines continue over a page break, repeat the
12148 title followed by (Cont'd).
12151 \begin_layout Subsection
12155 \begin_layout Standard
12160 names as labels then cross-reference the label to insert the name.
12161 The cross-reference dialog will show the current cast of characters.
12162 You can use this to insert the speaker name in narratives also.
12165 \begin_layout Subsection
12166 Paper size and Margins
12169 \begin_layout Standard
12170 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12173 \begin_layout Subsection
12177 \begin_layout Standard
12178 The following environments are available.
12179 You can use hollywood.bind to get the bind keys shown at the right.
12182 \begin_layout Itemize
12186 \begin_inset Newline newline
12191 Used where nothing else works.
12195 \begin_layout Itemize
12201 \begin_inset space \hfill{}
12209 \begin_inset Newline newline
12212 Usually followed by something like
12213 \begin_inset Quotes eld
12216 on Sally waking up.
12217 \begin_inset Quotes erd
12223 \begin_layout Itemize
12227 \begin_inset space \hfill{}
12231 \begin_inset Newline newline
12236 Introduces a new INTERIOR camera set-up.
12237 Always followed by DAY or NIGHT, or something similar to define the lighting
12239 Everthing on this line in CAPS.
12242 \begin_layout Itemize
12246 \begin_inset space \hfill{}
12250 \begin_inset Newline newline
12255 Introduces a new EXTERIOR camera set-up.
12256 Everthing on this line in CAPS.
12259 \begin_layout Itemize
12263 \begin_inset space \hfill{}
12267 \begin_inset Newline newline
12272 The character speaking.
12275 \begin_layout Itemize
12279 \begin_inset space \hfill{}
12283 \begin_inset Newline newline
12288 Instructions to the speaker.
12289 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12291 Both will be printed.
12294 \begin_layout Itemize
12298 \begin_inset space \hfill{}
12302 \begin_inset Newline newline
12314 \begin_layout Itemize
12318 \begin_inset space \hfill{}
12322 \begin_inset Newline newline
12327 Camera movement instruction.
12329 \begin_inset space \thinspace{}
12333 \begin_inset space \space{}
12339 \begin_layout Itemize
12343 \begin_inset space \hfill{}
12349 \begin_layout Itemize
12353 \begin_inset space \hfill{}
12359 \begin_layout Itemize
12363 \begin_inset space \hfill{}
12369 \begin_layout Itemize
12373 \begin_inset space \hfill{}
12379 \begin_layout Subsection
12383 \begin_layout Itemize
12387 \begin_layout Itemize
12391 \begin_layout Itemize
12393 \begin_inset space \thinspace{}
12400 \begin_layout Itemize
12405 \begin_layout Itemize
12406 PAN — camera movement
12409 \begin_layout Itemize
12410 INSERT — cut to close-up of
12413 \begin_layout Section
12417 \begin_layout Standard
12420 Panayotis Papasotiriou
12423 \begin_layout Subsection
12427 \begin_layout Standard
12428 The ijmpc package is a set of macros that facilitates electronic manuscript
12431 International Journal of Modern Physics C
12434 Similarly, the ijmpd package is for creating manuscripts to be submitted
12437 International Journal of Modern Physics D
12440 Both journals are published by World Scientific.
12441 The corresponding document classes are named
12450 These files, together with instructions for the authors, can be downloaded
12452 \begin_inset Flex URL
12455 \begin_layout Plain Layout
12457 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12463 \begin_inset Flex URL
12466 \begin_layout Plain Layout
12468 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12474 Both packages are modified versions of the standard
12475 \begin_inset Quotes eld
12479 \begin_inset Quotes erd
12482 package, and they are almost (but not exactly) identical.
12483 Most of their features are supported by \SpecialChar LyX
12485 I have used \SpecialChar LyX
12486 successfully to write articles submitted to both journals
12487 without any problem.
12490 \begin_layout Subsection
12494 \begin_layout Standard
12495 As usual, the easiest way to write a paper is to start with a template.
12498 File\SpecialChar menuseparator
12517 This will give an (almost) empty document that includes the most common
12518 fields found in a manuscript.
12519 Simply overwrite the existing text (including the brackets,
12524 You should keep in mind the following remarks.
12527 \begin_layout Enumerate
12529 won't let you change the font size and the page style of the document,
12530 because such modifications are not allowed by both packages.
12533 \begin_layout Enumerate
12534 The language of the document should not be changed.
12535 Before previewing your paper, be sure that the babel package is not used.
12536 To do this, click on
12538 Tools\SpecialChar menuseparator
12549 checkbox in the language settings, and click on
12557 , if you wish to make this change permanent).
12560 \begin_layout Enumerate
12562 \begin_inset Quotes eld
12566 \begin_inset Quotes erd
12569 style must be used to define keywords.
12572 \begin_layout Enumerate
12573 The ijmpc package provides a style named
12574 \begin_inset Quotes eld
12577 Classification Codes
12578 \begin_inset Quotes erd
12581 , which can be used to define classification codes, such as PACS numbers.
12582 Note that this facility is not supported by the ijmpd package.
12585 \begin_layout Enumerate
12586 Several new environments are available:
12587 \begin_inset Quotes eld
12591 \begin_inset Quotes erd
12595 \begin_inset Quotes eld
12599 \begin_inset Quotes erd
12603 \begin_inset Quotes eld
12607 \begin_inset Quotes erd
12611 \begin_inset Quotes eld
12615 \begin_inset Quotes erd
12619 \begin_inset Quotes eld
12623 \begin_inset Quotes erd
12627 \begin_inset Quotes eld
12631 \begin_inset Quotes erd
12635 \begin_inset Quotes eld
12639 \begin_inset Quotes erd
12643 \begin_inset Quotes eld
12647 \begin_inset Quotes erd
12651 \begin_inset Quotes eld
12655 \begin_inset Quotes erd
12659 \begin_inset Quotes eld
12663 \begin_inset Quotes erd
12667 \begin_inset Quotes eld
12671 \begin_inset Quotes erd
12675 \begin_inset Quotes eld
12679 \begin_inset Quotes erd
12683 \begin_inset Quotes eld
12687 \begin_inset Quotes erd
12691 \begin_inset Quotes eld
12695 \begin_inset Quotes erd
12699 Their use is more or less obvious.
12701 supports all these environments; it will use the proper label, text style,
12702 and numbering scheme for each of them.
12705 \begin_layout Enumerate
12706 Both packages use basic citations; the natbib package should not be used.
12707 In \SpecialChar LyX
12708 , citation references are shown as usual; in the output, citations are
12709 shown as superscripts.
12710 If you want to use a citation as normal text, you should use the
12715 \begin_inset space \thinspace{}
12719 \begin_inset space \space{}
12723 \begin_inset Quotes eld
12727 \begin_inset space \space{}
12737 \begin_inset Quotes erd
12743 \begin_layout Enumerate
12745 \begin_inset Quotes eld
12749 \begin_inset Quotes erd
12752 section in both packages.
12753 To put acknowledgments, just use the
12754 \begin_inset Quotes eld
12758 \begin_inset Quotes erd
12764 \begin_layout Enumerate
12765 Appendices may be added to the paper,
12769 the Acknowledgments and
12775 provides a special environment, called
12776 \begin_inset Quotes eld
12780 \begin_inset Quotes erd
12783 which marks the beginning of the appendices.
12784 This environment should be left blank; it just sends a \SpecialChar LaTeX
12785 command, but nothing
12787 In \SpecialChar LyX
12789 \begin_inset Quotes eld
12793 \begin_inset Quotes erd
12796 is printed with blue letters, as a signal that all sections after that
12797 point are appendices.
12798 To write an appendix, use the
12799 \begin_inset Quotes eld
12803 \begin_inset Quotes erd
12808 will number each appendix with capital letters, as required by both journals.
12810 \begin_inset Quotes eld
12814 \begin_inset Quotes erd
12821 be present before the first appendix; if not, all appendices will be numbered
12822 as normal sections in the output.
12825 \begin_layout Enumerate
12826 The ijmpc and the ijmpd packages use the
12830 command to implement table captions.
12831 As a result, a table created by \SpecialChar LyX
12832 is printed correctly, but its caption
12834 However, you can use some \SpecialChar TeX
12835 code to overcome this problem, so that captions
12836 are printed as expected.
12837 To do so, create a float table as usual, remove the caption, and replace
12838 it with the \SpecialChar TeX
12849 (sic); you must also the \SpecialChar TeX
12854 immediately after the tabular material.
12855 Study the example table included in the template files to see how this
12856 trick is implemented.
12857 Alternatively, If you need table captions, you should implement the whole
12862 file, then include this file to the \SpecialChar LyX
12865 Insert\SpecialChar menuseparator
12866 File\SpecialChar menuseparator
12868 \begin_inset space ~
12874 Details on how to create a table float can be found in the files
12882 , included in the corresponding packages.
12885 \begin_layout Subsection
12886 Preparing a paper for submission
12889 \begin_layout Standard
12890 Before you submit your paper you must export the \SpecialChar LyX
12891 document as a \SpecialChar LaTeX
12894 File\SpecialChar menuseparator
12895 Export\SpecialChar menuseparator
12903 \begin_layout Plain Layout
12904 Actually you have the choice between \SpecialChar LaTeX
12905 (plain) and pdflatex.
12906 If you intend to use pdflatex to prepare the paper, you should use the
12907 pdflatex option so that included graphics are converted to PDF format,
12908 ready for use by pdflatex.
12913 , then make the following changes to the resulting
12920 \begin_layout Enumerate
12921 Remove the comment lines before the
12930 \begin_layout Enumerate
12931 Remove everything between (and including) the
12943 commands, except for any commands you specifically put into the \SpecialChar LaTeX
12947 \begin_layout Standard
12952 file should be saved and processed through \SpecialChar LaTeX
12953 as many times as necessary.
12954 You may also want to check the resulting
12961 \begin_layout Subsection
12962 Use of \SpecialChar TeX
12966 \begin_layout Standard
12967 The use of \SpecialChar TeX
12968 code is reduced to two commands, which must be placed at the
12969 top of the document.
12970 If you started writing your paper by using the
12978 template, the \SpecialChar TeX
12979 code needed is already in its place; you usually don't need
12981 You may only modify the first \SpecialChar TeX
12982 code to specify the information printed
12983 to the top of odd and even pages (authors' names and short paper's title,
12985 This \SpecialChar TeX
12986 code must have the form
12990 markboth{Authors' Names}{Short Paper's Title}
12995 \begin_layout Section
12999 \begin_layout Standard
13005 \begin_layout Subsection
13009 \begin_layout Standard
13010 The iopart package provides a document class to create electronic manuscript
13011 submission to the journals published by the Institute of Physics.
13012 Instructions for the authors how to create a paper using the iopart class
13013 can be downloaded together with the iopart package from the site
13014 \begin_inset Flex URL
13017 \begin_layout Plain Layout
13019 ftp://ftp.iop.org/pub/journals/latex2e
13027 \begin_layout Subsection
13031 \begin_layout Standard
13032 The easiest way to write a paper is to start with the file
13036 that is available in \SpecialChar LyX
13037 's examples files folder.
13038 Open this file, save it under a new name, and start writing.
13039 The example file explains how to use the special text environments.
13040 Here are the most important advices:
13043 \begin_layout Itemize
13044 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13047 Use AMS math package
13049 in the document settings under
13056 \begin_layout Itemize
13059 The title environment defines the kind of your paper.
13060 So use one of the following environments for the title:
13063 \begin_inset Separator parbreak
13070 \begin_layout Itemize
13079 \begin_layout Itemize
13088 \begin_layout Itemize
13094 for a Topical review
13097 \begin_layout Itemize
13106 \begin_layout Itemize
13115 \begin_layout Itemize
13121 for a Paper (same as Title)
13124 \begin_layout Itemize
13130 for a Preliminary communication
13133 \begin_layout Itemize
13139 for a Rapid communication
13142 \begin_layout Itemize
13148 for a Letter to the editor
13152 \begin_layout Itemize
13155 All title environments except of
13159 can have an optional short title.
13162 \begin_layout Itemize
13163 There is a general title environment
13167 which is not directly supported by the \SpecialChar LyX
13169 This can be used as \SpecialChar TeX
13170 code when your document doesn't fit into one of the
13174 \begin_layout Standard
13175 For more informations like hints for special table and formula formatting,
13176 look at the IOP author guidelines.
13179 \begin_layout Section
13183 \begin_layout Standard
13186 Panayotis Papasotiriou
13189 \begin_layout Subsection
13193 \begin_layout Standard
13194 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13195 that facilitates electronic manuscript submission to the journals they
13197 Most known of them (at least in my domain of interest) are
13199 Astrophysics and Space Science
13205 , but there are many others (see a complete list at
13206 \begin_inset Flex URL
13209 \begin_layout Plain Layout
13211 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13217 The Kluwer package may be downloaded from the site
13218 \begin_inset Flex URL
13221 \begin_layout Plain Layout
13223 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13229 A complete user guide is contained in that package (but it can also be
13230 downloaded separately).
13233 \begin_layout Standard
13235 supports many features of the package but not everything.
13236 However, the \SpecialChar TeX
13237 code needed is reduced to some
13238 \begin_inset Quotes eld
13242 \begin_inset Quotes erd
13245 commands of the package (see
13246 \begin_inset space ~
13250 \begin_inset CommandInset ref
13252 reference "subsec:kluwer_peculiarities"
13257 I have recently used \SpecialChar LyX
13258 to write an article submitted to the
13260 Astrophysics and Space Science
13262 without any problem.
13265 \begin_layout Subsection
13269 \begin_layout Standard
13270 The easiest way to write a paper is to start with the Kluwer template file.
13273 File\SpecialChar menuseparator
13285 This will give an (almost) empty document that includes the most common
13286 fields found in a manuscript and a short description of their use.
13287 As in most templates, simply overwrite the existing text (including the
13292 ) with the correct information.
13295 \begin_layout Subsection
13296 Preparing a paper for submission
13299 \begin_layout Standard
13300 As in the AAS\SpecialChar TeX
13301 package, before you submit your paper to a journal you must
13303 \begin_inset Quotes eld
13307 \begin_inset Quotes erd
13313 \begin_layout Enumerate
13314 Export your paper as a \SpecialChar LaTeX
13316 To do this, click on
13318 File\SpecialChar menuseparator
13319 Export\SpecialChar menuseparator
13327 \begin_layout Enumerate
13332 file with a text editor and make the following changes
13333 \begin_inset Separator parbreak
13340 \begin_layout Enumerate
13341 remove the comment lines before the
13350 \begin_layout Enumerate
13351 remove everything between (and including) the
13363 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13367 \begin_layout Standard
13376 \begin_layout Enumerate
13381 file through \SpecialChar LaTeX
13382 as many times as necessary (usually up to three).
13385 \begin_layout Enumerate
13391 \begin_inset space \thinspace{}
13395 \begin_inset space \space{}
13402 , and check if everything is OK (it should, if you didn't make any mistake).
13405 \begin_layout Subsection
13406 \begin_inset Quotes eld
13410 \begin_inset Quotes erd
13413 of the Kluwer package
13414 \begin_inset CommandInset label
13416 name "subsec:kluwer_peculiarities"
13423 \begin_layout Standard
13424 The Kluwer package has the following
13425 \begin_inset Quotes eld
13429 \begin_inset Quotes erd
13435 \begin_layout Enumerate
13436 It is possible to write multiple articles in the same \SpecialChar LaTeX
13441 \begin_layout Plain Layout
13442 I can't imagine any good reason to do this.
13448 Each article must be included in the environment
13449 \begin_inset Quotes eld
13453 \begin_inset Quotes erd
13457 Unfortunately, this environment cannot be omitted, even if you write just
13459 Therefore, each article starts with the command
13465 and, obviously, ends with the command
13472 Although this can be implemented in \SpecialChar LyX
13473 , I didn't included it, since it looks
13474 ugly and can confuse the novice user.
13475 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13478 \begin_inset Quotes eld
13483 \begin_inset Quotes erd
13489 \begin_layout Enumerate
13490 Information given at the beginning of the article (i.
13491 \begin_inset space \thinspace{}
13495 \begin_inset space \space{}
13498 title, subtitle, author, institution, running title, running author, abstract
13499 and keywords) must be included in an environment called
13500 \begin_inset Quotes eld
13504 \begin_inset Quotes erd
13508 This is not implemented in \SpecialChar LyX
13509 , so you must enter title, subtitle etc.
13510 \begin_inset space ~
13513 between two \SpecialChar TeX
13529 \begin_layout Enumerate
13530 According to the user manual, the label of each bibliography item must be
13554 \begin_layout Standard
13559 template takes care of all these
13560 \begin_inset Quotes eld
13564 \begin_inset Quotes erd
13568 If you start a new paper using this template you don't need to do anything
13573 \begin_layout Enumerate
13574 don't delete the \SpecialChar TeX
13575 code included in the template, and
13578 \begin_layout Enumerate
13579 copy the example bibliography item included in the template and modify it
13580 as necessary to enter new bibliography items.
13583 \begin_layout Section
13587 \begin_layout Standard
13593 \begin_layout Subsection
13597 \begin_layout Standard
13598 The \SpecialChar LyX
13601 article (koma-script)
13605 report (koma-script)
13623 correspond to the \SpecialChar LaTeX
13641 \begin_inset space ~
13644 of the Koma-Script family.
13645 They are replacements for the standard document classes
13661 , resp., and fit better to European typography conventions in a number of
13665 \begin_layout Itemize
13666 Standard character size is 11pt in
13668 article (koma-script)
13672 report (koma-script)
13680 letter (koma-script)
13685 \begin_layout Itemize
13686 Headings, labels of the description environment, and a number of elements
13689 letter (koma-script)
13691 document class are set in a bold sans serif font.
13695 \begin_layout Plain Layout
13696 There is a big difference between the bold sans serif old cm fonts and new
13697 ec fonts, especially in the appearance of headings.
13698 In comparison, the ec bold sans serif fonts look a bit thin.
13699 Here the \SpecialChar LaTeX
13708 helps to produce the
13709 \begin_inset Quotes eld
13713 \begin_inset Quotes erd
13716 appearance when using the ec fonts.
13721 The numbering of chapter headings is made in the same way as the numbering
13722 of section headings, that is without the extra line
13723 \begin_inset Quotes eld
13726 Chapter\SpecialChar ldots
13728 \begin_inset Quotes erd
13732 In addition, the appearance of the headings can be modified by using a
13733 number of options (in \SpecialChar LyX
13734 to be entered in the field
13737 \begin_inset space ~
13744 Layout\SpecialChar menuseparator
13751 \begin_layout Itemize
13752 The main means in the Koma-Script document classes to design the type area
13761 (in \SpecialChar LyX
13762 to be entered in the extra class options field in the dialog
13764 Document\SpecialChar menuseparator
13768 They make a clearer modification of page margins possible as do the options
13771 Document\SpecialChar menuseparator
13778 \begin_layout Itemize
13779 The \SpecialChar LaTeX
13780 document classes of the Koma-Script family define a number of additional
13782 Those part of it which makes sense in \SpecialChar LyX
13783 is implemented in corresponding
13787 \begin_layout Standard
13788 Detailed descriptions of the \SpecialChar LaTeX
13789 document classes of the Koma-Script family
13790 can be found in the Koma-Script documentation
13801 \begin_layout Subsection
13802 article (koma-script), report (koma-script), and book (koma-script)
13805 \begin_layout Standard
13806 The document classes
13808 article (koma-script)
13812 report (koma-script)
13822 are implemented in the layout files
13835 They contain all the paragraph types of the corresponding standard document
13848 , resp., partly modified, with the exception of the \SpecialChar LyX
13853 -type, which is replaced by the new
13857 -type having the same functionality.
13862 -Type there is a number of new paragraph types added.
13869 letter (koma-script)
13874 \begin_layout Itemize
13883 : are equivalents to
13891 , resp., additionally inserting an entry in the table of contents.
13900 are not contained in
13902 article (koma-script)
13907 \begin_layout Itemize
13916 : behave exactly as
13924 , resp., additionally clearing running heads.
13929 is not contained in
13931 article (koma-script)
13937 \begin_layout Plain Layout
13950 report (koma-script)
13952 , but since this is identical to
13956 , is has not been implemented in \SpecialChar LyX
13965 \begin_layout Itemize
13970 : generates a heading directly above the following paragraph in the standard
13971 character size without affecting the structure of the document.
13974 \begin_layout Itemize
13983 are special captions which respect the different space settings needed
13984 for captions placed above or below an element (if you follow strict typographic
13985 rules, you might want to place table captions always above the table).
13986 You can also use the class option
13990 , which will switch
14003 You need at least Koma-Script version 2.8q to use this.
14006 \begin_layout Itemize
14011 : can be used to set a bonmot, e.
14012 \begin_inset space \thinspace{}
14016 \begin_inset space \space{}
14019 at the beginning of a chapter.
14020 If you use the optional argument (
14022 Insert\SpecialChar menuseparator
14024 \begin_inset space ~
14029 ), you can insert the dictum's author there.
14030 Dictum and author are separated by a line.
14031 You need at least Koma-Script version 2.8q to use this.
14036 is not contained in
14038 article (koma-script)
14043 \begin_layout Standard
14044 The following types, together with the standard types
14056 , form the title area of the document.
14057 They must be entered ahead of the first
14058 \begin_inset Quotes eld
14062 \begin_inset Quotes erd
14069 \begin_layout Plain Layout
14070 The corresponding \SpecialChar LaTeX
14071 commands must appear before the
14082 When such a type is used more than once, the latter usage overwrites the
14083 former one, that means, for every type only the latest usage is valid.
14084 The order of the different types however has, like
14096 , no effect on the appearance of the produced document.
14099 \begin_layout Itemize
14104 : produces a centered paragraph above the ordinary title (
14116 ) for the subject of the document.
14119 \begin_layout Itemize
14124 : produces a centered paragraph below the ordinary title (
14136 ) for the publishers' name.
14139 \begin_layout Itemize
14146 report (koma-script)
14152 produces a centered paragraph on its own page behind the title page, or
14155 article (koma-script)
14157 produces a centered paragraph below the ordinary title (
14173 ) for a dedication.
14176 \begin_layout Itemize
14181 : produces a left aligned paragraph above the ordinary title (
14197 ) for a document`s head.
14200 \begin_layout Itemize
14205 : produces in a double-sided print in
14207 report (koma-script)
14213 a left-aligned paragraph at the top of the title page`s back or has no
14214 effect in a single-sided print or in
14216 article (koma-script)
14221 \begin_layout Itemize
14226 : produces in a double-sided print in
14228 report (koma-script)
14234 a left-aligned paragraph at the bottom of the title page`s back or has
14235 no effect in a single-sided print or in
14237 article (koma-script)
14242 \begin_layout Itemize
14247 : produces a special
14248 \begin_inset Quotes eld
14252 \begin_inset Quotes erd
14255 page ahead of the actual document containing a paragraph without special
14259 \begin_layout Standard
14260 The layout files for the document classes
14262 article (koma-script)
14266 report (koma-script)
14272 do include the file
14277 This is thought of as a place to define your own types.
14282 in your personal layout directory and edit the file!
14285 \begin_layout Subsection
14286 letter (koma-script)
14289 \begin_layout Standard
14293 letter (koma-script)
14295 is implemented in the layout file
14300 It contains all the paragraph types of the corresponding standard document
14305 , partly modified, with the exception of the \SpecialChar LyX
14319 type, which is replaced by the new
14324 In addition, it contains, in contrast to the standard document class, the
14343 Furthermore, there are a number of new letter specific types.
14346 \begin_layout Standard
14347 The appearance of the letter produced by this document class can be controlled
14348 by a number of \SpecialChar LaTeX
14349 commands, which you can put in the \SpecialChar LaTeX
14354 \begin_layout Plain Layout
14355 For example, the standard appearance of the letter`s heading, consisting
14356 of name and address, is quite self-willed.
14358 \begin_inset Quotes eld
14362 \begin_inset Quotes erd
14365 heading is produced by the following \SpecialChar LaTeX
14366 commands in the preamble:
14369 \begin_layout LyX-Code
14379 \begin_layout LyX-Code
14395 \begin_layout LyX-Code
14405 \begin_layout LyX-Code
14425 A detailed German description of such \SpecialChar LaTeX
14426 commands can be found in the Koma-Script
14432 With it, the letter's author can produce his personal letter layout.
14435 \begin_layout Standard
14444 define the beginning of the letter and must be used in every letter.
14445 To emphasize them in the \SpecialChar LyX
14446 document class, they are marked with the letter
14456 \begin_inset space ~
14459 in the left margin.
14460 It is possible to write any number of letters in one file.
14465 type produces a new letter using the same addressee and a
14469 type produces a new addressee.
14486 are ordinary paragraph types and can also be used several times in one
14487 and the same letter.
14490 \begin_layout Itemize
14495 : produces a paragraph for the addressee and implicitly defines the beginning
14499 \begin_layout Itemize
14504 : produces a paragraph for the form of address and implicitly produces a
14508 \begin_layout Itemize
14513 : produces a paragraph for a close.
14516 \begin_layout Itemize
14521 : produces a paragraph for a postscript.
14524 \begin_layout Itemize
14529 : produces a paragraph for a distribution list.
14532 \begin_layout Itemize
14537 : produces a paragraph for enclosures.
14540 \begin_layout Standard
14581 are input types provided with a label to enter information, which will
14582 be processed by the document class.
14586 \begin_layout Plain Layout
14587 It could be seen as a matter of inconsequence, that the types
14595 described above are not such input types as well.
14596 Because of the special meaning of those types, however, I have implemented
14597 them as ordinary paragraph types with a one letter mark in the left margin.
14598 Moreover, it would affect my feeling of symmetry, if the
14606 type had such a serious different appearance.
14611 The types must be used ahead of the corresponding
14618 \begin_layout Standard
14619 An implementation of these types in a WYSIWYG fashion does not seem to make
14620 sense, because the real appearance of the produced letter does not only
14621 depend on the usage of the particular type, but also on other factors.
14622 For example, a signature entered in the
14626 type will in the standard behavior appear in the produced letter only,
14627 when in the same letter also a
14632 The entered value of the
14636 type will in the standard behavior not appear in the produced letter at
14638 The possibility to design the letter`s heading freely is already indicated
14639 in a footnote above.
14642 \begin_layout Standard
14643 The input types can also be used as empty paragraphs.
14644 This makes sense e.
14645 \begin_inset space \thinspace{}
14649 \begin_inset space \space{}
14661 type is not used at all, in the standard behavior the value of the
14665 type is used as signature, whereas if an empty
14669 type is used, no signature value is defined.
14672 \begin_layout Standard
14673 By using the input types it is possible to write a letter template, containing
14674 filled input types with your personal dates (name, address, etc.) and empty
14675 input types for other dates you want to enter.
14678 \begin_layout Itemize
14683 : sender's name, in the standard behavior appears as a centered paragraph
14684 in small caps in the letter`s heading.
14687 \begin_layout Itemize
14692 : sender's signature, in the standard behavior appears below the
14701 type is used, the value of the
14705 type appears instead.
14708 \begin_layout Itemize
14713 : sender's address, in the standard behavior appears in a centered paragraph
14714 in the letter`s heading below the sender's name.
14717 \begin_layout Itemize
14722 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
14733 \begin_layout Itemize
14738 : place of the letter`s making.
14741 \begin_layout Itemize
14746 : date of the letter`s making.
14755 , in the standard behavior, produce the place and the date in a right-aligned
14756 line below the addressee's field.
14761 type is used, neither place nor date appear, independent of the value of
14771 type is used, the date of the letter `s production is used.
14774 \begin_layout Itemize
14779 : sender`s back address, in the standard behavior appears above the addressee's
14780 field in a small sans serif font.
14783 \begin_layout Itemize
14788 : special mail information, in the standard behavior appears underlined
14789 above the addressee's field below the back address.
14792 \begin_layout Itemize
14797 : additional information, in the standard behavior appears on right side
14798 below the addressee`s field.
14801 \begin_layout Itemize
14806 : the letter's title, in the standard behavior appears in a big, bold, sans
14807 serif font above the subject.
14810 \begin_layout Itemize
14815 : the letter's subject, in the standard behavior appears in a bold font
14823 \begin_layout Standard
14844 produce a business letter like line above the
14848 line containing the fields
14849 \begin_inset Quotes eld
14853 \begin_inset Quotes erd
14857 \begin_inset Quotes eld
14861 \begin_inset Quotes erd
14865 \begin_inset Quotes eld
14869 \begin_inset Quotes erd
14873 \begin_inset Quotes eld
14877 \begin_inset Quotes erd
14881 \begin_inset Quotes eld
14885 \begin_inset Quotes erd
14889 \begin_inset Quotes eld
14893 \begin_inset Quotes erd
14897 For the date field, the value of the
14903 \begin_inset Quotes eld
14906 business letter types
14907 \begin_inset Quotes erd
14910 is used, the value of the
14914 type however does not appear, but only the \SpecialChar LaTeX
14922 The ordinary output of place and date in a right-aligned line below the
14923 addressee`s field is suppressed.
14924 The types are implemented as input types provided with a label and must
14925 be used ahead of the corresponding
14932 \begin_layout Itemize
14940 \begin_layout Itemize
14948 \begin_layout Itemize
14956 \begin_layout Itemize
14964 \begin_layout Itemize
14972 \begin_layout Subsection
14973 The new letter class: letter (koma-script v.2)
14976 \begin_layout Standard
14982 \begin_layout Standard
14983 \begin_inset VSpace medskip
14989 \begin_layout Standard
14991 Koma-Script version 2.8 has introduced a new letter class
14995 which supersedes the now unsupported
15000 It has — on the \SpecialChar LaTeX
15001 side — a completely new interface and is not compatible
15002 with the old class.
15003 Therefore, \SpecialChar LyX
15004 supports both, though it is recommended you use the new class.
15007 \begin_layout Standard
15008 This class covers the same functionality as
15010 letter (koma-script),
15013 The basic items are
15017 (receiver's address, same as
15021 in the old layout),
15034 will start a new letter (i.
15035 \begin_inset space \thinspace{}
15039 \begin_inset space \space{}
15042 you can write several letters per document).
15043 New elements are sender's
15059 and the possibility to use a
15065 Insert\SpecialChar menuseparator
15071 \begin_layout Standard
15072 The biggest improvement is, though, that the letter's layout is configurable
15073 to meet almost any needs.
15074 This can be done via the preamble or with a special style file (Letter
15075 Class Option, extension
15079 ), that will be read in as a class option.
15083 \begin_layout Plain Layout
15084 The KOMA package comes with some default
15089 There is, for instance, a
15093 file that follows german typesetting rules, or a
15097 that provides the default layout of the old
15102 The latter can be loaded with the class option
15111 ayout\SpecialChar menuseparator
15116 ocument\SpecialChar menuseparator
15128 template that is included in \SpecialChar LyX
15130 A detailed description is to be found in the Koma-Script documentation
15138 \begin_layout Subsection
15142 \begin_layout Standard
15143 Visualizing the Koma-Script document classes in \SpecialChar LyX
15144 , the \SpecialChar LyX
15145 internals cause some
15149 \begin_layout Itemize
15150 The chapter number of a
15154 type appears on a line of its own above the chapter heading instead of
15155 appearing in the same line ahead of it.
15156 The cause for that is the \SpecialChar LyX
15157 internal behavior for the labeltype
15161 in the layout file.
15164 \begin_layout Itemize
15165 The headings of the types
15173 are only put in the
15174 \begin_inset Quotes eld
15178 \begin_inset Quotes erd
15182 table of contents, but not in the \SpecialChar LyX
15183 table of contents (
15185 Document\SpecialChar menuseparator
15187 \begin_inset space ~
15191 \begin_inset space ~
15199 \begin_layout Itemize
15200 The paragraphs in a
15204 document class appear in a skip separation mode, not indented.
15205 This is the standard behavior, no special \SpecialChar LaTeX
15206 commands are needed for that.
15209 Document\SpecialChar menuseparator
15212 dialog the corresponding radio button indicates
15221 value always has the effect that extra \SpecialChar LaTeX
15222 commands are inserted in the document
15223 to produce the gap, which is not what is wanted in this case.
15226 \begin_layout Section
15230 \begin_layout Standard
15236 \begin_layout Subsection
15240 \begin_layout Standard
15241 Memoir is a very powerful and constantly evolving class.
15242 It has been designed with regard to fictional and non-fictional literature.
15243 Its aim is to let the user have maximum control over the typesetting of
15245 Memoir is based on the standard book class, but it can also emulate the
15246 article class (see below).
15249 \begin_layout Standard
15250 Peter Wilson, the developer of Memoir, is known as the author of lots of
15251 useful packages in the \SpecialChar LaTeX
15253 Most of them have been merged with Memoir.
15254 Therefore, it is much easier to layout the table of contents, appendices,
15255 chapter designs and such.
15257 , though, does not support all of these goodies natively.
15258 Some of them might be added to forthcoming releases
15262 \begin_layout Plain Layout
15263 You are invited to send suggestions to
15264 \begin_inset Flex URL
15267 \begin_layout Plain Layout
15269 lyx-devel@lists.lyx.org
15279 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15281 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15283 commands (\SpecialChar TeX
15288 \begin_layout Plain Layout
15293 \begin_layout Plain Layout
15303 \begin_inset space ~
15307 \begin_inset CommandInset ref
15309 reference "sec:Inserting-TeX-Code"
15319 In this section, we can only list those features that are natively supported
15320 by \SpecialChar LyX
15322 For detailed descriptions (and for the rest of features) we recommend you
15323 have a look at the detailed manual of the Memoir class
15327 \begin_layout Plain Layout
15332 \begin_layout Plain Layout
15342 \begin_inset Flex URL
15345 \begin_layout Plain Layout
15347 CTAN:/macros/latex/memoir/memman.pdf
15357 , which is not only a user guide for the class, but also both a comprehensive
15358 description on good typesetting and a superb example for good typesetting
15362 \begin_layout Subsection
15363 Basic features and restrictions
15366 \begin_layout Standard
15367 Memoir supports basically all features of the standard book classes.
15368 There are, however, some differences, as follows:
15371 \begin_layout Description
15373 \begin_inset space ~
15376 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15379 \begin_layout Description
15381 \begin_inset space ~
15384 style: The fancy page style is not supported, due to a command clash between
15385 Memoir and the fancyhdr package (they both define a command with the same
15386 name, which confuses \SpecialChar LaTeX
15388 Instead, Memoir comes with a number of its own page styles (see
15390 Layout\SpecialChar menuseparator
15391 Document\SpecialChar menuseparator
15393 \begin_inset space ~
15399 If you want to use these for the chapter pages, you have to use the command
15406 in the main text or in preamble (e.
15407 \begin_inset space \thinspace{}
15411 \begin_inset space \space{}
15418 chapterstyle{companion}
15423 \begin_layout Description
15424 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15425 optional argument in the standard classes.
15426 With this, you can specify an alternative version of the title for the
15427 table of contents and the headers (for instance, if the title is too long).
15428 In \SpecialChar LyX
15429 , you can do this via
15431 Insert\SpecialChar menuseparator
15433 \begin_inset space ~
15438 at the beginning of a chapter/section.
15439 Memoir features a second optional argument and thus separates the table
15440 of contents from the header.
15441 You can define three variants of a title with this: one for the main text,
15442 one for the table of contents, and one for the headers.
15443 Simply insert two optional arguments if you need this feature, the first
15444 one containing the short title for the Table of Contents, the second one
15445 containing an alternative short title for the headers.
15448 \begin_layout Description
15449 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15450 of contents, the list of figures and the list of table start a new page
15452 Memoir does not follow this route.
15453 You have to insert a page break yourself, if you want to have one.
15456 \begin_layout Description
15457 Titlepage: For some unknown reason, Memoir uses pagination on the title
15458 page (in the standard classes, title pages are
15459 \begin_inset Quotes eld
15463 \begin_inset Quotes erd
15467 If you want an empty title page, type
15471 aliaspagestyle{title}{empty}
15476 \begin_layout Description
15477 Article: With the class option
15483 Layout\SpecialChar menuseparator
15484 Document\SpecialChar menuseparator
15486 \begin_inset space ~
15491 ), you can emulate article style.
15492 That is, counters (footnotes, figures, tables etc.) will not be reset on
15493 new chapters, chapters don't start a new page (but are—in contrary to
15494 \begin_inset Quotes eld
15498 \begin_inset Quotes erd
15501 article classes—still allowed), parts, though, use their own page, as in
15505 \begin_layout Description
15506 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15507 font commands, which have been used in the old \SpecialChar LaTeX
15509 \begin_inset space \thinspace{}
15513 \begin_inset space \space{}
15529 It produces an error and stops \SpecialChar LaTeX
15530 whenever such a command appears.
15535 reallows the commands and spits out warnings instead (which does at least
15536 not stop \SpecialChar LaTeX
15538 Since a lot of packages and particularly Bib\SpecialChar TeX
15539 style files are still using
15540 those commands, we have decided to use this option by default.
15543 \begin_layout Subsection
15547 \begin_layout Standard
15548 We will only describe the features supported by \SpecialChar LyX
15549 (which is not much currently).
15550 Please consult the Memoir manual
15554 \begin_layout Plain Layout
15559 \begin_layout Plain Layout
15569 \begin_inset Flex URL
15572 \begin_layout Plain Layout
15574 CTAN:/macros/latex/memoir/memman.pdf
15587 \begin_layout Description
15588 Abstract: You may wonder why an abstract is an extra feature.
15589 Well, it is in book class.
15590 Usually books don't have abstracts.
15591 Memoir, however, has.
15592 You can use it wherever and how often you like.
15595 \begin_layout Description
15596 Chapterprecis: You may know this older typesetting style: The contents of
15597 a chapter are summarized below the title and also in the table of contents
15599 \begin_inset space \thinspace{}
15603 \begin_inset space \space{}
15608 Our hero arrives in Troia; he loses some friends; he finds others
15611 Chapterprecis does exactly this.
15612 It is therefore only sensible below a chapter.
15615 \begin_layout Description
15616 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15617 The epigraph environment provides an elegant way of typesetting such a
15619 The motto itself (text) and its author (source) are divided by a short
15621 Unfortunately, we have to fool \SpecialChar LyX
15622 a bit here again, since the environment
15623 needs two arguments (text and source).
15624 In this case, we have to use curly brackets (in \SpecialChar TeX
15625 mode) between the two
15636 <author of the slogan>.
15639 \begin_layout Description
15640 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15641 complex figurative poems).
15643 can only support a few of them.
15644 One is poemtitle, which is a centered title for poems, which will also
15645 be added to the table of contents (verse is the standard environment for
15647 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
15649 because they have to be nested inside regular verse environments, which
15650 is not possible with \SpecialChar LyX
15654 \begin_layout Description
15655 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15658 \begin_layout Section
15659 Article (mwart), book (mwbk) and report (mwrep)
15660 \begin_inset Argument status
15663 \begin_layout Plain Layout
15676 \begin_layout Standard
15682 \begin_layout Standard
15683 The \SpecialChar LyX
15700 correspond to the \SpecialChar LaTeX
15714 They are replacements for the standard document classes
15726 , resp., and fit better to Polish typography conventions in a number of points.
15730 \begin_layout Standard
15734 \begin_layout Itemize
15735 Unnumbered titles (with star, e.
15736 \begin_inset space \thinspace{}
15740 \begin_inset space \space{}
15747 ) are added into table of contents,
15750 \begin_layout Itemize
15751 Additional page styles:
15752 \begin_inset Separator parbreak
15759 \begin_layout Description
15760 uheadings header with separated lines,
15763 \begin_layout Description
15764 myheadings custom header, contents headers via commands:
15779 \begin_layout Description
15780 myuheadings custom header with separated lines,
15783 \begin_layout Description
15784 outer page number is placed on outer side of page
15788 \begin_layout Itemize
15790 \begin_inset Separator parbreak
15797 \begin_layout Description
15798 rmheadings serif titles — default,
15801 \begin_layout Description
15802 sfheadings sansserif titles,
15805 \begin_layout Description
15806 authortitle on title page first placed is author next title — default,
15809 \begin_layout Description
15810 titleauthor on title page first placed is title next author,
15813 \begin_layout Description
15814 withmarginpar reserve place on page for margins.
15818 \begin_layout Section
15822 \begin_layout Standard
15827 provides an alternative to the standard
15832 It provides similar functionality, but you might prefer this layout with
15833 sans serif sections, headings, and more.
15836 \begin_layout Section
15837 Rev\SpecialChar TeX
15841 \begin_layout Standard
15847 \begin_layout Standard
15848 \begin_inset VSpace bigskip
15854 \begin_layout Standard
15859 \begin_inset space ~
15864 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
15866 \begin_inset Formula $\beta$
15869 release of May, 1999) class.
15872 \begin_layout Standard
15878 textclass, which works with Rev\SpecialChar TeX
15880 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
15882 That means that it doesn't interact very well with \SpecialChar LyX
15883 , which requires \SpecialChar LaTeX2e
15885 it has been kludged to work.
15886 Since Rev\SpecialChar TeX
15887 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
15892 Rev\SpecialChar TeX
15894 \begin_inset space ~
15899 textclass should also be pretty easy to use.
15902 \begin_layout Standard
15903 These documents are supposed to be used in
15907 to the Rev\SpecialChar TeX
15908 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
15910 and assume you'll know what to put in the preamble if necessary.
15913 \begin_layout Subsection
15917 \begin_layout Standard
15918 All you need to do is install Rev\SpecialChar TeX
15919 4, as described in the package's README
15921 The package can be found at The Rev\SpecialChar TeX
15923 \begin_inset Flex URL
15926 \begin_layout Plain Layout
15928 http://publish.aps.org/revtex4/
15934 Install it somewhere that \SpecialChar LaTeX
15936 Test it by trying to \SpecialChar LaTeX
15937 a short Rev\SpecialChar TeX
15938 4 document in some random directory (i.
15939 \begin_inset space \thinspace{}
15943 \begin_inset space \space{}
15946 not the directory where you installed the class file.) Then, if you reconfigure
15948 , it will find the class file and let you use the Rev\SpecialChar TeX
15952 \begin_layout Standard
15953 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
15962 \begin_inset space ~
15967 template, found in the templates directory.
15970 \begin_layout Subsection
15974 \begin_layout Standard
15975 Optional arguments to
15982 \begin_inset Quotes eld
15986 \begin_inset Quotes erd
15990 \begin_inset Quotes eld
15994 \begin_inset Quotes erd
16004 \begin_inset space ~
16012 \begin_inset space ~
16018 Remember that in Rev\SpecialChar TeX
16019 , at least one optional argument is required!
16022 \begin_layout Standard
16023 Other preamble matter, like
16030 \begin_inset space ~
16037 \begin_inset space ~
16042 dialog, also as usual.
16045 \begin_layout Subsection
16049 \begin_layout Standard
16050 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16052 For example, the Email layout corresponds to
16059 Note that (at least as of Rev\SpecialChar TeX
16068 layouts are exactly equivalent, so you shouldn't need to use both.
16072 \begin_layout Plain Layout
16073 In case you're curious, both were included so that
16077 would be able to translate both
16097 \begin_layout Subsection
16101 \begin_layout Standard
16102 There are a couple of important unique aspects of Rev\SpecialChar TeX
16103 4 which might cause
16104 bugs that will be even more confusing in \SpecialChar LyX
16108 \begin_layout Standard
16109 In Rev\SpecialChar TeX
16127 The \SpecialChar LyX
16128 equivalent is that there is a separate Thanks layout.
16133 write footnotes in the
16137 layout, or weird things may happen.
16138 See the Rev\SpecialChar TeX
16139 4 documentation for more details.
16142 \begin_layout Standard
16146 \begin_inset space ~
16154 \begin_inset space ~
16163 layouts must be placed
16171 layout and the corresponding
16188 , the \SpecialChar LaTeX
16192 \begin_layout Subsection
16196 \begin_layout Standard
16197 The main problem with this layout is that you can't use the optional arguments
16198 to layouts like Email and Title.
16199 (The problem is not unique to this layout; you can't use optional arguments
16200 to the Section layouts either.) This means that after you export that file
16201 to \SpecialChar LaTeX
16202 (which you'll need to do eventually to send it in to APS), you'll need
16203 to edit the \SpecialChar LaTeX
16204 file with a text editor to add the optional arguments to set,
16206 \begin_inset space \thinspace{}
16210 \begin_inset space \space{}
16213 the running title for the page headers.
16214 Lacking these layouts makes the
16220 (and the equivalent
16226 ) useless, so the corresponding layouts don't exist, and will have to be
16231 \begin_layout Plain Layout
16236 actually, \SpecialChar LyX
16237 1.3.0 supports some forms of optional arguments, but this layout
16238 has not been updated yet to take advantage of it.
16246 \begin_layout Section
16247 Springer Journals (
16254 \begin_layout Standard
16260 \begin_layout Subsection
16264 \begin_layout Standard
16265 These are the layout files for some of the journal formats used by Springer
16266 Verlag and listed on
16267 \begin_inset Flex URL
16270 \begin_layout Plain Layout
16272 http://www.springer.de/author/tex/help-journals.html
16277 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16279 It is a modular system: the things common to all journals are implemented
16284 , which journal-specific layout files (such as, e.
16285 \begin_inset space \thinspace{}
16289 \begin_inset space \space{}
16296 for Journal of Geodesy) can include.
16299 \begin_layout Standard
16300 This means that implementing support for any other Springer journal on this
16301 list is as simple as writing your own
16309 file following the outline given in
16317 \begin_layout Standard
16318 It is reasonably well tested only for the Journal of Geodesy.
16327 come with the standard \SpecialChar LyX
16329 Install the relevant class file (downloaded from Springer) in a proper
16330 directory, reconfigure \SpecialChar LaTeX
16331 (in the te\SpecialChar TeX
16336 , as root if necessary — doesn't \SpecialChar LyX
16337 take care of this?), reconfigure \SpecialChar LyX
16342 \begin_layout Subsection
16346 \begin_layout Standard
16347 A large number of theorem-like styles —
16359 \begin_layout Standard
16362 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16363 _Title, Author_Running, Institute,
16364 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16367 See the Springer class file documentation for details.
16370 \begin_layout Subsection
16374 \begin_layout Itemize
16386 \begin_layout Itemize
16389 Probability Theory and Related Fields
16395 — Jean-Marc Lasgouttes
16398 \begin_layout Standard
16399 Add your own, it isn't so hard!
16402 \begin_layout Subsection
16406 \begin_layout Standard
16407 These files are partly based on the older
16411 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16413 file from Springer.
16418 layout, are now defunct.
16419 Jean-Marc Lasgouttes helped out big in making me find my way around the
16421 layout file mechanism.
16424 \begin_layout Subsection
16428 \begin_layout Standard
16430 But probably less than in the old hacked-\SpecialChar LaTeX
16438 \begin_layout Standard
16440 \begin_inset space \thinspace{}
16443 g.: does not display the number for theorem-like layouts, just #.
16446 \begin_layout Section
16449 Sli\SpecialChar TeX
16453 \begin_inset CommandInset label
16462 \begin_layout Standard
16470 \begin_layout Subsection
16474 \begin_layout Standard
16475 This section describes how to use \SpecialChar LyX
16476 to make slides for overhead projectors.
16477 There are two document classes that can do this: the default slides class
16480 Foil\SpecialChar TeX
16484 This section documents the former.
16487 \begin_layout Standard
16488 I'm going to say this again, nice and clear, so that there's no misunderstanding
16492 \begin_layout Standard
16493 \begin_inset VSpace bigskip
16499 \begin_layout Standard
16503 This section documents the class
16504 \begin_inset Quotes eld
16512 \begin_inset Quotes erd
16520 \begin_layout Standard
16521 \begin_inset VSpace bigskip
16527 \begin_layout Standard
16528 If you're looking for the documentation for
16529 \begin_inset Quotes eld
16534 slides (Foil\SpecialChar TeX
16538 \begin_inset Quotes erd
16541 , check out section
16542 \begin_inset space ~
16546 \begin_inset CommandInset ref
16548 reference "sec:foiltex"
16558 \begin_inset Quotes eld
16563 slides (Foil\SpecialChar TeX
16567 \begin_inset Quotes erd
16570 ] is actually somewhat better than the default
16578 \begin_layout Plain Layout
16580 or so I've been told repeatedly by its advocates.
16581 Having never used it, I have no idea if this claim is true or not.
16586 which this section documents.
16589 \begin_layout Standard
16590 This class is the \SpecialChar LaTeX2e
16591 improvement of the old
16593 Sli\SpecialChar TeX
16597 Every \SpecialChar LaTeX2e
16598 distribution includes this class [which I'll just refer to as
16599 \begin_inset Quotes eld
16607 \begin_inset Quotes erd
16610 from now on], so you're bound to have it.
16611 As I noted earlier, there are other classes, such as
16615 , which also produce slides for overhead projectors and do a better job
16617 However, there are some things which
16621 can do which the others can't, such as generate overlays.
16622 Read on to learn more!
16625 \begin_layout Subsection
16627 \begin_inset CommandInset label
16629 name "sec:slidesetup"
16636 \begin_layout Standard
16637 Obviously, to use this document class, you need to select
16638 \begin_inset Quotes eld
16646 \begin_inset Quotes erd
16649 from the class list in the
16651 Document\SpecialChar menuseparator
16655 There are some other special things you should know about this class:
16658 \begin_layout Itemize
16659 Don't bother changing the options
16664 They're not supported by the
16671 \begin_layout Itemize
16675 \begin_inset space ~
16680 behaves a bit differently for this class.
16681 The possible choices and what they do are as follows:
16682 \begin_inset Separator parbreak
16689 \begin_layout Description
16694 The final output contains page numbers in the lower right corner.
16697 \begin_layout Description
16706 , but also prints out any time markers you've put in.
16707 This is the default.
16710 \begin_layout Description
16715 The final output contains no page numbers, time markers, or alignment markers.
16719 \begin_layout Itemize
16724 class has an extra option:
16730 \begin_inset Quotes eld
16738 \begin_inset Quotes erd
16741 in the extra class options.
16742 \begin_inset Separator parbreak
16749 \begin_layout Standard
16750 Using this options allows you to add time markers to
16756 \begin_inset space ~
16760 \begin_inset CommandInset ref
16762 reference "sec:slideNote"
16770 \begin_layout Standard
16771 You can also use the template file
16772 \begin_inset Quotes eld
16780 \begin_inset Quotes erd
16783 to automatically set up a document to use the
16789 File\SpecialChar menuseparator
16791 \begin_inset space ~
16795 \begin_inset space ~
16800 to open your new document].
16801 The template file also contains some examples of the special paragraph
16802 environments used by this class.
16803 I'll describe those next.
16806 \begin_layout Subsection
16807 Paragraph Environments
16810 \begin_layout Subsubsection
16811 Supported Environments
16814 \begin_layout Standard
16815 The first thing you'll notice when you start up a new
16819 document is the font size and type: it's the equivalent of the size
16820 \begin_inset Quotes eld
16828 \begin_inset Quotes erd
16834 \begin_inset space ~
16840 This is also what's used in the output.
16842 \begin_inset Quotes eld
16846 \begin_inset Quotes erd
16849 to remind you that this is a slide.
16850 Your final slides will use a larger font; ergo, you'll have less space.
16851 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
16854 \begin_layout Standard
16855 The next thing that becomes obvious is the changes to the paragraph environment
16856 pull-down box [at the far-left end of the toolbar].
16857 Most of the paragraph environments you're used to seeing are missing.
16858 There are also five new ones.
16863 class itself only supports certain paragraph environments:
16866 \begin_layout Itemize
16872 \begin_layout Itemize
16878 \begin_layout Itemize
16884 \begin_layout Itemize
16890 \begin_layout Itemize
16896 \begin_layout Itemize
16902 \begin_layout Itemize
16908 \begin_layout Itemize
16914 \begin_layout Itemize
16920 \begin_layout Itemize
16927 \begin_layout Itemize
16933 \begin_layout Standard
16934 All of the other standard environments, including the section-heading environmen
16935 ts, aren't used in the
16942 \begin_layout Standard
16943 On the other hand, you'll notice the following new environments:
16946 \begin_layout Itemize
16952 \begin_layout Itemize
16958 \begin_layout Itemize
16964 \begin_layout Itemize
16970 \begin_layout Itemize
16976 \begin_layout Standard
16977 These five are kind of quirky, due to a
16978 \begin_inset Quotes eld
16982 \begin_inset Quotes erd
16985 in \SpecialChar LyX
16987 You see, \SpecialChar LyX
16988 doesn't permit you to nest any other paragraph environment into
16989 an empty environment.
16990 Now, that's fine and dandy, but it means that you wouldn't be able to start
16991 a slide with anything except plain text.
16992 To deal with this, I've performed a little
16993 \begin_inset Quotes eld
16998 \begin_inset Quotes erd
17004 \begin_layout Subsubsection
17005 Quirks of the New Environments
17006 \begin_inset CommandInset label
17008 name "sec:slideQuirk"
17015 \begin_layout Standard
17016 All five of the new paragraph environments are somewhat quirky due to inherent
17017 limitiations in the current version of \SpecialChar LyX
17019 As I just mentioned, \SpecialChar LyX
17020 forbids environments that begin with another environment.
17021 To get around this, the
17025 environment isn't a paragraph environment as described in the
17033 \begin_layout Standard
17034 You should consider
17047 \begin_inset Quotes eld
17050 pseudo-environments.
17051 \begin_inset Quotes erd
17054 They look like a section heading or a
17055 \begin_inset Quotes eld
17063 \begin_inset Quotes erd
17066 but really begin a [and, if necessary, end the previous] paragraph environment.
17076 \begin_inset Quotes eld
17080 \begin_inset Quotes erd
17083 These two perform some action.
17086 \begin_layout Standard
17087 A common feature of all five environments,
17107 , is a rather long-ish label.
17108 The text following this label — ordinarily the contents of the paragraph
17109 environment — is utterly irrelevant for
17131 completely ignores it.
17132 In fact, you can leave these five environments completely empty.
17136 \begin_layout Standard
17141 to put any text after the rather long-ish label, you might want to.
17142 This could be a short description of the contents of the
17147 In that case, enter your descriptive comment and hit
17151 as you normally would.
17154 \begin_layout Standard
17155 If, on the other hand, you don't want to enter any descriptive text, you'll
17156 hit another \SpecialChar LyX
17159 , like nature, abhors a vacuum, and will not let you start a new paragraph
17160 environment until you put something in the old one.
17164 \begin_layout Itemize
17165 Start entering the text that will
17193 \begin_layout Itemize
17194 Now move to the beginning of that paragraph.
17198 \begin_layout Itemize
17207 \begin_layout Itemize
17208 Finally, change this new, empty paragraph to a
17232 \begin_layout Standard
17233 Some future version of \SpecialChar LyX
17234 will, hopefully, resolve this quirkiness\SpecialChar ldots
17238 \begin_layout Subsection
17239 Making a Presentation with
17252 \begin_layout Subsubsection
17260 \begin_layout Standard
17261 If you're expecting this section to teach you how to actually make a presentatio
17262 n, you'll be sorely disappointed.
17263 Naturally, I'll describe all of the ways the
17267 class can assist you in preparing the materials for a presentation.
17268 Filling in the contents, however, is up to you.
17273 the \SpecialChar LyX
17277 \begin_layout Standard
17282 environment [in the manner described in section
17283 \begin_inset space ~
17287 \begin_inset CommandInset ref
17289 reference "sec:slideQuirk"
17293 ] tells \SpecialChar LyX
17294 to begin a new slide [duh].
17295 The label for this environment/
17296 \begin_inset Quotes erd
17300 \begin_inset Quotes erd
17304 \begin_inset Quotes eld
17308 \begin_inset Quotes erd
17311 in cool blue, followed by the label,
17312 \begin_inset Quotes eld
17316 \begin_inset Quotes erd
17320 Any text or paragraph environments that follow this one go on the new slide.
17324 \begin_layout Standard
17325 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17327 (this can be specified in the
17332 In fact, you'll want to, once you finish entering the contents of one slide.
17333 If you've entered more text than can physically fit on a slide, the extra
17334 overflows onto a new slide.
17335 I don't recommend doing this, however, since the overflow slide won't have
17336 any page number on it.
17337 Furthermore, it may interfere with any
17341 you've made to accompany the oversized
17348 \begin_layout Standard
17357 environments work the same way as the
17362 They both create an
17363 \begin_inset Quotes eld
17367 \begin_inset Quotes erd
17370 followed by a label [
17371 \begin_inset Quotes eld
17375 \begin_inset Quotes erd
17379 \begin_inset Quotes eld
17383 \begin_inset Quotes erd
17387 The color is a stunning magenta instead of blue, and the
17388 \begin_inset Quotes eld
17392 \begin_inset Quotes erd
17395 will look different, in style and in length.
17396 The label fonts of all three also differ from one another.
17399 \begin_layout Standard
17404 , if the contents of a
17412 exceed the physical size of a slide or sheet of paper, the extra will overflow
17414 Again, you should avoid this.
17415 It defeats the whole purpose of
17426 \begin_layout Subsubsection
17436 \begin_layout Standard
17441 is a slide that sits atop another slide.
17442 Perhaps you wish to discuss a figure on the main
17446 before displaying the text associated with it.
17447 One way to accomplish this is tape a flap of dark paper over the part of
17452 you want to display later.
17453 This method fails, however, if you wish to overlap one graph with another,
17455 You would then have to fumble while speaking to align the two separate,
17460 s to align the two graphs.
17465 environment in both cases makes life much easier.
17468 \begin_layout Standard
17473 receives the page number of its
17474 \begin_inset Quotes eld
17478 \begin_inset Quotes erd
17486 \begin_inset Quotes eld
17494 \begin_inset Quotes erd
17501 \begin_layout Plain Layout
17502 Presumably, mutliple
17507 \begin_inset Quotes eld
17515 \begin_inset Quotes erd
17519 \begin_inset Quotes eld
17527 \begin_inset Quotes erd
17531 \begin_inset Quotes eld
17539 \begin_inset Quotes erd
17543 \begin_inset space ~
17546 appended to the page number of the parent
17556 Clearly, you want the contents of both the
17564 to each fit on a single physical slide! You should probably consider an
17570 \begin_inset Quotes eld
17574 \begin_inset Quotes erd
17582 Indeed, the \SpecialChar LyX
17587 class provides a visual cue for this: the label at the start of an
17591 is shorter than that at the start of a
17596 Lastly, when you generate printable output, you'll find alignment markers
17597 in all four corners of both the
17601 page and its parent
17606 These will assist you in lining up the two physical slides.
17609 \begin_layout Standard
17610 The major problem in overlaying two slides is aligning the contents of the
17611 two transparencies.
17612 How much space should you leave for that graph on the second slide? Worse
17613 still, what if you want a graph and a sentence on second slide, but there
17614 is text on the main transparency that goes in between them? You could try
17615 and insert vertical space of the right size.
17616 The better way is to use
17627 \begin_layout Standard
17628 As their names imply,
17636 are two command-like paragraph environments that make all subsequent text
17637 invisible and visible, respectively.
17639 \begin_inset space ~
17643 \begin_inset CommandInset ref
17645 reference "sec:slideQuirk"
17649 that you don't place anything
17653 these two environments, however.
17658 , it inserts a centered, sky-blue label into the page reading
17659 \begin_inset Quotes eld
17662 <Invisible Text Follows>
17663 \begin_inset Quotes erd
17667 For paragraphs following this label, the parts of the
17675 ; it doesn't matter which] where they would be contain instead blank space.
17679 \begin_layout Standard
17684 , the corresponding centered label is
17685 \begin_inset Quotes eld
17688 <Visible Text Follows>
17689 \begin_inset Quotes erd
17693 Paragraphs following this label behave normally.
17694 Note that the beginning of a new
17706 automatically shuts off an
17711 It's therefore not necessary to use
17722 \begin_layout Standard
17723 By now, it should be obvious how to create overlay transparencies using
17724 the proper combination of
17743 \begin_layout Enumerate
17748 , including everything that will appear on it, whether on the main slide
17756 \begin_layout Enumerate
17757 Before each figure or paragraph that will appear only on the
17766 If necessary, insert a
17770 environment after the
17777 \begin_layout Enumerate
17782 immediately following the
17789 \begin_layout Enumerate
17790 Copy the contents of this
17801 \begin_layout Enumerate
17806 , change all of the
17817 \begin_layout Standard
17819 You've just made an
17826 \begin_layout Standard
17827 There's one problem with the way I've designed the \SpecialChar LyX
17832 class: you can't make text in the middle of a paragraph invisible, nor
17833 make text in the middle of an invisible paragraph visible again.
17834 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
17839 \begin_layout Plain Layout
17840 The commands of interest are:
17843 \begin_layout Itemize
17848 invisible \SpecialChar ldots
17852 \begin_layout Itemize
17857 visible \SpecialChar ldots
17861 \begin_layout Plain Layout
17863 and need to be marked as \SpecialChar TeX
17866 \begin_inset Quotes eld
17870 \begin_inset Quotes erd
17873 you wish to change goes in between the brackets [and after the
17886 If you don't know how to mark text as \SpecialChar TeX
17887 , see the appropriate section of
17900 \begin_layout Subsubsection
17910 \begin_inset CommandInset label
17912 name "sec:slideNote"
17919 \begin_layout Standard
17928 is associated with a
17929 \begin_inset Quotes eld
17933 \begin_inset Quotes erd
17941 Here, too, the \SpecialChar LyX
17946 class provides visual cues.
17951 is shorter than that of a
17955 [yet longer than that of an
17959 ] and, like the label of an
17963 is shockingly magenta.
17964 Additionally, the printed
17968 has the page number of its
17969 \begin_inset Quotes eld
17973 \begin_inset Quotes erd
17981 \begin_inset Quotes eld
17989 \begin_inset Quotes erd
17993 \begin_inset Quotes eld
18001 \begin_inset Quotes erd
18005 \begin_inset Quotes eld
18013 \begin_inset Quotes erd
18017 You can have multiple
18021 s associated with a single
18033 , you'll probably want to break up long
18037 s so that they fit on a single sheet of paper.
18040 \begin_layout Standard
18045 is obvious: it contains anything additional you might want to say about
18051 It could also be used as a sheet of reminders for a particular
18056 In the case of the latter, you might want to make use of time markers.
18057 Currently, the \SpecialChar LyX
18063 \begin_inset Quotes eld
18067 \begin_inset Quotes erd
18070 support for time markers, a
18072 Sli\SpecialChar TeX
18076 So, you'll have to resort to using the \SpecialChar LaTeX
18080 \begin_layout Standard
18081 To use time markers, you'll need to specify the extra class option
18082 \begin_inset Quotes eld
18090 \begin_inset Quotes erd
18094 \begin_inset space ~
18098 \begin_inset CommandInset ref
18100 reference "sec:slidesetup"
18105 This option turns on timing marks, which will appear in the lower-left-hand
18111 To set what appears in the time marker, you use the \SpecialChar LaTeX
18113 \begin_inset Quotes eld
18123 \begin_inset Quotes erd
18127 \begin_inset Quotes eld
18137 \begin_inset Quotes erd
18141 The arguments of both commands are time measured in seconds.
18143 \begin_inset Quotes eld
18153 \begin_inset Quotes erd
18156 sets the time marker to a given time.
18158 \begin_inset Quotes eld
18168 \begin_inset Quotes erd
18171 increments the time marker by the specified amount.
18172 Using time markers and
18176 s in this fashion, you can remind yourself how much time to spend on a particula
18184 \begin_layout Standard
18185 There's one last feature to describe.
18186 Clearly, you'd like to print out all of your
18194 s on transparencies while printing all of your
18211 with which it is associated.
18212 What's a person to do?
18215 \begin_layout Standard
18216 Luckily, there are two \SpecialChar LaTeX
18217 commands that allow you to select what to print
18219 Both must be placed into the preamble of your document.
18221 \begin_inset Quotes eld
18233 \begin_inset Quotes erd
18236 will cause the output to contain only the
18245 Correspondingly, the command
18246 \begin_inset Quotes eld
18258 \begin_inset Quotes erd
18261 prevents the output of anything but
18266 I'd advise placing both commands in the preamble and initially comment
18268 You can then preview your entire presentation as you write.
18269 When you're done writing, you can then uncomment one of the two to select
18270 what you want to print.
18271 I like to uncomment
18272 \begin_inset Quotes eld
18284 \begin_inset Quotes erd
18287 , print to a file with
18288 \begin_inset Quotes eld
18296 \begin_inset Quotes erd
18299 in its name, comment it back out, then uncomment
18300 \begin_inset Quotes eld
18312 \begin_inset Quotes erd
18316 \begin_inset Quotes eld
18324 \begin_inset Quotes erd
18328 I can then send either file to a printer, loading transparencies or plain
18329 paper as appropriate.
18332 \begin_layout Standard
18333 You can also provide other arguments to the
18334 \begin_inset Quotes eld
18344 \begin_inset Quotes erd
18348 \begin_inset Quotes eld
18358 \begin_inset Quotes erd
18362 See a good \SpecialChar LaTeX
18366 \begin_layout Subsection
18371 Class Template File
18374 \begin_layout Standard
18375 I have also provided a template file,
18376 \begin_inset Quotes eld
18384 \begin_inset Quotes erd
18392 To use it, begin your new presentation with
18397 ile\SpecialChar menuseparator
18399 \begin_inset space ~
18403 \begin_inset space ~
18413 Your new \SpecialChar LyX
18414 presentation file will contain an example
18435 additionally contain an example of the use of
18444 Lastly, the preamble will contain:
18447 \begin_layout LyX-Code
18448 % Uncomment to print out only slides and overlays
18451 \begin_layout LyX-Code
18455 \begin_layout LyX-Code
18461 \begin_inset Newline newline
18467 \begin_layout LyX-Code
18468 % Uncomment to print out only notes
18471 \begin_layout LyX-Code
18475 \begin_layout LyX-Code
18483 \begin_layout Standard
18484 One final thing: I created this class to support the \SpecialChar LaTeX2e
18486 \begin_inset Quotes eld
18491 Sli\SpecialChar TeX
18495 \begin_inset Quotes erd
18498 class, one of the built-in \SpecialChar LaTeX2e
18500 Neither I nor the rest of the \SpecialChar LyX
18501 Team endorse or oppose the use of this built-in
18503 It's here if you want it or need it.
18504 There exist other \SpecialChar LaTeX2e
18505 classes for creating presentations, such as the
18510 \begin_inset space ~
18514 \begin_inset CommandInset ref
18516 reference "sec:foiltex"
18521 \begin_inset Quotes eld
18529 \begin_inset Quotes erd
18532 package [present on some \SpecialChar TeX
18534 The latter is not yet supported under \SpecialChar LyX
18539 \begin_layout Plain Layout
18540 Perhaps you can take on the task\SpecialChar ldots
18546 I know nothing about these other classes.
18547 Try them out to see what sort of alternative they provide.
18550 \begin_layout Chapter
18552 Features needing Extra Software
18555 \begin_layout Section
18556 Checking \SpecialChar TeX
18560 \begin_layout Standard
18566 \begin_layout Subsection
18570 \begin_layout Standard
18579 \begin_layout Plain Layout
18584 is not yet available when you are using the \SpecialChar LaTeX
18585 distribution MiK\SpecialChar TeX
18591 , you'll find in the
18598 \begin_inset space ~
18609 \begin_inset Newline newline
18613 \begin_inset CommandInset href
18615 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18622 \begin_layout Standard
18625 Chk\SpecialChar TeX
18628 package is a program that was written by
18629 \begin_inset Flex Noun
18632 \begin_layout Plain Layout
18634 \begin_inset space ~
18642 in frustration because some constructs in \SpecialChar LaTeX
18643 are sometimes non-intuitive,
18644 and easy to forget.
18645 The program runs over your \SpecialChar LaTeX
18646 file, checks the integrity of the file, and
18647 flags some common errors.
18648 In other technical words, it is
18652 for \SpecialChar LaTeX
18656 \begin_layout Standard
18657 Well, what is a syntax checker doing in \SpecialChar LyX
18658 which is supposed to produce correct
18660 anyways? The answer is simple: Just as
18664 not only checks the
18668 of C programs, but also does
18672 checks for type-errors,
18674 Chk\SpecialChar TeX
18677 catches some common
18681 errors, in addition to the syntactical ones.
18684 Chk\SpecialChar TeX
18687 is capable of detecting several common errors, such as
18690 \begin_layout Itemize
18691 Ellipsis detection:
18692 \begin_inset Newline newline
18695 Use \SpecialChar ldots
18699 \begin_layout Itemize
18700 No space in front of/after parenthesis:
18701 \begin_inset Newline newline
18707 \begin_layout Itemize
18708 Enforcement of normal space after common abbreviations:
18709 \begin_inset Newline newline
18713 \begin_inset space \thinspace{}
18717 \begin_inset space \space{}
18720 is too wide spacing.
18723 \begin_layout Itemize
18724 Enforcement of end-of-sentence space when the last sentence ends with a
18726 \begin_inset Newline newline
18730 And this is wrong spacing.
18733 \begin_layout Itemize
18734 Space in front of labels and similar commands:
18735 \begin_inset Newline newline
18738 The label should stick right up to the text to avoid falling to a wrong
18741 \begin_inset CommandInset label
18751 \begin_layout Plain Layout
18752 This footnote is in danger of falling off to a wrong page
18757 The label is separated too much.
18760 \begin_layout Itemize
18761 Space in front of references, instead of hard spaces:
18762 \begin_inset Newline newline
18765 If you have bad luck, the text will break right between the referenced text
18766 and reference number, and that's a pity.
18768 \begin_inset CommandInset ref
18770 reference "sec:chktex"
18777 \begin_layout Itemize
18779 \begin_inset Quotes eld
18783 \begin_inset Quotes erd
18787 \begin_inset Formula $\times$
18791 \begin_inset Newline newline
18794 2x2 looks cheap compared to
18795 \begin_inset Formula $2\times2$
18801 \begin_layout Standard
18802 and more \SpecialChar ldots
18803 It is an invaluable tool when you are
18804 \begin_inset Quotes eld
18808 \begin_inset Quotes erd
18811 your document before printing, and you should run it right after the obligatory
18812 spelling check, and before you go fine tuning the typesetting.
18815 \begin_layout Subsection
18819 \begin_layout Standard
18820 If you have the program installed, usage is as simple as choosing
18822 Tools\SpecialChar menuseparator
18824 \begin_inset space ~
18830 This will make \SpecialChar LyX
18831 generate a \SpecialChar LaTeX
18832 file of your document, start
18834 Chk\SpecialChar TeX
18837 to check it, and then make \SpecialChar LyX
18839 \begin_inset Quotes eld
18843 \begin_inset Quotes erd
18846 with the warnings from
18848 Chk\SpecialChar TeX
18851 , if there were any.
18852 The warnings will be placed close to the point of the mistake, and you
18853 can quickly find them by using the
18855 Navigate\SpecialChar menuseparator
18858 menu item, or the shortcut key
18867 Open the error boxes by clicking on them with the mouse, or use the shortcut
18876 bindings, or the corresponding
18885 Read the warning and correct the mistake, if it is a mistake.
18886 If you have trouble understanding what the warning is about, you can safely
18888 Remember that there is a hidden layer between the document on screen and
18889 the technical details in invoking
18891 Chk\SpecialChar TeX
18894 , and this gap can make some warnings seem arcane or just plain silly.
18897 \begin_layout Standard
18898 This document is an excellent testing bed for the feature, and it should
18899 provide quite a few warnings for you to fiddle with.
18900 Since computers are only so smart, expect most of the warnings to be false
18904 \begin_layout Subsection
18905 How to fine tune it
18908 \begin_layout Standard
18909 Sometimes, you'll find that
18911 Chk\SpecialChar TeX
18914 makes more noise than suits your mood.
18915 Then you can choose not to use it, wait until your mood changes, or try
18918 Chk\SpecialChar TeX
18921 to get better along with you.
18924 \begin_layout Standard
18927 Chk\SpecialChar TeX
18934 very configurable and extensible, you should not expect to solve all problems
18937 Chk\SpecialChar TeX
18940 in \SpecialChar LyX
18942 Since \SpecialChar LyX
18943 has to generate a somewhat special \SpecialChar LaTeX
18944 file to be able to match the
18945 line numbers from the
18947 Chk\SpecialChar TeX
18954 \begin_layout Plain Layout
18955 You can inspect the specific output from
18961 Document\SpecialChar menuseparator
18964 \begin_inset space ~
18978 to the internal document structure, some of the warnings will not appear
18980 There are two things you can do about this:
18983 \begin_layout Itemize
18986 Chk\SpecialChar TeX
18989 invocation command line in
18990 \begin_inset Flex Noun
18993 \begin_layout Plain Layout
18994 Tools\SpecialChar menuseparator
18995 Preferences\SpecialChar menuseparator
18996 Output\SpecialChar menuseparator
18997 LaTeX\SpecialChar menuseparator
19005 Chk\SpecialChar TeX
19008 installation configuration file (usually with the file
19013 See below to learn what warnings can be enabled and disabled on the command
19017 \begin_layout Itemize
19018 Export your document as a raw \SpecialChar LaTeX
19021 File\SpecialChar menuseparator
19022 Export\SpecialChar menuseparator
19031 Invoked in this way, it can be a hassle to find the corresponding place
19032 in the document inside \SpecialChar LyX
19033 , but with a little patience, you should be able
19037 \begin_layout Standard
19038 Here follows the warning messages that can be enabled and disabled in
19047 to disable a warning, and
19051 to enable a warning.
19052 The emphasized entries are disabled by default, because the default is
19055 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19060 \begin_layout Standard
19061 Notice that you should only use the options that enable and disable warnings,
19062 because \SpecialChar LyX
19063 relies on some of the other command line parameters to be set
19064 in a specific way to have a chance to communicate with
19071 \begin_layout Enumerate
19075 Command terminated with space.
19078 \begin_layout Enumerate
19081 Non-breaking space (
19082 \begin_inset Quotes eld
19090 \begin_inset Quotes erd
19093 ) should have been used.
19096 \begin_layout Enumerate
19100 You should enclose the previous parenthesis with
19101 \begin_inset Quotes eld
19109 \begin_inset Quotes erd
19115 \begin_layout Enumerate
19118 Italic correction (
19119 \begin_inset Quotes eld
19129 \begin_inset Quotes erd
19132 ) found in non-italic buffer.
19135 \begin_layout Enumerate
19138 Italic correction (
19139 \begin_inset Quotes eld
19149 \begin_inset Quotes erd
19152 ) found more than once.
19155 \begin_layout Enumerate
19159 No italic correction (
19160 \begin_inset Quotes eld
19170 \begin_inset Quotes erd
19176 \begin_layout Enumerate
19180 \begin_inset Quotes eld
19188 \begin_inset Quotes erd
19192 \begin_inset Quotes eld
19200 \begin_inset Quotes erd
19206 \begin_layout Enumerate
19209 Wrong length of dash may have been used.
19212 \begin_layout Enumerate
19216 \begin_inset Quotes eld
19224 \begin_inset Quotes erd
19228 \begin_inset Quotes eld
19236 \begin_inset Quotes erd
19242 \begin_layout Enumerate
19246 \begin_inset Quotes eld
19254 \begin_inset Quotes erd
19260 \begin_layout Enumerate
19264 \begin_inset Quotes eld
19272 \begin_inset Quotes erd
19275 to achieve an ellipsis.
19278 \begin_layout Enumerate
19281 Inter-word spacing (
19282 \begin_inset Quotes eld
19292 \begin_inset Quotes eld
19295 ) should perhaps be used.
19298 \begin_layout Enumerate
19301 Inter-sentence spacing (
19302 \begin_inset Quotes eld
19312 \begin_inset Quotes erd
19315 ) should perhaps be used.
19318 \begin_layout Enumerate
19321 Could not find argument for command.
19324 \begin_layout Enumerate
19328 \begin_inset Quotes eld
19336 \begin_inset Quotes erd
19342 \begin_layout Enumerate
19345 Math mode still on at end of \SpecialChar LaTeX
19349 \begin_layout Enumerate
19353 \begin_inset Quotes eld
19361 \begin_inset Quotes erd
19364 doesn't match the number of
19365 \begin_inset Quotes eld
19373 \begin_inset Quotes erd
19379 \begin_layout Enumerate
19382 You should use either
19385 \begin_inset Quotes eld
19393 \begin_inset Quotes erd
19398 as an alternative to
19399 \begin_inset Quotes eld
19407 \begin_inset Quotes erd
19413 \begin_layout Enumerate
19420 " (ASCII 39) instead of "
19427 \begin_layout Enumerate
19430 User-specified pattern found.
19433 \begin_layout Enumerate
19436 This command might not be intended.
19439 \begin_layout Enumerate
19446 \begin_layout Enumerate
19464 \begin_layout Enumerate
19467 Delete this space to maintain correct page references.
19470 \begin_layout Enumerate
19474 You might wish to put this between a pair of
19475 \begin_inset Quotes eld
19483 \begin_inset Quotes erd
19489 \begin_layout Enumerate
19492 You ought to remove spaces in front of punctuation.
19495 \begin_layout Enumerate
19498 Could not execute \SpecialChar LaTeX
19502 \begin_layout Enumerate
19511 in front of small punctuation.
19514 \begin_layout Enumerate
19522 may look prettier here.
19525 \begin_layout Enumerate
19529 Multiple spaces detected in output.
19532 \begin_layout Enumerate
19535 This text may be ignored.
19538 \begin_layout Enumerate
19544 \begin_inset Quotes eld
19549 to begin quotation, not
19556 \begin_layout Enumerate
19563 to end quotation, not
19566 \begin_inset Quotes eld
19574 \begin_layout Enumerate
19580 \begin_layout Enumerate
19583 You should perhaps use
19584 \begin_inset Quotes eld
19592 \begin_inset Quotes erd
19598 \begin_layout Enumerate
19601 You should put a space in front of/after parenthesis.
19604 \begin_layout Enumerate
19607 You should avoid spaces in front of/after parenthesis.
19610 \begin_layout Enumerate
19614 You should not use punctuation in front of/after quotes.
19617 \begin_layout Enumerate
19620 Double space found.
19623 \begin_layout Enumerate
19626 You should put punctuation outside inner/inside display math mode.
19629 \begin_layout Enumerate
19632 You ought to not use primitive \SpecialChar TeX
19633 in \SpecialChar LaTeX
19637 \begin_layout Enumerate
19640 You should remove spaces in front of
19641 \begin_inset Quotes eld
19649 \begin_inset Quotes erd
19655 \begin_layout Enumerate
19658 \begin_inset Quotes eld
19666 \begin_inset Quotes erd
19669 is normally not followed by
19670 \begin_inset Quotes eld
19678 \begin_inset Quotes erd
19684 \begin_layout Standard
19685 In later versions of \SpecialChar LyX
19686 , we hope to provide a more complete interface to this
19687 tool (and it's smaller cousin
19691 ) to exploit the full power of it.
19692 But it's not exactly useless as it is now: go try it on one of your existing
19693 documents of a certain length and be surprised.
19696 \begin_layout Section
19697 Version Control in \SpecialChar LyX
19701 \begin_layout Standard
19704 Lars Gullik Bjønnes
19711 \begin_layout Subsection
19715 \begin_layout Standard
19717 supports some of the most basic RCS/CVS/SVN/GIT commands.
19718 If you need something a bit more sophisticated you will have to do that
19719 manually in a terminal.
19722 \begin_layout Standard
19723 Also note that CVS support is not as good as subversion support so we advise
19725 A good place to start learning Subversion is SVN Book
19729 \begin_layout Plain Layout
19730 \begin_inset CommandInset href
19732 target "http://svnbook.red-bean.com/"
19742 In the case of RCS you should read
19743 \begin_inset Quotes eld
19747 \begin_inset Quotes erd
19750 (a man file, read it with
19755 This file describes all the basic features of RCS.
19756 You should especially notice the comment about a RCS directory, and the
19757 notion of a master RCS file (the file ending in
19764 \begin_layout Standard
19765 Before you begin to use the version control features in \SpecialChar LyX
19767 familiar with RCS/CVS/SVN/GIT usage.
19768 The implementation in \SpecialChar LyX
19769 assumes a recent version of the GNU RCS or CVS/SVN
19770 package — no guarantees are made for older versions.
19771 Most of the log messages are not currently displayed after operations —
19772 you can check them in the Messages pane if unsure.
19773 Regular users of version control will appreciate VC toolbar, which can
19776 View\SpecialChar menuseparator
19777 Toolbars\SpecialChar menuseparator
19779 \begin_inset space ~
19787 \begin_layout Standard
19788 For introducing your own external commands consult vc-command in the manual
19789 of \SpecialChar LyX
19793 \begin_layout Standard
19794 It is strongly recommended to store documents in uncompressed format if
19795 using version control (uncheck
19797 Document\SpecialChar menuseparator
19800 if it is checked): Uncompressed LyX documents are text files and therefore
19801 for merging two different versions by version control systems.
19802 Compressed LyX documents are binary files, which cannot be merged by version
19806 \begin_layout Subsection
19807 RCS commands in \SpecialChar LyX
19811 \begin_layout Standard
19812 The following sections describe the RCS commands supported by \SpecialChar LyX
19814 You can find them in the
19816 File\SpecialChar menuseparator
19818 \begin_inset space ~
19825 was tested against RCS 5.7/5.8.
19828 \begin_layout Subsubsection
19834 \begin_layout Standard
19835 If your document is not under revision control, this is the only item shown
19837 And if it is under revision control, the
19841 item is not visible.
19845 \begin_layout Standard
19846 This command registers your document with RCS (unless you are under the
19847 directory managed by CVS)\SpecialChar endofsentence
19848 You are asked interactively to supply an initial
19849 description of the document.
19850 The document is now set in Read-Only mode and you have to
19853 \begin_inset space ~
19857 \begin_inset space ~
19861 \begin_inset space ~
19866 , before making any changes to it.
19867 A document under revision control has a
19868 \begin_inset Quotes eld
19871 [RCS:<version> <locker>]
19872 \begin_inset Quotes erd
19875 item tagged to the filename in the minibuffer.
19878 \begin_layout Standard
19879 RCS command that is run:
19881 ci -q -u -i -t-"<initial description>" <file-name>
19884 \begin_layout Standard
19889 to understand the switches.
19893 \begin_layout Subsubsection
19899 \begin_layout Standard
19900 When you are finished editing a file, you check in your changes.
19901 When you do this, you are asked for a description of the changes.
19902 This is stored in the history log.
19903 The version number is bumped, your changes are applied to the master RCS
19904 file, the document is unlocked and set to Read-Only mode.
19907 \begin_layout Standard
19910 ci -q -u -m"<description>" <file-name>
19913 \begin_layout Subsubsection
19919 \begin_layout Standard
19920 By doing this you lock the document so that only you can edit it.
19921 This will also make the document Read-Write only for you.
19922 You will usually continue editing for a while and when you are finished
19923 you check in your changes.
19924 The status line is changed to reflect that you have locked the file.
19927 \begin_layout Standard
19930 co -q -l <file-name>
19933 \begin_layout Subsubsection
19936 Revert To Repository Version
19939 \begin_layout Standard
19940 This will discard all changes made to the document since the last check
19942 You get a warning before changes are discarded.
19945 \begin_layout Standard
19948 co -f -u<version> <file-name>
19951 \begin_layout Subsubsection
19957 \begin_layout Standard
19958 This will create a copy of the current document.
19959 Since RCS does not support copy operations natively, the version history
19960 is not preserved, and the copy is added as a new file.
19961 It requires a clean document without any changes since the last checkin.
19962 You are asked for a file name and a description of the copy operation.
19963 After that the copy is created, both locally and in the repository.
19964 If the parent directories of the copied and original document differ, all
19965 relative paths of included files of the copy are adjusted (like in
19967 File\SpecialChar menuseparator
19972 Finally, the copy is loaded instead of the original document.
19975 \begin_layout Labeling
19976 \labelwidthstring 00.00.0000
19978 \begin_inset space ~
19982 \begin_inset space ~
19986 \begin_inset Newline newline
19990 \begin_inset Flex Code
19993 \begin_layout Plain Layout
19996 \begin_inset Quotes eld
20000 \begin_inset Quotes erd
20009 \begin_inset Flex Code
20012 \begin_layout Plain Layout
20015 \begin_inset Quotes eld
20019 \begin_inset Quotes erd
20028 \begin_inset Newline newline
20032 \begin_inset Flex Code
20035 \begin_layout Plain Layout
20039 \begin_inset Quotes eld
20043 \begin_inset Quotes erd
20054 \begin_layout Subsubsection
20060 \begin_layout Standard
20061 This makes as if the last check in never happened.
20062 No changes are made to the document loaded into \SpecialChar LyX
20063 , but the last version
20064 is removed from the master RCS file.
20067 \begin_layout Standard
20070 rcs -o<version> <file-name>
20073 \begin_layout Subsubsection
20079 \begin_layout Standard
20080 This shows the complete history of the RCS document.
20085 is shown in a browser.
20093 \begin_layout Subsubsection
20097 \begin_layout Standard
20099 supports RCS version number, author name, date and time of last commit.
20100 All those are extracted from
20102 rlog -r <file-name>
20106 \begin_inset CommandInset ref
20108 reference "subsec:VCS-Revision-Information"
20115 \begin_layout Subsection
20116 CVS commands in \SpecialChar LyX
20120 \begin_layout Standard
20121 A subset of CVS operations is supported by \SpecialChar LyX
20123 You can find the commands in the
20125 File\SpecialChar menuseparator
20127 \begin_inset space ~
20133 The version control system SVN is more powerful, so please use it instead
20134 of CVS if possible.
20137 \begin_layout Subsubsection
20143 \begin_layout Standard
20144 If you start from scratch with CVS you have to create your repository and
20145 checkout the working copy with external tools.
20146 If you're using a client-server setup you may need to login before doing
20147 the first repository checkout.
20150 \begin_layout Standard
20151 If your documents are under revision control and others are using the same
20152 repository problems arise when different changes to the same document at
20153 the same location happen.
20154 Standard CVS repositories don't operate with a file locking mechanism.
20155 This may be surprising, but conflicts only occur if people disagree on
20156 the proper content of the same part of a document.
20157 So, if co-workers are used to communicate regularly, these conflicts occur
20159 If they don't communicate they have a fundamental problem anyway.
20160 Nevertheless some people like to work with so called
20161 \begin_inset Quotes eld
20165 \begin_inset Quotes erd
20169 If they do so the working copy of all files is readonly when checked out
20170 first and the user starts editing after using a special command to make
20171 the working copy writable.
20172 When the changes are checked in the working copy returns to readonly state.
20173 With \SpecialChar LyX
20174 one has to edit the
20175 \begin_inset Flex Code
20178 \begin_layout Plain Layout
20184 file and add the line
20185 \begin_inset Flex Code
20188 \begin_layout Plain Layout
20194 to work with reserved checkouts.
20195 The benefit is the possibility to see who is using a writable copy of some
20197 It's not guaranteed only one user makes a copy writable.
20200 \begin_layout Standard
20202 tries to guess if you're using reserved or non-reserved checkouts.
20203 If your working copy is readonly or it is writable and an additional copy
20204 of your document exists in the CVS/Base sub-directory a reserved otherwise
20205 a non-reserved checkout is assumed.
20206 When a reserved checkout is detected you have to use
20207 \begin_inset Flex Noun
20210 \begin_layout Plain Layout
20216 to make your working copy writable if it's readonly.
20218 \begin_inset Flex Noun
20221 \begin_layout Plain Layout
20227 operation is possible and that makes your working copy readonly again after
20228 transferring your changes to the repository.
20231 \begin_layout Standard
20232 More information about CVS can be found here
20233 \begin_inset Flex URL
20236 \begin_layout Plain Layout
20238 http://www.nongnu.org/cvs
20244 \begin_inset Flex URL
20247 \begin_layout Plain Layout
20249 http://ximbiot.com/cvs
20257 \begin_layout Standard
20262 to understand the sub-commands and the switches mentioned below.
20265 \begin_layout Subsubsection
20271 \begin_layout Standard
20272 If your document is not under revision control, this is the only item shown
20274 And if it is under revision control, the
20281 item is not visible.
20285 \begin_layout Standard
20286 This command registers in CVS your document
20287 \begin_inset Flex Strong
20290 \begin_layout Plain Layout
20298 in the case you have already the documents directory under CVS control
20304 This means you have to create or checkout the archive by yourself using
20306 (In case you forget that step \SpecialChar LyX
20307 registers the document with RCS.)
20310 \begin_layout Standard
20311 Then you are asked interactively to supply an initial description of the
20313 Don't forget that registered file is not yet checked in.
20316 \begin_layout Standard
20317 CVS command that is run:
20319 cvs -q add -m"<entered message>" "<file-name>"
20322 \begin_layout Standard
20327 above and for all other CVS commands is an abbreviation for
20328 \begin_inset Quotes eld
20331 change the current working directory to file location and use the file name
20332 without path component as argument
20333 \begin_inset Quotes erd
20339 \begin_layout Subsubsection
20345 \begin_layout Standard
20346 When you are finished editing a file, you commit your changes.
20347 When you do this and you had changed the document, you are asked for a
20348 description of the changes.
20349 After that changes are written to the repository.
20350 In case you didn't change the document and a reserved checkout is detected
20351 the reservation made on
20352 \begin_inset Flex Noun
20355 \begin_layout Plain Layout
20364 \begin_layout Labeling
20365 \labelwidthstring 00.00.0000
20367 \begin_inset space ~
20371 \begin_inset space ~
20375 \begin_inset Newline newline
20379 \begin_inset Flex Code
20382 \begin_layout Plain Layout
20385 -q commit -m"<description>" "<file-name>"
20391 \begin_inset Newline newline
20395 \begin_inset Flex Code
20398 \begin_layout Plain Layout
20409 \begin_layout Subsubsection
20415 \begin_layout Standard
20416 When you are sharing a repository with others, you may have to incorporate
20417 their changes into your working copy.
20420 \begin_layout Standard
20423 cvs -q update "<file-name>"
20426 \begin_layout Standard
20427 If a readonly checkout is detected the working copy is made writable and
20431 \begin_layout Standard
20434 cvs -q edit "<file-name>"
20437 \begin_layout Subsubsection
20440 Revert To Repository Version
20443 \begin_layout Standard
20444 This will discard all changes made to the document since the last check
20446 You get a warning before changes are discarded.
20447 Firstly the file is deleted, secondly CVS update command is run.
20450 \begin_layout Standard
20453 cvs -q update "<file-name>"
20456 \begin_layout Standard
20457 If a reserved checkout is detected and the working copy has no changes only
20458 the reservation is undone.
20461 \begin_layout Standard
20464 cvs -q unedit "<file-name>"
20467 \begin_layout Subsubsection
20473 \begin_layout Standard
20474 This will create a copy of the current document.
20475 Since CVS does not support copy operations natively, the version history
20476 is not preserved, and the copy is added as a new file.
20477 It requires a clean document without any changes since the last checkin.
20478 You are asked for a file name and a description of the copy operation.
20479 After that the copy is created, both locally and in the repository.
20480 If the parent directories of the copied and original document differ, all
20481 relative paths of included files of the copy are adjusted (like in
20483 File\SpecialChar menuseparator
20488 Finally, the copy is loaded instead of the original document.
20491 \begin_layout Labeling
20492 \labelwidthstring 00.00.0000
20494 \begin_inset space ~
20498 \begin_inset space ~
20502 \begin_inset Newline newline
20506 \begin_inset Flex Code
20509 \begin_layout Plain Layout
20512 \begin_inset Quotes eld
20516 \begin_inset Quotes erd
20525 \begin_inset Flex Code
20528 \begin_layout Plain Layout
20531 \begin_inset Quotes eld
20535 \begin_inset Quotes erd
20544 \begin_inset Newline newline
20548 \begin_inset Flex Code
20551 \begin_layout Plain Layout
20555 \begin_inset Quotes eld
20559 \begin_inset Quotes erd
20570 \begin_layout Subsubsection
20576 \begin_layout Standard
20577 This will rename the current document.
20578 Since CVS does not support rename operations natively, the version history
20579 is not preserved, the renamed document is added as a new file, and the
20580 original document is deleted.
20581 It requires a clean document without any changes since the last checkin.
20582 You are asked for a file name and a description of the rename operation.
20583 After that the document is renamed, both locally and in the repository.
20584 If the parent directories of the new and old file names differ, all relative
20585 paths of included files are adjusted (like in
20587 File\SpecialChar menuseparator
20592 Finally, the document is reloaded using the new name.
20595 \begin_layout Labeling
20596 \labelwidthstring 00.00.0000
20598 \begin_inset space ~
20602 \begin_inset space ~
20606 \begin_inset Newline newline
20610 \begin_inset Flex Code
20613 \begin_layout Plain Layout
20616 \begin_inset Quotes eld
20620 \begin_inset Quotes erd
20629 \begin_inset Flex Code
20632 \begin_layout Plain Layout
20635 \begin_inset Quotes eld
20639 \begin_inset Quotes erd
20648 \begin_inset Newline newline
20652 \begin_inset Flex Code
20655 \begin_layout Plain Layout
20659 \begin_inset Quotes eld
20663 \begin_inset Quotes erd
20672 \begin_inset Newline newline
20676 \begin_inset Flex Code
20679 \begin_layout Plain Layout
20683 \begin_inset Quotes eld
20687 \begin_inset Quotes erd
20698 \begin_layout Subsubsection
20699 Update of the local directory checkout from repository
20702 \begin_layout Standard
20703 Once your documents gets more complex, containing sub-documents and pictures,
20705 \begin_inset Flex Code
20708 \begin_layout Plain Layout
20714 files and so on using version control becomes more complicated.
20716 supports updating the whole tree in which resides the document.
20717 This become especially useful once you cooperate with people which neither
20718 have detailed knowledge about CVS usage nor they have ambition to commit
20719 additional material to the repository.
20720 You have to organize the files structure so that all external files are
20721 in the same directory or subdirectories of the document.
20722 It's good practice anyway to store multipart documents in an extra directory.
20725 \begin_layout Standard
20727 \begin_inset Flex Code
20730 \begin_layout Plain Layout
20731 Update local directory from repository
20736 command updates the whole directory.
20737 If local changes are detected user is warned before update starts.
20738 In case of merge conflicts both versions of the conflicting document parts
20739 are placed in the final document.
20740 You have to review and correct the result of the merge.
20741 You'll find the conflicts enclosed in pairs of
20742 \begin_inset Flex Code
20745 \begin_layout Plain Layout
20752 \begin_inset Flex Code
20755 \begin_layout Plain Layout
20762 \begin_inset Flex Code
20765 \begin_layout Plain Layout
20772 The first part is your version as before the update operation with the
20773 document name prepended.
20774 The second one is the repository version with the version number after
20776 \begin_inset Flex Code
20779 \begin_layout Plain Layout
20788 \begin_layout Labeling
20789 \labelwidthstring 00.00.0000
20791 \begin_inset space ~
20795 \begin_inset space ~
20799 \begin_inset Newline newline
20803 \begin_inset Flex Code
20806 \begin_layout Plain Layout
20814 (Ask if changes are detected.)
20815 \begin_inset Newline newline
20819 \begin_inset Flex Code
20822 \begin_layout Plain Layout
20823 cd $path; cvs -q update
20833 \begin_layout Standard
20835 \begin_inset Flex Code
20838 \begin_layout Plain Layout
20844 stands for the path to the document.
20847 \begin_layout Subsubsection
20853 \begin_layout Standard
20854 This shows the complete history of the CVS document.
20857 cvs log "<file-name>"
20859 is shown in a browser.
20862 \begin_layout Subsubsection
20866 \begin_layout Standard
20868 supports CVS version number, author name, date and time of last commit.
20869 All those are extracted from
20871 cvs log -r <file-name>
20875 \begin_inset CommandInset ref
20877 reference "subsec:VCS-Revision-Information"
20884 \begin_layout Subsection
20885 SVN commands in \SpecialChar LyX
20889 \begin_layout Standard
20890 SVN is now partially supported by \SpecialChar LyX
20892 You can find the commands in the
20894 File\SpecialChar menuseparator
20896 \begin_inset space ~
20902 Please note that if you use password protected access to repository via
20903 ssh, you will be asked in terminal window.
20905 was tested against SVN 1.5, 1.6, 1.7 and 1.8
20909 \begin_layout Plain Layout
20910 Most of the commands will work with 1.4 too, see
20911 \begin_inset CommandInset ref
20913 reference "subsec:SVN-Repo-Update"
20918 There seems to be currently unresolved permissions problem under SVN 1.8
20919 with reverting changes when file is locked.
20927 \begin_layout Subsubsection
20933 \begin_layout Standard
20934 If your document is not under revision control, this is the only item shown
20936 And if it is under revision control, the
20943 item is not visible.
20946 \begin_layout Standard
20947 This command registers in SVN your document ONLY in case you have already
20948 the documents directory under SVN control (in particular
20953 This means you have to checkout the archive by yourself.
20956 \begin_layout Standard
20957 Then you are asked interactively to supply an initial description of the
20959 Don't forget that registered file is not yet commited.
20962 \begin_layout Standard
20963 SVN command that is run:
20966 \begin_inset Quotes eld
20970 \begin_inset Quotes erd
20976 \begin_layout Standard
20981 to understand the switches.
20984 \begin_layout Subsubsection
20990 \begin_layout Standard
20991 When you are finished editing a file, you commit your changes.
20992 When you do this, you are asked for a description of the changes.
20993 After that changes are commited.
20996 \begin_layout Standard
21001 \begin_layout Plain Layout
21002 In case locking is not enabled.
21004 \begin_inset CommandInset ref
21006 reference "subsec:SVN-File-Locking"
21017 svn commit -q -m"<description>" <file-name>
21020 \begin_layout Subsubsection
21026 \begin_layout Standard
21027 Updates the changes of this file from the repository.
21028 Be sure you understand SVN merging and conflicts resolving before using
21029 this function, because all conflicts has to be resolved manually by you!
21032 \begin_layout Standard
21037 \begin_layout Plain Layout
21045 svn update --non-interactive
21046 \begin_inset Quotes eld
21050 \begin_inset Quotes erd
21056 \begin_layout Subsubsection
21059 Revert To Repository Version
21062 \begin_layout Standard
21063 This will discard all changes made to the document since the last check
21065 You get a warning before changes are discarded.
21068 \begin_layout Standard
21072 \begin_inset Quotes eld
21076 \begin_inset Quotes erd
21082 \begin_layout Subsubsection
21088 \begin_layout Standard
21089 This will create a copy of the current document including the version history.
21090 It requires a clean document without any changes since the last checkin.
21091 You are asked for a file name and a description of the copy operation.
21092 After that the copy is created, both locally and in the repository.
21093 If the parent directories of the copied and original document differ, all
21094 relative paths of included files of the copy are adjusted (like in
21096 File\SpecialChar menuseparator
21101 Finally, the copy is loaded instead of the original document.
21104 \begin_layout Labeling
21105 \labelwidthstring 00.00.0000
21107 \begin_inset space ~
21111 \begin_inset space ~
21115 \begin_inset Newline newline
21119 \begin_inset Flex Code
21122 \begin_layout Plain Layout
21126 \begin_inset Quotes eld
21130 \begin_inset Quotes erd
21134 \begin_inset Quotes eld
21138 \begin_inset Quotes erd
21147 \begin_inset Newline newline
21151 \begin_inset Flex Code
21154 \begin_layout Plain Layout
21163 \begin_layout Subsubsection
21169 \begin_layout Standard
21170 This will rename the current document including the version history.
21171 It requires a clean document without any changes since the last checkin.
21172 You are asked for a file name and a description of the rename operation.
21173 After that the document is renamed, both locally and in the repository.
21174 If the parent directories of the new and old file names differ, all relative
21175 paths of included files are adjusted (like in
21177 File\SpecialChar menuseparator
21182 Finally, the document is reloaded using the new name.
21185 \begin_layout Labeling
21186 \labelwidthstring 00.00.0000
21188 \begin_inset space ~
21192 \begin_inset space ~
21196 \begin_inset Newline newline
21200 \begin_inset Flex Code
21203 \begin_layout Plain Layout
21207 \begin_inset Quotes eld
21211 \begin_inset Quotes erd
21215 \begin_inset Quotes eld
21219 \begin_inset Quotes erd
21228 \begin_inset Newline newline
21232 \begin_inset Flex Code
21235 \begin_layout Plain Layout
21244 \begin_layout Subsubsection
21245 \begin_inset CommandInset label
21247 name "subsec:SVN-Repo-Update"
21251 Update of the local directory checkout from repository
21255 \begin_layout Plain Layout
21256 Note that this command will work only with subversion
21257 \begin_inset Formula $\geqq1.5$
21268 \begin_layout Standard
21269 All the commands above have one shortcomming - they deal with the current
21271 Once your document contains pictures, includes external
21272 \begin_inset Flex Code
21275 \begin_layout Plain Layout
21281 files and so on administration becomes more complicated.
21283 now supports updating the whole tree in which resides the document
21287 \begin_layout Plain Layout
21288 One need to organize the files structure so that all external files are
21289 in the same directory or subdirectories of the document.
21296 This become especially useful once you cooperate with people which neither
21297 know about subversion management nor they have ambition to commit additional
21298 material to the repository.
21302 \begin_layout Standard
21303 \begin_inset Flex Code
21306 \begin_layout Plain Layout
21307 Update local directory from repository
21312 command updates the whole directory and in case of merge conflicts local
21313 version of the files are left, so no unintended data loss occurs.
21314 If local changes are detected user is warned before update starts.
21317 \begin_layout Labeling
21318 \labelwidthstring 00.00.0000
21320 \begin_inset space ~
21324 \begin_inset space ~
21328 \begin_inset Newline newline
21332 \begin_inset Flex Code
21335 \begin_layout Plain Layout
21341 (Ask if changes are detected.)
21342 \begin_inset Newline newline
21346 \begin_inset Flex Code
21349 \begin_layout Plain Layout
21350 svn update –accept mine-full $path
21358 \begin_layout Standard
21360 \begin_inset Flex Code
21363 \begin_layout Plain Layout
21369 stands for the path to the document.
21372 \begin_layout Subsubsection
21378 \begin_layout Standard
21379 This shows the complete history of the SVN document.
21383 \begin_inset Quotes eld
21387 \begin_inset Quotes erd
21392 is shown in a browser.
21395 \begin_layout Subsubsection
21397 \begin_inset CommandInset label
21399 name "subsec:SVN-File-Locking"
21406 \begin_layout Standard
21407 The file exchange through various revision control systems brings the problem
21408 of merge conflicts in case two different users try to edit the same (parts
21410 When such a conflict happens it needs manual resolving and one reasonable
21411 alternative is to provide some kind of locking mechanism, which guarantees
21412 that only one user is allowed to edit file at the given time.
21415 \begin_layout Standard
21416 SVN has two such mechanisms to provide mutual exclusivity for file access
21417 - locks and automatic setting of write permissions (see sec.
21419 \begin_inset CommandInset ref
21421 reference "subsec:Automatical-Locking-Property"
21426 \begin_inset Flex Code
21429 \begin_layout Plain Layout
21439 \begin_layout Plain Layout
21440 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21446 If this property is detected for a given document \SpecialChar LyX
21447 starts to use SVN locks
21448 for document editing automatically and the whole check-in/out mechanism
21449 switches to the same regimen as for RCS.
21450 This in particular means there are two different modes of file use in \SpecialChar LyX
21454 \begin_layout Itemize
21456 The loaded file is in the read-only mode.
21457 For editing on needs to check-out.
21462 consists of updating from the repository and gaining write lock.
21463 If the lock is not possible to obtain, we remain in unlocked state.
21466 \begin_layout Itemize
21468 The loaded file is in the 'normal' edit mode.
21469 No other user is allowed to edit the file.
21474 consists of commiting changes and releasing write-lock.
21475 If no changes have been made to the document, no commit will be produced
21479 \begin_layout Plain Layout
21480 Don't be puzzled by the fact that you will be asked for commit message anyway.
21485 and only the write-lock will be released.
21488 \begin_layout Standard
21492 \begin_layout Labeling
21493 \labelwidthstring 00.00.0000
21496 svn commit -q -m"<description>" "<file-name>"
21497 \begin_inset Newline newline
21500 svn unlock "<file-name>"
21503 \begin_layout Labeling
21504 \labelwidthstring 00.00.0000
21507 svn update "<file-name>"
21508 \begin_inset Newline newline
21511 svn lock "<file-name>"
21514 \begin_layout Subsubsection
21517 \begin_inset CommandInset label
21519 name "subsec:Automatical-Locking-Property"
21525 Automatic Locking Property
21528 \begin_layout Standard
21529 The above mentioned automatic setting of write permissions of the .lyx file
21535 ile\SpecialChar menuseparator
21541 \begin_inset space ~
21544 Control\SpecialChar menuseparator
21549 oggle locking property
21552 This command is active only when the file is not locked on the svn server
21554 you need to check-out before proceeding).
21557 \begin_layout Labeling
21558 \labelwidthstring 00.00.0000
21560 \begin_inset space ~
21566 \begin_layout Labeling
21567 \labelwidthstring 00.00.0000
21570 svn propset svn:needs-lock ON "<file-name>"
21573 \begin_layout Labeling
21574 \labelwidthstring 00.00.0000
21577 svn propdel svn:needs-lock "<file-name>"
21580 \begin_layout Subsubsection
21581 \begin_inset CommandInset label
21583 name "subsec:VCS-Revision-Information"
21587 Revision Information in Documents
21590 \begin_layout Standard
21591 There are more possibilities how to activate revision information in our
21595 \begin_layout Itemize
21598 \begin_inset Separator parbreak
21605 \begin_layout Itemize
21606 tree revision information (
21607 \begin_inset Flex Code
21610 \begin_layout Plain Layout
21617 The result is the output of the
21618 \begin_inset Flex Code
21621 \begin_layout Plain Layout
21627 command, the following table gives you an idea, how to read the results.
21630 \begin_layout Standard
21632 \begin_inset Tabular
21633 <lyxtabular version="3" rows="6" columns="2">
21634 <features tabularvalignment="middle">
21635 <column alignment="center" valignment="top">
21636 <column alignment="center" valignment="top">
21638 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21641 \begin_layout Plain Layout
21647 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21650 \begin_layout Plain Layout
21658 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21661 \begin_layout Plain Layout
21667 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21670 \begin_layout Plain Layout
21671 mixed revision working copy
21678 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21681 \begin_layout Plain Layout
21687 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21690 \begin_layout Plain Layout
21691 modified working copy
21698 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21701 \begin_layout Plain Layout
21707 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21710 \begin_layout Plain Layout
21711 switched working copy
21718 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21721 \begin_layout Plain Layout
21727 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21730 \begin_layout Plain Layout
21731 partial working copy, from a sparse checkout
21738 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21741 \begin_layout Plain Layout
21747 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21750 \begin_layout Plain Layout
21751 mixed revision, modified, switched working copy
21764 \begin_layout Itemize
21765 file revision information.
21766 The result comes from parsing the output of
21767 \begin_inset Flex Code
21770 \begin_layout Plain Layout
21772 \begin_inset space ~
21776 \begin_inset space ~
21780 \begin_inset space ~
21789 Supported flags are:
21790 \begin_inset Separator parbreak
21797 \begin_layout Itemize
21798 version number of the last commit (
21799 \begin_inset Flex Code
21802 \begin_layout Plain Layout
21811 \begin_layout Itemize
21812 author of the last commit (
21813 \begin_inset Flex Code
21816 \begin_layout Plain Layout
21825 \begin_layout Itemize
21826 date of the last commit (
21827 \begin_inset Flex Code
21830 \begin_layout Plain Layout
21839 \begin_layout Itemize
21840 time of the last commit (
21841 \begin_inset Flex Code
21844 \begin_layout Plain Layout
21854 \begin_layout Standard
21855 You can obtain this info via InsetInfo (e.g.
21857 \begin_inset Flex Code
21860 \begin_layout Plain Layout
21861 info-insert buffer vcs-date
21867 The information will be available only when you have the file stored under
21868 svn managment (i.e.
21870 \begin_inset Flex Code
21873 \begin_layout Plain Layout
21879 directory is available with your document).
21883 \begin_layout Itemize
21884 Another—a hacking one—possibility is to use svn keywords
21888 \begin_layout Plain Layout
21889 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
21895 In short – you set file keywords property (e.g.
21898 svn propset svn:keywords 'Rev' file.lyx
21900 ) and then paste keyword \SpecialChar TeX
21905 \begin_layout Plain Layout
21906 This is an easy way how to ensure that \SpecialChar LyX
21907 won't break the line in the middle
21913 tag in your document (e.g.
21918 \begin_layout Plain Layout
21926 This way svn client will automatically substitute revision number (e.g.
21931 \begin_layout Plain Layout
21938 ) after each update and commit.
21939 There are more problems with this approach.
21940 Firstly, the '$' character is used in \SpecialChar TeX
21941 world for math equations, so any
21942 occurence of math formula
21943 \begin_inset Formula $Rev$
21947 \begin_inset Formula $Rev:59$
21950 in your \SpecialChar LyX
21952 Similarly for other keywords like Id, Date, Author, etc.
21953 Secondly svn output is dependent on your locales, so its very easy that
21954 svn would produce some problematic strings once Date is used.
21955 Thirdly you get the whole 'Rev: 59' string in your document instead of
21957 Until subversion implements user's custom keywords it will be hard to use
21958 this approach reliably or let \SpecialChar LyX
21959 to support it directly.
21962 \begin_layout Subsection
21963 SVN and Windows Environment
21966 \begin_layout Quote
21967 My inclination is to say that if the user cannot figure out the command
21968 line operations on their own fairly quickly, they would be well advised
21969 to use TortoiseSVN.
21975 \begin_layout Subsubsection
21979 \begin_layout Standard
21980 In addition to installing \SpecialChar LyX
21981 , and having access to a Subversion repository,
21982 the user will need to install the Subversion client program.
21983 A Windows installer for the client program is available from
21984 \begin_inset CommandInset href
21987 target "http://www.collab.net/nonav/downloads/subversion/"
21992 The user may also want to install
21993 \begin_inset CommandInset href
21996 target "http://tortoisesvn.tigris.org/"
22000 , which integrates Subversion operations into the context (rightclick) menu
22001 of Windows Explorer.
22002 Operations done outside \SpecialChar LyX
22003 will typically be more convenient using the Explorer
22005 Note that TortoiseSVN is not a replacement for the client program, which
22006 is what \SpecialChar LyX
22010 \begin_layout Subsubsection
22011 Bringing a document under Subversion control
22014 \begin_layout Standard
22015 Before a \SpecialChar LyX
22016 document can be brought under version control in Subversion, its
22017 parent directory needs to be under version control.
22018 If the document is being added to a project already in the repository,
22019 this is accomplished by checking the project out to the directory where
22020 the new document will be placed.
22021 If the project itself is not yet under version control (for instance, if
22022 this document starts a new project), the directory must be imported into
22024 This is done outside \SpecialChar LyX
22026 Both import and checkout are easily accomplished from the Explorer context
22027 menu using TortoiseSVN, or alternatively can be done using the command
22028 line client at a DOS prompt.
22029 The procedure for importing the project using TortoiseSVN is described
22030 below, assuming an existing repository and a new project being started
22038 For information on using the Subversion client program, run
22045 \begin_layout Enumerate
22052 in Windows Explorer, right click it, and select
22054 TortoiseSVN\SpecialChar menuseparator
22058 If necessary, adjust the URL for the repository, then click OK.
22061 \begin_layout Enumerate
22062 Right click the level of the repository under which you want to place the
22063 new project folder (typically the top level) and click
22067 Supply a name for the project folder and click OK.
22068 Add a message for the log file if desired, then click OK again.
22069 The new project folder should appear in the repository.
22070 Finally, click OK again to exit the repository browser.
22073 \begin_layout Enumerate
22074 Once again right click
22080 , this time selecting SVN Checkout\SpecialChar ldots
22081 Select the URL of the project folder
22082 you just created in the repository, and set the checkout directory to
22090 You will be warned about a non-empty folder; click OK to proceed.
22091 You should now have a
22102 \begin_layout Enumerate
22103 Create or open your document in \SpecialChar LyX
22106 File\SpecialChar menuseparator
22108 \begin_inset space ~
22111 Control\SpecialChar menuseparator
22115 Add a log message and click OK to commit the document to version control.
22118 \begin_layout Standard
22119 From this point onward, you should have full functionality in the
22121 File\SpecialChar menuseparator
22123 \begin_inset space ~
22129 You also have the option of checking the document in and out, viewing its
22131 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22132 client program from a command prompt.
22135 \begin_layout Subsubsection
22136 SSH tunnel used with SVN under Windows
22139 \begin_layout Standard
22140 Compared with Linux setting up an svn client to communicate over ssh under
22141 Windows is a rather troublesome task.
22142 We will at least offer some hints how to setup the client side but prior
22143 knowledge about ssh and the Windows command line is needed, also be prepared
22144 for a great deal of frustration\SpecialChar ldots
22148 \begin_layout Enumerate
22149 Get an svn client for windows, as described in the previous sections.
22150 When it is a fresh install run some svn command (e.g.
22152 \begin_inset Flex Code
22155 \begin_layout Plain Layout
22161 ) to create config files, which you will need to change later on.
22164 \begin_layout Enumerate
22165 Choose an ssh client for Windows.
22166 There are several possibilities, we will use the one from Putty tools
22170 \begin_layout Plain Layout
22171 \begin_inset Flex URL
22174 \begin_layout Plain Layout
22176 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22187 You will need to set the connection up so that the client doesn't ask for
22188 any password from you.
22189 To keep things easy we will use only keys without any additional password
22191 \begin_inset Separator parbreak
22198 \begin_layout Enumerate
22200 \begin_inset Flex Code
22203 \begin_layout Plain Layout
22210 Save your private .ppk key file and put the public one on the server side.
22211 If the SVN server runs on Linux, note that the format of the public key
22212 is not compatible with Linux openssh and you will need to direcly copy-paste
22215 Public key for pasting into OpenSSH authorized_keys file
22217 :” edit field into the server's
22218 \begin_inset Flex Code
22221 \begin_layout Plain Layout
22222 ~/.ssh/authorized_keys
22228 \begin_inset Flex Code
22231 \begin_layout Plain Layout
22240 \begin_layout Enumerate
22242 \begin_inset Flex Code
22245 \begin_layout Plain Layout
22252 In the SVN config file
22256 \begin_layout Plain Layout
22257 Exact path depends on Windows version, usually somewhere around
22258 \begin_inset Flex Code
22261 \begin_layout Plain Layout
22264 Documents and Settings
22278 \begin_inset Flex Code
22281 \begin_layout Plain Layout
22296 , section [tunnels], setup ssh command, e.g.
22298 \begin_inset Flex Code
22301 \begin_layout Plain Layout
22302 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22311 \begin_layout Plain Layout
22312 It will usually take a lot of time to get exact command right and it depends
22314 For example do not have some remote server saved as a default session in
22316 If things fail, try to connect via plink without SVN first.
22325 \begin_layout Enumerate
22326 Checkout the SVN archive, e.
22327 \begin_inset space \thinspace{}
22331 \begin_inset Newline newline
22335 \begin_inset Flex Code
22338 \begin_layout Plain Layout
22339 svn co svn+ssh://user@server/repository_path
22347 \begin_layout Subsubsection
22348 End-of-Line Conversions
22351 \begin_layout Standard
22352 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22354 use different line endings inside the .lyx files.
22355 This is not a problem as far as \SpecialChar LyX
22356 functionality is concerned, but the commit
22357 diffs will be huge and merge-conflicts prone.
22358 Fortunately SVN itself knows
22362 \begin_layout Plain Layout
22363 \begin_inset Flex URL
22366 \begin_layout Plain Layout
22368 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22378 how to deal with CR/LF problems when switching .lyx files to the
22379 \begin_inset Flex Code
22382 \begin_layout Plain Layout
22392 \begin_layout Plain Layout
22394 \begin_inset Flex Code
22397 \begin_layout Plain Layout
22398 svn propset svn:eol-style native FILE_NAME
22411 \begin_layout Subsection
22412 GIT commands in \SpecialChar LyX
22416 \begin_layout Standard
22417 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22419 You can find the commands in the
22421 File\SpecialChar menuseparator
22423 \begin_inset space ~
22429 Please note that if you use password protected access to repository via
22430 ssh, you will be asked in terminal window.
22432 was tested against GIT 1.7.
22436 \begin_layout Plain Layout
22437 Windows users please note that you need to ensure that git is on the path.
22438 This can be set from within \SpecialChar LyX
22441 Tools\SpecialChar menuseparator
22442 Preferences\SpecialChar menuseparator
22443 Paths\SpecialChar menuseparator
22454 \begin_layout Standard
22455 One big difference of GIT and the other supported version control systems
22456 is the distributed nature of GIT: With traditional version control systems
22457 there is one central server which hosts the repository.
22458 Users commit their changes to the server, and get updates made by other
22460 With GIT, users commit to a local repository.
22461 The local repository can be synchronized with one or more remote repositories
22463 \begin_inset Flex Code
22466 \begin_layout Plain Layout
22473 \begin_inset Flex Code
22476 \begin_layout Plain Layout
22484 does not interact in any way with remote GIT repositories.
22485 It works exclusively with the local repository in a very similar way as
22486 with a central CVS or SVN repository.
22487 If you use remote GIT repositories you need to do the
22488 \begin_inset Flex Code
22491 \begin_layout Plain Layout
22498 \begin_inset Flex Code
22501 \begin_layout Plain Layout
22507 operations with your favourite GIT client.
22510 \begin_layout Subsubsection
22516 \begin_layout Standard
22517 If your document is not under revision control, this is the only item shown
22519 And if it is under revision control, the
22526 item is not visible.
22529 \begin_layout Standard
22530 This command registers in GIT your document ONLY in case you have already
22531 the documents directory under GIT control (in particular
22536 This means you have to checkout the archive by yourself.
22539 \begin_layout Standard
22540 Then you are asked interactively to supply an initial description of the
22542 Don't forget that registered file is not yet commited.
22545 \begin_layout Standard
22546 GIT command that is run:
22549 \begin_inset Quotes eld
22553 \begin_inset Quotes erd
22559 \begin_layout Standard
22564 to understand the switches.
22567 \begin_layout Subsubsection
22573 \begin_layout Standard
22574 When you are finished editing a file, you commit your changes.
22575 When you do this, you are asked for a description of the changes.
22576 After that changes are commited.
22579 \begin_layout Standard
22582 git commit -q -m"<description>" <file-name>
22585 \begin_layout Subsubsection
22588 Revert To Repository Version
22591 \begin_layout Standard
22592 This will discard all changes made to the document since the last check
22594 You get a warning before changes are discarded.
22597 \begin_layout Standard
22601 \begin_inset Quotes eld
22605 \begin_inset Quotes erd
22611 \begin_layout Subsubsection
22617 \begin_layout Standard
22618 This will rename the current document including the version history.
22619 It requires a clean document without any changes since the last checkin.
22620 You are asked for a file name and a description of the rename operation.
22621 After that the document is renamed, both locally and in the repository.
22622 If the parent directories of the new and old file names differ, all relative
22623 paths of included files are adjusted (like in
22625 File\SpecialChar menuseparator
22630 Finally, the document is reloaded using the new name.
22633 \begin_layout Labeling
22634 \labelwidthstring 00.00.0000
22636 \begin_inset space ~
22640 \begin_inset space ~
22644 \begin_inset Newline newline
22648 \begin_inset Flex Code
22651 \begin_layout Plain Layout
22655 \begin_inset Quotes eld
22659 \begin_inset Quotes erd
22663 \begin_inset Quotes eld
22667 \begin_inset Quotes erd
22676 \begin_inset Newline newline
22680 \begin_inset Flex Code
22683 \begin_layout Plain Layout
22692 \begin_layout Subsubsection
22698 \begin_layout Standard
22699 This shows the complete history of the GIT document.
22703 \begin_inset Quotes eld
22707 \begin_inset Quotes erd
22712 is shown in a browser.
22715 \begin_layout Subsubsection
22719 \begin_layout Standard
22721 supports GIT hash number of the last commit to the file, author name, date
22722 and time of last commit.
22723 All those are extracted from
22725 git log -n 1 --pretty=format:%H%n%an%n%ai
22728 Tree version information is obtained via
22730 git describe --abbrev --dirty --long
22734 \begin_inset CommandInset ref
22736 reference "subsec:VCS-Revision-Information"
22743 \begin_layout Subsection
22747 \begin_layout Standard
22748 With the recent addition of the vc-command function \SpecialChar LyX
22749 power users are allowed
22750 to create their own commands for revision control.
22753 \begin_layout Standard
22754 As an example you can see how two TortoiseSVN commands could be integrated
22758 \begin_layout Description
22760 \begin_inset Flex Code
22763 \begin_layout Plain Layout
22764 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
22772 \begin_layout Description
22774 \begin_inset Flex Code
22777 \begin_layout Plain Layout
22778 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
22786 \begin_layout Subsection
22787 Version control and Document comparison
22790 \begin_layout Standard
22791 One of the typical uses of version control is to inspect the changes between
22792 revisions, usually by creating
22793 \begin_inset Flex Code
22796 \begin_layout Plain Layout
22803 While this is useful for plain text files, it is much less useful in the
22804 case of \SpecialChar LyX
22805 files, which have more a complicated structure.
22806 Hence we provide binding to the Document comparison feature.
22807 There are two ways of calling this feature - either by direct call of
22808 \begin_inset Flex Code
22811 \begin_layout Plain Layout
22818 function (for details see \SpecialChar LyX
22819 functions manual) or by icon/menu item
22820 \begin_inset Flex Noun
22823 \begin_layout Plain Layout
22824 Compare with older revision...
22830 One can either compare two chosen revisions of the document or he can simply
22831 compare the current version of edited text with older revisions (where
22833 \begin_inset Flex Noun
22836 \begin_layout Plain Layout
22842 ' revisions back means comparison of the edited file with last commited
22847 \begin_layout Standard
22848 This feature is supported for SVN and RCS though due to the more complicated
22849 versioning scheme of RCS there is a constraint – when addressing the revisions
22850 in dialog, numbers always point to the last number in RCS revision number,
22853 We don't currently support GIT addressing of revisions, one can just compare
22854 edited document with its revision X steps backs, where X is addressed as
22858 \begin_layout Section
22859 Literate Programming
22862 \begin_layout Standard
22867 (kayvan@sylvan.com)
22871 original documentation written by
22873 Edmar Wienskoski Jr.
22876 (edmar-w-jr@technologist.com)
22879 \begin_layout Subsection
22883 \begin_layout Standard
22884 The main purpose of this documentation is to show you how to use \SpecialChar LyX
22886 programming, where it is assumed that you are familiar with this programming
22887 technique, and know what
22888 \begin_inset Quotes eld
22892 \begin_inset Quotes erd
22896 \begin_inset Quotes eld
22900 \begin_inset Quotes erd
22904 If that is not the case, please follow the web links provided in the following
22906 There is a lot of good documentation out there covering old development
22907 history to the latest tools tips.
22910 \begin_layout Standard
22911 It is also assumed that you are familiar with \SpecialChar LyX
22912 itself to a point that you
22913 are comfortable changing your \SpecialChar LyX
22914 preferences, and X resources file.
22915 If that is not the case please refer to other \SpecialChar LyX
22916 documentation to cover your
22920 \begin_layout Subsection
22921 Literate Programming
22924 \begin_layout Standard
22925 From the Literate Programming FAQ:
22928 \begin_layout Quotation
22929 Literate programming is the combination of documentation and source together
22930 in a fashion suited for reading by human beings.
22931 In fact, literate programs should be enjoyable reading, even inviting!
22932 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
22933 and documentation in a single file.
22934 Literate programming tools then parse the file to produce either readable
22935 documentation or compilable source.
22936 The WEB style of literate programming was created by D.
22937 \begin_inset space \thinspace{}
22941 Knuth during the development of his \SpecialChar TeX
22942 typesetting software.
22946 \begin_layout Standard
22947 Another excerpt says:
22950 \begin_layout Quotation
22953 How is literate programming different from verbose commenting?
22956 \begin_layout Quotation
22957 There are three distinguishing characteristics.
22958 In order of importance, they are:
22959 \begin_inset Separator parbreak
22966 \begin_layout Itemize
22967 flexible order of elaboration
22970 \begin_layout Itemize
22971 automatic support for browsing
22974 \begin_layout Itemize
22975 typeset documentation, especially diagrams and mathematics
22979 \begin_layout Standard
22980 Now that I sparked your curiosity, take a look in the references.
22983 \begin_layout Subsubsection
22987 \begin_layout Standard
22988 The complete Literate Programming FAQ can be found at:
22991 \begin_layout Quote
22992 Literate Programming FAQ
22993 \begin_inset Flex URL
22996 \begin_layout Plain Layout
22998 http://www.literateprogramming.com/lpfaq.pdf
23006 \begin_layout Standard
23007 The FAQ lists 23 (twenty three!) different literate programming tools.
23008 Where some are specialized or
23009 \begin_inset Quotes eld
23013 \begin_inset Quotes erd
23016 for particular programming languages, while other have general scope.
23021 for my own use for several reasons:
23024 \begin_layout Itemize
23025 It can generate the documentation either in \SpecialChar LaTeX
23029 \begin_layout Itemize
23030 It has a open architecture, i.
23031 \begin_inset space \thinspace{}
23035 \begin_inset space \space{}
23038 it is easy to plug in new filters and to perform special processing that
23043 \begin_layout Itemize
23044 There is a good selection of filters available already (the HTML is one
23048 \begin_layout Itemize
23052 \begin_layout Standard
23053 The Noweb web page can be found at:
23056 \begin_layout Quote
23058 \begin_inset Flex URL
23061 \begin_layout Plain Layout
23063 http://www.cs.virginia.edu/~nr/noweb/
23071 \begin_layout Standard
23072 Starting from there you can reach many other interesting links and even
23073 some literate program examples.
23076 \begin_layout Subsection
23078 and Literate Programming with Noweb
23081 \begin_layout Standard
23082 The \SpecialChar LyX
23083 support for Literate Programming is provided by using the generic \SpecialChar LyX
23085 converters mechanism.
23086 This support is provided in a
23087 \begin_inset Quotes eld
23091 \begin_inset Quotes erd
23095 \begin_inset space \thinspace{}
23099 \begin_inset space \space{}
23102 you will be able to use this new \SpecialChar LyX
23103 feature with some other literate programming
23104 tool of your choice by just changing your \SpecialChar LyX
23108 \begin_layout Subsubsection
23109 Generating documents and code (weaving and tangling)
23112 \begin_layout Paragraph
23113 Using the noweb module
23116 \begin_layout Standard
23117 If you have installed Noweb and \SpecialChar LyX
23118 successfully, whenever you open a new document,
23119 after you have chosen its document class, use the Document->Settings menu
23121 \begin_inset Quotes eld
23125 \begin_inset Quotes erd
23129 If Noweb is correctly installed, when you click on the
23130 \begin_inset Quotes eld
23134 \begin_inset Quotes erd
23137 link, you will see the
23138 \begin_inset Quotes eld
23142 \begin_inset Quotes erd
23145 module in the available list and you can add it to your document.
23148 \begin_layout Paragraph
23152 \begin_layout Standard
23154 enables you to write code with a layout named
23155 \begin_inset Flex Noun
23158 \begin_layout Plain Layout
23165 Noweb delimits chunks like this:
23168 \begin_layout LyX-Code
23172 \begin_layout LyX-Code
23176 \begin_layout LyX-Code
23180 \begin_layout LyX-Code
23184 \begin_layout LyX-Code
23188 \begin_layout Standard
23189 The problem is that whatever is written in between the << and the
23193 must be taken literally, i.
23194 \begin_inset space \thinspace{}
23198 \begin_inset space \space{}
23202 should be prevented from making any special interpretation of what has
23204 This is also handled by
23205 \begin_inset Flex Noun
23208 \begin_layout Plain Layout
23214 , that works like a normal paragraph but has a free spacing capability.
23217 \begin_layout Standard
23218 As a special note, you can also use the
23219 \begin_inset Quotes eld
23223 \begin_inset Quotes erd
23226 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23230 \begin_layout LyX-Code
23234 \begin_layout LyX-Code
23235 def some_function(args):
23238 \begin_layout LyX-Code
23239 "This is the doc string for this function."
23242 \begin_layout LyX-Code
23243 print "My args: ", args
23246 \begin_layout LyX-Code
23247 @ %def some_function
23250 \begin_layout Standard
23251 For an example of this usage and the resulting cross-reference output, look
23252 at the Literate python program in
23254 LIBDIR/examples/listerrors.lyx
23256 which should make this all clear.
23259 \begin_layout Paragraph
23260 Generating the documentation
23263 \begin_layout Standard
23264 At this point you already have a new document file with a proper document
23265 class, and with some code and text on it.
23266 How do I print it? The answer is simple, you select
23268 View\SpecialChar menuseparator
23272 Just like you would do for a plain document.
23273 No special procedure is required.
23276 \begin_layout Standard
23277 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23281 \begin_layout Enumerate
23284 Update\SpecialChar menuseparator
23287 menu option is chosen, a \SpecialChar LaTeX
23290 \begin_inset Separator parbreak
23297 \begin_layout Standard
23298 If the document is of any literate class the generated file will be named
23299 with an extension name defined by the
23300 \begin_inset Quotes eld
23304 \begin_inset Quotes erd
23307 format (defined in the Preferences panel), otherwise the file will have
23316 \begin_layout Enumerate
23317 Note that the only difference so far is in the name of the file, no special
23318 processing is required by \SpecialChar LyX
23320 Given that you formatted the code using the
23321 \begin_inset Flex Noun
23324 \begin_layout Plain Layout
23330 layout that, by itself, takes care of the business.
23333 \begin_layout Enumerate
23334 If the document is of any literate class \SpecialChar LyX
23335 will then use the internal \SpecialChar LyX
23337 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23342 \begin_layout Plain Layout
23343 The converters are defined in the
23345 Tools\SpecialChar menuseparator
23349 \begin_inset Quotes eld
23353 \begin_inset Quotes erd
23365 manual for general information about converters.
23370 to generate the \SpecialChar LaTeX
23372 \begin_inset Separator parbreak
23379 \begin_layout Standard
23380 Otherwise it will just skip this step.
23384 \begin_layout Enumerate
23385 Finally, \SpecialChar LaTeX
23386 is invoked and the regular post processing continues as in a plain
23390 \begin_layout Standard
23391 Independence from a particular
23392 \begin_inset Quotes eld
23396 \begin_inset Quotes erd
23399 is easily achieved by changing the commands that are run by the various
23403 \begin_layout Paragraph
23404 Generating the code
23407 \begin_layout Standard
23408 When the build menu option is chosen or the corresponding button in the
23409 toolbar is pressed, a \SpecialChar LaTeX
23410 file is generated just like step 1 above.
23411 Next, \SpecialChar LyX
23417 This converter needs to be defined by the user and is not installed by
23418 default, though the Program format is.
23419 This converter (like any other converter) will have two parts:
23422 \begin_layout Enumerate
23423 The converter program itself.
23424 This program performs the conversion from the one format to the other (in
23425 this case, from the Noweb format to the Program pseudo-format).
23428 \begin_layout Enumerate
23429 The error log parser.
23430 This is a program whose sole purpose is to rewrite error messages in a
23431 format that \SpecialChar LyX
23433 This makes it possible for \SpecialChar LyX
23434 to place error boxes in the right places in
23438 \begin_layout Standard
23439 The first part, the
23440 \begin_inset Quotes eld
23444 \begin_inset Quotes erd
23447 setting, should be set to
23448 \begin_inset Newline newline
23452 \begin_inset Quotes eld
23460 \begin_inset Quotes erd
23464 \begin_inset Newline newline
23467 This basically means that \SpecialChar LyX
23469 \begin_inset Quotes eld
23473 \begin_inset Quotes erd
23476 (a program or script) with the name of the Noweb file (normally a file
23477 in the \SpecialChar LyX
23478 temp directory) and the directory path of the original \SpecialChar LyX
23483 \begin_layout Standard
23484 This is an implementation of
23485 \begin_inset Quotes eld
23489 \begin_inset Quotes erd
23492 that you can place in a directory on your path:
23495 \begin_layout Standard
23496 \begin_inset VSpace defskip
23502 \begin_layout Standard
23503 \begin_inset Newpage pagebreak
23509 \begin_layout Standard
23515 \begin_layout Standard
23521 \begin_layout Standard
23524 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23527 \begin_layout Standard
23528 \begin_inset VSpace defskip
23534 \begin_layout Standard
23535 The next part of the converter setting is the
23536 \begin_inset Quotes eld
23540 \begin_inset Quotes erd
23543 which is to be set to
23544 \begin_inset Newline newline
23548 \begin_inset Quotes eld
23553 parselog=$$s/scripts/listerrors
23556 \begin_inset Quotes erd
23560 \begin_inset Newline newline
23563 This will run any errors that are generated by the
23564 \begin_inset Quotes eld
23568 \begin_inset Quotes erd
23571 process through the
23572 \begin_inset Quotes eld
23576 \begin_inset Quotes erd
23582 \begin_layout Standard
23583 The build will normally take place in \SpecialChar LyX
23584 's temporary directory, so the files
23585 produced by the conversion will be in that directory.
23587 will copy out what it regards as the `main' file, but the
23591 conversion may produce several files, and so most of these would then be
23592 deleted when \SpecialChar LyX
23594 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23595 the build-script chunk can place the generated files in that location.
23598 \begin_layout Paragraph
23599 Build instructions in the document
23602 \begin_layout Standard
23603 The last piece of the integration between \SpecialChar LyX
23605 \begin_inset Quotes eld
23609 \begin_inset Quotes erd
23613 Generally, the instructions for building your program should be embedded
23614 in a chunk of its own.
23616 \begin_inset Quotes eld
23620 \begin_inset Quotes erd
23623 above uses the notangle command to look for this chunk (called
23624 \begin_inset Quotes eld
23628 \begin_inset Quotes erd
23631 ) and runs its contents through
23632 \begin_inset Quotes eld
23636 \begin_inset Quotes erd
23642 \begin_layout Standard
23643 Typically, such a chunk would look something like this:
23646 \begin_layout LyX-Code
23650 \begin_layout LyX-Code
23652 \begin_inset Newline newline
23655 if [ -z "${NOWEB_SOURCE}" ]
23656 \begin_inset Newline newline
23662 \begin_layout LyX-Code
23663 NOWEB_SOURCE=myfile.nw
23664 \begin_inset Newline newline
23668 \begin_inset Newline newline
23672 code to extract files ...
23673 use NOWEB_OUTPUT_DIR here ...]
23674 \begin_inset Newline newline
23678 code to compile files ...]
23679 \begin_inset Newline newline
23685 \begin_layout Standard
23688 LIBDIR/examples/listerrors.lyx
23692 LIBDIR/examples/Literate.lyx
23694 which implement two versions of the
23695 \begin_inset Quotes eld
23699 \begin_inset Quotes erd
23702 program for some illustrations of how all of these pieces go together or
23705 LIBDIR/examples/noweb2lyx.lyx.
23708 Interestingly, these three files show off the language-indepence of the
23710 literate programming support since they are written in Python, C and Perl
23714 \begin_layout Subsubsection
23715 Configuring \SpecialChar LyX
23719 \begin_layout Standard
23720 All the Literate Programming support is configured by the
23722 Tools\SpecialChar menuseparator
23726 \begin_inset Quotes eld
23730 \begin_inset Quotes erd
23734 The important parts are:
23737 \begin_layout Description
23739 \begin_inset space ~
23743 \begin_inset Quotes eld
23747 \begin_inset Quotes erd
23751 \begin_inset space ~
23754 format Set up via the File Formats tab, this is where the Noweb-specific
23764 , the file extension is set to
23769 This tells \SpecialChar LyX
23770 to create a file with a
23774 extension in the first step of the conversion process.
23777 \begin_layout Description
23779 \begin_inset space ~
23787 \begin_inset space ~
23790 format This is an empty format whose sole purpose is to be the endpoint
23791 of a conversion (which then allows us to set up a converter for it).
23794 \begin_layout Description
23804 This converter performs the
23805 \begin_inset Quotes eld
23809 \begin_inset Quotes erd
23812 of the literate document.
23813 For Noweb, it is set to
23814 \begin_inset Quotes eld
23819 noweave -delay -index $$i > $$o
23822 \begin_inset Quotes erd
23828 \begin_layout Description
23838 \begin_inset Quotes eld
23842 \begin_inset Quotes erd
23846 As stated above, the Converter is set to
23847 \begin_inset Quotes eld
23855 \begin_inset Quotes erd
23858 , with Flags set to
23859 \begin_inset Newline newline
23863 \begin_inset Quotes eld
23868 parselog=$$s/scripts/listerrors
23871 \begin_inset Quotes erd
23877 \begin_layout Subsubsection
23881 \begin_layout Standard
23882 There is also a new function implemented in the \SpecialChar LyX
23884 \begin_inset Quotes eld
23887 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
23891 \begin_layout Standard
23892 When debugging code with ddd/gdb, it is possible to invoke a text editor
23893 at the current execution position with a single key stroke.
23894 The default ddd configuration for that is shift-ctrl-V.
23895 It happens that you can define the editor command line invocation in ddd
23898 Edit\SpecialChar menuseparator
23899 Preferences\SpecialChar menuseparator
23902 dialog and changing the "Edit Sources" entry.
23905 \begin_layout Standard
23906 I take advantage of the newly created \SpecialChar LyX
23907 server function and this ddd feature,
23909 \begin_inset Quotes eld
23913 \begin_inset Quotes erd
23919 \begin_layout Standard
23920 \begin_inset VSpace defskip
23926 \begin_layout Standard
23929 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
23932 \begin_layout Standard
23933 \begin_inset VSpace defskip
23939 \begin_layout Standard
23940 With this, whenever you are using ddd and find a point in the program that
23941 you want to edit, you just press shift-ctrl-V (in the ddd window), and
23942 ddd will forward this information to \SpecialChar LyX
23943 through the \SpecialChar LyX
23944 server and then the
23946 window will show the same file with the cursor at the same position ddd
23948 No more guessing or long scrolling to locate a point in the program back
23952 \begin_layout Standard
23953 Note however that you must enable the \SpecialChar LyX
23954 server to get this feature working
23955 (it is disabled by default).
23956 You can enable it in
23968 ) by entering in the
23974 \begin_inset Quotes eld
23979 /home/<your-home-directory>/.lyx/lyxpipe
23982 \begin_inset Quotes erd
23988 \begin_layout Standard
23989 Read the \SpecialChar LyX
23990 server documentation in the
23992 Customization Manual
23994 for further information.
23997 \begin_layout Subsubsection
24001 \begin_layout Standard
24002 There are six new buttons that can be added to your \SpecialChar LyX
24004 Five of these buttons are short cuts to layout styles:
24027 The last one is a short cut to the
24028 \begin_inset Quotes eld
24032 \begin_inset Quotes erd
24039 \begin_layout Standard
24041 has a range of buttons that are available for tool bar customization.
24042 In my toolbar I like to combine the six short cuts above with two more:
24047 \SpecialChar menuseparator
24052 \SpecialChar menuseparator
24059 Document\SpecialChar menuseparator
24060 View\SpecialChar menuseparator
24064 Here is how it looks like:
24067 \begin_layout LyX-Code
24071 \begin_layout LyX-Code
24075 \begin_layout LyX-Code
24076 Icon "layout Standard"
24079 \begin_layout LyX-Code
24080 Icon "layout Section"
24083 \begin_layout LyX-Code
24084 Icon "layout \SpecialChar LaTeX
24088 \begin_layout LyX-Code
24089 Icon "layout \SpecialChar LyX
24093 \begin_layout LyX-Code
24094 Icon "layout Chunk"
24097 \begin_layout LyX-Code
24101 \begin_layout LyX-Code
24105 \begin_layout LyX-Code
24106 Icon "buffer-typeset"
24109 \begin_layout LyX-Code
24110 Icon "build-program"
24113 \begin_layout LyX-Code
24117 \begin_layout LyX-Code
24121 \begin_layout LyX-Code
24125 \begin_layout LyX-Code
24129 \begin_layout LyX-Code
24133 \begin_layout Subsubsection
24134 Colors customization
24137 \begin_layout Standard
24138 There are a number of colors in \SpecialChar LyX
24139 that can be customized in
24144 One of the things that bothers people is the \SpecialChar LaTeX
24146 The default color is red, since the chunks uses \SpecialChar LaTeX
24147 font, and there is a lot
24148 of chunks in literate documents, you may get tired of seeing everything
24150 You can change it by going to the tabs
24159 \begin_layout Standard
24160 The next thing is the visible presence of the newline character in the screen.
24161 You can choose the color of this particular character and make it blend
24163 I recommend you choosing a color that is close to the background but not
24164 equal, that way you still can see it is there, but it is not bothering
24168 \begin_layout Subsection
24173 \begin_layout Standard
24182 is documented in the
24186 example file and in the Sweave manual (menu
24188 Help\SpecialChar menuseparator
24194 \begin_layout Chapter
24198 \begin_layout Standard
24199 You can do everything with \SpecialChar LyX
24200 that you can do with \SpecialChar LaTeX
24202 However, \SpecialChar LyX
24203 cannot support every \SpecialChar LaTeX
24205 But you can always use \SpecialChar TeX
24207 This chapter shows you some more special things you might want to use.
24208 For other special things you can do with figures, tables, floats, boxes
24209 and notes, have a look at the
24212 \begin_inset space ~
24220 \begin_layout Section
24221 Multiple Text Columns
24224 \begin_layout Standard
24225 This feature is independent of the option
24227 Two-column document
24229 in the document settings under
24234 If you want to have 2
24235 \begin_inset space ~
24238 columns for the whole document, it is recommended to use the
24240 Two-column document
24243 For all other cases use this feature.
24246 \begin_layout Standard
24247 To use multiple text columns in your document, you have to load the module
24254 Document\SpecialChar menuseparator
24255 Settings\SpecialChar menuseparator
24258 ) and must have the \SpecialChar LaTeX
24266 \begin_layout Standard
24267 Footnotes within multiple columns will be placed at the bottom of the page
24268 and not under each column.
24269 Within the different columns you can use everything, with the limitation
24270 that for floats you need to use the float option
24277 \begin_layout Subsection
24281 \begin_layout Standard
24282 If you want to have 2
24283 \begin_inset space ~
24286 columns in your text, insert a multicolumn inset via the menu
24288 Insert\SpecialChar menuseparator
24290 \begin_inset space ~
24293 Insets\SpecialChar menuseparator
24295 \begin_inset space ~
24300 where the columns should start.
24301 Write all text that should be printed in 2
24302 \begin_inset space ~
24305 columns into this inset.
24308 \begin_layout Standard
24309 Here is an example:
24312 \begin_layout Standard
24314 \begin_inset Flex Multiple Columns
24317 \begin_layout Plain Layout
24322 The Adventure of the Empty House
24325 \begin_inset Newline newline
24328 by Sir Arthur Conan Doyle
24331 \begin_layout Plain Layout
24334 It was in the spring of the year 1894 that all London was interested, and
24335 the fashionable world dismayed, by the murder of the Honourable Ronald
24336 Adair under most unusual and inexplicable circumstances.
24337 The public has already learned those particulars of the crime which came
24338 out in the police investigation, but a good deal was suppressed upon that
24339 occasion, since the case for the prosecution was so overwhelmingly strong
24340 that it was not necessary to bring forward all the facts.
24341 Only now, at the end of nearly ten years, am I allowed to supply those
24342 missing links which make up the whole of that remarkable chain.
24343 The crime was of interest in itself, but that interest was as nothing to
24344 me compared to the inconceivable sequel, which afforded me the greatest
24345 shock and surprise of any event in my adventurous life.
24346 Even now, after this long interval, I find myself thrilling as I think
24347 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24348 ty which utterly submerged my mind.
24349 Let me say to that public, which has shown some interest in those glimpses
24350 which I have occasionally given them of the thoughts and actions of a very
24351 remarkable man, that they are not to blame me if I have not shared my knowledge
24352 with them, for I should have considered it my first duty to do so, had
24353 I not been barred by a positive prohibition from his own lips, which was
24354 only withdrawn upon the third of last month.
24362 \begin_layout Standard
24363 To get 3 or more columns, set the cursor into the multicolumn inset and
24366 Insert\SpecialChar menuseparator
24368 \begin_inset space ~
24372 \begin_inset space ~
24378 The number of the desired columns is written into that inset (for 3
24379 \begin_inset space ~
24383 \begin_inset Quotes eld
24387 \begin_inset Quotes erd
24391 \begin_inset Newline newline
24394 Here is an example with 3
24395 \begin_inset space ~
24401 \begin_layout Standard
24402 \begin_inset Flex Multiple Columns
24405 \begin_layout Plain Layout
24408 \begin_inset Argument 1
24411 \begin_layout Plain Layout
24417 It can be imagined that my close intimacy with Sherlock Holmes had interested
24418 me deeply in crime, and that after his disappearance I never failed to
24419 read with care the various problems which came before the public.
24420 And I even attempted, more than once, for my own private satisfaction,
24421 to employ his methods in their solution, though with indifferent success.
24422 There was none, however, which appealed to me like this tragedy of Ronald
24424 As I read the evidence at the inquest, which led up to a verdict of willful
24425 murder against some person or persons unknown, I realized more clearly
24426 than I had ever done the loss which the community had sustained by the
24427 death of Sherlock Holmes.
24428 There were points about this strange business which would, I was sure,
24429 have specially appealed to him, and the efforts of the police would have
24430 been supplemented, or more probably anticipated, by the trained observation
24431 and the alert mind of the first criminal agent in Europe.
24432 All day, as I drove upon my round, I turned over the case in my mind and
24433 found no explanation which appeared to me to be adequate.
24434 At the risk of telling a twice-told tale, I will recapitulate the facts
24435 as they were known to the public at the conclusion of the inquest.
24443 \begin_layout Standard
24444 You can have up to 10
24445 \begin_inset space ~
24448 columns if you want to, but that might not be very pleasant for the readers
24452 \begin_layout Standard
24453 \begin_inset Newpage newpage
24459 \begin_layout Subsection
24460 Columns inside Columns
24463 \begin_layout Standard
24464 You can also have columns inside columns:
24467 \begin_layout Standard
24468 \begin_inset Flex Multiple Columns
24471 \begin_layout Plain Layout
24474 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24475 at that time governor of one of the Australian colonies.
24476 Adair's mother had returned from Australia to undergo the operation for
24477 cataract, and she, her son Ronald, and her daughter Hilda were living together
24481 \begin_layout Plain Layout
24482 \begin_inset Flex Multiple Columns
24485 \begin_layout Plain Layout
24488 The youth moved in the best society–had, so far as was known, no enemies
24489 and no particular vices.
24490 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24491 had been broken off by mutual consent some months before, and there was
24492 no sign that it had left any very profound feeling behind it.
24493 For the rest {sic} the man's life moved in a narrow and conventional circle,
24494 for his habits were quiet and his nature unemotional.
24495 Yet it was upon this easy-going young aristocrat that death came, in most
24496 strange and unexpected form, between the hours of ten and eleven-twenty
24497 on the night of March 30, 1894.
24505 \begin_layout Plain Layout
24508 Ronald Adair was fond of cards–playing continually, but never for such stakes
24510 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24511 It was shown that, after dinner on the day of his death, he had played
24512 a rubber of whist at the latter club.
24513 He had also played there in the afternoon.
24518 The evidence of those who had played with him– Mr.
24519 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24520 and that there was a fairly equal fall of the cards.
24521 Adair might have lost five pounds, but not more.
24522 His fortune was a considerable one, and such a loss could not in any way
24524 He had played nearly every day at one club or other, but he was a cautious
24525 player, and usually rose a winner.
24526 It came out in evidence that, in partnership with Colonel Moran, he had
24527 actually won as much as four hundred and twenty pounds in a sitting, some
24528 weeks before, from Godfrey Milner and Lord Balmoral.
24529 So much for his recent history as it came out at the inquest.
24537 \begin_layout Subsection
24541 \begin_layout Standard
24542 The examples in this section show some more special features of multiple
24546 \begin_layout Standard
24547 For more features of multiple columns, have a look at the documentation
24548 of the \SpecialChar LaTeX
24554 \begin_inset CommandInset citation
24563 \begin_layout Subsubsection
24567 \begin_layout Standard
24568 To add a preface text for multiple columns, set the cursor into the multicolumn
24569 inset and use the menu
24571 Insert\SpecialChar menuseparator
24575 Write your preface text into that inset.
24576 \begin_inset Newline newline
24579 This is an example with some preface text:
24582 \begin_layout Standard
24583 \begin_inset VSpace bigskip
24589 \begin_layout Standard
24590 \begin_inset Flex Multiple Columns
24593 \begin_layout Plain Layout
24594 \begin_inset Argument 2
24597 \begin_layout Plain Layout
24598 And the story continues and continues and continues and continues\SpecialChar ldots
24606 On the evening of the crime, he returned from the club exactly at ten.
24607 His mother and sister were out spending the evening with a relation.
24608 The servant deposed that she heard him enter the front room on the second
24609 floor, generally used as his sitting-room.
24610 She had lit a fire there, and as it smoked she had opened the window.
24611 No sound was heard from the room until eleven-twenty, the hour of the return
24612 of Lady Maynooth and her daughter.
24613 Desiring to say good-night, she attempted to enter her son's room.
24614 The door was locked on the inside, and no answer could be got to their
24615 cries and knocking.
24616 Help was obtained, and the door forced.
24617 The unfortunate young man was found lying near the table.
24618 His head had been horribly mutilated by an expanding revolver bullet, but
24619 no weapon of any sort was to be found in the room.
24627 \begin_layout Standard
24628 You can also use a section heading as the preface if you use a section command
24629 as \SpecialChar TeX
24631 For example the command
24634 \begin_layout Standard
24639 subsection{subsection title}
24642 \begin_layout Standard
24643 creates a subsection.
24644 In this example the preface is a subsubsection:
24647 \begin_layout Standard
24648 \begin_inset Flex Multiple Columns
24651 \begin_layout Plain Layout
24652 \begin_inset Argument 2
24655 \begin_layout Plain Layout
24659 \begin_layout Plain Layout
24668 This is a subsubsection heading as a preface
24672 \begin_layout Plain Layout
24686 A minute examination of the circumstances served only to make the case more
24688 In the first place, no reason could be given why the young man should have
24689 fastened the door upon the inside.
24690 There was the possibility that the murderer had done this, and had afterwards
24691 escaped by the window.
24692 The drop was at least twenty feet, however, and a bed of crocuses in full
24694 Neither the flowers nor the earth showed any sign of having been disturbed,
24695 nor were there any marks upon the narrow strip of grass which separated
24696 the house from the road.
24697 Apparently, therefore, it was the young man himself who had fastened the
24699 But how did he come by his death? No one could have climbed up to the window
24700 without leaving traces.
24701 Suppose a man had fired through the window, he would indeed be a remarkable
24702 shot who could with a revolver inflict so deadly a wound.
24703 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24704 a hundred yards of the house.
24705 No one had heard a shot.
24713 \begin_layout Standard
24714 If there is less vertical space than 6
24715 \begin_inset space ~
24718 text lines is left on the page at the beginning of the multiple columns,
24719 a page break will be inserted before the multiple columns.
24720 Depending on the number of lines of the preface text, you might want to
24722 This is done by setting the cursor into the mulitcolumn inset behind the
24723 preface (if there is any) and using the menu
24725 Insert\SpecialChar menuseparator
24727 \begin_inset space ~
24731 \begin_inset space ~
24735 \begin_inset space ~
24741 Insert into that inset the amount of space like e.
24742 \begin_inset space \thinspace{}
24746 \begin_inset space \space{}
24750 \begin_inset Quotes eld
24754 \begin_inset Quotes erd
24758 \begin_inset Newline newline
24761 In this example the space is set to 7
24762 \begin_inset space ~
24765 text lines by using
24766 \begin_inset Quotes eld
24772 \begin_inset Quotes erd
24781 needs to be inserted as \SpecialChar TeX
24785 \begin_layout Standard
24786 \begin_inset Flex Multiple Columns
24789 \begin_layout Plain Layout
24790 \begin_inset Argument 3
24793 \begin_layout Plain Layout
24798 \begin_layout Plain Layout
24814 On the evening of the crime, he returned from the club exactly at ten.
24815 His mother and sister were out spending the evening with a relation.
24816 The servant deposed that she heard him enter the front room on the second
24817 floor, generally used as his sitting-room.
24818 She had lit a fire there, and as it smoked she had opened the window.
24819 No sound was heard from the room until eleven-twenty, the hour of the return
24820 of Lady Maynooth and her daughter.
24821 Desiring to say good-night, she attempted to enter her son's room.
24822 The door was locked on the inside, and no answer could be got to their
24823 cries and knocking.
24824 Help was obtained, and the door forced.
24825 The unfortunate young man was found lying near the table.
24826 His head had been horribly mutilated by an expanding revolver bullet, but
24827 no weapon of any sort was to be found in the room.
24835 \begin_layout Subsubsection
24839 \begin_layout Standard
24840 The amount of space before and after multiple columns can be changed by
24841 changing the length
24848 For example the command
24851 \begin_layout Standard
24861 \begin_layout Standard
24862 in \SpecialChar TeX
24863 Code changes its value to 3
24864 \begin_inset space \thinspace{}
24868 The change must be made before the multiple columns' start.
24869 The predefined value is 13
24870 \begin_inset space \thinspace{}
24876 \begin_layout Standard
24884 \begin_inset space \thinspace{}
24890 \begin_layout Standard
24894 \begin_layout Plain Layout
24900 multicolsep}{2.5cm}
24908 \begin_layout Standard
24909 \begin_inset Flex Multiple Columns
24912 \begin_layout Plain Layout
24915 All day I turned these facts over in my mind, endeavouring to hit upon some
24916 theory which could reconcile them all, and to find that line of least resistanc
24917 e which my poor friend had declared to be the starting-point of every investigat
24919 I confess that I made little progress.
24920 In the evening I strolled across the Park, and found myself about six o'clock
24921 at the Oxford Street end of Park Lane.
24922 A group of loafers upon the pavements, all staring up at a particular window,
24923 directed me to the house which I had come to see.
24924 A tall, thin man with coloured glasses, whom I strongly suspected of being
24925 a plain-clothes detective, was pointing out some theory of his own, while
24926 the others crowded round to listen to what he said.
24927 I got as near him as I could, but his observations seemed to me to be absurd,
24928 so I withdrew again in some disgust.
24929 As I did so I struck against an elderly, deformed man, who had been behind
24930 me, and I knocked down several books which he was carrying.
24938 \begin_layout Standard
24939 \begin_inset Note Greyedout
24942 \begin_layout Plain Layout
24947 The values you set with
24953 will be used for all following multiple columns until you change them again.
24961 \begin_layout Standard
24965 \begin_layout Plain Layout
24977 \begin_inset Note Note
24980 \begin_layout Plain Layout
24981 go back to the default
24989 \begin_layout Standard
24990 \begin_inset Newpage newpage
24996 \begin_layout Subsubsection
25000 \begin_layout Standard
25001 A column break can be forced by inserting the command
25007 as \SpecialChar TeX
25008 Code to that position in the text where the column should be broken.
25009 Note that this leads in most cases to whitespace in the text.
25010 \begin_inset Newline newline
25013 Here is an example:
25016 \begin_layout Standard
25017 \begin_inset Flex Multiple Columns
25020 \begin_layout Plain Layout
25023 \begin_inset Quotes eld
25026 You're surprised to see me, sir,
25027 \begin_inset Quotes erd
25030 said he, in a strange, croaking voice.
25033 \begin_layout Plain Layout
25036 I acknowledged that I was.
25039 \begin_layout Plain Layout
25042 \begin_inset Quotes eld
25045 Well, I've a conscience, sir, and when I chanced to see you go into this
25046 house, as I came hobbling after you, I thought to myself, I'll just step
25047 in and see that kind gentleman, and tell him that if I was a bit gruff
25048 in my manner there was not any harm meant, and that I am much obliged to
25049 him for picking up my books.
25050 \begin_inset Quotes erd
25056 \begin_layout Plain Layout
25059 \begin_inset Quotes eld
25062 You make too much of a trifle,
25063 \begin_inset Quotes erd
25068 \begin_inset Quotes eld
25071 May I ask how you knew who I was?
25072 \begin_inset Quotes erd
25075 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25079 \begin_layout Plain Layout
25091 \begin_layout Plain Layout
25094 \begin_inset Quotes eld
25097 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25098 you'll find my little bookshop at the corner of Church Street, and very
25099 happy to see you, I am sure.
25100 Maybe you collect yourself, sir.
25104 \begin_inset space ~
25117 –a bargain, every one of them.
25118 With five volumes you could just fill that gap on that second shelf.
25119 It looks untidy, does it not, sir?
25120 \begin_inset Quotes erd
25131 \begin_layout Subsubsection
25135 \begin_layout Standard
25136 The width of the columns is automatically calculated, but you can modify
25137 the space between the columns.
25138 This is done by changing the length
25145 Its predefined value is 10
25146 \begin_inset space \thinspace{}
25150 Here is an example where
25157 \begin_inset space \thinspace{}
25163 \begin_layout Standard
25167 \begin_layout Plain Layout
25181 \begin_layout Standard
25182 \begin_inset Flex Multiple Columns
25185 \begin_layout Plain Layout
25188 My observations of No.
25189 \begin_inset space \space{}
25192 427 Park Lane did little to clear up the problem in which I was interested.
25193 The house was separated from the street by a low wall and railing, the
25194 whole not more than five feet high.
25195 It was perfectly easy, therefore, for anyone to get into the garden, but
25196 the window was entirely inaccessible, since there was no water pipe or
25197 anything which could help the most active man to climb it.
25198 More puzzled than ever, I retraced my steps to Kensington.
25199 I had not been in my study five minutes when the maid entered to say that
25200 a person desired to see me.
25201 To my astonishment it was none other than my strange old book collector,
25202 his sharp, wizened face peering out from a frame of white hair, and his
25203 precious volumes, a dozen of them at least, wedged under his right arm.
25211 \begin_layout Standard
25215 \begin_layout Plain Layout
25227 \begin_inset Note Note
25230 \begin_layout Plain Layout
25231 go back to the default
25239 \begin_layout Subsubsection
25243 \begin_layout Standard
25244 Between the columns a rule with a width of the length
25251 If this rule width is set to 0
25252 \begin_inset space \thinspace{}
25255 pt (this is the default), the rule is suppressed.
25256 In the following example the rule is 2
25257 \begin_inset space \thinspace{}
25263 \begin_layout Standard
25267 \begin_layout Plain Layout
25273 columnseprule}{2pt}
25281 \begin_layout Standard
25282 \begin_inset Flex Multiple Columns
25285 \begin_layout Plain Layout
25288 \begin_inset Quotes eld
25291 You're surprised to see me, sir,
25292 \begin_inset Quotes erd
25295 said he, in a strange, croaking voice.
25298 \begin_layout Plain Layout
25301 I acknowledged that I was.
25304 \begin_layout Plain Layout
25307 \begin_inset Quotes eld
25310 Well, I've a conscience, sir, and when I chanced to see you go into this
25311 house, as I came hobbling after you, I thought to myself, I'll just step
25312 in and see that kind gentleman, and tell him that if I was a bit gruff
25313 in my manner there was not any harm meant, and that I am much obliged to
25314 him for picking up my books.
25315 \begin_inset Quotes erd
25321 \begin_layout Plain Layout
25324 \begin_inset Quotes eld
25327 You make too much of a trifle,
25328 \begin_inset Quotes erd
25333 \begin_inset Quotes eld
25336 May I ask how you knew who I was?
25337 \begin_inset Quotes erd
25343 \begin_layout Plain Layout
25346 \begin_inset Quotes eld
25349 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25350 you'll find my little bookshop at the corner of Church Street, and very
25351 happy to see you, I am sure.
25352 Maybe you collect yourself, sir.
25356 \begin_inset space ~
25369 –a bargain, every one of them.
25370 With five volumes you could just fill that gap on that second shelf.
25371 It looks untidy, does it not, sir?
25372 \begin_inset Quotes erd
25383 \begin_layout Standard
25384 \begin_inset VSpace defskip
25390 \begin_layout Standard
25391 The rule can be colored by redefining the command
25398 This is done by inserting the command
25399 \begin_inset Newline newline
25408 columnseprulecolor}{
25413 \begin_inset Newline newline
25416 as \SpecialChar TeX
25417 Code before the multicolumn inset.
25422 in this command by a color of your choice.
25423 You can use all pre- and self-defined colors.
25431 \begin_inset space ~
25436 for more information about pre- and self-defined colors.
25437 To go back to the default color insert the command
25438 \begin_inset Newline newline
25447 columnseprulecolor}{
25452 \begin_inset Newline newline
25455 Here is the example with a cyan rule and 1
25456 \begin_inset space \thinspace{}
25459 cm column separation:
25462 \begin_layout Standard
25466 \begin_layout Plain Layout
25475 \begin_layout Plain Layout
25481 columnseprulecolor}{
25491 \begin_layout Standard
25492 \begin_inset Flex Multiple Columns
25495 \begin_layout Plain Layout
25498 \begin_inset Quotes eld
25501 You're surprised to see me, sir,
25502 \begin_inset Quotes erd
25505 said he, in a strange, croaking voice.
25508 \begin_layout Plain Layout
25511 I acknowledged that I was.
25514 \begin_layout Plain Layout
25517 \begin_inset Quotes eld
25520 Well, I've a conscience, sir, and when I chanced to see you go into this
25521 house, as I came hobbling after you, I thought to myself, I'll just step
25522 in and see that kind gentleman, and tell him that if I was a bit gruff
25523 in my manner there was not any harm meant, and that I am much obliged to
25524 him for picking up my books.
25525 \begin_inset Quotes erd
25531 \begin_layout Plain Layout
25534 \begin_inset Quotes eld
25537 You make too much of a trifle,
25538 \begin_inset Quotes erd
25543 \begin_inset Quotes eld
25546 May I ask how you knew who I was?
25547 \begin_inset Quotes erd
25553 \begin_layout Plain Layout
25556 \begin_inset Quotes eld
25559 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25560 you'll find my little bookshop at the corner of Church Street, and very
25561 happy to see you, I am sure.
25562 Maybe you collect yourself, sir.
25566 \begin_inset space ~
25579 –a bargain, every one of them.
25580 With five volumes you could just fill that gap on that second shelf.
25581 It looks untidy, does it not, sir?
25582 \begin_inset Quotes erd
25593 \begin_layout Standard
25597 \begin_layout Plain Layout
25603 columnseprule}{0pt}
25606 \begin_layout Plain Layout
25612 columnseprulecolor}{
25620 \begin_inset Note Note
25623 \begin_layout Plain Layout
25624 go back to the default
25632 \begin_layout Section
25633 Non-standard Paragraph Shapes
25636 \begin_layout Standard
25639 as well as any other text processor uses by default rectangular paragraphs.
25640 For special cases like for example posters, invitation cards or poems you
25641 can modify the paragraph shape to one of your choice.
25642 This can be done by using the \SpecialChar LaTeX
25647 which is loaded by using in the document settings the module
25649 Custom paragraph shapes
25654 \begin_layout Subsection
25658 \begin_layout Standard
25663 provides the following shapes:
25666 \begin_layout Standard
25667 \begin_inset Tabular
25668 <lyxtabular version="3" rows="13" columns="3">
25669 <features booktabs="true" islongtable="true" longtabularalignment="center">
25670 <column alignment="center" valignment="middle" width="16col%">
25671 <column alignment="center" valignment="middle" width="40col%">
25672 <column alignment="center" valignment="middle" width="35col%">
25673 <row endhead="true">
25674 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25677 \begin_layout Plain Layout
25683 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25686 \begin_layout Plain Layout
25692 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25695 \begin_layout Plain Layout
25703 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25706 \begin_layout Plain Layout
25712 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25715 \begin_layout Plain Layout
25716 Circle with circular hole (in the size of a CD/DVD)
25721 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25724 \begin_layout Plain Layout
25725 Cannot be scaled, take care there is not too much text
25732 <cell alignment="center" valignment="top" topline="true" usebox="none">
25735 \begin_layout Plain Layout
25741 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25744 \begin_layout Plain Layout
25750 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25753 \begin_layout Plain Layout
25754 Fragile, calculation might fail
25761 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25764 \begin_layout Plain Layout
25770 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25773 \begin_layout Plain Layout
25774 Rhomboid (symbolizing a
25775 \begin_inset Quotes eld
25779 \begin_inset Quotes erd
25787 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25790 \begin_layout Plain Layout
25798 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25801 \begin_layout Plain Layout
25807 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25810 \begin_layout Plain Layout
25816 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25819 \begin_layout Plain Layout
25827 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25830 \begin_layout Plain Layout
25836 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25839 \begin_layout Plain Layout
25845 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25848 \begin_layout Plain Layout
25856 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25859 \begin_layout Plain Layout
25865 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25868 \begin_layout Plain Layout
25869 Nut for bolt (hexagon with circular hole)
25874 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25877 \begin_layout Plain Layout
25885 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25888 \begin_layout Plain Layout
25894 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25897 \begin_layout Plain Layout
25903 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25906 \begin_layout Plain Layout
25914 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25917 \begin_layout Plain Layout
25923 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25926 \begin_layout Plain Layout
25932 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25935 \begin_layout Plain Layout
25943 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25946 \begin_layout Plain Layout
25952 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25955 \begin_layout Plain Layout
25961 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25964 \begin_layout Plain Layout
25972 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25975 \begin_layout Plain Layout
25981 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25984 \begin_layout Plain Layout
25985 Normal/reversed rain drop
25990 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25993 \begin_layout Plain Layout
25994 Fragile, calculation might fail
26001 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26004 \begin_layout Plain Layout
26011 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26014 \begin_layout Plain Layout
26015 The \SpecialChar TeX
26021 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26024 \begin_layout Plain Layout
26032 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26035 \begin_layout Plain Layout
26037 \begin_inset Newline newline
26045 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26048 \begin_layout Plain Layout
26049 Triangles in different orientations
26054 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26057 \begin_layout Plain Layout
26071 \begin_layout Standard
26072 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26074 for environments in the toolbar.
26077 \begin_layout Standard
26078 \begin_inset Newpage newpage
26084 \begin_layout Standard
26085 Here is an example paragraph in the shape of a nut:
26088 \begin_layout Standard
26089 \begin_inset VSpace bigskip
26098 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26099 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26101 At vero eos et accusam et justo duo dolores et ea rebum.
26102 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26104 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26105 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26109 \begin_layout Standard
26110 \begin_inset VSpace bigskip
26116 \begin_layout Standard
26117 \begin_inset Note Greyedout
26120 \begin_layout Plain Layout
26125 : shapepar paragraphs cannot run over a page break.
26133 \begin_layout Standard
26134 \begin_inset VSpace bigskip
26140 \begin_layout Standard
26145 takes care that the shape will always be preserved, no matter how much
26146 text is in the paragraph.
26147 Therefore the paragraph size changes with the amount of contained text.
26148 This can lead to paragraph sizes exceeding the page margins.
26149 To demonstrate the size scaling, here is the same example paragraph but
26150 with twice as much text:
26153 \begin_layout Standard
26154 \begin_inset Newpage newpage
26163 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26164 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26166 At vero eos et accusam et justo duo dolores et ea rebum.
26167 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26169 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26170 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26172 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26173 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26175 At vero eos et accusam et justo duo dolores et ea rebum.
26176 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26178 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26179 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26183 \begin_layout Standard
26184 \begin_inset VSpace bigskip
26190 \begin_layout Standard
26191 An exception is the shape
26196 It cannot be scaled because it must fit the size of a CD/DVD.
26197 Therefore the amount of text that fits into the shape is limited.
26198 \begin_inset Newline newline
26209 shape are fragile, meaning that the calculation of their size can fail,
26210 depending on the amount of text.
26211 You will then get the \SpecialChar LaTeX
26213 \begin_inset Quotes eld
26216 Arithmetic overflow
26217 \begin_inset Quotes erd
26221 In this case one can try to remove or add some text; if nothing works one
26222 has to use another shape.
26225 \begin_layout Standard
26226 \begin_inset VSpace bigskip
26232 \begin_layout Standard
26233 For shapes with tips you will maybe see that \SpecialChar LaTeX
26234 's hyphenation routine fails
26235 for text in the tips.
26236 Therefore it is often necessary to add hyphenation points
26241 arg "specialchar-insert hyphenation"
26246 ) to the corresponding text parts.
26249 \begin_layout Standard
26250 \begin_inset VSpace bigskip
26256 \begin_layout Standard
26257 Shapepar paragraphs are either always centered or placed on the page so
26258 that their left border touches the left page margin.
26259 You can therefore not use the paragraph dialog to align such paragraphs.
26260 A solution is to put the paragraph into a minipage or parbox and align
26262 The problem is hereby to find the right width for the box.
26263 Because if it is too wide and you center the box, the paragraph is not
26264 centered too because it sticks at the left side of the box.
26265 So you might have to play a bit with the width until it fits.
26266 Here are two heart-shaped paragraphs, the first one is not aligned, the
26267 second one is right-aligned:
26270 \begin_layout Standard
26271 \begin_inset Newpage newpage
26277 \begin_layout Heart
26281 Lo\SpecialChar softhyphen
26282 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26283 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26285 At vero eos et accusam et justo duo dolores et ea rebum.
26286 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26290 \begin_layout Standard
26291 \begin_inset VSpace bigskip
26297 \begin_layout Standard
26300 \begin_inset Box Frameless
26310 height_special "totalheight"
26315 backgroundcolor "none"
26318 \begin_layout Heart
26322 Lo\SpecialChar softhyphen
26323 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26324 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26326 At vero eos et accusam et justo duo dolores et ea rebum.
26327 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26336 \begin_layout Subsection
26340 \begin_layout Standard
26341 You can define any shape you want.
26342 Doing this manually is a lot of work because every coordinate must be specified.
26343 But there is a way to let the computer calculate the coordinates:
26346 \begin_layout Enumerate
26347 Install the program
26348 \begin_inset CommandInset href
26351 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26358 \begin_layout Enumerate
26365 TeX/LaTeX\SpecialChar menuseparator
26366 Settings\SpecialChar menuseparator
26369 and select the font size you are using in your document.
26370 For example this document uses the size 12
26371 \begin_inset space \thinspace{}
26377 \begin_layout Enumerate
26381 \begin_layout Enumerate
26384 TeX/LaTeX\SpecialChar menuseparator
26387 to export the shape to coordinates.
26388 In the appearing dialog use either the outline of your shape for the coordinate
26389 s or the path itself.
26393 \begin_layout Plain Layout
26394 For more information see
26395 \begin_inset CommandInset href
26397 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26409 \begin_layout Standard
26410 The coordinates are written into a \SpecialChar TeX
26412 To use it for your \SpecialChar LyX
26416 \begin_layout Enumerate
26417 Place the cursor before the first character of your paragraph (or into a
26421 \begin_layout Enumerate
26422 Open in \SpecialChar LyX
26425 Insert\SpecialChar menuseparator
26426 File\SpecialChar menuseparator
26428 \begin_inset space ~
26433 , select the file and use
26442 \begin_layout Standard
26443 \begin_inset VSpace defskip
26449 \begin_layout Standard
26450 \begin_inset Note Greyedout
26453 \begin_layout Plain Layout
26458 : The changed shape only applies to the current paragraph; everything is
26459 reset to normal for the next paragraph.
26460 Therefore the shape definition file must be input into every paragraph
26461 with the desired shape.
26469 \begin_layout Standard
26470 \begin_inset VSpace bigskip
26476 \begin_layout Standard
26477 Here is an example:
26480 \begin_layout Standard
26481 \begin_inset VSpace bigskip
26487 \begin_layout Standard
26488 \begin_inset CommandInset include
26490 filename "SpecialParagraphShape.tex"
26496 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26497 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26499 At vero eos et accusam et justo duo dolores et ea rebum.
26500 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26502 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26503 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26507 \begin_layout Standard
26508 \begin_inset VSpace bigskip
26514 \begin_layout Standard
26519 to draw complexer shapes in
26523 you can draw the shape in a program of your choice and import the resulting
26529 Then you only need to draw a line or spline along the outline of the image.
26532 \begin_layout Standard
26533 \begin_inset VSpace bigskip
26539 \begin_layout Standard
26542 Custom paragraph shapes
26544 also provides the two commands
26552 which can be used to define custom shapes coordinate by coordinate.
26556 \begin_layout Plain Layout
26557 These commands are internally used for all shapes described here.
26562 For information how these styles are used and about further customization
26563 possibilities, have a look at the documentation of the package
26568 \begin_inset CommandInset citation
26577 \begin_layout Bibliography
26578 \begin_inset CommandInset bibitem
26579 LatexCommand bibitem
26584 Documentation of the \SpecialChar LaTeX
26586 \begin_inset CommandInset href
26589 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26596 \begin_layout Bibliography
26597 \begin_inset CommandInset bibitem
26598 LatexCommand bibitem
26603 Documentation of the \SpecialChar LaTeX
26605 \begin_inset CommandInset href
26608 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"