1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
8 % DO NOT ALTER THIS PREAMBLE!!!
10 % This preamble is designed to ensure that the manual prints
11 % out as advertised. If you mess with this preamble,
12 % parts of the manual may not print out as expected. If you
13 % have problems LaTeXing this file, please contact
14 % the documentation team
15 % email: lyx-docs@lists.lyx.org
21 % set fonts for nicer pdf view
22 \IfFileExists{lmodern.sty}
23 {\usepackage{lmodern}}{}
25 \fi % end if pdflatex is used
27 % the pages of the TOC are numbered roman
28 % and a PDF-bookmark for the TOC is added
30 \let\myTOC\tableofcontents
31 \renewcommand{\tableofcontents}{%
32 \pdfbookmark[1]{\contentsname}{}
35 \pagenumbering{arabic}}
37 % extra space for tables
38 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
40 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
41 \use_default_options false
49 \maintain_unincluded_children false
51 \language_package default
54 \font_roman "default" "default"
55 \font_sans "default" "default"
56 \font_typewriter "default" "default"
57 \font_math "auto" "auto"
58 \font_default_family default
59 \use_non_tex_fonts false
62 \font_sf_scale 100 100
63 \font_tt_scale 100 100
65 \default_output_format default
67 \bibtex_command default
68 \index_command default
72 \pdf_title "LyX's Additional Features manual"
73 \pdf_author "LyX Team"
74 \pdf_subject "LyX's additional features documentation"
75 \pdf_keywords "LyX, Documentation, Additional"
77 \pdf_bookmarksnumbered true
78 \pdf_bookmarksopen false
79 \pdf_bookmarksopenlevel 1
84 \pdf_pdfusetitle false
85 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
88 \use_package amsmath 1
89 \use_package amssymb 1
92 \use_package mathdots 1
93 \use_package mathtools 0
95 \use_package stackrel 0
96 \use_package stmaryrd 0
97 \use_package undertilde 0
99 \cite_engine_type default
103 \paperorientation portrait
107 \notefontcolor #0000ff
114 \paragraph_separation indent
115 \paragraph_indentation default
116 \quotes_language english
119 \paperpagestyle headings
120 \tracking_changes false
121 \output_changes false
130 Additional \SpecialChar LyX
134 \begin_layout Subtitle
139 by the \SpecialChar LyX
144 \begin_layout Plain Layout
146 Principal maintainer of this file is
151 If you have comments or error corrections, please send them to the \SpecialChar LyX
154 \begin_inset Flex Code
157 \begin_layout Plain Layout
159 <lyx-docs@lists.lyx.org>
172 \begin_layout Standard
173 \begin_inset CommandInset toc
174 LatexCommand tableofcontents
181 \begin_layout Chapter
185 \begin_layout Standard
186 This manual is essentially Part II of the
188 User's Guide\SpecialChar endofsentence
191 The reason for separating the two documents is simple: the
195 is already quite lengthy, and it contains information on all of the basic
196 features one needs to know in order to prepare most documents.
197 However, the \SpecialChar LyX
198 Team has worked to make \SpecialChar LyX
199 extensible through various configuration
200 files and external packages.
201 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
203 create a layout file (or module) for it without having to alter \SpecialChar LyX
205 We've already had contributions of several new features this way, and some
206 of them are documented here.
207 There are also some more `advanced' features, such as how to control the
208 presentation of bibliographies and how to work with multi-part documents,
209 that are not covered in the
213 and are discussed here.
216 \begin_layout Standard
217 This manual also documents some special features, like fax support, version
218 control, and SGML support, which require additional software to work properly.
219 There is also a chapter on \SpecialChar LyX
221 And lastly, there's a chapter of \SpecialChar LaTeX
222 tools and tips, things you can use to
223 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
225 After all, \SpecialChar LyX
230 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
234 \begin_layout Standard
235 If you haven't read the
239 yet, you are definitely in the wrong manual.
244 is the first place to go, since it describes the notation and format of
246 You should also be thoroughly familiar with the
250 and all of the basic features of \SpecialChar LyX
251 before attempting to read this one.
254 \begin_layout Standard
255 Since many of the topics in this manual depend heavily on \SpecialChar LyX
257 with \SpecialChar LaTeX
258 , this first chapter covers the inner workings of \SpecialChar LyX
261 to generate exactly the \SpecialChar LaTeX
263 It is obviously for more seasoned \SpecialChar LyX
267 \begin_layout Chapter
269 and \SpecialChar LaTeX
273 \begin_layout Section
275 Uses \SpecialChar LaTeX
279 \begin_layout Standard
280 This chapter is for both \SpecialChar TeX
281 -nicians and the \SpecialChar LaTeX
283 In it, we'll explain how \SpecialChar LyX
284 and \SpecialChar LaTeX
285 work together to produce printable output.
286 This is the only place in any of the manuals where we assume you know something
287 about \SpecialChar LaTeX
291 \begin_layout Standard
292 At one time, \SpecialChar LyX
294 \begin_inset Quotes eld
297 WYSIWYM frontend to \SpecialChar LaTeX
299 \begin_inset Quotes erd
302 but that's no longer true.
303 There are frontends to \SpecialChar LaTeX
308 \begin_layout Plain Layout
309 Some familar ones are \SpecialChar TeX
310 maker and kile, on Linux, and \SpecialChar TeX
312 There are also the \SpecialChar LaTeX
313 modes for vi and emacs, of course.
318 These are basically text editors with the ability to run \SpecialChar LaTeX
320 errors in the file you're editing.
321 Although \SpecialChar LyX
330 run \SpecialChar LaTeX
331 , and it also indicates errors in the file, it also does much, much
333 For one thing, you don't need to know \SpecialChar LaTeX
334 to use \SpecialChar LyX
337 has added its own extensions to \SpecialChar LaTeX
339 Try the following sometime: select
340 \begin_inset Flex Noun
343 \begin_layout Plain Layout
344 Export\SpecialChar menuseparator
352 \begin_inset Flex Noun
355 \begin_layout Plain Layout
362 \begin_inset Flex Noun
365 \begin_layout Plain Layout
366 View\SpecialChar menuseparator
376 ), then look at the preamble of the resulting
377 \begin_inset Flex Code
380 \begin_layout Plain Layout
387 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
389 These macros are defined automatically, according to the features you use
393 \begin_layout Standard
394 There are several commands that automatically invoke \SpecialChar LaTeX
399 \begin_layout Itemize
400 \begin_inset Flex Noun
403 \begin_layout Plain Layout
404 Document\SpecialChar menuseparator
413 \begin_layout Itemize
414 \begin_inset Flex Noun
417 \begin_layout Plain Layout
418 Document\SpecialChar menuseparator
427 \begin_layout Itemize
428 \begin_inset Flex Noun
431 \begin_layout Plain Layout
432 File\SpecialChar menuseparator
441 \begin_layout Itemize
442 \begin_inset Flex Noun
445 \begin_layout Plain Layout
446 File\SpecialChar menuseparator
455 \begin_layout Standard
456 They will only invoke \SpecialChar LaTeX
457 if the file has changed since the last time \SpecialChar LaTeX
463 \begin_layout Standard
464 When \SpecialChar LyX
465 runs \SpecialChar LaTeX
466 on the file you're editing, it performs these steps:
469 \begin_layout Enumerate
470 Convert the document to \SpecialChar LaTeX
471 and save to a file with the extension
472 \begin_inset Flex Code
475 \begin_layout Plain Layout
482 \begin_inset Flex Code
485 \begin_layout Plain Layout
494 \begin_layout Enumerate
495 Run \SpecialChar LaTeX
497 \begin_inset Flex Code
500 \begin_layout Plain Layout
506 file (maybe several times), and run any other commands (such as
507 \begin_inset Flex Code
510 \begin_layout Plain Layout
517 \begin_inset Flex Code
520 \begin_layout Plain Layout
526 ) needed to compile the \SpecialChar LaTeX
530 \begin_layout Enumerate
531 If there are any errors, show the error log.
534 \begin_layout Standard
535 If you have run \SpecialChar LaTeX
537 \begin_inset Flex Noun
540 \begin_layout Plain Layout
543 \SpecialChar menuseparator
552 then runs a DVI viewer to display the DVI-file.
554 \begin_inset Flex Noun
557 \begin_layout Plain Layout
560 \SpecialChar menuseparator
569 performs further steps:
572 \begin_layout Itemize
574 \begin_inset Flex Code
577 \begin_layout Plain Layout
583 to convert the DVI file to PostScript.
586 \begin_layout Itemize
587 Run a PostScript viewer, such as
588 \begin_inset Flex Code
591 \begin_layout Plain Layout
597 , to display the PostScript file.
600 \begin_layout Standard
602 does similar things when viewing, or exporting, other formats.
605 \begin_layout Section
606 Translating \SpecialChar LaTeX
607 files into \SpecialChar LyX
611 \begin_layout Standard
612 You can import a \SpecialChar LaTeX
613 file into \SpecialChar LyX
615 \begin_inset Flex Noun
618 \begin_layout Plain Layout
619 File\SpecialChar menuseparator
620 Import\SpecialChar menuseparator
627 command in \SpecialChar LyX
629 This will call a program named
630 \begin_inset Flex Code
633 \begin_layout Plain Layout
639 which will create a file
640 \begin_inset Flex Code
643 \begin_layout Plain Layout
650 \begin_inset Flex Code
653 \begin_layout Plain Layout
661 will then open that file.
665 \begin_layout Plain Layout
666 \begin_inset Flex Code
669 \begin_layout Plain Layout
675 can also be run from the command line, of course.
683 \begin_layout Standard
684 \begin_inset Flex Code
687 \begin_layout Plain Layout
693 will translate most legal \SpecialChar LaTeX
694 , but not everything.
695 It will put things it doesn't understand into \SpecialChar TeX
696 code, so after translating
698 \begin_inset Flex Code
701 \begin_layout Plain Layout
707 , you can look for \SpecialChar TeX
708 code and hand-edit it until it looks right.
711 \begin_layout Standard
712 If you don't know what \SpecialChar TeX
713 code is, read the next section.
716 \begin_layout Section
717 \begin_inset CommandInset label
719 name "sec:Inserting-TeX-Code"
723 Inserting \SpecialChar TeX
724 Code into \SpecialChar LyX
728 \begin_layout Standard
729 Anything you can do in \SpecialChar LaTeX
730 you can do in \SpecialChar LyX
731 , for a very simple reason: You can
732 always insert \SpecialChar TeX
733 code into any \SpecialChar LyX
736 cannot, and will never be able to, display every possible \SpecialChar LaTeX
738 If ever you need to insert \SpecialChar LaTeX
739 commands into your \SpecialChar LyX
740 document, you can use the
742 \begin_inset Flex Code
745 \begin_layout Plain Layout
752 box, which you can insert into your document with
753 \begin_inset Flex Noun
756 \begin_layout Plain Layout
757 Insert\SpecialChar menuseparator
767 or the keyboard shortcut
776 \begin_layout Standard
777 Here's an example of inserting \SpecialChar LaTeX
778 commands in a \SpecialChar LyX
780 The code looks like this:
783 \begin_layout LyX-Code
787 \begin_inset Newline newline
793 \begin_inset Newline newline
796 This is an example of a minipage environment.
798 \begin_inset Newline newline
801 can put nearly everything in it, even (non-floating)
802 \begin_inset Newline newline
807 \begin_inset Newline newline
813 \begin_inset Newline newline
817 \begin_inset Newline newline
823 \begin_inset Newline newline
829 \begin_inset Newline newline
835 \begin_inset Newline newline
840 \begin_inset Newline newline
846 \begin_inset Newline newline
852 \begin_inset Newline newline
858 \begin_inset Newline newline
866 \begin_layout LyX-Code
870 \begin_layout Standard
872 \begin_inset Flex Code
875 \begin_layout Plain Layout
882 box containing this text is directly after this paragraph.
883 Those of you reading the manual in \SpecialChar LyX
884 will only see the \SpecialChar TeX
886 Those reading a printed version of the manuals will see the actual results:
887 \begin_inset VSpace bigskip
893 \begin_layout Standard
897 \begin_layout Plain Layout
904 \begin_layout Plain Layout
911 \begin_layout Plain Layout
913 This is an example of a minipage environment.
914 You can put nearly everything in it, even (non-floating) figures and tables.
918 \begin_layout Plain Layout
925 \begin_layout Plain Layout
930 \begin_layout Plain Layout
937 \begin_layout Plain Layout
944 \begin_layout Plain Layout
951 \begin_layout Plain Layout
957 \begin_layout Plain Layout
964 \begin_layout Plain Layout
971 \begin_layout Plain Layout
978 \begin_layout Plain Layout
988 \begin_inset VSpace bigskip
994 \begin_layout Standard
995 In addition to using \SpecialChar TeX
996 code, you can also create a separate file containing
997 some complex \SpecialChar LaTeX
998 structure and then use
999 \begin_inset Flex Noun
1002 \begin_layout Plain Layout
1003 Insert\SpecialChar menuseparator
1005 \begin_inset space ~
1013 to include your file (you should select the type
1014 \begin_inset Flex Code
1017 \begin_layout Plain Layout
1024 We recommend that you only do this if you have a
1025 \begin_inset Flex Code
1028 \begin_layout Plain Layout
1039 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1043 \begin_layout Standard
1044 There are a few last points to emphasize:
1047 \begin_layout Itemize
1053 check if your \SpecialChar LaTeX
1057 \begin_layout Itemize
1058 Beware of reinventing the wheel.
1061 \begin_layout Standard
1062 On that last point, \SpecialChar LyX
1063 does have quite a few features tucked into it, and
1065 Be sure to check the manuals to make sure that \SpecialChar LyX
1066 doesn't have such-and-such
1067 feature before you decide you have to do it by hand.
1068 Moreover, there are numerous \SpecialChar LaTeX
1069 packages out there to do all sorts of things,
1070 from labels to envelopes to fancy multipage tables.
1072 \begin_inset CommandInset href
1075 target "http://www.ctan.org/"
1082 \begin_layout Standard
1083 If you do need to do some wild and fancy things within your document, be
1084 sure to check out a good \SpecialChar LaTeX
1085 book for assistance.
1086 There are a number of them listed in the bibliography of the
1093 \begin_layout Section
1095 and the \SpecialChar LaTeX
1099 \begin_layout Subsection
1100 About the \SpecialChar LaTeX
1104 \begin_layout Standard
1105 If you already know \SpecialChar LaTeX
1106 , there is no need to explain here what the preamble
1108 If you don't, the following will give you some ideas—we recommend again
1109 that you consult a \SpecialChar LaTeX
1110 book for further information.
1111 In any case, you should read the points below, because they explain what
1112 you can do and what you don't need to do in the \SpecialChar LaTeX
1113 preamble of a \SpecialChar LyX
1117 \begin_layout Standard
1118 The \SpecialChar LaTeX
1119 preamble comes at the very beginning of a document,
1127 \begin_layout Itemize
1128 Declare the document class.
1130 \begin_inset Newline newline
1134 already does this for you.
1135 If you're a seasoned \SpecialChar LaTeX
1136 -nician, and you have a custom document class you
1137 want to use, check out the
1139 Customization Manual
1141 for information on how to make \SpecialChar LyX
1145 \begin_layout Itemize
1146 Declare the usage of packages.
1148 \begin_inset Newline newline
1152 packages provide special commands, which are only available within a document
1153 when the package has been declared in the preamble.
1154 In addition to providing special commands, the inclusion of a package can
1155 change the document.
1156 For example, the package
1157 \begin_inset Flex Code
1160 \begin_layout Plain Layout
1166 forces all paragraphs to be indented.
1167 There are other packages for labels, envelopes, margins, etc.
1171 \begin_layout Itemize
1172 Set counters, variables, lengths and widths.
1174 \begin_inset Newline newline
1177 There are several \SpecialChar LaTeX
1178 counters and variables that
1182 be set globally from within the preamble in order to have the desired effect.
1183 (There are variables that you can set and reset inside the document, too.)
1184 Margins are a good example of something that must be set in the preamble.
1185 Another example is the label format for lists.
1186 You can actually set these just about anywhere, but it's best to do it
1187 just once, inside the preamble.
1190 \begin_layout Itemize
1191 Declare user defined commands (with
1192 \begin_inset Flex Code
1195 \begin_layout Plain Layout
1204 \begin_inset Flex Code
1207 \begin_layout Plain Layout
1216 \begin_inset Newline newline
1219 These are abbreviations for \SpecialChar LaTeX
1220 commands which appear very often inside a document.
1221 Although the preamble is a good place to declare such commands, they
1225 be declared anywhere (before they are used for the first time, of course).
1226 This can be useful if there is a lot of raw \SpecialChar LaTeX
1227 code in your document, which
1228 normally should not be the case.
1231 \begin_layout Standard
1233 adds its own set of definitions to the preamble of the
1234 \begin_inset Flex Code
1237 \begin_layout Plain Layout
1244 This makes \SpecialChar LaTeX
1245 files generated by \SpecialChar LyX
1249 \begin_layout Subsection
1250 Changing the Preamble
1253 \begin_layout Standard
1254 The commands which \SpecialChar LyX
1255 adds to the preamble of a \SpecialChar LaTeX
1256 file are fixed; you can't
1257 change them without patching \SpecialChar LyX
1259 You can, however, add your own stuff to the preamble by selecting
1260 \begin_inset Flex Noun
1263 \begin_layout Plain Layout
1266 \begin_inset space ~
1275 \begin_inset Flex Noun
1278 \begin_layout Plain Layout
1279 Document\SpecialChar menuseparator
1287 adds anything in the
1288 \begin_inset Flex Noun
1291 \begin_layout Plain Layout
1297 dialog to its own built-in preamble.
1298 Before adding your own declarations in the preamble, you should make sure
1299 that \SpecialChar LyX
1300 doesn't already support what you want to do.
1301 (Remember what we said about reinventing the wheel?) Also,
1303 make sure your preamble code is correct
1307 doesn't check it for you.
1308 If there is an error, you're likely to get an error like
1309 \begin_inset Quotes eld
1313 \begin_inset Flex Code
1316 \begin_layout Plain Layout
1325 \begin_inset Quotes erd
1329 If you see this error, check your preamble.
1332 \begin_layout Subsection
1336 \begin_layout Standard
1337 Here are some examples of what you can add to a preamble, and what they
1341 \begin_layout Subsubsection
1345 \begin_layout Standard
1346 There are two variables under \SpecialChar LaTeX
1347 that control page position:
1348 \begin_inset Flex Code
1351 \begin_layout Plain Layout
1360 \begin_inset Flex Code
1363 \begin_layout Plain Layout
1372 Their names should be self-explanatory.
1373 These variables are useful if you think for a moment about computer labels.
1374 Sometimes, the size of a print medium and the area of the medium that you
1375 can actually print on aren't the same.
1377 \begin_inset Flex Code
1380 \begin_layout Plain Layout
1389 \begin_inset Flex Code
1392 \begin_layout Plain Layout
1403 \begin_layout Standard
1404 The default values for
1405 \begin_inset Flex Code
1408 \begin_layout Plain Layout
1417 \begin_inset Flex Code
1420 \begin_layout Plain Layout
1429 \begin_inset space \thinspace{}
1433 \begin_inset space \thinspace{}
1437 \begin_inset space \space{}
1440 the page isn't shifted.
1441 Unfortunately, some DVI drivers always seem to shift the page.
1442 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1443 If you're using \SpecialChar LyX
1444 on a system that you don't personally maintain, and your
1445 sysadmin is a doofus,
1446 \begin_inset Flex Code
1449 \begin_layout Plain Layout
1458 \begin_inset Flex Code
1461 \begin_layout Plain Layout
1470 Suppose your left and top margins are always 0.5
1471 \begin_inset space \thinspace{}
1475 You can add this to the preamble:
1478 \begin_layout LyX-Code
1486 \begin_layout LyX-Code
1494 \begin_layout Standard
1495 and your margins should now be correct.
1498 \begin_layout Subsubsection
1502 \begin_layout Standard
1503 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1504 There's a rather nice package, available at your nearest CTAN archive,
1505 for printing sheets of labels:
1506 \begin_inset Flex Code
1509 \begin_layout Plain Layout
1516 Now, your system may not have this package installed by default.
1517 We leave that up to you to check.
1518 You'll also want to read the documentation for it; we're not going to do
1520 Since this is an example, however, we'll give you an example of how you
1524 \begin_layout Standard
1525 First, make sure you're using the
1526 \begin_inset Flex Code
1529 \begin_layout Plain Layout
1536 Next, you need to put the following in your preamble:
1539 \begin_layout LyX-Code
1545 \begin_layout LyX-Code
1551 \begin_layout LyX-Code
1557 \begin_layout LyX-Code
1563 \begin_layout LyX-Code
1569 \begin_layout LyX-Code
1575 \begin_layout LyX-Code
1581 \begin_layout Standard
1582 This sets things up for Avery label sheets, stock #5360.
1583 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1586 \begin_inset Flex Code
1589 \begin_layout Plain Layout
1598 \begin_inset Flex Code
1601 \begin_layout Plain Layout
1609 around each label text.
1610 This and other special features of
1611 \begin_inset Flex Code
1614 \begin_layout Plain Layout
1620 are explained in its documentation.
1623 \begin_layout Standard
1624 Someday, someone may write a \SpecialChar LyX
1625 layout file to support this package directly.
1626 Maybe that someone is you.
1629 \begin_layout Subsubsection
1630 Example #3: Paragraph Indentation
1633 \begin_layout Standard
1634 Americans are trained to indent the first line of
1639 As with all of their other weird quirks, most Americans will whine and
1640 moan until they can have their way and indent the first line of all paragraphs.
1649 \begin_layout Standard
1650 Of course, this behavior isn't standard typography.
1651 In books, you typically only indent the first line of a paragraph
1655 it follows another one.
1656 The idea behind indenting the first line of a paragraph is to distinguish
1657 neighboring paragraphs from one another.
1658 If there is no previous paragraph—for example, if it follows a figure or
1659 is the first paragraph in a section—then there is no need for indentation.
1663 \begin_layout Standard
1664 If you're a typical American (we're still joking!), though, you don't care
1665 about such esoteric things; you want your indentation! Add this to the
1669 \begin_layout LyX-Code
1672 usepackage{indentfirst}
1675 \begin_layout Standard
1676 If your \SpecialChar TeX
1677 distribution isn't braindead, you'll have this package, and all
1678 of your paragraphs will get the indentation the Founding Fathers intended
1682 \begin_layout Subsubsection
1683 Example #4: This Document
1686 \begin_layout Standard
1687 You can also check out the preamble of this document to get an idea of some
1688 of the advanced things you can do.
1691 \begin_layout Section
1693 and \SpecialChar LaTeX
1697 \begin_layout Standard
1698 When \SpecialChar LyX
1699 calls \SpecialChar LaTeX
1700 , it tells \SpecialChar LaTeX
1701 to blithely ignore any errors and keep going.
1702 It then uses the logfile from the \SpecialChar LaTeX
1703 run to do a post-mortem.
1704 After analyzing the logfile, \SpecialChar LyX
1705 displays a dialog listing the errors.
1706 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1708 where the error occurred.
1712 \begin_layout Plain Layout
1714 Analyzing the logfile is a tough job, and \SpecialChar LyX
1715 doesn't always go to the right
1717 There are also cases where \SpecialChar LaTeX
1718 reports the error on one line, but the actual
1720 This is not unlike forgetting a closing brace in a program: You'll get
1721 an error, but only later.
1729 \begin_layout Standard
1730 Some folks also like to look at the log file directly: It is available from
1732 \begin_inset Flex Noun
1735 \begin_layout Plain Layout
1738 \SpecialChar menuseparator
1742 \begin_inset space ~
1751 There are some fairly common error messages and warnings.
1752 We'll cover those here.
1753 You should look at a good \SpecialChar LaTeX
1754 book for a complete listing.
1757 \begin_layout Itemize
1758 \begin_inset Flex Code
1761 \begin_layout Plain Layout
1769 \begin_inset Newline newline
1772 Anything beginning with these words is a warning message for the purpose
1774 \begin_inset Quotes eld
1778 \begin_inset Quotes erd
1781 the \SpecialChar LaTeX
1783 You'll get messages like this if you added or changed cross-references
1784 or bibliography entries, in which case, \SpecialChar LaTeX
1785 is trying to tell you that you
1786 need to make another run.
1787 You can by-and-large ignore these.
1790 \begin_layout Itemize
1791 \begin_inset Flex Code
1794 \begin_layout Plain Layout
1802 \begin_inset Newline newline
1805 Another warning message, this time about fonts which \SpecialChar LaTeX
1807 The rest of the message will often say something about a replacement font
1808 that \SpecialChar LaTeX
1810 You can safely ignore these, too.
1813 \begin_layout Itemize
1814 \begin_inset Flex Code
1817 \begin_layout Plain Layout
1826 \begin_inset Newline newline
1835 They are warnings about lines that were too long and run past the right
1837 Almost always, this is unnoticeable in the final output.
1838 (It can be just a point or two.) Or, only one or two characters extend past
1841 seems to generate at least one of these messages for just about any document
1843 \begin_inset Newline newline
1846 You can ignore these messages.
1847 Your eyes will tell you if there's a problem with something that's too
1848 wide; just look at the output.
1852 \begin_layout Plain Layout
1853 You can also enable the `draft' option in
1854 \begin_inset Flex Noun
1857 \begin_layout Plain Layout
1860 \SpecialChar menuseparator
1868 , and then \SpecialChar LaTeX
1869 will draw a black box in the margin of lines that are overfull.
1877 \begin_layout Itemize
1878 \begin_inset Flex Code
1881 \begin_layout Plain Layout
1890 \begin_inset Newline newline
1893 Not quite as common as its cousin.
1895 seems to like to print lines that are a bit too wide as opposed to ones
1896 that are a bit too narrow.
1897 We have no idea why.
1900 \begin_layout Itemize
1901 \begin_inset Flex Code
1904 \begin_layout Plain Layout
1913 \begin_inset Flex Code
1916 \begin_layout Plain Layout
1925 \begin_inset Newline newline
1928 Warnings about troubles breaking the page.
1929 Once again, just look at the output.
1930 Your eyes will tell you where something has gone wrong.
1933 \begin_layout Itemize
1934 \begin_inset Flex Code
1937 \begin_layout Plain Layout
1940 \begin_inset Quotes els
1944 \begin_inset Quotes ers
1953 \begin_inset Newline newline
1957 \begin_inset Quotes eld
1961 \begin_inset Quotes erd
1964 isn't installed on this system.
1965 This usually appears because some package your document needs isn't installed.
1966 If you didn't touch the preamble or didn't use the
1967 \begin_inset Flex Code
1970 \begin_layout Plain Layout
1978 command, then one of the packages \SpecialChar LyX
1979 tried to load is missing.
1981 \begin_inset Flex Noun
1984 \begin_layout Plain Layout
1985 Help\SpecialChar menuseparator
1992 to get a list of packages that \SpecialChar LyX
1994 This file is updated whenever you reconfigure \SpecialChar LyX
1996 \begin_inset Flex Noun
1999 \begin_layout Plain Layout
2000 Tools\SpecialChar menuseparator
2006 ) and tells you which packages have been detected and what they do.
2007 \begin_inset Newline newline
2011 \begin_inset Flex Code
2014 \begin_layout Plain Layout
2022 command and the package in question isn't installed, then you'll need to
2023 install it yourself.
2026 \begin_layout Itemize
2027 \begin_inset Flex Code
2030 \begin_layout Plain Layout
2032 Error: Unknown option
2038 \begin_inset Newline newline
2041 Error messages beginning with this are trying to tell you that you specified
2042 a bad or undefined option to a package.
2043 Check the package's documentation.
2046 \begin_layout Itemize
2047 \begin_inset Flex Code
2050 \begin_layout Plain Layout
2051 Undefined control sequence
2057 \begin_inset Newline newline
2060 If you've inserted \SpecialChar LaTeX
2061 code into your document, but made a typo, you'll get
2063 You may have forgotten to load a package.
2064 In any case, this error message usually means that you used an undefined
2069 \begin_layout Standard
2070 There are other error and warning messages.
2071 Some are self-explanatory.
2072 These are usually \SpecialChar LaTeX
2074 Others are downright cryptic.
2075 These are usually \SpecialChar TeX
2076 error messages, and we really have
2080 what they mean or how to decipher them.
2084 \begin_layout Standard
2085 There's a general sequence you should follow if you get error messages:
2088 \begin_layout Enumerate
2089 Look at the \SpecialChar LaTeX
2090 code you inserted for typos.
2093 \begin_layout Enumerate
2094 If there are no typos, check that you used the command(s) correctly.
2097 \begin_layout Enumerate
2098 If you get a bunch of error boxes piled up at the very top of the document—and
2099 especially if you see a
2100 \begin_inset Quotes eld
2104 \begin_inset Flex Code
2107 \begin_layout Plain Layout
2116 \begin_inset Quotes erd
2119 error—it means that there are errors in the preamble.
2120 Start debugging your preamble.
2123 \begin_layout Enumerate
2124 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2126 document, the first suspect is your \SpecialChar LaTeX
2127 distribution itself.
2128 Check for missing packages and install them.
2131 \begin_layout Enumerate
2132 Okay, so there are no missing packages.
2133 Did you use any of the fine-tuning options in \SpecialChar LyX
2134 ? Specifically, did you
2138 any of them, like trying to manually insert lots of
2139 \begin_inset Flex Code
2142 \begin_layout Plain Layout
2144 \begin_inset space ~
2153 \begin_inset Flex Code
2156 \begin_layout Plain Layout
2163 \begin_inset Flex Code
2166 \begin_layout Plain Layout
2172 ? Did you try to kludge something together with these instead of using the
2173 appropriate paragraph environment?
2176 \begin_layout Enumerate
2177 All right, you didn't use any of the fine-tuning options, you played by
2179 Did you try to pull a fancy maneuver? Did you do something funky inside
2180 a table or an equation, like inserting a graphic into a table cell?
2183 \begin_layout Enumerate
2184 Do you have long sections of text where \SpecialChar LaTeX
2185 cannot find a place to break a
2186 line? By default, \SpecialChar LaTeX
2187 is rather strict about how much extra inter-word spacing
2188 it will add in order to break a line.
2189 Preferably, you should rework the paragraph to avoid the problem.
2192 \begin_layout Enumerate
2193 Did you go overboard with the nesting? \SpecialChar LyX
2194 (currently) doesn't check to make
2195 sure you're in the limits for nesting environments.
2196 If you nested a bunch of environments to the
2197 \begin_inset Formula $17^{\mathrm{th}}$
2200 level, that's the problem.
2201 (The limit in \SpecialChar LaTeX
2205 \begin_layout Enumerate
2206 Okay, you didn't get any error messages, but your output looks awful.
2207 If you have a table or figure that's too wide or long for the page, you
2209 \begin_inset Separator parbreak
2216 \begin_layout Enumerate
2217 rescale the figure so it fits.
2220 \begin_layout Enumerate
2221 trim down the table so it fits.
2225 \begin_layout Enumerate
2226 If something else is wrong with the output, and you didn't try to pull anything
2227 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2230 \begin_layout Standard
2231 If all this doesn't help—well, then
2235 you might have found a bug in \SpecialChar LyX
2240 \begin_layout Chapter
2244 \begin_layout Section
2245 Customizing Bibliographies with Bib\SpecialChar TeX
2249 \begin_layout Standard
2250 The most basic information about how to use Bib\SpecialChar TeX
2251 with \SpecialChar LyX
2255 Bibliography databases (Bib\SpecialChar TeX
2263 The following subsections explain special bibliography features supported
2268 \begin_layout Subsection
2269 Alternative Citation Styles
2272 \begin_layout Standard
2273 Standard Bib\SpecialChar TeX
2275 \begin_inset space \thinspace{}
2279 \begin_inset space \space{}
2283 \begin_inset Quotes eld
2287 \begin_inset Quotes erd
2290 ) to refer to a cited work.
2291 However, in many scientific disciplines, other citation styles are in use.
2292 The most common one is the author-year style (e.
2293 \begin_inset space \thinspace{}
2297 \begin_inset space \space{}
2301 \begin_inset Quotes eld
2305 \begin_inset Quotes erd
2310 supports two packages that provide this style,
2311 \begin_inset Flex Code
2314 \begin_layout Plain Layout
2321 \begin_inset Flex Code
2324 \begin_layout Plain Layout
2331 Both packages have their pros and cons, which cannot be listed in detail.
2332 If you only want to have simple author-year (or author-numerical) style,
2333 or if you want to use one of the countless style files for
2334 \begin_inset Flex Code
2337 \begin_layout Plain Layout
2343 , then the established
2344 \begin_inset Flex Code
2347 \begin_layout Plain Layout
2353 package is probably your choice.
2354 If you need special features like short title references, ibidem etc., you
2356 \begin_inset Flex Code
2359 \begin_layout Plain Layout
2368 \begin_layout Standard
2369 The handling of both packages in \SpecialChar LyX
2370 is basically the same.
2372 \begin_inset Flex Noun
2375 \begin_layout Plain Layout
2376 Document\SpecialChar menuseparator
2383 \begin_inset Flex Noun
2386 \begin_layout Plain Layout
2393 \begin_inset Flex Noun
2396 \begin_layout Plain Layout
2403 \begin_inset Flex Noun
2406 \begin_layout Plain Layout
2413 With both packages, you will get some extra features in the citation dialog
2414 and you can select the style of the reference (
2415 \begin_inset Quotes eld
2419 \begin_inset Quotes erd
2423 \begin_inset Quotes eld
2427 \begin_inset Quotes erd
2431 \begin_inset Quotes eld
2435 \begin_inset Quotes erd
2439 \begin_inset Quotes eld
2443 \begin_inset Quotes erd
2447 Note that both packages need specifically designed style files.
2448 They both ship their own, but there are lots of additional style files,
2449 and there is even an interactive style file builder
2453 \begin_layout Plain Layout
2455 \begin_inset Flex URL
2458 \begin_layout Plain Layout
2460 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2471 \begin_inset Flex Code
2474 \begin_layout Plain Layout
2483 \begin_layout Subsection
2484 Sectioned Bibliographies
2487 \begin_layout Standard
2488 Sometimes you might need to divide your bibliography into several sections.
2489 If you are for instance a historian, the possibility to separate sources
2490 and scientific works is most likely a
2491 \begin_inset Quotes eld
2495 \begin_inset Quotes erd
2499 Unfortunately, Bib\SpecialChar TeX
2500 itself does not allow you to do this.
2501 But with the help of some \SpecialChar LaTeX
2502 packages, Bib\SpecialChar TeX
2503 can be extended to fit your needs.
2506 \begin_layout Standard
2508 provides native support for one of these packages,
2516 \begin_layout Plain Layout
2518 \begin_inset Flex URL
2521 \begin_layout Plain Layout
2523 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2533 The advantage of this package (compared to other packages like
2537 ) is that you don't need to define new citation commands.
2538 Instead, you need to prepare different bibliographic databases which include
2539 the entries for the different sections of the bibliography.
2540 For example: If you want to divide your bibliography into the sections
2542 \begin_inset Quotes eld
2546 \begin_inset Quotes erd
2550 \begin_inset Quotes eld
2554 \begin_inset Quotes erd
2557 , you first need to create two bibliographic databases, e.
2558 \begin_inset space \thinspace{}
2562 \begin_inset space \space{}
2566 \begin_inset Flex Code
2569 \begin_layout Plain Layout
2576 \begin_inset Flex Code
2579 \begin_layout Plain Layout
2589 \begin_layout Standard
2591 \begin_inset Flex Noun
2594 \begin_layout Plain Layout
2595 Document\SpecialChar menuseparator
2602 \begin_inset Flex Noun
2605 \begin_layout Plain Layout
2612 \begin_inset Flex Noun
2615 \begin_layout Plain Layout
2616 Sectioned bibliography
2622 Now you can insert multiple Bib\SpecialChar TeX
2623 bibliographies, one for each section of
2625 Returning to our example: Insert the Bib\SpecialChar TeX
2627 \begin_inset Flex Code
2630 \begin_layout Plain Layout
2636 and a second one for the database
2637 \begin_inset Flex Code
2640 \begin_layout Plain Layout
2647 You are free to use the same or different styles for each section.
2648 Additionally, you can choose if the bibliography section should contain
2650 \begin_inset Quotes eld
2653 all cited references
2654 \begin_inset Quotes erd
2657 of the specified database(s) (which is the default),
2658 \begin_inset Quotes eld
2661 all uncited references
2662 \begin_inset Quotes erd
2666 \begin_inset Quotes eld
2670 \begin_inset Quotes erd
2674 This might be useful if you would like to separate your bibliography into
2676 \begin_inset Quotes eld
2680 \begin_inset Quotes erd
2684 \begin_inset Quotes eld
2688 \begin_inset Quotes erd
2692 \begin_inset Quotes eld
2696 \begin_inset Quotes erd
2700 The titles for the sections can be added as ordinary sections or subsections.
2702 \begin_inset Flex Code
2705 \begin_layout Plain Layout
2711 removes the bibliography title, you have to manually re-add that, too (as
2712 a chapter* or section*, for instance).
2715 \begin_layout Subsection
2716 Multiple Bibliographies
2719 \begin_layout Standard
2720 Multiple bibliographies, e.
2721 \begin_inset space \thinspace{}
2725 \begin_inset space \space{}
2728 a bibliography for each section or chapter of the document, are not supported
2729 by Bib\SpecialChar TeX
2732 \begin_inset Flex Code
2735 \begin_layout Plain Layout
2741 package, which is used for the creation of sectioned bibliographies in
2743 (see the previous section), provides an easy way to solve this task, if
2744 you are willing to use some
2745 \begin_inset Flex Noun
2748 \begin_layout Plain Layout
2756 \begin_inset space ~
2760 \begin_inset CommandInset ref
2762 reference "sec:Inserting-TeX-Code"
2770 \begin_layout Plain Layout
2771 An alternative approach is to use the
2772 \begin_inset Flex Code
2775 \begin_layout Plain Layout
2782 \begin_inset Flex Code
2785 \begin_layout Plain Layout
2791 package, respectively.
2799 \begin_layout Standard
2801 \begin_inset Flex Noun
2804 \begin_layout Plain Layout
2805 Document\SpecialChar menuseparator
2812 \begin_inset Flex Noun
2815 \begin_layout Plain Layout
2822 \begin_inset Flex Noun
2825 \begin_layout Plain Layout
2826 Sectioned bibliography
2832 In the document, you have to enclose the sections, which shall contain
2833 their own bibliography (including the Bib\SpecialChar TeX
2834 bibliography itself), between
2836 \begin_inset Flex Code
2839 \begin_layout Plain Layout
2848 \begin_inset Flex Code
2851 \begin_layout Plain Layout
2859 (those commands have to be inserted as \SpecialChar TeX
2861 The bibliography will contain all references that have been cited in the
2863 \begin_inset Flex Code
2866 \begin_layout Plain Layout
2877 If you are using this approach, then every citation reference has to be
2879 \begin_inset Flex Code
2882 \begin_layout Plain Layout
2890 \begin_inset Flex Code
2893 \begin_layout Plain Layout
2902 \begin_layout Section
2906 \begin_layout Subsection
2910 \begin_layout Standard
2911 When you are working on a large file with many sections, it is often convenient
2912 to break up the document into several files, or perhaps you have something
2913 where a table may change from time to time, but the preceding text does
2915 In these cases, you should seriously consider using multipart documents.
2916 For example, scientific papers often have five major sections: the introduction
2917 , observations, results, discussion, and conclusion.
2918 Each of these could be its own separate \SpecialChar LyX
2920 \begin_inset Quotes eld
2924 \begin_inset Quotes erd
2927 file which contains the title, authors, abstract, references, etc., plus
2928 the five included files.
2929 It is important to note that each of these files is a full \SpecialChar LyX
2931 can be formatted and printed on its own, as well as included in a master
2933 Each of these files must have the same document class, however—don't attempt
2934 to mix book classes with article classes.
2935 You may also include \SpecialChar LaTeX
2936 files; however, these files must not have their own
2938 \begin_inset space \thinspace{}
2942 \begin_inset space \space{}
2945 everything up to and including the
2946 \begin_inset Flex Code
2949 \begin_layout Plain Layout
2958 \begin_inset Flex Code
2961 \begin_layout Plain Layout
2969 line must be deleted) or else errors will be generated when you try to
2973 \begin_layout Standard
2975 allows you to include files quite easily with
2976 \begin_inset Flex Noun
2979 \begin_layout Plain Layout
2980 Insert\SpecialChar menuseparator
2982 \begin_inset space ~
2991 When you click on this selection a small box is inserted into the file
2992 at the current cursor location.
2993 Clicking on the box raises a dialog which allows you to select the file
2994 to be included, and the method of its inclusion.
2998 \begin_layout Standard
2999 The file selection box should by now be obvious.
3000 The three inclusion methods are
3001 \begin_inset Quotes eld
3005 \begin_inset Quotes erd
3009 \begin_inset Quotes eld
3013 \begin_inset Quotes erd
3017 \begin_inset Quotes eld
3021 \begin_inset Quotes erd
3025 The difference between
3026 \begin_inset Quotes eld
3030 \begin_inset Quotes erd
3034 \begin_inset Quotes eld
3038 \begin_inset Quotes erd
3041 is really only meaningful to \SpecialChar LaTeX
3042 perts, but the practical difference is that
3044 \begin_inset Quotes eld
3048 \begin_inset Quotes erd
3051 are typeset beginning on a new page, while files that are
3052 \begin_inset Quotes eld
3056 \begin_inset Quotes erd
3059 are typeset starting on the current page.
3062 \begin_layout Standard
3063 Generally, the master file is converted into a full \SpecialChar LaTeX
3064 file before typesetting,
3065 while the included files are converted to \SpecialChar LaTeX
3066 files that do not have all the
3067 preamble information.
3070 \begin_layout Standard
3072 \begin_inset Quotes eld
3076 \begin_inset Quotes erd
3079 included file allows you to include a file typeset exactly as it appears
3081 \begin_inset space \thinspace{}
3085 \begin_inset space \space{}
3089 \begin_inset Flex Code
3092 \begin_layout Plain Layout
3098 mode, with the characters set in a fixed-width typewriter font.
3099 Normally, spaces in this file are invisible, though two consecutive spaces
3100 are conserved, unlike \SpecialChar LyX
3101 's normal treatment of spaces.
3102 However, setting the
3103 \begin_inset Flex Noun
3106 \begin_layout Plain Layout
3108 \begin_inset space ~
3112 \begin_inset space ~
3116 \begin_inset space ~
3124 checkbox typesets a mark to unambiguously define the presence of a space.
3128 \begin_layout Subsection
3129 Cross-References Between Files
3132 \begin_layout Standard
3133 \begin_inset Box Shadowbox
3143 height_special "totalheight"
3148 backgroundcolor "none"
3151 \begin_layout Plain Layout
3152 This section is somewhat out of date.
3153 Need to describe default master documents and how children are opened when
3163 \begin_layout Standard
3164 It is possible to set up cross-references between the different files.
3165 First, open all the files in question: let's call them A and B in a two
3166 file example, where B is included in A.
3167 Let's say you insert a label in A, then want to reference it in B.
3168 Open the cross-reference dialog whilst in document B, and you can select
3170 \begin_inset Quotes eld
3174 \begin_inset Quotes erd
3180 \begin_layout Subsection
3181 Bibliography Lists in all Subdocuments
3184 \begin_layout Standard
3185 \begin_inset Box Frameless
3195 height_special "totalheight"
3200 backgroundcolor "none"
3203 \begin_layout Plain Layout
3204 This section also needs updating.
3205 There is now material about this on the wiki, and it could be copied here.
3213 \begin_layout Standard
3214 Copy the bibliography list with all entries to all subdocuments and transform
3216 This way \SpecialChar LyX
3218 \begin_inset Flex Code
3221 \begin_layout Plain Layout
3227 -files and you can easily insert references without making the bibliography
3231 \begin_layout Standard
3232 As the bibliography list is in a comment, \SpecialChar LaTeX
3233 won't use it and the references
3234 will look like this: [?], instead of like this: [1].
3235 One solution is to use the \SpecialChar LaTeX
3237 \begin_inset Flex Code
3240 \begin_layout Plain Layout
3246 that will only include comments by processing the files separately.
3247 To do this, add in the \SpecialChar LaTeX
3248 preamble of every subdocument the following:
3251 \begin_layout LyX-Code
3257 \begin_layout LyX-Code
3260 includecomment{comment}
3263 \begin_layout Standard
3265 \begin_inset Flex URL
3268 \begin_layout Plain Layout
3270 http://wiki.lyx.org/FAQ/Unsorted#toc31
3278 \begin_layout Section
3283 \begin_layout Standard
3284 Users sometimes need to be able to
3285 \begin_inset Quotes eld
3289 \begin_inset Quotes erd
3293 file together with all the images (and other files) on which it depends,
3294 either for sending to a publisher or for sharing with a co-author.
3296 2.0 includes a Python script (
3297 \begin_inset Flex Code
3300 \begin_layout Plain Layout
3306 ) that automates this process.
3307 To use it, you must have either the
3308 \begin_inset Flex Code
3311 \begin_layout Plain Layout
3318 \begin_inset Flex Code
3321 \begin_layout Plain Layout
3327 python modules installed on your system.
3328 By default, the script prefers the
3329 \begin_inset Flex Code
3332 \begin_layout Plain Layout
3339 \begin_inset Flex Code
3342 \begin_layout Plain Layout
3348 format on Unix-like systems and the
3349 \begin_inset Flex Code
3352 \begin_layout Plain Layout
3361 \begin_layout Standard
3363 's configuration process will set the script up to export a `\SpecialChar LyX
3365 and this format will then be available under
3366 \begin_inset Flex Code
3369 \begin_layout Plain Layout
3370 File\SpecialChar menuseparator
3379 \begin_layout Standard
3380 Independently of the platform, the generation of a particular archive format
3381 can be forced by adding either the
3382 \begin_inset Flex Code
3385 \begin_layout Plain Layout
3392 \begin_inset Flex Code
3395 \begin_layout Plain Layout
3402 \begin_inset Flex Code
3405 \begin_layout Plain Layout
3412 \begin_inset Flex Code
3415 \begin_layout Plain Layout
3421 format) switch to the
3422 \begin_inset Flex Code
3425 \begin_layout Plain Layout
3427 \SpecialChar menuseparator
3435 \begin_inset Flex Code
3438 \begin_layout Plain Layout
3439 Tools\SpecialChar menuseparator
3440 Preferences\SpecialChar menuseparator
3441 File Handling\SpecialChar menuseparator
3448 (Make sure you add the switch after the script name, not before it.)
3451 \begin_layout Section
3452 Fancy Headers and Footers
3455 \begin_layout Standard
3456 The default page layout is rather plain; for an
3457 \begin_inset Flex Code
3460 \begin_layout Plain Layout
3466 document class, all you get is a centered page number at the bottom of
3468 This document uses KOMA-script's book class, so it appears to be a bit
3470 But to really put on a show, you need to set the document page style to
3472 \begin_inset Quotes eld
3476 \begin_inset Quotes erd
3479 , as mentioned in the
3484 This section describes the \SpecialChar LaTeX
3485 code you need to insert in your \SpecialChar LaTeX
3487 order to get the desired effects.
3490 \begin_layout Standard
3491 For more information on fancy headers, see the
3492 \begin_inset Flex Code
3495 \begin_layout Plain Layout
3501 package documentation.
3503 \begin_inset Flex URL
3506 \begin_layout Plain Layout
3508 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3516 \begin_layout Standard
3517 The page header is divided into three fields, not surprisingly labeled
3518 \begin_inset Quotes eld
3522 \begin_inset Quotes erd
3526 \begin_inset Quotes eld
3530 \begin_inset Quotes erd
3534 \begin_inset Quotes eld
3538 \begin_inset Quotes erd
3542 The footer is also divided into these three fields.
3543 The \SpecialChar LaTeX
3544 commands to set these fields in the simplest manner are
3545 \begin_inset Flex Code
3548 \begin_layout Plain Layout
3557 \begin_inset Flex Code
3560 \begin_layout Plain Layout
3569 \begin_inset Flex Code
3572 \begin_layout Plain Layout
3581 \begin_inset Flex Code
3584 \begin_layout Plain Layout
3593 Suppose you wish to put your name in the upper left hand corner of each
3595 Simply insert the following command in the preamble:
3598 \begin_layout Standard
3607 \begin_layout Standard
3608 You will now see your name in the upper left.
3609 If a field has a default entry that you would like to get rid of (often
3610 the page number appears in the central footer) simply include a command
3611 with a blank argument, e.
3612 \begin_inset space \thinspace{}
3618 \begin_layout Standard
3626 \begin_layout Standard
3627 Let's get really fancy: lets put the section number with the word
3628 \begin_inset Quotes eld
3632 \begin_inset Quotes erd
3636 \begin_inset space \thinspace{}
3640 \begin_inset space \space{}
3643 Section 3) in the upper left, the page number (e.
3644 \begin_inset space \thinspace{}
3648 \begin_inset space \space{}
3651 Page 4) in the upper right, your name in the lower left, and the date in
3653 The following commands should now appear in the preamble:
3656 \begin_layout Standard
3666 \begin_layout Standard
3674 \begin_layout Standard
3684 \begin_layout Standard
3693 \begin_layout Standard
3701 \begin_layout Standard
3711 \begin_layout Standard
3713 \begin_inset Flex Code
3716 \begin_layout Plain Layout
3725 \begin_inset Flex Code
3728 \begin_layout Plain Layout
3736 access \SpecialChar LaTeX
3737 's section and page counters, and so print out the current section
3740 \begin_inset Flex Code
3743 \begin_layout Plain Layout
3751 simply prints out today's date.
3754 \begin_layout Standard
3755 The thicknesses of the horizontal rules drawn beneath the header and above
3756 the footer can also be modified.
3757 If you don't want one of the rules, set its thickness to 0.
3758 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3764 \begin_inset Flex Code
3767 \begin_layout Plain Layout
3772 headrulewidth}{0.4pt}
3778 \begin_inset Flex Code
3781 \begin_layout Plain Layout
3786 footrulewidth}{0.4pt}
3791 to set the thicknesses.
3794 \begin_layout Standard
3795 You can switch the header/footer settings on and off for individual pages
3797 \begin_inset Flex Code
3800 \begin_layout Plain Layout
3803 thispagestyle{empty}
3809 \begin_inset Flex Code
3812 \begin_layout Plain Layout
3815 thispagestyle{plain}
3821 \begin_inset Flex Code
3824 \begin_layout Plain Layout
3827 thispagestyle{fancy}
3833 Simply insert them in the text on the page you want changed and mark them
3836 In fact, title pages are marked as plain by default, while following pages
3837 are marked fancy when using the global fancy setting.
3840 \begin_layout Standard
3841 As a final example, it is possible to include an image in the header or
3843 Suppose you want to put a company logo in the upper lefthand corner.
3844 You might try something like
3847 \begin_layout Standard
3856 includegraphics{logo.eps}}}
3859 \begin_layout Standard
3861 (you may need to preface this with
3862 \begin_inset Flex Code
3865 \begin_layout Plain Layout
3869 usepackage{graphics}
3874 if you don't include graphics elsewhere in your document).
3877 \begin_layout Section
3878 Itemize Bullet Selection
3879 \begin_inset CommandInset label
3888 \begin_layout Standard
3894 \begin_layout Subsection
3898 \begin_layout Standard
3900 provides 216 bullet shapes that can be accessed from a simple dialog.
3901 Using this dialog you can easily specify what bullet shape to use at each
3902 level of an itemized list.
3903 These settings are document-wide so you won't be able to specify different
3904 sets of bullets for different paragraphs.
3908 \begin_layout Plain Layout
3909 Well, actually you can but you'll have to do it by hand.
3917 \begin_layout Subsection
3921 \begin_layout Standard
3922 Open the dialog by selecting the
3923 \begin_inset Flex Noun
3926 \begin_layout Plain Layout
3927 Document\SpecialChar menuseparator
3933 menu item and then select the
3934 \begin_inset Flex Noun
3937 \begin_layout Plain Layout
3946 \begin_layout Standard
3947 The dialog provides you with a table of bullet shapes.
3948 A column of buttons on the left of the table provides access to the six
3949 different panels of bullet shapes.
3950 The row of buttons across the top is used to select which bullet depth
3952 A text entry under the table shows the currently selected bullet shape's
3954 equivalent and this can be edited if desired.
3955 If you do modify the text you will also need to specify any needed packages
3956 in the \SpecialChar LaTeX
3960 \begin_layout Standard
3961 The six panels are divided up by the packages they require.
3962 The following table shows the mappings from button name to \SpecialChar LaTeX
3964 \begin_inset Separator parbreak
3970 \begin_layout Standard
3972 \begin_inset Tabular
3973 <lyxtabular version="3" rows="7" columns="2">
3974 <features tabularvalignment="middle">
3975 <column alignment="center" valignment="top" width="0pt">
3976 <column alignment="center" valignment="top" width="0pt">
3978 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3981 \begin_layout Plain Layout
3996 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3999 \begin_layout Plain Layout
4016 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4019 \begin_layout Plain Layout
4034 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4037 \begin_layout Plain Layout
4046 base \SpecialChar LaTeX
4054 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4057 \begin_layout Plain Layout
4072 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4075 \begin_layout Plain Layout
4092 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4095 \begin_layout Plain Layout
4110 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4113 \begin_layout Plain Layout
4130 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4133 \begin_layout Plain Layout
4148 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4151 \begin_layout Plain Layout
4168 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4171 \begin_layout Plain Layout
4186 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4189 \begin_layout Plain Layout
4206 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4209 \begin_layout Plain Layout
4224 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4227 \begin_layout Plain Layout
4250 \begin_layout Standard
4252 doesn't stop you using bullets from packages you don't have.
4253 If you get errors from \SpecialChar LaTeX
4254 when you try to view or print the file, then it
4255 is likely you are missing a package.
4259 \begin_layout Plain Layout
4261 doesn't restrict your use since you may be editing locally and exporting
4270 \begin_layout Subsection
4274 \begin_layout Standard
4275 Select which bullet depth you want to change then select the bullet shape
4277 Any changes will not be visible in \SpecialChar LyX
4278 , but are visible when viewing the document.
4281 \begin_layout Standard
4282 You can reset a bullet shape to the default simply by clicking your right
4283 mouse button on the appropriate bullet depth button.
4287 \begin_layout Plain Layout
4292 want to have multiple sets of paragraphs with different sets of bullets
4293 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4295 The bullet selection dialog can help though because it provides you with
4296 the \SpecialChar LaTeX
4297 code for a wide range of bullet shapes.
4298 To make your own custom paragraphs you have the following options:
4301 \begin_layout Plain Layout
4305 \begin_layout Plain Layout
4321 \begin_layout Plain Layout
4325 \begin_layout Plain Layout
4347 \begin_layout Itemize
4348 Use the \SpecialChar LaTeX
4350 \begin_inset Flex Code
4353 \begin_layout Plain Layout
4361 to specify a new bullet shape for a given depth.
4362 You'll also need to save the current bullet shape so you can restore it
4364 In this itemized list the following \SpecialChar LaTeX
4365 code was used to change the bullet
4366 used for the first depth.
4367 \begin_inset Separator parbreak
4374 \begin_layout LyX-Code
4384 \begin_layout LyX-Code
4401 \begin_layout Itemize
4402 Note that the itemize depth is specified in Roman numerals as part of the
4412 \begin_layout Itemize
4416 \begin_layout Plain Layout
4429 Specify each individual entry by starting each item with the bullet shape
4430 enclosed in square brackets and set as
4431 \begin_inset Flex Noun
4434 \begin_layout Plain Layout
4442 For example, this item was started with
4443 \begin_inset Flex Code
4446 \begin_layout Plain Layout
4461 \begin_layout Plain Layout
4465 \begin_layout Plain Layout
4481 \begin_layout Plain Layout
4482 You'll also need to revert the labelitem back to its previous setting for
4483 the global bullet shape settings to remain in effect.
4484 The way used here was:
4487 \begin_layout LyX-Code
4502 \begin_layout Chapter
4504 and the World Wide Web
4507 \begin_layout Standard
4509 has long supported the export of documents to various web-friendly formats,
4511 Before verson 2.0, however, HTML export was always accomplished by the use
4512 of external converters.
4516 \begin_layout Plain Layout
4517 For details on the use of external converters with \SpecialChar LyX
4522 section of the Customization manual.
4527 These fall into two large groups: there are converters that use \SpecialChar LaTeX
4529 intermediate format, such as
4530 \begin_inset Flex Code
4533 \begin_layout Plain Layout
4540 \begin_inset Flex Code
4543 \begin_layout Plain Layout
4550 \begin_inset Flex Code
4553 \begin_layout Plain Layout
4559 , relying upon \SpecialChar LyX
4560 to produce the \SpecialChar LaTeX
4561 ; and there is a converter that works directly
4564 \begin_inset Flex Code
4567 \begin_layout Plain Layout
4575 All of these have different advantages and disadvantages.
4579 \begin_layout Standard
4580 The \SpecialChar LaTeX
4581 -based converters have the advantage that, in principle, they know everythin
4582 g about the exported document that \SpecialChar LaTeX
4584 Such converters do not care, for example, if a certain block of code was
4585 produced by \SpecialChar LyX
4586 or was Evil Red Text.
4587 These converters know about
4588 \begin_inset Flex Code
4591 \begin_layout Plain Layout
4597 files, counters, and references, and can often make use of the
4598 \begin_inset Flex Code
4601 \begin_layout Plain Layout
4607 files generated by Bib\SpecialChar TeX
4609 On the other hand, \SpecialChar LaTeX
4610 is a very hard language to parse—it is sometimes said
4611 that only \SpecialChar TeX
4612 itself understands \SpecialChar TeX
4613 —and \SpecialChar LaTeX
4614 -based converters will often choke on
4615 what seem to be quite simple constructs; complex ones can throw them completely
4616 , and as of this writing, for example, the
4620 manual will not export with
4621 \begin_inset Flex Code
4624 \begin_layout Plain Layout
4630 , though the others will.
4631 The other issue concerns how math is handled.
4632 These converters typically convert the formulae into little pictures that
4633 are then linked from the HTML document.
4634 Since these are actually generated by \SpecialChar LaTeX
4635 , they are accurate.
4636 But they do not scale well, and just getting them to look as if they are
4637 actually meant to be in your document—so that the font sizes seem to be
4638 roughly the same—can be a challenge.
4641 \begin_layout Standard
4643 \begin_inset Flex Code
4646 \begin_layout Plain Layout
4654 \begin_inset CommandInset href
4656 name "http://elyxer.nongnu.org/"
4657 target "http://elyxer.nongnu.org/"
4661 ) solves some of these problems.
4662 In particular, the formulae it produces scale perfectly, since it renders
4663 math using a combination of HTML and CSS rather than converting the formulae
4665 But even moderately complex formula are rendered less well than with
4666 \begin_inset Flex Code
4669 \begin_layout Plain Layout
4675 ; this reflects the limitations of HTML.
4679 \begin_layout Plain Layout
4681 \begin_inset Flex Code
4684 \begin_layout Plain Layout
4691 can also use jsMath and MathJax for equations, but this setting is only
4692 available globally and requires one to have access to a server that runs
4698 More importantly (as of version 1.1.1, at least),
4699 \begin_inset Flex Code
4702 \begin_layout Plain Layout
4709 has limited support for math macros and no support for user-defined paragraph
4710 or character styles.
4711 These limitations make
4712 \begin_inset Flex Code
4715 \begin_layout Plain Layout
4722 unsuitable for many of the documents \SpecialChar LyX
4724 In principle, of course, these problems could be solved, but the \SpecialChar LyX
4726 have decided to follow a different path and have made \SpecialChar LyX
4728 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
4729 , DocBook, and plaintext.
4732 \begin_layout Standard
4733 As of this writing, XHTML output remains under development and should probably
4735 \begin_inset Quotes eld
4739 \begin_inset Quotes erd
4746 \begin_layout Plain Layout
4748 \begin_inset Flex Code
4751 \begin_layout Plain Layout
4752 development/HTML.notes
4757 , which can be found in the \SpecialChar LyX
4759 \begin_inset CommandInset href
4761 name "accessed online"
4762 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
4766 , usually contains up-to-date information about the state of XHTML output.
4767 See also the list of XHTML bugs on
4768 \begin_inset CommandInset href
4770 name "the bug tracker"
4771 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"
4780 Still, the developers have chosen this approach because it has several
4781 potential advantages over the other two.
4784 \begin_layout Standard
4785 These advantages are primarily due to the fact that the XHTML output routines,
4786 since they are part of \SpecialChar LyX
4787 , know everything \SpecialChar LyX
4788 knows about the document being
4793 \begin_layout Plain Layout
4794 Another advantage is that, since these routines are internal to \SpecialChar LyX
4796 immune to changes in \SpecialChar LyX
4797 's file format, or to changes in the semantics of
4803 So they know about the table of contents (as displayed in the outline),
4804 about the counters associated with different paragraph styles, and about
4805 user-defined styles.
4806 The XHTML output routines know what \SpecialChar LyX
4807 knows about internationalization,
4808 too, so they will output
4809 \begin_inset Quotes eld
4813 \begin_inset Quotes erd
4817 \begin_inset Quotes eld
4825 \begin_inset Quotes erd
4828 , depending upon the language in effect at the time.
4832 \begin_layout Standard
4833 Quite generally, the output routines know what \SpecialChar LyX
4834 knows about document layout,
4835 that is, about how the document is to be rendered on screen.
4836 We use this information when we output the document as XHTML.
4837 In particular, \SpecialChar LyX
4842 generates CSS style information corresponding to the layout information
4843 it uses to render the document on screen: if section headings are supposed
4844 to be sans-serif and bold as seen in \SpecialChar LyX
4845 , then (by default) they will be sans-seri
4846 f and bold when viewed in a web browser, too.
4847 And this is true not just for pre-defined styles, like Section, but for
4848 any style, including user-defined styles.
4849 Indeed, the XHTML output routines make no distinction between user-defined
4850 paragraph and character styles and \SpecialChar LyX
4851 's own pre-defined styles: in each case,
4852 everything \SpecialChar LyX
4853 knows about the styles is contained in the layout files.
4854 And much the same is true as regards pre-defined textual insets, such as
4855 footnotes, and various custom insets.
4859 \begin_layout Standard
4860 The result is that XHTML output can be customized and extended in exactly
4861 the same way \SpecialChar LaTeX
4862 output can be customized and extended: through layout files
4864 See chapter five of the
4868 manual for the details.
4871 \begin_layout Standard
4872 The remainder of this chapter contains more detailed information on XHTML
4873 output, its limitations, and ways to work around those limitations.
4876 \begin_layout Section
4877 Math Output in XHTML
4880 \begin_layout Standard
4882 offers four choices for how math is rendered.
4883 These have various advantages and disadvantages:
4886 \begin_layout Itemize
4888 \begin_inset Newline newline
4891 MathML is a dialect of XML designed specifically for mathematics on the
4892 web, and it typically renders very well in browsers that support it.
4893 The disadvantage is that not all browsers support MathML, and support is
4894 not complete even in the Gecko-based browsers, such as Firefox.
4895 \begin_inset Newline newline
4899 is unable to render a formula as MathML—for example, if the formula
4901 \begin_inset Flex Code
4904 \begin_layout Plain Layout
4910 package or ERT—then it will instead output the formula as an image.
4914 \begin_layout Itemize
4916 \begin_inset Newline newline
4920 \begin_inset Flex Code
4923 \begin_layout Plain Layout
4929 outputs math as HTML, styled by CSS.
4933 \begin_layout Plain Layout
4935 has borrowed some of the CSS for its HTML output from
4936 \begin_inset Flex Code
4939 \begin_layout Plain Layout
4950 For simple formulae, this can work quite well, though with more complicated
4951 formulae it tends to break down.
4952 Still, this method has the advantage that it is very widely supported and
4953 so it may be appropriate for documents that contain only a little, fairly
4955 \begin_inset Newline newline
4958 If Lyx is unable to render a formula as HTML—for example, if the formula
4960 \begin_inset Flex Code
4963 \begin_layout Plain Layout
4969 package or ERT—then it will instead output the formula as an image.
4973 \begin_layout Itemize
4975 \begin_inset Newline newline
4979 \begin_inset Flex Code
4982 \begin_layout Plain Layout
4989 will output formulae as images, the very same images, in fact, that are
4990 used for instant preview.
4994 \begin_layout Plain Layout
4995 Instant preview does
4999 have to be on for images to be output, however.
5004 The advantage to this method is that the images are simply generated by
5006 , so they are very accurate.
5007 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5008 so they do not scale terribly well, and one cannot copy them, etc.
5009 (As of this writing, there are also problems about equation numbering.
5011 \begin_inset CommandInset href
5014 target "http://www.lyx.org/trac/ticket/6894"
5019 \begin_inset Newline newline
5022 The size of the images can be controlled by setting the
5023 \begin_inset Quotes eld
5027 \begin_inset Quotes erd
5031 \begin_inset Flex Noun
5034 \begin_layout Plain Layout
5035 Document\SpecialChar menuseparator
5036 Settings\SpecialChar menuseparator
5046 \begin_layout Plain Layout
5047 For those who want to know, this controls the resolution of the image in
5048 dots per inch and is based upon a default of 75 dpi.
5054 \begin_inset Newline newline
5058 for some reason fails to create an image for a formula (e.g., if a required
5060 package is not installed), then it will fall back to outputing the raw
5065 \begin_layout Itemize
5068 \begin_inset Newline newline
5071 Finally, \SpecialChar LyX
5072 will happily output math as \SpecialChar LaTeX
5074 As well as being the output of last resort, this method can be used with
5076 \begin_inset CommandInset href
5079 target "http://www.math.union.edu/~dpvc/jsMath/"
5083 , which uses JavaScript to render \SpecialChar LaTeX
5084 embedded in HTML documents.
5086 wraps the \SpecialChar LaTeX
5088 \begin_inset Flex Code
5091 \begin_layout Plain Layout
5097 (for inline formulas) or
5098 \begin_inset Flex Code
5101 \begin_layout Plain Layout
5107 (for displayed formulas) with
5108 \begin_inset Flex Code
5111 \begin_layout Plain Layout
5117 , as is required for jsMath.
5120 \begin_layout Standard
5121 One of these output methods must be selected under
5122 \begin_inset Flex Noun
5125 \begin_layout Plain Layout
5126 Document\SpecialChar menuseparator
5127 Settings\SpecialChar menuseparator
5134 By default, \SpecialChar LyX
5136 This is a document-wide setting, therefore.
5139 \begin_layout Standard
5140 Eventually, \SpecialChar LyX
5141 will offer the user the option to select an alternate output
5142 method for a particular inset, say, one that isn't being rendered very
5147 \begin_layout Plain Layout
5148 That said, since \SpecialChar LyX
5149 falls back to images if the inset contains ERT, then one
5150 can force output as an image by putting some harmless ERT into the math,
5152 \begin_inset Formula $a=b\relax$
5163 \begin_layout Section
5164 Bibliography and Citations
5167 \begin_layout Standard
5168 XHTML output fully supports bibliographies and citations.
5172 \begin_layout Standard
5173 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5175 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5178 If you are using numerical citations, then \SpecialChar LyX
5179 will output numerical labels,
5180 such as [1] or [17], rather than simply showing the citation key in square
5181 brackets, as it does on-screen.
5182 If you are using author-year citations, then \SpecialChar LyX
5183 will add lowercase letters
5184 to the years, just as Bib\SpecialChar TeX
5185 does, if it finds more than one citation for
5186 a given author-year combination.
5187 The labels will be printed with the bibliography entries.
5188 Note that there is, at present, no way to customize the appearance of the
5189 labels, for example, to choose between square brackets and parentheses.
5192 \begin_layout Standard
5193 Bibliography output is handled by the same machinery that handles the presentati
5194 on of reference information in the citation dialog, so you will see in the
5195 XHTML output pretty much what you would see if you were to look at a given
5196 entry in the citation dialog.
5197 The formatting can be customized in your layout file or, preferably, in
5203 manual for the details.
5206 \begin_layout Standard
5207 The main defect at present is that cross-referenced information is printed
5208 with every entry with which it is associated.
5209 So you can see things like this:
5214 \begin_inset Quotes eld
5217 Context and Logical Form
5218 \begin_inset Quotes erd
5223 Language in Context: Selected Essays
5225 (Oxford: Oxford University Press, 2007), pp.
5231 \begin_inset Quotes eld
5234 Semantics in Context
5235 \begin_inset Quotes erd
5240 Language in Context: Selected Essays
5242 (Oxford: Oxford University Press, 2007), pp.
5246 \begin_layout Standard
5247 This should be fixed before long.
5250 \begin_layout Standard
5251 There is no support at present for sectioned bibliographies.
5252 If you have multiple bibliographies, then \SpecialChar LyX
5253 will print the same bibliography
5257 \begin_layout Section
5261 \begin_layout Standard
5263 will happily export indexes as XHTML, but with certain limitations at the
5267 \begin_layout Standard
5268 Index export will be most reliable when you do not attempt to use the fancy
5269 constructs that are described in the section on indexes in the
5277 \begin_layout Plain Layout
5278 The main issue here is that \SpecialChar LyX
5279 itself does not really handle these.
5280 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5286 We'll describe how they are handled using the subsection headings from
5290 \begin_layout Itemize
5291 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5292 makes an effort to support these,
5293 but the entries must be separated by
5294 \begin_inset Quotes eld
5298 \begin_inset Quotes erd
5301 , that is, there must be spaces around the exclamation point.
5302 This is because it is otherwise too difficult to check for escaped exclamation
5303 points, ones in math, and so forth.
5306 \begin_layout Itemize
5307 Page Ranges: There is no support at all for page ranges, since these make
5308 no sense with XHMTL.
5309 Instead, you will just get two index entries, one at either end.
5312 \begin_layout Itemize
5313 Cross-referencing: There is no support for cross-referencing.
5315 finds an entry containing the
5316 \begin_inset Quotes eld
5319 |see\SpecialChar ldots
5321 \begin_inset Quotes erd
5324 construct, it is just dropped, and the rest is treated as an ordinary index
5328 \begin_layout Itemize
5329 Index Entry Order: \SpecialChar LyX
5330 does support attempts to fix the sorting order.
5331 It will take what is before the first `@' it finds and use that for sorting,
5332 taking what follows the first `@' to be the actual entry.
5333 At present, \SpecialChar LyX
5334 does not check for escaped `@', so do not try to index email
5338 \begin_layout Itemize
5339 Index Entry Layout: You can format entries by using the text style dialog,
5340 or by using any other method available within \SpecialChar LyX
5342 There is no support for constructs like:
5343 \begin_inset Quotes eld
5347 \begin_inset Quotes erd
5351 Indeed, if \SpecialChar LyX
5352 finds a pipe symbol, `|', in an entry, it will delete it and
5353 everything that follows it.
5356 \begin_layout Itemize
5357 Multiple Indexes: There is no support for multiple indexes.
5358 Rather, all index entries will be printed as one large index.
5359 To avoid our printing several versions of the index, we print only the
5360 main index, so make sure you have one.
5363 \begin_layout Section
5364 Nomenclature and Glossary
5367 \begin_layout Standard
5368 There is at present no support for glossaries.
5369 Adding it would be fairly trivial, and welcome.
5372 \begin_layout Chapter
5373 The \SpecialChar LyX
5377 \begin_layout Section
5381 \begin_layout Standard
5382 The `\SpecialChar LyX
5383 server' allows other programs to talk to \SpecialChar LyX
5384 , invoke \SpecialChar LyX
5385 commands, and retrieve
5386 information about the \SpecialChar LyX
5388 This is only intended for advanced users, but they should find it useful.
5389 It is by writing to the \SpecialChar LyX
5390 server, for example, that bibliography managers,
5391 such as JabRef, are able to
5392 \begin_inset Quotes eld
5396 \begin_inset Quotes erd
5399 citations to \SpecialChar LyX
5403 \begin_layout Section
5404 Starting the \SpecialChar LyX
5408 \begin_layout Standard
5409 The \SpecialChar LyX
5410 server works through the use of a pair of named pipes.
5411 These are usually located in
5412 \begin_inset Flex Code
5415 \begin_layout Plain Layout
5421 , (except on Windows, where
5425 named pipes are special objects located in
5426 \begin_inset Flex Code
5429 \begin_layout Plain Layout
5441 ) and have the names
5442 \begin_inset Quotes eld
5446 \begin_inset Flex Code
5449 \begin_layout Plain Layout
5456 \begin_inset Quotes erd
5460 \begin_inset Quotes eld
5464 \begin_inset Flex Code
5467 \begin_layout Plain Layout
5474 \begin_inset Quotes erd
5478 External programs write into
5479 \begin_inset Flex Code
5482 \begin_layout Plain Layout
5488 and read back data from
5489 \begin_inset Flex Code
5492 \begin_layout Plain Layout
5499 The stem of the pipe names can be defined in the
5500 \begin_inset Flex Noun
5503 \begin_layout Plain Layout
5504 Tools\SpecialChar menuseparator
5511 \begin_inset Flex Code
5514 \begin_layout Plain Layout
5515 "/home/myhome/lyxpipe"
5521 \begin_inset Flex Code
5524 \begin_layout Plain Layout
5538 on Windows (where any working path instead of lyxpipe can be used, for
5540 \begin_inset Flex Code
5543 \begin_layout Plain Layout
5566 configure this manually in order for the server to start.
5569 \begin_layout Standard
5572 \begin_inset Flex Code
5575 \begin_layout Plain Layout
5582 \begin_inset Flex Code
5585 \begin_layout Plain Layout
5591 ' to create the pipes.
5592 If one of the pipes already exists, \SpecialChar LyX
5593 will assume that another \SpecialChar LyX
5595 is already running and will not start the server.
5596 On POSIX (Unix like) systems, if for some other reason, an unused
5597 \begin_inset Quotes eld
5601 \begin_inset Quotes erd
5604 pipe is left in existence when \SpecialChar LyX
5605 closes, then \SpecialChar LyX
5606 will try to delete it.
5607 If this fails for some reason, you will need to delete the pipes manually
5608 and then restart \SpecialChar LyX
5610 On Windows, pipes are deleted by the OS on program termination or crash,
5612 \begin_inset Quotes eld
5616 \begin_inset Quotes erd
5619 pipes should not be possible.
5622 \begin_layout Standard
5623 To have several \SpecialChar LyX
5624 processes with servers at the same time, you have to use
5625 different configurations, perhaps by using separate user directories, each
5627 \begin_inset Flex Code
5630 \begin_layout Plain Layout
5636 file, for each process.
5639 \begin_layout Standard
5640 If you are developing a client program, you might find it useful to enable
5641 debugging information from the \SpecialChar LyX
5643 Do this by starting \SpecialChar LyX
5645 \begin_inset Flex Code
5648 \begin_layout Plain Layout
5657 \begin_layout Standard
5658 You can find a complete example client written in C++ in the source distribution
5660 \begin_inset Flex Code
5663 \begin_layout Plain Layout
5664 development/lyxserver/server_monitor.cpp
5672 \begin_layout Standard
5673 Another useful tool is the command-line based client found in
5674 \begin_inset Flex Code
5677 \begin_layout Plain Layout
5678 src/client/lyxclient
5686 \begin_layout Section
5687 Normal communication
5690 \begin_layout Standard
5691 To issue a \SpecialChar LyX
5692 call, the client writes a line of ASCII text into the input
5694 This line has the following format:
5711 \begin_layout Description
5712 clientname is a name that the client can choose arbitrarily.
5713 Its only use is that \SpecialChar LyX
5714 will echo it if it sends an answer—so a client can
5715 dispatch results from different requesters.
5718 \begin_layout Description
5719 function is the function you want \SpecialChar LyX
5721 It is the same as the commands you'd use in the minibuffer.
5724 \begin_layout Description
5725 argument is an optional argument which is meaningful only to some functions
5727 \begin_inset Quotes eld
5731 \begin_inset Quotes erd
5734 LFUN will insert the argument as text at the cursor position).
5737 \begin_layout Standard
5738 The answer from \SpecialChar LyX
5739 will arrive in the output pipe and be of the form
5756 \begin_layout Standard
5765 are just echoed from the command request, while
5769 is more or less useful information filled according to how the command
5770 execution worked out.
5771 Some commands, such as
5772 \begin_inset Quotes eld
5776 \begin_inset Quotes erd
5779 , will return information about the internal state of \SpecialChar LyX
5781 return an empty data-response.
5782 This means that the command execution went fine.
5785 \begin_layout Standard
5786 In case of errors, the response from \SpecialChar LyX
5804 \begin_layout Standard
5809 should contain an explanation of why the command failed.
5812 \begin_layout Standard
5816 \begin_layout LyX-Code
5817 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
5818 \begin_inset Newline newline
5821 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
5822 \begin_inset Newline newline
5825 read a <~/.lyxpipe.out
5826 \begin_inset Newline newline
5832 \begin_layout Subsection
5833 AppleScript (Mac OS X)
5836 \begin_layout Standard
5837 Since \SpecialChar LyX
5838 2.1, \SpecialChar LyX
5839 supports basic interactions with AppleScript for normal communicatio
5840 n through the command run.
5841 This command takes a direct argument (the
5845 to perform) and an optional argument.
5846 It either returns the output of the function or triggers an error with
5847 the error message and code.
5850 \begin_layout Standard
5854 \begin_layout LyX-Code
5855 tell application "\SpecialChar LyX
5859 \begin_layout LyX-Code
5863 \begin_layout LyX-Code
5864 -- Stores the current file name into f
5867 \begin_layout LyX-Code
5868 set f to (run "server-get-filename" with argument "")
5871 \begin_layout LyX-Code
5872 on error the error_message number the error_number
5875 \begin_layout LyX-Code
5876 display dialog "Error: " & the error_number & ".
5880 \begin_layout LyX-Code
5881 & the error_message buttons {"OK"} default button 1
5884 \begin_layout LyX-Code
5888 \begin_layout LyX-Code
5892 \begin_layout Section
5896 \begin_layout Standard
5898 can notify clients of events going on asynchronously.
5899 Currently it will only do this if the user binds a key sequence with the
5901 \begin_inset Quotes eld
5905 \begin_inset Quotes erd
5909 The format of the string \SpecialChar LyX
5910 sends is as follows:
5914 \begin_inset Flex Code
5917 \begin_layout Plain Layout
5928 \begin_layout Standard
5933 is the printed representation of the key sequence that was actually typed
5937 \begin_layout Standard
5938 This mechanism can be used to extend \SpecialChar LyX
5939 's command set and implement macros.
5940 Bind some key sequence to
5941 \begin_inset Quotes eld
5945 \begin_inset Quotes erd
5949 Then start a client that listens on the output pipe, dispatches the command
5950 according to the sequence, and starts a function that may use \SpecialChar LyX
5953 requests to issue a command or a series of commands to \SpecialChar LyX
5957 \begin_layout Section
5958 The simple \SpecialChar LyX
5962 \begin_layout Standard
5964 implements a simple protocol that can be used for session management.
5965 All messages are of the form
5978 \begin_layout Standard
5984 \begin_inset Quotes eld
5988 \begin_inset Quotes erd
5992 \begin_inset Quotes eld
5996 \begin_inset Quotes erd
6001 \begin_inset Quotes eld
6005 \begin_inset Quotes erd
6008 is received from a client, \SpecialChar LyX
6009 will report back to inform the client that
6010 it's listening to it's messages, while
6011 \begin_inset Quotes eld
6015 \begin_inset Quotes erd
6018 sent from \SpecialChar LyX
6019 will inform clients that \SpecialChar LyX
6023 \begin_layout Section
6024 Reverse DVI/PDF search
6027 \begin_layout Standard
6028 Some DVI/PDF viewers
6032 \begin_layout Plain Layout
6033 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6034 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6043 facility (also called
6048 This means that you can tell \SpecialChar LyX
6049 to put the cursor to a specific line in the
6050 document by clicking at the respective position in the DVI/PDF output.
6051 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6053 This is done via the \SpecialChar LyX
6054 server either by using the named pipe (
6058 ), or the UNIX domain socket (
6062 ) that \SpecialChar LyX
6063 creates in its temporary directory (this is the way the
6064 \begin_inset Flex Code
6067 \begin_layout Plain Layout
6073 program communicates with \SpecialChar LyX
6075 In some cases, you need a helper script that mediates between the viewer
6076 and \SpecialChar LyX
6077 , in others, the viewer can communicate with \SpecialChar LyX
6079 This depends on the selected viewer and on your operating system.
6080 The same applies to the way viewers need to be configured and the way the
6081 reverse search is actually performed.
6082 In what follows, we will thus describe how to setup reverse search for
6084 Before we turn to this, though, we will explain what needs to be done generally
6085 to enable reverse search in the DVI/PDF output.
6088 \begin_layout Subsection
6090 \begin_inset CommandInset label
6092 name "subsec:rev-search"
6099 \begin_layout Standard
6100 In most cases \SpecialChar LyX
6101 will do the work for you by enabling the option
6102 \begin_inset Flex Noun
6105 \begin_layout Plain Layout
6106 Synchronize with Output
6112 \begin_inset Flex Noun
6115 \begin_layout Plain Layout
6116 Document\SpecialChar menuseparator
6117 Settings\SpecialChar menuseparator
6124 In such a case \SpecialChar LyX
6125 will automatically insert the necessary Sync\SpecialChar TeX
6127 PDF) or load the srcltx package (for DVI) respectively.
6128 This option can be easily reached also on
6129 \begin_inset Flex Code
6132 \begin_layout Plain Layout
6141 \begin_layout Standard
6142 If you need a different setting, you can select or input a custom macro
6143 from the drop down box just below
6144 \begin_inset Flex Noun
6147 \begin_layout Plain Layout
6148 Document\SpecialChar menuseparator
6149 Settings\SpecialChar menuseparator
6150 Output\SpecialChar menuseparator
6151 Synchronize with Output
6159 \begin_layout Standard
6160 Note that the method
6161 \begin_inset Flex Code
6164 \begin_layout Plain Layout
6172 enables gzip compression.
6173 If your viewer does not support it, you should instead use
6174 \begin_inset Flex Code
6177 \begin_layout Plain Layout
6188 \begin_layout Standard
6189 Please also note that including the
6190 \begin_inset Flex Code
6193 \begin_layout Plain Layout
6200 \begin_inset Flex Code
6203 \begin_layout Plain Layout
6209 sometimes has an undesired impact on the typesetting.
6210 Thus, you should switch output synchronization off for the final typesetting
6212 \begin_inset Flex Code
6215 \begin_layout Plain Layout
6222 \begin_inset Flex Code
6225 \begin_layout Plain Layout
6235 \begin_layout Standard
6236 In case you need some more special settings that are not covered by the
6237 automatic settings, read the next section about how to set up output synchroniz
6239 If the automatic setup suits your needs, you can readily jump to section
6240 \begin_inset space ~
6244 \begin_inset CommandInset ref
6246 reference "subsec:configuring-viewers"
6250 , where the necessary configuration steps in your viewer – needed both with
6251 the automatic and the manual setup – are described.
6254 \begin_layout Subsection
6258 \begin_layout Standard
6260 provides several different methods for reverse search.
6261 Some are built-in in the
6262 \begin_inset Flex Code
6265 \begin_layout Plain Layout
6271 program, some are provided by external packages.
6272 Your choice depends on whether your \SpecialChar LaTeX
6273 distribution already provides a given
6274 method (the built-in methods are rather new) and whether your viewer can
6276 The available methods are described in the following.
6279 \begin_layout Subsubsection*
6280 Built-in DVI-search via src-specials (DVI only)
6283 \begin_layout Standard
6284 This method provides the DVI file with the necessary information for reverse
6286 It is available in \SpecialChar LaTeX
6287 since quite some time (any somewhat recent \SpecialChar LaTeX
6289 should include it), and it works reliably.
6290 To enable it, change the
6291 \begin_inset Flex Noun
6294 \begin_layout Plain Layout
6305 \begin_inset Flex Noun
6308 \begin_layout Plain Layout
6319 \begin_inset Flex Noun
6322 \begin_layout Plain Layout
6323 Preferences\SpecialChar menuseparator
6324 File Handling\SpecialChar menuseparator
6331 \begin_inset Flex Code
6334 \begin_layout Plain Layout
6335 latex -src-specials $$i
6341 If this doesn't work, check if your \SpecialChar TeX
6342 engine needs different options (the
6343 syntax might differ in some distributions).
6346 \begin_layout Subsubsection*
6347 External Packages (PDFSync and scrltx)
6350 \begin_layout Standard
6359 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6361 In order to enable it, load the packages in the \SpecialChar LyX
6365 \begin_layout Itemize
6366 \begin_inset Flex Code
6369 \begin_layout Plain Layout
6377 for reverse PDF search,
6380 \begin_layout Itemize
6381 \begin_inset Flex Code
6384 \begin_layout Plain Layout
6387 usepackage[active]{srcltx}
6392 for reverse DVI search.
6395 \begin_layout Standard
6396 If you want to be able to perform both DVI and PDF reverse searches, you
6397 can also insert in the preamble the following lines
6400 \begin_layout LyX-Code
6404 \begin_inset Newline newline
6410 \begin_inset Newline newline
6416 \begin_inset Newline newline
6422 \begin_inset Newline newline
6427 usepackage[active]{srcltx}
6428 \begin_inset Newline newline
6436 \begin_layout Standard
6437 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6438 right package will be used.
6441 \begin_layout Standard
6442 Note that PDFSync might affect the output layout of your document.
6443 It is therefore advised to disable PDFsync for final documents.
6446 \begin_layout Subsubsection*
6447 Built-in reverse search via Sync\SpecialChar TeX
6451 \begin_layout Standard
6453 \begin_inset Flex Code
6456 \begin_layout Plain Layout
6462 have built-in support for both PDF and DVI reverse search.
6465 Sync\SpecialChar TeX
6468 facility is basically the result of the integration of the PDFSync package
6469 to the pdftex program and its merge with the
6474 You need at least \SpecialChar TeX
6475 Live 2008 or a recent Mik\SpecialChar TeX
6476 distribution in order to use
6481 \begin_layout Plain Layout
6482 For some reason, Mik\SpecialChar TeX
6483 does not understand/obey the command \SpecialChar LyX
6485 the preamble when you check the "Enable Forward/Reverse Search" button
6486 in the toolbar and does not generate the necessary info.
6489 \begin_layout Plain Layout
6490 The generation of the required info can be forced by changing the converter
6492 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
6493 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
6494 the -synctex=1 switch).
6499 Also note that only a few PDF viewers (Okular and Qpdfview on Unix, Skim
6500 on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
6504 \begin_layout Standard
6505 To enable Sync\SpecialChar TeX
6506 for DVI output, change the
6507 \begin_inset Flex Noun
6510 \begin_layout Plain Layout
6521 \begin_inset Flex Noun
6524 \begin_layout Plain Layout
6535 \begin_inset Flex Noun
6538 \begin_layout Plain Layout
6539 Preferences\SpecialChar menuseparator
6540 File Handling\SpecialChar menuseparator
6547 \begin_inset Flex Code
6550 \begin_layout Plain Layout
6551 latex -synctex=1 $$i
6556 , and for PDF output, change the
6557 \begin_inset Flex Noun
6560 \begin_layout Plain Layout
6565 (pdflatex) -> PDF (pdflatex)
6571 \begin_inset Flex Code
6574 \begin_layout Plain Layout
6575 pdflatex -synctex=1 $$i
6581 Check the documentation of your viewer whether the viewer needs to be configure
6582 d for the use with Sync\SpecialChar TeX
6587 \begin_layout Plain Layout
6588 Note that the option
6589 \begin_inset Flex Code
6592 \begin_layout Plain Layout
6598 option enables gzip compression.
6599 If your viewer does not support it, you should instead use
6600 \begin_inset Flex Code
6603 \begin_layout Plain Layout
6617 \begin_layout Subsection
6618 Configuring and using specific viewers
6619 \begin_inset CommandInset label
6621 name "subsec:configuring-viewers"
6628 \begin_layout Subsubsection*
6629 Xdvi (all platforms)
6632 \begin_layout Standard
6634 \begin_inset Flex Code
6637 \begin_layout Plain Layout
6643 , you don't need to do anything else for performing a reverse DVI search,
6645 already provides the necessary hooks for automatically using the
6646 \begin_inset Flex Code
6649 \begin_layout Plain Layout
6656 Just setup your document as described above (reverse search is triggered
6657 by Ctrl-click or Alt-click on Mac OSX, respectively).
6660 \begin_layout Standard
6661 However, if for whatever reason you want to use the named pipe instead of
6662 the socket for communicating with \SpecialChar LyX
6663 , simply change the DVI viewer in
6664 \begin_inset Flex Noun
6667 \begin_layout Plain Layout
6668 Preferences\SpecialChar menuseparator
6669 File Handling\SpecialChar menuseparator
6679 \begin_layout Plain Layout
6680 On Mac OSX you have to use
6681 \begin_inset Flex Code
6684 \begin_layout Plain Layout
6685 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
6696 \begin_inset Flex Code
6699 \begin_layout Plain Layout
6700 xdvi -editor "lyxeditor.sh %f %l"
6706 \begin_inset Flex Code
6709 \begin_layout Plain Layout
6715 is a suitable script.
6716 For example, a minimal shell script is the following one:
6719 \begin_layout LyX-Code
6721 \begin_inset Newline newline
6724 LYXPIPE="/path/to/lyxpipe"
6725 \begin_inset Newline newline
6728 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
6729 \begin_inset Newline newline
6732 echo "$COMMAND" > "${LYXPIPE}".in || exit
6733 \begin_inset Newline newline
6736 read TMP < "${LYXPIPE}".out || exit
6739 \begin_layout Standard
6741 \begin_inset Flex Code
6744 \begin_layout Plain Layout
6754 \begin_layout Plain Layout
6761 XServer pipe path specified in
6762 \begin_inset Flex Noun
6765 \begin_layout Plain Layout
6766 Preferences\SpecialChar menuseparator
6776 \begin_layout Plain Layout
6778 \begin_inset Flex Code
6781 \begin_layout Plain Layout
6787 folder of a source distribution you can find a
6788 \begin_inset Flex Code
6791 \begin_layout Plain Layout
6797 script which is able to locate the
6801 based on your preferences.
6809 \begin_layout Subsubsection*
6813 \begin_layout Standard
6815 \begin_inset Flex Code
6818 \begin_layout Plain Layout
6819 /Applications/MacDviX_Folder/calleditor.script
6824 , add the following lines:
6827 \begin_layout LyX-Code
6832 \begin_layout Plain Layout
6839 X.app/Contents/MacOS/lyxeditor "$2" $1
6840 \begin_inset Newline newline
6846 \begin_layout Standard
6847 Modify the lines accordingly if you install \SpecialChar LyX
6848 somewhere else than in the
6849 Applications folder.
6852 \begin_layout Standard
6853 Reverse search is triggered by Alt-click (OPTION-click).
6856 \begin_layout Subsubsection*
6860 \begin_layout Standard
6862 \begin_inset Flex Code
6865 \begin_layout Plain Layout
6866 open -a Skim.app $$i
6871 to the viewer setting in
6872 \begin_inset Flex Noun
6875 \begin_layout Plain Layout
6876 Preferences\SpecialChar menuseparator
6877 File Handling\SpecialChar menuseparator
6878 File formats\SpecialChar menuseparator
6885 \begin_inset Flex Noun
6888 \begin_layout Plain Layout
6889 Skim\SpecialChar menuseparator
6890 Preferences\SpecialChar menuseparator
6897 \begin_inset Flex Noun
6900 \begin_layout Plain Layout
6906 preset and enter command
6907 \begin_inset Flex Noun
6910 \begin_layout Plain Layout
6911 /Applications/\SpecialChar LyX
6912 .app/Contents/MacOS/lyxeditor
6920 \begin_layout Standard
6921 Reverse search is triggered by COMMAND-SHIFT-click
6924 \begin_layout Subsubsection*
6928 \begin_layout Standard
6930 \begin_inset Flex Noun
6933 \begin_layout Plain Layout
6934 Settings\SpecialChar menuseparator
6935 Configure Okular\SpecialChar menuseparator
6942 \begin_inset Quotes eld
6946 \begin_inset Quotes erd
6950 \begin_inset Flex Code
6953 \begin_layout Plain Layout
6962 \begin_layout Standard
6963 Reverse search is triggered by SHIFT-click.
6966 \begin_layout Subsubsection*
6970 \begin_layout Standard
6971 Qpdfview supports Sync\SpecialChar TeX
6972 since version 0.3.5.
6974 \begin_inset Flex Noun
6977 \begin_layout Plain Layout
6978 Edit\SpecialChar menuseparator
6979 Settings\SpecialChar menuseparator
6985 , click on the input field of the
6986 \begin_inset Quotes eld
6990 \begin_inset Quotes erd
6993 item and add the command
6994 \begin_inset Flex Code
6997 \begin_layout Plain Layout
7006 \begin_layout Standard
7007 Reverse search is triggered by double-click.
7010 \begin_layout Subsubsection*
7014 \begin_layout Standard
7015 Launch yap, choose its
7016 \begin_inset Flex Noun
7019 \begin_layout Plain Layout
7020 View\SpecialChar menuseparator
7027 \begin_inset Quotes eld
7031 \begin_inset Quotes erd
7036 \begin_inset Quotes eld
7039 New\SpecialChar ldots
7041 \begin_inset Quotes erd
7044 button and, in the window that opens, enter
7045 \begin_inset Quotes eld
7050 \begin_inset Quotes erd
7053 (or any other name you like) in the
7054 \begin_inset Quotes eld
7058 \begin_inset Quotes erd
7062 Now click on the button labeled
7063 \begin_inset Quotes eld
7068 \begin_inset Quotes erd
7071 to open a file dialog and navigate to the directory containing the batch
7073 \begin_inset Flex Code
7076 \begin_layout Plain Layout
7084 \begin_inset Flex Code
7087 \begin_layout Plain Layout
7093 and then specify the program arguments as
7094 \begin_inset Flex Code
7097 \begin_layout Plain Layout
7105 \begin_inset Flex Code
7108 \begin_layout Plain Layout
7114 wrapper is used for communicating with \SpecialChar LyX
7122 \begin_layout LyX-Code
7124 \begin_inset Newline newline
7127 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
7136 \begin_inset Newline newline
7150 \begin_layout Standard
7151 Make sure that the \SpecialChar LyX
7152 Server pipe path you specified in \SpecialChar LyX
7154 \begin_inset Flex Code
7157 \begin_layout Plain Layout
7171 , otherwise change the
7172 \begin_inset Flex Code
7175 \begin_layout Plain Layout
7181 wrapper accordingly.
7184 \begin_layout Standard
7185 In yap, reverse search is triggered by double-click.
7188 \begin_layout Subsubsection*
7189 SumatraPDF (Windows)
7192 \begin_layout Standard
7193 In order to use SumatraPDF for inverse search, enter
7194 \begin_inset Flex Code
7197 \begin_layout Plain Layout
7198 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
7203 in the viewer setting in
7204 \begin_inset Flex Noun
7207 \begin_layout Plain Layout
7208 Preferences\SpecialChar menuseparator
7209 File Handling\SpecialChar menuseparator
7210 File formats\SpecialChar menuseparator
7217 \begin_inset Flex Code
7220 \begin_layout Plain Layout
7226 is the previous wrapper.
7227 If SumatraPDF.exe is not in your command PATH, use its full file name.
7230 \begin_layout Standard
7231 Reverse search is triggered by double-click.
7234 \begin_layout Subsubsection*
7238 \begin_layout Standard
7239 First of all, make sure that yap is your default DVI viewer in the Windows
7240 environment, then launch it, choose its
7241 \begin_inset Flex Noun
7244 \begin_layout Plain Layout
7245 View\SpecialChar menuseparator
7252 \begin_inset Quotes eld
7256 \begin_inset Quotes erd
7261 \begin_inset Quotes eld
7264 New\SpecialChar ldots
7266 \begin_inset Quotes erd
7269 button and, in the window that opens, enter
7270 \begin_inset Quotes eld
7275 \begin_inset Quotes erd
7278 (or any other name you like) in the
7279 \begin_inset Quotes eld
7283 \begin_inset Quotes erd
7287 Now click on the button labeled
7288 \begin_inset Quotes eld
7293 \begin_inset Quotes erd
7296 to open a file dialog and navigate to the directory containing the
7297 \begin_inset Flex Code
7300 \begin_layout Plain Layout
7306 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7309 \begin_inset Flex Code
7312 \begin_layout Plain Layout
7318 and then specify the program arguments as
7319 \begin_inset Flex Code
7322 \begin_layout Plain Layout
7329 In this way, you will be using the
7333 for communicating with \SpecialChar LyX
7335 If, for whatever reason, you want to use the
7340 \begin_inset Flex Code
7343 \begin_layout Plain Layout
7349 option and be sure to specify the \SpecialChar LyX
7350 Server pipe path in the \SpecialChar LyX
7354 \begin_layout Standard
7355 In yap, reverse search is triggered by double-click.
7358 \begin_layout Subsubsection*
7362 \begin_layout Standard
7363 In order to use SumatraPDF for inverse search, enter
7364 \begin_inset Flex Code
7367 \begin_layout Plain Layout
7368 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7373 in the viewer setting in
7374 \begin_inset Flex Noun
7377 \begin_layout Plain Layout
7378 Preferences\SpecialChar menuseparator
7379 File Handling\SpecialChar menuseparator
7380 File formats\SpecialChar menuseparator
7387 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7389 \begin_inset Flex Code
7392 \begin_layout Plain Layout
7398 enables communication via the
7404 \begin_inset Flex Code
7407 \begin_layout Plain Layout
7413 option if you want to use the
7417 , and be sure to specify the \SpecialChar LyX
7418 Server pipe path in the \SpecialChar LyX
7422 \begin_layout Standard
7423 Reverse search is triggered by double-click.
7426 \begin_layout Section
7430 \begin_layout Standard
7431 Forward search is, as the name implies, in a sense the
7432 \begin_inset Quotes eld
7436 \begin_inset Quotes erd
7440 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7442 If forward search is set up (as described in what follows), you can put
7443 the cursor anywhere in your \SpecialChar LyX
7445 \begin_inset Flex Noun
7448 \begin_layout Plain Layout
7449 Navigate\SpecialChar menuseparator
7456 \begin_inset Flex Noun
7459 \begin_layout Plain Layout
7465 in the context menu via right mouse click), and then the viewer will jump
7466 to that position as well.
7467 This implies, of course, that your viewer supports this function.
7470 \begin_layout Standard
7471 To make forward search possible, you first need to provide the generated
7472 output PDF/DVI file with additional information about the \SpecialChar TeX
7474 This can be done via the methods described in the section
7475 \begin_inset CommandInset ref
7477 reference "subsec:rev-search"
7484 \begin_layout Standard
7485 Additionally, you need to configure \SpecialChar LyX
7486 for using your viewers in
7487 \begin_inset Flex Noun
7490 \begin_layout Plain Layout
7491 Tools\SpecialChar menuseparator
7492 Preferences\SpecialChar menuseparator
7493 Output\SpecialChar menuseparator
7500 We provide a range of tested configurations for some viewers, which you
7501 can select from the drop down list.
7502 If none of these configurations suits you, you have to find out and enter
7503 a suitable configuration yourself.
7504 The definition syntax uses the following placeholders:
7507 \begin_layout Itemize
7509 \begin_inset Flex Code
7512 \begin_layout Plain Layout
7521 \begin_layout Itemize
7523 \begin_inset Flex Code
7526 \begin_layout Plain Layout
7532 : name of the (temporary) exported .tex file (without path)
7535 \begin_layout Itemize
7537 \begin_inset Flex Code
7540 \begin_layout Plain Layout
7546 : name of the (temporary) exported .tex file (including path)
7549 \begin_layout Itemize
7551 \begin_inset Flex Code
7554 \begin_layout Plain Layout
7560 : name of the exported output file (either dvi or pdf, depending on which
7561 one exists in the temporary directory)
7564 \begin_layout Standard
7565 Note that only some of the viewers provide full forward search functionality,
7566 among them yap, xdvi, okular
7570 \begin_layout Plain Layout
7571 You might want to set
7572 \begin_inset Flex Code
7575 \begin_layout Plain Layout
7582 \begin_inset Flex Noun
7585 \begin_layout Plain Layout
7586 Tools\SpecialChar menuseparator
7587 Preferences\SpecialChar menuseparator
7588 File Handling\SpecialChar menuseparator
7590 \begin_inset space ~
7603 , qpdfview and SumatraPDF
7607 \begin_layout Plain Layout
7608 SumatraPDF can also use DDE commands through the external program CMCDDE
7610 \begin_inset CommandInset href
7612 target "ftp://ftp2.commence.com/pub/freebies/"
7622 While many of the widespread PDF viewers (most notably Adobe Reader) do
7623 not support forward search at all, some other viewers – e.
7624 \begin_inset space \thinspace{}
7628 evince and xpdf – allow at least to reload the document and jump to a specific
7629 page of the file, so you can at least navigate
7630 \begin_inset Quotes eld
7634 \begin_inset Quotes erd
7638 This latter functionality is provided by an external call of synctex (see
7639 the predefined example configurations).
7643 \begin_layout Standard
7644 Forward search works both with DVI and PDF output.
7646 simply checks which preview format you have used before (i.
7647 \begin_inset space \thinspace{}
7650 e., which format is already there in the temporary directory) and chooses
7651 the appropriate configuration for the respective format.
7654 \begin_layout Chapter
7655 Special Document Classes
7658 \begin_layout Section
7662 \begin_layout Standard
7668 \begin_layout Subsection
7672 \begin_layout Standard
7673 This section describes how \SpecialChar LyX
7674 can be used to write articles for submission
7675 to the scientific journal
7677 Astronomy and Astrophysics
7680 \begin_inset Flex URL
7683 \begin_layout Plain Layout
7685 http://www.edpsciences.fr/aa/
7690 ) using Version 5.01 of the document class
7695 This package can be downloaded from the ftp site
7698 \begin_layout Standard
7699 \begin_inset VSpace medskip
7705 \begin_layout Standard
7707 \begin_inset Flex URL
7710 \begin_layout Plain Layout
7712 ftp://ftp.edpsciences.org/pub/aa/readme.html
7720 \begin_layout Standard
7721 \begin_inset VSpace medskip
7727 \begin_layout Standard
7728 A manual comes together with that package, and this text is not meant to
7729 replace the original manual but is merely a short guide in how to realize
7730 the correct form of your paper.
7734 \begin_layout Standard
7735 Please note that the publisher of the journal was changed from Springer
7736 to EDP Sciences starting January 1, 2001.
7737 That change involved also some slight changes to the style files, namely
7738 the removal of the thesaurus command.
7739 The \SpecialChar LyX
7740 class aa supports the newest version of these style files, V 5.01.
7741 If you have an older version installed, please upgrade.
7742 For compatibility, the old (version 4) layout has been kept as
7747 Please refer to the comments in
7750 Dir/layouts/aapaper.layout
7755 \begin_layout Subsection
7759 \begin_layout Standard
7760 It is recommended you start from the example template distributed with \SpecialChar LyX
7762 If you are not using a template, note the following settings:
7765 \begin_layout Itemize
7772 Document\SpecialChar menuseparator
7775 dialog (OK, that one was obvious).
7778 \begin_layout Itemize
7779 Don't change the option
7782 \begin_inset space ~
7792 The whole layout is done by the macros, you shouldn't change anything.
7795 \begin_layout Subsection
7799 \begin_layout Standard
7800 First thing to enter is the header information.
7801 It consists of seven entries, of which some are optional.
7805 \begin_layout Itemize
7813 \begin_layout Itemize
7821 \begin_layout Itemize
7829 \begin_layout Itemize
7837 \begin_layout Itemize
7842 : [optional] if more than one author: whom to contact for offprint requests.
7845 \begin_layout Itemize
7850 : [optional] mail address for contacts.
7853 \begin_layout Itemize
7861 Received: <date>; Accepted <date>
7864 \begin_layout Standard
7865 There is no need to issue the
7871 command, this is done automatically by \SpecialChar LyX
7872 when the header is finished.
7873 Although the order of the single header entries doesn't matter it is advised
7874 to keep the above sequence, just to get the best optics and meets the layout
7875 of the real document.
7878 \begin_layout Standard
7879 If you want to place footnotes in the header block, e.
7880 \begin_inset space \thinspace{}
7884 \begin_inset space \space{}
7887 to state your present address, just use the standard footnote via the menu
7890 Insert\SpecialChar menuseparator
7895 will automagically use the term
7904 \begin_layout Standard
7905 In addition to these topics, the macros use three additional \SpecialChar LaTeX
7907 have no counterpart in \SpecialChar LyX
7911 \begin_layout Itemize
7918 to separate different names for more than one author and institute, respectivel
7922 \begin_layout Itemize
7929 to mark corresponding author/institute pairs.
7930 The institutes are numbered sequentially as they appear in the
7934 field, so you have to put a marker to each author.
7937 \begin_layout Itemize
7944 to supply an email address for fast contact.
7947 \begin_layout Standard
7948 In all cases, the appropriate command has to be entered in \SpecialChar LyX
7956 \begin_layout Subsection
7960 \begin_layout Standard
7961 The abstract should immediately follow the header block.
7962 With version 5 the abstract environment was changed to a command, and there
7963 is now a resctriction to only one paragraph.
7964 In addition, it should contain an entry with the keywords.
7965 This is not yet implemented for \SpecialChar LyX
7966 , therefore you have to enter the \SpecialChar LaTeX
7974 by hand and mark it as \SpecialChar LaTeX
7976 Refer to the example paper.
7979 \begin_layout Subsection
7980 Supported environments
7983 \begin_layout Standard
7984 The A&A paper layout supports the following environments for structuring
7988 \begin_layout Itemize
7994 \begin_layout Itemize
8000 \begin_layout Itemize
8006 \begin_layout Itemize
8012 \begin_layout Itemize
8018 \begin_layout Itemize
8024 \begin_layout Itemize
8030 \begin_layout Itemize
8036 \begin_layout Itemize
8042 \begin_layout Itemize
8048 \begin_layout Itemize
8054 \begin_layout Itemize
8061 \begin_layout Subsection
8062 Commands not supported by \SpecialChar LyX
8066 \begin_layout Standard
8067 Some commands are not yet supported by the
8071 layout for \SpecialChar LyX
8073 Some have already been mentioned.
8074 For the sake of completeness, they are listed all together here:
8077 \begin_layout Itemize
8085 \begin_layout Itemize
8093 \begin_layout Itemize
8101 \begin_layout Itemize
8109 \begin_layout Itemize
8117 \begin_layout Itemize
8125 \begin_layout Itemize
8133 \begin_layout Itemize
8141 \begin_layout Standard
8142 If you want to use any of these commands, you have to enter them yourself.
8145 Do not forget to mark them as \SpecialChar LaTeX
8149 \begin_layout Subsection
8150 Figure and Table Floats
8153 \begin_layout Standard
8155 provides support for the necessary float environments
8157 figure, figure*, table
8163 , therefore we won't tell much about it here.
8167 \begin_inset space ~
8173 Just remember that tables should be left-aligned.
8174 For that, select the table and change the alignment in
8176 Edit\SpecialChar menuseparator
8178 \begin_inset space ~
8184 \begin_layout Standard
8185 There is only one special thing: the figures with caption besides the figure.
8186 To create such a figure, you have to do the following:
8189 \begin_layout Enumerate
8190 Create a wide figure float:
8192 Insert\SpecialChar menuseparator
8193 Float\SpecialChar menuseparator
8196 , then right click in the figure and select
8202 \begin_inset space ~
8210 \begin_layout Enumerate
8211 Enter your caption text.
8214 \begin_layout Enumerate
8219 to move the cursor above the caption.
8222 \begin_layout Enumerate
8226 \begin_layout Enumerate
8227 Position the cursor behind the figure and insert a horizontal fill:
8229 Insert\SpecialChar menuseparator
8231 \begin_inset space ~
8234 Character\SpecialChar menuseparator
8236 \begin_inset space ~
8244 \begin_layout Enumerate
8245 Switch to \SpecialChar LaTeX
8249 \begin_inset space ~
8257 \begin_layout Enumerate
8267 Do not close the brace!
8270 \begin_layout Enumerate
8271 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8276 \begin_inset space ~
8288 \begin_layout Standard
8289 Also, refer to the figures in the example paper.
8292 \begin_layout Subsection
8296 \begin_layout Standard
8297 For submission, the paper has to be formated in a special double-spacing
8299 For this purpose, you have to give the option
8303 to the documentclass.
8304 This must be done using the extra class options field in the
8306 Document\SpecialChar menuseparator
8310 Just enter the string
8317 \begin_layout Subsection
8321 \begin_layout Standard
8326 directory contains an example paper written with \SpecialChar LyX
8328 It is the example paper from the original macro package, translated to
8331 Use it for inspiration, and compare the original \SpecialChar LaTeX
8332 code with \SpecialChar LyX
8336 \begin_layout Section
8341 \begin_layout Standard
8347 \begin_layout Subsection
8351 \begin_layout Standard
8353 is a set of macros produced by the American Astronomical Society to
8354 facilitate electronic manuscript submission to the three journals they
8355 publish: the Astrophysical Journal (including the Letters and Supplement),
8356 the Astronomical Journal, and the Publications of the Astronomical Society
8359 has proven to be an excellent tool for generating these documents, especially
8360 given its equation, citation, and figure handling capabilities.
8362 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8363 is the version described here, or higher.
8364 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8365 2.09 and are fundamentally
8366 incompatible with \SpecialChar LyX
8368 The AAS\SpecialChar TeX
8369 package may be downloaded from the AAS\SpecialChar TeX
8373 \begin_layout Standard
8374 \begin_inset VSpace medskip
8380 \begin_layout Standard
8382 \begin_inset Flex URL
8385 \begin_layout Plain Layout
8387 http://www.journals.uchicago.edu/AAS/AASTeX
8395 \begin_layout Standard
8396 \begin_inset VSpace medskip
8402 \begin_layout Standard
8403 A complete user guide is contained in that package and you should familiarize
8404 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8407 will not reduce the need to figure out all the AAS\SpecialChar TeX
8408 commands, it will only
8409 reduce the drudgery of typing everything in.
8410 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8412 completely to the requirements of the journal to which you are submitting
8416 \begin_layout Subsection
8417 Starting a New Paper
8420 \begin_layout Standard
8421 I strongly suggest that you start with the AAS\SpecialChar TeX
8425 File\SpecialChar menuseparator
8432 , enter the new file name, then choose the
8437 This will show the most common fields found in a manuscript.
8438 Simply overwrite the existing text (including the brackets,
8442 ) with the correct information.
8443 Many of the AAS\SpecialChar TeX
8444 commands and environments can be implemented directly in
8446 , but some cannot: most noticeably
8458 , which should stick out like a sore thumb if you actually just opened the
8460 For commands such as these, the \SpecialChar LaTeX
8461 code must be entered directly and marked
8463 Such commands are referred to as \SpecialChar TeX
8464 code, or Evil Red Text.
8465 I tried to minimize the amount of \SpecialChar TeX
8466 code needed in an AAS\SpecialChar TeX
8468 there is still a bit more required than any of us would like.
8471 \begin_layout Subsection
8472 Finishing Your Paper
8475 \begin_layout Standard
8476 When the paper is finished to your satisfaction and previews/prints correctly,
8478 \begin_inset Quotes eld
8482 \begin_inset Quotes erd
8485 actions which need to be done before you submit it to the journals.
8489 \begin_layout Enumerate
8490 Export your paper as a \SpecialChar LaTeX
8493 File\SpecialChar menuseparator
8494 Export\SpecialChar menuseparator
8502 \begin_layout Enumerate
8507 file with your favorite text editor
8508 \begin_inset Separator parbreak
8515 \begin_layout Enumerate
8516 remove the comment lines before the
8525 \begin_layout Enumerate
8530 usepackage...{fontenc}
8532 line if it appears (usually just after
8547 \begin_layout Enumerate
8548 remove everything between (and including) the
8560 commands, except for any commands you specifically put into the \SpecialChar LaTeX
8562 (which should appear immediately after the
8563 \begin_inset Quotes eld
8566 User specified \SpecialChar LaTeX
8568 \begin_inset Quotes erd
8579 \begin_layout Enumerate
8580 Run the resulting file through \SpecialChar LaTeX
8581 to make sure it still processes correctly.
8584 \begin_layout Enumerate
8585 Reread the journal requirements to make sure your filenames and formats
8589 \begin_layout Enumerate
8593 \begin_layout Subsection
8594 Comments On Specific Commands
8597 \begin_layout Standard
8598 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8605 ) gives a good description of each.
8606 Thus it's probably easiest for me to go down the list as found in the guide
8607 and offer comments where necessary.
8608 So let's begin \SpecialChar ldots
8612 \begin_layout Subsubsection
8613 Things that work as expected
8616 \begin_layout Standard
8617 Because they work as you might expect, I simply list them and the section
8718 begin{thebibliography}
8726 (2.13.2), all the cite commands and their variations (2.13.2), the generic
8727 graphicx figure commands (2.14.1),
8751 (2.15.4, amongst other places),
8778 \begin_layout Standard
8779 The following style options also work correctly:
8800 Simply put them in the
8806 Layout\SpecialChar menuseparator
8812 \begin_layout Subsubsection
8813 Things that work, but require more comment
8816 \begin_layout Standard
8817 The following items work, but require a little more discussion:
8820 \begin_layout Itemize
8821 These items are reserved for use by the journal editors, but you can put
8822 them into the \SpecialChar LaTeX
8823 preamble if you feel compelled to do so:
8856 \begin_layout Itemize
8857 These items may be placed in the \SpecialChar LaTeX
8858 preamble, and are included as blanks in
8880 \begin_layout Itemize
8887 (2.3) – can only be used
8888 \begin_inset Quotes eld
8892 \begin_inset Quotes erd
8895 , not in the middle of a paragraph.
8896 Use \SpecialChar TeX
8897 code if you need to embed it.
8900 \begin_layout Itemize
8907 (2.3) – will have extra {} after it.
8908 This should not cause an error.
8911 \begin_layout Itemize
8918 (2.6) – can only be used
8919 \begin_inset Quotes eld
8923 \begin_inset Quotes erd
8926 , not in the middle of a paragraph.
8927 Use \SpecialChar TeX
8928 code if you need to embed it.
8931 \begin_layout Itemize
8938 (2.8) – can't insert a cross-reference tag, you must type the tag name by
8942 \begin_layout Itemize
8956 \begin_layout Itemize
8963 (2.9) – will have extra {} after it.
8964 This should not cause an error.
8967 \begin_layout Itemize
8974 (2.11) – will have extra {} after it.
8975 This should not cause an error.
8978 \begin_layout Itemize
8985 (2.14.2) – you can insert an optional filename argument by placing the cursor
8986 at the beginning of the text and selecting
8988 Insert\SpecialChar menuseparator
8993 \begin_inset Quotes eld
8997 \begin_inset Quotes erd
9000 inserts an optional argument of the type needed by
9007 Hopefully it will be renamed someday.
9010 \begin_layout Itemize
9023 for the catalog ID optional parameter
9026 \begin_layout Itemize
9039 for the catalog ID optional parameter
9042 \begin_layout Subsubsection
9043 Things not implemented, use \SpecialChar TeX
9047 \begin_layout Standard
9070 setcounter{equation}
9072 (2.12), Journal name abbreviations (2.13.4),
9108 (2.15.4, insert it as the first element in the lefthand cell after where
9110 Don't use any of \SpecialChar LyX
9111 's rules in the table),
9123 (2.15.5), much of Misc (2.17, except
9174 \begin_layout Subsubsection
9175 Things that cannot be implemented
9178 \begin_layout Standard
9180 at least in any meaningful sort of way, so I suggest ignoring them.
9181 They are the references environment (2.13.3), and the deluxetable environment
9183 If you really, really need to use deluxetable, I suggest editing it in
9184 a separate file with a text editor, then using
9186 Insert\SpecialChar menuseparator
9188 \begin_inset space ~
9193 to include it in your \SpecialChar LyX
9199 file to see an example of this.
9202 \begin_layout Subsection
9203 FAQs, Tips, Tricks, and Other Ruminations
9206 \begin_layout Subsubsection
9207 Getting \SpecialChar LyX
9208 and AAS\SpecialChar TeX
9212 \begin_layout Standard
9213 It can be a bit tricky to get \SpecialChar LyX
9214 to recognize a new layout and document class.
9215 When all else fails, do this:
9218 \begin_layout Enumerate
9219 Make certain that \SpecialChar LaTeX
9220 can find AAS\SpecialChar TeX
9222 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9224 directory completely unrelated to \SpecialChar LaTeX
9225 or AAS\SpecialChar TeX
9226 and run \SpecialChar LaTeX
9234 \begin_layout Enumerate
9239 appears in \SpecialChar LyX
9247 \begin_layout Enumerate
9250 Tools\SpecialChar menuseparator
9254 , then restart \SpecialChar LyX
9258 \begin_layout Enumerate
9259 Open a regular new file, not from a template.
9260 Does AAS\SpecialChar TeX
9261 appear in the class list in
9263 Document\SpecialChar menuseparator
9269 \begin_layout Standard
9270 If you get a warning from an existing AAS\SpecialChar TeX
9271 document about not being able
9272 to find the AAS\SpecialChar TeX
9273 layout or a message about
9274 \begin_inset Quotes eld
9277 You should not mix title layouts with normal ones
9278 \begin_inset Quotes erd
9281 , things haven't been installed correctly.
9284 \begin_layout Subsubsection
9286 error processing a table
9289 \begin_layout Standard
9291 , by default, attempts to center the table caption/title.
9292 This seems to produce a bad interaction in AAS\SpecialChar TeX
9293 so you should click somewhere
9294 in the caption/title, then select
9296 Edit\SpecialChar menuseparator
9298 \begin_inset space ~
9312 This took care of it for me.
9315 \begin_layout Subsubsection
9319 \begin_layout Standard
9320 A couple of things: 1) I have noticed some funny spacing in the reference
9321 entries in the text.
9322 When you enter the bibliography item data, make sure their is
9326 space between the last author and the parenthesis setting off the year;
9330 \begin_inset space \thinspace{}
9334 \begin_inset space \space{}
9348 2) Entering the references at all is not obvious.
9349 The easiest thing is to start typing your first reference at the end of
9350 the document, then mark it as type
9355 That will put a small gray box in front of what you just typed.
9356 Click on the box to fill in the rest of the information.
9357 For new references, go to the end of an existing reference and press return.
9358 That will create a new line with its own box, etc.
9361 \begin_layout Subsubsection
9365 \begin_layout Standard
9366 Even though AAS\SpecialChar TeX
9367 provides its own figure commands (
9373 , for example), I much prefer \SpecialChar LaTeX
9374 's standard figure commands (with the default
9383 \begin_inset space ~
9386 commands as \SpecialChar TeX
9387 code into a Figure Float box if you desire, but I never have
9388 much luck getting the layout right.
9389 With the standard graphics, \SpecialChar LyX
9394 usepackage{graphicx}
9396 command into the \SpecialChar LaTeX
9397 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9399 interspersing the figures in the text.
9400 I believe ApJ accepts figures exactly this way now; AJ might still use
9402 \begin_inset Quotes eld
9405 stack everything at the end
9406 \begin_inset Quotes erd
9412 \begin_layout Subsubsection
9413 Things I could have done, but didn't
9416 \begin_layout Standard
9418 \begin_inset Quotes eld
9422 \begin_inset Quotes erd
9425 things I could have implemented, but chose not to.
9426 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9428 even though it is double-spaced in the paper manuscript.
9429 Also, I chose not to make separate layouts for the preprint and preprint2
9431 Since I assume you will spend most of your time in the plain manuscript
9432 mode anyway, I decided not to chew up more disk space with this.
9436 \begin_layout Subsection
9440 \begin_layout Standard
9441 Your mileage may vary.
9442 I've now had papers published by both ApJ and AJ that have had 98% of the
9443 effort done in \SpecialChar LyX
9444 ; the last 2% was the \SpecialChar LaTeX
9445 post-processing and a few cleanups.
9446 I have had no trouble with the submission process, and I'm sure the journals
9447 were never aware that there might be a difference.
9448 So, go forth and publish!
9451 \begin_layout Section
9452 AMS \SpecialChar LaTeX
9456 \begin_layout Standard
9466 \begin_layout Standard
9467 \begin_inset VSpace bigskip
9473 \begin_layout Standard
9475 The AMS \SpecialChar LaTeX
9476 layouts are set up to conform to suggested styles for mathematical
9477 papers to be submitted to American Mathematical Society publications.
9478 The layouts are not tailored to a specific journal, but easily can be.
9479 You should refer to the AMS documentation for specific instructions for
9480 each journal (usually it will entail only changing a single line in the
9483 That documentation is available on the Web at
9484 \begin_inset Flex URL
9487 \begin_layout Plain Layout
9495 \begin_inset Flex URL
9498 \begin_layout Plain Layout
9500 ftp://ftp.ams.org/pub/tex/amslatex/
9506 These layouts are appropriate, and useful, for any mathematical writing.
9510 \begin_layout Standard
9511 There are two basic AMS \SpecialChar LaTeX
9515 \begin_layout Itemize
9516 amsart: The standard AMS article format.
9519 \begin_layout Itemize
9520 amsbook: the standard AMS book (really, monograph) format.
9524 \begin_layout Standard
9525 The layouts themselves contain only the minimum necessary to use the AMS
9527 They do not, in particular, contain any of the `theorem' environments used
9528 for setting theorems, lemmas, and the like.
9529 These are contained, instead, in the
9530 \begin_inset Flex Code
9533 \begin_layout Plain Layout
9539 module, which is loaded by default when you select one of the AMS classes.
9540 (It can also be used with other classes and can be removed, if you would
9541 rather use something else.) Less commonly used environments are in the
9542 \begin_inset Flex Code
9545 \begin_layout Plain Layout
9546 Theorems (AMS-Extended)
9551 module, which must be loaded manually.
9554 \begin_layout Standard
9555 By default, theorems and the like are numbered consecutively throughout
9556 the document, but this may be modified by loading the module
9557 \begin_inset Flex Code
9560 \begin_layout Plain Layout
9561 Theorems (Order by Section)
9566 or, if you are using
9567 \begin_inset Flex Code
9570 \begin_layout Plain Layout
9577 \begin_inset Flex Code
9580 \begin_layout Plain Layout
9581 Theorems (Order by Chapter)
9587 These will number the results as
9588 \begin_inset Formula $n.m$
9591 , where the first number refers to the section (or chapter) and the second
9592 refers to the total number of results so far in that section (or chapter).
9593 Many environments are also available unnumbered.
9594 These are indicated by an asterisk at the end.
9595 If you happen to want
9599 unnumbered results, the module
9600 \begin_inset Flex Code
9603 \begin_layout Plain Layout
9609 provides that option.
9612 \begin_layout Standard
9613 Note that these modules do not
9617 to be used with the AMS classes.
9618 It is perfectly possible to use the
9619 \begin_inset Flex Code
9622 \begin_layout Plain Layout
9628 module, and the others mentioned, with other classes, such as
9629 \begin_inset Flex Code
9632 \begin_layout Plain Layout
9639 \begin_inset Flex Code
9642 \begin_layout Plain Layout
9649 \begin_inset Flex Code
9652 \begin_layout Plain Layout
9661 \begin_layout Subsection
9662 What these layouts provide
9665 \begin_layout Standard
9666 There is a long list of included environments provided by these layouts.
9667 In AMS-\SpecialChar LaTeX
9668 , there is, in fact, an opportunity to define an unlimited variety
9669 of `theorem' environments.
9670 However, the AMS recommends the environments that are available in \SpecialChar LyX
9675 \begin_layout Standard
9676 The following environments—as well as the standard environments, such as
9678 \begin_inset Flex Noun
9681 \begin_layout Plain Layout
9688 \begin_inset Flex Noun
9691 \begin_layout Plain Layout
9698 \begin_inset Flex Noun
9701 \begin_layout Plain Layout
9708 \begin_inset Flex Noun
9711 \begin_layout Plain Layout
9718 \begin_inset Flex Noun
9721 \begin_layout Plain Layout
9728 \begin_inset Flex Code
9731 \begin_layout Plain Layout
9738 \begin_inset Flex Code
9741 \begin_layout Plain Layout
9750 \begin_layout Description
9751 Address This should be the author's permanent address.
9754 \begin_layout Description
9756 \begin_inset space ~
9759 Address This should be the author's temporary address at the time of submission,
9760 if different from the Address.
9763 \begin_layout Description
9764 Email Author's e-mail address
9767 \begin_layout Description
9768 URL Author's Web address, if desired.
9771 \begin_layout Description
9772 Keywords Key words or phrases used to identify specific topics discussed
9776 \begin_layout Description
9777 Subjectclass These refer to the AMS Subject Classifications, published and
9780 Mathematical Reviews
9783 These are also available online at the AMS cites listed above.
9786 \begin_layout Description
9790 \begin_layout Description
9794 \begin_layout Description
9798 \begin_layout Standard
9799 The following environments are provided by both the
9800 \begin_inset Flex Code
9803 \begin_layout Plain Layout
9810 \begin_inset Flex Code
9813 \begin_layout Plain Layout
9819 modules, in the latter case in both starred (unnumbered) and unstarred
9820 (numbered) versions.
9821 These same environments are provided only in the starred versions by the
9823 \begin_inset Flex Code
9826 \begin_layout Plain Layout
9835 \begin_layout Theorem
9836 This is typically used for the statements of major results.
9840 \begin_layout Corollary*
9841 This is used for statements which follow fairly directly from previous statement
9843 Again, these can be major results.
9848 These are smaller results needed to prove other statements.
9851 \begin_layout Proposition
9852 These are less major results which (hopefully) add to the general theory
9856 \begin_layout Conjecture
9857 These are statements provided without justification, which the author does
9858 not know how to prove, but which seem to be true (to the author, at least).
9861 \begin_layout Definition*
9862 Guess what this is for.
9863 The font is different for this environment than for the previous ones.
9867 \begin_layout Example*
9868 Used for examples illustrating proven results.
9871 \begin_layout Problem
9872 It's not really known what this is for.
9873 You should figure it out.
9876 \begin_layout Exercise*
9877 Write a description for this one.
9880 \begin_layout Remark
9881 This environment is also a type of theorem, usually a lesser sort of observation.
9884 \begin_layout Claim*
9885 Often used in the course of giving a proof of a larger result.
9889 Generally, these are used to break up long arguments, using specific instances
9895 The numbering scheme for cases is on its own, not together with other numbered
9901 At the end of this environment, a QED symbol (usually a square, but it can
9902 vary with different styles) is placed.
9903 If you want to have other environments within this one—for example, Case
9904 environments—and have the QED symbol appear only after them, then the other
9905 environments need to be nested within the proof environment.
9908 Nesting Environments
9914 for information on nesting.
9917 \begin_layout Standard
9918 And these environments are provided by
9919 \begin_inset Flex Code
9922 \begin_layout Plain Layout
9923 Theorems (AMS-Extended)
9931 \begin_layout Criterion*
9932 A required condition.
9935 \begin_layout Algorithm*
9936 A general procedure to be used.
9939 \begin_layout Axiom*
9940 This is a property or statement taken as true within the system being discussed.
9943 \begin_layout Condition*
9944 Sometimes used to state a condition assumed within the present context of
9949 Similar to a Remark.
9952 \begin_layout Notation*
9953 Used for the explanation of, yes, notation.
9956 \begin_layout Summary
9957 Do we really need to tell you?
9960 \begin_layout Acknowledgement*
9964 \begin_layout Conclusion*
9965 Sometimes used at the end of a long train of argument.
9969 Used in a way similar to Proposition, though perhaps lower on the scale.
9972 \begin_layout Standard
9973 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
9976 They need to be available on your system in order to use these environments.
9979 \begin_layout Section
9987 \begin_layout Standard
9993 \begin_layout Subsection
9997 \begin_layout Standard
9998 These are the layout files for some of the journals of the American Geophysical
10000 It is assumed that you have both the AGU's own class files and AGUplus
10001 installed (everything to be found at
10002 \begin_inset Flex URL
10005 \begin_layout Plain Layout
10007 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10015 \begin_layout Subsection
10019 \begin_layout Standard
10029 They are still called this in the \SpecialChar LyX
10030 GUI, though their \SpecialChar LaTeX
10043 \begin_layout Standard
10044 Newly defined styles are
10081 These are mostly manuscript attributes and defined in the AGU class documentati
10085 \begin_layout Standard
10086 I suspect this is still badly incomplete.
10089 \begin_layout Subsection
10093 \begin_layout Standard
10110 \begin_layout Subsection
10114 \begin_layout Itemize
10117 Journal of Geophysical Research
10126 \begin_layout Standard
10127 Add your own, it isn't so hard! Look at the
10138 \begin_layout Subsection
10139 Bugs and things to remember
10142 \begin_layout Standard
10143 In order to use the new layouts, you must remember to do the following for
10147 \begin_layout Enumerate
10153 This can be done in the
10155 Layout\SpecialChar menuseparator
10160 Document\SpecialChar menuseparator
10164 (AGU articles are always in English, right? So
10168 choose a language.)
10171 \begin_layout Enumerate
10176 into the document's
10181 (Yes, this is a bug.)
10184 \begin_layout Enumerate
10185 Make sure you use the
10189 bibliography style, by entering
10193 into the second field of the Bib\SpecialChar TeX
10195 None of the standard styles will do.
10198 \begin_layout Section
10202 \begin_layout Standard
10208 \begin_layout Subsection
10212 \begin_layout Standard
10213 Broadway is for writing plays.
10214 The format is more decorative than Hollywood, and much less standardized.
10215 This format should be suitable for workshops.
10218 \begin_layout Subsection
10222 \begin_layout Standard
10223 The same as in Hollywood.
10226 \begin_layout Subsection
10230 \begin_layout Standard
10235 names as labels then cross-reference the label to insert the name.
10236 The cross-reference dialog will show the current cast of characters.
10239 \begin_layout Subsection
10240 Paper size and Margins
10243 \begin_layout Standard
10244 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10247 \begin_layout Subsection
10251 \begin_layout Standard
10252 The following environments are available.
10253 You can use broadway.bind to get the bind keys shown at the right.
10256 \begin_layout Itemize
10260 \begin_inset Newline newline
10265 You should not have to use this, but it is here for anything that does not
10269 \begin_layout Itemize
10273 \begin_inset space \hfill{}
10277 \begin_inset Newline newline
10282 Used to describe stage setting and the action.
10283 First use of speaker names in all CAPs.
10286 \begin_layout Itemize
10290 \begin_inset space \hfill{}
10294 \begin_inset Newline newline
10299 Automatically numbered.
10300 On screen it will be arabic, but will print as Roman.
10303 \begin_layout Itemize
10307 \begin_inset space \hfill{}
10311 \begin_inset Newline newline
10321 It is just centered text.
10324 \begin_layout Itemize
10328 \begin_inset space \hfill{}
10332 \begin_inset Newline newline
10337 Not automatically numbered.
10338 You supply the number.
10339 This is because I couldn't figure out how.
10342 \begin_layout Itemize
10346 \begin_inset space \hfill{}
10350 \begin_inset Newline newline
10355 A special case of Narrative to describe the setting and action as the curtain
10359 \begin_layout Itemize
10363 \begin_inset space \hfill{}
10367 \begin_inset Newline newline
10372 The speaker's (actor's) title, centered in all CAPS.
10375 \begin_layout Itemize
10379 \begin_inset space \hfill{}
10383 \begin_inset Newline newline
10388 Instructions to the speaker.
10389 The parentheses are automatically inserted.
10390 The ( will appear on screen, but both will be in the printed play.
10391 This environment is only used within
10398 \begin_layout Itemize
10402 \begin_inset space \hfill{}
10406 \begin_inset Newline newline
10411 What the Speaker says.
10414 \begin_layout Itemize
10418 \begin_inset space \hfill{}
10422 \begin_inset Newline newline
10427 The curtain comes down.
10430 \begin_layout Itemize
10434 \begin_inset space \hfill{}
10440 \begin_layout Itemize
10444 \begin_inset space \hfill{}
10450 \begin_layout Itemize
10454 \begin_inset space \hfill{}
10460 \begin_layout Standard
10464 \begin_layout Section
10468 \begin_layout Standard
10473 can be used to type letters according to German conventions.
10474 A template file is included in
10476 .../lyx/share/templates
10478 for you to use as a starting point.
10481 \begin_layout Section
10489 \begin_layout Standard
10495 \begin_layout Subsection
10499 \begin_layout Standard
10500 This is the layout file for the European Geophysical Society journals.
10505 can be downloaded from the web site of the EGS under
10506 \begin_inset Flex URL
10509 \begin_layout Plain Layout
10519 \begin_layout Subsection
10523 \begin_layout Standard
10526 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10534 The current layout file is unfortunately very unmodular and would benefit
10535 from using the various
10542 \begin_layout Section
10546 \begin_layout Standard
10547 See the \SpecialChar LyX
10553 It contains all infos you need.
10556 \begin_layout Section
10559 Foil\SpecialChar TeX
10563 \begin_inset CommandInset label
10572 \begin_layout Standard
10578 \begin_layout Subsection
10582 \begin_layout Standard
10583 This section describes how to use \SpecialChar LyX
10584 to make slides for overhead projectors.
10585 There are two document classes that can do this: the default slides class
10588 Foil\SpecialChar TeX
10592 This section documents the latter.
10595 \begin_layout Standard
10596 I'm going to say this again, nice and clear, so that there's no misunderstanding
10600 \begin_layout Standard
10601 \begin_inset VSpace bigskip
10607 \begin_layout Standard
10611 This section documents the class
10612 \begin_inset Quotes eld
10620 \begin_inset Quotes erd
10628 \begin_layout Standard
10629 \begin_inset VSpace bigskip
10635 \begin_layout Standard
10636 If you're looking for the documentation for
10637 \begin_inset Quotes eld
10645 \begin_inset Quotes erd
10648 , check out section
10649 \begin_inset space ~
10653 \begin_inset CommandInset ref
10655 reference "sec:slitex"
10660 If your machine doesn't have the
10665 \begin_inset Quotes eld
10673 \begin_inset Quotes erd
10676 ] installed, you'll probably have to use the default
10680 class, which isn't quite as good as
10685 \begin_layout Standard
10690 class is designed for use with version 2.1 of the
10695 class file which is now an integral part of \SpecialChar LaTeX2e
10699 \begin_layout Subsection
10703 \begin_layout Standard
10704 Obviously, to use this document class, you need to select
10705 \begin_inset Quotes eld
10713 \begin_inset Quotes erd
10723 \begin_inset space ~
10729 There are some settings in the
10732 \begin_inset space ~
10737 dialog that you should know about that are specific to this class:
10740 \begin_layout Itemize
10741 Don't change the options
10752 \begin_inset space ~
10758 They're ignored by the
10765 \begin_layout Itemize
10766 The default font size is 20
10767 \begin_inset space \thinspace{}
10770 pt with the other options being 17
10771 \begin_inset space \thinspace{}
10775 \begin_inset space \thinspace{}
10779 \begin_inset space \thinspace{}
10785 \begin_layout Itemize
10786 The default font is
10794 but all math equations are still typeset in the usual roman font.
10797 \begin_layout Itemize
10800 Foil\SpecialChar TeX
10803 supports A4 and Letter paper sizes as well as a special size for working
10805 \begin_inset space \thinspace{}
10809 It doesn't support A5, B5, legal or executive paper sizes.
10812 \begin_layout Itemize
10813 Don't bother changing the
10817 settings because they are ignored anyway.
10818 All floats appear where they are defined in the text.
10821 \begin_layout Itemize
10826 setting behaves a bit differently for this class.
10829 Foil\SpecialChar TeX
10832 provides extensive footer and header capabilities including a user-defined
10835 \begin_inset space ~
10839 \begin_inset CommandInset ref
10841 reference "sec:foilfoot"
10846 The title page is treated differently to all other pages in the document
10855 has the logo centered at the bottom of the page (if one is defined).
10856 The possible page style choices and what they do are as follows:
10857 \begin_inset Separator parbreak
10864 \begin_layout Labeling
10865 \labelwidthstring MMMMMMM
10872 The final output contains no page numbers, or other headers or footers
10873 (except footnotes of course).
10877 \begin_layout Labeling
10878 \labelwidthstring MMMMMMM
10885 The final output contains page numbers centered at the bottom of the page.
10886 No other headings or footers (other than footnotes).
10889 \begin_layout Labeling
10890 \labelwidthstring MMMMMMM
10895 Page numbers in lower right corner.
10896 Additional headers and footers are also shown.
10897 This is also the default.
10900 \begin_layout Labeling
10901 \labelwidthstring MMMMMMM
10906 Gives you access to the
10910 package although its use with
10912 Foil\SpecialChar TeX
10915 is discouraged by the writer of the
10917 Foil\SpecialChar TeX
10920 package because of some potential page layout clashes.
10924 \begin_layout Subsubsection
10928 \begin_layout Standard
10929 The following options may be used in the extra class options in the
10931 Document\SpecialChar menuseparator
10937 \begin_layout Labeling
10938 \labelwidthstring MMMMMMx
10943 This sets up the page layout for 7.33
10944 \begin_inset space \thinspace{}
10948 \begin_inset space \thinspace{}
10951 in paper, which is about the same aspect ratio as a 35
10952 \begin_inset space \thinspace{}
10955 mm slide, making it a bit easier to work with this medium.
10958 \begin_layout Labeling
10959 \labelwidthstring MMMMMMx
10964 Places a rule across the page below the header on every page except the
10968 \begin_layout Labeling
10969 \labelwidthstring MMMMMMx
10974 Places a rule across the page above the footer on every page except the
10978 \begin_layout Labeling
10979 \labelwidthstring MMMMMMx
10984 This is automatically set each time you create a new
10991 Foil\SpecialChar TeX
10994 to use the dvips driver to rotate those pages that are set as landscape
10998 \begin_layout Labeling
10999 \labelwidthstring MMMMMMx
11004 Simply changes the page dimensions to those of a landscape page but doesn't
11006 Thus if you use this option you need to use an external program to rotate
11007 each page or feed your paper through your printer as landscape.
11008 Note that this option effectively reverses the roles of the
11016 environments (don't worry these are described in the next section).
11019 \begin_layout Labeling
11020 \labelwidthstring MMMMMMx
11025 Equation numbers on the left.
11028 \begin_layout Labeling
11029 \labelwidthstring MMMMMMx
11034 Flush-left equations.
11037 \begin_layout Subsection
11038 Supported Environments
11041 \begin_layout Standard
11042 Most of the environments commonly supported in other classes are also supported
11048 There are several additional environments provided by
11050 Foil\SpecialChar TeX
11053 as well as a couple added by \SpecialChar LyX
11055 The following environments are shared with other classes:
11058 \begin_layout Standard
11059 \begin_inset Flex Multiple Columns
11062 \begin_layout Itemize
11068 \begin_layout Itemize
11074 \begin_layout Itemize
11080 \begin_layout Itemize
11086 \begin_layout Itemize
11092 \begin_layout Itemize
11099 \begin_layout Itemize
11105 \begin_layout Itemize
11111 \begin_layout Itemize
11117 \begin_layout Itemize
11123 \begin_layout Itemize
11129 \begin_layout Itemize
11135 \begin_layout Itemize
11141 \begin_layout Itemize
11147 \begin_layout Itemize
11153 \begin_layout Itemize
11159 \begin_layout Itemize
11165 \begin_layout Itemize
11176 \begin_layout Standard
11177 That is, all the major environments apart from the sectioning environments.
11178 Since foils are essentially self-contained sections, with a title and body,
11181 Foil\SpecialChar TeX
11184 provides specific commands for starting new foils and these are:
11187 \begin_layout Itemize
11193 \begin_layout Itemize
11199 \begin_layout Standard
11201 also provides slightly modified versions of these two environments called:
11204 \begin_layout Itemize
11210 \begin_layout Itemize
11213 ShortRotatefoilhead
11216 \begin_layout Standard
11217 and the differences will be explained in the next section.
11220 \begin_layout Standard
11221 Since foils are often used in presenting ideas or new theorems and such
11224 Foil\SpecialChar TeX
11227 also provides a comprehensive box of goodies for presenting them:
11230 \begin_layout Standard
11231 \begin_inset Flex Multiple Columns
11234 \begin_layout Itemize
11240 \begin_layout Itemize
11246 \begin_layout Itemize
11252 \begin_layout Itemize
11258 \begin_layout Itemize
11264 \begin_layout Itemize
11270 \begin_layout Itemize
11276 \begin_layout Itemize
11282 \begin_layout Itemize
11288 \begin_layout Itemize
11294 \begin_layout Itemize
11305 \begin_layout Standard
11306 The starred versions are unnumbered while the unstarred versions are numbered.
11307 There are also two list environments added by \SpecialChar LyX
11311 \begin_layout Itemize
11317 \begin_layout Itemize
11323 \begin_layout Standard
11326 Foil\SpecialChar TeX
11329 provides some powerful header and footer capabilities that are best set
11330 in the preamble although they may be set at any point in a document.
11331 If you want to change these settings in your document the best place to
11332 do so is at the very top of a foil, i.
11333 \begin_inset space \thinspace{}
11339 \begin_inset space \space{}
11344 straight after the foilhead.
11347 \begin_layout Standard
11348 For this purpose, the following command styles are provided [
11355 \begin_layout Standard
11356 \begin_inset Flex Multiple Columns
11359 \begin_layout Itemize
11363 \begin_inset space ~
11369 \begin_layout Itemize
11375 \begin_layout Itemize
11379 \begin_inset space ~
11385 \begin_layout Itemize
11389 \begin_inset space ~
11395 \begin_layout Itemize
11399 \begin_inset space ~
11405 \begin_inset Separator parbreak
11412 \begin_layout Plain Layout
11413 \begin_inset space ~
11425 \begin_layout Standard
11426 There are also a few commands provided by
11428 Foil\SpecialChar TeX
11431 that aren't directly supported by \SpecialChar LyX
11432 but I'll tell you what they do and how
11433 to use them in section
11434 \begin_inset space ~
11438 \begin_inset CommandInset ref
11440 reference "sec:unsuppfoils"
11447 \begin_layout Subsection
11448 Building a Set of Foils
11451 \begin_layout Standard
11452 This section will give a simple introduction to using the different environments
11453 to build a set of foils.
11454 If you want to see an example set of foils, take a look at the
11458 file you find in \SpecialChar LyX
11466 \begin_layout Subsubsection
11467 Give It a Title Page
11470 \begin_layout Standard
11471 Unlike other classes that provide
11491 creates the title on a page of its own.
11492 If you leave out the
11496 environment \SpecialChar LaTeX
11497 will substitute the current date (every time you regenerate
11501 \begin_layout Subsubsection
11505 \begin_layout Standard
11506 As I mentioned earlier, there are four ways of starting a new foil.
11507 For portrait foils you should use
11516 The difference between these two environments is the amount of space between
11517 the title of the foil (the foilhead) and the body of the foil.
11520 \begin_layout Standard
11521 Landscape foils are generated using the
11527 ShortRotatefoilhead
11530 Again the only difference is the spacing between foilhead and body.
11531 Both of the short versions have 0.5
11532 \begin_inset space ~
11535 inches less separation between the foilhead and the body.
11539 \begin_layout Standard
11540 One problem with the support for landscape foils is the requirement that
11541 you have to use the
11545 driver to generate the PostScript output otherwise the foils won't be rotated.
11546 It is possible to get landscape foils even if you haven't got the
11550 driver provided you can feed your foils sideways through your printer ;-)
11553 \begin_layout Subsubsection
11554 Theorems, Lemmas, Proofs and more
11557 \begin_layout Standard
11558 Due to a small bug in \SpecialChar LyX
11559 you can't have two of the same type of these environments
11560 directly following each other.
11561 They must be separated by something.
11562 If you try, you will just be extending the previous environment as if you
11563 had merged the two environments together.
11564 So, how do you get around this problem? The simplest option is to insert
11565 some text between the two environments or add a
11570 environment between the two with just a
11571 \begin_inset Quotes eld
11579 \begin_inset Quotes erd
11583 This will force \SpecialChar LyX
11584 to produce two separate environments and hence the correct
11587 An example is provided in the example file included with the \SpecialChar LyX
11589 Remember, this problem only occurs if you are trying to place two of the
11590 same type of theorem-like environments one directly after the other.
11593 \begin_layout Subsubsection
11597 \begin_layout Standard
11598 You get all the commonly supported list styles found in other classes as
11599 well as two new ones.
11600 I'll only describe the new ones here.
11601 If you want to find out more about the other list environments check out
11607 If you intend to use itemized lists you might also want to read about the
11611 \begin_inset space ~
11615 \begin_inset space ~
11620 dialog described above in section
11621 \begin_inset space ~
11625 \begin_inset CommandInset ref
11627 reference "sec:bullet"
11634 \begin_layout Standard
11635 The two new list styles,
11643 , are designed to make it easier for you to create lists of do's and don'ts
11644 or right and wrong by providing dedicated environments that use a tick
11645 or a cross as the label of the list.
11646 These lists are in fact dedicated variants of the
11651 They do however require that you have the
11655 packages installed.
11658 \begin_layout Subsubsection
11662 \begin_layout Standard
11665 Foil\SpecialChar TeX
11668 redefines the floating tables and figures so that they appear exactly where
11669 they are in the text rather than pushing them to the top of the page or
11670 to some user specified location.
11671 In fact if you change the float placement settings they are simply ignored.
11674 \begin_layout Subsubsection
11675 Page Headers and Footers
11676 \begin_inset CommandInset label
11678 name "sec:foilfoot"
11685 \begin_layout Standard
11689 \begin_inset space ~
11698 are two commands used to control the left-footer text string.
11699 The first is meant to allow you to include a graphic logo on your foils
11701 \begin_inset Quotes eld
11706 Foil\SpecialChar TeX
11710 \begin_inset Quotes erd
11714 While the second is meant to provide a classification for the audience,
11718 \begin_inset space \thinspace{}
11724 \begin_inset space \space{}
11728 It is empty by default.
11731 \begin_layout Standard
11732 The remaining page corners can be filled by
11735 \begin_inset space ~
11740 (which defaults to page numbers),
11743 \begin_inset space ~
11751 \begin_inset space ~
11759 \begin_layout Subsection
11762 Foil\SpecialChar TeX
11766 \begin_inset CommandInset label
11768 name "sec:unsuppfoils"
11775 \begin_layout Standard
11776 All the commands mentioned below need to be set in a
11786 within another environment.
11789 \begin_layout Subsubsection
11793 \begin_layout Standard
11794 All lengths are adjusted using the
11817 should be replaced by the name given to the length you want to change and
11822 is the length value.
11823 All lengths should be specified in units of length such as inches (
11835 ) or relative to some document or font-based length such as
11845 \begin_layout Standard
11846 It's possible to change the spacing between a foilhead and the body of the
11847 foil by adjusting the length specified by
11854 For example, to make
11859 \begin_inset space \space{}
11862 in closer to their bodies put the following in the preamble:
11868 foilheadskip}{-0.5in}
11871 \begin_layout Standard
11872 The spacings around floats can be adjusted by setting these lengths:
11875 \begin_layout Labeling
11876 \labelwidthstring MMMMMMMMMMM
11883 Separation between the text and the top of the float
11886 \begin_layout Labeling
11887 \labelwidthstring MMMMMMMMMMM
11894 Separation between the float and the caption
11897 \begin_layout Labeling
11898 \labelwidthstring MMMMMMMMMMM
11905 Separation between the caption and the following text
11908 \begin_layout Labeling
11909 \labelwidthstring MMMMMMMMMMM
11916 You can make the captions narrower than the surrounding text by adjusting
11918 Best done relative to
11927 \begin_layout Standard
11928 There are also several title page related lengths that you may find useful
11929 if you have a long title or several authors:
11932 \begin_layout Labeling
11933 \labelwidthstring MMMMMMMMMMM
11940 Separation from headers to
11945 \begin_layout Labeling
11946 \labelwidthstring MMMMMMMMMMM
11964 \begin_layout Labeling
11965 \labelwidthstring MMMMMMMMMMM
11979 \begin_layout Labeling
11980 \labelwidthstring MMMMMMMMMMM
11996 \begin_layout Labeling
11997 \labelwidthstring MMMMMMMMMMM
12013 \begin_layout Standard
12014 The last length related command affects all the list environments.
12025 a list environment then all the vertical spacing between the list items
12027 Note that this is a command not a length so it doesn't require
12033 like the stuff mentioned above.
12036 \begin_layout Subsubsection
12037 Headers and Footers
12040 \begin_layout Standard
12053 commands control whether the logo in the
12057 definition appear on a given page.
12064 in the preamble then none of the foils will have the logo on them.
12065 If you don't want the logo on a particular page place the
12071 directly after the foilhead of that page and the
12077 directly after the next foilhead.
12080 \begin_layout Standard
12081 If you decide to use the
12085 page style setting in the
12088 \begin_inset space ~
12093 dialog you should probably add
12103 to your preamble so headers and footers on landscape pages are correctly
12104 placed when rotated.
12105 This is due to some clashes between the page layouts provided by the
12116 \begin_layout Section
12117 Hollywood (Hollywood spec scripts)
12120 \begin_layout Standard
12126 \begin_layout Subsection
12130 \begin_layout Standard
12131 Getting the format of a Hollywood script right is a
12132 \begin_inset Quotes eld
12136 \begin_inset Quotes erd
12139 It is designed to make the readers focus on content and to be easy and
12140 familiar for the actors to read.
12141 Each page of a script should be one minute of film.
12142 Nothing goes in a script that you cannot see or hear on screen.
12143 The courier 12 pt font should be used throughout.
12147 \begin_layout Subsection
12151 \begin_layout Standard
12152 Speakers' lines should NEVER break in mid-sentence.
12153 If a speaker's lines continue over a page break, repeat the
12157 title followed by (Cont'd).
12160 \begin_layout Subsection
12164 \begin_layout Standard
12169 names as labels then cross-reference the label to insert the name.
12170 The cross-reference dialog will show the current cast of characters.
12171 You can use this to insert the speaker name in narratives also.
12174 \begin_layout Subsection
12175 Paper size and Margins
12178 \begin_layout Standard
12179 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12182 \begin_layout Subsection
12186 \begin_layout Standard
12187 The following environments are available.
12188 You can use hollywood.bind to get the bind keys shown at the right.
12191 \begin_layout Itemize
12195 \begin_inset Newline newline
12200 Used where nothing else works.
12204 \begin_layout Itemize
12210 \begin_inset space \hfill{}
12218 \begin_inset Newline newline
12221 Usually followed by something like
12222 \begin_inset Quotes eld
12225 on Sally waking up.
12226 \begin_inset Quotes erd
12232 \begin_layout Itemize
12236 \begin_inset space \hfill{}
12240 \begin_inset Newline newline
12245 Introduces a new INTERIOR camera set-up.
12246 Always followed by DAY or NIGHT, or something similar to define the lighting
12248 Everthing on this line in CAPS.
12251 \begin_layout Itemize
12255 \begin_inset space \hfill{}
12259 \begin_inset Newline newline
12264 Introduces a new EXTERIOR camera set-up.
12265 Everthing on this line in CAPS.
12268 \begin_layout Itemize
12272 \begin_inset space \hfill{}
12276 \begin_inset Newline newline
12281 The character speaking.
12284 \begin_layout Itemize
12288 \begin_inset space \hfill{}
12292 \begin_inset Newline newline
12297 Instructions to the speaker.
12298 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12300 Both will be printed.
12303 \begin_layout Itemize
12307 \begin_inset space \hfill{}
12311 \begin_inset Newline newline
12323 \begin_layout Itemize
12327 \begin_inset space \hfill{}
12331 \begin_inset Newline newline
12336 Camera movement instruction.
12338 \begin_inset space \thinspace{}
12342 \begin_inset space \space{}
12348 \begin_layout Itemize
12352 \begin_inset space \hfill{}
12358 \begin_layout Itemize
12362 \begin_inset space \hfill{}
12368 \begin_layout Itemize
12372 \begin_inset space \hfill{}
12378 \begin_layout Itemize
12382 \begin_inset space \hfill{}
12388 \begin_layout Subsection
12392 \begin_layout Itemize
12396 \begin_layout Itemize
12400 \begin_layout Itemize
12402 \begin_inset space \thinspace{}
12409 \begin_layout Itemize
12414 \begin_layout Itemize
12415 PAN — camera movement
12418 \begin_layout Itemize
12419 INSERT — cut to close-up of
12422 \begin_layout Section
12426 \begin_layout Standard
12429 Panayotis Papasotiriou
12432 \begin_layout Subsection
12436 \begin_layout Standard
12437 The ijmpc package is a set of macros that facilitates electronic manuscript
12440 International Journal of Modern Physics C
12443 Similarly, the ijmpd package is for creating manuscripts to be submitted
12446 International Journal of Modern Physics D
12449 Both journals are published by World Scientific.
12450 The corresponding document classes are named
12459 These files, together with instructions for the authors, can be downloaded
12461 \begin_inset Flex URL
12464 \begin_layout Plain Layout
12466 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12472 \begin_inset Flex URL
12475 \begin_layout Plain Layout
12477 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12483 Both packages are modified versions of the standard
12484 \begin_inset Quotes eld
12488 \begin_inset Quotes erd
12491 package, and they are almost (but not exactly) identical.
12492 Most of their features are supported by \SpecialChar LyX
12494 I have used \SpecialChar LyX
12495 successfully to write articles submitted to both journals
12496 without any problem.
12499 \begin_layout Subsection
12503 \begin_layout Standard
12504 As usual, the easiest way to write a paper is to start with a template.
12507 File\SpecialChar menuseparator
12526 This will give an (almost) empty document that includes the most common
12527 fields found in a manuscript.
12528 Simply overwrite the existing text (including the brackets,
12533 You should keep in mind the following remarks.
12536 \begin_layout Enumerate
12538 won't let you change the font size and the page style of the document,
12539 because such modifications are not allowed by both packages.
12542 \begin_layout Enumerate
12543 The language of the document should not be changed.
12544 Before previewing your paper, be sure that the babel package is not used.
12545 To do this, click on
12547 Tools\SpecialChar menuseparator
12558 checkbox in the language settings, and click on
12566 , if you wish to make this change permanent).
12569 \begin_layout Enumerate
12571 \begin_inset Quotes eld
12575 \begin_inset Quotes erd
12578 style must be used to define keywords.
12581 \begin_layout Enumerate
12582 The ijmpc package provides a style named
12583 \begin_inset Quotes eld
12586 Classification Codes
12587 \begin_inset Quotes erd
12590 , which can be used to define classification codes, such as PACS numbers.
12591 Note that this facility is not supported by the ijmpd package.
12594 \begin_layout Enumerate
12595 Several new environments are available:
12596 \begin_inset Quotes eld
12600 \begin_inset Quotes erd
12604 \begin_inset Quotes eld
12608 \begin_inset Quotes erd
12612 \begin_inset Quotes eld
12616 \begin_inset Quotes erd
12620 \begin_inset Quotes eld
12624 \begin_inset Quotes erd
12628 \begin_inset Quotes eld
12632 \begin_inset Quotes erd
12636 \begin_inset Quotes eld
12640 \begin_inset Quotes erd
12644 \begin_inset Quotes eld
12648 \begin_inset Quotes erd
12652 \begin_inset Quotes eld
12656 \begin_inset Quotes erd
12660 \begin_inset Quotes eld
12664 \begin_inset Quotes erd
12668 \begin_inset Quotes eld
12672 \begin_inset Quotes erd
12676 \begin_inset Quotes eld
12680 \begin_inset Quotes erd
12684 \begin_inset Quotes eld
12688 \begin_inset Quotes erd
12692 \begin_inset Quotes eld
12696 \begin_inset Quotes erd
12700 \begin_inset Quotes eld
12704 \begin_inset Quotes erd
12708 Their use is more or less obvious.
12710 supports all these environments; it will use the proper label, text style,
12711 and numbering scheme for each of them.
12714 \begin_layout Enumerate
12715 Both packages use basic citations; the natbib package should not be used.
12716 In \SpecialChar LyX
12717 , citation references are shown as usual; in the output, citations are
12718 shown as superscripts.
12719 If you want to use a citation as normal text, you should use the
12724 \begin_inset space \thinspace{}
12728 \begin_inset space \space{}
12732 \begin_inset Quotes eld
12736 \begin_inset space \space{}
12746 \begin_inset Quotes erd
12752 \begin_layout Enumerate
12754 \begin_inset Quotes eld
12758 \begin_inset Quotes erd
12761 section in both packages.
12762 To put acknowledgments, just use the
12763 \begin_inset Quotes eld
12767 \begin_inset Quotes erd
12773 \begin_layout Enumerate
12774 Appendices may be added to the paper,
12778 the Acknowledgments and
12784 provides a special environment, called
12785 \begin_inset Quotes eld
12789 \begin_inset Quotes erd
12792 which marks the beginning of the appendices.
12793 This environment should be left blank; it just sends a \SpecialChar LaTeX
12794 command, but nothing
12796 In \SpecialChar LyX
12798 \begin_inset Quotes eld
12802 \begin_inset Quotes erd
12805 is printed with blue letters, as a signal that all sections after that
12806 point are appendices.
12807 To write an appendix, use the
12808 \begin_inset Quotes eld
12812 \begin_inset Quotes erd
12817 will number each appendix with capital letters, as required by both journals.
12819 \begin_inset Quotes eld
12823 \begin_inset Quotes erd
12830 be present before the first appendix; if not, all appendices will be numbered
12831 as normal sections in the output.
12834 \begin_layout Enumerate
12835 The ijmpc and the ijmpd packages use the
12839 command to implement table captions.
12840 As a result, a table created by \SpecialChar LyX
12841 is printed correctly, but its caption
12843 However, you can use some \SpecialChar TeX
12844 code to overcome this problem, so that captions
12845 are printed as expected.
12846 To do so, create a float table as usual, remove the caption, and replace
12847 it with the \SpecialChar TeX
12858 (sic); you must also the \SpecialChar TeX
12863 immediately after the tabular material.
12864 Study the example table included in the template files to see how this
12865 trick is implemented.
12866 Alternatively, If you need table captions, you should implement the whole
12871 file, then include this file to the \SpecialChar LyX
12874 Insert\SpecialChar menuseparator
12875 File\SpecialChar menuseparator
12877 \begin_inset space ~
12883 Details on how to create a table float can be found in the files
12891 , included in the corresponding packages.
12894 \begin_layout Subsection
12895 Preparing a paper for submission
12898 \begin_layout Standard
12899 Before you submit your paper you must export the \SpecialChar LyX
12900 document as a \SpecialChar LaTeX
12903 File\SpecialChar menuseparator
12904 Export\SpecialChar menuseparator
12912 \begin_layout Plain Layout
12913 Actually you have the choice between \SpecialChar LaTeX
12914 (plain) and pdflatex.
12915 If you intend to use pdflatex to prepare the paper, you should use the
12916 pdflatex option so that included graphics are converted to PDF format,
12917 ready for use by pdflatex.
12922 , then make the following changes to the resulting
12929 \begin_layout Enumerate
12930 Remove the comment lines before the
12939 \begin_layout Enumerate
12940 Remove everything between (and including) the
12952 commands, except for any commands you specifically put into the \SpecialChar LaTeX
12956 \begin_layout Standard
12961 file should be saved and processed through \SpecialChar LaTeX
12962 as many times as necessary.
12963 You may also want to check the resulting
12970 \begin_layout Subsection
12971 Use of \SpecialChar TeX
12975 \begin_layout Standard
12976 The use of \SpecialChar TeX
12977 code is reduced to two commands, which must be placed at the
12978 top of the document.
12979 If you started writing your paper by using the
12987 template, the \SpecialChar TeX
12988 code needed is already in its place; you usually don't need
12990 You may only modify the first \SpecialChar TeX
12991 code to specify the information printed
12992 to the top of odd and even pages (authors' names and short paper's title,
12994 This \SpecialChar TeX
12995 code must have the form
12999 markboth{Authors' Names}{Short Paper's Title}
13004 \begin_layout Section
13008 \begin_layout Standard
13014 \begin_layout Subsection
13018 \begin_layout Standard
13019 The iopart package provides a document class to create electronic manuscript
13020 submission to the journals published by the Institute of Physics.
13021 Instructions for the authors how to create a paper using the iopart class
13022 can be downloaded together with the iopart package from the site
13023 \begin_inset Flex URL
13026 \begin_layout Plain Layout
13028 ftp://ftp.iop.org/pub/journals/latex2e
13036 \begin_layout Subsection
13040 \begin_layout Standard
13041 The easiest way to write a paper is to start with the file
13045 that is available in \SpecialChar LyX
13046 's examples files folder.
13047 Open this file, save it under a new name, and start writing.
13048 The example file explains how to use the special text environments.
13049 Here are the most important advices:
13052 \begin_layout Itemize
13053 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13056 Use AMS math package
13058 in the document settings under
13065 \begin_layout Itemize
13068 The title environment defines the kind of your paper.
13069 So use one of the following environments for the title:
13072 \begin_inset Separator parbreak
13079 \begin_layout Itemize
13088 \begin_layout Itemize
13097 \begin_layout Itemize
13103 for a Topical review
13106 \begin_layout Itemize
13115 \begin_layout Itemize
13124 \begin_layout Itemize
13130 for a Paper (same as Title)
13133 \begin_layout Itemize
13139 for a Preliminary communication
13142 \begin_layout Itemize
13148 for a Rapid communication
13151 \begin_layout Itemize
13157 for a Letter to the editor
13161 \begin_layout Itemize
13164 All title environments except of
13168 can have an optional short title.
13171 \begin_layout Itemize
13172 There is a general title environment
13176 which is not directly supported by the \SpecialChar LyX
13178 This can be used as \SpecialChar TeX
13179 code when your document doesn't fit into one of the
13183 \begin_layout Standard
13184 For more informations like hints for special table and formula formatting,
13185 look at the IOP author guidelines.
13188 \begin_layout Section
13192 \begin_layout Standard
13195 Panayotis Papasotiriou
13198 \begin_layout Subsection
13202 \begin_layout Standard
13203 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13204 that facilitates electronic manuscript submission to the journals they
13206 Most known of them (at least in my domain of interest) are
13208 Astrophysics and Space Science
13214 , but there are many others (see a complete list at
13215 \begin_inset Flex URL
13218 \begin_layout Plain Layout
13220 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13226 The Kluwer package may be downloaded from the site
13227 \begin_inset Flex URL
13230 \begin_layout Plain Layout
13232 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13238 A complete user guide is contained in that package (but it can also be
13239 downloaded separately).
13242 \begin_layout Standard
13244 supports many features of the package but not everything.
13245 However, the \SpecialChar TeX
13246 code needed is reduced to some
13247 \begin_inset Quotes eld
13251 \begin_inset Quotes erd
13254 commands of the package (see
13255 \begin_inset space ~
13259 \begin_inset CommandInset ref
13261 reference "subsec:kluwer_peculiarities"
13266 I have recently used \SpecialChar LyX
13267 to write an article submitted to the
13269 Astrophysics and Space Science
13271 without any problem.
13274 \begin_layout Subsection
13278 \begin_layout Standard
13279 The easiest way to write a paper is to start with the Kluwer template file.
13282 File\SpecialChar menuseparator
13294 This will give an (almost) empty document that includes the most common
13295 fields found in a manuscript and a short description of their use.
13296 As in most templates, simply overwrite the existing text (including the
13301 ) with the correct information.
13304 \begin_layout Subsection
13305 Preparing a paper for submission
13308 \begin_layout Standard
13309 As in the AAS\SpecialChar TeX
13310 package, before you submit your paper to a journal you must
13312 \begin_inset Quotes eld
13316 \begin_inset Quotes erd
13322 \begin_layout Enumerate
13323 Export your paper as a \SpecialChar LaTeX
13325 To do this, click on
13327 File\SpecialChar menuseparator
13328 Export\SpecialChar menuseparator
13336 \begin_layout Enumerate
13341 file with a text editor and make the following changes
13342 \begin_inset Separator parbreak
13349 \begin_layout Enumerate
13350 remove the comment lines before the
13359 \begin_layout Enumerate
13360 remove everything between (and including) the
13372 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13376 \begin_layout Standard
13385 \begin_layout Enumerate
13390 file through \SpecialChar LaTeX
13391 as many times as necessary (usually up to three).
13394 \begin_layout Enumerate
13400 \begin_inset space \thinspace{}
13404 \begin_inset space \space{}
13411 , and check if everything is OK (it should, if you didn't make any mistake).
13414 \begin_layout Subsection
13415 \begin_inset Quotes eld
13419 \begin_inset Quotes erd
13422 of the Kluwer package
13423 \begin_inset CommandInset label
13425 name "subsec:kluwer_peculiarities"
13432 \begin_layout Standard
13433 The Kluwer package has the following
13434 \begin_inset Quotes eld
13438 \begin_inset Quotes erd
13444 \begin_layout Enumerate
13445 It is possible to write multiple articles in the same \SpecialChar LaTeX
13450 \begin_layout Plain Layout
13451 I can't imagine any good reason to do this.
13457 Each article must be included in the environment
13458 \begin_inset Quotes eld
13462 \begin_inset Quotes erd
13466 Unfortunately, this environment cannot be omitted, even if you write just
13468 Therefore, each article starts with the command
13474 and, obviously, ends with the command
13481 Although this can be implemented in \SpecialChar LyX
13482 , I didn't included it, since it looks
13483 ugly and can confuse the novice user.
13484 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13487 \begin_inset Quotes eld
13492 \begin_inset Quotes erd
13498 \begin_layout Enumerate
13499 Information given at the beginning of the article (i.
13500 \begin_inset space \thinspace{}
13504 \begin_inset space \space{}
13507 title, subtitle, author, institution, running title, running author, abstract
13508 and keywords) must be included in an environment called
13509 \begin_inset Quotes eld
13513 \begin_inset Quotes erd
13517 This is not implemented in \SpecialChar LyX
13518 , so you must enter title, subtitle etc.
13519 \begin_inset space ~
13522 between two \SpecialChar TeX
13538 \begin_layout Enumerate
13539 According to the user manual, the label of each bibliography item must be
13563 \begin_layout Standard
13568 template takes care of all these
13569 \begin_inset Quotes eld
13573 \begin_inset Quotes erd
13577 If you start a new paper using this template you don't need to do anything
13582 \begin_layout Enumerate
13583 don't delete the \SpecialChar TeX
13584 code included in the template, and
13587 \begin_layout Enumerate
13588 copy the example bibliography item included in the template and modify it
13589 as necessary to enter new bibliography items.
13592 \begin_layout Section
13596 \begin_layout Standard
13602 \begin_layout Subsection
13606 \begin_layout Standard
13607 The \SpecialChar LyX
13610 article (koma-script)
13614 report (koma-script)
13632 correspond to the \SpecialChar LaTeX
13650 \begin_inset space ~
13653 of the Koma-Script family.
13654 They are replacements for the standard document classes
13670 , resp., and fit better to European typography conventions in a number of
13674 \begin_layout Itemize
13675 Standard character size is 11pt in
13677 article (koma-script)
13681 report (koma-script)
13689 letter (koma-script)
13694 \begin_layout Itemize
13695 Headings, labels of the description environment, and a number of elements
13698 letter (koma-script)
13700 document class are set in a bold sans serif font.
13704 \begin_layout Plain Layout
13705 There is a big difference between the bold sans serif old cm fonts and new
13706 ec fonts, especially in the appearance of headings.
13707 In comparison, the ec bold sans serif fonts look a bit thin.
13708 Here the \SpecialChar LaTeX
13717 helps to produce the
13718 \begin_inset Quotes eld
13722 \begin_inset Quotes erd
13725 appearance when using the ec fonts.
13730 The numbering of chapter headings is made in the same way as the numbering
13731 of section headings, that is without the extra line
13732 \begin_inset Quotes eld
13735 Chapter\SpecialChar ldots
13737 \begin_inset Quotes erd
13741 In addition, the appearance of the headings can be modified by using a
13742 number of options (in \SpecialChar LyX
13743 to be entered in the field
13746 \begin_inset space ~
13753 Layout\SpecialChar menuseparator
13760 \begin_layout Itemize
13761 The main means in the Koma-Script document classes to design the type area
13770 (in \SpecialChar LyX
13771 to be entered in the extra class options field in the dialog
13773 Document\SpecialChar menuseparator
13777 They make a clearer modification of page margins possible as do the options
13780 Document\SpecialChar menuseparator
13787 \begin_layout Itemize
13788 The \SpecialChar LaTeX
13789 document classes of the Koma-Script family define a number of additional
13791 Those part of it which makes sense in \SpecialChar LyX
13792 is implemented in corresponding
13796 \begin_layout Standard
13797 Detailed descriptions of the \SpecialChar LaTeX
13798 document classes of the Koma-Script family
13799 can be found in the Koma-Script documentation
13810 \begin_layout Subsection
13811 article (koma-script), report (koma-script), and book (koma-script)
13814 \begin_layout Standard
13815 The document classes
13817 article (koma-script)
13821 report (koma-script)
13831 are implemented in the layout files
13844 They contain all the paragraph types of the corresponding standard document
13857 , resp., partly modified, with the exception of the \SpecialChar LyX
13862 -type, which is replaced by the new
13866 -type having the same functionality.
13871 -Type there is a number of new paragraph types added.
13878 letter (koma-script)
13883 \begin_layout Itemize
13892 : are equivalents to
13900 , resp., additionally inserting an entry in the table of contents.
13909 are not contained in
13911 article (koma-script)
13916 \begin_layout Itemize
13925 : behave exactly as
13933 , resp., additionally clearing running heads.
13938 is not contained in
13940 article (koma-script)
13946 \begin_layout Plain Layout
13959 report (koma-script)
13961 , but since this is identical to
13965 , is has not been implemented in \SpecialChar LyX
13974 \begin_layout Itemize
13979 : generates a heading directly above the following paragraph in the standard
13980 character size without affecting the structure of the document.
13983 \begin_layout Itemize
13992 are special captions which respect the different space settings needed
13993 for captions placed above or below an element (if you follow strict typographic
13994 rules, you might want to place table captions always above the table).
13995 You can also use the class option
13999 , which will switch
14012 You need at least Koma-Script version 2.8q to use this.
14015 \begin_layout Itemize
14020 : can be used to set a bonmot, e.
14021 \begin_inset space \thinspace{}
14025 \begin_inset space \space{}
14028 at the beginning of a chapter.
14029 If you use the optional argument (
14031 Insert\SpecialChar menuseparator
14033 \begin_inset space ~
14038 ), you can insert the dictum's author there.
14039 Dictum and author are separated by a line.
14040 You need at least Koma-Script version 2.8q to use this.
14045 is not contained in
14047 article (koma-script)
14052 \begin_layout Standard
14053 The following types, together with the standard types
14065 , form the title area of the document.
14066 They must be entered ahead of the first
14067 \begin_inset Quotes eld
14071 \begin_inset Quotes erd
14078 \begin_layout Plain Layout
14079 The corresponding \SpecialChar LaTeX
14080 commands must appear before the
14091 When such a type is used more than once, the latter usage overwrites the
14092 former one, that means, for every type only the latest usage is valid.
14093 The order of the different types however has, like
14105 , no effect on the appearance of the produced document.
14108 \begin_layout Itemize
14113 : produces a centered paragraph above the ordinary title (
14125 ) for the subject of the document.
14128 \begin_layout Itemize
14133 : produces a centered paragraph below the ordinary title (
14145 ) for the publishers' name.
14148 \begin_layout Itemize
14155 report (koma-script)
14161 produces a centered paragraph on its own page behind the title page, or
14164 article (koma-script)
14166 produces a centered paragraph below the ordinary title (
14182 ) for a dedication.
14185 \begin_layout Itemize
14190 : produces a left aligned paragraph above the ordinary title (
14206 ) for a document`s head.
14209 \begin_layout Itemize
14214 : produces in a double-sided print in
14216 report (koma-script)
14222 a left-aligned paragraph at the top of the title page`s back or has no
14223 effect in a single-sided print or in
14225 article (koma-script)
14230 \begin_layout Itemize
14235 : produces in a double-sided print in
14237 report (koma-script)
14243 a left-aligned paragraph at the bottom of the title page`s back or has
14244 no effect in a single-sided print or in
14246 article (koma-script)
14251 \begin_layout Itemize
14256 : produces a special
14257 \begin_inset Quotes eld
14261 \begin_inset Quotes erd
14264 page ahead of the actual document containing a paragraph without special
14268 \begin_layout Standard
14269 The layout files for the document classes
14271 article (koma-script)
14275 report (koma-script)
14281 do include the file
14286 This is thought of as a place to define your own types.
14291 in your personal layout directory and edit the file!
14294 \begin_layout Subsection
14295 letter (koma-script)
14298 \begin_layout Standard
14302 letter (koma-script)
14304 is implemented in the layout file
14309 It contains all the paragraph types of the corresponding standard document
14314 , partly modified, with the exception of the \SpecialChar LyX
14328 type, which is replaced by the new
14333 In addition, it contains, in contrast to the standard document class, the
14352 Furthermore, there are a number of new letter specific types.
14355 \begin_layout Standard
14356 The appearance of the letter produced by this document class can be controlled
14357 by a number of \SpecialChar LaTeX
14358 commands, which you can put in the \SpecialChar LaTeX
14363 \begin_layout Plain Layout
14364 For example, the standard appearance of the letter`s heading, consisting
14365 of name and address, is quite self-willed.
14367 \begin_inset Quotes eld
14371 \begin_inset Quotes erd
14374 heading is produced by the following \SpecialChar LaTeX
14375 commands in the preamble:
14378 \begin_layout LyX-Code
14388 \begin_layout LyX-Code
14404 \begin_layout LyX-Code
14414 \begin_layout LyX-Code
14434 A detailed German description of such \SpecialChar LaTeX
14435 commands can be found in the Koma-Script
14441 With it, the letter's author can produce his personal letter layout.
14444 \begin_layout Standard
14453 define the beginning of the letter and must be used in every letter.
14454 To emphasize them in the \SpecialChar LyX
14455 document class, they are marked with the letter
14465 \begin_inset space ~
14468 in the left margin.
14469 It is possible to write any number of letters in one file.
14474 type produces a new letter using the same addressee and a
14478 type produces a new addressee.
14495 are ordinary paragraph types and can also be used several times in one
14496 and the same letter.
14499 \begin_layout Itemize
14504 : produces a paragraph for the addressee and implicitly defines the beginning
14508 \begin_layout Itemize
14513 : produces a paragraph for the form of address and implicitly produces a
14517 \begin_layout Itemize
14522 : produces a paragraph for a close.
14525 \begin_layout Itemize
14530 : produces a paragraph for a postscript.
14533 \begin_layout Itemize
14538 : produces a paragraph for a distribution list.
14541 \begin_layout Itemize
14546 : produces a paragraph for enclosures.
14549 \begin_layout Standard
14590 are input types provided with a label to enter information, which will
14591 be processed by the document class.
14595 \begin_layout Plain Layout
14596 It could be seen as a matter of inconsequence, that the types
14604 described above are not such input types as well.
14605 Because of the special meaning of those types, however, I have implemented
14606 them as ordinary paragraph types with a one letter mark in the left margin.
14607 Moreover, it would affect my feeling of symmetry, if the
14615 type had such a serious different appearance.
14620 The types must be used ahead of the corresponding
14627 \begin_layout Standard
14628 An implementation of these types in a WYSIWYG fashion does not seem to make
14629 sense, because the real appearance of the produced letter does not only
14630 depend on the usage of the particular type, but also on other factors.
14631 For example, a signature entered in the
14635 type will in the standard behavior appear in the produced letter only,
14636 when in the same letter also a
14641 The entered value of the
14645 type will in the standard behavior not appear in the produced letter at
14647 The possibility to design the letter`s heading freely is already indicated
14648 in a footnote above.
14651 \begin_layout Standard
14652 The input types can also be used as empty paragraphs.
14653 This makes sense e.
14654 \begin_inset space \thinspace{}
14658 \begin_inset space \space{}
14670 type is not used at all, in the standard behavior the value of the
14674 type is used as signature, whereas if an empty
14678 type is used, no signature value is defined.
14681 \begin_layout Standard
14682 By using the input types it is possible to write a letter template, containing
14683 filled input types with your personal dates (name, address, etc.) and empty
14684 input types for other dates you want to enter.
14687 \begin_layout Itemize
14692 : sender's name, in the standard behavior appears as a centered paragraph
14693 in small caps in the letter`s heading.
14696 \begin_layout Itemize
14701 : sender's signature, in the standard behavior appears below the
14710 type is used, the value of the
14714 type appears instead.
14717 \begin_layout Itemize
14722 : sender's address, in the standard behavior appears in a centered paragraph
14723 in the letter`s heading below the sender's name.
14726 \begin_layout Itemize
14731 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
14742 \begin_layout Itemize
14747 : place of the letter`s making.
14750 \begin_layout Itemize
14755 : date of the letter`s making.
14764 , in the standard behavior, produce the place and the date in a right-aligned
14765 line below the addressee's field.
14770 type is used, neither place nor date appear, independent of the value of
14780 type is used, the date of the letter `s production is used.
14783 \begin_layout Itemize
14788 : sender`s back address, in the standard behavior appears above the addressee's
14789 field in a small sans serif font.
14792 \begin_layout Itemize
14797 : special mail information, in the standard behavior appears underlined
14798 above the addressee's field below the back address.
14801 \begin_layout Itemize
14806 : additional information, in the standard behavior appears on right side
14807 below the addressee`s field.
14810 \begin_layout Itemize
14815 : the letter's title, in the standard behavior appears in a big, bold, sans
14816 serif font above the subject.
14819 \begin_layout Itemize
14824 : the letter's subject, in the standard behavior appears in a bold font
14832 \begin_layout Standard
14853 produce a business letter like line above the
14857 line containing the fields
14858 \begin_inset Quotes eld
14862 \begin_inset Quotes erd
14866 \begin_inset Quotes eld
14870 \begin_inset Quotes erd
14874 \begin_inset Quotes eld
14878 \begin_inset Quotes erd
14882 \begin_inset Quotes eld
14886 \begin_inset Quotes erd
14890 \begin_inset Quotes eld
14894 \begin_inset Quotes erd
14898 \begin_inset Quotes eld
14902 \begin_inset Quotes erd
14906 For the date field, the value of the
14912 \begin_inset Quotes eld
14915 business letter types
14916 \begin_inset Quotes erd
14919 is used, the value of the
14923 type however does not appear, but only the \SpecialChar LaTeX
14931 The ordinary output of place and date in a right-aligned line below the
14932 addressee`s field is suppressed.
14933 The types are implemented as input types provided with a label and must
14934 be used ahead of the corresponding
14941 \begin_layout Itemize
14949 \begin_layout Itemize
14957 \begin_layout Itemize
14965 \begin_layout Itemize
14973 \begin_layout Itemize
14981 \begin_layout Subsection
14982 The new letter class: letter (koma-script v.2)
14985 \begin_layout Standard
14991 \begin_layout Standard
14992 \begin_inset VSpace medskip
14998 \begin_layout Standard
15000 Koma-Script version 2.8 has introduced a new letter class
15004 which supersedes the now unsupported
15009 It has — on the \SpecialChar LaTeX
15010 side — a completely new interface and is not compatible
15011 with the old class.
15012 Therefore, \SpecialChar LyX
15013 supports both, though it is recommended you use the new class.
15016 \begin_layout Standard
15017 This class covers the same functionality as
15019 letter (koma-script),
15022 The basic items are
15026 (receiver's address, same as
15030 in the old layout),
15043 will start a new letter (i.
15044 \begin_inset space \thinspace{}
15048 \begin_inset space \space{}
15051 you can write several letters per document).
15052 New elements are sender's
15068 and the possibility to use a
15074 Insert\SpecialChar menuseparator
15080 \begin_layout Standard
15081 The biggest improvement is, though, that the letter's layout is configurable
15082 to meet almost any needs.
15083 This can be done via the preamble or with a special style file (Letter
15084 Class Option, extension
15088 ), that will be read in as a class option.
15092 \begin_layout Plain Layout
15093 The KOMA package comes with some default
15098 There is, for instance, a
15102 file that follows german typesetting rules, or a
15106 that provides the default layout of the old
15111 The latter can be loaded with the class option
15120 ayout\SpecialChar menuseparator
15125 ocument\SpecialChar menuseparator
15137 template that is included in \SpecialChar LyX
15139 A detailed description is to be found in the Koma-Script documentation
15147 \begin_layout Subsection
15151 \begin_layout Standard
15152 Visualizing the Koma-Script document classes in \SpecialChar LyX
15153 , the \SpecialChar LyX
15154 internals cause some
15158 \begin_layout Itemize
15159 The chapter number of a
15163 type appears on a line of its own above the chapter heading instead of
15164 appearing in the same line ahead of it.
15165 The cause for that is the \SpecialChar LyX
15166 internal behavior for the labeltype
15170 in the layout file.
15173 \begin_layout Itemize
15174 The headings of the types
15182 are only put in the
15183 \begin_inset Quotes eld
15187 \begin_inset Quotes erd
15191 table of contents, but not in the \SpecialChar LyX
15192 table of contents (
15194 Document\SpecialChar menuseparator
15196 \begin_inset space ~
15200 \begin_inset space ~
15208 \begin_layout Itemize
15209 The paragraphs in a
15213 document class appear in a skip separation mode, not indented.
15214 This is the standard behavior, no special \SpecialChar LaTeX
15215 commands are needed for that.
15218 Document\SpecialChar menuseparator
15221 dialog the corresponding radio button indicates
15230 value always has the effect that extra \SpecialChar LaTeX
15231 commands are inserted in the document
15232 to produce the gap, which is not what is wanted in this case.
15235 \begin_layout Section
15239 \begin_layout Standard
15245 \begin_layout Subsection
15249 \begin_layout Standard
15250 Memoir is a very powerful and constantly evolving class.
15251 It has been designed with regard to fictional and non-fictional literature.
15252 Its aim is to let the user have maximum control over the typesetting of
15254 Memoir is based on the standard book class, but it can also emulate the
15255 article class (see below).
15258 \begin_layout Standard
15259 Peter Wilson, the developer of Memoir, is known as the author of lots of
15260 useful packages in the \SpecialChar LaTeX
15262 Most of them have been merged with Memoir.
15263 Therefore, it is much easier to layout the table of contents, appendices,
15264 chapter designs and such.
15266 , though, does not support all of these goodies natively.
15267 Some of them might be added to forthcoming releases
15271 \begin_layout Plain Layout
15272 You are invited to send suggestions to
15273 \begin_inset Flex URL
15276 \begin_layout Plain Layout
15278 lyx-devel@lists.lyx.org
15288 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15290 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15292 commands (\SpecialChar TeX
15297 \begin_layout Plain Layout
15302 \begin_layout Plain Layout
15312 \begin_inset space ~
15316 \begin_inset CommandInset ref
15318 reference "sec:Inserting-TeX-Code"
15328 In this section, we can only list those features that are natively supported
15329 by \SpecialChar LyX
15331 For detailed descriptions (and for the rest of features) we recommend you
15332 have a look at the detailed manual of the Memoir class
15336 \begin_layout Plain Layout
15341 \begin_layout Plain Layout
15351 \begin_inset Flex URL
15354 \begin_layout Plain Layout
15356 CTAN:/macros/latex/memoir/memman.pdf
15366 , which is not only a user guide for the class, but also both a comprehensive
15367 description on good typesetting and a superb example for good typesetting
15371 \begin_layout Subsection
15372 Basic features and restrictions
15375 \begin_layout Standard
15376 Memoir supports basically all features of the standard book classes.
15377 There are, however, some differences, as follows:
15380 \begin_layout Description
15382 \begin_inset space ~
15385 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15388 \begin_layout Description
15390 \begin_inset space ~
15393 style: The fancy page style is not supported, due to a command clash between
15394 Memoir and the fancyhdr package (they both define a command with the same
15395 name, which confuses \SpecialChar LaTeX
15397 Instead, Memoir comes with a number of its own page styles (see
15399 Layout\SpecialChar menuseparator
15400 Document\SpecialChar menuseparator
15402 \begin_inset space ~
15408 If you want to use these for the chapter pages, you have to use the command
15415 in the main text or in preamble (e.
15416 \begin_inset space \thinspace{}
15420 \begin_inset space \space{}
15427 chapterstyle{companion}
15432 \begin_layout Description
15433 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15434 optional argument in the standard classes.
15435 With this, you can specify an alternative version of the title for the
15436 table of contents and the headers (for instance, if the title is too long).
15437 In \SpecialChar LyX
15438 , you can do this via
15440 Insert\SpecialChar menuseparator
15442 \begin_inset space ~
15447 at the beginning of a chapter/section.
15448 Memoir features a second optional argument and thus separates the table
15449 of contents from the header.
15450 You can define three variants of a title with this: one for the main text,
15451 one for the table of contents, and one for the headers.
15452 Simply insert two optional arguments if you need this feature, the first
15453 one containing the short title for the Table of Contents, the second one
15454 containing an alternative short title for the headers.
15457 \begin_layout Description
15458 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15459 of contents, the list of figures and the list of table start a new page
15461 Memoir does not follow this route.
15462 You have to insert a page break yourself, if you want to have one.
15465 \begin_layout Description
15466 Titlepage: For some unknown reason, Memoir uses pagination on the title
15467 page (in the standard classes, title pages are
15468 \begin_inset Quotes eld
15472 \begin_inset Quotes erd
15476 If you want an empty title page, type
15480 aliaspagestyle{title}{empty}
15485 \begin_layout Description
15486 Article: With the class option
15492 Layout\SpecialChar menuseparator
15493 Document\SpecialChar menuseparator
15495 \begin_inset space ~
15500 ), you can emulate article style.
15501 That is, counters (footnotes, figures, tables etc.) will not be reset on
15502 new chapters, chapters don't start a new page (but are—in contrary to
15503 \begin_inset Quotes eld
15507 \begin_inset Quotes erd
15510 article classes—still allowed), parts, though, use their own page, as in
15514 \begin_layout Description
15515 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15516 font commands, which have been used in the old \SpecialChar LaTeX
15518 \begin_inset space \thinspace{}
15522 \begin_inset space \space{}
15538 It produces an error and stops \SpecialChar LaTeX
15539 whenever such a command appears.
15544 reallows the commands and spits out warnings instead (which does at least
15545 not stop \SpecialChar LaTeX
15547 Since a lot of packages and particularly Bib\SpecialChar TeX
15548 style files are still using
15549 those commands, we have decided to use this option by default.
15552 \begin_layout Subsection
15556 \begin_layout Standard
15557 We will only describe the features supported by \SpecialChar LyX
15558 (which is not much currently).
15559 Please consult the Memoir manual
15563 \begin_layout Plain Layout
15568 \begin_layout Plain Layout
15578 \begin_inset Flex URL
15581 \begin_layout Plain Layout
15583 CTAN:/macros/latex/memoir/memman.pdf
15596 \begin_layout Description
15597 Abstract: You may wonder why an abstract is an extra feature.
15598 Well, it is in book class.
15599 Usually books don't have abstracts.
15600 Memoir, however, has.
15601 You can use it wherever and how often you like.
15604 \begin_layout Description
15605 Chapterprecis: You may know this older typesetting style: The contents of
15606 a chapter are summarized below the title and also in the table of contents
15608 \begin_inset space \thinspace{}
15612 \begin_inset space \space{}
15617 Our hero arrives in Troia; he loses some friends; he finds others
15620 Chapterprecis does exactly this.
15621 It is therefore only sensible below a chapter.
15624 \begin_layout Description
15625 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15626 The epigraph environment provides an elegant way of typesetting such a
15628 The motto itself (text) and its author (source) are divided by a short
15630 Unfortunately, we have to fool \SpecialChar LyX
15631 a bit here again, since the environment
15632 needs two arguments (text and source).
15633 In this case, we have to use curly brackets (in \SpecialChar TeX
15634 mode) between the two
15645 <author of the slogan>.
15648 \begin_layout Description
15649 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15650 complex figurative poems).
15652 can only support a few of them.
15653 One is poemtitle, which is a centered title for poems, which will also
15654 be added to the table of contents (verse is the standard environment for
15656 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
15658 because they have to be nested inside regular verse environments, which
15659 is not possible with \SpecialChar LyX
15663 \begin_layout Description
15664 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15667 \begin_layout Section
15668 Article (mwart), book (mwbk) and report (mwrep)
15669 \begin_inset Argument status
15672 \begin_layout Plain Layout
15685 \begin_layout Standard
15691 \begin_layout Standard
15692 The \SpecialChar LyX
15709 correspond to the \SpecialChar LaTeX
15723 They are replacements for the standard document classes
15735 , resp., and fit better to Polish typography conventions in a number of points.
15739 \begin_layout Standard
15743 \begin_layout Itemize
15744 Unnumbered titles (with star, e.
15745 \begin_inset space \thinspace{}
15749 \begin_inset space \space{}
15756 ) are added into table of contents,
15759 \begin_layout Itemize
15760 Additional page styles:
15761 \begin_inset Separator parbreak
15768 \begin_layout Description
15769 uheadings header with separated lines,
15772 \begin_layout Description
15773 myheadings custom header, contents headers via commands:
15788 \begin_layout Description
15789 myuheadings custom header with separated lines,
15792 \begin_layout Description
15793 outer page number is placed on outer side of page
15797 \begin_layout Itemize
15799 \begin_inset Separator parbreak
15806 \begin_layout Description
15807 rmheadings serif titles — default,
15810 \begin_layout Description
15811 sfheadings sansserif titles,
15814 \begin_layout Description
15815 authortitle on title page first placed is author next title — default,
15818 \begin_layout Description
15819 titleauthor on title page first placed is title next author,
15822 \begin_layout Description
15823 withmarginpar reserve place on page for margins.
15827 \begin_layout Section
15831 \begin_layout Standard
15836 provides an alternative to the standard
15841 It provides similar functionality, but you might prefer this layout with
15842 sans serif sections, headings, and more.
15845 \begin_layout Section
15846 Rev\SpecialChar TeX
15850 \begin_layout Standard
15856 \begin_layout Standard
15857 \begin_inset VSpace bigskip
15863 \begin_layout Standard
15868 \begin_inset space ~
15873 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
15875 \begin_inset Formula $\beta$
15878 release of May, 1999) class.
15881 \begin_layout Standard
15887 textclass, which works with Rev\SpecialChar TeX
15889 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
15891 That means that it doesn't interact very well with \SpecialChar LyX
15892 , which requires \SpecialChar LaTeX2e
15894 it has been kludged to work.
15895 Since Rev\SpecialChar TeX
15896 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
15901 Rev\SpecialChar TeX
15903 \begin_inset space ~
15908 textclass should also be pretty easy to use.
15911 \begin_layout Standard
15912 These documents are supposed to be used in
15916 to the Rev\SpecialChar TeX
15917 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
15919 and assume you'll know what to put in the preamble if necessary.
15922 \begin_layout Subsection
15926 \begin_layout Standard
15927 All you need to do is install Rev\SpecialChar TeX
15928 4, as described in the package's README
15930 The package can be found at The Rev\SpecialChar TeX
15932 \begin_inset Flex URL
15935 \begin_layout Plain Layout
15937 http://publish.aps.org/revtex4/
15943 Install it somewhere that \SpecialChar LaTeX
15945 Test it by trying to \SpecialChar LaTeX
15946 a short Rev\SpecialChar TeX
15947 4 document in some random directory (i.
15948 \begin_inset space \thinspace{}
15952 \begin_inset space \space{}
15955 not the directory where you installed the class file.) Then, if you reconfigure
15957 , it will find the class file and let you use the Rev\SpecialChar TeX
15961 \begin_layout Standard
15962 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
15971 \begin_inset space ~
15976 template, found in the templates directory.
15979 \begin_layout Subsection
15983 \begin_layout Standard
15984 Optional arguments to
15991 \begin_inset Quotes eld
15995 \begin_inset Quotes erd
15999 \begin_inset Quotes eld
16003 \begin_inset Quotes erd
16013 \begin_inset space ~
16021 \begin_inset space ~
16027 Remember that in Rev\SpecialChar TeX
16028 , at least one optional argument is required!
16031 \begin_layout Standard
16032 Other preamble matter, like
16039 \begin_inset space ~
16046 \begin_inset space ~
16051 dialog, also as usual.
16054 \begin_layout Subsection
16058 \begin_layout Standard
16059 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16061 For example, the Email layout corresponds to
16068 Note that (at least as of Rev\SpecialChar TeX
16077 layouts are exactly equivalent, so you shouldn't need to use both.
16081 \begin_layout Plain Layout
16082 In case you're curious, both were included so that
16086 would be able to translate both
16106 \begin_layout Subsection
16110 \begin_layout Standard
16111 There are a couple of important unique aspects of Rev\SpecialChar TeX
16112 4 which might cause
16113 bugs that will be even more confusing in \SpecialChar LyX
16117 \begin_layout Standard
16118 In Rev\SpecialChar TeX
16136 The \SpecialChar LyX
16137 equivalent is that there is a separate Thanks layout.
16142 write footnotes in the
16146 layout, or weird things may happen.
16147 See the Rev\SpecialChar TeX
16148 4 documentation for more details.
16151 \begin_layout Standard
16155 \begin_inset space ~
16163 \begin_inset space ~
16172 layouts must be placed
16180 layout and the corresponding
16197 , the \SpecialChar LaTeX
16201 \begin_layout Subsection
16205 \begin_layout Standard
16206 The main problem with this layout is that you can't use the optional arguments
16207 to layouts like Email and Title.
16208 (The problem is not unique to this layout; you can't use optional arguments
16209 to the Section layouts either.) This means that after you export that file
16210 to \SpecialChar LaTeX
16211 (which you'll need to do eventually to send it in to APS), you'll need
16212 to edit the \SpecialChar LaTeX
16213 file with a text editor to add the optional arguments to set,
16215 \begin_inset space \thinspace{}
16219 \begin_inset space \space{}
16222 the running title for the page headers.
16223 Lacking these layouts makes the
16229 (and the equivalent
16235 ) useless, so the corresponding layouts don't exist, and will have to be
16240 \begin_layout Plain Layout
16245 actually, \SpecialChar LyX
16246 1.3.0 supports some forms of optional arguments, but this layout
16247 has not been updated yet to take advantage of it.
16255 \begin_layout Section
16256 Springer Journals (
16263 \begin_layout Standard
16269 \begin_layout Subsection
16273 \begin_layout Standard
16274 These are the layout files for some of the journal formats used by Springer
16275 Verlag and listed on
16276 \begin_inset Flex URL
16279 \begin_layout Plain Layout
16281 http://www.springer.de/author/tex/help-journals.html
16286 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16288 It is a modular system: the things common to all journals are implemented
16293 , which journal-specific layout files (such as, e.
16294 \begin_inset space \thinspace{}
16298 \begin_inset space \space{}
16305 for Journal of Geodesy) can include.
16308 \begin_layout Standard
16309 This means that implementing support for any other Springer journal on this
16310 list is as simple as writing your own
16318 file following the outline given in
16326 \begin_layout Standard
16327 It is reasonably well tested only for the Journal of Geodesy.
16336 come with the standard \SpecialChar LyX
16338 Install the relevant class file (downloaded from Springer) in a proper
16339 directory, reconfigure \SpecialChar LaTeX
16340 (in the te\SpecialChar TeX
16345 , as root if necessary — doesn't \SpecialChar LyX
16346 take care of this?), reconfigure \SpecialChar LyX
16351 \begin_layout Subsection
16355 \begin_layout Standard
16356 A large number of theorem-like styles —
16368 \begin_layout Standard
16371 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16372 _Title, Author_Running, Institute,
16373 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16376 See the Springer class file documentation for details.
16379 \begin_layout Subsection
16383 \begin_layout Itemize
16395 \begin_layout Itemize
16398 Probability Theory and Related Fields
16404 — Jean-Marc Lasgouttes
16407 \begin_layout Standard
16408 Add your own, it isn't so hard!
16411 \begin_layout Subsection
16415 \begin_layout Standard
16416 These files are partly based on the older
16420 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16422 file from Springer.
16427 layout, are now defunct.
16428 Jean-Marc Lasgouttes helped out big in making me find my way around the
16430 layout file mechanism.
16433 \begin_layout Subsection
16437 \begin_layout Standard
16439 But probably less than in the old hacked-\SpecialChar LaTeX
16447 \begin_layout Standard
16449 \begin_inset space \thinspace{}
16452 g.: does not display the number for theorem-like layouts, just #.
16455 \begin_layout Section
16458 Sli\SpecialChar TeX
16462 \begin_inset CommandInset label
16471 \begin_layout Standard
16479 \begin_layout Subsection
16483 \begin_layout Standard
16484 This section describes how to use \SpecialChar LyX
16485 to make slides for overhead projectors.
16486 There are two document classes that can do this: the default slides class
16489 Foil\SpecialChar TeX
16493 This section documents the former.
16496 \begin_layout Standard
16497 I'm going to say this again, nice and clear, so that there's no misunderstanding
16501 \begin_layout Standard
16502 \begin_inset VSpace bigskip
16508 \begin_layout Standard
16512 This section documents the class
16513 \begin_inset Quotes eld
16521 \begin_inset Quotes erd
16529 \begin_layout Standard
16530 \begin_inset VSpace bigskip
16536 \begin_layout Standard
16537 If you're looking for the documentation for
16538 \begin_inset Quotes eld
16543 slides (Foil\SpecialChar TeX
16547 \begin_inset Quotes erd
16550 , check out section
16551 \begin_inset space ~
16555 \begin_inset CommandInset ref
16557 reference "sec:foiltex"
16567 \begin_inset Quotes eld
16572 slides (Foil\SpecialChar TeX
16576 \begin_inset Quotes erd
16579 ] is actually somewhat better than the default
16587 \begin_layout Plain Layout
16589 or so I've been told repeatedly by its advocates.
16590 Having never used it, I have no idea if this claim is true or not.
16595 which this section documents.
16598 \begin_layout Standard
16599 This class is the \SpecialChar LaTeX2e
16600 improvement of the old
16602 Sli\SpecialChar TeX
16606 Every \SpecialChar LaTeX2e
16607 distribution includes this class [which I'll just refer to as
16608 \begin_inset Quotes eld
16616 \begin_inset Quotes erd
16619 from now on], so you're bound to have it.
16620 As I noted earlier, there are other classes, such as
16624 , which also produce slides for overhead projectors and do a better job
16626 However, there are some things which
16630 can do which the others can't, such as generate overlays.
16631 Read on to learn more!
16634 \begin_layout Subsection
16636 \begin_inset CommandInset label
16638 name "sec:slidesetup"
16645 \begin_layout Standard
16646 Obviously, to use this document class, you need to select
16647 \begin_inset Quotes eld
16655 \begin_inset Quotes erd
16658 from the class list in the
16660 Document\SpecialChar menuseparator
16664 There are some other special things you should know about this class:
16667 \begin_layout Itemize
16668 Don't bother changing the options
16673 They're not supported by the
16680 \begin_layout Itemize
16684 \begin_inset space ~
16689 behaves a bit differently for this class.
16690 The possible choices and what they do are as follows:
16691 \begin_inset Separator parbreak
16698 \begin_layout Description
16703 The final output contains page numbers in the lower right corner.
16706 \begin_layout Description
16715 , but also prints out any time markers you've put in.
16716 This is the default.
16719 \begin_layout Description
16724 The final output contains no page numbers, time markers, or alignment markers.
16728 \begin_layout Itemize
16733 class has an extra option:
16739 \begin_inset Quotes eld
16747 \begin_inset Quotes erd
16750 in the extra class options.
16751 \begin_inset Separator parbreak
16758 \begin_layout Standard
16759 Using this options allows you to add time markers to
16765 \begin_inset space ~
16769 \begin_inset CommandInset ref
16771 reference "sec:slideNote"
16779 \begin_layout Standard
16780 You can also use the template file
16781 \begin_inset Quotes eld
16789 \begin_inset Quotes erd
16792 to automatically set up a document to use the
16798 File\SpecialChar menuseparator
16800 \begin_inset space ~
16804 \begin_inset space ~
16809 to open your new document].
16810 The template file also contains some examples of the special paragraph
16811 environments used by this class.
16812 I'll describe those next.
16815 \begin_layout Subsection
16816 Paragraph Environments
16819 \begin_layout Subsubsection
16820 Supported Environments
16823 \begin_layout Standard
16824 The first thing you'll notice when you start up a new
16828 document is the font size and type: it's the equivalent of the size
16829 \begin_inset Quotes eld
16837 \begin_inset Quotes erd
16843 \begin_inset space ~
16849 This is also what's used in the output.
16851 \begin_inset Quotes eld
16855 \begin_inset Quotes erd
16858 to remind you that this is a slide.
16859 Your final slides will use a larger font; ergo, you'll have less space.
16860 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
16863 \begin_layout Standard
16864 The next thing that becomes obvious is the changes to the paragraph environment
16865 pull-down box [at the far-left end of the toolbar].
16866 Most of the paragraph environments you're used to seeing are missing.
16867 There are also five new ones.
16872 class itself only supports certain paragraph environments:
16875 \begin_layout Itemize
16881 \begin_layout Itemize
16887 \begin_layout Itemize
16893 \begin_layout Itemize
16899 \begin_layout Itemize
16905 \begin_layout Itemize
16911 \begin_layout Itemize
16917 \begin_layout Itemize
16923 \begin_layout Itemize
16929 \begin_layout Itemize
16936 \begin_layout Itemize
16942 \begin_layout Standard
16943 All of the other standard environments, including the section-heading environmen
16944 ts, aren't used in the
16951 \begin_layout Standard
16952 On the other hand, you'll notice the following new environments:
16955 \begin_layout Itemize
16961 \begin_layout Itemize
16967 \begin_layout Itemize
16973 \begin_layout Itemize
16979 \begin_layout Itemize
16985 \begin_layout Standard
16986 These five are kind of quirky, due to a
16987 \begin_inset Quotes eld
16991 \begin_inset Quotes erd
16994 in \SpecialChar LyX
16996 You see, \SpecialChar LyX
16997 doesn't permit you to nest any other paragraph environment into
16998 an empty environment.
16999 Now, that's fine and dandy, but it means that you wouldn't be able to start
17000 a slide with anything except plain text.
17001 To deal with this, I've performed a little
17002 \begin_inset Quotes eld
17007 \begin_inset Quotes erd
17013 \begin_layout Subsubsection
17014 Quirks of the New Environments
17015 \begin_inset CommandInset label
17017 name "sec:slideQuirk"
17024 \begin_layout Standard
17025 All five of the new paragraph environments are somewhat quirky due to inherent
17026 limitiations in the current version of \SpecialChar LyX
17028 As I just mentioned, \SpecialChar LyX
17029 forbids environments that begin with another environment.
17030 To get around this, the
17034 environment isn't a paragraph environment as described in the
17042 \begin_layout Standard
17043 You should consider
17056 \begin_inset Quotes eld
17059 pseudo-environments.
17060 \begin_inset Quotes erd
17063 They look like a section heading or a
17064 \begin_inset Quotes eld
17072 \begin_inset Quotes erd
17075 but really begin a [and, if necessary, end the previous] paragraph environment.
17085 \begin_inset Quotes eld
17089 \begin_inset Quotes erd
17092 These two perform some action.
17095 \begin_layout Standard
17096 A common feature of all five environments,
17116 , is a rather long-ish label.
17117 The text following this label — ordinarily the contents of the paragraph
17118 environment — is utterly irrelevant for
17140 completely ignores it.
17141 In fact, you can leave these five environments completely empty.
17145 \begin_layout Standard
17150 to put any text after the rather long-ish label, you might want to.
17151 This could be a short description of the contents of the
17156 In that case, enter your descriptive comment and hit
17160 as you normally would.
17163 \begin_layout Standard
17164 If, on the other hand, you don't want to enter any descriptive text, you'll
17165 hit another \SpecialChar LyX
17168 , like nature, abhors a vacuum, and will not let you start a new paragraph
17169 environment until you put something in the old one.
17173 \begin_layout Itemize
17174 Start entering the text that will
17202 \begin_layout Itemize
17203 Now move to the beginning of that paragraph.
17207 \begin_layout Itemize
17216 \begin_layout Itemize
17217 Finally, change this new, empty paragraph to a
17241 \begin_layout Standard
17242 Some future version of \SpecialChar LyX
17243 will, hopefully, resolve this quirkiness\SpecialChar ldots
17247 \begin_layout Subsection
17248 Making a Presentation with
17261 \begin_layout Subsubsection
17269 \begin_layout Standard
17270 If you're expecting this section to teach you how to actually make a presentatio
17271 n, you'll be sorely disappointed.
17272 Naturally, I'll describe all of the ways the
17276 class can assist you in preparing the materials for a presentation.
17277 Filling in the contents, however, is up to you.
17282 the \SpecialChar LyX
17286 \begin_layout Standard
17291 environment [in the manner described in section
17292 \begin_inset space ~
17296 \begin_inset CommandInset ref
17298 reference "sec:slideQuirk"
17302 ] tells \SpecialChar LyX
17303 to begin a new slide [duh].
17304 The label for this environment/
17305 \begin_inset Quotes erd
17309 \begin_inset Quotes erd
17313 \begin_inset Quotes eld
17317 \begin_inset Quotes erd
17320 in cool blue, followed by the label,
17321 \begin_inset Quotes eld
17325 \begin_inset Quotes erd
17329 Any text or paragraph environments that follow this one go on the new slide.
17333 \begin_layout Standard
17334 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17336 (this can be specified in the
17341 In fact, you'll want to, once you finish entering the contents of one slide.
17342 If you've entered more text than can physically fit on a slide, the extra
17343 overflows onto a new slide.
17344 I don't recommend doing this, however, since the overflow slide won't have
17345 any page number on it.
17346 Furthermore, it may interfere with any
17350 you've made to accompany the oversized
17357 \begin_layout Standard
17366 environments work the same way as the
17371 They both create an
17372 \begin_inset Quotes eld
17376 \begin_inset Quotes erd
17379 followed by a label [
17380 \begin_inset Quotes eld
17384 \begin_inset Quotes erd
17388 \begin_inset Quotes eld
17392 \begin_inset Quotes erd
17396 The color is a stunning magenta instead of blue, and the
17397 \begin_inset Quotes eld
17401 \begin_inset Quotes erd
17404 will look different, in style and in length.
17405 The label fonts of all three also differ from one another.
17408 \begin_layout Standard
17413 , if the contents of a
17421 exceed the physical size of a slide or sheet of paper, the extra will overflow
17423 Again, you should avoid this.
17424 It defeats the whole purpose of
17435 \begin_layout Subsubsection
17445 \begin_layout Standard
17450 is a slide that sits atop another slide.
17451 Perhaps you wish to discuss a figure on the main
17455 before displaying the text associated with it.
17456 One way to accomplish this is tape a flap of dark paper over the part of
17461 you want to display later.
17462 This method fails, however, if you wish to overlap one graph with another,
17464 You would then have to fumble while speaking to align the two separate,
17469 s to align the two graphs.
17474 environment in both cases makes life much easier.
17477 \begin_layout Standard
17482 receives the page number of its
17483 \begin_inset Quotes eld
17487 \begin_inset Quotes erd
17495 \begin_inset Quotes eld
17503 \begin_inset Quotes erd
17510 \begin_layout Plain Layout
17511 Presumably, mutliple
17516 \begin_inset Quotes eld
17524 \begin_inset Quotes erd
17528 \begin_inset Quotes eld
17536 \begin_inset Quotes erd
17540 \begin_inset Quotes eld
17548 \begin_inset Quotes erd
17552 \begin_inset space ~
17555 appended to the page number of the parent
17565 Clearly, you want the contents of both the
17573 to each fit on a single physical slide! You should probably consider an
17579 \begin_inset Quotes eld
17583 \begin_inset Quotes erd
17591 Indeed, the \SpecialChar LyX
17596 class provides a visual cue for this: the label at the start of an
17600 is shorter than that at the start of a
17605 Lastly, when you generate printable output, you'll find alignment markers
17606 in all four corners of both the
17610 page and its parent
17615 These will assist you in lining up the two physical slides.
17618 \begin_layout Standard
17619 The major problem in overlaying two slides is aligning the contents of the
17620 two transparencies.
17621 How much space should you leave for that graph on the second slide? Worse
17622 still, what if you want a graph and a sentence on second slide, but there
17623 is text on the main transparency that goes in between them? You could try
17624 and insert vertical space of the right size.
17625 The better way is to use
17636 \begin_layout Standard
17637 As their names imply,
17645 are two command-like paragraph environments that make all subsequent text
17646 invisible and visible, respectively.
17648 \begin_inset space ~
17652 \begin_inset CommandInset ref
17654 reference "sec:slideQuirk"
17658 that you don't place anything
17662 these two environments, however.
17667 , it inserts a centered, sky-blue label into the page reading
17668 \begin_inset Quotes eld
17671 <Invisible Text Follows>
17672 \begin_inset Quotes erd
17676 For paragraphs following this label, the parts of the
17684 ; it doesn't matter which] where they would be contain instead blank space.
17688 \begin_layout Standard
17693 , the corresponding centered label is
17694 \begin_inset Quotes eld
17697 <Visible Text Follows>
17698 \begin_inset Quotes erd
17702 Paragraphs following this label behave normally.
17703 Note that the beginning of a new
17715 automatically shuts off an
17720 It's therefore not necessary to use
17731 \begin_layout Standard
17732 By now, it should be obvious how to create overlay transparencies using
17733 the proper combination of
17752 \begin_layout Enumerate
17757 , including everything that will appear on it, whether on the main slide
17765 \begin_layout Enumerate
17766 Before each figure or paragraph that will appear only on the
17775 If necessary, insert a
17779 environment after the
17786 \begin_layout Enumerate
17791 immediately following the
17798 \begin_layout Enumerate
17799 Copy the contents of this
17810 \begin_layout Enumerate
17815 , change all of the
17826 \begin_layout Standard
17828 You've just made an
17835 \begin_layout Standard
17836 There's one problem with the way I've designed the \SpecialChar LyX
17841 class: you can't make text in the middle of a paragraph invisible, nor
17842 make text in the middle of an invisible paragraph visible again.
17843 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
17848 \begin_layout Plain Layout
17849 The commands of interest are:
17852 \begin_layout Itemize
17857 invisible \SpecialChar ldots
17861 \begin_layout Itemize
17866 visible \SpecialChar ldots
17870 \begin_layout Plain Layout
17872 and need to be marked as \SpecialChar TeX
17875 \begin_inset Quotes eld
17879 \begin_inset Quotes erd
17882 you wish to change goes in between the brackets [and after the
17895 If you don't know how to mark text as \SpecialChar TeX
17896 , see the appropriate section of
17909 \begin_layout Subsubsection
17919 \begin_inset CommandInset label
17921 name "sec:slideNote"
17928 \begin_layout Standard
17937 is associated with a
17938 \begin_inset Quotes eld
17942 \begin_inset Quotes erd
17950 Here, too, the \SpecialChar LyX
17955 class provides visual cues.
17960 is shorter than that of a
17964 [yet longer than that of an
17968 ] and, like the label of an
17972 is shockingly magenta.
17973 Additionally, the printed
17977 has the page number of its
17978 \begin_inset Quotes eld
17982 \begin_inset Quotes erd
17990 \begin_inset Quotes eld
17998 \begin_inset Quotes erd
18002 \begin_inset Quotes eld
18010 \begin_inset Quotes erd
18014 \begin_inset Quotes eld
18022 \begin_inset Quotes erd
18026 You can have multiple
18030 s associated with a single
18042 , you'll probably want to break up long
18046 s so that they fit on a single sheet of paper.
18049 \begin_layout Standard
18054 is obvious: it contains anything additional you might want to say about
18060 It could also be used as a sheet of reminders for a particular
18065 In the case of the latter, you might want to make use of time markers.
18066 Currently, the \SpecialChar LyX
18072 \begin_inset Quotes eld
18076 \begin_inset Quotes erd
18079 support for time markers, a
18081 Sli\SpecialChar TeX
18085 So, you'll have to resort to using the \SpecialChar LaTeX
18089 \begin_layout Standard
18090 To use time markers, you'll need to specify the extra class option
18091 \begin_inset Quotes eld
18099 \begin_inset Quotes erd
18103 \begin_inset space ~
18107 \begin_inset CommandInset ref
18109 reference "sec:slidesetup"
18114 This option turns on timing marks, which will appear in the lower-left-hand
18120 To set what appears in the time marker, you use the \SpecialChar LaTeX
18122 \begin_inset Quotes eld
18132 \begin_inset Quotes erd
18136 \begin_inset Quotes eld
18146 \begin_inset Quotes erd
18150 The arguments of both commands are time measured in seconds.
18152 \begin_inset Quotes eld
18162 \begin_inset Quotes erd
18165 sets the time marker to a given time.
18167 \begin_inset Quotes eld
18177 \begin_inset Quotes erd
18180 increments the time marker by the specified amount.
18181 Using time markers and
18185 s in this fashion, you can remind yourself how much time to spend on a particula
18193 \begin_layout Standard
18194 There's one last feature to describe.
18195 Clearly, you'd like to print out all of your
18203 s on transparencies while printing all of your
18220 with which it is associated.
18221 What's a person to do?
18224 \begin_layout Standard
18225 Luckily, there are two \SpecialChar LaTeX
18226 commands that allow you to select what to print
18228 Both must be placed into the preamble of your document.
18230 \begin_inset Quotes eld
18242 \begin_inset Quotes erd
18245 will cause the output to contain only the
18254 Correspondingly, the command
18255 \begin_inset Quotes eld
18267 \begin_inset Quotes erd
18270 prevents the output of anything but
18275 I'd advise placing both commands in the preamble and initially comment
18277 You can then preview your entire presentation as you write.
18278 When you're done writing, you can then uncomment one of the two to select
18279 what you want to print.
18280 I like to uncomment
18281 \begin_inset Quotes eld
18293 \begin_inset Quotes erd
18296 , print to a file with
18297 \begin_inset Quotes eld
18305 \begin_inset Quotes erd
18308 in its name, comment it back out, then uncomment
18309 \begin_inset Quotes eld
18321 \begin_inset Quotes erd
18325 \begin_inset Quotes eld
18333 \begin_inset Quotes erd
18337 I can then send either file to a printer, loading transparencies or plain
18338 paper as appropriate.
18341 \begin_layout Standard
18342 You can also provide other arguments to the
18343 \begin_inset Quotes eld
18353 \begin_inset Quotes erd
18357 \begin_inset Quotes eld
18367 \begin_inset Quotes erd
18371 See a good \SpecialChar LaTeX
18375 \begin_layout Subsection
18380 Class Template File
18383 \begin_layout Standard
18384 I have also provided a template file,
18385 \begin_inset Quotes eld
18393 \begin_inset Quotes erd
18401 To use it, begin your new presentation with
18406 ile\SpecialChar menuseparator
18408 \begin_inset space ~
18412 \begin_inset space ~
18422 Your new \SpecialChar LyX
18423 presentation file will contain an example
18444 additionally contain an example of the use of
18453 Lastly, the preamble will contain:
18456 \begin_layout LyX-Code
18457 % Uncomment to print out only slides and overlays
18460 \begin_layout LyX-Code
18464 \begin_layout LyX-Code
18470 \begin_inset Newline newline
18476 \begin_layout LyX-Code
18477 % Uncomment to print out only notes
18480 \begin_layout LyX-Code
18484 \begin_layout LyX-Code
18492 \begin_layout Standard
18493 One final thing: I created this class to support the \SpecialChar LaTeX2e
18495 \begin_inset Quotes eld
18500 Sli\SpecialChar TeX
18504 \begin_inset Quotes erd
18507 class, one of the built-in \SpecialChar LaTeX2e
18509 Neither I nor the rest of the \SpecialChar LyX
18510 Team endorse or oppose the use of this built-in
18512 It's here if you want it or need it.
18513 There exist other \SpecialChar LaTeX2e
18514 classes for creating presentations, such as the
18519 \begin_inset space ~
18523 \begin_inset CommandInset ref
18525 reference "sec:foiltex"
18530 \begin_inset Quotes eld
18538 \begin_inset Quotes erd
18541 package [present on some \SpecialChar TeX
18543 The latter is not yet supported under \SpecialChar LyX
18548 \begin_layout Plain Layout
18549 Perhaps you can take on the task\SpecialChar ldots
18555 I know nothing about these other classes.
18556 Try them out to see what sort of alternative they provide.
18559 \begin_layout Chapter
18561 Features needing Extra Software
18564 \begin_layout Section
18565 Checking \SpecialChar TeX
18569 \begin_layout Standard
18575 \begin_layout Subsection
18579 \begin_layout Standard
18588 \begin_layout Plain Layout
18593 is not yet available when you are using the \SpecialChar LaTeX
18594 distribution MiK\SpecialChar TeX
18600 , you'll find in the
18607 \begin_inset space ~
18618 \begin_inset Newline newline
18622 \begin_inset CommandInset href
18624 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18631 \begin_layout Standard
18634 Chk\SpecialChar TeX
18637 package is a program that was written by
18638 \begin_inset Flex Noun
18641 \begin_layout Plain Layout
18643 \begin_inset space ~
18651 in frustration because some constructs in \SpecialChar LaTeX
18652 are sometimes non-intuitive,
18653 and easy to forget.
18654 The program runs over your \SpecialChar LaTeX
18655 file, checks the integrity of the file, and
18656 flags some common errors.
18657 In other technical words, it is
18661 for \SpecialChar LaTeX
18665 \begin_layout Standard
18666 Well, what is a syntax checker doing in \SpecialChar LyX
18667 which is supposed to produce correct
18669 anyways? The answer is simple: Just as
18673 not only checks the
18677 of C programs, but also does
18681 checks for type-errors,
18683 Chk\SpecialChar TeX
18686 catches some common
18690 errors, in addition to the syntactical ones.
18693 Chk\SpecialChar TeX
18696 is capable of detecting several common errors, such as
18699 \begin_layout Itemize
18700 Ellipsis detection:
18701 \begin_inset Newline newline
18704 Use \SpecialChar ldots
18708 \begin_layout Itemize
18709 No space in front of/after parenthesis:
18710 \begin_inset Newline newline
18716 \begin_layout Itemize
18717 Enforcement of normal space after common abbreviations:
18718 \begin_inset Newline newline
18722 \begin_inset space \thinspace{}
18726 \begin_inset space \space{}
18729 is too wide spacing.
18732 \begin_layout Itemize
18733 Enforcement of end-of-sentence space when the last sentence ends with a
18735 \begin_inset Newline newline
18739 And this is wrong spacing.
18742 \begin_layout Itemize
18743 Space in front of labels and similar commands:
18744 \begin_inset Newline newline
18747 The label should stick right up to the text to avoid falling to a wrong
18750 \begin_inset CommandInset label
18760 \begin_layout Plain Layout
18761 This footnote is in danger of falling off to a wrong page
18766 The label is separated too much.
18769 \begin_layout Itemize
18770 Space in front of references, instead of hard spaces:
18771 \begin_inset Newline newline
18774 If you have bad luck, the text will break right between the referenced text
18775 and reference number, and that's a pity.
18777 \begin_inset CommandInset ref
18779 reference "sec:chktex"
18786 \begin_layout Itemize
18788 \begin_inset Quotes eld
18792 \begin_inset Quotes erd
18796 \begin_inset Formula $\times$
18800 \begin_inset Newline newline
18803 2x2 looks cheap compared to
18804 \begin_inset Formula $2\times2$
18810 \begin_layout Standard
18811 and more \SpecialChar ldots
18812 It is an invaluable tool when you are
18813 \begin_inset Quotes eld
18817 \begin_inset Quotes erd
18820 your document before printing, and you should run it right after the obligatory
18821 spelling check, and before you go fine tuning the typesetting.
18824 \begin_layout Subsection
18828 \begin_layout Standard
18829 If you have the program installed, usage is as simple as choosing
18831 Tools\SpecialChar menuseparator
18833 \begin_inset space ~
18839 This will make \SpecialChar LyX
18840 generate a \SpecialChar LaTeX
18841 file of your document, start
18843 Chk\SpecialChar TeX
18846 to check it, and then make \SpecialChar LyX
18848 \begin_inset Quotes eld
18852 \begin_inset Quotes erd
18855 with the warnings from
18857 Chk\SpecialChar TeX
18860 , if there were any.
18861 The warnings will be placed close to the point of the mistake, and you
18862 can quickly find them by using the
18864 Navigate\SpecialChar menuseparator
18867 menu item, or the shortcut key
18876 Open the error boxes by clicking on them with the mouse, or use the shortcut
18885 bindings, or the corresponding
18894 Read the warning and correct the mistake, if it is a mistake.
18895 If you have trouble understanding what the warning is about, you can safely
18897 Remember that there is a hidden layer between the document on screen and
18898 the technical details in invoking
18900 Chk\SpecialChar TeX
18903 , and this gap can make some warnings seem arcane or just plain silly.
18906 \begin_layout Standard
18907 This document is an excellent testing bed for the feature, and it should
18908 provide quite a few warnings for you to fiddle with.
18909 Since computers are only so smart, expect most of the warnings to be false
18913 \begin_layout Subsection
18914 How to fine tune it
18917 \begin_layout Standard
18918 Sometimes, you'll find that
18920 Chk\SpecialChar TeX
18923 makes more noise than suits your mood.
18924 Then you can choose not to use it, wait until your mood changes, or try
18927 Chk\SpecialChar TeX
18930 to get better along with you.
18933 \begin_layout Standard
18936 Chk\SpecialChar TeX
18943 very configurable and extensible, you should not expect to solve all problems
18946 Chk\SpecialChar TeX
18949 in \SpecialChar LyX
18951 Since \SpecialChar LyX
18952 has to generate a somewhat special \SpecialChar LaTeX
18953 file to be able to match the
18954 line numbers from the
18956 Chk\SpecialChar TeX
18963 \begin_layout Plain Layout
18964 You can inspect the specific output from
18970 Document\SpecialChar menuseparator
18973 \begin_inset space ~
18987 to the internal document structure, some of the warnings will not appear
18989 There are two things you can do about this:
18992 \begin_layout Itemize
18995 Chk\SpecialChar TeX
18998 invocation command line in
18999 \begin_inset Flex Noun
19002 \begin_layout Plain Layout
19003 Tools\SpecialChar menuseparator
19004 Preferences\SpecialChar menuseparator
19005 Output\SpecialChar menuseparator
19006 LaTeX\SpecialChar menuseparator
19014 Chk\SpecialChar TeX
19017 installation configuration file (usually with the file
19022 See below to learn what warnings can be enabled and disabled on the command
19026 \begin_layout Itemize
19027 Export your document as a raw \SpecialChar LaTeX
19030 File\SpecialChar menuseparator
19031 Export\SpecialChar menuseparator
19040 Invoked in this way, it can be a hassle to find the corresponding place
19041 in the document inside \SpecialChar LyX
19042 , but with a little patience, you should be able
19046 \begin_layout Standard
19047 Here follows the warning messages that can be enabled and disabled in
19056 to disable a warning, and
19060 to enable a warning.
19061 The emphasized entries are disabled by default, because the default is
19064 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19069 \begin_layout Standard
19070 Notice that you should only use the options that enable and disable warnings,
19071 because \SpecialChar LyX
19072 relies on some of the other command line parameters to be set
19073 in a specific way to have a chance to communicate with
19080 \begin_layout Enumerate
19084 Command terminated with space.
19087 \begin_layout Enumerate
19090 Non-breaking space (
19091 \begin_inset Quotes eld
19099 \begin_inset Quotes erd
19102 ) should have been used.
19105 \begin_layout Enumerate
19109 You should enclose the previous parenthesis with
19110 \begin_inset Quotes eld
19118 \begin_inset Quotes erd
19124 \begin_layout Enumerate
19127 Italic correction (
19128 \begin_inset Quotes eld
19138 \begin_inset Quotes erd
19141 ) found in non-italic buffer.
19144 \begin_layout Enumerate
19147 Italic correction (
19148 \begin_inset Quotes eld
19158 \begin_inset Quotes erd
19161 ) found more than once.
19164 \begin_layout Enumerate
19168 No italic correction (
19169 \begin_inset Quotes eld
19179 \begin_inset Quotes erd
19185 \begin_layout Enumerate
19189 \begin_inset Quotes eld
19197 \begin_inset Quotes erd
19201 \begin_inset Quotes eld
19209 \begin_inset Quotes erd
19215 \begin_layout Enumerate
19218 Wrong length of dash may have been used.
19221 \begin_layout Enumerate
19225 \begin_inset Quotes eld
19233 \begin_inset Quotes erd
19237 \begin_inset Quotes eld
19245 \begin_inset Quotes erd
19251 \begin_layout Enumerate
19255 \begin_inset Quotes eld
19263 \begin_inset Quotes erd
19269 \begin_layout Enumerate
19273 \begin_inset Quotes eld
19281 \begin_inset Quotes erd
19284 to achieve an ellipsis.
19287 \begin_layout Enumerate
19290 Inter-word spacing (
19291 \begin_inset Quotes eld
19301 \begin_inset Quotes eld
19304 ) should perhaps be used.
19307 \begin_layout Enumerate
19310 Inter-sentence spacing (
19311 \begin_inset Quotes eld
19321 \begin_inset Quotes erd
19324 ) should perhaps be used.
19327 \begin_layout Enumerate
19330 Could not find argument for command.
19333 \begin_layout Enumerate
19337 \begin_inset Quotes eld
19345 \begin_inset Quotes erd
19351 \begin_layout Enumerate
19354 Math mode still on at end of \SpecialChar LaTeX
19358 \begin_layout Enumerate
19362 \begin_inset Quotes eld
19370 \begin_inset Quotes erd
19373 doesn't match the number of
19374 \begin_inset Quotes eld
19382 \begin_inset Quotes erd
19388 \begin_layout Enumerate
19391 You should use either
19394 \begin_inset Quotes eld
19402 \begin_inset Quotes erd
19407 as an alternative to
19408 \begin_inset Quotes eld
19416 \begin_inset Quotes erd
19422 \begin_layout Enumerate
19429 " (ASCII 39) instead of "
19436 \begin_layout Enumerate
19439 User-specified pattern found.
19442 \begin_layout Enumerate
19445 This command might not be intended.
19448 \begin_layout Enumerate
19455 \begin_layout Enumerate
19473 \begin_layout Enumerate
19476 Delete this space to maintain correct page references.
19479 \begin_layout Enumerate
19483 You might wish to put this between a pair of
19484 \begin_inset Quotes eld
19492 \begin_inset Quotes erd
19498 \begin_layout Enumerate
19501 You ought to remove spaces in front of punctuation.
19504 \begin_layout Enumerate
19507 Could not execute \SpecialChar LaTeX
19511 \begin_layout Enumerate
19520 in front of small punctuation.
19523 \begin_layout Enumerate
19531 may look prettier here.
19534 \begin_layout Enumerate
19538 Multiple spaces detected in output.
19541 \begin_layout Enumerate
19544 This text may be ignored.
19547 \begin_layout Enumerate
19553 \begin_inset Quotes eld
19558 to begin quotation, not
19565 \begin_layout Enumerate
19572 to end quotation, not
19575 \begin_inset Quotes eld
19583 \begin_layout Enumerate
19589 \begin_layout Enumerate
19592 You should perhaps use
19593 \begin_inset Quotes eld
19601 \begin_inset Quotes erd
19607 \begin_layout Enumerate
19610 You should put a space in front of/after parenthesis.
19613 \begin_layout Enumerate
19616 You should avoid spaces in front of/after parenthesis.
19619 \begin_layout Enumerate
19623 You should not use punctuation in front of/after quotes.
19626 \begin_layout Enumerate
19629 Double space found.
19632 \begin_layout Enumerate
19635 You should put punctuation outside inner/inside display math mode.
19638 \begin_layout Enumerate
19641 You ought to not use primitive \SpecialChar TeX
19642 in \SpecialChar LaTeX
19646 \begin_layout Enumerate
19649 You should remove spaces in front of
19650 \begin_inset Quotes eld
19658 \begin_inset Quotes erd
19664 \begin_layout Enumerate
19667 \begin_inset Quotes eld
19675 \begin_inset Quotes erd
19678 is normally not followed by
19679 \begin_inset Quotes eld
19687 \begin_inset Quotes erd
19693 \begin_layout Standard
19694 In later versions of \SpecialChar LyX
19695 , we hope to provide a more complete interface to this
19696 tool (and it's smaller cousin
19700 ) to exploit the full power of it.
19701 But it's not exactly useless as it is now: go try it on one of your existing
19702 documents of a certain length and be surprised.
19705 \begin_layout Section
19706 Version Control in \SpecialChar LyX
19710 \begin_layout Standard
19713 Lars Gullik Bjønnes
19720 \begin_layout Subsection
19724 \begin_layout Standard
19726 supports some of the most basic RCS/CVS/SVN/GIT commands.
19727 If you need something a bit more sophisticated you will have to do that
19728 manually in a terminal.
19731 \begin_layout Standard
19732 Also note that CVS support is not as good as subversion support so we advise
19734 A good place to start learning Subversion is SVN Book
19738 \begin_layout Plain Layout
19739 \begin_inset CommandInset href
19741 target "http://svnbook.red-bean.com/"
19751 In the case of RCS you should read
19752 \begin_inset Quotes eld
19756 \begin_inset Quotes erd
19759 (a man file, read it with
19764 This file describes all the basic features of RCS.
19765 You should especially notice the comment about a RCS directory, and the
19766 notion of a master RCS file (the file ending in
19773 \begin_layout Standard
19774 Before you begin to use the version control features in \SpecialChar LyX
19776 familiar with RCS/CVS/SVN/GIT usage.
19777 The implementation in \SpecialChar LyX
19778 assumes a recent version of the GNU RCS or CVS/SVN
19779 package — no guarantees are made for older versions.
19780 Most of the log messages are not currently displayed after operations —
19781 you can check them in the Messages pane if unsure.
19782 Regular users of version control will appreciate VC toolbar, which can
19785 View\SpecialChar menuseparator
19786 Toolbars\SpecialChar menuseparator
19788 \begin_inset space ~
19796 \begin_layout Standard
19797 For introducing your own external commands consult vc-command in the manual
19798 of \SpecialChar LyX
19802 \begin_layout Standard
19803 It is strongly recommended to store documents in uncompressed format if
19804 using version control (uncheck
19806 Document\SpecialChar menuseparator
19809 if it is checked): Uncompressed LyX documents are text files and therefore
19810 for merging two different versions by version control systems.
19811 Compressed LyX documents are binary files, which cannot be merged by version
19815 \begin_layout Subsection
19816 RCS commands in \SpecialChar LyX
19820 \begin_layout Standard
19821 The following sections describe the RCS commands supported by \SpecialChar LyX
19823 You can find them in the
19825 File\SpecialChar menuseparator
19827 \begin_inset space ~
19834 was tested against RCS 5.7/5.8.
19837 \begin_layout Subsubsection
19843 \begin_layout Standard
19844 If your document is not under revision control, this is the only item shown
19846 And if it is under revision control, the
19850 item is not visible.
19854 \begin_layout Standard
19855 This command registers your document with RCS (unless you are under the
19856 directory managed by CVS)\SpecialChar endofsentence
19857 You are asked interactively to supply an initial
19858 description of the document.
19859 The document is now set in Read-Only mode and you have to
19862 \begin_inset space ~
19866 \begin_inset space ~
19870 \begin_inset space ~
19875 , before making any changes to it.
19876 A document under revision control has a
19877 \begin_inset Quotes eld
19880 [RCS:<version> <locker>]
19881 \begin_inset Quotes erd
19884 item tagged to the filename in the minibuffer.
19887 \begin_layout Standard
19888 RCS command that is run:
19890 ci -q -u -i -t-"<initial description>" <file-name>
19893 \begin_layout Standard
19898 to understand the switches.
19902 \begin_layout Subsubsection
19908 \begin_layout Standard
19909 When you are finished editing a file, you check in your changes.
19910 When you do this, you are asked for a description of the changes.
19911 This is stored in the history log.
19912 The version number is bumped, your changes are applied to the master RCS
19913 file, the document is unlocked and set to Read-Only mode.
19916 \begin_layout Standard
19919 ci -q -u -m"<description>" <file-name>
19922 \begin_layout Subsubsection
19928 \begin_layout Standard
19929 By doing this you lock the document so that only you can edit it.
19930 This will also make the document Read-Write only for you.
19931 You will usually continue editing for a while and when you are finished
19932 you check in your changes.
19933 The status line is changed to reflect that you have locked the file.
19936 \begin_layout Standard
19939 co -q -l <file-name>
19942 \begin_layout Subsubsection
19945 Revert To Repository Version
19948 \begin_layout Standard
19949 This will discard all changes made to the document since the last check
19951 You get a warning before changes are discarded.
19954 \begin_layout Standard
19957 co -f -u<version> <file-name>
19960 \begin_layout Subsubsection
19966 \begin_layout Standard
19967 This will create a copy of the current document.
19968 Since RCS does not support copy operations natively, the version history
19969 is not preserved, and the copy is added as a new file.
19970 It requires a clean document without any changes since the last checkin.
19971 You are asked for a file name and a description of the copy operation.
19972 After that the copy is created, both locally and in the repository.
19973 If the parent directories of the copied and original document differ, all
19974 relative paths of included files of the copy are adjusted (like in
19976 File\SpecialChar menuseparator
19981 Finally, the copy is loaded instead of the original document.
19984 \begin_layout Labeling
19985 \labelwidthstring 00.00.0000
19987 \begin_inset space ~
19991 \begin_inset space ~
19995 \begin_inset Newline newline
19999 \begin_inset Flex Code
20002 \begin_layout Plain Layout
20005 \begin_inset Quotes eld
20009 \begin_inset Quotes erd
20018 \begin_inset Flex Code
20021 \begin_layout Plain Layout
20024 \begin_inset Quotes eld
20028 \begin_inset Quotes erd
20037 \begin_inset Newline newline
20041 \begin_inset Flex Code
20044 \begin_layout Plain Layout
20048 \begin_inset Quotes eld
20052 \begin_inset Quotes erd
20063 \begin_layout Subsubsection
20069 \begin_layout Standard
20070 This makes as if the last check in never happened.
20071 No changes are made to the document loaded into \SpecialChar LyX
20072 , but the last version
20073 is removed from the master RCS file.
20076 \begin_layout Standard
20079 rcs -o<version> <file-name>
20082 \begin_layout Subsubsection
20088 \begin_layout Standard
20089 This shows the complete history of the RCS document.
20094 is shown in a browser.
20102 \begin_layout Subsubsection
20106 \begin_layout Standard
20108 supports RCS version number, author name, date and time of last commit.
20109 All those are extracted from
20111 rlog -r <file-name>
20115 \begin_inset CommandInset ref
20117 reference "subsec:VCS-Revision-Information"
20124 \begin_layout Subsection
20125 CVS commands in \SpecialChar LyX
20129 \begin_layout Standard
20130 A subset of CVS operations is supported by \SpecialChar LyX
20132 You can find the commands in the
20134 File\SpecialChar menuseparator
20136 \begin_inset space ~
20142 The version control system SVN is more powerful, so please use it instead
20143 of CVS if possible.
20146 \begin_layout Subsubsection
20152 \begin_layout Standard
20153 If you start from scratch with CVS you have to create your repository and
20154 checkout the working copy with external tools.
20155 If you're using a client-server setup you may need to login before doing
20156 the first repository checkout.
20159 \begin_layout Standard
20160 If your documents are under revision control and others are using the same
20161 repository problems arise when different changes to the same document at
20162 the same location happen.
20163 Standard CVS repositories don't operate with a file locking mechanism.
20164 This may be surprising, but conflicts only occur if people disagree on
20165 the proper content of the same part of a document.
20166 So, if co-workers are used to communicate regularly, these conflicts occur
20168 If they don't communicate they have a fundamental problem anyway.
20169 Nevertheless some people like to work with so called
20170 \begin_inset Quotes eld
20174 \begin_inset Quotes erd
20178 If they do so the working copy of all files is readonly when checked out
20179 first and the user starts editing after using a special command to make
20180 the working copy writable.
20181 When the changes are checked in the working copy returns to readonly state.
20182 With \SpecialChar LyX
20183 one has to edit the
20184 \begin_inset Flex Code
20187 \begin_layout Plain Layout
20193 file and add the line
20194 \begin_inset Flex Code
20197 \begin_layout Plain Layout
20203 to work with reserved checkouts.
20204 The benefit is the possibility to see who is using a writable copy of some
20206 It's not guaranteed only one user makes a copy writable.
20209 \begin_layout Standard
20211 tries to guess if you're using reserved or non-reserved checkouts.
20212 If your working copy is readonly or it is writable and an additional copy
20213 of your document exists in the CVS/Base sub-directory a reserved otherwise
20214 a non-reserved checkout is assumed.
20215 When a reserved checkout is detected you have to use
20216 \begin_inset Flex Noun
20219 \begin_layout Plain Layout
20225 to make your working copy writable if it's readonly.
20227 \begin_inset Flex Noun
20230 \begin_layout Plain Layout
20236 operation is possible and that makes your working copy readonly again after
20237 transferring your changes to the repository.
20240 \begin_layout Standard
20241 More information about CVS can be found here
20242 \begin_inset Flex URL
20245 \begin_layout Plain Layout
20247 http://www.nongnu.org/cvs
20253 \begin_inset Flex URL
20256 \begin_layout Plain Layout
20258 http://ximbiot.com/cvs
20266 \begin_layout Standard
20271 to understand the sub-commands and the switches mentioned below.
20274 \begin_layout Subsubsection
20280 \begin_layout Standard
20281 If your document is not under revision control, this is the only item shown
20283 And if it is under revision control, the
20290 item is not visible.
20294 \begin_layout Standard
20295 This command registers in CVS your document
20296 \begin_inset Flex Strong
20299 \begin_layout Plain Layout
20307 in the case you have already the documents directory under CVS control
20313 This means you have to create or checkout the archive by yourself using
20315 (In case you forget that step \SpecialChar LyX
20316 registers the document with RCS.)
20319 \begin_layout Standard
20320 Then you are asked interactively to supply an initial description of the
20322 Don't forget that registered file is not yet checked in.
20325 \begin_layout Standard
20326 CVS command that is run:
20328 cvs -q add -m"<entered message>" "<file-name>"
20331 \begin_layout Standard
20336 above and for all other CVS commands is an abbreviation for
20337 \begin_inset Quotes eld
20340 change the current working directory to file location and use the file name
20341 without path component as argument
20342 \begin_inset Quotes erd
20348 \begin_layout Subsubsection
20354 \begin_layout Standard
20355 When you are finished editing a file, you commit your changes.
20356 When you do this and you had changed the document, you are asked for a
20357 description of the changes.
20358 After that changes are written to the repository.
20359 In case you didn't change the document and a reserved checkout is detected
20360 the reservation made on
20361 \begin_inset Flex Noun
20364 \begin_layout Plain Layout
20373 \begin_layout Labeling
20374 \labelwidthstring 00.00.0000
20376 \begin_inset space ~
20380 \begin_inset space ~
20384 \begin_inset Newline newline
20388 \begin_inset Flex Code
20391 \begin_layout Plain Layout
20394 -q commit -m"<description>" "<file-name>"
20400 \begin_inset Newline newline
20404 \begin_inset Flex Code
20407 \begin_layout Plain Layout
20418 \begin_layout Subsubsection
20424 \begin_layout Standard
20425 When you are sharing a repository with others, you may have to incorporate
20426 their changes into your working copy.
20429 \begin_layout Standard
20432 cvs -q update "<file-name>"
20435 \begin_layout Standard
20436 If a readonly checkout is detected the working copy is made writable and
20440 \begin_layout Standard
20443 cvs -q edit "<file-name>"
20446 \begin_layout Subsubsection
20449 Revert To Repository Version
20452 \begin_layout Standard
20453 This will discard all changes made to the document since the last check
20455 You get a warning before changes are discarded.
20456 Firstly the file is deleted, secondly CVS update command is run.
20459 \begin_layout Standard
20462 cvs -q update "<file-name>"
20465 \begin_layout Standard
20466 If a reserved checkout is detected and the working copy has no changes only
20467 the reservation is undone.
20470 \begin_layout Standard
20473 cvs -q unedit "<file-name>"
20476 \begin_layout Subsubsection
20482 \begin_layout Standard
20483 This will create a copy of the current document.
20484 Since CVS does not support copy operations natively, the version history
20485 is not preserved, and the copy is added as a new file.
20486 It requires a clean document without any changes since the last checkin.
20487 You are asked for a file name and a description of the copy operation.
20488 After that the copy is created, both locally and in the repository.
20489 If the parent directories of the copied and original document differ, all
20490 relative paths of included files of the copy are adjusted (like in
20492 File\SpecialChar menuseparator
20497 Finally, the copy is loaded instead of the original document.
20500 \begin_layout Labeling
20501 \labelwidthstring 00.00.0000
20503 \begin_inset space ~
20507 \begin_inset space ~
20511 \begin_inset Newline newline
20515 \begin_inset Flex Code
20518 \begin_layout Plain Layout
20521 \begin_inset Quotes eld
20525 \begin_inset Quotes erd
20534 \begin_inset Flex Code
20537 \begin_layout Plain Layout
20540 \begin_inset Quotes eld
20544 \begin_inset Quotes erd
20553 \begin_inset Newline newline
20557 \begin_inset Flex Code
20560 \begin_layout Plain Layout
20564 \begin_inset Quotes eld
20568 \begin_inset Quotes erd
20579 \begin_layout Subsubsection
20585 \begin_layout Standard
20586 This will rename the current document.
20587 Since CVS does not support rename operations natively, the version history
20588 is not preserved, the renamed document is added as a new file, and the
20589 original document is deleted.
20590 It requires a clean document without any changes since the last checkin.
20591 You are asked for a file name and a description of the rename operation.
20592 After that the document is renamed, both locally and in the repository.
20593 If the parent directories of the new and old file names differ, all relative
20594 paths of included files are adjusted (like in
20596 File\SpecialChar menuseparator
20601 Finally, the document is reloaded using the new name.
20604 \begin_layout Labeling
20605 \labelwidthstring 00.00.0000
20607 \begin_inset space ~
20611 \begin_inset space ~
20615 \begin_inset Newline newline
20619 \begin_inset Flex Code
20622 \begin_layout Plain Layout
20625 \begin_inset Quotes eld
20629 \begin_inset Quotes erd
20638 \begin_inset Flex Code
20641 \begin_layout Plain Layout
20644 \begin_inset Quotes eld
20648 \begin_inset Quotes erd
20657 \begin_inset Newline newline
20661 \begin_inset Flex Code
20664 \begin_layout Plain Layout
20668 \begin_inset Quotes eld
20672 \begin_inset Quotes erd
20681 \begin_inset Newline newline
20685 \begin_inset Flex Code
20688 \begin_layout Plain Layout
20692 \begin_inset Quotes eld
20696 \begin_inset Quotes erd
20707 \begin_layout Subsubsection
20708 Update of the local directory checkout from repository
20711 \begin_layout Standard
20712 Once your documents gets more complex, containing sub-documents and pictures,
20714 \begin_inset Flex Code
20717 \begin_layout Plain Layout
20723 files and so on using version control becomes more complicated.
20725 supports updating the whole tree in which resides the document.
20726 This become especially useful once you cooperate with people which neither
20727 have detailed knowledge about CVS usage nor they have ambition to commit
20728 additional material to the repository.
20729 You have to organize the files structure so that all external files are
20730 in the same directory or subdirectories of the document.
20731 It's good practice anyway to store multipart documents in an extra directory.
20734 \begin_layout Standard
20736 \begin_inset Flex Code
20739 \begin_layout Plain Layout
20740 Update local directory from repository
20745 command updates the whole directory.
20746 If local changes are detected user is warned before update starts.
20747 In case of merge conflicts both versions of the conflicting document parts
20748 are placed in the final document.
20749 You have to review and correct the result of the merge.
20750 You'll find the conflicts enclosed in pairs of
20751 \begin_inset Flex Code
20754 \begin_layout Plain Layout
20761 \begin_inset Flex Code
20764 \begin_layout Plain Layout
20771 \begin_inset Flex Code
20774 \begin_layout Plain Layout
20781 The first part is your version as before the update operation with the
20782 document name prepended.
20783 The second one is the repository version with the version number after
20785 \begin_inset Flex Code
20788 \begin_layout Plain Layout
20797 \begin_layout Labeling
20798 \labelwidthstring 00.00.0000
20800 \begin_inset space ~
20804 \begin_inset space ~
20808 \begin_inset Newline newline
20812 \begin_inset Flex Code
20815 \begin_layout Plain Layout
20823 (Ask if changes are detected.)
20824 \begin_inset Newline newline
20828 \begin_inset Flex Code
20831 \begin_layout Plain Layout
20832 cd $path; cvs -q update
20842 \begin_layout Standard
20844 \begin_inset Flex Code
20847 \begin_layout Plain Layout
20853 stands for the path to the document.
20856 \begin_layout Subsubsection
20862 \begin_layout Standard
20863 This shows the complete history of the CVS document.
20866 cvs log "<file-name>"
20868 is shown in a browser.
20871 \begin_layout Subsubsection
20875 \begin_layout Standard
20877 supports CVS version number, author name, date and time of last commit.
20878 All those are extracted from
20880 cvs log -r <file-name>
20884 \begin_inset CommandInset ref
20886 reference "subsec:VCS-Revision-Information"
20893 \begin_layout Subsection
20894 SVN commands in \SpecialChar LyX
20898 \begin_layout Standard
20899 SVN is now partially supported by \SpecialChar LyX
20901 You can find the commands in the
20903 File\SpecialChar menuseparator
20905 \begin_inset space ~
20911 Please note that if you use password protected access to repository via
20912 ssh, you will be asked in terminal window.
20914 was tested against SVN 1.5, 1.6, 1.7 and 1.8
20918 \begin_layout Plain Layout
20919 Most of the commands will work with 1.4 too, see
20920 \begin_inset CommandInset ref
20922 reference "subsec:SVN-Repo-Update"
20927 There seems to be currently unresolved permissions problem under SVN 1.8
20928 with reverting changes when file is locked.
20936 \begin_layout Subsubsection
20942 \begin_layout Standard
20943 If your document is not under revision control, this is the only item shown
20945 And if it is under revision control, the
20952 item is not visible.
20955 \begin_layout Standard
20956 This command registers in SVN your document ONLY in case you have already
20957 the documents directory under SVN control (in particular
20962 This means you have to checkout the archive by yourself.
20965 \begin_layout Standard
20966 Then you are asked interactively to supply an initial description of the
20968 Don't forget that registered file is not yet commited.
20971 \begin_layout Standard
20972 SVN command that is run:
20975 \begin_inset Quotes eld
20979 \begin_inset Quotes erd
20985 \begin_layout Standard
20990 to understand the switches.
20993 \begin_layout Subsubsection
20999 \begin_layout Standard
21000 When you are finished editing a file, you commit your changes.
21001 When you do this, you are asked for a description of the changes.
21002 After that changes are commited.
21005 \begin_layout Standard
21010 \begin_layout Plain Layout
21011 In case locking is not enabled.
21013 \begin_inset CommandInset ref
21015 reference "subsec:SVN-File-Locking"
21026 svn commit -q -m"<description>" <file-name>
21029 \begin_layout Subsubsection
21035 \begin_layout Standard
21036 Updates the changes of this file from the repository.
21037 Be sure you understand SVN merging and conflicts resolving before using
21038 this function, because all conflicts has to be resolved manually by you!
21041 \begin_layout Standard
21046 \begin_layout Plain Layout
21054 svn update --non-interactive
21055 \begin_inset Quotes eld
21059 \begin_inset Quotes erd
21065 \begin_layout Subsubsection
21068 Revert To Repository Version
21071 \begin_layout Standard
21072 This will discard all changes made to the document since the last check
21074 You get a warning before changes are discarded.
21077 \begin_layout Standard
21081 \begin_inset Quotes eld
21085 \begin_inset Quotes erd
21091 \begin_layout Subsubsection
21097 \begin_layout Standard
21098 This will create a copy of the current document including the version history.
21099 It requires a clean document without any changes since the last checkin.
21100 You are asked for a file name and a description of the copy operation.
21101 After that the copy is created, both locally and in the repository.
21102 If the parent directories of the copied and original document differ, all
21103 relative paths of included files of the copy are adjusted (like in
21105 File\SpecialChar menuseparator
21110 Finally, the copy is loaded instead of the original document.
21113 \begin_layout Labeling
21114 \labelwidthstring 00.00.0000
21116 \begin_inset space ~
21120 \begin_inset space ~
21124 \begin_inset Newline newline
21128 \begin_inset Flex Code
21131 \begin_layout Plain Layout
21135 \begin_inset Quotes eld
21139 \begin_inset Quotes erd
21143 \begin_inset Quotes eld
21147 \begin_inset Quotes erd
21156 \begin_inset Newline newline
21160 \begin_inset Flex Code
21163 \begin_layout Plain Layout
21172 \begin_layout Subsubsection
21178 \begin_layout Standard
21179 This will rename the current document including the version history.
21180 It requires a clean document without any changes since the last checkin.
21181 You are asked for a file name and a description of the rename operation.
21182 After that the document is renamed, both locally and in the repository.
21183 If the parent directories of the new and old file names differ, all relative
21184 paths of included files are adjusted (like in
21186 File\SpecialChar menuseparator
21191 Finally, the document is reloaded using the new name.
21194 \begin_layout Labeling
21195 \labelwidthstring 00.00.0000
21197 \begin_inset space ~
21201 \begin_inset space ~
21205 \begin_inset Newline newline
21209 \begin_inset Flex Code
21212 \begin_layout Plain Layout
21216 \begin_inset Quotes eld
21220 \begin_inset Quotes erd
21224 \begin_inset Quotes eld
21228 \begin_inset Quotes erd
21237 \begin_inset Newline newline
21241 \begin_inset Flex Code
21244 \begin_layout Plain Layout
21253 \begin_layout Subsubsection
21254 \begin_inset CommandInset label
21256 name "subsec:SVN-Repo-Update"
21260 Update of the local directory checkout from repository
21264 \begin_layout Plain Layout
21265 Note that this command will work only with subversion
21266 \begin_inset Formula $\geqq1.5$
21277 \begin_layout Standard
21278 All the commands above have one shortcomming - they deal with the current
21280 Once your document contains pictures, includes external
21281 \begin_inset Flex Code
21284 \begin_layout Plain Layout
21290 files and so on administration becomes more complicated.
21292 now supports updating the whole tree in which resides the document
21296 \begin_layout Plain Layout
21297 One need to organize the files structure so that all external files are
21298 in the same directory or subdirectories of the document.
21305 This become especially useful once you cooperate with people which neither
21306 know about subversion management nor they have ambition to commit additional
21307 material to the repository.
21311 \begin_layout Standard
21312 \begin_inset Flex Code
21315 \begin_layout Plain Layout
21316 Update local directory from repository
21321 command updates the whole directory and in case of merge conflicts local
21322 version of the files are left, so no unintended data loss occurs.
21323 If local changes are detected user is warned before update starts.
21326 \begin_layout Labeling
21327 \labelwidthstring 00.00.0000
21329 \begin_inset space ~
21333 \begin_inset space ~
21337 \begin_inset Newline newline
21341 \begin_inset Flex Code
21344 \begin_layout Plain Layout
21350 (Ask if changes are detected.)
21351 \begin_inset Newline newline
21355 \begin_inset Flex Code
21358 \begin_layout Plain Layout
21359 svn update –accept mine-full $path
21367 \begin_layout Standard
21369 \begin_inset Flex Code
21372 \begin_layout Plain Layout
21378 stands for the path to the document.
21381 \begin_layout Subsubsection
21387 \begin_layout Standard
21388 This shows the complete history of the SVN document.
21392 \begin_inset Quotes eld
21396 \begin_inset Quotes erd
21401 is shown in a browser.
21404 \begin_layout Subsubsection
21406 \begin_inset CommandInset label
21408 name "subsec:SVN-File-Locking"
21415 \begin_layout Standard
21416 The file exchange through various revision control systems brings the problem
21417 of merge conflicts in case two different users try to edit the same (parts
21419 When such a conflict happens it needs manual resolving and one reasonable
21420 alternative is to provide some kind of locking mechanism, which guarantees
21421 that only one user is allowed to edit file at the given time.
21424 \begin_layout Standard
21425 SVN has two such mechanisms to provide mutual exclusivity for file access
21426 - locks and automatic setting of write permissions (see sec.
21428 \begin_inset CommandInset ref
21430 reference "subsec:Automatical-Locking-Property"
21435 \begin_inset Flex Code
21438 \begin_layout Plain Layout
21448 \begin_layout Plain Layout
21449 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21455 If this property is detected for a given document \SpecialChar LyX
21456 starts to use SVN locks
21457 for document editing automatically and the whole check-in/out mechanism
21458 switches to the same regimen as for RCS.
21459 This in particular means there are two different modes of file use in \SpecialChar LyX
21463 \begin_layout Itemize
21465 The loaded file is in the read-only mode.
21466 For editing on needs to check-out.
21471 consists of updating from the repository and gaining write lock.
21472 If the lock is not possible to obtain, we remain in unlocked state.
21475 \begin_layout Itemize
21477 The loaded file is in the 'normal' edit mode.
21478 No other user is allowed to edit the file.
21483 consists of commiting changes and releasing write-lock.
21484 If no changes have been made to the document, no commit will be produced
21488 \begin_layout Plain Layout
21489 Don't be puzzled by the fact that you will be asked for commit message anyway.
21494 and only the write-lock will be released.
21497 \begin_layout Standard
21501 \begin_layout Labeling
21502 \labelwidthstring 00.00.0000
21505 svn commit -q -m"<description>" "<file-name>"
21506 \begin_inset Newline newline
21509 svn unlock "<file-name>"
21512 \begin_layout Labeling
21513 \labelwidthstring 00.00.0000
21516 svn update "<file-name>"
21517 \begin_inset Newline newline
21520 svn lock "<file-name>"
21523 \begin_layout Subsubsection
21526 \begin_inset CommandInset label
21528 name "subsec:Automatical-Locking-Property"
21534 Automatic Locking Property
21537 \begin_layout Standard
21538 The above mentioned automatic setting of write permissions of the .lyx file
21544 ile\SpecialChar menuseparator
21550 \begin_inset space ~
21553 Control\SpecialChar menuseparator
21558 oggle locking property
21561 This command is active only when the file is not locked on the svn server
21563 you need to check-out before proceeding).
21566 \begin_layout Labeling
21567 \labelwidthstring 00.00.0000
21569 \begin_inset space ~
21575 \begin_layout Labeling
21576 \labelwidthstring 00.00.0000
21579 svn propset svn:needs-lock ON "<file-name>"
21582 \begin_layout Labeling
21583 \labelwidthstring 00.00.0000
21586 svn propdel svn:needs-lock "<file-name>"
21589 \begin_layout Subsubsection
21590 \begin_inset CommandInset label
21592 name "subsec:VCS-Revision-Information"
21596 Revision Information in Documents
21599 \begin_layout Standard
21600 There are more possibilities how to activate revision information in our
21604 \begin_layout Itemize
21607 \begin_inset Separator parbreak
21614 \begin_layout Itemize
21615 tree revision information (
21616 \begin_inset Flex Code
21619 \begin_layout Plain Layout
21626 The result is the output of the
21627 \begin_inset Flex Code
21630 \begin_layout Plain Layout
21636 command, the following table gives you an idea, how to read the results.
21639 \begin_layout Standard
21641 \begin_inset Tabular
21642 <lyxtabular version="3" rows="6" columns="2">
21643 <features tabularvalignment="middle">
21644 <column alignment="center" valignment="top">
21645 <column alignment="center" valignment="top">
21647 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21650 \begin_layout Plain Layout
21656 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21659 \begin_layout Plain Layout
21667 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21670 \begin_layout Plain Layout
21676 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21679 \begin_layout Plain Layout
21680 mixed revision working copy
21687 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21690 \begin_layout Plain Layout
21696 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21699 \begin_layout Plain Layout
21700 modified working copy
21707 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21710 \begin_layout Plain Layout
21716 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21719 \begin_layout Plain Layout
21720 switched working copy
21727 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21730 \begin_layout Plain Layout
21736 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21739 \begin_layout Plain Layout
21740 partial working copy, from a sparse checkout
21747 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21750 \begin_layout Plain Layout
21756 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21759 \begin_layout Plain Layout
21760 mixed revision, modified, switched working copy
21773 \begin_layout Itemize
21774 file revision information.
21775 The result comes from parsing the output of
21776 \begin_inset Flex Code
21779 \begin_layout Plain Layout
21781 \begin_inset space ~
21785 \begin_inset space ~
21789 \begin_inset space ~
21798 Supported flags are:
21799 \begin_inset Separator parbreak
21806 \begin_layout Itemize
21807 version number of the last commit (
21808 \begin_inset Flex Code
21811 \begin_layout Plain Layout
21820 \begin_layout Itemize
21821 author of the last commit (
21822 \begin_inset Flex Code
21825 \begin_layout Plain Layout
21834 \begin_layout Itemize
21835 date of the last commit (
21836 \begin_inset Flex Code
21839 \begin_layout Plain Layout
21848 \begin_layout Itemize
21849 time of the last commit (
21850 \begin_inset Flex Code
21853 \begin_layout Plain Layout
21863 \begin_layout Standard
21864 You can obtain this info via InsetInfo (e.g.
21866 \begin_inset Flex Code
21869 \begin_layout Plain Layout
21870 info-insert buffer vcs-date
21876 The information will be available only when you have the file stored under
21877 svn managment (i.e.
21879 \begin_inset Flex Code
21882 \begin_layout Plain Layout
21888 directory is available with your document).
21892 \begin_layout Itemize
21893 Another—a hacking one—possibility is to use svn keywords
21897 \begin_layout Plain Layout
21898 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
21904 In short – you set file keywords property (e.g.
21907 svn propset svn:keywords 'Rev' file.lyx
21909 ) and then paste keyword \SpecialChar TeX
21914 \begin_layout Plain Layout
21915 This is an easy way how to ensure that \SpecialChar LyX
21916 won't break the line in the middle
21922 tag in your document (e.g.
21927 \begin_layout Plain Layout
21935 This way svn client will automatically substitute revision number (e.g.
21940 \begin_layout Plain Layout
21947 ) after each update and commit.
21948 There are more problems with this approach.
21949 Firstly, the '$' character is used in \SpecialChar TeX
21950 world for math equations, so any
21951 occurence of math formula
21952 \begin_inset Formula $Rev$
21956 \begin_inset Formula $Rev:59$
21959 in your \SpecialChar LyX
21961 Similarly for other keywords like Id, Date, Author, etc.
21962 Secondly svn output is dependent on your locales, so its very easy that
21963 svn would produce some problematic strings once Date is used.
21964 Thirdly you get the whole 'Rev: 59' string in your document instead of
21966 Until subversion implements user's custom keywords it will be hard to use
21967 this approach reliably or let \SpecialChar LyX
21968 to support it directly.
21971 \begin_layout Subsection
21972 SVN and Windows Environment
21975 \begin_layout Quote
21976 My inclination is to say that if the user cannot figure out the command
21977 line operations on their own fairly quickly, they would be well advised
21978 to use TortoiseSVN.
21984 \begin_layout Subsubsection
21988 \begin_layout Standard
21989 In addition to installing \SpecialChar LyX
21990 , and having access to a Subversion repository,
21991 the user will need to install the Subversion client program.
21992 A Windows installer for the client program is available from
21993 \begin_inset CommandInset href
21996 target "http://www.collab.net/nonav/downloads/subversion/"
22001 The user may also want to install
22002 \begin_inset CommandInset href
22005 target "http://tortoisesvn.tigris.org/"
22009 , which integrates Subversion operations into the context (rightclick) menu
22010 of Windows Explorer.
22011 Operations done outside \SpecialChar LyX
22012 will typically be more convenient using the Explorer
22014 Note that TortoiseSVN is not a replacement for the client program, which
22015 is what \SpecialChar LyX
22019 \begin_layout Subsubsection
22020 Bringing a document under Subversion control
22023 \begin_layout Standard
22024 Before a \SpecialChar LyX
22025 document can be brought under version control in Subversion, its
22026 parent directory needs to be under version control.
22027 If the document is being added to a project already in the repository,
22028 this is accomplished by checking the project out to the directory where
22029 the new document will be placed.
22030 If the project itself is not yet under version control (for instance, if
22031 this document starts a new project), the directory must be imported into
22033 This is done outside \SpecialChar LyX
22035 Both import and checkout are easily accomplished from the Explorer context
22036 menu using TortoiseSVN, or alternatively can be done using the command
22037 line client at a DOS prompt.
22038 The procedure for importing the project using TortoiseSVN is described
22039 below, assuming an existing repository and a new project being started
22047 For information on using the Subversion client program, run
22054 \begin_layout Enumerate
22061 in Windows Explorer, right click it, and select
22063 TortoiseSVN\SpecialChar menuseparator
22067 If necessary, adjust the URL for the repository, then click OK.
22070 \begin_layout Enumerate
22071 Right click the level of the repository under which you want to place the
22072 new project folder (typically the top level) and click
22076 Supply a name for the project folder and click OK.
22077 Add a message for the log file if desired, then click OK again.
22078 The new project folder should appear in the repository.
22079 Finally, click OK again to exit the repository browser.
22082 \begin_layout Enumerate
22083 Once again right click
22089 , this time selecting SVN Checkout\SpecialChar ldots
22090 Select the URL of the project folder
22091 you just created in the repository, and set the checkout directory to
22099 You will be warned about a non-empty folder; click OK to proceed.
22100 You should now have a
22111 \begin_layout Enumerate
22112 Create or open your document in \SpecialChar LyX
22115 File\SpecialChar menuseparator
22117 \begin_inset space ~
22120 Control\SpecialChar menuseparator
22124 Add a log message and click OK to commit the document to version control.
22127 \begin_layout Standard
22128 From this point onward, you should have full functionality in the
22130 File\SpecialChar menuseparator
22132 \begin_inset space ~
22138 You also have the option of checking the document in and out, viewing its
22140 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22141 client program from a command prompt.
22144 \begin_layout Subsubsection
22145 SSH tunnel used with SVN under Windows
22148 \begin_layout Standard
22149 Compared with Linux setting up an svn client to communicate over ssh under
22150 Windows is a rather troublesome task.
22151 We will at least offer some hints how to setup the client side but prior
22152 knowledge about ssh and the Windows command line is needed, also be prepared
22153 for a great deal of frustration\SpecialChar ldots
22157 \begin_layout Enumerate
22158 Get an svn client for windows, as described in the previous sections.
22159 When it is a fresh install run some svn command (e.g.
22161 \begin_inset Flex Code
22164 \begin_layout Plain Layout
22170 ) to create config files, which you will need to change later on.
22173 \begin_layout Enumerate
22174 Choose an ssh client for Windows.
22175 There are several possibilities, we will use the one from Putty tools
22179 \begin_layout Plain Layout
22180 \begin_inset Flex URL
22183 \begin_layout Plain Layout
22185 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22196 You will need to set the connection up so that the client doesn't ask for
22197 any password from you.
22198 To keep things easy we will use only keys without any additional password
22200 \begin_inset Separator parbreak
22207 \begin_layout Enumerate
22209 \begin_inset Flex Code
22212 \begin_layout Plain Layout
22219 Save your private .ppk key file and put the public one on the server side.
22220 If the SVN server runs on Linux, note that the format of the public key
22221 is not compatible with Linux openssh and you will need to direcly copy-paste
22224 Public key for pasting into OpenSSH authorized_keys file
22226 :” edit field into the server's
22227 \begin_inset Flex Code
22230 \begin_layout Plain Layout
22231 ~/.ssh/authorized_keys
22237 \begin_inset Flex Code
22240 \begin_layout Plain Layout
22249 \begin_layout Enumerate
22251 \begin_inset Flex Code
22254 \begin_layout Plain Layout
22261 In the SVN config file
22265 \begin_layout Plain Layout
22266 Exact path depends on Windows version, usually somewhere around
22267 \begin_inset Flex Code
22270 \begin_layout Plain Layout
22273 Documents and Settings
22287 \begin_inset Flex Code
22290 \begin_layout Plain Layout
22305 , section [tunnels], setup ssh command, e.g.
22307 \begin_inset Flex Code
22310 \begin_layout Plain Layout
22311 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22320 \begin_layout Plain Layout
22321 It will usually take a lot of time to get exact command right and it depends
22323 For example do not have some remote server saved as a default session in
22325 If things fail, try to connect via plink without SVN first.
22334 \begin_layout Enumerate
22335 Checkout the SVN archive, e.
22336 \begin_inset space \thinspace{}
22340 \begin_inset Newline newline
22344 \begin_inset Flex Code
22347 \begin_layout Plain Layout
22348 svn co svn+ssh://user@server/repository_path
22356 \begin_layout Subsubsection
22357 End-of-Line Conversions
22360 \begin_layout Standard
22361 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22363 use different line endings inside the .lyx files.
22364 This is not a problem as far as \SpecialChar LyX
22365 functionality is concerned, but the commit
22366 diffs will be huge and merge-conflicts prone.
22367 Fortunately SVN itself knows
22371 \begin_layout Plain Layout
22372 \begin_inset Flex URL
22375 \begin_layout Plain Layout
22377 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22387 how to deal with CR/LF problems when switching .lyx files to the
22388 \begin_inset Flex Code
22391 \begin_layout Plain Layout
22401 \begin_layout Plain Layout
22403 \begin_inset Flex Code
22406 \begin_layout Plain Layout
22407 svn propset svn:eol-style native FILE_NAME
22420 \begin_layout Subsection
22421 GIT commands in \SpecialChar LyX
22425 \begin_layout Standard
22426 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22428 You can find the commands in the
22430 File\SpecialChar menuseparator
22432 \begin_inset space ~
22438 Please note that if you use password protected access to repository via
22439 ssh, you will be asked in terminal window.
22441 was tested against GIT 1.7.
22445 \begin_layout Plain Layout
22446 Windows users please note that you need to ensure that git is on the path.
22447 This can be set from within \SpecialChar LyX
22450 Tools\SpecialChar menuseparator
22451 Preferences\SpecialChar menuseparator
22452 Paths\SpecialChar menuseparator
22463 \begin_layout Standard
22464 One big difference of GIT and the other supported version control systems
22465 is the distributed nature of GIT: With traditional version control systems
22466 there is one central server which hosts the repository.
22467 Users commit their changes to the server, and get updates made by other
22469 With GIT, users commit to a local repository.
22470 The local repository can be synchronized with one or more remote repositories
22472 \begin_inset Flex Code
22475 \begin_layout Plain Layout
22482 \begin_inset Flex Code
22485 \begin_layout Plain Layout
22493 does not interact in any way with remote GIT repositories.
22494 It works exclusively with the local repository in a very similar way as
22495 with a central CVS or SVN repository.
22496 If you use remote GIT repositories you need to do the
22497 \begin_inset Flex Code
22500 \begin_layout Plain Layout
22507 \begin_inset Flex Code
22510 \begin_layout Plain Layout
22516 operations with your favourite GIT client.
22519 \begin_layout Subsubsection
22525 \begin_layout Standard
22526 If your document is not under revision control, this is the only item shown
22528 And if it is under revision control, the
22535 item is not visible.
22538 \begin_layout Standard
22539 This command registers in GIT your document ONLY in case you have already
22540 the documents directory under GIT control (in particular
22545 This means you have to checkout the archive by yourself.
22548 \begin_layout Standard
22549 Then you are asked interactively to supply an initial description of the
22551 Don't forget that registered file is not yet commited.
22554 \begin_layout Standard
22555 GIT command that is run:
22558 \begin_inset Quotes eld
22562 \begin_inset Quotes erd
22568 \begin_layout Standard
22573 to understand the switches.
22576 \begin_layout Subsubsection
22582 \begin_layout Standard
22583 When you are finished editing a file, you commit your changes.
22584 When you do this, you are asked for a description of the changes.
22585 After that changes are commited.
22588 \begin_layout Standard
22591 git commit -q -m"<description>" <file-name>
22594 \begin_layout Subsubsection
22597 Revert To Repository Version
22600 \begin_layout Standard
22601 This will discard all changes made to the document since the last check
22603 You get a warning before changes are discarded.
22606 \begin_layout Standard
22610 \begin_inset Quotes eld
22614 \begin_inset Quotes erd
22620 \begin_layout Subsubsection
22626 \begin_layout Standard
22627 This will rename the current document including the version history.
22628 It requires a clean document without any changes since the last checkin.
22629 You are asked for a file name and a description of the rename operation.
22630 After that the document is renamed, both locally and in the repository.
22631 If the parent directories of the new and old file names differ, all relative
22632 paths of included files are adjusted (like in
22634 File\SpecialChar menuseparator
22639 Finally, the document is reloaded using the new name.
22642 \begin_layout Labeling
22643 \labelwidthstring 00.00.0000
22645 \begin_inset space ~
22649 \begin_inset space ~
22653 \begin_inset Newline newline
22657 \begin_inset Flex Code
22660 \begin_layout Plain Layout
22664 \begin_inset Quotes eld
22668 \begin_inset Quotes erd
22672 \begin_inset Quotes eld
22676 \begin_inset Quotes erd
22685 \begin_inset Newline newline
22689 \begin_inset Flex Code
22692 \begin_layout Plain Layout
22701 \begin_layout Subsubsection
22707 \begin_layout Standard
22708 This shows the complete history of the GIT document.
22712 \begin_inset Quotes eld
22716 \begin_inset Quotes erd
22721 is shown in a browser.
22724 \begin_layout Subsubsection
22728 \begin_layout Standard
22730 supports GIT hash number of the last commit to the file, author name, date
22731 and time of last commit.
22732 All those are extracted from
22734 git log -n 1 --pretty=format:%H%n%an%n%ai
22737 Tree version information is obtained via
22739 git describe --abbrev --dirty --long
22743 \begin_inset CommandInset ref
22745 reference "subsec:VCS-Revision-Information"
22752 \begin_layout Subsection
22756 \begin_layout Standard
22757 With the recent addition of the vc-command function \SpecialChar LyX
22758 power users are allowed
22759 to create their own commands for revision control.
22762 \begin_layout Standard
22763 As an example you can see how two TortoiseSVN commands could be integrated
22767 \begin_layout Description
22769 \begin_inset Flex Code
22772 \begin_layout Plain Layout
22773 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
22781 \begin_layout Description
22783 \begin_inset Flex Code
22786 \begin_layout Plain Layout
22787 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
22795 \begin_layout Subsection
22796 Version control and Document comparison
22799 \begin_layout Standard
22800 One of the typical uses of version control is to inspect the changes between
22801 revisions, usually by creating
22802 \begin_inset Flex Code
22805 \begin_layout Plain Layout
22812 While this is useful for plain text files, it is much less useful in the
22813 case of \SpecialChar LyX
22814 files, which have more a complicated structure.
22815 Hence we provide binding to the Document comparison feature.
22816 There are two ways of calling this feature - either by direct call of
22817 \begin_inset Flex Code
22820 \begin_layout Plain Layout
22827 function (for details see \SpecialChar LyX
22828 functions manual) or by icon/menu item
22829 \begin_inset Flex Noun
22832 \begin_layout Plain Layout
22833 Compare with older revision...
22839 One can either compare two chosen revisions of the document or he can simply
22840 compare the current version of edited text with older revisions (where
22842 \begin_inset Flex Noun
22845 \begin_layout Plain Layout
22851 ' revisions back means comparison of the edited file with last commited
22856 \begin_layout Standard
22857 This feature is supported for SVN and RCS though due to the more complicated
22858 versioning scheme of RCS there is a constraint – when addressing the revisions
22859 in dialog, numbers always point to the last number in RCS revision number,
22862 We don't currently support GIT addressing of revisions, one can just compare
22863 edited document with its revision X steps backs, where X is addressed as
22867 \begin_layout Section
22868 Literate Programming
22871 \begin_layout Standard
22876 (kayvan@sylvan.com)
22880 original documentation written by
22882 Edmar Wienskoski Jr.
22885 (edmar-w-jr@technologist.com)
22888 \begin_layout Subsection
22892 \begin_layout Standard
22893 The main purpose of this documentation is to show you how to use \SpecialChar LyX
22895 programming, where it is assumed that you are familiar with this programming
22896 technique, and know what
22897 \begin_inset Quotes eld
22901 \begin_inset Quotes erd
22905 \begin_inset Quotes eld
22909 \begin_inset Quotes erd
22913 If that is not the case, please follow the web links provided in the following
22915 There is a lot of good documentation out there covering old development
22916 history to the latest tools tips.
22919 \begin_layout Standard
22920 It is also assumed that you are familiar with \SpecialChar LyX
22921 itself to a point that you
22922 are comfortable changing your \SpecialChar LyX
22923 preferences, and X resources file.
22924 If that is not the case please refer to other \SpecialChar LyX
22925 documentation to cover your
22929 \begin_layout Subsection
22930 Literate Programming
22933 \begin_layout Standard
22934 From the Literate Programming FAQ:
22937 \begin_layout Quotation
22938 Literate programming is the combination of documentation and source together
22939 in a fashion suited for reading by human beings.
22940 In fact, literate programs should be enjoyable reading, even inviting!
22941 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
22942 and documentation in a single file.
22943 Literate programming tools then parse the file to produce either readable
22944 documentation or compilable source.
22945 The WEB style of literate programming was created by D.
22946 \begin_inset space \thinspace{}
22950 Knuth during the development of his \SpecialChar TeX
22951 typesetting software.
22955 \begin_layout Standard
22956 Another excerpt says:
22959 \begin_layout Quotation
22962 How is literate programming different from verbose commenting?
22965 \begin_layout Quotation
22966 There are three distinguishing characteristics.
22967 In order of importance, they are:
22968 \begin_inset Separator parbreak
22975 \begin_layout Itemize
22976 flexible order of elaboration
22979 \begin_layout Itemize
22980 automatic support for browsing
22983 \begin_layout Itemize
22984 typeset documentation, especially diagrams and mathematics
22988 \begin_layout Standard
22989 Now that I sparked your curiosity, take a look in the references.
22992 \begin_layout Subsubsection
22996 \begin_layout Standard
22997 The complete Literate Programming FAQ can be found at:
23000 \begin_layout Quote
23001 Literate Programming FAQ
23002 \begin_inset Flex URL
23005 \begin_layout Plain Layout
23007 http://www.literateprogramming.com/lpfaq.pdf
23015 \begin_layout Standard
23016 The FAQ lists 23 (twenty three!) different literate programming tools.
23017 Where some are specialized or
23018 \begin_inset Quotes eld
23022 \begin_inset Quotes erd
23025 for particular programming languages, while other have general scope.
23030 for my own use for several reasons:
23033 \begin_layout Itemize
23034 It can generate the documentation either in \SpecialChar LaTeX
23038 \begin_layout Itemize
23039 It has a open architecture, i.
23040 \begin_inset space \thinspace{}
23044 \begin_inset space \space{}
23047 it is easy to plug in new filters and to perform special processing that
23052 \begin_layout Itemize
23053 There is a good selection of filters available already (the HTML is one
23057 \begin_layout Itemize
23061 \begin_layout Standard
23062 The Noweb web page can be found at:
23065 \begin_layout Quote
23067 \begin_inset Flex URL
23070 \begin_layout Plain Layout
23072 http://www.cs.virginia.edu/~nr/noweb/
23080 \begin_layout Standard
23081 Starting from there you can reach many other interesting links and even
23082 some literate program examples.
23085 \begin_layout Subsection
23087 and Literate Programming with Noweb
23090 \begin_layout Standard
23091 The \SpecialChar LyX
23092 support for Literate Programming is provided by using the generic \SpecialChar LyX
23094 converters mechanism.
23095 This support is provided in a
23096 \begin_inset Quotes eld
23100 \begin_inset Quotes erd
23104 \begin_inset space \thinspace{}
23108 \begin_inset space \space{}
23111 you will be able to use this new \SpecialChar LyX
23112 feature with some other literate programming
23113 tool of your choice by just changing your \SpecialChar LyX
23117 \begin_layout Subsubsection
23118 Generating documents and code (weaving and tangling)
23121 \begin_layout Paragraph
23122 Using the noweb module
23125 \begin_layout Standard
23126 If you have installed Noweb and \SpecialChar LyX
23127 successfully, whenever you open a new document,
23128 after you have chosen its document class, use the Document->Settings menu
23130 \begin_inset Quotes eld
23134 \begin_inset Quotes erd
23138 If Noweb is correctly installed, when you click on the
23139 \begin_inset Quotes eld
23143 \begin_inset Quotes erd
23146 link, you will see the
23147 \begin_inset Quotes eld
23151 \begin_inset Quotes erd
23154 module in the available list and you can add it to your document.
23157 \begin_layout Paragraph
23161 \begin_layout Standard
23163 enables you to write code with a layout named
23164 \begin_inset Flex Noun
23167 \begin_layout Plain Layout
23174 Noweb delimits chunks like this:
23177 \begin_layout LyX-Code
23181 \begin_layout LyX-Code
23185 \begin_layout LyX-Code
23189 \begin_layout LyX-Code
23193 \begin_layout LyX-Code
23197 \begin_layout Standard
23198 The problem is that whatever is written in between the << and the
23202 must be taken literally, i.
23203 \begin_inset space \thinspace{}
23207 \begin_inset space \space{}
23211 should be prevented from making any special interpretation of what has
23213 This is also handled by
23214 \begin_inset Flex Noun
23217 \begin_layout Plain Layout
23223 , that works like a normal paragraph but has a free spacing capability.
23226 \begin_layout Standard
23227 As a special note, you can also use the
23228 \begin_inset Quotes eld
23232 \begin_inset Quotes erd
23235 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23239 \begin_layout LyX-Code
23243 \begin_layout LyX-Code
23244 def some_function(args):
23247 \begin_layout LyX-Code
23248 "This is the doc string for this function."
23251 \begin_layout LyX-Code
23252 print "My args: ", args
23255 \begin_layout LyX-Code
23256 @ %def some_function
23259 \begin_layout Standard
23260 For an example of this usage and the resulting cross-reference output, look
23261 at the Literate python program in
23263 LIBDIR/examples/listerrors.lyx
23265 which should make this all clear.
23268 \begin_layout Paragraph
23269 Generating the documentation
23272 \begin_layout Standard
23273 At this point you already have a new document file with a proper document
23274 class, and with some code and text on it.
23275 How do I print it? The answer is simple, you select
23277 View\SpecialChar menuseparator
23281 Just like you would do for a plain document.
23282 No special procedure is required.
23285 \begin_layout Standard
23286 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23290 \begin_layout Enumerate
23293 Update\SpecialChar menuseparator
23296 menu option is chosen, a \SpecialChar LaTeX
23299 \begin_inset Separator parbreak
23306 \begin_layout Standard
23307 If the document is of any literate class the generated file will be named
23308 with an extension name defined by the
23309 \begin_inset Quotes eld
23313 \begin_inset Quotes erd
23316 format (defined in the Preferences panel), otherwise the file will have
23325 \begin_layout Enumerate
23326 Note that the only difference so far is in the name of the file, no special
23327 processing is required by \SpecialChar LyX
23329 Given that you formatted the code using the
23330 \begin_inset Flex Noun
23333 \begin_layout Plain Layout
23339 layout that, by itself, takes care of the business.
23342 \begin_layout Enumerate
23343 If the document is of any literate class \SpecialChar LyX
23344 will then use the internal \SpecialChar LyX
23346 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23351 \begin_layout Plain Layout
23352 The converters are defined in the
23354 Tools\SpecialChar menuseparator
23358 \begin_inset Quotes eld
23362 \begin_inset Quotes erd
23374 manual for general information about converters.
23379 to generate the \SpecialChar LaTeX
23381 \begin_inset Separator parbreak
23388 \begin_layout Standard
23389 Otherwise it will just skip this step.
23393 \begin_layout Enumerate
23394 Finally, \SpecialChar LaTeX
23395 is invoked and the regular post processing continues as in a plain
23399 \begin_layout Standard
23400 Independence from a particular
23401 \begin_inset Quotes eld
23405 \begin_inset Quotes erd
23408 is easily achieved by changing the commands that are run by the various
23412 \begin_layout Paragraph
23413 Generating the code
23416 \begin_layout Standard
23417 When the build menu option is chosen or the corresponding button in the
23418 toolbar is pressed, a \SpecialChar LaTeX
23419 file is generated just like step 1 above.
23420 Next, \SpecialChar LyX
23426 This converter needs to be defined by the user and is not installed by
23427 default, though the Program format is.
23428 This converter (like any other converter) will have two parts:
23431 \begin_layout Enumerate
23432 The converter program itself.
23433 This program performs the conversion from the one format to the other (in
23434 this case, from the Noweb format to the Program pseudo-format).
23437 \begin_layout Enumerate
23438 The error log parser.
23439 This is a program whose sole purpose is to rewrite error messages in a
23440 format that \SpecialChar LyX
23442 This makes it possible for \SpecialChar LyX
23443 to place error boxes in the right places in
23447 \begin_layout Standard
23448 The first part, the
23449 \begin_inset Quotes eld
23453 \begin_inset Quotes erd
23456 setting, should be set to
23457 \begin_inset Newline newline
23461 \begin_inset Quotes eld
23469 \begin_inset Quotes erd
23473 \begin_inset Newline newline
23476 This basically means that \SpecialChar LyX
23478 \begin_inset Quotes eld
23482 \begin_inset Quotes erd
23485 (a program or script) with the name of the Noweb file (normally a file
23486 in the \SpecialChar LyX
23487 temp directory) and the directory path of the original \SpecialChar LyX
23492 \begin_layout Standard
23493 This is an implementation of
23494 \begin_inset Quotes eld
23498 \begin_inset Quotes erd
23501 that you can place in a directory on your path:
23504 \begin_layout Standard
23505 \begin_inset VSpace defskip
23511 \begin_layout Standard
23512 \begin_inset Newpage pagebreak
23518 \begin_layout Standard
23524 \begin_layout Standard
23530 \begin_layout Standard
23533 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23536 \begin_layout Standard
23537 \begin_inset VSpace defskip
23543 \begin_layout Standard
23544 The next part of the converter setting is the
23545 \begin_inset Quotes eld
23549 \begin_inset Quotes erd
23552 which is to be set to
23553 \begin_inset Newline newline
23557 \begin_inset Quotes eld
23562 parselog=$$s/scripts/listerrors
23565 \begin_inset Quotes erd
23569 \begin_inset Newline newline
23572 This will run any errors that are generated by the
23573 \begin_inset Quotes eld
23577 \begin_inset Quotes erd
23580 process through the
23581 \begin_inset Quotes eld
23585 \begin_inset Quotes erd
23591 \begin_layout Standard
23592 The build will normally take place in \SpecialChar LyX
23593 's temporary directory, so the files
23594 produced by the conversion will be in that directory.
23596 will copy out what it regards as the `main' file, but the
23600 conversion may produce several files, and so most of these would then be
23601 deleted when \SpecialChar LyX
23603 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23604 the build-script chunk can place the generated files in that location.
23607 \begin_layout Paragraph
23608 Build instructions in the document
23611 \begin_layout Standard
23612 The last piece of the integration between \SpecialChar LyX
23614 \begin_inset Quotes eld
23618 \begin_inset Quotes erd
23622 Generally, the instructions for building your program should be embedded
23623 in a chunk of its own.
23625 \begin_inset Quotes eld
23629 \begin_inset Quotes erd
23632 above uses the notangle command to look for this chunk (called
23633 \begin_inset Quotes eld
23637 \begin_inset Quotes erd
23640 ) and runs its contents through
23641 \begin_inset Quotes eld
23645 \begin_inset Quotes erd
23651 \begin_layout Standard
23652 Typically, such a chunk would look something like this:
23655 \begin_layout LyX-Code
23659 \begin_layout LyX-Code
23661 \begin_inset Newline newline
23664 if [ -z "${NOWEB_SOURCE}" ]
23665 \begin_inset Newline newline
23671 \begin_layout LyX-Code
23672 NOWEB_SOURCE=myfile.nw
23673 \begin_inset Newline newline
23677 \begin_inset Newline newline
23681 code to extract files ...
23682 use NOWEB_OUTPUT_DIR here ...]
23683 \begin_inset Newline newline
23687 code to compile files ...]
23688 \begin_inset Newline newline
23694 \begin_layout Standard
23697 LIBDIR/examples/listerrors.lyx
23701 LIBDIR/examples/Literate.lyx
23703 which implement two versions of the
23704 \begin_inset Quotes eld
23708 \begin_inset Quotes erd
23711 program for some illustrations of how all of these pieces go together or
23714 LIBDIR/examples/noweb2lyx.lyx.
23717 Interestingly, these three files show off the language-indepence of the
23719 literate programming support since they are written in Python, C and Perl
23723 \begin_layout Subsubsection
23724 Configuring \SpecialChar LyX
23728 \begin_layout Standard
23729 All the Literate Programming support is configured by the
23731 Tools\SpecialChar menuseparator
23735 \begin_inset Quotes eld
23739 \begin_inset Quotes erd
23743 The important parts are:
23746 \begin_layout Description
23748 \begin_inset space ~
23752 \begin_inset Quotes eld
23756 \begin_inset Quotes erd
23760 \begin_inset space ~
23763 format Set up via the File Formats tab, this is where the Noweb-specific
23773 , the file extension is set to
23778 This tells \SpecialChar LyX
23779 to create a file with a
23783 extension in the first step of the conversion process.
23786 \begin_layout Description
23788 \begin_inset space ~
23796 \begin_inset space ~
23799 format This is an empty format whose sole purpose is to be the endpoint
23800 of a conversion (which then allows us to set up a converter for it).
23803 \begin_layout Description
23813 This converter performs the
23814 \begin_inset Quotes eld
23818 \begin_inset Quotes erd
23821 of the literate document.
23822 For Noweb, it is set to
23823 \begin_inset Quotes eld
23828 noweave -delay -index $$i > $$o
23831 \begin_inset Quotes erd
23837 \begin_layout Description
23847 \begin_inset Quotes eld
23851 \begin_inset Quotes erd
23855 As stated above, the Converter is set to
23856 \begin_inset Quotes eld
23864 \begin_inset Quotes erd
23867 , with Flags set to
23868 \begin_inset Newline newline
23872 \begin_inset Quotes eld
23877 parselog=$$s/scripts/listerrors
23880 \begin_inset Quotes erd
23886 \begin_layout Subsubsection
23890 \begin_layout Standard
23891 There is also a new function implemented in the \SpecialChar LyX
23893 \begin_inset Quotes eld
23896 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
23900 \begin_layout Standard
23901 When debugging code with ddd/gdb, it is possible to invoke a text editor
23902 at the current execution position with a single key stroke.
23903 The default ddd configuration for that is shift-ctrl-V.
23904 It happens that you can define the editor command line invocation in ddd
23907 Edit\SpecialChar menuseparator
23908 Preferences\SpecialChar menuseparator
23911 dialog and changing the "Edit Sources" entry.
23914 \begin_layout Standard
23915 I take advantage of the newly created \SpecialChar LyX
23916 server function and this ddd feature,
23918 \begin_inset Quotes eld
23922 \begin_inset Quotes erd
23928 \begin_layout Standard
23929 \begin_inset VSpace defskip
23935 \begin_layout Standard
23938 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
23941 \begin_layout Standard
23942 \begin_inset VSpace defskip
23948 \begin_layout Standard
23949 With this, whenever you are using ddd and find a point in the program that
23950 you want to edit, you just press shift-ctrl-V (in the ddd window), and
23951 ddd will forward this information to \SpecialChar LyX
23952 through the \SpecialChar LyX
23953 server and then the
23955 window will show the same file with the cursor at the same position ddd
23957 No more guessing or long scrolling to locate a point in the program back
23961 \begin_layout Standard
23962 Note however that you must enable the \SpecialChar LyX
23963 server to get this feature working
23964 (it is disabled by default).
23965 You can enable it in
23977 ) by entering in the
23983 \begin_inset Quotes eld
23988 /home/<your-home-directory>/.lyx/lyxpipe
23991 \begin_inset Quotes erd
23997 \begin_layout Standard
23998 Read the \SpecialChar LyX
23999 server documentation in the
24001 Customization Manual
24003 for further information.
24006 \begin_layout Subsubsection
24010 \begin_layout Standard
24011 There are six new buttons that can be added to your \SpecialChar LyX
24013 Five of these buttons are short cuts to layout styles:
24036 The last one is a short cut to the
24037 \begin_inset Quotes eld
24041 \begin_inset Quotes erd
24048 \begin_layout Standard
24050 has a range of buttons that are available for tool bar customization.
24051 In my toolbar I like to combine the six short cuts above with two more:
24056 \SpecialChar menuseparator
24061 \SpecialChar menuseparator
24068 Document\SpecialChar menuseparator
24069 View\SpecialChar menuseparator
24073 Here is how it looks like:
24076 \begin_layout LyX-Code
24080 \begin_layout LyX-Code
24084 \begin_layout LyX-Code
24085 Icon "layout Standard"
24088 \begin_layout LyX-Code
24089 Icon "layout Section"
24092 \begin_layout LyX-Code
24093 Icon "layout \SpecialChar LaTeX
24097 \begin_layout LyX-Code
24098 Icon "layout \SpecialChar LyX
24102 \begin_layout LyX-Code
24103 Icon "layout Chunk"
24106 \begin_layout LyX-Code
24110 \begin_layout LyX-Code
24114 \begin_layout LyX-Code
24115 Icon "buffer-typeset"
24118 \begin_layout LyX-Code
24119 Icon "build-program"
24122 \begin_layout LyX-Code
24126 \begin_layout LyX-Code
24130 \begin_layout LyX-Code
24134 \begin_layout LyX-Code
24138 \begin_layout LyX-Code
24142 \begin_layout Subsubsection
24143 Colors customization
24146 \begin_layout Standard
24147 There are a number of colors in \SpecialChar LyX
24148 that can be customized in
24153 One of the things that bothers people is the \SpecialChar LaTeX
24155 The default color is red, since the chunks uses \SpecialChar LaTeX
24156 font, and there is a lot
24157 of chunks in literate documents, you may get tired of seeing everything
24159 You can change it by going to the tabs
24168 \begin_layout Standard
24169 The next thing is the visible presence of the newline character in the screen.
24170 You can choose the color of this particular character and make it blend
24172 I recommend you choosing a color that is close to the background but not
24173 equal, that way you still can see it is there, but it is not bothering
24177 \begin_layout Subsection
24182 \begin_layout Standard
24191 is documented in the
24195 example file and in the Sweave manual (menu
24197 Help\SpecialChar menuseparator
24203 \begin_layout Chapter
24207 \begin_layout Standard
24208 You can do everything with \SpecialChar LyX
24209 that you can do with \SpecialChar LaTeX
24211 However, \SpecialChar LyX
24212 cannot support every \SpecialChar LaTeX
24214 But you can always use \SpecialChar TeX
24216 This chapter shows you some more special things you might want to use.
24217 For other special things you can do with figures, tables, floats, boxes
24218 and notes, have a look at the
24221 \begin_inset space ~
24229 \begin_layout Section
24230 Multiple Text Columns
24233 \begin_layout Standard
24234 This feature is independent of the option
24236 Two-column document
24238 in the document settings under
24243 If you want to have 2
24244 \begin_inset space ~
24247 columns for the whole document, it is recommended to use the
24249 Two-column document
24252 For all other cases use this feature.
24255 \begin_layout Standard
24256 To use multiple text columns in your document, you have to load the module
24263 Document\SpecialChar menuseparator
24264 Settings\SpecialChar menuseparator
24267 ) and must have the \SpecialChar LaTeX
24275 \begin_layout Standard
24276 Footnotes within multiple columns will be placed at the bottom of the page
24277 and not under each column.
24278 Within the different columns you can use everything, with the limitation
24279 that for floats you need to use the float option
24286 \begin_layout Subsection
24290 \begin_layout Standard
24291 If you want to have 2
24292 \begin_inset space ~
24295 columns in your text, insert a multicolumn inset via the menu
24297 Insert\SpecialChar menuseparator
24299 \begin_inset space ~
24302 Insets\SpecialChar menuseparator
24304 \begin_inset space ~
24309 where the columns should start.
24310 Write all text that should be printed in 2
24311 \begin_inset space ~
24314 columns into this inset.
24317 \begin_layout Standard
24318 Here is an example:
24321 \begin_layout Standard
24323 \begin_inset Flex Multiple Columns
24326 \begin_layout Plain Layout
24331 The Adventure of the Empty House
24334 \begin_inset Newline newline
24337 by Sir Arthur Conan Doyle
24340 \begin_layout Plain Layout
24343 It was in the spring of the year 1894 that all London was interested, and
24344 the fashionable world dismayed, by the murder of the Honourable Ronald
24345 Adair under most unusual and inexplicable circumstances.
24346 The public has already learned those particulars of the crime which came
24347 out in the police investigation, but a good deal was suppressed upon that
24348 occasion, since the case for the prosecution was so overwhelmingly strong
24349 that it was not necessary to bring forward all the facts.
24350 Only now, at the end of nearly ten years, am I allowed to supply those
24351 missing links which make up the whole of that remarkable chain.
24352 The crime was of interest in itself, but that interest was as nothing to
24353 me compared to the inconceivable sequel, which afforded me the greatest
24354 shock and surprise of any event in my adventurous life.
24355 Even now, after this long interval, I find myself thrilling as I think
24356 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24357 ty which utterly submerged my mind.
24358 Let me say to that public, which has shown some interest in those glimpses
24359 which I have occasionally given them of the thoughts and actions of a very
24360 remarkable man, that they are not to blame me if I have not shared my knowledge
24361 with them, for I should have considered it my first duty to do so, had
24362 I not been barred by a positive prohibition from his own lips, which was
24363 only withdrawn upon the third of last month.
24371 \begin_layout Standard
24372 To get 3 or more columns, set the cursor into the multicolumn inset and
24375 Insert\SpecialChar menuseparator
24377 \begin_inset space ~
24381 \begin_inset space ~
24387 The number of the desired columns is written into that inset (for 3
24388 \begin_inset space ~
24392 \begin_inset Quotes eld
24396 \begin_inset Quotes erd
24400 \begin_inset Newline newline
24403 Here is an example with 3
24404 \begin_inset space ~
24410 \begin_layout Standard
24411 \begin_inset Flex Multiple Columns
24414 \begin_layout Plain Layout
24417 \begin_inset Argument 1
24420 \begin_layout Plain Layout
24426 It can be imagined that my close intimacy with Sherlock Holmes had interested
24427 me deeply in crime, and that after his disappearance I never failed to
24428 read with care the various problems which came before the public.
24429 And I even attempted, more than once, for my own private satisfaction,
24430 to employ his methods in their solution, though with indifferent success.
24431 There was none, however, which appealed to me like this tragedy of Ronald
24433 As I read the evidence at the inquest, which led up to a verdict of willful
24434 murder against some person or persons unknown, I realized more clearly
24435 than I had ever done the loss which the community had sustained by the
24436 death of Sherlock Holmes.
24437 There were points about this strange business which would, I was sure,
24438 have specially appealed to him, and the efforts of the police would have
24439 been supplemented, or more probably anticipated, by the trained observation
24440 and the alert mind of the first criminal agent in Europe.
24441 All day, as I drove upon my round, I turned over the case in my mind and
24442 found no explanation which appeared to me to be adequate.
24443 At the risk of telling a twice-told tale, I will recapitulate the facts
24444 as they were known to the public at the conclusion of the inquest.
24452 \begin_layout Standard
24453 You can have up to 10
24454 \begin_inset space ~
24457 columns if you want to, but that might not be very pleasant for the readers
24461 \begin_layout Standard
24462 \begin_inset Newpage newpage
24468 \begin_layout Subsection
24469 Columns inside Columns
24472 \begin_layout Standard
24473 You can also have columns inside columns:
24476 \begin_layout Standard
24477 \begin_inset Flex Multiple Columns
24480 \begin_layout Plain Layout
24483 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24484 at that time governor of one of the Australian colonies.
24485 Adair's mother had returned from Australia to undergo the operation for
24486 cataract, and she, her son Ronald, and her daughter Hilda were living together
24490 \begin_layout Plain Layout
24491 \begin_inset Flex Multiple Columns
24494 \begin_layout Plain Layout
24497 The youth moved in the best society–had, so far as was known, no enemies
24498 and no particular vices.
24499 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24500 had been broken off by mutual consent some months before, and there was
24501 no sign that it had left any very profound feeling behind it.
24502 For the rest {sic} the man's life moved in a narrow and conventional circle,
24503 for his habits were quiet and his nature unemotional.
24504 Yet it was upon this easy-going young aristocrat that death came, in most
24505 strange and unexpected form, between the hours of ten and eleven-twenty
24506 on the night of March 30, 1894.
24514 \begin_layout Plain Layout
24517 Ronald Adair was fond of cards–playing continually, but never for such stakes
24519 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24520 It was shown that, after dinner on the day of his death, he had played
24521 a rubber of whist at the latter club.
24522 He had also played there in the afternoon.
24527 The evidence of those who had played with him– Mr.
24528 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24529 and that there was a fairly equal fall of the cards.
24530 Adair might have lost five pounds, but not more.
24531 His fortune was a considerable one, and such a loss could not in any way
24533 He had played nearly every day at one club or other, but he was a cautious
24534 player, and usually rose a winner.
24535 It came out in evidence that, in partnership with Colonel Moran, he had
24536 actually won as much as four hundred and twenty pounds in a sitting, some
24537 weeks before, from Godfrey Milner and Lord Balmoral.
24538 So much for his recent history as it came out at the inquest.
24546 \begin_layout Subsection
24550 \begin_layout Standard
24551 The examples in this section show some more special features of multiple
24555 \begin_layout Standard
24556 For more features of multiple columns, have a look at the documentation
24557 of the \SpecialChar LaTeX
24563 \begin_inset CommandInset citation
24572 \begin_layout Subsubsection
24576 \begin_layout Standard
24577 To add a preface text for multiple columns, set the cursor into the multicolumn
24578 inset and use the menu
24580 Insert\SpecialChar menuseparator
24584 Write your preface text into that inset.
24585 \begin_inset Newline newline
24588 This is an example with some preface text:
24591 \begin_layout Standard
24592 \begin_inset VSpace bigskip
24598 \begin_layout Standard
24599 \begin_inset Flex Multiple Columns
24602 \begin_layout Plain Layout
24603 \begin_inset Argument 2
24606 \begin_layout Plain Layout
24607 And the story continues and continues and continues and continues\SpecialChar ldots
24615 On the evening of the crime, he returned from the club exactly at ten.
24616 His mother and sister were out spending the evening with a relation.
24617 The servant deposed that she heard him enter the front room on the second
24618 floor, generally used as his sitting-room.
24619 She had lit a fire there, and as it smoked she had opened the window.
24620 No sound was heard from the room until eleven-twenty, the hour of the return
24621 of Lady Maynooth and her daughter.
24622 Desiring to say good-night, she attempted to enter her son's room.
24623 The door was locked on the inside, and no answer could be got to their
24624 cries and knocking.
24625 Help was obtained, and the door forced.
24626 The unfortunate young man was found lying near the table.
24627 His head had been horribly mutilated by an expanding revolver bullet, but
24628 no weapon of any sort was to be found in the room.
24636 \begin_layout Standard
24637 You can also use a section heading as the preface if you use a section command
24638 as \SpecialChar TeX
24640 For example the command
24643 \begin_layout Standard
24648 subsection{subsection title}
24651 \begin_layout Standard
24652 creates a subsection.
24653 In this example the preface is a subsubsection:
24656 \begin_layout Standard
24657 \begin_inset Flex Multiple Columns
24660 \begin_layout Plain Layout
24661 \begin_inset Argument 2
24664 \begin_layout Plain Layout
24668 \begin_layout Plain Layout
24677 This is a subsubsection heading as a preface
24681 \begin_layout Plain Layout
24695 A minute examination of the circumstances served only to make the case more
24697 In the first place, no reason could be given why the young man should have
24698 fastened the door upon the inside.
24699 There was the possibility that the murderer had done this, and had afterwards
24700 escaped by the window.
24701 The drop was at least twenty feet, however, and a bed of crocuses in full
24703 Neither the flowers nor the earth showed any sign of having been disturbed,
24704 nor were there any marks upon the narrow strip of grass which separated
24705 the house from the road.
24706 Apparently, therefore, it was the young man himself who had fastened the
24708 But how did he come by his death? No one could have climbed up to the window
24709 without leaving traces.
24710 Suppose a man had fired through the window, he would indeed be a remarkable
24711 shot who could with a revolver inflict so deadly a wound.
24712 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24713 a hundred yards of the house.
24714 No one had heard a shot.
24722 \begin_layout Standard
24723 If there is less vertical space than 6
24724 \begin_inset space ~
24727 text lines is left on the page at the beginning of the multiple columns,
24728 a page break will be inserted before the multiple columns.
24729 Depending on the number of lines of the preface text, you might want to
24731 This is done by setting the cursor into the mulitcolumn inset behind the
24732 preface (if there is any) and using the menu
24734 Insert\SpecialChar menuseparator
24736 \begin_inset space ~
24740 \begin_inset space ~
24744 \begin_inset space ~
24750 Insert into that inset the amount of space like e.
24751 \begin_inset space \thinspace{}
24755 \begin_inset space \space{}
24759 \begin_inset Quotes eld
24763 \begin_inset Quotes erd
24767 \begin_inset Newline newline
24770 In this example the space is set to 7
24771 \begin_inset space ~
24774 text lines by using
24775 \begin_inset Quotes eld
24781 \begin_inset Quotes erd
24790 needs to be inserted as \SpecialChar TeX
24794 \begin_layout Standard
24795 \begin_inset Flex Multiple Columns
24798 \begin_layout Plain Layout
24799 \begin_inset Argument 3
24802 \begin_layout Plain Layout
24807 \begin_layout Plain Layout
24823 On the evening of the crime, he returned from the club exactly at ten.
24824 His mother and sister were out spending the evening with a relation.
24825 The servant deposed that she heard him enter the front room on the second
24826 floor, generally used as his sitting-room.
24827 She had lit a fire there, and as it smoked she had opened the window.
24828 No sound was heard from the room until eleven-twenty, the hour of the return
24829 of Lady Maynooth and her daughter.
24830 Desiring to say good-night, she attempted to enter her son's room.
24831 The door was locked on the inside, and no answer could be got to their
24832 cries and knocking.
24833 Help was obtained, and the door forced.
24834 The unfortunate young man was found lying near the table.
24835 His head had been horribly mutilated by an expanding revolver bullet, but
24836 no weapon of any sort was to be found in the room.
24844 \begin_layout Subsubsection
24848 \begin_layout Standard
24849 The amount of space before and after multiple columns can be changed by
24850 changing the length
24857 For example the command
24860 \begin_layout Standard
24870 \begin_layout Standard
24871 in \SpecialChar TeX
24872 Code changes its value to 3
24873 \begin_inset space \thinspace{}
24877 The change must be made before the multiple columns' start.
24878 The predefined value is 13
24879 \begin_inset space \thinspace{}
24885 \begin_layout Standard
24893 \begin_inset space \thinspace{}
24899 \begin_layout Standard
24903 \begin_layout Plain Layout
24909 multicolsep}{2.5cm}
24917 \begin_layout Standard
24918 \begin_inset Flex Multiple Columns
24921 \begin_layout Plain Layout
24924 All day I turned these facts over in my mind, endeavouring to hit upon some
24925 theory which could reconcile them all, and to find that line of least resistanc
24926 e which my poor friend had declared to be the starting-point of every investigat
24928 I confess that I made little progress.
24929 In the evening I strolled across the Park, and found myself about six o'clock
24930 at the Oxford Street end of Park Lane.
24931 A group of loafers upon the pavements, all staring up at a particular window,
24932 directed me to the house which I had come to see.
24933 A tall, thin man with coloured glasses, whom I strongly suspected of being
24934 a plain-clothes detective, was pointing out some theory of his own, while
24935 the others crowded round to listen to what he said.
24936 I got as near him as I could, but his observations seemed to me to be absurd,
24937 so I withdrew again in some disgust.
24938 As I did so I struck against an elderly, deformed man, who had been behind
24939 me, and I knocked down several books which he was carrying.
24947 \begin_layout Standard
24948 \begin_inset Note Greyedout
24951 \begin_layout Plain Layout
24956 The values you set with
24962 will be used for all following multiple columns until you change them again.
24970 \begin_layout Standard
24974 \begin_layout Plain Layout
24986 \begin_inset Note Note
24989 \begin_layout Plain Layout
24990 go back to the default
24998 \begin_layout Standard
24999 \begin_inset Newpage newpage
25005 \begin_layout Subsubsection
25009 \begin_layout Standard
25010 A column break can be forced by inserting the command
25016 as \SpecialChar TeX
25017 Code to that position in the text where the column should be broken.
25018 Note that this leads in most cases to whitespace in the text.
25019 \begin_inset Newline newline
25022 Here is an example:
25025 \begin_layout Standard
25026 \begin_inset Flex Multiple Columns
25029 \begin_layout Plain Layout
25032 \begin_inset Quotes eld
25035 You're surprised to see me, sir,
25036 \begin_inset Quotes erd
25039 said he, in a strange, croaking voice.
25042 \begin_layout Plain Layout
25045 I acknowledged that I was.
25048 \begin_layout Plain Layout
25051 \begin_inset Quotes eld
25054 Well, I've a conscience, sir, and when I chanced to see you go into this
25055 house, as I came hobbling after you, I thought to myself, I'll just step
25056 in and see that kind gentleman, and tell him that if I was a bit gruff
25057 in my manner there was not any harm meant, and that I am much obliged to
25058 him for picking up my books.
25059 \begin_inset Quotes erd
25065 \begin_layout Plain Layout
25068 \begin_inset Quotes eld
25071 You make too much of a trifle,
25072 \begin_inset Quotes erd
25077 \begin_inset Quotes eld
25080 May I ask how you knew who I was?
25081 \begin_inset Quotes erd
25084 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25088 \begin_layout Plain Layout
25100 \begin_layout Plain Layout
25103 \begin_inset Quotes eld
25106 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25107 you'll find my little bookshop at the corner of Church Street, and very
25108 happy to see you, I am sure.
25109 Maybe you collect yourself, sir.
25113 \begin_inset space ~
25126 –a bargain, every one of them.
25127 With five volumes you could just fill that gap on that second shelf.
25128 It looks untidy, does it not, sir?
25129 \begin_inset Quotes erd
25140 \begin_layout Subsubsection
25144 \begin_layout Standard
25145 The width of the columns is automatically calculated, but you can modify
25146 the space between the columns.
25147 This is done by changing the length
25154 Its predefined value is 10
25155 \begin_inset space \thinspace{}
25159 Here is an example where
25166 \begin_inset space \thinspace{}
25172 \begin_layout Standard
25176 \begin_layout Plain Layout
25190 \begin_layout Standard
25191 \begin_inset Flex Multiple Columns
25194 \begin_layout Plain Layout
25197 My observations of No.
25198 \begin_inset space \space{}
25201 427 Park Lane did little to clear up the problem in which I was interested.
25202 The house was separated from the street by a low wall and railing, the
25203 whole not more than five feet high.
25204 It was perfectly easy, therefore, for anyone to get into the garden, but
25205 the window was entirely inaccessible, since there was no water pipe or
25206 anything which could help the most active man to climb it.
25207 More puzzled than ever, I retraced my steps to Kensington.
25208 I had not been in my study five minutes when the maid entered to say that
25209 a person desired to see me.
25210 To my astonishment it was none other than my strange old book collector,
25211 his sharp, wizened face peering out from a frame of white hair, and his
25212 precious volumes, a dozen of them at least, wedged under his right arm.
25220 \begin_layout Standard
25224 \begin_layout Plain Layout
25236 \begin_inset Note Note
25239 \begin_layout Plain Layout
25240 go back to the default
25248 \begin_layout Subsubsection
25252 \begin_layout Standard
25253 Between the columns a rule with a width of the length
25260 If this rule width is set to 0
25261 \begin_inset space \thinspace{}
25264 pt (this is the default), the rule is suppressed.
25265 In the following example the rule is 2
25266 \begin_inset space \thinspace{}
25272 \begin_layout Standard
25276 \begin_layout Plain Layout
25282 columnseprule}{2pt}
25290 \begin_layout Standard
25291 \begin_inset Flex Multiple Columns
25294 \begin_layout Plain Layout
25297 \begin_inset Quotes eld
25300 You're surprised to see me, sir,
25301 \begin_inset Quotes erd
25304 said he, in a strange, croaking voice.
25307 \begin_layout Plain Layout
25310 I acknowledged that I was.
25313 \begin_layout Plain Layout
25316 \begin_inset Quotes eld
25319 Well, I've a conscience, sir, and when I chanced to see you go into this
25320 house, as I came hobbling after you, I thought to myself, I'll just step
25321 in and see that kind gentleman, and tell him that if I was a bit gruff
25322 in my manner there was not any harm meant, and that I am much obliged to
25323 him for picking up my books.
25324 \begin_inset Quotes erd
25330 \begin_layout Plain Layout
25333 \begin_inset Quotes eld
25336 You make too much of a trifle,
25337 \begin_inset Quotes erd
25342 \begin_inset Quotes eld
25345 May I ask how you knew who I was?
25346 \begin_inset Quotes erd
25352 \begin_layout Plain Layout
25355 \begin_inset Quotes eld
25358 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25359 you'll find my little bookshop at the corner of Church Street, and very
25360 happy to see you, I am sure.
25361 Maybe you collect yourself, sir.
25365 \begin_inset space ~
25378 –a bargain, every one of them.
25379 With five volumes you could just fill that gap on that second shelf.
25380 It looks untidy, does it not, sir?
25381 \begin_inset Quotes erd
25392 \begin_layout Standard
25393 \begin_inset VSpace defskip
25399 \begin_layout Standard
25400 The rule can be colored by redefining the command
25407 This is done by inserting the command
25408 \begin_inset Newline newline
25417 columnseprulecolor}{
25422 \begin_inset Newline newline
25425 as \SpecialChar TeX
25426 Code before the multicolumn inset.
25431 in this command by a color of your choice.
25432 You can use all pre- and self-defined colors.
25440 \begin_inset space ~
25445 for more information about pre- and self-defined colors.
25446 To go back to the default color insert the command
25447 \begin_inset Newline newline
25456 columnseprulecolor}{
25461 \begin_inset Newline newline
25464 Here is the example with a cyan rule and 1
25465 \begin_inset space \thinspace{}
25468 cm column separation:
25471 \begin_layout Standard
25475 \begin_layout Plain Layout
25484 \begin_layout Plain Layout
25490 columnseprulecolor}{
25500 \begin_layout Standard
25501 \begin_inset Flex Multiple Columns
25504 \begin_layout Plain Layout
25507 \begin_inset Quotes eld
25510 You're surprised to see me, sir,
25511 \begin_inset Quotes erd
25514 said he, in a strange, croaking voice.
25517 \begin_layout Plain Layout
25520 I acknowledged that I was.
25523 \begin_layout Plain Layout
25526 \begin_inset Quotes eld
25529 Well, I've a conscience, sir, and when I chanced to see you go into this
25530 house, as I came hobbling after you, I thought to myself, I'll just step
25531 in and see that kind gentleman, and tell him that if I was a bit gruff
25532 in my manner there was not any harm meant, and that I am much obliged to
25533 him for picking up my books.
25534 \begin_inset Quotes erd
25540 \begin_layout Plain Layout
25543 \begin_inset Quotes eld
25546 You make too much of a trifle,
25547 \begin_inset Quotes erd
25552 \begin_inset Quotes eld
25555 May I ask how you knew who I was?
25556 \begin_inset Quotes erd
25562 \begin_layout Plain Layout
25565 \begin_inset Quotes eld
25568 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25569 you'll find my little bookshop at the corner of Church Street, and very
25570 happy to see you, I am sure.
25571 Maybe you collect yourself, sir.
25575 \begin_inset space ~
25588 –a bargain, every one of them.
25589 With five volumes you could just fill that gap on that second shelf.
25590 It looks untidy, does it not, sir?
25591 \begin_inset Quotes erd
25602 \begin_layout Standard
25606 \begin_layout Plain Layout
25612 columnseprule}{0pt}
25615 \begin_layout Plain Layout
25621 columnseprulecolor}{
25629 \begin_inset Note Note
25632 \begin_layout Plain Layout
25633 go back to the default
25641 \begin_layout Section
25642 Non-standard Paragraph Shapes
25645 \begin_layout Standard
25648 as well as any other text processor uses by default rectangular paragraphs.
25649 For special cases like for example posters, invitation cards or poems you
25650 can modify the paragraph shape to one of your choice.
25651 This can be done by using the \SpecialChar LaTeX
25656 which is loaded by using in the document settings the module
25658 Custom paragraph shapes
25663 \begin_layout Subsection
25667 \begin_layout Standard
25672 provides the following shapes:
25675 \begin_layout Standard
25676 \begin_inset Tabular
25677 <lyxtabular version="3" rows="13" columns="3">
25678 <features booktabs="true" islongtable="true" longtabularalignment="center">
25679 <column alignment="center" valignment="middle" width="16col%">
25680 <column alignment="center" valignment="middle" width="40col%">
25681 <column alignment="center" valignment="middle" width="35col%">
25682 <row endhead="true">
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" usebox="none">
25695 \begin_layout Plain Layout
25701 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25704 \begin_layout Plain Layout
25712 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25715 \begin_layout Plain Layout
25721 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25724 \begin_layout Plain Layout
25725 Circle with circular hole (in the size of a CD/DVD)
25730 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25733 \begin_layout Plain Layout
25734 Cannot be scaled, take care there is not too much text
25741 <cell alignment="center" valignment="top" topline="true" usebox="none">
25744 \begin_layout Plain Layout
25750 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25753 \begin_layout Plain Layout
25759 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25762 \begin_layout Plain Layout
25763 Fragile, calculation might fail
25770 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25773 \begin_layout Plain Layout
25779 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25782 \begin_layout Plain Layout
25783 Rhomboid (symbolizing a
25784 \begin_inset Quotes eld
25788 \begin_inset Quotes erd
25796 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25799 \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" usebox="none">
25819 \begin_layout Plain Layout
25825 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25828 \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" usebox="none">
25848 \begin_layout Plain Layout
25854 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25857 \begin_layout Plain Layout
25865 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25868 \begin_layout Plain Layout
25874 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25877 \begin_layout Plain Layout
25878 Nut for bolt (hexagon with circular hole)
25883 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25886 \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" usebox="none">
25906 \begin_layout Plain Layout
25912 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25915 \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" usebox="none">
25935 \begin_layout Plain Layout
25941 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25944 \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" usebox="none">
25964 \begin_layout Plain Layout
25970 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25973 \begin_layout Plain Layout
25981 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25984 \begin_layout Plain Layout
25990 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25993 \begin_layout Plain Layout
25994 Normal/reversed rain drop
25999 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26002 \begin_layout Plain Layout
26003 Fragile, calculation might fail
26010 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26013 \begin_layout Plain Layout
26020 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26023 \begin_layout Plain Layout
26024 The \SpecialChar TeX
26030 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26033 \begin_layout Plain Layout
26041 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26044 \begin_layout Plain Layout
26046 \begin_inset Newline newline
26054 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26057 \begin_layout Plain Layout
26058 Triangles in different orientations
26063 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26066 \begin_layout Plain Layout
26080 \begin_layout Standard
26081 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26083 for environments in the toolbar.
26086 \begin_layout Standard
26087 \begin_inset Newpage newpage
26093 \begin_layout Standard
26094 Here is an example paragraph in the shape of a nut:
26097 \begin_layout Standard
26098 \begin_inset VSpace bigskip
26107 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26108 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26110 At vero eos et accusam et justo duo dolores et ea rebum.
26111 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26113 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26114 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26118 \begin_layout Standard
26119 \begin_inset VSpace bigskip
26125 \begin_layout Standard
26126 \begin_inset Note Greyedout
26129 \begin_layout Plain Layout
26134 : shapepar paragraphs cannot run over a page break.
26142 \begin_layout Standard
26143 \begin_inset VSpace bigskip
26149 \begin_layout Standard
26154 takes care that the shape will always be preserved, no matter how much
26155 text is in the paragraph.
26156 Therefore the paragraph size changes with the amount of contained text.
26157 This can lead to paragraph sizes exceeding the page margins.
26158 To demonstrate the size scaling, here is the same example paragraph but
26159 with twice as much text:
26162 \begin_layout Standard
26163 \begin_inset Newpage newpage
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
26181 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26182 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26184 At vero eos et accusam et justo duo dolores et ea rebum.
26185 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26187 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26188 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26192 \begin_layout Standard
26193 \begin_inset VSpace bigskip
26199 \begin_layout Standard
26200 An exception is the shape
26205 It cannot be scaled because it must fit the size of a CD/DVD.
26206 Therefore the amount of text that fits into the shape is limited.
26207 \begin_inset Newline newline
26218 shape are fragile, meaning that the calculation of their size can fail,
26219 depending on the amount of text.
26220 You will then get the \SpecialChar LaTeX
26222 \begin_inset Quotes eld
26225 Arithmetic overflow
26226 \begin_inset Quotes erd
26230 In this case one can try to remove or add some text; if nothing works one
26231 has to use another shape.
26234 \begin_layout Standard
26235 \begin_inset VSpace bigskip
26241 \begin_layout Standard
26242 For shapes with tips you will maybe see that \SpecialChar LaTeX
26243 's hyphenation routine fails
26244 for text in the tips.
26245 Therefore it is often necessary to add hyphenation points
26250 arg "specialchar-insert hyphenation"
26255 ) to the corresponding text parts.
26258 \begin_layout Standard
26259 \begin_inset VSpace bigskip
26265 \begin_layout Standard
26266 Shapepar paragraphs are either always centered or placed on the page so
26267 that their left border touches the left page margin.
26268 You can therefore not use the paragraph dialog to align such paragraphs.
26269 A solution is to put the paragraph into a minipage or parbox and align
26271 The problem is hereby to find the right width for the box.
26272 Because if it is too wide and you center the box, the paragraph is not
26273 centered too because it sticks at the left side of the box.
26274 So you might have to play a bit with the width until it fits.
26275 Here are two heart-shaped paragraphs, the first one is not aligned, the
26276 second one is right-aligned:
26279 \begin_layout Standard
26280 \begin_inset Newpage newpage
26286 \begin_layout Heart
26290 Lo\SpecialChar softhyphen
26291 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26292 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26294 At vero eos et accusam et justo duo dolores et ea rebum.
26295 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26299 \begin_layout Standard
26300 \begin_inset VSpace bigskip
26306 \begin_layout Standard
26309 \begin_inset Box Frameless
26319 height_special "totalheight"
26324 backgroundcolor "none"
26327 \begin_layout Heart
26331 Lo\SpecialChar softhyphen
26332 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26333 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26335 At vero eos et accusam et justo duo dolores et ea rebum.
26336 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26345 \begin_layout Subsection
26349 \begin_layout Standard
26350 You can define any shape you want.
26351 Doing this manually is a lot of work because every coordinate must be specified.
26352 But there is a way to let the computer calculate the coordinates:
26355 \begin_layout Enumerate
26356 Install the program
26357 \begin_inset CommandInset href
26360 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26367 \begin_layout Enumerate
26374 TeX/LaTeX\SpecialChar menuseparator
26375 Settings\SpecialChar menuseparator
26378 and select the font size you are using in your document.
26379 For example this document uses the size 12
26380 \begin_inset space \thinspace{}
26386 \begin_layout Enumerate
26390 \begin_layout Enumerate
26393 TeX/LaTeX\SpecialChar menuseparator
26396 to export the shape to coordinates.
26397 In the appearing dialog use either the outline of your shape for the coordinate
26398 s or the path itself.
26402 \begin_layout Plain Layout
26403 For more information see
26404 \begin_inset CommandInset href
26406 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26418 \begin_layout Standard
26419 The coordinates are written into a \SpecialChar TeX
26421 To use it for your \SpecialChar LyX
26425 \begin_layout Enumerate
26426 Place the cursor before the first character of your paragraph (or into a
26430 \begin_layout Enumerate
26431 Open in \SpecialChar LyX
26434 Insert\SpecialChar menuseparator
26435 File\SpecialChar menuseparator
26437 \begin_inset space ~
26442 , select the file and use
26451 \begin_layout Standard
26452 \begin_inset VSpace defskip
26458 \begin_layout Standard
26459 \begin_inset Note Greyedout
26462 \begin_layout Plain Layout
26467 : The changed shape only applies to the current paragraph; everything is
26468 reset to normal for the next paragraph.
26469 Therefore the shape definition file must be input into every paragraph
26470 with the desired shape.
26478 \begin_layout Standard
26479 \begin_inset VSpace bigskip
26485 \begin_layout Standard
26486 Here is an example:
26489 \begin_layout Standard
26490 \begin_inset VSpace bigskip
26496 \begin_layout Standard
26497 \begin_inset CommandInset include
26499 filename "SpecialParagraphShape.tex"
26505 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26506 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26508 At vero eos et accusam et justo duo dolores et ea rebum.
26509 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26511 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26512 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26516 \begin_layout Standard
26517 \begin_inset VSpace bigskip
26523 \begin_layout Standard
26528 to draw complexer shapes in
26532 you can draw the shape in a program of your choice and import the resulting
26538 Then you only need to draw a line or spline along the outline of the image.
26541 \begin_layout Standard
26542 \begin_inset VSpace bigskip
26548 \begin_layout Standard
26551 Custom paragraph shapes
26553 also provides the two commands
26561 which can be used to define custom shapes coordinate by coordinate.
26565 \begin_layout Plain Layout
26566 These commands are internally used for all shapes described here.
26571 For information how these styles are used and about further customization
26572 possibilities, have a look at the documentation of the package
26577 \begin_inset CommandInset citation
26586 \begin_layout Bibliography
26587 \begin_inset CommandInset bibitem
26588 LatexCommand bibitem
26593 Documentation of the \SpecialChar LaTeX
26595 \begin_inset CommandInset href
26598 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26605 \begin_layout Bibliography
26606 \begin_inset CommandInset bibitem
26607 LatexCommand bibitem
26612 Documentation of the \SpecialChar LaTeX
26614 \begin_inset CommandInset href
26617 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"