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
52 InsetLayout CharStyle:MenuItem
61 \newcommand*{\menuitem}[1]{{\sffamily #1}}
66 \language_package default
69 \font_roman "default" "default"
70 \font_sans "default" "default"
71 \font_typewriter "default" "default"
72 \font_math "auto" "auto"
73 \font_default_family default
74 \use_non_tex_fonts false
77 \font_sf_scale 100 100
78 \font_tt_scale 100 100
80 \default_output_format default
82 \bibtex_command default
83 \index_command default
87 \pdf_title "LyX's Additional Features manual"
88 \pdf_author "LyX Team"
89 \pdf_subject "LyX's additional features documentation"
90 \pdf_keywords "LyX, Documentation, Additional"
92 \pdf_bookmarksnumbered true
93 \pdf_bookmarksopen false
94 \pdf_bookmarksopenlevel 1
99 \pdf_pdfusetitle false
100 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
103 \use_package amsmath 1
104 \use_package amssymb 1
105 \use_package cancel 0
107 \use_package mathdots 1
108 \use_package mathtools 0
109 \use_package mhchem 1
110 \use_package stackrel 0
111 \use_package stmaryrd 0
112 \use_package undertilde 0
114 \cite_engine_type default
118 \paperorientation portrait
122 \notefontcolor #0000ff
129 \paragraph_separation indent
130 \paragraph_indentation default
131 \quotes_language english
134 \paperpagestyle headings
135 \tracking_changes false
136 \output_changes false
145 Additional \SpecialChar LyX
149 \begin_layout Subtitle
154 by the \SpecialChar LyX
159 \begin_layout Plain Layout
161 Principal maintainer of this file is
166 If you have comments or error corrections, please send them to the \SpecialChar LyX
169 \begin_inset Flex Code
172 \begin_layout Plain Layout
174 <lyx-docs@lists.lyx.org>
187 \begin_layout Standard
188 \begin_inset CommandInset toc
189 LatexCommand tableofcontents
196 \begin_layout Chapter
200 \begin_layout Standard
201 This manual is essentially Part II of the
203 User's Guide\SpecialChar endofsentence
206 The reason for separating the two documents is simple: the
210 is already quite lengthy, and it contains information on all of the basic
211 features one needs to know in order to prepare most documents.
212 However, the \SpecialChar LyX
213 Team has worked to make \SpecialChar LyX
214 extensible through various configuration
215 files and external packages.
216 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
218 create a layout file (or module) for it without having to alter \SpecialChar LyX
220 We've already had contributions of several new features this way, and some
221 of them are documented here.
222 There are also some more `advanced' features, such as how to control the
223 presentation of bibliographies and how to work with multi-part documents,
224 that are not covered in the
228 and are discussed here.
231 \begin_layout Standard
232 This manual also documents some special features, like fax support, version
233 control, and SGML support, which require additional software to work properly.
234 There is also a chapter on \SpecialChar LyX
236 And lastly, there's a chapter of \SpecialChar LaTeX
237 tools and tips, things you can use to
238 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
240 After all, \SpecialChar LyX
245 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
249 \begin_layout Standard
250 If you haven't read the
254 yet, you are definitely in the wrong manual.
259 is the first place to go, since it describes the notation and format of
261 You should also be thoroughly familiar with the
265 and all of the basic features of \SpecialChar LyX
266 before attempting to read this one.
269 \begin_layout Standard
270 Since many of the topics in this manual depend heavily on \SpecialChar LyX
272 with \SpecialChar LaTeX
273 , this first chapter covers the inner workings of \SpecialChar LyX
276 to generate exactly the \SpecialChar LaTeX
278 It is obviously for more seasoned \SpecialChar LyX
282 \begin_layout Chapter
284 and \SpecialChar LaTeX
288 \begin_layout Section
290 Uses \SpecialChar LaTeX
294 \begin_layout Standard
295 This chapter is for both \SpecialChar TeX
296 -nicians and the \SpecialChar LaTeX
298 In it, we'll explain how \SpecialChar LyX
299 and \SpecialChar LaTeX
300 work together to produce printable output.
301 This is the only place in any of the manuals where we assume you know something
302 about \SpecialChar LaTeX
306 \begin_layout Standard
307 At one time, \SpecialChar LyX
309 \begin_inset Quotes eld
312 WYSIWYM frontend to \SpecialChar LaTeX
314 \begin_inset Quotes erd
317 but that's no longer true.
318 There are frontends to \SpecialChar LaTeX
323 \begin_layout Plain Layout
324 Some familar ones are \SpecialChar TeX
325 maker and kile, on Linux, and \SpecialChar TeX
327 There are also the \SpecialChar LaTeX
328 modes for vi and emacs, of course.
333 These are basically text editors with the ability to run \SpecialChar LaTeX
335 errors in the file you're editing.
336 Although \SpecialChar LyX
345 run \SpecialChar LaTeX
346 , and it also indicates errors in the file, it also does much, much
348 For one thing, you don't need to know \SpecialChar LaTeX
349 to use \SpecialChar LyX
352 has added its own extensions to \SpecialChar LaTeX
354 Try the following sometime: select
355 \begin_inset Flex MenuItem
358 \begin_layout Plain Layout
359 Export\SpecialChar menuseparator
367 \begin_inset Flex MenuItem
370 \begin_layout Plain Layout
377 \begin_inset Flex MenuItem
380 \begin_layout Plain Layout
381 View\SpecialChar menuseparator
391 ), then look at the preamble of the resulting
392 \begin_inset Flex Code
395 \begin_layout Plain Layout
402 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
404 These macros are defined automatically, according to the features you use
408 \begin_layout Standard
409 There are several commands that automatically invoke \SpecialChar LaTeX
414 \begin_layout Itemize
415 \begin_inset Flex MenuItem
418 \begin_layout Plain Layout
419 Document\SpecialChar menuseparator
428 \begin_layout Itemize
429 \begin_inset Flex MenuItem
432 \begin_layout Plain Layout
433 Document\SpecialChar menuseparator
442 \begin_layout Itemize
443 \begin_inset Flex MenuItem
446 \begin_layout Plain Layout
447 File\SpecialChar menuseparator
456 \begin_layout Itemize
457 \begin_inset Flex MenuItem
460 \begin_layout Plain Layout
461 File\SpecialChar menuseparator
470 \begin_layout Standard
471 They will only invoke \SpecialChar LaTeX
472 if the file has changed since the last time \SpecialChar LaTeX
478 \begin_layout Standard
479 When \SpecialChar LyX
480 runs \SpecialChar LaTeX
481 on the file you're editing, it performs these steps:
484 \begin_layout Enumerate
485 Convert the document to \SpecialChar LaTeX
486 and save to a file with the extension
487 \begin_inset Flex Code
490 \begin_layout Plain Layout
497 \begin_inset Flex Code
500 \begin_layout Plain Layout
509 \begin_layout Enumerate
510 Run \SpecialChar LaTeX
512 \begin_inset Flex Code
515 \begin_layout Plain Layout
521 file (maybe several times), and run any other commands (such as
522 \begin_inset Flex Code
525 \begin_layout Plain Layout
532 \begin_inset Flex Code
535 \begin_layout Plain Layout
541 ) needed to compile the \SpecialChar LaTeX
545 \begin_layout Enumerate
546 If there are any errors, show the error log.
549 \begin_layout Standard
550 If you have run \SpecialChar LaTeX
552 \begin_inset Flex MenuItem
555 \begin_layout Plain Layout
558 \SpecialChar menuseparator
567 then runs a DVI viewer to display the DVI-file.
569 \begin_inset Flex MenuItem
572 \begin_layout Plain Layout
575 \SpecialChar menuseparator
584 performs further steps:
587 \begin_layout Itemize
589 \begin_inset Flex Code
592 \begin_layout Plain Layout
598 to convert the DVI file to PostScript.
601 \begin_layout Itemize
602 Run a PostScript viewer, such as
603 \begin_inset Flex Code
606 \begin_layout Plain Layout
612 , to display the PostScript file.
615 \begin_layout Standard
617 does similar things when viewing, or exporting, other formats.
620 \begin_layout Section
621 Translating \SpecialChar LaTeX
622 files into \SpecialChar LyX
626 \begin_layout Standard
627 You can import a \SpecialChar LaTeX
628 file into \SpecialChar LyX
630 \begin_inset Flex MenuItem
633 \begin_layout Plain Layout
634 File\SpecialChar menuseparator
635 Import\SpecialChar menuseparator
642 command in \SpecialChar LyX
644 This will call a program named
645 \begin_inset Flex Code
648 \begin_layout Plain Layout
654 which will create a file
655 \begin_inset Flex Code
658 \begin_layout Plain Layout
665 \begin_inset Flex Code
668 \begin_layout Plain Layout
676 will then open that file.
680 \begin_layout Plain Layout
681 \begin_inset Flex Code
684 \begin_layout Plain Layout
690 can also be run from the command line, of course.
698 \begin_layout Standard
699 \begin_inset Flex Code
702 \begin_layout Plain Layout
708 will translate most legal \SpecialChar LaTeX
709 , but not everything.
710 It will put things it doesn't understand into \SpecialChar TeX
711 code, so after translating
713 \begin_inset Flex Code
716 \begin_layout Plain Layout
722 , you can look for \SpecialChar TeX
723 code and hand-edit it until it looks right.
726 \begin_layout Standard
727 If you don't know what \SpecialChar TeX
728 code is, read the next section.
731 \begin_layout Section
732 \begin_inset CommandInset label
734 name "sec:Inserting-TeX-Code"
738 Inserting \SpecialChar TeX
739 Code into \SpecialChar LyX
743 \begin_layout Standard
744 Anything you can do in \SpecialChar LaTeX
745 you can do in \SpecialChar LyX
746 , for a very simple reason: You can
747 always insert \SpecialChar TeX
748 code into any \SpecialChar LyX
751 cannot, and will never be able to, display every possible \SpecialChar LaTeX
753 If ever you need to insert \SpecialChar LaTeX
754 commands into your \SpecialChar LyX
755 document, you can use the
757 \begin_inset Flex Code
760 \begin_layout Plain Layout
767 box, which you can insert into your document with
768 \begin_inset Flex MenuItem
771 \begin_layout Plain Layout
772 Insert\SpecialChar menuseparator
782 or the keyboard shortcut
791 \begin_layout Standard
792 Here's an example of inserting \SpecialChar LaTeX
793 commands in a \SpecialChar LyX
795 The code looks like this:
798 \begin_layout LyX-Code
802 \begin_inset Newline newline
808 \begin_inset Newline newline
811 This is an example of a minipage environment.
813 \begin_inset Newline newline
816 can put nearly everything in it, even (non-floating)
817 \begin_inset Newline newline
822 \begin_inset Newline newline
828 \begin_inset Newline newline
832 \begin_inset Newline newline
838 \begin_inset Newline newline
844 \begin_inset Newline newline
850 \begin_inset Newline newline
855 \begin_inset Newline newline
861 \begin_inset Newline newline
867 \begin_inset Newline newline
873 \begin_inset Newline newline
881 \begin_layout LyX-Code
885 \begin_layout Standard
887 \begin_inset Flex Code
890 \begin_layout Plain Layout
897 box containing this text is directly after this paragraph.
898 Those of you reading the manual in \SpecialChar LyX
899 will only see the \SpecialChar TeX
901 Those reading a printed version of the manuals will see the actual results:
902 \begin_inset VSpace bigskip
908 \begin_layout Standard
912 \begin_layout Plain Layout
919 \begin_layout Plain Layout
926 \begin_layout Plain Layout
928 This is an example of a minipage environment.
929 You can put nearly everything in it, even (non-floating) figures and tables.
933 \begin_layout Plain Layout
940 \begin_layout Plain Layout
945 \begin_layout Plain Layout
952 \begin_layout Plain Layout
959 \begin_layout Plain Layout
966 \begin_layout Plain Layout
972 \begin_layout Plain Layout
979 \begin_layout Plain Layout
986 \begin_layout Plain Layout
993 \begin_layout Plain Layout
1003 \begin_inset VSpace bigskip
1009 \begin_layout Standard
1010 In addition to using \SpecialChar TeX
1011 code, you can also create a separate file containing
1012 some complex \SpecialChar LaTeX
1013 structure and then use
1014 \begin_inset Flex MenuItem
1017 \begin_layout Plain Layout
1018 Insert\SpecialChar menuseparator
1020 \begin_inset space ~
1028 to include your file (you should select the type
1029 \begin_inset Flex Code
1032 \begin_layout Plain Layout
1039 We recommend that you only do this if you have a
1040 \begin_inset Flex Code
1043 \begin_layout Plain Layout
1054 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1058 \begin_layout Standard
1059 There are a few last points to emphasize:
1062 \begin_layout Itemize
1068 check if your \SpecialChar LaTeX
1072 \begin_layout Itemize
1073 Beware of reinventing the wheel.
1076 \begin_layout Standard
1077 On that last point, \SpecialChar LyX
1078 does have quite a few features tucked into it, and
1080 Be sure to check the manuals to make sure that \SpecialChar LyX
1081 doesn't have such-and-such
1082 feature before you decide you have to do it by hand.
1083 Moreover, there are numerous \SpecialChar LaTeX
1084 packages out there to do all sorts of things,
1085 from labels to envelopes to fancy multipage tables.
1087 \begin_inset CommandInset href
1090 target "http://www.ctan.org/"
1097 \begin_layout Standard
1098 If you do need to do some wild and fancy things within your document, be
1099 sure to check out a good \SpecialChar LaTeX
1100 book for assistance.
1101 There are a number of them listed in the bibliography of the
1108 \begin_layout Section
1110 and the \SpecialChar LaTeX
1114 \begin_layout Subsection
1115 About the \SpecialChar LaTeX
1119 \begin_layout Standard
1120 If you already know \SpecialChar LaTeX
1121 , there is no need to explain here what the preamble
1123 If you don't, the following will give you some ideas—we recommend again
1124 that you consult a \SpecialChar LaTeX
1125 book for further information.
1126 In any case, you should read the points below, because they explain what
1127 you can do and what you don't need to do in the \SpecialChar LaTeX
1128 preamble of a \SpecialChar LyX
1132 \begin_layout Standard
1133 The \SpecialChar LaTeX
1134 preamble comes at the very beginning of a document,
1142 \begin_layout Itemize
1143 Declare the document class.
1145 \begin_inset Newline newline
1149 already does this for you.
1150 If you're a seasoned \SpecialChar LaTeX
1151 -nician, and you have a custom document class you
1152 want to use, check out the
1154 Customization Manual
1156 for information on how to make \SpecialChar LyX
1160 \begin_layout Itemize
1161 Declare the usage of packages.
1163 \begin_inset Newline newline
1167 packages provide special commands, which are only available within a document
1168 when the package has been declared in the preamble.
1169 In addition to providing special commands, the inclusion of a package can
1170 change the document.
1171 For example, the package
1172 \begin_inset Flex Code
1175 \begin_layout Plain Layout
1181 forces all paragraphs to be indented.
1182 There are other packages for labels, envelopes, margins, etc.
1186 \begin_layout Itemize
1187 Set counters, variables, lengths and widths.
1189 \begin_inset Newline newline
1192 There are several \SpecialChar LaTeX
1193 counters and variables that
1197 be set globally from within the preamble in order to have the desired effect.
1198 (There are variables that you can set and reset inside the document, too.)
1199 Margins are a good example of something that must be set in the preamble.
1200 Another example is the label format for lists.
1201 You can actually set these just about anywhere, but it's best to do it
1202 just once, inside the preamble.
1205 \begin_layout Itemize
1206 Declare user defined commands (with
1207 \begin_inset Flex Code
1210 \begin_layout Plain Layout
1219 \begin_inset Flex Code
1222 \begin_layout Plain Layout
1231 \begin_inset Newline newline
1234 These are abbreviations for \SpecialChar LaTeX
1235 commands which appear very often inside a document.
1236 Although the preamble is a good place to declare such commands, they
1240 be declared anywhere (before they are used for the first time, of course).
1241 This can be useful if there is a lot of raw \SpecialChar LaTeX
1242 code in your document, which
1243 normally should not be the case.
1246 \begin_layout Standard
1248 adds its own set of definitions to the preamble of the
1249 \begin_inset Flex Code
1252 \begin_layout Plain Layout
1259 This makes \SpecialChar LaTeX
1260 files generated by \SpecialChar LyX
1264 \begin_layout Subsection
1265 Changing the Preamble
1268 \begin_layout Standard
1269 The commands which \SpecialChar LyX
1270 adds to the preamble of a \SpecialChar LaTeX
1271 file are fixed; you can't
1272 change them without patching \SpecialChar LyX
1274 You can, however, add your own stuff to the preamble by selecting
1275 \begin_inset Flex MenuItem
1278 \begin_layout Plain Layout
1281 \begin_inset space ~
1290 \begin_inset Flex MenuItem
1293 \begin_layout Plain Layout
1294 Document\SpecialChar menuseparator
1302 adds anything in the
1303 \begin_inset Flex MenuItem
1306 \begin_layout Plain Layout
1312 dialog to its own built-in preamble.
1313 Before adding your own declarations in the preamble, you should make sure
1314 that \SpecialChar LyX
1315 doesn't already support what you want to do.
1316 (Remember what we said about reinventing the wheel?) Also,
1318 make sure your preamble code is correct
1322 doesn't check it for you.
1323 If there is an error, you're likely to get an error like
1324 \begin_inset Quotes eld
1328 \begin_inset Flex Code
1331 \begin_layout Plain Layout
1340 \begin_inset Quotes erd
1344 If you see this error, check your preamble.
1347 \begin_layout Subsection
1351 \begin_layout Standard
1352 Here are some examples of what you can add to a preamble, and what they
1356 \begin_layout Subsubsection
1360 \begin_layout Standard
1361 There are two variables under \SpecialChar LaTeX
1362 that control page position:
1363 \begin_inset Flex Code
1366 \begin_layout Plain Layout
1375 \begin_inset Flex Code
1378 \begin_layout Plain Layout
1387 Their names should be self-explanatory.
1388 These variables are useful if you think for a moment about computer labels.
1389 Sometimes, the size of a print medium and the area of the medium that you
1390 can actually print on aren't the same.
1392 \begin_inset Flex Code
1395 \begin_layout Plain Layout
1404 \begin_inset Flex Code
1407 \begin_layout Plain Layout
1418 \begin_layout Standard
1419 The default values for
1420 \begin_inset Flex Code
1423 \begin_layout Plain Layout
1432 \begin_inset Flex Code
1435 \begin_layout Plain Layout
1444 \begin_inset space \thinspace{}
1448 \begin_inset space \thinspace{}
1452 \begin_inset space \space{}
1455 the page isn't shifted.
1456 Unfortunately, some DVI drivers always seem to shift the page.
1457 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1458 If you're using \SpecialChar LyX
1459 on a system that you don't personally maintain, and your
1460 sysadmin is a doofus,
1461 \begin_inset Flex Code
1464 \begin_layout Plain Layout
1473 \begin_inset Flex Code
1476 \begin_layout Plain Layout
1485 Suppose your left and top margins are always 0.5
1486 \begin_inset space \thinspace{}
1490 You can add this to the preamble:
1493 \begin_layout LyX-Code
1501 \begin_layout LyX-Code
1509 \begin_layout Standard
1510 and your margins should now be correct.
1513 \begin_layout Subsubsection
1517 \begin_layout Standard
1518 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1519 There's a rather nice package, available at your nearest CTAN archive,
1520 for printing sheets of labels:
1521 \begin_inset Flex Code
1524 \begin_layout Plain Layout
1531 Now, your system may not have this package installed by default.
1532 We leave that up to you to check.
1533 You'll also want to read the documentation for it; we're not going to do
1535 Since this is an example, however, we'll give you an example of how you
1539 \begin_layout Standard
1540 First, make sure you're using the
1541 \begin_inset Flex Code
1544 \begin_layout Plain Layout
1551 Next, you need to put the following in your preamble:
1554 \begin_layout LyX-Code
1560 \begin_layout LyX-Code
1566 \begin_layout LyX-Code
1572 \begin_layout LyX-Code
1578 \begin_layout LyX-Code
1584 \begin_layout LyX-Code
1590 \begin_layout LyX-Code
1596 \begin_layout Standard
1597 This sets things up for Avery label sheets, stock #5360.
1598 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1601 \begin_inset Flex Code
1604 \begin_layout Plain Layout
1613 \begin_inset Flex Code
1616 \begin_layout Plain Layout
1624 around each label text.
1625 This and other special features of
1626 \begin_inset Flex Code
1629 \begin_layout Plain Layout
1635 are explained in its documentation.
1638 \begin_layout Standard
1639 Someday, someone may write a \SpecialChar LyX
1640 layout file to support this package directly.
1641 Maybe that someone is you.
1644 \begin_layout Subsubsection
1645 Example #3: Paragraph Indentation
1648 \begin_layout Standard
1649 Americans are trained to indent the first line of
1654 As with all of their other weird quirks, most Americans will whine and
1655 moan until they can have their way and indent the first line of all paragraphs.
1664 \begin_layout Standard
1665 Of course, this behavior isn't standard typography.
1666 In books, you typically only indent the first line of a paragraph
1670 it follows another one.
1671 The idea behind indenting the first line of a paragraph is to distinguish
1672 neighboring paragraphs from one another.
1673 If there is no previous paragraph—for example, if it follows a figure or
1674 is the first paragraph in a section—then there is no need for indentation.
1678 \begin_layout Standard
1679 If you're a typical American (we're still joking!), though, you don't care
1680 about such esoteric things; you want your indentation! Add this to the
1684 \begin_layout LyX-Code
1687 usepackage{indentfirst}
1690 \begin_layout Standard
1691 If your \SpecialChar TeX
1692 distribution isn't braindead, you'll have this package, and all
1693 of your paragraphs will get the indentation the Founding Fathers intended
1697 \begin_layout Subsubsection
1698 Example #4: This Document
1701 \begin_layout Standard
1702 You can also check out the preamble of this document to get an idea of some
1703 of the advanced things you can do.
1706 \begin_layout Section
1708 and \SpecialChar LaTeX
1712 \begin_layout Standard
1713 When \SpecialChar LyX
1714 calls \SpecialChar LaTeX
1715 , it tells \SpecialChar LaTeX
1716 to blithely ignore any errors and keep going.
1717 It then uses the logfile from the \SpecialChar LaTeX
1718 run to do a post-mortem.
1719 After analyzing the logfile, \SpecialChar LyX
1720 displays a dialog listing the errors.
1721 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1723 where the error occurred.
1727 \begin_layout Plain Layout
1729 Analyzing the logfile is a tough job, and \SpecialChar LyX
1730 doesn't always go to the right
1732 There are also cases where \SpecialChar LaTeX
1733 reports the error on one line, but the actual
1735 This is not unlike forgetting a closing brace in a program: You'll get
1736 an error, but only later.
1744 \begin_layout Standard
1745 Some folks also like to look at the log file directly: It is available from
1747 \begin_inset Flex MenuItem
1750 \begin_layout Plain Layout
1753 \SpecialChar menuseparator
1757 \begin_inset space ~
1766 There are some fairly common error messages and warnings.
1767 We'll cover those here.
1768 You should look at a good \SpecialChar LaTeX
1769 book for a complete listing.
1772 \begin_layout Itemize
1773 \begin_inset Flex Code
1776 \begin_layout Plain Layout
1784 \begin_inset Newline newline
1787 Anything beginning with these words is a warning message for the purpose
1789 \begin_inset Quotes eld
1793 \begin_inset Quotes erd
1796 the \SpecialChar LaTeX
1798 You'll get messages like this if you added or changed cross-references
1799 or bibliography entries, in which case, \SpecialChar LaTeX
1800 is trying to tell you that you
1801 need to make another run.
1802 You can by-and-large ignore these.
1805 \begin_layout Itemize
1806 \begin_inset Flex Code
1809 \begin_layout Plain Layout
1817 \begin_inset Newline newline
1820 Another warning message, this time about fonts which \SpecialChar LaTeX
1822 The rest of the message will often say something about a replacement font
1823 that \SpecialChar LaTeX
1825 You can safely ignore these, too.
1828 \begin_layout Itemize
1829 \begin_inset Flex Code
1832 \begin_layout Plain Layout
1841 \begin_inset Newline newline
1850 They are warnings about lines that were too long and run past the right
1852 Almost always, this is unnoticeable in the final output.
1853 (It can be just a point or two.) Or, only one or two characters extend past
1856 seems to generate at least one of these messages for just about any document
1858 \begin_inset Newline newline
1861 You can ignore these messages.
1862 Your eyes will tell you if there's a problem with something that's too
1863 wide; just look at the output.
1867 \begin_layout Plain Layout
1868 You can also enable the `draft' option in
1869 \begin_inset Flex MenuItem
1872 \begin_layout Plain Layout
1875 \SpecialChar menuseparator
1883 , and then \SpecialChar LaTeX
1884 will draw a black box in the margin of lines that are overfull.
1892 \begin_layout Itemize
1893 \begin_inset Flex Code
1896 \begin_layout Plain Layout
1905 \begin_inset Newline newline
1908 Not quite as common as its cousin.
1910 seems to like to print lines that are a bit too wide as opposed to ones
1911 that are a bit too narrow.
1912 We have no idea why.
1915 \begin_layout Itemize
1916 \begin_inset Flex Code
1919 \begin_layout Plain Layout
1928 \begin_inset Flex Code
1931 \begin_layout Plain Layout
1940 \begin_inset Newline newline
1943 Warnings about troubles breaking the page.
1944 Once again, just look at the output.
1945 Your eyes will tell you where something has gone wrong.
1948 \begin_layout Itemize
1949 \begin_inset Flex Code
1952 \begin_layout Plain Layout
1955 \begin_inset Quotes els
1959 \begin_inset Quotes ers
1968 \begin_inset Newline newline
1972 \begin_inset Quotes eld
1976 \begin_inset Quotes erd
1979 isn't installed on this system.
1980 This usually appears because some package your document needs isn't installed.
1981 If you didn't touch the preamble or didn't use the
1982 \begin_inset Flex Code
1985 \begin_layout Plain Layout
1993 command, then one of the packages \SpecialChar LyX
1994 tried to load is missing.
1996 \begin_inset Flex MenuItem
1999 \begin_layout Plain Layout
2000 Help\SpecialChar menuseparator
2007 to get a list of packages that \SpecialChar LyX
2009 This file is updated whenever you reconfigure \SpecialChar LyX
2011 \begin_inset Flex MenuItem
2014 \begin_layout Plain Layout
2015 Tools\SpecialChar menuseparator
2021 ) and tells you which packages have been detected and what they do.
2022 \begin_inset Newline newline
2026 \begin_inset Flex Code
2029 \begin_layout Plain Layout
2037 command and the package in question isn't installed, then you'll need to
2038 install it yourself.
2041 \begin_layout Itemize
2042 \begin_inset Flex Code
2045 \begin_layout Plain Layout
2047 Error: Unknown option
2053 \begin_inset Newline newline
2056 Error messages beginning with this are trying to tell you that you specified
2057 a bad or undefined option to a package.
2058 Check the package's documentation.
2061 \begin_layout Itemize
2062 \begin_inset Flex Code
2065 \begin_layout Plain Layout
2066 Undefined control sequence
2072 \begin_inset Newline newline
2075 If you've inserted \SpecialChar LaTeX
2076 code into your document, but made a typo, you'll get
2078 You may have forgotten to load a package.
2079 In any case, this error message usually means that you used an undefined
2084 \begin_layout Standard
2085 There are other error and warning messages.
2086 Some are self-explanatory.
2087 These are usually \SpecialChar LaTeX
2089 Others are downright cryptic.
2090 These are usually \SpecialChar TeX
2091 error messages, and we really have
2095 what they mean or how to decipher them.
2099 \begin_layout Standard
2100 There's a general sequence you should follow if you get error messages:
2103 \begin_layout Enumerate
2104 Look at the \SpecialChar LaTeX
2105 code you inserted for typos.
2108 \begin_layout Enumerate
2109 If there are no typos, check that you used the command(s) correctly.
2112 \begin_layout Enumerate
2113 If you get a bunch of error boxes piled up at the very top of the document—and
2114 especially if you see a
2115 \begin_inset Quotes eld
2119 \begin_inset Flex Code
2122 \begin_layout Plain Layout
2131 \begin_inset Quotes erd
2134 error—it means that there are errors in the preamble.
2135 Start debugging your preamble.
2138 \begin_layout Enumerate
2139 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2141 document, the first suspect is your \SpecialChar LaTeX
2142 distribution itself.
2143 Check for missing packages and install them.
2146 \begin_layout Enumerate
2147 Okay, so there are no missing packages.
2148 Did you use any of the fine-tuning options in \SpecialChar LyX
2149 ? Specifically, did you
2153 any of them, like trying to manually insert lots of
2154 \begin_inset Flex Code
2157 \begin_layout Plain Layout
2159 \begin_inset space ~
2168 \begin_inset Flex Code
2171 \begin_layout Plain Layout
2178 \begin_inset Flex Code
2181 \begin_layout Plain Layout
2187 ? Did you try to kludge something together with these instead of using the
2188 appropriate paragraph environment?
2191 \begin_layout Enumerate
2192 All right, you didn't use any of the fine-tuning options, you played by
2194 Did you try to pull a fancy maneuver? Did you do something funky inside
2195 a table or an equation, like inserting a graphic into a table cell?
2198 \begin_layout Enumerate
2199 Do you have long sections of text where \SpecialChar LaTeX
2200 cannot find a place to break a
2201 line? By default, \SpecialChar LaTeX
2202 is rather strict about how much extra inter-word spacing
2203 it will add in order to break a line.
2204 Preferably, you should rework the paragraph to avoid the problem.
2205 If this isn't an option, you can wrap your text in
2206 \begin_inset Flex Code
2209 \begin_layout Plain Layout
2217 to make \SpecialChar LaTeX
2218 's line breaking more, well, sloppy.
2221 \begin_layout Enumerate
2222 Did you go overboard with the nesting? \SpecialChar LyX
2223 (currently) doesn't check to make
2224 sure you're in the limits for nesting environments.
2225 If you nested a bunch of environments to the
2226 \begin_inset Formula $17^{\mathrm{th}}$
2229 level, that's the problem.
2230 (The limit in \SpecialChar LaTeX
2234 \begin_layout Enumerate
2235 Okay, you didn't get any error messages, but your output looks awful.
2236 If you have a table or figure that's too wide or long for the page, you
2238 \begin_inset Separator parbreak
2245 \begin_layout Enumerate
2246 rescale the figure so it fits.
2249 \begin_layout Enumerate
2250 trim down the table so it fits.
2254 \begin_layout Enumerate
2255 If something else is wrong with the output, and you didn't try to pull anything
2256 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2259 \begin_layout Standard
2260 If all this doesn't help—well, then
2264 you might have found a bug in \SpecialChar LyX
2269 \begin_layout Chapter
2273 \begin_layout Section
2274 Customizing Bibliographies with Bib\SpecialChar TeX
2278 \begin_layout Standard
2279 The most basic information about how to use Bib\SpecialChar TeX
2280 with \SpecialChar LyX
2284 Bibliography databases (Bib\SpecialChar TeX
2292 The following subsections explain special bibliography features supported
2297 \begin_layout Subsection
2298 Alternative Citation Styles
2301 \begin_layout Standard
2302 Standard Bib\SpecialChar TeX
2304 \begin_inset space \thinspace{}
2308 \begin_inset space \space{}
2312 \begin_inset Quotes eld
2316 \begin_inset Quotes erd
2319 ) to refer to a cited work.
2320 However, in many scientific disciplines, other citation styles are in use.
2321 The most common one is the author-year style (e.
2322 \begin_inset space \thinspace{}
2326 \begin_inset space \space{}
2330 \begin_inset Quotes eld
2334 \begin_inset Quotes erd
2339 supports two packages that provide this style,
2340 \begin_inset Flex Code
2343 \begin_layout Plain Layout
2350 \begin_inset Flex Code
2353 \begin_layout Plain Layout
2360 Both packages have their pros and cons, which cannot be listed in detail.
2361 If you only want to have simple author-year (or author-numerical) style,
2362 or if you want to use one of the countless style files for
2363 \begin_inset Flex Code
2366 \begin_layout Plain Layout
2372 , then the established
2373 \begin_inset Flex Code
2376 \begin_layout Plain Layout
2382 package is probably your choice.
2383 If you need special features like short title references, ibidem etc., you
2385 \begin_inset Flex Code
2388 \begin_layout Plain Layout
2397 \begin_layout Standard
2398 The handling of both packages in \SpecialChar LyX
2399 is basically the same.
2401 \begin_inset Flex MenuItem
2404 \begin_layout Plain Layout
2405 Document\SpecialChar menuseparator
2412 \begin_inset Flex MenuItem
2415 \begin_layout Plain Layout
2422 \begin_inset Flex MenuItem
2425 \begin_layout Plain Layout
2432 \begin_inset Flex MenuItem
2435 \begin_layout Plain Layout
2442 With both packages, you will get some extra features in the citation dialog
2443 and you can select the style of the reference (
2444 \begin_inset Quotes eld
2448 \begin_inset Quotes erd
2452 \begin_inset Quotes eld
2456 \begin_inset Quotes erd
2460 \begin_inset Quotes eld
2464 \begin_inset Quotes erd
2468 \begin_inset Quotes eld
2472 \begin_inset Quotes erd
2476 Note that both packages need specifically designed style files.
2477 They both ship their own, but there are lots of additional style files,
2478 and there is even an interactive style file builder
2482 \begin_layout Plain Layout
2484 \begin_inset Flex URL
2487 \begin_layout Plain Layout
2489 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2500 \begin_inset Flex Code
2503 \begin_layout Plain Layout
2512 \begin_layout Subsection
2513 Sectioned Bibliographies
2516 \begin_layout Standard
2517 Sometimes you might need to divide your bibliography into several sections.
2518 If you are for instance a historian, the possibility to separate sources
2519 and scientific works is most likely a
2520 \begin_inset Quotes eld
2524 \begin_inset Quotes erd
2528 Unfortunately, Bib\SpecialChar TeX
2529 itself does not allow you to do this.
2530 But with the help of some \SpecialChar LaTeX
2531 packages, Bib\SpecialChar TeX
2532 can be extended to fit your needs.
2535 \begin_layout Standard
2537 provides native support for one of these packages,
2545 \begin_layout Plain Layout
2547 \begin_inset Flex URL
2550 \begin_layout Plain Layout
2552 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2562 The advantage of this package (compared to other packages like
2566 ) is that you don't need to define new citation commands.
2567 Instead, you need to prepare different bibliographic databases which include
2568 the entries for the different sections of the bibliography.
2569 For example: If you want to divide your bibliography into the sections
2571 \begin_inset Quotes eld
2575 \begin_inset Quotes erd
2579 \begin_inset Quotes eld
2583 \begin_inset Quotes erd
2586 , you first need to create two bibliographic databases, e.
2587 \begin_inset space \thinspace{}
2591 \begin_inset space \space{}
2595 \begin_inset Flex Code
2598 \begin_layout Plain Layout
2605 \begin_inset Flex Code
2608 \begin_layout Plain Layout
2618 \begin_layout Standard
2620 \begin_inset Flex MenuItem
2623 \begin_layout Plain Layout
2624 Document\SpecialChar menuseparator
2631 \begin_inset Flex MenuItem
2634 \begin_layout Plain Layout
2641 \begin_inset Flex MenuItem
2644 \begin_layout Plain Layout
2645 Sectioned bibliography
2651 Now you can insert multiple Bib\SpecialChar TeX
2652 bibliographies, one for each section of
2654 Returning to our example: Insert the Bib\SpecialChar TeX
2656 \begin_inset Flex Code
2659 \begin_layout Plain Layout
2665 and a second one for the database
2666 \begin_inset Flex Code
2669 \begin_layout Plain Layout
2676 You are free to use the same or different styles for each section.
2677 Additionally, you can choose if the bibliography section should contain
2679 \begin_inset Quotes eld
2682 all cited references
2683 \begin_inset Quotes erd
2686 of the specified database(s) (which is the default),
2687 \begin_inset Quotes eld
2690 all uncited references
2691 \begin_inset Quotes erd
2695 \begin_inset Quotes eld
2699 \begin_inset Quotes erd
2703 This might be useful if you would like to separate your bibliography into
2705 \begin_inset Quotes eld
2709 \begin_inset Quotes erd
2713 \begin_inset Quotes eld
2717 \begin_inset Quotes erd
2721 \begin_inset Quotes eld
2725 \begin_inset Quotes erd
2729 The titles for the sections can be added as ordinary sections or subsections.
2731 \begin_inset Flex Code
2734 \begin_layout Plain Layout
2740 removes the bibliography title, you have to manually re-add that, too (as
2741 a chapter* or section*, for instance).
2744 \begin_layout Subsection
2745 Multiple Bibliographies
2748 \begin_layout Standard
2749 Multiple bibliographies, e.
2750 \begin_inset space \thinspace{}
2754 \begin_inset space \space{}
2757 a bibliography for each section or chapter of the document, are not supported
2758 by Bib\SpecialChar TeX
2761 \begin_inset Flex Code
2764 \begin_layout Plain Layout
2770 package, which is used for the creation of sectioned bibliographies in
2772 (see the previous section), provides an easy way to solve this task, if
2773 you are willing to use some
2774 \begin_inset Flex MenuItem
2777 \begin_layout Plain Layout
2785 \begin_inset space ~
2789 \begin_inset CommandInset ref
2791 reference "sec:Inserting-TeX-Code"
2799 \begin_layout Plain Layout
2800 An alternative approach is to use the
2801 \begin_inset Flex Code
2804 \begin_layout Plain Layout
2811 \begin_inset Flex Code
2814 \begin_layout Plain Layout
2820 package, respectively.
2828 \begin_layout Standard
2830 \begin_inset Flex MenuItem
2833 \begin_layout Plain Layout
2834 Document\SpecialChar menuseparator
2841 \begin_inset Flex MenuItem
2844 \begin_layout Plain Layout
2851 \begin_inset Flex MenuItem
2854 \begin_layout Plain Layout
2855 Sectioned bibliography
2861 In the document, you have to enclose the sections, which shall contain
2862 their own bibliography (including the Bib\SpecialChar TeX
2863 bibliography itself), between
2865 \begin_inset Flex Code
2868 \begin_layout Plain Layout
2877 \begin_inset Flex Code
2880 \begin_layout Plain Layout
2888 (those commands have to be inserted as \SpecialChar TeX
2890 The bibliography will contain all references that have been cited in the
2892 \begin_inset Flex Code
2895 \begin_layout Plain Layout
2906 If you are using this approach, then every citation reference has to be
2908 \begin_inset Flex Code
2911 \begin_layout Plain Layout
2919 \begin_inset Flex Code
2922 \begin_layout Plain Layout
2931 \begin_layout Section
2935 \begin_layout Subsection
2939 \begin_layout Standard
2940 When you are working on a large file with many sections, it is often convenient
2941 to break up the document into several files, or perhaps you have something
2942 where a table may change from time to time, but the preceding text does
2944 In these cases, you should seriously consider using multipart documents.
2945 For example, scientific papers often have five major sections: the introduction
2946 , observations, results, discussion, and conclusion.
2947 Each of these could be its own separate \SpecialChar LyX
2949 \begin_inset Quotes eld
2953 \begin_inset Quotes erd
2956 file which contains the title, authors, abstract, references, etc., plus
2957 the five included files.
2958 It is important to note that each of these files is a full \SpecialChar LyX
2960 can be formatted and printed on its own, as well as included in a master
2962 Each of these files must have the same document class, however—don't attempt
2963 to mix book classes with article classes.
2964 You may also include \SpecialChar LaTeX
2965 files; however, these files must not have their own
2967 \begin_inset space \thinspace{}
2971 \begin_inset space \space{}
2974 everything up to and including the
2975 \begin_inset Flex Code
2978 \begin_layout Plain Layout
2987 \begin_inset Flex Code
2990 \begin_layout Plain Layout
2998 line must be deleted) or else errors will be generated when you try to
3002 \begin_layout Standard
3004 allows you to include files quite easily with
3005 \begin_inset Flex MenuItem
3008 \begin_layout Plain Layout
3009 Insert\SpecialChar menuseparator
3011 \begin_inset space ~
3020 When you click on this selection a small box is inserted into the file
3021 at the current cursor location.
3022 Clicking on the box raises a dialog which allows you to select the file
3023 to be included, and the method of its inclusion.
3027 \begin_layout Standard
3028 The file selection box should by now be obvious.
3029 The three inclusion methods are
3030 \begin_inset Quotes eld
3034 \begin_inset Quotes erd
3038 \begin_inset Quotes eld
3042 \begin_inset Quotes erd
3046 \begin_inset Quotes eld
3050 \begin_inset Quotes erd
3054 The difference between
3055 \begin_inset Quotes eld
3059 \begin_inset Quotes erd
3063 \begin_inset Quotes eld
3067 \begin_inset Quotes erd
3070 is really only meaningful to \SpecialChar LaTeX
3071 perts, but the practical difference is that
3073 \begin_inset Quotes eld
3077 \begin_inset Quotes erd
3080 are typeset beginning on a new page, while files that are
3081 \begin_inset Quotes eld
3085 \begin_inset Quotes erd
3088 are typeset starting on the current page.
3091 \begin_layout Standard
3092 Generally, the master file is converted into a full \SpecialChar LaTeX
3093 file before typesetting,
3094 while the included files are converted to \SpecialChar LaTeX
3095 files that do not have all the
3096 preamble information.
3099 \begin_layout Standard
3101 \begin_inset Quotes eld
3105 \begin_inset Quotes erd
3108 included file allows you to include a file typeset exactly as it appears
3110 \begin_inset space \thinspace{}
3114 \begin_inset space \space{}
3118 \begin_inset Flex Code
3121 \begin_layout Plain Layout
3127 mode, with the characters set in a fixed-width typewriter font.
3128 Normally, spaces in this file are invisible, though two consecutive spaces
3129 are conserved, unlike \SpecialChar LyX
3130 's normal treatment of spaces.
3131 However, setting the
3132 \begin_inset Flex MenuItem
3135 \begin_layout Plain Layout
3137 \begin_inset space ~
3141 \begin_inset space ~
3145 \begin_inset space ~
3153 checkbox typesets a mark to unambiguously define the presence of a space.
3157 \begin_layout Subsection
3158 Cross-References Between Files
3161 \begin_layout Standard
3162 \begin_inset Box Shadowbox
3172 height_special "totalheight"
3177 backgroundcolor "none"
3180 \begin_layout Plain Layout
3181 This section is somewhat out of date.
3182 Need to describe default master documents and how children are opened when
3192 \begin_layout Standard
3193 It is possible to set up cross-references between the different files.
3194 First, open all the files in question: let's call them A and B in a two
3195 file example, where B is included in A.
3196 Let's say you insert a label in A, then want to reference it in B.
3197 Open the cross-reference dialog whilst in document B, and you can select
3199 \begin_inset Quotes eld
3203 \begin_inset Quotes erd
3209 \begin_layout Subsection
3210 Bibliography Lists in all Subdocuments
3213 \begin_layout Standard
3214 \begin_inset Box Frameless
3224 height_special "totalheight"
3229 backgroundcolor "none"
3232 \begin_layout Plain Layout
3233 This section also needs updating.
3234 There is now material about this on the wiki, and it could be copied here.
3242 \begin_layout Standard
3243 Copy the bibliography list with all entries to all subdocuments and transform
3245 This way \SpecialChar LyX
3247 \begin_inset Flex Code
3250 \begin_layout Plain Layout
3256 -files and you can easily insert references without making the bibliography
3260 \begin_layout Standard
3261 As the bibliography list is in a comment, \SpecialChar LaTeX
3262 won't use it and the references
3263 will look like this: [?], instead of like this: [1].
3264 One solution is to use the \SpecialChar LaTeX
3266 \begin_inset Flex Code
3269 \begin_layout Plain Layout
3275 that will only include comments by processing the files separately.
3276 To do this, add in the \SpecialChar LaTeX
3277 preamble of every subdocument the following:
3280 \begin_layout LyX-Code
3286 \begin_layout LyX-Code
3289 includecomment{comment}
3292 \begin_layout Standard
3294 \begin_inset Flex URL
3297 \begin_layout Plain Layout
3299 http://wiki.lyx.org/FAQ/Unsorted#toc31
3307 \begin_layout Section
3312 \begin_layout Standard
3313 Users sometimes need to be able to
3314 \begin_inset Quotes eld
3318 \begin_inset Quotes erd
3322 file together with all the images (and other files) on which it depends,
3323 either for sending to a publisher or for sharing with a co-author.
3325 2.0 includes a Python script (
3326 \begin_inset Flex Code
3329 \begin_layout Plain Layout
3335 ) that automates this process.
3336 To use it, you must have either the
3337 \begin_inset Flex Code
3340 \begin_layout Plain Layout
3347 \begin_inset Flex Code
3350 \begin_layout Plain Layout
3356 python modules installed on your system.
3357 By default, the script prefers the
3358 \begin_inset Flex Code
3361 \begin_layout Plain Layout
3368 \begin_inset Flex Code
3371 \begin_layout Plain Layout
3377 format on Unix-like systems and the
3378 \begin_inset Flex Code
3381 \begin_layout Plain Layout
3390 \begin_layout Standard
3392 's configuration process will set the script up to export a `\SpecialChar LyX
3394 and this format will then be available under
3395 \begin_inset Flex Code
3398 \begin_layout Plain Layout
3399 File\SpecialChar menuseparator
3408 \begin_layout Standard
3409 Independently of the platform, the generation of a particular archive format
3410 can be forced by adding either the
3411 \begin_inset Flex Code
3414 \begin_layout Plain Layout
3421 \begin_inset Flex Code
3424 \begin_layout Plain Layout
3431 \begin_inset Flex Code
3434 \begin_layout Plain Layout
3441 \begin_inset Flex Code
3444 \begin_layout Plain Layout
3450 format) switch to the
3451 \begin_inset Flex Code
3454 \begin_layout Plain Layout
3456 \SpecialChar menuseparator
3464 \begin_inset Flex Code
3467 \begin_layout Plain Layout
3468 Tools\SpecialChar menuseparator
3469 Preferences\SpecialChar menuseparator
3470 File Handling\SpecialChar menuseparator
3477 (Make sure you add the switch after the script name, not before it.)
3480 \begin_layout Section
3481 Fancy Headers and Footers
3484 \begin_layout Standard
3485 The default page layout is rather plain; for an
3486 \begin_inset Flex Code
3489 \begin_layout Plain Layout
3495 document class, all you get is a centered page number at the bottom of
3497 This document uses KOMA-script's book class, so it appears to be a bit
3499 But to really put on a show, you need to set the document page style to
3501 \begin_inset Quotes eld
3505 \begin_inset Quotes erd
3508 , as mentioned in the
3513 This section describes the \SpecialChar LaTeX
3514 code you need to insert in your \SpecialChar LaTeX
3516 order to get the desired effects.
3519 \begin_layout Standard
3520 For more information on fancy headers, see the
3521 \begin_inset Flex Code
3524 \begin_layout Plain Layout
3530 package documentation.
3532 \begin_inset Flex URL
3535 \begin_layout Plain Layout
3537 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3545 \begin_layout Standard
3546 The page header is divided into three fields, not surprisingly labeled
3547 \begin_inset Quotes eld
3551 \begin_inset Quotes erd
3555 \begin_inset Quotes eld
3559 \begin_inset Quotes erd
3563 \begin_inset Quotes eld
3567 \begin_inset Quotes erd
3571 The footer is also divided into these three fields.
3572 The \SpecialChar LaTeX
3573 commands to set these fields in the simplest manner are
3574 \begin_inset Flex Code
3577 \begin_layout Plain Layout
3586 \begin_inset Flex Code
3589 \begin_layout Plain Layout
3598 \begin_inset Flex Code
3601 \begin_layout Plain Layout
3610 \begin_inset Flex Code
3613 \begin_layout Plain Layout
3622 Suppose you wish to put your name in the upper left hand corner of each
3624 Simply insert the following command in the preamble:
3627 \begin_layout Standard
3636 \begin_layout Standard
3637 You will now see your name in the upper left.
3638 If a field has a default entry that you would like to get rid of (often
3639 the page number appears in the central footer) simply include a command
3640 with a blank argument, e.
3641 \begin_inset space \thinspace{}
3647 \begin_layout Standard
3655 \begin_layout Standard
3656 Let's get really fancy: lets put the section number with the word
3657 \begin_inset Quotes eld
3661 \begin_inset Quotes erd
3665 \begin_inset space \thinspace{}
3669 \begin_inset space \space{}
3672 Section 3) in the upper left, the page number (e.
3673 \begin_inset space \thinspace{}
3677 \begin_inset space \space{}
3680 Page 4) in the upper right, your name in the lower left, and the date in
3682 The following commands should now appear in the preamble:
3685 \begin_layout Standard
3695 \begin_layout Standard
3703 \begin_layout Standard
3713 \begin_layout Standard
3722 \begin_layout Standard
3730 \begin_layout Standard
3740 \begin_layout Standard
3742 \begin_inset Flex Code
3745 \begin_layout Plain Layout
3754 \begin_inset Flex Code
3757 \begin_layout Plain Layout
3765 access \SpecialChar LaTeX
3766 's section and page counters, and so print out the current section
3769 \begin_inset Flex Code
3772 \begin_layout Plain Layout
3780 simply prints out today's date.
3783 \begin_layout Standard
3784 The thicknesses of the horizontal rules drawn beneath the header and above
3785 the footer can also be modified.
3786 If you don't want one of the rules, set its thickness to 0.
3787 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3793 \begin_inset Flex Code
3796 \begin_layout Plain Layout
3801 headrulewidth}{0.4pt}
3807 \begin_inset Flex Code
3810 \begin_layout Plain Layout
3815 footrulewidth}{0.4pt}
3820 to set the thicknesses.
3823 \begin_layout Standard
3824 You can switch the header/footer settings on and off for individual pages
3826 \begin_inset Flex Code
3829 \begin_layout Plain Layout
3832 thispagestyle{empty}
3838 \begin_inset Flex Code
3841 \begin_layout Plain Layout
3844 thispagestyle{plain}
3850 \begin_inset Flex Code
3853 \begin_layout Plain Layout
3856 thispagestyle{fancy}
3862 Simply insert them in the text on the page you want changed and mark them
3865 In fact, title pages are marked as plain by default, while following pages
3866 are marked fancy when using the global fancy setting.
3869 \begin_layout Standard
3870 As a final example, it is possible to include an image in the header or
3872 Suppose you want to put a company logo in the upper lefthand corner.
3873 You might try something like
3876 \begin_layout Standard
3885 includegraphics{logo.eps}}}
3888 \begin_layout Standard
3890 (you may need to preface this with
3891 \begin_inset Flex Code
3894 \begin_layout Plain Layout
3898 usepackage{graphics}
3903 if you don't include graphics elsewhere in your document).
3906 \begin_layout Section
3907 Itemize Bullet Selection
3908 \begin_inset CommandInset label
3917 \begin_layout Standard
3923 \begin_layout Subsection
3927 \begin_layout Standard
3929 provides 216 bullet shapes that can be accessed from a simple dialog.
3930 Using this dialog you can easily specify what bullet shape to use at each
3931 level of an itemized list.
3932 These settings are document-wide so you won't be able to specify different
3933 sets of bullets for different paragraphs.
3937 \begin_layout Plain Layout
3938 Well, actually you can but you'll have to do it by hand.
3946 \begin_layout Subsection
3950 \begin_layout Standard
3951 Open the dialog by selecting the
3952 \begin_inset Flex MenuItem
3955 \begin_layout Plain Layout
3956 Document\SpecialChar menuseparator
3962 menu item and then select the
3963 \begin_inset Flex MenuItem
3966 \begin_layout Plain Layout
3975 \begin_layout Standard
3976 The dialog provides you with a table of bullet shapes.
3977 A column of buttons on the left of the table provides access to the six
3978 different panels of bullet shapes.
3979 The row of buttons across the top is used to select which bullet depth
3981 A text entry under the table shows the currently selected bullet shape's
3983 equivalent and this can be edited if desired.
3984 If you do modify the text you will also need to specify any needed packages
3985 in the \SpecialChar LaTeX
3989 \begin_layout Standard
3990 The six panels are divided up by the packages they require.
3991 The following table shows the mappings from button name to \SpecialChar LaTeX
3993 \begin_inset Separator parbreak
3999 \begin_layout Standard
4001 \begin_inset Tabular
4002 <lyxtabular version="3" rows="7" columns="2">
4003 <features tabularvalignment="middle">
4004 <column alignment="center" valignment="top" width="0pt">
4005 <column alignment="center" valignment="top" width="0pt">
4007 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4010 \begin_layout Plain Layout
4025 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4028 \begin_layout Plain Layout
4045 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4048 \begin_layout Plain Layout
4063 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4066 \begin_layout Plain Layout
4075 base \SpecialChar LaTeX
4083 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4086 \begin_layout Plain Layout
4101 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4104 \begin_layout Plain Layout
4121 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4124 \begin_layout Plain Layout
4139 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4142 \begin_layout Plain Layout
4159 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4162 \begin_layout Plain Layout
4177 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4180 \begin_layout Plain Layout
4197 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4200 \begin_layout Plain Layout
4215 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4218 \begin_layout Plain Layout
4235 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4238 \begin_layout Plain Layout
4253 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4256 \begin_layout Plain Layout
4279 \begin_layout Standard
4281 doesn't stop you using bullets from packages you don't have.
4282 If you get errors from \SpecialChar LaTeX
4283 when you try to view or print the file, then it
4284 is likely you are missing a package.
4288 \begin_layout Plain Layout
4290 doesn't restrict your use since you may be editing locally and exporting
4299 \begin_layout Subsection
4303 \begin_layout Standard
4304 Select which bullet depth you want to change then select the bullet shape
4306 Any changes will not be visible in \SpecialChar LyX
4307 , but are visible when viewing the document.
4310 \begin_layout Standard
4311 You can reset a bullet shape to the default simply by clicking your right
4312 mouse button on the appropriate bullet depth button.
4316 \begin_layout Plain Layout
4321 want to have multiple sets of paragraphs with different sets of bullets
4322 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4324 The bullet selection dialog can help though because it provides you with
4325 the \SpecialChar LaTeX
4326 code for a wide range of bullet shapes.
4327 To make your own custom paragraphs you have the following options:
4330 \begin_layout Plain Layout
4334 \begin_layout Plain Layout
4350 \begin_layout Plain Layout
4354 \begin_layout Plain Layout
4376 \begin_layout Itemize
4377 Use the \SpecialChar LaTeX
4379 \begin_inset Flex Code
4382 \begin_layout Plain Layout
4390 to specify a new bullet shape for a given depth.
4391 You'll also need to save the current bullet shape so you can restore it
4393 In this itemized list the following \SpecialChar LaTeX
4394 code was used to change the bullet
4395 used for the first depth.
4396 \begin_inset Separator parbreak
4403 \begin_layout LyX-Code
4413 \begin_layout LyX-Code
4430 \begin_layout Itemize
4431 Note that the itemize depth is specified in Roman numerals as part of the
4441 \begin_layout Itemize
4445 \begin_layout Plain Layout
4458 Specify each individual entry by starting each item with the bullet shape
4459 enclosed in square brackets and set as
4460 \begin_inset Flex MenuItem
4463 \begin_layout Plain Layout
4471 For example, this item was started with
4472 \begin_inset Flex Code
4475 \begin_layout Plain Layout
4490 \begin_layout Plain Layout
4494 \begin_layout Plain Layout
4510 \begin_layout Plain Layout
4511 You'll also need to revert the labelitem back to its previous setting for
4512 the global bullet shape settings to remain in effect.
4513 The way used here was:
4516 \begin_layout LyX-Code
4531 \begin_layout Chapter
4533 and the World Wide Web
4536 \begin_layout Standard
4538 has long supported the export of documents to various web-friendly formats,
4540 Before verson 2.0, however, HTML export was always accomplished by the use
4541 of external converters.
4545 \begin_layout Plain Layout
4546 For details on the use of external converters with \SpecialChar LyX
4551 section of the Customization manual.
4556 These fall into two large groups: there are converters that use \SpecialChar LaTeX
4558 intermediate format, such as
4559 \begin_inset Flex Code
4562 \begin_layout Plain Layout
4569 \begin_inset Flex Code
4572 \begin_layout Plain Layout
4579 \begin_inset Flex Code
4582 \begin_layout Plain Layout
4588 , relying upon \SpecialChar LyX
4589 to produce the \SpecialChar LaTeX
4590 ; and there is a converter that works directly
4593 \begin_inset Flex Code
4596 \begin_layout Plain Layout
4604 All of these have different advantages and disadvantages.
4608 \begin_layout Standard
4609 The \SpecialChar LaTeX
4610 -based converters have the advantage that, in principle, they know everythin
4611 g about the exported document that \SpecialChar LaTeX
4613 Such converters do not care, for example, if a certain block of code was
4614 produced by \SpecialChar LyX
4615 or was Evil Red Text.
4616 These converters know about
4617 \begin_inset Flex Code
4620 \begin_layout Plain Layout
4626 files, counters, and references, and can often make use of the
4627 \begin_inset Flex Code
4630 \begin_layout Plain Layout
4636 files generated by Bib\SpecialChar TeX
4638 On the other hand, \SpecialChar LaTeX
4639 is a very hard language to parse—it is sometimes said
4640 that only \SpecialChar TeX
4641 itself understands \SpecialChar TeX
4642 —and \SpecialChar LaTeX
4643 -based converters will often choke on
4644 what seem to be quite simple constructs; complex ones can throw them completely
4645 , and as of this writing, for example, the
4649 manual will not export with
4650 \begin_inset Flex Code
4653 \begin_layout Plain Layout
4659 , though the others will.
4660 The other issue concerns how math is handled.
4661 These converters typically convert the formulae into little pictures that
4662 are then linked from the HTML document.
4663 Since these are actually generated by \SpecialChar LaTeX
4664 , they are accurate.
4665 But they do not scale well, and just getting them to look as if they are
4666 actually meant to be in your document—so that the font sizes seem to be
4667 roughly the same—can be a challenge.
4670 \begin_layout Standard
4672 \begin_inset Flex Code
4675 \begin_layout Plain Layout
4683 \begin_inset CommandInset href
4685 name "http://elyxer.nongnu.org/"
4686 target "http://elyxer.nongnu.org/"
4690 ) solves some of these problems.
4691 In particular, the formulae it produces scale perfectly, since it renders
4692 math using a combination of HTML and CSS rather than converting the formulae
4694 But even moderately complex formula are rendered less well than with
4695 \begin_inset Flex Code
4698 \begin_layout Plain Layout
4704 ; this reflects the limitations of HTML.
4708 \begin_layout Plain Layout
4710 \begin_inset Flex Code
4713 \begin_layout Plain Layout
4720 can also use jsMath and MathJax for equations, but this setting is only
4721 available globally and requires one to have access to a server that runs
4727 More importantly (as of version 1.1.1, at least),
4728 \begin_inset Flex Code
4731 \begin_layout Plain Layout
4738 has limited support for math macros and no support for user-defined paragraph
4739 or character styles.
4740 These limitations make
4741 \begin_inset Flex Code
4744 \begin_layout Plain Layout
4751 unsuitable for many of the documents \SpecialChar LyX
4753 In principle, of course, these problems could be solved, but the \SpecialChar LyX
4755 have decided to follow a different path and have made \SpecialChar LyX
4757 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
4758 , DocBook, and plaintext.
4761 \begin_layout Standard
4762 As of this writing, XHTML output remains under development and should probably
4764 \begin_inset Quotes eld
4768 \begin_inset Quotes erd
4775 \begin_layout Plain Layout
4777 \begin_inset Flex Code
4780 \begin_layout Plain Layout
4781 development/HTML.notes
4786 , which can be found in the \SpecialChar LyX
4788 \begin_inset CommandInset href
4790 name "accessed online"
4791 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
4795 , usually contains up-to-date information about the state of XHTML output.
4796 See also the list of XHTML bugs on
4797 \begin_inset CommandInset href
4799 name "the bug tracker"
4800 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"
4809 Still, the developers have chosen this approach because it has several
4810 potential advantages over the other two.
4813 \begin_layout Standard
4814 These advantages are primarily due to the fact that the XHTML output routines,
4815 since they are part of \SpecialChar LyX
4816 , know everything \SpecialChar LyX
4817 knows about the document being
4822 \begin_layout Plain Layout
4823 Another advantage is that, since these routines are internal to \SpecialChar LyX
4825 immune to changes in \SpecialChar LyX
4826 's file format, or to changes in the semantics of
4832 So they know about the table of contents (as displayed in the outline),
4833 about the counters associated with different paragraph styles, and about
4834 user-defined styles.
4835 The XHTML output routines know what \SpecialChar LyX
4836 knows about internationalization,
4837 too, so they will output
4838 \begin_inset Quotes eld
4842 \begin_inset Quotes erd
4846 \begin_inset Quotes eld
4854 \begin_inset Quotes erd
4857 , depending upon the language in effect at the time.
4861 \begin_layout Standard
4862 Quite generally, the output routines know what \SpecialChar LyX
4863 knows about document layout,
4864 that is, about how the document is to be rendered on screen.
4865 We use this information when we output the document as XHTML.
4866 In particular, \SpecialChar LyX
4871 generates CSS style information corresponding to the layout information
4872 it uses to render the document on screen: if section headings are supposed
4873 to be sans-serif and bold as seen in \SpecialChar LyX
4874 , then (by default) they will be sans-seri
4875 f and bold when viewed in a web browser, too.
4876 And this is true not just for pre-defined styles, like Section, but for
4877 any style, including user-defined styles.
4878 Indeed, the XHTML output routines make no distinction between user-defined
4879 paragraph and character styles and \SpecialChar LyX
4880 's own pre-defined styles: in each case,
4881 everything \SpecialChar LyX
4882 knows about the styles is contained in the layout files.
4883 And much the same is true as regards pre-defined textual insets, such as
4884 footnotes, and various custom insets.
4888 \begin_layout Standard
4889 The result is that XHTML output can be customized and extended in exactly
4890 the same way \SpecialChar LaTeX
4891 output can be customized and extended: through layout files
4893 See chapter five of the
4897 manual for the details.
4900 \begin_layout Standard
4901 The remainder of this chapter contains more detailed information on XHTML
4902 output, its limitations, and ways to work around those limitations.
4905 \begin_layout Section
4906 Math Output in XHTML
4909 \begin_layout Standard
4911 offers four choices for how math is rendered.
4912 These have various advantages and disadvantages:
4915 \begin_layout Itemize
4917 \begin_inset Newline newline
4920 MathML is a dialect of XML designed specifically for mathematics on the
4921 web, and it typically renders very well in browsers that support it.
4922 The disadvantage is that not all browsers support MathML, and support is
4923 not complete even in the Gecko-based browsers, such as Firefox.
4924 \begin_inset Newline newline
4928 is unable to render a formula as MathML—for example, if the formula
4930 \begin_inset Flex Code
4933 \begin_layout Plain Layout
4939 package or ERT—then it will instead output the formula as an image.
4943 \begin_layout Itemize
4945 \begin_inset Newline newline
4949 \begin_inset Flex Code
4952 \begin_layout Plain Layout
4958 outputs math as HTML, styled by CSS.
4962 \begin_layout Plain Layout
4964 has borrowed some of the CSS for its HTML output from
4965 \begin_inset Flex Code
4968 \begin_layout Plain Layout
4979 For simple formulae, this can work quite well, though with more complicated
4980 formulae it tends to break down.
4981 Still, this method has the advantage that it is very widely supported and
4982 so it may be appropriate for documents that contain only a little, fairly
4984 \begin_inset Newline newline
4987 If Lyx is unable to render a formula as HTML—for example, if the formula
4989 \begin_inset Flex Code
4992 \begin_layout Plain Layout
4998 package or ERT—then it will instead output the formula as an image.
5002 \begin_layout Itemize
5004 \begin_inset Newline newline
5008 \begin_inset Flex Code
5011 \begin_layout Plain Layout
5018 will output formulae as images, the very same images, in fact, that are
5019 used for instant preview.
5023 \begin_layout Plain Layout
5024 Instant preview does
5028 have to be on for images to be output, however.
5033 The advantage to this method is that the images are simply generated by
5035 , so they are very accurate.
5036 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5037 so they do not scale terribly well, and one cannot copy them, etc.
5038 (As of this writing, there are also problems about equation numbering.
5040 \begin_inset CommandInset href
5043 target "http://www.lyx.org/trac/ticket/6894"
5048 \begin_inset Newline newline
5051 The size of the images can be controlled by setting the
5052 \begin_inset Quotes eld
5056 \begin_inset Quotes erd
5060 \begin_inset Flex MenuItem
5063 \begin_layout Plain Layout
5064 Document\SpecialChar menuseparator
5065 Settings\SpecialChar menuseparator
5075 \begin_layout Plain Layout
5076 For those who want to know, this controls the resolution of the image in
5077 dots per inch and is based upon a default of 75 dpi.
5083 \begin_inset Newline newline
5087 for some reason fails to create an image for a formula (e.g., if a required
5089 package is not installed), then it will fall back to outputing the raw
5094 \begin_layout Itemize
5097 \begin_inset Newline newline
5100 Finally, \SpecialChar LyX
5101 will happily output math as \SpecialChar LaTeX
5103 As well as being the output of last resort, this method can be used with
5105 \begin_inset CommandInset href
5108 target "http://www.math.union.edu/~dpvc/jsMath/"
5112 , which uses JavaScript to render \SpecialChar LaTeX
5113 embedded in HTML documents.
5115 wraps the \SpecialChar LaTeX
5117 \begin_inset Flex Code
5120 \begin_layout Plain Layout
5126 (for inline formulas) or
5127 \begin_inset Flex Code
5130 \begin_layout Plain Layout
5136 (for displayed formulas) with
5137 \begin_inset Flex Code
5140 \begin_layout Plain Layout
5146 , as is required for jsMath.
5149 \begin_layout Standard
5150 One of these output methods must be selected under
5151 \begin_inset Flex MenuItem
5154 \begin_layout Plain Layout
5155 Document\SpecialChar menuseparator
5156 Settings\SpecialChar menuseparator
5163 By default, \SpecialChar LyX
5165 This is a document-wide setting, therefore.
5168 \begin_layout Standard
5169 Eventually, \SpecialChar LyX
5170 will offer the user the option to select an alternate output
5171 method for a particular inset, say, one that isn't being rendered very
5176 \begin_layout Plain Layout
5177 That said, since \SpecialChar LyX
5178 falls back to images if the inset contains ERT, then one
5179 can force output as an image by putting some harmless ERT into the math,
5181 \begin_inset Formula $a=b\relax$
5192 \begin_layout Section
5193 Bibliography and Citations
5196 \begin_layout Standard
5197 XHTML output fully supports bibliographies and citations.
5201 \begin_layout Standard
5202 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5204 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5207 If you are using numerical citations, then \SpecialChar LyX
5208 will output numerical labels,
5209 such as [1] or [17], rather than simply showing the citation key in square
5210 brackets, as it does on-screen.
5211 If you are using author-year citations, then \SpecialChar LyX
5212 will add lowercase letters
5213 to the years, just as Bib\SpecialChar TeX
5214 does, if it finds more than one citation for
5215 a given author-year combination.
5216 The labels will be printed with the bibliography entries.
5217 Note that there is, at present, no way to customize the appearance of the
5218 labels, for example, to choose between square brackets and parentheses.
5221 \begin_layout Standard
5222 Bibliography output is handled by the same machinery that handles the presentati
5223 on of reference information in the citation dialog, so you will see in the
5224 XHTML output pretty much what you would see if you were to look at a given
5225 entry in the citation dialog.
5226 The formatting can be customized in your layout file or, preferably, in
5232 manual for the details.
5235 \begin_layout Standard
5236 The main defect at present is that cross-referenced information is printed
5237 with every entry with which it is associated.
5238 So you can see things like this:
5243 \begin_inset Quotes eld
5246 Context and Logical Form
5247 \begin_inset Quotes erd
5252 Language in Context: Selected Essays
5254 (Oxford: Oxford University Press, 2007), pp.
5260 \begin_inset Quotes eld
5263 Semantics in Context
5264 \begin_inset Quotes erd
5269 Language in Context: Selected Essays
5271 (Oxford: Oxford University Press, 2007), pp.
5275 \begin_layout Standard
5276 This should be fixed before long.
5279 \begin_layout Standard
5280 There is no support at present for sectioned bibliographies.
5281 If you have multiple bibliographies, then \SpecialChar LyX
5282 will print the same bibliography
5286 \begin_layout Section
5290 \begin_layout Standard
5292 will happily export indexes as XHTML, but with certain limitations at the
5296 \begin_layout Standard
5297 Index export will be most reliable when you do not attempt to use the fancy
5298 constructs that are described in the section on indexes in the
5306 \begin_layout Plain Layout
5307 The main issue here is that \SpecialChar LyX
5308 itself does not really handle these.
5309 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5315 We'll describe how they are handled using the subsection headings from
5319 \begin_layout Itemize
5320 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5321 makes an effort to support these,
5322 but the entries must be separated by
5323 \begin_inset Quotes eld
5327 \begin_inset Quotes erd
5330 , that is, there must be spaces around the exclamation point.
5331 This is because it is otherwise too difficult to check for escaped exclamation
5332 points, ones in math, and so forth.
5335 \begin_layout Itemize
5336 Page Ranges: There is no support at all for page ranges, since these make
5337 no sense with XHMTL.
5338 Instead, you will just get two index entries, one at either end.
5341 \begin_layout Itemize
5342 Cross-referencing: There is no support for cross-referencing.
5344 finds an entry containing the
5345 \begin_inset Quotes eld
5348 |see\SpecialChar ldots
5350 \begin_inset Quotes erd
5353 construct, it is just dropped, and the rest is treated as an ordinary index
5357 \begin_layout Itemize
5358 Index Entry Order: \SpecialChar LyX
5359 does support attempts to fix the sorting order.
5360 It will take what is before the first `@' it finds and use that for sorting,
5361 taking what follows the first `@' to be the actual entry.
5362 At present, \SpecialChar LyX
5363 does not check for escaped `@', so do not try to index email
5367 \begin_layout Itemize
5368 Index Entry Layout: You can format entries by using the text style dialog,
5369 or by using any other method available within \SpecialChar LyX
5371 There is no support for constructs like:
5372 \begin_inset Quotes eld
5376 \begin_inset Quotes erd
5380 Indeed, if \SpecialChar LyX
5381 finds a pipe symbol, `|', in an entry, it will delete it and
5382 everything that follows it.
5385 \begin_layout Itemize
5386 Multiple Indexes: There is no support for multiple indexes.
5387 Rather, all index entries will be printed as one large index.
5388 To avoid our printing several versions of the index, we print only the
5389 main index, so make sure you have one.
5392 \begin_layout Section
5393 Nomenclature and Glossary
5396 \begin_layout Standard
5397 There is at present no support for glossaries.
5398 Adding it would be fairly trivial, and welcome.
5401 \begin_layout Chapter
5402 The \SpecialChar LyX
5406 \begin_layout Section
5410 \begin_layout Standard
5411 The `\SpecialChar LyX
5412 server' allows other programs to talk to \SpecialChar LyX
5413 , invoke \SpecialChar LyX
5414 commands, and retrieve
5415 information about the \SpecialChar LyX
5417 This is only intended for advanced users, but they should find it useful.
5418 It is by writing to the \SpecialChar LyX
5419 server, for example, that bibliography managers,
5420 such as JabRef, are able to
5421 \begin_inset Quotes eld
5425 \begin_inset Quotes erd
5428 citations to \SpecialChar LyX
5432 \begin_layout Section
5433 Starting the \SpecialChar LyX
5437 \begin_layout Standard
5438 The \SpecialChar LyX
5439 server works through the use of a pair of named pipes.
5440 These are usually located in
5441 \begin_inset Flex Code
5444 \begin_layout Plain Layout
5450 , (except on Windows, where
5454 named pipes are special objects located in
5455 \begin_inset Flex Code
5458 \begin_layout Plain Layout
5470 ) and have the names
5471 \begin_inset Quotes eld
5475 \begin_inset Flex Code
5478 \begin_layout Plain Layout
5485 \begin_inset Quotes erd
5489 \begin_inset Quotes eld
5493 \begin_inset Flex Code
5496 \begin_layout Plain Layout
5503 \begin_inset Quotes erd
5507 External programs write into
5508 \begin_inset Flex Code
5511 \begin_layout Plain Layout
5517 and read back data from
5518 \begin_inset Flex Code
5521 \begin_layout Plain Layout
5528 The stem of the pipe names can be defined in the
5529 \begin_inset Flex MenuItem
5532 \begin_layout Plain Layout
5533 Tools\SpecialChar menuseparator
5540 \begin_inset Flex Code
5543 \begin_layout Plain Layout
5544 "/home/myhome/lyxpipe"
5550 \begin_inset Flex Code
5553 \begin_layout Plain Layout
5567 on Windows (where any working path instead of lyxpipe can be used, for
5569 \begin_inset Flex Code
5572 \begin_layout Plain Layout
5595 configure this manually in order for the server to start.
5598 \begin_layout Standard
5601 \begin_inset Flex Code
5604 \begin_layout Plain Layout
5611 \begin_inset Flex Code
5614 \begin_layout Plain Layout
5620 ' to create the pipes.
5621 If one of the pipes already exists, \SpecialChar LyX
5622 will assume that another \SpecialChar LyX
5624 is already running and will not start the server.
5625 On POSIX (Unix like) systems, if for some other reason, an unused
5626 \begin_inset Quotes eld
5630 \begin_inset Quotes erd
5633 pipe is left in existence when \SpecialChar LyX
5634 closes, then \SpecialChar LyX
5635 will try to delete it.
5636 If this fails for some reason, you will need to delete the pipes manually
5637 and then restart \SpecialChar LyX
5639 On Windows, pipes are deleted by the OS on program termination or crash,
5641 \begin_inset Quotes eld
5645 \begin_inset Quotes erd
5648 pipes should not be possible.
5651 \begin_layout Standard
5652 To have several \SpecialChar LyX
5653 processes with servers at the same time, you have to use
5654 different configurations, perhaps by using separate user directories, each
5656 \begin_inset Flex Code
5659 \begin_layout Plain Layout
5665 file, for each process.
5668 \begin_layout Standard
5669 If you are developing a client program, you might find it useful to enable
5670 debugging information from the \SpecialChar LyX
5672 Do this by starting \SpecialChar LyX
5674 \begin_inset Flex Code
5677 \begin_layout Plain Layout
5686 \begin_layout Standard
5687 You can find a complete example client written in C++ in the source distribution
5689 \begin_inset Flex Code
5692 \begin_layout Plain Layout
5693 development/lyxserver/server_monitor.cpp
5701 \begin_layout Standard
5702 Another useful tool is the command-line based client found in
5703 \begin_inset Flex Code
5706 \begin_layout Plain Layout
5707 src/client/lyxclient
5715 \begin_layout Section
5716 Normal communication
5719 \begin_layout Standard
5720 To issue a \SpecialChar LyX
5721 call, the client writes a line of ASCII text into the input
5723 This line has the following format:
5740 \begin_layout Description
5741 clientname is a name that the client can choose arbitrarily.
5742 Its only use is that \SpecialChar LyX
5743 will echo it if it sends an answer—so a client can
5744 dispatch results from different requesters.
5747 \begin_layout Description
5748 function is the function you want \SpecialChar LyX
5750 It is the same as the commands you'd use in the minibuffer.
5753 \begin_layout Description
5754 argument is an optional argument which is meaningful only to some functions
5756 \begin_inset Quotes eld
5760 \begin_inset Quotes erd
5763 LFUN will insert the argument as text at the cursor position).
5766 \begin_layout Standard
5767 The answer from \SpecialChar LyX
5768 will arrive in the output pipe and be of the form
5785 \begin_layout Standard
5794 are just echoed from the command request, while
5798 is more or less useful information filled according to how the command
5799 execution worked out.
5800 Some commands, such as
5801 \begin_inset Quotes eld
5805 \begin_inset Quotes erd
5808 , will return information about the internal state of \SpecialChar LyX
5810 return an empty data-response.
5811 This means that the command execution went fine.
5814 \begin_layout Standard
5815 In case of errors, the response from \SpecialChar LyX
5833 \begin_layout Standard
5838 should contain an explanation of why the command failed.
5841 \begin_layout Standard
5845 \begin_layout LyX-Code
5846 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
5847 \begin_inset Newline newline
5850 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
5851 \begin_inset Newline newline
5854 read a <~/.lyxpipe.out
5855 \begin_inset Newline newline
5861 \begin_layout Subsection
5862 AppleScript (Mac OS X)
5865 \begin_layout Standard
5866 Since \SpecialChar LyX
5867 2.1, \SpecialChar LyX
5868 supports basic interactions with AppleScript for normal communicatio
5869 n through the command run.
5870 This command takes a direct argument (the
5874 to perform) and an optional argument.
5875 It either returns the output of the function or triggers an error with
5876 the error message and code.
5879 \begin_layout Standard
5883 \begin_layout LyX-Code
5884 tell application "\SpecialChar LyX
5888 \begin_layout LyX-Code
5892 \begin_layout LyX-Code
5893 -- Stores the current file name into f
5896 \begin_layout LyX-Code
5897 set f to (run "server-get-filename" with argument "")
5900 \begin_layout LyX-Code
5901 on error the error_message number the error_number
5904 \begin_layout LyX-Code
5905 display dialog "Error: " & the error_number & ".
5909 \begin_layout LyX-Code
5910 & the error_message buttons {"OK"} default button 1
5913 \begin_layout LyX-Code
5917 \begin_layout LyX-Code
5921 \begin_layout Section
5925 \begin_layout Standard
5927 can notify clients of events going on asynchronously.
5928 Currently it will only do this if the user binds a key sequence with the
5930 \begin_inset Quotes eld
5934 \begin_inset Quotes erd
5938 The format of the string \SpecialChar LyX
5939 sends is as follows:
5943 \begin_inset Flex Code
5946 \begin_layout Plain Layout
5957 \begin_layout Standard
5962 is the printed representation of the key sequence that was actually typed
5966 \begin_layout Standard
5967 This mechanism can be used to extend \SpecialChar LyX
5968 's command set and implement macros.
5969 Bind some key sequence to
5970 \begin_inset Quotes eld
5974 \begin_inset Quotes erd
5978 Then start a client that listens on the output pipe, dispatches the command
5979 according to the sequence, and starts a function that may use \SpecialChar LyX
5982 requests to issue a command or a series of commands to \SpecialChar LyX
5986 \begin_layout Section
5987 The simple \SpecialChar LyX
5991 \begin_layout Standard
5993 implements a simple protocol that can be used for session management.
5994 All messages are of the form
6007 \begin_layout Standard
6013 \begin_inset Quotes eld
6017 \begin_inset Quotes erd
6021 \begin_inset Quotes eld
6025 \begin_inset Quotes erd
6030 \begin_inset Quotes eld
6034 \begin_inset Quotes erd
6037 is received from a client, \SpecialChar LyX
6038 will report back to inform the client that
6039 it's listening to it's messages, while
6040 \begin_inset Quotes eld
6044 \begin_inset Quotes erd
6047 sent from \SpecialChar LyX
6048 will inform clients that \SpecialChar LyX
6052 \begin_layout Section
6053 Reverse DVI/PDF search
6056 \begin_layout Standard
6057 Some DVI/PDF viewers
6061 \begin_layout Plain Layout
6062 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6063 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6072 facility (also called
6077 This means that you can tell \SpecialChar LyX
6078 to put the cursor to a specific line in the
6079 document by clicking at the respective position in the DVI/PDF output.
6080 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6082 This is done via the \SpecialChar LyX
6083 server either by using the named pipe (
6087 ), or the UNIX domain socket (
6091 ) that \SpecialChar LyX
6092 creates in its temporary directory (this is the way the
6093 \begin_inset Flex Code
6096 \begin_layout Plain Layout
6102 program communicates with \SpecialChar LyX
6104 In some cases, you need a helper script that mediates between the viewer
6105 and \SpecialChar LyX
6106 , in others, the viewer can communicate with \SpecialChar LyX
6108 This depends on the selected viewer and on your operating system.
6109 The same applies to the way viewers need to be configured and the way the
6110 reverse search is actually performed.
6111 In what follows, we will thus describe how to setup reverse search for
6113 Before we turn to this, though, we will explain what needs to be done generally
6114 to enable reverse search in the DVI/PDF output.
6117 \begin_layout Subsection
6119 \begin_inset CommandInset label
6121 name "subsec:rev-search"
6128 \begin_layout Standard
6129 In most cases \SpecialChar LyX
6130 will do the work for you by enabling the option
6131 \begin_inset Flex MenuItem
6134 \begin_layout Plain Layout
6135 Synchronize with Output
6141 \begin_inset Flex MenuItem
6144 \begin_layout Plain Layout
6145 Document\SpecialChar menuseparator
6146 Settings\SpecialChar menuseparator
6153 In such a case \SpecialChar LyX
6154 will automatically insert the necessary Sync\SpecialChar TeX
6156 PDF) or load the srcltx package (for DVI) respectively.
6157 This option can be easily reached also on
6158 \begin_inset Flex Code
6161 \begin_layout Plain Layout
6170 \begin_layout Standard
6171 If you need a different setting, you can select or input a custom macro
6172 from the drop down box just below
6173 \begin_inset Flex MenuItem
6176 \begin_layout Plain Layout
6177 Document\SpecialChar menuseparator
6178 Settings\SpecialChar menuseparator
6179 Output\SpecialChar menuseparator
6180 Synchronize with Output
6188 \begin_layout Standard
6189 Note that the method
6190 \begin_inset Flex Code
6193 \begin_layout Plain Layout
6201 enables gzip compression.
6202 If your viewer does not support it, you should instead use
6203 \begin_inset Flex Code
6206 \begin_layout Plain Layout
6217 \begin_layout Standard
6218 Please also note that including the
6219 \begin_inset Flex Code
6222 \begin_layout Plain Layout
6229 \begin_inset Flex Code
6232 \begin_layout Plain Layout
6238 sometimes has an undesired impact on the typesetting.
6239 Thus, you should switch output synchronization off for the final typesetting
6241 \begin_inset Flex Code
6244 \begin_layout Plain Layout
6251 \begin_inset Flex Code
6254 \begin_layout Plain Layout
6264 \begin_layout Standard
6265 In case you need some more special settings that are not covered by the
6266 automatic settings, read the next section about how to set up output synchroniz
6268 If the automatic setup suits your needs, you can readily jump to section
6269 \begin_inset space ~
6273 \begin_inset CommandInset ref
6275 reference "subsec:configuring-viewers"
6279 , where the necessary configuration steps in your viewer – needed both with
6280 the automatic and the manual setup – are described.
6283 \begin_layout Subsection
6287 \begin_layout Standard
6289 provides several different methods for reverse search.
6290 Some are built-in in the
6291 \begin_inset Flex Code
6294 \begin_layout Plain Layout
6300 program, some are provided by external packages.
6301 Your choice depends on whether your \SpecialChar LaTeX
6302 distribution already provides a given
6303 method (the built-in methods are rather new) and whether your viewer can
6305 The available methods are described in the following.
6308 \begin_layout Subsubsection*
6309 Built-in DVI-search via src-specials (DVI only)
6312 \begin_layout Standard
6313 This method provides the DVI file with the necessary information for reverse
6315 It is available in \SpecialChar LaTeX
6316 since quite some time (any somewhat recent \SpecialChar LaTeX
6318 should include it), and it works reliably.
6319 To enable it, change the
6320 \begin_inset Flex MenuItem
6323 \begin_layout Plain Layout
6334 \begin_inset Flex MenuItem
6337 \begin_layout Plain Layout
6348 \begin_inset Flex MenuItem
6351 \begin_layout Plain Layout
6352 Preferences\SpecialChar menuseparator
6353 File Handling\SpecialChar menuseparator
6360 \begin_inset Flex Code
6363 \begin_layout Plain Layout
6364 latex -src-specials $$i
6370 If this doesn't work, check if your \SpecialChar TeX
6371 engine needs different options (the
6372 syntax might differ in some distributions).
6375 \begin_layout Subsubsection*
6376 External Packages (PDFSync and scrltx)
6379 \begin_layout Standard
6388 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6390 In order to enable it, load the packages in the \SpecialChar LyX
6394 \begin_layout Itemize
6395 \begin_inset Flex Code
6398 \begin_layout Plain Layout
6406 for reverse PDF search,
6409 \begin_layout Itemize
6410 \begin_inset Flex Code
6413 \begin_layout Plain Layout
6416 usepackage[active]{srcltx}
6421 for reverse DVI search.
6424 \begin_layout Standard
6425 If you want to be able to perform both DVI and PDF reverse searches, you
6426 can also insert in the preamble the following lines
6429 \begin_layout LyX-Code
6433 \begin_inset Newline newline
6439 \begin_inset Newline newline
6445 \begin_inset Newline newline
6451 \begin_inset Newline newline
6456 usepackage[active]{srcltx}
6457 \begin_inset Newline newline
6465 \begin_layout Standard
6466 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6467 right package will be used.
6470 \begin_layout Standard
6471 Note that PDFSync might affect the output layout of your document.
6472 It is therefore advised to disable PDFsync for final documents.
6475 \begin_layout Subsubsection*
6476 Built-in reverse search via Sync\SpecialChar TeX
6480 \begin_layout Standard
6482 \begin_inset Flex Code
6485 \begin_layout Plain Layout
6491 have built-in support for both PDF and DVI reverse search.
6494 Sync\SpecialChar TeX
6497 facility is basically the result of the integration of the PDFSync package
6498 to the pdftex program and its merge with the
6503 You need at least \SpecialChar TeX
6504 Live 2008 or a recent Mik\SpecialChar TeX
6505 distribution in order to use
6510 \begin_layout Plain Layout
6511 For some reason, Mik\SpecialChar TeX
6512 does not understand/obey the command \SpecialChar LyX
6514 the preamble when you check the "Enable Forward/Reverse Search" button
6515 in the toolbar and does not generate the necessary info.
6518 \begin_layout Plain Layout
6519 The generation of the required info can be forced by changing the converter
6521 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
6522 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
6523 the -synctex=1 switch).
6528 Also note that only a few PDF viewers (Okular and Qpdfview on Unix, Skim
6529 on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
6533 \begin_layout Standard
6534 To enable Sync\SpecialChar TeX
6535 for DVI output, change the
6536 \begin_inset Flex MenuItem
6539 \begin_layout Plain Layout
6550 \begin_inset Flex MenuItem
6553 \begin_layout Plain Layout
6564 \begin_inset Flex MenuItem
6567 \begin_layout Plain Layout
6568 Preferences\SpecialChar menuseparator
6569 File Handling\SpecialChar menuseparator
6576 \begin_inset Flex Code
6579 \begin_layout Plain Layout
6580 latex -synctex=1 $$i
6585 , and for PDF output, change the
6586 \begin_inset Flex MenuItem
6589 \begin_layout Plain Layout
6594 (pdflatex) -> PDF (pdflatex)
6600 \begin_inset Flex Code
6603 \begin_layout Plain Layout
6604 pdflatex -synctex=1 $$i
6610 Check the documentation of your viewer whether the viewer needs to be configure
6611 d for the use with Sync\SpecialChar TeX
6616 \begin_layout Plain Layout
6617 Note that the option
6618 \begin_inset Flex Code
6621 \begin_layout Plain Layout
6627 option enables gzip compression.
6628 If your viewer does not support it, you should instead use
6629 \begin_inset Flex Code
6632 \begin_layout Plain Layout
6646 \begin_layout Subsection
6647 Configuring and using specific viewers
6648 \begin_inset CommandInset label
6650 name "subsec:configuring-viewers"
6657 \begin_layout Subsubsection*
6658 Xdvi (all platforms)
6661 \begin_layout Standard
6663 \begin_inset Flex Code
6666 \begin_layout Plain Layout
6672 , you don't need to do anything else for performing a reverse DVI search,
6674 already provides the necessary hooks for automatically using the
6675 \begin_inset Flex Code
6678 \begin_layout Plain Layout
6685 Just setup your document as described above (reverse search is triggered
6686 by Ctrl-click or Alt-click on Mac OSX, respectively).
6689 \begin_layout Standard
6690 However, if for whatever reason you want to use the named pipe instead of
6691 the socket for communicating with \SpecialChar LyX
6692 , simply change the DVI viewer in
6693 \begin_inset Flex MenuItem
6696 \begin_layout Plain Layout
6697 Preferences\SpecialChar menuseparator
6698 File Handling\SpecialChar menuseparator
6708 \begin_layout Plain Layout
6709 On Mac OSX you have to use
6710 \begin_inset Flex Code
6713 \begin_layout Plain Layout
6714 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
6725 \begin_inset Flex Code
6728 \begin_layout Plain Layout
6729 xdvi -editor "lyxeditor.sh %f %l"
6735 \begin_inset Flex Code
6738 \begin_layout Plain Layout
6744 is a suitable script.
6745 For example, a minimal shell script is the following one:
6748 \begin_layout LyX-Code
6750 \begin_inset Newline newline
6753 LYXPIPE="/path/to/lyxpipe"
6754 \begin_inset Newline newline
6757 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
6758 \begin_inset Newline newline
6761 echo "$COMMAND" > "${LYXPIPE}".in || exit
6762 \begin_inset Newline newline
6765 read TMP < "${LYXPIPE}".out || exit
6768 \begin_layout Standard
6770 \begin_inset Flex Code
6773 \begin_layout Plain Layout
6783 \begin_layout Plain Layout
6790 XServer pipe path specified in
6791 \begin_inset Flex MenuItem
6794 \begin_layout Plain Layout
6795 Preferences\SpecialChar menuseparator
6805 \begin_layout Plain Layout
6807 \begin_inset Flex Code
6810 \begin_layout Plain Layout
6816 folder of a source distribution you can find a
6817 \begin_inset Flex Code
6820 \begin_layout Plain Layout
6826 script which is able to locate the
6830 based on your preferences.
6838 \begin_layout Subsubsection*
6842 \begin_layout Standard
6844 \begin_inset Flex Code
6847 \begin_layout Plain Layout
6848 /Applications/MacDviX_Folder/calleditor.script
6853 , add the following lines:
6856 \begin_layout LyX-Code
6861 \begin_layout Plain Layout
6868 X.app/Contents/MacOS/lyxeditor "$2" $1
6869 \begin_inset Newline newline
6875 \begin_layout Standard
6876 Modify the lines accordingly if you install \SpecialChar LyX
6877 somewhere else than in the
6878 Applications folder.
6881 \begin_layout Standard
6882 Reverse search is triggered by Alt-click (OPTION-click).
6885 \begin_layout Subsubsection*
6889 \begin_layout Standard
6891 \begin_inset Flex Code
6894 \begin_layout Plain Layout
6895 open -a Skim.app $$i
6900 to the viewer setting in
6901 \begin_inset Flex MenuItem
6904 \begin_layout Plain Layout
6905 Preferences\SpecialChar menuseparator
6906 File Handling\SpecialChar menuseparator
6907 File formats\SpecialChar menuseparator
6914 \begin_inset Flex MenuItem
6917 \begin_layout Plain Layout
6918 Skim\SpecialChar menuseparator
6919 Preferences\SpecialChar menuseparator
6926 \begin_inset Flex MenuItem
6929 \begin_layout Plain Layout
6935 preset and enter command
6936 \begin_inset Flex MenuItem
6939 \begin_layout Plain Layout
6940 /Applications/\SpecialChar LyX
6941 .app/Contents/MacOS/lyxeditor
6949 \begin_layout Standard
6950 Reverse search is triggered by COMMAND-SHIFT-click
6953 \begin_layout Subsubsection*
6957 \begin_layout Standard
6959 \begin_inset Flex MenuItem
6962 \begin_layout Plain Layout
6963 Settings\SpecialChar menuseparator
6964 Configure Okular\SpecialChar menuseparator
6971 \begin_inset Quotes eld
6975 \begin_inset Quotes erd
6979 \begin_inset Flex Code
6982 \begin_layout Plain Layout
6991 \begin_layout Standard
6992 Reverse search is triggered by SHIFT-click.
6995 \begin_layout Subsubsection*
6999 \begin_layout Standard
7000 Qpdfview supports Sync\SpecialChar TeX
7001 since version 0.3.5.
7003 \begin_inset Flex MenuItem
7006 \begin_layout Plain Layout
7007 Edit\SpecialChar menuseparator
7008 Settings\SpecialChar menuseparator
7014 , click on the input field of the
7015 \begin_inset Quotes eld
7019 \begin_inset Quotes erd
7022 item and add the command
7023 \begin_inset Flex Code
7026 \begin_layout Plain Layout
7035 \begin_layout Standard
7036 Reverse search is triggered by double-click.
7039 \begin_layout Subsubsection*
7043 \begin_layout Standard
7044 Launch yap, choose its
7045 \begin_inset Flex MenuItem
7048 \begin_layout Plain Layout
7049 View\SpecialChar menuseparator
7056 \begin_inset Quotes eld
7060 \begin_inset Quotes erd
7065 \begin_inset Quotes eld
7068 New\SpecialChar ldots
7070 \begin_inset Quotes erd
7073 button and, in the window that opens, enter
7074 \begin_inset Quotes eld
7079 \begin_inset Quotes erd
7082 (or any other name you like) in the
7083 \begin_inset Quotes eld
7087 \begin_inset Quotes erd
7091 Now click on the button labeled
7092 \begin_inset Quotes eld
7097 \begin_inset Quotes erd
7100 to open a file dialog and navigate to the directory containing the batch
7102 \begin_inset Flex Code
7105 \begin_layout Plain Layout
7113 \begin_inset Flex Code
7116 \begin_layout Plain Layout
7122 and then specify the program arguments as
7123 \begin_inset Flex Code
7126 \begin_layout Plain Layout
7134 \begin_inset Flex Code
7137 \begin_layout Plain Layout
7143 wrapper is used for communicating with \SpecialChar LyX
7151 \begin_layout LyX-Code
7153 \begin_inset Newline newline
7156 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
7165 \begin_inset Newline newline
7179 \begin_layout Standard
7180 Make sure that the \SpecialChar LyX
7181 Server pipe path you specified in \SpecialChar LyX
7183 \begin_inset Flex Code
7186 \begin_layout Plain Layout
7200 , otherwise change the
7201 \begin_inset Flex Code
7204 \begin_layout Plain Layout
7210 wrapper accordingly.
7213 \begin_layout Standard
7214 In yap, reverse search is triggered by double-click.
7217 \begin_layout Subsubsection*
7218 SumatraPDF (Windows)
7221 \begin_layout Standard
7222 In order to use SumatraPDF for inverse search, enter
7223 \begin_inset Flex Code
7226 \begin_layout Plain Layout
7227 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
7232 in the viewer setting in
7233 \begin_inset Flex MenuItem
7236 \begin_layout Plain Layout
7237 Preferences\SpecialChar menuseparator
7238 File Handling\SpecialChar menuseparator
7239 File formats\SpecialChar menuseparator
7246 \begin_inset Flex Code
7249 \begin_layout Plain Layout
7255 is the previous wrapper.
7256 If SumatraPDF.exe is not in your command PATH, use its full file name.
7259 \begin_layout Standard
7260 Reverse search is triggered by double-click.
7263 \begin_layout Subsubsection*
7267 \begin_layout Standard
7268 First of all, make sure that yap is your default DVI viewer in the Windows
7269 environment, then launch it, choose its
7270 \begin_inset Flex MenuItem
7273 \begin_layout Plain Layout
7274 View\SpecialChar menuseparator
7281 \begin_inset Quotes eld
7285 \begin_inset Quotes erd
7290 \begin_inset Quotes eld
7293 New\SpecialChar ldots
7295 \begin_inset Quotes erd
7298 button and, in the window that opens, enter
7299 \begin_inset Quotes eld
7304 \begin_inset Quotes erd
7307 (or any other name you like) in the
7308 \begin_inset Quotes eld
7312 \begin_inset Quotes erd
7316 Now click on the button labeled
7317 \begin_inset Quotes eld
7322 \begin_inset Quotes erd
7325 to open a file dialog and navigate to the directory containing the
7326 \begin_inset Flex Code
7329 \begin_layout Plain Layout
7335 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7338 \begin_inset Flex Code
7341 \begin_layout Plain Layout
7347 and then specify the program arguments as
7348 \begin_inset Flex Code
7351 \begin_layout Plain Layout
7358 In this way, you will be using the
7362 for communicating with \SpecialChar LyX
7364 If, for whatever reason, you want to use the
7369 \begin_inset Flex Code
7372 \begin_layout Plain Layout
7378 option and be sure to specify the \SpecialChar LyX
7379 Server pipe path in the \SpecialChar LyX
7383 \begin_layout Standard
7384 In yap, reverse search is triggered by double-click.
7387 \begin_layout Subsubsection*
7391 \begin_layout Standard
7392 In order to use SumatraPDF for inverse search, enter
7393 \begin_inset Flex Code
7396 \begin_layout Plain Layout
7397 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7402 in the viewer setting in
7403 \begin_inset Flex MenuItem
7406 \begin_layout Plain Layout
7407 Preferences\SpecialChar menuseparator
7408 File Handling\SpecialChar menuseparator
7409 File formats\SpecialChar menuseparator
7416 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7418 \begin_inset Flex Code
7421 \begin_layout Plain Layout
7427 enables communication via the
7433 \begin_inset Flex Code
7436 \begin_layout Plain Layout
7442 option if you want to use the
7446 , and be sure to specify the \SpecialChar LyX
7447 Server pipe path in the \SpecialChar LyX
7451 \begin_layout Standard
7452 Reverse search is triggered by double-click.
7455 \begin_layout Section
7459 \begin_layout Standard
7460 Forward search is, as the name implies, in a sense the
7461 \begin_inset Quotes eld
7465 \begin_inset Quotes erd
7469 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7471 If forward search is set up (as described in what follows), you can put
7472 the cursor anywhere in your \SpecialChar LyX
7474 \begin_inset Flex MenuItem
7477 \begin_layout Plain Layout
7478 Navigate\SpecialChar menuseparator
7485 \begin_inset Flex MenuItem
7488 \begin_layout Plain Layout
7494 in the context menu via right mouse click), and then the viewer will jump
7495 to that position as well.
7496 This implies, of course, that your viewer supports this function.
7499 \begin_layout Standard
7500 To make forward search possible, you first need to provide the generated
7501 output PDF/DVI file with additional information about the \SpecialChar TeX
7503 This can be done via the methods described in the section
7504 \begin_inset CommandInset ref
7506 reference "subsec:rev-search"
7513 \begin_layout Standard
7514 Additionally, you need to configure \SpecialChar LyX
7515 for using your viewers in
7516 \begin_inset Flex MenuItem
7519 \begin_layout Plain Layout
7520 Tools\SpecialChar menuseparator
7521 Preferences\SpecialChar menuseparator
7522 Output\SpecialChar menuseparator
7529 We provide a range of tested configurations for some viewers, which you
7530 can select from the drop down list.
7531 If none of these configurations suits you, you have to find out and enter
7532 a suitable configuration yourself.
7533 The definition syntax uses the following placeholders:
7536 \begin_layout Itemize
7538 \begin_inset Flex Code
7541 \begin_layout Plain Layout
7550 \begin_layout Itemize
7552 \begin_inset Flex Code
7555 \begin_layout Plain Layout
7561 : name of the (temporary) exported .tex file (without path)
7564 \begin_layout Itemize
7566 \begin_inset Flex Code
7569 \begin_layout Plain Layout
7575 : name of the (temporary) exported .tex file (including path)
7578 \begin_layout Itemize
7580 \begin_inset Flex Code
7583 \begin_layout Plain Layout
7589 : name of the exported output file (either dvi or pdf, depending on which
7590 one exists in the temporary directory)
7593 \begin_layout Standard
7594 Note that only some of the viewers provide full forward search functionality,
7595 among them yap, xdvi, okular
7599 \begin_layout Plain Layout
7600 You might want to set
7601 \begin_inset Flex Code
7604 \begin_layout Plain Layout
7611 \begin_inset Flex MenuItem
7614 \begin_layout Plain Layout
7615 Tools\SpecialChar menuseparator
7616 Preferences\SpecialChar menuseparator
7617 File Handling\SpecialChar menuseparator
7619 \begin_inset space ~
7632 , qpdfview and SumatraPDF
7636 \begin_layout Plain Layout
7637 SumatraPDF can also use DDE commands through the external program CMCDDE
7639 \begin_inset CommandInset href
7641 target "ftp://ftp2.commence.com/pub/freebies/"
7651 While many of the widespread PDF viewers (most notably Adobe Reader) do
7652 not support forward search at all, some other viewers – e.
7653 \begin_inset space \thinspace{}
7657 evince and xpdf – allow at least to reload the document and jump to a specific
7658 page of the file, so you can at least navigate
7659 \begin_inset Quotes eld
7663 \begin_inset Quotes erd
7667 This latter functionality is provided by an external call of synctex (see
7668 the predefined example configurations).
7672 \begin_layout Standard
7673 Forward search works both with DVI and PDF output.
7675 simply checks which preview format you have used before (i.
7676 \begin_inset space \thinspace{}
7679 e., which format is already there in the temporary directory) and chooses
7680 the appropriate configuration for the respective format.
7683 \begin_layout Chapter
7684 Special Document Classes
7687 \begin_layout Section
7691 \begin_layout Standard
7697 \begin_layout Subsection
7701 \begin_layout Standard
7702 This section describes how \SpecialChar LyX
7703 can be used to write articles for submission
7704 to the scientific journal
7706 Astronomy and Astrophysics
7709 \begin_inset Flex URL
7712 \begin_layout Plain Layout
7714 http://www.edpsciences.fr/aa/
7719 ) using Version 5.01 of the document class
7724 This package can be downloaded from the ftp site
7727 \begin_layout Standard
7728 \begin_inset VSpace medskip
7734 \begin_layout Standard
7736 \begin_inset Flex URL
7739 \begin_layout Plain Layout
7741 ftp://ftp.edpsciences.org/pub/aa/readme.html
7749 \begin_layout Standard
7750 \begin_inset VSpace medskip
7756 \begin_layout Standard
7757 A manual comes together with that package, and this text is not meant to
7758 replace the original manual but is merely a short guide in how to realize
7759 the correct form of your paper.
7763 \begin_layout Standard
7764 Please note that the publisher of the journal was changed from Springer
7765 to EDP Sciences starting January 1, 2001.
7766 That change involved also some slight changes to the style files, namely
7767 the removal of the thesaurus command.
7768 The \SpecialChar LyX
7769 class aa supports the newest version of these style files, V 5.01.
7770 If you have an older version installed, please upgrade.
7771 For compatibility, the old (version 4) layout has been kept as
7776 Please refer to the comments in
7779 Dir/layouts/aapaper.layout
7784 \begin_layout Subsection
7788 \begin_layout Standard
7789 It is recommended you start from the example template distributed with \SpecialChar LyX
7791 If you are not using a template, note the following settings:
7794 \begin_layout Itemize
7801 Document\SpecialChar menuseparator
7804 dialog (OK, that one was obvious).
7807 \begin_layout Itemize
7808 Don't change the option
7811 \begin_inset space ~
7821 The whole layout is done by the macros, you shouldn't change anything.
7824 \begin_layout Subsection
7828 \begin_layout Standard
7829 First thing to enter is the header information.
7830 It consists of seven entries, of which some are optional.
7834 \begin_layout Itemize
7842 \begin_layout Itemize
7850 \begin_layout Itemize
7858 \begin_layout Itemize
7866 \begin_layout Itemize
7871 : [optional] if more than one author: whom to contact for offprint requests.
7874 \begin_layout Itemize
7879 : [optional] mail address for contacts.
7882 \begin_layout Itemize
7890 Received: <date>; Accepted <date>
7893 \begin_layout Standard
7894 There is no need to issue the
7900 command, this is done automatically by \SpecialChar LyX
7901 when the header is finished.
7902 Although the order of the single header entries doesn't matter it is advised
7903 to keep the above sequence, just to get the best optics and meets the layout
7904 of the real document.
7907 \begin_layout Standard
7908 If you want to place footnotes in the header block, e.
7909 \begin_inset space \thinspace{}
7913 \begin_inset space \space{}
7916 to state your present address, just use the standard footnote via the menu
7919 Insert\SpecialChar menuseparator
7924 will automagically use the term
7933 \begin_layout Standard
7934 In addition to these topics, the macros use three additional \SpecialChar LaTeX
7936 have no counterpart in \SpecialChar LyX
7940 \begin_layout Itemize
7947 to separate different names for more than one author and institute, respectivel
7951 \begin_layout Itemize
7958 to mark corresponding author/institute pairs.
7959 The institutes are numbered sequentially as they appear in the
7963 field, so you have to put a marker to each author.
7966 \begin_layout Itemize
7973 to supply an email address for fast contact.
7976 \begin_layout Standard
7977 In all cases, the appropriate command has to be entered in \SpecialChar LyX
7985 \begin_layout Subsection
7989 \begin_layout Standard
7990 The abstract should immediately follow the header block.
7991 With version 5 the abstract environment was changed to a command, and there
7992 is now a resctriction to only one paragraph.
7993 In addition, it should contain an entry with the keywords.
7994 This is not yet implemented for \SpecialChar LyX
7995 , therefore you have to enter the \SpecialChar LaTeX
8003 by hand and mark it as \SpecialChar LaTeX
8005 Refer to the example paper.
8008 \begin_layout Subsection
8009 Supported environments
8012 \begin_layout Standard
8013 The A&A paper layout supports the following environments for structuring
8017 \begin_layout Itemize
8023 \begin_layout Itemize
8029 \begin_layout Itemize
8035 \begin_layout Itemize
8041 \begin_layout Itemize
8047 \begin_layout Itemize
8053 \begin_layout Itemize
8059 \begin_layout Itemize
8065 \begin_layout Itemize
8071 \begin_layout Itemize
8077 \begin_layout Itemize
8083 \begin_layout Itemize
8090 \begin_layout Subsection
8091 Commands not supported by \SpecialChar LyX
8095 \begin_layout Standard
8096 Some commands are not yet supported by the
8100 layout for \SpecialChar LyX
8102 Some have already been mentioned.
8103 For the sake of completeness, they are listed all together here:
8106 \begin_layout Itemize
8114 \begin_layout Itemize
8122 \begin_layout Itemize
8130 \begin_layout Itemize
8138 \begin_layout Itemize
8146 \begin_layout Itemize
8154 \begin_layout Itemize
8162 \begin_layout Itemize
8170 \begin_layout Standard
8171 If you want to use any of these commands, you have to enter them yourself.
8174 Do not forget to mark them as \SpecialChar LaTeX
8178 \begin_layout Subsection
8179 Figure and Table Floats
8182 \begin_layout Standard
8184 provides support for the necessary float environments
8186 figure, figure*, table
8192 , therefore we won't tell much about it here.
8196 \begin_inset space ~
8202 Just remember that tables should be left-aligned.
8203 For that, select the table and change the alignment in
8205 Edit\SpecialChar menuseparator
8207 \begin_inset space ~
8213 \begin_layout Standard
8214 There is only one special thing: the figures with caption besides the figure.
8215 To create such a figure, you have to do the following:
8218 \begin_layout Enumerate
8219 Create a wide figure float:
8221 Insert\SpecialChar menuseparator
8222 Float\SpecialChar menuseparator
8225 , then right click in the figure and select
8231 \begin_inset space ~
8239 \begin_layout Enumerate
8240 Enter your caption text.
8243 \begin_layout Enumerate
8248 to move the cursor above the caption.
8251 \begin_layout Enumerate
8255 \begin_layout Enumerate
8256 Position the cursor behind the figure and insert a horizontal fill:
8258 Insert\SpecialChar menuseparator
8260 \begin_inset space ~
8263 Character\SpecialChar menuseparator
8265 \begin_inset space ~
8273 \begin_layout Enumerate
8274 Switch to \SpecialChar LaTeX
8278 \begin_inset space ~
8286 \begin_layout Enumerate
8296 Do not close the brace!
8299 \begin_layout Enumerate
8300 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8305 \begin_inset space ~
8317 \begin_layout Standard
8318 Also, refer to the figures in the example paper.
8321 \begin_layout Subsection
8325 \begin_layout Standard
8326 For submission, the paper has to be formated in a special double-spacing
8328 For this purpose, you have to give the option
8332 to the documentclass.
8333 This must be done using the extra class options field in the
8335 Document\SpecialChar menuseparator
8339 Just enter the string
8346 \begin_layout Subsection
8350 \begin_layout Standard
8355 directory contains an example paper written with \SpecialChar LyX
8357 It is the example paper from the original macro package, translated to
8360 Use it for inspiration, and compare the original \SpecialChar LaTeX
8361 code with \SpecialChar LyX
8365 \begin_layout Section
8370 \begin_layout Standard
8376 \begin_layout Subsection
8380 \begin_layout Standard
8382 is a set of macros produced by the American Astronomical Society to
8383 facilitate electronic manuscript submission to the three journals they
8384 publish: the Astrophysical Journal (including the Letters and Supplement),
8385 the Astronomical Journal, and the Publications of the Astronomical Society
8388 has proven to be an excellent tool for generating these documents, especially
8389 given its equation, citation, and figure handling capabilities.
8391 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8392 is the version described here, or higher.
8393 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8394 2.09 and are fundamentally
8395 incompatible with \SpecialChar LyX
8397 The AAS\SpecialChar TeX
8398 package may be downloaded from the AAS\SpecialChar TeX
8402 \begin_layout Standard
8403 \begin_inset VSpace medskip
8409 \begin_layout Standard
8411 \begin_inset Flex URL
8414 \begin_layout Plain Layout
8416 http://www.journals.uchicago.edu/AAS/AASTeX
8424 \begin_layout Standard
8425 \begin_inset VSpace medskip
8431 \begin_layout Standard
8432 A complete user guide is contained in that package and you should familiarize
8433 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8436 will not reduce the need to figure out all the AAS\SpecialChar TeX
8437 commands, it will only
8438 reduce the drudgery of typing everything in.
8439 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8441 completely to the requirements of the journal to which you are submitting
8445 \begin_layout Subsection
8446 Starting a New Paper
8449 \begin_layout Standard
8450 I strongly suggest that you start with the AAS\SpecialChar TeX
8454 File\SpecialChar menuseparator
8461 , enter the new file name, then choose the
8466 This will show the most common fields found in a manuscript.
8467 Simply overwrite the existing text (including the brackets,
8471 ) with the correct information.
8472 Many of the AAS\SpecialChar TeX
8473 commands and environments can be implemented directly in
8475 , but some cannot: most noticeably
8487 , which should stick out like a sore thumb if you actually just opened the
8489 For commands such as these, the \SpecialChar LaTeX
8490 code must be entered directly and marked
8492 Such commands are referred to as \SpecialChar TeX
8493 code, or Evil Red Text.
8494 I tried to minimize the amount of \SpecialChar TeX
8495 code needed in an AAS\SpecialChar TeX
8497 there is still a bit more required than any of us would like.
8500 \begin_layout Subsection
8501 Finishing Your Paper
8504 \begin_layout Standard
8505 When the paper is finished to your satisfaction and previews/prints correctly,
8507 \begin_inset Quotes eld
8511 \begin_inset Quotes erd
8514 actions which need to be done before you submit it to the journals.
8518 \begin_layout Enumerate
8519 Export your paper as a \SpecialChar LaTeX
8522 File\SpecialChar menuseparator
8523 Export\SpecialChar menuseparator
8531 \begin_layout Enumerate
8536 file with your favorite text editor
8537 \begin_inset Separator parbreak
8544 \begin_layout Enumerate
8545 remove the comment lines before the
8554 \begin_layout Enumerate
8559 usepackage...{fontenc}
8561 line if it appears (usually just after
8576 \begin_layout Enumerate
8577 remove everything between (and including) the
8589 commands, except for any commands you specifically put into the \SpecialChar LaTeX
8591 (which should appear immediately after the
8592 \begin_inset Quotes eld
8595 User specified \SpecialChar LaTeX
8597 \begin_inset Quotes erd
8608 \begin_layout Enumerate
8609 Run the resulting file through \SpecialChar LaTeX
8610 to make sure it still processes correctly.
8613 \begin_layout Enumerate
8614 Reread the journal requirements to make sure your filenames and formats
8618 \begin_layout Enumerate
8622 \begin_layout Subsection
8623 Comments On Specific Commands
8626 \begin_layout Standard
8627 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8634 ) gives a good description of each.
8635 Thus it's probably easiest for me to go down the list as found in the guide
8636 and offer comments where necessary.
8637 So let's begin \SpecialChar ldots
8641 \begin_layout Subsubsection
8642 Things that work as expected
8645 \begin_layout Standard
8646 Because they work as you might expect, I simply list them and the section
8747 begin{thebibliography}
8755 (2.13.2), all the cite commands and their variations (2.13.2), the generic
8756 graphicx figure commands (2.14.1),
8780 (2.15.4, amongst other places),
8807 \begin_layout Standard
8808 The following style options also work correctly:
8829 Simply put them in the
8835 Layout\SpecialChar menuseparator
8841 \begin_layout Subsubsection
8842 Things that work, but require more comment
8845 \begin_layout Standard
8846 The following items work, but require a little more discussion:
8849 \begin_layout Itemize
8850 These items are reserved for use by the journal editors, but you can put
8851 them into the \SpecialChar LaTeX
8852 preamble if you feel compelled to do so:
8885 \begin_layout Itemize
8886 These items may be placed in the \SpecialChar LaTeX
8887 preamble, and are included as blanks in
8909 \begin_layout Itemize
8916 (2.3) – can only be used
8917 \begin_inset Quotes eld
8921 \begin_inset Quotes erd
8924 , not in the middle of a paragraph.
8925 Use \SpecialChar TeX
8926 code if you need to embed it.
8929 \begin_layout Itemize
8936 (2.3) – will have extra {} after it.
8937 This should not cause an error.
8940 \begin_layout Itemize
8947 (2.6) – can only be used
8948 \begin_inset Quotes eld
8952 \begin_inset Quotes erd
8955 , not in the middle of a paragraph.
8956 Use \SpecialChar TeX
8957 code if you need to embed it.
8960 \begin_layout Itemize
8967 (2.8) – can't insert a cross-reference tag, you must type the tag name by
8971 \begin_layout Itemize
8985 \begin_layout Itemize
8992 (2.9) – will have extra {} after it.
8993 This should not cause an error.
8996 \begin_layout Itemize
9003 (2.11) – will have extra {} after it.
9004 This should not cause an error.
9007 \begin_layout Itemize
9014 (2.14.2) – you can insert an optional filename argument by placing the cursor
9015 at the beginning of the text and selecting
9017 Insert\SpecialChar menuseparator
9022 \begin_inset Quotes eld
9026 \begin_inset Quotes erd
9029 inserts an optional argument of the type needed by
9036 Hopefully it will be renamed someday.
9039 \begin_layout Itemize
9052 for the catalog ID optional parameter
9055 \begin_layout Itemize
9068 for the catalog ID optional parameter
9071 \begin_layout Subsubsection
9072 Things not implemented, use \SpecialChar TeX
9076 \begin_layout Standard
9099 setcounter{equation}
9101 (2.12), Journal name abbreviations (2.13.4),
9137 (2.15.4, insert it as the first element in the lefthand cell after where
9139 Don't use any of \SpecialChar LyX
9140 's rules in the table),
9152 (2.15.5), much of Misc (2.17, except
9203 \begin_layout Subsubsection
9204 Things that cannot be implemented
9207 \begin_layout Standard
9209 at least in any meaningful sort of way, so I suggest ignoring them.
9210 They are the references environment (2.13.3), and the deluxetable environment
9212 If you really, really need to use deluxetable, I suggest editing it in
9213 a separate file with a text editor, then using
9215 Insert\SpecialChar menuseparator
9217 \begin_inset space ~
9222 to include it in your \SpecialChar LyX
9228 file to see an example of this.
9231 \begin_layout Subsection
9232 FAQs, Tips, Tricks, and Other Ruminations
9235 \begin_layout Subsubsection
9236 Getting \SpecialChar LyX
9237 and AAS\SpecialChar TeX
9241 \begin_layout Standard
9242 It can be a bit tricky to get \SpecialChar LyX
9243 to recognize a new layout and document class.
9244 When all else fails, do this:
9247 \begin_layout Enumerate
9248 Make certain that \SpecialChar LaTeX
9249 can find AAS\SpecialChar TeX
9251 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9253 directory completely unrelated to \SpecialChar LaTeX
9254 or AAS\SpecialChar TeX
9255 and run \SpecialChar LaTeX
9263 \begin_layout Enumerate
9268 appears in \SpecialChar LyX
9276 \begin_layout Enumerate
9279 Tools\SpecialChar menuseparator
9283 , then restart \SpecialChar LyX
9287 \begin_layout Enumerate
9288 Open a regular new file, not from a template.
9289 Does AAS\SpecialChar TeX
9290 appear in the class list in
9292 Document\SpecialChar menuseparator
9298 \begin_layout Standard
9299 If you get a warning from an existing AAS\SpecialChar TeX
9300 document about not being able
9301 to find the AAS\SpecialChar TeX
9302 layout or a message about
9303 \begin_inset Quotes eld
9306 You should not mix title layouts with normal ones
9307 \begin_inset Quotes erd
9310 , things haven't been installed correctly.
9313 \begin_layout Subsubsection
9315 error processing a table
9318 \begin_layout Standard
9320 , by default, attempts to center the table caption/title.
9321 This seems to produce a bad interaction in AAS\SpecialChar TeX
9322 so you should click somewhere
9323 in the caption/title, then select
9325 Edit\SpecialChar menuseparator
9327 \begin_inset space ~
9341 This took care of it for me.
9344 \begin_layout Subsubsection
9348 \begin_layout Standard
9349 A couple of things: 1) I have noticed some funny spacing in the reference
9350 entries in the text.
9351 When you enter the bibliography item data, make sure their is
9355 space between the last author and the parenthesis setting off the year;
9359 \begin_inset space \thinspace{}
9363 \begin_inset space \space{}
9377 2) Entering the references at all is not obvious.
9378 The easiest thing is to start typing your first reference at the end of
9379 the document, then mark it as type
9384 That will put a small gray box in front of what you just typed.
9385 Click on the box to fill in the rest of the information.
9386 For new references, go to the end of an existing reference and press return.
9387 That will create a new line with its own box, etc.
9390 \begin_layout Subsubsection
9394 \begin_layout Standard
9395 Even though AAS\SpecialChar TeX
9396 provides its own figure commands (
9402 , for example), I much prefer \SpecialChar LaTeX
9403 's standard figure commands (with the default
9412 \begin_inset space ~
9415 commands as \SpecialChar TeX
9416 code into a Figure Float box if you desire, but I never have
9417 much luck getting the layout right.
9418 With the standard graphics, \SpecialChar LyX
9423 usepackage{graphicx}
9425 command into the \SpecialChar LaTeX
9426 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9428 interspersing the figures in the text.
9429 I believe ApJ accepts figures exactly this way now; AJ might still use
9431 \begin_inset Quotes eld
9434 stack everything at the end
9435 \begin_inset Quotes erd
9441 \begin_layout Subsubsection
9442 Things I could have done, but didn't
9445 \begin_layout Standard
9447 \begin_inset Quotes eld
9451 \begin_inset Quotes erd
9454 things I could have implemented, but chose not to.
9455 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9457 even though it is double-spaced in the paper manuscript.
9458 Also, I chose not to make separate layouts for the preprint and preprint2
9460 Since I assume you will spend most of your time in the plain manuscript
9461 mode anyway, I decided not to chew up more disk space with this.
9465 \begin_layout Subsection
9469 \begin_layout Standard
9470 Your mileage may vary.
9471 I've now had papers published by both ApJ and AJ that have had 98% of the
9472 effort done in \SpecialChar LyX
9473 ; the last 2% was the \SpecialChar LaTeX
9474 post-processing and a few cleanups.
9475 I have had no trouble with the submission process, and I'm sure the journals
9476 were never aware that there might be a difference.
9477 So, go forth and publish!
9480 \begin_layout Section
9481 AMS \SpecialChar LaTeX
9485 \begin_layout Standard
9495 \begin_layout Standard
9496 \begin_inset VSpace bigskip
9502 \begin_layout Standard
9504 The AMS \SpecialChar LaTeX
9505 layouts are set up to conform to suggested styles for mathematical
9506 papers to be submitted to American Mathematical Society publications.
9507 The layouts are not tailored to a specific journal, but easily can be.
9508 You should refer to the AMS documentation for specific instructions for
9509 each journal (usually it will entail only changing a single line in the
9512 That documentation is available on the Web at
9513 \begin_inset Flex URL
9516 \begin_layout Plain Layout
9524 \begin_inset Flex URL
9527 \begin_layout Plain Layout
9529 ftp://ftp.ams.org/pub/tex/amslatex/
9535 These layouts are appropriate, and useful, for any mathematical writing.
9539 \begin_layout Standard
9540 There are two basic AMS \SpecialChar LaTeX
9544 \begin_layout Itemize
9545 amsart: The standard AMS article format.
9548 \begin_layout Itemize
9549 amsbook: the standard AMS book (really, monograph) format.
9553 \begin_layout Standard
9554 The layouts themselves contain only the minimum necessary to use the AMS
9556 They do not, in particular, contain any of the `theorem' environments used
9557 for setting theorems, lemmas, and the like.
9558 These are contained, instead, in the
9559 \begin_inset Flex Code
9562 \begin_layout Plain Layout
9568 module, which is loaded by default when you select one of the AMS classes.
9569 (It can also be used with other classes and can be removed, if you would
9570 rather use something else.) Less commonly used environments are in the
9571 \begin_inset Flex Code
9574 \begin_layout Plain Layout
9575 Theorems (AMS-Extended)
9580 module, which must be loaded manually.
9583 \begin_layout Standard
9584 By default, theorems and the like are numbered consecutively throughout
9585 the document, but this may be modified by loading the module
9586 \begin_inset Flex Code
9589 \begin_layout Plain Layout
9590 Theorems (Order by Section)
9595 or, if you are using
9596 \begin_inset Flex Code
9599 \begin_layout Plain Layout
9606 \begin_inset Flex Code
9609 \begin_layout Plain Layout
9610 Theorems (Order by Chapter)
9616 These will number the results as
9617 \begin_inset Formula $n.m$
9620 , where the first number refers to the section (or chapter) and the second
9621 refers to the total number of results so far in that section (or chapter).
9622 Many environments are also available unnumbered.
9623 These are indicated by an asterisk at the end.
9624 If you happen to want
9628 unnumbered results, the module
9629 \begin_inset Flex Code
9632 \begin_layout Plain Layout
9638 provides that option.
9641 \begin_layout Standard
9642 Note that these modules do not
9646 to be used with the AMS classes.
9647 It is perfectly possible to use the
9648 \begin_inset Flex Code
9651 \begin_layout Plain Layout
9657 module, and the others mentioned, with other classes, such as
9658 \begin_inset Flex Code
9661 \begin_layout Plain Layout
9668 \begin_inset Flex Code
9671 \begin_layout Plain Layout
9678 \begin_inset Flex Code
9681 \begin_layout Plain Layout
9690 \begin_layout Subsection
9691 What these layouts provide
9694 \begin_layout Standard
9695 There is a long list of included environments provided by these layouts.
9696 In AMS-\SpecialChar LaTeX
9697 , there is, in fact, an opportunity to define an unlimited variety
9698 of `theorem' environments.
9699 However, the AMS recommends the environments that are available in \SpecialChar LyX
9704 \begin_layout Standard
9705 The following environments—as well as the standard environments, such as
9707 \begin_inset Flex Noun
9710 \begin_layout Plain Layout
9717 \begin_inset Flex Noun
9720 \begin_layout Plain Layout
9727 \begin_inset Flex Noun
9730 \begin_layout Plain Layout
9737 \begin_inset Flex Noun
9740 \begin_layout Plain Layout
9747 \begin_inset Flex Noun
9750 \begin_layout Plain Layout
9757 \begin_inset Flex Code
9760 \begin_layout Plain Layout
9767 \begin_inset Flex Code
9770 \begin_layout Plain Layout
9779 \begin_layout Description
9780 Address This should be the author's permanent address.
9783 \begin_layout Description
9785 \begin_inset space ~
9788 Address This should be the author's temporary address at the time of submission,
9789 if different from the Address.
9792 \begin_layout Description
9793 Email Author's e-mail address
9796 \begin_layout Description
9797 URL Author's Web address, if desired.
9800 \begin_layout Description
9801 Keywords Key words or phrases used to identify specific topics discussed
9805 \begin_layout Description
9806 Subjectclass These refer to the AMS Subject Classifications, published and
9809 Mathematical Reviews
9812 These are also available online at the AMS cites listed above.
9815 \begin_layout Description
9819 \begin_layout Description
9823 \begin_layout Description
9827 \begin_layout Standard
9828 The following environments are provided by both the
9829 \begin_inset Flex Code
9832 \begin_layout Plain Layout
9839 \begin_inset Flex Code
9842 \begin_layout Plain Layout
9848 modules, in the latter case in both starred (unnumbered) and unstarred
9849 (numbered) versions.
9850 These same environments are provided only in the starred versions by the
9852 \begin_inset Flex Code
9855 \begin_layout Plain Layout
9864 \begin_layout Theorem
9865 This is typically used for the statements of major results.
9869 \begin_layout Corollary*
9870 This is used for statements which follow fairly directly from previous statement
9872 Again, these can be major results.
9877 These are smaller results needed to prove other statements.
9880 \begin_layout Proposition
9881 These are less major results which (hopefully) add to the general theory
9885 \begin_layout Conjecture
9886 These are statements provided without justification, which the author does
9887 not know how to prove, but which seem to be true (to the author, at least).
9890 \begin_layout Definition*
9891 Guess what this is for.
9892 The font is different for this environment than for the previous ones.
9896 \begin_layout Example*
9897 Used for examples illustrating proven results.
9900 \begin_layout Problem
9901 It's not really known what this is for.
9902 You should figure it out.
9905 \begin_layout Exercise*
9906 Write a description for this one.
9909 \begin_layout Remark
9910 This environment is also a type of theorem, usually a lesser sort of observation.
9913 \begin_layout Claim*
9914 Often used in the course of giving a proof of a larger result.
9918 Generally, these are used to break up long arguments, using specific instances
9924 The numbering scheme for cases is on its own, not together with other numbered
9930 At the end of this environment, a QED symbol (usually a square, but it can
9931 vary with different styles) is placed.
9932 If you want to have other environments within this one—for example, Case
9933 environments—and have the QED symbol appear only after them, then the other
9934 environments need to be nested within the proof environment.
9937 Nesting Environments
9943 for information on nesting.
9946 \begin_layout Standard
9947 And these environments are provided by
9948 \begin_inset Flex Code
9951 \begin_layout Plain Layout
9952 Theorems (AMS-Extended)
9960 \begin_layout Criterion*
9961 A required condition.
9964 \begin_layout Algorithm*
9965 A general procedure to be used.
9968 \begin_layout Axiom*
9969 This is a property or statement taken as true within the system being discussed.
9972 \begin_layout Condition*
9973 Sometimes used to state a condition assumed within the present context of
9978 Similar to a Remark.
9981 \begin_layout Notation*
9982 Used for the explanation of, yes, notation.
9985 \begin_layout Summary
9986 Do we really need to tell you?
9989 \begin_layout Acknowledgement*
9993 \begin_layout Conclusion*
9994 Sometimes used at the end of a long train of argument.
9998 Used in a way similar to Proposition, though perhaps lower on the scale.
10001 \begin_layout Standard
10002 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10005 They need to be available on your system in order to use these environments.
10008 \begin_layout Section
10016 \begin_layout Standard
10022 \begin_layout Subsection
10026 \begin_layout Standard
10027 These are the layout files for some of the journals of the American Geophysical
10029 It is assumed that you have both the AGU's own class files and AGUplus
10030 installed (everything to be found at
10031 \begin_inset Flex URL
10034 \begin_layout Plain Layout
10036 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10044 \begin_layout Subsection
10048 \begin_layout Standard
10058 They are still called this in the \SpecialChar LyX
10059 GUI, though their \SpecialChar LaTeX
10072 \begin_layout Standard
10073 Newly defined styles are
10110 These are mostly manuscript attributes and defined in the AGU class documentati
10114 \begin_layout Standard
10115 I suspect this is still badly incomplete.
10118 \begin_layout Subsection
10122 \begin_layout Standard
10139 \begin_layout Subsection
10143 \begin_layout Itemize
10146 Journal of Geophysical Research
10155 \begin_layout Standard
10156 Add your own, it isn't so hard! Look at the
10167 \begin_layout Subsection
10168 Bugs and things to remember
10171 \begin_layout Standard
10172 In order to use the new layouts, you must remember to do the following for
10176 \begin_layout Enumerate
10182 This can be done in the
10184 Layout\SpecialChar menuseparator
10189 Document\SpecialChar menuseparator
10193 (AGU articles are always in English, right? So
10197 choose a language.)
10200 \begin_layout Enumerate
10205 into the document's
10210 (Yes, this is a bug.)
10213 \begin_layout Enumerate
10214 Make sure you use the
10218 bibliography style, by entering
10222 into the second field of the Bib\SpecialChar TeX
10224 None of the standard styles will do.
10227 \begin_layout Section
10231 \begin_layout Standard
10237 \begin_layout Subsection
10241 \begin_layout Standard
10242 Broadway is for writing plays.
10243 The format is more decorative than Hollywood, and much less standardized.
10244 This format should be suitable for workshops.
10247 \begin_layout Subsection
10251 \begin_layout Standard
10252 The same as in Hollywood.
10255 \begin_layout Subsection
10259 \begin_layout Standard
10264 names as labels then cross-reference the label to insert the name.
10265 The cross-reference dialog will show the current cast of characters.
10268 \begin_layout Subsection
10269 Paper size and Margins
10272 \begin_layout Standard
10273 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10276 \begin_layout Subsection
10280 \begin_layout Standard
10281 The following environments are available.
10282 You can use broadway.bind to get the bind keys shown at the right.
10285 \begin_layout Itemize
10289 \begin_inset Newline newline
10294 You should not have to use this, but it is here for anything that does not
10298 \begin_layout Itemize
10302 \begin_inset space \hfill{}
10306 \begin_inset Newline newline
10311 Used to describe stage setting and the action.
10312 First use of speaker names in all CAPs.
10315 \begin_layout Itemize
10319 \begin_inset space \hfill{}
10323 \begin_inset Newline newline
10328 Automatically numbered.
10329 On screen it will be arabic, but will print as Roman.
10332 \begin_layout Itemize
10336 \begin_inset space \hfill{}
10340 \begin_inset Newline newline
10350 It is just centered text.
10353 \begin_layout Itemize
10357 \begin_inset space \hfill{}
10361 \begin_inset Newline newline
10366 Not automatically numbered.
10367 You supply the number.
10368 This is because I couldn't figure out how.
10371 \begin_layout Itemize
10375 \begin_inset space \hfill{}
10379 \begin_inset Newline newline
10384 A special case of Narrative to describe the setting and action as the curtain
10388 \begin_layout Itemize
10392 \begin_inset space \hfill{}
10396 \begin_inset Newline newline
10401 The speaker's (actor's) title, centered in all CAPS.
10404 \begin_layout Itemize
10408 \begin_inset space \hfill{}
10412 \begin_inset Newline newline
10417 Instructions to the speaker.
10418 The parentheses are automatically inserted.
10419 The ( will appear on screen, but both will be in the printed play.
10420 This environment is only used within
10427 \begin_layout Itemize
10431 \begin_inset space \hfill{}
10435 \begin_inset Newline newline
10440 What the Speaker says.
10443 \begin_layout Itemize
10447 \begin_inset space \hfill{}
10451 \begin_inset Newline newline
10456 The curtain comes down.
10459 \begin_layout Itemize
10463 \begin_inset space \hfill{}
10469 \begin_layout Itemize
10473 \begin_inset space \hfill{}
10479 \begin_layout Itemize
10483 \begin_inset space \hfill{}
10489 \begin_layout Standard
10493 \begin_layout Section
10497 \begin_layout Standard
10502 can be used to type letters according to German conventions.
10503 A template file is included in
10505 .../lyx/share/templates
10507 for you to use as a starting point.
10510 \begin_layout Section
10518 \begin_layout Standard
10524 \begin_layout Subsection
10528 \begin_layout Standard
10529 This is the layout file for the European Geophysical Society journals.
10534 can be downloaded from the web site of the EGS under
10535 \begin_inset Flex URL
10538 \begin_layout Plain Layout
10548 \begin_layout Subsection
10552 \begin_layout Standard
10555 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10563 The current layout file is unfortunately very unmodular and would benefit
10564 from using the various
10571 \begin_layout Section
10575 \begin_layout Standard
10576 See the \SpecialChar LyX
10582 It contains all infos you need.
10585 \begin_layout Section
10588 Foil\SpecialChar TeX
10592 \begin_inset CommandInset label
10601 \begin_layout Standard
10607 \begin_layout Subsection
10611 \begin_layout Standard
10612 This section describes how to use \SpecialChar LyX
10613 to make slides for overhead projectors.
10614 There are two document classes that can do this: the default slides class
10617 Foil\SpecialChar TeX
10621 This section documents the latter.
10624 \begin_layout Standard
10625 I'm going to say this again, nice and clear, so that there's no misunderstanding
10629 \begin_layout Standard
10630 \begin_inset VSpace bigskip
10636 \begin_layout Standard
10640 This section documents the class
10641 \begin_inset Quotes eld
10649 \begin_inset Quotes erd
10657 \begin_layout Standard
10658 \begin_inset VSpace bigskip
10664 \begin_layout Standard
10665 If you're looking for the documentation for
10666 \begin_inset Quotes eld
10674 \begin_inset Quotes erd
10677 , check out section
10678 \begin_inset space ~
10682 \begin_inset CommandInset ref
10684 reference "sec:slitex"
10689 If your machine doesn't have the
10694 \begin_inset Quotes eld
10702 \begin_inset Quotes erd
10705 ] installed, you'll probably have to use the default
10709 class, which isn't quite as good as
10714 \begin_layout Standard
10719 class is designed for use with version 2.1 of the
10724 class file which is now an integral part of \SpecialChar LaTeX2e
10728 \begin_layout Subsection
10732 \begin_layout Standard
10733 Obviously, to use this document class, you need to select
10734 \begin_inset Quotes eld
10742 \begin_inset Quotes erd
10752 \begin_inset space ~
10758 There are some settings in the
10761 \begin_inset space ~
10766 dialog that you should know about that are specific to this class:
10769 \begin_layout Itemize
10770 Don't change the options
10781 \begin_inset space ~
10787 They're ignored by the
10794 \begin_layout Itemize
10795 The default font size is 20
10796 \begin_inset space \thinspace{}
10799 pt with the other options being 17
10800 \begin_inset space \thinspace{}
10804 \begin_inset space \thinspace{}
10808 \begin_inset space \thinspace{}
10814 \begin_layout Itemize
10815 The default font is
10823 but all math equations are still typeset in the usual roman font.
10826 \begin_layout Itemize
10829 Foil\SpecialChar TeX
10832 supports A4 and Letter paper sizes as well as a special size for working
10834 \begin_inset space \thinspace{}
10838 It doesn't support A5, B5, legal or executive paper sizes.
10841 \begin_layout Itemize
10842 Don't bother changing the
10846 settings because they are ignored anyway.
10847 All floats appear where they are defined in the text.
10850 \begin_layout Itemize
10855 setting behaves a bit differently for this class.
10858 Foil\SpecialChar TeX
10861 provides extensive footer and header capabilities including a user-defined
10864 \begin_inset space ~
10868 \begin_inset CommandInset ref
10870 reference "sec:foilfoot"
10875 The title page is treated differently to all other pages in the document
10884 has the logo centered at the bottom of the page (if one is defined).
10885 The possible page style choices and what they do are as follows:
10886 \begin_inset Separator parbreak
10893 \begin_layout Labeling
10894 \labelwidthstring MMMMMMM
10901 The final output contains no page numbers, or other headers or footers
10902 (except footnotes of course).
10906 \begin_layout Labeling
10907 \labelwidthstring MMMMMMM
10914 The final output contains page numbers centered at the bottom of the page.
10915 No other headings or footers (other than footnotes).
10918 \begin_layout Labeling
10919 \labelwidthstring MMMMMMM
10924 Page numbers in lower right corner.
10925 Additional headers and footers are also shown.
10926 This is also the default.
10929 \begin_layout Labeling
10930 \labelwidthstring MMMMMMM
10935 Gives you access to the
10939 package although its use with
10941 Foil\SpecialChar TeX
10944 is discouraged by the writer of the
10946 Foil\SpecialChar TeX
10949 package because of some potential page layout clashes.
10953 \begin_layout Subsubsection
10957 \begin_layout Standard
10958 The following options may be used in the extra class options in the
10960 Document\SpecialChar menuseparator
10966 \begin_layout Labeling
10967 \labelwidthstring MMMMMMx
10972 This sets up the page layout for 7.33
10973 \begin_inset space \thinspace{}
10977 \begin_inset space \thinspace{}
10980 in paper, which is about the same aspect ratio as a 35
10981 \begin_inset space \thinspace{}
10984 mm slide, making it a bit easier to work with this medium.
10987 \begin_layout Labeling
10988 \labelwidthstring MMMMMMx
10993 Places a rule across the page below the header on every page except the
10997 \begin_layout Labeling
10998 \labelwidthstring MMMMMMx
11003 Places a rule across the page above the footer on every page except the
11007 \begin_layout Labeling
11008 \labelwidthstring MMMMMMx
11013 This is automatically set each time you create a new
11020 Foil\SpecialChar TeX
11023 to use the dvips driver to rotate those pages that are set as landscape
11027 \begin_layout Labeling
11028 \labelwidthstring MMMMMMx
11033 Simply changes the page dimensions to those of a landscape page but doesn't
11035 Thus if you use this option you need to use an external program to rotate
11036 each page or feed your paper through your printer as landscape.
11037 Note that this option effectively reverses the roles of the
11045 environments (don't worry these are described in the next section).
11048 \begin_layout Labeling
11049 \labelwidthstring MMMMMMx
11054 Equation numbers on the left.
11057 \begin_layout Labeling
11058 \labelwidthstring MMMMMMx
11063 Flush-left equations.
11066 \begin_layout Subsection
11067 Supported Environments
11070 \begin_layout Standard
11071 Most of the environments commonly supported in other classes are also supported
11077 There are several additional environments provided by
11079 Foil\SpecialChar TeX
11082 as well as a couple added by \SpecialChar LyX
11084 The following environments are shared with other classes:
11087 \begin_layout Standard
11088 \begin_inset Flex Multiple Columns
11091 \begin_layout Itemize
11097 \begin_layout Itemize
11103 \begin_layout Itemize
11109 \begin_layout Itemize
11115 \begin_layout Itemize
11121 \begin_layout Itemize
11128 \begin_layout Itemize
11134 \begin_layout Itemize
11140 \begin_layout Itemize
11146 \begin_layout Itemize
11152 \begin_layout Itemize
11158 \begin_layout Itemize
11164 \begin_layout Itemize
11170 \begin_layout Itemize
11176 \begin_layout Itemize
11182 \begin_layout Itemize
11188 \begin_layout Itemize
11194 \begin_layout Itemize
11205 \begin_layout Standard
11206 That is, all the major environments apart from the sectioning environments.
11207 Since foils are essentially self-contained sections, with a title and body,
11210 Foil\SpecialChar TeX
11213 provides specific commands for starting new foils and these are:
11216 \begin_layout Itemize
11222 \begin_layout Itemize
11228 \begin_layout Standard
11230 also provides slightly modified versions of these two environments called:
11233 \begin_layout Itemize
11239 \begin_layout Itemize
11242 ShortRotatefoilhead
11245 \begin_layout Standard
11246 and the differences will be explained in the next section.
11249 \begin_layout Standard
11250 Since foils are often used in presenting ideas or new theorems and such
11253 Foil\SpecialChar TeX
11256 also provides a comprehensive box of goodies for presenting them:
11259 \begin_layout Standard
11260 \begin_inset Flex Multiple Columns
11263 \begin_layout Itemize
11269 \begin_layout Itemize
11275 \begin_layout Itemize
11281 \begin_layout Itemize
11287 \begin_layout Itemize
11293 \begin_layout Itemize
11299 \begin_layout Itemize
11305 \begin_layout Itemize
11311 \begin_layout Itemize
11317 \begin_layout Itemize
11323 \begin_layout Itemize
11334 \begin_layout Standard
11335 The starred versions are unnumbered while the unstarred versions are numbered.
11336 There are also two list environments added by \SpecialChar LyX
11340 \begin_layout Itemize
11346 \begin_layout Itemize
11352 \begin_layout Standard
11355 Foil\SpecialChar TeX
11358 provides some powerful header and footer capabilities that are best set
11359 in the preamble although they may be set at any point in a document.
11360 If you want to change these settings in your document the best place to
11361 do so is at the very top of a foil, i.
11362 \begin_inset space \thinspace{}
11368 \begin_inset space \space{}
11373 straight after the foilhead.
11376 \begin_layout Standard
11377 For this purpose, the following command styles are provided [
11384 \begin_layout Standard
11385 \begin_inset Flex Multiple Columns
11388 \begin_layout Itemize
11392 \begin_inset space ~
11398 \begin_layout Itemize
11404 \begin_layout Itemize
11408 \begin_inset space ~
11414 \begin_layout Itemize
11418 \begin_inset space ~
11424 \begin_layout Itemize
11428 \begin_inset space ~
11434 \begin_inset Separator parbreak
11441 \begin_layout Plain Layout
11442 \begin_inset space ~
11454 \begin_layout Standard
11455 There are also a few commands provided by
11457 Foil\SpecialChar TeX
11460 that aren't directly supported by \SpecialChar LyX
11461 but I'll tell you what they do and how
11462 to use them in section
11463 \begin_inset space ~
11467 \begin_inset CommandInset ref
11469 reference "sec:unsuppfoils"
11476 \begin_layout Subsection
11477 Building a Set of Foils
11480 \begin_layout Standard
11481 This section will give a simple introduction to using the different environments
11482 to build a set of foils.
11483 If you want to see an example set of foils, take a look at the
11487 file you find in \SpecialChar LyX
11495 \begin_layout Subsubsection
11496 Give It a Title Page
11499 \begin_layout Standard
11500 Unlike other classes that provide
11520 creates the title on a page of its own.
11521 If you leave out the
11525 environment \SpecialChar LaTeX
11526 will substitute the current date (every time you regenerate
11530 \begin_layout Subsubsection
11534 \begin_layout Standard
11535 As I mentioned earlier, there are four ways of starting a new foil.
11536 For portrait foils you should use
11545 The difference between these two environments is the amount of space between
11546 the title of the foil (the foilhead) and the body of the foil.
11549 \begin_layout Standard
11550 Landscape foils are generated using the
11556 ShortRotatefoilhead
11559 Again the only difference is the spacing between foilhead and body.
11560 Both of the short versions have 0.5
11561 \begin_inset space ~
11564 inches less separation between the foilhead and the body.
11568 \begin_layout Standard
11569 One problem with the support for landscape foils is the requirement that
11570 you have to use the
11574 driver to generate the PostScript output otherwise the foils won't be rotated.
11575 It is possible to get landscape foils even if you haven't got the
11579 driver provided you can feed your foils sideways through your printer ;-)
11582 \begin_layout Subsubsection
11583 Theorems, Lemmas, Proofs and more
11586 \begin_layout Standard
11587 Due to a small bug in \SpecialChar LyX
11588 you can't have two of the same type of these environments
11589 directly following each other.
11590 They must be separated by something.
11591 If you try, you will just be extending the previous environment as if you
11592 had merged the two environments together.
11593 So, how do you get around this problem? The simplest option is to insert
11594 some text between the two environments or add a
11599 environment between the two with just a
11600 \begin_inset Quotes eld
11608 \begin_inset Quotes erd
11612 This will force \SpecialChar LyX
11613 to produce two separate environments and hence the correct
11616 An example is provided in the example file included with the \SpecialChar LyX
11618 Remember, this problem only occurs if you are trying to place two of the
11619 same type of theorem-like environments one directly after the other.
11622 \begin_layout Subsubsection
11626 \begin_layout Standard
11627 You get all the commonly supported list styles found in other classes as
11628 well as two new ones.
11629 I'll only describe the new ones here.
11630 If you want to find out more about the other list environments check out
11636 If you intend to use itemized lists you might also want to read about the
11640 \begin_inset space ~
11644 \begin_inset space ~
11649 dialog described above in section
11650 \begin_inset space ~
11654 \begin_inset CommandInset ref
11656 reference "sec:bullet"
11663 \begin_layout Standard
11664 The two new list styles,
11672 , are designed to make it easier for you to create lists of do's and don'ts
11673 or right and wrong by providing dedicated environments that use a tick
11674 or a cross as the label of the list.
11675 These lists are in fact dedicated variants of the
11680 They do however require that you have the
11684 packages installed.
11687 \begin_layout Subsubsection
11691 \begin_layout Standard
11694 Foil\SpecialChar TeX
11697 redefines the floating tables and figures so that they appear exactly where
11698 they are in the text rather than pushing them to the top of the page or
11699 to some user specified location.
11700 In fact if you change the float placement settings they are simply ignored.
11703 \begin_layout Subsubsection
11704 Page Headers and Footers
11705 \begin_inset CommandInset label
11707 name "sec:foilfoot"
11714 \begin_layout Standard
11718 \begin_inset space ~
11727 are two commands used to control the left-footer text string.
11728 The first is meant to allow you to include a graphic logo on your foils
11730 \begin_inset Quotes eld
11735 Foil\SpecialChar TeX
11739 \begin_inset Quotes erd
11743 While the second is meant to provide a classification for the audience,
11747 \begin_inset space \thinspace{}
11753 \begin_inset space \space{}
11757 It is empty by default.
11760 \begin_layout Standard
11761 The remaining page corners can be filled by
11764 \begin_inset space ~
11769 (which defaults to page numbers),
11772 \begin_inset space ~
11780 \begin_inset space ~
11788 \begin_layout Subsection
11791 Foil\SpecialChar TeX
11795 \begin_inset CommandInset label
11797 name "sec:unsuppfoils"
11804 \begin_layout Standard
11805 All the commands mentioned below need to be set in a
11815 within another environment.
11818 \begin_layout Subsubsection
11822 \begin_layout Standard
11823 All lengths are adjusted using the
11846 should be replaced by the name given to the length you want to change and
11851 is the length value.
11852 All lengths should be specified in units of length such as inches (
11864 ) or relative to some document or font-based length such as
11874 \begin_layout Standard
11875 It's possible to change the spacing between a foilhead and the body of the
11876 foil by adjusting the length specified by
11883 For example, to make
11888 \begin_inset space \space{}
11891 in closer to their bodies put the following in the preamble:
11897 foilheadskip}{-0.5in}
11900 \begin_layout Standard
11901 The spacings around floats can be adjusted by setting these lengths:
11904 \begin_layout Labeling
11905 \labelwidthstring MMMMMMMMMMM
11912 Separation between the text and the top of the float
11915 \begin_layout Labeling
11916 \labelwidthstring MMMMMMMMMMM
11923 Separation between the float and the caption
11926 \begin_layout Labeling
11927 \labelwidthstring MMMMMMMMMMM
11934 Separation between the caption and the following text
11937 \begin_layout Labeling
11938 \labelwidthstring MMMMMMMMMMM
11945 You can make the captions narrower than the surrounding text by adjusting
11947 Best done relative to
11956 \begin_layout Standard
11957 There are also several title page related lengths that you may find useful
11958 if you have a long title or several authors:
11961 \begin_layout Labeling
11962 \labelwidthstring MMMMMMMMMMM
11969 Separation from headers to
11974 \begin_layout Labeling
11975 \labelwidthstring MMMMMMMMMMM
11993 \begin_layout Labeling
11994 \labelwidthstring MMMMMMMMMMM
12008 \begin_layout Labeling
12009 \labelwidthstring MMMMMMMMMMM
12025 \begin_layout Labeling
12026 \labelwidthstring MMMMMMMMMMM
12042 \begin_layout Standard
12043 The last length related command affects all the list environments.
12054 a list environment then all the vertical spacing between the list items
12056 Note that this is a command not a length so it doesn't require
12062 like the stuff mentioned above.
12065 \begin_layout Subsubsection
12066 Headers and Footers
12069 \begin_layout Standard
12082 commands control whether the logo in the
12086 definition appear on a given page.
12093 in the preamble then none of the foils will have the logo on them.
12094 If you don't want the logo on a particular page place the
12100 directly after the foilhead of that page and the
12106 directly after the next foilhead.
12109 \begin_layout Standard
12110 If you decide to use the
12114 page style setting in the
12117 \begin_inset space ~
12122 dialog you should probably add
12132 to your preamble so headers and footers on landscape pages are correctly
12133 placed when rotated.
12134 This is due to some clashes between the page layouts provided by the
12145 \begin_layout Section
12146 Hollywood (Hollywood spec scripts)
12149 \begin_layout Standard
12155 \begin_layout Subsection
12159 \begin_layout Standard
12160 Getting the format of a Hollywood script right is a
12161 \begin_inset Quotes eld
12165 \begin_inset Quotes erd
12168 It is designed to make the readers focus on content and to be easy and
12169 familiar for the actors to read.
12170 Each page of a script should be one minute of film.
12171 Nothing goes in a script that you cannot see or hear on screen.
12172 The courier 12 pt font should be used throughout.
12176 \begin_layout Subsection
12180 \begin_layout Standard
12181 Speakers' lines should NEVER break in mid-sentence.
12182 If a speaker's lines continue over a page break, repeat the
12186 title followed by (Cont'd).
12189 \begin_layout Subsection
12193 \begin_layout Standard
12198 names as labels then cross-reference the label to insert the name.
12199 The cross-reference dialog will show the current cast of characters.
12200 You can use this to insert the speaker name in narratives also.
12203 \begin_layout Subsection
12204 Paper size and Margins
12207 \begin_layout Standard
12208 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12211 \begin_layout Subsection
12215 \begin_layout Standard
12216 The following environments are available.
12217 You can use hollywood.bind to get the bind keys shown at the right.
12220 \begin_layout Itemize
12224 \begin_inset Newline newline
12229 Used where nothing else works.
12233 \begin_layout Itemize
12239 \begin_inset space \hfill{}
12247 \begin_inset Newline newline
12250 Usually followed by something like
12251 \begin_inset Quotes eld
12254 on Sally waking up.
12255 \begin_inset Quotes erd
12261 \begin_layout Itemize
12265 \begin_inset space \hfill{}
12269 \begin_inset Newline newline
12274 Introduces a new INTERIOR camera set-up.
12275 Always followed by DAY or NIGHT, or something similar to define the lighting
12277 Everthing on this line in CAPS.
12280 \begin_layout Itemize
12284 \begin_inset space \hfill{}
12288 \begin_inset Newline newline
12293 Introduces a new EXTERIOR camera set-up.
12294 Everthing on this line in CAPS.
12297 \begin_layout Itemize
12301 \begin_inset space \hfill{}
12305 \begin_inset Newline newline
12310 The character speaking.
12313 \begin_layout Itemize
12317 \begin_inset space \hfill{}
12321 \begin_inset Newline newline
12326 Instructions to the speaker.
12327 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12329 Both will be printed.
12332 \begin_layout Itemize
12336 \begin_inset space \hfill{}
12340 \begin_inset Newline newline
12352 \begin_layout Itemize
12356 \begin_inset space \hfill{}
12360 \begin_inset Newline newline
12365 Camera movement instruction.
12367 \begin_inset space \thinspace{}
12371 \begin_inset space \space{}
12377 \begin_layout Itemize
12381 \begin_inset space \hfill{}
12387 \begin_layout Itemize
12391 \begin_inset space \hfill{}
12397 \begin_layout Itemize
12401 \begin_inset space \hfill{}
12407 \begin_layout Itemize
12411 \begin_inset space \hfill{}
12417 \begin_layout Subsection
12421 \begin_layout Itemize
12425 \begin_layout Itemize
12429 \begin_layout Itemize
12431 \begin_inset space \thinspace{}
12438 \begin_layout Itemize
12443 \begin_layout Itemize
12444 PAN — camera movement
12447 \begin_layout Itemize
12448 INSERT — cut to close-up of
12451 \begin_layout Section
12455 \begin_layout Standard
12458 Panayotis Papasotiriou
12461 \begin_layout Subsection
12465 \begin_layout Standard
12466 The ijmpc package is a set of macros that facilitates electronic manuscript
12469 International Journal of Modern Physics C
12472 Similarly, the ijmpd package is for creating manuscripts to be submitted
12475 International Journal of Modern Physics D
12478 Both journals are published by World Scientific.
12479 The corresponding document classes are named
12488 These files, together with instructions for the authors, can be downloaded
12490 \begin_inset Flex URL
12493 \begin_layout Plain Layout
12495 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12501 \begin_inset Flex URL
12504 \begin_layout Plain Layout
12506 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12512 Both packages are modified versions of the standard
12513 \begin_inset Quotes eld
12517 \begin_inset Quotes erd
12520 package, and they are almost (but not exactly) identical.
12521 Most of their features are supported by \SpecialChar LyX
12523 I have used \SpecialChar LyX
12524 successfully to write articles submitted to both journals
12525 without any problem.
12528 \begin_layout Subsection
12532 \begin_layout Standard
12533 As usual, the easiest way to write a paper is to start with a template.
12536 File\SpecialChar menuseparator
12555 This will give an (almost) empty document that includes the most common
12556 fields found in a manuscript.
12557 Simply overwrite the existing text (including the brackets,
12562 You should keep in mind the following remarks.
12565 \begin_layout Enumerate
12567 won't let you change the font size and the page style of the document,
12568 because such modifications are not allowed by both packages.
12571 \begin_layout Enumerate
12572 The language of the document should not be changed.
12573 Before previewing your paper, be sure that the babel package is not used.
12574 To do this, click on
12576 Tools\SpecialChar menuseparator
12587 checkbox in the language settings, and click on
12595 , if you wish to make this change permanent).
12598 \begin_layout Enumerate
12600 \begin_inset Quotes eld
12604 \begin_inset Quotes erd
12607 style must be used to define keywords.
12610 \begin_layout Enumerate
12611 The ijmpc package provides a style named
12612 \begin_inset Quotes eld
12615 Classification Codes
12616 \begin_inset Quotes erd
12619 , which can be used to define classification codes, such as PACS numbers.
12620 Note that this facility is not supported by the ijmpd package.
12623 \begin_layout Enumerate
12624 Several new environments are available:
12625 \begin_inset Quotes eld
12629 \begin_inset Quotes erd
12633 \begin_inset Quotes eld
12637 \begin_inset Quotes erd
12641 \begin_inset Quotes eld
12645 \begin_inset Quotes erd
12649 \begin_inset Quotes eld
12653 \begin_inset Quotes erd
12657 \begin_inset Quotes eld
12661 \begin_inset Quotes erd
12665 \begin_inset Quotes eld
12669 \begin_inset Quotes erd
12673 \begin_inset Quotes eld
12677 \begin_inset Quotes erd
12681 \begin_inset Quotes eld
12685 \begin_inset Quotes erd
12689 \begin_inset Quotes eld
12693 \begin_inset Quotes erd
12697 \begin_inset Quotes eld
12701 \begin_inset Quotes erd
12705 \begin_inset Quotes eld
12709 \begin_inset Quotes erd
12713 \begin_inset Quotes eld
12717 \begin_inset Quotes erd
12721 \begin_inset Quotes eld
12725 \begin_inset Quotes erd
12729 \begin_inset Quotes eld
12733 \begin_inset Quotes erd
12737 Their use is more or less obvious.
12739 supports all these environments; it will use the proper label, text style,
12740 and numbering scheme for each of them.
12743 \begin_layout Enumerate
12744 Both packages use basic citations; the natbib package should not be used.
12745 In \SpecialChar LyX
12746 , citation references are shown as usual; in the output, citations are
12747 shown as superscripts.
12748 If you want to use a citation as normal text, you should use the
12753 \begin_inset space \thinspace{}
12757 \begin_inset space \space{}
12761 \begin_inset Quotes eld
12765 \begin_inset space \space{}
12775 \begin_inset Quotes erd
12781 \begin_layout Enumerate
12783 \begin_inset Quotes eld
12787 \begin_inset Quotes erd
12790 section in both packages.
12791 To put acknowledgments, just use the
12792 \begin_inset Quotes eld
12796 \begin_inset Quotes erd
12802 \begin_layout Enumerate
12803 Appendices may be added to the paper,
12807 the Acknowledgments and
12813 provides a special environment, called
12814 \begin_inset Quotes eld
12818 \begin_inset Quotes erd
12821 which marks the beginning of the appendices.
12822 This environment should be left blank; it just sends a \SpecialChar LaTeX
12823 command, but nothing
12825 In \SpecialChar LyX
12827 \begin_inset Quotes eld
12831 \begin_inset Quotes erd
12834 is printed with blue letters, as a signal that all sections after that
12835 point are appendices.
12836 To write an appendix, use the
12837 \begin_inset Quotes eld
12841 \begin_inset Quotes erd
12846 will number each appendix with capital letters, as required by both journals.
12848 \begin_inset Quotes eld
12852 \begin_inset Quotes erd
12859 be present before the first appendix; if not, all appendices will be numbered
12860 as normal sections in the output.
12863 \begin_layout Enumerate
12864 The ijmpc and the ijmpd packages use the
12868 command to implement table captions.
12869 As a result, a table created by \SpecialChar LyX
12870 is printed correctly, but its caption
12872 However, you can use some \SpecialChar TeX
12873 code to overcome this problem, so that captions
12874 are printed as expected.
12875 To do so, create a float table as usual, remove the caption, and replace
12876 it with the \SpecialChar TeX
12887 (sic); you must also the \SpecialChar TeX
12892 immediately after the tabular material.
12893 Study the example table included in the template files to see how this
12894 trick is implemented.
12895 Alternatively, If you need table captions, you should implement the whole
12900 file, then include this file to the \SpecialChar LyX
12903 Insert\SpecialChar menuseparator
12904 File\SpecialChar menuseparator
12906 \begin_inset space ~
12912 Details on how to create a table float can be found in the files
12920 , included in the corresponding packages.
12923 \begin_layout Subsection
12924 Preparing a paper for submission
12927 \begin_layout Standard
12928 Before you submit your paper you must export the \SpecialChar LyX
12929 document as a \SpecialChar LaTeX
12932 File\SpecialChar menuseparator
12933 Export\SpecialChar menuseparator
12941 \begin_layout Plain Layout
12942 Actually you have the choice between \SpecialChar LaTeX
12943 (plain) and pdflatex.
12944 If you intend to use pdflatex to prepare the paper, you should use the
12945 pdflatex option so that included graphics are converted to PDF format,
12946 ready for use by pdflatex.
12951 , then make the following changes to the resulting
12958 \begin_layout Enumerate
12959 Remove the comment lines before the
12968 \begin_layout Enumerate
12969 Remove everything between (and including) the
12981 commands, except for any commands you specifically put into the \SpecialChar LaTeX
12985 \begin_layout Standard
12990 file should be saved and processed through \SpecialChar LaTeX
12991 as many times as necessary.
12992 You may also want to check the resulting
12999 \begin_layout Subsection
13000 Use of \SpecialChar TeX
13004 \begin_layout Standard
13005 The use of \SpecialChar TeX
13006 code is reduced to two commands, which must be placed at the
13007 top of the document.
13008 If you started writing your paper by using the
13016 template, the \SpecialChar TeX
13017 code needed is already in its place; you usually don't need
13019 You may only modify the first \SpecialChar TeX
13020 code to specify the information printed
13021 to the top of odd and even pages (authors' names and short paper's title,
13023 This \SpecialChar TeX
13024 code must have the form
13028 markboth{Authors' Names}{Short Paper's Title}
13033 \begin_layout Section
13037 \begin_layout Standard
13043 \begin_layout Subsection
13047 \begin_layout Standard
13048 The iopart package provides a document class to create electronic manuscript
13049 submission to the journals published by the Institute of Physics.
13050 Instructions for the authors how to create a paper using the iopart class
13051 can be downloaded together with the iopart package from the site
13052 \begin_inset Flex URL
13055 \begin_layout Plain Layout
13057 ftp://ftp.iop.org/pub/journals/latex2e
13065 \begin_layout Subsection
13069 \begin_layout Standard
13070 The easiest way to write a paper is to start with the file
13074 that is available in \SpecialChar LyX
13075 's examples files folder.
13076 Open this file, save it under a new name, and start writing.
13077 The example file explains how to use the special text environments.
13078 Here are the most important advices:
13081 \begin_layout Itemize
13082 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13085 Use AMS math package
13087 in the document settings under
13094 \begin_layout Itemize
13097 The title environment defines the kind of your paper.
13098 So use one of the following environments for the title:
13101 \begin_inset Separator parbreak
13108 \begin_layout Itemize
13117 \begin_layout Itemize
13126 \begin_layout Itemize
13132 for a Topical review
13135 \begin_layout Itemize
13144 \begin_layout Itemize
13153 \begin_layout Itemize
13159 for a Paper (same as Title)
13162 \begin_layout Itemize
13168 for a Preliminary communication
13171 \begin_layout Itemize
13177 for a Rapid communication
13180 \begin_layout Itemize
13186 for a Letter to the editor
13190 \begin_layout Itemize
13193 All title environments except of
13197 can have an optional short title.
13200 \begin_layout Itemize
13201 There is a general title environment
13205 which is not directly supported by the \SpecialChar LyX
13207 This can be used as \SpecialChar TeX
13208 code when your document doesn't fit into one of the
13212 \begin_layout Standard
13213 For more informations like hints for special table and formula formatting,
13214 look at the IOP author guidelines.
13217 \begin_layout Section
13221 \begin_layout Standard
13224 Panayotis Papasotiriou
13227 \begin_layout Subsection
13231 \begin_layout Standard
13232 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13233 that facilitates electronic manuscript submission to the journals they
13235 Most known of them (at least in my domain of interest) are
13237 Astrophysics and Space Science
13243 , but there are many others (see a complete list at
13244 \begin_inset Flex URL
13247 \begin_layout Plain Layout
13249 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13255 The Kluwer package may be downloaded from the site
13256 \begin_inset Flex URL
13259 \begin_layout Plain Layout
13261 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13267 A complete user guide is contained in that package (but it can also be
13268 downloaded separately).
13271 \begin_layout Standard
13273 supports many features of the package but not everything.
13274 However, the \SpecialChar TeX
13275 code needed is reduced to some
13276 \begin_inset Quotes eld
13280 \begin_inset Quotes erd
13283 commands of the package (see
13284 \begin_inset space ~
13288 \begin_inset CommandInset ref
13290 reference "subsec:kluwer_peculiarities"
13295 I have recently used \SpecialChar LyX
13296 to write an article submitted to the
13298 Astrophysics and Space Science
13300 without any problem.
13303 \begin_layout Subsection
13307 \begin_layout Standard
13308 The easiest way to write a paper is to start with the Kluwer template file.
13311 File\SpecialChar menuseparator
13323 This will give an (almost) empty document that includes the most common
13324 fields found in a manuscript and a short description of their use.
13325 As in most templates, simply overwrite the existing text (including the
13330 ) with the correct information.
13333 \begin_layout Subsection
13334 Preparing a paper for submission
13337 \begin_layout Standard
13338 As in the AAS\SpecialChar TeX
13339 package, before you submit your paper to a journal you must
13341 \begin_inset Quotes eld
13345 \begin_inset Quotes erd
13351 \begin_layout Enumerate
13352 Export your paper as a \SpecialChar LaTeX
13354 To do this, click on
13356 File\SpecialChar menuseparator
13357 Export\SpecialChar menuseparator
13365 \begin_layout Enumerate
13370 file with a text editor and make the following changes
13371 \begin_inset Separator parbreak
13378 \begin_layout Enumerate
13379 remove the comment lines before the
13388 \begin_layout Enumerate
13389 remove everything between (and including) the
13401 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13405 \begin_layout Standard
13414 \begin_layout Enumerate
13419 file through \SpecialChar LaTeX
13420 as many times as necessary (usually up to three).
13423 \begin_layout Enumerate
13429 \begin_inset space \thinspace{}
13433 \begin_inset space \space{}
13440 , and check if everything is OK (it should, if you didn't make any mistake).
13443 \begin_layout Subsection
13444 \begin_inset Quotes eld
13448 \begin_inset Quotes erd
13451 of the Kluwer package
13452 \begin_inset CommandInset label
13454 name "subsec:kluwer_peculiarities"
13461 \begin_layout Standard
13462 The Kluwer package has the following
13463 \begin_inset Quotes eld
13467 \begin_inset Quotes erd
13473 \begin_layout Enumerate
13474 It is possible to write multiple articles in the same \SpecialChar LaTeX
13479 \begin_layout Plain Layout
13480 I can't imagine any good reason to do this.
13486 Each article must be included in the environment
13487 \begin_inset Quotes eld
13491 \begin_inset Quotes erd
13495 Unfortunately, this environment cannot be omitted, even if you write just
13497 Therefore, each article starts with the command
13503 and, obviously, ends with the command
13510 Although this can be implemented in \SpecialChar LyX
13511 , I didn't included it, since it looks
13512 ugly and can confuse the novice user.
13513 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13516 \begin_inset Quotes eld
13521 \begin_inset Quotes erd
13527 \begin_layout Enumerate
13528 Information given at the beginning of the article (i.
13529 \begin_inset space \thinspace{}
13533 \begin_inset space \space{}
13536 title, subtitle, author, institution, running title, running author, abstract
13537 and keywords) must be included in an environment called
13538 \begin_inset Quotes eld
13542 \begin_inset Quotes erd
13546 This is not implemented in \SpecialChar LyX
13547 , so you must enter title, subtitle etc.
13548 \begin_inset space ~
13551 between two \SpecialChar TeX
13567 \begin_layout Enumerate
13568 According to the user manual, the label of each bibliography item must be
13592 \begin_layout Standard
13597 template takes care of all these
13598 \begin_inset Quotes eld
13602 \begin_inset Quotes erd
13606 If you start a new paper using this template you don't need to do anything
13611 \begin_layout Enumerate
13612 don't delete the \SpecialChar TeX
13613 code included in the template, and
13616 \begin_layout Enumerate
13617 copy the example bibliography item included in the template and modify it
13618 as necessary to enter new bibliography items.
13621 \begin_layout Section
13625 \begin_layout Standard
13631 \begin_layout Subsection
13635 \begin_layout Standard
13636 The \SpecialChar LyX
13639 article (koma-script)
13643 report (koma-script)
13661 correspond to the \SpecialChar LaTeX
13679 \begin_inset space ~
13682 of the Koma-Script family.
13683 They are replacements for the standard document classes
13699 , resp., and fit better to European typography conventions in a number of
13703 \begin_layout Itemize
13704 Standard character size is 11pt in
13706 article (koma-script)
13710 report (koma-script)
13718 letter (koma-script)
13723 \begin_layout Itemize
13724 Headings, labels of the description environment, and a number of elements
13727 letter (koma-script)
13729 document class are set in a bold sans serif font.
13733 \begin_layout Plain Layout
13734 There is a big difference between the bold sans serif old cm fonts and new
13735 ec fonts, especially in the appearance of headings.
13736 In comparison, the ec bold sans serif fonts look a bit thin.
13737 Here the \SpecialChar LaTeX
13746 helps to produce the
13747 \begin_inset Quotes eld
13751 \begin_inset Quotes erd
13754 appearance when using the ec fonts.
13759 The numbering of chapter headings is made in the same way as the numbering
13760 of section headings, that is without the extra line
13761 \begin_inset Quotes eld
13764 Chapter\SpecialChar ldots
13766 \begin_inset Quotes erd
13770 In addition, the appearance of the headings can be modified by using a
13771 number of options (in \SpecialChar LyX
13772 to be entered in the field
13775 \begin_inset space ~
13782 Layout\SpecialChar menuseparator
13789 \begin_layout Itemize
13790 The main means in the Koma-Script document classes to design the type area
13799 (in \SpecialChar LyX
13800 to be entered in the extra class options field in the dialog
13802 Document\SpecialChar menuseparator
13806 They make a clearer modification of page margins possible as do the options
13809 Document\SpecialChar menuseparator
13816 \begin_layout Itemize
13817 The \SpecialChar LaTeX
13818 document classes of the Koma-Script family define a number of additional
13820 Those part of it which makes sense in \SpecialChar LyX
13821 is implemented in corresponding
13825 \begin_layout Standard
13826 Detailed descriptions of the \SpecialChar LaTeX
13827 document classes of the Koma-Script family
13828 can be found in the Koma-Script documentation
13839 \begin_layout Subsection
13840 article (koma-script), report (koma-script), and book (koma-script)
13843 \begin_layout Standard
13844 The document classes
13846 article (koma-script)
13850 report (koma-script)
13860 are implemented in the layout files
13873 They contain all the paragraph types of the corresponding standard document
13886 , resp., partly modified, with the exception of the \SpecialChar LyX
13891 -type, which is replaced by the new
13895 -type having the same functionality.
13900 -Type there is a number of new paragraph types added.
13907 letter (koma-script)
13912 \begin_layout Itemize
13921 : are equivalents to
13929 , resp., additionally inserting an entry in the table of contents.
13938 are not contained in
13940 article (koma-script)
13945 \begin_layout Itemize
13954 : behave exactly as
13962 , resp., additionally clearing running heads.
13967 is not contained in
13969 article (koma-script)
13975 \begin_layout Plain Layout
13988 report (koma-script)
13990 , but since this is identical to
13994 , is has not been implemented in \SpecialChar LyX
14003 \begin_layout Itemize
14008 : generates a heading directly above the following paragraph in the standard
14009 character size without affecting the structure of the document.
14012 \begin_layout Itemize
14021 are special captions which respect the different space settings needed
14022 for captions placed above or below an element (if you follow strict typographic
14023 rules, you might want to place table captions always above the table).
14024 You can also use the class option
14028 , which will switch
14041 You need at least Koma-Script version 2.8q to use this.
14044 \begin_layout Itemize
14049 : can be used to set a bonmot, e.
14050 \begin_inset space \thinspace{}
14054 \begin_inset space \space{}
14057 at the beginning of a chapter.
14058 If you use the optional argument (
14060 Insert\SpecialChar menuseparator
14062 \begin_inset space ~
14067 ), you can insert the dictum's author there.
14068 Dictum and author are separated by a line.
14069 You need at least Koma-Script version 2.8q to use this.
14074 is not contained in
14076 article (koma-script)
14081 \begin_layout Standard
14082 The following types, together with the standard types
14094 , form the title area of the document.
14095 They must be entered ahead of the first
14096 \begin_inset Quotes eld
14100 \begin_inset Quotes erd
14107 \begin_layout Plain Layout
14108 The corresponding \SpecialChar LaTeX
14109 commands must appear before the
14120 When such a type is used more than once, the latter usage overwrites the
14121 former one, that means, for every type only the latest usage is valid.
14122 The order of the different types however has, like
14134 , no effect on the appearance of the produced document.
14137 \begin_layout Itemize
14142 : produces a centered paragraph above the ordinary title (
14154 ) for the subject of the document.
14157 \begin_layout Itemize
14162 : produces a centered paragraph below the ordinary title (
14174 ) for the publishers' name.
14177 \begin_layout Itemize
14184 report (koma-script)
14190 produces a centered paragraph on its own page behind the title page, or
14193 article (koma-script)
14195 produces a centered paragraph below the ordinary title (
14211 ) for a dedication.
14214 \begin_layout Itemize
14219 : produces a left aligned paragraph above the ordinary title (
14235 ) for a document`s head.
14238 \begin_layout Itemize
14243 : produces in a double-sided print in
14245 report (koma-script)
14251 a left-aligned paragraph at the top of the title page`s back or has no
14252 effect in a single-sided print or in
14254 article (koma-script)
14259 \begin_layout Itemize
14264 : produces in a double-sided print in
14266 report (koma-script)
14272 a left-aligned paragraph at the bottom of the title page`s back or has
14273 no effect in a single-sided print or in
14275 article (koma-script)
14280 \begin_layout Itemize
14285 : produces a special
14286 \begin_inset Quotes eld
14290 \begin_inset Quotes erd
14293 page ahead of the actual document containing a paragraph without special
14297 \begin_layout Standard
14298 The layout files for the document classes
14300 article (koma-script)
14304 report (koma-script)
14310 do include the file
14315 This is thought of as a place to define your own types.
14320 in your personal layout directory and edit the file!
14323 \begin_layout Subsection
14324 letter (koma-script)
14327 \begin_layout Standard
14331 letter (koma-script)
14333 is implemented in the layout file
14338 It contains all the paragraph types of the corresponding standard document
14343 , partly modified, with the exception of the \SpecialChar LyX
14357 type, which is replaced by the new
14362 In addition, it contains, in contrast to the standard document class, the
14381 Furthermore, there are a number of new letter specific types.
14384 \begin_layout Standard
14385 The appearance of the letter produced by this document class can be controlled
14386 by a number of \SpecialChar LaTeX
14387 commands, which you can put in the \SpecialChar LaTeX
14392 \begin_layout Plain Layout
14393 For example, the standard appearance of the letter`s heading, consisting
14394 of name and address, is quite self-willed.
14396 \begin_inset Quotes eld
14400 \begin_inset Quotes erd
14403 heading is produced by the following \SpecialChar LaTeX
14404 commands in the preamble:
14407 \begin_layout LyX-Code
14417 \begin_layout LyX-Code
14433 \begin_layout LyX-Code
14443 \begin_layout LyX-Code
14463 A detailed German description of such \SpecialChar LaTeX
14464 commands can be found in the Koma-Script
14470 With it, the letter's author can produce his personal letter layout.
14473 \begin_layout Standard
14482 define the beginning of the letter and must be used in every letter.
14483 To emphasize them in the \SpecialChar LyX
14484 document class, they are marked with the letter
14494 \begin_inset space ~
14497 in the left margin.
14498 It is possible to write any number of letters in one file.
14503 type produces a new letter using the same addressee and a
14507 type produces a new addressee.
14524 are ordinary paragraph types and can also be used several times in one
14525 and the same letter.
14528 \begin_layout Itemize
14533 : produces a paragraph for the addressee and implicitly defines the beginning
14537 \begin_layout Itemize
14542 : produces a paragraph for the form of address and implicitly produces a
14546 \begin_layout Itemize
14551 : produces a paragraph for a close.
14554 \begin_layout Itemize
14559 : produces a paragraph for a postscript.
14562 \begin_layout Itemize
14567 : produces a paragraph for a distribution list.
14570 \begin_layout Itemize
14575 : produces a paragraph for enclosures.
14578 \begin_layout Standard
14619 are input types provided with a label to enter information, which will
14620 be processed by the document class.
14624 \begin_layout Plain Layout
14625 It could be seen as a matter of inconsequence, that the types
14633 described above are not such input types as well.
14634 Because of the special meaning of those types, however, I have implemented
14635 them as ordinary paragraph types with a one letter mark in the left margin.
14636 Moreover, it would affect my feeling of symmetry, if the
14644 type had such a serious different appearance.
14649 The types must be used ahead of the corresponding
14656 \begin_layout Standard
14657 An implementation of these types in a WYSIWYG fashion does not seem to make
14658 sense, because the real appearance of the produced letter does not only
14659 depend on the usage of the particular type, but also on other factors.
14660 For example, a signature entered in the
14664 type will in the standard behavior appear in the produced letter only,
14665 when in the same letter also a
14670 The entered value of the
14674 type will in the standard behavior not appear in the produced letter at
14676 The possibility to design the letter`s heading freely is already indicated
14677 in a footnote above.
14680 \begin_layout Standard
14681 The input types can also be used as empty paragraphs.
14682 This makes sense e.
14683 \begin_inset space \thinspace{}
14687 \begin_inset space \space{}
14699 type is not used at all, in the standard behavior the value of the
14703 type is used as signature, whereas if an empty
14707 type is used, no signature value is defined.
14710 \begin_layout Standard
14711 By using the input types it is possible to write a letter template, containing
14712 filled input types with your personal dates (name, address, etc.) and empty
14713 input types for other dates you want to enter.
14716 \begin_layout Itemize
14721 : sender's name, in the standard behavior appears as a centered paragraph
14722 in small caps in the letter`s heading.
14725 \begin_layout Itemize
14730 : sender's signature, in the standard behavior appears below the
14739 type is used, the value of the
14743 type appears instead.
14746 \begin_layout Itemize
14751 : sender's address, in the standard behavior appears in a centered paragraph
14752 in the letter`s heading below the sender's name.
14755 \begin_layout Itemize
14760 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
14771 \begin_layout Itemize
14776 : place of the letter`s making.
14779 \begin_layout Itemize
14784 : date of the letter`s making.
14793 , in the standard behavior, produce the place and the date in a right-aligned
14794 line below the addressee's field.
14799 type is used, neither place nor date appear, independent of the value of
14809 type is used, the date of the letter `s production is used.
14812 \begin_layout Itemize
14817 : sender`s back address, in the standard behavior appears above the addressee's
14818 field in a small sans serif font.
14821 \begin_layout Itemize
14826 : special mail information, in the standard behavior appears underlined
14827 above the addressee's field below the back address.
14830 \begin_layout Itemize
14835 : additional information, in the standard behavior appears on right side
14836 below the addressee`s field.
14839 \begin_layout Itemize
14844 : the letter's title, in the standard behavior appears in a big, bold, sans
14845 serif font above the subject.
14848 \begin_layout Itemize
14853 : the letter's subject, in the standard behavior appears in a bold font
14861 \begin_layout Standard
14882 produce a business letter like line above the
14886 line containing the fields
14887 \begin_inset Quotes eld
14891 \begin_inset Quotes erd
14895 \begin_inset Quotes eld
14899 \begin_inset Quotes erd
14903 \begin_inset Quotes eld
14907 \begin_inset Quotes erd
14911 \begin_inset Quotes eld
14915 \begin_inset Quotes erd
14919 \begin_inset Quotes eld
14923 \begin_inset Quotes erd
14927 \begin_inset Quotes eld
14931 \begin_inset Quotes erd
14935 For the date field, the value of the
14941 \begin_inset Quotes eld
14944 business letter types
14945 \begin_inset Quotes erd
14948 is used, the value of the
14952 type however does not appear, but only the \SpecialChar LaTeX
14960 The ordinary output of place and date in a right-aligned line below the
14961 addressee`s field is suppressed.
14962 The types are implemented as input types provided with a label and must
14963 be used ahead of the corresponding
14970 \begin_layout Itemize
14978 \begin_layout Itemize
14986 \begin_layout Itemize
14994 \begin_layout Itemize
15002 \begin_layout Itemize
15010 \begin_layout Subsection
15011 The new letter class: letter (koma-script v.2)
15014 \begin_layout Standard
15020 \begin_layout Standard
15021 \begin_inset VSpace medskip
15027 \begin_layout Standard
15029 Koma-Script version 2.8 has introduced a new letter class
15033 which supersedes the now unsupported
15038 It has — on the \SpecialChar LaTeX
15039 side — a completely new interface and is not compatible
15040 with the old class.
15041 Therefore, \SpecialChar LyX
15042 supports both, though it is recommended you use the new class.
15045 \begin_layout Standard
15046 This class covers the same functionality as
15048 letter (koma-script),
15051 The basic items are
15055 (receiver's address, same as
15059 in the old layout),
15072 will start a new letter (i.
15073 \begin_inset space \thinspace{}
15077 \begin_inset space \space{}
15080 you can write several letters per document).
15081 New elements are sender's
15097 and the possibility to use a
15103 Insert\SpecialChar menuseparator
15109 \begin_layout Standard
15110 The biggest improvement is, though, that the letter's layout is configurable
15111 to meet almost any needs.
15112 This can be done via the preamble or with a special style file (Letter
15113 Class Option, extension
15117 ), that will be read in as a class option.
15121 \begin_layout Plain Layout
15122 The KOMA package comes with some default
15127 There is, for instance, a
15131 file that follows german typesetting rules, or a
15135 that provides the default layout of the old
15140 The latter can be loaded with the class option
15149 ayout\SpecialChar menuseparator
15154 ocument\SpecialChar menuseparator
15166 template that is included in \SpecialChar LyX
15168 A detailed description is to be found in the Koma-Script documentation
15176 \begin_layout Subsection
15180 \begin_layout Standard
15181 Visualizing the Koma-Script document classes in \SpecialChar LyX
15182 , the \SpecialChar LyX
15183 internals cause some
15187 \begin_layout Itemize
15188 The chapter number of a
15192 type appears on a line of its own above the chapter heading instead of
15193 appearing in the same line ahead of it.
15194 The cause for that is the \SpecialChar LyX
15195 internal behavior for the labeltype
15199 in the layout file.
15202 \begin_layout Itemize
15203 The headings of the types
15211 are only put in the
15212 \begin_inset Quotes eld
15216 \begin_inset Quotes erd
15220 table of contents, but not in the \SpecialChar LyX
15221 table of contents (
15223 Document\SpecialChar menuseparator
15225 \begin_inset space ~
15229 \begin_inset space ~
15237 \begin_layout Itemize
15238 The paragraphs in a
15242 document class appear in a skip separation mode, not indented.
15243 This is the standard behavior, no special \SpecialChar LaTeX
15244 commands are needed for that.
15247 Document\SpecialChar menuseparator
15250 dialog the corresponding radio button indicates
15259 value always has the effect that extra \SpecialChar LaTeX
15260 commands are inserted in the document
15261 to produce the gap, which is not what is wanted in this case.
15264 \begin_layout Section
15268 \begin_layout Standard
15274 \begin_layout Subsection
15278 \begin_layout Standard
15279 Memoir is a very powerful and constantly evolving class.
15280 It has been designed with regard to fictional and non-fictional literature.
15281 Its aim is to let the user have maximum control over the typesetting of
15283 Memoir is based on the standard book class, but it can also emulate the
15284 article class (see below).
15287 \begin_layout Standard
15288 Peter Wilson, the developer of Memoir, is known as the author of lots of
15289 useful packages in the \SpecialChar LaTeX
15291 Most of them have been merged with Memoir.
15292 Therefore, it is much easier to layout the table of contents, appendices,
15293 chapter designs and such.
15295 , though, does not support all of these goodies natively.
15296 Some of them might be added to forthcoming releases
15300 \begin_layout Plain Layout
15301 You are invited to send suggestions to
15302 \begin_inset Flex URL
15305 \begin_layout Plain Layout
15307 lyx-devel@lists.lyx.org
15317 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15319 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15321 commands (\SpecialChar TeX
15326 \begin_layout Plain Layout
15331 \begin_layout Plain Layout
15341 \begin_inset space ~
15345 \begin_inset CommandInset ref
15347 reference "sec:Inserting-TeX-Code"
15357 In this section, we can only list those features that are natively supported
15358 by \SpecialChar LyX
15360 For detailed descriptions (and for the rest of features) we recommend you
15361 have a look at the detailed manual of the Memoir class
15365 \begin_layout Plain Layout
15370 \begin_layout Plain Layout
15380 \begin_inset Flex URL
15383 \begin_layout Plain Layout
15385 CTAN:/macros/latex/memoir/memman.pdf
15395 , which is not only a user guide for the class, but also both a comprehensive
15396 description on good typesetting and a superb example for good typesetting
15400 \begin_layout Subsection
15401 Basic features and restrictions
15404 \begin_layout Standard
15405 Memoir supports basically all features of the standard book classes.
15406 There are, however, some differences, as follows:
15409 \begin_layout Description
15411 \begin_inset space ~
15414 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15417 \begin_layout Description
15419 \begin_inset space ~
15422 style: The fancy page style is not supported, due to a command clash between
15423 Memoir and the fancyhdr package (they both define a command with the same
15424 name, which confuses \SpecialChar LaTeX
15426 Instead, Memoir comes with a number of its own page styles (see
15428 Layout\SpecialChar menuseparator
15429 Document\SpecialChar menuseparator
15431 \begin_inset space ~
15437 If you want to use these for the chapter pages, you have to use the command
15444 in the main text or in preamble (e.
15445 \begin_inset space \thinspace{}
15449 \begin_inset space \space{}
15456 chapterstyle{companion}
15461 \begin_layout Description
15462 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15463 optional argument in the standard classes.
15464 With this, you can specify an alternative version of the title for the
15465 table of contents and the headers (for instance, if the title is too long).
15466 In \SpecialChar LyX
15467 , you can do this via
15469 Insert\SpecialChar menuseparator
15471 \begin_inset space ~
15476 at the beginning of a chapter/section.
15477 Memoir features a second optional argument and thus separates the table
15478 of contents from the header.
15479 You can define three variants of a title with this: one for the main text,
15480 one for the table of contents, and one for the headers.
15481 Simply insert two optional arguments if you need this feature, the first
15482 one containing the short title for the Table of Contents, the second one
15483 containing an alternative short title for the headers.
15486 \begin_layout Description
15487 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15488 of contents, the list of figures and the list of table start a new page
15490 Memoir does not follow this route.
15491 You have to insert a page break yourself, if you want to have one.
15494 \begin_layout Description
15495 Titlepage: For some unknown reason, Memoir uses pagination on the title
15496 page (in the standard classes, title pages are
15497 \begin_inset Quotes eld
15501 \begin_inset Quotes erd
15505 If you want an empty title page, type
15509 aliaspagestyle{title}{empty}
15514 \begin_layout Description
15515 Article: With the class option
15521 Layout\SpecialChar menuseparator
15522 Document\SpecialChar menuseparator
15524 \begin_inset space ~
15529 ), you can emulate article style.
15530 That is, counters (footnotes, figures, tables etc.) will not be reset on
15531 new chapters, chapters don't start a new page (but are—in contrary to
15532 \begin_inset Quotes eld
15536 \begin_inset Quotes erd
15539 article classes—still allowed), parts, though, use their own page, as in
15543 \begin_layout Description
15544 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15545 font commands, which have been used in the old \SpecialChar LaTeX
15547 \begin_inset space \thinspace{}
15551 \begin_inset space \space{}
15567 It produces an error and stops \SpecialChar LaTeX
15568 whenever such a command appears.
15573 reallows the commands and spits out warnings instead (which does at least
15574 not stop \SpecialChar LaTeX
15576 Since a lot of packages and particularly Bib\SpecialChar TeX
15577 style files are still using
15578 those commands, we have decided to use this option by default.
15581 \begin_layout Subsection
15585 \begin_layout Standard
15586 We will only describe the features supported by \SpecialChar LyX
15587 (which is not much currently).
15588 Please consult the Memoir manual
15592 \begin_layout Plain Layout
15597 \begin_layout Plain Layout
15607 \begin_inset Flex URL
15610 \begin_layout Plain Layout
15612 CTAN:/macros/latex/memoir/memman.pdf
15625 \begin_layout Description
15626 Abstract: You may wonder why an abstract is an extra feature.
15627 Well, it is in book class.
15628 Usually books don't have abstracts.
15629 Memoir, however, has.
15630 You can use it wherever and how often you like.
15633 \begin_layout Description
15634 Chapterprecis: You may know this older typesetting style: The contents of
15635 a chapter are summarized below the title and also in the table of contents
15637 \begin_inset space \thinspace{}
15641 \begin_inset space \space{}
15646 Our hero arrives in Troia; he loses some friends; he finds others
15649 Chapterprecis does exactly this.
15650 It is therefore only sensible below a chapter.
15653 \begin_layout Description
15654 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15655 The epigraph environment provides an elegant way of typesetting such a
15657 The motto itself (text) and its author (source) are divided by a short
15659 Unfortunately, we have to fool \SpecialChar LyX
15660 a bit here again, since the environment
15661 needs two arguments (text and source).
15662 In this case, we have to use curly brackets (in \SpecialChar TeX
15663 mode) between the two
15674 <author of the slogan>.
15677 \begin_layout Description
15678 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15679 complex figurative poems).
15681 can only support a few of them.
15682 One is poemtitle, which is a centered title for poems, which will also
15683 be added to the table of contents (verse is the standard environment for
15685 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
15687 because they have to be nested inside regular verse environments, which
15688 is not possible with \SpecialChar LyX
15692 \begin_layout Description
15693 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15696 \begin_layout Section
15697 Article (mwart), book (mwbk) and report (mwrep)
15698 \begin_inset Argument status
15701 \begin_layout Plain Layout
15714 \begin_layout Standard
15720 \begin_layout Standard
15721 The \SpecialChar LyX
15738 correspond to the \SpecialChar LaTeX
15752 They are replacements for the standard document classes
15764 , resp., and fit better to Polish typography conventions in a number of points.
15768 \begin_layout Standard
15772 \begin_layout Itemize
15773 Unnumbered titles (with star, e.
15774 \begin_inset space \thinspace{}
15778 \begin_inset space \space{}
15785 ) are added into table of contents,
15788 \begin_layout Itemize
15789 Additional page styles:
15790 \begin_inset Separator parbreak
15797 \begin_layout Description
15798 uheadings header with separated lines,
15801 \begin_layout Description
15802 myheadings custom header, contents headers via commands:
15817 \begin_layout Description
15818 myuheadings custom header with separated lines,
15821 \begin_layout Description
15822 outer page number is placed on outer side of page
15826 \begin_layout Itemize
15828 \begin_inset Separator parbreak
15835 \begin_layout Description
15836 rmheadings serif titles — default,
15839 \begin_layout Description
15840 sfheadings sansserif titles,
15843 \begin_layout Description
15844 authortitle on title page first placed is author next title — default,
15847 \begin_layout Description
15848 titleauthor on title page first placed is title next author,
15851 \begin_layout Description
15852 withmarginpar reserve place on page for margins.
15856 \begin_layout Section
15860 \begin_layout Standard
15865 provides an alternative to the standard
15870 It provides similar functionality, but you might prefer this layout with
15871 sans serif sections, headings, and more.
15874 \begin_layout Section
15875 Rev\SpecialChar TeX
15879 \begin_layout Standard
15885 \begin_layout Standard
15886 \begin_inset VSpace bigskip
15892 \begin_layout Standard
15897 \begin_inset space ~
15902 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
15904 \begin_inset Formula $\beta$
15907 release of May, 1999) class.
15910 \begin_layout Standard
15916 textclass, which works with Rev\SpecialChar TeX
15918 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
15920 That means that it doesn't interact very well with \SpecialChar LyX
15921 , which requires \SpecialChar LaTeX2e
15923 it has been kludged to work.
15924 Since Rev\SpecialChar TeX
15925 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
15930 Rev\SpecialChar TeX
15932 \begin_inset space ~
15937 textclass should also be pretty easy to use.
15940 \begin_layout Standard
15941 These documents are supposed to be used in
15945 to the Rev\SpecialChar TeX
15946 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
15948 and assume you'll know what to put in the preamble if necessary.
15951 \begin_layout Subsection
15955 \begin_layout Standard
15956 All you need to do is install Rev\SpecialChar TeX
15957 4, as described in the package's README
15959 The package can be found at The Rev\SpecialChar TeX
15961 \begin_inset Flex URL
15964 \begin_layout Plain Layout
15966 http://publish.aps.org/revtex4/
15972 Install it somewhere that \SpecialChar LaTeX
15974 Test it by trying to \SpecialChar LaTeX
15975 a short Rev\SpecialChar TeX
15976 4 document in some random directory (i.
15977 \begin_inset space \thinspace{}
15981 \begin_inset space \space{}
15984 not the directory where you installed the class file.) Then, if you reconfigure
15986 , it will find the class file and let you use the Rev\SpecialChar TeX
15990 \begin_layout Standard
15991 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16000 \begin_inset space ~
16005 template, found in the templates directory.
16008 \begin_layout Subsection
16012 \begin_layout Standard
16013 Optional arguments to
16020 \begin_inset Quotes eld
16024 \begin_inset Quotes erd
16028 \begin_inset Quotes eld
16032 \begin_inset Quotes erd
16042 \begin_inset space ~
16050 \begin_inset space ~
16056 Remember that in Rev\SpecialChar TeX
16057 , at least one optional argument is required!
16060 \begin_layout Standard
16061 Other preamble matter, like
16068 \begin_inset space ~
16075 \begin_inset space ~
16080 dialog, also as usual.
16083 \begin_layout Subsection
16087 \begin_layout Standard
16088 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16090 For example, the Email layout corresponds to
16097 Note that (at least as of Rev\SpecialChar TeX
16106 layouts are exactly equivalent, so you shouldn't need to use both.
16110 \begin_layout Plain Layout
16111 In case you're curious, both were included so that
16115 would be able to translate both
16135 \begin_layout Subsection
16139 \begin_layout Standard
16140 There are a couple of important unique aspects of Rev\SpecialChar TeX
16141 4 which might cause
16142 bugs that will be even more confusing in \SpecialChar LyX
16146 \begin_layout Standard
16147 In Rev\SpecialChar TeX
16165 The \SpecialChar LyX
16166 equivalent is that there is a separate Thanks layout.
16171 write footnotes in the
16175 layout, or weird things may happen.
16176 See the Rev\SpecialChar TeX
16177 4 documentation for more details.
16180 \begin_layout Standard
16184 \begin_inset space ~
16192 \begin_inset space ~
16201 layouts must be placed
16209 layout and the corresponding
16226 , the \SpecialChar LaTeX
16230 \begin_layout Subsection
16234 \begin_layout Standard
16235 The main problem with this layout is that you can't use the optional arguments
16236 to layouts like Email and Title.
16237 (The problem is not unique to this layout; you can't use optional arguments
16238 to the Section layouts either.) This means that after you export that file
16239 to \SpecialChar LaTeX
16240 (which you'll need to do eventually to send it in to APS), you'll need
16241 to edit the \SpecialChar LaTeX
16242 file with a text editor to add the optional arguments to set,
16244 \begin_inset space \thinspace{}
16248 \begin_inset space \space{}
16251 the running title for the page headers.
16252 Lacking these layouts makes the
16258 (and the equivalent
16264 ) useless, so the corresponding layouts don't exist, and will have to be
16269 \begin_layout Plain Layout
16274 actually, \SpecialChar LyX
16275 1.3.0 supports some forms of optional arguments, but this layout
16276 has not been updated yet to take advantage of it.
16284 \begin_layout Section
16285 Springer Journals (
16292 \begin_layout Standard
16298 \begin_layout Subsection
16302 \begin_layout Standard
16303 These are the layout files for some of the journal formats used by Springer
16304 Verlag and listed on
16305 \begin_inset Flex URL
16308 \begin_layout Plain Layout
16310 http://www.springer.de/author/tex/help-journals.html
16315 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16317 It is a modular system: the things common to all journals are implemented
16322 , which journal-specific layout files (such as, e.
16323 \begin_inset space \thinspace{}
16327 \begin_inset space \space{}
16334 for Journal of Geodesy) can include.
16337 \begin_layout Standard
16338 This means that implementing support for any other Springer journal on this
16339 list is as simple as writing your own
16347 file following the outline given in
16355 \begin_layout Standard
16356 It is reasonably well tested only for the Journal of Geodesy.
16365 come with the standard \SpecialChar LyX
16367 Install the relevant class file (downloaded from Springer) in a proper
16368 directory, reconfigure \SpecialChar LaTeX
16369 (in the te\SpecialChar TeX
16374 , as root if necessary — doesn't \SpecialChar LyX
16375 take care of this?), reconfigure \SpecialChar LyX
16380 \begin_layout Subsection
16384 \begin_layout Standard
16385 A large number of theorem-like styles —
16397 \begin_layout Standard
16400 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16401 _Title, Author_Running, Institute,
16402 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16405 See the Springer class file documentation for details.
16408 \begin_layout Subsection
16412 \begin_layout Itemize
16424 \begin_layout Itemize
16427 Probability Theory and Related Fields
16433 — Jean-Marc Lasgouttes
16436 \begin_layout Standard
16437 Add your own, it isn't so hard!
16440 \begin_layout Subsection
16444 \begin_layout Standard
16445 These files are partly based on the older
16449 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16451 file from Springer.
16456 layout, are now defunct.
16457 Jean-Marc Lasgouttes helped out big in making me find my way around the
16459 layout file mechanism.
16462 \begin_layout Subsection
16466 \begin_layout Standard
16468 But probably less than in the old hacked-\SpecialChar LaTeX
16476 \begin_layout Standard
16478 \begin_inset space \thinspace{}
16481 g.: does not display the number for theorem-like layouts, just #.
16484 \begin_layout Section
16487 Sli\SpecialChar TeX
16491 \begin_inset CommandInset label
16500 \begin_layout Standard
16508 \begin_layout Subsection
16512 \begin_layout Standard
16513 This section describes how to use \SpecialChar LyX
16514 to make slides for overhead projectors.
16515 There are two document classes that can do this: the default slides class
16518 Foil\SpecialChar TeX
16522 This section documents the former.
16525 \begin_layout Standard
16526 I'm going to say this again, nice and clear, so that there's no misunderstanding
16530 \begin_layout Standard
16531 \begin_inset VSpace bigskip
16537 \begin_layout Standard
16541 This section documents the class
16542 \begin_inset Quotes eld
16550 \begin_inset Quotes erd
16558 \begin_layout Standard
16559 \begin_inset VSpace bigskip
16565 \begin_layout Standard
16566 If you're looking for the documentation for
16567 \begin_inset Quotes eld
16572 slides (Foil\SpecialChar TeX
16576 \begin_inset Quotes erd
16579 , check out section
16580 \begin_inset space ~
16584 \begin_inset CommandInset ref
16586 reference "sec:foiltex"
16596 \begin_inset Quotes eld
16601 slides (Foil\SpecialChar TeX
16605 \begin_inset Quotes erd
16608 ] is actually somewhat better than the default
16616 \begin_layout Plain Layout
16618 or so I've been told repeatedly by its advocates.
16619 Having never used it, I have no idea if this claim is true or not.
16624 which this section documents.
16627 \begin_layout Standard
16628 This class is the \SpecialChar LaTeX2e
16629 improvement of the old
16631 Sli\SpecialChar TeX
16635 Every \SpecialChar LaTeX2e
16636 distribution includes this class [which I'll just refer to as
16637 \begin_inset Quotes eld
16645 \begin_inset Quotes erd
16648 from now on], so you're bound to have it.
16649 As I noted earlier, there are other classes, such as
16653 , which also produce slides for overhead projectors and do a better job
16655 However, there are some things which
16659 can do which the others can't, such as generate overlays.
16660 Read on to learn more!
16663 \begin_layout Subsection
16665 \begin_inset CommandInset label
16667 name "sec:slidesetup"
16674 \begin_layout Standard
16675 Obviously, to use this document class, you need to select
16676 \begin_inset Quotes eld
16684 \begin_inset Quotes erd
16687 from the class list in the
16689 Document\SpecialChar menuseparator
16693 There are some other special things you should know about this class:
16696 \begin_layout Itemize
16697 Don't bother changing the options
16702 They're not supported by the
16709 \begin_layout Itemize
16713 \begin_inset space ~
16718 behaves a bit differently for this class.
16719 The possible choices and what they do are as follows:
16720 \begin_inset Separator parbreak
16727 \begin_layout Description
16732 The final output contains page numbers in the lower right corner.
16735 \begin_layout Description
16744 , but also prints out any time markers you've put in.
16745 This is the default.
16748 \begin_layout Description
16753 The final output contains no page numbers, time markers, or alignment markers.
16757 \begin_layout Itemize
16762 class has an extra option:
16768 \begin_inset Quotes eld
16776 \begin_inset Quotes erd
16779 in the extra class options.
16780 \begin_inset Separator parbreak
16787 \begin_layout Standard
16788 Using this options allows you to add time markers to
16794 \begin_inset space ~
16798 \begin_inset CommandInset ref
16800 reference "sec:slideNote"
16808 \begin_layout Standard
16809 You can also use the template file
16810 \begin_inset Quotes eld
16818 \begin_inset Quotes erd
16821 to automatically set up a document to use the
16827 File\SpecialChar menuseparator
16829 \begin_inset space ~
16833 \begin_inset space ~
16838 to open your new document].
16839 The template file also contains some examples of the special paragraph
16840 environments used by this class.
16841 I'll describe those next.
16844 \begin_layout Subsection
16845 Paragraph Environments
16848 \begin_layout Subsubsection
16849 Supported Environments
16852 \begin_layout Standard
16853 The first thing you'll notice when you start up a new
16857 document is the font size and type: it's the equivalent of the size
16858 \begin_inset Quotes eld
16866 \begin_inset Quotes erd
16872 \begin_inset space ~
16878 This is also what's used in the output.
16880 \begin_inset Quotes eld
16884 \begin_inset Quotes erd
16887 to remind you that this is a slide.
16888 Your final slides will use a larger font; ergo, you'll have less space.
16889 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
16892 \begin_layout Standard
16893 The next thing that becomes obvious is the changes to the paragraph environment
16894 pull-down box [at the far-left end of the toolbar].
16895 Most of the paragraph environments you're used to seeing are missing.
16896 There are also five new ones.
16901 class itself only supports certain paragraph environments:
16904 \begin_layout Itemize
16910 \begin_layout Itemize
16916 \begin_layout Itemize
16922 \begin_layout Itemize
16928 \begin_layout Itemize
16934 \begin_layout Itemize
16940 \begin_layout Itemize
16946 \begin_layout Itemize
16952 \begin_layout Itemize
16958 \begin_layout Itemize
16965 \begin_layout Itemize
16971 \begin_layout Standard
16972 All of the other standard environments, including the section-heading environmen
16973 ts, aren't used in the
16980 \begin_layout Standard
16981 On the other hand, you'll notice the following new environments:
16984 \begin_layout Itemize
16990 \begin_layout Itemize
16996 \begin_layout Itemize
17002 \begin_layout Itemize
17008 \begin_layout Itemize
17014 \begin_layout Standard
17015 These five are kind of quirky, due to a
17016 \begin_inset Quotes eld
17020 \begin_inset Quotes erd
17023 in \SpecialChar LyX
17025 You see, \SpecialChar LyX
17026 doesn't permit you to nest any other paragraph environment into
17027 an empty environment.
17028 Now, that's fine and dandy, but it means that you wouldn't be able to start
17029 a slide with anything except plain text.
17030 To deal with this, I've performed a little
17031 \begin_inset Quotes eld
17036 \begin_inset Quotes erd
17042 \begin_layout Subsubsection
17043 Quirks of the New Environments
17044 \begin_inset CommandInset label
17046 name "sec:slideQuirk"
17053 \begin_layout Standard
17054 All five of the new paragraph environments are somewhat quirky due to inherent
17055 limitiations in the current version of \SpecialChar LyX
17057 As I just mentioned, \SpecialChar LyX
17058 forbids environments that begin with another environment.
17059 To get around this, the
17063 environment isn't a paragraph environment as described in the
17071 \begin_layout Standard
17072 You should consider
17085 \begin_inset Quotes eld
17088 pseudo-environments.
17089 \begin_inset Quotes erd
17092 They look like a section heading or a
17093 \begin_inset Quotes eld
17101 \begin_inset Quotes erd
17104 but really begin a [and, if necessary, end the previous] paragraph environment.
17114 \begin_inset Quotes eld
17118 \begin_inset Quotes erd
17121 These two perform some action.
17124 \begin_layout Standard
17125 A common feature of all five environments,
17145 , is a rather long-ish label.
17146 The text following this label — ordinarily the contents of the paragraph
17147 environment — is utterly irrelevant for
17169 completely ignores it.
17170 In fact, you can leave these five environments completely empty.
17174 \begin_layout Standard
17179 to put any text after the rather long-ish label, you might want to.
17180 This could be a short description of the contents of the
17185 In that case, enter your descriptive comment and hit
17189 as you normally would.
17192 \begin_layout Standard
17193 If, on the other hand, you don't want to enter any descriptive text, you'll
17194 hit another \SpecialChar LyX
17197 , like nature, abhors a vacuum, and will not let you start a new paragraph
17198 environment until you put something in the old one.
17202 \begin_layout Itemize
17203 Start entering the text that will
17231 \begin_layout Itemize
17232 Now move to the beginning of that paragraph.
17236 \begin_layout Itemize
17245 \begin_layout Itemize
17246 Finally, change this new, empty paragraph to a
17270 \begin_layout Standard
17271 Some future version of \SpecialChar LyX
17272 will, hopefully, resolve this quirkiness\SpecialChar ldots
17276 \begin_layout Subsection
17277 Making a Presentation with
17290 \begin_layout Subsubsection
17298 \begin_layout Standard
17299 If you're expecting this section to teach you how to actually make a presentatio
17300 n, you'll be sorely disappointed.
17301 Naturally, I'll describe all of the ways the
17305 class can assist you in preparing the materials for a presentation.
17306 Filling in the contents, however, is up to you.
17311 the \SpecialChar LyX
17315 \begin_layout Standard
17320 environment [in the manner described in section
17321 \begin_inset space ~
17325 \begin_inset CommandInset ref
17327 reference "sec:slideQuirk"
17331 ] tells \SpecialChar LyX
17332 to begin a new slide [duh].
17333 The label for this environment/
17334 \begin_inset Quotes erd
17338 \begin_inset Quotes erd
17342 \begin_inset Quotes eld
17346 \begin_inset Quotes erd
17349 in cool blue, followed by the label,
17350 \begin_inset Quotes eld
17354 \begin_inset Quotes erd
17358 Any text or paragraph environments that follow this one go on the new slide.
17362 \begin_layout Standard
17363 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17365 (this can be specified in the
17370 In fact, you'll want to, once you finish entering the contents of one slide.
17371 If you've entered more text than can physically fit on a slide, the extra
17372 overflows onto a new slide.
17373 I don't recommend doing this, however, since the overflow slide won't have
17374 any page number on it.
17375 Furthermore, it may interfere with any
17379 you've made to accompany the oversized
17386 \begin_layout Standard
17395 environments work the same way as the
17400 They both create an
17401 \begin_inset Quotes eld
17405 \begin_inset Quotes erd
17408 followed by a label [
17409 \begin_inset Quotes eld
17413 \begin_inset Quotes erd
17417 \begin_inset Quotes eld
17421 \begin_inset Quotes erd
17425 The color is a stunning magenta instead of blue, and the
17426 \begin_inset Quotes eld
17430 \begin_inset Quotes erd
17433 will look different, in style and in length.
17434 The label fonts of all three also differ from one another.
17437 \begin_layout Standard
17442 , if the contents of a
17450 exceed the physical size of a slide or sheet of paper, the extra will overflow
17452 Again, you should avoid this.
17453 It defeats the whole purpose of
17464 \begin_layout Subsubsection
17474 \begin_layout Standard
17479 is a slide that sits atop another slide.
17480 Perhaps you wish to discuss a figure on the main
17484 before displaying the text associated with it.
17485 One way to accomplish this is tape a flap of dark paper over the part of
17490 you want to display later.
17491 This method fails, however, if you wish to overlap one graph with another,
17493 You would then have to fumble while speaking to align the two separate,
17498 s to align the two graphs.
17503 environment in both cases makes life much easier.
17506 \begin_layout Standard
17511 receives the page number of its
17512 \begin_inset Quotes eld
17516 \begin_inset Quotes erd
17524 \begin_inset Quotes eld
17532 \begin_inset Quotes erd
17539 \begin_layout Plain Layout
17540 Presumably, mutliple
17545 \begin_inset Quotes eld
17553 \begin_inset Quotes erd
17557 \begin_inset Quotes eld
17565 \begin_inset Quotes erd
17569 \begin_inset Quotes eld
17577 \begin_inset Quotes erd
17581 \begin_inset space ~
17584 appended to the page number of the parent
17594 Clearly, you want the contents of both the
17602 to each fit on a single physical slide! You should probably consider an
17608 \begin_inset Quotes eld
17612 \begin_inset Quotes erd
17620 Indeed, the \SpecialChar LyX
17625 class provides a visual cue for this: the label at the start of an
17629 is shorter than that at the start of a
17634 Lastly, when you generate printable output, you'll find alignment markers
17635 in all four corners of both the
17639 page and its parent
17644 These will assist you in lining up the two physical slides.
17647 \begin_layout Standard
17648 The major problem in overlaying two slides is aligning the contents of the
17649 two transparencies.
17650 How much space should you leave for that graph on the second slide? Worse
17651 still, what if you want a graph and a sentence on second slide, but there
17652 is text on the main transparency that goes in between them? You could try
17653 and insert vertical space of the right size.
17654 The better way is to use
17665 \begin_layout Standard
17666 As their names imply,
17674 are two command-like paragraph environments that make all subsequent text
17675 invisible and visible, respectively.
17677 \begin_inset space ~
17681 \begin_inset CommandInset ref
17683 reference "sec:slideQuirk"
17687 that you don't place anything
17691 these two environments, however.
17696 , it inserts a centered, sky-blue label into the page reading
17697 \begin_inset Quotes eld
17700 <Invisible Text Follows>
17701 \begin_inset Quotes erd
17705 For paragraphs following this label, the parts of the
17713 ; it doesn't matter which] where they would be contain instead blank space.
17717 \begin_layout Standard
17722 , the corresponding centered label is
17723 \begin_inset Quotes eld
17726 <Visible Text Follows>
17727 \begin_inset Quotes erd
17731 Paragraphs following this label behave normally.
17732 Note that the beginning of a new
17744 automatically shuts off an
17749 It's therefore not necessary to use
17760 \begin_layout Standard
17761 By now, it should be obvious how to create overlay transparencies using
17762 the proper combination of
17781 \begin_layout Enumerate
17786 , including everything that will appear on it, whether on the main slide
17794 \begin_layout Enumerate
17795 Before each figure or paragraph that will appear only on the
17804 If necessary, insert a
17808 environment after the
17815 \begin_layout Enumerate
17820 immediately following the
17827 \begin_layout Enumerate
17828 Copy the contents of this
17839 \begin_layout Enumerate
17844 , change all of the
17855 \begin_layout Standard
17857 You've just made an
17864 \begin_layout Standard
17865 There's one problem with the way I've designed the \SpecialChar LyX
17870 class: you can't make text in the middle of a paragraph invisible, nor
17871 make text in the middle of an invisible paragraph visible again.
17872 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
17877 \begin_layout Plain Layout
17878 The commands of interest are:
17881 \begin_layout Itemize
17886 invisible \SpecialChar ldots
17890 \begin_layout Itemize
17895 visible \SpecialChar ldots
17899 \begin_layout Plain Layout
17901 and need to be marked as \SpecialChar TeX
17904 \begin_inset Quotes eld
17908 \begin_inset Quotes erd
17911 you wish to change goes in between the brackets [and after the
17924 If you don't know how to mark text as \SpecialChar TeX
17925 , see the appropriate section of
17938 \begin_layout Subsubsection
17948 \begin_inset CommandInset label
17950 name "sec:slideNote"
17957 \begin_layout Standard
17966 is associated with a
17967 \begin_inset Quotes eld
17971 \begin_inset Quotes erd
17979 Here, too, the \SpecialChar LyX
17984 class provides visual cues.
17989 is shorter than that of a
17993 [yet longer than that of an
17997 ] and, like the label of an
18001 is shockingly magenta.
18002 Additionally, the printed
18006 has the page number of its
18007 \begin_inset Quotes eld
18011 \begin_inset Quotes erd
18019 \begin_inset Quotes eld
18027 \begin_inset Quotes erd
18031 \begin_inset Quotes eld
18039 \begin_inset Quotes erd
18043 \begin_inset Quotes eld
18051 \begin_inset Quotes erd
18055 You can have multiple
18059 s associated with a single
18071 , you'll probably want to break up long
18075 s so that they fit on a single sheet of paper.
18078 \begin_layout Standard
18083 is obvious: it contains anything additional you might want to say about
18089 It could also be used as a sheet of reminders for a particular
18094 In the case of the latter, you might want to make use of time markers.
18095 Currently, the \SpecialChar LyX
18101 \begin_inset Quotes eld
18105 \begin_inset Quotes erd
18108 support for time markers, a
18110 Sli\SpecialChar TeX
18114 So, you'll have to resort to using the \SpecialChar LaTeX
18118 \begin_layout Standard
18119 To use time markers, you'll need to specify the extra class option
18120 \begin_inset Quotes eld
18128 \begin_inset Quotes erd
18132 \begin_inset space ~
18136 \begin_inset CommandInset ref
18138 reference "sec:slidesetup"
18143 This option turns on timing marks, which will appear in the lower-left-hand
18149 To set what appears in the time marker, you use the \SpecialChar LaTeX
18151 \begin_inset Quotes eld
18161 \begin_inset Quotes erd
18165 \begin_inset Quotes eld
18175 \begin_inset Quotes erd
18179 The arguments of both commands are time measured in seconds.
18181 \begin_inset Quotes eld
18191 \begin_inset Quotes erd
18194 sets the time marker to a given time.
18196 \begin_inset Quotes eld
18206 \begin_inset Quotes erd
18209 increments the time marker by the specified amount.
18210 Using time markers and
18214 s in this fashion, you can remind yourself how much time to spend on a particula
18222 \begin_layout Standard
18223 There's one last feature to describe.
18224 Clearly, you'd like to print out all of your
18232 s on transparencies while printing all of your
18249 with which it is associated.
18250 What's a person to do?
18253 \begin_layout Standard
18254 Luckily, there are two \SpecialChar LaTeX
18255 commands that allow you to select what to print
18257 Both must be placed into the preamble of your document.
18259 \begin_inset Quotes eld
18271 \begin_inset Quotes erd
18274 will cause the output to contain only the
18283 Correspondingly, the command
18284 \begin_inset Quotes eld
18296 \begin_inset Quotes erd
18299 prevents the output of anything but
18304 I'd advise placing both commands in the preamble and initially comment
18306 You can then preview your entire presentation as you write.
18307 When you're done writing, you can then uncomment one of the two to select
18308 what you want to print.
18309 I like to uncomment
18310 \begin_inset Quotes eld
18322 \begin_inset Quotes erd
18325 , print to a file with
18326 \begin_inset Quotes eld
18334 \begin_inset Quotes erd
18337 in its name, comment it back out, then uncomment
18338 \begin_inset Quotes eld
18350 \begin_inset Quotes erd
18354 \begin_inset Quotes eld
18362 \begin_inset Quotes erd
18366 I can then send either file to a printer, loading transparencies or plain
18367 paper as appropriate.
18370 \begin_layout Standard
18371 You can also provide other arguments to the
18372 \begin_inset Quotes eld
18382 \begin_inset Quotes erd
18386 \begin_inset Quotes eld
18396 \begin_inset Quotes erd
18400 See a good \SpecialChar LaTeX
18404 \begin_layout Subsection
18409 Class Template File
18412 \begin_layout Standard
18413 I have also provided a template file,
18414 \begin_inset Quotes eld
18422 \begin_inset Quotes erd
18430 To use it, begin your new presentation with
18435 ile\SpecialChar menuseparator
18437 \begin_inset space ~
18441 \begin_inset space ~
18451 Your new \SpecialChar LyX
18452 presentation file will contain an example
18473 additionally contain an example of the use of
18482 Lastly, the preamble will contain:
18485 \begin_layout LyX-Code
18486 % Uncomment to print out only slides and overlays
18489 \begin_layout LyX-Code
18493 \begin_layout LyX-Code
18499 \begin_inset Newline newline
18505 \begin_layout LyX-Code
18506 % Uncomment to print out only notes
18509 \begin_layout LyX-Code
18513 \begin_layout LyX-Code
18521 \begin_layout Standard
18522 One final thing: I created this class to support the \SpecialChar LaTeX2e
18524 \begin_inset Quotes eld
18529 Sli\SpecialChar TeX
18533 \begin_inset Quotes erd
18536 class, one of the built-in \SpecialChar LaTeX2e
18538 Neither I nor the rest of the \SpecialChar LyX
18539 Team endorse or oppose the use of this built-in
18541 It's here if you want it or need it.
18542 There exist other \SpecialChar LaTeX2e
18543 classes for creating presentations, such as the
18548 \begin_inset space ~
18552 \begin_inset CommandInset ref
18554 reference "sec:foiltex"
18559 \begin_inset Quotes eld
18567 \begin_inset Quotes erd
18570 package [present on some \SpecialChar TeX
18572 The latter is not yet supported under \SpecialChar LyX
18577 \begin_layout Plain Layout
18578 Perhaps you can take on the task\SpecialChar ldots
18584 I know nothing about these other classes.
18585 Try them out to see what sort of alternative they provide.
18588 \begin_layout Chapter
18590 Features needing Extra Software
18593 \begin_layout Section
18594 Checking \SpecialChar TeX
18598 \begin_layout Standard
18604 \begin_layout Subsection
18608 \begin_layout Standard
18617 \begin_layout Plain Layout
18622 is not yet available when you are using the \SpecialChar LaTeX
18623 distribution MiK\SpecialChar TeX
18629 , you'll find in the
18636 \begin_inset space ~
18647 \begin_inset Newline newline
18651 \begin_inset CommandInset href
18653 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18660 \begin_layout Standard
18663 Chk\SpecialChar TeX
18666 package is a program that was written by
18667 \begin_inset Flex Noun
18670 \begin_layout Plain Layout
18672 \begin_inset space ~
18680 in frustration because some constructs in \SpecialChar LaTeX
18681 are sometimes non-intuitive,
18682 and easy to forget.
18683 The program runs over your \SpecialChar LaTeX
18684 file, checks the integrity of the file, and
18685 flags some common errors.
18686 In other technical words, it is
18690 for \SpecialChar LaTeX
18694 \begin_layout Standard
18695 Well, what is a syntax checker doing in \SpecialChar LyX
18696 which is supposed to produce correct
18698 anyways? The answer is simple: Just as
18702 not only checks the
18706 of C programs, but also does
18710 checks for type-errors,
18712 Chk\SpecialChar TeX
18715 catches some common
18719 errors, in addition to the syntactical ones.
18722 Chk\SpecialChar TeX
18725 is capable of detecting several common errors, such as
18728 \begin_layout Itemize
18729 Ellipsis detection:
18730 \begin_inset Newline newline
18733 Use \SpecialChar ldots
18737 \begin_layout Itemize
18738 No space in front of/after parenthesis:
18739 \begin_inset Newline newline
18745 \begin_layout Itemize
18746 Enforcement of normal space after common abbreviations:
18747 \begin_inset Newline newline
18751 \begin_inset space \thinspace{}
18755 \begin_inset space \space{}
18758 is too wide spacing.
18761 \begin_layout Itemize
18762 Enforcement of end-of-sentence space when the last sentence ends with a
18764 \begin_inset Newline newline
18768 And this is wrong spacing.
18771 \begin_layout Itemize
18772 Space in front of labels and similar commands:
18773 \begin_inset Newline newline
18776 The label should stick right up to the text to avoid falling to a wrong
18779 \begin_inset CommandInset label
18789 \begin_layout Plain Layout
18790 This footnote is in danger of falling off to a wrong page
18795 The label is separated too much.
18798 \begin_layout Itemize
18799 Space in front of references, instead of hard spaces:
18800 \begin_inset Newline newline
18803 If you have bad luck, the text will break right between the referenced text
18804 and reference number, and that's a pity.
18806 \begin_inset CommandInset ref
18808 reference "sec:chktex"
18815 \begin_layout Itemize
18817 \begin_inset Quotes eld
18821 \begin_inset Quotes erd
18825 \begin_inset Formula $\times$
18829 \begin_inset Newline newline
18832 2x2 looks cheap compared to
18833 \begin_inset Formula $2\times2$
18839 \begin_layout Standard
18840 and more \SpecialChar ldots
18841 It is an invaluable tool when you are
18842 \begin_inset Quotes eld
18846 \begin_inset Quotes erd
18849 your document before printing, and you should run it right after the obligatory
18850 spelling check, and before you go fine tuning the typesetting.
18853 \begin_layout Subsection
18857 \begin_layout Standard
18858 If you have the program installed, usage is as simple as choosing
18860 Tools\SpecialChar menuseparator
18862 \begin_inset space ~
18868 This will make \SpecialChar LyX
18869 generate a \SpecialChar LaTeX
18870 file of your document, start
18872 Chk\SpecialChar TeX
18875 to check it, and then make \SpecialChar LyX
18877 \begin_inset Quotes eld
18881 \begin_inset Quotes erd
18884 with the warnings from
18886 Chk\SpecialChar TeX
18889 , if there were any.
18890 The warnings will be placed close to the point of the mistake, and you
18891 can quickly find them by using the
18893 Navigate\SpecialChar menuseparator
18896 menu item, or the shortcut key
18905 Open the error boxes by clicking on them with the mouse, or use the shortcut
18914 bindings, or the corresponding
18923 Read the warning and correct the mistake, if it is a mistake.
18924 If you have trouble understanding what the warning is about, you can safely
18926 Remember that there is a hidden layer between the document on screen and
18927 the technical details in invoking
18929 Chk\SpecialChar TeX
18932 , and this gap can make some warnings seem arcane or just plain silly.
18935 \begin_layout Standard
18936 This document is an excellent testing bed for the feature, and it should
18937 provide quite a few warnings for you to fiddle with.
18938 Since computers are only so smart, expect most of the warnings to be false
18942 \begin_layout Subsection
18943 How to fine tune it
18946 \begin_layout Standard
18947 Sometimes, you'll find that
18949 Chk\SpecialChar TeX
18952 makes more noise than suits your mood.
18953 Then you can choose not to use it, wait until your mood changes, or try
18956 Chk\SpecialChar TeX
18959 to get better along with you.
18962 \begin_layout Standard
18965 Chk\SpecialChar TeX
18972 very configurable and extensible, you should not expect to solve all problems
18975 Chk\SpecialChar TeX
18978 in \SpecialChar LyX
18980 Since \SpecialChar LyX
18981 has to generate a somewhat special \SpecialChar LaTeX
18982 file to be able to match the
18983 line numbers from the
18985 Chk\SpecialChar TeX
18992 \begin_layout Plain Layout
18993 You can inspect the specific output from
18999 Document\SpecialChar menuseparator
19002 \begin_inset space ~
19016 to the internal document structure, some of the warnings will not appear
19018 There are two things you can do about this:
19021 \begin_layout Itemize
19024 Chk\SpecialChar TeX
19027 invocation command line in
19028 \begin_inset Flex MenuItem
19031 \begin_layout Plain Layout
19032 Tools\SpecialChar menuseparator
19033 Preferences\SpecialChar menuseparator
19034 Output\SpecialChar menuseparator
19035 LaTeX\SpecialChar menuseparator
19043 Chk\SpecialChar TeX
19046 installation configuration file (usually with the file
19051 See below to learn what warnings can be enabled and disabled on the command
19055 \begin_layout Itemize
19056 Export your document as a raw \SpecialChar LaTeX
19059 File\SpecialChar menuseparator
19060 Export\SpecialChar menuseparator
19069 Invoked in this way, it can be a hassle to find the corresponding place
19070 in the document inside \SpecialChar LyX
19071 , but with a little patience, you should be able
19075 \begin_layout Standard
19076 Here follows the warning messages that can be enabled and disabled in
19085 to disable a warning, and
19089 to enable a warning.
19090 The emphasized entries are disabled by default, because the default is
19093 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19098 \begin_layout Standard
19099 Notice that you should only use the options that enable and disable warnings,
19100 because \SpecialChar LyX
19101 relies on some of the other command line parameters to be set
19102 in a specific way to have a chance to communicate with
19109 \begin_layout Enumerate
19113 Command terminated with space.
19116 \begin_layout Enumerate
19119 Non-breaking space (
19120 \begin_inset Quotes eld
19128 \begin_inset Quotes erd
19131 ) should have been used.
19134 \begin_layout Enumerate
19138 You should enclose the previous parenthesis with
19139 \begin_inset Quotes eld
19147 \begin_inset Quotes erd
19153 \begin_layout Enumerate
19156 Italic correction (
19157 \begin_inset Quotes eld
19167 \begin_inset Quotes erd
19170 ) found in non-italic buffer.
19173 \begin_layout Enumerate
19176 Italic correction (
19177 \begin_inset Quotes eld
19187 \begin_inset Quotes erd
19190 ) found more than once.
19193 \begin_layout Enumerate
19197 No italic correction (
19198 \begin_inset Quotes eld
19208 \begin_inset Quotes erd
19214 \begin_layout Enumerate
19218 \begin_inset Quotes eld
19226 \begin_inset Quotes erd
19230 \begin_inset Quotes eld
19238 \begin_inset Quotes erd
19244 \begin_layout Enumerate
19247 Wrong length of dash may have been used.
19250 \begin_layout Enumerate
19254 \begin_inset Quotes eld
19262 \begin_inset Quotes erd
19266 \begin_inset Quotes eld
19274 \begin_inset Quotes erd
19280 \begin_layout Enumerate
19284 \begin_inset Quotes eld
19292 \begin_inset Quotes erd
19298 \begin_layout Enumerate
19302 \begin_inset Quotes eld
19310 \begin_inset Quotes erd
19313 to achieve an ellipsis.
19316 \begin_layout Enumerate
19319 Inter-word spacing (
19320 \begin_inset Quotes eld
19330 \begin_inset Quotes eld
19333 ) should perhaps be used.
19336 \begin_layout Enumerate
19339 Inter-sentence spacing (
19340 \begin_inset Quotes eld
19350 \begin_inset Quotes erd
19353 ) should perhaps be used.
19356 \begin_layout Enumerate
19359 Could not find argument for command.
19362 \begin_layout Enumerate
19366 \begin_inset Quotes eld
19374 \begin_inset Quotes erd
19380 \begin_layout Enumerate
19383 Math mode still on at end of \SpecialChar LaTeX
19387 \begin_layout Enumerate
19391 \begin_inset Quotes eld
19399 \begin_inset Quotes erd
19402 doesn't match the number of
19403 \begin_inset Quotes eld
19411 \begin_inset Quotes erd
19417 \begin_layout Enumerate
19420 You should use either
19423 \begin_inset Quotes eld
19431 \begin_inset Quotes erd
19436 as an alternative to
19437 \begin_inset Quotes eld
19445 \begin_inset Quotes erd
19451 \begin_layout Enumerate
19458 " (ASCII 39) instead of "
19465 \begin_layout Enumerate
19468 User-specified pattern found.
19471 \begin_layout Enumerate
19474 This command might not be intended.
19477 \begin_layout Enumerate
19484 \begin_layout Enumerate
19502 \begin_layout Enumerate
19505 Delete this space to maintain correct page references.
19508 \begin_layout Enumerate
19512 You might wish to put this between a pair of
19513 \begin_inset Quotes eld
19521 \begin_inset Quotes erd
19527 \begin_layout Enumerate
19530 You ought to remove spaces in front of punctuation.
19533 \begin_layout Enumerate
19536 Could not execute \SpecialChar LaTeX
19540 \begin_layout Enumerate
19549 in front of small punctuation.
19552 \begin_layout Enumerate
19560 may look prettier here.
19563 \begin_layout Enumerate
19567 Multiple spaces detected in output.
19570 \begin_layout Enumerate
19573 This text may be ignored.
19576 \begin_layout Enumerate
19582 \begin_inset Quotes eld
19587 to begin quotation, not
19594 \begin_layout Enumerate
19601 to end quotation, not
19604 \begin_inset Quotes eld
19612 \begin_layout Enumerate
19618 \begin_layout Enumerate
19621 You should perhaps use
19622 \begin_inset Quotes eld
19630 \begin_inset Quotes erd
19636 \begin_layout Enumerate
19639 You should put a space in front of/after parenthesis.
19642 \begin_layout Enumerate
19645 You should avoid spaces in front of/after parenthesis.
19648 \begin_layout Enumerate
19652 You should not use punctuation in front of/after quotes.
19655 \begin_layout Enumerate
19658 Double space found.
19661 \begin_layout Enumerate
19664 You should put punctuation outside inner/inside display math mode.
19667 \begin_layout Enumerate
19670 You ought to not use primitive \SpecialChar TeX
19671 in \SpecialChar LaTeX
19675 \begin_layout Enumerate
19678 You should remove spaces in front of
19679 \begin_inset Quotes eld
19687 \begin_inset Quotes erd
19693 \begin_layout Enumerate
19696 \begin_inset Quotes eld
19704 \begin_inset Quotes erd
19707 is normally not followed by
19708 \begin_inset Quotes eld
19716 \begin_inset Quotes erd
19722 \begin_layout Standard
19723 In later versions of \SpecialChar LyX
19724 , we hope to provide a more complete interface to this
19725 tool (and it's smaller cousin
19729 ) to exploit the full power of it.
19730 But it's not exactly useless as it is now: go try it on one of your existing
19731 documents of a certain length and be surprised.
19734 \begin_layout Section
19735 Version Control in \SpecialChar LyX
19739 \begin_layout Standard
19742 Lars Gullik Bjønnes
19749 \begin_layout Subsection
19753 \begin_layout Standard
19755 supports some of the most basic RCS/CVS/SVN/GIT commands.
19756 If you need something a bit more sophisticated you will have to do that
19757 manually in a terminal.
19760 \begin_layout Standard
19761 Also note that CVS support is not as good as subversion support so we advise
19763 A good place to start learning Subversion is SVN Book
19767 \begin_layout Plain Layout
19768 \begin_inset CommandInset href
19770 target "http://svnbook.red-bean.com/"
19780 In the case of RCS you should read
19781 \begin_inset Quotes eld
19785 \begin_inset Quotes erd
19788 (a man file, read it with
19793 This file describes all the basic features of RCS.
19794 You should especially notice the comment about a RCS directory, and the
19795 notion of a master RCS file (the file ending in
19802 \begin_layout Standard
19803 Before you begin to use the version control features in \SpecialChar LyX
19805 familiar with RCS/CVS/SVN/GIT usage.
19806 The implementation in \SpecialChar LyX
19807 assumes a recent version of the GNU RCS or CVS/SVN
19808 package — no guarantees are made for older versions.
19809 Most of the log messages are not currently displayed after operations —
19810 you can check them in the Messages pane if unsure.
19811 Regular users of version control will appreciate VC toolbar, which can
19814 View\SpecialChar menuseparator
19815 Toolbars\SpecialChar menuseparator
19817 \begin_inset space ~
19825 \begin_layout Standard
19826 For introducing your own external commands consult vc-command in the manual
19827 of \SpecialChar LyX
19831 \begin_layout Standard
19832 It is strongly recommended to store documents in uncompressed format if
19833 using version control (uncheck
19835 Document\SpecialChar menuseparator
19838 if it is checked): Uncompressed LyX documents are text files and therefore
19839 for merging two different versions by version control systems.
19840 Compressed LyX documents are binary files, which cannot be merged by version
19844 \begin_layout Subsection
19845 RCS commands in \SpecialChar LyX
19849 \begin_layout Standard
19850 The following sections describe the RCS commands supported by \SpecialChar LyX
19852 You can find them in the
19854 File\SpecialChar menuseparator
19856 \begin_inset space ~
19863 was tested against RCS 5.7/5.8.
19866 \begin_layout Subsubsection
19872 \begin_layout Standard
19873 If your document is not under revision control, this is the only item shown
19875 And if it is under revision control, the
19879 item is not visible.
19883 \begin_layout Standard
19884 This command registers your document with RCS (unless you are under the
19885 directory managed by CVS)\SpecialChar endofsentence
19886 You are asked interactively to supply an initial
19887 description of the document.
19888 The document is now set in Read-Only mode and you have to
19891 \begin_inset space ~
19895 \begin_inset space ~
19899 \begin_inset space ~
19904 , before making any changes to it.
19905 A document under revision control has a
19906 \begin_inset Quotes eld
19909 [RCS:<version> <locker>]
19910 \begin_inset Quotes erd
19913 item tagged to the filename in the minibuffer.
19916 \begin_layout Standard
19917 RCS command that is run:
19919 ci -q -u -i -t-"<initial description>" <file-name>
19922 \begin_layout Standard
19927 to understand the switches.
19931 \begin_layout Subsubsection
19937 \begin_layout Standard
19938 When you are finished editing a file, you check in your changes.
19939 When you do this, you are asked for a description of the changes.
19940 This is stored in the history log.
19941 The version number is bumped, your changes are applied to the master RCS
19942 file, the document is unlocked and set to Read-Only mode.
19945 \begin_layout Standard
19948 ci -q -u -m"<description>" <file-name>
19951 \begin_layout Subsubsection
19957 \begin_layout Standard
19958 By doing this you lock the document so that only you can edit it.
19959 This will also make the document Read-Write only for you.
19960 You will usually continue editing for a while and when you are finished
19961 you check in your changes.
19962 The status line is changed to reflect that you have locked the file.
19965 \begin_layout Standard
19968 co -q -l <file-name>
19971 \begin_layout Subsubsection
19974 Revert To Repository Version
19977 \begin_layout Standard
19978 This will discard all changes made to the document since the last check
19980 You get a warning before changes are discarded.
19983 \begin_layout Standard
19986 co -f -u<version> <file-name>
19989 \begin_layout Subsubsection
19995 \begin_layout Standard
19996 This will create a copy of the current document.
19997 Since RCS does not support copy operations natively, the version history
19998 is not preserved, and the copy is added as a new file.
19999 It requires a clean document without any changes since the last checkin.
20000 You are asked for a file name and a description of the copy operation.
20001 After that the copy is created, both locally and in the repository.
20002 If the parent directories of the copied and original document differ, all
20003 relative paths of included files of the copy are adjusted (like in
20005 File\SpecialChar menuseparator
20010 Finally, the copy is loaded instead of the original document.
20013 \begin_layout Labeling
20014 \labelwidthstring 00.00.0000
20016 \begin_inset space ~
20020 \begin_inset space ~
20024 \begin_inset Newline newline
20028 \begin_inset Flex Code
20031 \begin_layout Plain Layout
20034 \begin_inset Quotes eld
20038 \begin_inset Quotes erd
20047 \begin_inset Flex Code
20050 \begin_layout Plain Layout
20053 \begin_inset Quotes eld
20057 \begin_inset Quotes erd
20066 \begin_inset Newline newline
20070 \begin_inset Flex Code
20073 \begin_layout Plain Layout
20077 \begin_inset Quotes eld
20081 \begin_inset Quotes erd
20092 \begin_layout Subsubsection
20098 \begin_layout Standard
20099 This makes as if the last check in never happened.
20100 No changes are made to the document loaded into \SpecialChar LyX
20101 , but the last version
20102 is removed from the master RCS file.
20105 \begin_layout Standard
20108 rcs -o<version> <file-name>
20111 \begin_layout Subsubsection
20117 \begin_layout Standard
20118 This shows the complete history of the RCS document.
20123 is shown in a browser.
20131 \begin_layout Subsubsection
20135 \begin_layout Standard
20137 supports RCS version number, author name, date and time of last commit.
20138 All those are extracted from
20140 rlog -r <file-name>
20144 \begin_inset CommandInset ref
20146 reference "subsec:VCS-Revision-Information"
20153 \begin_layout Subsection
20154 CVS commands in \SpecialChar LyX
20158 \begin_layout Standard
20159 A subset of CVS operations is supported by \SpecialChar LyX
20161 You can find the commands in the
20163 File\SpecialChar menuseparator
20165 \begin_inset space ~
20171 The version control system SVN is more powerful, so please use it instead
20172 of CVS if possible.
20175 \begin_layout Subsubsection
20181 \begin_layout Standard
20182 If you start from scratch with CVS you have to create your repository and
20183 checkout the working copy with external tools.
20184 If you're using a client-server setup you may need to login before doing
20185 the first repository checkout.
20188 \begin_layout Standard
20189 If your documents are under revision control and others are using the same
20190 repository problems arise when different changes to the same document at
20191 the same location happen.
20192 Standard CVS repositories don't operate with a file locking mechanism.
20193 This may be surprising, but conflicts only occur if people disagree on
20194 the proper content of the same part of a document.
20195 So, if co-workers are used to communicate regularly, these conflicts occur
20197 If they don't communicate they have a fundamental problem anyway.
20198 Nevertheless some people like to work with so called
20199 \begin_inset Quotes eld
20203 \begin_inset Quotes erd
20207 If they do so the working copy of all files is readonly when checked out
20208 first and the user starts editing after using a special command to make
20209 the working copy writable.
20210 When the changes are checked in the working copy returns to readonly state.
20211 With \SpecialChar LyX
20212 one has to edit the
20213 \begin_inset Flex Code
20216 \begin_layout Plain Layout
20222 file and add the line
20223 \begin_inset Flex Code
20226 \begin_layout Plain Layout
20232 to work with reserved checkouts.
20233 The benefit is the possibility to see who is using a writable copy of some
20235 It's not guaranteed only one user makes a copy writable.
20238 \begin_layout Standard
20240 tries to guess if you're using reserved or non-reserved checkouts.
20241 If your working copy is readonly or it is writable and an additional copy
20242 of your document exists in the CVS/Base sub-directory a reserved otherwise
20243 a non-reserved checkout is assumed.
20244 When a reserved checkout is detected you have to use
20245 \begin_inset Flex MenuItem
20248 \begin_layout Plain Layout
20254 to make your working copy writable if it's readonly.
20256 \begin_inset Flex MenuItem
20259 \begin_layout Plain Layout
20265 operation is possible and that makes your working copy readonly again after
20266 transferring your changes to the repository.
20269 \begin_layout Standard
20270 More information about CVS can be found here
20271 \begin_inset Flex URL
20274 \begin_layout Plain Layout
20276 http://www.nongnu.org/cvs
20282 \begin_inset Flex URL
20285 \begin_layout Plain Layout
20287 http://ximbiot.com/cvs
20295 \begin_layout Standard
20300 to understand the sub-commands and the switches mentioned below.
20303 \begin_layout Subsubsection
20309 \begin_layout Standard
20310 If your document is not under revision control, this is the only item shown
20312 And if it is under revision control, the
20319 item is not visible.
20323 \begin_layout Standard
20324 This command registers in CVS your document
20325 \begin_inset Flex Strong
20328 \begin_layout Plain Layout
20336 in the case you have already the documents directory under CVS control
20342 This means you have to create or checkout the archive by yourself using
20344 (In case you forget that step \SpecialChar LyX
20345 registers the document with RCS.)
20348 \begin_layout Standard
20349 Then you are asked interactively to supply an initial description of the
20351 Don't forget that registered file is not yet checked in.
20354 \begin_layout Standard
20355 CVS command that is run:
20357 cvs -q add -m"<entered message>" "<file-name>"
20360 \begin_layout Standard
20365 above and for all other CVS commands is an abbreviation for
20366 \begin_inset Quotes eld
20369 change the current working directory to file location and use the file name
20370 without path component as argument
20371 \begin_inset Quotes erd
20377 \begin_layout Subsubsection
20383 \begin_layout Standard
20384 When you are finished editing a file, you commit your changes.
20385 When you do this and you had changed the document, you are asked for a
20386 description of the changes.
20387 After that changes are written to the repository.
20388 In case you didn't change the document and a reserved checkout is detected
20389 the reservation made on
20390 \begin_inset Flex MenuItem
20393 \begin_layout Plain Layout
20402 \begin_layout Labeling
20403 \labelwidthstring 00.00.0000
20405 \begin_inset space ~
20409 \begin_inset space ~
20413 \begin_inset Newline newline
20417 \begin_inset Flex Code
20420 \begin_layout Plain Layout
20423 -q commit -m"<description>" "<file-name>"
20429 \begin_inset Newline newline
20433 \begin_inset Flex Code
20436 \begin_layout Plain Layout
20447 \begin_layout Subsubsection
20453 \begin_layout Standard
20454 When you are sharing a repository with others, you may have to incorporate
20455 their changes into your working copy.
20458 \begin_layout Standard
20461 cvs -q update "<file-name>"
20464 \begin_layout Standard
20465 If a readonly checkout is detected the working copy is made writable and
20469 \begin_layout Standard
20472 cvs -q edit "<file-name>"
20475 \begin_layout Subsubsection
20478 Revert To Repository Version
20481 \begin_layout Standard
20482 This will discard all changes made to the document since the last check
20484 You get a warning before changes are discarded.
20485 Firstly the file is deleted, secondly CVS update command is run.
20488 \begin_layout Standard
20491 cvs -q update "<file-name>"
20494 \begin_layout Standard
20495 If a reserved checkout is detected and the working copy has no changes only
20496 the reservation is undone.
20499 \begin_layout Standard
20502 cvs -q unedit "<file-name>"
20505 \begin_layout Subsubsection
20511 \begin_layout Standard
20512 This will create a copy of the current document.
20513 Since CVS does not support copy operations natively, the version history
20514 is not preserved, and the copy is added as a new file.
20515 It requires a clean document without any changes since the last checkin.
20516 You are asked for a file name and a description of the copy operation.
20517 After that the copy is created, both locally and in the repository.
20518 If the parent directories of the copied and original document differ, all
20519 relative paths of included files of the copy are adjusted (like in
20521 File\SpecialChar menuseparator
20526 Finally, the copy is loaded instead of the original document.
20529 \begin_layout Labeling
20530 \labelwidthstring 00.00.0000
20532 \begin_inset space ~
20536 \begin_inset space ~
20540 \begin_inset Newline newline
20544 \begin_inset Flex Code
20547 \begin_layout Plain Layout
20550 \begin_inset Quotes eld
20554 \begin_inset Quotes erd
20563 \begin_inset Flex Code
20566 \begin_layout Plain Layout
20569 \begin_inset Quotes eld
20573 \begin_inset Quotes erd
20582 \begin_inset Newline newline
20586 \begin_inset Flex Code
20589 \begin_layout Plain Layout
20593 \begin_inset Quotes eld
20597 \begin_inset Quotes erd
20608 \begin_layout Subsubsection
20614 \begin_layout Standard
20615 This will rename the current document.
20616 Since CVS does not support rename operations natively, the version history
20617 is not preserved, the renamed document is added as a new file, and the
20618 original document is deleted.
20619 It requires a clean document without any changes since the last checkin.
20620 You are asked for a file name and a description of the rename operation.
20621 After that the document is renamed, both locally and in the repository.
20622 If the parent directories of the new and old file names differ, all relative
20623 paths of included files are adjusted (like in
20625 File\SpecialChar menuseparator
20630 Finally, the document is reloaded using the new name.
20633 \begin_layout Labeling
20634 \labelwidthstring 00.00.0000
20636 \begin_inset space ~
20640 \begin_inset space ~
20644 \begin_inset Newline newline
20648 \begin_inset Flex Code
20651 \begin_layout Plain Layout
20654 \begin_inset Quotes eld
20658 \begin_inset Quotes erd
20667 \begin_inset Flex Code
20670 \begin_layout Plain Layout
20673 \begin_inset Quotes eld
20677 \begin_inset Quotes erd
20686 \begin_inset Newline newline
20690 \begin_inset Flex Code
20693 \begin_layout Plain Layout
20697 \begin_inset Quotes eld
20701 \begin_inset Quotes erd
20710 \begin_inset Newline newline
20714 \begin_inset Flex Code
20717 \begin_layout Plain Layout
20721 \begin_inset Quotes eld
20725 \begin_inset Quotes erd
20736 \begin_layout Subsubsection
20737 Update of the local directory checkout from repository
20740 \begin_layout Standard
20741 Once your documents gets more complex, containing sub-documents and pictures,
20743 \begin_inset Flex Code
20746 \begin_layout Plain Layout
20752 files and so on using version control becomes more complicated.
20754 supports updating the whole tree in which resides the document.
20755 This become especially useful once you cooperate with people which neither
20756 have detailed knowledge about CVS usage nor they have ambition to commit
20757 additional material to the repository.
20758 You have to organize the files structure so that all external files are
20759 in the same directory or subdirectories of the document.
20760 It's good practice anyway to store multipart documents in an extra directory.
20763 \begin_layout Standard
20765 \begin_inset Flex Code
20768 \begin_layout Plain Layout
20769 Update local directory from repository
20774 command updates the whole directory.
20775 If local changes are detected user is warned before update starts.
20776 In case of merge conflicts both versions of the conflicting document parts
20777 are placed in the final document.
20778 You have to review and correct the result of the merge.
20779 You'll find the conflicts enclosed in pairs of
20780 \begin_inset Flex Code
20783 \begin_layout Plain Layout
20790 \begin_inset Flex Code
20793 \begin_layout Plain Layout
20800 \begin_inset Flex Code
20803 \begin_layout Plain Layout
20810 The first part is your version as before the update operation with the
20811 document name prepended.
20812 The second one is the repository version with the version number after
20814 \begin_inset Flex Code
20817 \begin_layout Plain Layout
20826 \begin_layout Labeling
20827 \labelwidthstring 00.00.0000
20829 \begin_inset space ~
20833 \begin_inset space ~
20837 \begin_inset Newline newline
20841 \begin_inset Flex Code
20844 \begin_layout Plain Layout
20852 (Ask if changes are detected.)
20853 \begin_inset Newline newline
20857 \begin_inset Flex Code
20860 \begin_layout Plain Layout
20861 cd $path; cvs -q update
20871 \begin_layout Standard
20873 \begin_inset Flex Code
20876 \begin_layout Plain Layout
20882 stands for the path to the document.
20885 \begin_layout Subsubsection
20891 \begin_layout Standard
20892 This shows the complete history of the CVS document.
20895 cvs log "<file-name>"
20897 is shown in a browser.
20900 \begin_layout Subsubsection
20904 \begin_layout Standard
20906 supports CVS version number, author name, date and time of last commit.
20907 All those are extracted from
20909 cvs log -r <file-name>
20913 \begin_inset CommandInset ref
20915 reference "subsec:VCS-Revision-Information"
20922 \begin_layout Subsection
20923 SVN commands in \SpecialChar LyX
20927 \begin_layout Standard
20928 SVN is now partially supported by \SpecialChar LyX
20930 You can find the commands in the
20932 File\SpecialChar menuseparator
20934 \begin_inset space ~
20940 Please note that if you use password protected access to repository via
20941 ssh, you will be asked in terminal window.
20943 was tested against SVN 1.5, 1.6, 1.7 and 1.8
20947 \begin_layout Plain Layout
20948 Most of the commands will work with 1.4 too, see
20949 \begin_inset CommandInset ref
20951 reference "subsec:SVN-Repo-Update"
20956 There seems to be currently unresolved permissions problem under SVN 1.8
20957 with reverting changes when file is locked.
20965 \begin_layout Subsubsection
20971 \begin_layout Standard
20972 If your document is not under revision control, this is the only item shown
20974 And if it is under revision control, the
20981 item is not visible.
20984 \begin_layout Standard
20985 This command registers in SVN your document ONLY in case you have already
20986 the documents directory under SVN control (in particular
20991 This means you have to checkout the archive by yourself.
20994 \begin_layout Standard
20995 Then you are asked interactively to supply an initial description of the
20997 Don't forget that registered file is not yet commited.
21000 \begin_layout Standard
21001 SVN command that is run:
21004 \begin_inset Quotes eld
21008 \begin_inset Quotes erd
21014 \begin_layout Standard
21019 to understand the switches.
21022 \begin_layout Subsubsection
21028 \begin_layout Standard
21029 When you are finished editing a file, you commit your changes.
21030 When you do this, you are asked for a description of the changes.
21031 After that changes are commited.
21034 \begin_layout Standard
21039 \begin_layout Plain Layout
21040 In case locking is not enabled.
21042 \begin_inset CommandInset ref
21044 reference "subsec:SVN-File-Locking"
21055 svn commit -q -m"<description>" <file-name>
21058 \begin_layout Subsubsection
21064 \begin_layout Standard
21065 Updates the changes of this file from the repository.
21066 Be sure you understand SVN merging and conflicts resolving before using
21067 this function, because all conflicts has to be resolved manually by you!
21070 \begin_layout Standard
21075 \begin_layout Plain Layout
21083 svn update --non-interactive
21084 \begin_inset Quotes eld
21088 \begin_inset Quotes erd
21094 \begin_layout Subsubsection
21097 Revert To Repository Version
21100 \begin_layout Standard
21101 This will discard all changes made to the document since the last check
21103 You get a warning before changes are discarded.
21106 \begin_layout Standard
21110 \begin_inset Quotes eld
21114 \begin_inset Quotes erd
21120 \begin_layout Subsubsection
21126 \begin_layout Standard
21127 This will create a copy of the current document including the version history.
21128 It requires a clean document without any changes since the last checkin.
21129 You are asked for a file name and a description of the copy operation.
21130 After that the copy is created, both locally and in the repository.
21131 If the parent directories of the copied and original document differ, all
21132 relative paths of included files of the copy are adjusted (like in
21134 File\SpecialChar menuseparator
21139 Finally, the copy is loaded instead of the original document.
21142 \begin_layout Labeling
21143 \labelwidthstring 00.00.0000
21145 \begin_inset space ~
21149 \begin_inset space ~
21153 \begin_inset Newline newline
21157 \begin_inset Flex Code
21160 \begin_layout Plain Layout
21164 \begin_inset Quotes eld
21168 \begin_inset Quotes erd
21172 \begin_inset Quotes eld
21176 \begin_inset Quotes erd
21185 \begin_inset Newline newline
21189 \begin_inset Flex Code
21192 \begin_layout Plain Layout
21201 \begin_layout Subsubsection
21207 \begin_layout Standard
21208 This will rename the current document including the version history.
21209 It requires a clean document without any changes since the last checkin.
21210 You are asked for a file name and a description of the rename operation.
21211 After that the document is renamed, both locally and in the repository.
21212 If the parent directories of the new and old file names differ, all relative
21213 paths of included files are adjusted (like in
21215 File\SpecialChar menuseparator
21220 Finally, the document is reloaded using the new name.
21223 \begin_layout Labeling
21224 \labelwidthstring 00.00.0000
21226 \begin_inset space ~
21230 \begin_inset space ~
21234 \begin_inset Newline newline
21238 \begin_inset Flex Code
21241 \begin_layout Plain Layout
21245 \begin_inset Quotes eld
21249 \begin_inset Quotes erd
21253 \begin_inset Quotes eld
21257 \begin_inset Quotes erd
21266 \begin_inset Newline newline
21270 \begin_inset Flex Code
21273 \begin_layout Plain Layout
21282 \begin_layout Subsubsection
21283 \begin_inset CommandInset label
21285 name "subsec:SVN-Repo-Update"
21289 Update of the local directory checkout from repository
21293 \begin_layout Plain Layout
21294 Note that this command will work only with subversion
21295 \begin_inset Formula $\geqq1.5$
21306 \begin_layout Standard
21307 All the commands above have one shortcomming - they deal with the current
21309 Once your document contains pictures, includes external
21310 \begin_inset Flex Code
21313 \begin_layout Plain Layout
21319 files and so on administration becomes more complicated.
21321 now supports updating the whole tree in which resides the document
21325 \begin_layout Plain Layout
21326 One need to organize the files structure so that all external files are
21327 in the same directory or subdirectories of the document.
21334 This become especially useful once you cooperate with people which neither
21335 know about subversion management nor they have ambition to commit additional
21336 material to the repository.
21340 \begin_layout Standard
21341 \begin_inset Flex Code
21344 \begin_layout Plain Layout
21345 Update local directory from repository
21350 command updates the whole directory and in case of merge conflicts local
21351 version of the files are left, so no unintended data loss occurs.
21352 If local changes are detected user is warned before update starts.
21355 \begin_layout Labeling
21356 \labelwidthstring 00.00.0000
21358 \begin_inset space ~
21362 \begin_inset space ~
21366 \begin_inset Newline newline
21370 \begin_inset Flex Code
21373 \begin_layout Plain Layout
21379 (Ask if changes are detected.)
21380 \begin_inset Newline newline
21384 \begin_inset Flex Code
21387 \begin_layout Plain Layout
21388 svn update –accept mine-full $path
21396 \begin_layout Standard
21398 \begin_inset Flex Code
21401 \begin_layout Plain Layout
21407 stands for the path to the document.
21410 \begin_layout Subsubsection
21416 \begin_layout Standard
21417 This shows the complete history of the SVN document.
21421 \begin_inset Quotes eld
21425 \begin_inset Quotes erd
21430 is shown in a browser.
21433 \begin_layout Subsubsection
21435 \begin_inset CommandInset label
21437 name "subsec:SVN-File-Locking"
21444 \begin_layout Standard
21445 The file exchange through various revision control systems brings the problem
21446 of merge conflicts in case two different users try to edit the same (parts
21448 When such a conflict happens it needs manual resolving and one reasonable
21449 alternative is to provide some kind of locking mechanism, which guarantees
21450 that only one user is allowed to edit file at the given time.
21453 \begin_layout Standard
21454 SVN has two such mechanisms to provide mutual exclusivity for file access
21455 - locks and automatic setting of write permissions (see sec.
21457 \begin_inset CommandInset ref
21459 reference "subsec:Automatical-Locking-Property"
21464 \begin_inset Flex Code
21467 \begin_layout Plain Layout
21477 \begin_layout Plain Layout
21478 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21484 If this property is detected for a given document \SpecialChar LyX
21485 starts to use SVN locks
21486 for document editing automatically and the whole check-in/out mechanism
21487 switches to the same regimen as for RCS.
21488 This in particular means there are two different modes of file use in \SpecialChar LyX
21492 \begin_layout Itemize
21494 The loaded file is in the read-only mode.
21495 For editing on needs to check-out.
21500 consists of updating from the repository and gaining write lock.
21501 If the lock is not possible to obtain, we remain in unlocked state.
21504 \begin_layout Itemize
21506 The loaded file is in the 'normal' edit mode.
21507 No other user is allowed to edit the file.
21512 consists of commiting changes and releasing write-lock.
21513 If no changes have been made to the document, no commit will be produced
21517 \begin_layout Plain Layout
21518 Don't be puzzled by the fact that you will be asked for commit message anyway.
21523 and only the write-lock will be released.
21526 \begin_layout Standard
21530 \begin_layout Labeling
21531 \labelwidthstring 00.00.0000
21534 svn commit -q -m"<description>" "<file-name>"
21535 \begin_inset Newline newline
21538 svn unlock "<file-name>"
21541 \begin_layout Labeling
21542 \labelwidthstring 00.00.0000
21545 svn update "<file-name>"
21546 \begin_inset Newline newline
21549 svn lock "<file-name>"
21552 \begin_layout Subsubsection
21555 \begin_inset CommandInset label
21557 name "subsec:Automatical-Locking-Property"
21563 Automatic Locking Property
21566 \begin_layout Standard
21567 The above mentioned automatic setting of write permissions of the .lyx file
21573 ile\SpecialChar menuseparator
21579 \begin_inset space ~
21582 Control\SpecialChar menuseparator
21587 oggle locking property
21590 This command is active only when the file is not locked on the svn server
21592 you need to check-out before proceeding).
21595 \begin_layout Labeling
21596 \labelwidthstring 00.00.0000
21598 \begin_inset space ~
21604 \begin_layout Labeling
21605 \labelwidthstring 00.00.0000
21608 svn propset svn:needs-lock ON "<file-name>"
21611 \begin_layout Labeling
21612 \labelwidthstring 00.00.0000
21615 svn propdel svn:needs-lock "<file-name>"
21618 \begin_layout Subsubsection
21619 \begin_inset CommandInset label
21621 name "subsec:VCS-Revision-Information"
21625 Revision Information in Documents
21628 \begin_layout Standard
21629 There are more possibilities how to activate revision information in our
21633 \begin_layout Itemize
21636 \begin_inset Separator parbreak
21643 \begin_layout Itemize
21644 tree revision information (
21645 \begin_inset Flex Code
21648 \begin_layout Plain Layout
21655 The result is the output of the
21656 \begin_inset Flex Code
21659 \begin_layout Plain Layout
21665 command, the following table gives you an idea, how to read the results.
21668 \begin_layout Standard
21670 \begin_inset Tabular
21671 <lyxtabular version="3" rows="6" columns="2">
21672 <features tabularvalignment="middle">
21673 <column alignment="center" valignment="top">
21674 <column alignment="center" valignment="top">
21676 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21679 \begin_layout Plain Layout
21685 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21688 \begin_layout Plain Layout
21696 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21699 \begin_layout Plain Layout
21705 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21708 \begin_layout Plain Layout
21709 mixed revision working copy
21716 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21719 \begin_layout Plain Layout
21725 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21728 \begin_layout Plain Layout
21729 modified working copy
21736 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21739 \begin_layout Plain Layout
21745 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21748 \begin_layout Plain Layout
21749 switched working copy
21756 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21759 \begin_layout Plain Layout
21765 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21768 \begin_layout Plain Layout
21769 partial working copy, from a sparse checkout
21776 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21779 \begin_layout Plain Layout
21785 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21788 \begin_layout Plain Layout
21789 mixed revision, modified, switched working copy
21802 \begin_layout Itemize
21803 file revision information.
21804 The result comes from parsing the output of
21805 \begin_inset Flex Code
21808 \begin_layout Plain Layout
21810 \begin_inset space ~
21814 \begin_inset space ~
21818 \begin_inset space ~
21827 Supported flags are:
21828 \begin_inset Separator parbreak
21835 \begin_layout Itemize
21836 version number of the last commit (
21837 \begin_inset Flex Code
21840 \begin_layout Plain Layout
21849 \begin_layout Itemize
21850 author of the last commit (
21851 \begin_inset Flex Code
21854 \begin_layout Plain Layout
21863 \begin_layout Itemize
21864 date of the last commit (
21865 \begin_inset Flex Code
21868 \begin_layout Plain Layout
21877 \begin_layout Itemize
21878 time of the last commit (
21879 \begin_inset Flex Code
21882 \begin_layout Plain Layout
21892 \begin_layout Standard
21893 You can obtain this info via InsetInfo (e.g.
21895 \begin_inset Flex Code
21898 \begin_layout Plain Layout
21899 info-insert buffer vcs-date
21905 The information will be available only when you have the file stored under
21906 svn managment (i.e.
21908 \begin_inset Flex Code
21911 \begin_layout Plain Layout
21917 directory is available with your document).
21921 \begin_layout Itemize
21922 Another—a hacking one—possibility is to use svn keywords
21926 \begin_layout Plain Layout
21927 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
21933 In short – you set file keywords property (e.g.
21936 svn propset svn:keywords 'Rev' file.lyx
21938 ) and then paste keyword \SpecialChar TeX
21943 \begin_layout Plain Layout
21944 This is an easy way how to ensure that \SpecialChar LyX
21945 won't break the line in the middle
21951 tag in your document (e.g.
21956 \begin_layout Plain Layout
21964 This way svn client will automatically substitute revision number (e.g.
21969 \begin_layout Plain Layout
21976 ) after each update and commit.
21977 There are more problems with this approach.
21978 Firstly, the '$' character is used in \SpecialChar TeX
21979 world for math equations, so any
21980 occurence of math formula
21981 \begin_inset Formula $Rev$
21985 \begin_inset Formula $Rev:59$
21988 in your \SpecialChar LyX
21990 Similarly for other keywords like Id, Date, Author, etc.
21991 Secondly svn output is dependent on your locales, so its very easy that
21992 svn would produce some problematic strings once Date is used.
21993 Thirdly you get the whole 'Rev: 59' string in your document instead of
21995 Until subversion implements user's custom keywords it will be hard to use
21996 this approach reliably or let \SpecialChar LyX
21997 to support it directly.
22000 \begin_layout Subsection
22001 SVN and Windows Environment
22004 \begin_layout Quote
22005 My inclination is to say that if the user cannot figure out the command
22006 line operations on their own fairly quickly, they would be well advised
22007 to use TortoiseSVN.
22013 \begin_layout Subsubsection
22017 \begin_layout Standard
22018 In addition to installing \SpecialChar LyX
22019 , and having access to a Subversion repository,
22020 the user will need to install the Subversion client program.
22021 A Windows installer for the client program is available from
22022 \begin_inset CommandInset href
22025 target "http://www.collab.net/nonav/downloads/subversion/"
22030 The user may also want to install
22031 \begin_inset CommandInset href
22034 target "http://tortoisesvn.tigris.org/"
22038 , which integrates Subversion operations into the context (rightclick) menu
22039 of Windows Explorer.
22040 Operations done outside \SpecialChar LyX
22041 will typically be more convenient using the Explorer
22043 Note that TortoiseSVN is not a replacement for the client program, which
22044 is what \SpecialChar LyX
22048 \begin_layout Subsubsection
22049 Bringing a document under Subversion control
22052 \begin_layout Standard
22053 Before a \SpecialChar LyX
22054 document can be brought under version control in Subversion, its
22055 parent directory needs to be under version control.
22056 If the document is being added to a project already in the repository,
22057 this is accomplished by checking the project out to the directory where
22058 the new document will be placed.
22059 If the project itself is not yet under version control (for instance, if
22060 this document starts a new project), the directory must be imported into
22062 This is done outside \SpecialChar LyX
22064 Both import and checkout are easily accomplished from the Explorer context
22065 menu using TortoiseSVN, or alternatively can be done using the command
22066 line client at a DOS prompt.
22067 The procedure for importing the project using TortoiseSVN is described
22068 below, assuming an existing repository and a new project being started
22076 For information on using the Subversion client program, run
22083 \begin_layout Enumerate
22090 in Windows Explorer, right click it, and select
22092 TortoiseSVN\SpecialChar menuseparator
22096 If necessary, adjust the URL for the repository, then click OK.
22099 \begin_layout Enumerate
22100 Right click the level of the repository under which you want to place the
22101 new project folder (typically the top level) and click
22105 Supply a name for the project folder and click OK.
22106 Add a message for the log file if desired, then click OK again.
22107 The new project folder should appear in the repository.
22108 Finally, click OK again to exit the repository browser.
22111 \begin_layout Enumerate
22112 Once again right click
22118 , this time selecting SVN Checkout\SpecialChar ldots
22119 Select the URL of the project folder
22120 you just created in the repository, and set the checkout directory to
22128 You will be warned about a non-empty folder; click OK to proceed.
22129 You should now have a
22140 \begin_layout Enumerate
22141 Create or open your document in \SpecialChar LyX
22144 File\SpecialChar menuseparator
22146 \begin_inset space ~
22149 Control\SpecialChar menuseparator
22153 Add a log message and click OK to commit the document to version control.
22156 \begin_layout Standard
22157 From this point onward, you should have full functionality in the
22159 File\SpecialChar menuseparator
22161 \begin_inset space ~
22167 You also have the option of checking the document in and out, viewing its
22169 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22170 client program from a command prompt.
22173 \begin_layout Subsubsection
22174 SSH tunnel used with SVN under Windows
22177 \begin_layout Standard
22178 Compared with Linux setting up an svn client to communicate over ssh under
22179 Windows is a rather troublesome task.
22180 We will at least offer some hints how to setup the client side but prior
22181 knowledge about ssh and the Windows command line is needed, also be prepared
22182 for a great deal of frustration\SpecialChar ldots
22186 \begin_layout Enumerate
22187 Get an svn client for windows, as described in the previous sections.
22188 When it is a fresh install run some svn command (e.g.
22190 \begin_inset Flex Code
22193 \begin_layout Plain Layout
22199 ) to create config files, which you will need to change later on.
22202 \begin_layout Enumerate
22203 Choose an ssh client for Windows.
22204 There are several possibilities, we will use the one from Putty tools
22208 \begin_layout Plain Layout
22209 \begin_inset Flex URL
22212 \begin_layout Plain Layout
22214 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22225 You will need to set the connection up so that the client doesn't ask for
22226 any password from you.
22227 To keep things easy we will use only keys without any additional password
22229 \begin_inset Separator parbreak
22236 \begin_layout Enumerate
22238 \begin_inset Flex Code
22241 \begin_layout Plain Layout
22248 Save your private .ppk key file and put the public one on the server side.
22249 If the SVN server runs on Linux, note that the format of the public key
22250 is not compatible with Linux openssh and you will need to direcly copy-paste
22253 Public key for pasting into OpenSSH authorized_keys file
22255 :” edit field into the server's
22256 \begin_inset Flex Code
22259 \begin_layout Plain Layout
22260 ~/.ssh/authorized_keys
22266 \begin_inset Flex Code
22269 \begin_layout Plain Layout
22278 \begin_layout Enumerate
22280 \begin_inset Flex Code
22283 \begin_layout Plain Layout
22290 In the SVN config file
22294 \begin_layout Plain Layout
22295 Exact path depends on Windows version, usually somewhere around
22296 \begin_inset Flex Code
22299 \begin_layout Plain Layout
22302 Documents and Settings
22316 \begin_inset Flex Code
22319 \begin_layout Plain Layout
22334 , section [tunnels], setup ssh command, e.g.
22336 \begin_inset Flex Code
22339 \begin_layout Plain Layout
22340 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22349 \begin_layout Plain Layout
22350 It will usually take a lot of time to get exact command right and it depends
22352 For example do not have some remote server saved as a default session in
22354 If things fail, try to connect via plink without SVN first.
22363 \begin_layout Enumerate
22364 Checkout the SVN archive, e.
22365 \begin_inset space \thinspace{}
22369 \begin_inset Newline newline
22373 \begin_inset Flex Code
22376 \begin_layout Plain Layout
22377 svn co svn+ssh://user@server/repository_path
22385 \begin_layout Subsubsection
22386 End-of-Line Conversions
22389 \begin_layout Standard
22390 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22392 use different line endings inside the .lyx files.
22393 This is not a problem as far as \SpecialChar LyX
22394 functionality is concerned, but the commit
22395 diffs will be huge and merge-conflicts prone.
22396 Fortunately SVN itself knows
22400 \begin_layout Plain Layout
22401 \begin_inset Flex URL
22404 \begin_layout Plain Layout
22406 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22416 how to deal with CR/LF problems when switching .lyx files to the
22417 \begin_inset Flex Code
22420 \begin_layout Plain Layout
22430 \begin_layout Plain Layout
22432 \begin_inset Flex Code
22435 \begin_layout Plain Layout
22436 svn propset svn:eol-style native FILE_NAME
22449 \begin_layout Subsection
22450 GIT commands in \SpecialChar LyX
22454 \begin_layout Standard
22455 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22457 You can find the commands in the
22459 File\SpecialChar menuseparator
22461 \begin_inset space ~
22467 Please note that if you use password protected access to repository via
22468 ssh, you will be asked in terminal window.
22470 was tested against GIT 1.7.
22474 \begin_layout Plain Layout
22475 Windows users please note that you need to ensure that git is on the path.
22476 This can be set from within \SpecialChar LyX
22479 Tools\SpecialChar menuseparator
22480 Preferences\SpecialChar menuseparator
22481 Paths\SpecialChar menuseparator
22492 \begin_layout Standard
22493 One big difference of GIT and the other supported version control systems
22494 is the distributed nature of GIT: With traditional version control systems
22495 there is one central server which hosts the repository.
22496 Users commit their changes to the server, and get updates made by other
22498 With GIT, users commit to a local repository.
22499 The local repository can be synchronized with one or more remote repositories
22501 \begin_inset Flex Code
22504 \begin_layout Plain Layout
22511 \begin_inset Flex Code
22514 \begin_layout Plain Layout
22522 does not interact in any way with remote GIT repositories.
22523 It works exclusively with the local repository in a very similar way as
22524 with a central CVS or SVN repository.
22525 If you use remote GIT repositories you need to do the
22526 \begin_inset Flex Code
22529 \begin_layout Plain Layout
22536 \begin_inset Flex Code
22539 \begin_layout Plain Layout
22545 operations with your favourite GIT client.
22548 \begin_layout Subsubsection
22554 \begin_layout Standard
22555 If your document is not under revision control, this is the only item shown
22557 And if it is under revision control, the
22564 item is not visible.
22567 \begin_layout Standard
22568 This command registers in GIT your document ONLY in case you have already
22569 the documents directory under GIT control (in particular
22574 This means you have to checkout the archive by yourself.
22577 \begin_layout Standard
22578 Then you are asked interactively to supply an initial description of the
22580 Don't forget that registered file is not yet commited.
22583 \begin_layout Standard
22584 GIT command that is run:
22587 \begin_inset Quotes eld
22591 \begin_inset Quotes erd
22597 \begin_layout Standard
22602 to understand the switches.
22605 \begin_layout Subsubsection
22611 \begin_layout Standard
22612 When you are finished editing a file, you commit your changes.
22613 When you do this, you are asked for a description of the changes.
22614 After that changes are commited.
22617 \begin_layout Standard
22620 git commit -q -m"<description>" <file-name>
22623 \begin_layout Subsubsection
22626 Revert To Repository Version
22629 \begin_layout Standard
22630 This will discard all changes made to the document since the last check
22632 You get a warning before changes are discarded.
22635 \begin_layout Standard
22639 \begin_inset Quotes eld
22643 \begin_inset Quotes erd
22649 \begin_layout Subsubsection
22655 \begin_layout Standard
22656 This will rename the current document including the version history.
22657 It requires a clean document without any changes since the last checkin.
22658 You are asked for a file name and a description of the rename operation.
22659 After that the document is renamed, both locally and in the repository.
22660 If the parent directories of the new and old file names differ, all relative
22661 paths of included files are adjusted (like in
22663 File\SpecialChar menuseparator
22668 Finally, the document is reloaded using the new name.
22671 \begin_layout Labeling
22672 \labelwidthstring 00.00.0000
22674 \begin_inset space ~
22678 \begin_inset space ~
22682 \begin_inset Newline newline
22686 \begin_inset Flex Code
22689 \begin_layout Plain Layout
22693 \begin_inset Quotes eld
22697 \begin_inset Quotes erd
22701 \begin_inset Quotes eld
22705 \begin_inset Quotes erd
22714 \begin_inset Newline newline
22718 \begin_inset Flex Code
22721 \begin_layout Plain Layout
22730 \begin_layout Subsubsection
22736 \begin_layout Standard
22737 This shows the complete history of the GIT document.
22741 \begin_inset Quotes eld
22745 \begin_inset Quotes erd
22750 is shown in a browser.
22753 \begin_layout Subsubsection
22757 \begin_layout Standard
22759 supports GIT hash number of the last commit to the file, author name, date
22760 and time of last commit.
22761 All those are extracted from
22763 git log -n 1 --pretty=format:%H%n%an%n%ai
22766 Tree version information is obtained via
22768 git describe --abbrev --dirty --long
22772 \begin_inset CommandInset ref
22774 reference "subsec:VCS-Revision-Information"
22781 \begin_layout Subsection
22785 \begin_layout Standard
22786 With the recent addition of the vc-command function \SpecialChar LyX
22787 power users are allowed
22788 to create their own commands for revision control.
22791 \begin_layout Standard
22792 As an example you can see how two TortoiseSVN commands could be integrated
22796 \begin_layout Description
22798 \begin_inset Flex Code
22801 \begin_layout Plain Layout
22802 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
22810 \begin_layout Description
22812 \begin_inset Flex Code
22815 \begin_layout Plain Layout
22816 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
22824 \begin_layout Subsection
22825 Version control and Document comparison
22828 \begin_layout Standard
22829 One of the typical uses of version control is to inspect the changes between
22830 revisions, usually by creating
22831 \begin_inset Flex Code
22834 \begin_layout Plain Layout
22841 While this is useful for plain text files, it is much less useful in the
22842 case of \SpecialChar LyX
22843 files, which have more a complicated structure.
22844 Hence we provide binding to the Document comparison feature.
22845 There are two ways of calling this feature - either by direct call of
22846 \begin_inset Flex Code
22849 \begin_layout Plain Layout
22856 function (for details see \SpecialChar LyX
22857 functions manual) or by icon/menu item
22858 \begin_inset Flex MenuItem
22861 \begin_layout Plain Layout
22862 Compare with older revision...
22868 One can either compare two chosen revisions of the document or he can simply
22869 compare the current version of edited text with older revisions (where
22871 \begin_inset Flex MenuItem
22874 \begin_layout Plain Layout
22880 ' revisions back means comparison of the edited file with last commited
22885 \begin_layout Standard
22886 This feature is supported for SVN and RCS though due to the more complicated
22887 versioning scheme of RCS there is a constraint – when addressing the revisions
22888 in dialog, numbers always point to the last number in RCS revision number,
22891 We don't currently support GIT addressing of revisions, one can just compare
22892 edited document with its revision X steps backs, where X is addressed as
22896 \begin_layout Section
22897 Literate Programming
22900 \begin_layout Standard
22905 (kayvan@sylvan.com)
22909 original documentation written by
22911 Edmar Wienskoski Jr.
22914 (edmar-w-jr@technologist.com)
22917 \begin_layout Subsection
22921 \begin_layout Standard
22922 The main purpose of this documentation is to show you how to use \SpecialChar LyX
22924 programming, where it is assumed that you are familiar with this programming
22925 technique, and know what
22926 \begin_inset Quotes eld
22930 \begin_inset Quotes erd
22934 \begin_inset Quotes eld
22938 \begin_inset Quotes erd
22942 If that is not the case, please follow the web links provided in the following
22944 There is a lot of good documentation out there covering old development
22945 history to the latest tools tips.
22948 \begin_layout Standard
22949 It is also assumed that you are familiar with \SpecialChar LyX
22950 itself to a point that you
22951 are comfortable changing your \SpecialChar LyX
22952 preferences, and X resources file.
22953 If that is not the case please refer to other \SpecialChar LyX
22954 documentation to cover your
22958 \begin_layout Subsection
22959 Literate Programming
22962 \begin_layout Standard
22963 From the Literate Programming FAQ:
22966 \begin_layout Quotation
22967 Literate programming is the combination of documentation and source together
22968 in a fashion suited for reading by human beings.
22969 In fact, literate programs should be enjoyable reading, even inviting!
22970 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
22971 and documentation in a single file.
22972 Literate programming tools then parse the file to produce either readable
22973 documentation or compilable source.
22974 The WEB style of literate programming was created by D.
22975 \begin_inset space \thinspace{}
22979 Knuth during the development of his \SpecialChar TeX
22980 typesetting software.
22984 \begin_layout Standard
22985 Another excerpt says:
22988 \begin_layout Quotation
22991 How is literate programming different from verbose commenting?
22994 \begin_layout Quotation
22995 There are three distinguishing characteristics.
22996 In order of importance, they are:
22997 \begin_inset Separator parbreak
23004 \begin_layout Itemize
23005 flexible order of elaboration
23008 \begin_layout Itemize
23009 automatic support for browsing
23012 \begin_layout Itemize
23013 typeset documentation, especially diagrams and mathematics
23017 \begin_layout Standard
23018 Now that I sparked your curiosity, take a look in the references.
23021 \begin_layout Subsubsection
23025 \begin_layout Standard
23026 The complete Literate Programming FAQ can be found at:
23029 \begin_layout Quote
23030 Literate Programming FAQ
23031 \begin_inset Flex URL
23034 \begin_layout Plain Layout
23036 http://www.literateprogramming.com/lpfaq.pdf
23044 \begin_layout Standard
23045 The FAQ lists 23 (twenty three!) different literate programming tools.
23046 Where some are specialized or
23047 \begin_inset Quotes eld
23051 \begin_inset Quotes erd
23054 for particular programming languages, while other have general scope.
23059 for my own use for several reasons:
23062 \begin_layout Itemize
23063 It can generate the documentation either in \SpecialChar LaTeX
23067 \begin_layout Itemize
23068 It has a open architecture, i.
23069 \begin_inset space \thinspace{}
23073 \begin_inset space \space{}
23076 it is easy to plug in new filters and to perform special processing that
23081 \begin_layout Itemize
23082 There is a good selection of filters available already (the HTML is one
23086 \begin_layout Itemize
23090 \begin_layout Standard
23091 The Noweb web page can be found at:
23094 \begin_layout Quote
23096 \begin_inset Flex URL
23099 \begin_layout Plain Layout
23101 http://www.cs.virginia.edu/~nr/noweb/
23109 \begin_layout Standard
23110 Starting from there you can reach many other interesting links and even
23111 some literate program examples.
23114 \begin_layout Subsection
23116 and Literate Programming with Noweb
23119 \begin_layout Standard
23120 The \SpecialChar LyX
23121 support for Literate Programming is provided by using the generic \SpecialChar LyX
23123 converters mechanism.
23124 This support is provided in a
23125 \begin_inset Quotes eld
23129 \begin_inset Quotes erd
23133 \begin_inset space \thinspace{}
23137 \begin_inset space \space{}
23140 you will be able to use this new \SpecialChar LyX
23141 feature with some other literate programming
23142 tool of your choice by just changing your \SpecialChar LyX
23146 \begin_layout Subsubsection
23147 Generating documents and code (weaving and tangling)
23150 \begin_layout Paragraph
23151 Using the noweb module
23154 \begin_layout Standard
23155 If you have installed Noweb and \SpecialChar LyX
23156 successfully, whenever you open a new document,
23157 after you have chosen its document class, use the Document->Settings menu
23159 \begin_inset Quotes eld
23163 \begin_inset Quotes erd
23167 If Noweb is correctly installed, when you click on the
23168 \begin_inset Quotes eld
23172 \begin_inset Quotes erd
23175 link, you will see the
23176 \begin_inset Quotes eld
23180 \begin_inset Quotes erd
23183 module in the available list and you can add it to your document.
23186 \begin_layout Paragraph
23190 \begin_layout Standard
23192 enables you to write code with a layout named
23193 \begin_inset Flex Noun
23196 \begin_layout Plain Layout
23203 Noweb delimits chunks like this:
23206 \begin_layout LyX-Code
23210 \begin_layout LyX-Code
23214 \begin_layout LyX-Code
23218 \begin_layout LyX-Code
23222 \begin_layout LyX-Code
23226 \begin_layout Standard
23227 The problem is that whatever is written in between the << and the
23231 must be taken literally, i.
23232 \begin_inset space \thinspace{}
23236 \begin_inset space \space{}
23240 should be prevented from making any special interpretation of what has
23242 This is also handled by
23243 \begin_inset Flex Noun
23246 \begin_layout Plain Layout
23252 , that works like a normal paragraph but has a free spacing capability.
23255 \begin_layout Standard
23256 As a special note, you can also use the
23257 \begin_inset Quotes eld
23261 \begin_inset Quotes erd
23264 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23268 \begin_layout LyX-Code
23272 \begin_layout LyX-Code
23273 def some_function(args):
23276 \begin_layout LyX-Code
23277 "This is the doc string for this function."
23280 \begin_layout LyX-Code
23281 print "My args: ", args
23284 \begin_layout LyX-Code
23285 @ %def some_function
23288 \begin_layout Standard
23289 For an example of this usage and the resulting cross-reference output, look
23290 at the Literate python program in
23292 LIBDIR/examples/listerrors.lyx
23294 which should make this all clear.
23297 \begin_layout Paragraph
23298 Generating the documentation
23301 \begin_layout Standard
23302 At this point you already have a new document file with a proper document
23303 class, and with some code and text on it.
23304 How do I print it? The answer is simple, you select
23306 View\SpecialChar menuseparator
23310 Just like you would do for a plain document.
23311 No special procedure is required.
23314 \begin_layout Standard
23315 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23319 \begin_layout Enumerate
23322 Update\SpecialChar menuseparator
23325 menu option is chosen, a \SpecialChar LaTeX
23328 \begin_inset Separator parbreak
23335 \begin_layout Standard
23336 If the document is of any literate class the generated file will be named
23337 with an extension name defined by the
23338 \begin_inset Quotes eld
23342 \begin_inset Quotes erd
23345 format (defined in the Preferences panel), otherwise the file will have
23354 \begin_layout Enumerate
23355 Note that the only difference so far is in the name of the file, no special
23356 processing is required by \SpecialChar LyX
23358 Given that you formatted the code using the
23359 \begin_inset Flex Noun
23362 \begin_layout Plain Layout
23368 layout that, by itself, takes care of the business.
23371 \begin_layout Enumerate
23372 If the document is of any literate class \SpecialChar LyX
23373 will then use the internal \SpecialChar LyX
23375 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23380 \begin_layout Plain Layout
23381 The converters are defined in the
23383 Tools\SpecialChar menuseparator
23387 \begin_inset Quotes eld
23391 \begin_inset Quotes erd
23403 manual for general information about converters.
23408 to generate the \SpecialChar LaTeX
23410 \begin_inset Separator parbreak
23417 \begin_layout Standard
23418 Otherwise it will just skip this step.
23422 \begin_layout Enumerate
23423 Finally, \SpecialChar LaTeX
23424 is invoked and the regular post processing continues as in a plain
23428 \begin_layout Standard
23429 Independence from a particular
23430 \begin_inset Quotes eld
23434 \begin_inset Quotes erd
23437 is easily achieved by changing the commands that are run by the various
23441 \begin_layout Paragraph
23442 Generating the code
23445 \begin_layout Standard
23446 When the build menu option is chosen or the corresponding button in the
23447 toolbar is pressed, a \SpecialChar LaTeX
23448 file is generated just like step 1 above.
23449 Next, \SpecialChar LyX
23455 This converter needs to be defined by the user and is not installed by
23456 default, though the Program format is.
23457 This converter (like any other converter) will have two parts:
23460 \begin_layout Enumerate
23461 The converter program itself.
23462 This program performs the conversion from the one format to the other (in
23463 this case, from the Noweb format to the Program pseudo-format).
23466 \begin_layout Enumerate
23467 The error log parser.
23468 This is a program whose sole purpose is to rewrite error messages in a
23469 format that \SpecialChar LyX
23471 This makes it possible for \SpecialChar LyX
23472 to place error boxes in the right places in
23476 \begin_layout Standard
23477 The first part, the
23478 \begin_inset Quotes eld
23482 \begin_inset Quotes erd
23485 setting, should be set to
23486 \begin_inset Newline newline
23490 \begin_inset Quotes eld
23498 \begin_inset Quotes erd
23502 \begin_inset Newline newline
23505 This basically means that \SpecialChar LyX
23507 \begin_inset Quotes eld
23511 \begin_inset Quotes erd
23514 (a program or script) with the name of the Noweb file (normally a file
23515 in the \SpecialChar LyX
23516 temp directory) and the directory path of the original \SpecialChar LyX
23521 \begin_layout Standard
23522 This is an implementation of
23523 \begin_inset Quotes eld
23527 \begin_inset Quotes erd
23530 that you can place in a directory on your path:
23533 \begin_layout Standard
23534 \begin_inset VSpace defskip
23540 \begin_layout Standard
23541 \begin_inset Newpage pagebreak
23547 \begin_layout Standard
23553 \begin_layout Standard
23559 \begin_layout Standard
23562 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23565 \begin_layout Standard
23566 \begin_inset VSpace defskip
23572 \begin_layout Standard
23573 The next part of the converter setting is the
23574 \begin_inset Quotes eld
23578 \begin_inset Quotes erd
23581 which is to be set to
23582 \begin_inset Newline newline
23586 \begin_inset Quotes eld
23591 parselog=$$s/scripts/listerrors
23594 \begin_inset Quotes erd
23598 \begin_inset Newline newline
23601 This will run any errors that are generated by the
23602 \begin_inset Quotes eld
23606 \begin_inset Quotes erd
23609 process through the
23610 \begin_inset Quotes eld
23614 \begin_inset Quotes erd
23620 \begin_layout Standard
23621 The build will normally take place in \SpecialChar LyX
23622 's temporary directory, so the files
23623 produced by the conversion will be in that directory.
23625 will copy out what it regards as the `main' file, but the
23629 conversion may produce several files, and so most of these would then be
23630 deleted when \SpecialChar LyX
23632 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23633 the build-script chunk can place the generated files in that location.
23636 \begin_layout Paragraph
23637 Build instructions in the document
23640 \begin_layout Standard
23641 The last piece of the integration between \SpecialChar LyX
23643 \begin_inset Quotes eld
23647 \begin_inset Quotes erd
23651 Generally, the instructions for building your program should be embedded
23652 in a chunk of its own.
23654 \begin_inset Quotes eld
23658 \begin_inset Quotes erd
23661 above uses the notangle command to look for this chunk (called
23662 \begin_inset Quotes eld
23666 \begin_inset Quotes erd
23669 ) and runs its contents through
23670 \begin_inset Quotes eld
23674 \begin_inset Quotes erd
23680 \begin_layout Standard
23681 Typically, such a chunk would look something like this:
23684 \begin_layout LyX-Code
23688 \begin_layout LyX-Code
23690 \begin_inset Newline newline
23693 if [ -z "${NOWEB_SOURCE}" ]
23694 \begin_inset Newline newline
23700 \begin_layout LyX-Code
23701 NOWEB_SOURCE=myfile.nw
23702 \begin_inset Newline newline
23706 \begin_inset Newline newline
23710 code to extract files ...
23711 use NOWEB_OUTPUT_DIR here ...]
23712 \begin_inset Newline newline
23716 code to compile files ...]
23717 \begin_inset Newline newline
23723 \begin_layout Standard
23726 LIBDIR/examples/listerrors.lyx
23730 LIBDIR/examples/Literate.lyx
23732 which implement two versions of the
23733 \begin_inset Quotes eld
23737 \begin_inset Quotes erd
23740 program for some illustrations of how all of these pieces go together or
23743 LIBDIR/examples/noweb2lyx.lyx.
23746 Interestingly, these three files show off the language-indepence of the
23748 literate programming support since they are written in Python, C and Perl
23752 \begin_layout Subsubsection
23753 Configuring \SpecialChar LyX
23757 \begin_layout Standard
23758 All the Literate Programming support is configured by the
23760 Tools\SpecialChar menuseparator
23764 \begin_inset Quotes eld
23768 \begin_inset Quotes erd
23772 The important parts are:
23775 \begin_layout Description
23777 \begin_inset space ~
23781 \begin_inset Quotes eld
23785 \begin_inset Quotes erd
23789 \begin_inset space ~
23792 format Set up via the File Formats tab, this is where the Noweb-specific
23802 , the file extension is set to
23807 This tells \SpecialChar LyX
23808 to create a file with a
23812 extension in the first step of the conversion process.
23815 \begin_layout Description
23817 \begin_inset space ~
23825 \begin_inset space ~
23828 format This is an empty format whose sole purpose is to be the endpoint
23829 of a conversion (which then allows us to set up a converter for it).
23832 \begin_layout Description
23842 This converter performs the
23843 \begin_inset Quotes eld
23847 \begin_inset Quotes erd
23850 of the literate document.
23851 For Noweb, it is set to
23852 \begin_inset Quotes eld
23857 noweave -delay -index $$i > $$o
23860 \begin_inset Quotes erd
23866 \begin_layout Description
23876 \begin_inset Quotes eld
23880 \begin_inset Quotes erd
23884 As stated above, the Converter is set to
23885 \begin_inset Quotes eld
23893 \begin_inset Quotes erd
23896 , with Flags set to
23897 \begin_inset Newline newline
23901 \begin_inset Quotes eld
23906 parselog=$$s/scripts/listerrors
23909 \begin_inset Quotes erd
23915 \begin_layout Subsubsection
23919 \begin_layout Standard
23920 There is also a new function implemented in the \SpecialChar LyX
23922 \begin_inset Quotes eld
23925 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
23929 \begin_layout Standard
23930 When debugging code with ddd/gdb, it is possible to invoke a text editor
23931 at the current execution position with a single key stroke.
23932 The default ddd configuration for that is shift-ctrl-V.
23933 It happens that you can define the editor command line invocation in ddd
23936 Edit\SpecialChar menuseparator
23937 Preferences\SpecialChar menuseparator
23940 dialog and changing the "Edit Sources" entry.
23943 \begin_layout Standard
23944 I take advantage of the newly created \SpecialChar LyX
23945 server function and this ddd feature,
23947 \begin_inset Quotes eld
23951 \begin_inset Quotes erd
23957 \begin_layout Standard
23958 \begin_inset VSpace defskip
23964 \begin_layout Standard
23967 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
23970 \begin_layout Standard
23971 \begin_inset VSpace defskip
23977 \begin_layout Standard
23978 With this, whenever you are using ddd and find a point in the program that
23979 you want to edit, you just press shift-ctrl-V (in the ddd window), and
23980 ddd will forward this information to \SpecialChar LyX
23981 through the \SpecialChar LyX
23982 server and then the
23984 window will show the same file with the cursor at the same position ddd
23986 No more guessing or long scrolling to locate a point in the program back
23990 \begin_layout Standard
23991 Note however that you must enable the \SpecialChar LyX
23992 server to get this feature working
23993 (it is disabled by default).
23994 You can enable it in
24006 ) by entering in the
24012 \begin_inset Quotes eld
24017 /home/<your-home-directory>/.lyx/lyxpipe
24020 \begin_inset Quotes erd
24026 \begin_layout Standard
24027 Read the \SpecialChar LyX
24028 server documentation in the
24030 Customization Manual
24032 for further information.
24035 \begin_layout Subsubsection
24039 \begin_layout Standard
24040 There are six new buttons that can be added to your \SpecialChar LyX
24042 Five of these buttons are short cuts to layout styles:
24065 The last one is a short cut to the
24066 \begin_inset Quotes eld
24070 \begin_inset Quotes erd
24077 \begin_layout Standard
24079 has a range of buttons that are available for tool bar customization.
24080 In my toolbar I like to combine the six short cuts above with two more:
24085 \SpecialChar menuseparator
24090 \SpecialChar menuseparator
24097 Document\SpecialChar menuseparator
24098 View\SpecialChar menuseparator
24102 Here is how it looks like:
24105 \begin_layout LyX-Code
24109 \begin_layout LyX-Code
24113 \begin_layout LyX-Code
24114 Icon "layout Standard"
24117 \begin_layout LyX-Code
24118 Icon "layout Section"
24121 \begin_layout LyX-Code
24122 Icon "layout \SpecialChar LaTeX
24126 \begin_layout LyX-Code
24127 Icon "layout \SpecialChar LyX
24131 \begin_layout LyX-Code
24132 Icon "layout Chunk"
24135 \begin_layout LyX-Code
24139 \begin_layout LyX-Code
24143 \begin_layout LyX-Code
24144 Icon "buffer-typeset"
24147 \begin_layout LyX-Code
24148 Icon "build-program"
24151 \begin_layout LyX-Code
24155 \begin_layout LyX-Code
24159 \begin_layout LyX-Code
24163 \begin_layout LyX-Code
24167 \begin_layout LyX-Code
24171 \begin_layout Subsubsection
24172 Colors customization
24175 \begin_layout Standard
24176 There are a number of colors in \SpecialChar LyX
24177 that can be customized in
24182 One of the things that bothers people is the \SpecialChar LaTeX
24184 The default color is red, since the chunks uses \SpecialChar LaTeX
24185 font, and there is a lot
24186 of chunks in literate documents, you may get tired of seeing everything
24188 You can change it by going to the tabs
24197 \begin_layout Standard
24198 The next thing is the visible presence of the newline character in the screen.
24199 You can choose the color of this particular character and make it blend
24201 I recommend you choosing a color that is close to the background but not
24202 equal, that way you still can see it is there, but it is not bothering
24206 \begin_layout Subsection
24211 \begin_layout Standard
24220 is documented in the
24224 example file and in the Sweave manual (menu
24226 Help\SpecialChar menuseparator
24232 \begin_layout Chapter
24236 \begin_layout Standard
24237 You can do everything with \SpecialChar LyX
24238 that you can do with \SpecialChar LaTeX
24240 However, \SpecialChar LyX
24241 cannot support every \SpecialChar LaTeX
24243 But you can always use \SpecialChar TeX
24245 This chapter shows you some more special things you might want to use.
24246 For other special things you can do with figures, tables, floats, boxes
24247 and notes, have a look at the
24250 \begin_inset space ~
24258 \begin_layout Section
24259 Multiple Text Columns
24262 \begin_layout Standard
24263 This feature is independent of the option
24265 Two-column document
24267 in the document settings under
24272 If you want to have 2
24273 \begin_inset space ~
24276 columns for the whole document, it is recommended to use the
24278 Two-column document
24281 For all other cases use this feature.
24284 \begin_layout Standard
24285 To use multiple text columns in your document, you have to load the module
24292 Document\SpecialChar menuseparator
24293 Settings\SpecialChar menuseparator
24296 ) and must have the \SpecialChar LaTeX
24304 \begin_layout Standard
24305 Footnotes within multiple columns will be placed at the bottom of the page
24306 and not under each column.
24307 Within the different columns you can use everything, with the limitation
24308 that for floats you need to use the float option
24315 \begin_layout Subsection
24319 \begin_layout Standard
24320 If you want to have 2
24321 \begin_inset space ~
24324 columns in your text, insert a multicolumn inset via the menu
24326 Insert\SpecialChar menuseparator
24328 \begin_inset space ~
24331 Insets\SpecialChar menuseparator
24333 \begin_inset space ~
24338 where the columns should start.
24339 Write all text that should be printed in 2
24340 \begin_inset space ~
24343 columns into this inset.
24346 \begin_layout Standard
24347 Here is an example:
24350 \begin_layout Standard
24352 \begin_inset Flex Multiple Columns
24355 \begin_layout Plain Layout
24360 The Adventure of the Empty House
24363 \begin_inset Newline newline
24366 by Sir Arthur Conan Doyle
24369 \begin_layout Plain Layout
24372 It was in the spring of the year 1894 that all London was interested, and
24373 the fashionable world dismayed, by the murder of the Honourable Ronald
24374 Adair under most unusual and inexplicable circumstances.
24375 The public has already learned those particulars of the crime which came
24376 out in the police investigation, but a good deal was suppressed upon that
24377 occasion, since the case for the prosecution was so overwhelmingly strong
24378 that it was not necessary to bring forward all the facts.
24379 Only now, at the end of nearly ten years, am I allowed to supply those
24380 missing links which make up the whole of that remarkable chain.
24381 The crime was of interest in itself, but that interest was as nothing to
24382 me compared to the inconceivable sequel, which afforded me the greatest
24383 shock and surprise of any event in my adventurous life.
24384 Even now, after this long interval, I find myself thrilling as I think
24385 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24386 ty which utterly submerged my mind.
24387 Let me say to that public, which has shown some interest in those glimpses
24388 which I have occasionally given them of the thoughts and actions of a very
24389 remarkable man, that they are not to blame me if I have not shared my knowledge
24390 with them, for I should have considered it my first duty to do so, had
24391 I not been barred by a positive prohibition from his own lips, which was
24392 only withdrawn upon the third of last month.
24400 \begin_layout Standard
24401 To get 3 or more columns, set the cursor into the multicolumn inset and
24404 Insert\SpecialChar menuseparator
24406 \begin_inset space ~
24410 \begin_inset space ~
24416 The number of the desired columns is written into that inset (for 3
24417 \begin_inset space ~
24421 \begin_inset Quotes eld
24425 \begin_inset Quotes erd
24429 \begin_inset Newline newline
24432 Here is an example with 3
24433 \begin_inset space ~
24439 \begin_layout Standard
24440 \begin_inset Flex Multiple Columns
24443 \begin_layout Plain Layout
24446 \begin_inset Argument 1
24449 \begin_layout Plain Layout
24455 It can be imagined that my close intimacy with Sherlock Holmes had interested
24456 me deeply in crime, and that after his disappearance I never failed to
24457 read with care the various problems which came before the public.
24458 And I even attempted, more than once, for my own private satisfaction,
24459 to employ his methods in their solution, though with indifferent success.
24460 There was none, however, which appealed to me like this tragedy of Ronald
24462 As I read the evidence at the inquest, which led up to a verdict of willful
24463 murder against some person or persons unknown, I realized more clearly
24464 than I had ever done the loss which the community had sustained by the
24465 death of Sherlock Holmes.
24466 There were points about this strange business which would, I was sure,
24467 have specially appealed to him, and the efforts of the police would have
24468 been supplemented, or more probably anticipated, by the trained observation
24469 and the alert mind of the first criminal agent in Europe.
24470 All day, as I drove upon my round, I turned over the case in my mind and
24471 found no explanation which appeared to me to be adequate.
24472 At the risk of telling a twice-told tale, I will recapitulate the facts
24473 as they were known to the public at the conclusion of the inquest.
24481 \begin_layout Standard
24482 You can have up to 10
24483 \begin_inset space ~
24486 columns if you want to, but that might not be very pleasant for the readers
24490 \begin_layout Standard
24491 \begin_inset Newpage newpage
24497 \begin_layout Subsection
24498 Columns inside Columns
24501 \begin_layout Standard
24502 You can also have columns inside columns:
24505 \begin_layout Standard
24506 \begin_inset Flex Multiple Columns
24509 \begin_layout Plain Layout
24512 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24513 at that time governor of one of the Australian colonies.
24514 Adair's mother had returned from Australia to undergo the operation for
24515 cataract, and she, her son Ronald, and her daughter Hilda were living together
24519 \begin_layout Plain Layout
24520 \begin_inset Flex Multiple Columns
24523 \begin_layout Plain Layout
24526 The youth moved in the best society–had, so far as was known, no enemies
24527 and no particular vices.
24528 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24529 had been broken off by mutual consent some months before, and there was
24530 no sign that it had left any very profound feeling behind it.
24531 For the rest {sic} the man's life moved in a narrow and conventional circle,
24532 for his habits were quiet and his nature unemotional.
24533 Yet it was upon this easy-going young aristocrat that death came, in most
24534 strange and unexpected form, between the hours of ten and eleven-twenty
24535 on the night of March 30, 1894.
24543 \begin_layout Plain Layout
24546 Ronald Adair was fond of cards–playing continually, but never for such stakes
24548 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24549 It was shown that, after dinner on the day of his death, he had played
24550 a rubber of whist at the latter club.
24551 He had also played there in the afternoon.
24556 The evidence of those who had played with him– Mr.
24557 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24558 and that there was a fairly equal fall of the cards.
24559 Adair might have lost five pounds, but not more.
24560 His fortune was a considerable one, and such a loss could not in any way
24562 He had played nearly every day at one club or other, but he was a cautious
24563 player, and usually rose a winner.
24564 It came out in evidence that, in partnership with Colonel Moran, he had
24565 actually won as much as four hundred and twenty pounds in a sitting, some
24566 weeks before, from Godfrey Milner and Lord Balmoral.
24567 So much for his recent history as it came out at the inquest.
24575 \begin_layout Subsection
24579 \begin_layout Standard
24580 The examples in this section show some more special features of multiple
24584 \begin_layout Standard
24585 For more features of multiple columns, have a look at the documentation
24586 of the \SpecialChar LaTeX
24592 \begin_inset CommandInset citation
24601 \begin_layout Subsubsection
24605 \begin_layout Standard
24606 To add a preface text for multiple columns, set the cursor into the multicolumn
24607 inset and use the menu
24609 Insert\SpecialChar menuseparator
24613 Write your preface text into that inset.
24614 \begin_inset Newline newline
24617 This is an example with some preface text:
24620 \begin_layout Standard
24621 \begin_inset VSpace bigskip
24627 \begin_layout Standard
24628 \begin_inset Flex Multiple Columns
24631 \begin_layout Plain Layout
24632 \begin_inset Argument 2
24635 \begin_layout Plain Layout
24636 And the story continues and continues and continues and continues\SpecialChar ldots
24644 On the evening of the crime, he returned from the club exactly at ten.
24645 His mother and sister were out spending the evening with a relation.
24646 The servant deposed that she heard him enter the front room on the second
24647 floor, generally used as his sitting-room.
24648 She had lit a fire there, and as it smoked she had opened the window.
24649 No sound was heard from the room until eleven-twenty, the hour of the return
24650 of Lady Maynooth and her daughter.
24651 Desiring to say good-night, she attempted to enter her son's room.
24652 The door was locked on the inside, and no answer could be got to their
24653 cries and knocking.
24654 Help was obtained, and the door forced.
24655 The unfortunate young man was found lying near the table.
24656 His head had been horribly mutilated by an expanding revolver bullet, but
24657 no weapon of any sort was to be found in the room.
24665 \begin_layout Standard
24666 You can also use a section heading as the preface if you use a section command
24667 as \SpecialChar TeX
24669 For example the command
24672 \begin_layout Standard
24677 subsection{subsection title}
24680 \begin_layout Standard
24681 creates a subsection.
24682 In this example the preface is a subsubsection:
24685 \begin_layout Standard
24686 \begin_inset Flex Multiple Columns
24689 \begin_layout Plain Layout
24690 \begin_inset Argument 2
24693 \begin_layout Plain Layout
24697 \begin_layout Plain Layout
24706 This is a subsubsection heading as a preface
24710 \begin_layout Plain Layout
24724 A minute examination of the circumstances served only to make the case more
24726 In the first place, no reason could be given why the young man should have
24727 fastened the door upon the inside.
24728 There was the possibility that the murderer had done this, and had afterwards
24729 escaped by the window.
24730 The drop was at least twenty feet, however, and a bed of crocuses in full
24732 Neither the flowers nor the earth showed any sign of having been disturbed,
24733 nor were there any marks upon the narrow strip of grass which separated
24734 the house from the road.
24735 Apparently, therefore, it was the young man himself who had fastened the
24737 But how did he come by his death? No one could have climbed up to the window
24738 without leaving traces.
24739 Suppose a man had fired through the window, he would indeed be a remarkable
24740 shot who could with a revolver inflict so deadly a wound.
24741 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24742 a hundred yards of the house.
24743 No one had heard a shot.
24751 \begin_layout Standard
24752 If there is less vertical space than 6
24753 \begin_inset space ~
24756 text lines is left on the page at the beginning of the multiple columns,
24757 a page break will be inserted before the multiple columns.
24758 Depending on the number of lines of the preface text, you might want to
24760 This is done by setting the cursor into the mulitcolumn inset behind the
24761 preface (if there is any) and using the menu
24763 Insert\SpecialChar menuseparator
24765 \begin_inset space ~
24769 \begin_inset space ~
24773 \begin_inset space ~
24779 Insert into that inset the amount of space like e.
24780 \begin_inset space \thinspace{}
24784 \begin_inset space \space{}
24788 \begin_inset Quotes eld
24792 \begin_inset Quotes erd
24796 \begin_inset Newline newline
24799 In this example the space is set to 7
24800 \begin_inset space ~
24803 text lines by using
24804 \begin_inset Quotes eld
24810 \begin_inset Quotes erd
24819 needs to be inserted as \SpecialChar TeX
24823 \begin_layout Standard
24824 \begin_inset Flex Multiple Columns
24827 \begin_layout Plain Layout
24828 \begin_inset Argument 3
24831 \begin_layout Plain Layout
24836 \begin_layout Plain Layout
24852 On the evening of the crime, he returned from the club exactly at ten.
24853 His mother and sister were out spending the evening with a relation.
24854 The servant deposed that she heard him enter the front room on the second
24855 floor, generally used as his sitting-room.
24856 She had lit a fire there, and as it smoked she had opened the window.
24857 No sound was heard from the room until eleven-twenty, the hour of the return
24858 of Lady Maynooth and her daughter.
24859 Desiring to say good-night, she attempted to enter her son's room.
24860 The door was locked on the inside, and no answer could be got to their
24861 cries and knocking.
24862 Help was obtained, and the door forced.
24863 The unfortunate young man was found lying near the table.
24864 His head had been horribly mutilated by an expanding revolver bullet, but
24865 no weapon of any sort was to be found in the room.
24873 \begin_layout Subsubsection
24877 \begin_layout Standard
24878 The amount of space before and after multiple columns can be changed by
24879 changing the length
24886 For example the command
24889 \begin_layout Standard
24899 \begin_layout Standard
24900 in \SpecialChar TeX
24901 Code changes its value to 3
24902 \begin_inset space \thinspace{}
24906 The change must be made before the multiple columns' start.
24907 The predefined value is 13
24908 \begin_inset space \thinspace{}
24914 \begin_layout Standard
24922 \begin_inset space \thinspace{}
24928 \begin_layout Standard
24932 \begin_layout Plain Layout
24938 multicolsep}{2.5cm}
24946 \begin_layout Standard
24947 \begin_inset Flex Multiple Columns
24950 \begin_layout Plain Layout
24953 All day I turned these facts over in my mind, endeavouring to hit upon some
24954 theory which could reconcile them all, and to find that line of least resistanc
24955 e which my poor friend had declared to be the starting-point of every investigat
24957 I confess that I made little progress.
24958 In the evening I strolled across the Park, and found myself about six o'clock
24959 at the Oxford Street end of Park Lane.
24960 A group of loafers upon the pavements, all staring up at a particular window,
24961 directed me to the house which I had come to see.
24962 A tall, thin man with coloured glasses, whom I strongly suspected of being
24963 a plain-clothes detective, was pointing out some theory of his own, while
24964 the others crowded round to listen to what he said.
24965 I got as near him as I could, but his observations seemed to me to be absurd,
24966 so I withdrew again in some disgust.
24967 As I did so I struck against an elderly, deformed man, who had been behind
24968 me, and I knocked down several books which he was carrying.
24976 \begin_layout Standard
24977 \begin_inset Note Greyedout
24980 \begin_layout Plain Layout
24985 The values you set with
24991 will be used for all following multiple columns until you change them again.
24999 \begin_layout Standard
25003 \begin_layout Plain Layout
25015 \begin_inset Note Note
25018 \begin_layout Plain Layout
25019 go back to the default
25027 \begin_layout Standard
25028 \begin_inset Newpage newpage
25034 \begin_layout Subsubsection
25038 \begin_layout Standard
25039 A column break can be forced by inserting the command
25045 as \SpecialChar TeX
25046 Code to that position in the text where the column should be broken.
25047 Note that this leads in most cases to whitespace in the text.
25048 \begin_inset Newline newline
25051 Here is an example:
25054 \begin_layout Standard
25055 \begin_inset Flex Multiple Columns
25058 \begin_layout Plain Layout
25061 \begin_inset Quotes eld
25064 You're surprised to see me, sir,
25065 \begin_inset Quotes erd
25068 said he, in a strange, croaking voice.
25071 \begin_layout Plain Layout
25074 I acknowledged that I was.
25077 \begin_layout Plain Layout
25080 \begin_inset Quotes eld
25083 Well, I've a conscience, sir, and when I chanced to see you go into this
25084 house, as I came hobbling after you, I thought to myself, I'll just step
25085 in and see that kind gentleman, and tell him that if I was a bit gruff
25086 in my manner there was not any harm meant, and that I am much obliged to
25087 him for picking up my books.
25088 \begin_inset Quotes erd
25094 \begin_layout Plain Layout
25097 \begin_inset Quotes eld
25100 You make too much of a trifle,
25101 \begin_inset Quotes erd
25106 \begin_inset Quotes eld
25109 May I ask how you knew who I was?
25110 \begin_inset Quotes erd
25113 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25117 \begin_layout Plain Layout
25129 \begin_layout Plain Layout
25132 \begin_inset Quotes eld
25135 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25136 you'll find my little bookshop at the corner of Church Street, and very
25137 happy to see you, I am sure.
25138 Maybe you collect yourself, sir.
25142 \begin_inset space ~
25155 –a bargain, every one of them.
25156 With five volumes you could just fill that gap on that second shelf.
25157 It looks untidy, does it not, sir?
25158 \begin_inset Quotes erd
25169 \begin_layout Subsubsection
25173 \begin_layout Standard
25174 The width of the columns is automatically calculated, but you can modify
25175 the space between the columns.
25176 This is done by changing the length
25183 Its predefined value is 10
25184 \begin_inset space \thinspace{}
25188 Here is an example where
25195 \begin_inset space \thinspace{}
25201 \begin_layout Standard
25205 \begin_layout Plain Layout
25219 \begin_layout Standard
25220 \begin_inset Flex Multiple Columns
25223 \begin_layout Plain Layout
25226 My observations of No.
25227 \begin_inset space \space{}
25230 427 Park Lane did little to clear up the problem in which I was interested.
25231 The house was separated from the street by a low wall and railing, the
25232 whole not more than five feet high.
25233 It was perfectly easy, therefore, for anyone to get into the garden, but
25234 the window was entirely inaccessible, since there was no water pipe or
25235 anything which could help the most active man to climb it.
25236 More puzzled than ever, I retraced my steps to Kensington.
25237 I had not been in my study five minutes when the maid entered to say that
25238 a person desired to see me.
25239 To my astonishment it was none other than my strange old book collector,
25240 his sharp, wizened face peering out from a frame of white hair, and his
25241 precious volumes, a dozen of them at least, wedged under his right arm.
25249 \begin_layout Standard
25253 \begin_layout Plain Layout
25265 \begin_inset Note Note
25268 \begin_layout Plain Layout
25269 go back to the default
25277 \begin_layout Subsubsection
25281 \begin_layout Standard
25282 Between the columns a rule with a width of the length
25289 If this rule width is set to 0
25290 \begin_inset space \thinspace{}
25293 pt (this is the default), the rule is suppressed.
25294 In the following example the rule is 2
25295 \begin_inset space \thinspace{}
25301 \begin_layout Standard
25305 \begin_layout Plain Layout
25311 columnseprule}{2pt}
25319 \begin_layout Standard
25320 \begin_inset Flex Multiple Columns
25323 \begin_layout Plain Layout
25326 \begin_inset Quotes eld
25329 You're surprised to see me, sir,
25330 \begin_inset Quotes erd
25333 said he, in a strange, croaking voice.
25336 \begin_layout Plain Layout
25339 I acknowledged that I was.
25342 \begin_layout Plain Layout
25345 \begin_inset Quotes eld
25348 Well, I've a conscience, sir, and when I chanced to see you go into this
25349 house, as I came hobbling after you, I thought to myself, I'll just step
25350 in and see that kind gentleman, and tell him that if I was a bit gruff
25351 in my manner there was not any harm meant, and that I am much obliged to
25352 him for picking up my books.
25353 \begin_inset Quotes erd
25359 \begin_layout Plain Layout
25362 \begin_inset Quotes eld
25365 You make too much of a trifle,
25366 \begin_inset Quotes erd
25371 \begin_inset Quotes eld
25374 May I ask how you knew who I was?
25375 \begin_inset Quotes erd
25381 \begin_layout Plain Layout
25384 \begin_inset Quotes eld
25387 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25388 you'll find my little bookshop at the corner of Church Street, and very
25389 happy to see you, I am sure.
25390 Maybe you collect yourself, sir.
25394 \begin_inset space ~
25407 –a bargain, every one of them.
25408 With five volumes you could just fill that gap on that second shelf.
25409 It looks untidy, does it not, sir?
25410 \begin_inset Quotes erd
25421 \begin_layout Standard
25422 \begin_inset VSpace defskip
25428 \begin_layout Standard
25429 The rule can be colored by redefining the command
25436 This is done by inserting the command
25437 \begin_inset Newline newline
25446 columnseprulecolor}{
25451 \begin_inset Newline newline
25454 as \SpecialChar TeX
25455 Code before the multicolumn inset.
25460 in this command by a color of your choice.
25461 You can use all pre- and self-defined colors.
25469 \begin_inset space ~
25474 for more information about pre- and self-defined colors.
25475 To go back to the default color insert the command
25476 \begin_inset Newline newline
25485 columnseprulecolor}{
25490 \begin_inset Newline newline
25493 Here is the example with a cyan rule and 1
25494 \begin_inset space \thinspace{}
25497 cm column separation:
25500 \begin_layout Standard
25504 \begin_layout Plain Layout
25513 \begin_layout Plain Layout
25519 columnseprulecolor}{
25529 \begin_layout Standard
25530 \begin_inset Flex Multiple Columns
25533 \begin_layout Plain Layout
25536 \begin_inset Quotes eld
25539 You're surprised to see me, sir,
25540 \begin_inset Quotes erd
25543 said he, in a strange, croaking voice.
25546 \begin_layout Plain Layout
25549 I acknowledged that I was.
25552 \begin_layout Plain Layout
25555 \begin_inset Quotes eld
25558 Well, I've a conscience, sir, and when I chanced to see you go into this
25559 house, as I came hobbling after you, I thought to myself, I'll just step
25560 in and see that kind gentleman, and tell him that if I was a bit gruff
25561 in my manner there was not any harm meant, and that I am much obliged to
25562 him for picking up my books.
25563 \begin_inset Quotes erd
25569 \begin_layout Plain Layout
25572 \begin_inset Quotes eld
25575 You make too much of a trifle,
25576 \begin_inset Quotes erd
25581 \begin_inset Quotes eld
25584 May I ask how you knew who I was?
25585 \begin_inset Quotes erd
25591 \begin_layout Plain Layout
25594 \begin_inset Quotes eld
25597 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25598 you'll find my little bookshop at the corner of Church Street, and very
25599 happy to see you, I am sure.
25600 Maybe you collect yourself, sir.
25604 \begin_inset space ~
25617 –a bargain, every one of them.
25618 With five volumes you could just fill that gap on that second shelf.
25619 It looks untidy, does it not, sir?
25620 \begin_inset Quotes erd
25631 \begin_layout Standard
25635 \begin_layout Plain Layout
25641 columnseprule}{0pt}
25644 \begin_layout Plain Layout
25650 columnseprulecolor}{
25658 \begin_inset Note Note
25661 \begin_layout Plain Layout
25662 go back to the default
25670 \begin_layout Section
25671 Non-standard Paragraph Shapes
25674 \begin_layout Standard
25677 as well as any other text processor uses by default rectangular paragraphs.
25678 For special cases like for example posters, invitation cards or poems you
25679 can modify the paragraph shape to one of your choice.
25680 This can be done by using the \SpecialChar LaTeX
25685 which is loaded by using in the document settings the module
25687 Custom paragraph shapes
25692 \begin_layout Subsection
25696 \begin_layout Standard
25701 provides the following shapes:
25704 \begin_layout Standard
25705 \begin_inset Tabular
25706 <lyxtabular version="3" rows="13" columns="3">
25707 <features booktabs="true" islongtable="true" longtabularalignment="center">
25708 <column alignment="center" valignment="middle" width="16col%">
25709 <column alignment="center" valignment="middle" width="40col%">
25710 <column alignment="center" valignment="middle" width="35col%">
25711 <row endhead="true">
25712 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25715 \begin_layout Plain Layout
25721 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25724 \begin_layout Plain Layout
25730 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25733 \begin_layout Plain Layout
25741 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25744 \begin_layout Plain Layout
25750 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25753 \begin_layout Plain Layout
25754 Circle with circular hole (in the size of a CD/DVD)
25759 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25762 \begin_layout Plain Layout
25763 Cannot be scaled, take care there is not too much text
25770 <cell alignment="center" valignment="top" topline="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
25788 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25791 \begin_layout Plain Layout
25792 Fragile, calculation might fail
25799 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25802 \begin_layout Plain Layout
25808 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25811 \begin_layout Plain Layout
25812 Rhomboid (symbolizing a
25813 \begin_inset Quotes eld
25817 \begin_inset Quotes erd
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
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
25907 Nut for bolt (hexagon with circular hole)
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" leftline="true" usebox="none">
25926 \begin_layout Plain Layout
25932 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25935 \begin_layout Plain Layout
25941 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25944 \begin_layout Plain Layout
25952 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25955 \begin_layout Plain Layout
25961 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25964 \begin_layout Plain Layout
25970 <cell alignment="center" valignment="top" topline="true" bottomline="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
25999 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26002 \begin_layout Plain Layout
26010 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26013 \begin_layout Plain Layout
26019 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26022 \begin_layout Plain Layout
26023 Normal/reversed rain drop
26028 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26031 \begin_layout Plain Layout
26032 Fragile, calculation might fail
26039 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26042 \begin_layout Plain Layout
26049 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26052 \begin_layout Plain Layout
26053 The \SpecialChar TeX
26059 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26062 \begin_layout Plain Layout
26070 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26073 \begin_layout Plain Layout
26075 \begin_inset Newline newline
26083 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26086 \begin_layout Plain Layout
26087 Triangles in different orientations
26092 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26095 \begin_layout Plain Layout
26109 \begin_layout Standard
26110 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26112 for environments in the toolbar.
26115 \begin_layout Standard
26116 \begin_inset Newpage newpage
26122 \begin_layout Standard
26123 Here is an example paragraph in the shape of a nut:
26126 \begin_layout Standard
26127 \begin_inset VSpace bigskip
26136 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26137 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26139 At vero eos et accusam et justo duo dolores et ea rebum.
26140 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26142 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26143 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26147 \begin_layout Standard
26148 \begin_inset VSpace bigskip
26154 \begin_layout Standard
26155 \begin_inset Note Greyedout
26158 \begin_layout Plain Layout
26163 : shapepar paragraphs cannot run over a page break.
26171 \begin_layout Standard
26172 \begin_inset VSpace bigskip
26178 \begin_layout Standard
26183 takes care that the shape will always be preserved, no matter how much
26184 text is in the paragraph.
26185 Therefore the paragraph size changes with the amount of contained text.
26186 This can lead to paragraph sizes exceeding the page margins.
26187 To demonstrate the size scaling, here is the same example paragraph but
26188 with twice as much text:
26191 \begin_layout Standard
26192 \begin_inset Newpage newpage
26201 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26202 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26204 At vero eos et accusam et justo duo dolores et ea rebum.
26205 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26207 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26208 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26210 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26211 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26213 At vero eos et accusam et justo duo dolores et ea rebum.
26214 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26216 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26217 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26221 \begin_layout Standard
26222 \begin_inset VSpace bigskip
26228 \begin_layout Standard
26229 An exception is the shape
26234 It cannot be scaled because it must fit the size of a CD/DVD.
26235 Therefore the amount of text that fits into the shape is limited.
26236 \begin_inset Newline newline
26247 shape are fragile, meaning that the calculation of their size can fail,
26248 depending on the amount of text.
26249 You will then get the \SpecialChar LaTeX
26251 \begin_inset Quotes eld
26254 Arithmetic overflow
26255 \begin_inset Quotes erd
26259 In this case one can try to remove or add some text; if nothing works one
26260 has to use another shape.
26263 \begin_layout Standard
26264 \begin_inset VSpace bigskip
26270 \begin_layout Standard
26271 For shapes with tips you will maybe see that \SpecialChar LaTeX
26272 's hyphenation routine fails
26273 for text in the tips.
26274 Therefore it is often necessary to add hyphenation points
26279 arg "specialchar-insert hyphenation"
26284 ) to the corresponding text parts.
26287 \begin_layout Standard
26288 \begin_inset VSpace bigskip
26294 \begin_layout Standard
26295 Shapepar paragraphs are either always centered or placed on the page so
26296 that their left border touches the left page margin.
26297 You can therefore not use the paragraph dialog to align such paragraphs.
26298 A solution is to put the paragraph into a minipage or parbox and align
26300 The problem is hereby to find the right width for the box.
26301 Because if it is too wide and you center the box, the paragraph is not
26302 centered too because it sticks at the left side of the box.
26303 So you might have to play a bit with the width until it fits.
26304 Here are two heart-shaped paragraphs, the first one is not aligned, the
26305 second one is right-aligned:
26308 \begin_layout Standard
26309 \begin_inset Newpage newpage
26315 \begin_layout Heart
26319 Lo\SpecialChar softhyphen
26320 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26321 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26323 At vero eos et accusam et justo duo dolores et ea rebum.
26324 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26328 \begin_layout Standard
26329 \begin_inset VSpace bigskip
26335 \begin_layout Standard
26338 \begin_inset Box Frameless
26348 height_special "totalheight"
26353 backgroundcolor "none"
26356 \begin_layout Heart
26360 Lo\SpecialChar softhyphen
26361 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26362 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26364 At vero eos et accusam et justo duo dolores et ea rebum.
26365 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26374 \begin_layout Subsection
26378 \begin_layout Standard
26379 You can define any shape you want.
26380 Doing this manually is a lot of work because every coordinate must be specified.
26381 But there is a way to let the computer calculate the coordinates:
26384 \begin_layout Enumerate
26385 Install the program
26386 \begin_inset CommandInset href
26389 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26396 \begin_layout Enumerate
26403 TeX/LaTeX\SpecialChar menuseparator
26404 Settings\SpecialChar menuseparator
26407 and select the font size you are using in your document.
26408 For example this document uses the size 12
26409 \begin_inset space \thinspace{}
26415 \begin_layout Enumerate
26419 \begin_layout Enumerate
26422 TeX/LaTeX\SpecialChar menuseparator
26425 to export the shape to coordinates.
26426 In the appearing dialog use either the outline of your shape for the coordinate
26427 s or the path itself.
26431 \begin_layout Plain Layout
26432 For more information see
26433 \begin_inset CommandInset href
26435 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26447 \begin_layout Standard
26448 The coordinates are written into a \SpecialChar TeX
26450 To use it for your \SpecialChar LyX
26454 \begin_layout Enumerate
26455 Place the cursor before the first character of your paragraph (or into a
26459 \begin_layout Enumerate
26460 Open in \SpecialChar LyX
26463 Insert\SpecialChar menuseparator
26464 File\SpecialChar menuseparator
26466 \begin_inset space ~
26471 , select the file and use
26480 \begin_layout Standard
26481 \begin_inset VSpace defskip
26487 \begin_layout Standard
26488 \begin_inset Note Greyedout
26491 \begin_layout Plain Layout
26496 : The changed shape only applies to the current paragraph; everything is
26497 reset to normal for the next paragraph.
26498 Therefore the shape definition file must be input into every paragraph
26499 with the desired shape.
26507 \begin_layout Standard
26508 \begin_inset VSpace bigskip
26514 \begin_layout Standard
26515 Here is an example:
26518 \begin_layout Standard
26519 \begin_inset VSpace bigskip
26525 \begin_layout Standard
26526 \begin_inset CommandInset include
26528 filename "SpecialParagraphShape.tex"
26534 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26535 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26537 At vero eos et accusam et justo duo dolores et ea rebum.
26538 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26540 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26541 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26545 \begin_layout Standard
26546 \begin_inset VSpace bigskip
26552 \begin_layout Standard
26557 to draw complexer shapes in
26561 you can draw the shape in a program of your choice and import the resulting
26567 Then you only need to draw a line or spline along the outline of the image.
26570 \begin_layout Standard
26571 \begin_inset VSpace bigskip
26577 \begin_layout Standard
26580 Custom paragraph shapes
26582 also provides the two commands
26590 which can be used to define custom shapes coordinate by coordinate.
26594 \begin_layout Plain Layout
26595 These commands are internally used for all shapes described here.
26600 For information how these styles are used and about further customization
26601 possibilities, have a look at the documentation of the package
26606 \begin_inset CommandInset citation
26615 \begin_layout Bibliography
26616 \begin_inset CommandInset bibitem
26617 LatexCommand bibitem
26622 Documentation of the \SpecialChar LaTeX
26624 \begin_inset CommandInset href
26627 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26634 \begin_layout Bibliography
26635 \begin_inset CommandInset bibitem
26636 LatexCommand bibitem
26641 Documentation of the \SpecialChar LaTeX
26643 \begin_inset CommandInset href
26646 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"