1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
5 \origin /systemlyxdir/doc/
8 % DO NOT ALTER THIS PREAMBLE!!!
10 % This preamble is designed to ensure that the manual prints
11 % out as advertised. If you mess with this preamble,
12 % parts of the manual may not print out as expected. If you
13 % have problems LaTeXing this file, please contact
14 % the documentation team
15 % email: lyx-docs@lists.lyx.org
21 % set fonts for nicer pdf view
22 \IfFileExists{lmodern.sty}
23 {\usepackage{lmodern}}{}
25 \fi % end if pdflatex is used
27 % the pages of the TOC are numbered roman
28 % and a PDF-bookmark for the TOC is added
30 \let\myTOC\tableofcontents
31 \renewcommand{\tableofcontents}{%
32 \pdfbookmark[1]{\contentsname}{}
35 \pagenumbering{arabic}}
37 % extra space for tables
38 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
40 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
41 \use_default_options false
49 \maintain_unincluded_children false
52 InsetLayout CharStyle:MenuItem
61 \newcommand*{\menuitem}[1]{{\sffamily #1}}
66 \language_package default
69 \font_roman "default" "default"
70 \font_sans "default" "default"
71 \font_typewriter "default" "default"
72 \font_math "auto" "auto"
73 \font_default_family default
74 \use_non_tex_fonts false
77 \font_sf_scale 100 100
78 \font_tt_scale 100 100
80 \default_output_format default
82 \bibtex_command default
83 \index_command default
87 \pdf_title "LyX's Additional Features manual"
88 \pdf_author "LyX Team"
89 \pdf_subject "LyX's additional features documentation"
90 \pdf_keywords "LyX, Documentation, Additional"
92 \pdf_bookmarksnumbered true
93 \pdf_bookmarksopen false
94 \pdf_bookmarksopenlevel 1
99 \pdf_pdfusetitle false
100 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
103 \use_package amsmath 1
104 \use_package amssymb 1
105 \use_package cancel 0
107 \use_package mathdots 1
108 \use_package mathtools 0
109 \use_package mhchem 1
110 \use_package stackrel 0
111 \use_package stmaryrd 0
112 \use_package undertilde 0
114 \cite_engine_type default
118 \paperorientation portrait
122 \notefontcolor #0000ff
129 \paragraph_separation indent
130 \paragraph_indentation default
131 \quotes_language english
134 \paperpagestyle headings
135 \tracking_changes true
136 \output_changes false
140 \author -712698321 "Jürgen Spitzmüller"
141 \author -195340706 "Georg Baum"
142 \author 711066561 "Enrico Forestieri"
148 Additional \SpecialChar LyX
152 \begin_layout Subtitle
157 by the \SpecialChar LyX
162 \begin_layout Plain Layout
164 Principal maintainer of this file is
169 If you have comments or error corrections, please send them to the \SpecialChar LyX
172 \begin_inset Flex Code
175 \begin_layout Plain Layout
177 <lyx-docs@lists.lyx.org>
190 \begin_layout Standard
191 \begin_inset CommandInset toc
192 LatexCommand tableofcontents
199 \begin_layout Chapter
203 \begin_layout Standard
204 This manual is essentially Part II of the
206 User's Guide\SpecialChar endofsentence
209 The reason for separating the two documents is simple: the
213 is already quite lengthy, and it contains information on all of the basic
214 features one needs to know in order to prepare most documents.
215 However, the \SpecialChar LyX
216 Team has worked to make \SpecialChar LyX
217 extensible through various configuration
218 files and external packages.
219 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
221 create a layout file (or module) for it without having to alter \SpecialChar LyX
223 We've already had contributions of several new features this way, and some
224 of them are documented here.
225 There are also some more `advanced' features, such as how to control the
226 presentation of bibliographies and how to work with multi-part documents,
227 that are not covered in the
231 and are discussed here.
234 \begin_layout Standard
235 This manual also documents some special features, like fax support, version
236 control, and SGML support, which require additional software to work properly.
237 There is also a chapter on \SpecialChar LyX
239 And lastly, there's a chapter of \SpecialChar LaTeX
240 tools and tips, things you can use to
241 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
243 After all, \SpecialChar LyX
248 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
252 \begin_layout Standard
253 If you haven't read the
257 yet, you are definitely in the wrong manual.
262 is the first place to go, since it describes the notation and format of
264 You should also be thoroughly familiar with the
268 and all of the basic features of \SpecialChar LyX
269 before attempting to read this one.
272 \begin_layout Standard
273 Since many of the topics in this manual depend heavily on \SpecialChar LyX
275 with \SpecialChar LaTeX
276 , this first chapter covers the inner workings of \SpecialChar LyX
279 to generate exactly the \SpecialChar LaTeX
281 It is obviously for more seasoned \SpecialChar LyX
285 \begin_layout Chapter
287 and \SpecialChar LaTeX
291 \begin_layout Section
293 Uses \SpecialChar LaTeX
297 \begin_layout Standard
298 This chapter is for both \SpecialChar TeX
299 -nicians and the \SpecialChar LaTeX
301 In it, we'll explain how \SpecialChar LyX
302 and \SpecialChar LaTeX
303 work together to produce printable output.
304 This is the only place in any of the manuals where we assume you know something
305 about \SpecialChar LaTeX
309 \begin_layout Standard
310 At one time, \SpecialChar LyX
312 \begin_inset Quotes eld
315 WYSIWYM frontend to \SpecialChar LaTeX
317 \begin_inset Quotes erd
320 but that's no longer true.
321 There are frontends to \SpecialChar LaTeX
326 \begin_layout Plain Layout
327 Some familar ones are \SpecialChar TeX
328 maker and kile, on Linux, and \SpecialChar TeX
330 There are also the \SpecialChar LaTeX
331 modes for vi and emacs, of course.
336 These are basically text editors with the ability to run \SpecialChar LaTeX
338 errors in the file you're editing.
339 Although \SpecialChar LyX
348 run \SpecialChar LaTeX
349 , and it also indicates errors in the file, it also does much, much
351 For one thing, you don't need to know \SpecialChar LaTeX
352 to use \SpecialChar LyX
355 has added its own extensions to \SpecialChar LaTeX
357 Try the following sometime: select
358 \begin_inset Flex MenuItem
361 \begin_layout Plain Layout
362 Export\SpecialChar menuseparator
370 \begin_inset Flex MenuItem
373 \begin_layout Plain Layout
380 \begin_inset Flex MenuItem
383 \begin_layout Plain Layout
384 View\SpecialChar menuseparator
394 ), then look at the preamble of the resulting
395 \begin_inset Flex Code
398 \begin_layout Plain Layout
405 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
407 These macros are defined automatically, according to the features you use
411 \begin_layout Standard
412 There are several commands that automatically invoke \SpecialChar LaTeX
417 \begin_layout Itemize
418 \begin_inset Flex MenuItem
421 \begin_layout Plain Layout
422 Document\SpecialChar menuseparator
431 \begin_layout Itemize
432 \begin_inset Flex MenuItem
435 \begin_layout Plain Layout
436 Document\SpecialChar menuseparator
445 \begin_layout Itemize
446 \begin_inset Flex MenuItem
449 \begin_layout Plain Layout
450 File\SpecialChar menuseparator
459 \begin_layout Itemize
460 \begin_inset Flex MenuItem
463 \begin_layout Plain Layout
464 File\SpecialChar menuseparator
473 \begin_layout Standard
474 They will only invoke \SpecialChar LaTeX
475 if the file has changed since the last time \SpecialChar LaTeX
481 \begin_layout Standard
482 When \SpecialChar LyX
483 runs \SpecialChar LaTeX
484 on the file you're editing, it performs these steps:
487 \begin_layout Enumerate
488 Convert the document to \SpecialChar LaTeX
489 and save to a file with the extension
490 \begin_inset Flex Code
493 \begin_layout Plain Layout
500 \begin_inset Flex Code
503 \begin_layout Plain Layout
512 \begin_layout Enumerate
513 Run \SpecialChar LaTeX
515 \begin_inset Flex Code
518 \begin_layout Plain Layout
524 file (maybe several times), and run any other commands (such as
525 \begin_inset Flex Code
528 \begin_layout Plain Layout
535 \begin_inset Flex Code
538 \begin_layout Plain Layout
544 ) needed to compile the \SpecialChar LaTeX
548 \begin_layout Enumerate
549 If there are any errors, show the error log.
552 \begin_layout Standard
553 If you have run \SpecialChar LaTeX
555 \begin_inset Flex MenuItem
558 \begin_layout Plain Layout
561 \SpecialChar menuseparator
570 then runs a DVI viewer to display the DVI-file.
572 \begin_inset Flex MenuItem
575 \begin_layout Plain Layout
578 \SpecialChar menuseparator
587 performs further steps:
590 \begin_layout Itemize
592 \begin_inset Flex Code
595 \begin_layout Plain Layout
601 to convert the DVI file to PostScript.
604 \begin_layout Itemize
605 Run a PostScript viewer, such as
606 \begin_inset Flex Code
609 \begin_layout Plain Layout
615 , to display the PostScript file.
618 \begin_layout Standard
620 does similar things when viewing, or exporting, other formats.
623 \begin_layout Section
624 Translating \SpecialChar LaTeX
625 files into \SpecialChar LyX
629 \begin_layout Standard
630 You can import a \SpecialChar LaTeX
631 file into \SpecialChar LyX
633 \begin_inset Flex MenuItem
636 \begin_layout Plain Layout
637 File\SpecialChar menuseparator
638 Import\SpecialChar menuseparator
645 command in \SpecialChar LyX
647 This will call a program named
648 \begin_inset Flex Code
651 \begin_layout Plain Layout
657 which will create a file
658 \begin_inset Flex Code
661 \begin_layout Plain Layout
668 \begin_inset Flex Code
671 \begin_layout Plain Layout
679 will then open that file.
683 \begin_layout Plain Layout
684 \begin_inset Flex Code
687 \begin_layout Plain Layout
693 can also be run from the command line, of course.
701 \begin_layout Standard
702 \begin_inset Flex Code
705 \begin_layout Plain Layout
711 will translate most legal \SpecialChar LaTeX
712 , but not everything.
713 It will put things it doesn't understand into \SpecialChar TeX
714 code, so after translating
716 \begin_inset Flex Code
719 \begin_layout Plain Layout
725 , you can look for \SpecialChar TeX
726 code and hand-edit it until it looks right.
729 \begin_layout Standard
730 If you don't know what \SpecialChar TeX
731 code is, read the next section.
734 \begin_layout Section
735 \begin_inset CommandInset label
737 name "sec:Inserting-TeX-Code"
741 Inserting \SpecialChar TeX
742 Code into \SpecialChar LyX
746 \begin_layout Standard
747 Anything you can do in \SpecialChar LaTeX
748 you can do in \SpecialChar LyX
749 , for a very simple reason: You can
750 always insert \SpecialChar TeX
751 code into any \SpecialChar LyX
754 cannot, and will never be able to, display every possible \SpecialChar LaTeX
756 If ever you need to insert \SpecialChar LaTeX
757 commands into your \SpecialChar LyX
758 document, you can use the
760 \begin_inset Flex Code
763 \begin_layout Plain Layout
770 box, which you can insert into your document with
771 \begin_inset Flex MenuItem
774 \begin_layout Plain Layout
775 Insert\SpecialChar menuseparator
777 \change_deleted -712698321 1437633182
780 \change_inserted -712698321 1437633182
792 or the keyboard shortcut
801 \begin_layout Standard
802 Here's an example of inserting \SpecialChar LaTeX
803 commands in a \SpecialChar LyX
805 The code looks like this:
808 \begin_layout LyX-Code
812 \begin_inset Newline newline
818 \begin_inset Newline newline
821 This is an example of a minipage environment.
823 \begin_inset Newline newline
826 can put nearly everything in it, even (non-floating)
827 \begin_inset Newline newline
832 \begin_inset Newline newline
838 \begin_inset Newline newline
842 \begin_inset Newline newline
848 \begin_inset Newline newline
854 \begin_inset Newline newline
860 \begin_inset Newline newline
865 \begin_inset Newline newline
871 \begin_inset Newline newline
877 \begin_inset Newline newline
883 \begin_inset Newline newline
891 \begin_layout LyX-Code
895 \begin_layout Standard
897 \begin_inset Flex Code
900 \begin_layout Plain Layout
907 box containing this text is directly after this paragraph.
908 Those of you reading the manual in \SpecialChar LyX
909 will only see the \SpecialChar TeX
911 Those reading a printed version of the manuals will see the actual results:
912 \begin_inset VSpace bigskip
918 \begin_layout Standard
922 \begin_layout Plain Layout
929 \begin_layout Plain Layout
936 \begin_layout Plain Layout
938 This is an example of a minipage environment.
939 You can put nearly everything in it, even (non-floating) figures and tables.
943 \begin_layout Plain Layout
950 \begin_layout Plain Layout
955 \begin_layout Plain Layout
962 \begin_layout Plain Layout
969 \begin_layout Plain Layout
976 \begin_layout Plain Layout
982 \begin_layout Plain Layout
989 \begin_layout Plain Layout
996 \begin_layout Plain Layout
1003 \begin_layout Plain Layout
1013 \begin_inset VSpace bigskip
1019 \begin_layout Standard
1020 In addition to using \SpecialChar TeX
1021 code, you can also create a separate file containing
1022 some complex \SpecialChar LaTeX
1023 structure and then use
1024 \begin_inset Flex MenuItem
1027 \begin_layout Plain Layout
1028 Insert\SpecialChar menuseparator
1030 \begin_inset space ~
1038 to include your file (you should select the type
1039 \begin_inset Flex Code
1042 \begin_layout Plain Layout
1049 We recommend that you only do this if you have a
1050 \begin_inset Flex Code
1053 \begin_layout Plain Layout
1064 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1068 \begin_layout Standard
1069 There are a few last points to emphasize:
1072 \begin_layout Itemize
1078 check if your \SpecialChar LaTeX
1082 \begin_layout Itemize
1083 Beware of reinventing the wheel.
1086 \begin_layout Standard
1087 On that last point, \SpecialChar LyX
1088 does have quite a few features tucked into it, and
1090 Be sure to check the manuals to make sure that \SpecialChar LyX
1091 doesn't have such-and-such
1092 feature before you decide you have to do it by hand.
1093 Moreover, there are numerous \SpecialChar LaTeX
1094 packages out there to do all sorts of things,
1095 from labels to envelopes to fancy multipage tables.
1097 \begin_inset CommandInset href
1100 target "http://www.ctan.org/"
1107 \begin_layout Standard
1108 If you do need to do some wild and fancy things within your document, be
1109 sure to check out a good \SpecialChar LaTeX
1110 book for assistance.
1111 There are a number of them listed in the bibliography of the
1118 \begin_layout Section
1120 and the \SpecialChar LaTeX
1124 \begin_layout Subsection
1125 About the \SpecialChar LaTeX
1129 \begin_layout Standard
1130 If you already know \SpecialChar LaTeX
1131 , there is no need to explain here what the preamble
1133 If you don't, the following will give you some ideas—we recommend again
1134 that you consult a \SpecialChar LaTeX
1135 book for further information.
1136 In any case, you should read the points below, because they explain what
1137 you can do and what you don't need to do in the \SpecialChar LaTeX
1138 preamble of a \SpecialChar LyX
1142 \begin_layout Standard
1143 The \SpecialChar LaTeX
1144 preamble comes at the very beginning of a document,
1152 \begin_layout Itemize
1153 Declare the document class.
1155 \begin_inset Newline newline
1159 already does this for you.
1160 If you're a seasoned \SpecialChar LaTeX
1161 -nician, and you have a custom document class you
1162 want to use, check out the
1164 Customization Manual
1166 for information on how to make \SpecialChar LyX
1170 \begin_layout Itemize
1171 Declare the usage of packages.
1173 \begin_inset Newline newline
1177 packages provide special commands, which are only available within a document
1178 when the package has been declared in the preamble.
1179 In addition to providing special commands, the inclusion of a package can
1180 change the document.
1181 For example, the package
1182 \begin_inset Flex Code
1185 \begin_layout Plain Layout
1191 forces all paragraphs to be indented.
1192 There are other packages for labels, envelopes, margins, etc.
1196 \begin_layout Itemize
1197 Set counters, variables, lengths and widths.
1199 \begin_inset Newline newline
1202 There are several \SpecialChar LaTeX
1203 counters and variables that
1207 be set globally from within the preamble in order to have the desired effect.
1208 (There are variables that you can set and reset inside the document, too.)
1209 Margins are a good example of something that must be set in the preamble.
1210 Another example is the label format for lists.
1211 You can actually set these just about anywhere, but it's best to do it
1212 just once, inside the preamble.
1215 \begin_layout Itemize
1216 Declare user defined commands (with
1217 \begin_inset Flex Code
1220 \begin_layout Plain Layout
1229 \begin_inset Flex Code
1232 \begin_layout Plain Layout
1241 \begin_inset Newline newline
1244 These are abbreviations for \SpecialChar LaTeX
1245 commands which appear very often inside a document.
1246 Although the preamble is a good place to declare such commands, they
1250 be declared anywhere (before they are used for the first time, of course).
1251 This can be useful if there is a lot of raw \SpecialChar LaTeX
1252 code in your document, which
1253 normally should not be the case.
1256 \begin_layout Standard
1258 adds its own set of definitions to the preamble of the
1259 \begin_inset Flex Code
1262 \begin_layout Plain Layout
1269 This makes \SpecialChar LaTeX
1270 files generated by \SpecialChar LyX
1274 \begin_layout Subsection
1275 Changing the Preamble
1278 \begin_layout Standard
1279 The commands which \SpecialChar LyX
1280 adds to the preamble of a \SpecialChar LaTeX
1281 file are fixed; you can't
1282 change them without patching \SpecialChar LyX
1284 You can, however, add your own stuff to the preamble by selecting
1285 \begin_inset Flex MenuItem
1288 \begin_layout Plain Layout
1291 \begin_inset space ~
1300 \begin_inset Flex MenuItem
1303 \begin_layout Plain Layout
1304 Document\SpecialChar menuseparator
1312 adds anything in the
1313 \begin_inset Flex MenuItem
1316 \begin_layout Plain Layout
1322 dialog to its own built-in preamble.
1323 Before adding your own declarations in the preamble, you should make sure
1324 that \SpecialChar LyX
1325 doesn't already support what you want to do.
1326 (Remember what we said about reinventing the wheel?) Also,
1328 make sure your preamble code is correct
1332 doesn't check it for you.
1333 If there is an error, you're likely to get an error like
1334 \begin_inset Quotes eld
1338 \begin_inset Flex Code
1341 \begin_layout Plain Layout
1350 \begin_inset Quotes erd
1354 If you see this error, check your preamble.
1357 \begin_layout Subsection
1361 \begin_layout Standard
1362 Here are some examples of what you can add to a preamble, and what they
1366 \begin_layout Subsubsection
1370 \begin_layout Standard
1371 There are two variables under \SpecialChar LaTeX
1372 that control page position:
1373 \begin_inset Flex Code
1376 \begin_layout Plain Layout
1385 \begin_inset Flex Code
1388 \begin_layout Plain Layout
1397 Their names should be self-explanatory.
1398 These variables are useful if you think for a moment about computer labels.
1399 Sometimes, the size of a print medium and the area of the medium that you
1400 can actually print on aren't the same.
1402 \begin_inset Flex Code
1405 \begin_layout Plain Layout
1414 \begin_inset Flex Code
1417 \begin_layout Plain Layout
1428 \begin_layout Standard
1429 The default values for
1430 \begin_inset Flex Code
1433 \begin_layout Plain Layout
1442 \begin_inset Flex Code
1445 \begin_layout Plain Layout
1454 \begin_inset space \thinspace{}
1458 \begin_inset space \thinspace{}
1462 \begin_inset space \space{}
1465 the page isn't shifted.
1466 Unfortunately, some DVI drivers always seem to shift the page.
1467 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1468 If you're using \SpecialChar LyX
1469 on a system that you don't personally maintain, and your
1470 sysadmin is a doofus,
1471 \begin_inset Flex Code
1474 \begin_layout Plain Layout
1483 \begin_inset Flex Code
1486 \begin_layout Plain Layout
1495 Suppose your left and top margins are always 0.5
1496 \begin_inset space \thinspace{}
1500 You can add this to the preamble:
1503 \begin_layout LyX-Code
1511 \begin_layout LyX-Code
1519 \begin_layout Standard
1520 and your margins should now be correct.
1523 \begin_layout Subsubsection
1527 \begin_layout Standard
1528 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1529 There's a rather nice package, available at your nearest CTAN archive,
1530 for printing sheets of labels:
1531 \begin_inset Flex Code
1534 \begin_layout Plain Layout
1541 Now, your system may not have this package installed by default.
1542 We leave that up to you to check.
1543 You'll also want to read the documentation for it; we're not going to do
1545 Since this is an example, however, we'll give you an example of how you
1549 \begin_layout Standard
1550 First, make sure you're using the
1551 \begin_inset Flex Code
1554 \begin_layout Plain Layout
1561 Next, you need to put the following in your preamble:
1564 \begin_layout LyX-Code
1570 \begin_layout LyX-Code
1576 \begin_layout LyX-Code
1582 \begin_layout LyX-Code
1588 \begin_layout LyX-Code
1594 \begin_layout LyX-Code
1600 \begin_layout LyX-Code
1606 \begin_layout Standard
1607 This sets things up for Avery label sheets, stock #5360.
1608 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1611 \begin_inset Flex Code
1614 \begin_layout Plain Layout
1623 \begin_inset Flex Code
1626 \begin_layout Plain Layout
1634 around each label text.
1635 This and other special features of
1636 \begin_inset Flex Code
1639 \begin_layout Plain Layout
1645 are explained in its documentation.
1648 \begin_layout Standard
1649 Someday, someone may write a \SpecialChar LyX
1650 layout file to support this package directly.
1651 Maybe that someone is you.
1654 \begin_layout Subsubsection
1655 Example #3: Paragraph Indentation
1658 \begin_layout Standard
1659 Americans are trained to indent the first line of
1664 As with all of their other weird quirks, most Americans will whine and
1665 moan until they can have their way and indent the first line of all paragraphs.
1674 \begin_layout Standard
1675 Of course, this behavior isn't standard typography.
1676 In books, you typically only indent the first line of a paragraph
1680 it follows another one.
1681 The idea behind indenting the first line of a paragraph is to distinguish
1682 neighboring paragraphs from one another.
1683 If there is no previous paragraph—for example, if it follows a figure or
1684 is the first paragraph in a section—then there is no need for indentation.
1688 \begin_layout Standard
1689 If you're a typical American (we're still joking!), though, you don't care
1690 about such esoteric things; you want your indentation! Add this to the
1694 \begin_layout LyX-Code
1697 usepackage{indentfirst}
1700 \begin_layout Standard
1701 If your \SpecialChar TeX
1702 distribution isn't braindead, you'll have this package, and all
1703 of your paragraphs will get the indentation the Founding Fathers intended
1707 \begin_layout Subsubsection
1708 Example #4: This Document
1711 \begin_layout Standard
1712 You can also check out the preamble of this document to get an idea of some
1713 of the advanced things you can do.
1716 \begin_layout Section
1718 and \SpecialChar LaTeX
1722 \begin_layout Standard
1723 When \SpecialChar LyX
1724 calls \SpecialChar LaTeX
1725 , it tells \SpecialChar LaTeX
1726 to blithely ignore any errors and keep going.
1727 It then uses the logfile from the \SpecialChar LaTeX
1728 run to do a post-mortem.
1729 After analyzing the logfile, \SpecialChar LyX
1730 displays a dialog listing the errors.
1731 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1733 where the error occurred.
1737 \begin_layout Plain Layout
1739 Analyzing the logfile is a tough job, and \SpecialChar LyX
1740 doesn't always go to the right
1742 There are also cases where \SpecialChar LaTeX
1743 reports the error on one line, but the actual
1745 This is not unlike forgetting a closing brace in a program: You'll get
1746 an error, but only later.
1754 \begin_layout Standard
1755 Some folks also like to look at the log file directly: It is available from
1757 \begin_inset Flex MenuItem
1760 \begin_layout Plain Layout
1763 \SpecialChar menuseparator
1767 \begin_inset space ~
1776 There are some fairly common error messages and warnings.
1777 We'll cover those here.
1778 You should look at a good \SpecialChar LaTeX
1779 book for a complete listing.
1782 \begin_layout Itemize
1783 \begin_inset Flex Code
1786 \begin_layout Plain Layout
1794 \begin_inset Newline newline
1797 Anything beginning with these words is a warning message for the purpose
1799 \begin_inset Quotes eld
1803 \begin_inset Quotes erd
1806 the \SpecialChar LaTeX
1808 You'll get messages like this if you added or changed cross-references
1809 or bibliography entries, in which case, \SpecialChar LaTeX
1810 is trying to tell you that you
1811 need to make another run.
1812 You can by-and-large ignore these.
1815 \begin_layout Itemize
1816 \begin_inset Flex Code
1819 \begin_layout Plain Layout
1827 \begin_inset Newline newline
1830 Another warning message, this time about fonts which \SpecialChar LaTeX
1832 The rest of the message will often say something about a replacement font
1833 that \SpecialChar LaTeX
1835 You can safely ignore these, too.
1838 \begin_layout Itemize
1839 \begin_inset Flex Code
1842 \begin_layout Plain Layout
1851 \begin_inset Newline newline
1860 They are warnings about lines that were too long and run past the right
1862 Almost always, this is unnoticeable in the final output.
1863 (It can be just a point or two.) Or, only one or two characters extend past
1866 seems to generate at least one of these messages for just about any document
1868 \begin_inset Newline newline
1871 You can ignore these messages.
1872 Your eyes will tell you if there's a problem with something that's too
1873 wide; just look at the output.
1877 \begin_layout Plain Layout
1878 You can also enable the `draft' option in
1879 \begin_inset Flex MenuItem
1882 \begin_layout Plain Layout
1885 \SpecialChar menuseparator
1893 , and then \SpecialChar LaTeX
1894 will draw a black box in the margin of lines that are overfull.
1902 \begin_layout Itemize
1903 \begin_inset Flex Code
1906 \begin_layout Plain Layout
1915 \begin_inset Newline newline
1918 Not quite as common as its cousin.
1920 seems to like to print lines that are a bit too wide as opposed to ones
1921 that are a bit too narrow.
1922 We have no idea why.
1925 \begin_layout Itemize
1926 \begin_inset Flex Code
1929 \begin_layout Plain Layout
1938 \begin_inset Flex Code
1941 \begin_layout Plain Layout
1950 \begin_inset Newline newline
1953 Warnings about troubles breaking the page.
1954 Once again, just look at the output.
1955 Your eyes will tell you where something has gone wrong.
1958 \begin_layout Itemize
1959 \begin_inset Flex Code
1962 \begin_layout Plain Layout
1965 \begin_inset Quotes els
1969 \begin_inset Quotes ers
1978 \begin_inset Newline newline
1982 \begin_inset Quotes eld
1986 \begin_inset Quotes erd
1989 isn't installed on this system.
1990 This usually appears because some package your document needs isn't installed.
1991 If you didn't touch the preamble or didn't use the
1992 \begin_inset Flex Code
1995 \begin_layout Plain Layout
2003 command, then one of the packages \SpecialChar LyX
2004 tried to load is missing.
2006 \begin_inset Flex MenuItem
2009 \begin_layout Plain Layout
2010 Help\SpecialChar menuseparator
2017 to get a list of packages that \SpecialChar LyX
2019 This file is updated whenever you reconfigure \SpecialChar LyX
2021 \begin_inset Flex MenuItem
2024 \begin_layout Plain Layout
2025 Tools\SpecialChar menuseparator
2031 ) and tells you which packages have been detected and what they do.
2032 \begin_inset Newline newline
2036 \begin_inset Flex Code
2039 \begin_layout Plain Layout
2047 command and the package in question isn't installed, then you'll need to
2048 install it yourself.
2051 \begin_layout Itemize
2052 \begin_inset Flex Code
2055 \begin_layout Plain Layout
2057 Error: Unknown option
2063 \begin_inset Newline newline
2066 Error messages beginning with this are trying to tell you that you specified
2067 a bad or undefined option to a package.
2068 Check the package's documentation.
2071 \begin_layout Itemize
2072 \begin_inset Flex Code
2075 \begin_layout Plain Layout
2076 Undefined control sequence
2082 \begin_inset Newline newline
2085 If you've inserted \SpecialChar LaTeX
2086 code into your document, but made a typo, you'll get
2088 You may have forgotten to load a package.
2089 In any case, this error message usually means that you used an undefined
2094 \begin_layout Standard
2095 There are other error and warning messages.
2096 Some are self-explanatory.
2097 These are usually \SpecialChar LaTeX
2099 Others are downright cryptic.
2100 These are usually \SpecialChar TeX
2101 error messages, and we really have
2105 what they mean or how to decipher them.
2109 \begin_layout Standard
2110 There's a general sequence you should follow if you get error messages:
2113 \begin_layout Enumerate
2114 Look at the \SpecialChar LaTeX
2115 code you inserted for typos.
2118 \begin_layout Enumerate
2119 If there are no typos, check that you used the command(s) correctly.
2122 \begin_layout Enumerate
2123 If you get a bunch of error boxes piled up at the very top of the document—and
2124 especially if you see a
2125 \begin_inset Quotes eld
2129 \begin_inset Flex Code
2132 \begin_layout Plain Layout
2141 \begin_inset Quotes erd
2144 error—it means that there are errors in the preamble.
2145 Start debugging your preamble.
2148 \begin_layout Enumerate
2149 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2151 document, the first suspect is your \SpecialChar LaTeX
2152 distribution itself.
2153 Check for missing packages and install them.
2156 \begin_layout Enumerate
2157 Okay, so there are no missing packages.
2158 Did you use any of the fine-tuning options in \SpecialChar LyX
2159 ? Specifically, did you
2163 any of them, like trying to manually insert lots of
2164 \begin_inset Flex Code
2167 \begin_layout Plain Layout
2169 \begin_inset space ~
2178 \begin_inset Flex Code
2181 \begin_layout Plain Layout
2188 \begin_inset Flex Code
2191 \begin_layout Plain Layout
2197 ? Did you try to kludge something together with these instead of using the
2198 appropriate paragraph environment?
2201 \begin_layout Enumerate
2202 All right, you didn't use any of the fine-tuning options, you played by
2204 Did you try to pull a fancy maneuver? Did you do something funky inside
2205 a table or an equation, like inserting a graphic into a table cell?
2208 \begin_layout Enumerate
2209 Do you have long sections of text where \SpecialChar LaTeX
2210 cannot find a place to break a
2211 line? By default, \SpecialChar LaTeX
2212 is rather strict about how much extra inter-word spacing
2213 it will add in order to break a line.
2214 Preferably, you should rework the paragraph to avoid the problem.
2215 If this isn't an option, you can wrap your text in
2216 \begin_inset Flex Code
2219 \begin_layout Plain Layout
2227 to make \SpecialChar LaTeX
2228 's line breaking more, well, sloppy.
2231 \begin_layout Enumerate
2232 Did you go overboard with the nesting? \SpecialChar LyX
2233 (currently) doesn't check to make
2234 sure you're in the limits for nesting environments.
2235 If you nested a bunch of environments to the
2236 \begin_inset Formula $17^{\mathrm{th}}$
2239 level, that's the problem.
2240 (The limit in \SpecialChar LaTeX
2244 \begin_layout Enumerate
2245 Okay, you didn't get any error messages, but your output looks awful.
2246 If you have a table or figure that's too wide or long for the page, you
2248 \begin_inset Separator parbreak
2255 \begin_layout Enumerate
2256 rescale the figure so it fits.
2259 \begin_layout Enumerate
2260 trim down the table so it fits.
2264 \begin_layout Enumerate
2265 If something else is wrong with the output, and you didn't try to pull anything
2266 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2269 \begin_layout Standard
2270 If all this doesn't help—well, then
2274 you might have found a bug in \SpecialChar LyX
2279 \begin_layout Chapter
2283 \begin_layout Section
2284 Customizing Bibliographies with Bib\SpecialChar TeX
2288 \begin_layout Standard
2289 The most basic information about how to use Bib\SpecialChar TeX
2290 with \SpecialChar LyX
2294 Bibliography databases (Bib\SpecialChar TeX
2302 The following subsections explain special bibliography features supported
2307 \begin_layout Subsection
2308 Alternative Citation Styles
2311 \begin_layout Standard
2312 Standard Bib\SpecialChar TeX
2314 \begin_inset space \thinspace{}
2318 \begin_inset space \space{}
2322 \begin_inset Quotes eld
2326 \begin_inset Quotes erd
2329 ) to refer to a cited work.
2330 However, in many scientific disciplines, other citation styles are in use.
2331 The most common one is the author-year style (e.
2332 \begin_inset space \thinspace{}
2336 \begin_inset space \space{}
2340 \begin_inset Quotes eld
2344 \begin_inset Quotes erd
2349 supports two packages that provide this style,
2350 \begin_inset Flex Code
2353 \begin_layout Plain Layout
2360 \begin_inset Flex Code
2363 \begin_layout Plain Layout
2370 Both packages have their pros and cons, which cannot be listed in detail.
2371 If you only want to have simple author-year (or author-numerical) style,
2372 or if you want to use one of the countless style files for
2373 \begin_inset Flex Code
2376 \begin_layout Plain Layout
2382 , then the established
2383 \begin_inset Flex Code
2386 \begin_layout Plain Layout
2392 package is probably your choice.
2393 If you need special features like short title references, ibidem etc., you
2395 \begin_inset Flex Code
2398 \begin_layout Plain Layout
2407 \begin_layout Standard
2408 The handling of both packages in \SpecialChar LyX
2409 is basically the same.
2411 \begin_inset Flex MenuItem
2414 \begin_layout Plain Layout
2415 Document\SpecialChar menuseparator
2422 \begin_inset Flex MenuItem
2425 \begin_layout Plain Layout
2432 \begin_inset Flex MenuItem
2435 \begin_layout Plain Layout
2442 \begin_inset Flex MenuItem
2445 \begin_layout Plain Layout
2452 With both packages, you will get some extra features in the citation dialog
2453 and you can select the style of the reference (
2454 \begin_inset Quotes eld
2458 \begin_inset Quotes erd
2462 \begin_inset Quotes eld
2466 \begin_inset Quotes erd
2470 \begin_inset Quotes eld
2474 \begin_inset Quotes erd
2478 \begin_inset Quotes eld
2482 \begin_inset Quotes erd
2486 Note that both packages need specifically designed style files.
2487 They both ship their own, but there are lots of additional style files,
2488 and there is even an interactive style file builder
2492 \begin_layout Plain Layout
2494 \begin_inset Flex URL
2497 \begin_layout Plain Layout
2499 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2510 \begin_inset Flex Code
2513 \begin_layout Plain Layout
2522 \begin_layout Subsection
2523 Sectioned Bibliographies
2526 \begin_layout Standard
2527 Sometimes you might need to divide your bibliography into several sections.
2528 If you are for instance a historian, the possibility to separate sources
2529 and scientific works is most likely a
2530 \begin_inset Quotes eld
2534 \begin_inset Quotes erd
2538 Unfortunately, Bib\SpecialChar TeX
2539 itself does not allow you to do this.
2540 But with the help of some \SpecialChar LaTeX
2541 packages, Bib\SpecialChar TeX
2542 can be extended to fit your needs.
2545 \begin_layout Standard
2547 provides native support for one of these packages,
2555 \begin_layout Plain Layout
2557 \begin_inset Flex URL
2560 \begin_layout Plain Layout
2562 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2572 The advantage of this package (compared to other packages like
2576 ) is that you don't need to define new citation commands.
2577 Instead, you need to prepare different bibliographic databases which include
2578 the entries for the different sections of the bibliography.
2579 For example: If you want to divide your bibliography into the sections
2581 \begin_inset Quotes eld
2585 \begin_inset Quotes erd
2589 \begin_inset Quotes eld
2593 \begin_inset Quotes erd
2596 , you first need to create two bibliographic databases, e.
2597 \begin_inset space \thinspace{}
2601 \begin_inset space \space{}
2605 \begin_inset Flex Code
2608 \begin_layout Plain Layout
2615 \begin_inset Flex Code
2618 \begin_layout Plain Layout
2628 \begin_layout Standard
2630 \begin_inset Flex MenuItem
2633 \begin_layout Plain Layout
2634 Document\SpecialChar menuseparator
2641 \begin_inset Flex MenuItem
2644 \begin_layout Plain Layout
2651 \begin_inset Flex MenuItem
2654 \begin_layout Plain Layout
2655 Sectioned bibliography
2661 Now you can insert multiple Bib\SpecialChar TeX
2662 bibliographies, one for each section of
2664 Returning to our example: Insert the Bib\SpecialChar TeX
2666 \begin_inset Flex Code
2669 \begin_layout Plain Layout
2675 and a second one for the database
2676 \begin_inset Flex Code
2679 \begin_layout Plain Layout
2686 You are free to use the same or different styles for each section.
2687 Additionally, you can choose if the bibliography section should contain
2689 \begin_inset Quotes eld
2692 all cited references
2693 \begin_inset Quotes erd
2696 of the specified database(s) (which is the default),
2697 \begin_inset Quotes eld
2700 all uncited references
2701 \begin_inset Quotes erd
2705 \begin_inset Quotes eld
2709 \begin_inset Quotes erd
2713 This might be useful if you would like to separate your bibliography into
2715 \begin_inset Quotes eld
2719 \begin_inset Quotes erd
2723 \begin_inset Quotes eld
2727 \begin_inset Quotes erd
2731 \begin_inset Quotes eld
2735 \begin_inset Quotes erd
2739 The titles for the sections can be added as ordinary sections or subsections.
2741 \begin_inset Flex Code
2744 \begin_layout Plain Layout
2750 removes the bibliography title, you have to manually re-add that, too (as
2751 a chapter* or section*, for instance).
2754 \begin_layout Subsection
2755 Multiple Bibliographies
2758 \begin_layout Standard
2759 Multiple bibliographies, e.
2760 \begin_inset space \thinspace{}
2764 \begin_inset space \space{}
2767 a bibliography for each section or chapter of the document, are not supported
2768 by Bib\SpecialChar TeX
2771 \begin_inset Flex Code
2774 \begin_layout Plain Layout
2780 package, which is used for the creation of sectioned bibliographies in
2782 (see the previous section), provides an easy way to solve this task, if
2783 you are willing to use some
2784 \begin_inset Flex MenuItem
2787 \begin_layout Plain Layout
2795 \begin_inset space ~
2799 \begin_inset CommandInset ref
2801 reference "sec:Inserting-TeX-Code"
2809 \begin_layout Plain Layout
2810 An alternative approach is to use the
2811 \begin_inset Flex Code
2814 \begin_layout Plain Layout
2821 \begin_inset Flex Code
2824 \begin_layout Plain Layout
2830 package, respectively.
2838 \begin_layout Standard
2840 \begin_inset Flex MenuItem
2843 \begin_layout Plain Layout
2844 Document\SpecialChar menuseparator
2851 \begin_inset Flex MenuItem
2854 \begin_layout Plain Layout
2861 \begin_inset Flex MenuItem
2864 \begin_layout Plain Layout
2865 Sectioned bibliography
2871 In the document, you have to enclose the sections, which shall contain
2872 their own bibliography (including the Bib\SpecialChar TeX
2873 bibliography itself), between
2875 \begin_inset Flex Code
2878 \begin_layout Plain Layout
2887 \begin_inset Flex Code
2890 \begin_layout Plain Layout
2898 (those commands have to be inserted as \SpecialChar TeX
2900 The bibliography will contain all references that have been cited in the
2902 \begin_inset Flex Code
2905 \begin_layout Plain Layout
2916 If you are using this approach, then every citation reference has to be
2918 \begin_inset Flex Code
2921 \begin_layout Plain Layout
2929 \begin_inset Flex Code
2932 \begin_layout Plain Layout
2941 \begin_layout Section
2945 \begin_layout Subsection
2949 \begin_layout Standard
2950 When you are working on a large file with many sections, it is often convenient
2951 to break up the document into several files, or perhaps you have something
2952 where a table may change from time to time, but the preceding text does
2954 In these cases, you should seriously consider using multipart documents.
2955 For example, scientific papers often have five major sections: the introduction
2956 , observations, results, discussion, and conclusion.
2957 Each of these could be its own separate \SpecialChar LyX
2959 \begin_inset Quotes eld
2963 \begin_inset Quotes erd
2966 file which contains the title, authors, abstract, references, etc., plus
2967 the five included files.
2968 It is important to note that each of these files is a full \SpecialChar LyX
2970 can be formatted and printed on its own, as well as included in a master
2972 Each of these files must have the same document class, however—don't attempt
2973 to mix book classes with article classes.
2974 You may also include \SpecialChar LaTeX
2975 files; however, these files must not have their own
2977 \begin_inset space \thinspace{}
2981 \begin_inset space \space{}
2984 everything up to and including the
2985 \begin_inset Flex Code
2988 \begin_layout Plain Layout
2997 \begin_inset Flex Code
3000 \begin_layout Plain Layout
3008 line must be deleted) or else errors will be generated when you try to
3012 \begin_layout Standard
3014 allows you to include files quite easily with
3015 \begin_inset Flex MenuItem
3018 \begin_layout Plain Layout
3019 Insert\SpecialChar menuseparator
3021 \begin_inset space ~
3030 When you click on this selection a small box is inserted into the file
3031 at the current cursor location.
3032 Clicking on the box raises a dialog which allows you to select the file
3033 to be included, and the method of its inclusion.
3037 \begin_layout Standard
3038 The file selection box should by now be obvious.
3039 The three inclusion methods are
3040 \begin_inset Quotes eld
3044 \begin_inset Quotes erd
3048 \begin_inset Quotes eld
3052 \begin_inset Quotes erd
3056 \begin_inset Quotes eld
3060 \begin_inset Quotes erd
3064 The difference between
3065 \begin_inset Quotes eld
3069 \begin_inset Quotes erd
3073 \begin_inset Quotes eld
3077 \begin_inset Quotes erd
3080 is really only meaningful to \SpecialChar LaTeX
3081 perts, but the practical difference is that
3083 \begin_inset Quotes eld
3087 \begin_inset Quotes erd
3090 are typeset beginning on a new page, while files that are
3091 \begin_inset Quotes eld
3095 \begin_inset Quotes erd
3098 are typeset starting on the current page.
3101 \begin_layout Standard
3102 Generally, the master file is converted into a full \SpecialChar LaTeX
3103 file before typesetting,
3104 while the included files are converted to \SpecialChar LaTeX
3105 files that do not have all the
3106 preamble information.
3109 \begin_layout Standard
3111 \begin_inset Quotes eld
3115 \begin_inset Quotes erd
3118 included file allows you to include a file typeset exactly as it appears
3120 \begin_inset space \thinspace{}
3124 \begin_inset space \space{}
3128 \begin_inset Flex Code
3131 \begin_layout Plain Layout
3137 mode, with the characters set in a fixed-width typewriter font.
3138 Normally, spaces in this file are invisible, though two consecutive spaces
3139 are conserved, unlike \SpecialChar LyX
3140 's normal treatment of spaces.
3141 However, setting the
3142 \begin_inset Flex MenuItem
3145 \begin_layout Plain Layout
3147 \begin_inset space ~
3151 \begin_inset space ~
3155 \begin_inset space ~
3163 checkbox typesets a mark to unambiguously define the presence of a space.
3167 \begin_layout Subsection
3168 Cross-References Between Files
3171 \begin_layout Standard
3172 \begin_inset Box Shadowbox
3182 height_special "totalheight"
3187 backgroundcolor "none"
3190 \begin_layout Plain Layout
3191 This section is somewhat out of date.
3192 Need to describe default master documents and how children are opened when
3202 \begin_layout Standard
3203 It is possible to set up cross-references between the different files.
3204 First, open all the files in question: let's call them A and B in a two
3205 file example, where B is included in A.
3206 Let's say you insert a label in A, then want to reference it in B.
3207 Open the cross-reference dialog whilst in document B, and you can select
3209 \begin_inset Quotes eld
3213 \begin_inset Quotes erd
3219 \begin_layout Subsection
3220 Bibliography Lists in all Subdocuments
3223 \begin_layout Standard
3224 \begin_inset Box Frameless
3234 height_special "totalheight"
3239 backgroundcolor "none"
3242 \begin_layout Plain Layout
3243 This section also needs updating.
3244 There is now material about this on the wiki, and it could be copied here.
3252 \begin_layout Standard
3253 Copy the bibliography list with all entries to all subdocuments and transform
3255 This way \SpecialChar LyX
3257 \begin_inset Flex Code
3260 \begin_layout Plain Layout
3266 -files and you can easily insert references without making the bibliography
3270 \begin_layout Standard
3271 As the bibliography list is in a comment, \SpecialChar LaTeX
3272 won't use it and the references
3273 will look like this: [?], instead of like this: [1].
3274 One solution is to use the \SpecialChar LaTeX
3276 \begin_inset Flex Code
3279 \begin_layout Plain Layout
3285 that will only include comments by processing the files separately.
3286 To do this, add in the \SpecialChar LaTeX
3287 preamble of every subdocument the following:
3290 \begin_layout LyX-Code
3296 \begin_layout LyX-Code
3299 includecomment{comment}
3302 \begin_layout Standard
3304 \begin_inset Flex URL
3307 \begin_layout Plain Layout
3309 http://wiki.lyx.org/FAQ/Unsorted#toc31
3317 \begin_layout Section
3322 \begin_layout Standard
3323 Users sometimes need to be able to
3324 \begin_inset Quotes eld
3328 \begin_inset Quotes erd
3332 file together with all the images (and other files) on which it depends,
3333 either for sending to a publisher or for sharing with a co-author.
3335 2.0 includes a Python script (
3336 \begin_inset Flex Code
3339 \begin_layout Plain Layout
3345 ) that automates this process.
3346 To use it, you must have either the
3347 \begin_inset Flex Code
3350 \begin_layout Plain Layout
3357 \begin_inset Flex Code
3360 \begin_layout Plain Layout
3366 python modules installed on your system.
3367 By default, the script prefers the
3368 \begin_inset Flex Code
3371 \begin_layout Plain Layout
3378 \begin_inset Flex Code
3381 \begin_layout Plain Layout
3387 format on Unix-like systems and the
3388 \begin_inset Flex Code
3391 \begin_layout Plain Layout
3400 \begin_layout Standard
3402 's configuration process will set the script up to export a `\SpecialChar LyX
3404 and this format will then be available under
3405 \begin_inset Flex Code
3408 \begin_layout Plain Layout
3409 File\SpecialChar menuseparator
3418 \begin_layout Standard
3419 Independently of the platform, the generation of a particular archive format
3420 can be forced by adding either the
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
3451 \begin_inset Flex Code
3454 \begin_layout Plain Layout
3460 format) switch to the
3461 \begin_inset Flex Code
3464 \begin_layout Plain Layout
3466 \SpecialChar menuseparator
3474 \begin_inset Flex Code
3477 \begin_layout Plain Layout
3478 Tools\SpecialChar menuseparator
3479 Preferences\SpecialChar menuseparator
3480 File Handling\SpecialChar menuseparator
3487 (Make sure you add the switch after the script name, not before it.)
3490 \begin_layout Section
3491 Fancy Headers and Footers
3494 \begin_layout Standard
3495 The default page layout is rather plain; for an
3496 \begin_inset Flex Code
3499 \begin_layout Plain Layout
3505 document class, all you get is a centered page number at the bottom of
3507 This document uses KOMA-script's book class, so it appears to be a bit
3509 But to really put on a show, you need to set the document page style to
3511 \begin_inset Quotes eld
3515 \begin_inset Quotes erd
3518 , as mentioned in the
3523 This section describes the \SpecialChar LaTeX
3524 code you need to insert in your \SpecialChar LaTeX
3526 order to get the desired effects.
3529 \begin_layout Standard
3530 For more information on fancy headers, see the
3531 \begin_inset Flex Code
3534 \begin_layout Plain Layout
3540 package documentation.
3542 \begin_inset Flex URL
3545 \begin_layout Plain Layout
3547 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3555 \begin_layout Standard
3556 The page header is divided into three fields, not surprisingly labeled
3557 \begin_inset Quotes eld
3561 \begin_inset Quotes erd
3565 \begin_inset Quotes eld
3569 \begin_inset Quotes erd
3573 \begin_inset Quotes eld
3577 \begin_inset Quotes erd
3581 The footer is also divided into these three fields.
3582 The \SpecialChar LaTeX
3583 commands to set these fields in the simplest manner are
3584 \begin_inset Flex Code
3587 \begin_layout Plain Layout
3596 \begin_inset Flex Code
3599 \begin_layout Plain Layout
3608 \begin_inset Flex Code
3611 \begin_layout Plain Layout
3620 \begin_inset Flex Code
3623 \begin_layout Plain Layout
3632 Suppose you wish to put your name in the upper left hand corner of each
3634 Simply insert the following command in the preamble:
3637 \begin_layout Standard
3646 \begin_layout Standard
3647 You will now see your name in the upper left.
3648 If a field has a default entry that you would like to get rid of (often
3649 the page number appears in the central footer) simply include a command
3650 with a blank argument, e.
3651 \begin_inset space \thinspace{}
3657 \begin_layout Standard
3665 \begin_layout Standard
3666 Let's get really fancy: lets put the section number with the word
3667 \begin_inset Quotes eld
3671 \begin_inset Quotes erd
3675 \begin_inset space \thinspace{}
3679 \begin_inset space \space{}
3682 Section 3) in the upper left, the page number (e.
3683 \begin_inset space \thinspace{}
3687 \begin_inset space \space{}
3690 Page 4) in the upper right, your name in the lower left, and the date in
3692 The following commands should now appear in the preamble:
3695 \begin_layout Standard
3705 \begin_layout Standard
3713 \begin_layout Standard
3723 \begin_layout Standard
3732 \begin_layout Standard
3740 \begin_layout Standard
3750 \begin_layout Standard
3752 \begin_inset Flex Code
3755 \begin_layout Plain Layout
3764 \begin_inset Flex Code
3767 \begin_layout Plain Layout
3775 access \SpecialChar LaTeX
3776 's section and page counters, and so print out the current section
3779 \begin_inset Flex Code
3782 \begin_layout Plain Layout
3790 simply prints out today's date.
3793 \begin_layout Standard
3794 The thicknesses of the horizontal rules drawn beneath the header and above
3795 the footer can also be modified.
3796 If you don't want one of the rules, set its thickness to 0.
3797 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3803 \begin_inset Flex Code
3806 \begin_layout Plain Layout
3811 headrulewidth}{0.4pt}
3817 \begin_inset Flex Code
3820 \begin_layout Plain Layout
3825 footrulewidth}{0.4pt}
3830 to set the thicknesses.
3833 \begin_layout Standard
3834 You can switch the header/footer settings on and off for individual pages
3836 \begin_inset Flex Code
3839 \begin_layout Plain Layout
3842 thispagestyle{empty}
3848 \begin_inset Flex Code
3851 \begin_layout Plain Layout
3854 thispagestyle{plain}
3860 \begin_inset Flex Code
3863 \begin_layout Plain Layout
3866 thispagestyle{fancy}
3872 Simply insert them in the text on the page you want changed and mark them
3875 In fact, title pages are marked as plain by default, while following pages
3876 are marked fancy when using the global fancy setting.
3879 \begin_layout Standard
3880 As a final example, it is possible to include an image in the header or
3882 Suppose you want to put a company logo in the upper lefthand corner.
3883 You might try something like
3886 \begin_layout Standard
3895 includegraphics{logo.eps}}}
3898 \begin_layout Standard
3900 (you may need to preface this with
3901 \begin_inset Flex Code
3904 \begin_layout Plain Layout
3908 usepackage{graphics}
3913 if you don't include graphics elsewhere in your document).
3916 \begin_layout Section
3917 Itemize Bullet Selection
3918 \begin_inset CommandInset label
3927 \begin_layout Standard
3933 \begin_layout Subsection
3937 \begin_layout Standard
3939 provides 216 bullet shapes that can be accessed from a simple dialog.
3940 Using this dialog you can easily specify what bullet shape to use at each
3941 level of an itemized list.
3942 These settings are document-wide so you won't be able to specify different
3943 sets of bullets for different paragraphs.
3947 \begin_layout Plain Layout
3948 Well, actually you can but you'll have to do it by hand.
3956 \begin_layout Subsection
3960 \begin_layout Standard
3961 Open the dialog by selecting the
3962 \begin_inset Flex MenuItem
3965 \begin_layout Plain Layout
3966 Document\SpecialChar menuseparator
3972 menu item and then select the
3973 \begin_inset Flex MenuItem
3976 \begin_layout Plain Layout
3985 \begin_layout Standard
3986 The dialog provides you with a table of bullet shapes.
3987 A column of buttons on the left of the table provides access to the six
3988 different panels of bullet shapes.
3989 The row of buttons across the top is used to select which bullet depth
3991 A text entry under the table shows the currently selected bullet shape's
3993 equivalent and this can be edited if desired.
3994 If you do modify the text you will also need to specify any needed packages
3995 in the \SpecialChar LaTeX
3999 \begin_layout Standard
4000 The six panels are divided up by the packages they require.
4001 The following table shows the mappings from button name to \SpecialChar LaTeX
4003 \begin_inset Separator parbreak
4009 \begin_layout Standard
4011 \begin_inset Tabular
4012 <lyxtabular version="3" rows="7" columns="2">
4013 <features tabularvalignment="middle">
4014 <column alignment="center" valignment="top" width="0pt">
4015 <column alignment="center" valignment="top" width="0pt">
4017 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4020 \begin_layout Plain Layout
4035 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4038 \begin_layout Plain Layout
4055 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4058 \begin_layout Plain Layout
4073 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4076 \begin_layout Plain Layout
4085 base \SpecialChar LaTeX
4093 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4096 \begin_layout Plain Layout
4111 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4114 \begin_layout Plain Layout
4131 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4134 \begin_layout Plain Layout
4149 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4152 \begin_layout Plain Layout
4169 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4172 \begin_layout Plain Layout
4187 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4190 \begin_layout Plain Layout
4207 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4210 \begin_layout Plain Layout
4225 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4228 \begin_layout Plain Layout
4245 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4248 \begin_layout Plain Layout
4263 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4266 \begin_layout Plain Layout
4289 \begin_layout Standard
4291 doesn't stop you using bullets from packages you don't have.
4292 If you get errors from \SpecialChar LaTeX
4293 when you try to view or print the file, then it
4294 is likely you are missing a package.
4298 \begin_layout Plain Layout
4300 doesn't restrict your use since you may be editing locally and exporting
4309 \begin_layout Subsection
4313 \begin_layout Standard
4314 Select which bullet depth you want to change then select the bullet shape
4316 Any changes will not be visible in \SpecialChar LyX
4317 , but are visible when viewing the document.
4320 \begin_layout Standard
4321 You can reset a bullet shape to the default simply by clicking your right
4322 mouse button on the appropriate bullet depth button.
4326 \begin_layout Plain Layout
4331 want to have multiple sets of paragraphs with different sets of bullets
4332 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4334 The bullet selection dialog can help though because it provides you with
4335 the \SpecialChar LaTeX
4336 code for a wide range of bullet shapes.
4337 To make your own custom paragraphs you have the following options:
4340 \begin_layout Plain Layout
4344 \begin_layout Plain Layout
4360 \begin_layout Plain Layout
4364 \begin_layout Plain Layout
4386 \begin_layout Itemize
4387 Use the \SpecialChar LaTeX
4389 \begin_inset Flex Code
4392 \begin_layout Plain Layout
4400 to specify a new bullet shape for a given depth.
4401 You'll also need to save the current bullet shape so you can restore it
4403 In this itemized list the following \SpecialChar LaTeX
4404 code was used to change the bullet
4405 used for the first depth.
4406 \begin_inset Separator parbreak
4413 \begin_layout LyX-Code
4423 \begin_layout LyX-Code
4440 \begin_layout Itemize
4441 Note that the itemize depth is specified in Roman numerals as part of the
4451 \begin_layout Itemize
4455 \begin_layout Plain Layout
4468 Specify each individual entry by starting each item with the bullet shape
4469 enclosed in square brackets and set as
4470 \begin_inset Flex MenuItem
4473 \begin_layout Plain Layout
4481 For example, this item was started with
4482 \begin_inset Flex Code
4485 \begin_layout Plain Layout
4500 \begin_layout Plain Layout
4504 \begin_layout Plain Layout
4520 \begin_layout Plain Layout
4521 You'll also need to revert the labelitem back to its previous setting for
4522 the global bullet shape settings to remain in effect.
4523 The way used here was:
4526 \begin_layout LyX-Code
4541 \begin_layout Chapter
4543 and the World Wide Web
4546 \begin_layout Standard
4548 has long supported the export of documents to various web-friendly formats,
4550 Before verson 2.0, however, HTML export was always accomplished by the use
4551 of external converters.
4555 \begin_layout Plain Layout
4556 For details on the use of external converters with \SpecialChar LyX
4561 section of the Customization manual.
4566 These fall into two large groups: there are converters that use \SpecialChar LaTeX
4568 intermediate format, such as
4569 \begin_inset Flex Code
4572 \begin_layout Plain Layout
4579 \begin_inset Flex Code
4582 \begin_layout Plain Layout
4589 \begin_inset Flex Code
4592 \begin_layout Plain Layout
4598 , relying upon \SpecialChar LyX
4599 to produce the \SpecialChar LaTeX
4600 ; and there is a converter that works directly
4603 \begin_inset Flex Code
4606 \begin_layout Plain Layout
4614 All of these have different advantages and disadvantages.
4618 \begin_layout Standard
4619 The \SpecialChar LaTeX
4620 -based converters have the advantage that, in principle, they know everythin
4621 g about the exported document that \SpecialChar LaTeX
4623 Such converters do not care, for example, if a certain block of code was
4624 produced by \SpecialChar LyX
4625 or was Evil Red Text.
4626 These converters know about
4627 \begin_inset Flex Code
4630 \begin_layout Plain Layout
4636 files, counters, and references, and can often make use of the
4637 \begin_inset Flex Code
4640 \begin_layout Plain Layout
4646 files generated by Bib\SpecialChar TeX
4648 On the other hand, \SpecialChar LaTeX
4649 is a very hard language to parse—it is sometimes said
4650 that only \SpecialChar TeX
4651 itself understands \SpecialChar TeX
4652 —and \SpecialChar LaTeX
4653 -based converters will often choke on
4654 what seem to be quite simple constructs; complex ones can throw them completely
4655 , and as of this writing, for example, the
4659 manual will not export with
4660 \begin_inset Flex Code
4663 \begin_layout Plain Layout
4669 , though the others will.
4670 The other issue concerns how math is handled.
4671 These converters typically convert the formulae into little pictures that
4672 are then linked from the HTML document.
4673 Since these are actually generated by \SpecialChar LaTeX
4674 , they are accurate.
4675 But they do not scale well, and just getting them to look as if they are
4676 actually meant to be in your document—so that the font sizes seem to be
4677 roughly the same—can be a challenge.
4680 \begin_layout Standard
4682 \begin_inset Flex Code
4685 \begin_layout Plain Layout
4693 \begin_inset CommandInset href
4695 name "http://elyxer.nongnu.org/"
4696 target "http://elyxer.nongnu.org/"
4700 ) solves some of these problems.
4701 In particular, the formulae it produces scale perfectly, since it renders
4702 math using a combination of HTML and CSS rather than converting the formulae
4704 But even moderately complex formula are rendered less well than with
4705 \begin_inset Flex Code
4708 \begin_layout Plain Layout
4714 ; this reflects the limitations of HTML.
4718 \begin_layout Plain Layout
4720 \begin_inset Flex Code
4723 \begin_layout Plain Layout
4730 can also use jsMath and MathJax for equations, but this setting is only
4731 available globally and requires one to have access to a server that runs
4737 More importantly (as of version 1.1.1, at least),
4738 \begin_inset Flex Code
4741 \begin_layout Plain Layout
4748 has limited support for math macros and no support for user-defined paragraph
4749 or character styles.
4750 These limitations make
4751 \begin_inset Flex Code
4754 \begin_layout Plain Layout
4761 unsuitable for many of the documents \SpecialChar LyX
4763 In principle, of course, these problems could be solved, but the \SpecialChar LyX
4765 have decided to follow a different path and have made \SpecialChar LyX
4767 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
4768 , DocBook, and plaintext.
4771 \begin_layout Standard
4772 As of this writing, XHTML output remains under development and should probably
4774 \begin_inset Quotes eld
4778 \begin_inset Quotes erd
4785 \begin_layout Plain Layout
4787 \begin_inset Flex Code
4790 \begin_layout Plain Layout
4791 development/HTML.notes
4796 , which can be found in the \SpecialChar LyX
4798 \begin_inset CommandInset href
4800 name "accessed online"
4801 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
4805 , usually contains up-to-date information about the state of XHTML output.
4806 See also the list of XHTML bugs on
4807 \begin_inset CommandInset href
4809 name "the bug tracker"
4810 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"
4819 Still, the developers have chosen this approach because it has several
4820 potential advantages over the other two.
4823 \begin_layout Standard
4824 These advantages are primarily due to the fact that the XHTML output routines,
4825 since they are part of \SpecialChar LyX
4826 , know everything \SpecialChar LyX
4827 knows about the document being
4832 \begin_layout Plain Layout
4833 Another advantage is that, since these routines are internal to \SpecialChar LyX
4835 immune to changes in \SpecialChar LyX
4836 's file format, or to changes in the semantics of
4842 So they know about the table of contents (as displayed in the outline),
4843 about the counters associated with different paragraph styles, and about
4844 user-defined styles.
4845 The XHTML output routines know what \SpecialChar LyX
4846 knows about internationalization,
4847 too, so they will output
4848 \begin_inset Quotes eld
4852 \begin_inset Quotes erd
4856 \begin_inset Quotes eld
4864 \begin_inset Quotes erd
4867 , depending upon the language in effect at the time.
4871 \begin_layout Standard
4872 Quite generally, the output routines know what \SpecialChar LyX
4873 knows about document layout,
4874 that is, about how the document is to be rendered on screen.
4875 We use this information when we output the document as XHTML.
4876 In particular, \SpecialChar LyX
4881 generates CSS style information corresponding to the layout information
4882 it uses to render the document on screen: if section headings are supposed
4883 to be sans-serif and bold as seen in \SpecialChar LyX
4884 , then (by default) they will be sans-seri
4885 f and bold when viewed in a web browser, too.
4886 And this is true not just for pre-defined styles, like Section, but for
4887 any style, including user-defined styles.
4888 Indeed, the XHTML output routines make no distinction between user-defined
4889 paragraph and character styles and \SpecialChar LyX
4890 's own pre-defined styles: in each case,
4891 everything \SpecialChar LyX
4892 knows about the styles is contained in the layout files.
4893 And much the same is true as regards pre-defined textual insets, such as
4894 footnotes, and various custom insets.
4898 \begin_layout Standard
4899 The result is that XHTML output can be customized and extended in exactly
4900 the same way \SpecialChar LaTeX
4901 output can be customized and extended: through layout files
4903 See chapter five of the
4907 manual for the details.
4910 \begin_layout Standard
4911 The remainder of this chapter contains more detailed information on XHTML
4912 output, its limitations, and ways to work around those limitations.
4915 \begin_layout Section
4916 Math Output in XHTML
4919 \begin_layout Standard
4921 offers four choices for how math is rendered.
4922 These have various advantages and disadvantages:
4925 \begin_layout Itemize
4927 \begin_inset Newline newline
4930 MathML is a dialect of XML designed specifically for mathematics on the
4931 web, and it typically renders very well in browsers that support it.
4932 The disadvantage is that not all browsers support MathML, and support is
4933 not complete even in the Gecko-based browsers, such as Firefox.
4934 \begin_inset Newline newline
4938 is unable to render a formula as MathML—for example, if the formula
4940 \begin_inset Flex Code
4943 \begin_layout Plain Layout
4949 package or ERT—then it will instead output the formula as an image.
4953 \begin_layout Itemize
4955 \begin_inset Newline newline
4959 \begin_inset Flex Code
4962 \begin_layout Plain Layout
4968 outputs math as HTML, styled by CSS.
4972 \begin_layout Plain Layout
4974 has borrowed some of the CSS for its HTML output from
4975 \begin_inset Flex Code
4978 \begin_layout Plain Layout
4989 For simple formulae, this can work quite well, though with more complicated
4990 formulae it tends to break down.
4991 Still, this method has the advantage that it is very widely supported and
4992 so it may be appropriate for documents that contain only a little, fairly
4994 \begin_inset Newline newline
4997 If Lyx is unable to render a formula as HTML—for example, if the formula
4999 \begin_inset Flex Code
5002 \begin_layout Plain Layout
5008 package or ERT—then it will instead output the formula as an image.
5012 \begin_layout Itemize
5014 \begin_inset Newline newline
5018 \begin_inset Flex Code
5021 \begin_layout Plain Layout
5028 will output formulae as images, the very same images, in fact, that are
5029 used for instant preview.
5033 \begin_layout Plain Layout
5034 Instant preview does
5038 have to be on for images to be output, however.
5043 The advantage to this method is that the images are simply generated by
5045 , so they are very accurate.
5046 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5047 so they do not scale terribly well, and one cannot copy them, etc.
5048 (As of this writing, there are also problems about equation numbering.
5050 \begin_inset CommandInset href
5053 target "http://www.lyx.org/trac/ticket/6894"
5058 \begin_inset Newline newline
5061 The size of the images can be controlled by setting the
5062 \begin_inset Quotes eld
5066 \begin_inset Quotes erd
5070 \begin_inset Flex MenuItem
5073 \begin_layout Plain Layout
5074 Document\SpecialChar menuseparator
5075 Settings\SpecialChar menuseparator
5085 \begin_layout Plain Layout
5086 For those who want to know, this controls the resolution of the image in
5087 dots per inch and is based upon a default of 75 dpi.
5093 \begin_inset Newline newline
5097 for some reason fails to create an image for a formula (e.g., if a required
5099 package is not installed), then it will fall back to outputing the raw
5104 \begin_layout Itemize
5107 \begin_inset Newline newline
5110 Finally, \SpecialChar LyX
5111 will happily output math as \SpecialChar LaTeX
5113 As well as being the output of last resort, this method can be used with
5115 \begin_inset CommandInset href
5118 target "http://www.math.union.edu/~dpvc/jsMath/"
5122 , which uses JavaScript to render \SpecialChar LaTeX
5123 embedded in HTML documents.
5125 wraps the \SpecialChar LaTeX
5127 \begin_inset Flex Code
5130 \begin_layout Plain Layout
5136 (for inline formulas) or
5137 \begin_inset Flex Code
5140 \begin_layout Plain Layout
5146 (for displayed formulas) with
5147 \begin_inset Flex Code
5150 \begin_layout Plain Layout
5156 , as is required for jsMath.
5159 \begin_layout Standard
5160 One of these output methods must be selected under
5161 \begin_inset Flex MenuItem
5164 \begin_layout Plain Layout
5165 Document\SpecialChar menuseparator
5166 Settings\SpecialChar menuseparator
5173 By default, \SpecialChar LyX
5175 This is a document-wide setting, therefore.
5178 \begin_layout Standard
5179 Eventually, \SpecialChar LyX
5180 will offer the user the option to select an alternate output
5181 method for a particular inset, say, one that isn't being rendered very
5186 \begin_layout Plain Layout
5187 That said, since \SpecialChar LyX
5188 falls back to images if the inset contains ERT, then one
5189 can force output as an image by putting some harmless ERT into the math,
5191 \begin_inset Formula $a=b\relax$
5202 \begin_layout Section
5203 Bibliography and Citations
5206 \begin_layout Standard
5207 XHTML output fully supports bibliographies and citations.
5211 \begin_layout Standard
5212 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5214 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5217 If you are using numerical citations, then \SpecialChar LyX
5218 will output numerical labels,
5219 such as [1] or [17], rather than simply showing the citation key in square
5220 brackets, as it does on-screen.
5221 If you are using author-year citations, then \SpecialChar LyX
5222 will add lowercase letters
5223 to the years, just as Bib\SpecialChar TeX
5224 does, if it finds more than one citation for
5225 a given author-year combination.
5226 The labels will be printed with the bibliography entries.
5227 Note that there is, at present, no way to customize the appearance of the
5228 labels, for example, to choose between square brackets and parentheses.
5231 \begin_layout Standard
5232 Bibliography output is handled by the same machinery that handles the presentati
5233 on of reference information in the citation dialog, so you will see in the
5234 XHTML output pretty much what you would see if you were to look at a given
5235 entry in the citation dialog.
5236 The formatting can be customized in your layout file or, preferably, in
5242 manual for the details.
5245 \begin_layout Standard
5246 The main defect at present is that cross-referenced information is printed
5247 with every entry with which it is associated.
5248 So you can see things like this:
5253 \begin_inset Quotes eld
5256 Context and Logical Form
5257 \begin_inset Quotes erd
5262 Language in Context: Selected Essays
5264 (Oxford: Oxford University Press, 2007), pp.
5270 \begin_inset Quotes eld
5273 Semantics in Context
5274 \begin_inset Quotes erd
5279 Language in Context: Selected Essays
5281 (Oxford: Oxford University Press, 2007), pp.
5285 \begin_layout Standard
5286 This should be fixed before long.
5289 \begin_layout Standard
5290 There is no support at present for sectioned bibliographies.
5291 If you have multiple bibliographies, then \SpecialChar LyX
5292 will print the same bibliography
5296 \begin_layout Section
5300 \begin_layout Standard
5302 will happily export indexes as XHTML, but with certain limitations at the
5306 \begin_layout Standard
5307 Index export will be most reliable when you do not attempt to use the fancy
5308 constructs that are described in the section on indexes in the
5316 \begin_layout Plain Layout
5317 The main issue here is that \SpecialChar LyX
5318 itself does not really handle these.
5319 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5325 We'll describe how they are handled using the subsection headings from
5329 \begin_layout Itemize
5330 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5331 makes an effort to support these,
5332 but the entries must be separated by
5333 \begin_inset Quotes eld
5337 \begin_inset Quotes erd
5340 , that is, there must be spaces around the exclamation point.
5341 This is because it is otherwise too difficult to check for escaped exclamation
5342 points, ones in math, and so forth.
5345 \begin_layout Itemize
5346 Page Ranges: There is no support at all for page ranges, since these make
5347 no sense with XHMTL.
5348 Instead, you will just get two index entries, one at either end.
5351 \begin_layout Itemize
5352 Cross-referencing: There is no support for cross-referencing.
5354 finds an entry containing the
5355 \begin_inset Quotes eld
5358 |see\SpecialChar ldots
5360 \begin_inset Quotes erd
5363 construct, it is just dropped, and the rest is treated as an ordinary index
5367 \begin_layout Itemize
5368 Index Entry Order: \SpecialChar LyX
5369 does support attempts to fix the sorting order.
5370 It will take what is before the first `@' it finds and use that for sorting,
5371 taking what follows the first `@' to be the actual entry.
5372 At present, \SpecialChar LyX
5373 does not check for escaped `@', so do not try to index email
5377 \begin_layout Itemize
5378 Index Entry Layout: You can format entries by using the text style dialog,
5379 or by using any other method available within \SpecialChar LyX
5381 There is no support for constructs like:
5382 \begin_inset Quotes eld
5386 \begin_inset Quotes erd
5390 Indeed, if \SpecialChar LyX
5391 finds a pipe symbol, `|', in an entry, it will delete it and
5392 everything that follows it.
5395 \begin_layout Itemize
5396 Multiple Indexes: There is no support for multiple indexes.
5397 Rather, all index entries will be printed as one large index.
5398 To avoid our printing several versions of the index, we print only the
5399 main index, so make sure you have one.
5402 \begin_layout Section
5403 Nomenclature and Glossary
5406 \begin_layout Standard
5407 There is at present no support for glossaries.
5408 Adding it would be fairly trivial, and welcome.
5411 \begin_layout Chapter
5412 The \SpecialChar LyX
5416 \begin_layout Section
5420 \begin_layout Standard
5421 The `\SpecialChar LyX
5422 server' allows other programs to talk to \SpecialChar LyX
5423 , invoke \SpecialChar LyX
5424 commands, and retrieve
5425 information about the \SpecialChar LyX
5427 This is only intended for advanced users, but they should find it useful.
5428 It is by writing to the \SpecialChar LyX
5429 server, for example, that bibliography managers,
5430 such as JabRef, are able to
5431 \begin_inset Quotes eld
5435 \begin_inset Quotes erd
5438 citations to \SpecialChar LyX
5442 \begin_layout Section
5443 Starting the \SpecialChar LyX
5447 \begin_layout Standard
5448 The \SpecialChar LyX
5449 server works through the use of a pair of named pipes.
5450 These are usually located in
5451 \begin_inset Flex Code
5454 \begin_layout Plain Layout
5460 , (except on Windows, where
5464 named pipes are special objects located in
5465 \begin_inset Flex Code
5468 \begin_layout Plain Layout
5480 ) and have the names
5481 \begin_inset Quotes eld
5485 \begin_inset Flex Code
5488 \begin_layout Plain Layout
5495 \begin_inset Quotes erd
5499 \begin_inset Quotes eld
5503 \begin_inset Flex Code
5506 \begin_layout Plain Layout
5513 \begin_inset Quotes erd
5517 External programs write into
5518 \begin_inset Flex Code
5521 \begin_layout Plain Layout
5527 and read back data from
5528 \begin_inset Flex Code
5531 \begin_layout Plain Layout
5538 The stem of the pipe names can be defined in the
5539 \begin_inset Flex MenuItem
5542 \begin_layout Plain Layout
5543 Tools\SpecialChar menuseparator
5550 \begin_inset Flex Code
5553 \begin_layout Plain Layout
5554 "/home/myhome/lyxpipe"
5560 \begin_inset Flex Code
5563 \begin_layout Plain Layout
5578 \change_deleted 711066561 1405258697
5580 \change_inserted 711066561 1405258701
5584 \change_inserted 711066561 1405258613
5588 \change_inserted 711066561 1405258962
5590 \begin_inset Flex Code
5593 \begin_layout Plain Layout
5595 \change_inserted 711066561 1405258868
5622 configure this manually in order for the server to start.
5625 \begin_layout Standard
5628 \begin_inset Flex Code
5631 \begin_layout Plain Layout
5638 \begin_inset Flex Code
5641 \begin_layout Plain Layout
5647 ' to create the pipes.
5648 If one of the pipes already exists, \SpecialChar LyX
5649 will assume that another \SpecialChar LyX
5651 is already running and will not start the server.
5652 On POSIX (Unix like) systems, if for some other reason, an unused
5653 \begin_inset Quotes eld
5657 \begin_inset Quotes erd
5660 pipe is left in existence when \SpecialChar LyX
5661 closes, then \SpecialChar LyX
5662 will try to delete it.
5663 If this fails for some reason, you will need to delete the pipes manually
5664 and then restart \SpecialChar LyX
5666 On Windows, pipes are deleted by the OS on program termination or crash,
5668 \begin_inset Quotes eld
5672 \begin_inset Quotes erd
5675 pipes should not be possible.
5678 \begin_layout Standard
5679 To have several \SpecialChar LyX
5680 processes with servers at the same time, you have to use
5681 different configurations, perhaps by using separate user directories, each
5683 \begin_inset Flex Code
5686 \begin_layout Plain Layout
5692 file, for each process.
5695 \begin_layout Standard
5696 If you are developing a client program, you might find it useful to enable
5697 debugging information from the \SpecialChar LyX
5699 Do this by starting \SpecialChar LyX
5701 \begin_inset Flex Code
5704 \begin_layout Plain Layout
5713 \begin_layout Standard
5714 You can find a complete example client written in C
5715 \change_inserted 711066561 1405258366
5718 in the source distribution as
5719 \begin_inset Flex Code
5722 \begin_layout Plain Layout
5723 development/lyxserver/server_monitor.c
5724 \change_inserted 711066561 1405258386
5735 \begin_layout Standard
5736 Another useful tool is the command-line based client
5737 \change_inserted 711066561 1405258403
5741 \begin_inset Flex Code
5744 \begin_layout Plain Layout
5745 src/client/lyxclient
5753 \begin_layout Section
5754 Normal communication
5757 \begin_layout Standard
5758 To issue a \SpecialChar LyX
5759 call, the client writes a line of ASCII text into the input
5761 This line has the following format:
5778 \begin_layout Description
5779 clientname is a name that the client can choose arbitrarily.
5780 Its only use is that \SpecialChar LyX
5781 will echo it if it sends an answer—so a client can
5782 dispatch results from different requesters.
5785 \begin_layout Description
5786 function is the function you want \SpecialChar LyX
5788 It is the same as the commands you'd use in the minibuffer.
5791 \begin_layout Description
5792 argument is an optional argument which is meaningful only to some functions
5794 \begin_inset Quotes eld
5798 \begin_inset Quotes erd
5801 LFUN will insert the argument as text at the cursor position).
5804 \begin_layout Standard
5805 The answer from \SpecialChar LyX
5806 will arrive in the output pipe and be of the form
5823 \begin_layout Standard
5832 are just echoed from the command request, while
5836 is more or less useful information filled according to how the command
5837 execution worked out.
5838 Some commands, such as
5839 \begin_inset Quotes eld
5843 \begin_inset Quotes erd
5846 , will return information about the internal state of \SpecialChar LyX
5848 return an empty data-response.
5849 This means that the command execution went fine.
5852 \begin_layout Standard
5853 In case of errors, the response from \SpecialChar LyX
5871 \begin_layout Standard
5876 should contain an explanation of why the command failed.
5879 \begin_layout Standard
5883 \begin_layout LyX-Code
5884 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
5885 \begin_inset Newline newline
5888 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
5889 \begin_inset Newline newline
5892 read a <~/.lyxpipe.out
5893 \begin_inset Newline newline
5899 \begin_layout Subsection
5900 AppleScript (Mac OS X)
5903 \begin_layout Standard
5904 Since \SpecialChar LyX
5905 2.1, \SpecialChar LyX
5906 supports basic interactions with AppleScript for normal communicatio
5907 n through the command run.
5908 This command takes a direct argument (the
5912 to perform) and an optional argument.
5913 It either returns the output of the function or triggers an error with
5914 the error message and code.
5917 \begin_layout Standard
5921 \begin_layout LyX-Code
5922 tell application "\SpecialChar LyX
5926 \begin_layout LyX-Code
5930 \begin_layout LyX-Code
5931 -- Stores the current file name into f
5934 \begin_layout LyX-Code
5935 set f to (run "server-get-filename" with argument "")
5938 \begin_layout LyX-Code
5939 on error the error_message number the error_number
5942 \begin_layout LyX-Code
5943 display dialog "Error: " & the error_number & ".
5947 \begin_layout LyX-Code
5948 & the error_message buttons {"OK"} default button 1
5951 \begin_layout LyX-Code
5955 \begin_layout LyX-Code
5959 \begin_layout Section
5963 \begin_layout Standard
5965 can notify clients of events going on asynchronously.
5966 Currently it will only do this if the user binds a key sequence with the
5968 \begin_inset Quotes eld
5972 \begin_inset Quotes erd
5976 The format of the string \SpecialChar LyX
5977 sends is as follows:
5981 \begin_inset Flex Code
5984 \begin_layout Plain Layout
5995 \begin_layout Standard
6000 is the printed representation of the key sequence that was actually typed
6004 \begin_layout Standard
6005 This mechanism can be used to extend \SpecialChar LyX
6006 's command set and implement macros.
6007 Bind some key sequence to
6008 \begin_inset Quotes eld
6012 \begin_inset Quotes erd
6016 Then start a client that listens on the output pipe, dispatches the command
6017 according to the sequence, and starts a function that may use \SpecialChar LyX
6020 requests to issue a command or a series of commands to \SpecialChar LyX
6024 \begin_layout Section
6025 The simple \SpecialChar LyX
6029 \begin_layout Standard
6031 implements a simple protocol that can be used for session management.
6032 All messages are of the form
6045 \begin_layout Standard
6051 \begin_inset Quotes eld
6055 \begin_inset Quotes erd
6059 \begin_inset Quotes eld
6063 \begin_inset Quotes erd
6068 \begin_inset Quotes eld
6072 \begin_inset Quotes erd
6075 is received from a client, \SpecialChar LyX
6076 will report back to inform the client that
6077 it's listening to it's messages, while
6078 \begin_inset Quotes eld
6082 \begin_inset Quotes erd
6085 sent from \SpecialChar LyX
6086 will inform clients that \SpecialChar LyX
6090 \begin_layout Section
6091 Reverse DVI/PDF search
6094 \begin_layout Standard
6095 Some DVI/PDF viewers
6099 \begin_layout Plain Layout
6100 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux
6101 \change_inserted 711066561 1405273809
6104 , Skim on Mac OSX and SumatraPDF on Windows.
6113 facility (also called
6118 This means that you can tell \SpecialChar LyX
6119 to put the cursor to a specific line in the
6120 document by clicking at the respective position in the DVI/PDF output.
6121 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6123 This is done via the \SpecialChar LyX
6124 server either by using the named pipe (
6128 ), or the UNIX domain socket (
6132 ) that \SpecialChar LyX
6133 creates in its temporary directory (this is the way the
6134 \begin_inset Flex Code
6137 \begin_layout Plain Layout
6143 program communicates with \SpecialChar LyX
6145 In some cases, you need a helper script that mediates between the viewer
6146 and \SpecialChar LyX
6147 , in others, the viewer can communicate with \SpecialChar LyX
6149 This depends on the selected viewer and on your operating system.
6150 The same applies to the way viewers need to be configured and the way the
6151 reverse search is actually performed.
6152 In what follows, we will thus describe how to setup reverse search for
6154 Before we turn to this, though, we will explain what needs to be done generally
6155 to enable reverse search in the DVI/PDF output.
6158 \begin_layout Subsection
6160 \begin_inset CommandInset label
6162 name "subsec:rev-search"
6169 \begin_layout Standard
6170 In most cases \SpecialChar LyX
6171 will do the work for you by enabling the option
6172 \begin_inset Flex MenuItem
6175 \begin_layout Plain Layout
6176 Synchronize with Output
6182 \begin_inset Flex MenuItem
6185 \begin_layout Plain Layout
6186 Document\SpecialChar menuseparator
6187 Settings\SpecialChar menuseparator
6194 In such a case \SpecialChar LyX
6195 will automatically insert the necessary Sync\SpecialChar TeX
6197 PDF) or load the srcltx package (for DVI) respectively.
6198 This option can be easily reached also on
6199 \begin_inset Flex Code
6202 \begin_layout Plain Layout
6211 \begin_layout Standard
6212 If you need a different setting, you can select or input a custom macro
6213 from the drop down box just below
6214 \begin_inset Flex MenuItem
6217 \begin_layout Plain Layout
6218 Document\SpecialChar menuseparator
6219 Settings\SpecialChar menuseparator
6220 Output\SpecialChar menuseparator
6221 Synchronize with Output
6229 \begin_layout Standard
6230 Note that the method
6231 \begin_inset Flex Code
6234 \begin_layout Plain Layout
6242 enables gzip compression.
6243 If your viewer does not support it, you should instead use
6244 \begin_inset Flex Code
6247 \begin_layout Plain Layout
6258 \begin_layout Standard
6260 \change_deleted 711066561 1405259326
6262 \change_inserted 711066561 1405259326
6265 so note that including the
6266 \begin_inset Flex Code
6269 \begin_layout Plain Layout
6276 \begin_inset Flex Code
6279 \begin_layout Plain Layout
6285 sometimes has an undesired impact on the typesetting.
6286 Thus, you should switch output synchronization off for the final typesetting
6288 \begin_inset Flex Code
6291 \begin_layout Plain Layout
6298 \begin_inset Flex Code
6301 \begin_layout Plain Layout
6311 \begin_layout Standard
6312 In case you need some more special settings that are not covered by the
6313 automatic settings, read the next section about how to set up output synchroniz
6315 If the automatic setup suits your needs, you can readily jump to section
6316 \begin_inset space ~
6320 \begin_inset CommandInset ref
6322 reference "subsec:configuring-viewers"
6326 , where the necessary configuration steps in your viewer – needed both with
6327 the automatic and the manual setup – are described.
6330 \begin_layout Subsection
6334 \begin_layout Standard
6336 provides several different methods for reverse search.
6337 Some are built-in in the
6338 \begin_inset Flex Code
6341 \begin_layout Plain Layout
6347 program, some are provided by external packages.
6348 Your choice depends on whether your \SpecialChar LaTeX
6349 distribution already provides a given
6350 method (the built-in methods are rather new) and whether your viewer can
6352 The available methods are described in the following.
6355 \begin_layout Subsubsection*
6356 Built-in DVI-search via src-specials (DVI only)
6359 \begin_layout Standard
6360 This method provides the DVI file with the necessary information for reverse
6362 It is available in \SpecialChar LaTeX
6363 since quite some time (any somewhat recent \SpecialChar LaTeX
6365 should include it), and it works reliably.
6366 To enable it, change the
6367 \begin_inset Flex MenuItem
6370 \begin_layout Plain Layout
6372 \change_deleted -712698321 1437633234
6377 \begin_layout Plain Layout
6385 \change_inserted -712698321 1437633234
6398 \begin_inset Flex MenuItem
6401 \begin_layout Plain Layout
6403 \change_deleted -712698321 1437633251
6408 \begin_layout Plain Layout
6416 \change_inserted -712698321 1437633251
6429 \begin_inset Flex MenuItem
6432 \begin_layout Plain Layout
6433 Preferences\SpecialChar menuseparator
6434 File Handling\SpecialChar menuseparator
6441 \begin_inset Flex Code
6444 \begin_layout Plain Layout
6445 latex -src-specials $$i
6451 If this doesn't work, check if your \SpecialChar TeX
6452 engine needs different options (the
6453 syntax might differ in some distributions).
6456 \begin_layout Subsubsection*
6457 External Packages (PDFSync and scrltx)
6460 \begin_layout Standard
6469 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6471 In order to enable it, load the packages in the \SpecialChar LyX
6475 \begin_layout Itemize
6476 \begin_inset Flex Code
6479 \begin_layout Plain Layout
6487 for reverse PDF search,
6490 \begin_layout Itemize
6491 \begin_inset Flex Code
6494 \begin_layout Plain Layout
6497 usepackage[active]{srcltx}
6502 for reverse DVI search.
6505 \begin_layout Standard
6506 If you want to be able to perform both DVI and PDF reverse searches, you
6507 can also insert in the preamble the following lines
6510 \begin_layout LyX-Code
6514 \begin_inset Newline newline
6520 \begin_inset Newline newline
6526 \begin_inset Newline newline
6532 \begin_inset Newline newline
6537 usepackage[active]{srcltx}
6538 \begin_inset Newline newline
6546 \begin_layout Standard
6547 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6548 right package will be used.
6551 \begin_layout Standard
6552 Note that PDFSync might affect the output layout of your document.
6553 It is therefore advised to disable PDFsync for final documents.
6556 \begin_layout Subsubsection*
6557 Built-in reverse search via Sync\SpecialChar TeX
6561 \begin_layout Standard
6563 \begin_inset Flex Code
6566 \begin_layout Plain Layout
6572 have built-in support for both PDF and DVI reverse search.
6575 Sync\SpecialChar TeX
6578 facility is basically the result of the integration of the PDFSync package
6579 to the pdftex program and its merge with the
6584 You need at least \SpecialChar TeX
6585 Live 2008 or a recent Mik\SpecialChar TeX
6586 distribution in order to use
6591 \begin_layout Plain Layout
6592 For some reason, Mik\SpecialChar TeX
6593 does not understand/obey the command \SpecialChar LyX
6595 the preamble when you check the "Enable Forward/Reverse Search" button
6596 in the toolbar and does not generate the necessary info.
6599 \begin_layout Plain Layout
6600 The generation of the required info can be forced by changing the converter
6602 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
6603 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
6604 the -synctex=1 switch).
6610 Also note that only a few PDF viewers (
6611 \change_inserted 711066561 1405273879
6612 Okular and Qpdfview on Unix,
6614 Skim on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
6618 \begin_layout Standard
6619 To enable Sync\SpecialChar TeX
6620 for DVI output, change the
6621 \begin_inset Flex MenuItem
6624 \begin_layout Plain Layout
6626 \change_deleted -712698321 1437633274
6631 \begin_layout Plain Layout
6639 \change_inserted -712698321 1437633274
6652 \begin_inset Flex MenuItem
6655 \begin_layout Plain Layout
6657 \change_deleted -712698321 1437633275
6662 \begin_layout Plain Layout
6670 \change_inserted -712698321 1437633275
6683 \begin_inset Flex MenuItem
6686 \begin_layout Plain Layout
6687 Preferences\SpecialChar menuseparator
6688 File Handling\SpecialChar menuseparator
6695 \begin_inset Flex Code
6698 \begin_layout Plain Layout
6699 latex -synctex=1 $$i
6704 , and for PDF output, change the
6705 \begin_inset Flex MenuItem
6708 \begin_layout Plain Layout
6710 \change_deleted -712698321 1437633276
6715 \begin_layout Plain Layout
6723 \change_inserted -712698321 1437633276
6730 (pdflatex) -> PDF (pdflatex)
6736 \begin_inset Flex Code
6739 \begin_layout Plain Layout
6740 pdflatex -synctex=1 $$i
6746 Check the documentation of your viewer whether the viewer needs to be configure
6747 d for the use with Sync\SpecialChar TeX
6752 \begin_layout Plain Layout
6753 Note that the option
6754 \begin_inset Flex Code
6757 \begin_layout Plain Layout
6763 option enables gzip compression.
6764 If your viewer does not support it, you should instead use
6765 \begin_inset Flex Code
6768 \begin_layout Plain Layout
6782 \begin_layout Subsection
6783 Configuring and using specific viewers
6784 \begin_inset CommandInset label
6786 name "subsec:configuring-viewers"
6793 \begin_layout Subsubsection*
6794 Xdvi (all platforms)
6797 \begin_layout Standard
6799 \begin_inset Flex Code
6802 \begin_layout Plain Layout
6808 , you don't need to do anything else for performing a reverse DVI search,
6810 already provides the necessary hooks for automatically using the
6811 \begin_inset Flex Code
6814 \begin_layout Plain Layout
6821 Just setup your document as described above (reverse search is triggered
6822 by Ctrl-click or Alt-click on Mac OSX, respectively).
6825 \begin_layout Standard
6826 However, if for whatever reason you want to use the named pipe instead of
6827 the socket for communicating with \SpecialChar LyX
6828 , simply change the DVI viewer in
6829 \begin_inset Flex MenuItem
6832 \begin_layout Plain Layout
6833 Preferences\SpecialChar menuseparator
6834 File Handling\SpecialChar menuseparator
6844 \begin_layout Plain Layout
6845 On Mac OSX you have to use
6846 \begin_inset Flex Code
6849 \begin_layout Plain Layout
6850 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
6861 \begin_inset Flex Code
6864 \begin_layout Plain Layout
6865 xdvi -editor "lyxeditor.sh %f %l"
6871 \begin_inset Flex Code
6874 \begin_layout Plain Layout
6880 is a suitable script.
6881 For example, a minimal shell script is the following one:
6884 \begin_layout LyX-Code
6886 \begin_inset Newline newline
6889 LYXPIPE="/path/to/lyxpipe"
6890 \begin_inset Newline newline
6893 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
6894 \begin_inset Newline newline
6897 echo "$COMMAND" > "${LYXPIPE}".in || exit
6898 \begin_inset Newline newline
6901 read TMP < "${LYXPIPE}".out || exit
6904 \begin_layout Standard
6906 \begin_inset Flex Code
6909 \begin_layout Plain Layout
6919 \begin_layout Plain Layout
6926 XServer pipe path specified in
6927 \begin_inset Flex MenuItem
6930 \begin_layout Plain Layout
6931 Preferences\SpecialChar menuseparator
6941 \begin_layout Plain Layout
6943 \begin_inset Flex Code
6946 \begin_layout Plain Layout
6952 folder of a source distribution you can find a
6953 \begin_inset Flex Code
6956 \begin_layout Plain Layout
6962 script which is able to locate the
6966 based on your preferences.
6974 \begin_layout Subsubsection*
6978 \begin_layout Standard
6980 \begin_inset Flex Code
6983 \begin_layout Plain Layout
6984 /Applications/MacDviX_Folder/calleditor.script
6989 , add the following lines:
6992 \begin_layout LyX-Code
6997 \begin_layout Plain Layout
7004 X.app/Contents/MacOS/lyxeditor "$2" $1
7005 \begin_inset Newline newline
7011 \begin_layout Standard
7012 Modify the lines accordingly if you install \SpecialChar LyX
7013 somewhere else than in the
7014 Applications folder.
7017 \begin_layout Standard
7018 Reverse search is triggered by Alt-click (OPTION-click).
7021 \begin_layout Subsubsection*
7025 \begin_layout Standard
7027 \begin_inset Flex Code
7030 \begin_layout Plain Layout
7031 open -a Skim.app $$i
7036 to the viewer setting in
7037 \begin_inset Flex MenuItem
7040 \begin_layout Plain Layout
7041 Preferences\SpecialChar menuseparator
7042 File Handling\SpecialChar menuseparator
7043 File formats\SpecialChar menuseparator
7050 \begin_inset Flex MenuItem
7053 \begin_layout Plain Layout
7054 Skim\SpecialChar menuseparator
7055 Preferences\SpecialChar menuseparator
7062 \begin_inset Flex MenuItem
7065 \begin_layout Plain Layout
7071 preset and enter command
7072 \begin_inset Flex MenuItem
7075 \begin_layout Plain Layout
7076 /Applications/\SpecialChar LyX
7077 .app/Contents/MacOS/lyxeditor
7085 \begin_layout Standard
7086 Reverse search is triggered by COMMAND-SHIFT-click
7089 \begin_layout Subsubsection*
7093 \begin_layout Standard
7095 \begin_inset Flex MenuItem
7098 \begin_layout Plain Layout
7099 Settings\SpecialChar menuseparator
7100 Configure Okular\SpecialChar ldots
7101 \SpecialChar menuseparator
7108 \begin_inset Quotes eld
7112 \begin_inset Quotes erd
7116 \begin_inset Flex Code
7119 \begin_layout Plain Layout
7128 \begin_layout Standard
7129 Reverse search is triggered by SHIFT-click.
7130 \change_inserted 711066561 1405259853
7134 \begin_layout Subsubsection*
7136 \change_inserted 711066561 1405273730
7140 \begin_layout Standard
7142 \change_inserted 711066561 1405263147
7143 Qpdfview supports Sync\SpecialChar TeX
7144 since version 0.3.5.
7146 \begin_inset Flex MenuItem
7149 \begin_layout Plain Layout
7151 \change_inserted 711066561 1405260331
7152 Edit\SpecialChar menuseparator
7153 Settings\SpecialChar ldots
7154 \SpecialChar menuseparator
7162 , click on the input field of the
7163 \begin_inset Quotes eld
7167 \begin_inset Quotes erd
7170 item and add the command
7171 \begin_inset Flex Code
7174 \begin_layout Plain Layout
7176 \change_inserted 711066561 1405260473
7187 \begin_layout Standard
7189 \change_inserted 711066561 1405260506
7190 Reverse search is triggered by double-click.
7195 \begin_layout Subsubsection*
7199 \begin_layout Standard
7200 Launch yap, choose its
7201 \begin_inset Flex MenuItem
7204 \begin_layout Plain Layout
7205 View\SpecialChar menuseparator
7212 \begin_inset Quotes eld
7216 \begin_inset Quotes erd
7221 \begin_inset Quotes eld
7224 New\SpecialChar ldots
7226 \begin_inset Quotes erd
7229 button and, in the window that opens, enter
7230 \begin_inset Quotes eld
7235 \begin_inset Quotes erd
7238 (or any other name you like) in the
7239 \begin_inset Quotes eld
7243 \begin_inset Quotes erd
7247 Now click on the button labeled
7248 \begin_inset Quotes eld
7253 \begin_inset Quotes erd
7256 to open a file dialog and navigate to the directory containing the batch
7258 \begin_inset Flex Code
7261 \begin_layout Plain Layout
7269 \begin_inset Flex Code
7272 \begin_layout Plain Layout
7278 and then specify the program arguments as
7279 \begin_inset Flex Code
7282 \begin_layout Plain Layout
7290 \begin_inset Flex Code
7293 \begin_layout Plain Layout
7299 wrapper is used for communicating with \SpecialChar LyX
7307 \begin_layout LyX-Code
7309 \begin_inset Newline newline
7312 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
7321 \begin_inset Newline newline
7335 \begin_layout Standard
7336 Make sure that the \SpecialChar LyX
7337 Server pipe path you specified in \SpecialChar LyX
7339 \begin_inset Flex Code
7342 \begin_layout Plain Layout
7356 , otherwise change the
7357 \begin_inset Flex Code
7360 \begin_layout Plain Layout
7366 wrapper accordingly.
7369 \begin_layout Standard
7370 In yap, reverse search is triggered by double-click.
7373 \begin_layout Subsubsection*
7374 SumatraPDF (Windows)
7377 \begin_layout Standard
7378 In order to use SumatraPDF for inverse search, enter
7379 \begin_inset Flex Code
7382 \begin_layout Plain Layout
7383 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
7388 in the viewer setting in
7389 \begin_inset Flex MenuItem
7392 \begin_layout Plain Layout
7393 Preferences\SpecialChar menuseparator
7394 File Handling\SpecialChar menuseparator
7395 File formats\SpecialChar menuseparator
7402 \begin_inset Flex Code
7405 \begin_layout Plain Layout
7411 is the previous wrapper.
7412 If SumatraPDF.exe is not in your command PATH, use its full file name.
7415 \begin_layout Standard
7416 Reverse search is triggered by double-click.
7419 \begin_layout Subsubsection*
7423 \begin_layout Standard
7424 First of all, make sure that yap is your default DVI viewer in the Windows
7425 environment, then launch it, choose its
7426 \begin_inset Flex MenuItem
7429 \begin_layout Plain Layout
7430 View\SpecialChar menuseparator
7437 \begin_inset Quotes eld
7441 \begin_inset Quotes erd
7446 \begin_inset Quotes eld
7449 New\SpecialChar ldots
7451 \begin_inset Quotes erd
7454 button and, in the window that opens, enter
7455 \begin_inset Quotes eld
7460 \begin_inset Quotes erd
7463 (or any other name you like) in the
7464 \begin_inset Quotes eld
7468 \begin_inset Quotes erd
7472 Now click on the button labeled
7473 \begin_inset Quotes eld
7478 \begin_inset Quotes erd
7481 to open a file dialog and navigate to the directory containing the
7482 \begin_inset Flex Code
7485 \begin_layout Plain Layout
7491 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7494 \begin_inset Flex Code
7497 \begin_layout Plain Layout
7503 and then specify the program arguments as
7504 \begin_inset Flex Code
7507 \begin_layout Plain Layout
7514 In this way, you will be using the
7518 for communicating with \SpecialChar LyX
7520 If, for whatever reason, you want to use the
7525 \begin_inset Flex Code
7528 \begin_layout Plain Layout
7534 option and be sure to specify the \SpecialChar LyX
7535 Server pipe path in the \SpecialChar LyX
7539 \begin_layout Standard
7540 In yap, reverse search is triggered by double-click.
7543 \begin_layout Subsubsection*
7547 \begin_layout Standard
7548 In order to use SumatraPDF for inverse search, enter
7549 \begin_inset Flex Code
7552 \begin_layout Plain Layout
7553 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7558 in the viewer setting in
7559 \begin_inset Flex MenuItem
7562 \begin_layout Plain Layout
7563 Preferences\SpecialChar menuseparator
7564 File Handling\SpecialChar menuseparator
7565 File formats\SpecialChar menuseparator
7572 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7574 \begin_inset Flex Code
7577 \begin_layout Plain Layout
7583 enables communication via the
7589 \begin_inset Flex Code
7592 \begin_layout Plain Layout
7598 option if you want to use the
7602 , and be sure to specify the \SpecialChar LyX
7603 Server pipe path in the \SpecialChar LyX
7607 \begin_layout Standard
7608 Reverse search is triggered by double-click.
7611 \begin_layout Section
7615 \begin_layout Standard
7616 Forward search is, as the name implies, in a sense the
7617 \begin_inset Quotes eld
7621 \begin_inset Quotes erd
7625 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7627 If forward search is set up (as described in what follows), you can put
7628 the cursor anywhere in your \SpecialChar LyX
7630 \begin_inset Flex MenuItem
7633 \begin_layout Plain Layout
7634 Navigate\SpecialChar menuseparator
7641 \begin_inset Flex MenuItem
7644 \begin_layout Plain Layout
7650 in the context menu via right mouse click), and then the viewer will jump
7651 to that position as well.
7652 This implies, of course, that your viewer supports this function.
7655 \begin_layout Standard
7656 To make forward search possible, you first need to provide the generated
7657 output PDF/DVI file with additional information about the \SpecialChar TeX
7659 This can be done via the methods described in the section
7660 \begin_inset CommandInset ref
7662 reference "subsec:rev-search"
7669 \begin_layout Standard
7670 Additionally, you need to configure \SpecialChar LyX
7671 for using your viewers in
7672 \begin_inset Flex MenuItem
7675 \begin_layout Plain Layout
7676 Tools\SpecialChar menuseparator
7677 Preferences\SpecialChar menuseparator
7678 Output\SpecialChar menuseparator
7685 We provide a range of tested configurations for some viewers, which you
7686 can select from the drop down list.
7687 If none of these configurations suits you, you have to find out and enter
7688 a suitable configuration yourself.
7689 The definition syntax uses the following placeholders:
7692 \begin_layout Itemize
7694 \begin_inset Flex Code
7697 \begin_layout Plain Layout
7706 \begin_layout Itemize
7708 \begin_inset Flex Code
7711 \begin_layout Plain Layout
7717 : name of the (temporary) exported .tex file (without path)
7720 \begin_layout Itemize
7722 \begin_inset Flex Code
7725 \begin_layout Plain Layout
7731 : name of the (temporary) exported .tex file (including path)
7734 \begin_layout Itemize
7736 \begin_inset Flex Code
7739 \begin_layout Plain Layout
7745 : name of the exported output file (either dvi or pdf, depending on which
7746 one exists in the temporary directory)
7749 \begin_layout Standard
7750 Note that only some of the viewers provide full forward search functionality,
7751 among them yap, xdvi, okular
7755 \begin_layout Plain Layout
7756 You might want to set
7757 \begin_inset Flex Code
7760 \begin_layout Plain Layout
7767 \begin_inset Flex MenuItem
7770 \begin_layout Plain Layout
7771 Tools\SpecialChar menuseparator
7772 Preferences\SpecialChar menuseparator
7773 File Handling\SpecialChar menuseparator
7775 \begin_inset space ~
7789 \change_inserted 711066561 1405264317
7793 \change_deleted 711066561 1405264282
7800 \begin_layout Plain Layout
7802 \change_deleted 711066561 1405264216
7806 \change_inserted 711066561 1405264265
7807 PDF can also use DDE commands through the external program
7810 \change_deleted 711066561 1405264271
7814 \begin_inset CommandInset href
7816 target "ftp://ftp2.commence.com/pub/freebies/"
7826 While many of the widespread PDF viewers (most notably Adobe Reader) do
7827 not support forward search at all, some other viewers – e.
7828 \begin_inset space \thinspace{}
7832 evince and xpdf – allow at least to reload the document and jump to a specific
7833 page of the file, so you can at least navigate
7834 \begin_inset Quotes eld
7838 \begin_inset Quotes erd
7842 This latter functionality is provided by an external call of synctex (see
7843 the predefined example configurations).
7847 \begin_layout Standard
7848 Forward search works both with DVI and PDF output.
7850 simply checks which preview format you have used before (i.
7851 \begin_inset space \thinspace{}
7854 e., which format is already there in the temporary directory) and chooses
7855 the appropriate configuration for the respective format.
7858 \begin_layout Chapter
7859 Special Document Classes
7862 \begin_layout Section
7866 \begin_layout Standard
7872 \begin_layout Subsection
7876 \begin_layout Standard
7877 This section describes how \SpecialChar LyX
7878 can be used to write articles for submission
7879 to the scientific journal
7881 Astronomy and Astrophysics
7883 (www.edpsciences.fr/aa/
7884 \begin_inset Flex URL
7887 \begin_layout Plain Layout
7889 http://www.edpsciences.fr/aa/
7894 ) using Version 5.01 of the document class
7899 This package can be downloaded from the ftp site
7902 \begin_layout Standard
7903 \begin_inset VSpace medskip
7909 \begin_layout Standard
7911 \begin_inset Flex URL
7914 \begin_layout Plain Layout
7916 ftp://ftp.edpsciences.org/pub/aa/readme.html
7924 \begin_layout Standard
7925 \begin_inset VSpace medskip
7931 \begin_layout Standard
7932 A manual comes together with that package, and this text is not meant to
7933 replace the original manual but is merely a short guide in how to realize
7934 the correct form of your paper.
7938 \begin_layout Standard
7939 Please note that the publisher of the journal was changed from Springer
7940 to EDP Sciences starting January 1, 2001.
7941 That change involved also some slight changes to the style files, namely
7942 the removal of the thesaurus command.
7943 The \SpecialChar LyX
7944 class aa supports the newest version of these style files, V 5.01.
7945 If you have an older version installed, please upgrade.
7946 For compatibility, the old (version 4) layout has been kept as
7951 Please refer to the comments in
7954 Dir/layouts/aapaper.layout
7959 \begin_layout Subsection
7963 \begin_layout Standard
7964 It is recommended you start from the example template distributed with \SpecialChar LyX
7966 If you are not using a template, note the following settings:
7969 \begin_layout Itemize
7976 Document\SpecialChar menuseparator
7979 dialog (OK, that one was obvious).
7982 \begin_layout Itemize
7983 Don't change the option
7986 \begin_inset space ~
7996 The whole layout is done by the macros, you shouldn't change anything.
7999 \begin_layout Subsection
8003 \begin_layout Standard
8004 First thing to enter is the header information.
8005 It consists of seven entries, of which some are optional.
8009 \begin_layout Itemize
8017 \begin_layout Itemize
8025 \begin_layout Itemize
8033 \begin_layout Itemize
8041 \begin_layout Itemize
8046 : [optional] if more than one author: whom to contact for offprint requests.
8049 \begin_layout Itemize
8054 : [optional] mail address for contacts.
8057 \begin_layout Itemize
8065 Received: <date>; Accepted <date>
8068 \begin_layout Standard
8069 There is no need to issue the
8075 command, this is done automatically by \SpecialChar LyX
8076 when the header is finished.
8077 Although the order of the single header entries doesn't matter it is advised
8078 to keep the above sequence, just to get the best optics and meets the layout
8079 of the real document.
8082 \begin_layout Standard
8083 If you want to place footnotes in the header block, e.
8084 \begin_inset space \thinspace{}
8088 \begin_inset space \space{}
8091 to state your present address, just use the standard footnote via the menu
8094 Insert\SpecialChar menuseparator
8099 will automagically use the term
8108 \begin_layout Standard
8109 In addition to these topics, the macros use three additional \SpecialChar LaTeX
8111 have no counterpart in \SpecialChar LyX
8115 \begin_layout Itemize
8122 to separate different names for more than one author and institute, respectivel
8126 \begin_layout Itemize
8133 to mark corresponding author/institute pairs.
8134 The institutes are numbered sequentially as they appear in the
8138 field, so you have to put a marker to each author.
8141 \begin_layout Itemize
8148 to supply an email address for fast contact.
8151 \begin_layout Standard
8152 In all cases, the appropriate command has to be entered in \SpecialChar LyX
8160 \begin_layout Subsection
8164 \begin_layout Standard
8165 The abstract should immediately follow the header block.
8166 With version 5 the abstract environment was changed to a command, and there
8167 is now a resctriction to only one paragraph.
8168 In addition, it should contain an entry with the keywords.
8169 This is not yet implemented for \SpecialChar LyX
8170 , therefore you have to enter the \SpecialChar LaTeX
8178 by hand and mark it as \SpecialChar LaTeX
8180 Refer to the example paper.
8183 \begin_layout Subsection
8184 Supported environments
8187 \begin_layout Standard
8188 The A&A paper layout supports the following environments for structuring
8192 \begin_layout Itemize
8198 \begin_layout Itemize
8204 \begin_layout Itemize
8210 \begin_layout Itemize
8216 \begin_layout Itemize
8222 \begin_layout Itemize
8228 \begin_layout Itemize
8234 \begin_layout Itemize
8240 \begin_layout Itemize
8246 \begin_layout Itemize
8252 \begin_layout Itemize
8258 \begin_layout Itemize
8265 \begin_layout Subsection
8266 Commands not supported by \SpecialChar LyX
8270 \begin_layout Standard
8271 Some commands are not yet supported by the
8275 layout for \SpecialChar LyX
8277 Some have already been mentioned.
8278 For the sake of completeness, they are listed all together here:
8281 \begin_layout Itemize
8289 \begin_layout Itemize
8297 \begin_layout Itemize
8305 \begin_layout Itemize
8313 \begin_layout Itemize
8321 \begin_layout Itemize
8329 \begin_layout Itemize
8337 \begin_layout Itemize
8345 \begin_layout Standard
8346 If you want to use any of these commands, you have to enter them yourself.
8349 Do not forget to mark them as \SpecialChar LaTeX
8353 \begin_layout Subsection
8354 Figure and Table Floats
8357 \begin_layout Standard
8359 provides support for the necessary float environments
8361 figure, figure*, table
8367 , therefore we won't tell much about it here.
8371 \begin_inset space ~
8377 Just remember that tables should be left-aligned.
8378 For that, select the table and change the alignment in
8380 Edit\SpecialChar menuseparator
8382 \begin_inset space ~
8388 \begin_layout Standard
8389 There is only one special thing: the figures with caption besides the figure.
8390 To create such a figure, you have to do the following:
8393 \begin_layout Enumerate
8394 Create a wide figure float:
8396 Insert\SpecialChar menuseparator
8397 Float\SpecialChar menuseparator
8400 , then right click in the figure and select
8406 \begin_inset space ~
8414 \begin_layout Enumerate
8415 Enter your caption text.
8418 \begin_layout Enumerate
8423 to move the cursor above the caption.
8426 \begin_layout Enumerate
8430 \begin_layout Enumerate
8431 Position the cursor behind the figure and insert a horizontal fill:
8433 Insert\SpecialChar menuseparator
8435 \begin_inset space ~
8438 Character\SpecialChar menuseparator
8440 \begin_inset space ~
8448 \begin_layout Enumerate
8449 Switch to \SpecialChar LaTeX
8453 \begin_inset space ~
8461 \begin_layout Enumerate
8471 Do not close the brace!
8474 \begin_layout Enumerate
8475 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8480 \begin_inset space ~
8492 \begin_layout Standard
8493 Also, refer to the figures in the example paper.
8496 \begin_layout Subsection
8500 \begin_layout Standard
8501 For submission, the paper has to be formated in a special double-spacing
8503 For this purpose, you have to give the option
8507 to the documentclass.
8508 This must be done using the extra class options field in the
8510 Document\SpecialChar menuseparator
8514 Just enter the string
8521 \begin_layout Subsection
8525 \begin_layout Standard
8530 directory contains an example paper written with \SpecialChar LyX
8532 It is the example paper from the original macro package, translated to
8535 Use it for inspiration, and compare the original \SpecialChar LaTeX
8536 code with \SpecialChar LyX
8540 \begin_layout Section
8545 \begin_layout Standard
8551 \begin_layout Subsection
8555 \begin_layout Standard
8557 is a set of macros produced by the American Astronomical Society to
8558 facilitate electronic manuscript submission to the three journals they
8559 publish: the Astrophysical Journal (including the Letters and Supplement),
8560 the Astronomical Journal, and the Publications of the Astronomical Society
8563 has proven to be an excellent tool for generating these documents, especially
8564 given its equation, citation, and figure handling capabilities.
8566 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8567 is the version described here, or higher.
8568 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8569 2.09 and are fundamentally
8570 incompatible with \SpecialChar LyX
8572 The AAS\SpecialChar TeX
8573 package may be downloaded from the AAS\SpecialChar TeX
8577 \begin_layout Standard
8578 \begin_inset VSpace medskip
8584 \begin_layout Standard
8586 \begin_inset Flex URL
8589 \begin_layout Plain Layout
8591 http://www.journals.uchicago.edu/AAS/AASTeX
8599 \begin_layout Standard
8600 \begin_inset VSpace medskip
8606 \begin_layout Standard
8607 A complete user guide is contained in that package and you should familiarize
8608 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8611 will not reduce the need to figure out all the AAS\SpecialChar TeX
8612 commands, it will only
8613 reduce the drudgery of typing everything in.
8614 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8616 completely to the requirements of the journal to which you are submitting
8620 \begin_layout Subsection
8621 Starting a New Paper
8624 \begin_layout Standard
8625 I strongly suggest that you start with the AAS\SpecialChar TeX
8629 File\SpecialChar menuseparator
8636 , enter the new file name, then choose the
8641 This will show the most common fields found in a manuscript.
8642 Simply overwrite the existing text (including the brackets,
8646 ) with the correct information.
8647 Many of the AAS\SpecialChar TeX
8648 commands and environments can be implemented directly in
8650 , but some cannot: most noticeably
8662 , which should stick out like a sore thumb if you actually just opened the
8664 For commands such as these, the \SpecialChar LaTeX
8665 code must be entered directly and marked
8667 Such commands are referred to as \SpecialChar TeX
8668 code, or Evil Red Text.
8669 I tried to minimize the amount of \SpecialChar TeX
8670 code needed in an AAS\SpecialChar TeX
8672 there is still a bit more required than any of us would like.
8675 \begin_layout Subsection
8676 Finishing Your Paper
8679 \begin_layout Standard
8680 When the paper is finished to your satisfaction and previews/prints correctly,
8682 \begin_inset Quotes eld
8686 \begin_inset Quotes erd
8689 actions which need to be done before you submit it to the journals.
8693 \begin_layout Enumerate
8694 Export your paper as a \SpecialChar LaTeX
8697 File\SpecialChar menuseparator
8698 Export\SpecialChar menuseparator
8706 \begin_layout Enumerate
8711 file with your favorite text editor
8712 \begin_inset Separator parbreak
8719 \begin_layout Enumerate
8720 remove the comment lines before the
8729 \begin_layout Enumerate
8734 usepackage...{fontenc}
8736 line if it appears (usually just after
8751 \begin_layout Enumerate
8752 remove everything between (and including) the
8764 commands, except for any commands you specifically put into the \SpecialChar LaTeX
8766 (which should appear immediately after the
8767 \begin_inset Quotes eld
8770 User specified \SpecialChar LaTeX
8772 \begin_inset Quotes erd
8783 \begin_layout Enumerate
8784 Run the resulting file through \SpecialChar LaTeX
8785 to make sure it still processes correctly.
8788 \begin_layout Enumerate
8789 Reread the journal requirements to make sure your filenames and formats
8793 \begin_layout Enumerate
8797 \begin_layout Subsection
8798 Comments On Specific Commands
8801 \begin_layout Standard
8802 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8809 ) gives a good description of each.
8810 Thus it's probably easiest for me to go down the list as found in the guide
8811 and offer comments where necessary.
8812 So let's begin \SpecialChar ldots
8816 \begin_layout Subsubsection
8817 Things that work as expected
8820 \begin_layout Standard
8821 Because they work as you might expect, I simply list them and the section
8922 begin{thebibliography}
8930 (2.13.2), all the cite commands and their variations (2.13.2), the generic
8931 graphicx figure commands (2.14.1),
8955 (2.15.4, amongst other places),
8982 \begin_layout Standard
8983 The following style options also work correctly:
9004 Simply put them in the
9010 Layout\SpecialChar menuseparator
9016 \begin_layout Subsubsection
9017 Things that work, but require more comment
9020 \begin_layout Standard
9021 The following items work, but require a little more discussion:
9024 \begin_layout Itemize
9025 These items are reserved for use by the journal editors, but you can put
9026 them into the \SpecialChar LaTeX
9027 preamble if you feel compelled to do so:
9060 \begin_layout Itemize
9061 These items may be placed in the \SpecialChar LaTeX
9062 preamble, and are included as blanks in
9084 \begin_layout Itemize
9091 (2.3) – can only be used
9092 \begin_inset Quotes eld
9096 \begin_inset Quotes erd
9099 , not in the middle of a paragraph.
9100 Use \SpecialChar TeX
9101 code if you need to embed it.
9104 \begin_layout Itemize
9111 (2.3) – will have extra {} after it.
9112 This should not cause an error.
9115 \begin_layout Itemize
9122 (2.6) – can only be used
9123 \begin_inset Quotes eld
9127 \begin_inset Quotes erd
9130 , not in the middle of a paragraph.
9131 Use \SpecialChar TeX
9132 code if you need to embed it.
9135 \begin_layout Itemize
9142 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9146 \begin_layout Itemize
9160 \begin_layout Itemize
9167 (2.9) – will have extra {} after it.
9168 This should not cause an error.
9171 \begin_layout Itemize
9178 (2.11) – will have extra {} after it.
9179 This should not cause an error.
9182 \begin_layout Itemize
9189 (2.14.2) – you can insert an optional filename argument by placing the cursor
9190 at the beginning of the text and selecting
9192 Insert\SpecialChar menuseparator
9197 \begin_inset Quotes eld
9201 \begin_inset Quotes erd
9204 inserts an optional argument of the type needed by
9211 Hopefully it will be renamed someday.
9214 \begin_layout Itemize
9227 for the catalog ID optional parameter
9230 \begin_layout Itemize
9243 for the catalog ID optional parameter
9246 \begin_layout Subsubsection
9247 Things not implemented, use \SpecialChar TeX
9251 \begin_layout Standard
9274 setcounter{equation}
9276 (2.12), Journal name abbreviations (2.13.4),
9312 (2.15.4, insert it as the first element in the lefthand cell after where
9314 Don't use any of \SpecialChar LyX
9315 's rules in the table),
9327 (2.15.5), much of Misc (2.17, except
9378 \begin_layout Subsubsection
9379 Things that cannot be implemented
9382 \begin_layout Standard
9384 at least in any meaningful sort of way, so I suggest ignoring them.
9385 They are the references environment (2.13.3), and the deluxetable environment
9387 If you really, really need to use deluxetable, I suggest editing it in
9388 a separate file with a text editor, then using
9390 Insert\SpecialChar menuseparator
9392 \begin_inset space ~
9397 to include it in your \SpecialChar LyX
9403 file to see an example of this.
9406 \begin_layout Subsection
9407 FAQs, Tips, Tricks, and Other Ruminations
9410 \begin_layout Subsubsection
9411 Getting \SpecialChar LyX
9412 and AAS\SpecialChar TeX
9416 \begin_layout Standard
9417 It can be a bit tricky to get \SpecialChar LyX
9418 to recognize a new layout and document class.
9419 When all else fails, do this:
9422 \begin_layout Enumerate
9423 Make certain that \SpecialChar LaTeX
9424 can find AAS\SpecialChar TeX
9426 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9428 directory completely unrelated to \SpecialChar LaTeX
9429 or AAS\SpecialChar TeX
9430 and run \SpecialChar LaTeX
9438 \begin_layout Enumerate
9443 appears in \SpecialChar LyX
9451 \begin_layout Enumerate
9454 Tools\SpecialChar menuseparator
9458 , then restart \SpecialChar LyX
9462 \begin_layout Enumerate
9463 Open a regular new file, not from a template.
9464 Does AAS\SpecialChar TeX
9465 appear in the class list in
9467 Document\SpecialChar menuseparator
9473 \begin_layout Standard
9474 If you get a warning from an existing AAS\SpecialChar TeX
9475 document about not being able
9476 to find the AAS\SpecialChar TeX
9477 layout or a message about
9478 \begin_inset Quotes eld
9481 You should not mix title layouts with normal ones
9482 \begin_inset Quotes erd
9485 , things haven't been installed correctly.
9488 \begin_layout Subsubsection
9490 error processing a table
9493 \begin_layout Standard
9495 , by default, attempts to center the table caption/title.
9496 This seems to produce a bad interaction in AAS\SpecialChar TeX
9497 so you should click somewhere
9498 in the caption/title, then select
9500 Edit\SpecialChar menuseparator
9502 \begin_inset space ~
9516 This took care of it for me.
9519 \begin_layout Subsubsection
9523 \begin_layout Standard
9524 A couple of things: 1) I have noticed some funny spacing in the reference
9525 entries in the text.
9526 When you enter the bibliography item data, make sure their is
9530 space between the last author and the parenthesis setting off the year;
9534 \begin_inset space \thinspace{}
9538 \begin_inset space \space{}
9552 2) Entering the references at all is not obvious.
9553 The easiest thing is to start typing your first reference at the end of
9554 the document, then mark it as type
9559 That will put a small gray box in front of what you just typed.
9560 Click on the box to fill in the rest of the information.
9561 For new references, go to the end of an existing reference and press return.
9562 That will create a new line with its own box, etc.
9565 \begin_layout Subsubsection
9569 \begin_layout Standard
9570 Even though AAS\SpecialChar TeX
9571 provides its own figure commands (
9577 , for example), I much prefer \SpecialChar LaTeX
9578 's standard figure commands (with the default
9587 \begin_inset space ~
9590 commands as \SpecialChar TeX
9591 code into a Figure Float box if you desire, but I never have
9592 much luck getting the layout right.
9593 With the standard graphics, \SpecialChar LyX
9598 usepackage{graphicx}
9600 command into the \SpecialChar LaTeX
9601 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9603 interspersing the figures in the text.
9604 I believe ApJ accepts figures exactly this way now; AJ might still use
9606 \begin_inset Quotes eld
9609 stack everything at the end
9610 \begin_inset Quotes erd
9616 \begin_layout Subsubsection
9617 Things I could have done, but didn't
9620 \begin_layout Standard
9622 \begin_inset Quotes eld
9626 \begin_inset Quotes erd
9629 things I could have implemented, but chose not to.
9630 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9632 even though it is double-spaced in the paper manuscript.
9633 Also, I chose not to make separate layouts for the preprint and preprint2
9635 Since I assume you will spend most of your time in the plain manuscript
9636 mode anyway, I decided not to chew up more disk space with this.
9640 \begin_layout Subsection
9644 \begin_layout Standard
9645 Your mileage may vary.
9646 I've now had papers published by both ApJ and AJ that have had 98% of the
9647 effort done in \SpecialChar LyX
9648 ; the last 2% was the \SpecialChar LaTeX
9649 post-processing and a few cleanups.
9650 I have had no trouble with the submission process, and I'm sure the journals
9651 were never aware that there might be a difference.
9652 So, go forth and publish!
9655 \begin_layout Section
9656 AMS \SpecialChar LaTeX
9660 \begin_layout Standard
9670 \begin_layout Standard
9671 \begin_inset VSpace bigskip
9677 \begin_layout Standard
9679 The AMS \SpecialChar LaTeX
9680 layouts are set up to conform to suggested styles for mathematical
9681 papers to be submitted to American Mathematical Society publications.
9682 The layouts are not tailored to a specific journal, but easily can be.
9683 You should refer to the AMS documentation for specific instructions for
9684 each journal (usually it will entail only changing a single line in the
9687 That documentation is available on the Web at
9688 \begin_inset Flex URL
9691 \begin_layout Plain Layout
9699 \begin_inset Flex URL
9702 \begin_layout Plain Layout
9704 ftp://ftp.ams.org/pub/tex/amslatex/
9710 These layouts are appropriate, and useful, for any mathematical writing.
9714 \begin_layout Standard
9715 There are two basic AMS \SpecialChar LaTeX
9719 \begin_layout Itemize
9720 amsart: The standard AMS article format.
9723 \begin_layout Itemize
9724 amsbook: the standard AMS book (really, monograph) format.
9728 \begin_layout Standard
9729 The layouts themselves contain only the minimum necessary to use the AMS
9731 They do not, in particular, contain any of the `theorem' environments used
9732 for setting theorems, lemmas, and the like.
9733 These are contained, instead, in the
9734 \begin_inset Flex Code
9737 \begin_layout Plain Layout
9743 module, which is loaded by default when you select one of the AMS classes.
9744 (It can also be used with other classes and can be removed, if you would
9745 rather use something else.) Less commonly used environments are in the
9746 \begin_inset Flex Code
9749 \begin_layout Plain Layout
9750 Theorems (AMS-Extended)
9755 module, which must be loaded manually.
9758 \begin_layout Standard
9759 By default, theorems and the like are numbered consecutively throughout
9760 the document, but this may be modified by loading the module
9761 \begin_inset Flex Code
9764 \begin_layout Plain Layout
9765 Theorems (Order by Section)
9770 or, if you are using
9771 \begin_inset Flex Code
9774 \begin_layout Plain Layout
9781 \begin_inset Flex Code
9784 \begin_layout Plain Layout
9785 Theorems (Order by Chapter)
9791 These will number the results as
9792 \begin_inset Formula $n.m$
9795 , where the first number refers to the section (or chapter) and the second
9796 refers to the total number of results so far in that section (or chapter).
9797 Many environments are also available unnumbered.
9798 These are indicated by an asterisk at the end.
9799 If you happen to want
9803 unnumbered results, the module
9804 \begin_inset Flex Code
9807 \begin_layout Plain Layout
9813 provides that option.
9816 \begin_layout Standard
9817 Note that these modules do not
9821 to be used with the AMS classes.
9822 It is perfectly possible to use the
9823 \begin_inset Flex Code
9826 \begin_layout Plain Layout
9832 module, and the others mentioned, with other classes, such as
9833 \begin_inset Flex Code
9836 \begin_layout Plain Layout
9843 \begin_inset Flex Code
9846 \begin_layout Plain Layout
9853 \begin_inset Flex Code
9856 \begin_layout Plain Layout
9865 \begin_layout Subsection
9866 What these layouts provide
9869 \begin_layout Standard
9870 There is a long list of included environments provided by these layouts.
9871 In AMS-\SpecialChar LaTeX
9872 , there is, in fact, an opportunity to define an unlimited variety
9873 of `theorem' environments.
9874 However, the AMS recommends the environments that are available in \SpecialChar LyX
9879 \begin_layout Standard
9880 The following environments—as well as the standard environments, such as
9882 \begin_inset Flex Noun
9885 \begin_layout Plain Layout
9892 \begin_inset Flex Noun
9895 \begin_layout Plain Layout
9902 \begin_inset Flex Noun
9905 \begin_layout Plain Layout
9912 \begin_inset Flex Noun
9915 \begin_layout Plain Layout
9922 \begin_inset Flex Noun
9925 \begin_layout Plain Layout
9932 \begin_inset Flex Code
9935 \begin_layout Plain Layout
9942 \begin_inset Flex Code
9945 \begin_layout Plain Layout
9954 \begin_layout Description
9955 Address This should be the author's permanent address.
9958 \begin_layout Description
9960 \begin_inset space ~
9963 Address This should be the author's temporary address at the time of submission,
9964 if different from the Address.
9967 \begin_layout Description
9968 Email Author's e-mail address
9971 \begin_layout Description
9972 URL Author's Web address, if desired.
9975 \begin_layout Description
9976 Keywords Key words or phrases used to identify specific topics discussed
9980 \begin_layout Description
9981 Subjectclass These refer to the AMS Subject Classifications, published and
9984 Mathematical Reviews
9987 These are also available online at the AMS cites listed above.
9990 \begin_layout Description
9994 \begin_layout Description
9998 \begin_layout Description
10002 \begin_layout Standard
10003 The following environments are provided by both the
10004 \begin_inset Flex Code
10007 \begin_layout Plain Layout
10014 \begin_inset Flex Code
10017 \begin_layout Plain Layout
10023 modules, in the latter case in both starred (unnumbered) and unstarred
10024 (numbered) versions.
10025 These same environments are provided only in the starred versions by the
10027 \begin_inset Flex Code
10030 \begin_layout Plain Layout
10039 \begin_layout Theorem
10040 This is typically used for the statements of major results.
10044 \begin_layout Corollary*
10045 This is used for statements which follow fairly directly from previous statement
10047 Again, these can be major results.
10051 \begin_layout Lemma
10052 These are smaller results needed to prove other statements.
10055 \begin_layout Proposition
10056 These are less major results which (hopefully) add to the general theory
10060 \begin_layout Conjecture
10061 These are statements provided without justification, which the author does
10062 not know how to prove, but which seem to be true (to the author, at least).
10065 \begin_layout Definition*
10066 Guess what this is for.
10067 The font is different for this environment than for the previous ones.
10071 \begin_layout Example*
10072 Used for examples illustrating proven results.
10075 \begin_layout Problem
10076 It's not really known what this is for.
10077 You should figure it out.
10080 \begin_layout Exercise*
10081 Write a description for this one.
10084 \begin_layout Remark
10085 This environment is also a type of theorem, usually a lesser sort of observation.
10088 \begin_layout Claim*
10089 Often used in the course of giving a proof of a larger result.
10093 Generally, these are used to break up long arguments, using specific instances
10099 The numbering scheme for cases is on its own, not together with other numbered
10104 \begin_layout Proof
10105 At the end of this environment, a QED symbol (usually a square, but it can
10106 vary with different styles) is placed.
10107 If you want to have other environments within this one—for example, Case
10108 environments—and have the QED symbol appear only after them, then the other
10109 environments need to be nested within the proof environment.
10112 Nesting Environments
10118 for information on nesting.
10121 \begin_layout Standard
10122 And these environments are provided by
10123 \begin_inset Flex Code
10126 \begin_layout Plain Layout
10127 Theorems (AMS-Extended)
10135 \begin_layout Criterion*
10136 A required condition.
10139 \begin_layout Algorithm*
10140 A general procedure to be used.
10143 \begin_layout Axiom*
10144 This is a property or statement taken as true within the system being discussed.
10147 \begin_layout Condition*
10148 Sometimes used to state a condition assumed within the present context of
10152 \begin_layout Note*
10153 Similar to a Remark.
10156 \begin_layout Notation*
10157 Used for the explanation of, yes, notation.
10160 \begin_layout Summary
10161 Do we really need to tell you?
10164 \begin_layout Acknowledgement*
10168 \begin_layout Conclusion*
10169 Sometimes used at the end of a long train of argument.
10173 Used in a way similar to Proposition, though perhaps lower on the scale.
10176 \begin_layout Standard
10177 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10180 They need to be available on your system in order to use these environments.
10183 \begin_layout Section
10191 \begin_layout Standard
10197 \begin_layout Subsection
10201 \begin_layout Standard
10202 These are the layout files for some of the journals of the American Geophysical
10204 It is assumed that you have both the AGU's own class files and AGUplus
10205 installed (everything to be found at
10206 \begin_inset Flex URL
10209 \begin_layout Plain Layout
10211 ftp://ftp.agu.org/journals/latex/journals
10219 \begin_layout Subsection
10223 \begin_layout Standard
10233 They are still called this in the \SpecialChar LyX
10234 GUI, though their \SpecialChar LaTeX
10247 \begin_layout Standard
10248 Newly defined styles are
10285 These are mostly manuscript attributes and defined in the AGU class documentati
10289 \begin_layout Standard
10290 I suspect this is still badly incomplete.
10293 \begin_layout Subsection
10297 \begin_layout Standard
10314 \begin_layout Subsection
10318 \begin_layout Itemize
10321 Journal of Geophysical Research
10330 \begin_layout Standard
10331 Add your own, it isn't so hard! Look at the
10342 \begin_layout Subsection
10343 Bugs and things to remember
10346 \begin_layout Standard
10347 In order to use the new layouts, you must remember to do the following for
10351 \begin_layout Enumerate
10357 This can be done in the
10359 Layout\SpecialChar menuseparator
10364 Document\SpecialChar menuseparator
10368 (AGU articles are always in English, right? So
10372 choose a language.)
10375 \begin_layout Enumerate
10380 into the document's
10385 (Yes, this is a bug.)
10388 \begin_layout Enumerate
10389 Make sure you use the
10393 bibliography style, by entering
10397 into the second field of the Bib\SpecialChar TeX
10399 None of the standard styles will do.
10402 \begin_layout Section
10406 \begin_layout Standard
10412 \begin_layout Subsection
10416 \begin_layout Standard
10417 Broadway is for writing plays.
10418 The format is more decorative than Hollywood, and much less standardized.
10419 This format should be suitable for workshops.
10422 \begin_layout Subsection
10426 \begin_layout Standard
10427 The same as in Hollywood.
10430 \begin_layout Subsection
10434 \begin_layout Standard
10439 names as labels then cross-reference the label to insert the name.
10440 The cross-reference dialog will show the current cast of characters.
10443 \begin_layout Subsection
10444 Paper size and Margins
10447 \begin_layout Standard
10448 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10451 \begin_layout Subsection
10455 \begin_layout Standard
10456 The following environments are available.
10457 You can use broadway.bind to get the bind keys shown at the right.
10460 \begin_layout Itemize
10464 \begin_inset Newline newline
10469 You should not have to use this, but it is here for anything that does not
10473 \begin_layout Itemize
10477 \begin_inset space \hfill{}
10481 \begin_inset Newline newline
10486 Used to describe stage setting and the action.
10487 First use of speaker names in all CAPs.
10490 \begin_layout Itemize
10494 \begin_inset space \hfill{}
10498 \begin_inset Newline newline
10503 Automatically numbered.
10504 On screen it will be arabic, but will print as Roman.
10507 \begin_layout Itemize
10511 \begin_inset space \hfill{}
10515 \begin_inset Newline newline
10525 It is just centered text.
10528 \begin_layout Itemize
10532 \begin_inset space \hfill{}
10536 \begin_inset Newline newline
10541 Not automatically numbered.
10542 You supply the number.
10543 This is because I couldn't figure out how.
10546 \begin_layout Itemize
10550 \begin_inset space \hfill{}
10554 \begin_inset Newline newline
10559 A special case of Narrative to describe the setting and action as the curtain
10563 \begin_layout Itemize
10567 \begin_inset space \hfill{}
10571 \begin_inset Newline newline
10576 The speaker's (actor's) title, centered in all CAPS.
10579 \begin_layout Itemize
10583 \begin_inset space \hfill{}
10587 \begin_inset Newline newline
10592 Instructions to the speaker.
10593 The parentheses are automatically inserted.
10594 The ( will appear on screen, but both will be in the printed play.
10595 This environment is only used within
10602 \begin_layout Itemize
10606 \begin_inset space \hfill{}
10610 \begin_inset Newline newline
10615 What the Speaker says.
10618 \begin_layout Itemize
10622 \begin_inset space \hfill{}
10626 \begin_inset Newline newline
10631 The curtain comes down.
10634 \begin_layout Itemize
10638 \begin_inset space \hfill{}
10644 \begin_layout Itemize
10648 \begin_inset space \hfill{}
10654 \begin_layout Itemize
10658 \begin_inset space \hfill{}
10664 \begin_layout Standard
10668 \begin_layout Section
10672 \begin_layout Standard
10677 can be used to type letters according to German conventions.
10678 A template file is included in
10680 .../lyx/share/templates
10682 for you to use as a starting point.
10685 \begin_layout Section
10693 \begin_layout Standard
10699 \begin_layout Subsection
10703 \begin_layout Standard
10704 This is the layout file for the European Geophysical Society journals.
10709 can be downloaded from the web site of the EGS under
10710 \begin_inset Flex URL
10713 \begin_layout Plain Layout
10723 \begin_layout Subsection
10727 \begin_layout Standard
10730 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10738 The current layout file is unfortunately very unmodular and would benefit
10739 from using the various
10746 \begin_layout Section
10750 \begin_layout Standard
10751 See the \SpecialChar LyX
10757 It contains all infos you need.
10760 \begin_layout Section
10763 Foil\SpecialChar TeX
10767 \begin_inset CommandInset label
10776 \begin_layout Standard
10782 \begin_layout Subsection
10786 \begin_layout Standard
10787 This section describes how to use \SpecialChar LyX
10788 to make slides for overhead projectors.
10789 There are two document classes that can do this: the default slides class
10792 Foil\SpecialChar TeX
10796 This section documents the latter.
10799 \begin_layout Standard
10800 I'm going to say this again, nice and clear, so that there's no misunderstanding
10804 \begin_layout Standard
10805 \begin_inset VSpace bigskip
10811 \begin_layout Standard
10815 This section documents the class
10816 \begin_inset Quotes eld
10822 \change_inserted -712698321 1437633339
10824 \change_deleted -712698321 1437633344
10831 \begin_inset Quotes erd
10839 \begin_layout Standard
10840 \begin_inset VSpace bigskip
10846 \begin_layout Standard
10847 If you're looking for the documentation for
10848 \begin_inset Quotes eld
10856 \begin_inset Quotes erd
10859 , check out section
10860 \begin_inset space ~
10864 \begin_inset CommandInset ref
10866 reference "sec:slitex"
10871 If your machine doesn't have the
10876 \begin_inset Quotes eld
10882 \change_inserted -712698321 1437633364
10884 \change_deleted -712698321 1437633362
10891 \begin_inset Quotes erd
10894 ] installed, you'll probably have to use the default
10898 class, which isn't quite as good as
10903 \begin_layout Standard
10908 class is designed for use with version 2.1 of the
10913 class file which is now an integral part of \SpecialChar LaTeX2e
10917 \begin_layout Subsection
10921 \begin_layout Standard
10922 Obviously, to use this document class, you need to select
10923 \begin_inset Quotes eld
10929 \change_inserted -712698321 1437633373
10931 \change_deleted -712698321 1437633373
10938 \begin_inset Quotes erd
10948 \begin_inset space ~
10954 There are some settings in the
10957 \begin_inset space ~
10962 dialog that you should know about that are specific to this class:
10965 \begin_layout Itemize
10966 Don't change the options
10977 \begin_inset space ~
10983 They're ignored by the
10990 \begin_layout Itemize
10991 The default font size is 20
10992 \begin_inset space \thinspace{}
10995 pt with the other options being 17
10996 \begin_inset space \thinspace{}
11000 \begin_inset space \thinspace{}
11004 \begin_inset space \thinspace{}
11010 \begin_layout Itemize
11011 The default font is
11019 but all math equations are still typeset in the usual roman font.
11022 \begin_layout Itemize
11025 Foil\SpecialChar TeX
11028 supports A4 and Letter paper sizes as well as a special size for working
11030 \begin_inset space \thinspace{}
11034 It doesn't support A5, B5, legal or executive paper sizes.
11037 \begin_layout Itemize
11038 Don't bother changing the
11042 settings because they are ignored anyway.
11043 All floats appear where they are defined in the text.
11046 \begin_layout Itemize
11051 setting behaves a bit differently for this class.
11054 Foil\SpecialChar TeX
11057 provides extensive footer and header capabilities including a user-defined
11060 \begin_inset space ~
11064 \begin_inset CommandInset ref
11066 reference "sec:foilfoot"
11071 The title page is treated differently to all other pages in the document
11080 has the logo centered at the bottom of the page (if one is defined).
11081 The possible page style choices and what they do are as follows:
11082 \begin_inset Separator parbreak
11089 \begin_layout Labeling
11090 \labelwidthstring MMMMMMM
11097 The final output contains no page numbers, or other headers or footers
11098 (except footnotes of course).
11102 \begin_layout Labeling
11103 \labelwidthstring MMMMMMM
11110 The final output contains page numbers centered at the bottom of the page.
11111 No other headings or footers (other than footnotes).
11114 \begin_layout Labeling
11115 \labelwidthstring MMMMMMM
11120 Page numbers in lower right corner.
11121 Additional headers and footers are also shown.
11122 This is also the default.
11125 \begin_layout Labeling
11126 \labelwidthstring MMMMMMM
11131 Gives you access to the
11135 package although its use with
11137 Foil\SpecialChar TeX
11140 is discouraged by the writer of the
11142 Foil\SpecialChar TeX
11145 package because of some potential page layout clashes.
11149 \begin_layout Subsubsection
11153 \begin_layout Standard
11154 The following options may be used in the extra class options in the
11156 Document\SpecialChar menuseparator
11162 \begin_layout Labeling
11163 \labelwidthstring MMMMMMx
11168 This sets up the page layout for 7.33
11169 \begin_inset space \thinspace{}
11173 \begin_inset space \thinspace{}
11176 in paper, which is about the same aspect ratio as a 35
11177 \begin_inset space \thinspace{}
11180 mm slide, making it a bit easier to work with this medium.
11183 \begin_layout Labeling
11184 \labelwidthstring MMMMMMx
11189 Places a rule across the page below the header on every page except the
11193 \begin_layout Labeling
11194 \labelwidthstring MMMMMMx
11199 Places a rule across the page above the footer on every page except the
11203 \begin_layout Labeling
11204 \labelwidthstring MMMMMMx
11209 This is automatically set each time you create a new
11216 Foil\SpecialChar TeX
11219 to use the dvips driver to rotate those pages that are set as landscape
11223 \begin_layout Labeling
11224 \labelwidthstring MMMMMMx
11229 Simply changes the page dimensions to those of a landscape page but doesn't
11231 Thus if you use this option you need to use an external program to rotate
11232 each page or feed your paper through your printer as landscape.
11233 Note that this option effectively reverses the roles of the
11241 environments (don't worry these are described in the next section).
11244 \begin_layout Labeling
11245 \labelwidthstring MMMMMMx
11250 Equation numbers on the left.
11253 \begin_layout Labeling
11254 \labelwidthstring MMMMMMx
11259 Flush-left equations.
11262 \begin_layout Subsection
11263 Supported Environments
11266 \begin_layout Standard
11267 Most of the environments commonly supported in other classes are also supported
11273 There are several additional environments provided by
11275 Foil\SpecialChar TeX
11278 as well as a couple added by \SpecialChar LyX
11280 The following environments are shared with other classes:
11283 \begin_layout Standard
11284 \begin_inset Flex Multiple Columns
11287 \begin_layout Itemize
11293 \begin_layout Itemize
11299 \begin_layout Itemize
11305 \begin_layout Itemize
11311 \begin_layout Itemize
11317 \begin_layout Itemize
11324 \begin_layout Itemize
11330 \begin_layout Itemize
11336 \begin_layout Itemize
11342 \begin_layout Itemize
11348 \begin_layout Itemize
11354 \begin_layout Itemize
11360 \begin_layout Itemize
11366 \begin_layout Itemize
11372 \begin_layout Itemize
11378 \begin_layout Itemize
11384 \begin_layout Itemize
11390 \begin_layout Itemize
11401 \begin_layout Standard
11402 That is, all the major environments apart from the sectioning environments.
11403 Since foils are essentially self-contained sections, with a title and body,
11406 Foil\SpecialChar TeX
11409 provides specific commands for starting new foils and these are:
11412 \begin_layout Itemize
11418 \begin_layout Itemize
11424 \begin_layout Standard
11426 also provides slightly modified versions of these two environments called:
11429 \begin_layout Itemize
11435 \begin_layout Itemize
11438 ShortRotatefoilhead
11441 \begin_layout Standard
11442 and the differences will be explained in the next section.
11445 \begin_layout Standard
11446 Since foils are often used in presenting ideas or new theorems and such
11449 Foil\SpecialChar TeX
11452 also provides a comprehensive box of goodies for presenting them:
11455 \begin_layout Standard
11456 \begin_inset Flex Multiple Columns
11459 \begin_layout Itemize
11465 \begin_layout Itemize
11471 \begin_layout Itemize
11477 \begin_layout Itemize
11483 \begin_layout Itemize
11489 \begin_layout Itemize
11495 \begin_layout Itemize
11501 \begin_layout Itemize
11507 \begin_layout Itemize
11513 \begin_layout Itemize
11519 \begin_layout Itemize
11530 \begin_layout Standard
11531 The starred versions are unnumbered while the unstarred versions are numbered.
11532 There are also two list environments added by \SpecialChar LyX
11536 \begin_layout Itemize
11542 \begin_layout Itemize
11548 \begin_layout Standard
11551 Foil\SpecialChar TeX
11554 provides some powerful header and footer capabilities that are best set
11555 in the preamble although they may be set at any point in a document.
11556 If you want to change these settings in your document the best place to
11557 do so is at the very top of a foil, i.
11558 \begin_inset space \thinspace{}
11564 \begin_inset space \space{}
11569 straight after the foilhead.
11572 \begin_layout Standard
11573 For this purpose, the following command styles are provided [
11580 \begin_layout Standard
11581 \begin_inset Flex Multiple Columns
11584 \begin_layout Itemize
11588 \begin_inset space ~
11594 \begin_layout Itemize
11600 \begin_layout Itemize
11604 \begin_inset space ~
11610 \begin_layout Itemize
11614 \begin_inset space ~
11620 \begin_layout Itemize
11624 \begin_inset space ~
11630 \begin_inset Separator parbreak
11637 \begin_layout Plain Layout
11638 \begin_inset space ~
11650 \begin_layout Standard
11651 There are also a few commands provided by
11653 Foil\SpecialChar TeX
11656 that aren't directly supported by \SpecialChar LyX
11657 but I'll tell you what they do and how
11658 to use them in section
11659 \begin_inset space ~
11663 \begin_inset CommandInset ref
11665 reference "sec:unsuppfoils"
11672 \begin_layout Subsection
11673 Building a Set of Foils
11676 \begin_layout Standard
11677 This section will give a simple introduction to using the different environments
11678 to build a set of foils.
11679 If you want to see an example set of foils, take a look at the
11683 file you find in \SpecialChar LyX
11691 \begin_layout Subsubsection
11692 Give It a Title Page
11695 \begin_layout Standard
11696 Unlike other classes that provide
11716 creates the title on a page of its own.
11717 If you leave out the
11721 environment \SpecialChar LaTeX
11722 will substitute the current date (every time you regenerate
11726 \begin_layout Subsubsection
11730 \begin_layout Standard
11731 As I mentioned earlier, there are four ways of starting a new foil.
11732 For portrait foils you should use
11741 The difference between these two environments is the amount of space between
11742 the title of the foil (the foilhead) and the body of the foil.
11745 \begin_layout Standard
11746 Landscape foils are generated using the
11752 ShortRotatefoilhead
11755 Again the only difference is the spacing between foilhead and body.
11756 Both of the short versions have 0.5
11757 \begin_inset space ~
11760 inches less separation between the foilhead and the body.
11764 \begin_layout Standard
11765 One problem with the support for landscape foils is the requirement that
11766 you have to use the
11770 driver to generate the PostScript output otherwise the foils won't be rotated.
11771 It is possible to get landscape foils even if you haven't got the
11775 driver provided you can feed your foils sideways through your printer ;-)
11778 \begin_layout Subsubsection
11779 Theorems, Lemmas, Proofs and more
11782 \begin_layout Standard
11783 Due to a small bug in \SpecialChar LyX
11784 you can't have two of the same type of these environments
11785 directly following each other.
11786 They must be separated by something.
11787 If you try, you will just be extending the previous environment as if you
11788 had merged the two environments together.
11789 So, how do you get around this problem? The simplest option is to insert
11790 some text between the two environments or add a
11795 environment between the two with just a
11796 \begin_inset Quotes eld
11804 \begin_inset Quotes erd
11808 This will force \SpecialChar LyX
11809 to produce two separate environments and hence the correct
11812 An example is provided in the example file included with the \SpecialChar LyX
11814 Remember, this problem only occurs if you are trying to place two of the
11815 same type of theorem-like environments one directly after the other.
11818 \begin_layout Subsubsection
11822 \begin_layout Standard
11823 You get all the commonly supported list styles found in other classes as
11824 well as two new ones.
11825 I'll only describe the new ones here.
11826 If you want to find out more about the other list environments check out
11832 If you intend to use itemized lists you might also want to read about the
11836 \begin_inset space ~
11840 \begin_inset space ~
11845 dialog described above in section
11846 \begin_inset space ~
11850 \begin_inset CommandInset ref
11852 reference "sec:bullet"
11859 \begin_layout Standard
11860 The two new list styles,
11868 , are designed to make it easier for you to create lists of do's and don'ts
11869 or right and wrong by providing dedicated environments that use a tick
11870 or a cross as the label of the list.
11871 These lists are in fact dedicated variants of the
11876 They do however require that you have the
11880 packages installed.
11883 \begin_layout Subsubsection
11887 \begin_layout Standard
11890 Foil\SpecialChar TeX
11893 redefines the floating tables and figures so that they appear exactly where
11894 they are in the text rather than pushing them to the top of the page or
11895 to some user specified location.
11896 In fact if you change the float placement settings they are simply ignored.
11899 \begin_layout Subsubsection
11900 Page Headers and Footers
11901 \begin_inset CommandInset label
11903 name "sec:foilfoot"
11910 \begin_layout Standard
11914 \begin_inset space ~
11923 are two commands used to control the left-footer text string.
11924 The first is meant to allow you to include a graphic logo on your foils
11926 \begin_inset Quotes eld
11931 Foil\SpecialChar TeX
11935 \begin_inset Quotes erd
11939 While the second is meant to provide a classification for the audience,
11943 \begin_inset space \thinspace{}
11949 \begin_inset space \space{}
11953 It is empty by default.
11956 \begin_layout Standard
11957 The remaining page corners can be filled by
11960 \begin_inset space ~
11965 (which defaults to page numbers),
11968 \begin_inset space ~
11976 \begin_inset space ~
11984 \begin_layout Subsection
11987 Foil\SpecialChar TeX
11991 \begin_inset CommandInset label
11993 name "sec:unsuppfoils"
12000 \begin_layout Standard
12001 All the commands mentioned below need to be set in a
12011 within another environment.
12014 \begin_layout Subsubsection
12018 \begin_layout Standard
12019 All lengths are adjusted using the
12042 should be replaced by the name given to the length you want to change and
12047 is the length value.
12048 All lengths should be specified in units of length such as inches (
12060 ) or relative to some document or font-based length such as
12070 \begin_layout Standard
12071 It's possible to change the spacing between a foilhead and the body of the
12072 foil by adjusting the length specified by
12079 For example, to make
12084 \begin_inset space \space{}
12087 in closer to their bodies put the following in the preamble:
12093 foilheadskip}{-0.5in}
12096 \begin_layout Standard
12097 The spacings around floats can be adjusted by setting these lengths:
12100 \begin_layout Labeling
12101 \labelwidthstring MMMMMMMMMMM
12108 Separation between the text and the top of the float
12111 \begin_layout Labeling
12112 \labelwidthstring MMMMMMMMMMM
12119 Separation between the float and the caption
12122 \begin_layout Labeling
12123 \labelwidthstring MMMMMMMMMMM
12130 Separation between the caption and the following text
12133 \begin_layout Labeling
12134 \labelwidthstring MMMMMMMMMMM
12141 You can make the captions narrower than the surrounding text by adjusting
12143 Best done relative to
12152 \begin_layout Standard
12153 There are also several title page related lengths that you may find useful
12154 if you have a long title or several authors:
12157 \begin_layout Labeling
12158 \labelwidthstring MMMMMMMMMMM
12165 Separation from headers to
12170 \begin_layout Labeling
12171 \labelwidthstring MMMMMMMMMMM
12189 \begin_layout Labeling
12190 \labelwidthstring MMMMMMMMMMM
12204 \begin_layout Labeling
12205 \labelwidthstring MMMMMMMMMMM
12221 \begin_layout Labeling
12222 \labelwidthstring MMMMMMMMMMM
12238 \begin_layout Standard
12239 The last length related command affects all the list environments.
12250 a list environment then all the vertical spacing between the list items
12252 Note that this is a command not a length so it doesn't require
12258 like the stuff mentioned above.
12261 \begin_layout Subsubsection
12262 Headers and Footers
12265 \begin_layout Standard
12278 commands control whether the logo in the
12282 definition appear on a given page.
12289 in the preamble then none of the foils will have the logo on them.
12290 If you don't want the logo on a particular page place the
12296 directly after the foilhead of that page and the
12302 directly after the next foilhead.
12305 \begin_layout Standard
12306 If you decide to use the
12310 page style setting in the
12313 \begin_inset space ~
12318 dialog you should probably add
12328 to your preamble so headers and footers on landscape pages are correctly
12329 placed when rotated.
12330 This is due to some clashes between the page layouts provided by the
12341 \begin_layout Section
12342 Hollywood (Hollywood spec scripts)
12345 \begin_layout Standard
12351 \begin_layout Subsection
12355 \begin_layout Standard
12356 Getting the format of a Hollywood script right is a
12357 \begin_inset Quotes eld
12361 \begin_inset Quotes erd
12364 It is designed to make the readers focus on content and to be easy and
12365 familiar for the actors to read.
12366 Each page of a script should be one minute of film.
12367 Nothing goes in a script that you cannot see or hear on screen.
12368 The courier 12 pt font should be used throughout.
12372 \begin_layout Subsection
12376 \begin_layout Standard
12377 Speakers' lines should NEVER break in mid-sentence.
12378 If a speaker's lines continue over a page break, repeat the
12382 title followed by (Cont'd).
12385 \begin_layout Subsection
12389 \begin_layout Standard
12394 names as labels then cross-reference the label to insert the name.
12395 The cross-reference dialog will show the current cast of characters.
12396 You can use this to insert the speaker name in narratives also.
12399 \begin_layout Subsection
12400 Paper size and Margins
12403 \begin_layout Standard
12404 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12407 \begin_layout Subsection
12411 \begin_layout Standard
12412 The following environments are available.
12413 You can use hollywood.bind to get the bind keys shown at the right.
12416 \begin_layout Itemize
12420 \begin_inset Newline newline
12425 Used where nothing else works.
12429 \begin_layout Itemize
12435 \begin_inset space \hfill{}
12443 \begin_inset Newline newline
12446 Usually followed by something like
12447 \begin_inset Quotes eld
12450 on Sally waking up.
12451 \begin_inset Quotes erd
12457 \begin_layout Itemize
12461 \begin_inset space \hfill{}
12465 \begin_inset Newline newline
12470 Introduces a new INTERIOR camera set-up.
12471 Always followed by DAY or NIGHT, or something similar to define the lighting
12473 Everthing on this line in CAPS.
12476 \begin_layout Itemize
12480 \begin_inset space \hfill{}
12484 \begin_inset Newline newline
12489 Introduces a new EXTERIOR camera set-up.
12490 Everthing on this line in CAPS.
12493 \begin_layout Itemize
12497 \begin_inset space \hfill{}
12501 \begin_inset Newline newline
12506 The character speaking.
12509 \begin_layout Itemize
12513 \begin_inset space \hfill{}
12517 \begin_inset Newline newline
12522 Instructions to the speaker.
12523 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12525 Both will be printed.
12528 \begin_layout Itemize
12532 \begin_inset space \hfill{}
12536 \begin_inset Newline newline
12548 \begin_layout Itemize
12552 \begin_inset space \hfill{}
12556 \begin_inset Newline newline
12561 Camera movement instruction.
12563 \begin_inset space \thinspace{}
12567 \begin_inset space \space{}
12573 \begin_layout Itemize
12577 \begin_inset space \hfill{}
12583 \begin_layout Itemize
12587 \begin_inset space \hfill{}
12593 \begin_layout Itemize
12597 \begin_inset space \hfill{}
12603 \begin_layout Itemize
12607 \begin_inset space \hfill{}
12613 \begin_layout Subsection
12617 \begin_layout Itemize
12621 \begin_layout Itemize
12625 \begin_layout Itemize
12627 \begin_inset space \thinspace{}
12634 \begin_layout Itemize
12639 \begin_layout Itemize
12640 PAN — camera movement
12643 \begin_layout Itemize
12644 INSERT — cut to close-up of
12647 \begin_layout Section
12651 \begin_layout Standard
12654 Panayotis Papasotiriou
12657 \begin_layout Subsection
12661 \begin_layout Standard
12662 The ijmpc package is a set of macros that facilitates electronic manuscript
12665 International Journal of Modern Physics C
12668 Similarly, the ijmpd package is for creating manuscripts to be submitted
12671 International Journal of Modern Physics D
12674 Both journals are published by World Scientific.
12675 The corresponding document classes are named
12684 These files, together with instructions for the authors, can be downloaded
12686 \begin_inset Flex URL
12689 \begin_layout Plain Layout
12691 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12697 \begin_inset Flex URL
12700 \begin_layout Plain Layout
12702 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12708 Both packages are modified versions of the standard
12709 \begin_inset Quotes eld
12713 \begin_inset Quotes erd
12716 package, and they are almost (but not exactly) identical.
12717 Most of their features are supported by \SpecialChar LyX
12719 I have used \SpecialChar LyX
12720 successfully to write articles submitted to both journals
12721 without any problem.
12724 \begin_layout Subsection
12728 \begin_layout Standard
12729 As usual, the easiest way to write a paper is to start with a template.
12732 File\SpecialChar menuseparator
12751 This will give an (almost) empty document that includes the most common
12752 fields found in a manuscript.
12753 Simply overwrite the existing text (including the brackets,
12758 You should keep in mind the following remarks.
12761 \begin_layout Enumerate
12763 won't let you change the font size and the page style of the document,
12764 because such modifications are not allowed by both packages.
12767 \begin_layout Enumerate
12768 The language of the document should not be changed.
12769 Before previewing your paper, be sure that the babel package is not used.
12770 To do this, click on
12772 Tools\SpecialChar menuseparator
12783 checkbox in the language settings, and click on
12791 , if you wish to make this change permanent).
12794 \begin_layout Enumerate
12796 \begin_inset Quotes eld
12800 \begin_inset Quotes erd
12803 style must be used to define keywords.
12806 \begin_layout Enumerate
12807 The ijmpc package provides a style named
12808 \begin_inset Quotes eld
12811 Classification Codes
12812 \begin_inset Quotes erd
12815 , which can be used to define classification codes, such as PACS numbers.
12816 Note that this facility is not supported by the ijmpd package.
12819 \begin_layout Enumerate
12820 Several new environments are available:
12821 \begin_inset Quotes eld
12825 \begin_inset Quotes erd
12829 \begin_inset Quotes eld
12833 \begin_inset Quotes erd
12837 \begin_inset Quotes eld
12841 \begin_inset Quotes erd
12845 \begin_inset Quotes eld
12849 \begin_inset Quotes erd
12853 \begin_inset Quotes eld
12857 \begin_inset Quotes erd
12861 \begin_inset Quotes eld
12865 \begin_inset Quotes erd
12869 \begin_inset Quotes eld
12873 \begin_inset Quotes erd
12877 \begin_inset Quotes eld
12881 \begin_inset Quotes erd
12885 \begin_inset Quotes eld
12889 \begin_inset Quotes erd
12893 \begin_inset Quotes eld
12897 \begin_inset Quotes erd
12901 \begin_inset Quotes eld
12905 \begin_inset Quotes erd
12909 \begin_inset Quotes eld
12913 \begin_inset Quotes erd
12917 \begin_inset Quotes eld
12921 \begin_inset Quotes erd
12925 \begin_inset Quotes eld
12929 \begin_inset Quotes erd
12933 Their use is more or less obvious.
12935 supports all these environments; it will use the proper label, text style,
12936 and numbering scheme for each of them.
12939 \begin_layout Enumerate
12940 Both packages use basic citations; the natbib package should not be used.
12941 In \SpecialChar LyX
12942 , citation references are shown as usual; in the output, citations are
12943 shown as superscripts.
12944 If you want to use a citation as normal text, you should use the
12949 \begin_inset space \thinspace{}
12953 \begin_inset space \space{}
12957 \begin_inset Quotes eld
12961 \begin_inset space \space{}
12971 \begin_inset Quotes erd
12977 \begin_layout Enumerate
12979 \begin_inset Quotes eld
12983 \begin_inset Quotes erd
12986 section in both packages.
12987 To put acknowledgments, just use the
12988 \begin_inset Quotes eld
12992 \begin_inset Quotes erd
12998 \begin_layout Enumerate
12999 Appendices may be added to the paper,
13003 the Acknowledgments and
13009 provides a special environment, called
13010 \begin_inset Quotes eld
13014 \begin_inset Quotes erd
13017 which marks the beginning of the appendices.
13018 This environment should be left blank; it just sends a \SpecialChar LaTeX
13019 command, but nothing
13021 In \SpecialChar LyX
13023 \begin_inset Quotes eld
13027 \begin_inset Quotes erd
13030 is printed with blue letters, as a signal that all sections after that
13031 point are appendices.
13032 To write an appendix, use the
13033 \begin_inset Quotes eld
13037 \begin_inset Quotes erd
13042 will number each appendix with capital letters, as required by both journals.
13044 \begin_inset Quotes eld
13048 \begin_inset Quotes erd
13055 be present before the first appendix; if not, all appendices will be numbered
13056 as normal sections in the output.
13059 \begin_layout Enumerate
13060 The ijmpc and the ijmpd packages use the
13064 command to implement table captions.
13065 As a result, a table created by \SpecialChar LyX
13066 is printed correctly, but its caption
13068 However, you can use some \SpecialChar TeX
13069 code to overcome this problem, so that captions
13070 are printed as expected.
13071 To do so, create a float table as usual, remove the caption, and replace
13072 it with the \SpecialChar TeX
13083 (sic); you must also the \SpecialChar TeX
13088 immediately after the tabular material.
13089 Study the example table included in the template files to see how this
13090 trick is implemented.
13091 Alternatively, If you need table captions, you should implement the whole
13096 file, then include this file to the \SpecialChar LyX
13099 Insert\SpecialChar menuseparator
13100 File\SpecialChar menuseparator
13102 \begin_inset space ~
13108 Details on how to create a table float can be found in the files
13116 , included in the corresponding packages.
13119 \begin_layout Subsection
13120 Preparing a paper for submission
13123 \begin_layout Standard
13124 Before you submit your paper you must export the \SpecialChar LyX
13125 document as a \SpecialChar LaTeX
13128 File\SpecialChar menuseparator
13129 Export\SpecialChar menuseparator
13137 \begin_layout Plain Layout
13138 Actually you have the choice between \SpecialChar LaTeX
13139 (plain) and pdflatex.
13140 If you intend to use pdflatex to prepare the paper, you should use the
13141 pdflatex option so that included graphics are converted to PDF format,
13142 ready for use by pdflatex.
13147 , then make the following changes to the resulting
13154 \begin_layout Enumerate
13155 Remove the comment lines before the
13164 \begin_layout Enumerate
13165 Remove everything between (and including) the
13177 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13181 \begin_layout Standard
13186 file should be saved and processed through \SpecialChar LaTeX
13187 as many times as necessary.
13188 You may also want to check the resulting
13195 \begin_layout Subsection
13196 Use of \SpecialChar TeX
13200 \begin_layout Standard
13201 The use of \SpecialChar TeX
13202 code is reduced to two commands, which must be placed at the
13203 top of the document.
13204 If you started writing your paper by using the
13212 template, the \SpecialChar TeX
13213 code needed is already in its place; you usually don't need
13215 You may only modify the first \SpecialChar TeX
13216 code to specify the information printed
13217 to the top of odd and even pages (authors' names and short paper's title,
13219 This \SpecialChar TeX
13220 code must have the form
13224 markboth{Authors' Names}{Short Paper's Title}
13229 \begin_layout Section
13233 \begin_layout Standard
13239 \begin_layout Subsection
13243 \begin_layout Standard
13244 The iopart package provides a document class to create electronic manuscript
13245 submission to the journals published by the Institute of Physics.
13246 Instructions for the authors how to create a paper using the iopart class
13247 can be downloaded together with the iopart package from the site
13248 \begin_inset Flex URL
13251 \begin_layout Plain Layout
13253 ftp://ftp.iop.org/pub/journals/latex2e
13261 \begin_layout Subsection
13265 \begin_layout Standard
13266 The easiest way to write a paper is to start with the file
13270 that is available in \SpecialChar LyX
13271 's examples files folder.
13272 Open this file, save it under a new name, and start writing.
13273 The example file explains how to use the special text environments.
13274 Here are the most important advices:
13277 \begin_layout Itemize
13278 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13281 Use AMS math package
13283 in the document settings under
13290 \begin_layout Itemize
13293 The title environment defines the kind of your paper.
13294 So use one of the following environments for the title:
13297 \begin_inset Separator parbreak
13304 \begin_layout Itemize
13313 \begin_layout Itemize
13322 \begin_layout Itemize
13328 for a Topical review
13331 \begin_layout Itemize
13340 \begin_layout Itemize
13349 \begin_layout Itemize
13355 for a Paper (same as Title)
13358 \begin_layout Itemize
13364 for a Preliminary communication
13367 \begin_layout Itemize
13373 for a Rapid communication
13376 \begin_layout Itemize
13382 for a Letter to the editor
13386 \begin_layout Itemize
13389 All title environments except of
13393 can have an optional short title.
13396 \begin_layout Itemize
13397 There is a general title environment
13401 which is not directly supported by the \SpecialChar LyX
13403 This can be used as \SpecialChar TeX
13404 code when your document doesn't fit into one of the
13408 \begin_layout Standard
13409 For more informations like hints for special table and formula formatting,
13410 look at the IOP author guidelines.
13413 \begin_layout Section
13417 \begin_layout Standard
13420 Panayotis Papasotiriou
13423 \begin_layout Subsection
13427 \begin_layout Standard
13428 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13429 that facilitates electronic manuscript submission to the journals they
13431 Most known of them (at least in my domain of interest) are
13433 Astrophysics and Space Science
13439 , but there are many others (see a complete list at
13440 \begin_inset Flex URL
13443 \begin_layout Plain Layout
13445 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13451 The Kluwer package may be downloaded from the site
13452 \begin_inset Flex URL
13455 \begin_layout Plain Layout
13457 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13463 A complete user guide is contained in that package (but it can also be
13464 downloaded separately).
13467 \begin_layout Standard
13469 supports many features of the package but not everything.
13470 However, the \SpecialChar TeX
13471 code needed is reduced to some
13472 \begin_inset Quotes eld
13476 \begin_inset Quotes erd
13479 commands of the package (see
13480 \begin_inset space ~
13484 \begin_inset CommandInset ref
13486 reference "subsec:kluwer_peculiarities"
13491 I have recently used \SpecialChar LyX
13492 to write an article submitted to the
13494 Astrophysics and Space Science
13496 without any problem.
13499 \begin_layout Subsection
13503 \begin_layout Standard
13504 The easiest way to write a paper is to start with the Kluwer template file.
13507 File\SpecialChar menuseparator
13519 This will give an (almost) empty document that includes the most common
13520 fields found in a manuscript and a short description of their use.
13521 As in most templates, simply overwrite the existing text (including the
13526 ) with the correct information.
13529 \begin_layout Subsection
13530 Preparing a paper for submission
13533 \begin_layout Standard
13534 As in the AAS\SpecialChar TeX
13535 package, before you submit your paper to a journal you must
13537 \begin_inset Quotes eld
13541 \begin_inset Quotes erd
13547 \begin_layout Enumerate
13548 Export your paper as a \SpecialChar LaTeX
13550 To do this, click on
13552 File\SpecialChar menuseparator
13553 Export\SpecialChar menuseparator
13561 \begin_layout Enumerate
13566 file with a text editor and make the following changes
13567 \begin_inset Separator parbreak
13574 \begin_layout Enumerate
13575 remove the comment lines before the
13584 \begin_layout Enumerate
13585 remove everything between (and including) the
13597 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13601 \begin_layout Standard
13610 \begin_layout Enumerate
13615 file through \SpecialChar LaTeX
13616 as many times as necessary (usually up to three).
13619 \begin_layout Enumerate
13625 \begin_inset space \thinspace{}
13629 \begin_inset space \space{}
13636 , and check if everything is OK (it should, if you didn't make any mistake).
13639 \begin_layout Subsection
13640 \begin_inset Quotes eld
13644 \begin_inset Quotes erd
13647 of the Kluwer package
13648 \begin_inset CommandInset label
13650 name "subsec:kluwer_peculiarities"
13657 \begin_layout Standard
13658 The Kluwer package has the following
13659 \begin_inset Quotes eld
13663 \begin_inset Quotes erd
13669 \begin_layout Enumerate
13670 It is possible to write multiple articles in the same \SpecialChar LaTeX
13675 \begin_layout Plain Layout
13676 I can't imagine any good reason to do this.
13682 Each article must be included in the environment
13683 \begin_inset Quotes eld
13687 \begin_inset Quotes erd
13691 Unfortunately, this environment cannot be omitted, even if you write just
13693 Therefore, each article starts with the command
13699 and, obviously, ends with the command
13706 Although this can be implemented in \SpecialChar LyX
13707 , I didn't included it, since it looks
13708 ugly and can confuse the novice user.
13709 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13712 \begin_inset Quotes eld
13717 \begin_inset Quotes erd
13723 \begin_layout Enumerate
13724 Information given at the beginning of the article (i.
13725 \begin_inset space \thinspace{}
13729 \begin_inset space \space{}
13732 title, subtitle, author, institution, running title, running author, abstract
13733 and keywords) must be included in an environment called
13734 \begin_inset Quotes eld
13738 \begin_inset Quotes erd
13742 This is not implemented in \SpecialChar LyX
13743 , so you must enter title, subtitle etc.
13744 \begin_inset space ~
13747 between two \SpecialChar TeX
13763 \begin_layout Enumerate
13764 According to the user manual, the label of each bibliography item must be
13788 \begin_layout Standard
13793 template takes care of all these
13794 \begin_inset Quotes eld
13798 \begin_inset Quotes erd
13802 If you start a new paper using this template you don't need to do anything
13807 \begin_layout Enumerate
13808 don't delete the \SpecialChar TeX
13809 code included in the template, and
13812 \begin_layout Enumerate
13813 copy the example bibliography item included in the template and modify it
13814 as necessary to enter new bibliography items.
13817 \begin_layout Section
13821 \begin_layout Standard
13827 \begin_layout Subsection
13831 \begin_layout Standard
13832 The \SpecialChar LyX
13835 article (koma-script)
13839 report (koma-script)
13857 correspond to the \SpecialChar LaTeX
13875 \begin_inset space ~
13878 of the Koma-Script family.
13879 They are replacements for the standard document classes
13895 , resp., and fit better to European typography conventions in a number of
13899 \begin_layout Itemize
13900 Standard character size is 11pt in
13902 article (koma-script)
13906 report (koma-script)
13914 letter (koma-script)
13919 \begin_layout Itemize
13920 Headings, labels of the description environment, and a number of elements
13923 letter (koma-script)
13925 document class are set in a bold sans serif font.
13929 \begin_layout Plain Layout
13930 There is a big difference between the bold sans serif old cm fonts and new
13931 ec fonts, especially in the appearance of headings.
13932 In comparison, the ec bold sans serif fonts look a bit thin.
13933 Here the \SpecialChar LaTeX
13942 helps to produce the
13943 \begin_inset Quotes eld
13947 \begin_inset Quotes erd
13950 appearance when using the ec fonts.
13955 The numbering of chapter headings is made in the same way as the numbering
13956 of section headings, that is without the extra line
13957 \begin_inset Quotes eld
13960 Chapter\SpecialChar ldots
13962 \begin_inset Quotes erd
13966 In addition, the appearance of the headings can be modified by using a
13967 number of options (in \SpecialChar LyX
13968 to be entered in the field
13971 \begin_inset space ~
13978 Layout\SpecialChar menuseparator
13985 \begin_layout Itemize
13986 The main means in the Koma-Script document classes to design the type area
13995 (in \SpecialChar LyX
13996 to be entered in the extra class options field in the dialog
13998 Document\SpecialChar menuseparator
14002 They make a clearer modification of page margins possible as do the options
14005 Document\SpecialChar menuseparator
14012 \begin_layout Itemize
14013 The \SpecialChar LaTeX
14014 document classes of the Koma-Script family define a number of additional
14016 Those part of it which makes sense in \SpecialChar LyX
14017 is implemented in corresponding
14021 \begin_layout Standard
14022 Detailed descriptions of the \SpecialChar LaTeX
14023 document classes of the Koma-Script family
14024 can be found in the Koma-Script documentation
14035 \begin_layout Subsection
14036 article (koma-script), report (koma-script), and book (koma-script)
14039 \begin_layout Standard
14040 The document classes
14042 article (koma-script)
14046 report (koma-script)
14056 are implemented in the layout files
14069 They contain all the paragraph types of the corresponding standard document
14082 , resp., partly modified, with the exception of the \SpecialChar LyX
14087 -type, which is replaced by the new
14091 -type having the same functionality.
14096 -Type there is a number of new paragraph types added.
14103 letter (koma-script)
14108 \begin_layout Itemize
14117 : are equivalents to
14125 , resp., additionally inserting an entry in the table of contents.
14134 are not contained in
14136 article (koma-script)
14141 \begin_layout Itemize
14150 : behave exactly as
14158 , resp., additionally clearing running heads.
14163 is not contained in
14165 article (koma-script)
14171 \begin_layout Plain Layout
14184 report (koma-script)
14186 , but since this is identical to
14190 , is has not been implemented in \SpecialChar LyX
14199 \begin_layout Itemize
14204 : generates a heading directly above the following paragraph in the standard
14205 character size without affecting the structure of the document.
14208 \begin_layout Itemize
14217 are special captions which respect the different space settings needed
14218 for captions placed above or below an element (if you follow strict typographic
14219 rules, you might want to place table captions always above the table).
14220 You can also use the class option
14224 , which will switch
14237 You need at least Koma-Script version 2.8q to use this.
14240 \begin_layout Itemize
14245 : can be used to set a bonmot, e.
14246 \begin_inset space \thinspace{}
14250 \begin_inset space \space{}
14253 at the beginning of a chapter.
14254 If you use the optional argument (
14256 Insert\SpecialChar menuseparator
14258 \begin_inset space ~
14263 ), you can insert the dictum's author there.
14264 Dictum and author are separated by a line.
14265 You need at least Koma-Script version 2.8q to use this.
14270 is not contained in
14272 article (koma-script)
14277 \begin_layout Standard
14278 The following types, together with the standard types
14290 , form the title area of the document.
14291 They must be entered ahead of the first
14292 \begin_inset Quotes eld
14296 \begin_inset Quotes erd
14303 \begin_layout Plain Layout
14304 The corresponding \SpecialChar LaTeX
14305 commands must appear before the
14316 When such a type is used more than once, the latter usage overwrites the
14317 former one, that means, for every type only the latest usage is valid.
14318 The order of the different types however has, like
14330 , no effect on the appearance of the produced document.
14333 \begin_layout Itemize
14338 : produces a centered paragraph above the ordinary title (
14350 ) for the subject of the document.
14353 \begin_layout Itemize
14358 : produces a centered paragraph below the ordinary title (
14370 ) for the publishers' name.
14373 \begin_layout Itemize
14380 report (koma-script)
14386 produces a centered paragraph on its own page behind the title page, or
14389 article (koma-script)
14391 produces a centered paragraph below the ordinary title (
14407 ) for a dedication.
14410 \begin_layout Itemize
14415 : produces a left aligned paragraph above the ordinary title (
14431 ) for a document`s head.
14434 \begin_layout Itemize
14439 : produces in a double-sided print in
14441 report (koma-script)
14447 a left-aligned paragraph at the top of the title page`s back or has no
14448 effect in a single-sided print or in
14450 article (koma-script)
14455 \begin_layout Itemize
14460 : produces in a double-sided print in
14462 report (koma-script)
14468 a left-aligned paragraph at the bottom of the title page`s back or has
14469 no effect in a single-sided print or in
14471 article (koma-script)
14476 \begin_layout Itemize
14481 : produces a special
14482 \begin_inset Quotes eld
14486 \begin_inset Quotes erd
14489 page ahead of the actual document containing a paragraph without special
14493 \begin_layout Standard
14494 The layout files for the document classes
14496 article (koma-script)
14500 report (koma-script)
14506 do include the file
14511 This is thought of as a place to define your own types.
14516 in your personal layout directory and edit the file!
14519 \begin_layout Subsection
14520 letter (koma-script)
14523 \begin_layout Standard
14527 letter (koma-script)
14529 is implemented in the layout file
14534 It contains all the paragraph types of the corresponding standard document
14539 , partly modified, with the exception of the \SpecialChar LyX
14553 type, which is replaced by the new
14558 In addition, it contains, in contrast to the standard document class, the
14577 Furthermore, there are a number of new letter specific types.
14580 \begin_layout Standard
14581 The appearance of the letter produced by this document class can be controlled
14582 by a number of \SpecialChar LaTeX
14583 commands, which you can put in the \SpecialChar LaTeX
14588 \begin_layout Plain Layout
14589 For example, the standard appearance of the letter`s heading, consisting
14590 of name and address, is quite self-willed.
14592 \begin_inset Quotes eld
14596 \begin_inset Quotes erd
14599 heading is produced by the following \SpecialChar LaTeX
14600 commands in the preamble:
14603 \begin_layout LyX-Code
14613 \begin_layout LyX-Code
14629 \begin_layout LyX-Code
14639 \begin_layout LyX-Code
14659 A detailed German description of such \SpecialChar LaTeX
14660 commands can be found in the Koma-Script
14666 With it, the letter's author can produce his personal letter layout.
14669 \begin_layout Standard
14678 define the beginning of the letter and must be used in every letter.
14679 To emphasize them in the \SpecialChar LyX
14680 document class, they are marked with the letter
14690 \begin_inset space ~
14693 in the left margin.
14694 It is possible to write any number of letters in one file.
14699 type produces a new letter using the same addressee and a
14703 type produces a new addressee.
14720 are ordinary paragraph types and can also be used several times in one
14721 and the same letter.
14724 \begin_layout Itemize
14729 : produces a paragraph for the addressee and implicitly defines the beginning
14733 \begin_layout Itemize
14738 : produces a paragraph for the form of address and implicitly produces a
14742 \begin_layout Itemize
14747 : produces a paragraph for a close.
14750 \begin_layout Itemize
14755 : produces a paragraph for a postscript.
14758 \begin_layout Itemize
14763 : produces a paragraph for a distribution list.
14766 \begin_layout Itemize
14771 : produces a paragraph for enclosures.
14774 \begin_layout Standard
14815 are input types provided with a label to enter information, which will
14816 be processed by the document class.
14820 \begin_layout Plain Layout
14821 It could be seen as a matter of inconsequence, that the types
14829 described above are not such input types as well.
14830 Because of the special meaning of those types, however, I have implemented
14831 them as ordinary paragraph types with a one letter mark in the left margin.
14832 Moreover, it would affect my feeling of symmetry, if the
14840 type had such a serious different appearance.
14845 The types must be used ahead of the corresponding
14852 \begin_layout Standard
14853 An implementation of these types in a WYSIWYG fashion does not seem to make
14854 sense, because the real appearance of the produced letter does not only
14855 depend on the usage of the particular type, but also on other factors.
14856 For example, a signature entered in the
14860 type will in the standard behavior appear in the produced letter only,
14861 when in the same letter also a
14866 The entered value of the
14870 type will in the standard behavior not appear in the produced letter at
14872 The possibility to design the letter`s heading freely is already indicated
14873 in a footnote above.
14876 \begin_layout Standard
14877 The input types can also be used as empty paragraphs.
14878 This makes sense e.
14879 \begin_inset space \thinspace{}
14883 \begin_inset space \space{}
14895 type is not used at all, in the standard behavior the value of the
14899 type is used as signature, whereas if an empty
14903 type is used, no signature value is defined.
14906 \begin_layout Standard
14907 By using the input types it is possible to write a letter template, containing
14908 filled input types with your personal dates (name, address, etc.) and empty
14909 input types for other dates you want to enter.
14912 \begin_layout Itemize
14917 : sender's name, in the standard behavior appears as a centered paragraph
14918 in small caps in the letter`s heading.
14921 \begin_layout Itemize
14926 : sender's signature, in the standard behavior appears below the
14935 type is used, the value of the
14939 type appears instead.
14942 \begin_layout Itemize
14947 : sender's address, in the standard behavior appears in a centered paragraph
14948 in the letter`s heading below the sender's name.
14951 \begin_layout Itemize
14956 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
14967 \begin_layout Itemize
14972 : place of the letter`s making.
14975 \begin_layout Itemize
14980 : date of the letter`s making.
14989 , in the standard behavior, produce the place and the date in a right-aligned
14990 line below the addressee's field.
14995 type is used, neither place nor date appear, independent of the value of
15005 type is used, the date of the letter `s production is used.
15008 \begin_layout Itemize
15013 : sender`s back address, in the standard behavior appears above the addressee's
15014 field in a small sans serif font.
15017 \begin_layout Itemize
15022 : special mail information, in the standard behavior appears underlined
15023 above the addressee's field below the back address.
15026 \begin_layout Itemize
15031 : additional information, in the standard behavior appears on right side
15032 below the addressee`s field.
15035 \begin_layout Itemize
15040 : the letter's title, in the standard behavior appears in a big, bold, sans
15041 serif font above the subject.
15044 \begin_layout Itemize
15049 : the letter's subject, in the standard behavior appears in a bold font
15057 \begin_layout Standard
15078 produce a business letter like line above the
15082 line containing the fields
15083 \begin_inset Quotes eld
15087 \begin_inset Quotes erd
15091 \begin_inset Quotes eld
15095 \begin_inset Quotes erd
15099 \begin_inset Quotes eld
15103 \begin_inset Quotes erd
15107 \begin_inset Quotes eld
15111 \begin_inset Quotes erd
15115 \begin_inset Quotes eld
15119 \begin_inset Quotes erd
15123 \begin_inset Quotes eld
15127 \begin_inset Quotes erd
15131 For the date field, the value of the
15137 \begin_inset Quotes eld
15140 business letter types
15141 \begin_inset Quotes erd
15144 is used, the value of the
15148 type however does not appear, but only the \SpecialChar LaTeX
15156 The ordinary output of place and date in a right-aligned line below the
15157 addressee`s field is suppressed.
15158 The types are implemented as input types provided with a label and must
15159 be used ahead of the corresponding
15166 \begin_layout Itemize
15174 \begin_layout Itemize
15182 \begin_layout Itemize
15190 \begin_layout Itemize
15198 \begin_layout Itemize
15206 \begin_layout Subsection
15207 The new letter class: letter (koma-script v.2)
15210 \begin_layout Standard
15216 \begin_layout Standard
15217 \begin_inset VSpace medskip
15223 \begin_layout Standard
15225 Koma-Script version 2.8 has introduced a new letter class
15229 which supersedes the now unsupported
15234 It has — on the \SpecialChar LaTeX
15235 side — a completely new interface and is not compatible
15236 with the old class.
15237 Therefore, \SpecialChar LyX
15238 supports both, though it is recommended you use the new class.
15241 \begin_layout Standard
15242 This class covers the same functionality as
15244 letter (koma-script),
15247 The basic items are
15251 (receiver's address, same as
15255 in the old layout),
15268 will start a new letter (i.
15269 \begin_inset space \thinspace{}
15273 \begin_inset space \space{}
15276 you can write several letters per document).
15277 New elements are sender's
15293 and the possibility to use a
15299 Insert\SpecialChar menuseparator
15305 \begin_layout Standard
15306 The biggest improvement is, though, that the letter's layout is configurable
15307 to meet almost any needs.
15308 This can be done via the preamble or with a special style file (Letter
15309 Class Option, extension
15313 ), that will be read in as a class option.
15317 \begin_layout Plain Layout
15318 The KOMA package comes with some default
15323 There is, for instance, a
15327 file that follows german typesetting rules, or a
15331 that provides the default layout of the old
15336 The latter can be loaded with the class option
15345 ayout\SpecialChar menuseparator
15350 ocument\SpecialChar menuseparator
15362 template that is included in \SpecialChar LyX
15364 A detailed description is to be found in the Koma-Script documentation
15372 \begin_layout Subsection
15376 \begin_layout Standard
15377 Visualizing the Koma-Script document classes in \SpecialChar LyX
15378 , the \SpecialChar LyX
15379 internals cause some
15383 \begin_layout Itemize
15384 The chapter number of a
15388 type appears on a line of its own above the chapter heading instead of
15389 appearing in the same line ahead of it.
15390 The cause for that is the \SpecialChar LyX
15391 internal behavior for the labeltype
15395 in the layout file.
15398 \begin_layout Itemize
15399 The headings of the types
15407 are only put in the
15408 \begin_inset Quotes eld
15412 \begin_inset Quotes erd
15416 table of contents, but not in the \SpecialChar LyX
15417 table of contents (
15419 Document\SpecialChar menuseparator
15421 \begin_inset space ~
15425 \begin_inset space ~
15433 \begin_layout Itemize
15434 The paragraphs in a
15438 document class appear in a skip separation mode, not indented.
15439 This is the standard behavior, no special \SpecialChar LaTeX
15440 commands are needed for that.
15443 Document\SpecialChar menuseparator
15446 dialog the corresponding radio button indicates
15455 value always has the effect that extra \SpecialChar LaTeX
15456 commands are inserted in the document
15457 to produce the gap, which is not what is wanted in this case.
15460 \begin_layout Section
15464 \begin_layout Standard
15470 \begin_layout Subsection
15474 \begin_layout Standard
15475 Memoir is a very powerful and constantly evolving class.
15476 It has been designed with regard to fictional and non-fictional literature.
15477 Its aim is to let the user have maximum control over the typesetting of
15479 Memoir is based on the standard book class, but it can also emulate the
15480 article class (see below).
15483 \begin_layout Standard
15484 Peter Wilson, the developer of Memoir, is known as the author of lots of
15485 useful packages in the \SpecialChar LaTeX
15487 Most of them have been merged with Memoir.
15488 Therefore, it is much easier to layout the table of contents, appendices,
15489 chapter designs and such.
15491 , though, does not support all of these goodies natively.
15492 Some of them might be added to forthcoming releases
15496 \begin_layout Plain Layout
15497 You are invited to send suggestions to
15498 \begin_inset Flex URL
15501 \begin_layout Plain Layout
15503 lyx-devel@lists.lyx.org
15513 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15515 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15517 commands (\SpecialChar TeX
15522 \begin_layout Plain Layout
15527 \begin_layout Plain Layout
15537 \begin_inset space ~
15541 \begin_inset CommandInset ref
15543 reference "sec:Inserting-TeX-Code"
15553 In this section, we can only list those features that are natively supported
15554 by \SpecialChar LyX
15556 For detailed descriptions (and for the rest of features) we recommend you
15557 have a look at the detailed manual of the Memoir class
15561 \begin_layout Plain Layout
15566 \begin_layout Plain Layout
15576 \begin_inset Flex URL
15579 \begin_layout Plain Layout
15581 CTAN:/macros/latex/memoir/memman.pdf
15591 , which is not only a user guide for the class, but also both a comprehensive
15592 description on good typesetting and a superb example for good typesetting
15596 \begin_layout Subsection
15597 Basic features and restrictions
15600 \begin_layout Standard
15601 Memoir supports basically all features of the standard book classes.
15602 There are, however, some differences, as follows:
15605 \begin_layout Description
15607 \begin_inset space ~
15610 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15613 \begin_layout Description
15615 \begin_inset space ~
15618 style: The fancy page style is not supported, due to a command clash between
15619 Memoir and the fancyhdr package (they both define a command with the same
15620 name, which confuses \SpecialChar LaTeX
15622 Instead, Memoir comes with a number of its own page styles (see
15624 Layout\SpecialChar menuseparator
15625 Document\SpecialChar menuseparator
15627 \begin_inset space ~
15633 If you want to use these for the chapter pages, you have to use the command
15640 in the main text or in preamble (e.
15641 \begin_inset space \thinspace{}
15645 \begin_inset space \space{}
15652 chapterstyle{companion}
15657 \begin_layout Description
15658 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15659 optional argument in the standard classes.
15660 With this, you can specify an alternative version of the title for the
15661 table of contents and the headers (for instance, if the title is too long).
15662 In \SpecialChar LyX
15663 , you can do this via
15665 Insert\SpecialChar menuseparator
15667 \begin_inset space ~
15672 at the beginning of a chapter/section.
15673 Memoir features a second optional argument and thus separates the table
15674 of contents from the header.
15675 You can define three variants of a title with this: one for the main text,
15676 one for the table of contents, and one for the headers.
15677 Simply insert two optional arguments if you need this feature, the first
15678 one containing the short title for the Table of Contents, the second one
15679 containing an alternative short title for the headers.
15682 \begin_layout Description
15683 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15684 of contents, the list of figures and the list of table start a new page
15686 Memoir does not follow this route.
15687 You have to insert a page break yourself, if you want to have one.
15690 \begin_layout Description
15691 Titlepage: For some unknown reason, Memoir uses pagination on the title
15692 page (in the standard classes, title pages are
15693 \begin_inset Quotes eld
15697 \begin_inset Quotes erd
15701 If you want an empty title page, type
15705 aliaspagestyle{title}{empty}
15710 \begin_layout Description
15711 Article: With the class option
15717 Layout\SpecialChar menuseparator
15718 Document\SpecialChar menuseparator
15720 \begin_inset space ~
15725 ), you can emulate article style.
15726 That is, counters (footnotes, figures, tables etc.) will not be reset on
15727 new chapters, chapters don't start a new page (but are—in contrary to
15728 \begin_inset Quotes eld
15732 \begin_inset Quotes erd
15735 article classes—still allowed), parts, though, use their own page, as in
15739 \begin_layout Description
15740 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15741 font commands, which have been used in the old \SpecialChar LaTeX
15743 \begin_inset space \thinspace{}
15747 \begin_inset space \space{}
15763 It produces an error and stops \SpecialChar LaTeX
15764 whenever such a command appears.
15769 reallows the commands and spits out warnings instead (which does at least
15770 not stop \SpecialChar LaTeX
15772 Since a lot of packages and particularly Bib\SpecialChar TeX
15773 style files are still using
15774 those commands, we have decided to use this option by default.
15777 \begin_layout Subsection
15781 \begin_layout Standard
15782 We will only describe the features supported by \SpecialChar LyX
15783 (which is not much currently).
15784 Please consult the Memoir manual
15788 \begin_layout Plain Layout
15793 \begin_layout Plain Layout
15803 \begin_inset Flex URL
15806 \begin_layout Plain Layout
15808 CTAN:/macros/latex/memoir/memman.pdf
15821 \begin_layout Description
15822 Abstract: You may wonder why an abstract is an extra feature.
15823 Well, it is in book class.
15824 Usually books don't have abstracts.
15825 Memoir, however, has.
15826 You can use it wherever and how often you like.
15829 \begin_layout Description
15830 Chapterprecis: You may know this older typesetting style: The contents of
15831 a chapter are summarized below the title and also in the table of contents
15833 \begin_inset space \thinspace{}
15837 \begin_inset space \space{}
15842 Our hero arrives in Troia; he loses some friends; he finds others
15845 Chapterprecis does exactly this.
15846 It is therefore only sensible below a chapter.
15849 \begin_layout Description
15850 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15851 The epigraph environment provides an elegant way of typesetting such a
15853 The motto itself (text) and its author (source) are divided by a short
15855 Unfortunately, we have to fool \SpecialChar LyX
15856 a bit here again, since the environment
15857 needs two arguments (text and source).
15858 In this case, we have to use curly brackets (in \SpecialChar TeX
15859 mode) between the two
15870 <author of the slogan>.
15873 \begin_layout Description
15874 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15875 complex figurative poems).
15877 can only support a few of them.
15878 One is poemtitle, which is a centered title for poems, which will also
15879 be added to the table of contents (verse is the standard environment for
15881 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
15883 because they have to be nested inside regular verse environments, which
15884 is not possible with \SpecialChar LyX
15888 \begin_layout Description
15889 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15892 \begin_layout Section
15893 Article (mwart), book (mwbk) and report (mwrep)
15894 \begin_inset Argument status
15897 \begin_layout Plain Layout
15910 \begin_layout Standard
15916 \begin_layout Standard
15917 The \SpecialChar LyX
15934 correspond to the \SpecialChar LaTeX
15948 They are replacements for the standard document classes
15960 , resp., and fit better to Polish typography conventions in a number of points.
15964 \begin_layout Standard
15968 \begin_layout Itemize
15969 Unnumbered titles (with star, e.
15970 \begin_inset space \thinspace{}
15974 \begin_inset space \space{}
15981 ) are added into table of contents,
15984 \begin_layout Itemize
15985 Additional page styles:
15986 \begin_inset Separator parbreak
15993 \begin_layout Description
15994 uheadings header with separated lines,
15997 \begin_layout Description
15998 myheadings custom header, contents headers via commands:
16013 \begin_layout Description
16014 myuheadings custom header with separated lines,
16017 \begin_layout Description
16018 outer page number is placed on outer side of page
16022 \begin_layout Itemize
16024 \begin_inset Separator parbreak
16031 \begin_layout Description
16032 rmheadings serif titles — default,
16035 \begin_layout Description
16036 sfheadings sansserif titles,
16039 \begin_layout Description
16040 authortitle on title page first placed is author next title — default,
16043 \begin_layout Description
16044 titleauthor on title page first placed is title next author,
16047 \begin_layout Description
16048 withmarginpar reserve place on page for margins.
16052 \begin_layout Section
16056 \begin_layout Standard
16061 provides an alternative to the standard
16066 It provides similar functionality, but you might prefer this layout with
16067 sans serif sections, headings, and more.
16070 \begin_layout Section
16071 Rev\SpecialChar TeX
16075 \begin_layout Standard
16081 \begin_layout Standard
16082 \begin_inset VSpace bigskip
16088 \begin_layout Standard
16093 \begin_inset space ~
16098 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16100 \begin_inset Formula $\beta$
16103 release of May, 1999) class.
16106 \begin_layout Standard
16112 textclass, which works with Rev\SpecialChar TeX
16114 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16116 That means that it doesn't interact very well with \SpecialChar LyX
16117 , which requires \SpecialChar LaTeX2e
16119 it has been kludged to work.
16120 Since Rev\SpecialChar TeX
16121 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16126 Rev\SpecialChar TeX
16128 \begin_inset space ~
16133 textclass should also be pretty easy to use.
16136 \begin_layout Standard
16137 These documents are supposed to be used in
16141 to the Rev\SpecialChar TeX
16142 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16144 and assume you'll know what to put in the preamble if necessary.
16147 \begin_layout Subsection
16151 \begin_layout Standard
16152 All you need to do is install Rev\SpecialChar TeX
16153 4, as described in the package's README
16155 The package can be found at The Rev\SpecialChar TeX
16157 \begin_inset Flex URL
16160 \begin_layout Plain Layout
16162 http://publish.aps.org/revtex4/
16168 Install it somewhere that \SpecialChar LaTeX
16170 Test it by trying to \SpecialChar LaTeX
16171 a short Rev\SpecialChar TeX
16172 4 document in some random directory (i.
16173 \begin_inset space \thinspace{}
16177 \begin_inset space \space{}
16180 not the directory where you installed the class file.) Then, if you reconfigure
16182 , it will find the class file and let you use the Rev\SpecialChar TeX
16186 \begin_layout Standard
16187 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16196 \begin_inset space ~
16201 template, found in the templates directory.
16204 \begin_layout Subsection
16208 \begin_layout Standard
16209 Optional arguments to
16216 \begin_inset Quotes eld
16220 \begin_inset Quotes erd
16224 \begin_inset Quotes eld
16228 \begin_inset Quotes erd
16238 \begin_inset space ~
16246 \begin_inset space ~
16252 Remember that in Rev\SpecialChar TeX
16253 , at least one optional argument is required!
16256 \begin_layout Standard
16257 Other preamble matter, like
16264 \begin_inset space ~
16271 \begin_inset space ~
16276 dialog, also as usual.
16279 \begin_layout Subsection
16283 \begin_layout Standard
16284 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16286 For example, the Email layout corresponds to
16293 Note that (at least as of Rev\SpecialChar TeX
16302 layouts are exactly equivalent, so you shouldn't need to use both.
16306 \begin_layout Plain Layout
16307 In case you're curious, both were included so that
16311 would be able to translate both
16331 \begin_layout Subsection
16335 \begin_layout Standard
16336 There are a couple of important unique aspects of Rev\SpecialChar TeX
16337 4 which might cause
16338 bugs that will be even more confusing in \SpecialChar LyX
16342 \begin_layout Standard
16343 In Rev\SpecialChar TeX
16361 The \SpecialChar LyX
16362 equivalent is that there is a separate Thanks layout.
16367 write footnotes in the
16371 layout, or weird things may happen.
16372 See the Rev\SpecialChar TeX
16373 4 documentation for more details.
16376 \begin_layout Standard
16380 \begin_inset space ~
16388 \begin_inset space ~
16397 layouts must be placed
16405 layout and the corresponding
16422 , the \SpecialChar LaTeX
16426 \begin_layout Subsection
16430 \begin_layout Standard
16431 The main problem with this layout is that you can't use the optional arguments
16432 to layouts like Email and Title.
16433 (The problem is not unique to this layout; you can't use optional arguments
16434 to the Section layouts either.) This means that after you export that file
16435 to \SpecialChar LaTeX
16436 (which you'll need to do eventually to send it in to APS), you'll need
16437 to edit the \SpecialChar LaTeX
16438 file with a text editor to add the optional arguments to set,
16440 \begin_inset space \thinspace{}
16444 \begin_inset space \space{}
16447 the running title for the page headers.
16448 Lacking these layouts makes the
16454 (and the equivalent
16460 ) useless, so the corresponding layouts don't exist, and will have to be
16465 \begin_layout Plain Layout
16470 actually, \SpecialChar LyX
16471 1.3.0 supports some forms of optional arguments, but this layout
16472 has not been updated yet to take advantage of it.
16480 \begin_layout Section
16481 Springer Journals (
16488 \begin_layout Standard
16494 \begin_layout Subsection
16498 \begin_layout Standard
16499 These are the layout files for some of the journal formats used by Springer
16500 Verlag and listed on
16501 \begin_inset Flex URL
16504 \begin_layout Plain Layout
16506 http://www.springer.de/author/tex/help-journals.html
16511 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16513 It is a modular system: the things common to all journals are implemented
16518 , which journal-specific layout files (such as, e.
16519 \begin_inset space \thinspace{}
16523 \begin_inset space \space{}
16530 for Journal of Geodesy) can include.
16533 \begin_layout Standard
16534 This means that implementing support for any other Springer journal on this
16535 list is as simple as writing your own
16543 file following the outline given in
16551 \begin_layout Standard
16552 It is reasonably well tested only for the Journal of Geodesy.
16561 come with the standard \SpecialChar LyX
16563 Install the relevant class file (downloaded from Springer) in a proper
16564 directory, reconfigure \SpecialChar LaTeX
16565 (in the te\SpecialChar TeX
16570 , as root if necessary — doesn't \SpecialChar LyX
16571 take care of this?), reconfigure \SpecialChar LyX
16576 \begin_layout Subsection
16580 \begin_layout Standard
16581 A large number of theorem-like styles —
16593 \begin_layout Standard
16596 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16597 _Title, Author_Running, Institute,
16598 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16601 See the Springer class file documentation for details.
16604 \begin_layout Subsection
16608 \begin_layout Itemize
16620 \begin_layout Itemize
16623 Probability Theory and Related Fields
16629 — Jean-Marc Lasgouttes
16632 \begin_layout Standard
16633 Add your own, it isn't so hard!
16636 \begin_layout Subsection
16640 \begin_layout Standard
16641 These files are partly based on the older
16645 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16647 file from Springer.
16652 layout, are now defunct.
16653 Jean-Marc Lasgouttes helped out big in making me find my way around the
16655 layout file mechanism.
16658 \begin_layout Subsection
16662 \begin_layout Standard
16664 But probably less than in the old hacked-\SpecialChar LaTeX
16672 \begin_layout Standard
16674 \begin_inset space \thinspace{}
16677 g.: does not display the number for theorem-like layouts, just #.
16680 \begin_layout Section
16683 Sli\SpecialChar TeX
16687 \begin_inset CommandInset label
16696 \begin_layout Standard
16704 \begin_layout Subsection
16708 \begin_layout Standard
16709 This section describes how to use \SpecialChar LyX
16710 to make slides for overhead projectors.
16711 There are two document classes that can do this: the default slides class
16714 Foil\SpecialChar TeX
16718 This section documents the former.
16721 \begin_layout Standard
16722 I'm going to say this again, nice and clear, so that there's no misunderstanding
16726 \begin_layout Standard
16727 \begin_inset VSpace bigskip
16733 \begin_layout Standard
16737 This section documents the class
16738 \begin_inset Quotes eld
16746 \begin_inset Quotes erd
16754 \begin_layout Standard
16755 \begin_inset VSpace bigskip
16761 \begin_layout Standard
16762 If you're looking for the documentation for
16763 \begin_inset Quotes eld
16768 slides (Foil\SpecialChar TeX
16772 \begin_inset Quotes erd
16775 , check out section
16776 \begin_inset space ~
16780 \begin_inset CommandInset ref
16782 reference "sec:foiltex"
16792 \begin_inset Quotes eld
16797 slides (Foil\SpecialChar TeX
16801 \begin_inset Quotes erd
16804 ] is actually somewhat better than the default
16812 \begin_layout Plain Layout
16814 or so I've been told repeatedly by its advocates.
16815 Having never used it, I have no idea if this claim is true or not.
16820 which this section documents.
16823 \begin_layout Standard
16824 This class is the \SpecialChar LaTeX2e
16825 improvement of the old
16827 Sli\SpecialChar TeX
16831 Every \SpecialChar LaTeX2e
16832 distribution includes this class [which I'll just refer to as
16833 \begin_inset Quotes eld
16841 \begin_inset Quotes erd
16844 from now on], so you're bound to have it.
16845 As I noted earlier, there are other classes, such as
16849 , which also produce slides for overhead projectors and do a better job
16851 However, there are some things which
16855 can do which the others can't, such as generate overlays.
16856 Read on to learn more!
16859 \begin_layout Subsection
16861 \begin_inset CommandInset label
16863 name "sec:slidesetup"
16870 \begin_layout Standard
16871 Obviously, to use this document class, you need to select
16872 \begin_inset Quotes eld
16880 \begin_inset Quotes erd
16883 from the class list in the
16885 Document\SpecialChar menuseparator
16889 There are some other special things you should know about this class:
16892 \begin_layout Itemize
16893 Don't bother changing the options
16898 They're not supported by the
16905 \begin_layout Itemize
16909 \begin_inset space ~
16914 behaves a bit differently for this class.
16915 The possible choices and what they do are as follows:
16916 \begin_inset Separator parbreak
16923 \begin_layout Description
16928 The final output contains page numbers in the lower right corner.
16931 \begin_layout Description
16940 , but also prints out any time markers you've put in.
16941 This is the default.
16944 \begin_layout Description
16949 The final output contains no page numbers, time markers, or alignment markers.
16953 \begin_layout Itemize
16958 class has an extra option:
16964 \begin_inset Quotes eld
16972 \begin_inset Quotes erd
16975 in the extra class options.
16976 \begin_inset Separator parbreak
16983 \begin_layout Standard
16984 Using this options allows you to add time markers to
16990 \begin_inset space ~
16994 \begin_inset CommandInset ref
16996 reference "sec:slideNote"
17004 \begin_layout Standard
17005 You can also use the template file
17006 \begin_inset Quotes eld
17014 \begin_inset Quotes erd
17017 to automatically set up a document to use the
17023 File\SpecialChar menuseparator
17025 \begin_inset space ~
17029 \begin_inset space ~
17034 to open your new document].
17035 The template file also contains some examples of the special paragraph
17036 environments used by this class.
17037 I'll describe those next.
17040 \begin_layout Subsection
17041 Paragraph Environments
17044 \begin_layout Subsubsection
17045 Supported Environments
17048 \begin_layout Standard
17049 The first thing you'll notice when you start up a new
17053 document is the font size and type: it's the equivalent of the size
17054 \begin_inset Quotes eld
17062 \begin_inset Quotes erd
17068 \begin_inset space ~
17074 This is also what's used in the output.
17076 \begin_inset Quotes eld
17080 \begin_inset Quotes erd
17083 to remind you that this is a slide.
17084 Your final slides will use a larger font; ergo, you'll have less space.
17085 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17088 \begin_layout Standard
17089 The next thing that becomes obvious is the changes to the paragraph environment
17090 pull-down box [at the far-left end of the toolbar].
17091 Most of the paragraph environments you're used to seeing are missing.
17092 There are also five new ones.
17097 class itself only supports certain paragraph environments:
17100 \begin_layout Itemize
17106 \begin_layout Itemize
17112 \begin_layout Itemize
17118 \begin_layout Itemize
17124 \begin_layout Itemize
17130 \begin_layout Itemize
17136 \begin_layout Itemize
17142 \begin_layout Itemize
17148 \begin_layout Itemize
17154 \begin_layout Itemize
17161 \begin_layout Itemize
17167 \begin_layout Standard
17168 All of the other standard environments, including the section-heading environmen
17169 ts, aren't used in the
17176 \begin_layout Standard
17177 On the other hand, you'll notice the following new environments:
17180 \begin_layout Itemize
17186 \begin_layout Itemize
17192 \begin_layout Itemize
17198 \begin_layout Itemize
17204 \begin_layout Itemize
17210 \begin_layout Standard
17211 These five are kind of quirky, due to a
17212 \begin_inset Quotes eld
17216 \begin_inset Quotes erd
17219 in \SpecialChar LyX
17221 You see, \SpecialChar LyX
17222 doesn't permit you to nest any other paragraph environment into
17223 an empty environment.
17224 Now, that's fine and dandy, but it means that you wouldn't be able to start
17225 a slide with anything except plain text.
17226 To deal with this, I've performed a little
17227 \begin_inset Quotes eld
17232 \begin_inset Quotes erd
17238 \begin_layout Subsubsection
17239 Quirks of the New Environments
17240 \begin_inset CommandInset label
17242 name "sec:slideQuirk"
17249 \begin_layout Standard
17250 All five of the new paragraph environments are somewhat quirky due to inherent
17251 limitiations in the current version of \SpecialChar LyX
17253 As I just mentioned, \SpecialChar LyX
17254 forbids environments that begin with another environment.
17255 To get around this, the
17259 environment isn't a paragraph environment as described in the
17267 \begin_layout Standard
17268 You should consider
17281 \begin_inset Quotes eld
17284 pseudo-environments.
17285 \begin_inset Quotes erd
17288 They look like a section heading or a
17289 \begin_inset Quotes eld
17297 \begin_inset Quotes erd
17300 but really begin a [and, if necessary, end the previous] paragraph environment.
17310 \begin_inset Quotes eld
17314 \begin_inset Quotes erd
17317 These two perform some action.
17320 \begin_layout Standard
17321 A common feature of all five environments,
17341 , is a rather long-ish label.
17342 The text following this label — ordinarily the contents of the paragraph
17343 environment — is utterly irrelevant for
17365 completely ignores it.
17366 In fact, you can leave these five environments completely empty.
17370 \begin_layout Standard
17375 to put any text after the rather long-ish label, you might want to.
17376 This could be a short description of the contents of the
17381 In that case, enter your descriptive comment and hit
17385 as you normally would.
17388 \begin_layout Standard
17389 If, on the other hand, you don't want to enter any descriptive text, you'll
17390 hit another \SpecialChar LyX
17393 , like nature, abhors a vacuum, and will not let you start a new paragraph
17394 environment until you put something in the old one.
17398 \begin_layout Itemize
17399 Start entering the text that will
17427 \begin_layout Itemize
17428 Now move to the beginning of that paragraph.
17432 \begin_layout Itemize
17441 \begin_layout Itemize
17442 Finally, change this new, empty paragraph to a
17466 \begin_layout Standard
17467 Some future version of \SpecialChar LyX
17468 will, hopefully, resolve this quirkiness\SpecialChar ldots
17472 \begin_layout Subsection
17473 Making a Presentation with
17486 \begin_layout Subsubsection
17494 \begin_layout Standard
17495 If you're expecting this section to teach you how to actually make a presentatio
17496 n, you'll be sorely disappointed.
17497 Naturally, I'll describe all of the ways the
17501 class can assist you in preparing the materials for a presentation.
17502 Filling in the contents, however, is up to you.
17507 the \SpecialChar LyX
17511 \begin_layout Standard
17516 environment [in the manner described in section
17517 \begin_inset space ~
17521 \begin_inset CommandInset ref
17523 reference "sec:slideQuirk"
17527 ] tells \SpecialChar LyX
17528 to begin a new slide [duh].
17529 The label for this environment/
17530 \begin_inset Quotes erd
17534 \begin_inset Quotes erd
17538 \begin_inset Quotes eld
17542 \begin_inset Quotes erd
17545 in cool blue, followed by the label,
17546 \begin_inset Quotes eld
17550 \begin_inset Quotes erd
17554 Any text or paragraph environments that follow this one go on the new slide.
17558 \begin_layout Standard
17559 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17561 (this can be specified in the
17566 In fact, you'll want to, once you finish entering the contents of one slide.
17567 If you've entered more text than can physically fit on a slide, the extra
17568 overflows onto a new slide.
17569 I don't recommend doing this, however, since the overflow slide won't have
17570 any page number on it.
17571 Furthermore, it may interfere with any
17575 you've made to accompany the oversized
17582 \begin_layout Standard
17591 environments work the same way as the
17596 They both create an
17597 \begin_inset Quotes eld
17601 \begin_inset Quotes erd
17604 followed by a label [
17605 \begin_inset Quotes eld
17609 \begin_inset Quotes erd
17613 \begin_inset Quotes eld
17617 \begin_inset Quotes erd
17621 The color is a stunning magenta instead of blue, and the
17622 \begin_inset Quotes eld
17626 \begin_inset Quotes erd
17629 will look different, in style and in length.
17630 The label fonts of all three also differ from one another.
17633 \begin_layout Standard
17638 , if the contents of a
17646 exceed the physical size of a slide or sheet of paper, the extra will overflow
17648 Again, you should avoid this.
17649 It defeats the whole purpose of
17660 \begin_layout Subsubsection
17670 \begin_layout Standard
17675 is a slide that sits atop another slide.
17676 Perhaps you wish to discuss a figure on the main
17680 before displaying the text associated with it.
17681 One way to accomplish this is tape a flap of dark paper over the part of
17686 you want to display later.
17687 This method fails, however, if you wish to overlap one graph with another,
17689 You would then have to fumble while speaking to align the two separate,
17694 s to align the two graphs.
17699 environment in both cases makes life much easier.
17702 \begin_layout Standard
17707 receives the page number of its
17708 \begin_inset Quotes eld
17712 \begin_inset Quotes erd
17720 \begin_inset Quotes eld
17728 \begin_inset Quotes erd
17735 \begin_layout Plain Layout
17736 Presumably, mutliple
17741 \begin_inset Quotes eld
17749 \begin_inset Quotes erd
17753 \begin_inset Quotes eld
17761 \begin_inset Quotes erd
17765 \begin_inset Quotes eld
17773 \begin_inset Quotes erd
17777 \begin_inset space ~
17780 appended to the page number of the parent
17790 Clearly, you want the contents of both the
17798 to each fit on a single physical slide! You should probably consider an
17804 \begin_inset Quotes eld
17808 \begin_inset Quotes erd
17816 Indeed, the \SpecialChar LyX
17821 class provides a visual cue for this: the label at the start of an
17825 is shorter than that at the start of a
17830 Lastly, when you generate printable output, you'll find alignment markers
17831 in all four corners of both the
17835 page and its parent
17840 These will assist you in lining up the two physical slides.
17843 \begin_layout Standard
17844 The major problem in overlaying two slides is aligning the contents of the
17845 two transparencies.
17846 How much space should you leave for that graph on the second slide? Worse
17847 still, what if you want a graph and a sentence on second slide, but there
17848 is text on the main transparency that goes in between them? You could try
17849 and insert vertical space of the right size.
17850 The better way is to use
17861 \begin_layout Standard
17862 As their names imply,
17870 are two command-like paragraph environments that make all subsequent text
17871 invisible and visible, respectively.
17873 \begin_inset space ~
17877 \begin_inset CommandInset ref
17879 reference "sec:slideQuirk"
17883 that you don't place anything
17887 these two environments, however.
17892 , it inserts a centered, sky-blue label into the page reading
17893 \begin_inset Quotes eld
17896 <Invisible Text Follows>
17897 \begin_inset Quotes erd
17901 For paragraphs following this label, the parts of the
17909 ; it doesn't matter which] where they would be contain instead blank space.
17913 \begin_layout Standard
17918 , the corresponding centered label is
17919 \begin_inset Quotes eld
17922 <Visible Text Follows>
17923 \begin_inset Quotes erd
17927 Paragraphs following this label behave normally.
17928 Note that the beginning of a new
17940 automatically shuts off an
17945 It's therefore not necessary to use
17956 \begin_layout Standard
17957 By now, it should be obvious how to create overlay transparencies using
17958 the proper combination of
17977 \begin_layout Enumerate
17982 , including everything that will appear on it, whether on the main slide
17990 \begin_layout Enumerate
17991 Before each figure or paragraph that will appear only on the
18000 If necessary, insert a
18004 environment after the
18011 \begin_layout Enumerate
18016 immediately following the
18023 \begin_layout Enumerate
18024 Copy the contents of this
18035 \begin_layout Enumerate
18040 , change all of the
18051 \begin_layout Standard
18053 You've just made an
18060 \begin_layout Standard
18061 There's one problem with the way I've designed the \SpecialChar LyX
18066 class: you can't make text in the middle of a paragraph invisible, nor
18067 make text in the middle of an invisible paragraph visible again.
18068 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18073 \begin_layout Plain Layout
18074 The commands of interest are:
18077 \begin_layout Itemize
18082 invisible \SpecialChar ldots
18086 \begin_layout Itemize
18091 visible \SpecialChar ldots
18095 \begin_layout Plain Layout
18097 and need to be marked as \SpecialChar TeX
18100 \begin_inset Quotes eld
18104 \begin_inset Quotes erd
18107 you wish to change goes in between the brackets [and after the
18120 If you don't know how to mark text as \SpecialChar TeX
18121 , see the appropriate section of
18134 \begin_layout Subsubsection
18144 \begin_inset CommandInset label
18146 name "sec:slideNote"
18153 \begin_layout Standard
18162 is associated with a
18163 \begin_inset Quotes eld
18167 \begin_inset Quotes erd
18175 Here, too, the \SpecialChar LyX
18180 class provides visual cues.
18185 is shorter than that of a
18189 [yet longer than that of an
18193 ] and, like the label of an
18197 is shockingly magenta.
18198 Additionally, the printed
18202 has the page number of its
18203 \begin_inset Quotes eld
18207 \begin_inset Quotes erd
18215 \begin_inset Quotes eld
18223 \begin_inset Quotes erd
18227 \begin_inset Quotes eld
18235 \begin_inset Quotes erd
18239 \begin_inset Quotes eld
18247 \begin_inset Quotes erd
18251 You can have multiple
18255 s associated with a single
18267 , you'll probably want to break up long
18271 s so that they fit on a single sheet of paper.
18274 \begin_layout Standard
18279 is obvious: it contains anything additional you might want to say about
18285 It could also be used as a sheet of reminders for a particular
18290 In the case of the latter, you might want to make use of time markers.
18291 Currently, the \SpecialChar LyX
18297 \begin_inset Quotes eld
18301 \begin_inset Quotes erd
18304 support for time markers, a
18306 Sli\SpecialChar TeX
18310 So, you'll have to resort to using the \SpecialChar LaTeX
18314 \begin_layout Standard
18315 To use time markers, you'll need to specify the extra class option
18316 \begin_inset Quotes eld
18324 \begin_inset Quotes erd
18328 \begin_inset space ~
18332 \begin_inset CommandInset ref
18334 reference "sec:slidesetup"
18339 This option turns on timing marks, which will appear in the lower-left-hand
18345 To set what appears in the time marker, you use the \SpecialChar LaTeX
18347 \begin_inset Quotes eld
18357 \begin_inset Quotes erd
18361 \begin_inset Quotes eld
18371 \begin_inset Quotes erd
18375 The arguments of both commands are time measured in seconds.
18377 \begin_inset Quotes eld
18387 \begin_inset Quotes erd
18390 sets the time marker to a given time.
18392 \begin_inset Quotes eld
18402 \begin_inset Quotes erd
18405 increments the time marker by the specified amount.
18406 Using time markers and
18410 s in this fashion, you can remind yourself how much time to spend on a particula
18418 \begin_layout Standard
18419 There's one last feature to describe.
18420 Clearly, you'd like to print out all of your
18428 s on transparencies while printing all of your
18445 with which it is associated.
18446 What's a person to do?
18449 \begin_layout Standard
18450 Luckily, there are two \SpecialChar LaTeX
18451 commands that allow you to select what to print
18453 Both must be placed into the preamble of your document.
18455 \begin_inset Quotes eld
18467 \begin_inset Quotes erd
18470 will cause the output to contain only the
18479 Correspondingly, the command
18480 \begin_inset Quotes eld
18492 \begin_inset Quotes erd
18495 prevents the output of anything but
18500 I'd advise placing both commands in the preamble and initially comment
18502 You can then preview your entire presentation as you write.
18503 When you're done writing, you can then uncomment one of the two to select
18504 what you want to print.
18505 I like to uncomment
18506 \begin_inset Quotes eld
18518 \begin_inset Quotes erd
18521 , print to a file with
18522 \begin_inset Quotes eld
18530 \begin_inset Quotes erd
18533 in its name, comment it back out, then uncomment
18534 \begin_inset Quotes eld
18546 \begin_inset Quotes erd
18550 \begin_inset Quotes eld
18558 \begin_inset Quotes erd
18562 I can then send either file to a printer, loading transparencies or plain
18563 paper as appropriate.
18566 \begin_layout Standard
18567 You can also provide other arguments to the
18568 \begin_inset Quotes eld
18578 \begin_inset Quotes erd
18582 \begin_inset Quotes eld
18592 \begin_inset Quotes erd
18596 See a good \SpecialChar LaTeX
18600 \begin_layout Subsection
18605 Class Template File
18608 \begin_layout Standard
18609 I have also provided a template file,
18610 \begin_inset Quotes eld
18618 \begin_inset Quotes erd
18626 To use it, begin your new presentation with
18631 ile\SpecialChar menuseparator
18633 \begin_inset space ~
18637 \begin_inset space ~
18647 Your new \SpecialChar LyX
18648 presentation file will contain an example
18669 additionally contain an example of the use of
18678 Lastly, the preamble will contain:
18681 \begin_layout LyX-Code
18682 % Uncomment to print out only slides and overlays
18685 \begin_layout LyX-Code
18689 \begin_layout LyX-Code
18695 \begin_inset Newline newline
18701 \begin_layout LyX-Code
18702 % Uncomment to print out only notes
18705 \begin_layout LyX-Code
18709 \begin_layout LyX-Code
18717 \begin_layout Standard
18718 One final thing: I created this class to support the \SpecialChar LaTeX2e
18720 \begin_inset Quotes eld
18725 Sli\SpecialChar TeX
18729 \begin_inset Quotes erd
18732 class, one of the built-in \SpecialChar LaTeX2e
18734 Neither I nor the rest of the \SpecialChar LyX
18735 Team endorse or oppose the use of this built-in
18737 It's here if you want it or need it.
18738 There exist other \SpecialChar LaTeX2e
18739 classes for creating presentations, such as the
18744 \begin_inset space ~
18748 \begin_inset CommandInset ref
18750 reference "sec:foiltex"
18755 \begin_inset Quotes eld
18763 \begin_inset Quotes erd
18766 package [present on some \SpecialChar TeX
18768 The latter is not yet supported under \SpecialChar LyX
18773 \begin_layout Plain Layout
18774 Perhaps you can take on the task\SpecialChar ldots
18780 I know nothing about these other classes.
18781 Try them out to see what sort of alternative they provide.
18784 \begin_layout Chapter
18786 Features needing Extra Software
18789 \begin_layout Section
18790 Checking \SpecialChar TeX
18794 \begin_layout Standard
18800 \begin_layout Subsection
18804 \begin_layout Standard
18813 \begin_layout Plain Layout
18818 is not yet available when you are using the \SpecialChar LaTeX
18819 distribution MiK\SpecialChar TeX
18825 , you'll find in the
18832 \begin_inset space ~
18836 \change_deleted -712698321 1437633476
18839 \change_inserted -712698321 1437633477
18850 \begin_inset Newline newline
18854 \begin_inset CommandInset href
18856 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18863 \begin_layout Standard
18866 Chk\SpecialChar TeX
18869 package is a program that was written by
18870 \begin_inset Flex Noun
18873 \begin_layout Plain Layout
18875 \begin_inset space ~
18883 in frustration because some constructs in \SpecialChar LaTeX
18884 are sometimes non-intuitive,
18885 and easy to forget.
18886 The program runs over your \SpecialChar LaTeX
18887 file, checks the integrity of the file, and
18888 flags some common errors.
18889 In other technical words, it is
18893 for \SpecialChar LaTeX
18897 \begin_layout Standard
18898 Well, what is a syntax checker doing in \SpecialChar LyX
18899 which is supposed to produce correct
18901 anyways? The answer is simple: Just as
18905 not only checks the
18909 of C programs, but also does
18913 checks for type-errors,
18915 Chk\SpecialChar TeX
18918 catches some common
18922 errors, in addition to the syntactical ones.
18925 Chk\SpecialChar TeX
18928 is capable of detecting several common errors, such as
18931 \begin_layout Itemize
18932 Ellipsis detection:
18933 \begin_inset Newline newline
18936 Use \SpecialChar ldots
18940 \begin_layout Itemize
18941 No space in front of/after parenthesis:
18942 \begin_inset Newline newline
18948 \begin_layout Itemize
18949 Enforcement of normal space after common abbreviations:
18950 \begin_inset Newline newline
18954 \begin_inset space \thinspace{}
18958 \begin_inset space \space{}
18961 is too wide spacing.
18964 \begin_layout Itemize
18965 Enforcement of end-of-sentence space when the last sentence ends with a
18967 \begin_inset Newline newline
18971 And this is wrong spacing.
18974 \begin_layout Itemize
18975 Space in front of labels and similar commands:
18976 \begin_inset Newline newline
18979 The label should stick right up to the text to avoid falling to a wrong
18982 \begin_inset CommandInset label
18992 \begin_layout Plain Layout
18993 This footnote is in danger of falling off to a wrong page
18998 The label is separated too much.
19001 \begin_layout Itemize
19002 Space in front of references, instead of hard spaces:
19003 \begin_inset Newline newline
19006 If you have bad luck, the text will break right between the referenced text
19007 and reference number, and that's a pity.
19009 \begin_inset CommandInset ref
19011 reference "sec:chktex"
19018 \begin_layout Itemize
19020 \begin_inset Quotes eld
19024 \begin_inset Quotes erd
19028 \begin_inset Formula $\times$
19032 \begin_inset Newline newline
19035 2x2 looks cheap compared to
19036 \begin_inset Formula $2\times2$
19042 \begin_layout Standard
19043 and more \SpecialChar ldots
19044 It is an invaluable tool when you are
19045 \begin_inset Quotes eld
19049 \begin_inset Quotes erd
19052 your document before printing, and you should run it right after the obligatory
19053 spelling check, and before you go fine tuning the typesetting.
19056 \begin_layout Subsection
19060 \begin_layout Standard
19061 If you have the program installed, usage is as simple as choosing
19063 Tools\SpecialChar menuseparator
19065 \begin_inset space ~
19069 \change_deleted -712698321 1437633488
19072 \change_inserted -712698321 1437633488
19078 This will make \SpecialChar LyX
19079 generate a \SpecialChar LaTeX
19080 file of your document, start
19082 Chk\SpecialChar TeX
19085 to check it, and then make \SpecialChar LyX
19087 \begin_inset Quotes eld
19091 \begin_inset Quotes erd
19094 with the warnings from
19096 Chk\SpecialChar TeX
19099 , if there were any.
19100 The warnings will be placed close to the point of the mistake, and you
19101 can quickly find them by using the
19103 Navigate\SpecialChar menuseparator
19106 menu item, or the shortcut key
19115 Open the error boxes by clicking on them with the mouse, or use the shortcut
19124 bindings, or the corresponding
19133 Read the warning and correct the mistake, if it is a mistake.
19134 If you have trouble understanding what the warning is about, you can safely
19136 Remember that there is a hidden layer between the document on screen and
19137 the technical details in invoking
19139 Chk\SpecialChar TeX
19142 , and this gap can make some warnings seem arcane or just plain silly.
19145 \begin_layout Standard
19146 This document is an excellent testing bed for the feature, and it should
19147 provide quite a few warnings for you to fiddle with.
19148 Since computers are only so smart, expect most of the warnings to be false
19152 \begin_layout Subsection
19153 How to fine tune it
19156 \begin_layout Standard
19157 Sometimes, you'll find that
19159 Chk\SpecialChar TeX
19162 makes more noise than suits your mood.
19163 Then you can choose not to use it, wait until your mood changes, or try
19166 Chk\SpecialChar TeX
19169 to get better along with you.
19172 \begin_layout Standard
19175 Chk\SpecialChar TeX
19182 very configurable and extensible, you should not expect to solve all problems
19185 Chk\SpecialChar TeX
19188 in \SpecialChar LyX
19190 Since \SpecialChar LyX
19191 has to generate a somewhat special \SpecialChar LaTeX
19192 file to be able to match the
19193 line numbers from the
19195 Chk\SpecialChar TeX
19202 \begin_layout Plain Layout
19203 You can inspect the specific output from
19209 Document\SpecialChar menuseparator
19212 \begin_inset space ~
19226 to the internal document structure, some of the warnings will not appear
19228 There are two things you can do about this:
19231 \begin_layout Itemize
19234 Chk\SpecialChar TeX
19237 invocation command line in
19238 \begin_inset Flex MenuItem
19241 \begin_layout Plain Layout
19242 Tools\SpecialChar menuseparator
19243 Preferences\SpecialChar menuseparator
19244 Output\SpecialChar menuseparator
19246 \change_deleted -712698321 1437633504
19249 \change_inserted -712698321 1437633507
19252 \SpecialChar menuseparator
19254 \change_deleted -712698321 1437633509
19257 \change_inserted -712698321 1437633511
19267 Chk\SpecialChar TeX
19270 installation configuration file (usually with the file
19275 See below to learn what warnings can be enabled and disabled on the command
19279 \begin_layout Itemize
19280 Export your document as a raw \SpecialChar LaTeX
19283 File\SpecialChar menuseparator
19284 Export\SpecialChar menuseparator
19293 Invoked in this way, it can be a hassle to find the corresponding place
19294 in the document inside \SpecialChar LyX
19295 , but with a little patience, you should be able
19299 \begin_layout Standard
19300 Here follows the warning messages that can be enabled and disabled in
19309 to disable a warning, and
19313 to enable a warning.
19314 The emphasized entries are disabled by default, because the default is
19317 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19322 \begin_layout Standard
19323 Notice that you should only use the options that enable and disable warnings,
19324 because \SpecialChar LyX
19325 relies on some of the other command line parameters to be set
19326 in a specific way to have a chance to communicate with
19333 \begin_layout Enumerate
19337 Command terminated with space.
19340 \begin_layout Enumerate
19343 Non-breaking space (
19344 \begin_inset Quotes eld
19352 \begin_inset Quotes erd
19355 ) should have been used.
19358 \begin_layout Enumerate
19362 You should enclose the previous parenthesis with
19363 \begin_inset Quotes eld
19371 \begin_inset Quotes erd
19377 \begin_layout Enumerate
19380 Italic correction (
19381 \begin_inset Quotes eld
19391 \begin_inset Quotes erd
19394 ) found in non-italic buffer.
19397 \begin_layout Enumerate
19400 Italic correction (
19401 \begin_inset Quotes eld
19411 \begin_inset Quotes erd
19414 ) found more than once.
19417 \begin_layout Enumerate
19421 No italic correction (
19422 \begin_inset Quotes eld
19432 \begin_inset Quotes erd
19438 \begin_layout Enumerate
19442 \begin_inset Quotes eld
19450 \begin_inset Quotes erd
19454 \begin_inset Quotes eld
19462 \begin_inset Quotes erd
19468 \begin_layout Enumerate
19471 Wrong length of dash may have been used.
19474 \begin_layout Enumerate
19478 \begin_inset Quotes eld
19486 \begin_inset Quotes erd
19490 \begin_inset Quotes eld
19498 \begin_inset Quotes erd
19504 \begin_layout Enumerate
19508 \begin_inset Quotes eld
19516 \begin_inset Quotes erd
19522 \begin_layout Enumerate
19526 \begin_inset Quotes eld
19534 \begin_inset Quotes erd
19537 to achieve an ellipsis.
19540 \begin_layout Enumerate
19543 Inter-word spacing (
19544 \begin_inset Quotes eld
19554 \begin_inset Quotes eld
19557 ) should perhaps be used.
19560 \begin_layout Enumerate
19563 Inter-sentence spacing (
19564 \begin_inset Quotes eld
19574 \begin_inset Quotes erd
19577 ) should perhaps be used.
19580 \begin_layout Enumerate
19583 Could not find argument for command.
19586 \begin_layout Enumerate
19590 \begin_inset Quotes eld
19598 \begin_inset Quotes erd
19604 \begin_layout Enumerate
19607 Math mode still on at end of \SpecialChar LaTeX
19611 \begin_layout Enumerate
19615 \begin_inset Quotes eld
19623 \begin_inset Quotes erd
19626 doesn't match the number of
19627 \begin_inset Quotes eld
19635 \begin_inset Quotes erd
19641 \begin_layout Enumerate
19644 You should use either
19647 \begin_inset Quotes eld
19655 \begin_inset Quotes erd
19660 as an alternative to
19661 \begin_inset Quotes eld
19669 \begin_inset Quotes erd
19675 \begin_layout Enumerate
19682 " (ASCII 39) instead of "
19689 \begin_layout Enumerate
19692 User-specified pattern found.
19695 \begin_layout Enumerate
19698 This command might not be intended.
19701 \begin_layout Enumerate
19708 \begin_layout Enumerate
19726 \begin_layout Enumerate
19729 Delete this space to maintain correct page references.
19732 \begin_layout Enumerate
19736 You might wish to put this between a pair of
19737 \begin_inset Quotes eld
19745 \begin_inset Quotes erd
19751 \begin_layout Enumerate
19754 You ought to remove spaces in front of punctuation.
19757 \begin_layout Enumerate
19760 Could not execute \SpecialChar LaTeX
19764 \begin_layout Enumerate
19773 in front of small punctuation.
19776 \begin_layout Enumerate
19784 may look prettier here.
19787 \begin_layout Enumerate
19791 Multiple spaces detected in output.
19794 \begin_layout Enumerate
19797 This text may be ignored.
19800 \begin_layout Enumerate
19806 \begin_inset Quotes eld
19811 to begin quotation, not
19818 \begin_layout Enumerate
19825 to end quotation, not
19828 \begin_inset Quotes eld
19836 \begin_layout Enumerate
19842 \begin_layout Enumerate
19845 You should perhaps use
19846 \begin_inset Quotes eld
19854 \begin_inset Quotes erd
19860 \begin_layout Enumerate
19863 You should put a space in front of/after parenthesis.
19866 \begin_layout Enumerate
19869 You should avoid spaces in front of/after parenthesis.
19872 \begin_layout Enumerate
19876 You should not use punctuation in front of/after quotes.
19879 \begin_layout Enumerate
19882 Double space found.
19885 \begin_layout Enumerate
19888 You should put punctuation outside inner/inside display math mode.
19891 \begin_layout Enumerate
19894 You ought to not use primitive \SpecialChar TeX
19895 in \SpecialChar LaTeX
19899 \begin_layout Enumerate
19902 You should remove spaces in front of
19903 \begin_inset Quotes eld
19911 \begin_inset Quotes erd
19917 \begin_layout Enumerate
19920 \begin_inset Quotes eld
19928 \begin_inset Quotes erd
19931 is normally not followed by
19932 \begin_inset Quotes eld
19940 \begin_inset Quotes erd
19946 \begin_layout Standard
19947 In later versions of \SpecialChar LyX
19948 , we hope to provide a more complete interface to this
19949 tool (and it's smaller cousin
19953 ) to exploit the full power of it.
19954 But it's not exactly useless as it is now: go try it on one of your existing
19955 documents of a certain length and be surprised.
19958 \begin_layout Section
19959 Version Control in \SpecialChar LyX
19963 \begin_layout Standard
19966 Lars Gullik Bjønnes
19973 \begin_layout Subsection
19977 \begin_layout Standard
19979 supports some of the most basic RCS/CVS/SVN/GIT commands.
19980 If you need something a bit more sophisticated you will have to do that
19981 manually in a terminal.
19984 \begin_layout Standard
19985 Also note that CVS support is not as good as subversion support so we advise
19987 A good place to start learning Subversion is SVN Book
19991 \begin_layout Plain Layout
19992 \begin_inset CommandInset href
19994 target "http://svnbook.red-bean.com/"
20004 In the case of RCS you should read
20005 \begin_inset Quotes eld
20009 \begin_inset Quotes erd
20012 (a man file, read it with
20017 This file describes all the basic features of RCS.
20018 You should especially notice the comment about a RCS directory, and the
20019 notion of a master RCS file (the file ending in
20026 \begin_layout Standard
20027 Before you begin to use the version control features in \SpecialChar LyX
20029 familiar with RCS/CVS/SVN/GIT usage.
20030 The implementation in \SpecialChar LyX
20031 assumes a recent version of the GNU RCS or CVS/SVN
20032 package — no guarantees are made for older versions.
20033 Most of the log messages are not currently displayed after operations —
20034 you can check them in the Messages pane if unsure.
20035 Regular users of version control will appreciate VC toolbar, which can
20038 View\SpecialChar menuseparator
20039 Toolbars\SpecialChar menuseparator
20041 \begin_inset space ~
20049 \begin_layout Standard
20050 For introducing your own external commands consult vc-command in the manual
20051 of \SpecialChar LyX
20053 \change_inserted -195340706 1447278952
20057 \begin_layout Standard
20059 \change_inserted -195340706 1447279250
20060 It is strongly recommended to store documents in uncompressed format if
20061 using version control (uncheck
20063 Document\SpecialChar menuseparator
20066 if it is checked): Uncompressed LyX documents are text files and therefore
20067 for merging two different versions by version control systems.
20068 Compressed LyX documents are binary files, which cannot be merged by version
20074 \begin_layout Subsection
20075 RCS commands in \SpecialChar LyX
20079 \begin_layout Standard
20080 The following sections describe the RCS commands supported by \SpecialChar LyX
20082 You can find them in the
20084 File\SpecialChar menuseparator
20086 \begin_inset space ~
20093 was tested against RCS 5.7/5.8
20097 \begin_layout Plain Layout
20098 Note that old DOS / MS Windows builds (5.7) need to setup environment variables
20099 in order to work properly with \SpecialChar LyX
20101 In particular time zone (TZ) should be set and more importantly RCSINIT
20102 in order to change default archive location ("SET RCSINIT=-x,v/") — \SpecialChar LyX
20104 archive to be found in file.lyx,v within the original document directory.
20105 See also README shipped with Windows RCS binaries.
20113 \begin_layout Subsubsection
20119 \begin_layout Standard
20120 If your document is not under revision control, this is the only item shown
20122 And if it is under revision control, the
20126 item is not visible.
20130 \begin_layout Standard
20131 This command registers your document with RCS (unless you are under the
20132 directory managed by CVS)\SpecialChar endofsentence
20133 You are asked interactively to supply an initial
20134 description of the document.
20135 The document is now set in Read-Only mode and you have to
20138 \begin_inset space ~
20142 \begin_inset space ~
20146 \begin_inset space ~
20151 , before making any changes to it.
20152 A document under revision control has a
20153 \begin_inset Quotes eld
20156 [RCS:<version> <locker>]
20157 \begin_inset Quotes erd
20160 item tagged to the filename in the minibuffer.
20163 \begin_layout Standard
20164 RCS command that is run:
20166 ci -q -u -i -t-"<initial description>" <file-name>
20169 \begin_layout Standard
20174 to understand the switches.
20178 \begin_layout Subsubsection
20184 \begin_layout Standard
20185 When you are finished editing a file, you check in your changes.
20186 When you do this, you are asked for a description of the changes.
20187 This is stored in the history log.
20188 The version number is bumped, your changes are applied to the master RCS
20189 file, the document is unlocked and set to Read-Only mode.
20192 \begin_layout Standard
20195 ci -q -u -m"<description>" <file-name>
20198 \begin_layout Subsubsection
20204 \begin_layout Standard
20205 By doing this you lock the document so that only you can edit it.
20206 This will also make the document Read-Write only for you.
20207 You will usually continue editing for a while and when you are finished
20208 you check in your changes.
20209 The status line is changed to reflect that you have locked the file.
20212 \begin_layout Standard
20215 co -q -l <file-name>
20218 \begin_layout Subsubsection
20221 Revert To Repository Version
20224 \begin_layout Standard
20225 This will discard all changes made to the document since the last check
20227 You get a warning before changes are discarded.
20230 \begin_layout Standard
20233 co -f -u<version> <file-name>
20236 \begin_layout Subsubsection
20242 \begin_layout Standard
20243 This will create a copy of the current document.
20244 Since RCS does not support copy operations natively, the version history
20245 is not preserved, and the copy is added as a new file.
20246 It requires a clean document without any changes since the last checkin.
20247 You are asked for a file name and a description of the copy operation.
20248 After that the copy is created, both locally and in the repository.
20249 If the parent directories of the copied and original document differ, all
20250 relative paths of included files of the copy are adjusted (like in
20252 File\SpecialChar menuseparator
20257 Finally, the copy is loaded instead of the original document.
20260 \begin_layout Labeling
20261 \labelwidthstring 00.00.0000
20263 \begin_inset space ~
20267 \begin_inset space ~
20271 \begin_inset Newline newline
20275 \begin_inset Flex Code
20278 \begin_layout Plain Layout
20281 \begin_inset Quotes eld
20285 \begin_inset Quotes erd
20294 \begin_inset Flex Code
20297 \begin_layout Plain Layout
20300 \begin_inset Quotes eld
20304 \begin_inset Quotes erd
20313 \begin_inset Newline newline
20317 \begin_inset Flex Code
20320 \begin_layout Plain Layout
20324 \begin_inset Quotes eld
20328 \begin_inset Quotes erd
20339 \begin_layout Subsubsection
20345 \begin_layout Standard
20346 This makes as if the last check in never happened.
20347 No changes are made to the document loaded into \SpecialChar LyX
20348 , but the last version
20349 is removed from the master RCS file.
20352 \begin_layout Standard
20355 rcs -o<version> <file-name>
20358 \begin_layout Subsubsection
20364 \begin_layout Standard
20365 This shows the complete history of the RCS document.
20370 is shown in a browser.
20378 \begin_layout Subsubsection
20382 \begin_layout Standard
20384 supports RCS version number, author name, date and time of last commit.
20385 All those are extracted from
20387 rlog -r <file-name>
20391 \begin_inset CommandInset ref
20393 reference "subsec:VCS-Revision-Information"
20400 \begin_layout Subsection
20401 CVS commands in \SpecialChar LyX
20405 \begin_layout Standard
20406 A subset of CVS operations is supported by \SpecialChar LyX
20408 You can find the commands in the
20410 File\SpecialChar menuseparator
20412 \begin_inset space ~
20418 The version control system SVN is more powerful, so please use it instead
20419 of CVS if possible.
20422 \begin_layout Subsubsection
20428 \begin_layout Standard
20429 If you start from scratch with CVS you have to create your repository and
20430 checkout the working copy with external tools.
20431 If you're using a client-server setup you may need to login before doing
20432 the first repository checkout.
20435 \begin_layout Standard
20436 If your documents are under revision control and others are using the same
20437 repository problems arise when different changes to the same document at
20438 the same location happen.
20439 Standard CVS repositories don't operate with a file locking mechanism.
20440 This may be surprising, but conflicts only occur if people disagree on
20441 the proper content of the same part of a document.
20442 So, if co-workers are used to communicate regularly, these conflicts occur
20444 If they don't communicate they have a fundamental problem anyway.
20445 Nevertheless some people like to work with so called
20446 \begin_inset Quotes eld
20450 \begin_inset Quotes erd
20454 If they do so the working copy of all files is readonly when checked out
20455 first and the user starts editing after using a special command to make
20456 the working copy writable.
20457 When the changes are checked in the working copy returns to readonly state.
20458 With \SpecialChar LyX
20459 one has to edit the
20460 \begin_inset Flex Code
20463 \begin_layout Plain Layout
20469 file and add the line
20470 \begin_inset Flex Code
20473 \begin_layout Plain Layout
20479 to work with reserved checkouts.
20480 The benefit is the possibility to see who is using a writable copy of some
20482 It's not guaranteed only one user makes a copy writable.
20485 \begin_layout Standard
20487 tries to guess if you're using reserved or non-reserved checkouts.
20488 If your working copy is readonly or it is writable and an additional copy
20489 of your document exists in the CVS/Base sub-directory a reserved otherwise
20490 a non-reserved checkout is assumed.
20491 When a reserved checkout is detected you have to use
20492 \begin_inset Flex MenuItem
20495 \begin_layout Plain Layout
20501 to make your working copy writable if it's readonly.
20503 \begin_inset Flex MenuItem
20506 \begin_layout Plain Layout
20512 operation is possible and that makes your working copy readonly again after
20513 transferring your changes to the repository.
20516 \begin_layout Standard
20517 More information about CVS can be found here
20518 \begin_inset Flex URL
20521 \begin_layout Plain Layout
20523 http://www.nongnu.org/cvs
20529 \begin_inset Flex URL
20532 \begin_layout Plain Layout
20534 http://ximbiot.com/cvs
20542 \begin_layout Standard
20547 to understand the sub-commands and the switches mentioned below.
20550 \begin_layout Subsubsection
20556 \begin_layout Standard
20557 If your document is not under revision control, this is the only item shown
20559 And if it is under revision control, the
20566 item is not visible.
20570 \begin_layout Standard
20571 This command registers in CVS your document
20572 \begin_inset Flex Strong
20575 \begin_layout Plain Layout
20583 in the case you have already the documents directory under CVS control
20589 This means you have to create or checkout the archive by yourself using
20591 (In case you forget that step \SpecialChar LyX
20592 registers the document with RCS.)
20595 \begin_layout Standard
20596 Then you are asked interactively to supply an initial description of the
20598 Don't forget that registered file is not yet checked in.
20601 \begin_layout Standard
20602 CVS command that is run:
20604 cvs -q add -m"<entered message>" "<file-name>"
20607 \begin_layout Standard
20612 above and for all other CVS commands is an abbreviation for
20613 \begin_inset Quotes eld
20616 change the current working directory to file location and use the file name
20617 without path component as argument
20618 \begin_inset Quotes erd
20624 \begin_layout Subsubsection
20630 \begin_layout Standard
20631 When you are finished editing a file, you commit your changes.
20632 When you do this and you had changed the document, you are asked for a
20633 description of the changes.
20634 After that changes are written to the repository.
20635 In case you didn't change the document and a reserved checkout is detected
20636 the reservation made on
20637 \begin_inset Flex MenuItem
20640 \begin_layout Plain Layout
20649 \begin_layout Labeling
20650 \labelwidthstring 00.00.0000
20652 \begin_inset space ~
20656 \begin_inset space ~
20660 \begin_inset Newline newline
20664 \begin_inset Flex Code
20667 \begin_layout Plain Layout
20670 -q commit -m"<description>" "<file-name>"
20676 \begin_inset Newline newline
20680 \begin_inset Flex Code
20683 \begin_layout Plain Layout
20694 \begin_layout Subsubsection
20700 \begin_layout Standard
20701 When you are sharing a repository with others, you may have to incorporate
20702 their changes into your working copy.
20705 \begin_layout Standard
20708 cvs -q update "<file-name>"
20711 \begin_layout Standard
20712 If a readonly checkout is detected the working copy is made writable and
20716 \begin_layout Standard
20719 cvs -q edit "<file-name>"
20722 \begin_layout Subsubsection
20725 Revert To Repository Version
20728 \begin_layout Standard
20729 This will discard all changes made to the document since the last check
20731 You get a warning before changes are discarded.
20732 Firstly the file is deleted, secondly CVS update command is run.
20735 \begin_layout Standard
20738 cvs -q update "<file-name>"
20741 \begin_layout Standard
20742 If a reserved checkout is detected and the working copy has no changes only
20743 the reservation is undone.
20746 \begin_layout Standard
20749 cvs -q unedit "<file-name>"
20752 \begin_layout Subsubsection
20758 \begin_layout Standard
20759 This will create a copy of the current document.
20760 Since CVS does not support copy operations natively, the version history
20761 is not preserved, and the copy is added as a new file.
20762 It requires a clean document without any changes since the last checkin.
20763 You are asked for a file name and a description of the copy operation.
20764 After that the copy is created, both locally and in the repository.
20765 If the parent directories of the copied and original document differ, all
20766 relative paths of included files of the copy are adjusted (like in
20768 File\SpecialChar menuseparator
20773 Finally, the copy is loaded instead of the original document.
20776 \begin_layout Labeling
20777 \labelwidthstring 00.00.0000
20779 \begin_inset space ~
20783 \begin_inset space ~
20787 \begin_inset Newline newline
20791 \begin_inset Flex Code
20794 \begin_layout Plain Layout
20797 \begin_inset Quotes eld
20801 \begin_inset Quotes erd
20810 \begin_inset Flex Code
20813 \begin_layout Plain Layout
20816 \begin_inset Quotes eld
20820 \begin_inset Quotes erd
20829 \begin_inset Newline newline
20833 \begin_inset Flex Code
20836 \begin_layout Plain Layout
20840 \begin_inset Quotes eld
20844 \begin_inset Quotes erd
20855 \begin_layout Subsubsection
20861 \begin_layout Standard
20862 This will rename the current document.
20863 Since CVS does not support rename operations natively, the version history
20864 is not preserved, the renamed document is added as a new file, and the
20865 original document is deleted.
20866 It requires a clean document without any changes since the last checkin.
20867 You are asked for a file name and a description of the rename operation.
20868 After that the document is renamed, both locally and in the repository.
20869 If the parent directories of the new and old file names differ, all relative
20870 paths of included files are adjusted (like in
20872 File\SpecialChar menuseparator
20877 Finally, the document is reloaded using the new name.
20880 \begin_layout Labeling
20881 \labelwidthstring 00.00.0000
20883 \begin_inset space ~
20887 \begin_inset space ~
20891 \begin_inset Newline newline
20895 \begin_inset Flex Code
20898 \begin_layout Plain Layout
20901 \begin_inset Quotes eld
20905 \begin_inset Quotes erd
20914 \begin_inset Flex Code
20917 \begin_layout Plain Layout
20920 \begin_inset Quotes eld
20924 \begin_inset Quotes erd
20933 \begin_inset Newline newline
20937 \begin_inset Flex Code
20940 \begin_layout Plain Layout
20944 \begin_inset Quotes eld
20948 \begin_inset Quotes erd
20957 \begin_inset Newline newline
20961 \begin_inset Flex Code
20964 \begin_layout Plain Layout
20968 \begin_inset Quotes eld
20972 \begin_inset Quotes erd
20983 \begin_layout Subsubsection
20984 Update of the local directory checkout from repository
20987 \begin_layout Standard
20988 Once your documents gets more complex, containing sub-documents and pictures,
20990 \begin_inset Flex Code
20993 \begin_layout Plain Layout
20999 files and so on using version control becomes more complicated.
21001 supports updating the whole tree in which resides the document.
21002 This become especially useful once you cooperate with people which neither
21003 have detailed knowledge about CVS usage nor they have ambition to commit
21004 additional material to the repository.
21005 You have to organize the files structure so that all external files are
21006 in the same directory or subdirectories of the document.
21007 It's good practice anyway to store multipart documents in an extra directory.
21010 \begin_layout Standard
21012 \begin_inset Flex Code
21015 \begin_layout Plain Layout
21016 Update local directory from repository
21021 command updates the whole directory.
21022 If local changes are detected user is warned before update starts.
21023 In case of merge conflicts both versions of the conflicting document parts
21024 are placed in the final document.
21025 You have to review and correct the result of the merge.
21026 You'll find the conflicts enclosed in pairs of
21027 \begin_inset Flex Code
21030 \begin_layout Plain Layout
21037 \begin_inset Flex Code
21040 \begin_layout Plain Layout
21047 \begin_inset Flex Code
21050 \begin_layout Plain Layout
21057 The first part is your version as before the update operation with the
21058 document name prepended.
21059 The second one is the repository version with the version number after
21061 \begin_inset Flex Code
21064 \begin_layout Plain Layout
21073 \begin_layout Labeling
21074 \labelwidthstring 00.00.0000
21076 \begin_inset space ~
21080 \begin_inset space ~
21084 \begin_inset Newline newline
21088 \begin_inset Flex Code
21091 \begin_layout Plain Layout
21099 (Ask if changes are detected.)
21100 \begin_inset Newline newline
21104 \begin_inset Flex Code
21107 \begin_layout Plain Layout
21108 cd $path; cvs -q update
21118 \begin_layout Standard
21120 \begin_inset Flex Code
21123 \begin_layout Plain Layout
21129 stands for the path to the document.
21132 \begin_layout Subsubsection
21138 \begin_layout Standard
21139 This shows the complete history of the CVS document.
21142 cvs log "<file-name>"
21144 is shown in a browser.
21147 \begin_layout Subsubsection
21151 \begin_layout Standard
21153 supports CVS version number, author name, date and time of last commit.
21154 All those are extracted from
21156 cvs log -r <file-name>
21160 \begin_inset CommandInset ref
21162 reference "subsec:VCS-Revision-Information"
21169 \begin_layout Subsection
21170 SVN commands in \SpecialChar LyX
21174 \begin_layout Standard
21175 SVN is now partially supported by \SpecialChar LyX
21177 You can find the commands in the
21179 File\SpecialChar menuseparator
21181 \begin_inset space ~
21187 Please note that if you use password protected access to repository via
21188 ssh, you will be asked in terminal window.
21190 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21194 \begin_layout Plain Layout
21195 Most of the commands will work with 1.4 too, see
21196 \begin_inset CommandInset ref
21198 reference "subsec:SVN-Repo-Update"
21203 There seems to be currently unresolved permissions problem under SVN 1.8
21204 with reverting changes when file is locked.
21212 \begin_layout Subsubsection
21218 \begin_layout Standard
21219 If your document is not under revision control, this is the only item shown
21221 And if it is under revision control, the
21228 item is not visible.
21231 \begin_layout Standard
21232 This command registers in SVN your document ONLY in case you have already
21233 the documents directory under SVN control (in particular
21238 This means you have to checkout the archive by yourself.
21241 \begin_layout Standard
21242 Then you are asked interactively to supply an initial description of the
21244 Don't forget that registered file is not yet commited.
21247 \begin_layout Standard
21248 SVN command that is run:
21251 \begin_inset Quotes eld
21255 \begin_inset Quotes erd
21261 \begin_layout Standard
21266 to understand the switches.
21269 \begin_layout Subsubsection
21275 \begin_layout Standard
21276 When you are finished editing a file, you commit your changes.
21277 When you do this, you are asked for a description of the changes.
21278 After that changes are commited.
21281 \begin_layout Standard
21286 \begin_layout Plain Layout
21287 In case locking is not enabled.
21289 \begin_inset CommandInset ref
21291 reference "subsec:SVN-File-Locking"
21302 svn commit -q -m"<description>" <file-name>
21305 \begin_layout Subsubsection
21311 \begin_layout Standard
21312 Updates the changes of this file from the repository.
21313 Be sure you understand SVN merging and conflicts resolving before using
21314 this function, because all conflicts has to be resolved manually by you!
21317 \begin_layout Standard
21322 \begin_layout Plain Layout
21330 svn update --non-interactive
21331 \begin_inset Quotes eld
21335 \begin_inset Quotes erd
21341 \begin_layout Subsubsection
21344 Revert To Repository Version
21347 \begin_layout Standard
21348 This will discard all changes made to the document since the last check
21350 You get a warning before changes are discarded.
21353 \begin_layout Standard
21357 \begin_inset Quotes eld
21361 \begin_inset Quotes erd
21367 \begin_layout Subsubsection
21373 \begin_layout Standard
21374 This will create a copy of the current document including the version history.
21375 It requires a clean document without any changes since the last checkin.
21376 You are asked for a file name and a description of the copy operation.
21377 After that the copy is created, both locally and in the repository.
21378 If the parent directories of the copied and original document differ, all
21379 relative paths of included files of the copy are adjusted (like in
21381 File\SpecialChar menuseparator
21386 Finally, the copy is loaded instead of the original document.
21389 \begin_layout Labeling
21390 \labelwidthstring 00.00.0000
21392 \begin_inset space ~
21396 \begin_inset space ~
21400 \begin_inset Newline newline
21404 \begin_inset Flex Code
21407 \begin_layout Plain Layout
21411 \begin_inset Quotes eld
21415 \begin_inset Quotes erd
21419 \begin_inset Quotes eld
21423 \begin_inset Quotes erd
21432 \begin_inset Newline newline
21436 \begin_inset Flex Code
21439 \begin_layout Plain Layout
21448 \begin_layout Subsubsection
21454 \begin_layout Standard
21455 This will rename the current document including the version history.
21456 It requires a clean document without any changes since the last checkin.
21457 You are asked for a file name and a description of the rename operation.
21458 After that the document is renamed, both locally and in the repository.
21459 If the parent directories of the new and old file names differ, all relative
21460 paths of included files are adjusted (like in
21462 File\SpecialChar menuseparator
21467 Finally, the document is reloaded using the new name.
21470 \begin_layout Labeling
21471 \labelwidthstring 00.00.0000
21473 \begin_inset space ~
21477 \begin_inset space ~
21481 \begin_inset Newline newline
21485 \begin_inset Flex Code
21488 \begin_layout Plain Layout
21492 \begin_inset Quotes eld
21496 \begin_inset Quotes erd
21500 \begin_inset Quotes eld
21504 \begin_inset Quotes erd
21513 \begin_inset Newline newline
21517 \begin_inset Flex Code
21520 \begin_layout Plain Layout
21529 \begin_layout Subsubsection
21530 \begin_inset CommandInset label
21532 name "subsec:SVN-Repo-Update"
21536 Update of the local directory checkout from repository
21540 \begin_layout Plain Layout
21541 Note that this command will work only with subversion
21542 \begin_inset Formula $\geqq1.5$
21553 \begin_layout Standard
21554 All the commands above have one shortcomming - they deal with the current
21556 Once your document contains pictures, includes external
21557 \begin_inset Flex Code
21560 \begin_layout Plain Layout
21566 files and so on administration becomes more complicated.
21568 now supports updating the whole tree in which resides the document
21572 \begin_layout Plain Layout
21573 One need to organize the files structure so that all external files are
21574 in the same directory or subdirectories of the document.
21581 This become especially useful once you cooperate with people which neither
21582 know about subversion management nor they have ambition to commit additional
21583 material to the repository.
21587 \begin_layout Standard
21588 \begin_inset Flex Code
21591 \begin_layout Plain Layout
21592 Update local directory from repository
21597 command updates the whole directory and in case of merge conflicts local
21598 version of the files are left, so no unintended data loss occurs.
21599 If local changes are detected user is warned before update starts.
21602 \begin_layout Labeling
21603 \labelwidthstring 00.00.0000
21605 \begin_inset space ~
21609 \begin_inset space ~
21613 \begin_inset Newline newline
21617 \begin_inset Flex Code
21620 \begin_layout Plain Layout
21626 (Ask if changes are detected.)
21627 \begin_inset Newline newline
21631 \begin_inset Flex Code
21634 \begin_layout Plain Layout
21635 svn update –accept mine-full $path
21643 \begin_layout Standard
21645 \begin_inset Flex Code
21648 \begin_layout Plain Layout
21654 stands for the path to the document.
21657 \begin_layout Subsubsection
21663 \begin_layout Standard
21664 This shows the complete history of the SVN document.
21668 \begin_inset Quotes eld
21672 \begin_inset Quotes erd
21677 is shown in a browser.
21680 \begin_layout Subsubsection
21682 \begin_inset CommandInset label
21684 name "subsec:SVN-File-Locking"
21691 \begin_layout Standard
21692 The file exchange through various revision control systems brings the problem
21693 of merge conflicts in case two different users try to edit the same (parts
21695 When such a conflict happens it needs manual resolving and one reasonable
21696 alternative is to provide some kind of locking mechanism, which guarantees
21697 that only one user is allowed to edit file at the given time.
21700 \begin_layout Standard
21701 SVN has two such mechanisms to provide mutual exclusivity for file access
21702 - locks and automatic setting of write permissions (see sec.
21704 \begin_inset CommandInset ref
21706 reference "subsec:Automatical-Locking-Property"
21711 \begin_inset Flex Code
21714 \begin_layout Plain Layout
21724 \begin_layout Plain Layout
21725 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21731 If this property is detected for a given document \SpecialChar LyX
21732 starts to use SVN locks
21733 for document editing automatically and the whole check-in/out mechanism
21734 switches to the same regimen as for RCS.
21735 This in particular means there are two different modes of file use in \SpecialChar LyX
21739 \begin_layout Itemize
21741 The loaded file is in the read-only mode.
21742 For editing on needs to check-out.
21747 consists of updating from the repository and gaining write lock.
21748 If the lock is not possible to obtain, we remain in unlocked state.
21751 \begin_layout Itemize
21753 The loaded file is in the 'normal' edit mode.
21754 No other user is allowed to edit the file.
21759 consists of commiting changes and releasing write-lock.
21760 If no changes have been made to the document, no commit will be produced
21764 \begin_layout Plain Layout
21765 Don't be puzzled by the fact that you will be asked for commit message anyway.
21770 and only the write-lock will be released.
21773 \begin_layout Standard
21777 \begin_layout Labeling
21778 \labelwidthstring 00.00.0000
21781 svn commit -q -m"<description>" "<file-name>"
21782 \begin_inset Newline newline
21785 svn unlock "<file-name>"
21788 \begin_layout Labeling
21789 \labelwidthstring 00.00.0000
21792 svn update "<file-name>"
21793 \begin_inset Newline newline
21796 svn lock "<file-name>"
21799 \begin_layout Subsubsection
21802 \begin_inset CommandInset label
21804 name "subsec:Automatical-Locking-Property"
21810 Automatic Locking Property
21813 \begin_layout Standard
21814 The above mentioned automatic setting of write permissions of the .lyx file
21820 ile\SpecialChar menuseparator
21826 \begin_inset space ~
21829 Control\SpecialChar menuseparator
21834 oggle locking property
21837 This command is active only when the file is not locked on the svn server
21839 you need to check-out before proceeding).
21842 \begin_layout Labeling
21843 \labelwidthstring 00.00.0000
21845 \begin_inset space ~
21851 \begin_layout Labeling
21852 \labelwidthstring 00.00.0000
21855 svn propset svn:needs-lock ON "<file-name>"
21858 \begin_layout Labeling
21859 \labelwidthstring 00.00.0000
21862 svn propdel svn:needs-lock "<file-name>"
21865 \begin_layout Subsubsection
21866 \begin_inset CommandInset label
21868 name "subsec:VCS-Revision-Information"
21872 Revision Information in Documents
21875 \begin_layout Standard
21876 There are more possibilities how to activate revision information in our
21880 \begin_layout Itemize
21883 \begin_inset Separator parbreak
21890 \begin_layout Itemize
21891 tree revision information (
21892 \begin_inset Flex Code
21895 \begin_layout Plain Layout
21902 The result is the output of the
21903 \begin_inset Flex Code
21906 \begin_layout Plain Layout
21912 command, the following table gives you an idea, how to read the results.
21915 \begin_layout Standard
21917 \begin_inset Tabular
21918 <lyxtabular version="3" rows="6" columns="2">
21919 <features tabularvalignment="middle">
21920 <column alignment="center" valignment="top">
21921 <column alignment="center" valignment="top">
21923 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21926 \begin_layout Plain Layout
21932 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21935 \begin_layout Plain Layout
21943 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21946 \begin_layout Plain Layout
21952 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21955 \begin_layout Plain Layout
21956 mixed revision working copy
21963 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21966 \begin_layout Plain Layout
21972 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21975 \begin_layout Plain Layout
21976 modified working copy
21983 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21986 \begin_layout Plain Layout
21992 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21995 \begin_layout Plain Layout
21996 switched working copy
22003 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22006 \begin_layout Plain Layout
22012 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22015 \begin_layout Plain Layout
22016 partial working copy, from a sparse checkout
22023 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22026 \begin_layout Plain Layout
22032 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22035 \begin_layout Plain Layout
22036 mixed revision, modified, switched working copy
22049 \begin_layout Itemize
22050 file revision information.
22051 The result comes from parsing the output of
22052 \begin_inset Flex Code
22055 \begin_layout Plain Layout
22057 \begin_inset space ~
22061 \begin_inset space ~
22065 \begin_inset space ~
22074 Supported flags are:
22075 \begin_inset Separator parbreak
22082 \begin_layout Itemize
22083 version number of the last commit (
22084 \begin_inset Flex Code
22087 \begin_layout Plain Layout
22096 \begin_layout Itemize
22097 author of the last commit (
22098 \begin_inset Flex Code
22101 \begin_layout Plain Layout
22110 \begin_layout Itemize
22111 date of the last commit (
22112 \begin_inset Flex Code
22115 \begin_layout Plain Layout
22124 \begin_layout Itemize
22125 time of the last commit (
22126 \begin_inset Flex Code
22129 \begin_layout Plain Layout
22139 \begin_layout Standard
22140 You can obtain this info via InsetInfo (e.g.
22142 \begin_inset Flex Code
22145 \begin_layout Plain Layout
22146 info-insert buffer vcs-date
22152 The information will be available only when you have the file stored under
22153 svn managment (i.e.
22155 \begin_inset Flex Code
22158 \begin_layout Plain Layout
22164 directory is available with your document).
22168 \begin_layout Itemize
22169 Another—a hacking one—possibility is to use svn keywords
22173 \begin_layout Plain Layout
22174 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22180 In short – you set file keywords property (e.g.
22183 svn propset svn:keywords 'Rev' file.lyx
22185 ) and then paste keyword \SpecialChar TeX
22190 \begin_layout Plain Layout
22191 This is an easy way how to ensure that \SpecialChar LyX
22192 won't break the line in the middle
22198 tag in your document (e.g.
22203 \begin_layout Plain Layout
22211 This way svn client will automatically substitute revision number (e.g.
22216 \begin_layout Plain Layout
22223 ) after each update and commit.
22224 There are more problems with this approach.
22225 Firstly, the '$' character is used in \SpecialChar TeX
22226 world for math equations, so any
22227 occurence of math formula
22228 \begin_inset Formula $Rev$
22232 \begin_inset Formula $Rev:59$
22235 in your \SpecialChar LyX
22237 Similarly for other keywords like Id, Date, Author, etc.
22238 Secondly svn output is dependent on your locales, so its very easy that
22239 svn would produce some problematic strings once Date is used.
22240 Thirdly you get the whole 'Rev: 59' string in your document instead of
22242 Until subversion implements user's custom keywords it will be hard to use
22243 this approach reliably or let \SpecialChar LyX
22244 to support it directly.
22247 \begin_layout Subsection
22248 SVN and Windows Environment
22251 \begin_layout Quote
22252 My inclination is to say that if the user cannot figure out the command
22253 line operations on their own fairly quickly, they would be well advised
22254 to use TortoiseSVN.
22260 \begin_layout Subsubsection
22264 \begin_layout Standard
22265 In addition to installing \SpecialChar LyX
22266 , and having access to a Subversion repository,
22267 the user will need to install the Subversion client program.
22268 A Windows installer for the client program is available from
22269 \begin_inset CommandInset href
22272 target "http://www.collab.net/nonav/downloads/subversion/"
22277 The user may also want to install
22278 \begin_inset CommandInset href
22281 target "http://tortoisesvn.tigris.org/"
22285 , which integrates Subversion operations into the context (rightclick) menu
22286 of Windows Explorer.
22287 Operations done outside \SpecialChar LyX
22288 will typically be more convenient using the Explorer
22290 Note that TortoiseSVN is not a replacement for the client program, which
22291 is what \SpecialChar LyX
22295 \begin_layout Subsubsection
22296 Bringing a document under Subversion control
22299 \begin_layout Standard
22300 Before a \SpecialChar LyX
22301 document can be brought under version control in Subversion, its
22302 parent directory needs to be under version control.
22303 If the document is being added to a project already in the repository,
22304 this is accomplished by checking the project out to the directory where
22305 the new document will be placed.
22306 If the project itself is not yet under version control (for instance, if
22307 this document starts a new project), the directory must be imported into
22309 This is done outside \SpecialChar LyX
22311 Both import and checkout are easily accomplished from the Explorer context
22312 menu using TortoiseSVN, or alternatively can be done using the command
22313 line client at a DOS prompt.
22314 The procedure for importing the project using TortoiseSVN is described
22315 below, assuming an existing repository and a new project being started
22323 For information on using the Subversion client program, run
22330 \begin_layout Enumerate
22337 in Windows Explorer, right click it, and select
22339 TortoiseSVN\SpecialChar menuseparator
22343 If necessary, adjust the URL for the repository, then click OK.
22346 \begin_layout Enumerate
22347 Right click the level of the repository under which you want to place the
22348 new project folder (typically the top level) and click
22352 Supply a name for the project folder and click OK.
22353 Add a message for the log file if desired, then click OK again.
22354 The new project folder should appear in the repository.
22355 Finally, click OK again to exit the repository browser.
22358 \begin_layout Enumerate
22359 Once again right click
22365 , this time selecting SVN Checkout\SpecialChar ldots
22366 Select the URL of the project folder
22367 you just created in the repository, and set the checkout directory to
22375 You will be warned about a non-empty folder; click OK to proceed.
22376 You should now have a
22387 \begin_layout Enumerate
22388 Create or open your document in \SpecialChar LyX
22391 File\SpecialChar menuseparator
22393 \begin_inset space ~
22396 Control\SpecialChar menuseparator
22400 Add a log message and click OK to commit the document to version control.
22403 \begin_layout Standard
22404 From this point onward, you should have full functionality in the
22406 File\SpecialChar menuseparator
22408 \begin_inset space ~
22414 You also have the option of checking the document in and out, viewing its
22416 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22417 client program from a command prompt.
22420 \begin_layout Subsubsection
22421 SSH tunnel used with SVN under Windows
22424 \begin_layout Standard
22425 Compared with Linux setting up an svn client to communicate over ssh under
22426 Windows is a rather troublesome task.
22427 We will at least offer some hints how to setup the client side but prior
22428 knowledge about ssh and the Windows command line is needed, also be prepared
22429 for a great deal of frustration\SpecialChar ldots
22433 \begin_layout Enumerate
22434 Get an svn client for windows, as described in the previous sections.
22435 When it is a fresh install run some svn command (e.g.
22437 \begin_inset Flex Code
22440 \begin_layout Plain Layout
22446 ) to create config files, which you will need to change later on.
22449 \begin_layout Enumerate
22450 Choose an ssh client for Windows.
22451 There are several possibilities, we will use the one from Putty tools
22455 \begin_layout Plain Layout
22456 \begin_inset Flex URL
22459 \begin_layout Plain Layout
22461 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22472 You will need to set the connection up so that the client doesn't ask for
22473 any password from you.
22474 To keep things easy we will use only keys without any additional password
22476 \begin_inset Separator parbreak
22483 \begin_layout Enumerate
22485 \begin_inset Flex Code
22488 \begin_layout Plain Layout
22495 Save your private .ppk key file and put the public one on the server side.
22496 If the SVN server runs on Linux, note that the format of the public key
22497 is not compatible with Linux openssh and you will need to direcly copy-paste
22500 Public key for pasting into OpenSSH authorized_keys file
22502 :” edit field into the server's
22503 \begin_inset Flex Code
22506 \begin_layout Plain Layout
22507 ~/.ssh/authorized_keys
22513 \begin_inset Flex Code
22516 \begin_layout Plain Layout
22525 \begin_layout Enumerate
22527 \begin_inset Flex Code
22530 \begin_layout Plain Layout
22537 In the SVN config file
22541 \begin_layout Plain Layout
22542 Exact path depends on Windows version, usually somewhere around
22543 \begin_inset Flex Code
22546 \begin_layout Plain Layout
22549 Documents and Settings
22563 \begin_inset Flex Code
22566 \begin_layout Plain Layout
22581 , section [tunnels], setup ssh command, e.g.
22583 \begin_inset Flex Code
22586 \begin_layout Plain Layout
22587 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22596 \begin_layout Plain Layout
22597 It will usually take a lot of time to get exact command right and it depends
22599 For example do not have some remote server saved as a default session in
22601 If things fail, try to connect via plink without SVN first.
22610 \begin_layout Enumerate
22611 Checkout the SVN archive, e.
22612 \begin_inset space \thinspace{}
22616 \begin_inset Newline newline
22620 \begin_inset Flex Code
22623 \begin_layout Plain Layout
22624 svn co svn+ssh://user@server/repository_path
22632 \begin_layout Subsubsection
22633 End-of-Line Conversions
22636 \begin_layout Standard
22637 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22639 use different line endings inside the .lyx files.
22640 This is not a problem as far as \SpecialChar LyX
22641 functionality is concerned, but the commit
22642 diffs will be huge and merge-conflicts prone.
22643 Fortunately SVN itself knows
22647 \begin_layout Plain Layout
22648 \begin_inset Flex URL
22651 \begin_layout Plain Layout
22653 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22663 how to deal with CR/LF problems when switching .lyx files to the
22664 \begin_inset Flex Code
22667 \begin_layout Plain Layout
22677 \begin_layout Plain Layout
22679 \begin_inset Flex Code
22682 \begin_layout Plain Layout
22683 svn propset svn:eol-style native FILE_NAME
22696 \begin_layout Subsection
22697 GIT commands in \SpecialChar LyX
22701 \begin_layout Standard
22702 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22704 You can find the commands in the
22706 File\SpecialChar menuseparator
22708 \begin_inset space ~
22714 Please note that if you use password protected access to repository via
22715 ssh, you will be asked in terminal window.
22717 was tested against GIT 1.7.
22721 \begin_layout Plain Layout
22722 Windows users please note that you need to ensure that git is on the path.
22723 This can be set from within \SpecialChar LyX
22726 Tools\SpecialChar menuseparator
22727 Preferences\SpecialChar menuseparator
22728 Paths\SpecialChar menuseparator
22739 \begin_layout Standard
22740 One big difference of GIT and the other supported version control systems
22741 is the distributed nature of GIT: With traditional version control systems
22742 there is one central server which hosts the repository.
22743 Users commit their changes to the server, and get updates made by other
22745 With GIT, users commit to a local repository.
22746 The local repository can be synchronized with one or more remote repositories
22748 \begin_inset Flex Code
22751 \begin_layout Plain Layout
22758 \begin_inset Flex Code
22761 \begin_layout Plain Layout
22769 does not interact in any way with remote GIT repositories.
22770 It works exclusively with the local repository in a very similar way as
22771 with a central CVS or SVN repository.
22772 If you use remote GIT repositories you need to do the
22773 \begin_inset Flex Code
22776 \begin_layout Plain Layout
22783 \begin_inset Flex Code
22786 \begin_layout Plain Layout
22792 operations with your favourite GIT client.
22795 \begin_layout Subsubsection
22801 \begin_layout Standard
22802 If your document is not under revision control, this is the only item shown
22804 And if it is under revision control, the
22811 item is not visible.
22814 \begin_layout Standard
22815 This command registers in GIT your document ONLY in case you have already
22816 the documents directory under GIT control (in particular
22821 This means you have to checkout the archive by yourself.
22824 \begin_layout Standard
22825 Then you are asked interactively to supply an initial description of the
22827 Don't forget that registered file is not yet commited.
22830 \begin_layout Standard
22831 GIT command that is run:
22834 \begin_inset Quotes eld
22838 \begin_inset Quotes erd
22844 \begin_layout Standard
22849 to understand the switches.
22852 \begin_layout Subsubsection
22858 \begin_layout Standard
22859 When you are finished editing a file, you commit your changes.
22860 When you do this, you are asked for a description of the changes.
22861 After that changes are commited.
22864 \begin_layout Standard
22867 git commit -q -m"<description>" <file-name>
22870 \begin_layout Subsubsection
22873 Revert To Repository Version
22876 \begin_layout Standard
22877 This will discard all changes made to the document since the last check
22879 You get a warning before changes are discarded.
22882 \begin_layout Standard
22886 \begin_inset Quotes eld
22890 \begin_inset Quotes erd
22896 \begin_layout Subsubsection
22902 \begin_layout Standard
22903 This will rename the current document including the version history.
22904 It requires a clean document without any changes since the last checkin.
22905 You are asked for a file name and a description of the rename operation.
22906 After that the document is renamed, both locally and in the repository.
22907 If the parent directories of the new and old file names differ, all relative
22908 paths of included files are adjusted (like in
22910 File\SpecialChar menuseparator
22915 Finally, the document is reloaded using the new name.
22918 \begin_layout Labeling
22919 \labelwidthstring 00.00.0000
22921 \begin_inset space ~
22925 \begin_inset space ~
22929 \begin_inset Newline newline
22933 \begin_inset Flex Code
22936 \begin_layout Plain Layout
22940 \begin_inset Quotes eld
22944 \begin_inset Quotes erd
22948 \begin_inset Quotes eld
22952 \begin_inset Quotes erd
22961 \begin_inset Newline newline
22965 \begin_inset Flex Code
22968 \begin_layout Plain Layout
22977 \begin_layout Subsubsection
22983 \begin_layout Standard
22984 This shows the complete history of the GIT document.
22988 \begin_inset Quotes eld
22992 \begin_inset Quotes erd
22997 is shown in a browser.
23000 \begin_layout Subsubsection
23004 \begin_layout Standard
23006 supports GIT hash number of the last commit to the file, author name, date
23007 and time of last commit.
23008 All those are extracted from
23010 git log -n 1 --pretty=format:%H%n%an%n%ai
23013 Tree version information is obtained via
23015 git describe --abbrev --dirty --long
23019 \begin_inset CommandInset ref
23021 reference "subsec:VCS-Revision-Information"
23028 \begin_layout Subsection
23032 \begin_layout Standard
23033 With the recent addition of the vc-command function \SpecialChar LyX
23034 power users are allowed
23035 to create their own commands for revision control.
23038 \begin_layout Standard
23039 As an example you can see how two TortoiseSVN commands could be integrated
23043 \begin_layout Description
23045 \begin_inset Flex Code
23048 \begin_layout Plain Layout
23049 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23057 \begin_layout Description
23059 \begin_inset Flex Code
23062 \begin_layout Plain Layout
23063 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23071 \begin_layout Subsection
23072 Version control and Document comparison
23075 \begin_layout Standard
23076 One of the typical uses of version control is to inspect the changes between
23077 revisions, usually by creating
23078 \begin_inset Flex Code
23081 \begin_layout Plain Layout
23088 While this is useful for plain text files, it is much less useful in the
23089 case of \SpecialChar LyX
23090 files, which have more a complicated structure.
23091 Hence we provide binding to the Document comparison feature.
23092 There are two ways of calling this feature - either by direct call of
23093 \begin_inset Flex Code
23096 \begin_layout Plain Layout
23103 function (for details see \SpecialChar LyX
23104 functions manual) or by icon/menu item
23105 \begin_inset Flex MenuItem
23108 \begin_layout Plain Layout
23109 Compare with older revision...
23115 One can either compare two chosen revisions of the document or he can simply
23116 compare the current version of edited text with older revisions (where
23118 \begin_inset Flex MenuItem
23121 \begin_layout Plain Layout
23127 ' revisions back means comparison of the edited file with last commited
23132 \begin_layout Standard
23133 This feature is supported for SVN and RCS though due to the more complicated
23134 versioning scheme of RCS there is a constraint – when addressing the revisions
23135 in dialog, numbers always point to the last number in RCS revision number,
23138 We don't currently support GIT addressing of revisions, one can just compare
23139 edited document with its revision X steps backs, where X is addressed as
23143 \begin_layout Section
23144 Literate Programming
23147 \begin_layout Standard
23152 (kayvan@sylvan.com)
23156 original documentation written by
23158 Edmar Wienskoski Jr.
23161 (edmar-w-jr@technologist.com)
23164 \begin_layout Subsection
23168 \begin_layout Standard
23169 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23171 programming, where it is assumed that you are familiar with this programming
23172 technique, and know what
23173 \begin_inset Quotes eld
23177 \begin_inset Quotes erd
23181 \begin_inset Quotes eld
23185 \begin_inset Quotes erd
23189 If that is not the case, please follow the web links provided in the following
23191 There is a lot of good documentation out there covering old development
23192 history to the latest tools tips.
23195 \begin_layout Standard
23196 It is also assumed that you are familiar with \SpecialChar LyX
23197 itself to a point that you
23198 are comfortable changing your \SpecialChar LyX
23199 preferences, and X resources file.
23200 If that is not the case please refer to other \SpecialChar LyX
23201 documentation to cover your
23205 \begin_layout Subsection
23206 Literate Programming
23209 \begin_layout Standard
23210 From the Literate Programming FAQ:
23213 \begin_layout Quotation
23214 Literate programming is the combination of documentation and source together
23215 in a fashion suited for reading by human beings.
23216 In fact, literate programs should be enjoyable reading, even inviting!
23217 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23218 and documentation in a single file.
23219 Literate programming tools then parse the file to produce either readable
23220 documentation or compilable source.
23221 The WEB style of literate programming was created by D.
23222 \begin_inset space \thinspace{}
23226 Knuth during the development of his \SpecialChar TeX
23227 typesetting software.
23231 \begin_layout Standard
23232 Another excerpt says:
23235 \begin_layout Quotation
23238 How is literate programming different from verbose commenting?
23241 \begin_layout Quotation
23242 There are three distinguishing characteristics.
23243 In order of importance, they are:
23244 \begin_inset Separator parbreak
23251 \begin_layout Itemize
23252 flexible order of elaboration
23255 \begin_layout Itemize
23256 automatic support for browsing
23259 \begin_layout Itemize
23260 typeset documentation, especially diagrams and mathematics
23264 \begin_layout Standard
23265 Now that I sparked your curiosity, take a look in the references.
23268 \begin_layout Subsubsection
23272 \begin_layout Standard
23273 The complete Literate Programming FAQ can be found at:
23276 \begin_layout Quote
23277 Literate Programming FAQ
23278 \begin_inset Flex URL
23281 \begin_layout Plain Layout
23283 http://www.literateprogramming.com/lpfaq.pdf
23291 \begin_layout Standard
23292 The FAQ lists 23 (twenty three!) different literate programming tools.
23293 Where some are specialized or
23294 \begin_inset Quotes eld
23298 \begin_inset Quotes erd
23301 for particular programming languages, while other have general scope.
23306 for my own use for several reasons:
23309 \begin_layout Itemize
23310 It can generate the documentation either in \SpecialChar LaTeX
23314 \begin_layout Itemize
23315 It has a open architecture, i.
23316 \begin_inset space \thinspace{}
23320 \begin_inset space \space{}
23323 it is easy to plug in new filters and to perform special processing that
23328 \begin_layout Itemize
23329 There is a good selection of filters available already (the HTML is one
23333 \begin_layout Itemize
23337 \begin_layout Standard
23338 The Noweb web page can be found at:
23341 \begin_layout Quote
23343 \begin_inset Flex URL
23346 \begin_layout Plain Layout
23348 http://www.cs.virginia.edu/~nr/noweb/
23356 \begin_layout Standard
23357 Starting from there you can reach many other interesting links and even
23358 some literate program examples.
23361 \begin_layout Subsection
23363 and Literate Programming with Noweb
23366 \begin_layout Standard
23367 The \SpecialChar LyX
23368 support for Literate Programming is provided by using the generic \SpecialChar LyX
23370 converters mechanism.
23371 This support is provided in a
23372 \begin_inset Quotes eld
23376 \begin_inset Quotes erd
23380 \begin_inset space \thinspace{}
23384 \begin_inset space \space{}
23387 you will be able to use this new \SpecialChar LyX
23388 feature with some other literate programming
23389 tool of your choice by just changing your \SpecialChar LyX
23393 \begin_layout Subsubsection
23394 Generating documents and code (weaving and tangling)
23397 \begin_layout Paragraph
23398 Using the noweb module
23401 \begin_layout Standard
23402 If you have installed Noweb and \SpecialChar LyX
23403 successfully, whenever you open a new document,
23404 after you have chosen its document class, use the Document->Settings menu
23406 \begin_inset Quotes eld
23410 \begin_inset Quotes erd
23414 If Noweb is correctly installed, when you click on the
23415 \begin_inset Quotes eld
23419 \begin_inset Quotes erd
23422 link, you will see the
23423 \begin_inset Quotes eld
23427 \begin_inset Quotes erd
23430 module in the available list and you can add it to your document.
23433 \begin_layout Paragraph
23437 \begin_layout Standard
23439 enables you to write code with a layout named
23440 \begin_inset Flex Noun
23443 \begin_layout Plain Layout
23450 Noweb delimits chunks like this:
23453 \begin_layout LyX-Code
23457 \begin_layout LyX-Code
23461 \begin_layout LyX-Code
23465 \begin_layout LyX-Code
23469 \begin_layout LyX-Code
23473 \begin_layout Standard
23474 The problem is that whatever is written in between the << and the
23478 must be taken literally, i.
23479 \begin_inset space \thinspace{}
23483 \begin_inset space \space{}
23487 should be prevented from making any special interpretation of what has
23489 This is also handled by
23490 \begin_inset Flex Noun
23493 \begin_layout Plain Layout
23499 , that works like a normal paragraph but has a free spacing capability.
23502 \begin_layout Standard
23503 As a special note, you can also use the
23504 \begin_inset Quotes eld
23508 \begin_inset Quotes erd
23511 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23515 \begin_layout LyX-Code
23519 \begin_layout LyX-Code
23520 def some_function(args):
23523 \begin_layout LyX-Code
23524 "This is the doc string for this function."
23527 \begin_layout LyX-Code
23528 print "My args: ", args
23531 \begin_layout LyX-Code
23532 @ %def some_function
23535 \begin_layout Standard
23536 For an example of this usage and the resulting cross-reference output, look
23537 at the Literate python program in
23539 LIBDIR/examples/listerrors.lyx
23541 which should make this all clear.
23544 \begin_layout Paragraph
23545 Generating the documentation
23548 \begin_layout Standard
23549 At this point you already have a new document file with a proper document
23550 class, and with some code and text on it.
23551 How do I print it? The answer is simple, you select
23553 View\SpecialChar menuseparator
23557 Just like you would do for a plain document.
23558 No special procedure is required.
23561 \begin_layout Standard
23562 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23566 \begin_layout Enumerate
23569 Update\SpecialChar menuseparator
23572 menu option is chosen, a \SpecialChar LaTeX
23575 \begin_inset Separator parbreak
23582 \begin_layout Standard
23583 If the document is of any literate class the generated file will be named
23584 with an extension name defined by the
23585 \begin_inset Quotes eld
23589 \begin_inset Quotes erd
23592 format (defined in the Preferences panel), otherwise the file will have
23601 \begin_layout Enumerate
23602 Note that the only difference so far is in the name of the file, no special
23603 processing is required by \SpecialChar LyX
23605 Given that you formatted the code using the
23606 \begin_inset Flex Noun
23609 \begin_layout Plain Layout
23615 layout that, by itself, takes care of the business.
23618 \begin_layout Enumerate
23619 If the document is of any literate class \SpecialChar LyX
23620 will then use the internal \SpecialChar LyX
23622 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23627 \begin_layout Plain Layout
23628 The converters are defined in the
23630 Tools\SpecialChar menuseparator
23634 \begin_inset Quotes eld
23638 \begin_inset Quotes erd
23650 manual for general information about converters.
23655 to generate the \SpecialChar LaTeX
23657 \begin_inset Separator parbreak
23664 \begin_layout Standard
23665 Otherwise it will just skip this step.
23669 \begin_layout Enumerate
23670 Finally, \SpecialChar LaTeX
23671 is invoked and the regular post processing continues as in a plain
23675 \begin_layout Standard
23676 Independence from a particular
23677 \begin_inset Quotes eld
23681 \begin_inset Quotes erd
23684 is easily achieved by changing the commands that are run by the various
23688 \begin_layout Paragraph
23689 Generating the code
23692 \begin_layout Standard
23693 When the build menu option is chosen or the corresponding button in the
23694 toolbar is pressed, a \SpecialChar LaTeX
23695 file is generated just like step 1 above.
23696 Next, \SpecialChar LyX
23702 This converter needs to be defined by the user and is not installed by
23703 default, though the Program format is.
23704 This converter (like any other converter) will have two parts:
23707 \begin_layout Enumerate
23708 The converter program itself.
23709 This program performs the conversion from the one format to the other (in
23710 this case, from the Noweb format to the Program pseudo-format).
23713 \begin_layout Enumerate
23714 The error log parser.
23715 This is a program whose sole purpose is to rewrite error messages in a
23716 format that \SpecialChar LyX
23718 This makes it possible for \SpecialChar LyX
23719 to place error boxes in the right places in
23723 \begin_layout Standard
23724 The first part, the
23725 \begin_inset Quotes eld
23729 \begin_inset Quotes erd
23732 setting, should be set to
23733 \begin_inset Newline newline
23737 \begin_inset Quotes eld
23745 \begin_inset Quotes erd
23749 \begin_inset Newline newline
23752 This basically means that \SpecialChar LyX
23754 \begin_inset Quotes eld
23758 \begin_inset Quotes erd
23761 (a program or script) with the name of the Noweb file (normally a file
23762 in the \SpecialChar LyX
23763 temp directory) and the directory path of the original \SpecialChar LyX
23768 \begin_layout Standard
23769 This is an implementation of
23770 \begin_inset Quotes eld
23774 \begin_inset Quotes erd
23777 that you can place in a directory on your path:
23780 \begin_layout Standard
23781 \begin_inset VSpace defskip
23787 \begin_layout Standard
23788 \begin_inset Newpage pagebreak
23794 \begin_layout Standard
23800 \begin_layout Standard
23806 \begin_layout Standard
23809 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23812 \begin_layout Standard
23813 \begin_inset VSpace defskip
23819 \begin_layout Standard
23820 The next part of the converter setting is the
23821 \begin_inset Quotes eld
23825 \begin_inset Quotes erd
23828 which is to be set to
23829 \begin_inset Newline newline
23833 \begin_inset Quotes eld
23838 parselog=$$s/scripts/listerrors
23841 \begin_inset Quotes erd
23845 \begin_inset Newline newline
23848 This will run any errors that are generated by the
23849 \begin_inset Quotes eld
23853 \begin_inset Quotes erd
23856 process through the
23857 \begin_inset Quotes eld
23861 \begin_inset Quotes erd
23867 \begin_layout Standard
23868 The build will normally take place in \SpecialChar LyX
23869 's temporary directory, so the files
23870 produced by the conversion will be in that directory.
23872 will copy out what it regards as the `main' file, but the
23876 conversion may produce several files, and so most of these would then be
23877 deleted when \SpecialChar LyX
23879 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23880 the build-script chunk can place the generated files in that location.
23883 \begin_layout Paragraph
23884 Build instructions in the document
23887 \begin_layout Standard
23888 The last piece of the integration between \SpecialChar LyX
23890 \begin_inset Quotes eld
23894 \begin_inset Quotes erd
23898 Generally, the instructions for building your program should be embedded
23899 in a chunk of its own.
23901 \begin_inset Quotes eld
23905 \begin_inset Quotes erd
23908 above uses the notangle command to look for this chunk (called
23909 \begin_inset Quotes eld
23913 \begin_inset Quotes erd
23916 ) and runs its contents through
23917 \begin_inset Quotes eld
23921 \begin_inset Quotes erd
23927 \begin_layout Standard
23928 Typically, such a chunk would look something like this:
23931 \begin_layout LyX-Code
23935 \begin_layout LyX-Code
23937 \begin_inset Newline newline
23940 if [ -z "${NOWEB_SOURCE}" ]
23941 \begin_inset Newline newline
23947 \begin_layout LyX-Code
23948 NOWEB_SOURCE=myfile.nw
23949 \begin_inset Newline newline
23953 \begin_inset Newline newline
23957 code to extract files ...
23958 use NOWEB_OUTPUT_DIR here ...]
23959 \begin_inset Newline newline
23963 code to compile files ...]
23964 \begin_inset Newline newline
23970 \begin_layout Standard
23973 LIBDIR/examples/listerrors.lyx
23977 LIBDIR/examples/Literate.lyx
23979 which implement two versions of the
23980 \begin_inset Quotes eld
23984 \begin_inset Quotes erd
23987 program for some illustrations of how all of these pieces go together or
23990 LIBDIR/examples/noweb2lyx.lyx.
23993 Interestingly, these three files show off the language-indepence of the
23995 literate programming support since they are written in Python, C and Perl
23999 \begin_layout Subsubsection
24000 Configuring \SpecialChar LyX
24004 \begin_layout Standard
24005 All the Literate Programming support is configured by the
24007 Tools\SpecialChar menuseparator
24011 \begin_inset Quotes eld
24015 \begin_inset Quotes erd
24019 The important parts are:
24022 \begin_layout Description
24024 \begin_inset space ~
24028 \begin_inset Quotes eld
24032 \begin_inset Quotes erd
24036 \begin_inset space ~
24039 format Set up via the File Formats tab, this is where the Noweb-specific
24049 , the file extension is set to
24054 This tells \SpecialChar LyX
24055 to create a file with a
24059 extension in the first step of the conversion process.
24062 \begin_layout Description
24064 \begin_inset space ~
24072 \begin_inset space ~
24075 format This is an empty format whose sole purpose is to be the endpoint
24076 of a conversion (which then allows us to set up a converter for it).
24079 \begin_layout Description
24089 This converter performs the
24090 \begin_inset Quotes eld
24094 \begin_inset Quotes erd
24097 of the literate document.
24098 For Noweb, it is set to
24099 \begin_inset Quotes eld
24104 noweave -delay -index $$i > $$o
24107 \begin_inset Quotes erd
24113 \begin_layout Description
24123 \begin_inset Quotes eld
24127 \begin_inset Quotes erd
24131 As stated above, the Converter is set to
24132 \begin_inset Quotes eld
24140 \begin_inset Quotes erd
24143 , with Flags set to
24144 \begin_inset Newline newline
24148 \begin_inset Quotes eld
24153 parselog=$$s/scripts/listerrors
24156 \begin_inset Quotes erd
24162 \begin_layout Subsubsection
24166 \begin_layout Standard
24167 There is also a new function implemented in the \SpecialChar LyX
24169 \begin_inset Quotes eld
24172 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24176 \begin_layout Standard
24177 When debugging code with ddd/gdb, it is possible to invoke a text editor
24178 at the current execution position with a single key stroke.
24179 The default ddd configuration for that is shift-ctrl-V.
24180 It happens that you can define the editor command line invocation in ddd
24183 Edit\SpecialChar menuseparator
24184 Preferences\SpecialChar menuseparator
24187 dialog and changing the "Edit Sources" entry.
24190 \begin_layout Standard
24191 I take advantage of the newly created \SpecialChar LyX
24192 server function and this ddd feature,
24194 \begin_inset Quotes eld
24198 \begin_inset Quotes erd
24204 \begin_layout Standard
24205 \begin_inset VSpace defskip
24211 \begin_layout Standard
24214 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24217 \begin_layout Standard
24218 \begin_inset VSpace defskip
24224 \begin_layout Standard
24225 With this, whenever you are using ddd and find a point in the program that
24226 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24227 ddd will forward this information to \SpecialChar LyX
24228 through the \SpecialChar LyX
24229 server and then the
24231 window will show the same file with the cursor at the same position ddd
24233 No more guessing or long scrolling to locate a point in the program back
24237 \begin_layout Standard
24238 Note however that you must enable the \SpecialChar LyX
24239 server to get this feature working
24240 (it is disabled by default).
24241 You can enable it in
24253 ) by entering in the
24259 \begin_inset Quotes eld
24264 /home/<your-home-directory>/.lyx/lyxpipe
24267 \begin_inset Quotes erd
24273 \begin_layout Standard
24274 Read the \SpecialChar LyX
24275 server documentation in the
24277 Customization Manual
24279 for further information.
24282 \begin_layout Subsubsection
24286 \begin_layout Standard
24287 There are six new buttons that can be added to your \SpecialChar LyX
24289 Five of these buttons are short cuts to layout styles:
24312 The last one is a short cut to the
24313 \begin_inset Quotes eld
24317 \begin_inset Quotes erd
24324 \begin_layout Standard
24326 has a range of buttons that are available for tool bar customization.
24327 In my toolbar I like to combine the six short cuts above with two more:
24332 \SpecialChar menuseparator
24337 \SpecialChar menuseparator
24344 Document\SpecialChar menuseparator
24345 View\SpecialChar menuseparator
24349 Here is how it looks like:
24352 \begin_layout LyX-Code
24356 \begin_layout LyX-Code
24360 \begin_layout LyX-Code
24361 Icon "layout Standard"
24364 \begin_layout LyX-Code
24365 Icon "layout Section"
24368 \begin_layout LyX-Code
24369 Icon "layout \SpecialChar LaTeX
24373 \begin_layout LyX-Code
24374 Icon "layout \SpecialChar LyX
24378 \begin_layout LyX-Code
24379 Icon "layout Chunk"
24382 \begin_layout LyX-Code
24386 \begin_layout LyX-Code
24390 \begin_layout LyX-Code
24391 Icon "buffer-typeset"
24394 \begin_layout LyX-Code
24395 Icon "build-program"
24398 \begin_layout LyX-Code
24402 \begin_layout LyX-Code
24406 \begin_layout LyX-Code
24410 \begin_layout LyX-Code
24414 \begin_layout LyX-Code
24418 \begin_layout Subsubsection
24419 Colors customization
24422 \begin_layout Standard
24423 There are a number of colors in \SpecialChar LyX
24424 that can be customized in
24429 One of the things that bothers people is the \SpecialChar LaTeX
24431 The default color is red, since the chunks uses \SpecialChar LaTeX
24432 font, and there is a lot
24433 of chunks in literate documents, you may get tired of seeing everything
24435 You can change it by going to the tabs
24444 \begin_layout Standard
24445 The next thing is the visible presence of the newline character in the screen.
24446 You can choose the color of this particular character and make it blend
24448 I recommend you choosing a color that is close to the background but not
24449 equal, that way you still can see it is there, but it is not bothering
24453 \begin_layout Subsection
24458 \begin_layout Standard
24467 is documented in the
24471 example file and in the Sweave manual (menu
24473 Help\SpecialChar menuseparator
24479 \begin_layout Chapter
24483 \begin_layout Standard
24484 You can do everything with \SpecialChar LyX
24485 that you can do with \SpecialChar LaTeX
24487 However, \SpecialChar LyX
24488 cannot support every \SpecialChar LaTeX
24490 But you can always use \SpecialChar TeX
24492 This chapter shows you some more special things you might want to use.
24493 For other special things you can do with figures, tables, floats, boxes
24494 and notes, have a look at the
24497 \begin_inset space ~
24505 \begin_layout Section
24506 Multiple Text Columns
24509 \begin_layout Standard
24510 This feature is independent of the option
24512 Two-column document
24514 in the document settings under
24519 If you want to have 2
24520 \begin_inset space ~
24523 columns for the whole document, it is recommended to use the
24525 Two-column document
24528 For all other cases use this feature.
24531 \begin_layout Standard
24532 To use multiple text columns in your document, you have to load the module
24539 Document\SpecialChar menuseparator
24540 Settings\SpecialChar menuseparator
24543 ) and must have the \SpecialChar LaTeX
24551 \begin_layout Standard
24552 Footnotes within multiple columns will be placed at the bottom of the page
24553 and not under each column.
24554 Within the different columns you can use everything, with the limitation
24555 that for floats you need to use the float option
24562 \begin_layout Subsection
24566 \begin_layout Standard
24567 If you want to have 2
24568 \begin_inset space ~
24571 columns in your text, insert a multicolumn inset via the menu
24573 Insert\SpecialChar menuseparator
24575 \begin_inset space ~
24578 Insets\SpecialChar menuseparator
24580 \begin_inset space ~
24585 where the columns should start.
24586 Write all text that should be printed in 2
24587 \begin_inset space ~
24590 columns into this inset.
24593 \begin_layout Standard
24594 Here is an example:
24597 \begin_layout Standard
24599 \begin_inset Flex Multiple Columns
24602 \begin_layout Plain Layout
24607 The Adventure of the Empty House
24610 \begin_inset Newline newline
24613 by Sir Arthur Conan Doyle
24616 \begin_layout Plain Layout
24619 It was in the spring of the year 1894 that all London was interested, and
24620 the fashionable world dismayed, by the murder of the Honourable Ronald
24621 Adair under most unusual and inexplicable circumstances.
24622 The public has already learned those particulars of the crime which came
24623 out in the police investigation, but a good deal was suppressed upon that
24624 occasion, since the case for the prosecution was so overwhelmingly strong
24625 that it was not necessary to bring forward all the facts.
24626 Only now, at the end of nearly ten years, am I allowed to supply those
24627 missing links which make up the whole of that remarkable chain.
24628 The crime was of interest in itself, but that interest was as nothing to
24629 me compared to the inconceivable sequel, which afforded me the greatest
24630 shock and surprise of any event in my adventurous life.
24631 Even now, after this long interval, I find myself thrilling as I think
24632 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24633 ty which utterly submerged my mind.
24634 Let me say to that public, which has shown some interest in those glimpses
24635 which I have occasionally given them of the thoughts and actions of a very
24636 remarkable man, that they are not to blame me if I have not shared my knowledge
24637 with them, for I should have considered it my first duty to do so, had
24638 I not been barred by a positive prohibition from his own lips, which was
24639 only withdrawn upon the third of last month.
24647 \begin_layout Standard
24648 To get 3 or more columns, set the cursor into the multicolumn inset and
24651 Insert\SpecialChar menuseparator
24653 \begin_inset space ~
24657 \begin_inset space ~
24663 The number of the desired columns is written into that inset (for 3
24664 \begin_inset space ~
24668 \begin_inset Quotes eld
24672 \begin_inset Quotes erd
24676 \begin_inset Newline newline
24679 Here is an example with 3
24680 \begin_inset space ~
24686 \begin_layout Standard
24687 \begin_inset Flex Multiple Columns
24690 \begin_layout Plain Layout
24693 \begin_inset Argument 1
24696 \begin_layout Plain Layout
24702 It can be imagined that my close intimacy with Sherlock Holmes had interested
24703 me deeply in crime, and that after his disappearance I never failed to
24704 read with care the various problems which came before the public.
24705 And I even attempted, more than once, for my own private satisfaction,
24706 to employ his methods in their solution, though with indifferent success.
24707 There was none, however, which appealed to me like this tragedy of Ronald
24709 As I read the evidence at the inquest, which led up to a verdict of willful
24710 murder against some person or persons unknown, I realized more clearly
24711 than I had ever done the loss which the community had sustained by the
24712 death of Sherlock Holmes.
24713 There were points about this strange business which would, I was sure,
24714 have specially appealed to him, and the efforts of the police would have
24715 been supplemented, or more probably anticipated, by the trained observation
24716 and the alert mind of the first criminal agent in Europe.
24717 All day, as I drove upon my round, I turned over the case in my mind and
24718 found no explanation which appeared to me to be adequate.
24719 At the risk of telling a twice-told tale, I will recapitulate the facts
24720 as they were known to the public at the conclusion of the inquest.
24728 \begin_layout Standard
24729 You can have up to 10
24730 \begin_inset space ~
24733 columns if you want to, but that might not be very pleasant for the readers
24737 \begin_layout Standard
24738 \begin_inset Newpage newpage
24744 \begin_layout Subsection
24745 Columns inside Columns
24748 \begin_layout Standard
24749 You can also have columns inside columns:
24752 \begin_layout Standard
24753 \begin_inset Flex Multiple Columns
24756 \begin_layout Plain Layout
24759 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24760 at that time governor of one of the Australian colonies.
24761 Adair's mother had returned from Australia to undergo the operation for
24762 cataract, and she, her son Ronald, and her daughter Hilda were living together
24766 \begin_layout Plain Layout
24767 \begin_inset Flex Multiple Columns
24770 \begin_layout Plain Layout
24773 The youth moved in the best society–had, so far as was known, no enemies
24774 and no particular vices.
24775 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24776 had been broken off by mutual consent some months before, and there was
24777 no sign that it had left any very profound feeling behind it.
24778 For the rest {sic} the man's life moved in a narrow and conventional circle,
24779 for his habits were quiet and his nature unemotional.
24780 Yet it was upon this easy-going young aristocrat that death came, in most
24781 strange and unexpected form, between the hours of ten and eleven-twenty
24782 on the night of March 30, 1894.
24790 \begin_layout Plain Layout
24793 Ronald Adair was fond of cards–playing continually, but never for such stakes
24795 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24796 It was shown that, after dinner on the day of his death, he had played
24797 a rubber of whist at the latter club.
24798 He had also played there in the afternoon.
24803 The evidence of those who had played with him– Mr.
24804 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24805 and that there was a fairly equal fall of the cards.
24806 Adair might have lost five pounds, but not more.
24807 His fortune was a considerable one, and such a loss could not in any way
24809 He had played nearly every day at one club or other, but he was a cautious
24810 player, and usually rose a winner.
24811 It came out in evidence that, in partnership with Colonel Moran, he had
24812 actually won as much as four hundred and twenty pounds in a sitting, some
24813 weeks before, from Godfrey Milner and Lord Balmoral.
24814 So much for his recent history as it came out at the inquest.
24822 \begin_layout Subsection
24826 \begin_layout Standard
24827 The examples in this section show some more special features of multiple
24831 \begin_layout Standard
24832 For more features of multiple columns, have a look at the documentation
24833 of the \SpecialChar LaTeX
24839 \begin_inset CommandInset citation
24848 \begin_layout Subsubsection
24852 \begin_layout Standard
24853 To add a preface text for multiple columns, set the cursor into the multicolumn
24854 inset and use the menu
24856 Insert\SpecialChar menuseparator
24860 Write your preface text into that inset.
24861 \begin_inset Newline newline
24864 This is an example with some preface text:
24867 \begin_layout Standard
24868 \begin_inset VSpace bigskip
24874 \begin_layout Standard
24875 \begin_inset Flex Multiple Columns
24878 \begin_layout Plain Layout
24879 \begin_inset Argument 2
24882 \begin_layout Plain Layout
24883 And the story continues and continues and continues and continues\SpecialChar ldots
24891 On the evening of the crime, he returned from the club exactly at ten.
24892 His mother and sister were out spending the evening with a relation.
24893 The servant deposed that she heard him enter the front room on the second
24894 floor, generally used as his sitting-room.
24895 She had lit a fire there, and as it smoked she had opened the window.
24896 No sound was heard from the room until eleven-twenty, the hour of the return
24897 of Lady Maynooth and her daughter.
24898 Desiring to say good-night, she attempted to enter her son's room.
24899 The door was locked on the inside, and no answer could be got to their
24900 cries and knocking.
24901 Help was obtained, and the door forced.
24902 The unfortunate young man was found lying near the table.
24903 His head had been horribly mutilated by an expanding revolver bullet, but
24904 no weapon of any sort was to be found in the room.
24912 \begin_layout Standard
24913 You can also use a section heading as the preface if you use a section command
24914 as \SpecialChar TeX
24916 For example the command
24919 \begin_layout Standard
24924 subsection{subsection title}
24927 \begin_layout Standard
24928 creates a subsection.
24929 In this example the preface is a subsubsection:
24932 \begin_layout Standard
24933 \begin_inset Flex Multiple Columns
24936 \begin_layout Plain Layout
24937 \begin_inset Argument 2
24940 \begin_layout Plain Layout
24944 \begin_layout Plain Layout
24953 This is a subsubsection heading as a preface
24957 \begin_layout Plain Layout
24971 A minute examination of the circumstances served only to make the case more
24973 In the first place, no reason could be given why the young man should have
24974 fastened the door upon the inside.
24975 There was the possibility that the murderer had done this, and had afterwards
24976 escaped by the window.
24977 The drop was at least twenty feet, however, and a bed of crocuses in full
24979 Neither the flowers nor the earth showed any sign of having been disturbed,
24980 nor were there any marks upon the narrow strip of grass which separated
24981 the house from the road.
24982 Apparently, therefore, it was the young man himself who had fastened the
24984 But how did he come by his death? No one could have climbed up to the window
24985 without leaving traces.
24986 Suppose a man had fired through the window, he would indeed be a remarkable
24987 shot who could with a revolver inflict so deadly a wound.
24988 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24989 a hundred yards of the house.
24990 No one had heard a shot.
24998 \begin_layout Standard
24999 If there is less vertical space than 6
25000 \begin_inset space ~
25003 text lines is left on the page at the beginning of the multiple columns,
25004 a page break will be inserted before the multiple columns.
25005 Depending on the number of lines of the preface text, you might want to
25007 This is done by setting the cursor into the mulitcolumn inset behind the
25008 preface (if there is any) and using the menu
25010 Insert\SpecialChar menuseparator
25012 \begin_inset space ~
25016 \begin_inset space ~
25020 \begin_inset space ~
25026 Insert into that inset the amount of space like e.
25027 \begin_inset space \thinspace{}
25031 \begin_inset space \space{}
25035 \begin_inset Quotes eld
25039 \begin_inset Quotes erd
25043 \begin_inset Newline newline
25046 In this example the space is set to 7
25047 \begin_inset space ~
25050 text lines by using
25051 \begin_inset Quotes eld
25057 \begin_inset Quotes erd
25066 needs to be inserted as \SpecialChar TeX
25070 \begin_layout Standard
25071 \begin_inset Flex Multiple Columns
25074 \begin_layout Plain Layout
25075 \begin_inset Argument 3
25078 \begin_layout Plain Layout
25083 \begin_layout Plain Layout
25099 On the evening of the crime, he returned from the club exactly at ten.
25100 His mother and sister were out spending the evening with a relation.
25101 The servant deposed that she heard him enter the front room on the second
25102 floor, generally used as his sitting-room.
25103 She had lit a fire there, and as it smoked she had opened the window.
25104 No sound was heard from the room until eleven-twenty, the hour of the return
25105 of Lady Maynooth and her daughter.
25106 Desiring to say good-night, she attempted to enter her son's room.
25107 The door was locked on the inside, and no answer could be got to their
25108 cries and knocking.
25109 Help was obtained, and the door forced.
25110 The unfortunate young man was found lying near the table.
25111 His head had been horribly mutilated by an expanding revolver bullet, but
25112 no weapon of any sort was to be found in the room.
25120 \begin_layout Subsubsection
25124 \begin_layout Standard
25125 The amount of space before and after multiple columns can be changed by
25126 changing the length
25133 For example the command
25136 \begin_layout Standard
25146 \begin_layout Standard
25147 in \SpecialChar TeX
25148 Code changes its value to 3
25149 \begin_inset space \thinspace{}
25153 The change must be made before the multiple columns' start.
25154 The predefined value is 13
25155 \begin_inset space \thinspace{}
25161 \begin_layout Standard
25169 \begin_inset space \thinspace{}
25175 \begin_layout Standard
25179 \begin_layout Plain Layout
25185 multicolsep}{2.5cm}
25193 \begin_layout Standard
25194 \begin_inset Flex Multiple Columns
25197 \begin_layout Plain Layout
25200 All day I turned these facts over in my mind, endeavouring to hit upon some
25201 theory which could reconcile them all, and to find that line of least resistanc
25202 e which my poor friend had declared to be the starting-point of every investigat
25204 I confess that I made little progress.
25205 In the evening I strolled across the Park, and found myself about six o'clock
25206 at the Oxford Street end of Park Lane.
25207 A group of loafers upon the pavements, all staring up at a particular window,
25208 directed me to the house which I had come to see.
25209 A tall, thin man with coloured glasses, whom I strongly suspected of being
25210 a plain-clothes detective, was pointing out some theory of his own, while
25211 the others crowded round to listen to what he said.
25212 I got as near him as I could, but his observations seemed to me to be absurd,
25213 so I withdrew again in some disgust.
25214 As I did so I struck against an elderly, deformed man, who had been behind
25215 me, and I knocked down several books which he was carrying.
25223 \begin_layout Standard
25224 \begin_inset Note Greyedout
25227 \begin_layout Plain Layout
25232 The values you set with
25238 will be used for all following multiple columns until you change them again.
25246 \begin_layout Standard
25250 \begin_layout Plain Layout
25262 \begin_inset Note Note
25265 \begin_layout Plain Layout
25266 go back to the default
25274 \begin_layout Standard
25275 \begin_inset Newpage newpage
25281 \begin_layout Subsubsection
25285 \begin_layout Standard
25286 A column break can be forced by inserting the command
25292 as \SpecialChar TeX
25294 \change_inserted -712698321 1437633561
25296 \change_deleted -712698321 1437633560
25299 Code to that position in the text where the column should be broken.
25300 Note that this leads in most cases to whitespace in the text.
25301 \begin_inset Newline newline
25304 Here is an example:
25307 \begin_layout Standard
25308 \begin_inset Flex Multiple Columns
25311 \begin_layout Plain Layout
25314 \begin_inset Quotes eld
25317 You're surprised to see me, sir,
25318 \begin_inset Quotes erd
25321 said he, in a strange, croaking voice.
25324 \begin_layout Plain Layout
25327 I acknowledged that I was.
25330 \begin_layout Plain Layout
25333 \begin_inset Quotes eld
25336 Well, I've a conscience, sir, and when I chanced to see you go into this
25337 house, as I came hobbling after you, I thought to myself, I'll just step
25338 in and see that kind gentleman, and tell him that if I was a bit gruff
25339 in my manner there was not any harm meant, and that I am much obliged to
25340 him for picking up my books.
25341 \begin_inset Quotes erd
25347 \begin_layout Plain Layout
25350 \begin_inset Quotes eld
25353 You make too much of a trifle,
25354 \begin_inset Quotes erd
25359 \begin_inset Quotes eld
25362 May I ask how you knew who I was?
25363 \begin_inset Quotes erd
25366 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25370 \begin_layout Plain Layout
25382 \begin_layout Plain Layout
25385 \begin_inset Quotes eld
25388 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25389 you'll find my little bookshop at the corner of Church Street, and very
25390 happy to see you, I am sure.
25391 Maybe you collect yourself, sir.
25395 \begin_inset space ~
25408 –a bargain, every one of them.
25409 With five volumes you could just fill that gap on that second shelf.
25410 It looks untidy, does it not, sir?
25411 \begin_inset Quotes erd
25422 \begin_layout Subsubsection
25426 \begin_layout Standard
25427 The width of the columns is automatically calculated, but you can modify
25428 the space between the columns.
25429 This is done by changing the length
25436 Its predefined value is 10
25437 \begin_inset space \thinspace{}
25441 Here is an example where
25448 \begin_inset space \thinspace{}
25454 \begin_layout Standard
25458 \begin_layout Plain Layout
25472 \begin_layout Standard
25473 \begin_inset Flex Multiple Columns
25476 \begin_layout Plain Layout
25479 My observations of No.
25480 \begin_inset space \space{}
25483 427 Park Lane did little to clear up the problem in which I was interested.
25484 The house was separated from the street by a low wall and railing, the
25485 whole not more than five feet high.
25486 It was perfectly easy, therefore, for anyone to get into the garden, but
25487 the window was entirely inaccessible, since there was no water pipe or
25488 anything which could help the most active man to climb it.
25489 More puzzled than ever, I retraced my steps to Kensington.
25490 I had not been in my study five minutes when the maid entered to say that
25491 a person desired to see me.
25492 To my astonishment it was none other than my strange old book collector,
25493 his sharp, wizened face peering out from a frame of white hair, and his
25494 precious volumes, a dozen of them at least, wedged under his right arm.
25502 \begin_layout Standard
25506 \begin_layout Plain Layout
25518 \begin_inset Note Note
25521 \begin_layout Plain Layout
25522 go back to the default
25530 \begin_layout Subsubsection
25534 \begin_layout Standard
25535 Between the columns a rule with a width of the length
25542 If this rule width is set to 0
25543 \begin_inset space \thinspace{}
25546 pt (this is the default), the rule is suppressed.
25547 In the following example the rule is 2
25548 \begin_inset space \thinspace{}
25554 \begin_layout Standard
25558 \begin_layout Plain Layout
25564 columnseprule}{2pt}
25572 \begin_layout Standard
25573 \begin_inset Flex Multiple Columns
25576 \begin_layout Plain Layout
25579 \begin_inset Quotes eld
25582 You're surprised to see me, sir,
25583 \begin_inset Quotes erd
25586 said he, in a strange, croaking voice.
25589 \begin_layout Plain Layout
25592 I acknowledged that I was.
25595 \begin_layout Plain Layout
25598 \begin_inset Quotes eld
25601 Well, I've a conscience, sir, and when I chanced to see you go into this
25602 house, as I came hobbling after you, I thought to myself, I'll just step
25603 in and see that kind gentleman, and tell him that if I was a bit gruff
25604 in my manner there was not any harm meant, and that I am much obliged to
25605 him for picking up my books.
25606 \begin_inset Quotes erd
25612 \begin_layout Plain Layout
25615 \begin_inset Quotes eld
25618 You make too much of a trifle,
25619 \begin_inset Quotes erd
25624 \begin_inset Quotes eld
25627 May I ask how you knew who I was?
25628 \begin_inset Quotes erd
25634 \begin_layout Plain Layout
25637 \begin_inset Quotes eld
25640 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25641 you'll find my little bookshop at the corner of Church Street, and very
25642 happy to see you, I am sure.
25643 Maybe you collect yourself, sir.
25647 \begin_inset space ~
25660 –a bargain, every one of them.
25661 With five volumes you could just fill that gap on that second shelf.
25662 It looks untidy, does it not, sir?
25663 \begin_inset Quotes erd
25674 \begin_layout Standard
25675 \begin_inset VSpace defskip
25681 \begin_layout Standard
25682 The rule can be colored by redefining the command
25689 This is done by inserting the command
25690 \begin_inset Newline newline
25699 columnseprulecolor}{
25704 \begin_inset Newline newline
25707 as \SpecialChar TeX
25709 \change_inserted -712698321 1437633567
25711 \change_deleted -712698321 1437633567
25714 Code before the multicolumn inset.
25719 in this command by a color of your choice.
25720 You can use all pre- and self-defined colors.
25728 \begin_inset space ~
25733 for more information about pre- and self-defined colors.
25734 To go back to the default color insert the command
25735 \begin_inset Newline newline
25744 columnseprulecolor}{
25749 \begin_inset Newline newline
25752 Here is the example with a cyan rule and 1
25753 \begin_inset space \thinspace{}
25756 cm column separation:
25759 \begin_layout Standard
25763 \begin_layout Plain Layout
25772 \begin_layout Plain Layout
25778 columnseprulecolor}{
25788 \begin_layout Standard
25789 \begin_inset Flex Multiple Columns
25792 \begin_layout Plain Layout
25795 \begin_inset Quotes eld
25798 You're surprised to see me, sir,
25799 \begin_inset Quotes erd
25802 said he, in a strange, croaking voice.
25805 \begin_layout Plain Layout
25808 I acknowledged that I was.
25811 \begin_layout Plain Layout
25814 \begin_inset Quotes eld
25817 Well, I've a conscience, sir, and when I chanced to see you go into this
25818 house, as I came hobbling after you, I thought to myself, I'll just step
25819 in and see that kind gentleman, and tell him that if I was a bit gruff
25820 in my manner there was not any harm meant, and that I am much obliged to
25821 him for picking up my books.
25822 \begin_inset Quotes erd
25828 \begin_layout Plain Layout
25831 \begin_inset Quotes eld
25834 You make too much of a trifle,
25835 \begin_inset Quotes erd
25840 \begin_inset Quotes eld
25843 May I ask how you knew who I was?
25844 \begin_inset Quotes erd
25850 \begin_layout Plain Layout
25853 \begin_inset Quotes eld
25856 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25857 you'll find my little bookshop at the corner of Church Street, and very
25858 happy to see you, I am sure.
25859 Maybe you collect yourself, sir.
25863 \begin_inset space ~
25876 –a bargain, every one of them.
25877 With five volumes you could just fill that gap on that second shelf.
25878 It looks untidy, does it not, sir?
25879 \begin_inset Quotes erd
25890 \begin_layout Standard
25894 \begin_layout Plain Layout
25900 columnseprule}{0pt}
25903 \begin_layout Plain Layout
25909 columnseprulecolor}{
25917 \begin_inset Note Note
25920 \begin_layout Plain Layout
25921 go back to the default
25929 \begin_layout Section
25930 Non-standard Paragraph Shapes
25933 \begin_layout Standard
25936 as well as any other text processor uses by default rectangular paragraphs.
25937 For special cases like for example posters, invitation cards or poems you
25938 can modify the paragraph shape to one of your choice.
25939 This can be done by using the \SpecialChar LaTeX
25944 which is loaded by using in the document settings the module
25946 Custom paragraph shapes
25951 \begin_layout Subsection
25955 \begin_layout Standard
25960 provides the following shapes:
25963 \begin_layout Standard
25964 \begin_inset Tabular
25965 <lyxtabular version="3" rows="13" columns="3">
25966 <features booktabs="true" islongtable="true" longtabularalignment="center">
25967 <column alignment="center" valignment="middle" width="16col%">
25968 <column alignment="center" valignment="middle" width="40col%">
25969 <column alignment="center" valignment="middle" width="35col%">
25970 <row endhead="true">
25971 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25974 \begin_layout Plain Layout
25980 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25983 \begin_layout Plain Layout
25989 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25992 \begin_layout Plain Layout
26000 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26003 \begin_layout Plain Layout
26009 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26012 \begin_layout Plain Layout
26013 Circle with circular hole (in the size of a CD/DVD)
26018 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26021 \begin_layout Plain Layout
26022 Cannot be scaled, take care there is not too much text
26029 <cell alignment="center" valignment="top" topline="true" usebox="none">
26032 \begin_layout Plain Layout
26038 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26041 \begin_layout Plain Layout
26047 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26050 \begin_layout Plain Layout
26051 Fragile, calculation might fail
26058 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26061 \begin_layout Plain Layout
26067 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26070 \begin_layout Plain Layout
26071 Rhomboid (symbolizing a
26072 \begin_inset Quotes eld
26076 \begin_inset Quotes erd
26084 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26087 \begin_layout Plain Layout
26095 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26098 \begin_layout Plain Layout
26104 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26107 \begin_layout Plain Layout
26113 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26116 \begin_layout Plain Layout
26124 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26127 \begin_layout Plain Layout
26133 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26136 \begin_layout Plain Layout
26142 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26145 \begin_layout Plain Layout
26153 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26156 \begin_layout Plain Layout
26162 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26165 \begin_layout Plain Layout
26166 Nut for bolt (hexagon with circular hole)
26171 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26174 \begin_layout Plain Layout
26182 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26185 \begin_layout Plain Layout
26191 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26194 \begin_layout Plain Layout
26200 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26203 \begin_layout Plain Layout
26211 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26214 \begin_layout Plain Layout
26220 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26223 \begin_layout Plain Layout
26229 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26232 \begin_layout Plain Layout
26240 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26243 \begin_layout Plain Layout
26249 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26252 \begin_layout Plain Layout
26258 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26261 \begin_layout Plain Layout
26269 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26272 \begin_layout Plain Layout
26278 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26281 \begin_layout Plain Layout
26282 Normal/reversed rain drop
26287 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26290 \begin_layout Plain Layout
26291 Fragile, calculation might fail
26298 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26301 \begin_layout Plain Layout
26308 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26311 \begin_layout Plain Layout
26312 The \SpecialChar TeX
26318 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26321 \begin_layout Plain Layout
26329 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26332 \begin_layout Plain Layout
26334 \begin_inset Newline newline
26342 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26345 \begin_layout Plain Layout
26346 Triangles in different orientations
26351 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26354 \begin_layout Plain Layout
26368 \begin_layout Standard
26369 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26371 for environments in the toolbar.
26374 \begin_layout Standard
26375 \begin_inset Newpage newpage
26381 \begin_layout Standard
26382 Here is an example paragraph in the shape of a nut:
26385 \begin_layout Standard
26386 \begin_inset VSpace bigskip
26395 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26396 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26398 At vero eos et accusam et justo duo dolores et ea rebum.
26399 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26401 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26402 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26406 \begin_layout Standard
26407 \begin_inset VSpace bigskip
26413 \begin_layout Standard
26414 \begin_inset Note Greyedout
26417 \begin_layout Plain Layout
26422 : shapepar paragraphs cannot run over a page break.
26430 \begin_layout Standard
26431 \begin_inset VSpace bigskip
26437 \begin_layout Standard
26442 takes care that the shape will always be preserved, no matter how much
26443 text is in the paragraph.
26444 Therefore the paragraph size changes with the amount of contained text.
26445 This can lead to paragraph sizes exceeding the page margins.
26446 To demonstrate the size scaling, here is the same example paragraph but
26447 with twice as much text:
26450 \begin_layout Standard
26451 \begin_inset Newpage newpage
26460 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26461 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26463 At vero eos et accusam et justo duo dolores et ea rebum.
26464 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26466 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26467 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26469 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26470 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26472 At vero eos et accusam et justo duo dolores et ea rebum.
26473 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26475 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26476 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26480 \begin_layout Standard
26481 \begin_inset VSpace bigskip
26487 \begin_layout Standard
26488 An exception is the shape
26493 It cannot be scaled because it must fit the size of a CD/DVD.
26494 Therefore the amount of text that fits into the shape is limited.
26495 \begin_inset Newline newline
26506 shape are fragile, meaning that the calculation of their size can fail,
26507 depending on the amount of text.
26508 You will then get the \SpecialChar LaTeX
26510 \begin_inset Quotes eld
26513 Arithmetic overflow
26514 \begin_inset Quotes erd
26518 In this case one can try to remove or add some text; if nothing works one
26519 has to use another shape.
26522 \begin_layout Standard
26523 \begin_inset VSpace bigskip
26529 \begin_layout Standard
26530 For shapes with tips you will maybe see that \SpecialChar LaTeX
26531 's hyphenation routine fails
26532 for text in the tips.
26533 Therefore it is often necessary to add hyphenation points
26538 arg "specialchar-insert hyphenation"
26543 ) to the corresponding text parts.
26546 \begin_layout Standard
26547 \begin_inset VSpace bigskip
26553 \begin_layout Standard
26554 Shapepar paragraphs are either always centered or placed on the page so
26555 that their left border touches the left page margin.
26556 You can therefore not use the paragraph dialog to align such paragraphs.
26557 A solution is to put the paragraph into a minipage or parbox and align
26559 The problem is hereby to find the right width for the box.
26560 Because if it is too wide and you center the box, the paragraph is not
26561 centered too because it sticks at the left side of the box.
26562 So you might have to play a bit with the width until it fits.
26563 Here are two heart-shaped paragraphs, the first one is not aligned, the
26564 second one is right-aligned:
26567 \begin_layout Standard
26568 \begin_inset Newpage newpage
26574 \begin_layout Heart
26578 Lo\SpecialChar softhyphen
26579 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26580 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26582 At vero eos et accusam et justo duo dolores et ea rebum.
26583 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26587 \begin_layout Standard
26588 \begin_inset VSpace bigskip
26594 \begin_layout Standard
26597 \begin_inset Box Frameless
26607 height_special "totalheight"
26612 backgroundcolor "none"
26615 \begin_layout Heart
26619 Lo\SpecialChar softhyphen
26620 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26621 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26623 At vero eos et accusam et justo duo dolores et ea rebum.
26624 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26633 \begin_layout Subsection
26637 \begin_layout Standard
26638 You can define any shape you want.
26639 Doing this manually is a lot of work because every coordinate must be specified.
26640 But there is a way to let the computer calculate the coordinates:
26643 \begin_layout Enumerate
26644 Install the program
26645 \begin_inset CommandInset href
26648 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26655 \begin_layout Enumerate
26661 \change_deleted -712698321 1437633577
26668 \begin_layout Plain Layout
26676 \change_inserted -712698321 1437633577
26680 \change_deleted -712698321 1437633578
26685 \begin_layout Plain Layout
26693 \change_inserted -712698321 1437633578
26696 \SpecialChar menuseparator
26697 Settings\SpecialChar menuseparator
26700 and select the font size you are using in your document.
26701 For example this document uses the size 12
26702 \begin_inset space \thinspace{}
26708 \begin_layout Enumerate
26712 \begin_layout Enumerate
26714 \change_deleted -712698321 1437633580
26721 \begin_layout Plain Layout
26729 \change_inserted -712698321 1437633580
26733 \change_deleted -712698321 1437633581
26738 \begin_layout Plain Layout
26746 \change_inserted -712698321 1437633581
26749 \SpecialChar menuseparator
26752 to export the shape to coordinates.
26753 In the appearing dialog use either the outline of your shape for the coordinate
26754 s or the path itself.
26758 \begin_layout Plain Layout
26759 For more information see
26760 \begin_inset CommandInset href
26762 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26774 \begin_layout Standard
26775 The coordinates are written into a \SpecialChar TeX
26777 \change_inserted -712698321 1437633584
26779 \change_deleted -712698321 1437633584
26783 To use it for your \SpecialChar LyX
26787 \begin_layout Enumerate
26788 Place the cursor before the first character of your paragraph (or into a
26792 \begin_layout Enumerate
26793 Open in \SpecialChar LyX
26796 Insert\SpecialChar menuseparator
26797 File\SpecialChar menuseparator
26799 \begin_inset space ~
26804 , select the file and use
26813 \begin_layout Standard
26814 \begin_inset VSpace defskip
26820 \begin_layout Standard
26821 \begin_inset Note Greyedout
26824 \begin_layout Plain Layout
26829 : The changed shape only applies to the current paragraph; everything is
26830 reset to normal for the next paragraph.
26831 Therefore the shape definition file must be input into every paragraph
26832 with the desired shape.
26840 \begin_layout Standard
26841 \begin_inset VSpace bigskip
26847 \begin_layout Standard
26848 Here is an example:
26851 \begin_layout Standard
26852 \begin_inset VSpace bigskip
26858 \begin_layout Standard
26859 \begin_inset CommandInset include
26861 filename "SpecialParagraphShape.tex"
26867 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26868 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26870 At vero eos et accusam et justo duo dolores et ea rebum.
26871 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26873 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26874 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26878 \begin_layout Standard
26879 \begin_inset VSpace bigskip
26885 \begin_layout Standard
26890 to draw complexer shapes in
26894 you can draw the shape in a program of your choice and import the resulting
26900 Then you only need to draw a line or spline along the outline of the image.
26903 \begin_layout Standard
26904 \begin_inset VSpace bigskip
26910 \begin_layout Standard
26913 Custom paragraph shapes
26915 also provides the two commands
26923 which can be used to define custom shapes coordinate by coordinate.
26927 \begin_layout Plain Layout
26928 These commands are internally used for all shapes described here.
26933 For information how these styles are used and about further customization
26934 possibilities, have a look at the documentation of the package
26939 \begin_inset CommandInset citation
26948 \begin_layout Bibliography
26949 \begin_inset CommandInset bibitem
26950 LatexCommand bibitem
26955 Documentation of the \SpecialChar LaTeX
26957 \begin_inset CommandInset href
26960 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26967 \begin_layout Bibliography
26968 \begin_inset CommandInset bibitem
26969 LatexCommand bibitem
26974 Documentation of the \SpecialChar LaTeX
26976 \begin_inset CommandInset href
26979 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"