1 #LyX 2.3 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
40 \maintain_unincluded_children false
42 \language_package default
45 \font_roman "lmodern" "default"
46 \font_sans "lmss" "default"
47 \font_typewriter "lmtt" "default"
48 \font_math "auto" "auto"
49 \font_default_family default
50 \use_non_tex_fonts false
53 \font_sf_scale 100 100
54 \font_tt_scale 100 100
56 \use_dash_ligatures true
58 \default_output_format pdf2
60 \bibtex_command default
61 \index_command default
65 \pdf_title "LyX's Additional Features manual"
66 \pdf_author "LyX Team"
67 \pdf_subject "LyX's additional features documentation"
68 \pdf_keywords "LyX, Documentation, Additional"
70 \pdf_bookmarksnumbered true
71 \pdf_bookmarksopen false
72 \pdf_bookmarksopenlevel 1
77 \pdf_pdfusetitle false
78 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
81 \use_package amsmath 1
82 \use_package amssymb 1
85 \use_package mathdots 1
86 \use_package mathtools 0
88 \use_package stackrel 0
89 \use_package stmaryrd 0
90 \use_package undertilde 0
92 \cite_engine_type default
96 \paperorientation portrait
101 \notefontcolor #0000ff
108 \paragraph_separation indent
109 \paragraph_indentation default
111 \math_indentation default
112 \math_numbering_side default
113 \quotes_style english
117 \paperpagestyle headings
118 \tracking_changes true
119 \output_changes false
128 Additional \SpecialChar LyX
132 \begin_layout Subtitle
137 by the \SpecialChar LyX
142 \begin_layout Plain Layout
144 Principal maintainer of this file is
149 If you have comments or error corrections, please send them to the \SpecialChar LyX
152 \begin_inset Flex Code
155 \begin_layout Plain Layout
157 <lyx-docs@lists.lyx.org>
170 \begin_layout Standard
171 \begin_inset CommandInset toc
172 LatexCommand tableofcontents
179 \begin_layout Chapter
183 \begin_layout Standard
184 This manual is essentially Part II of the
186 User's Guide\SpecialChar endofsentence
189 The reason for separating the two documents is simple: the
193 is already quite lengthy, and it contains information on all of the basic
194 features one needs to know in order to prepare most documents.
195 However, the \SpecialChar LyX
196 Team has worked to make \SpecialChar LyX
197 extensible through various configuration
198 files and external packages.
199 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
201 create a layout file (or module) for it without having to alter \SpecialChar LyX
203 We've already had contributions of several new features this way, and some
204 of them are documented here.
205 There are also some more `advanced' features, such as how to control the
206 presentation of bibliographies and how to work with multi-part documents,
207 that are not covered in the
211 and are discussed here.
214 \begin_layout Standard
215 This manual also documents some special features, like fax support, version
216 control, and SGML support, which require additional software to work properly.
217 There is also a chapter on \SpecialChar LyX
219 And lastly, there's a chapter of \SpecialChar LaTeX
220 tools and tips, things you can use to
221 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
223 After all, \SpecialChar LyX
228 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
232 \begin_layout Standard
233 If you haven't read the
237 yet, you are definitely in the wrong manual.
242 is the first place to go, since it describes the notation and format of
244 You should also be thoroughly familiar with the
248 and all of the basic features of \SpecialChar LyX
249 before attempting to read this one.
252 \begin_layout Standard
253 Since many of the topics in this manual depend heavily on \SpecialChar LyX
255 with \SpecialChar LaTeX
256 , this first chapter covers the inner workings of \SpecialChar LyX
259 to generate exactly the \SpecialChar LaTeX
261 It is obviously for more seasoned \SpecialChar LyX
265 \begin_layout Chapter
267 and \SpecialChar LaTeX
271 \begin_layout Section
273 Uses \SpecialChar LaTeX
277 \begin_layout Standard
278 This chapter is for both \SpecialChar TeX
279 -nicians and the \SpecialChar LaTeX
281 In it, we'll explain how \SpecialChar LyX
282 and \SpecialChar LaTeX
283 work together to produce printable output.
284 This is the only place in any of the manuals where we assume you know something
285 about \SpecialChar LaTeX
289 \begin_layout Standard
290 At one time, \SpecialChar LyX
292 \begin_inset Quotes eld
295 WYSIWYM frontend to \SpecialChar LaTeX
297 \begin_inset Quotes erd
300 but that's no longer true.
301 There are frontends to \SpecialChar LaTeX
306 \begin_layout Plain Layout
307 Some familar ones are \SpecialChar TeX
308 maker and kile, on Linux, and \SpecialChar TeX
310 There are also the \SpecialChar LaTeX
311 modes for vi and emacs, of course.
316 These are basically text editors with the ability to run \SpecialChar LaTeX
318 errors in the file you're editing.
319 Although \SpecialChar LyX
328 run \SpecialChar LaTeX
329 , and it also indicates errors in the file, it also does much, much
331 For one thing, you don't need to know \SpecialChar LaTeX
332 to use \SpecialChar LyX
335 has added its own extensions to \SpecialChar LaTeX
337 Try the following sometime: select
338 \begin_inset Flex Noun
341 \begin_layout Plain Layout
342 Export\SpecialChar menuseparator
349 \begin_inset Flex Noun
352 \begin_layout Plain Layout
359 \begin_inset Flex Noun
362 \begin_layout Plain Layout
363 View\SpecialChar menuseparator
373 ), then look at the preamble of the resulting
374 \begin_inset Flex Code
377 \begin_layout Plain Layout
384 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
386 These macros are defined automatically, according to the features you use
390 \begin_layout Standard
391 There are several commands that automatically invoke \SpecialChar LaTeX
396 \begin_layout Itemize
397 \begin_inset Flex Noun
400 \begin_layout Plain Layout
401 Document\SpecialChar menuseparator
410 \begin_layout Itemize
411 \begin_inset Flex Noun
414 \begin_layout Plain Layout
415 Document\SpecialChar menuseparator
424 \begin_layout Standard
425 They will only invoke \SpecialChar LaTeX
426 if the file has changed since the last time \SpecialChar LaTeX
432 \begin_layout Standard
433 When \SpecialChar LyX
434 runs \SpecialChar LaTeX
435 on the file you're editing, it performs these steps:
438 \begin_layout Enumerate
439 Convert the document to \SpecialChar LaTeX
440 and save to a file with the extension
441 \begin_inset Flex Code
444 \begin_layout Plain Layout
451 \begin_inset Flex Code
454 \begin_layout Plain Layout
463 \begin_layout Enumerate
464 Run \SpecialChar LaTeX
466 \begin_inset Flex Code
469 \begin_layout Plain Layout
475 file (maybe several times), and run any other commands (such as
476 \begin_inset Flex Code
479 \begin_layout Plain Layout
486 \begin_inset Flex Code
489 \begin_layout Plain Layout
495 ) needed to compile the \SpecialChar LaTeX
499 \begin_layout Enumerate
500 If there are any errors, show the error log.
503 \begin_layout Standard
504 If you have run \SpecialChar LaTeX
506 \begin_inset Flex Noun
509 \begin_layout Plain Layout
510 View\SpecialChar menuseparator
517 then runs a DVI viewer to display the DVI-file.
519 \begin_inset Flex Noun
522 \begin_layout Plain Layout
523 View\SpecialChar menuseparator
530 performs further steps:
533 \begin_layout Itemize
535 \begin_inset Flex Code
538 \begin_layout Plain Layout
544 to convert the DVI file to PostScript.
547 \begin_layout Itemize
548 Run a PostScript viewer, such as
549 \begin_inset Flex Code
552 \begin_layout Plain Layout
558 , to display the PostScript file.
561 \begin_layout Standard
563 does similar things when viewing, or exporting, other formats.
566 \begin_layout Section
567 Translating \SpecialChar LaTeX
568 files into \SpecialChar LyX
572 \begin_layout Standard
573 You can import a \SpecialChar LaTeX
574 file into \SpecialChar LyX
576 \begin_inset Flex Noun
579 \begin_layout Plain Layout
580 File\SpecialChar menuseparator
581 Import\SpecialChar menuseparator
587 command in \SpecialChar LyX
589 This will call a program named
590 \begin_inset Flex Code
593 \begin_layout Plain Layout
599 which will create a file
600 \begin_inset Flex Code
603 \begin_layout Plain Layout
610 \begin_inset Flex Code
613 \begin_layout Plain Layout
621 will then open that file.
625 \begin_layout Plain Layout
626 \begin_inset Flex Code
629 \begin_layout Plain Layout
635 can also be run from the command line, of course.
643 \begin_layout Standard
644 \begin_inset Flex Code
647 \begin_layout Plain Layout
653 will translate most legal \SpecialChar LaTeX
654 , but not everything.
655 It will put things it doesn't understand into \SpecialChar TeX
656 code, so after translating
658 \begin_inset Flex Code
661 \begin_layout Plain Layout
667 , you can look for \SpecialChar TeX
668 code and hand-edit it until it looks right.
671 \begin_layout Standard
672 If you don't know what \SpecialChar TeX
673 code is, read the next section.
676 \begin_layout Section
677 \begin_inset CommandInset label
679 name "sec:Inserting-TeX-Code"
683 Inserting \SpecialChar TeX
684 Code into \SpecialChar LyX
688 \begin_layout Standard
689 Anything you can do in \SpecialChar LaTeX
690 you can do in \SpecialChar LyX
691 , for a very simple reason: You can
692 always insert \SpecialChar TeX
693 code into any \SpecialChar LyX
696 cannot, and will never be able to, display every possible \SpecialChar LaTeX
698 If ever you need to insert \SpecialChar LaTeX
699 commands into your \SpecialChar LyX
700 document, you can use the
702 \begin_inset Flex Code
705 \begin_layout Plain Layout
712 box, which you can insert into your document with
713 \begin_inset Flex Noun
716 \begin_layout Plain Layout
717 Insert\SpecialChar menuseparator
727 or the keyboard shortcut
736 \begin_layout Standard
737 Here's an example of inserting \SpecialChar LaTeX
738 commands in a \SpecialChar LyX
740 The code looks like this:
743 \begin_layout LyX-Code
747 \begin_inset Newline newline
753 \begin_inset Newline newline
756 This is an example of a minipage environment.
758 \begin_inset Newline newline
761 can put nearly everything in it, even (non-floating)
762 \begin_inset Newline newline
767 \begin_inset Newline newline
773 \begin_inset Newline newline
777 \begin_inset Newline newline
783 \begin_inset Newline newline
789 \begin_inset Newline newline
795 \begin_inset Newline newline
800 \begin_inset Newline newline
806 \begin_inset Newline newline
812 \begin_inset Newline newline
818 \begin_inset Newline newline
826 \begin_layout LyX-Code
830 \begin_layout Standard
832 \begin_inset Flex Code
835 \begin_layout Plain Layout
842 box containing this text is directly after this paragraph.
843 Those of you reading the manual in \SpecialChar LyX
844 will only see the \SpecialChar TeX
846 Those reading a printed version of the manuals will see the actual results:
847 \begin_inset VSpace bigskip
853 \begin_layout Standard
857 \begin_layout Plain Layout
864 \begin_layout Plain Layout
871 \begin_layout Plain Layout
873 This is an example of a minipage environment.
874 You can put nearly everything in it, even (non-floating) figures and tables.
878 \begin_layout Plain Layout
885 \begin_layout Plain Layout
890 \begin_layout Plain Layout
897 \begin_layout Plain Layout
904 \begin_layout Plain Layout
911 \begin_layout Plain Layout
917 \begin_layout Plain Layout
924 \begin_layout Plain Layout
931 \begin_layout Plain Layout
938 \begin_layout Plain Layout
948 \begin_inset VSpace bigskip
954 \begin_layout Standard
955 In addition to using \SpecialChar TeX
956 code, you can also create a separate file containing
957 some complex \SpecialChar LaTeX
958 structure and then use
959 \begin_inset Flex Noun
962 \begin_layout Plain Layout
963 Insert\SpecialChar menuseparator
973 to include your file (you should select the type
974 \begin_inset Flex Code
977 \begin_layout Plain Layout
984 We recommend that you only do this if you have a
985 \begin_inset Flex Code
988 \begin_layout Plain Layout
999 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1003 \begin_layout Standard
1004 There are a few last points to emphasize:
1007 \begin_layout Itemize
1013 check if your \SpecialChar LaTeX
1017 \begin_layout Itemize
1018 Beware of reinventing the wheel.
1021 \begin_layout Standard
1022 On that last point, \SpecialChar LyX
1023 does have quite a few features tucked into it, and
1025 Be sure to check the manuals to make sure that \SpecialChar LyX
1026 doesn't have such-and-such
1027 feature before you decide you have to do it by hand.
1028 Moreover, there are numerous \SpecialChar LaTeX
1029 packages out there to do all sorts of things,
1030 from labels to envelopes to fancy multipage tables.
1032 \begin_inset CommandInset href
1035 target "http://www.ctan.org/"
1043 \begin_layout Standard
1044 If you do need to do some wild and fancy things within your document, be
1045 sure to check out a good \SpecialChar LaTeX
1046 book for assistance.
1047 There are a number of them listed in the bibliography of the
1054 \begin_layout Section
1056 and the \SpecialChar LaTeX
1060 \begin_layout Subsection
1061 About the \SpecialChar LaTeX
1065 \begin_layout Standard
1066 If you already know \SpecialChar LaTeX
1067 , there is no need to explain here what the preamble
1069 If you don't, the following will give you some ideas—we recommend again
1070 that you consult a \SpecialChar LaTeX
1071 book for further information.
1072 In any case, you should read the points below, because they explain what
1073 you can do and what you don't need to do in the \SpecialChar LaTeX
1074 preamble of a \SpecialChar LyX
1078 \begin_layout Standard
1079 The \SpecialChar LaTeX
1080 preamble comes at the very beginning of a document,
1088 \begin_layout Itemize
1089 Declare the document class.
1091 \begin_inset Newline newline
1095 already does this for you.
1096 If you're a seasoned \SpecialChar LaTeX
1097 -nician, and you have a custom document class you
1098 want to use, check out the
1100 Customization Manual
1102 for information on how to make \SpecialChar LyX
1106 \begin_layout Itemize
1107 Declare the usage of packages.
1109 \begin_inset Newline newline
1113 packages provide special commands, which are only available within a document
1114 when the package has been declared in the preamble.
1115 In addition to providing special commands, the inclusion of a package can
1116 change the document.
1117 For example, the package
1118 \begin_inset Flex Code
1121 \begin_layout Plain Layout
1127 forces all paragraphs to be indented.
1128 There are other packages for labels, envelopes, margins, etc.
1132 \begin_layout Itemize
1133 Set counters, variables, lengths and widths.
1135 \begin_inset Newline newline
1138 There are several \SpecialChar LaTeX
1139 counters and variables that
1143 be set globally from within the preamble in order to have the desired effect.
1144 (There are variables that you can set and reset inside the document, too.)
1145 Margins are a good example of something that must be set in the preamble.
1146 Another example is the label format for lists.
1147 You can actually set these just about anywhere, but it's best to do it
1148 just once, inside the preamble.
1151 \begin_layout Itemize
1152 Declare user defined commands (with
1153 \begin_inset Flex Code
1156 \begin_layout Plain Layout
1165 \begin_inset Flex Code
1168 \begin_layout Plain Layout
1177 \begin_inset Newline newline
1180 These are abbreviations for \SpecialChar LaTeX
1181 commands which appear very often inside a document.
1182 Although the preamble is a good place to declare such commands, they
1186 be declared anywhere (before they are used for the first time, of course).
1187 This can be useful if there is a lot of raw \SpecialChar LaTeX
1188 code in your document, which
1189 normally should not be the case.
1192 \begin_layout Standard
1194 adds its own set of definitions to the preamble of the
1195 \begin_inset Flex Code
1198 \begin_layout Plain Layout
1205 This makes \SpecialChar LaTeX
1206 files generated by \SpecialChar LyX
1210 \begin_layout Subsection
1211 Changing the Preamble
1214 \begin_layout Standard
1215 The commands which \SpecialChar LyX
1216 adds to the preamble of a \SpecialChar LaTeX
1217 file are fixed; you can't
1218 change them without patching \SpecialChar LyX
1220 You can, however, add your own stuff to the preamble by selecting
1221 \begin_inset Flex Noun
1224 \begin_layout Plain Layout
1227 \begin_inset space ~
1236 \begin_inset Flex Noun
1239 \begin_layout Plain Layout
1240 Document\SpecialChar menuseparator
1248 adds anything in the
1249 \begin_inset Flex Noun
1252 \begin_layout Plain Layout
1258 dialog to its own built-in preamble.
1259 Before adding your own declarations in the preamble, you should make sure
1260 that \SpecialChar LyX
1261 doesn't already support what you want to do.
1262 (Remember what we said about reinventing the wheel?) Also,
1264 make sure your preamble code is correct
1268 doesn't check it for you.
1269 If there is an error, you're likely to get an error like
1270 \begin_inset Quotes eld
1274 \begin_inset Flex Code
1277 \begin_layout Plain Layout
1286 \begin_inset Quotes erd
1290 If you see this error, check your preamble.
1293 \begin_layout Subsection
1297 \begin_layout Standard
1298 Here are some examples of what you can add to a preamble, and what they
1302 \begin_layout Subsubsection
1306 \begin_layout Standard
1307 There are two variables under \SpecialChar LaTeX
1308 that control page position:
1309 \begin_inset Flex Code
1312 \begin_layout Plain Layout
1321 \begin_inset Flex Code
1324 \begin_layout Plain Layout
1333 Their names should be self-explanatory.
1334 These variables are useful if you think for a moment about computer labels.
1335 Sometimes, the size of a print medium and the area of the medium that you
1336 can actually print on aren't the same.
1338 \begin_inset Flex Code
1341 \begin_layout Plain Layout
1350 \begin_inset Flex Code
1353 \begin_layout Plain Layout
1364 \begin_layout Standard
1365 The default values for
1366 \begin_inset Flex Code
1369 \begin_layout Plain Layout
1378 \begin_inset Flex Code
1381 \begin_layout Plain Layout
1390 \begin_inset space \thinspace{}
1394 \begin_inset space \thinspace{}
1398 \begin_inset space \space{}
1401 the page isn't shifted.
1402 Unfortunately, some DVI drivers always seem to shift the page.
1403 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1404 If you're using \SpecialChar LyX
1405 on a system that you don't personally maintain, and your
1406 sysadmin is a doofus,
1407 \begin_inset Flex Code
1410 \begin_layout Plain Layout
1419 \begin_inset Flex Code
1422 \begin_layout Plain Layout
1431 Suppose your left and top margins are always 0.5
1432 \begin_inset space \thinspace{}
1436 You can add this to the preamble:
1439 \begin_layout LyX-Code
1447 \begin_layout LyX-Code
1455 \begin_layout Standard
1456 and your margins should now be correct.
1459 \begin_layout Subsubsection
1463 \begin_layout Standard
1464 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1465 There's a rather nice package, available at your nearest CTAN archive,
1466 for printing sheets of labels:
1467 \begin_inset Flex Code
1470 \begin_layout Plain Layout
1477 Now, your system may not have this package installed by default.
1478 We leave that up to you to check.
1479 You'll also want to read the documentation for it; we're not going to do
1481 Since this is an example, however, we'll give you an example of how you
1485 \begin_layout Standard
1486 First, make sure you're using the
1487 \begin_inset Flex Code
1490 \begin_layout Plain Layout
1497 Next, you need to put the following in your preamble:
1500 \begin_layout LyX-Code
1506 \begin_layout LyX-Code
1512 \begin_layout LyX-Code
1518 \begin_layout LyX-Code
1524 \begin_layout LyX-Code
1530 \begin_layout LyX-Code
1536 \begin_layout LyX-Code
1542 \begin_layout Standard
1543 This sets things up for Avery label sheets, stock #5360.
1544 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1547 \begin_inset Flex Code
1550 \begin_layout Plain Layout
1559 \begin_inset Flex Code
1562 \begin_layout Plain Layout
1570 around each label text.
1571 This and other special features of
1572 \begin_inset Flex Code
1575 \begin_layout Plain Layout
1581 are explained in its documentation.
1584 \begin_layout Standard
1585 Someday, someone may write a \SpecialChar LyX
1586 layout file to support this package directly.
1587 Maybe that someone is you.
1590 \begin_layout Subsubsection
1591 Example #3: Paragraph Indentation
1594 \begin_layout Standard
1595 Americans are trained to indent the first line of
1600 As with all of their other weird quirks, most Americans will whine and
1601 moan until they can have their way and indent the first line of all paragraphs.
1610 \begin_layout Standard
1611 Of course, this behavior isn't standard typography.
1612 In books, you typically only indent the first line of a paragraph
1616 it follows another one.
1617 The idea behind indenting the first line of a paragraph is to distinguish
1618 neighboring paragraphs from one another.
1619 If there is no previous paragraph—for example, if it follows a figure or
1620 is the first paragraph in a section—then there is no need for indentation.
1624 \begin_layout Standard
1625 If you're a typical American (we're still joking!), though, you don't care
1626 about such esoteric things; you want your indentation! Add this to the
1630 \begin_layout LyX-Code
1633 usepackage{indentfirst}
1636 \begin_layout Standard
1637 If your \SpecialChar TeX
1638 distribution isn't braindead, you'll have this package, and all
1639 of your paragraphs will get the indentation the Founding Fathers intended
1643 \begin_layout Subsubsection
1644 Example #4: This Document
1647 \begin_layout Standard
1648 You can also check out the preamble of this document to get an idea of some
1649 of the advanced things you can do.
1652 \begin_layout Section
1654 and \SpecialChar LaTeX
1658 \begin_layout Standard
1659 When \SpecialChar LyX
1660 calls \SpecialChar LaTeX
1661 , it tells \SpecialChar LaTeX
1662 to blithely ignore any errors and keep going.
1663 It then uses the logfile from the \SpecialChar LaTeX
1664 run to do a post-mortem.
1665 After analyzing the logfile, \SpecialChar LyX
1666 displays a dialog listing the errors.
1667 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1669 where the error occurred.
1673 \begin_layout Plain Layout
1675 Analyzing the logfile is a tough job, and \SpecialChar LyX
1676 doesn't always go to the right
1678 There are also cases where \SpecialChar LaTeX
1679 reports the error on one line, but the actual
1681 This is not unlike forgetting a closing brace in a program: You'll get
1682 an error, but only later.
1690 \begin_layout Standard
1691 Some folks also like to look at the log file directly: It is available from
1693 \begin_inset Flex Noun
1696 \begin_layout Plain Layout
1697 Document\SpecialChar menuseparator
1699 \begin_inset space ~
1708 There are some fairly common error messages and warnings.
1709 We'll cover those here.
1710 You should look at a good \SpecialChar LaTeX
1711 book for a complete listing.
1714 \begin_layout Itemize
1715 \begin_inset Flex Code
1718 \begin_layout Plain Layout
1725 \begin_inset Newline newline
1728 Anything beginning with these words is a warning message for the purpose
1730 \begin_inset Quotes eld
1734 \begin_inset Quotes erd
1737 the \SpecialChar LaTeX
1739 You'll get messages like this if you added or changed cross-references
1740 or bibliography entries, in which case, \SpecialChar LaTeX
1741 is trying to tell you that you
1742 need to make another run.
1743 You can by-and-large ignore these.
1746 \begin_layout Itemize
1747 \begin_inset Flex Code
1750 \begin_layout Plain Layout
1757 \begin_inset Newline newline
1760 Another warning message, this time about fonts which \SpecialChar LaTeX
1762 The rest of the message will often say something about a replacement font
1763 that \SpecialChar LaTeX
1765 You can safely ignore these, too.
1768 \begin_layout Itemize
1769 \begin_inset Flex Code
1772 \begin_layout Plain Layout
1781 \begin_inset Newline newline
1790 They are warnings about lines that were too long and run past the right
1792 Almost always, this is unnoticeable in the final output.
1793 (It can be just a point or two.) Or, only one or two characters extend past
1796 seems to generate at least one of these messages for just about any document
1798 \begin_inset Newline newline
1801 You can ignore these messages.
1802 Your eyes will tell you if there's a problem with something that's too
1803 wide; just look at the output.
1807 \begin_layout Plain Layout
1808 You can also enable the `draft' option in
1809 \begin_inset Flex Noun
1812 \begin_layout Plain Layout
1813 Document\SpecialChar menuseparator
1819 , and then \SpecialChar LaTeX
1820 will draw a black box in the margin of lines that are overfull.
1828 \begin_layout Itemize
1829 \begin_inset Flex Code
1832 \begin_layout Plain Layout
1841 \begin_inset Newline newline
1844 Not quite as common as its cousin.
1846 seems to like to print lines that are a bit too wide as opposed to ones
1847 that are a bit too narrow.
1848 We have no idea why.
1851 \begin_layout Itemize
1852 \begin_inset Flex Code
1855 \begin_layout Plain Layout
1864 \begin_inset Flex Code
1867 \begin_layout Plain Layout
1876 \begin_inset Newline newline
1879 Warnings about troubles breaking the page.
1880 Once again, just look at the output.
1881 Your eyes will tell you where something has gone wrong.
1884 \begin_layout Itemize
1885 \begin_inset Flex Code
1888 \begin_layout Plain Layout
1890 \begin_inset Quotes els
1894 \begin_inset Quotes ers
1903 \begin_inset Newline newline
1907 \begin_inset Quotes eld
1911 \begin_inset Quotes erd
1914 isn't installed on this system.
1915 This usually appears because some package your document needs isn't installed.
1916 If you didn't touch the preamble or didn't use the
1917 \begin_inset Flex Code
1920 \begin_layout Plain Layout
1928 command, then one of the packages \SpecialChar LyX
1929 tried to load is missing.
1931 \begin_inset Flex Noun
1934 \begin_layout Plain Layout
1935 Help\SpecialChar menuseparator
1942 to get a list of packages that \SpecialChar LyX
1944 This file is updated whenever you reconfigure \SpecialChar LyX
1946 \begin_inset Flex Noun
1949 \begin_layout Plain Layout
1950 Tools\SpecialChar menuseparator
1956 ) and tells you which packages have been detected and what they do.
1957 \begin_inset Newline newline
1961 \begin_inset Flex Code
1964 \begin_layout Plain Layout
1972 command and the package in question isn't installed, then you'll need to
1973 install it yourself.
1976 \begin_layout Itemize
1977 \begin_inset Flex Code
1980 \begin_layout Plain Layout
1981 LaTeX Error: Unknown option
1987 \begin_inset Newline newline
1990 Error messages beginning with this are trying to tell you that you specified
1991 a bad or undefined option to a package.
1992 Check the package's documentation.
1995 \begin_layout Itemize
1996 \begin_inset Flex Code
1999 \begin_layout Plain Layout
2000 Undefined control sequence
2006 \begin_inset Newline newline
2009 If you've inserted \SpecialChar LaTeX
2010 code into your document, but made a typo, you'll get
2012 You may have forgotten to load a package.
2013 In any case, this error message usually means that you used an undefined
2018 \begin_layout Standard
2019 There are other error and warning messages.
2020 Some are self-explanatory.
2021 These are usually \SpecialChar LaTeX
2023 Others are downright cryptic.
2024 These are usually \SpecialChar TeX
2025 error messages, and we really have
2029 what they mean or how to decipher them.
2033 \begin_layout Standard
2034 There's a general sequence you should follow if you get error messages:
2037 \begin_layout Enumerate
2038 Look at the \SpecialChar LaTeX
2039 code you inserted for typos.
2042 \begin_layout Enumerate
2043 If there are no typos, check that you used the command(s) correctly.
2046 \begin_layout Enumerate
2047 If you get a bunch of error boxes piled up at the very top of the document—and
2048 especially if you see a
2049 \begin_inset Quotes eld
2053 \begin_inset Flex Code
2056 \begin_layout Plain Layout
2065 \begin_inset Quotes erd
2068 error—it means that there are errors in the preamble.
2069 Start debugging your preamble.
2072 \begin_layout Enumerate
2073 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2075 document, the first suspect is your \SpecialChar LaTeX
2076 distribution itself.
2077 Check for missing packages and install them.
2080 \begin_layout Enumerate
2081 Okay, so there are no missing packages.
2082 Did you use any of the fine-tuning options in \SpecialChar LyX
2083 ? Specifically, did you
2087 any of them, like trying to manually insert lots of
2088 \begin_inset Flex Code
2091 \begin_layout Plain Layout
2093 \begin_inset space ~
2102 \begin_inset Flex Code
2105 \begin_layout Plain Layout
2112 \begin_inset Flex Code
2115 \begin_layout Plain Layout
2121 ? Did you try to kludge something together with these instead of using the
2122 appropriate paragraph environment?
2125 \begin_layout Enumerate
2126 All right, you didn't use any of the fine-tuning options, you played by
2128 Did you try to pull a fancy maneuver? Did you do something funky inside
2129 a table or an equation, like inserting a graphic into a table cell?
2132 \begin_layout Enumerate
2133 Do you have long sections of text where \SpecialChar LaTeX
2134 cannot find a place to break a
2135 line? By default, \SpecialChar LaTeX
2136 is rather strict about how much extra inter-word spacing
2137 it will add in order to break a line.
2138 Preferably, you should rework the paragraph to avoid the problem.
2141 \begin_layout Enumerate
2142 Did you go overboard with the nesting? \SpecialChar LyX
2143 (currently) doesn't check to make
2144 sure you're in the limits for nesting environments.
2145 If you nested a bunch of environments to the
2146 \begin_inset Formula $17^{\mathrm{th}}$
2149 level, that's the problem.
2150 (The limit in \SpecialChar LaTeX
2154 \begin_layout Enumerate
2155 Okay, you didn't get any error messages, but your output looks awful.
2156 If you have a table or figure that's too wide or long for the page, you
2161 \begin_layout Enumerate
2162 rescale the figure so it fits.
2165 \begin_layout Enumerate
2166 trim down the table so it fits.
2170 \begin_layout Enumerate
2171 If something else is wrong with the output, and you didn't try to pull anything
2172 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2175 \begin_layout Standard
2176 If all this doesn't help—well, then
2180 you might have found a bug in \SpecialChar LyX
2185 \begin_layout Chapter
2189 \begin_layout Section
2190 Customizing Bibliographies with Bib\SpecialChar TeX
2194 \begin_layout Standard
2195 The most basic information about how to use Bib\SpecialChar TeX
2200 with \SpecialChar LyX
2201 is contained in the section
2203 Bibliography databases
2210 The following subsections explain special bibliography features supported
2215 \begin_layout Subsection
2216 Alternative Citation Styles
2219 \begin_layout Standard
2220 Standard Bib\SpecialChar TeX
2222 \begin_inset space \thinspace{}
2226 \begin_inset space \space{}
2230 \begin_inset Quotes eld
2234 \begin_inset Quotes erd
2237 ) to refer to a cited work.
2238 However, in many scientific disciplines, other citation styles are in use.
2239 The most common one is the author-year style (e.
2240 \begin_inset space \thinspace{}
2244 \begin_inset space \space{}
2248 \begin_inset Quotes eld
2252 \begin_inset Quotes erd
2257 supports three packages that provide this style,
2258 \begin_inset Flex Code
2261 \begin_layout Plain Layout
2268 \begin_inset Flex Code
2271 \begin_layout Plain Layout
2278 \begin_inset Flex Code
2281 \begin_layout Plain Layout
2288 Each of these packages has their pros and cons, which cannot be listed
2290 If you only want to have simple author-year (or author-numerical) style,
2291 or if you want to use one of the countless style files for
2292 \begin_inset Flex Code
2295 \begin_layout Plain Layout
2301 , then the established
2302 \begin_inset Flex Code
2305 \begin_layout Plain Layout
2311 package is probably your choice.
2312 If you look for specific citation styles common in law studies, you might
2314 \begin_inset Flex Code
2317 \begin_layout Plain Layout
2324 If you want to have full control over the formatting or look for advanced
2325 features such as ibidem, footnote citations, full title citations, advanced
2326 date formats (such as 400 BC) or full localization to other languages than
2327 English, you should definitely consider
2328 \begin_inset Flex Code
2331 \begin_layout Plain Layout
2337 , which exceeds all other packages in terms of features, but is also quite
2338 heavy and more resource-hungry.
2341 \begin_layout Standard
2342 The handling of these packages in \SpecialChar LyX
2343 is basically the same.
2345 \begin_inset Flex Noun
2348 \begin_layout Plain Layout
2349 Document\SpecialChar menuseparator
2356 \begin_inset Flex Noun
2359 \begin_layout Plain Layout
2366 \begin_inset Flex Noun
2369 \begin_layout Plain Layout
2376 \begin_inset Flex Noun
2379 \begin_layout Plain Layout
2386 \begin_inset Flex Noun
2389 \begin_layout Plain Layout
2390 Biblatex (Natbib mode)
2396 \begin_inset Flex Noun
2399 \begin_layout Plain Layout
2406 \begin_inset Flex Noun
2409 \begin_layout Plain Layout
2416 \begin_inset space ~
2419 6.5.3 in the User's Guide for more information on these choices).
2420 With all these packages, you will get some extra features in the citation
2421 dialog and you can select the style of the reference (
2422 \begin_inset Quotes eld
2426 \begin_inset Quotes erd
2430 \begin_inset Quotes eld
2434 \begin_inset Quotes erd
2438 \begin_inset Quotes eld
2442 \begin_inset Quotes erd
2446 \begin_inset Quotes eld
2450 \begin_inset Quotes erd
2454 Note that either package needs specifically designed style files.
2455 They all ship their own, but there are lots of additional style files,
2456 and there is even an interactive style file builder
2460 \begin_layout Plain Layout
2462 \begin_inset Flex URL
2465 \begin_layout Plain Layout
2467 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2478 \begin_inset Flex Code
2481 \begin_layout Plain Layout
2490 \begin_layout Subsection
2491 Subdivided Bibliographies
2494 \begin_layout Standard
2495 Sometimes you might need to divide your bibliography into several sections.
2496 If you are for instance a historian, the possibility to separate sources
2497 and scientific works is most likely a
2498 \begin_inset Quotes eld
2502 \begin_inset Quotes erd
2506 Unfortunately, Bib\SpecialChar TeX
2507 itself does not allow you to do this.
2508 But with the help of some \SpecialChar LaTeX
2509 packages, Bib\SpecialChar TeX
2510 can be extended to fit your needs.
2513 \begin_layout Standard
2515 provides native support for one of these packages,
2523 \begin_layout Plain Layout
2525 \begin_inset Flex URL
2528 \begin_layout Plain Layout
2530 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2540 The advantage of this package (compared to other packages such as
2544 ) is that you don't need to define new citation commands.
2545 Instead, you need to prepare different bibliographic databases which include
2546 the entries for the different sections of the bibliography.
2547 For example: If you want to divide your bibliography into the sections
2549 \begin_inset Quotes eld
2553 \begin_inset Quotes erd
2557 \begin_inset Quotes eld
2561 \begin_inset Quotes erd
2564 , you first need to create two bibliographic databases, e.
2565 \begin_inset space \thinspace{}
2569 \begin_inset space \space{}
2573 \begin_inset Flex Code
2576 \begin_layout Plain Layout
2583 \begin_inset Flex Code
2586 \begin_layout Plain Layout
2596 \begin_layout Standard
2598 \begin_inset Flex Noun
2601 \begin_layout Plain Layout
2602 Document\SpecialChar menuseparator
2609 \begin_inset Flex Noun
2612 \begin_layout Plain Layout
2619 \begin_inset Flex Noun
2622 \begin_layout Plain Layout
2623 Subdivided bibliography
2629 Now you can insert multiple Bib\SpecialChar TeX
2630 bibliographies, one for each section of
2632 Returning to our example: Insert the Bib\SpecialChar TeX
2634 \begin_inset Flex Code
2637 \begin_layout Plain Layout
2643 and a second one for the database
2644 \begin_inset Flex Code
2647 \begin_layout Plain Layout
2654 You are free to use the same or different styles for each section.
2655 Additionally, you can choose if the bibliography section should contain
2657 \begin_inset Quotes eld
2660 all cited references
2661 \begin_inset Quotes erd
2664 of the specified database(s) (which is the default),
2665 \begin_inset Quotes eld
2668 all uncited references
2669 \begin_inset Quotes erd
2673 \begin_inset Quotes eld
2677 \begin_inset Quotes erd
2681 This might be useful if you would like to separate your bibliography into
2683 \begin_inset Quotes eld
2687 \begin_inset Quotes erd
2691 \begin_inset Quotes eld
2695 \begin_inset Quotes erd
2699 \begin_inset Quotes eld
2703 \begin_inset Quotes erd
2707 The titles for the sections can be added as ordinary sections or subsections.
2709 \begin_inset Flex Code
2712 \begin_layout Plain Layout
2718 removes the bibliography title, you have to manually re-add that, too (as
2719 a chapter* or section*, for instance).
2722 \begin_layout Standard
2727 , the procedure is a bit different.
2736 , the aforementioned
2737 \begin_inset Flex Noun
2740 \begin_layout Plain Layout
2741 Subdivided bibliography
2746 option is disabled if you use
2755 provides its own means to generate subdivided bibliographies.
2756 You can either add keywords to bibliography entries via the
2757 \begin_inset Flex Code
2760 \begin_layout Plain Layout
2766 entry option and then filter bibliography sections by keyword (by adding
2768 \begin_inset Flex Code
2771 \begin_layout Plain Layout
2778 \begin_inset Flex Noun
2781 \begin_layout Plain Layout
2787 field of the dialog that opens if you right-click on the
2788 \begin_inset Flex Noun
2791 \begin_layout Plain Layout
2792 Biblatex Generated Bibliography
2797 button), or you can filter by entry types (such as
2806 \begin_inset space \thinspace{}
2811 \begin_inset Flex Code
2814 \begin_layout Plain Layout
2821 \begin_inset Flex Code
2824 \begin_layout Plain Layout
2831 \begin_inset Flex Noun
2834 \begin_layout Plain Layout
2840 field, or you can create so-called
2841 \begin_inset Quotes eld
2844 Bibliography Categories
2845 \begin_inset Quotes erd
2848 to which you can assign individual entries.
2849 Please refer to the Biblatex manual, section
2851 Subdivided Bibliographies
2856 \begin_layout Subsection
2857 Multiple Bibliographies
2860 \begin_layout Standard
2861 Multiple bibliographies, e.
2862 \begin_inset space \thinspace{}
2866 \begin_inset space \space{}
2869 a bibliography for each part, chapter, section, subsection or child (sub-documen
2870 t) of the document, are also supported by \SpecialChar LyX
2872 In order to enable it, go to
2873 \begin_inset Flex Noun
2876 \begin_layout Plain Layout
2877 Document\SpecialChar menuseparator
2878 Settings\SpecialChar menuseparator
2884 and select the relevant unit (e.
2885 \begin_inset space \thinspace{}
2889 \begin_inset Quotes eld
2893 \begin_inset Quotes erd
2897 \begin_inset Flex Noun
2900 \begin_layout Plain Layout
2901 Multiple Bibliographies
2907 Then add a Bib(la)\SpecialChar TeX
2908 bibliography to each unit (e.
2909 \begin_inset space \thinspace{}
2912 g., section) of your document.
2913 In the output, a separate bibliography, containing only the references
2914 done in the current unit is generated.
2917 \begin_layout Standard
2918 If you use Bib\SpecialChar TeX
2920 \begin_inset Flex Code
2923 \begin_layout Plain Layout
2930 \begin_inset Flex Code
2933 \begin_layout Plain Layout
2939 package is used to create multiple bibliographies.
2940 The former package is used if you select
2941 \begin_inset Quotes eld
2945 \begin_inset Quotes erd
2953 \begin_inset Flex Noun
2956 \begin_layout Plain Layout
2957 Sectioned Bibliography
2964 \begin_inset Flex Code
2967 \begin_layout Plain Layout
2977 \begin_layout Plain Layout
2978 An alternative approach, if you are willing to use some
2979 \begin_inset Flex Noun
2982 \begin_layout Plain Layout
2990 \begin_inset space ~
2994 \begin_inset CommandInset ref
2996 reference "sec:Inserting-TeX-Code"
3001 \begin_inset Flex Code
3004 \begin_layout Plain Layout
3016 \begin_inset Flex Code
3019 \begin_layout Plain Layout
3025 is used, \SpecialChar LyX
3026 encloses the specified units in
3027 \begin_inset Flex Code
3030 \begin_layout Plain Layout
3037 \begin_inset Flex Code
3040 \begin_layout Plain Layout
3049 \begin_inset Flex Code
3052 \begin_layout Plain Layout
3060 in order to create the units.
3061 Note that this approach has some limitations.
3062 First, every citation reference has to be inside some
3063 \begin_inset Flex Code
3066 \begin_layout Plain Layout
3073 So citations outside a defined unit (e.
3074 \begin_inset space \thinspace{}
3077 g., before the first section if you use
3078 \begin_inset Quotes eld
3082 \begin_inset Quotes erd
3086 \begin_inset Quotes eld
3090 \begin_inset Quotes erd
3094 You can also create your own units by entering
3095 \begin_inset Flex Code
3098 \begin_layout Plain Layout
3107 \begin_inset Flex Code
3110 \begin_layout Plain Layout
3119 code (for instance to work around the mentioned limitation).
3121 \begin_inset Flex Code
3124 \begin_layout Plain Layout
3131 A second limitation is that
3132 \begin_inset Flex Code
3135 \begin_layout Plain Layout
3141 always processes all references of a bibliography database, even if they
3143 This can result in odd labels (e.
3144 \begin_inset space \thinspace{}
3149 \begin_inset Quotes eld
3153 \begin_inset Quotes erd
3156 if two works of this author from 2014 are in the database, even if only
3160 \begin_layout Standard
3166 \begin_inset Flex Code
3169 \begin_layout Plain Layout
3175 option is used instead.
3176 If you need specific units, you can start them with the \SpecialChar TeX
3178 \begin_inset Flex Code
3181 \begin_layout Plain Layout
3190 \begin_inset Flex Code
3193 \begin_layout Plain Layout
3202 If you also want to control the end of the unit, use the environment
3203 \begin_inset Flex Code
3206 \begin_layout Plain Layout
3216 \begin_inset Flex Code
3219 \begin_layout Plain Layout
3229 \begin_inset Flex Code
3232 \begin_layout Plain Layout
3239 In addition to the individual bibliography of the current unit,
3243 also provides an easy way to output all bibliographies, subsequently, at
3245 \begin_inset space \thinspace{}
3248 g., at the end of the document).
3250 \begin_inset Quotes eld
3254 \begin_inset Quotes erd
3257 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3263 manual for more information on this topic.
3266 \begin_layout Section
3270 \begin_layout Subsection
3274 \begin_layout Standard
3275 When you are working on a large file with many sections, it is often convenient
3276 to break up the document into several files, or perhaps you have something
3277 where a table may change from time to time, but the preceding text does
3279 In these cases, you should seriously consider using multipart documents.
3280 For example, scientific papers often have five major sections: the introduction
3281 , observations, results, discussion, and conclusion.
3282 Each of these could be its own separate \SpecialChar LyX
3284 \begin_inset Quotes eld
3288 \begin_inset Quotes erd
3291 file which contains the title, authors, abstract, references, etc., plus
3292 the five included files.
3293 It is important to note that each of these files is a full \SpecialChar LyX
3295 can be formatted and printed on its own, as well as included in a master
3297 Each of these files must have the same document class, however—don't attempt
3298 to mix book classes with article classes.
3299 You may also include \SpecialChar LaTeX
3300 files; however, these files must not have their own
3302 \begin_inset space \thinspace{}
3306 \begin_inset space \space{}
3309 everything up to and including the
3310 \begin_inset Flex Code
3313 \begin_layout Plain Layout
3322 \begin_inset Flex Code
3325 \begin_layout Plain Layout
3333 line must be deleted) or else errors will be generated when you try to
3337 \begin_layout Standard
3339 allows you to include files quite easily with
3340 \begin_inset Flex Noun
3343 \begin_layout Plain Layout
3344 Insert\SpecialChar menuseparator
3346 \begin_inset space ~
3355 When you click on this selection a small box is inserted into the file
3356 at the current cursor location.
3357 Clicking on the box raises a dialog which allows you to select the file
3358 to be included, and the method of its inclusion.
3362 \begin_layout Standard
3363 The file selection box should by now be obvious.
3364 The three inclusion methods are
3365 \begin_inset Quotes eld
3369 \begin_inset Quotes erd
3373 \begin_inset Quotes eld
3377 \begin_inset Quotes erd
3381 \begin_inset Quotes eld
3385 \begin_inset Quotes erd
3389 The difference between
3390 \begin_inset Quotes eld
3394 \begin_inset Quotes erd
3398 \begin_inset Quotes eld
3402 \begin_inset Quotes erd
3405 is really only meaningful to \SpecialChar LaTeX
3406 perts, but the practical difference is that
3408 \begin_inset Quotes eld
3412 \begin_inset Quotes erd
3415 are typeset beginning on a new page, while files that are
3416 \begin_inset Quotes eld
3420 \begin_inset Quotes erd
3423 are typeset starting on the current page.
3426 \begin_layout Standard
3427 Generally, the master file is converted into a full \SpecialChar LaTeX
3428 file before typesetting,
3429 while the included files are converted to \SpecialChar LaTeX
3430 files that do not have all the
3431 preamble information.
3434 \begin_layout Standard
3436 \begin_inset Quotes eld
3440 \begin_inset Quotes erd
3443 included file allows you to include a file typeset exactly as it appears
3445 \begin_inset space \thinspace{}
3449 \begin_inset space \space{}
3453 \begin_inset Flex Code
3456 \begin_layout Plain Layout
3462 mode, with the characters set in a fixed-width typewriter font.
3463 Normally, spaces in this file are invisible, though two consecutive spaces
3464 are conserved, unlike \SpecialChar LyX
3465 's normal treatment of spaces.
3466 However, setting the
3467 \begin_inset Flex Noun
3470 \begin_layout Plain Layout
3472 \begin_inset space ~
3476 \begin_inset space ~
3480 \begin_inset space ~
3488 checkbox typesets a mark to unambiguously define the presence of a space.
3492 \begin_layout Subsection
3493 Cross-References Between Files
3496 \begin_layout Standard
3497 \begin_inset Box Shadowbox
3507 height_special "totalheight"
3512 backgroundcolor "none"
3515 \begin_layout Plain Layout
3516 This section is somewhat out of date.
3517 Need to describe default master documents and how children are opened when
3527 \begin_layout Standard
3528 It is possible to set up cross-references between the different files.
3529 First, open all the files in question: let's call them A and B in a two
3530 file example, where B is included in A.
3531 Let's say you insert a label in A, then want to reference it in B.
3532 Open the cross-reference dialog whilst in document B, and you can select
3534 \begin_inset Quotes eld
3538 \begin_inset Quotes erd
3544 \begin_layout Subsection
3545 Bibliography Lists in all Subdocuments
3548 \begin_layout Standard
3549 \begin_inset Box Frameless
3559 height_special "totalheight"
3564 backgroundcolor "none"
3567 \begin_layout Plain Layout
3568 This section also needs updating.
3569 There is now material about this on the wiki, and it could be copied here.
3577 \begin_layout Standard
3578 Copy the bibliography list with all entries to all subdocuments and transform
3580 This way \SpecialChar LyX
3582 \begin_inset Flex Code
3585 \begin_layout Plain Layout
3591 -files and you can easily insert references without making the bibliography
3595 \begin_layout Standard
3596 As the bibliography list is in a comment, \SpecialChar LaTeX
3597 won't use it and the references
3598 will look like this: [?], instead of like this: [1].
3599 One solution is to use the \SpecialChar LaTeX
3601 \begin_inset Flex Code
3604 \begin_layout Plain Layout
3610 that will only include comments by processing the files separately.
3611 To do this, add in the \SpecialChar LaTeX
3612 preamble of every subdocument the following:
3615 \begin_layout LyX-Code
3621 \begin_layout LyX-Code
3624 includecomment{comment}
3627 \begin_layout Standard
3629 \begin_inset Flex URL
3632 \begin_layout Plain Layout
3634 http://wiki.lyx.org/FAQ/Unsorted#toc31
3642 \begin_layout Section
3647 \begin_layout Standard
3648 Users sometimes need to be able to
3649 \begin_inset Quotes eld
3653 \begin_inset Quotes erd
3657 file together with all the images (and other files) on which it depends,
3658 either for sending to a publisher or for sharing with a co-author.
3660 2.0 includes a Python script (
3661 \begin_inset Flex Code
3664 \begin_layout Plain Layout
3670 ) that automates this process.
3671 To use it, you must have either the
3672 \begin_inset Flex Code
3675 \begin_layout Plain Layout
3682 \begin_inset Flex Code
3685 \begin_layout Plain Layout
3691 python modules installed on your system.
3692 By default, the script prefers the
3693 \begin_inset Flex Code
3696 \begin_layout Plain Layout
3703 \begin_inset Flex Code
3706 \begin_layout Plain Layout
3712 format on Unix-like systems and the
3713 \begin_inset Flex Code
3716 \begin_layout Plain Layout
3725 \begin_layout Standard
3727 's configuration process will set the script up to export a `\SpecialChar LyX
3729 and this format will then be available under
3730 \begin_inset Flex Code
3733 \begin_layout Plain Layout
3734 File\SpecialChar menuseparator
3743 \begin_layout Standard
3744 Independently of the platform, the generation of a particular archive format
3745 can be forced by adding either the
3746 \begin_inset Flex Code
3749 \begin_layout Plain Layout
3756 \begin_inset Flex Code
3759 \begin_layout Plain Layout
3766 \begin_inset Flex Code
3769 \begin_layout Plain Layout
3776 \begin_inset Flex Code
3779 \begin_layout Plain Layout
3785 format) switch to the
3786 \begin_inset Flex Code
3789 \begin_layout Plain Layout
3791 \SpecialChar menuseparator
3799 \begin_inset Flex Code
3802 \begin_layout Plain Layout
3803 Tools\SpecialChar menuseparator
3804 Preferences\SpecialChar menuseparator
3805 File Handling\SpecialChar menuseparator
3812 (Make sure you add the switch after the script name, not before it.)
3815 \begin_layout Section
3816 Fancy Headers and Footers
3819 \begin_layout Standard
3820 The default page layout is rather plain; for an
3821 \begin_inset Flex Code
3824 \begin_layout Plain Layout
3830 document class, all you get is a centered page number at the bottom of
3832 This document uses KOMA-script's book class, so it appears to be a bit
3834 But to really put on a show, you need to set the document page style to
3836 \begin_inset Quotes eld
3840 \begin_inset Quotes erd
3843 , as mentioned in the
3848 This section describes the \SpecialChar LaTeX
3849 code you need to insert in your \SpecialChar LaTeX
3851 order to get the desired effects.
3854 \begin_layout Standard
3855 For more information on fancy headers, see the
3856 \begin_inset Flex Code
3859 \begin_layout Plain Layout
3865 package documentation.
3867 \begin_inset Flex URL
3870 \begin_layout Plain Layout
3872 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3880 \begin_layout Standard
3881 The page header is divided into three fields, not surprisingly labeled
3882 \begin_inset Quotes eld
3886 \begin_inset Quotes erd
3890 \begin_inset Quotes eld
3894 \begin_inset Quotes erd
3898 \begin_inset Quotes eld
3902 \begin_inset Quotes erd
3906 The footer is also divided into these three fields.
3907 The \SpecialChar LaTeX
3908 commands to set these fields in the simplest manner are
3909 \begin_inset Flex Code
3912 \begin_layout Plain Layout
3921 \begin_inset Flex Code
3924 \begin_layout Plain Layout
3933 \begin_inset Flex Code
3936 \begin_layout Plain Layout
3945 \begin_inset Flex Code
3948 \begin_layout Plain Layout
3957 Suppose you wish to put your name in the upper left hand corner of each
3959 Simply insert the following command in the preamble:
3962 \begin_layout Standard
3971 \begin_layout Standard
3972 You will now see your name in the upper left.
3973 If a field has a default entry that you would like to get rid of (often
3974 the page number appears in the central footer) simply include a command
3975 with a blank argument, e.
3976 \begin_inset space \thinspace{}
3982 \begin_layout Standard
3990 \begin_layout Standard
3991 Let's get really fancy: lets put the section number with the word
3992 \begin_inset Quotes eld
3996 \begin_inset Quotes erd
4000 \begin_inset space \thinspace{}
4004 \begin_inset space \space{}
4007 Section 3) in the upper left, the page number (e.
4008 \begin_inset space \thinspace{}
4012 \begin_inset space \space{}
4015 Page 4) in the upper right, your name in the lower left, and the date in
4017 The following commands should now appear in the preamble:
4020 \begin_layout Standard
4030 \begin_layout Standard
4038 \begin_layout Standard
4048 \begin_layout Standard
4057 \begin_layout Standard
4065 \begin_layout Standard
4075 \begin_layout Standard
4077 \begin_inset Flex Code
4080 \begin_layout Plain Layout
4089 \begin_inset Flex Code
4092 \begin_layout Plain Layout
4100 access \SpecialChar LaTeX
4101 's section and page counters, and so print out the current section
4104 \begin_inset Flex Code
4107 \begin_layout Plain Layout
4115 simply prints out today's date.
4118 \begin_layout Standard
4119 The thicknesses of the horizontal rules drawn beneath the header and above
4120 the footer can also be modified.
4121 If you don't want one of the rules, set its thickness to 0.
4122 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4128 \begin_inset Flex Code
4131 \begin_layout Plain Layout
4136 headrulewidth}{0.4pt}
4142 \begin_inset Flex Code
4145 \begin_layout Plain Layout
4150 footrulewidth}{0.4pt}
4155 to set the thicknesses.
4158 \begin_layout Standard
4159 You can switch the header/footer settings on and off for individual pages
4161 \begin_inset Flex Code
4164 \begin_layout Plain Layout
4167 thispagestyle{empty}
4173 \begin_inset Flex Code
4176 \begin_layout Plain Layout
4179 thispagestyle{plain}
4185 \begin_inset Flex Code
4188 \begin_layout Plain Layout
4191 thispagestyle{fancy}
4197 Simply insert them in the text on the page you want changed and mark them
4200 In fact, title pages are marked as plain by default, while following pages
4201 are marked fancy when using the global fancy setting.
4204 \begin_layout Standard
4205 As a final example, it is possible to include an image in the header or
4207 Suppose you want to put a company logo in the upper lefthand corner.
4208 You might try something like
4211 \begin_layout Standard
4220 includegraphics{logo.eps}}}
4223 \begin_layout Standard
4225 (you may need to preface this with
4226 \begin_inset Flex Code
4229 \begin_layout Plain Layout
4233 usepackage{graphics}
4238 if you don't include graphics elsewhere in your document).
4241 \begin_layout Section
4242 Itemize Bullet Selection
4243 \begin_inset CommandInset label
4252 \begin_layout Standard
4258 \begin_layout Subsection
4262 \begin_layout Standard
4264 provides 216 bullet shapes that can be accessed from a simple dialog.
4265 Using this dialog you can easily specify what bullet shape to use at each
4266 level of an itemized list.
4267 These settings are document-wide so you won't be able to specify different
4268 sets of bullets for different paragraphs.
4272 \begin_layout Plain Layout
4273 Well, actually you can but you'll have to do it by hand.
4281 \begin_layout Subsection
4285 \begin_layout Standard
4286 Open the dialog by selecting the
4287 \begin_inset Flex Noun
4290 \begin_layout Plain Layout
4291 Document\SpecialChar menuseparator
4297 menu item and then select the
4298 \begin_inset Flex Noun
4301 \begin_layout Plain Layout
4310 \begin_layout Standard
4311 The dialog provides you with a table of bullet shapes.
4312 A column of buttons on the left of the table provides access to the six
4313 different panels of bullet shapes.
4314 The row of buttons across the top is used to select which bullet depth
4316 A text entry under the table shows the currently selected bullet shape's
4318 equivalent and this can be edited if desired.
4319 If you do modify the text you will also need to specify any needed packages
4320 in the \SpecialChar LaTeX
4324 \begin_layout Standard
4325 The six panels are divided up by the packages they require.
4326 The following table shows the mappings from button name to \SpecialChar LaTeX
4330 \begin_layout Standard
4332 \begin_inset Tabular
4333 <lyxtabular version="3" rows="7" columns="2">
4334 <features tabularvalignment="middle">
4335 <column alignment="center" valignment="top" width="0pt">
4336 <column alignment="center" valignment="top" width="0pt">
4338 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4341 \begin_layout Plain Layout
4356 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4359 \begin_layout Plain Layout
4376 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4379 \begin_layout Plain Layout
4394 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4397 \begin_layout Plain Layout
4406 base \SpecialChar LaTeX
4414 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4417 \begin_layout Plain Layout
4432 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4435 \begin_layout Plain Layout
4452 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4455 \begin_layout Plain Layout
4470 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4473 \begin_layout Plain Layout
4490 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4493 \begin_layout Plain Layout
4508 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4511 \begin_layout Plain Layout
4528 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4531 \begin_layout Plain Layout
4546 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4549 \begin_layout Plain Layout
4566 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4569 \begin_layout Plain Layout
4584 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4587 \begin_layout Plain Layout
4610 \begin_layout Standard
4612 doesn't stop you using bullets from packages you don't have.
4613 If you get errors from \SpecialChar LaTeX
4614 when you try to view or print the file, then it
4615 is likely you are missing a package.
4619 \begin_layout Plain Layout
4621 doesn't restrict your use since you may be editing locally and exporting
4630 \begin_layout Subsection
4634 \begin_layout Standard
4635 Select which bullet depth you want to change then select the bullet shape
4637 Any changes will not be visible in \SpecialChar LyX
4638 , but are visible when viewing the document.
4641 \begin_layout Standard
4642 You can reset a bullet shape to the default simply by clicking your right
4643 mouse button on the appropriate bullet depth button.
4647 \begin_layout Plain Layout
4652 want to have multiple sets of paragraphs with different sets of bullets
4653 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4655 The bullet selection dialog can help though because it provides you with
4656 the \SpecialChar LaTeX
4657 code for a wide range of bullet shapes.
4658 To make your own custom paragraphs you have the following options:
4661 \begin_layout Plain Layout
4665 \begin_layout Plain Layout
4681 \begin_layout Plain Layout
4685 \begin_layout Plain Layout
4707 \begin_layout Itemize
4708 Use the \SpecialChar LaTeX
4710 \begin_inset Flex Code
4713 \begin_layout Plain Layout
4721 to specify a new bullet shape for a given depth.
4722 You'll also need to save the current bullet shape so you can restore it
4724 In this itemized list the following \SpecialChar LaTeX
4725 code was used to change the bullet
4726 used for the first depth.
4730 \begin_layout LyX-Code
4740 \begin_layout LyX-Code
4757 \begin_layout Itemize
4758 Note that the itemize depth is specified in Roman numerals as part of the
4768 \begin_layout Itemize
4772 \begin_layout Plain Layout
4785 Specify each individual entry by starting each item with the bullet shape
4786 enclosed in square brackets and set as
4787 \begin_inset Flex Noun
4790 \begin_layout Plain Layout
4798 For example, this item was started with
4799 \begin_inset Flex Code
4802 \begin_layout Plain Layout
4817 \begin_layout Plain Layout
4821 \begin_layout Plain Layout
4837 \begin_layout Plain Layout
4838 You'll also need to revert the labelitem back to its previous setting for
4839 the global bullet shape settings to remain in effect.
4840 The way used here was:
4843 \begin_layout LyX-Code
4858 \begin_layout Chapter
4860 and the World Wide Web
4863 \begin_layout Standard
4865 has long supported the export of documents to various web-friendly formats,
4867 Before verson 2.0, however, HTML export was always accomplished by the use
4868 of external converters.
4872 \begin_layout Plain Layout
4873 For details on the use of external converters with \SpecialChar LyX
4878 section of the Customization manual.
4883 These fall into two large groups: there are converters that use \SpecialChar LaTeX
4885 intermediate format, such as
4886 \begin_inset Flex Code
4889 \begin_layout Plain Layout
4896 \begin_inset Flex Code
4899 \begin_layout Plain Layout
4906 \begin_inset Flex Code
4909 \begin_layout Plain Layout
4915 , relying upon \SpecialChar LyX
4916 to produce the \SpecialChar LaTeX
4917 ; and there is a converter that works directly
4920 \begin_inset Flex Code
4923 \begin_layout Plain Layout
4931 All of these have different advantages and disadvantages.
4935 \begin_layout Standard
4936 The \SpecialChar LaTeX
4937 -based converters have the advantage that, in principle, they know everythin
4938 g about the exported document that \SpecialChar LaTeX
4940 Such converters do not care, for example, if a certain block of code was
4941 produced by \SpecialChar LyX
4942 or was Evil Red Text.
4943 These converters know about
4944 \begin_inset Flex Code
4947 \begin_layout Plain Layout
4953 files, counters, and references, and can often make use of the
4954 \begin_inset Flex Code
4957 \begin_layout Plain Layout
4963 files generated by Bib\SpecialChar TeX
4965 On the other hand, \SpecialChar LaTeX
4966 is a very hard language to parse—it is sometimes said
4967 that only \SpecialChar TeX
4968 itself understands \SpecialChar TeX
4969 —and \SpecialChar LaTeX
4970 -based converters will often choke on
4971 what seem to be quite simple constructs; complex ones can throw them completely
4972 , and as of this writing, for example, the
4976 manual will not export with
4977 \begin_inset Flex Code
4980 \begin_layout Plain Layout
4986 , though the others will.
4987 The other issue concerns how math is handled.
4988 These converters typically convert the formulae into little pictures that
4989 are then linked from the HTML document.
4990 Since these are actually generated by \SpecialChar LaTeX
4991 , they are accurate.
4992 But they do not scale well, and just getting them to look as if they are
4993 actually meant to be in your document—so that the font sizes seem to be
4994 roughly the same—can be a challenge.
4997 \begin_layout Standard
4999 \begin_inset Flex Code
5002 \begin_layout Plain Layout
5010 \begin_inset CommandInset href
5012 name "http://elyxer.nongnu.org/"
5013 target "http://elyxer.nongnu.org/"
5018 ) solves some of these problems.
5019 In particular, the formulae it produces scale perfectly, since it renders
5020 math using a combination of HTML and CSS rather than converting the formulae
5022 But even moderately complex formula are rendered less well than with
5023 \begin_inset Flex Code
5026 \begin_layout Plain Layout
5032 ; this reflects the limitations of HTML.
5036 \begin_layout Plain Layout
5038 \begin_inset Flex Code
5041 \begin_layout Plain Layout
5048 can also use jsMath and MathJax for equations, but this setting is only
5049 available globally and requires one to have access to a server that runs
5055 More importantly (as of version 1.1.1, at least),
5056 \begin_inset Flex Code
5059 \begin_layout Plain Layout
5066 has limited support for math macros and no support for user-defined paragraph
5067 or character styles.
5068 These limitations make
5069 \begin_inset Flex Code
5072 \begin_layout Plain Layout
5079 unsuitable for many of the documents \SpecialChar LyX
5081 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5083 have decided to follow a different path and have made \SpecialChar LyX
5085 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5086 , DocBook, and plaintext.
5089 \begin_layout Standard
5090 As of this writing, XHTML output remains under development and should probably
5092 \begin_inset Quotes eld
5096 \begin_inset Quotes erd
5103 \begin_layout Plain Layout
5105 \begin_inset Flex Code
5108 \begin_layout Plain Layout
5109 development/HTML.notes
5114 , which can be found in the \SpecialChar LyX
5116 \begin_inset CommandInset href
5118 name "accessed online"
5119 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5124 , usually contains up-to-date information about the state of XHTML output.
5125 See also the list of XHTML bugs on
5126 \begin_inset CommandInset href
5128 name "the bug tracker"
5129 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"
5139 Still, the developers have chosen this approach because it has several
5140 potential advantages over the other two.
5143 \begin_layout Standard
5144 These advantages are primarily due to the fact that the XHTML output routines,
5145 since they are part of \SpecialChar LyX
5146 , know everything \SpecialChar LyX
5147 knows about the document being
5152 \begin_layout Plain Layout
5153 Another advantage is that, since these routines are internal to \SpecialChar LyX
5155 immune to changes in \SpecialChar LyX
5156 's file format, or to changes in the semantics of
5162 So they know about the table of contents (as displayed in the outline),
5163 about the counters associated with different paragraph styles, and about
5164 user-defined styles.
5165 The XHTML output routines know what \SpecialChar LyX
5166 knows about internationalization,
5167 too, so they will output
5168 \begin_inset Quotes eld
5172 \begin_inset Quotes erd
5176 \begin_inset Quotes eld
5184 \begin_inset Quotes erd
5187 , depending upon the language in effect at the time.
5191 \begin_layout Standard
5192 Quite generally, the output routines know what \SpecialChar LyX
5193 knows about document layout,
5194 that is, about how the document is to be rendered on screen.
5195 We use this information when we output the document as XHTML.
5196 In particular, \SpecialChar LyX
5201 generates CSS style information corresponding to the layout information
5202 it uses to render the document on screen: if section headings are supposed
5203 to be sans-serif and bold as seen in \SpecialChar LyX
5204 , then (by default) they will be sans-seri
5205 f and bold when viewed in a web browser, too.
5206 And this is true not just for pre-defined styles, like Section, but for
5207 any style, including user-defined styles.
5208 Indeed, the XHTML output routines make no distinction between user-defined
5209 paragraph and character styles and \SpecialChar LyX
5210 's own pre-defined styles: in each case,
5211 everything \SpecialChar LyX
5212 knows about the styles is contained in the layout files.
5213 And much the same is true as regards pre-defined textual insets, such as
5214 footnotes, and various custom insets.
5218 \begin_layout Standard
5219 The result is that XHTML output can be customized and extended in exactly
5220 the same way \SpecialChar LaTeX
5221 output can be customized and extended: through layout files
5223 See chapter five of the
5227 manual for the details.
5230 \begin_layout Standard
5231 The remainder of this chapter contains more detailed information on XHTML
5232 output, its limitations, and ways to work around those limitations.
5235 \begin_layout Section
5236 Math Output in XHTML
5239 \begin_layout Standard
5241 offers four choices for how math is rendered.
5242 These have various advantages and disadvantages:
5245 \begin_layout Itemize
5247 \begin_inset Newline newline
5250 MathML is a dialect of XML designed specifically for mathematics on the
5251 web, and it typically renders very well in browsers that support it.
5252 The disadvantage is that not all browsers support MathML, and support is
5253 not complete even in the Gecko-based browsers, such as Firefox.
5254 \begin_inset Newline newline
5258 is unable to render a formula as MathML—for example, if the formula
5260 \begin_inset Flex Code
5263 \begin_layout Plain Layout
5269 package or ERT—then it will instead output the formula as an image.
5273 \begin_layout Itemize
5275 \begin_inset Newline newline
5279 \begin_inset Flex Code
5282 \begin_layout Plain Layout
5288 outputs math as HTML, styled by CSS.
5292 \begin_layout Plain Layout
5294 has borrowed some of the CSS for its HTML output from
5295 \begin_inset Flex Code
5298 \begin_layout Plain Layout
5309 For simple formulae, this can work quite well, though with more complicated
5310 formulae it tends to break down.
5311 Still, this method has the advantage that it is very widely supported and
5312 so it may be appropriate for documents that contain only a little, fairly
5314 \begin_inset Newline newline
5317 If Lyx is unable to render a formula as HTML—for example, if the formula
5319 \begin_inset Flex Code
5322 \begin_layout Plain Layout
5328 package or ERT—then it will instead output the formula as an image.
5332 \begin_layout Itemize
5334 \begin_inset Newline newline
5338 \begin_inset Flex Code
5341 \begin_layout Plain Layout
5348 will output formulae as images, the very same images, in fact, that are
5349 used for instant preview.
5353 \begin_layout Plain Layout
5354 Instant preview does
5358 have to be on for images to be output, however.
5363 The advantage to this method is that the images are simply generated by
5365 , so they are very accurate.
5366 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5367 so they do not scale terribly well, and one cannot copy them, etc.
5368 (As of this writing, there are also problems about equation numbering.
5370 \begin_inset CommandInset href
5373 target "http://www.lyx.org/trac/ticket/6894"
5379 \begin_inset Newline newline
5382 The size of the images can be controlled by setting the
5383 \begin_inset Quotes eld
5387 \begin_inset Quotes erd
5391 \begin_inset Flex Noun
5394 \begin_layout Plain Layout
5395 Document\SpecialChar menuseparator
5396 Settings\SpecialChar menuseparator
5406 \begin_layout Plain Layout
5407 For those who want to know, this controls the resolution of the image in
5408 dots per inch and is based upon a default of 75 dpi.
5414 \begin_inset Newline newline
5418 for some reason fails to create an image for a formula (e.g., if a required
5420 package is not installed), then it will fall back to outputing the raw
5425 \begin_layout Itemize
5428 \begin_inset Newline newline
5431 Finally, \SpecialChar LyX
5432 will happily output math as \SpecialChar LaTeX
5434 As well as being the output of last resort, this method can be used with
5436 \begin_inset CommandInset href
5439 target "http://www.math.union.edu/~dpvc/jsMath/"
5444 , which uses JavaScript to render \SpecialChar LaTeX
5445 embedded in HTML documents.
5447 wraps the \SpecialChar LaTeX
5449 \begin_inset Flex Code
5452 \begin_layout Plain Layout
5458 (for inline formulas) or
5459 \begin_inset Flex Code
5462 \begin_layout Plain Layout
5468 (for displayed formulas) with
5469 \begin_inset Flex Code
5472 \begin_layout Plain Layout
5478 , as is required for jsMath.
5481 \begin_layout Standard
5482 One of these output methods must be selected under
5483 \begin_inset Flex Noun
5486 \begin_layout Plain Layout
5487 Document\SpecialChar menuseparator
5488 Settings\SpecialChar menuseparator
5495 By default, \SpecialChar LyX
5497 This is a document-wide setting, therefore.
5500 \begin_layout Standard
5501 Eventually, \SpecialChar LyX
5502 will offer the user the option to select an alternate output
5503 method for a particular inset, say, one that isn't being rendered very
5508 \begin_layout Plain Layout
5509 That said, since \SpecialChar LyX
5510 falls back to images if the inset contains ERT, then one
5511 can force output as an image by putting some harmless ERT into the math,
5513 \begin_inset Formula $a=b\relax$
5524 \begin_layout Section
5525 Bibliography and Citations
5528 \begin_layout Standard
5529 XHTML output fully supports bibliographies and citations.
5533 \begin_layout Standard
5534 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5536 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5539 If you are using numerical citations, then \SpecialChar LyX
5540 will output numerical labels,
5541 such as [1] or [17], rather than simply showing the citation key in square
5542 brackets, as it does on-screen.
5543 If you are using author-year citations, then \SpecialChar LyX
5544 will add lowercase letters
5545 to the years, just as Bib\SpecialChar TeX
5546 does, if it finds more than one citation for
5547 a given author-year combination.
5548 The labels will be printed with the bibliography entries.
5549 Note that there is, at present, no way to customize the appearance of the
5550 labels, for example, to choose between square brackets and parentheses.
5553 \begin_layout Standard
5554 Bibliography output is handled by the same machinery that handles the presentati
5555 on of reference information in the citation dialog, so you will see in the
5556 XHTML output pretty much what you would see if you were to look at a given
5557 entry in the citation dialog.
5558 The formatting can be customized in your layout file or, preferably, in
5564 manual for the details.
5567 \begin_layout Standard
5568 The main defect at present is that cross-referenced information is printed
5569 with every entry with which it is associated.
5570 So you can see things like this:
5575 \begin_inset Quotes eld
5578 Context and Logical Form
5579 \begin_inset Quotes erd
5584 Language in Context: Selected Essays
5586 (Oxford: Oxford University Press, 2007), pp.
5592 \begin_inset Quotes eld
5595 Semantics in Context
5596 \begin_inset Quotes erd
5601 Language in Context: Selected Essays
5603 (Oxford: Oxford University Press, 2007), pp.
5607 \begin_layout Standard
5608 This should be fixed before long.
5611 \begin_layout Standard
5612 There is no support at present for sectioned bibliographies.
5613 If you have multiple bibliographies, then \SpecialChar LyX
5614 will print the same bibliography
5618 \begin_layout Section
5622 \begin_layout Standard
5624 will happily export indexes as XHTML, but with certain limitations at the
5628 \begin_layout Standard
5629 Index export will be most reliable when you do not attempt to use the fancy
5630 constructs that are described in the section on indexes in the
5638 \begin_layout Plain Layout
5639 The main issue here is that \SpecialChar LyX
5640 itself does not really handle these.
5641 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5647 We'll describe how they are handled using the subsection headings from
5651 \begin_layout Itemize
5652 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5653 makes an effort to support these,
5654 but the entries must be separated by
5655 \begin_inset Quotes eld
5659 \begin_inset Quotes erd
5662 , that is, there must be spaces around the exclamation point.
5663 This is because it is otherwise too difficult to check for escaped exclamation
5664 points, ones in math, and so forth.
5667 \begin_layout Itemize
5668 Page Ranges: There is no support at all for page ranges, since these make
5669 no sense with XHMTL.
5670 Instead, you will just get two index entries, one at either end.
5673 \begin_layout Itemize
5674 Cross-referencing: There is no support for cross-referencing.
5676 finds an entry containing the
5677 \begin_inset Quotes eld
5680 |see\SpecialChar ldots
5682 \begin_inset Quotes erd
5685 construct, it is just dropped, and the rest is treated as an ordinary index
5689 \begin_layout Itemize
5690 Index Entry Order: \SpecialChar LyX
5691 does support attempts to fix the sorting order.
5692 It will take what is before the first `@' it finds and use that for sorting,
5693 taking what follows the first `@' to be the actual entry.
5694 At present, \SpecialChar LyX
5695 does not check for escaped `@', so do not try to index email
5699 \begin_layout Itemize
5700 Index Entry Layout: You can format entries by using the text style dialog,
5701 or by using any other method available within \SpecialChar LyX
5703 There is no support for constructs like:
5704 \begin_inset Quotes eld
5708 \begin_inset Quotes erd
5712 Indeed, if \SpecialChar LyX
5713 finds a pipe symbol, `|', in an entry, it will delete it and
5714 everything that follows it.
5717 \begin_layout Itemize
5718 Multiple Indexes: There is no support for multiple indexes.
5719 Rather, all index entries will be printed as one large index.
5720 To avoid our printing several versions of the index, we print only the
5721 main index, so make sure you have one.
5724 \begin_layout Section
5725 Nomenclature and Glossary
5728 \begin_layout Standard
5729 There is at present no support for glossaries.
5730 Adding it would be fairly trivial, and welcome.
5733 \begin_layout Chapter
5734 The \SpecialChar LyX
5738 \begin_layout Section
5742 \begin_layout Standard
5743 The `\SpecialChar LyX
5744 server' allows other programs to talk to \SpecialChar LyX
5745 , invoke \SpecialChar LyX
5746 commands, and retrieve
5747 information about the \SpecialChar LyX
5749 This is only intended for advanced users, but they should find it useful.
5750 It is by writing to the \SpecialChar LyX
5751 server, for example, that bibliography managers,
5752 such as JabRef, are able to
5753 \begin_inset Quotes eld
5757 \begin_inset Quotes erd
5760 citations to \SpecialChar LyX
5764 \begin_layout Section
5765 Starting the \SpecialChar LyX
5769 \begin_layout Standard
5770 The \SpecialChar LyX
5771 server works through the use of a pair of named pipes.
5772 These are usually located in
5773 \begin_inset Flex Code
5776 \begin_layout Plain Layout
5782 , (except on Windows, where
5786 named pipes are special objects located in
5787 \begin_inset Flex Code
5790 \begin_layout Plain Layout
5802 ) and have the names
5803 \begin_inset Quotes eld
5807 \begin_inset Flex Code
5810 \begin_layout Plain Layout
5817 \begin_inset Quotes erd
5821 \begin_inset Quotes eld
5825 \begin_inset Flex Code
5828 \begin_layout Plain Layout
5835 \begin_inset Quotes erd
5839 External programs write into
5840 \begin_inset Flex Code
5843 \begin_layout Plain Layout
5849 and read back data from
5850 \begin_inset Flex Code
5853 \begin_layout Plain Layout
5860 The stem of the pipe names can be defined in the
5861 \begin_inset Flex Noun
5864 \begin_layout Plain Layout
5865 Tools\SpecialChar menuseparator
5872 \begin_inset Flex Code
5875 \begin_layout Plain Layout
5876 "/home/myhome/lyxpipe"
5882 \begin_inset Flex Code
5885 \begin_layout Plain Layout
5899 on Windows (where any working path instead of lyxpipe can be used, for
5901 \begin_inset Flex Code
5904 \begin_layout Plain Layout
5927 configure this manually in order for the server to start.
5930 \begin_layout Standard
5933 \begin_inset Flex Code
5936 \begin_layout Plain Layout
5943 \begin_inset Flex Code
5946 \begin_layout Plain Layout
5952 ' to create the pipes.
5953 If one of the pipes already exists, \SpecialChar LyX
5954 will assume that another \SpecialChar LyX
5956 is already running and will not start the server.
5957 On POSIX (Unix like) systems, if for some other reason, an unused
5958 \begin_inset Quotes eld
5962 \begin_inset Quotes erd
5965 pipe is left in existence when \SpecialChar LyX
5966 closes, then \SpecialChar LyX
5967 will try to delete it.
5968 If this fails for some reason, you will need to delete the pipes manually
5969 and then restart \SpecialChar LyX
5971 On Windows, pipes are deleted by the OS on program termination or crash,
5973 \begin_inset Quotes eld
5977 \begin_inset Quotes erd
5980 pipes should not be possible.
5983 \begin_layout Standard
5984 To have several \SpecialChar LyX
5985 processes with servers at the same time, you have to use
5986 different configurations, perhaps by using separate user directories, each
5988 \begin_inset Flex Code
5991 \begin_layout Plain Layout
5997 file, for each process.
6000 \begin_layout Standard
6001 If you are developing a client program, you might find it useful to enable
6002 debugging information from the \SpecialChar LyX
6004 Do this by starting \SpecialChar LyX
6006 \begin_inset Flex Code
6009 \begin_layout Plain Layout
6018 \begin_layout Standard
6019 You can find a complete example client written in C++ in the source distribution
6021 \begin_inset Flex Code
6024 \begin_layout Plain Layout
6025 development/lyxserver/server_monitor.cpp
6033 \begin_layout Standard
6034 Another useful tool is the command-line based client found in
6035 \begin_inset Flex Code
6038 \begin_layout Plain Layout
6039 src/client/lyxclient
6047 \begin_layout Section
6048 Normal communication
6051 \begin_layout Standard
6052 To issue a \SpecialChar LyX
6053 call, the client writes a line of ASCII text into the input
6055 This line has the following format:
6072 \begin_layout Description
6073 clientname is a name that the client can choose arbitrarily.
6074 Its only use is that \SpecialChar LyX
6075 will echo it if it sends an answer—so a client can
6076 dispatch results from different requesters.
6079 \begin_layout Description
6080 function is the function you want \SpecialChar LyX
6082 It is the same as the commands you'd use in the minibuffer.
6085 \begin_layout Description
6086 argument is an optional argument which is meaningful only to some functions
6088 \begin_inset Quotes eld
6092 \begin_inset Quotes erd
6095 LFUN will insert the argument as text at the cursor position).
6098 \begin_layout Standard
6099 The answer from \SpecialChar LyX
6100 will arrive in the output pipe and be of the form
6117 \begin_layout Standard
6126 are just echoed from the command request, while
6130 is more or less useful information filled according to how the command
6131 execution worked out.
6132 Some commands, such as
6133 \begin_inset Quotes eld
6137 \begin_inset Quotes erd
6140 , will return information about the internal state of \SpecialChar LyX
6142 return an empty data-response.
6143 This means that the command execution went fine.
6146 \begin_layout Standard
6147 In case of errors, the response from \SpecialChar LyX
6165 \begin_layout Standard
6170 should contain an explanation of why the command failed.
6173 \begin_layout Standard
6177 \begin_layout LyX-Code
6178 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6179 \begin_inset Newline newline
6182 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6183 \begin_inset Newline newline
6186 read a <~/.lyxpipe.out
6187 \begin_inset Newline newline
6193 \begin_layout Subsection
6194 AppleScript (Mac OS X)
6197 \begin_layout Standard
6198 Since \SpecialChar LyX
6199 2.1, \SpecialChar LyX
6200 supports basic interactions with AppleScript for normal communicatio
6201 n through the command run.
6202 This command takes a direct argument (the
6206 to perform) and an optional argument.
6207 It either returns the output of the function or triggers an error with
6208 the error message and code.
6211 \begin_layout Standard
6215 \begin_layout LyX-Code
6216 tell application "\SpecialChar LyX
6220 \begin_layout LyX-Code
6224 \begin_layout LyX-Code
6225 -- Stores the current file name into f
6228 \begin_layout LyX-Code
6229 set f to (run "server-get-filename" with argument "")
6232 \begin_layout LyX-Code
6233 on error the error_message number the error_number
6236 \begin_layout LyX-Code
6237 display dialog "Error: " & the error_number & ".
6241 \begin_layout LyX-Code
6242 & the error_message buttons {"OK"} default button 1
6245 \begin_layout LyX-Code
6249 \begin_layout LyX-Code
6253 \begin_layout Section
6257 \begin_layout Standard
6259 can notify clients of events going on asynchronously.
6260 Currently it will only do this if the user binds a key sequence with the
6262 \begin_inset Quotes eld
6266 \begin_inset Quotes erd
6270 The format of the string \SpecialChar LyX
6271 sends is as follows:
6275 \begin_inset Flex Code
6278 \begin_layout Plain Layout
6289 \begin_layout Standard
6294 is the printed representation of the key sequence that was actually typed
6298 \begin_layout Standard
6299 This mechanism can be used to extend \SpecialChar LyX
6300 's command set and implement macros.
6301 Bind some key sequence to
6302 \begin_inset Quotes eld
6306 \begin_inset Quotes erd
6310 Then start a client that listens on the output pipe, dispatches the command
6311 according to the sequence, and starts a function that may use \SpecialChar LyX
6314 requests to issue a command or a series of commands to \SpecialChar LyX
6318 \begin_layout Section
6319 The simple \SpecialChar LyX
6323 \begin_layout Standard
6325 implements a simple protocol that can be used for session management.
6326 All messages are of the form
6339 \begin_layout Standard
6345 \begin_inset Quotes eld
6349 \begin_inset Quotes erd
6353 \begin_inset Quotes eld
6357 \begin_inset Quotes erd
6362 \begin_inset Quotes eld
6366 \begin_inset Quotes erd
6369 is received from a client, \SpecialChar LyX
6370 will report back to inform the client that
6371 it's listening to it's messages, while
6372 \begin_inset Quotes eld
6376 \begin_inset Quotes erd
6379 sent from \SpecialChar LyX
6380 will inform clients that \SpecialChar LyX
6384 \begin_layout Section
6385 Reverse DVI/PDF search
6388 \begin_layout Standard
6389 Some DVI/PDF viewers
6393 \begin_layout Plain Layout
6394 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6395 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6404 facility (also called
6409 This means that you can tell \SpecialChar LyX
6410 to put the cursor to a specific line in the
6411 document by clicking at the respective position in the DVI/PDF output.
6412 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6414 This is done via the \SpecialChar LyX
6415 server either by using the named pipe (
6419 ), or the UNIX domain socket (
6423 ) that \SpecialChar LyX
6424 creates in its temporary directory (this is the way the
6425 \begin_inset Flex Code
6428 \begin_layout Plain Layout
6434 program communicates with \SpecialChar LyX
6436 In some cases, you need a helper script that mediates between the viewer
6437 and \SpecialChar LyX
6438 , in others, the viewer can communicate with \SpecialChar LyX
6440 This depends on the selected viewer and on your operating system.
6441 The same applies to the way viewers need to be configured and the way the
6442 reverse search is actually performed.
6443 In what follows, we will thus describe how to setup reverse search for
6445 Before we turn to this, though, we will explain what needs to be done generally
6446 to enable reverse search in the DVI/PDF output.
6449 \begin_layout Subsection
6451 \begin_inset CommandInset label
6453 name "subsec:rev-search"
6460 \begin_layout Standard
6461 In most cases \SpecialChar LyX
6462 will do the work for you by enabling the option
6463 \begin_inset Flex Noun
6466 \begin_layout Plain Layout
6467 Synchronize with Output
6473 \begin_inset Flex Noun
6476 \begin_layout Plain Layout
6477 Document\SpecialChar menuseparator
6478 Settings\SpecialChar menuseparator
6485 In such a case \SpecialChar LyX
6486 will automatically insert the necessary Sync\SpecialChar TeX
6488 PDF) or load the srcltx package (for DVI) respectively.
6489 This option can be easily reached also on
6490 \begin_inset Flex Code
6493 \begin_layout Plain Layout
6502 \begin_layout Standard
6503 If you need a different setting, you can select or input a custom macro
6504 from the drop down box just below
6505 \begin_inset Flex Noun
6508 \begin_layout Plain Layout
6509 Document\SpecialChar menuseparator
6510 Settings\SpecialChar menuseparator
6511 Output\SpecialChar menuseparator
6512 Synchronize with Output
6520 \begin_layout Standard
6521 Note that the method
6522 \begin_inset Flex Code
6525 \begin_layout Plain Layout
6533 enables gzip compression.
6534 If your viewer does not support it, you should instead use
6535 \begin_inset Flex Code
6538 \begin_layout Plain Layout
6549 \begin_layout Standard
6550 Please also note that including the
6551 \begin_inset Flex Code
6554 \begin_layout Plain Layout
6561 \begin_inset Flex Code
6564 \begin_layout Plain Layout
6570 sometimes has an undesired impact on the typesetting.
6571 Thus, you should switch output synchronization off for the final typesetting
6573 \begin_inset Flex Code
6576 \begin_layout Plain Layout
6583 \begin_inset Flex Code
6586 \begin_layout Plain Layout
6596 \begin_layout Standard
6597 In case you need some more special settings that are not covered by the
6598 automatic settings, read the next section about how to set up output synchroniz
6600 If the automatic setup suits your needs, you can readily jump to section
6601 \begin_inset space ~
6605 \begin_inset CommandInset ref
6607 reference "subsec:configuring-viewers"
6611 , where the necessary configuration steps in your viewer – needed both with
6612 the automatic and the manual setup – are described.
6615 \begin_layout Subsection
6619 \begin_layout Standard
6621 provides several different methods for reverse search.
6622 Some are built-in in the
6623 \begin_inset Flex Code
6626 \begin_layout Plain Layout
6632 program, some are provided by external packages.
6633 Your choice depends on whether your \SpecialChar LaTeX
6634 distribution already provides a given
6635 method (the built-in methods are rather new) and whether your viewer can
6637 The available methods are described in the following.
6640 \begin_layout Subsubsection*
6641 Built-in DVI-search via src-specials (DVI only)
6644 \begin_layout Standard
6645 This method provides the DVI file with the necessary information for reverse
6647 It is available in \SpecialChar LaTeX
6648 since quite some time (any somewhat recent \SpecialChar LaTeX
6650 should include it), and it works reliably.
6651 To enable it, change the
6652 \begin_inset Flex Noun
6655 \begin_layout Plain Layout
6666 \begin_inset Flex Noun
6669 \begin_layout Plain Layout
6680 \begin_inset Flex Noun
6683 \begin_layout Plain Layout
6684 Preferences\SpecialChar menuseparator
6685 File Handling\SpecialChar menuseparator
6692 \begin_inset Flex Code
6695 \begin_layout Plain Layout
6696 latex -src-specials $$i
6702 If this doesn't work, check if your \SpecialChar TeX
6703 engine needs different options (the
6704 syntax might differ in some distributions).
6707 \begin_layout Subsubsection*
6708 External Packages (PDFSync and scrltx)
6711 \begin_layout Standard
6720 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6722 In order to enable it, load the packages in the \SpecialChar LyX
6726 \begin_layout Itemize
6727 \begin_inset Flex Code
6730 \begin_layout Plain Layout
6738 for reverse PDF search,
6741 \begin_layout Itemize
6742 \begin_inset Flex Code
6745 \begin_layout Plain Layout
6748 usepackage[active]{srcltx}
6753 for reverse DVI search.
6756 \begin_layout Standard
6757 If you want to be able to perform both DVI and PDF reverse searches, you
6758 can also insert in the preamble the following lines
6761 \begin_layout LyX-Code
6765 \begin_inset Newline newline
6771 \begin_inset Newline newline
6777 \begin_inset Newline newline
6783 \begin_inset Newline newline
6788 usepackage[active]{srcltx}
6789 \begin_inset Newline newline
6797 \begin_layout Standard
6798 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6799 right package will be used.
6802 \begin_layout Standard
6803 Note that PDFSync might affect the output layout of your document.
6804 It is therefore advised to disable PDFsync for final documents.
6807 \begin_layout Subsubsection*
6808 Built-in reverse search via Sync\SpecialChar TeX
6812 \begin_layout Standard
6814 \begin_inset Flex Code
6817 \begin_layout Plain Layout
6823 have built-in support for both PDF and DVI reverse search.
6826 Sync\SpecialChar TeX
6829 facility is basically the result of the integration of the PDFSync package
6830 to the pdftex program and its merge with the
6835 You need at least \SpecialChar TeX
6836 Live 2008 or a recent Mik\SpecialChar TeX
6837 distribution in order to use
6842 \begin_layout Plain Layout
6843 For some reason, Mik\SpecialChar TeX
6844 does not understand/obey the command \SpecialChar LyX
6846 the preamble when you check the "Enable Forward/Reverse Search" button
6847 in the toolbar and does not generate the necessary info.
6850 \begin_layout Plain Layout
6851 The generation of the required info can be forced by changing the converter
6853 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
6854 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
6855 the -synctex=1 switch).
6860 Also note that only a few PDF viewers (Okular and Qpdfview on Unix, Skim
6861 on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
6865 \begin_layout Standard
6866 To enable Sync\SpecialChar TeX
6867 for DVI output, change the
6868 \begin_inset Flex Noun
6871 \begin_layout Plain Layout
6882 \begin_inset Flex Noun
6885 \begin_layout Plain Layout
6896 \begin_inset Flex Noun
6899 \begin_layout Plain Layout
6900 Preferences\SpecialChar menuseparator
6901 File Handling\SpecialChar menuseparator
6908 \begin_inset Flex Code
6911 \begin_layout Plain Layout
6912 latex -synctex=1 $$i
6917 , and for PDF output, change the
6918 \begin_inset Flex Noun
6921 \begin_layout Plain Layout
6926 (pdflatex) -> PDF (pdflatex)
6932 \begin_inset Flex Code
6935 \begin_layout Plain Layout
6936 pdflatex -synctex=1 $$i
6942 Check the documentation of your viewer whether the viewer needs to be configure
6943 d for the use with Sync\SpecialChar TeX
6948 \begin_layout Plain Layout
6949 Note that the option
6950 \begin_inset Flex Code
6953 \begin_layout Plain Layout
6959 option enables gzip compression.
6960 If your viewer does not support it, you should instead use
6961 \begin_inset Flex Code
6964 \begin_layout Plain Layout
6978 \begin_layout Subsection
6979 Configuring and using specific viewers
6980 \begin_inset CommandInset label
6982 name "subsec:configuring-viewers"
6989 \begin_layout Subsubsection*
6990 Xdvi (all platforms)
6993 \begin_layout Standard
6995 \begin_inset Flex Code
6998 \begin_layout Plain Layout
7004 , you don't need to do anything else for performing a reverse DVI search,
7006 already provides the necessary hooks for automatically using the
7007 \begin_inset Flex Code
7010 \begin_layout Plain Layout
7017 Just setup your document as described above (reverse search is triggered
7018 by Ctrl-click or Alt-click on Mac OSX, respectively).
7021 \begin_layout Standard
7022 However, if for whatever reason you want to use the named pipe instead of
7023 the socket for communicating with \SpecialChar LyX
7024 , simply change the DVI viewer in
7025 \begin_inset Flex Noun
7028 \begin_layout Plain Layout
7029 Preferences\SpecialChar menuseparator
7030 File Handling\SpecialChar menuseparator
7040 \begin_layout Plain Layout
7041 On Mac OSX you have to use
7042 \begin_inset Flex Code
7045 \begin_layout Plain Layout
7046 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7057 \begin_inset Flex Code
7060 \begin_layout Plain Layout
7061 xdvi -editor "lyxeditor.sh %f %l"
7067 \begin_inset Flex Code
7070 \begin_layout Plain Layout
7076 is a suitable script.
7077 For example, a minimal shell script is the following one:
7080 \begin_layout LyX-Code
7082 \begin_inset Newline newline
7085 LYXPIPE="/path/to/lyxpipe"
7086 \begin_inset Newline newline
7089 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7090 \begin_inset Newline newline
7093 echo "$COMMAND" > "${LYXPIPE}".in || exit
7094 \begin_inset Newline newline
7097 read TMP < "${LYXPIPE}".out || exit
7100 \begin_layout Standard
7102 \begin_inset Flex Code
7105 \begin_layout Plain Layout
7111 is the LyXServer pipe path specified in
7112 \begin_inset Flex Noun
7115 \begin_layout Plain Layout
7116 Preferences\SpecialChar menuseparator
7126 \begin_layout Plain Layout
7128 \begin_inset Flex Code
7131 \begin_layout Plain Layout
7137 folder of a source distribution you can find a
7138 \begin_inset Flex Code
7141 \begin_layout Plain Layout
7147 script which is able to locate the
7151 based on your preferences.
7159 \begin_layout Subsubsection*
7163 \begin_layout Standard
7165 \begin_inset Flex Code
7168 \begin_layout Plain Layout
7169 /Applications/MacDviX_Folder/calleditor.script
7174 , add the following lines:
7177 \begin_layout LyX-Code
7178 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7179 \begin_inset Newline newline
7185 \begin_layout Standard
7186 Modify the lines accordingly if you install \SpecialChar LyX
7187 somewhere else than in the
7188 Applications folder.
7191 \begin_layout Standard
7192 Reverse search is triggered by Alt-click (OPTION-click).
7195 \begin_layout Subsubsection*
7199 \begin_layout Standard
7201 \begin_inset Flex Code
7204 \begin_layout Plain Layout
7205 open -a Skim.app $$i
7210 to the viewer setting in
7211 \begin_inset Flex Noun
7214 \begin_layout Plain Layout
7215 Preferences\SpecialChar menuseparator
7216 File Handling\SpecialChar menuseparator
7217 File formats\SpecialChar menuseparator
7224 \begin_inset Flex Noun
7227 \begin_layout Plain Layout
7228 Skim\SpecialChar menuseparator
7229 Preferences\SpecialChar menuseparator
7236 \begin_inset Flex Noun
7239 \begin_layout Plain Layout
7245 preset and enter command
7246 \begin_inset Flex Noun
7249 \begin_layout Plain Layout
7250 /Applications/\SpecialChar LyX
7251 .app/Contents/MacOS/lyxeditor
7259 \begin_layout Standard
7260 Reverse search is triggered by COMMAND-SHIFT-click
7263 \begin_layout Subsubsection*
7267 \begin_layout Standard
7268 Reverse search with evince does not work out of the box, but it can be achieved
7269 by means of some third party helper scripts.
7271 \begin_inset CommandInset href
7273 target "http://wiki.lyx.org/LyX/SyncTeX"
7281 \begin_layout Subsubsection*
7285 \begin_layout Standard
7287 \begin_inset Flex Noun
7290 \begin_layout Plain Layout
7291 Settings\SpecialChar menuseparator
7292 Configure Okular\SpecialChar menuseparator
7299 \begin_inset Quotes eld
7303 \begin_inset Quotes erd
7307 \begin_inset Flex Code
7310 \begin_layout Plain Layout
7319 \begin_layout Standard
7320 Reverse search is triggered by SHIFT-click.
7323 \begin_layout Subsubsection*
7327 \begin_layout Standard
7328 Qpdfview supports Sync\SpecialChar TeX
7329 since version 0.3.5.
7331 \begin_inset Flex Noun
7334 \begin_layout Plain Layout
7335 Edit\SpecialChar menuseparator
7336 Settings\SpecialChar menuseparator
7342 , click on the input field of the
7343 \begin_inset Quotes eld
7347 \begin_inset Quotes erd
7350 item and add the command
7351 \begin_inset Flex Code
7354 \begin_layout Plain Layout
7363 \begin_layout Standard
7364 Reverse search is triggered by double-click or, in more recent versions,
7368 \begin_layout Subsubsection*
7372 \begin_layout Standard
7373 Launch yap, choose its
7374 \begin_inset Flex Noun
7377 \begin_layout Plain Layout
7378 View\SpecialChar menuseparator
7385 \begin_inset Quotes eld
7389 \begin_inset Quotes erd
7394 \begin_inset Quotes eld
7397 New\SpecialChar ldots
7399 \begin_inset Quotes erd
7402 button and, in the window that opens, enter
7403 \begin_inset Quotes eld
7408 \begin_inset Quotes erd
7411 (or any other name you like) in the
7412 \begin_inset Quotes eld
7416 \begin_inset Quotes erd
7420 Now click on the button labeled
7421 \begin_inset Quotes eld
7426 \begin_inset Quotes erd
7429 to open a file dialog and navigate to the directory containing the batch
7431 \begin_inset Flex Code
7434 \begin_layout Plain Layout
7442 \begin_inset Flex Code
7445 \begin_layout Plain Layout
7451 and then specify the program arguments as
7452 \begin_inset Flex Code
7455 \begin_layout Plain Layout
7463 \begin_inset Flex Code
7466 \begin_layout Plain Layout
7472 wrapper is used for communicating with \SpecialChar LyX
7480 \begin_layout LyX-Code
7482 \begin_inset Newline newline
7485 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
7494 \begin_inset Newline newline
7508 \begin_layout Standard
7509 Make sure that the \SpecialChar LyX
7510 Server pipe path you specified in \SpecialChar LyX
7512 \begin_inset Flex Code
7515 \begin_layout Plain Layout
7529 , otherwise change the
7530 \begin_inset Flex Code
7533 \begin_layout Plain Layout
7539 wrapper accordingly.
7542 \begin_layout Standard
7543 In yap, reverse search is triggered by double-click.
7546 \begin_layout Subsubsection*
7547 SumatraPDF (Windows)
7550 \begin_layout Standard
7551 In order to use SumatraPDF for inverse search, enter
7552 \begin_inset Flex Code
7555 \begin_layout Plain Layout
7556 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
7561 in the viewer setting in
7562 \begin_inset Flex Noun
7565 \begin_layout Plain Layout
7566 Preferences\SpecialChar menuseparator
7567 File Handling\SpecialChar menuseparator
7568 File formats\SpecialChar menuseparator
7575 \begin_inset Flex Code
7578 \begin_layout Plain Layout
7584 is the previous wrapper.
7585 If SumatraPDF.exe is not in your command PATH, use its full file name.
7588 \begin_layout Standard
7589 Reverse search is triggered by double-click.
7592 \begin_layout Subsubsection*
7596 \begin_layout Standard
7597 First of all, make sure that yap is your default DVI viewer in the Windows
7598 environment, then launch it, choose its
7599 \begin_inset Flex Noun
7602 \begin_layout Plain Layout
7603 View\SpecialChar menuseparator
7610 \begin_inset Quotes eld
7614 \begin_inset Quotes erd
7619 \begin_inset Quotes eld
7622 New\SpecialChar ldots
7624 \begin_inset Quotes erd
7627 button and, in the window that opens, enter
7628 \begin_inset Quotes eld
7633 \begin_inset Quotes erd
7636 (or any other name you like) in the
7637 \begin_inset Quotes eld
7641 \begin_inset Quotes erd
7645 Now click on the button labeled
7646 \begin_inset Quotes eld
7651 \begin_inset Quotes erd
7654 to open a file dialog and navigate to the directory containing the
7655 \begin_inset Flex Code
7658 \begin_layout Plain Layout
7664 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7667 \begin_inset Flex Code
7670 \begin_layout Plain Layout
7676 and then specify the program arguments as
7677 \begin_inset Flex Code
7680 \begin_layout Plain Layout
7687 In this way, you will be using the
7691 for communicating with \SpecialChar LyX
7693 If, for whatever reason, you want to use the
7698 \begin_inset Flex Code
7701 \begin_layout Plain Layout
7707 option and be sure to specify the \SpecialChar LyX
7708 Server pipe path in the \SpecialChar LyX
7712 \begin_layout Standard
7713 In yap, reverse search is triggered by double-click.
7716 \begin_layout Subsubsection*
7720 \begin_layout Standard
7721 In order to use SumatraPDF for inverse search, enter
7722 \begin_inset Flex Code
7725 \begin_layout Plain Layout
7726 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7731 in the viewer setting in
7732 \begin_inset Flex Noun
7735 \begin_layout Plain Layout
7736 Preferences\SpecialChar menuseparator
7737 File Handling\SpecialChar menuseparator
7738 File formats\SpecialChar menuseparator
7745 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7747 \begin_inset Flex Code
7750 \begin_layout Plain Layout
7756 enables communication via the
7762 \begin_inset Flex Code
7765 \begin_layout Plain Layout
7771 option if you want to use the
7775 , and be sure to specify the \SpecialChar LyX
7776 Server pipe path in the \SpecialChar LyX
7780 \begin_layout Standard
7781 Reverse search is triggered by double-click.
7784 \begin_layout Section
7788 \begin_layout Standard
7789 Forward search is, as the name implies, in a sense the
7790 \begin_inset Quotes eld
7794 \begin_inset Quotes erd
7798 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7800 If forward search is set up (as described in what follows), you can put
7801 the cursor anywhere in your \SpecialChar LyX
7803 \begin_inset Flex Noun
7806 \begin_layout Plain Layout
7807 Navigate\SpecialChar menuseparator
7814 \begin_inset Flex Noun
7817 \begin_layout Plain Layout
7823 in the context menu via right mouse click), and then the viewer will jump
7824 to that position as well.
7825 This implies, of course, that your viewer supports this function.
7828 \begin_layout Standard
7829 To make forward search possible, you first need to provide the generated
7830 output PDF/DVI file with additional information about the \SpecialChar TeX
7832 This can be done via the methods described in the section
7833 \begin_inset CommandInset ref
7835 reference "subsec:rev-search"
7842 \begin_layout Standard
7843 Additionally, you need to configure \SpecialChar LyX
7844 for using your viewers in
7845 \begin_inset Flex Noun
7848 \begin_layout Plain Layout
7849 Tools\SpecialChar menuseparator
7850 Preferences\SpecialChar menuseparator
7851 Output\SpecialChar menuseparator
7858 We provide a range of tested configurations for some viewers, which you
7859 can select from the drop down list.
7860 If none of these configurations suits you, you have to find out and enter
7861 a suitable configuration yourself.
7862 The definition syntax uses the following placeholders:
7865 \begin_layout Itemize
7867 \begin_inset Flex Code
7870 \begin_layout Plain Layout
7879 \begin_layout Itemize
7881 \begin_inset Flex Code
7884 \begin_layout Plain Layout
7890 : name of the (temporary) exported .tex file (without path)
7893 \begin_layout Itemize
7895 \begin_inset Flex Code
7898 \begin_layout Plain Layout
7904 : name of the (temporary) exported .tex file (including path)
7907 \begin_layout Itemize
7909 \begin_inset Flex Code
7912 \begin_layout Plain Layout
7918 : name of the exported output file (either dvi or pdf, depending on which
7919 one exists in the temporary directory)
7922 \begin_layout Standard
7923 Note that only some of the viewers provide full and usable forward search
7924 functionality out of the box, among them yap, xdvi, okular
7928 \begin_layout Plain Layout
7929 You might want to set
7930 \begin_inset Flex Code
7933 \begin_layout Plain Layout
7940 \begin_inset Flex Noun
7943 \begin_layout Plain Layout
7944 Tools\SpecialChar menuseparator
7945 Preferences\SpecialChar menuseparator
7946 File Handling\SpecialChar menuseparator
7948 \begin_inset space ~
7961 , qpdfview, and SumatraPDF
7965 \begin_layout Plain Layout
7966 SumatraPDF can also use DDE commands through the external program CMCDDE
7968 \begin_inset CommandInset href
7970 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
7981 Others, such as evince
7985 \begin_layout Plain Layout
7986 \paragraph_spacing single
7987 Forward search with evince can be achieved by means of third party helper
7990 \begin_inset CommandInset href
7992 target "http://wiki.lyx.org/LyX/SyncTeX"
8002 , require some extra tools in order to use forward search.
8003 While many of the widespread PDF viewers (most notably Adobe Reader) do
8004 not support forward search at all, some other viewers – e.
8005 \begin_inset space \thinspace{}
8009 xpdf – allow at least to reload the document and jump to a specific page
8010 of the file, so you can at least navigate
8011 \begin_inset Quotes eld
8015 \begin_inset Quotes erd
8019 This latter functionality is provided by an external call of synctex (see
8020 the predefined example configurations).
8024 \begin_layout Standard
8025 Forward search works both with DVI and PDF output.
8027 simply checks which preview format you have used before (i.
8028 \begin_inset space \thinspace{}
8031 e., which format is already there in the temporary directory) and chooses
8032 the appropriate configuration for the respective format.
8035 \begin_layout Chapter
8036 Special Document Classes
8039 \begin_layout Section
8043 \begin_layout Standard
8049 \begin_layout Subsection
8053 \begin_layout Standard
8054 This section describes how \SpecialChar LyX
8055 can be used to write articles for submission
8056 to the scientific journal
8058 Astronomy and Astrophysics
8061 \begin_inset Flex URL
8064 \begin_layout Plain Layout
8066 http://www.edpsciences.fr/aa/
8071 ) using Version 5.01 of the document class
8076 This package can be downloaded from the ftp site
8079 \begin_layout Standard
8080 \begin_inset VSpace medskip
8086 \begin_layout Standard
8088 \begin_inset Flex URL
8091 \begin_layout Plain Layout
8093 ftp://ftp.edpsciences.org/pub/aa/readme.html
8101 \begin_layout Standard
8102 \begin_inset VSpace medskip
8108 \begin_layout Standard
8109 A manual comes together with that package, and this text is not meant to
8110 replace the original manual but is merely a short guide in how to realize
8111 the correct form of your paper.
8115 \begin_layout Standard
8116 Please note that the publisher of the journal was changed from Springer
8117 to EDP Sciences starting January 1, 2001.
8118 That change involved also some slight changes to the style files, namely
8119 the removal of the thesaurus command.
8120 The \SpecialChar LyX
8121 class aa supports the newest version of these style files, V 5.01.
8122 If you have an older version installed, please upgrade.
8123 For compatibility, the old (version 4) layout has been kept as
8128 Please refer to the comments in
8131 Dir/layouts/aapaper.layout
8136 \begin_layout Subsection
8140 \begin_layout Standard
8141 It is recommended you start from the example template distributed with \SpecialChar LyX
8143 If you are not using a template, note the following settings:
8146 \begin_layout Itemize
8153 Document\SpecialChar menuseparator
8156 dialog (OK, that one was obvious).
8159 \begin_layout Itemize
8160 Don't change the option
8163 \begin_inset space ~
8173 The whole layout is done by the macros, you shouldn't change anything.
8176 \begin_layout Subsection
8180 \begin_layout Standard
8181 First thing to enter is the header information.
8182 It consists of seven entries, of which some are optional.
8186 \begin_layout Itemize
8194 \begin_layout Itemize
8202 \begin_layout Itemize
8210 \begin_layout Itemize
8218 \begin_layout Itemize
8223 : [optional] if more than one author: whom to contact for offprint requests.
8226 \begin_layout Itemize
8231 : [optional] mail address for contacts.
8234 \begin_layout Itemize
8242 Received: <date>; Accepted <date>
8245 \begin_layout Standard
8246 There is no need to issue the
8252 command, this is done automatically by \SpecialChar LyX
8253 when the header is finished.
8254 Although the order of the single header entries doesn't matter it is advised
8255 to keep the above sequence, just to get the best optics and meets the layout
8256 of the real document.
8259 \begin_layout Standard
8260 If you want to place footnotes in the header block, e.
8261 \begin_inset space \thinspace{}
8265 \begin_inset space \space{}
8268 to state your present address, just use the standard footnote via the menu
8271 Insert\SpecialChar menuseparator
8276 will automagically use the term
8285 \begin_layout Standard
8286 In addition to these topics, the macros use three additional \SpecialChar LaTeX
8288 have no counterpart in \SpecialChar LyX
8292 \begin_layout Itemize
8299 to separate different names for more than one author and institute, respectivel
8303 \begin_layout Itemize
8310 to mark corresponding author/institute pairs.
8311 The institutes are numbered sequentially as they appear in the
8315 field, so you have to put a marker to each author.
8318 \begin_layout Itemize
8325 to supply an email address for fast contact.
8328 \begin_layout Standard
8329 In all cases, the appropriate command has to be entered in \SpecialChar LyX
8337 \begin_layout Subsection
8341 \begin_layout Standard
8342 The abstract should immediately follow the header block.
8343 With version 5 the abstract environment was changed to a command, and there
8344 is now a resctriction to only one paragraph.
8345 In addition, it should contain an entry with the keywords.
8346 This is not yet implemented for \SpecialChar LyX
8347 , therefore you have to enter the \SpecialChar LaTeX
8355 by hand and mark it as \SpecialChar LaTeX
8357 Refer to the example paper.
8360 \begin_layout Subsection
8361 Supported environments
8364 \begin_layout Standard
8365 The A&A paper layout supports the following environments for structuring
8369 \begin_layout Itemize
8375 \begin_layout Itemize
8381 \begin_layout Itemize
8387 \begin_layout Itemize
8393 \begin_layout Itemize
8399 \begin_layout Itemize
8405 \begin_layout Itemize
8411 \begin_layout Itemize
8417 \begin_layout Itemize
8423 \begin_layout Itemize
8429 \begin_layout Itemize
8435 \begin_layout Itemize
8442 \begin_layout Subsection
8443 Commands not supported by \SpecialChar LyX
8447 \begin_layout Standard
8448 Some commands are not yet supported by the
8452 layout for \SpecialChar LyX
8454 Some have already been mentioned.
8455 For the sake of completeness, they are listed all together here:
8458 \begin_layout Itemize
8466 \begin_layout Itemize
8474 \begin_layout Itemize
8482 \begin_layout Itemize
8490 \begin_layout Itemize
8498 \begin_layout Itemize
8506 \begin_layout Itemize
8514 \begin_layout Itemize
8522 \begin_layout Standard
8523 If you want to use any of these commands, you have to enter them yourself.
8526 Do not forget to mark them as \SpecialChar LaTeX
8530 \begin_layout Subsection
8531 Figure and Table Floats
8534 \begin_layout Standard
8536 provides support for the necessary float environments
8538 figure, figure*, table
8544 , therefore we won't tell much about it here.
8548 \begin_inset space ~
8554 Just remember that tables should be left-aligned.
8555 For that, select the table and change the alignment in
8557 Edit\SpecialChar menuseparator
8559 \begin_inset space ~
8565 \begin_layout Standard
8566 There is only one special thing: the figures with caption besides the figure.
8567 To create such a figure, you have to do the following:
8570 \begin_layout Enumerate
8571 Create a wide figure float:
8573 Insert\SpecialChar menuseparator
8574 Float\SpecialChar menuseparator
8577 , then right click in the figure and select
8580 \begin_inset space ~
8588 \begin_layout Enumerate
8589 Enter your caption text.
8592 \begin_layout Enumerate
8597 to move the cursor above the caption.
8600 \begin_layout Enumerate
8604 \begin_layout Enumerate
8605 Position the cursor behind the figure and insert a horizontal fill:
8607 Insert\SpecialChar menuseparator
8609 \begin_inset space ~
8612 Character\SpecialChar menuseparator
8614 \begin_inset space ~
8622 \begin_layout Enumerate
8623 Switch to \SpecialChar LaTeX
8627 \begin_inset space ~
8635 \begin_layout Enumerate
8645 Do not close the brace!
8648 \begin_layout Enumerate
8649 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8654 \begin_inset space ~
8666 \begin_layout Standard
8667 Also, refer to the figures in the example paper.
8670 \begin_layout Subsection
8674 \begin_layout Standard
8675 For submission, the paper has to be formated in a special double-spacing
8677 For this purpose, you have to give the option
8681 to the documentclass.
8682 This must be done using the extra class options field in the
8684 Document\SpecialChar menuseparator
8688 Just enter the string
8695 \begin_layout Subsection
8699 \begin_layout Standard
8704 directory contains an example paper written with \SpecialChar LyX
8706 It is the example paper from the original macro package, translated to
8709 Use it for inspiration, and compare the original \SpecialChar LaTeX
8710 code with \SpecialChar LyX
8714 \begin_layout Section
8719 \begin_layout Standard
8725 \begin_layout Subsection
8729 \begin_layout Standard
8731 is a set of macros produced by the American Astronomical Society to
8732 facilitate electronic manuscript submission to the three journals they
8733 publish: the Astrophysical Journal (including the Letters and Supplement),
8734 the Astronomical Journal, and the Publications of the Astronomical Society
8737 has proven to be an excellent tool for generating these documents, especially
8738 given its equation, citation, and figure handling capabilities.
8740 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8741 is the version described here, or higher.
8742 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8743 2.09 and are fundamentally
8744 incompatible with \SpecialChar LyX
8746 The AAS\SpecialChar TeX
8747 package may be downloaded from the AAS\SpecialChar TeX
8751 \begin_layout Standard
8752 \begin_inset VSpace medskip
8758 \begin_layout Standard
8760 \begin_inset Flex URL
8763 \begin_layout Plain Layout
8765 https://aas.org/aastex/aastex-downloads
8773 \begin_layout Standard
8774 \begin_inset VSpace medskip
8780 \begin_layout Standard
8781 A complete user guide is contained in that package and you should familiarize
8782 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8785 will not reduce the need to figure out all the AAS\SpecialChar TeX
8786 commands, it will only
8787 reduce the drudgery of typing everything in.
8788 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8790 completely to the requirements of the journal to which you are submitting
8794 \begin_layout Subsection
8795 Starting a New Paper
8798 \begin_layout Standard
8799 I strongly suggest that you start with the AAS\SpecialChar TeX
8803 File\SpecialChar menuseparator
8810 , enter the new file name, then choose the
8815 This will show the most common fields found in a manuscript.
8816 Simply overwrite the existing text (including the brackets,
8820 ) with the correct information.
8821 Many of the AAS\SpecialChar TeX
8822 commands and environments can be implemented directly in
8824 , but some cannot: most noticeably
8836 , which should stick out like a sore thumb if you actually just opened the
8838 For commands such as these, the \SpecialChar LaTeX
8839 code must be entered directly and marked
8841 Such commands are referred to as \SpecialChar TeX
8842 code, or Evil Red Text.
8843 I tried to minimize the amount of \SpecialChar TeX
8844 code needed in an AAS\SpecialChar TeX
8846 there is still a bit more required than any of us would like.
8849 \begin_layout Subsection
8850 Finishing Your Paper
8853 \begin_layout Standard
8854 When the paper is finished to your satisfaction and previews/prints correctly,
8856 \begin_inset Quotes eld
8860 \begin_inset Quotes erd
8863 actions which need to be done before you submit it to the journals.
8867 \begin_layout Enumerate
8868 Export your paper as a \SpecialChar LaTeX
8871 File\SpecialChar menuseparator
8872 Export\SpecialChar menuseparator
8880 \begin_layout Enumerate
8885 file with your favorite text editor
8889 \begin_layout Enumerate
8890 remove the comment lines before the
8899 \begin_layout Enumerate
8904 usepackage...{fontenc}
8906 line if it appears (usually just after
8921 \begin_layout Enumerate
8922 remove everything between (and including) the
8934 commands, except for any commands you specifically put into the \SpecialChar LaTeX
8936 (which should appear immediately after the
8937 \begin_inset Quotes eld
8940 User specified \SpecialChar LaTeX
8942 \begin_inset Quotes erd
8953 \begin_layout Enumerate
8954 Run the resulting file through \SpecialChar LaTeX
8955 to make sure it still processes correctly.
8958 \begin_layout Enumerate
8959 Reread the journal requirements to make sure your filenames and formats
8963 \begin_layout Enumerate
8967 \begin_layout Subsection
8968 Comments On Specific Commands
8971 \begin_layout Standard
8972 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8979 ) gives a good description of each.
8980 Thus it's probably easiest for me to go down the list as found in the guide
8981 and offer comments where necessary.
8982 So let's begin \SpecialChar ldots
8986 \begin_layout Subsubsection
8987 Things that work as expected
8990 \begin_layout Standard
8991 Because they work as you might expect, I simply list them and the section
9092 begin{thebibliography}
9100 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9101 graphicx figure commands (2.14.1),
9125 (2.15.4, amongst other places),
9152 \begin_layout Standard
9153 The following style options also work correctly:
9174 Simply put them in the
9180 Layout\SpecialChar menuseparator
9186 \begin_layout Subsubsection
9187 Things that work, but require more comment
9190 \begin_layout Standard
9191 The following items work, but require a little more discussion:
9194 \begin_layout Itemize
9195 These items are reserved for use by the journal editors, but you can put
9196 them into the \SpecialChar LaTeX
9197 preamble if you feel compelled to do so:
9230 \begin_layout Itemize
9231 These items may be placed in the \SpecialChar LaTeX
9232 preamble, and are included as blanks in
9254 \begin_layout Itemize
9261 (2.3) – can only be used
9262 \begin_inset Quotes eld
9266 \begin_inset Quotes erd
9269 , not in the middle of a paragraph.
9270 Use \SpecialChar TeX
9271 code if you need to embed it.
9274 \begin_layout Itemize
9281 (2.3) – will have extra {} after it.
9282 This should not cause an error.
9285 \begin_layout Itemize
9292 (2.6) – can only be used
9293 \begin_inset Quotes eld
9297 \begin_inset Quotes erd
9300 , not in the middle of a paragraph.
9301 Use \SpecialChar TeX
9302 code if you need to embed it.
9305 \begin_layout Itemize
9312 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9316 \begin_layout Itemize
9330 \begin_layout Itemize
9337 (2.9) – will have extra {} after it.
9338 This should not cause an error.
9341 \begin_layout Itemize
9348 (2.11) – will have extra {} after it.
9349 This should not cause an error.
9352 \begin_layout Itemize
9359 (2.14.2) – you can insert an optional filename argument by placing the cursor
9360 at the beginning of the text and selecting
9362 Insert\SpecialChar menuseparator
9367 \begin_inset Quotes eld
9371 \begin_inset Quotes erd
9374 inserts an optional argument of the type needed by
9381 Hopefully it will be renamed someday.
9384 \begin_layout Itemize
9397 for the catalog ID optional parameter
9400 \begin_layout Itemize
9413 for the catalog ID optional parameter
9416 \begin_layout Subsubsection
9417 Things not implemented, use \SpecialChar TeX
9421 \begin_layout Standard
9444 setcounter{equation}
9446 (2.12), Journal name abbreviations (2.13.4),
9482 (2.15.4, insert it as the first element in the lefthand cell after where
9484 Don't use any of \SpecialChar LyX
9485 's rules in the table),
9497 (2.15.5), much of Misc (2.17, except
9548 \begin_layout Subsubsection
9549 Things that cannot be implemented
9552 \begin_layout Standard
9554 at least in any meaningful sort of way, so I suggest ignoring them.
9555 They are the references environment (2.13.3), and the deluxetable environment
9557 If you really, really need to use deluxetable, I suggest editing it in
9558 a separate file with a text editor, then using
9560 Insert\SpecialChar menuseparator
9562 \begin_inset space ~
9567 to include it in your \SpecialChar LyX
9573 file to see an example of this.
9576 \begin_layout Subsection
9577 FAQs, Tips, Tricks, and Other Ruminations
9580 \begin_layout Subsubsection
9581 Getting \SpecialChar LyX
9582 and AAS\SpecialChar TeX
9586 \begin_layout Standard
9587 It can be a bit tricky to get \SpecialChar LyX
9588 to recognize a new layout and document class.
9589 When all else fails, do this:
9592 \begin_layout Enumerate
9593 Make certain that \SpecialChar LaTeX
9594 can find AAS\SpecialChar TeX
9596 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9598 directory completely unrelated to \SpecialChar LaTeX
9599 or AAS\SpecialChar TeX
9600 and run \SpecialChar LaTeX
9608 \begin_layout Enumerate
9613 appears in \SpecialChar LyX
9621 \begin_layout Enumerate
9624 Tools\SpecialChar menuseparator
9628 , then restart \SpecialChar LyX
9632 \begin_layout Enumerate
9633 Open a regular new file, not from a template.
9634 Does AAS\SpecialChar TeX
9635 appear in the class list in
9637 Document\SpecialChar menuseparator
9643 \begin_layout Standard
9644 If you get a warning from an existing AAS\SpecialChar TeX
9645 document about not being able
9646 to find the AAS\SpecialChar TeX
9647 layout or a message about
9648 \begin_inset Quotes eld
9651 You should not mix title layouts with normal ones
9652 \begin_inset Quotes erd
9655 , things haven't been installed correctly.
9658 \begin_layout Subsubsection
9660 error processing a table
9663 \begin_layout Standard
9665 , by default, attempts to center the table caption/title.
9666 This seems to produce a bad interaction in AAS\SpecialChar TeX
9667 so you should click somewhere
9668 in the caption/title, then select
9670 Edit\SpecialChar menuseparator
9672 \begin_inset space ~
9686 This took care of it for me.
9689 \begin_layout Subsubsection
9693 \begin_layout Standard
9694 A couple of things: 1) I have noticed some funny spacing in the reference
9695 entries in the text.
9696 When you enter the bibliography item data, make sure their is
9700 space between the last author and the parenthesis setting off the year;
9704 \begin_inset space \thinspace{}
9708 \begin_inset space \space{}
9722 2) Entering the references at all is not obvious.
9723 The easiest thing is to start typing your first reference at the end of
9724 the document, then mark it as type
9729 That will put a small gray box in front of what you just typed.
9730 Click on the box to fill in the rest of the information.
9731 For new references, go to the end of an existing reference and press return.
9732 That will create a new line with its own box, etc.
9735 \begin_layout Subsubsection
9739 \begin_layout Standard
9740 Even though AAS\SpecialChar TeX
9741 provides its own figure commands (
9747 , for example), I much prefer \SpecialChar LaTeX
9748 's standard figure commands (with the default
9757 \begin_inset space ~
9760 commands as \SpecialChar TeX
9761 code into a Figure Float box if you desire, but I never have
9762 much luck getting the layout right.
9763 With the standard graphics, \SpecialChar LyX
9768 usepackage{graphicx}
9770 command into the \SpecialChar LaTeX
9771 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9773 interspersing the figures in the text.
9774 I believe ApJ accepts figures exactly this way now; AJ might still use
9776 \begin_inset Quotes eld
9779 stack everything at the end
9780 \begin_inset Quotes erd
9786 \begin_layout Subsubsection
9787 Things I could have done, but didn't
9790 \begin_layout Standard
9792 \begin_inset Quotes eld
9796 \begin_inset Quotes erd
9799 things I could have implemented, but chose not to.
9800 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9802 even though it is double-spaced in the paper manuscript.
9803 Also, I chose not to make separate layouts for the preprint and preprint2
9805 Since I assume you will spend most of your time in the plain manuscript
9806 mode anyway, I decided not to chew up more disk space with this.
9810 \begin_layout Subsection
9814 \begin_layout Standard
9815 Your mileage may vary.
9816 I've now had papers published by both ApJ and AJ that have had 98% of the
9817 effort done in \SpecialChar LyX
9818 ; the last 2% was the \SpecialChar LaTeX
9819 post-processing and a few cleanups.
9820 I have had no trouble with the submission process, and I'm sure the journals
9821 were never aware that there might be a difference.
9822 So, go forth and publish!
9825 \begin_layout Section
9826 AMS \SpecialChar LaTeX
9830 \begin_layout Standard
9840 \begin_layout Standard
9841 \begin_inset VSpace bigskip
9847 \begin_layout Standard
9849 The AMS \SpecialChar LaTeX
9850 layouts are set up to conform to suggested styles for mathematical
9851 papers to be submitted to American Mathematical Society publications.
9852 The layouts are not tailored to a specific journal, but easily can be.
9853 You should refer to the AMS documentation for specific instructions for
9854 each journal (usually it will entail only changing a single line in the
9857 That documentation is available on the Web at
9858 \begin_inset Flex URL
9861 \begin_layout Plain Layout
9869 \begin_inset Flex URL
9872 \begin_layout Plain Layout
9874 ftp://ftp.ams.org/pub/tex/amslatex/
9880 These layouts are appropriate, and useful, for any mathematical writing.
9884 \begin_layout Standard
9885 There are two basic AMS \SpecialChar LaTeX
9889 \begin_layout Itemize
9890 amsart: The standard AMS article format.
9893 \begin_layout Itemize
9894 amsbook: the standard AMS book (really, monograph) format.
9898 \begin_layout Standard
9899 The layouts themselves contain only the minimum necessary to use the AMS
9901 They do not, in particular, contain any of the `theorem' environments used
9902 for setting theorems, lemmas, and the like.
9903 These are contained, instead, in the
9904 \begin_inset Flex Code
9907 \begin_layout Plain Layout
9913 module, which is loaded by default when you select one of the AMS classes.
9914 (It can also be used with other classes and can be removed, if you would
9915 rather use something else.) Less commonly used environments are in the
9916 \begin_inset Flex Code
9919 \begin_layout Plain Layout
9920 Theorems (AMS-Extended)
9925 module, which must be loaded manually.
9928 \begin_layout Standard
9929 By default, theorems and the like are numbered consecutively throughout
9930 the document, but this may be modified by loading the module
9931 \begin_inset Flex Code
9934 \begin_layout Plain Layout
9935 Theorems (Order by Section)
9940 or, if you are using
9941 \begin_inset Flex Code
9944 \begin_layout Plain Layout
9951 \begin_inset Flex Code
9954 \begin_layout Plain Layout
9955 Theorems (Order by Chapter)
9961 These will number the results as
9962 \begin_inset Formula $n.m$
9965 , where the first number refers to the section (or chapter) and the second
9966 refers to the total number of results so far in that section (or chapter).
9967 Many environments are also available unnumbered.
9968 These are indicated by an asterisk at the end.
9969 If you happen to want
9973 unnumbered results, the module
9974 \begin_inset Flex Code
9977 \begin_layout Plain Layout
9983 provides that option.
9986 \begin_layout Standard
9987 Note that these modules do not
9991 to be used with the AMS classes.
9992 It is perfectly possible to use the
9993 \begin_inset Flex Code
9996 \begin_layout Plain Layout
10002 module, and the others mentioned, with other classes, such as
10003 \begin_inset Flex Code
10006 \begin_layout Plain Layout
10013 \begin_inset Flex Code
10016 \begin_layout Plain Layout
10023 \begin_inset Flex Code
10026 \begin_layout Plain Layout
10035 \begin_layout Subsection
10036 What these layouts provide
10039 \begin_layout Standard
10040 There is a long list of included environments provided by these layouts.
10041 In AMS-\SpecialChar LaTeX
10042 , there is, in fact, an opportunity to define an unlimited variety
10043 of `theorem' environments.
10044 However, the AMS recommends the environments that are available in \SpecialChar LyX
10049 \begin_layout Standard
10050 The following environments—as well as the standard environments, such as
10052 \begin_inset Flex Noun
10055 \begin_layout Plain Layout
10062 \begin_inset Flex Noun
10065 \begin_layout Plain Layout
10072 \begin_inset Flex Noun
10075 \begin_layout Plain Layout
10082 \begin_inset Flex Noun
10085 \begin_layout Plain Layout
10092 \begin_inset Flex Noun
10095 \begin_layout Plain Layout
10102 \begin_inset Flex Code
10105 \begin_layout Plain Layout
10112 \begin_inset Flex Code
10115 \begin_layout Plain Layout
10124 \begin_layout Description
10125 Address This should be the author's permanent address.
10128 \begin_layout Description
10130 \begin_inset space ~
10133 Address This should be the author's temporary address at the time of submission,
10134 if different from the Address.
10137 \begin_layout Description
10138 Email Author's e-mail address
10141 \begin_layout Description
10142 URL Author's Web address, if desired.
10145 \begin_layout Description
10146 Keywords Key words or phrases used to identify specific topics discussed
10150 \begin_layout Description
10151 Subjectclass These refer to the AMS Subject Classifications, published and
10154 Mathematical Reviews
10157 These are also available online at the AMS cites listed above.
10160 \begin_layout Description
10164 \begin_layout Description
10168 \begin_layout Description
10172 \begin_layout Standard
10173 The following environments are provided by both the
10174 \begin_inset Flex Code
10177 \begin_layout Plain Layout
10184 \begin_inset Flex Code
10187 \begin_layout Plain Layout
10193 modules, in the latter case in both starred (unnumbered) and unstarred
10194 (numbered) versions.
10195 These same environments are provided only in the starred versions by the
10197 \begin_inset Flex Code
10200 \begin_layout Plain Layout
10209 \begin_layout Theorem
10210 This is typically used for the statements of major results.
10214 \begin_layout Corollary*
10215 This is used for statements which follow fairly directly from previous statement
10217 Again, these can be major results.
10221 \begin_layout Lemma
10222 These are smaller results needed to prove other statements.
10225 \begin_layout Proposition
10226 These are less major results which (hopefully) add to the general theory
10230 \begin_layout Conjecture
10231 These are statements provided without justification, which the author does
10232 not know how to prove, but which seem to be true (to the author, at least).
10235 \begin_layout Definition*
10236 Guess what this is for.
10237 The font is different for this environment than for the previous ones.
10241 \begin_layout Example*
10242 Used for examples illustrating proven results.
10245 \begin_layout Problem
10246 It's not really known what this is for.
10247 You should figure it out.
10250 \begin_layout Exercise*
10251 Write a description for this one.
10254 \begin_layout Remark
10255 This environment is also a type of theorem, usually a lesser sort of observation.
10258 \begin_layout Claim*
10259 Often used in the course of giving a proof of a larger result.
10263 Generally, these are used to break up long arguments, using specific instances
10269 The numbering scheme for cases is on its own, not together with other numbered
10274 \begin_layout Proof
10275 At the end of this environment, a QED symbol (usually a square, but it can
10276 vary with different styles) is placed.
10277 If you want to have other environments within this one—for example, Case
10278 environments—and have the QED symbol appear only after them, then the other
10279 environments need to be nested within the proof environment.
10282 Nesting Environments
10288 for information on nesting.
10291 \begin_layout Standard
10292 And these environments are provided by
10293 \begin_inset Flex Code
10296 \begin_layout Plain Layout
10297 Theorems (AMS-Extended)
10305 \begin_layout Criterion*
10306 A required condition.
10309 \begin_layout Algorithm*
10310 A general procedure to be used.
10313 \begin_layout Axiom*
10314 This is a property or statement taken as true within the system being discussed.
10317 \begin_layout Condition*
10318 Sometimes used to state a condition assumed within the present context of
10322 \begin_layout Note*
10323 Similar to a Remark.
10326 \begin_layout Notation*
10327 Used for the explanation of, yes, notation.
10330 \begin_layout Summary
10331 Do we really need to tell you?
10334 \begin_layout Acknowledgement*
10338 \begin_layout Conclusion*
10339 Sometimes used at the end of a long train of argument.
10343 Used in a way similar to Proposition, though perhaps lower on the scale.
10346 \begin_layout Standard
10347 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10350 They need to be available on your system in order to use these environments.
10353 \begin_layout Section
10361 \begin_layout Standard
10367 \begin_layout Subsection
10371 \begin_layout Standard
10372 These are the layout files for some of the journals of the American Geophysical
10374 It is assumed that you have both the AGU's own class files and AGUplus
10375 installed (everything to be found at
10376 \begin_inset Flex URL
10379 \begin_layout Plain Layout
10381 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10389 \begin_layout Subsection
10393 \begin_layout Standard
10403 They are still called this in the \SpecialChar LyX
10404 GUI, though their \SpecialChar LaTeX
10417 \begin_layout Standard
10418 Newly defined styles are
10455 These are mostly manuscript attributes and defined in the AGU class documentati
10459 \begin_layout Standard
10460 I suspect this is still badly incomplete.
10463 \begin_layout Subsection
10467 \begin_layout Standard
10484 \begin_layout Subsection
10488 \begin_layout Itemize
10491 Journal of Geophysical Research
10500 \begin_layout Standard
10501 Add your own, it isn't so hard! Look at the
10512 \begin_layout Subsection
10513 Bugs and things to remember
10516 \begin_layout Standard
10517 In order to use the new layouts, you must remember to do the following for
10521 \begin_layout Enumerate
10527 This can be done in the
10529 Layout\SpecialChar menuseparator
10534 Document\SpecialChar menuseparator
10538 (AGU articles are always in English, right? So
10542 choose a language.)
10545 \begin_layout Enumerate
10550 into the document's
10555 (Yes, this is a bug.)
10558 \begin_layout Enumerate
10559 Make sure you use the
10563 bibliography style, by entering
10567 into the second field of the Bib\SpecialChar TeX
10569 None of the standard styles will do.
10572 \begin_layout Section
10576 \begin_layout Standard
10582 \begin_layout Subsection
10586 \begin_layout Standard
10587 Broadway is for writing plays.
10588 The format is more decorative than Hollywood, and much less standardized.
10589 This format should be suitable for workshops.
10592 \begin_layout Subsection
10596 \begin_layout Standard
10597 The same as in Hollywood.
10600 \begin_layout Subsection
10604 \begin_layout Standard
10609 names as labels then cross-reference the label to insert the name.
10610 The cross-reference dialog will show the current cast of characters.
10613 \begin_layout Subsection
10614 Paper size and Margins
10617 \begin_layout Standard
10618 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10621 \begin_layout Subsection
10625 \begin_layout Standard
10626 The following environments are available.
10627 You can use broadway.bind to get the bind keys shown at the right.
10630 \begin_layout Itemize
10634 \begin_inset Newline newline
10639 You should not have to use this, but it is here for anything that does not
10643 \begin_layout Itemize
10647 \begin_inset space \hfill{}
10651 \begin_inset Newline newline
10656 Used to describe stage setting and the action.
10657 First use of speaker names in all CAPs.
10660 \begin_layout Itemize
10664 \begin_inset space \hfill{}
10668 \begin_inset Newline newline
10673 Automatically numbered.
10674 On screen it will be arabic, but will print as Roman.
10677 \begin_layout Itemize
10681 \begin_inset space \hfill{}
10685 \begin_inset Newline newline
10695 It is just centered text.
10698 \begin_layout Itemize
10702 \begin_inset space \hfill{}
10706 \begin_inset Newline newline
10711 Not automatically numbered.
10712 You supply the number.
10713 This is because I couldn't figure out how.
10716 \begin_layout Itemize
10720 \begin_inset space \hfill{}
10724 \begin_inset Newline newline
10729 A special case of Narrative to describe the setting and action as the curtain
10733 \begin_layout Itemize
10737 \begin_inset space \hfill{}
10741 \begin_inset Newline newline
10746 The speaker's (actor's) title, centered in all CAPS.
10749 \begin_layout Itemize
10753 \begin_inset space \hfill{}
10757 \begin_inset Newline newline
10762 Instructions to the speaker.
10763 The parentheses are automatically inserted.
10764 The ( will appear on screen, but both will be in the printed play.
10765 This environment is only used within
10772 \begin_layout Itemize
10776 \begin_inset space \hfill{}
10780 \begin_inset Newline newline
10785 What the Speaker says.
10788 \begin_layout Itemize
10792 \begin_inset space \hfill{}
10796 \begin_inset Newline newline
10801 The curtain comes down.
10804 \begin_layout Itemize
10808 \begin_inset space \hfill{}
10814 \begin_layout Itemize
10818 \begin_inset space \hfill{}
10824 \begin_layout Itemize
10828 \begin_inset space \hfill{}
10834 \begin_layout Standard
10838 \begin_layout Section
10842 \begin_layout Standard
10847 can be used to type letters according to German conventions.
10848 A template file is included in
10850 .../lyx/share/templates
10852 for you to use as a starting point.
10855 \begin_layout Section
10863 \begin_layout Standard
10869 \begin_layout Subsection
10873 \begin_layout Standard
10874 This is the layout file for the European Geophysical Society journals.
10879 can be downloaded from the web site of the EGS under
10880 \begin_inset Flex URL
10883 \begin_layout Plain Layout
10893 \begin_layout Subsection
10897 \begin_layout Standard
10900 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10908 The current layout file is unfortunately very unmodular and would benefit
10909 from using the various
10916 \begin_layout Section
10920 \begin_layout Standard
10921 See the \SpecialChar LyX
10927 It contains all infos you need.
10930 \begin_layout Section
10933 Foil\SpecialChar TeX
10937 \begin_inset CommandInset label
10946 \begin_layout Standard
10952 \begin_layout Subsection
10956 \begin_layout Standard
10957 This section describes how to use \SpecialChar LyX
10958 to make slides for overhead projectors.
10959 There are two document classes that can do this: the default slides class
10962 Foil\SpecialChar TeX
10966 This section documents the latter.
10969 \begin_layout Standard
10970 I'm going to say this again, nice and clear, so that there's no misunderstanding
10974 \begin_layout Standard
10975 \begin_inset VSpace bigskip
10981 \begin_layout Standard
10985 This section documents the class
10986 \begin_inset Quotes eld
10994 \begin_inset Quotes erd
11002 \begin_layout Standard
11003 \begin_inset VSpace bigskip
11009 \begin_layout Standard
11010 If you're looking for the documentation for
11011 \begin_inset Quotes eld
11019 \begin_inset Quotes erd
11022 , check out section
11023 \begin_inset space ~
11027 \begin_inset CommandInset ref
11029 reference "sec:slitex"
11034 If your machine doesn't have the
11042 installed, you'll probably have to use the default
11046 class, which isn't quite as good as
11051 \begin_layout Standard
11056 class is designed for use with version
11057 \begin_inset space ~
11065 class file which is now an integral part of \SpecialChar LaTeX2e
11069 \begin_layout Subsection
11073 \begin_layout Standard
11074 Obviously, to use this document class, you need to select
11085 \begin_inset space ~
11091 There are some settings in the
11094 \begin_inset space ~
11099 dialog that you should know about that are specific to this class:
11102 \begin_layout Itemize
11103 Don't change the options
11114 \begin_inset space ~
11120 They're ignored by the
11127 \begin_layout Itemize
11128 The default font size is 20
11129 \begin_inset space \thinspace{}
11132 pt with the other options being 17
11133 \begin_inset space \thinspace{}
11137 \begin_inset space \thinspace{}
11141 \begin_inset space \thinspace{}
11147 \begin_layout Itemize
11148 The default font is
11156 but all math equations are still typeset in the usual roman font.
11159 \begin_layout Itemize
11162 Foil\SpecialChar TeX
11165 supports A4 and Letter paper sizes as well as a special size for working
11167 \begin_inset space \thinspace{}
11171 It doesn't support A5, B5, legal or executive paper sizes.
11174 \begin_layout Itemize
11175 Don't bother changing the
11179 settings because they are ignored anyway.
11180 All floats appear where they are defined in the text.
11183 \begin_layout Itemize
11188 setting behaves a bit differently for this class.
11191 Foil\SpecialChar TeX
11194 provides extensive footer and header capabilities including a user-defined
11197 \begin_inset space ~
11201 \begin_inset CommandInset ref
11203 reference "sec:foilfoot"
11208 The title page is treated differently to all other pages in the document
11217 has the logo centered at the bottom of the page (if one is defined).
11218 The possible page style choices and what they do are as follows:
11222 \begin_layout Labeling
11223 \labelwidthstring MMMMMMM
11230 The final output contains no page numbers, or other headers or footers
11231 (except footnotes of course).
11235 \begin_layout Labeling
11236 \labelwidthstring MMMMMMM
11243 The final output contains page numbers centered at the bottom of the page.
11244 No other headings or footers (other than footnotes).
11247 \begin_layout Labeling
11248 \labelwidthstring MMMMMMM
11253 Page numbers in lower right corner.
11254 Additional headers and footers are also shown.
11255 This is also the default.
11258 \begin_layout Labeling
11259 \labelwidthstring MMMMMMM
11264 Gives you access to the
11268 package although its use with
11270 Foil\SpecialChar TeX
11273 is discouraged by the writer of the
11275 Foil\SpecialChar TeX
11278 package because of some potential page layout clashes.
11282 \begin_layout Subsubsection
11286 \begin_layout Standard
11287 The following options may be used in the extra class options in the
11289 Document\SpecialChar menuseparator
11295 \begin_layout Labeling
11296 \labelwidthstring MMMMMMx
11301 This sets up the page layout for 7.33
11302 \begin_inset space \thinspace{}
11306 \begin_inset space \thinspace{}
11309 in paper, which is about the same aspect ratio as a 35
11310 \begin_inset space \thinspace{}
11313 mm slide, making it a bit easier to work with this medium.
11316 \begin_layout Labeling
11317 \labelwidthstring MMMMMMx
11322 Places a rule across the page below the header on every page except the
11326 \begin_layout Labeling
11327 \labelwidthstring MMMMMMx
11332 Places a rule across the page above the footer on every page except the
11336 \begin_layout Labeling
11337 \labelwidthstring MMMMMMx
11342 This is automatically set each time you create a new
11349 Foil\SpecialChar TeX
11352 to use the dvips driver to rotate those pages that are set as landscape
11356 \begin_layout Labeling
11357 \labelwidthstring MMMMMMx
11362 Simply changes the page dimensions to those of a landscape page but doesn't
11364 Thus if you use this option you need to use an external program to rotate
11365 each page or feed your paper through your printer as landscape.
11366 Note that this option effectively reverses the roles of the
11374 environments (don't worry these are described in the next section).
11377 \begin_layout Labeling
11378 \labelwidthstring MMMMMMx
11383 Equation numbers on the left.
11386 \begin_layout Labeling
11387 \labelwidthstring MMMMMMx
11392 Flush-left equations.
11395 \begin_layout Subsection
11396 Supported Environments
11399 \begin_layout Standard
11400 Most of the environments commonly supported in other classes are also supported
11406 There are several additional environments provided by
11408 Foil\SpecialChar TeX
11411 as well as a couple added by \SpecialChar LyX
11413 The following environments are shared with other classes:
11416 \begin_layout Standard
11417 \begin_inset Flex Multiple Columns
11420 \begin_layout Itemize
11426 \begin_layout Itemize
11432 \begin_layout Itemize
11438 \begin_layout Itemize
11444 \begin_layout Itemize
11450 \begin_layout Itemize
11457 \begin_layout Itemize
11463 \begin_layout Itemize
11469 \begin_layout Itemize
11475 \begin_layout Itemize
11481 \begin_layout Itemize
11487 \begin_layout Itemize
11493 \begin_layout Itemize
11499 \begin_layout Itemize
11505 \begin_layout Itemize
11511 \begin_layout Itemize
11517 \begin_layout Itemize
11523 \begin_layout Itemize
11534 \begin_layout Standard
11535 That is, all the major environments apart from the sectioning environments.
11536 Since foils are essentially self-contained sections, with a title and body,
11539 Foil\SpecialChar TeX
11542 provides specific commands for starting new foils and these are:
11545 \begin_layout Itemize
11551 \begin_layout Itemize
11557 \begin_layout Standard
11559 also provides slightly modified versions of these two environments called:
11562 \begin_layout Itemize
11568 \begin_layout Itemize
11571 ShortRotatefoilhead
11574 \begin_layout Standard
11575 and the differences will be explained in the next section.
11578 \begin_layout Standard
11579 Since foils are often used in presenting ideas or new theorems and such
11582 Foil\SpecialChar TeX
11585 also provides a comprehensive box of goodies for presenting them:
11588 \begin_layout Standard
11589 \begin_inset Flex Multiple Columns
11592 \begin_layout Itemize
11598 \begin_layout Itemize
11604 \begin_layout Itemize
11610 \begin_layout Itemize
11616 \begin_layout Itemize
11622 \begin_layout Itemize
11628 \begin_layout Itemize
11634 \begin_layout Itemize
11640 \begin_layout Itemize
11646 \begin_layout Itemize
11652 \begin_layout Itemize
11663 \begin_layout Standard
11664 The starred versions are unnumbered while the unstarred versions are numbered.
11665 There are also two list environments added by \SpecialChar LyX
11669 \begin_layout Itemize
11675 \begin_layout Itemize
11681 \begin_layout Standard
11684 Foil\SpecialChar TeX
11687 provides some powerful header and footer capabilities that are best set
11688 in the preamble although they may be set at any point in a document.
11689 If you want to change these settings in your document the best place to
11690 do so is at the very top of a foil, i.
11691 \begin_inset space \thinspace{}
11697 \begin_inset space \space{}
11702 straight after the foilhead.
11705 \begin_layout Standard
11706 For this purpose, the following command styles are provided [
11713 \begin_layout Standard
11714 \begin_inset Flex Multiple Columns
11717 \begin_layout Itemize
11721 \begin_inset space ~
11727 \begin_layout Itemize
11733 \begin_layout Itemize
11737 \begin_inset space ~
11743 \begin_layout Itemize
11747 \begin_inset space ~
11753 \begin_layout Itemize
11757 \begin_inset space ~
11764 \begin_layout Plain Layout
11765 \begin_inset space ~
11777 \begin_layout Standard
11778 There are also a few commands provided by
11780 Foil\SpecialChar TeX
11783 that aren't directly supported by \SpecialChar LyX
11784 but I'll tell you what they do and how
11785 to use them in section
11786 \begin_inset space ~
11790 \begin_inset CommandInset ref
11792 reference "sec:unsuppfoils"
11799 \begin_layout Subsection
11800 Building a Set of Foils
11803 \begin_layout Standard
11804 This section will give a simple introduction to using the different environments
11805 to build a set of foils.
11806 If you want to see an example set of foils, take a look at the
11810 file you find in \SpecialChar LyX
11818 \begin_layout Subsubsection
11819 Give It a Title Page
11822 \begin_layout Standard
11823 Unlike other classes that provide
11843 creates the title on a page of its own.
11844 If you leave out the
11848 environment \SpecialChar LaTeX
11849 will substitute the current date (every time you regenerate
11853 \begin_layout Subsubsection
11857 \begin_layout Standard
11858 As I mentioned earlier, there are four ways of starting a new foil.
11859 For portrait foils you should use
11868 The difference between these two environments is the amount of space between
11869 the title of the foil (the foilhead) and the body of the foil.
11872 \begin_layout Standard
11873 Landscape foils are generated using the
11879 ShortRotatefoilhead
11882 Again the only difference is the spacing between foilhead and body.
11883 Both of the short versions have 0.5
11884 \begin_inset space ~
11887 inches less separation between the foilhead and the body.
11891 \begin_layout Standard
11892 One problem with the support for landscape foils is the requirement that
11893 you have to use the
11897 driver to generate the PostScript output otherwise the foils won't be rotated.
11898 It is possible to get landscape foils even if you haven't got the
11902 driver provided you can feed your foils sideways through your printer ;-)
11905 \begin_layout Subsubsection
11906 Theorems, Lemmas, Proofs and more
11909 \begin_layout Standard
11910 Due to a small bug in \SpecialChar LyX
11911 you can't have two of the same type of these environments
11912 directly following each other.
11913 They must be separated by something.
11914 If you try, you will just be extending the previous environment as if you
11915 had merged the two environments together.
11916 So, how do you get around this problem? The simplest option is to insert
11917 some text between the two environments or add a
11922 environment between the two with just a
11923 \begin_inset Quotes eld
11931 \begin_inset Quotes erd
11935 This will force \SpecialChar LyX
11936 to produce two separate environments and hence the correct
11939 An example is provided in the example file included with the \SpecialChar LyX
11941 Remember, this problem only occurs if you are trying to place two of the
11942 same type of theorem-like environments one directly after the other.
11945 \begin_layout Subsubsection
11949 \begin_layout Standard
11950 You get all the commonly supported list styles found in other classes as
11951 well as two new ones.
11952 I'll only describe the new ones here.
11953 If you want to find out more about the other list environments check out
11959 If you intend to use itemized lists you might also want to read about the
11963 \begin_inset space ~
11967 \begin_inset space ~
11972 dialog described above in section
11973 \begin_inset space ~
11977 \begin_inset CommandInset ref
11979 reference "sec:bullet"
11986 \begin_layout Standard
11987 The two new list styles,
11995 , are designed to make it easier for you to create lists of do's and don'ts
11996 or right and wrong by providing dedicated environments that use a tick
11997 or a cross as the label of the list.
11998 These lists are in fact dedicated variants of the
12003 They do however require that you have the
12007 packages installed.
12010 \begin_layout Subsubsection
12014 \begin_layout Standard
12017 Foil\SpecialChar TeX
12020 redefines the floating tables and figures so that they appear exactly where
12021 they are in the text rather than pushing them to the top of the page or
12022 to some user specified location.
12023 In fact if you change the float placement settings they are simply ignored.
12026 \begin_layout Subsubsection
12027 Page Headers and Footers
12028 \begin_inset CommandInset label
12030 name "sec:foilfoot"
12037 \begin_layout Standard
12041 \begin_inset space ~
12050 are two commands used to control the left-footer text string.
12051 The first is meant to allow you to include a graphic logo on your foils
12053 \begin_inset Quotes eld
12058 Foil\SpecialChar TeX
12062 \begin_inset Quotes erd
12066 While the second is meant to provide a classification for the audience,
12070 \begin_inset space \thinspace{}
12076 \begin_inset space \space{}
12080 It is empty by default.
12083 \begin_layout Standard
12084 The remaining page corners can be filled by
12087 \begin_inset space ~
12092 (which defaults to page numbers),
12095 \begin_inset space ~
12103 \begin_inset space ~
12111 \begin_layout Subsection
12114 Foil\SpecialChar TeX
12118 \begin_inset CommandInset label
12120 name "sec:unsuppfoils"
12127 \begin_layout Standard
12128 All the commands mentioned below need to be set in a
12138 within another environment.
12141 \begin_layout Subsubsection
12145 \begin_layout Standard
12146 All lengths are adjusted using the
12169 should be replaced by the name given to the length you want to change and
12174 is the length value.
12175 All lengths should be specified in units of length such as inches (
12187 ) or relative to some document or font-based length such as
12197 \begin_layout Standard
12198 It's possible to change the spacing between a foilhead and the body of the
12199 foil by adjusting the length specified by
12206 For example, to make
12211 \begin_inset space \space{}
12214 in closer to their bodies put the following in the preamble:
12220 foilheadskip}{-0.5in}
12223 \begin_layout Standard
12224 The spacings around floats can be adjusted by setting these lengths:
12227 \begin_layout Labeling
12228 \labelwidthstring MMMMMMMMMMM
12235 Separation between the text and the top of the float
12238 \begin_layout Labeling
12239 \labelwidthstring MMMMMMMMMMM
12246 Separation between the float and the caption
12249 \begin_layout Labeling
12250 \labelwidthstring MMMMMMMMMMM
12257 Separation between the caption and the following text
12260 \begin_layout Labeling
12261 \labelwidthstring MMMMMMMMMMM
12268 You can make the captions narrower than the surrounding text by adjusting
12270 Best done relative to
12279 \begin_layout Standard
12280 There are also several title page related lengths that you may find useful
12281 if you have a long title or several authors:
12284 \begin_layout Labeling
12285 \labelwidthstring MMMMMMMMMMM
12292 Separation from headers to
12297 \begin_layout Labeling
12298 \labelwidthstring MMMMMMMMMMM
12316 \begin_layout Labeling
12317 \labelwidthstring MMMMMMMMMMM
12331 \begin_layout Labeling
12332 \labelwidthstring MMMMMMMMMMM
12348 \begin_layout Labeling
12349 \labelwidthstring MMMMMMMMMMM
12365 \begin_layout Standard
12366 The last length related command affects all the list environments.
12377 a list environment then all the vertical spacing between the list items
12379 Note that this is a command not a length so it doesn't require
12385 like the stuff mentioned above.
12388 \begin_layout Subsubsection
12389 Headers and Footers
12392 \begin_layout Standard
12405 commands control whether the logo in the
12409 definition appear on a given page.
12416 in the preamble then none of the foils will have the logo on them.
12417 If you don't want the logo on a particular page place the
12423 directly after the foilhead of that page and the
12429 directly after the next foilhead.
12432 \begin_layout Standard
12433 If you decide to use the
12437 page style setting in the
12440 \begin_inset space ~
12445 dialog you should probably add
12455 to your preamble so headers and footers on landscape pages are correctly
12456 placed when rotated.
12457 This is due to some clashes between the page layouts provided by the
12468 \begin_layout Section
12469 Hollywood (Hollywood spec scripts)
12472 \begin_layout Standard
12478 \begin_layout Subsection
12482 \begin_layout Standard
12483 Getting the format of a Hollywood script right is a
12484 \begin_inset Quotes eld
12488 \begin_inset Quotes erd
12491 It is designed to make the readers focus on content and to be easy and
12492 familiar for the actors to read.
12493 Each page of a script should be one minute of film.
12494 Nothing goes in a script that you cannot see or hear on screen.
12495 The courier 12 pt font should be used throughout.
12499 \begin_layout Subsection
12503 \begin_layout Standard
12504 Speakers' lines should NEVER break in mid-sentence.
12505 If a speaker's lines continue over a page break, repeat the
12509 title followed by (Cont'd).
12512 \begin_layout Subsection
12516 \begin_layout Standard
12521 names as labels then cross-reference the label to insert the name.
12522 The cross-reference dialog will show the current cast of characters.
12523 You can use this to insert the speaker name in narratives also.
12526 \begin_layout Subsection
12527 Paper size and Margins
12530 \begin_layout Standard
12531 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12534 \begin_layout Subsection
12538 \begin_layout Standard
12539 The following environments are available.
12540 You can use hollywood.bind to get the bind keys shown at the right.
12543 \begin_layout Itemize
12547 \begin_inset Newline newline
12552 Used where nothing else works.
12556 \begin_layout Itemize
12562 \begin_inset space \hfill{}
12570 \begin_inset Newline newline
12573 Usually followed by something like
12574 \begin_inset Quotes eld
12577 on Sally waking up.
12578 \begin_inset Quotes erd
12584 \begin_layout Itemize
12588 \begin_inset space \hfill{}
12592 \begin_inset Newline newline
12597 Introduces a new INTERIOR camera set-up.
12598 Always followed by DAY or NIGHT, or something similar to define the lighting
12600 Everthing on this line in CAPS.
12603 \begin_layout Itemize
12607 \begin_inset space \hfill{}
12611 \begin_inset Newline newline
12616 Introduces a new EXTERIOR camera set-up.
12617 Everthing on this line in CAPS.
12620 \begin_layout Itemize
12624 \begin_inset space \hfill{}
12628 \begin_inset Newline newline
12633 The character speaking.
12636 \begin_layout Itemize
12640 \begin_inset space \hfill{}
12644 \begin_inset Newline newline
12649 Instructions to the speaker.
12650 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12652 Both will be printed.
12655 \begin_layout Itemize
12659 \begin_inset space \hfill{}
12663 \begin_inset Newline newline
12675 \begin_layout Itemize
12679 \begin_inset space \hfill{}
12683 \begin_inset Newline newline
12688 Camera movement instruction.
12690 \begin_inset space \thinspace{}
12694 \begin_inset space \space{}
12700 \begin_layout Itemize
12704 \begin_inset space \hfill{}
12710 \begin_layout Itemize
12714 \begin_inset space \hfill{}
12720 \begin_layout Itemize
12724 \begin_inset space \hfill{}
12730 \begin_layout Itemize
12734 \begin_inset space \hfill{}
12740 \begin_layout Subsection
12744 \begin_layout Itemize
12748 \begin_layout Itemize
12752 \begin_layout Itemize
12754 \begin_inset space \thinspace{}
12761 \begin_layout Itemize
12766 \begin_layout Itemize
12767 PAN — camera movement
12770 \begin_layout Itemize
12771 INSERT — cut to close-up of
12774 \begin_layout Section
12778 \begin_layout Standard
12781 Panayotis Papasotiriou
12784 \begin_layout Subsection
12788 \begin_layout Standard
12789 The ijmpc package is a set of macros that facilitates electronic manuscript
12792 International Journal of Modern Physics C
12795 Similarly, the ijmpd package is for creating manuscripts to be submitted
12798 International Journal of Modern Physics D
12801 Both journals are published by World Scientific.
12802 The corresponding document classes are named
12811 These files, together with instructions for the authors, can be downloaded
12813 \begin_inset Flex URL
12816 \begin_layout Plain Layout
12818 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12824 \begin_inset Flex URL
12827 \begin_layout Plain Layout
12829 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12835 Both packages are modified versions of the standard
12836 \begin_inset Quotes eld
12840 \begin_inset Quotes erd
12843 package, and they are almost (but not exactly) identical.
12844 Most of their features are supported by \SpecialChar LyX
12846 I have used \SpecialChar LyX
12847 successfully to write articles submitted to both journals
12848 without any problem.
12851 \begin_layout Subsection
12855 \begin_layout Standard
12856 As usual, the easiest way to write a paper is to start with a template.
12859 File\SpecialChar menuseparator
12875 This will give an (almost) empty document that includes the most common
12876 fields found in a manuscript.
12877 Simply overwrite the existing text (including the brackets,
12882 You should keep in mind the following remarks.
12885 \begin_layout Enumerate
12887 won't let you change the font size and the page style of the document,
12888 because such modifications are not allowed by both packages.
12891 \begin_layout Enumerate
12892 The language of the document should not be changed.
12893 Before previewing your paper, be sure that the babel package is not used.
12894 To do this, click on
12896 Tools\SpecialChar menuseparator
12907 checkbox in the language settings, and click on
12915 , if you wish to make this change permanent).
12918 \begin_layout Enumerate
12920 \begin_inset Quotes eld
12924 \begin_inset Quotes erd
12927 style must be used to define keywords.
12930 \begin_layout Enumerate
12931 The ijmpc package provides a style named
12932 \begin_inset Quotes eld
12935 Classification Codes
12936 \begin_inset Quotes erd
12939 , which can be used to define classification codes, such as PACS numbers.
12940 Note that this facility is not supported by the ijmpd package.
12943 \begin_layout Enumerate
12944 Several new environments are available:
12945 \begin_inset Quotes eld
12949 \begin_inset Quotes erd
12953 \begin_inset Quotes eld
12957 \begin_inset Quotes erd
12961 \begin_inset Quotes eld
12965 \begin_inset Quotes erd
12969 \begin_inset Quotes eld
12973 \begin_inset Quotes erd
12977 \begin_inset Quotes eld
12981 \begin_inset Quotes erd
12985 \begin_inset Quotes eld
12989 \begin_inset Quotes erd
12993 \begin_inset Quotes eld
12997 \begin_inset Quotes erd
13001 \begin_inset Quotes eld
13005 \begin_inset Quotes erd
13009 \begin_inset Quotes eld
13013 \begin_inset Quotes erd
13017 \begin_inset Quotes eld
13021 \begin_inset Quotes erd
13025 \begin_inset Quotes eld
13029 \begin_inset Quotes erd
13033 \begin_inset Quotes eld
13037 \begin_inset Quotes erd
13041 \begin_inset Quotes eld
13045 \begin_inset Quotes erd
13049 \begin_inset Quotes eld
13053 \begin_inset Quotes erd
13057 Their use is more or less obvious.
13059 supports all these environments; it will use the proper label, text style,
13060 and numbering scheme for each of them.
13063 \begin_layout Enumerate
13064 Both packages use basic citations; the natbib package should not be used.
13065 In \SpecialChar LyX
13066 , citation references are shown as usual; in the output, citations are
13067 shown as superscripts.
13068 If you want to use a citation as normal text, you should use the
13073 \begin_inset space \thinspace{}
13077 \begin_inset space \space{}
13081 \begin_inset Quotes eld
13085 \begin_inset space \space{}
13095 \begin_inset Quotes erd
13101 \begin_layout Enumerate
13103 \begin_inset Quotes eld
13107 \begin_inset Quotes erd
13110 section in both packages.
13111 To put acknowledgments, just use the
13112 \begin_inset Quotes eld
13116 \begin_inset Quotes erd
13122 \begin_layout Enumerate
13123 Appendices may be added to the paper,
13127 the Acknowledgments and
13133 provides a special environment, called
13134 \begin_inset Quotes eld
13138 \begin_inset Quotes erd
13141 which marks the beginning of the appendices.
13142 This environment should be left blank; it just sends a \SpecialChar LaTeX
13143 command, but nothing
13145 In \SpecialChar LyX
13147 \begin_inset Quotes eld
13151 \begin_inset Quotes erd
13154 is printed with blue letters, as a signal that all sections after that
13155 point are appendices.
13156 To write an appendix, use the
13157 \begin_inset Quotes eld
13161 \begin_inset Quotes erd
13166 will number each appendix with capital letters, as required by both journals.
13168 \begin_inset Quotes eld
13172 \begin_inset Quotes erd
13179 be present before the first appendix; if not, all appendices will be numbered
13180 as normal sections in the output.
13183 \begin_layout Enumerate
13184 The ijmpc and the ijmpd packages use the
13188 command to implement table captions.
13189 As a result, a table created by \SpecialChar LyX
13190 is printed correctly, but its caption
13192 However, you can use some \SpecialChar TeX
13193 code to overcome this problem, so that captions
13194 are printed as expected.
13195 To do so, create a float table as usual, remove the caption, and replace
13196 it with the \SpecialChar TeX
13207 (sic); you must also the \SpecialChar TeX
13212 immediately after the tabular material.
13213 Study the example table included in the template files to see how this
13214 trick is implemented.
13215 Alternatively, If you need table captions, you should implement the whole
13220 file, then include this file to the \SpecialChar LyX
13223 Insert\SpecialChar menuseparator
13224 File\SpecialChar menuseparator
13226 \begin_inset space ~
13232 Details on how to create a table float can be found in the files
13240 , included in the corresponding packages.
13243 \begin_layout Subsection
13244 Preparing a paper for submission
13247 \begin_layout Standard
13248 Before you submit your paper you must export the \SpecialChar LyX
13249 document as a \SpecialChar LaTeX
13252 File\SpecialChar menuseparator
13253 Export\SpecialChar menuseparator
13261 \begin_layout Plain Layout
13262 Actually you have the choice between \SpecialChar LaTeX
13263 (plain) and pdflatex.
13264 If you intend to use pdflatex to prepare the paper, you should use the
13265 pdflatex option so that included graphics are converted to PDF format,
13266 ready for use by pdflatex.
13271 , then make the following changes to the resulting
13278 \begin_layout Enumerate
13279 Remove the comment lines before the
13288 \begin_layout Enumerate
13289 Remove everything between (and including) the
13301 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13305 \begin_layout Standard
13310 file should be saved and processed through \SpecialChar LaTeX
13311 as many times as necessary.
13312 You may also want to check the resulting
13319 \begin_layout Subsection
13320 Use of \SpecialChar TeX
13324 \begin_layout Standard
13325 The use of \SpecialChar TeX
13326 code is reduced to two commands, which must be placed at the
13327 top of the document.
13328 If you started writing your paper by using the
13336 template, the \SpecialChar TeX
13337 code needed is already in its place; you usually don't need
13339 You may only modify the first \SpecialChar TeX
13340 code to specify the information printed
13341 to the top of odd and even pages (authors' names and short paper's title,
13343 This \SpecialChar TeX
13344 code must have the form
13348 markboth{Authors' Names}{Short Paper's Title}
13353 \begin_layout Section
13357 \begin_layout Standard
13363 \begin_layout Subsection
13367 \begin_layout Standard
13368 The iopart package provides a document class to create electronic manuscript
13369 submission to the journals published by the Institute of Physics.
13370 Instructions for the authors how to create a paper using the iopart class
13371 can be downloaded together with the iopart package from the site
13372 \begin_inset Flex URL
13375 \begin_layout Plain Layout
13377 ftp://ftp.iop.org/pub/journals/latex2e
13385 \begin_layout Subsection
13389 \begin_layout Standard
13390 The easiest way to write a paper is to start with the file
13394 that is available in \SpecialChar LyX
13395 's examples files folder.
13396 Open this file, save it under a new name, and start writing.
13397 The example file explains how to use the special text environments.
13398 Here are the most important advices:
13401 \begin_layout Itemize
13402 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13405 Use AMS math package
13407 in the document settings under
13414 \begin_layout Itemize
13417 The title environment defines the kind of your paper.
13418 So use one of the following environments for the title:
13422 \begin_layout Itemize
13431 \begin_layout Itemize
13440 \begin_layout Itemize
13446 for a Topical review
13449 \begin_layout Itemize
13458 \begin_layout Itemize
13467 \begin_layout Itemize
13473 for a Paper (same as Title)
13476 \begin_layout Itemize
13482 for a Preliminary communication
13485 \begin_layout Itemize
13491 for a Rapid communication
13494 \begin_layout Itemize
13500 for a Letter to the editor
13504 \begin_layout Itemize
13507 All title environments except of
13511 can have an optional short title.
13514 \begin_layout Itemize
13515 There is a general title environment
13519 which is not directly supported by the \SpecialChar LyX
13521 This can be used as \SpecialChar TeX
13522 code when your document doesn't fit into one of the
13526 \begin_layout Standard
13527 For more informations like hints for special table and formula formatting,
13528 look at the IOP author guidelines.
13531 \begin_layout Section
13535 \begin_layout Standard
13538 Panayotis Papasotiriou
13541 \begin_layout Subsection
13545 \begin_layout Standard
13546 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13547 that facilitates electronic manuscript submission to the journals they
13549 Most known of them (at least in my domain of interest) are
13551 Astrophysics and Space Science
13557 , but there are many others (see a complete list at
13558 \begin_inset Flex URL
13561 \begin_layout Plain Layout
13563 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13569 The Kluwer package may be downloaded from the site
13570 \begin_inset Flex URL
13573 \begin_layout Plain Layout
13575 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13581 A complete user guide is contained in that package (but it can also be
13582 downloaded separately).
13585 \begin_layout Standard
13587 supports many features of the package but not everything.
13588 However, the \SpecialChar TeX
13589 code needed is reduced to some
13590 \begin_inset Quotes eld
13594 \begin_inset Quotes erd
13597 commands of the package (see
13598 \begin_inset space ~
13602 \begin_inset CommandInset ref
13604 reference "subsec:kluwer_peculiarities"
13609 I have recently used \SpecialChar LyX
13610 to write an article submitted to the
13612 Astrophysics and Space Science
13614 without any problem.
13617 \begin_layout Subsection
13621 \begin_layout Standard
13622 The easiest way to write a paper is to start with the Kluwer template file.
13625 File\SpecialChar menuseparator
13637 This will give an (almost) empty document that includes the most common
13638 fields found in a manuscript and a short description of their use.
13639 As in most templates, simply overwrite the existing text (including the
13644 ) with the correct information.
13647 \begin_layout Subsection
13648 Preparing a paper for submission
13651 \begin_layout Standard
13652 As in the AAS\SpecialChar TeX
13653 package, before you submit your paper to a journal you must
13655 \begin_inset Quotes eld
13659 \begin_inset Quotes erd
13665 \begin_layout Enumerate
13666 Export your paper as a \SpecialChar LaTeX
13668 To do this, click on
13670 File\SpecialChar menuseparator
13671 Export\SpecialChar menuseparator
13679 \begin_layout Enumerate
13684 file with a text editor and make the following changes
13688 \begin_layout Enumerate
13689 remove the comment lines before the
13698 \begin_layout Enumerate
13699 remove everything between (and including) the
13711 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13715 \begin_layout Standard
13724 \begin_layout Enumerate
13729 file through \SpecialChar LaTeX
13730 as many times as necessary (usually up to three).
13733 \begin_layout Enumerate
13739 \begin_inset space \thinspace{}
13743 \begin_inset space \space{}
13750 , and check if everything is OK (it should, if you didn't make any mistake).
13753 \begin_layout Subsection
13754 \begin_inset Quotes eld
13758 \begin_inset Quotes erd
13761 of the Kluwer package
13762 \begin_inset CommandInset label
13764 name "subsec:kluwer_peculiarities"
13771 \begin_layout Standard
13772 The Kluwer package has the following
13773 \begin_inset Quotes eld
13777 \begin_inset Quotes erd
13783 \begin_layout Enumerate
13784 It is possible to write multiple articles in the same \SpecialChar LaTeX
13789 \begin_layout Plain Layout
13790 I can't imagine any good reason to do this.
13796 Each article must be included in the environment
13797 \begin_inset Quotes eld
13801 \begin_inset Quotes erd
13805 Unfortunately, this environment cannot be omitted, even if you write just
13807 Therefore, each article starts with the command
13813 and, obviously, ends with the command
13820 Although this can be implemented in \SpecialChar LyX
13821 , I didn't included it, since it looks
13822 ugly and can confuse the novice user.
13823 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13826 \begin_inset Quotes eld
13831 \begin_inset Quotes erd
13837 \begin_layout Enumerate
13838 Information given at the beginning of the article (i.
13839 \begin_inset space \thinspace{}
13843 \begin_inset space \space{}
13846 title, subtitle, author, institution, running title, running author, abstract
13847 and keywords) must be included in an environment called
13848 \begin_inset Quotes eld
13852 \begin_inset Quotes erd
13856 This is not implemented in \SpecialChar LyX
13857 , so you must enter title, subtitle etc.
13858 \begin_inset space ~
13861 between two \SpecialChar TeX
13877 \begin_layout Enumerate
13878 According to the user manual, the label of each bibliography item must be
13902 \begin_layout Standard
13907 template takes care of all these
13908 \begin_inset Quotes eld
13912 \begin_inset Quotes erd
13916 If you start a new paper using this template you don't need to do anything
13921 \begin_layout Enumerate
13922 don't delete the \SpecialChar TeX
13923 code included in the template, and
13926 \begin_layout Enumerate
13927 copy the example bibliography item included in the template and modify it
13928 as necessary to enter new bibliography items.
13931 \begin_layout Section
13935 \begin_layout Standard
13941 \begin_layout Subsection
13945 \begin_layout Standard
13946 The \SpecialChar LyX
13949 article (koma-script)
13953 report (koma-script)
13971 correspond to the \SpecialChar LaTeX
13989 \begin_inset space ~
13992 of the Koma-Script family.
13993 They are replacements for the standard document classes
14009 , resp., and fit better to European typography conventions in a number of
14013 \begin_layout Itemize
14014 Standard character size is 11pt in
14016 article (koma-script)
14020 report (koma-script)
14028 letter (koma-script)
14033 \begin_layout Itemize
14034 Headings, labels of the description environment, and a number of elements
14037 letter (koma-script)
14039 document class are set in a bold sans serif font.
14043 \begin_layout Plain Layout
14044 There is a big difference between the bold sans serif old cm fonts and new
14045 ec fonts, especially in the appearance of headings.
14046 In comparison, the ec bold sans serif fonts look a bit thin.
14047 Here the \SpecialChar LaTeX
14056 helps to produce the
14057 \begin_inset Quotes eld
14061 \begin_inset Quotes erd
14064 appearance when using the ec fonts.
14069 The numbering of chapter headings is made in the same way as the numbering
14070 of section headings, that is without the extra line
14071 \begin_inset Quotes eld
14074 Chapter\SpecialChar ldots
14076 \begin_inset Quotes erd
14080 In addition, the appearance of the headings can be modified by using a
14081 number of options (in \SpecialChar LyX
14082 to be entered in the field
14085 \begin_inset space ~
14092 Layout\SpecialChar menuseparator
14099 \begin_layout Itemize
14100 The main means in the Koma-Script document classes to design the type area
14109 (in \SpecialChar LyX
14110 to be entered in the extra class options field in the dialog
14112 Document\SpecialChar menuseparator
14116 They make a clearer modification of page margins possible as do the options
14119 Document\SpecialChar menuseparator
14126 \begin_layout Itemize
14127 The \SpecialChar LaTeX
14128 document classes of the Koma-Script family define a number of additional
14130 Those part of it which makes sense in \SpecialChar LyX
14131 is implemented in corresponding
14135 \begin_layout Standard
14136 Detailed descriptions of the \SpecialChar LaTeX
14137 document classes of the Koma-Script family
14138 can be found in the Koma-Script documentation
14149 \begin_layout Subsection
14150 article (koma-script), report (koma-script), and book (koma-script)
14153 \begin_layout Standard
14154 The document classes
14156 article (koma-script)
14160 report (koma-script)
14170 are implemented in the layout files
14183 They contain all the paragraph types of the corresponding standard document
14196 , resp., partly modified, with the exception of the \SpecialChar LyX
14201 -type, which is replaced by the new
14205 -type having the same functionality.
14210 -Type there is a number of new paragraph types added.
14217 letter (koma-script)
14222 \begin_layout Itemize
14231 : are equivalents to
14239 , resp., additionally inserting an entry in the table of contents.
14248 are not contained in
14250 article (koma-script)
14255 \begin_layout Itemize
14264 : behave exactly as
14272 , resp., additionally clearing running heads.
14277 is not contained in
14279 article (koma-script)
14285 \begin_layout Plain Layout
14298 report (koma-script)
14300 , but since this is identical to
14304 , is has not been implemented in \SpecialChar LyX
14313 \begin_layout Itemize
14318 : generates a heading directly above the following paragraph in the standard
14319 character size without affecting the structure of the document.
14322 \begin_layout Itemize
14331 are special captions which respect the different space settings needed
14332 for captions placed above or below an element (if you follow strict typographic
14333 rules, you might want to place table captions always above the table).
14334 You can also use the class option
14338 , which will switch
14351 You need at least Koma-Script version 2.8q to use this.
14354 \begin_layout Itemize
14359 : can be used to set a bonmot, e.
14360 \begin_inset space \thinspace{}
14364 \begin_inset space \space{}
14367 at the beginning of a chapter.
14368 If you use the optional argument (
14370 Insert\SpecialChar menuseparator
14372 \begin_inset space ~
14377 ), you can insert the dictum's author there.
14378 Dictum and author are separated by a line.
14379 You need at least Koma-Script version 2.8q to use this.
14384 is not contained in
14386 article (koma-script)
14391 \begin_layout Standard
14392 The following types, together with the standard types
14404 , form the title area of the document.
14405 They must be entered ahead of the first
14406 \begin_inset Quotes eld
14410 \begin_inset Quotes erd
14417 \begin_layout Plain Layout
14418 The corresponding \SpecialChar LaTeX
14419 commands must appear before the
14430 When such a type is used more than once, the latter usage overwrites the
14431 former one, that means, for every type only the latest usage is valid.
14432 The order of the different types however has, like
14444 , no effect on the appearance of the produced document.
14447 \begin_layout Itemize
14452 : produces a centered paragraph above the ordinary title (
14464 ) for the subject of the document.
14467 \begin_layout Itemize
14472 : produces a centered paragraph below the ordinary title (
14484 ) for the publishers' name.
14487 \begin_layout Itemize
14494 report (koma-script)
14500 produces a centered paragraph on its own page behind the title page, or
14503 article (koma-script)
14505 produces a centered paragraph below the ordinary title (
14521 ) for a dedication.
14524 \begin_layout Itemize
14529 : produces a left aligned paragraph above the ordinary title (
14545 ) for a document`s head.
14548 \begin_layout Itemize
14553 : produces in a double-sided print in
14555 report (koma-script)
14561 a left-aligned paragraph at the top of the title page`s back or has no
14562 effect in a single-sided print or in
14564 article (koma-script)
14569 \begin_layout Itemize
14574 : produces in a double-sided print in
14576 report (koma-script)
14582 a left-aligned paragraph at the bottom of the title page`s back or has
14583 no effect in a single-sided print or in
14585 article (koma-script)
14590 \begin_layout Itemize
14595 : produces a special
14596 \begin_inset Quotes eld
14600 \begin_inset Quotes erd
14603 page ahead of the actual document containing a paragraph without special
14607 \begin_layout Standard
14608 The layout files for the document classes
14610 article (koma-script)
14614 report (koma-script)
14620 do include the file
14625 This is thought of as a place to define your own types.
14630 in your personal layout directory and edit the file!
14633 \begin_layout Subsection
14634 letter (koma-script)
14637 \begin_layout Standard
14641 letter (koma-script)
14643 is implemented in the layout file
14648 It contains all the paragraph types of the corresponding standard document
14653 , partly modified, with the exception of the \SpecialChar LyX
14667 type, which is replaced by the new
14672 In addition, it contains, in contrast to the standard document class, the
14691 Furthermore, there are a number of new letter specific types.
14694 \begin_layout Standard
14695 The appearance of the letter produced by this document class can be controlled
14696 by a number of \SpecialChar LaTeX
14697 commands, which you can put in the \SpecialChar LaTeX
14702 \begin_layout Plain Layout
14703 For example, the standard appearance of the letter`s heading, consisting
14704 of name and address, is quite self-willed.
14706 \begin_inset Quotes eld
14710 \begin_inset Quotes erd
14713 heading is produced by the following \SpecialChar LaTeX
14714 commands in the preamble:
14717 \begin_layout LyX-Code
14727 \begin_layout LyX-Code
14743 \begin_layout LyX-Code
14753 \begin_layout LyX-Code
14773 A detailed German description of such \SpecialChar LaTeX
14774 commands can be found in the Koma-Script
14780 With it, the letter's author can produce his personal letter layout.
14783 \begin_layout Standard
14792 define the beginning of the letter and must be used in every letter.
14793 To emphasize them in the \SpecialChar LyX
14794 document class, they are marked with the letter
14804 \begin_inset space ~
14807 in the left margin.
14808 It is possible to write any number of letters in one file.
14813 type produces a new letter using the same addressee and a
14817 type produces a new addressee.
14834 are ordinary paragraph types and can also be used several times in one
14835 and the same letter.
14838 \begin_layout Itemize
14843 : produces a paragraph for the addressee and implicitly defines the beginning
14847 \begin_layout Itemize
14852 : produces a paragraph for the form of address and implicitly produces a
14856 \begin_layout Itemize
14861 : produces a paragraph for a close.
14864 \begin_layout Itemize
14869 : produces a paragraph for a postscript.
14872 \begin_layout Itemize
14877 : produces a paragraph for a distribution list.
14880 \begin_layout Itemize
14885 : produces a paragraph for enclosures.
14888 \begin_layout Standard
14929 are input types provided with a label to enter information, which will
14930 be processed by the document class.
14934 \begin_layout Plain Layout
14935 It could be seen as a matter of inconsequence, that the types
14943 described above are not such input types as well.
14944 Because of the special meaning of those types, however, I have implemented
14945 them as ordinary paragraph types with a one letter mark in the left margin.
14946 Moreover, it would affect my feeling of symmetry, if the
14954 type had such a serious different appearance.
14959 The types must be used ahead of the corresponding
14966 \begin_layout Standard
14967 An implementation of these types in a WYSIWYG fashion does not seem to make
14968 sense, because the real appearance of the produced letter does not only
14969 depend on the usage of the particular type, but also on other factors.
14970 For example, a signature entered in the
14974 type will in the standard behavior appear in the produced letter only,
14975 when in the same letter also a
14980 The entered value of the
14984 type will in the standard behavior not appear in the produced letter at
14986 The possibility to design the letter`s heading freely is already indicated
14987 in a footnote above.
14990 \begin_layout Standard
14991 The input types can also be used as empty paragraphs.
14992 This makes sense e.
14993 \begin_inset space \thinspace{}
14997 \begin_inset space \space{}
15009 type is not used at all, in the standard behavior the value of the
15013 type is used as signature, whereas if an empty
15017 type is used, no signature value is defined.
15020 \begin_layout Standard
15021 By using the input types it is possible to write a letter template, containing
15022 filled input types with your personal dates (name, address, etc.) and empty
15023 input types for other dates you want to enter.
15026 \begin_layout Itemize
15031 : sender's name, in the standard behavior appears as a centered paragraph
15032 in small caps in the letter`s heading.
15035 \begin_layout Itemize
15040 : sender's signature, in the standard behavior appears below the
15049 type is used, the value of the
15053 type appears instead.
15056 \begin_layout Itemize
15061 : sender's address, in the standard behavior appears in a centered paragraph
15062 in the letter`s heading below the sender's name.
15065 \begin_layout Itemize
15070 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15081 \begin_layout Itemize
15086 : place of the letter`s making.
15089 \begin_layout Itemize
15094 : date of the letter`s making.
15103 , in the standard behavior, produce the place and the date in a right-aligned
15104 line below the addressee's field.
15109 type is used, neither place nor date appear, independent of the value of
15119 type is used, the date of the letter `s production is used.
15122 \begin_layout Itemize
15127 : sender`s back address, in the standard behavior appears above the addressee's
15128 field in a small sans serif font.
15131 \begin_layout Itemize
15136 : special mail information, in the standard behavior appears underlined
15137 above the addressee's field below the back address.
15140 \begin_layout Itemize
15145 : additional information, in the standard behavior appears on right side
15146 below the addressee`s field.
15149 \begin_layout Itemize
15154 : the letter's title, in the standard behavior appears in a big, bold, sans
15155 serif font above the subject.
15158 \begin_layout Itemize
15163 : the letter's subject, in the standard behavior appears in a bold font
15171 \begin_layout Standard
15192 produce a business letter like line above the
15196 line containing the fields
15197 \begin_inset Quotes eld
15201 \begin_inset Quotes erd
15205 \begin_inset Quotes eld
15209 \begin_inset Quotes erd
15213 \begin_inset Quotes eld
15217 \begin_inset Quotes erd
15221 \begin_inset Quotes eld
15225 \begin_inset Quotes erd
15229 \begin_inset Quotes eld
15233 \begin_inset Quotes erd
15237 \begin_inset Quotes eld
15241 \begin_inset Quotes erd
15245 For the date field, the value of the
15251 \begin_inset Quotes eld
15254 business letter types
15255 \begin_inset Quotes erd
15258 is used, the value of the
15262 type however does not appear, but only the \SpecialChar LaTeX
15270 The ordinary output of place and date in a right-aligned line below the
15271 addressee`s field is suppressed.
15272 The types are implemented as input types provided with a label and must
15273 be used ahead of the corresponding
15280 \begin_layout Itemize
15288 \begin_layout Itemize
15296 \begin_layout Itemize
15304 \begin_layout Itemize
15312 \begin_layout Itemize
15320 \begin_layout Subsection
15321 The new letter class: letter (koma-script v.2)
15324 \begin_layout Standard
15330 \begin_layout Standard
15331 \begin_inset VSpace medskip
15337 \begin_layout Standard
15339 Koma-Script version 2.8 has introduced a new letter class
15343 which supersedes the now unsupported
15348 It has — on the \SpecialChar LaTeX
15349 side — a completely new interface and is not compatible
15350 with the old class.
15351 Therefore, \SpecialChar LyX
15352 supports both, though it is recommended you use the new class.
15355 \begin_layout Standard
15356 This class covers the same functionality as
15358 letter (koma-script),
15361 The basic items are
15365 (receiver's address, same as
15369 in the old layout),
15382 will start a new letter (i.
15383 \begin_inset space \thinspace{}
15387 \begin_inset space \space{}
15390 you can write several letters per document).
15391 New elements are sender's
15407 and the possibility to use a
15413 Insert\SpecialChar menuseparator
15419 \begin_layout Standard
15420 The biggest improvement is, though, that the letter's layout is configurable
15421 to meet almost any needs.
15422 This can be done via the preamble or with a special style file (Letter
15423 Class Option, extension
15427 ), that will be read in as a class option.
15431 \begin_layout Plain Layout
15432 The KOMA package comes with some default
15437 There is, for instance, a
15441 file that follows german typesetting rules, or a
15445 that provides the default layout of the old
15450 The latter can be loaded with the class option
15456 Layout\SpecialChar menuseparator
15457 Document\SpecialChar menuseparator
15469 template that is included in \SpecialChar LyX
15471 A detailed description is to be found in the Koma-Script documentation
15479 \begin_layout Subsection
15483 \begin_layout Standard
15484 Visualizing the Koma-Script document classes in \SpecialChar LyX
15485 , the \SpecialChar LyX
15486 internals cause some
15490 \begin_layout Itemize
15491 The chapter number of a
15495 type appears on a line of its own above the chapter heading instead of
15496 appearing in the same line ahead of it.
15497 The cause for that is the \SpecialChar LyX
15498 internal behavior for the labeltype
15502 in the layout file.
15505 \begin_layout Itemize
15506 The headings of the types
15514 are only put in the
15515 \begin_inset Quotes eld
15519 \begin_inset Quotes erd
15523 table of contents, but not in the \SpecialChar LyX
15524 table of contents (
15526 Document\SpecialChar menuseparator
15528 \begin_inset space ~
15532 \begin_inset space ~
15540 \begin_layout Itemize
15541 The paragraphs in a
15545 document class appear in a skip separation mode, not indented.
15546 This is the standard behavior, no special \SpecialChar LaTeX
15547 commands are needed for that.
15550 Document\SpecialChar menuseparator
15553 dialog the corresponding radio button indicates
15562 value always has the effect that extra \SpecialChar LaTeX
15563 commands are inserted in the document
15564 to produce the gap, which is not what is wanted in this case.
15567 \begin_layout Section
15571 \begin_layout Standard
15577 \begin_layout Subsection
15581 \begin_layout Standard
15582 Memoir is a very powerful and constantly evolving class.
15583 It has been designed with regard to fictional and non-fictional literature.
15584 Its aim is to let the user have maximum control over the typesetting of
15586 Memoir is based on the standard book class, but it can also emulate the
15587 article class (see below).
15590 \begin_layout Standard
15591 Peter Wilson, the developer of Memoir, is known as the author of lots of
15592 useful packages in the \SpecialChar LaTeX
15594 Most of them have been merged with Memoir.
15595 Therefore, it is much easier to layout the table of contents, appendices,
15596 chapter designs and such.
15598 , though, does not support all of these goodies natively.
15599 Some of them might be added to forthcoming releases
15603 \begin_layout Plain Layout
15604 You are invited to send suggestions to
15605 \begin_inset Flex URL
15608 \begin_layout Plain Layout
15610 lyx-devel@lists.lyx.org
15620 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15622 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15624 commands (\SpecialChar TeX
15629 \begin_layout Plain Layout
15634 \begin_layout Plain Layout
15644 \begin_inset space ~
15648 \begin_inset CommandInset ref
15650 reference "sec:Inserting-TeX-Code"
15660 In this section, we can only list those features that are natively supported
15661 by \SpecialChar LyX
15663 For detailed descriptions (and for the rest of features) we recommend you
15664 have a look at the detailed manual of the Memoir class
15668 \begin_layout Plain Layout
15673 \begin_layout Plain Layout
15683 \begin_inset Flex URL
15686 \begin_layout Plain Layout
15688 CTAN:/macros/latex/memoir/memman.pdf
15698 , which is not only a user guide for the class, but also both a comprehensive
15699 description on good typesetting and a superb example for good typesetting
15703 \begin_layout Subsection
15704 Basic features and restrictions
15707 \begin_layout Standard
15708 Memoir supports basically all features of the standard book classes.
15709 There are, however, some differences, as follows:
15712 \begin_layout Description
15714 \begin_inset space ~
15717 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15720 \begin_layout Description
15722 \begin_inset space ~
15725 style: The fancy page style is not supported, due to a command clash between
15726 Memoir and the fancyhdr package (they both define a command with the same
15727 name, which confuses \SpecialChar LaTeX
15729 Instead, Memoir comes with a number of its own page styles (see
15731 Layout\SpecialChar menuseparator
15732 Document\SpecialChar menuseparator
15734 \begin_inset space ~
15740 If you want to use these for the chapter pages, you have to use the command
15747 in the main text or in preamble (e.
15748 \begin_inset space \thinspace{}
15752 \begin_inset space \space{}
15759 chapterstyle{companion}
15764 \begin_layout Description
15765 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15766 optional argument in the standard classes.
15767 With this, you can specify an alternative version of the title for the
15768 table of contents and the headers (for instance, if the title is too long).
15769 In \SpecialChar LyX
15770 , you can do this via
15772 Insert\SpecialChar menuseparator
15774 \begin_inset space ~
15779 at the beginning of a chapter/section.
15780 Memoir features a second optional argument and thus separates the table
15781 of contents from the header.
15782 You can define three variants of a title with this: one for the main text,
15783 one for the table of contents, and one for the headers.
15784 Simply insert two optional arguments if you need this feature, the first
15785 one containing the short title for the Table of Contents, the second one
15786 containing an alternative short title for the headers.
15789 \begin_layout Description
15790 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15791 of contents, the list of figures and the list of table start a new page
15793 Memoir does not follow this route.
15794 You have to insert a page break yourself, if you want to have one.
15797 \begin_layout Description
15798 Titlepage: For some unknown reason, Memoir uses pagination on the title
15799 page (in the standard classes, title pages are
15800 \begin_inset Quotes eld
15804 \begin_inset Quotes erd
15808 If you want an empty title page, type
15812 aliaspagestyle{title}{empty}
15817 \begin_layout Description
15818 Article: With the class option
15824 Layout\SpecialChar menuseparator
15825 Document\SpecialChar menuseparator
15827 \begin_inset space ~
15832 ), you can emulate article style.
15833 That is, counters (footnotes, figures, tables etc.) will not be reset on
15834 new chapters, chapters don't start a new page (but are—in contrary to
15835 \begin_inset Quotes eld
15839 \begin_inset Quotes erd
15842 article classes—still allowed), parts, though, use their own page, as in
15846 \begin_layout Description
15847 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15848 font commands, which have been used in the old \SpecialChar LaTeX
15850 \begin_inset space \thinspace{}
15854 \begin_inset space \space{}
15870 It produces an error and stops \SpecialChar LaTeX
15871 whenever such a command appears.
15876 reallows the commands and spits out warnings instead (which does at least
15877 not stop \SpecialChar LaTeX
15879 Since a lot of packages and particularly Bib\SpecialChar TeX
15880 style files are still using
15881 those commands, we have decided to use this option by default.
15884 \begin_layout Subsection
15888 \begin_layout Standard
15889 We will only describe the features supported by \SpecialChar LyX
15890 (which is not much currently).
15891 Please consult the Memoir manual
15895 \begin_layout Plain Layout
15900 \begin_layout Plain Layout
15910 \begin_inset Flex URL
15913 \begin_layout Plain Layout
15915 CTAN:/macros/latex/memoir/memman.pdf
15928 \begin_layout Description
15929 Abstract: You may wonder why an abstract is an extra feature.
15930 Well, it is in book class.
15931 Usually books don't have abstracts.
15932 Memoir, however, has.
15933 You can use it wherever and how often you like.
15936 \begin_layout Description
15937 Chapterprecis: You may know this older typesetting style: The contents of
15938 a chapter are summarized below the title and also in the table of contents
15940 \begin_inset space \thinspace{}
15944 \begin_inset space \space{}
15949 Our hero arrives in Troia; he loses some friends; he finds others
15952 Chapterprecis does exactly this.
15953 It is therefore only sensible below a chapter.
15956 \begin_layout Description
15957 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15958 The epigraph environment provides an elegant way of typesetting such a
15960 The motto itself (text) and its author (source) are divided by a short
15962 Unfortunately, we have to fool \SpecialChar LyX
15963 a bit here again, since the environment
15964 needs two arguments (text and source).
15965 In this case, we have to use curly brackets (in \SpecialChar TeX
15966 mode) between the two
15977 <author of the slogan>.
15980 \begin_layout Description
15981 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15982 complex figurative poems).
15984 can only support a few of them.
15985 One is poemtitle, which is a centered title for poems, which will also
15986 be added to the table of contents (verse is the standard environment for
15988 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
15990 because they have to be nested inside regular verse environments, which
15991 is not possible with \SpecialChar LyX
15995 \begin_layout Description
15996 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15999 \begin_layout Section
16000 Article (mwart), book (mwbk) and report (mwrep)
16001 \begin_inset Argument status
16004 \begin_layout Plain Layout
16017 \begin_layout Standard
16023 \begin_layout Standard
16024 The \SpecialChar LyX
16041 correspond to the \SpecialChar LaTeX
16055 They are replacements for the standard document classes
16067 , resp., and fit better to Polish typography conventions in a number of points.
16071 \begin_layout Standard
16075 \begin_layout Itemize
16076 Unnumbered titles (with star, e.
16077 \begin_inset space \thinspace{}
16081 \begin_inset space \space{}
16088 ) are added into table of contents,
16091 \begin_layout Itemize
16092 Additional page styles:
16096 \begin_layout Description
16097 uheadings header with separated lines,
16100 \begin_layout Description
16101 myheadings custom header, contents headers via commands:
16116 \begin_layout Description
16117 myuheadings custom header with separated lines,
16120 \begin_layout Description
16121 outer page number is placed on outer side of page
16125 \begin_layout Itemize
16130 \begin_layout Description
16131 rmheadings serif titles — default,
16134 \begin_layout Description
16135 sfheadings sansserif titles,
16138 \begin_layout Description
16139 authortitle on title page first placed is author next title — default,
16142 \begin_layout Description
16143 titleauthor on title page first placed is title next author,
16146 \begin_layout Description
16147 withmarginpar reserve place on page for margins.
16151 \begin_layout Section
16155 \begin_layout Standard
16160 provides an alternative to the standard
16165 It provides similar functionality, but you might prefer this layout with
16166 sans serif sections, headings, and more.
16169 \begin_layout Section
16170 Rev\SpecialChar TeX
16174 \begin_layout Standard
16180 \begin_layout Standard
16181 \begin_inset VSpace bigskip
16187 \begin_layout Standard
16192 \begin_inset space ~
16197 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16199 \begin_inset Formula $\beta$
16202 release of May, 1999) class.
16205 \begin_layout Standard
16211 textclass, which works with Rev\SpecialChar TeX
16213 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16215 That means that it doesn't interact very well with \SpecialChar LyX
16216 , which requires \SpecialChar LaTeX2e
16218 it has been kludged to work.
16219 Since Rev\SpecialChar TeX
16220 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16225 Rev\SpecialChar TeX
16227 \begin_inset space ~
16232 textclass should also be pretty easy to use.
16235 \begin_layout Standard
16236 These documents are supposed to be used in
16240 to the Rev\SpecialChar TeX
16241 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16243 and assume you'll know what to put in the preamble if necessary.
16246 \begin_layout Subsection
16250 \begin_layout Standard
16251 All you need to do is install Rev\SpecialChar TeX
16252 4, as described in the package's README
16254 The package can be found at The Rev\SpecialChar TeX
16256 \begin_inset Flex URL
16259 \begin_layout Plain Layout
16261 http://publish.aps.org/revtex4/
16267 Install it somewhere that \SpecialChar LaTeX
16269 Test it by trying to \SpecialChar LaTeX
16270 a short Rev\SpecialChar TeX
16271 4 document in some random directory (i.
16272 \begin_inset space \thinspace{}
16276 \begin_inset space \space{}
16279 not the directory where you installed the class file.) Then, if you reconfigure
16281 , it will find the class file and let you use the Rev\SpecialChar TeX
16285 \begin_layout Standard
16286 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16295 \begin_inset space ~
16300 template, found in the templates directory.
16303 \begin_layout Subsection
16307 \begin_layout Standard
16308 Optional arguments to
16315 \begin_inset Quotes eld
16319 \begin_inset Quotes erd
16323 \begin_inset Quotes eld
16327 \begin_inset Quotes erd
16333 \begin_inset space ~
16341 \begin_inset space ~
16347 Remember that in Rev\SpecialChar TeX
16348 , at least one optional argument is required!
16351 \begin_layout Standard
16352 Other preamble matter, like
16359 \begin_inset space ~
16366 \begin_inset space ~
16371 dialog, also as usual.
16374 \begin_layout Subsection
16378 \begin_layout Standard
16379 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16381 For example, the Email layout corresponds to
16388 Note that (at least as of Rev\SpecialChar TeX
16397 layouts are exactly equivalent, so you shouldn't need to use both.
16401 \begin_layout Plain Layout
16402 In case you're curious, both were included so that
16406 would be able to translate both
16426 \begin_layout Subsection
16430 \begin_layout Standard
16431 There are a couple of important unique aspects of Rev\SpecialChar TeX
16432 4 which might cause
16433 bugs that will be even more confusing in \SpecialChar LyX
16437 \begin_layout Standard
16438 In Rev\SpecialChar TeX
16456 The \SpecialChar LyX
16457 equivalent is that there is a separate Thanks layout.
16462 write footnotes in the
16466 layout, or weird things may happen.
16467 See the Rev\SpecialChar TeX
16468 4 documentation for more details.
16471 \begin_layout Standard
16475 \begin_inset space ~
16483 \begin_inset space ~
16492 layouts must be placed
16500 layout and the corresponding
16517 , the \SpecialChar LaTeX
16521 \begin_layout Subsection
16525 \begin_layout Standard
16526 The main problem with this layout is that you can't use the optional arguments
16527 to layouts like Email and Title.
16528 (The problem is not unique to this layout; you can't use optional arguments
16529 to the Section layouts either.) This means that after you export that file
16530 to \SpecialChar LaTeX
16531 (which you'll need to do eventually to send it in to APS), you'll need
16532 to edit the \SpecialChar LaTeX
16533 file with a text editor to add the optional arguments to set,
16535 \begin_inset space \thinspace{}
16539 \begin_inset space \space{}
16542 the running title for the page headers.
16543 Lacking these layouts makes the
16549 (and the equivalent
16555 ) useless, so the corresponding layouts don't exist, and will have to be
16560 \begin_layout Plain Layout
16565 actually, \SpecialChar LyX
16566 1.3.0 supports some forms of optional arguments, but this layout
16567 has not been updated yet to take advantage of it.
16575 \begin_layout Section
16576 Springer Journals (
16583 \begin_layout Standard
16589 \begin_layout Subsection
16593 \begin_layout Standard
16594 These are the layout files for some of the journal formats used by Springer
16595 Verlag and listed on
16596 \begin_inset Flex URL
16599 \begin_layout Plain Layout
16601 http://www.springer.de/author/tex/help-journals.html
16606 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16608 It is a modular system: the things common to all journals are implemented
16613 , which journal-specific layout files (such as, e.
16614 \begin_inset space \thinspace{}
16618 \begin_inset space \space{}
16625 for Journal of Geodesy) can include.
16628 \begin_layout Standard
16629 This means that implementing support for any other Springer journal on this
16630 list is as simple as writing your own
16638 file following the outline given in
16646 \begin_layout Standard
16647 It is reasonably well tested only for the Journal of Geodesy.
16656 come with the standard \SpecialChar LyX
16658 Install the relevant class file (downloaded from Springer) in a proper
16659 directory, reconfigure \SpecialChar LaTeX
16660 (in the te\SpecialChar TeX
16665 , as root if necessary — doesn't \SpecialChar LyX
16666 take care of this?), reconfigure \SpecialChar LyX
16671 \begin_layout Subsection
16675 \begin_layout Standard
16676 A large number of theorem-like styles —
16688 \begin_layout Standard
16691 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16692 _Title, Author_Running, Institute,
16693 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16696 See the Springer class file documentation for details.
16699 \begin_layout Subsection
16703 \begin_layout Itemize
16715 \begin_layout Itemize
16718 Probability Theory and Related Fields
16724 — Jean-Marc Lasgouttes
16727 \begin_layout Standard
16728 Add your own, it isn't so hard!
16731 \begin_layout Subsection
16735 \begin_layout Standard
16736 These files are partly based on the older
16740 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16742 file from Springer.
16747 layout, are now defunct.
16748 Jean-Marc Lasgouttes helped out big in making me find my way around the
16750 layout file mechanism.
16753 \begin_layout Subsection
16757 \begin_layout Standard
16759 But probably less than in the old hacked-\SpecialChar LaTeX
16767 \begin_layout Standard
16769 \begin_inset space \thinspace{}
16772 g.: does not display the number for theorem-like layouts, just #.
16775 \begin_layout Section
16778 Sli\SpecialChar TeX
16782 \begin_inset CommandInset label
16791 \begin_layout Standard
16799 \begin_layout Subsection
16803 \begin_layout Standard
16804 This section describes how to use \SpecialChar LyX
16805 to make slides for overhead projectors.
16806 There are two document classes that can do this: the default slides class
16809 Foil\SpecialChar TeX
16813 This section documents the former.
16816 \begin_layout Standard
16817 I'm going to say this again, nice and clear, so that there's no misunderstanding
16821 \begin_layout Standard
16822 \begin_inset VSpace bigskip
16828 \begin_layout Standard
16832 This section documents the class
16833 \begin_inset Quotes eld
16841 \begin_inset Quotes erd
16849 \begin_layout Standard
16850 \begin_inset VSpace bigskip
16856 \begin_layout Standard
16857 If you're looking for the documentation for
16858 \begin_inset Quotes eld
16863 slides (Foil\SpecialChar TeX
16867 \begin_inset Quotes erd
16870 , check out section
16871 \begin_inset space ~
16875 \begin_inset CommandInset ref
16877 reference "sec:foiltex"
16887 \begin_inset Quotes eld
16892 slides (Foil\SpecialChar TeX
16896 \begin_inset Quotes erd
16899 ] is actually somewhat better than the default
16907 \begin_layout Plain Layout
16909 or so I've been told repeatedly by its advocates.
16910 Having never used it, I have no idea if this claim is true or not.
16915 which this section documents.
16918 \begin_layout Standard
16919 This class is the \SpecialChar LaTeX2e
16920 improvement of the old
16922 Sli\SpecialChar TeX
16926 Every \SpecialChar LaTeX2e
16927 distribution includes this class [which I'll just refer to as
16928 \begin_inset Quotes eld
16936 \begin_inset Quotes erd
16939 from now on], so you're bound to have it.
16940 As I noted earlier, there are other classes, such as
16944 , which also produce slides for overhead projectors and do a better job
16946 However, there are some things which
16950 can do which the others can't, such as generate overlays.
16951 Read on to learn more!
16954 \begin_layout Subsection
16956 \begin_inset CommandInset label
16958 name "sec:slidesetup"
16965 \begin_layout Standard
16966 Obviously, to use this document class, you need to select
16967 \begin_inset Quotes eld
16975 \begin_inset Quotes erd
16978 from the class list in the
16980 Document\SpecialChar menuseparator
16984 There are some other special things you should know about this class:
16987 \begin_layout Itemize
16988 Don't bother changing the options
16993 They're not supported by the
17000 \begin_layout Itemize
17004 \begin_inset space ~
17009 behaves a bit differently for this class.
17010 The possible choices and what they do are as follows:
17014 \begin_layout Description
17019 The final output contains page numbers in the lower right corner.
17022 \begin_layout Description
17031 , but also prints out any time markers you've put in.
17032 This is the default.
17035 \begin_layout Description
17040 The final output contains no page numbers, time markers, or alignment markers.
17044 \begin_layout Itemize
17049 class has an extra option:
17055 \begin_inset Quotes eld
17063 \begin_inset Quotes erd
17066 in the extra class options.
17070 \begin_layout Standard
17071 Using this options allows you to add time markers to
17077 \begin_inset space ~
17081 \begin_inset CommandInset ref
17083 reference "sec:slideNote"
17091 \begin_layout Standard
17092 You can also use the template file
17093 \begin_inset Quotes eld
17101 \begin_inset Quotes erd
17104 to automatically set up a document to use the
17110 File\SpecialChar menuseparator
17112 \begin_inset space ~
17116 \begin_inset space ~
17121 to open your new document].
17122 The template file also contains some examples of the special paragraph
17123 environments used by this class.
17124 I'll describe those next.
17127 \begin_layout Subsection
17128 Paragraph Environments
17131 \begin_layout Subsubsection
17132 Supported Environments
17135 \begin_layout Standard
17136 The first thing you'll notice when you start up a new
17140 document is the font size and type: it's the equivalent of the size
17141 \begin_inset Quotes eld
17149 \begin_inset Quotes erd
17155 \begin_inset space ~
17161 This is also what's used in the output.
17163 \begin_inset Quotes eld
17167 \begin_inset Quotes erd
17170 to remind you that this is a slide.
17171 Your final slides will use a larger font; ergo, you'll have less space.
17172 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17175 \begin_layout Standard
17176 The next thing that becomes obvious is the changes to the paragraph environment
17177 pull-down box [at the far-left end of the toolbar].
17178 Most of the paragraph environments you're used to seeing are missing.
17179 There are also five new ones.
17184 class itself only supports certain paragraph environments:
17187 \begin_layout Itemize
17193 \begin_layout Itemize
17199 \begin_layout Itemize
17205 \begin_layout Itemize
17211 \begin_layout Itemize
17217 \begin_layout Itemize
17223 \begin_layout Itemize
17229 \begin_layout Itemize
17235 \begin_layout Itemize
17241 \begin_layout Itemize
17248 \begin_layout Itemize
17254 \begin_layout Standard
17255 All of the other standard environments, including the section-heading environmen
17256 ts, aren't used in the
17263 \begin_layout Standard
17264 On the other hand, you'll notice the following new environments:
17267 \begin_layout Itemize
17273 \begin_layout Itemize
17279 \begin_layout Itemize
17285 \begin_layout Itemize
17291 \begin_layout Itemize
17297 \begin_layout Standard
17298 These five are kind of quirky, due to a
17299 \begin_inset Quotes eld
17303 \begin_inset Quotes erd
17306 in \SpecialChar LyX
17308 You see, \SpecialChar LyX
17309 doesn't permit you to nest any other paragraph environment into
17310 an empty environment.
17311 Now, that's fine and dandy, but it means that you wouldn't be able to start
17312 a slide with anything except plain text.
17313 To deal with this, I've performed a little
17314 \begin_inset Quotes eld
17319 \begin_inset Quotes erd
17325 \begin_layout Subsubsection
17326 Quirks of the New Environments
17327 \begin_inset CommandInset label
17329 name "sec:slideQuirk"
17336 \begin_layout Standard
17337 All five of the new paragraph environments are somewhat quirky due to inherent
17338 limitiations in the current version of \SpecialChar LyX
17340 As I just mentioned, \SpecialChar LyX
17341 forbids environments that begin with another environment.
17342 To get around this, the
17346 environment isn't a paragraph environment as described in the
17354 \begin_layout Standard
17355 You should consider
17368 \begin_inset Quotes eld
17371 pseudo-environments.
17372 \begin_inset Quotes erd
17375 They look like a section heading or a
17376 \begin_inset Quotes eld
17384 \begin_inset Quotes erd
17387 but really begin a [and, if necessary, end the previous] paragraph environment.
17397 \begin_inset Quotes eld
17401 \begin_inset Quotes erd
17404 These two perform some action.
17407 \begin_layout Standard
17408 A common feature of all five environments,
17428 , is a rather long-ish label.
17429 The text following this label — ordinarily the contents of the paragraph
17430 environment — is utterly irrelevant for
17452 completely ignores it.
17453 In fact, you can leave these five environments completely empty.
17457 \begin_layout Standard
17462 to put any text after the rather long-ish label, you might want to.
17463 This could be a short description of the contents of the
17468 In that case, enter your descriptive comment and hit
17472 as you normally would.
17475 \begin_layout Standard
17476 If, on the other hand, you don't want to enter any descriptive text, you'll
17477 hit another \SpecialChar LyX
17480 , like nature, abhors a vacuum, and will not let you start a new paragraph
17481 environment until you put something in the old one.
17485 \begin_layout Itemize
17486 Start entering the text that will
17514 \begin_layout Itemize
17515 Now move to the beginning of that paragraph.
17519 \begin_layout Itemize
17528 \begin_layout Itemize
17529 Finally, change this new, empty paragraph to a
17553 \begin_layout Standard
17554 Some future version of \SpecialChar LyX
17555 will, hopefully, resolve this quirkiness\SpecialChar ldots
17559 \begin_layout Subsection
17560 Making a Presentation with
17573 \begin_layout Subsubsection
17581 \begin_layout Standard
17582 If you're expecting this section to teach you how to actually make a presentatio
17583 n, you'll be sorely disappointed.
17584 Naturally, I'll describe all of the ways the
17588 class can assist you in preparing the materials for a presentation.
17589 Filling in the contents, however, is up to you.
17594 the \SpecialChar LyX
17598 \begin_layout Standard
17603 environment [in the manner described in section
17604 \begin_inset space ~
17608 \begin_inset CommandInset ref
17610 reference "sec:slideQuirk"
17614 ] tells \SpecialChar LyX
17615 to begin a new slide [duh].
17616 The label for this environment/
17617 \begin_inset Quotes erd
17621 \begin_inset Quotes erd
17625 \begin_inset Quotes eld
17629 \begin_inset Quotes erd
17632 in cool blue, followed by the label,
17633 \begin_inset Quotes eld
17637 \begin_inset Quotes erd
17641 Any text or paragraph environments that follow this one go on the new slide.
17645 \begin_layout Standard
17646 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17648 (this can be specified in the
17653 In fact, you'll want to, once you finish entering the contents of one slide.
17654 If you've entered more text than can physically fit on a slide, the extra
17655 overflows onto a new slide.
17656 I don't recommend doing this, however, since the overflow slide won't have
17657 any page number on it.
17658 Furthermore, it may interfere with any
17662 you've made to accompany the oversized
17669 \begin_layout Standard
17678 environments work the same way as the
17683 They both create an
17684 \begin_inset Quotes eld
17688 \begin_inset Quotes erd
17691 followed by a label [
17692 \begin_inset Quotes eld
17696 \begin_inset Quotes erd
17700 \begin_inset Quotes eld
17704 \begin_inset Quotes erd
17708 The color is a stunning magenta instead of blue, and the
17709 \begin_inset Quotes eld
17713 \begin_inset Quotes erd
17716 will look different, in style and in length.
17717 The label fonts of all three also differ from one another.
17720 \begin_layout Standard
17725 , if the contents of a
17733 exceed the physical size of a slide or sheet of paper, the extra will overflow
17735 Again, you should avoid this.
17736 It defeats the whole purpose of
17747 \begin_layout Subsubsection
17757 \begin_layout Standard
17762 is a slide that sits atop another slide.
17763 Perhaps you wish to discuss a figure on the main
17767 before displaying the text associated with it.
17768 One way to accomplish this is tape a flap of dark paper over the part of
17773 you want to display later.
17774 This method fails, however, if you wish to overlap one graph with another,
17776 You would then have to fumble while speaking to align the two separate,
17781 s to align the two graphs.
17786 environment in both cases makes life much easier.
17789 \begin_layout Standard
17794 receives the page number of its
17795 \begin_inset Quotes eld
17799 \begin_inset Quotes erd
17807 \begin_inset Quotes eld
17815 \begin_inset Quotes erd
17822 \begin_layout Plain Layout
17823 Presumably, mutliple
17828 \begin_inset Quotes eld
17836 \begin_inset Quotes erd
17840 \begin_inset Quotes eld
17848 \begin_inset Quotes erd
17852 \begin_inset Quotes eld
17860 \begin_inset Quotes erd
17864 \begin_inset space ~
17867 appended to the page number of the parent
17877 Clearly, you want the contents of both the
17885 to each fit on a single physical slide! You should probably consider an
17891 \begin_inset Quotes eld
17895 \begin_inset Quotes erd
17903 Indeed, the \SpecialChar LyX
17908 class provides a visual cue for this: the label at the start of an
17912 is shorter than that at the start of a
17917 Lastly, when you generate printable output, you'll find alignment markers
17918 in all four corners of both the
17922 page and its parent
17927 These will assist you in lining up the two physical slides.
17930 \begin_layout Standard
17931 The major problem in overlaying two slides is aligning the contents of the
17932 two transparencies.
17933 How much space should you leave for that graph on the second slide? Worse
17934 still, what if you want a graph and a sentence on second slide, but there
17935 is text on the main transparency that goes in between them? You could try
17936 and insert vertical space of the right size.
17937 The better way is to use
17948 \begin_layout Standard
17949 As their names imply,
17957 are two command-like paragraph environments that make all subsequent text
17958 invisible and visible, respectively.
17960 \begin_inset space ~
17964 \begin_inset CommandInset ref
17966 reference "sec:slideQuirk"
17970 that you don't place anything
17974 these two environments, however.
17979 , it inserts a centered, sky-blue label into the page reading
17980 \begin_inset Quotes eld
17983 <Invisible Text Follows>
17984 \begin_inset Quotes erd
17988 For paragraphs following this label, the parts of the
17996 ; it doesn't matter which] where they would be contain instead blank space.
18000 \begin_layout Standard
18005 , the corresponding centered label is
18006 \begin_inset Quotes eld
18009 <Visible Text Follows>
18010 \begin_inset Quotes erd
18014 Paragraphs following this label behave normally.
18015 Note that the beginning of a new
18027 automatically shuts off an
18032 It's therefore not necessary to use
18043 \begin_layout Standard
18044 By now, it should be obvious how to create overlay transparencies using
18045 the proper combination of
18064 \begin_layout Enumerate
18069 , including everything that will appear on it, whether on the main slide
18077 \begin_layout Enumerate
18078 Before each figure or paragraph that will appear only on the
18087 If necessary, insert a
18091 environment after the
18098 \begin_layout Enumerate
18103 immediately following the
18110 \begin_layout Enumerate
18111 Copy the contents of this
18122 \begin_layout Enumerate
18127 , change all of the
18138 \begin_layout Standard
18140 You've just made an
18147 \begin_layout Standard
18148 There's one problem with the way I've designed the \SpecialChar LyX
18153 class: you can't make text in the middle of a paragraph invisible, nor
18154 make text in the middle of an invisible paragraph visible again.
18155 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18160 \begin_layout Plain Layout
18161 The commands of interest are:
18164 \begin_layout Itemize
18169 invisible \SpecialChar ldots
18173 \begin_layout Itemize
18178 visible \SpecialChar ldots
18182 \begin_layout Plain Layout
18184 and need to be marked as \SpecialChar TeX
18187 \begin_inset Quotes eld
18191 \begin_inset Quotes erd
18194 you wish to change goes in between the brackets [and after the
18207 If you don't know how to mark text as \SpecialChar TeX
18208 , see the appropriate section of
18221 \begin_layout Subsubsection
18231 \begin_inset CommandInset label
18233 name "sec:slideNote"
18240 \begin_layout Standard
18249 is associated with a
18250 \begin_inset Quotes eld
18254 \begin_inset Quotes erd
18262 Here, too, the \SpecialChar LyX
18267 class provides visual cues.
18272 is shorter than that of a
18276 [yet longer than that of an
18280 ] and, like the label of an
18284 is shockingly magenta.
18285 Additionally, the printed
18289 has the page number of its
18290 \begin_inset Quotes eld
18294 \begin_inset Quotes erd
18302 \begin_inset Quotes eld
18310 \begin_inset Quotes erd
18314 \begin_inset Quotes eld
18322 \begin_inset Quotes erd
18326 \begin_inset Quotes eld
18334 \begin_inset Quotes erd
18338 You can have multiple
18342 s associated with a single
18354 , you'll probably want to break up long
18358 s so that they fit on a single sheet of paper.
18361 \begin_layout Standard
18366 is obvious: it contains anything additional you might want to say about
18372 It could also be used as a sheet of reminders for a particular
18377 In the case of the latter, you might want to make use of time markers.
18378 Currently, the \SpecialChar LyX
18384 \begin_inset Quotes eld
18388 \begin_inset Quotes erd
18391 support for time markers, a
18393 Sli\SpecialChar TeX
18397 So, you'll have to resort to using the \SpecialChar LaTeX
18401 \begin_layout Standard
18402 To use time markers, you'll need to specify the extra class option
18403 \begin_inset Quotes eld
18411 \begin_inset Quotes erd
18415 \begin_inset space ~
18419 \begin_inset CommandInset ref
18421 reference "sec:slidesetup"
18426 This option turns on timing marks, which will appear in the lower-left-hand
18432 To set what appears in the time marker, you use the \SpecialChar LaTeX
18434 \begin_inset Quotes eld
18444 \begin_inset Quotes erd
18448 \begin_inset Quotes eld
18458 \begin_inset Quotes erd
18462 The arguments of both commands are time measured in seconds.
18464 \begin_inset Quotes eld
18474 \begin_inset Quotes erd
18477 sets the time marker to a given time.
18479 \begin_inset Quotes eld
18489 \begin_inset Quotes erd
18492 increments the time marker by the specified amount.
18493 Using time markers and
18497 s in this fashion, you can remind yourself how much time to spend on a particula
18505 \begin_layout Standard
18506 There's one last feature to describe.
18507 Clearly, you'd like to print out all of your
18515 s on transparencies while printing all of your
18532 with which it is associated.
18533 What's a person to do?
18536 \begin_layout Standard
18537 Luckily, there are two \SpecialChar LaTeX
18538 commands that allow you to select what to print
18540 Both must be placed into the preamble of your document.
18542 \begin_inset Quotes eld
18554 \begin_inset Quotes erd
18557 will cause the output to contain only the
18566 Correspondingly, the command
18567 \begin_inset Quotes eld
18579 \begin_inset Quotes erd
18582 prevents the output of anything but
18587 I'd advise placing both commands in the preamble and initially comment
18589 You can then preview your entire presentation as you write.
18590 When you're done writing, you can then uncomment one of the two to select
18591 what you want to print.
18592 I like to uncomment
18593 \begin_inset Quotes eld
18605 \begin_inset Quotes erd
18608 , print to a file with
18609 \begin_inset Quotes eld
18617 \begin_inset Quotes erd
18620 in its name, comment it back out, then uncomment
18621 \begin_inset Quotes eld
18633 \begin_inset Quotes erd
18637 \begin_inset Quotes eld
18645 \begin_inset Quotes erd
18649 I can then send either file to a printer, loading transparencies or plain
18650 paper as appropriate.
18653 \begin_layout Standard
18654 You can also provide other arguments to the
18655 \begin_inset Quotes eld
18665 \begin_inset Quotes erd
18669 \begin_inset Quotes eld
18679 \begin_inset Quotes erd
18683 See a good \SpecialChar LaTeX
18687 \begin_layout Subsection
18692 Class Template File
18695 \begin_layout Standard
18696 I have also provided a template file,
18697 \begin_inset Quotes eld
18705 \begin_inset Quotes erd
18713 To use it, begin your new presentation with
18715 File\SpecialChar menuseparator
18717 \begin_inset space ~
18721 \begin_inset space ~
18727 Your new \SpecialChar LyX
18728 presentation file will contain an example
18749 additionally contain an example of the use of
18758 Lastly, the preamble will contain:
18761 \begin_layout LyX-Code
18762 % Uncomment to print out only slides and overlays
18765 \begin_layout LyX-Code
18769 \begin_layout LyX-Code
18775 \begin_inset Newline newline
18781 \begin_layout LyX-Code
18782 % Uncomment to print out only notes
18785 \begin_layout LyX-Code
18789 \begin_layout LyX-Code
18797 \begin_layout Standard
18798 One final thing: I created this class to support the \SpecialChar LaTeX2e
18800 \begin_inset Quotes eld
18805 Sli\SpecialChar TeX
18809 \begin_inset Quotes erd
18812 class, one of the built-in \SpecialChar LaTeX2e
18814 Neither I nor the rest of the \SpecialChar LyX
18815 Team endorse or oppose the use of this built-in
18817 It's here if you want it or need it.
18818 There exist other \SpecialChar LaTeX2e
18819 classes for creating presentations, such as the
18824 \begin_inset space ~
18828 \begin_inset CommandInset ref
18830 reference "sec:foiltex"
18835 \begin_inset Quotes eld
18843 \begin_inset Quotes erd
18846 package [present on some \SpecialChar TeX
18848 The latter is not yet supported under \SpecialChar LyX
18853 \begin_layout Plain Layout
18854 Perhaps you can take on the task\SpecialChar ldots
18860 I know nothing about these other classes.
18861 Try them out to see what sort of alternative they provide.
18864 \begin_layout Chapter
18866 Features needing Extra Software
18869 \begin_layout Section
18870 Checking \SpecialChar TeX
18874 \begin_layout Standard
18880 \begin_layout Subsection
18884 \begin_layout Standard
18893 \begin_layout Plain Layout
18898 is not yet available when you are using the \SpecialChar LaTeX
18899 distribution MiK\SpecialChar TeX
18905 , you'll find in the
18912 \begin_inset space ~
18923 \begin_inset Newline newline
18927 \begin_inset CommandInset href
18929 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18937 \begin_layout Standard
18940 Chk\SpecialChar TeX
18943 package is a program that was written by
18944 \begin_inset Flex Noun
18947 \begin_layout Plain Layout
18949 \begin_inset space ~
18957 in frustration because some constructs in \SpecialChar LaTeX
18958 are sometimes non-intuitive,
18959 and easy to forget.
18960 The program runs over your \SpecialChar LaTeX
18961 file, checks the integrity of the file, and
18962 flags some common errors.
18963 In other technical words, it is
18967 for \SpecialChar LaTeX
18971 \begin_layout Standard
18972 Well, what is a syntax checker doing in \SpecialChar LyX
18973 which is supposed to produce correct
18975 anyways? The answer is simple: Just as
18979 not only checks the
18983 of C programs, but also does
18987 checks for type-errors,
18989 Chk\SpecialChar TeX
18992 catches some common
18996 errors, in addition to the syntactical ones.
18999 Chk\SpecialChar TeX
19002 is capable of detecting several common errors, such as
19005 \begin_layout Itemize
19006 Ellipsis detection:
19007 \begin_inset Newline newline
19010 Use \SpecialChar ldots
19014 \begin_layout Itemize
19015 No space in front of/after parenthesis:
19016 \begin_inset Newline newline
19022 \begin_layout Itemize
19023 Enforcement of normal space after common abbreviations:
19024 \begin_inset Newline newline
19028 \begin_inset space \thinspace{}
19032 \begin_inset space \space{}
19035 is too wide spacing.
19038 \begin_layout Itemize
19039 Enforcement of end-of-sentence space when the last sentence ends with a
19041 \begin_inset Newline newline
19045 And this is wrong spacing.
19048 \begin_layout Itemize
19049 Space in front of labels and similar commands:
19050 \begin_inset Newline newline
19053 The label should stick right up to the text to avoid falling to a wrong
19056 \begin_inset CommandInset label
19066 \begin_layout Plain Layout
19067 This footnote is in danger of falling off to a wrong page
19072 The label is separated too much.
19075 \begin_layout Itemize
19076 Space in front of references, instead of hard spaces:
19077 \begin_inset Newline newline
19080 If you have bad luck, the text will break right between the referenced text
19081 and reference number, and that's a pity.
19083 \begin_inset CommandInset ref
19085 reference "sec:chktex"
19092 \begin_layout Itemize
19094 \begin_inset Quotes eld
19098 \begin_inset Quotes erd
19102 \begin_inset Formula $\times$
19106 \begin_inset Newline newline
19109 2x2 looks cheap compared to
19110 \begin_inset Formula $2\times2$
19116 \begin_layout Standard
19117 and more \SpecialChar ldots
19118 It is an invaluable tool when you are
19119 \begin_inset Quotes eld
19123 \begin_inset Quotes erd
19126 your document before printing, and you should run it right after the obligatory
19127 spelling check, and before you go fine tuning the typesetting.
19130 \begin_layout Subsection
19134 \begin_layout Standard
19135 If you have the program installed, usage is as simple as choosing
19137 Tools\SpecialChar menuseparator
19139 \begin_inset space ~
19145 This will make \SpecialChar LyX
19146 generate a \SpecialChar LaTeX
19147 file of your document, start
19149 Chk\SpecialChar TeX
19152 to check it, and then make \SpecialChar LyX
19154 \begin_inset Quotes eld
19158 \begin_inset Quotes erd
19161 with the warnings from
19163 Chk\SpecialChar TeX
19166 , if there were any.
19167 The warnings will be placed close to the point of the mistake, and you
19168 can quickly find them by using the
19170 Navigate\SpecialChar menuseparator
19173 menu item, or the shortcut key
19182 Open the error boxes by clicking on them with the mouse, or use the shortcut
19191 bindings, or the corresponding
19200 Read the warning and correct the mistake, if it is a mistake.
19201 If you have trouble understanding what the warning is about, you can safely
19203 Remember that there is a hidden layer between the document on screen and
19204 the technical details in invoking
19206 Chk\SpecialChar TeX
19209 , and this gap can make some warnings seem arcane or just plain silly.
19212 \begin_layout Standard
19213 This document is an excellent testing bed for the feature, and it should
19214 provide quite a few warnings for you to fiddle with.
19215 Since computers are only so smart, expect most of the warnings to be false
19219 \begin_layout Subsection
19220 How to fine tune it
19223 \begin_layout Standard
19224 Sometimes, you'll find that
19226 Chk\SpecialChar TeX
19229 makes more noise than suits your mood.
19230 Then you can choose not to use it, wait until your mood changes, or try
19233 Chk\SpecialChar TeX
19236 to get better along with you.
19239 \begin_layout Standard
19242 Chk\SpecialChar TeX
19249 very configurable and extensible, you should not expect to solve all problems
19252 Chk\SpecialChar TeX
19255 in \SpecialChar LyX
19257 Since \SpecialChar LyX
19258 has to generate a somewhat special \SpecialChar LaTeX
19259 file to be able to match the
19260 line numbers from the
19262 Chk\SpecialChar TeX
19269 \begin_layout Plain Layout
19270 You can inspect the specific output from
19276 Document\SpecialChar menuseparator
19279 \begin_inset space ~
19293 to the internal document structure, some of the warnings will not appear
19295 There are two things you can do about this:
19298 \begin_layout Itemize
19301 Chk\SpecialChar TeX
19304 invocation command line in
19305 \begin_inset Flex Noun
19308 \begin_layout Plain Layout
19309 Tools\SpecialChar menuseparator
19310 Preferences\SpecialChar menuseparator
19311 Output\SpecialChar menuseparator
19312 LaTeX\SpecialChar menuseparator
19320 Chk\SpecialChar TeX
19323 installation configuration file (usually with the file
19328 See below to learn what warnings can be enabled and disabled on the command
19332 \begin_layout Itemize
19333 Export your document as a raw \SpecialChar LaTeX
19336 File\SpecialChar menuseparator
19337 Export\SpecialChar menuseparator
19346 Invoked in this way, it can be a hassle to find the corresponding place
19347 in the document inside \SpecialChar LyX
19348 , but with a little patience, you should be able
19352 \begin_layout Standard
19353 Here follows the warning messages that can be enabled and disabled in
19362 to disable a warning, and
19366 to enable a warning.
19367 The emphasized entries are disabled by default, because the default is
19370 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19375 \begin_layout Standard
19376 Notice that you should only use the options that enable and disable warnings,
19377 because \SpecialChar LyX
19378 relies on some of the other command line parameters to be set
19379 in a specific way to have a chance to communicate with
19386 \begin_layout Enumerate
19390 Command terminated with space.
19393 \begin_layout Enumerate
19396 Non-breaking space (
19397 \begin_inset Quotes eld
19405 \begin_inset Quotes erd
19408 ) should have been used.
19411 \begin_layout Enumerate
19415 You should enclose the previous parenthesis with
19416 \begin_inset Quotes eld
19424 \begin_inset Quotes erd
19430 \begin_layout Enumerate
19433 Italic correction (
19434 \begin_inset Quotes eld
19444 \begin_inset Quotes erd
19447 ) found in non-italic buffer.
19450 \begin_layout Enumerate
19453 Italic correction (
19454 \begin_inset Quotes eld
19464 \begin_inset Quotes erd
19467 ) found more than once.
19470 \begin_layout Enumerate
19474 No italic correction (
19475 \begin_inset Quotes eld
19485 \begin_inset Quotes erd
19491 \begin_layout Enumerate
19495 \begin_inset Quotes eld
19503 \begin_inset Quotes erd
19507 \begin_inset Quotes eld
19515 \begin_inset Quotes erd
19521 \begin_layout Enumerate
19524 Wrong length of dash may have been used.
19527 \begin_layout Enumerate
19531 \begin_inset Quotes eld
19539 \begin_inset Quotes erd
19543 \begin_inset Quotes eld
19551 \begin_inset Quotes erd
19557 \begin_layout Enumerate
19561 \begin_inset Quotes eld
19569 \begin_inset Quotes erd
19575 \begin_layout Enumerate
19579 \begin_inset Quotes eld
19587 \begin_inset Quotes erd
19590 to achieve an ellipsis.
19593 \begin_layout Enumerate
19596 Inter-word spacing (
19597 \begin_inset Quotes eld
19607 \begin_inset Quotes eld
19610 ) should perhaps be used.
19613 \begin_layout Enumerate
19616 Inter-sentence spacing (
19617 \begin_inset Quotes eld
19627 \begin_inset Quotes erd
19630 ) should perhaps be used.
19633 \begin_layout Enumerate
19636 Could not find argument for command.
19639 \begin_layout Enumerate
19643 \begin_inset Quotes eld
19651 \begin_inset Quotes erd
19657 \begin_layout Enumerate
19660 Math mode still on at end of \SpecialChar LaTeX
19664 \begin_layout Enumerate
19668 \begin_inset Quotes eld
19676 \begin_inset Quotes erd
19679 doesn't match the number of
19680 \begin_inset Quotes eld
19688 \begin_inset Quotes erd
19694 \begin_layout Enumerate
19697 You should use either
19700 \begin_inset Quotes eld
19708 \begin_inset Quotes erd
19713 as an alternative to
19714 \begin_inset Quotes eld
19722 \begin_inset Quotes erd
19728 \begin_layout Enumerate
19735 " (ASCII 39) instead of "
19742 \begin_layout Enumerate
19745 User-specified pattern found.
19748 \begin_layout Enumerate
19751 This command might not be intended.
19754 \begin_layout Enumerate
19761 \begin_layout Enumerate
19779 \begin_layout Enumerate
19782 Delete this space to maintain correct page references.
19785 \begin_layout Enumerate
19789 You might wish to put this between a pair of
19790 \begin_inset Quotes eld
19798 \begin_inset Quotes erd
19804 \begin_layout Enumerate
19807 You ought to remove spaces in front of punctuation.
19810 \begin_layout Enumerate
19813 Could not execute \SpecialChar LaTeX
19817 \begin_layout Enumerate
19826 in front of small punctuation.
19829 \begin_layout Enumerate
19837 may look prettier here.
19840 \begin_layout Enumerate
19844 Multiple spaces detected in output.
19847 \begin_layout Enumerate
19850 This text may be ignored.
19853 \begin_layout Enumerate
19859 \begin_inset Quotes eld
19864 to begin quotation, not
19871 \begin_layout Enumerate
19878 to end quotation, not
19881 \begin_inset Quotes eld
19889 \begin_layout Enumerate
19895 \begin_layout Enumerate
19898 You should perhaps use
19899 \begin_inset Quotes eld
19907 \begin_inset Quotes erd
19913 \begin_layout Enumerate
19916 You should put a space in front of/after parenthesis.
19919 \begin_layout Enumerate
19922 You should avoid spaces in front of/after parenthesis.
19925 \begin_layout Enumerate
19929 You should not use punctuation in front of/after quotes.
19932 \begin_layout Enumerate
19935 Double space found.
19938 \begin_layout Enumerate
19941 You should put punctuation outside inner/inside display math mode.
19944 \begin_layout Enumerate
19947 You ought to not use primitive \SpecialChar TeX
19948 in \SpecialChar LaTeX
19952 \begin_layout Enumerate
19955 You should remove spaces in front of
19956 \begin_inset Quotes eld
19964 \begin_inset Quotes erd
19970 \begin_layout Enumerate
19973 \begin_inset Quotes eld
19981 \begin_inset Quotes erd
19984 is normally not followed by
19985 \begin_inset Quotes eld
19993 \begin_inset Quotes erd
19999 \begin_layout Standard
20000 In later versions of \SpecialChar LyX
20001 , we hope to provide a more complete interface to this
20002 tool (and it's smaller cousin
20006 ) to exploit the full power of it.
20007 But it's not exactly useless as it is now: go try it on one of your existing
20008 documents of a certain length and be surprised.
20011 \begin_layout Section
20012 Version Control in \SpecialChar LyX
20016 \begin_layout Standard
20019 Lars Gullik Bjønnes
20026 \begin_layout Subsection
20030 \begin_layout Standard
20032 supports some of the most basic RCS/CVS/SVN/GIT commands.
20033 If you need something a bit more sophisticated you will have to do that
20034 manually in a terminal.
20037 \begin_layout Standard
20038 Also note that CVS support is not as good as subversion support so we advise
20040 A good place to start learning Subversion is SVN Book
20044 \begin_layout Plain Layout
20045 \begin_inset CommandInset href
20047 target "http://svnbook.red-bean.com/"
20058 In the case of RCS you should read
20059 \begin_inset Quotes eld
20063 \begin_inset Quotes erd
20066 (a man file, read it with
20071 This file describes all the basic features of RCS.
20072 You should especially notice the comment about a RCS directory, and the
20073 notion of a master RCS file (the file ending in
20080 \begin_layout Standard
20081 Before you begin to use the version control features in \SpecialChar LyX
20083 familiar with RCS/CVS/SVN/GIT usage.
20084 The implementation in \SpecialChar LyX
20085 assumes a recent version of the GNU RCS or CVS/SVN
20086 package — no guarantees are made for older versions.
20087 Most of the log messages are not currently displayed after operations —
20088 you can check them in the Messages pane if unsure.
20089 Regular users of version control will appreciate VC toolbar, which can
20092 View\SpecialChar menuseparator
20093 Toolbars\SpecialChar menuseparator
20095 \begin_inset space ~
20103 \begin_layout Standard
20104 For introducing your own external commands consult vc-command in the manual
20105 of \SpecialChar LyX
20109 \begin_layout Standard
20110 It is strongly recommended to store documents in uncompressed format if
20111 using version control (uncheck
20113 Document\SpecialChar menuseparator
20116 if it is checked): Uncompressed LyX documents are text files and therefore
20117 for merging two different versions by version control systems.
20118 Compressed LyX documents are binary files, which cannot be merged by version
20122 \begin_layout Subsection
20123 RCS commands in \SpecialChar LyX
20127 \begin_layout Standard
20128 The following sections describe the RCS commands supported by \SpecialChar LyX
20130 You can find them in the
20132 File\SpecialChar menuseparator
20134 \begin_inset space ~
20141 was tested against RCS 5.7/5.8.
20144 \begin_layout Subsubsection
20150 \begin_layout Standard
20151 If your document is not under revision control, this is the only item shown
20153 And if it is under revision control, the
20157 item is not visible.
20161 \begin_layout Standard
20162 This command registers your document with RCS (unless you are under the
20163 directory managed by CVS)\SpecialChar endofsentence
20164 You are asked interactively to supply an initial
20165 description of the document.
20166 The document is now set in Read-Only mode and you have to
20169 \begin_inset space ~
20173 \begin_inset space ~
20177 \begin_inset space ~
20182 , before making any changes to it.
20183 A document under revision control has a
20184 \begin_inset Quotes eld
20187 [RCS:<version> <locker>]
20188 \begin_inset Quotes erd
20191 item tagged to the filename in the minibuffer.
20194 \begin_layout Standard
20195 RCS command that is run:
20197 ci -q -u -i -t-"<initial description>" <file-name>
20200 \begin_layout Standard
20205 to understand the switches.
20209 \begin_layout Subsubsection
20215 \begin_layout Standard
20216 When you are finished editing a file, you check in your changes.
20217 When you do this, you are asked for a description of the changes.
20218 This is stored in the history log.
20219 The version number is bumped, your changes are applied to the master RCS
20220 file, the document is unlocked and set to Read-Only mode.
20223 \begin_layout Standard
20226 ci -q -u -m"<description>" <file-name>
20229 \begin_layout Subsubsection
20235 \begin_layout Standard
20236 By doing this you lock the document so that only you can edit it.
20237 This will also make the document Read-Write only for you.
20238 You will usually continue editing for a while and when you are finished
20239 you check in your changes.
20240 The status line is changed to reflect that you have locked the file.
20243 \begin_layout Standard
20246 co -q -l <file-name>
20249 \begin_layout Subsubsection
20252 Revert To Repository Version
20255 \begin_layout Standard
20256 This will discard all changes made to the document since the last check
20258 You get a warning before changes are discarded.
20261 \begin_layout Standard
20264 co -f -u<version> <file-name>
20267 \begin_layout Subsubsection
20273 \begin_layout Standard
20274 This will create a copy of the current document.
20275 Since RCS does not support copy operations natively, the version history
20276 is not preserved, and the copy is added as a new file.
20277 It requires a clean document without any changes since the last checkin.
20278 You are asked for a file name and a description of the copy operation.
20279 After that the copy is created, both locally and in the repository.
20280 If the parent directories of the copied and original document differ, all
20281 relative paths of included files of the copy are adjusted (like in
20283 File\SpecialChar menuseparator
20288 Finally, the copy is loaded instead of the original document.
20291 \begin_layout Labeling
20292 \labelwidthstring 00.00.0000
20294 \begin_inset space ~
20298 \begin_inset space ~
20302 \begin_inset Newline newline
20306 \begin_inset Flex Code
20309 \begin_layout Plain Layout
20312 \begin_inset Quotes eld
20316 \begin_inset Quotes erd
20325 \begin_inset Flex Code
20328 \begin_layout Plain Layout
20331 \begin_inset Quotes eld
20335 \begin_inset Quotes erd
20344 \begin_inset Newline newline
20348 \begin_inset Flex Code
20351 \begin_layout Plain Layout
20355 \begin_inset Quotes eld
20359 \begin_inset Quotes erd
20370 \begin_layout Subsubsection
20376 \begin_layout Standard
20377 This makes as if the last check in never happened.
20378 No changes are made to the document loaded into \SpecialChar LyX
20379 , but the last version
20380 is removed from the master RCS file.
20383 \begin_layout Standard
20386 rcs -o<version> <file-name>
20389 \begin_layout Subsubsection
20395 \begin_layout Standard
20396 This shows the complete history of the RCS document.
20401 is shown in a browser.
20409 \begin_layout Subsubsection
20413 \begin_layout Standard
20415 supports RCS version number, author name, date and time of last commit.
20416 All those are extracted from
20418 rlog -r <file-name>
20422 \begin_inset CommandInset ref
20424 reference "subsec:VCS-Revision-Information"
20431 \begin_layout Subsection
20432 CVS commands in \SpecialChar LyX
20436 \begin_layout Standard
20437 A subset of CVS operations is supported by \SpecialChar LyX
20439 You can find the commands in the
20441 File\SpecialChar menuseparator
20443 \begin_inset space ~
20449 The version control system SVN is more powerful, so please use it instead
20450 of CVS if possible.
20453 \begin_layout Subsubsection
20459 \begin_layout Standard
20460 If you start from scratch with CVS you have to create your repository and
20461 checkout the working copy with external tools.
20462 If you're using a client-server setup you may need to login before doing
20463 the first repository checkout.
20466 \begin_layout Standard
20467 If your documents are under revision control and others are using the same
20468 repository problems arise when different changes to the same document at
20469 the same location happen.
20470 Standard CVS repositories don't operate with a file locking mechanism.
20471 This may be surprising, but conflicts only occur if people disagree on
20472 the proper content of the same part of a document.
20473 So, if co-workers are used to communicate regularly, these conflicts occur
20475 If they don't communicate they have a fundamental problem anyway.
20476 Nevertheless some people like to work with so called
20477 \begin_inset Quotes eld
20481 \begin_inset Quotes erd
20485 If they do so the working copy of all files is readonly when checked out
20486 first and the user starts editing after using a special command to make
20487 the working copy writable.
20488 When the changes are checked in the working copy returns to readonly state.
20489 With \SpecialChar LyX
20490 one has to edit the
20491 \begin_inset Flex Code
20494 \begin_layout Plain Layout
20500 file and add the line
20501 \begin_inset Flex Code
20504 \begin_layout Plain Layout
20510 to work with reserved checkouts.
20511 The benefit is the possibility to see who is using a writable copy of some
20513 It's not guaranteed only one user makes a copy writable.
20516 \begin_layout Standard
20518 tries to guess if you're using reserved or non-reserved checkouts.
20519 If your working copy is readonly or it is writable and an additional copy
20520 of your document exists in the CVS/Base sub-directory a reserved otherwise
20521 a non-reserved checkout is assumed.
20522 When a reserved checkout is detected you have to use
20523 \begin_inset Flex Noun
20526 \begin_layout Plain Layout
20532 to make your working copy writable if it's readonly.
20534 \begin_inset Flex Noun
20537 \begin_layout Plain Layout
20543 operation is possible and that makes your working copy readonly again after
20544 transferring your changes to the repository.
20547 \begin_layout Standard
20548 More information about CVS can be found here
20549 \begin_inset Flex URL
20552 \begin_layout Plain Layout
20554 http://www.nongnu.org/cvs
20560 \begin_inset Flex URL
20563 \begin_layout Plain Layout
20565 http://ximbiot.com/cvs
20573 \begin_layout Standard
20578 to understand the sub-commands and the switches mentioned below.
20581 \begin_layout Subsubsection
20587 \begin_layout Standard
20588 If your document is not under revision control, this is the only item shown
20590 And if it is under revision control, the
20594 item is not visible.
20598 \begin_layout Standard
20599 This command registers in CVS your document
20600 \begin_inset Flex Strong
20603 \begin_layout Plain Layout
20611 in the case you have already the documents directory under CVS control
20617 This means you have to create or checkout the archive by yourself using
20619 (In case you forget that step \SpecialChar LyX
20620 registers the document with RCS.)
20623 \begin_layout Standard
20624 Then you are asked interactively to supply an initial description of the
20626 Don't forget that registered file is not yet checked in.
20629 \begin_layout Standard
20630 CVS command that is run:
20632 cvs -q add -m"<entered message>" "<file-name>"
20635 \begin_layout Standard
20640 above and for all other CVS commands is an abbreviation for
20641 \begin_inset Quotes eld
20644 change the current working directory to file location and use the file name
20645 without path component as argument
20646 \begin_inset Quotes erd
20652 \begin_layout Subsubsection
20658 \begin_layout Standard
20659 When you are finished editing a file, you commit your changes.
20660 When you do this and you had changed the document, you are asked for a
20661 description of the changes.
20662 After that changes are written to the repository.
20663 In case you didn't change the document and a reserved checkout is detected
20664 the reservation made on
20665 \begin_inset Flex Noun
20668 \begin_layout Plain Layout
20677 \begin_layout Labeling
20678 \labelwidthstring 00.00.0000
20680 \begin_inset space ~
20684 \begin_inset space ~
20688 \begin_inset Newline newline
20692 \begin_inset Flex Code
20695 \begin_layout Plain Layout
20698 -q commit -m"<description>" "<file-name>"
20704 \begin_inset Newline newline
20708 \begin_inset Flex Code
20711 \begin_layout Plain Layout
20722 \begin_layout Subsubsection
20728 \begin_layout Standard
20729 When you are sharing a repository with others, you may have to incorporate
20730 their changes into your working copy.
20733 \begin_layout Standard
20736 cvs -q update "<file-name>"
20739 \begin_layout Standard
20740 If a readonly checkout is detected the working copy is made writable and
20744 \begin_layout Standard
20747 cvs -q edit "<file-name>"
20750 \begin_layout Subsubsection
20753 Revert To Repository Version
20756 \begin_layout Standard
20757 This will discard all changes made to the document since the last check
20759 You get a warning before changes are discarded.
20760 Firstly the file is deleted, secondly CVS update command is run.
20763 \begin_layout Standard
20766 cvs -q update "<file-name>"
20769 \begin_layout Standard
20770 If a reserved checkout is detected and the working copy has no changes only
20771 the reservation is undone.
20774 \begin_layout Standard
20777 cvs -q unedit "<file-name>"
20780 \begin_layout Subsubsection
20786 \begin_layout Standard
20787 This will create a copy of the current document.
20788 Since CVS does not support copy operations natively, the version history
20789 is not preserved, and the copy is added as a new file.
20790 It requires a clean document without any changes since the last checkin.
20791 You are asked for a file name and a description of the copy operation.
20792 After that the copy is created, both locally and in the repository.
20793 If the parent directories of the copied and original document differ, all
20794 relative paths of included files of the copy are adjusted (like in
20796 File\SpecialChar menuseparator
20801 Finally, the copy is loaded instead of the original document.
20804 \begin_layout Labeling
20805 \labelwidthstring 00.00.0000
20807 \begin_inset space ~
20811 \begin_inset space ~
20815 \begin_inset Newline newline
20819 \begin_inset Flex Code
20822 \begin_layout Plain Layout
20825 \begin_inset Quotes eld
20829 \begin_inset Quotes erd
20838 \begin_inset Flex Code
20841 \begin_layout Plain Layout
20844 \begin_inset Quotes eld
20848 \begin_inset Quotes erd
20857 \begin_inset Newline newline
20861 \begin_inset Flex Code
20864 \begin_layout Plain Layout
20868 \begin_inset Quotes eld
20872 \begin_inset Quotes erd
20883 \begin_layout Subsubsection
20889 \begin_layout Standard
20890 This will rename the current document.
20891 Since CVS does not support rename operations natively, the version history
20892 is not preserved, the renamed document is added as a new file, and the
20893 original document is deleted.
20894 It requires a clean document without any changes since the last checkin.
20895 You are asked for a file name and a description of the rename operation.
20896 After that the document is renamed, both locally and in the repository.
20897 If the parent directories of the new and old file names differ, all relative
20898 paths of included files are adjusted (like in
20900 File\SpecialChar menuseparator
20905 Finally, the document is reloaded using the new name.
20908 \begin_layout Labeling
20909 \labelwidthstring 00.00.0000
20911 \begin_inset space ~
20915 \begin_inset space ~
20919 \begin_inset Newline newline
20923 \begin_inset Flex Code
20926 \begin_layout Plain Layout
20929 \begin_inset Quotes eld
20933 \begin_inset Quotes erd
20942 \begin_inset Flex Code
20945 \begin_layout Plain Layout
20948 \begin_inset Quotes eld
20952 \begin_inset Quotes erd
20961 \begin_inset Newline newline
20965 \begin_inset Flex Code
20968 \begin_layout Plain Layout
20972 \begin_inset Quotes eld
20976 \begin_inset Quotes erd
20985 \begin_inset Newline newline
20989 \begin_inset Flex Code
20992 \begin_layout Plain Layout
20996 \begin_inset Quotes eld
21000 \begin_inset Quotes erd
21011 \begin_layout Subsubsection
21012 Update of the local directory checkout from repository
21015 \begin_layout Standard
21016 Once your documents gets more complex, containing sub-documents and pictures,
21018 \begin_inset Flex Code
21021 \begin_layout Plain Layout
21027 files and so on using version control becomes more complicated.
21029 supports updating the whole tree in which resides the document.
21030 This become especially useful once you cooperate with people which neither
21031 have detailed knowledge about CVS usage nor they have ambition to commit
21032 additional material to the repository.
21033 You have to organize the files structure so that all external files are
21034 in the same directory or subdirectories of the document.
21035 It's good practice anyway to store multipart documents in an extra directory.
21038 \begin_layout Standard
21040 \begin_inset Flex Code
21043 \begin_layout Plain Layout
21044 Update local directory from repository
21049 command updates the whole directory.
21050 If local changes are detected user is warned before update starts.
21051 In case of merge conflicts both versions of the conflicting document parts
21052 are placed in the final document.
21053 You have to review and correct the result of the merge.
21054 You'll find the conflicts enclosed in pairs of
21055 \begin_inset Flex Code
21058 \begin_layout Plain Layout
21065 \begin_inset Flex Code
21068 \begin_layout Plain Layout
21075 \begin_inset Flex Code
21078 \begin_layout Plain Layout
21085 The first part is your version as before the update operation with the
21086 document name prepended.
21087 The second one is the repository version with the version number after
21089 \begin_inset Flex Code
21092 \begin_layout Plain Layout
21101 \begin_layout Labeling
21102 \labelwidthstring 00.00.0000
21104 \begin_inset space ~
21108 \begin_inset space ~
21112 \begin_inset Newline newline
21116 \begin_inset Flex Code
21119 \begin_layout Plain Layout
21127 (Ask if changes are detected.)
21128 \begin_inset Newline newline
21132 \begin_inset Flex Code
21135 \begin_layout Plain Layout
21136 cd $path; cvs -q update
21146 \begin_layout Standard
21148 \begin_inset Flex Code
21151 \begin_layout Plain Layout
21157 stands for the path to the document.
21160 \begin_layout Subsubsection
21166 \begin_layout Standard
21167 This shows the complete history of the CVS document.
21170 cvs log "<file-name>"
21172 is shown in a browser.
21175 \begin_layout Subsubsection
21179 \begin_layout Standard
21181 supports CVS version number, author name, date and time of last commit.
21182 All those are extracted from
21184 cvs log -r <file-name>
21188 \begin_inset CommandInset ref
21190 reference "subsec:VCS-Revision-Information"
21197 \begin_layout Subsection
21198 SVN commands in \SpecialChar LyX
21202 \begin_layout Standard
21203 SVN is now partially supported by \SpecialChar LyX
21205 You can find the commands in the
21207 File\SpecialChar menuseparator
21209 \begin_inset space ~
21215 Please note that if you use password protected access to repository via
21216 ssh, you will be asked in terminal window.
21218 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21222 \begin_layout Plain Layout
21223 Most of the commands will work with 1.4 too, see
21224 \begin_inset CommandInset ref
21226 reference "subsec:SVN-Repo-Update"
21231 There seems to be currently unresolved permissions problem under SVN 1.8
21232 with reverting changes when file is locked.
21240 \begin_layout Subsubsection
21246 \begin_layout Standard
21247 If your document is not under revision control, this is the only item shown
21249 And if it is under revision control, the
21253 item is not visible.
21256 \begin_layout Standard
21257 This command registers in SVN your document ONLY in case you have already
21258 the documents directory under SVN control (in particular
21263 This means you have to checkout the archive by yourself.
21266 \begin_layout Standard
21267 Then you are asked interactively to supply an initial description of the
21269 Don't forget that registered file is not yet commited.
21272 \begin_layout Standard
21273 SVN command that is run:
21276 \begin_inset Quotes eld
21280 \begin_inset Quotes erd
21286 \begin_layout Standard
21291 to understand the switches.
21294 \begin_layout Subsubsection
21300 \begin_layout Standard
21301 When you are finished editing a file, you commit your changes.
21302 When you do this, you are asked for a description of the changes.
21303 After that changes are commited.
21306 \begin_layout Standard
21311 \begin_layout Plain Layout
21312 In case locking is not enabled.
21314 \begin_inset CommandInset ref
21316 reference "subsec:SVN-File-Locking"
21327 svn commit -q -m"<description>" <file-name>
21330 \begin_layout Subsubsection
21336 \begin_layout Standard
21337 Updates the changes of this file from the repository.
21338 Be sure you understand SVN merging and conflicts resolving before using
21339 this function, because all conflicts has to be resolved manually by you!
21342 \begin_layout Standard
21347 \begin_layout Plain Layout
21355 svn update --non-interactive
21356 \begin_inset Quotes eld
21360 \begin_inset Quotes erd
21366 \begin_layout Subsubsection
21369 Revert To Repository Version
21372 \begin_layout Standard
21373 This will discard all changes made to the document since the last check
21375 You get a warning before changes are discarded.
21378 \begin_layout Standard
21382 \begin_inset Quotes eld
21386 \begin_inset Quotes erd
21392 \begin_layout Subsubsection
21398 \begin_layout Standard
21399 This will create a copy of the current document including the version history.
21400 It requires a clean document without any changes since the last checkin.
21401 You are asked for a file name and a description of the copy operation.
21402 After that the copy is created, both locally and in the repository.
21403 If the parent directories of the copied and original document differ, all
21404 relative paths of included files of the copy are adjusted (like in
21406 File\SpecialChar menuseparator
21411 Finally, the copy is loaded instead of the original document.
21414 \begin_layout Labeling
21415 \labelwidthstring 00.00.0000
21417 \begin_inset space ~
21421 \begin_inset space ~
21425 \begin_inset Newline newline
21429 \begin_inset Flex Code
21432 \begin_layout Plain Layout
21436 \begin_inset Quotes eld
21440 \begin_inset Quotes erd
21444 \begin_inset Quotes eld
21448 \begin_inset Quotes erd
21457 \begin_inset Newline newline
21461 \begin_inset Flex Code
21464 \begin_layout Plain Layout
21473 \begin_layout Subsubsection
21479 \begin_layout Standard
21480 This will rename the current document including the version history.
21481 It requires a clean document without any changes since the last checkin.
21482 You are asked for a file name and a description of the rename operation.
21483 After that the document is renamed, both locally and in the repository.
21484 If the parent directories of the new and old file names differ, all relative
21485 paths of included files are adjusted (like in
21487 File\SpecialChar menuseparator
21492 Finally, the document is reloaded using the new name.
21495 \begin_layout Labeling
21496 \labelwidthstring 00.00.0000
21498 \begin_inset space ~
21502 \begin_inset space ~
21506 \begin_inset Newline newline
21510 \begin_inset Flex Code
21513 \begin_layout Plain Layout
21517 \begin_inset Quotes eld
21521 \begin_inset Quotes erd
21525 \begin_inset Quotes eld
21529 \begin_inset Quotes erd
21538 \begin_inset Newline newline
21542 \begin_inset Flex Code
21545 \begin_layout Plain Layout
21554 \begin_layout Subsubsection
21555 \begin_inset CommandInset label
21557 name "subsec:SVN-Repo-Update"
21561 Update of the local directory checkout from repository
21565 \begin_layout Plain Layout
21566 Note that this command will work only with subversion
21567 \begin_inset Formula $\geqq1.5$
21578 \begin_layout Standard
21579 All the commands above have one shortcomming - they deal with the current
21581 Once your document contains pictures, includes external
21582 \begin_inset Flex Code
21585 \begin_layout Plain Layout
21591 files and so on administration becomes more complicated.
21593 now supports updating the whole tree in which resides the document
21597 \begin_layout Plain Layout
21598 One need to organize the files structure so that all external files are
21599 in the same directory or subdirectories of the document.
21606 This become especially useful once you cooperate with people which neither
21607 know about subversion management nor they have ambition to commit additional
21608 material to the repository.
21612 \begin_layout Standard
21613 \begin_inset Flex Code
21616 \begin_layout Plain Layout
21617 Update local directory from repository
21622 command updates the whole directory and in case of merge conflicts local
21623 version of the files are left, so no unintended data loss occurs.
21624 If local changes are detected user is warned before update starts.
21627 \begin_layout Labeling
21628 \labelwidthstring 00.00.0000
21630 \begin_inset space ~
21634 \begin_inset space ~
21638 \begin_inset Newline newline
21642 \begin_inset Flex Code
21645 \begin_layout Plain Layout
21651 (Ask if changes are detected.)
21652 \begin_inset Newline newline
21656 \begin_inset Flex Code
21659 \begin_layout Plain Layout
21660 svn update –accept mine-full $path
21668 \begin_layout Standard
21670 \begin_inset Flex Code
21673 \begin_layout Plain Layout
21679 stands for the path to the document.
21682 \begin_layout Subsubsection
21688 \begin_layout Standard
21689 This shows the complete history of the SVN document.
21693 \begin_inset Quotes eld
21697 \begin_inset Quotes erd
21702 is shown in a browser.
21705 \begin_layout Subsubsection
21707 \begin_inset CommandInset label
21709 name "subsec:SVN-File-Locking"
21716 \begin_layout Standard
21717 The file exchange through various revision control systems brings the problem
21718 of merge conflicts in case two different users try to edit the same (parts
21720 When such a conflict happens it needs manual resolving and one reasonable
21721 alternative is to provide some kind of locking mechanism, which guarantees
21722 that only one user is allowed to edit file at the given time.
21725 \begin_layout Standard
21726 SVN has two such mechanisms to provide mutual exclusivity for file access
21727 - locks and automatic setting of write permissions (see sec.
21729 \begin_inset CommandInset ref
21731 reference "subsec:Automatical-Locking-Property"
21736 \begin_inset Flex Code
21739 \begin_layout Plain Layout
21749 \begin_layout Plain Layout
21750 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21756 If this property is detected for a given document \SpecialChar LyX
21757 starts to use SVN locks
21758 for document editing automatically and the whole check-in/out mechanism
21759 switches to the same regimen as for RCS.
21760 This in particular means there are two different modes of file use in \SpecialChar LyX
21764 \begin_layout Itemize
21766 The loaded file is in the read-only mode.
21767 For editing on needs to check-out.
21772 consists of updating from the repository and gaining write lock.
21773 If the lock is not possible to obtain, we remain in unlocked state.
21776 \begin_layout Itemize
21778 The loaded file is in the 'normal' edit mode.
21779 No other user is allowed to edit the file.
21784 consists of commiting changes and releasing write-lock.
21785 If no changes have been made to the document, no commit will be produced
21789 \begin_layout Plain Layout
21790 Don't be puzzled by the fact that you will be asked for commit message anyway.
21795 and only the write-lock will be released.
21798 \begin_layout Standard
21802 \begin_layout Labeling
21803 \labelwidthstring 00.00.0000
21806 svn commit -q -m"<description>" "<file-name>"
21807 \begin_inset Newline newline
21810 svn unlock "<file-name>"
21813 \begin_layout Labeling
21814 \labelwidthstring 00.00.0000
21817 svn update "<file-name>"
21818 \begin_inset Newline newline
21821 svn lock "<file-name>"
21824 \begin_layout Subsubsection
21827 \begin_inset CommandInset label
21829 name "subsec:Automatical-Locking-Property"
21835 Automatic Locking Property
21838 \begin_layout Standard
21839 The above mentioned automatic setting of write permissions of the .lyx file
21842 File\SpecialChar menuseparator
21844 \begin_inset space ~
21847 Control\SpecialChar menuseparator
21848 Toggle locking property
21851 This command is active only when the file is not locked on the svn server
21853 you need to check-out before proceeding).
21856 \begin_layout Labeling
21857 \labelwidthstring 00.00.0000
21859 \begin_inset space ~
21865 \begin_layout Labeling
21866 \labelwidthstring 00.00.0000
21869 svn propset svn:needs-lock ON "<file-name>"
21872 \begin_layout Labeling
21873 \labelwidthstring 00.00.0000
21876 svn propdel svn:needs-lock "<file-name>"
21879 \begin_layout Subsubsection
21880 \begin_inset CommandInset label
21882 name "subsec:VCS-Revision-Information"
21886 Revision Information in Documents
21889 \begin_layout Standard
21890 There are more possibilities how to activate revision information in our
21894 \begin_layout Itemize
21900 \begin_layout Itemize
21901 tree revision information (
21902 \begin_inset Flex Code
21905 \begin_layout Plain Layout
21912 The result is the output of the
21913 \begin_inset Flex Code
21916 \begin_layout Plain Layout
21922 command, the following table gives you an idea, how to read the results.
21925 \begin_layout Standard
21927 \begin_inset Tabular
21928 <lyxtabular version="3" rows="6" columns="2">
21929 <features tabularvalignment="middle">
21930 <column alignment="center" valignment="top">
21931 <column alignment="center" valignment="top">
21933 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21936 \begin_layout Plain Layout
21942 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21945 \begin_layout Plain Layout
21953 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21956 \begin_layout Plain Layout
21962 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21965 \begin_layout Plain Layout
21966 mixed revision working copy
21973 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21976 \begin_layout Plain Layout
21982 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21985 \begin_layout Plain Layout
21986 modified working copy
21993 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21996 \begin_layout Plain Layout
22002 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22005 \begin_layout Plain Layout
22006 switched working copy
22013 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22016 \begin_layout Plain Layout
22022 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22025 \begin_layout Plain Layout
22026 partial working copy, from a sparse checkout
22033 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22036 \begin_layout Plain Layout
22042 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22045 \begin_layout Plain Layout
22046 mixed revision, modified, switched working copy
22059 \begin_layout Itemize
22060 file revision information.
22061 The result comes from parsing the output of
22062 \begin_inset Flex Code
22065 \begin_layout Plain Layout
22067 \begin_inset space ~
22071 \begin_inset space ~
22075 \begin_inset space ~
22084 Supported flags are:
22088 \begin_layout Itemize
22089 version number of the last commit (
22090 \begin_inset Flex Code
22093 \begin_layout Plain Layout
22102 \begin_layout Itemize
22103 author of the last commit (
22104 \begin_inset Flex Code
22107 \begin_layout Plain Layout
22116 \begin_layout Itemize
22117 date of the last commit (
22118 \begin_inset Flex Code
22121 \begin_layout Plain Layout
22130 \begin_layout Itemize
22131 time of the last commit (
22132 \begin_inset Flex Code
22135 \begin_layout Plain Layout
22145 \begin_layout Standard
22146 You can obtain this info via InsetInfo (e.g.
22148 \begin_inset Flex Code
22151 \begin_layout Plain Layout
22152 info-insert buffer vcs-date
22158 The information will be available only when you have the file stored under
22159 svn managment (i.e.
22161 \begin_inset Flex Code
22164 \begin_layout Plain Layout
22170 directory is available with your document).
22174 \begin_layout Itemize
22175 Another—a hacking one—possibility is to use svn keywords
22179 \begin_layout Plain Layout
22180 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22186 In short – you set file keywords property (e.g.
22189 svn propset svn:keywords 'Rev' file.lyx
22191 ) and then paste keyword \SpecialChar TeX
22196 \begin_layout Plain Layout
22197 This is an easy way how to ensure that \SpecialChar LyX
22198 won't break the line in the middle
22204 tag in your document (e.g.
22209 \begin_layout Plain Layout
22217 This way svn client will automatically substitute revision number (e.g.
22222 \begin_layout Plain Layout
22229 ) after each update and commit.
22230 There are more problems with this approach.
22231 Firstly, the '$' character is used in \SpecialChar TeX
22232 world for math equations, so any
22233 occurence of math formula
22234 \begin_inset Formula $Rev$
22238 \begin_inset Formula $Rev:59$
22241 in your \SpecialChar LyX
22243 Similarly for other keywords like Id, Date, Author, etc.
22244 Secondly svn output is dependent on your locales, so its very easy that
22245 svn would produce some problematic strings once Date is used.
22246 Thirdly you get the whole 'Rev: 59' string in your document instead of
22248 Until subversion implements user's custom keywords it will be hard to use
22249 this approach reliably or let \SpecialChar LyX
22250 to support it directly.
22253 \begin_layout Subsection
22254 SVN and Windows Environment
22257 \begin_layout Quote
22258 My inclination is to say that if the user cannot figure out the command
22259 line operations on their own fairly quickly, they would be well advised
22260 to use TortoiseSVN.
22266 \begin_layout Subsubsection
22270 \begin_layout Standard
22271 In addition to installing \SpecialChar LyX
22272 , and having access to a Subversion repository,
22273 the user will need to install the Subversion client program.
22274 A Windows installer for the client program is available from
22275 \begin_inset CommandInset href
22278 target "http://www.collab.net/nonav/downloads/subversion/"
22284 The user may also want to install
22285 \begin_inset CommandInset href
22288 target "http://tortoisesvn.tigris.org/"
22293 , which integrates Subversion operations into the context (rightclick) menu
22294 of Windows Explorer.
22295 Operations done outside \SpecialChar LyX
22296 will typically be more convenient using the Explorer
22298 Note that TortoiseSVN is not a replacement for the client program, which
22299 is what \SpecialChar LyX
22303 \begin_layout Subsubsection
22304 Bringing a document under Subversion control
22307 \begin_layout Standard
22308 Before a \SpecialChar LyX
22309 document can be brought under version control in Subversion, its
22310 parent directory needs to be under version control.
22311 If the document is being added to a project already in the repository,
22312 this is accomplished by checking the project out to the directory where
22313 the new document will be placed.
22314 If the project itself is not yet under version control (for instance, if
22315 this document starts a new project), the directory must be imported into
22317 This is done outside \SpecialChar LyX
22319 Both import and checkout are easily accomplished from the Explorer context
22320 menu using TortoiseSVN, or alternatively can be done using the command
22321 line client at a DOS prompt.
22322 The procedure for importing the project using TortoiseSVN is described
22323 below, assuming an existing repository and a new project being started
22331 For information on using the Subversion client program, run
22338 \begin_layout Enumerate
22345 in Windows Explorer, right click it, and select
22347 TortoiseSVN\SpecialChar menuseparator
22351 If necessary, adjust the URL for the repository, then click OK.
22354 \begin_layout Enumerate
22355 Right click the level of the repository under which you want to place the
22356 new project folder (typically the top level) and click
22360 Supply a name for the project folder and click OK.
22361 Add a message for the log file if desired, then click OK again.
22362 The new project folder should appear in the repository.
22363 Finally, click OK again to exit the repository browser.
22366 \begin_layout Enumerate
22367 Once again right click
22373 , this time selecting SVN Checkout\SpecialChar ldots
22374 Select the URL of the project folder
22375 you just created in the repository, and set the checkout directory to
22383 You will be warned about a non-empty folder; click OK to proceed.
22384 You should now have a
22395 \begin_layout Enumerate
22396 Create or open your document in \SpecialChar LyX
22399 File\SpecialChar menuseparator
22401 \begin_inset space ~
22404 Control\SpecialChar menuseparator
22408 Add a log message and click OK to commit the document to version control.
22411 \begin_layout Standard
22412 From this point onward, you should have full functionality in the
22414 File\SpecialChar menuseparator
22416 \begin_inset space ~
22422 You also have the option of checking the document in and out, viewing its
22424 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22425 client program from a command prompt.
22428 \begin_layout Subsubsection
22429 SSH tunnel used with SVN under Windows
22432 \begin_layout Standard
22433 Compared with Linux setting up an svn client to communicate over ssh under
22434 Windows is a rather troublesome task.
22435 We will at least offer some hints how to setup the client side but prior
22436 knowledge about ssh and the Windows command line is needed, also be prepared
22437 for a great deal of frustration\SpecialChar ldots
22441 \begin_layout Enumerate
22442 Get an svn client for windows, as described in the previous sections.
22443 When it is a fresh install run some svn command (e.g.
22445 \begin_inset Flex Code
22448 \begin_layout Plain Layout
22454 ) to create config files, which you will need to change later on.
22457 \begin_layout Enumerate
22458 Choose an ssh client for Windows.
22459 There are several possibilities, we will use the one from Putty tools
22463 \begin_layout Plain Layout
22464 \begin_inset Flex URL
22467 \begin_layout Plain Layout
22469 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22480 You will need to set the connection up so that the client doesn't ask for
22481 any password from you.
22482 To keep things easy we will use only keys without any additional password
22487 \begin_layout Enumerate
22489 \begin_inset Flex Code
22492 \begin_layout Plain Layout
22499 Save your private .ppk key file and put the public one on the server side.
22500 If the SVN server runs on Linux, note that the format of the public key
22501 is not compatible with Linux openssh and you will need to direcly copy-paste
22504 Public key for pasting into OpenSSH authorized_keys file
22506 :” edit field into the server's
22507 \begin_inset Flex Code
22510 \begin_layout Plain Layout
22511 ~/.ssh/authorized_keys
22517 \begin_inset Flex Code
22520 \begin_layout Plain Layout
22529 \begin_layout Enumerate
22531 \begin_inset Flex Code
22534 \begin_layout Plain Layout
22541 In the SVN config file
22545 \begin_layout Plain Layout
22546 Exact path depends on Windows version, usually somewhere around
22547 \begin_inset Flex Code
22550 \begin_layout Plain Layout
22553 Documents and Settings
22567 \begin_inset Flex Code
22570 \begin_layout Plain Layout
22585 , section [tunnels], setup ssh command, e.g.
22587 \begin_inset Flex Code
22590 \begin_layout Plain Layout
22591 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22600 \begin_layout Plain Layout
22601 It will usually take a lot of time to get exact command right and it depends
22603 For example do not have some remote server saved as a default session in
22605 If things fail, try to connect via plink without SVN first.
22614 \begin_layout Enumerate
22615 Checkout the SVN archive, e.
22616 \begin_inset space \thinspace{}
22620 \begin_inset Newline newline
22624 \begin_inset Flex Code
22627 \begin_layout Plain Layout
22628 svn co svn+ssh://user@server/repository_path
22636 \begin_layout Subsubsection
22637 End-of-Line Conversions
22640 \begin_layout Standard
22641 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22643 use different line endings inside the .lyx files.
22644 This is not a problem as far as \SpecialChar LyX
22645 functionality is concerned, but the commit
22646 diffs will be huge and merge-conflicts prone.
22647 Fortunately SVN itself knows
22651 \begin_layout Plain Layout
22652 \begin_inset Flex URL
22655 \begin_layout Plain Layout
22657 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22667 how to deal with CR/LF problems when switching .lyx files to the
22668 \begin_inset Flex Code
22671 \begin_layout Plain Layout
22681 \begin_layout Plain Layout
22683 \begin_inset Flex Code
22686 \begin_layout Plain Layout
22687 svn propset svn:eol-style native FILE_NAME
22700 \begin_layout Subsection
22701 GIT commands in \SpecialChar LyX
22705 \begin_layout Standard
22706 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22708 You can find the commands in the
22710 File\SpecialChar menuseparator
22712 \begin_inset space ~
22718 Please note that if you use password protected access to repository via
22719 ssh, you will be asked in terminal window.
22721 was tested against GIT 1.7.
22725 \begin_layout Plain Layout
22726 Windows users please note that you need to ensure that git is on the path.
22727 This can be set from within \SpecialChar LyX
22730 Tools\SpecialChar menuseparator
22731 Preferences\SpecialChar menuseparator
22732 Paths\SpecialChar menuseparator
22743 \begin_layout Standard
22744 One big difference of GIT and the other supported version control systems
22745 is the distributed nature of GIT: With traditional version control systems
22746 there is one central server which hosts the repository.
22747 Users commit their changes to the server, and get updates made by other
22749 With GIT, users commit to a local repository.
22750 The local repository can be synchronized with one or more remote repositories
22752 \begin_inset Flex Code
22755 \begin_layout Plain Layout
22762 \begin_inset Flex Code
22765 \begin_layout Plain Layout
22773 does not interact in any way with remote GIT repositories.
22774 It works exclusively with the local repository in a very similar way as
22775 with a central CVS or SVN repository.
22776 If you use remote GIT repositories you need to do the
22777 \begin_inset Flex Code
22780 \begin_layout Plain Layout
22787 \begin_inset Flex Code
22790 \begin_layout Plain Layout
22796 operations with your favourite GIT client.
22799 \begin_layout Subsubsection
22805 \begin_layout Standard
22806 If your document is not under revision control, this is the only item shown
22808 And if it is under revision control, the
22812 item is not visible.
22815 \begin_layout Standard
22816 This command registers in GIT your document ONLY in case you have already
22817 the documents directory under GIT control (in particular
22822 This means you have to checkout the archive by yourself.
22825 \begin_layout Standard
22826 Then you are asked interactively to supply an initial description of the
22828 Don't forget that registered file is not yet commited.
22831 \begin_layout Standard
22832 GIT command that is run:
22835 \begin_inset Quotes eld
22839 \begin_inset Quotes erd
22845 \begin_layout Standard
22850 to understand the switches.
22853 \begin_layout Subsubsection
22859 \begin_layout Standard
22860 When you are finished editing a file, you commit your changes.
22861 When you do this, you are asked for a description of the changes.
22862 After that changes are commited.
22865 \begin_layout Standard
22868 git commit -q -m"<description>" <file-name>
22871 \begin_layout Subsubsection
22874 Revert To Repository Version
22877 \begin_layout Standard
22878 This will discard all changes made to the document since the last check
22880 You get a warning before changes are discarded.
22883 \begin_layout Standard
22887 \begin_inset Quotes eld
22891 \begin_inset Quotes erd
22897 \begin_layout Subsubsection
22903 \begin_layout Standard
22904 This will rename the current document including the version history.
22905 It requires a clean document without any changes since the last checkin.
22906 You are asked for a file name and a description of the rename operation.
22907 After that the document is renamed, both locally and in the repository.
22908 If the parent directories of the new and old file names differ, all relative
22909 paths of included files are adjusted (like in
22911 File\SpecialChar menuseparator
22916 Finally, the document is reloaded using the new name.
22919 \begin_layout Labeling
22920 \labelwidthstring 00.00.0000
22922 \begin_inset space ~
22926 \begin_inset space ~
22930 \begin_inset Newline newline
22934 \begin_inset Flex Code
22937 \begin_layout Plain Layout
22941 \begin_inset Quotes eld
22945 \begin_inset Quotes erd
22949 \begin_inset Quotes eld
22953 \begin_inset Quotes erd
22962 \begin_inset Newline newline
22966 \begin_inset Flex Code
22969 \begin_layout Plain Layout
22978 \begin_layout Subsubsection
22984 \begin_layout Standard
22985 This shows the complete history of the GIT document.
22989 \begin_inset Quotes eld
22993 \begin_inset Quotes erd
22998 is shown in a browser.
23001 \begin_layout Subsubsection
23005 \begin_layout Standard
23007 supports GIT hash number of the last commit to the file, author name, date
23008 and time of last commit.
23009 All those are extracted from
23011 git log -n 1 --pretty=format:%H%n%an%n%ai
23014 Tree version information is obtained via
23016 git describe --abbrev --dirty --long
23020 \begin_inset CommandInset ref
23022 reference "subsec:VCS-Revision-Information"
23029 \begin_layout Subsection
23033 \begin_layout Standard
23034 With the recent addition of the vc-command function \SpecialChar LyX
23035 power users are allowed
23036 to create their own commands for revision control.
23039 \begin_layout Standard
23040 As an example you can see how two TortoiseSVN commands could be integrated
23044 \begin_layout Description
23046 \begin_inset Flex Code
23049 \begin_layout Plain Layout
23050 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23058 \begin_layout Description
23060 \begin_inset Flex Code
23063 \begin_layout Plain Layout
23064 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23072 \begin_layout Subsection
23073 Version control and Document comparison
23076 \begin_layout Standard
23077 One of the typical uses of version control is to inspect the changes between
23078 revisions, usually by creating
23079 \begin_inset Flex Code
23082 \begin_layout Plain Layout
23089 While this is useful for plain text files, it is much less useful in the
23090 case of \SpecialChar LyX
23091 files, which have more a complicated structure.
23092 Hence we provide binding to the Document comparison feature.
23093 There are two ways of calling this feature - either by direct call of
23094 \begin_inset Flex Code
23097 \begin_layout Plain Layout
23104 function (for details see \SpecialChar LyX
23105 functions manual) or by icon/menu item
23106 \begin_inset Flex Noun
23109 \begin_layout Plain Layout
23110 Compare with older revision...
23116 One can either compare two chosen revisions of the document or he can simply
23117 compare the current version of edited text with older revisions (where
23119 \begin_inset Flex Noun
23122 \begin_layout Plain Layout
23128 ' revisions back means comparison of the edited file with last commited
23133 \begin_layout Standard
23134 This feature is supported for SVN and RCS though due to the more complicated
23135 versioning scheme of RCS there is a constraint – when addressing the revisions
23136 in dialog, numbers always point to the last number in RCS revision number,
23139 We don't currently support GIT addressing of revisions, one can just compare
23140 edited document with its revision X steps backs, where X is addressed as
23144 \begin_layout Section
23145 Literate Programming
23148 \begin_layout Standard
23153 (kayvan@sylvan.com)
23157 original documentation written by
23159 Edmar Wienskoski Jr.
23162 (edmar-w-jr@technologist.com)
23165 \begin_layout Subsection
23169 \begin_layout Standard
23170 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23172 programming, where it is assumed that you are familiar with this programming
23173 technique, and know what
23174 \begin_inset Quotes eld
23178 \begin_inset Quotes erd
23182 \begin_inset Quotes eld
23186 \begin_inset Quotes erd
23190 If that is not the case, please follow the web links provided in the following
23192 There is a lot of good documentation out there covering old development
23193 history to the latest tools tips.
23196 \begin_layout Standard
23197 It is also assumed that you are familiar with \SpecialChar LyX
23198 itself to a point that you
23199 are comfortable changing your \SpecialChar LyX
23200 preferences, and X resources file.
23201 If that is not the case please refer to other \SpecialChar LyX
23202 documentation to cover your
23206 \begin_layout Subsection
23207 Literate Programming
23210 \begin_layout Standard
23211 From the Literate Programming FAQ:
23214 \begin_layout Quotation
23215 Literate programming is the combination of documentation and source together
23216 in a fashion suited for reading by human beings.
23217 In fact, literate programs should be enjoyable reading, even inviting!
23218 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23219 and documentation in a single file.
23220 Literate programming tools then parse the file to produce either readable
23221 documentation or compilable source.
23222 The WEB style of literate programming was created by D.
23223 \begin_inset space \thinspace{}
23227 Knuth during the development of his \SpecialChar TeX
23228 typesetting software.
23232 \begin_layout Standard
23233 Another excerpt says:
23236 \begin_layout Quotation
23239 How is literate programming different from verbose commenting?
23242 \begin_layout Quotation
23243 There are three distinguishing characteristics.
23244 In order of importance, they are:
23248 \begin_layout Itemize
23249 flexible order of elaboration
23252 \begin_layout Itemize
23253 automatic support for browsing
23256 \begin_layout Itemize
23257 typeset documentation, especially diagrams and mathematics
23261 \begin_layout Standard
23262 Now that I sparked your curiosity, take a look in the references.
23265 \begin_layout Subsubsection
23269 \begin_layout Standard
23270 The complete Literate Programming FAQ can be found at:
23273 \begin_layout Quote
23274 Literate Programming FAQ
23275 \begin_inset Flex URL
23278 \begin_layout Plain Layout
23280 http://www.literateprogramming.com/lpfaq.pdf
23288 \begin_layout Standard
23289 The FAQ lists 23 (twenty three!) different literate programming tools.
23290 Where some are specialized or
23291 \begin_inset Quotes eld
23295 \begin_inset Quotes erd
23298 for particular programming languages, while other have general scope.
23303 for my own use for several reasons:
23306 \begin_layout Itemize
23307 It can generate the documentation either in \SpecialChar LaTeX
23311 \begin_layout Itemize
23312 It has a open architecture, i.
23313 \begin_inset space \thinspace{}
23317 \begin_inset space \space{}
23320 it is easy to plug in new filters and to perform special processing that
23325 \begin_layout Itemize
23326 There is a good selection of filters available already (the HTML is one
23330 \begin_layout Itemize
23334 \begin_layout Standard
23335 The Noweb web page can be found at:
23338 \begin_layout Quote
23340 \begin_inset Flex URL
23343 \begin_layout Plain Layout
23345 http://www.cs.virginia.edu/~nr/noweb/
23353 \begin_layout Standard
23354 Starting from there you can reach many other interesting links and even
23355 some literate program examples.
23358 \begin_layout Subsection
23360 and Literate Programming with Noweb
23363 \begin_layout Standard
23364 The \SpecialChar LyX
23365 support for Literate Programming is provided by using the generic \SpecialChar LyX
23367 converters mechanism.
23368 This support is provided in a
23369 \begin_inset Quotes eld
23373 \begin_inset Quotes erd
23377 \begin_inset space \thinspace{}
23381 \begin_inset space \space{}
23384 you will be able to use this new \SpecialChar LyX
23385 feature with some other literate programming
23386 tool of your choice by just changing your \SpecialChar LyX
23390 \begin_layout Subsubsection
23391 Generating documents and code (weaving and tangling)
23394 \begin_layout Paragraph
23395 Using the noweb module
23398 \begin_layout Standard
23399 If you have installed Noweb and \SpecialChar LyX
23400 successfully, whenever you open a new document,
23401 after you have chosen its document class, use the Document->Settings menu
23403 \begin_inset Quotes eld
23407 \begin_inset Quotes erd
23411 If Noweb is correctly installed, when you click on the
23412 \begin_inset Quotes eld
23416 \begin_inset Quotes erd
23419 link, you will see the
23420 \begin_inset Quotes eld
23424 \begin_inset Quotes erd
23427 module in the available list and you can add it to your document.
23430 \begin_layout Paragraph
23434 \begin_layout Standard
23436 enables you to write code with a layout named
23437 \begin_inset Flex Noun
23440 \begin_layout Plain Layout
23447 Noweb delimits chunks like this:
23450 \begin_layout LyX-Code
23454 \begin_layout LyX-Code
23458 \begin_layout LyX-Code
23462 \begin_layout LyX-Code
23466 \begin_layout LyX-Code
23470 \begin_layout Standard
23471 The problem is that whatever is written in between the << and the
23475 must be taken literally, i.
23476 \begin_inset space \thinspace{}
23480 \begin_inset space \space{}
23484 should be prevented from making any special interpretation of what has
23486 This is also handled by
23487 \begin_inset Flex Noun
23490 \begin_layout Plain Layout
23496 , that works like a normal paragraph but has a free spacing capability.
23499 \begin_layout Standard
23500 As a special note, you can also use the
23501 \begin_inset Quotes eld
23505 \begin_inset Quotes erd
23508 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23512 \begin_layout LyX-Code
23516 \begin_layout LyX-Code
23517 def some_function(args):
23520 \begin_layout LyX-Code
23521 "This is the doc string for this function."
23524 \begin_layout LyX-Code
23525 print "My args: ", args
23528 \begin_layout LyX-Code
23529 @ %def some_function
23532 \begin_layout Standard
23533 For an example of this usage and the resulting cross-reference output, look
23534 at the Literate python program in
23536 LIBDIR/examples/listerrors.lyx
23538 which should make this all clear.
23541 \begin_layout Paragraph
23542 Generating the documentation
23545 \begin_layout Standard
23546 At this point you already have a new document file with a proper document
23547 class, and with some code and text on it.
23548 How do I print it? The answer is simple, you select
23550 View\SpecialChar menuseparator
23554 Just like you would do for a plain document.
23555 No special procedure is required.
23558 \begin_layout Standard
23559 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23563 \begin_layout Enumerate
23566 Update\SpecialChar menuseparator
23569 menu option is chosen, a \SpecialChar LaTeX
23575 \begin_layout Standard
23576 If the document is of any literate class the generated file will be named
23577 with an extension name defined by the
23578 \begin_inset Quotes eld
23582 \begin_inset Quotes erd
23585 format (defined in the Preferences panel), otherwise the file will have
23594 \begin_layout Enumerate
23595 Note that the only difference so far is in the name of the file, no special
23596 processing is required by \SpecialChar LyX
23598 Given that you formatted the code using the
23599 \begin_inset Flex Noun
23602 \begin_layout Plain Layout
23608 layout that, by itself, takes care of the business.
23611 \begin_layout Enumerate
23612 If the document is of any literate class \SpecialChar LyX
23613 will then use the internal \SpecialChar LyX
23615 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23620 \begin_layout Plain Layout
23621 The converters are defined in the
23623 Tools\SpecialChar menuseparator
23627 \begin_inset Quotes eld
23631 \begin_inset Quotes erd
23643 manual for general information about converters.
23648 to generate the \SpecialChar LaTeX
23653 \begin_layout Standard
23654 Otherwise it will just skip this step.
23658 \begin_layout Enumerate
23659 Finally, \SpecialChar LaTeX
23660 is invoked and the regular post processing continues as in a plain
23664 \begin_layout Standard
23665 Independence from a particular
23666 \begin_inset Quotes eld
23670 \begin_inset Quotes erd
23673 is easily achieved by changing the commands that are run by the various
23677 \begin_layout Paragraph
23678 Generating the code
23681 \begin_layout Standard
23682 When the build menu option is chosen or the corresponding button in the
23683 toolbar is pressed, a \SpecialChar LaTeX
23684 file is generated just like step 1 above.
23685 Next, \SpecialChar LyX
23691 This converter needs to be defined by the user and is not installed by
23692 default, though the Program format is.
23693 This converter (like any other converter) will have two parts:
23696 \begin_layout Enumerate
23697 The converter program itself.
23698 This program performs the conversion from the one format to the other (in
23699 this case, from the Noweb format to the Program pseudo-format).
23702 \begin_layout Enumerate
23703 The error log parser.
23704 This is a program whose sole purpose is to rewrite error messages in a
23705 format that \SpecialChar LyX
23707 This makes it possible for \SpecialChar LyX
23708 to place error boxes in the right places in
23712 \begin_layout Standard
23713 The first part, the
23714 \begin_inset Quotes eld
23718 \begin_inset Quotes erd
23721 setting, should be set to
23722 \begin_inset Newline newline
23726 \begin_inset Quotes eld
23734 \begin_inset Quotes erd
23738 \begin_inset Newline newline
23741 This basically means that \SpecialChar LyX
23743 \begin_inset Quotes eld
23747 \begin_inset Quotes erd
23750 (a program or script) with the name of the Noweb file (normally a file
23751 in the \SpecialChar LyX
23752 temp directory) and the directory path of the original \SpecialChar LyX
23757 \begin_layout Standard
23758 This is an implementation of
23759 \begin_inset Quotes eld
23763 \begin_inset Quotes erd
23766 that you can place in a directory on your path:
23769 \begin_layout Standard
23770 \begin_inset VSpace defskip
23776 \begin_layout Standard
23777 \begin_inset Newpage pagebreak
23783 \begin_layout Standard
23789 \begin_layout Standard
23795 \begin_layout Standard
23798 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23801 \begin_layout Standard
23802 \begin_inset VSpace defskip
23808 \begin_layout Standard
23809 The next part of the converter setting is the
23810 \begin_inset Quotes eld
23814 \begin_inset Quotes erd
23817 which is to be set to
23818 \begin_inset Newline newline
23822 \begin_inset Quotes eld
23827 parselog=$$s/scripts/listerrors
23830 \begin_inset Quotes erd
23834 \begin_inset Newline newline
23837 This will run any errors that are generated by the
23838 \begin_inset Quotes eld
23842 \begin_inset Quotes erd
23845 process through the
23846 \begin_inset Quotes eld
23850 \begin_inset Quotes erd
23856 \begin_layout Standard
23857 The build will normally take place in \SpecialChar LyX
23858 's temporary directory, so the files
23859 produced by the conversion will be in that directory.
23861 will copy out what it regards as the `main' file, but the
23865 conversion may produce several files, and so most of these would then be
23866 deleted when \SpecialChar LyX
23868 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23869 the build-script chunk can place the generated files in that location.
23872 \begin_layout Paragraph
23873 Build instructions in the document
23876 \begin_layout Standard
23877 The last piece of the integration between \SpecialChar LyX
23879 \begin_inset Quotes eld
23883 \begin_inset Quotes erd
23887 Generally, the instructions for building your program should be embedded
23888 in a chunk of its own.
23890 \begin_inset Quotes eld
23894 \begin_inset Quotes erd
23897 above uses the notangle command to look for this chunk (called
23898 \begin_inset Quotes eld
23902 \begin_inset Quotes erd
23905 ) and runs its contents through
23906 \begin_inset Quotes eld
23910 \begin_inset Quotes erd
23916 \begin_layout Standard
23917 Typically, such a chunk would look something like this:
23920 \begin_layout LyX-Code
23924 \begin_layout LyX-Code
23926 \begin_inset Newline newline
23929 if [ -z "${NOWEB_SOURCE}" ]
23930 \begin_inset Newline newline
23936 \begin_layout LyX-Code
23937 NOWEB_SOURCE=myfile.nw
23938 \begin_inset Newline newline
23942 \begin_inset Newline newline
23946 code to extract files ...
23947 use NOWEB_OUTPUT_DIR here ...]
23948 \begin_inset Newline newline
23952 code to compile files ...]
23953 \begin_inset Newline newline
23959 \begin_layout Standard
23962 LIBDIR/examples/listerrors.lyx
23966 LIBDIR/examples/Literate.lyx
23968 which implement two versions of the
23969 \begin_inset Quotes eld
23973 \begin_inset Quotes erd
23976 program for some illustrations of how all of these pieces go together or
23979 LIBDIR/examples/noweb2lyx.lyx.
23982 Interestingly, these three files show off the language-indepence of the
23984 literate programming support since they are written in Python, C and Perl
23988 \begin_layout Subsubsection
23989 Configuring \SpecialChar LyX
23993 \begin_layout Standard
23994 All the Literate Programming support is configured by the
23996 Tools\SpecialChar menuseparator
24000 \begin_inset Quotes eld
24004 \begin_inset Quotes erd
24008 The important parts are:
24011 \begin_layout Description
24013 \begin_inset space ~
24017 \begin_inset Quotes eld
24021 \begin_inset Quotes erd
24025 \begin_inset space ~
24028 format Set up via the File Formats tab, this is where the Noweb-specific
24038 , the file extension is set to
24043 This tells \SpecialChar LyX
24044 to create a file with a
24048 extension in the first step of the conversion process.
24051 \begin_layout Description
24053 \begin_inset space ~
24061 \begin_inset space ~
24064 format This is an empty format whose sole purpose is to be the endpoint
24065 of a conversion (which then allows us to set up a converter for it).
24068 \begin_layout Description
24078 This converter performs the
24079 \begin_inset Quotes eld
24083 \begin_inset Quotes erd
24086 of the literate document.
24087 For Noweb, it is set to
24088 \begin_inset Quotes eld
24093 noweave -delay -index $$i > $$o
24096 \begin_inset Quotes erd
24102 \begin_layout Description
24112 \begin_inset Quotes eld
24116 \begin_inset Quotes erd
24120 As stated above, the Converter is set to
24121 \begin_inset Quotes eld
24129 \begin_inset Quotes erd
24132 , with Flags set to
24133 \begin_inset Newline newline
24137 \begin_inset Quotes eld
24142 parselog=$$s/scripts/listerrors
24145 \begin_inset Quotes erd
24151 \begin_layout Subsubsection
24155 \begin_layout Standard
24156 There is also a new function implemented in the \SpecialChar LyX
24158 \begin_inset Quotes eld
24161 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24165 \begin_layout Standard
24166 When debugging code with ddd/gdb, it is possible to invoke a text editor
24167 at the current execution position with a single key stroke.
24168 The default ddd configuration for that is shift-ctrl-V.
24169 It happens that you can define the editor command line invocation in ddd
24172 Edit\SpecialChar menuseparator
24173 Preferences\SpecialChar menuseparator
24176 dialog and changing the "Edit Sources" entry.
24179 \begin_layout Standard
24180 I take advantage of the newly created \SpecialChar LyX
24181 server function and this ddd feature,
24183 \begin_inset Quotes eld
24187 \begin_inset Quotes erd
24193 \begin_layout Standard
24194 \begin_inset VSpace defskip
24200 \begin_layout Standard
24203 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24206 \begin_layout Standard
24207 \begin_inset VSpace defskip
24213 \begin_layout Standard
24214 With this, whenever you are using ddd and find a point in the program that
24215 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24216 ddd will forward this information to \SpecialChar LyX
24217 through the \SpecialChar LyX
24218 server and then the
24220 window will show the same file with the cursor at the same position ddd
24222 No more guessing or long scrolling to locate a point in the program back
24226 \begin_layout Standard
24227 Note however that you must enable the \SpecialChar LyX
24228 server to get this feature working
24229 (it is disabled by default).
24230 You can enable it in
24242 ) by entering in the
24248 \begin_inset Quotes eld
24253 /home/<your-home-directory>/.lyx/lyxpipe
24256 \begin_inset Quotes erd
24262 \begin_layout Standard
24263 Read the \SpecialChar LyX
24264 server documentation in the
24266 Customization Manual
24268 for further information.
24271 \begin_layout Subsubsection
24275 \begin_layout Standard
24276 There are six new buttons that can be added to your \SpecialChar LyX
24278 Five of these buttons are short cuts to layout styles:
24301 The last one is a short cut to the
24302 \begin_inset Quotes eld
24306 \begin_inset Quotes erd
24313 \begin_layout Standard
24315 has a range of buttons that are available for tool bar customization.
24316 In my toolbar I like to combine the six short cuts above with two more:
24321 \SpecialChar menuseparator
24326 \SpecialChar menuseparator
24333 Document\SpecialChar menuseparator
24334 View\SpecialChar menuseparator
24338 Here is how it looks like:
24341 \begin_layout LyX-Code
24345 \begin_layout LyX-Code
24349 \begin_layout LyX-Code
24350 Icon "layout Standard"
24353 \begin_layout LyX-Code
24354 Icon "layout Section"
24357 \begin_layout LyX-Code
24358 Icon "layout \SpecialChar LaTeX
24362 \begin_layout LyX-Code
24363 Icon "layout \SpecialChar LyX
24367 \begin_layout LyX-Code
24368 Icon "layout Chunk"
24371 \begin_layout LyX-Code
24375 \begin_layout LyX-Code
24379 \begin_layout LyX-Code
24380 Icon "buffer-typeset"
24383 \begin_layout LyX-Code
24384 Icon "build-program"
24387 \begin_layout LyX-Code
24391 \begin_layout LyX-Code
24395 \begin_layout LyX-Code
24399 \begin_layout LyX-Code
24403 \begin_layout LyX-Code
24407 \begin_layout Subsubsection
24408 Colors customization
24411 \begin_layout Standard
24412 There are a number of colors in \SpecialChar LyX
24413 that can be customized in
24418 One of the things that bothers people is the \SpecialChar LaTeX
24420 The default color is red, since the chunks uses \SpecialChar LaTeX
24421 font, and there is a lot
24422 of chunks in literate documents, you may get tired of seeing everything
24424 You can change it by going to the tabs
24433 \begin_layout Standard
24434 The next thing is the visible presence of the newline character in the screen.
24435 You can choose the color of this particular character and make it blend
24437 I recommend you choosing a color that is close to the background but not
24438 equal, that way you still can see it is there, but it is not bothering
24442 \begin_layout Subsection
24447 \begin_layout Standard
24456 is documented in the
24460 example file and in the Sweave manual (menu
24462 Help\SpecialChar menuseparator
24468 \begin_layout Chapter
24472 \begin_layout Standard
24473 You can do everything with \SpecialChar LyX
24474 that you can do with \SpecialChar LaTeX
24476 However, \SpecialChar LyX
24477 cannot support every \SpecialChar LaTeX
24479 But you can always use \SpecialChar TeX
24481 This chapter shows you some more special things you might want to use.
24482 For other special things you can do with figures, tables, floats, boxes
24483 and notes, have a look at the
24486 \begin_inset space ~
24494 \begin_layout Section
24495 Multiple Text Columns
24498 \begin_layout Standard
24499 This feature is independent of the option
24501 Two-column document
24503 in the document settings under
24508 If you want to have 2
24509 \begin_inset space ~
24512 columns for the whole document, it is recommended to use the
24514 Two-column document
24517 For all other cases use this feature.
24520 \begin_layout Standard
24521 To use multiple text columns in your document, you have to load the module
24528 Document\SpecialChar menuseparator
24529 Settings\SpecialChar menuseparator
24532 ) and must have the \SpecialChar LaTeX
24540 \begin_layout Standard
24541 Footnotes within multiple columns will be placed at the bottom of the page
24542 and not under each column.
24543 Within the different columns you can use everything, with the limitation
24544 that for floats you need to use the float option
24551 \begin_layout Subsection
24555 \begin_layout Standard
24556 If you want to have 2
24557 \begin_inset space ~
24560 columns in your text, insert a multicolumn inset via the menu
24562 Insert\SpecialChar menuseparator
24564 \begin_inset space ~
24567 Insets\SpecialChar menuseparator
24569 \begin_inset space ~
24574 where the columns should start.
24575 Write all text that should be printed in 2
24576 \begin_inset space ~
24579 columns into this inset.
24582 \begin_layout Standard
24583 Here is an example:
24586 \begin_layout Standard
24588 \begin_inset Flex Multiple Columns
24591 \begin_layout Plain Layout
24596 The Adventure of the Empty House
24599 \begin_inset Newline newline
24602 by Sir Arthur Conan Doyle
24605 \begin_layout Plain Layout
24608 It was in the spring of the year 1894 that all London was interested, and
24609 the fashionable world dismayed, by the murder of the Honourable Ronald
24610 Adair under most unusual and inexplicable circumstances.
24611 The public has already learned those particulars of the crime which came
24612 out in the police investigation, but a good deal was suppressed upon that
24613 occasion, since the case for the prosecution was so overwhelmingly strong
24614 that it was not necessary to bring forward all the facts.
24615 Only now, at the end of nearly ten years, am I allowed to supply those
24616 missing links which make up the whole of that remarkable chain.
24617 The crime was of interest in itself, but that interest was as nothing to
24618 me compared to the inconceivable sequel, which afforded me the greatest
24619 shock and surprise of any event in my adventurous life.
24620 Even now, after this long interval, I find myself thrilling as I think
24621 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24622 ty which utterly submerged my mind.
24623 Let me say to that public, which has shown some interest in those glimpses
24624 which I have occasionally given them of the thoughts and actions of a very
24625 remarkable man, that they are not to blame me if I have not shared my knowledge
24626 with them, for I should have considered it my first duty to do so, had
24627 I not been barred by a positive prohibition from his own lips, which was
24628 only withdrawn upon the third of last month.
24636 \begin_layout Standard
24637 To get 3 or more columns, set the cursor into the multicolumn inset and
24640 Insert\SpecialChar menuseparator
24642 \begin_inset space ~
24646 \begin_inset space ~
24652 The number of the desired columns is written into that inset (for 3
24653 \begin_inset space ~
24657 \begin_inset Quotes eld
24661 \begin_inset Quotes erd
24665 \begin_inset Newline newline
24668 Here is an example with 3
24669 \begin_inset space ~
24675 \begin_layout Standard
24676 \begin_inset Flex Multiple Columns
24679 \begin_layout Plain Layout
24682 \begin_inset Argument 1
24685 \begin_layout Plain Layout
24691 It can be imagined that my close intimacy with Sherlock Holmes had interested
24692 me deeply in crime, and that after his disappearance I never failed to
24693 read with care the various problems which came before the public.
24694 And I even attempted, more than once, for my own private satisfaction,
24695 to employ his methods in their solution, though with indifferent success.
24696 There was none, however, which appealed to me like this tragedy of Ronald
24698 As I read the evidence at the inquest, which led up to a verdict of willful
24699 murder against some person or persons unknown, I realized more clearly
24700 than I had ever done the loss which the community had sustained by the
24701 death of Sherlock Holmes.
24702 There were points about this strange business which would, I was sure,
24703 have specially appealed to him, and the efforts of the police would have
24704 been supplemented, or more probably anticipated, by the trained observation
24705 and the alert mind of the first criminal agent in Europe.
24706 All day, as I drove upon my round, I turned over the case in my mind and
24707 found no explanation which appeared to me to be adequate.
24708 At the risk of telling a twice-told tale, I will recapitulate the facts
24709 as they were known to the public at the conclusion of the inquest.
24717 \begin_layout Standard
24718 You can have up to 10
24719 \begin_inset space ~
24722 columns if you want to, but that might not be very pleasant for the readers
24726 \begin_layout Standard
24727 \begin_inset Newpage newpage
24733 \begin_layout Subsection
24734 Columns inside Columns
24737 \begin_layout Standard
24738 You can also have columns inside columns:
24741 \begin_layout Standard
24742 \begin_inset Flex Multiple Columns
24745 \begin_layout Plain Layout
24748 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24749 at that time governor of one of the Australian colonies.
24750 Adair's mother had returned from Australia to undergo the operation for
24751 cataract, and she, her son Ronald, and her daughter Hilda were living together
24755 \begin_layout Plain Layout
24756 \begin_inset Flex Multiple Columns
24759 \begin_layout Plain Layout
24762 The youth moved in the best society–had, so far as was known, no enemies
24763 and no particular vices.
24764 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24765 had been broken off by mutual consent some months before, and there was
24766 no sign that it had left any very profound feeling behind it.
24767 For the rest {sic} the man's life moved in a narrow and conventional circle,
24768 for his habits were quiet and his nature unemotional.
24769 Yet it was upon this easy-going young aristocrat that death came, in most
24770 strange and unexpected form, between the hours of ten and eleven-twenty
24771 on the night of March 30, 1894.
24779 \begin_layout Plain Layout
24782 Ronald Adair was fond of cards–playing continually, but never for such stakes
24784 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24785 It was shown that, after dinner on the day of his death, he had played
24786 a rubber of whist at the latter club.
24787 He had also played there in the afternoon.
24792 The evidence of those who had played with him– Mr.
24793 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24794 and that there was a fairly equal fall of the cards.
24795 Adair might have lost five pounds, but not more.
24796 His fortune was a considerable one, and such a loss could not in any way
24798 He had played nearly every day at one club or other, but he was a cautious
24799 player, and usually rose a winner.
24800 It came out in evidence that, in partnership with Colonel Moran, he had
24801 actually won as much as four hundred and twenty pounds in a sitting, some
24802 weeks before, from Godfrey Milner and Lord Balmoral.
24803 So much for his recent history as it came out at the inquest.
24811 \begin_layout Subsection
24815 \begin_layout Standard
24816 The examples in this section show some more special features of multiple
24820 \begin_layout Standard
24821 For more features of multiple columns, have a look at the documentation
24822 of the \SpecialChar LaTeX
24828 \begin_inset CommandInset citation
24838 \begin_layout Subsubsection
24842 \begin_layout Standard
24843 To add a preface text for multiple columns, set the cursor into the multicolumn
24844 inset and use the menu
24846 Insert\SpecialChar menuseparator
24850 Write your preface text into that inset.
24851 \begin_inset Newline newline
24854 This is an example with some preface text:
24857 \begin_layout Standard
24858 \begin_inset VSpace bigskip
24864 \begin_layout Standard
24865 \begin_inset Flex Multiple Columns
24868 \begin_layout Plain Layout
24869 \begin_inset Argument 2
24872 \begin_layout Plain Layout
24873 And the story continues and continues and continues and continues\SpecialChar ldots
24881 On the evening of the crime, he returned from the club exactly at ten.
24882 His mother and sister were out spending the evening with a relation.
24883 The servant deposed that she heard him enter the front room on the second
24884 floor, generally used as his sitting-room.
24885 She had lit a fire there, and as it smoked she had opened the window.
24886 No sound was heard from the room until eleven-twenty, the hour of the return
24887 of Lady Maynooth and her daughter.
24888 Desiring to say good-night, she attempted to enter her son's room.
24889 The door was locked on the inside, and no answer could be got to their
24890 cries and knocking.
24891 Help was obtained, and the door forced.
24892 The unfortunate young man was found lying near the table.
24893 His head had been horribly mutilated by an expanding revolver bullet, but
24894 no weapon of any sort was to be found in the room.
24902 \begin_layout Standard
24903 You can also use a section heading as the preface if you use a section command
24904 as \SpecialChar TeX
24906 For example the command
24909 \begin_layout Standard
24914 subsection{subsection title}
24917 \begin_layout Standard
24918 creates a subsection.
24919 In this example the preface is a subsubsection:
24922 \begin_layout Standard
24923 \begin_inset Flex Multiple Columns
24926 \begin_layout Plain Layout
24927 \begin_inset Argument 2
24930 \begin_layout Plain Layout
24934 \begin_layout Plain Layout
24943 This is a subsubsection heading as a preface
24947 \begin_layout Plain Layout
24961 A minute examination of the circumstances served only to make the case more
24963 In the first place, no reason could be given why the young man should have
24964 fastened the door upon the inside.
24965 There was the possibility that the murderer had done this, and had afterwards
24966 escaped by the window.
24967 The drop was at least twenty feet, however, and a bed of crocuses in full
24969 Neither the flowers nor the earth showed any sign of having been disturbed,
24970 nor were there any marks upon the narrow strip of grass which separated
24971 the house from the road.
24972 Apparently, therefore, it was the young man himself who had fastened the
24974 But how did he come by his death? No one could have climbed up to the window
24975 without leaving traces.
24976 Suppose a man had fired through the window, he would indeed be a remarkable
24977 shot who could with a revolver inflict so deadly a wound.
24978 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24979 a hundred yards of the house.
24980 No one had heard a shot.
24988 \begin_layout Standard
24989 If there is less vertical space than 6
24990 \begin_inset space ~
24993 text lines is left on the page at the beginning of the multiple columns,
24994 a page break will be inserted before the multiple columns.
24995 Depending on the number of lines of the preface text, you might want to
24997 This is done by setting the cursor into the mulitcolumn inset behind the
24998 preface (if there is any) and using the menu
25000 Insert\SpecialChar menuseparator
25002 \begin_inset space ~
25006 \begin_inset space ~
25010 \begin_inset space ~
25016 Insert into that inset the amount of space like e.
25017 \begin_inset space \thinspace{}
25021 \begin_inset space \space{}
25025 \begin_inset Quotes eld
25029 \begin_inset Quotes erd
25033 \begin_inset Newline newline
25036 In this example the space is set to 7
25037 \begin_inset space ~
25040 text lines by using
25041 \begin_inset Quotes eld
25047 \begin_inset Quotes erd
25056 needs to be inserted as \SpecialChar TeX
25060 \begin_layout Standard
25061 \begin_inset Flex Multiple Columns
25064 \begin_layout Plain Layout
25065 \begin_inset Argument 3
25068 \begin_layout Plain Layout
25073 \begin_layout Plain Layout
25089 On the evening of the crime, he returned from the club exactly at ten.
25090 His mother and sister were out spending the evening with a relation.
25091 The servant deposed that she heard him enter the front room on the second
25092 floor, generally used as his sitting-room.
25093 She had lit a fire there, and as it smoked she had opened the window.
25094 No sound was heard from the room until eleven-twenty, the hour of the return
25095 of Lady Maynooth and her daughter.
25096 Desiring to say good-night, she attempted to enter her son's room.
25097 The door was locked on the inside, and no answer could be got to their
25098 cries and knocking.
25099 Help was obtained, and the door forced.
25100 The unfortunate young man was found lying near the table.
25101 His head had been horribly mutilated by an expanding revolver bullet, but
25102 no weapon of any sort was to be found in the room.
25110 \begin_layout Subsubsection
25114 \begin_layout Standard
25115 The amount of space before and after multiple columns can be changed by
25116 changing the length
25123 For example the command
25126 \begin_layout Standard
25136 \begin_layout Standard
25137 in \SpecialChar TeX
25138 Code changes its value to 3
25139 \begin_inset space \thinspace{}
25143 The change must be made before the multiple columns' start.
25144 The predefined value is 13
25145 \begin_inset space \thinspace{}
25151 \begin_layout Standard
25159 \begin_inset space \thinspace{}
25165 \begin_layout Standard
25169 \begin_layout Plain Layout
25175 multicolsep}{2.5cm}
25183 \begin_layout Standard
25184 \begin_inset Flex Multiple Columns
25187 \begin_layout Plain Layout
25190 All day I turned these facts over in my mind, endeavouring to hit upon some
25191 theory which could reconcile them all, and to find that line of least resistanc
25192 e which my poor friend had declared to be the starting-point of every investigat
25194 I confess that I made little progress.
25195 In the evening I strolled across the Park, and found myself about six o'clock
25196 at the Oxford Street end of Park Lane.
25197 A group of loafers upon the pavements, all staring up at a particular window,
25198 directed me to the house which I had come to see.
25199 A tall, thin man with coloured glasses, whom I strongly suspected of being
25200 a plain-clothes detective, was pointing out some theory of his own, while
25201 the others crowded round to listen to what he said.
25202 I got as near him as I could, but his observations seemed to me to be absurd,
25203 so I withdrew again in some disgust.
25204 As I did so I struck against an elderly, deformed man, who had been behind
25205 me, and I knocked down several books which he was carrying.
25213 \begin_layout Standard
25214 \begin_inset Note Greyedout
25217 \begin_layout Plain Layout
25222 The values you set with
25228 will be used for all following multiple columns until you change them again.
25236 \begin_layout Standard
25240 \begin_layout Plain Layout
25252 \begin_inset Note Note
25255 \begin_layout Plain Layout
25256 go back to the default
25264 \begin_layout Standard
25265 \begin_inset Newpage newpage
25271 \begin_layout Subsubsection
25275 \begin_layout Standard
25276 A column break can be forced by inserting the command
25282 as \SpecialChar TeX
25283 Code to that position in the text where the column should be broken.
25284 Note that this leads in most cases to whitespace in the text.
25285 \begin_inset Newline newline
25288 Here is an example:
25291 \begin_layout Standard
25292 \begin_inset Flex Multiple Columns
25295 \begin_layout Plain Layout
25298 \begin_inset Quotes eld
25301 You're surprised to see me, sir,
25302 \begin_inset Quotes erd
25305 said he, in a strange, croaking voice.
25308 \begin_layout Plain Layout
25311 I acknowledged that I was.
25314 \begin_layout Plain Layout
25317 \begin_inset Quotes eld
25320 Well, I've a conscience, sir, and when I chanced to see you go into this
25321 house, as I came hobbling after you, I thought to myself, I'll just step
25322 in and see that kind gentleman, and tell him that if I was a bit gruff
25323 in my manner there was not any harm meant, and that I am much obliged to
25324 him for picking up my books.
25325 \begin_inset Quotes erd
25331 \begin_layout Plain Layout
25334 \begin_inset Quotes eld
25337 You make too much of a trifle,
25338 \begin_inset Quotes erd
25343 \begin_inset Quotes eld
25346 May I ask how you knew who I was?
25347 \begin_inset Quotes erd
25350 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25354 \begin_layout Plain Layout
25366 \begin_layout Plain Layout
25369 \begin_inset Quotes eld
25372 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25373 you'll find my little bookshop at the corner of Church Street, and very
25374 happy to see you, I am sure.
25375 Maybe you collect yourself, sir.
25379 \begin_inset space ~
25392 –a bargain, every one of them.
25393 With five volumes you could just fill that gap on that second shelf.
25394 It looks untidy, does it not, sir?
25395 \begin_inset Quotes erd
25406 \begin_layout Subsubsection
25410 \begin_layout Standard
25411 The width of the columns is automatically calculated, but you can modify
25412 the space between the columns.
25413 This is done by changing the length
25420 Its predefined value is 10
25421 \begin_inset space \thinspace{}
25425 Here is an example where
25432 \begin_inset space \thinspace{}
25438 \begin_layout Standard
25442 \begin_layout Plain Layout
25456 \begin_layout Standard
25457 \begin_inset Flex Multiple Columns
25460 \begin_layout Plain Layout
25463 My observations of No.
25464 \begin_inset space \space{}
25467 427 Park Lane did little to clear up the problem in which I was interested.
25468 The house was separated from the street by a low wall and railing, the
25469 whole not more than five feet high.
25470 It was perfectly easy, therefore, for anyone to get into the garden, but
25471 the window was entirely inaccessible, since there was no water pipe or
25472 anything which could help the most active man to climb it.
25473 More puzzled than ever, I retraced my steps to Kensington.
25474 I had not been in my study five minutes when the maid entered to say that
25475 a person desired to see me.
25476 To my astonishment it was none other than my strange old book collector,
25477 his sharp, wizened face peering out from a frame of white hair, and his
25478 precious volumes, a dozen of them at least, wedged under his right arm.
25486 \begin_layout Standard
25490 \begin_layout Plain Layout
25502 \begin_inset Note Note
25505 \begin_layout Plain Layout
25506 go back to the default
25514 \begin_layout Subsubsection
25518 \begin_layout Standard
25519 Between the columns a rule with a width of the length
25526 If this rule width is set to 0
25527 \begin_inset space \thinspace{}
25530 pt (this is the default), the rule is suppressed.
25531 In the following example the rule is 2
25532 \begin_inset space \thinspace{}
25538 \begin_layout Standard
25542 \begin_layout Plain Layout
25548 columnseprule}{2pt}
25556 \begin_layout Standard
25557 \begin_inset Flex Multiple Columns
25560 \begin_layout Plain Layout
25563 \begin_inset Quotes eld
25566 You're surprised to see me, sir,
25567 \begin_inset Quotes erd
25570 said he, in a strange, croaking voice.
25573 \begin_layout Plain Layout
25576 I acknowledged that I was.
25579 \begin_layout Plain Layout
25582 \begin_inset Quotes eld
25585 Well, I've a conscience, sir, and when I chanced to see you go into this
25586 house, as I came hobbling after you, I thought to myself, I'll just step
25587 in and see that kind gentleman, and tell him that if I was a bit gruff
25588 in my manner there was not any harm meant, and that I am much obliged to
25589 him for picking up my books.
25590 \begin_inset Quotes erd
25596 \begin_layout Plain Layout
25599 \begin_inset Quotes eld
25602 You make too much of a trifle,
25603 \begin_inset Quotes erd
25608 \begin_inset Quotes eld
25611 May I ask how you knew who I was?
25612 \begin_inset Quotes erd
25618 \begin_layout Plain Layout
25621 \begin_inset Quotes eld
25624 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25625 you'll find my little bookshop at the corner of Church Street, and very
25626 happy to see you, I am sure.
25627 Maybe you collect yourself, sir.
25631 \begin_inset space ~
25644 –a bargain, every one of them.
25645 With five volumes you could just fill that gap on that second shelf.
25646 It looks untidy, does it not, sir?
25647 \begin_inset Quotes erd
25658 \begin_layout Standard
25659 \begin_inset VSpace defskip
25665 \begin_layout Standard
25666 The rule can be colored by redefining the command
25673 This is done by inserting the command
25674 \begin_inset Newline newline
25683 columnseprulecolor}{
25688 \begin_inset Newline newline
25691 as \SpecialChar TeX
25692 Code before the multicolumn inset.
25697 in this command by a color of your choice.
25698 You can use all pre- and self-defined colors.
25706 \begin_inset space ~
25711 for more information about pre- and self-defined colors.
25712 To go back to the default color insert the command
25713 \begin_inset Newline newline
25722 columnseprulecolor}{
25727 \begin_inset Newline newline
25730 Here is the example with a cyan rule and 1
25731 \begin_inset space \thinspace{}
25734 cm column separation:
25737 \begin_layout Standard
25741 \begin_layout Plain Layout
25750 \begin_layout Plain Layout
25756 columnseprulecolor}{
25766 \begin_layout Standard
25767 \begin_inset Flex Multiple Columns
25770 \begin_layout Plain Layout
25773 \begin_inset Quotes eld
25776 You're surprised to see me, sir,
25777 \begin_inset Quotes erd
25780 said he, in a strange, croaking voice.
25783 \begin_layout Plain Layout
25786 I acknowledged that I was.
25789 \begin_layout Plain Layout
25792 \begin_inset Quotes eld
25795 Well, I've a conscience, sir, and when I chanced to see you go into this
25796 house, as I came hobbling after you, I thought to myself, I'll just step
25797 in and see that kind gentleman, and tell him that if I was a bit gruff
25798 in my manner there was not any harm meant, and that I am much obliged to
25799 him for picking up my books.
25800 \begin_inset Quotes erd
25806 \begin_layout Plain Layout
25809 \begin_inset Quotes eld
25812 You make too much of a trifle,
25813 \begin_inset Quotes erd
25818 \begin_inset Quotes eld
25821 May I ask how you knew who I was?
25822 \begin_inset Quotes erd
25828 \begin_layout Plain Layout
25831 \begin_inset Quotes eld
25834 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25835 you'll find my little bookshop at the corner of Church Street, and very
25836 happy to see you, I am sure.
25837 Maybe you collect yourself, sir.
25841 \begin_inset space ~
25854 –a bargain, every one of them.
25855 With five volumes you could just fill that gap on that second shelf.
25856 It looks untidy, does it not, sir?
25857 \begin_inset Quotes erd
25868 \begin_layout Standard
25872 \begin_layout Plain Layout
25878 columnseprule}{0pt}
25881 \begin_layout Plain Layout
25887 columnseprulecolor}{
25895 \begin_inset Note Note
25898 \begin_layout Plain Layout
25899 go back to the default
25907 \begin_layout Section
25908 Non-standard Paragraph Shapes
25911 \begin_layout Standard
25914 as well as any other text processor uses by default rectangular paragraphs.
25915 For special cases like for example posters, invitation cards or poems you
25916 can modify the paragraph shape to one of your choice.
25917 This can be done by using the \SpecialChar LaTeX
25922 which is loaded by using in the document settings the module
25924 Custom paragraph shapes
25929 \begin_layout Subsection
25933 \begin_layout Standard
25938 provides the following shapes:
25941 \begin_layout Standard
25942 \begin_inset Tabular
25943 <lyxtabular version="3" rows="13" columns="3">
25944 <features booktabs="true" islongtable="true" longtabularalignment="center">
25945 <column alignment="center" valignment="middle" width="16col%">
25946 <column alignment="center" valignment="middle" width="40col%">
25947 <column alignment="center" valignment="middle" width="35col%">
25948 <row endhead="true">
25949 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25952 \begin_layout Plain Layout
25958 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25961 \begin_layout Plain Layout
25967 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25970 \begin_layout Plain Layout
25978 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25981 \begin_layout Plain Layout
25987 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25990 \begin_layout Plain Layout
25991 Circle with circular hole (in the size of a CD/DVD)
25996 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25999 \begin_layout Plain Layout
26000 Cannot be scaled, take care there is not too much text
26007 <cell alignment="center" valignment="top" topline="true" usebox="none">
26010 \begin_layout Plain Layout
26016 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26019 \begin_layout Plain Layout
26025 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26028 \begin_layout Plain Layout
26029 Fragile, calculation might fail
26036 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26039 \begin_layout Plain Layout
26045 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26048 \begin_layout Plain Layout
26049 Rhomboid (symbolizing a
26050 \begin_inset Quotes eld
26054 \begin_inset Quotes erd
26062 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26065 \begin_layout Plain Layout
26073 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26076 \begin_layout Plain Layout
26082 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26085 \begin_layout Plain Layout
26091 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26094 \begin_layout Plain Layout
26102 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26105 \begin_layout Plain Layout
26111 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26114 \begin_layout Plain Layout
26120 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26123 \begin_layout Plain Layout
26131 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26134 \begin_layout Plain Layout
26140 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26143 \begin_layout Plain Layout
26144 Nut for bolt (hexagon with circular hole)
26149 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26152 \begin_layout Plain Layout
26160 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26163 \begin_layout Plain Layout
26169 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26172 \begin_layout Plain Layout
26178 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26181 \begin_layout Plain Layout
26189 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26192 \begin_layout Plain Layout
26198 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26201 \begin_layout Plain Layout
26207 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26210 \begin_layout Plain Layout
26218 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26221 \begin_layout Plain Layout
26227 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26230 \begin_layout Plain Layout
26236 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26239 \begin_layout Plain Layout
26247 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26250 \begin_layout Plain Layout
26256 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26259 \begin_layout Plain Layout
26260 Normal/reversed rain drop
26265 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26268 \begin_layout Plain Layout
26269 Fragile, calculation might fail
26276 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26279 \begin_layout Plain Layout
26286 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26289 \begin_layout Plain Layout
26290 The \SpecialChar TeX
26296 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26299 \begin_layout Plain Layout
26307 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26310 \begin_layout Plain Layout
26312 \begin_inset Newline newline
26320 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26323 \begin_layout Plain Layout
26324 Triangles in different orientations
26329 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26332 \begin_layout Plain Layout
26346 \begin_layout Standard
26347 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26349 for environments in the toolbar.
26352 \begin_layout Standard
26353 \begin_inset Newpage newpage
26359 \begin_layout Standard
26360 Here is an example paragraph in the shape of a nut:
26363 \begin_layout Standard
26364 \begin_inset VSpace bigskip
26373 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26374 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26376 At vero eos et accusam et justo duo dolores et ea rebum.
26377 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26379 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26380 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26384 \begin_layout Standard
26385 \begin_inset VSpace bigskip
26391 \begin_layout Standard
26392 \begin_inset Note Greyedout
26395 \begin_layout Plain Layout
26400 : shapepar paragraphs cannot run over a page break.
26408 \begin_layout Standard
26409 \begin_inset VSpace bigskip
26415 \begin_layout Standard
26420 takes care that the shape will always be preserved, no matter how much
26421 text is in the paragraph.
26422 Therefore the paragraph size changes with the amount of contained text.
26423 This can lead to paragraph sizes exceeding the page margins.
26424 To demonstrate the size scaling, here is the same example paragraph but
26425 with twice as much text:
26428 \begin_layout Standard
26429 \begin_inset Newpage newpage
26438 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26439 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26441 At vero eos et accusam et justo duo dolores et ea rebum.
26442 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26444 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26445 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26447 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26448 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26450 At vero eos et accusam et justo duo dolores et ea rebum.
26451 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26453 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26454 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26458 \begin_layout Standard
26459 \begin_inset VSpace bigskip
26465 \begin_layout Standard
26466 An exception is the shape
26471 It cannot be scaled because it must fit the size of a CD/DVD.
26472 Therefore the amount of text that fits into the shape is limited.
26473 \begin_inset Newline newline
26484 shape are fragile, meaning that the calculation of their size can fail,
26485 depending on the amount of text.
26486 You will then get the \SpecialChar LaTeX
26488 \begin_inset Quotes eld
26491 Arithmetic overflow
26492 \begin_inset Quotes erd
26496 In this case one can try to remove or add some text; if nothing works one
26497 has to use another shape.
26500 \begin_layout Standard
26501 \begin_inset VSpace bigskip
26507 \begin_layout Standard
26508 For shapes with tips you will maybe see that \SpecialChar LaTeX
26509 's hyphenation routine fails
26510 for text in the tips.
26511 Therefore it is often necessary to add hyphenation points
26516 arg "specialchar-insert hyphenation"
26521 ) to the corresponding text parts.
26524 \begin_layout Standard
26525 \begin_inset VSpace bigskip
26531 \begin_layout Standard
26532 Shapepar paragraphs are either always centered or placed on the page so
26533 that their left border touches the left page margin.
26534 You can therefore not use the paragraph dialog to align such paragraphs.
26535 A solution is to put the paragraph into a minipage or parbox and align
26537 The problem is hereby to find the right width for the box.
26538 Because if it is too wide and you center the box, the paragraph is not
26539 centered too because it sticks at the left side of the box.
26540 So you might have to play a bit with the width until it fits.
26541 Here are two heart-shaped paragraphs, the first one is not aligned, the
26542 second one is right-aligned:
26545 \begin_layout Standard
26546 \begin_inset Newpage newpage
26552 \begin_layout Heart
26556 Lo\SpecialChar softhyphen
26557 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26558 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26560 At vero eos et accusam et justo duo dolores et ea rebum.
26561 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26565 \begin_layout Standard
26566 \begin_inset VSpace bigskip
26572 \begin_layout Standard
26575 \begin_inset Box Frameless
26585 height_special "totalheight"
26590 backgroundcolor "none"
26593 \begin_layout Heart
26597 Lo\SpecialChar softhyphen
26598 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26599 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26601 At vero eos et accusam et justo duo dolores et ea rebum.
26602 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26611 \begin_layout Subsection
26615 \begin_layout Standard
26616 You can define any shape you want.
26617 Doing this manually is a lot of work because every coordinate must be specified.
26618 But there is a way to let the computer calculate the coordinates:
26621 \begin_layout Enumerate
26622 Install the program
26623 \begin_inset CommandInset href
26626 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26634 \begin_layout Enumerate
26641 TeX/LaTeX\SpecialChar menuseparator
26642 Settings\SpecialChar menuseparator
26645 and select the font size you are using in your document.
26646 For example this document uses the size 12
26647 \begin_inset space \thinspace{}
26653 \begin_layout Enumerate
26657 \begin_layout Enumerate
26660 TeX/LaTeX\SpecialChar menuseparator
26663 to export the shape to coordinates.
26664 In the appearing dialog use either the outline of your shape for the coordinate
26665 s or the path itself.
26669 \begin_layout Plain Layout
26670 For more information see
26671 \begin_inset CommandInset href
26673 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26686 \begin_layout Standard
26687 The coordinates are written into a \SpecialChar TeX
26689 To use it for your \SpecialChar LyX
26693 \begin_layout Enumerate
26694 Place the cursor before the first character of your paragraph (or into a
26698 \begin_layout Enumerate
26699 Open in \SpecialChar LyX
26702 Insert\SpecialChar menuseparator
26703 File\SpecialChar menuseparator
26705 \begin_inset space ~
26710 , select the file and use
26719 \begin_layout Standard
26720 \begin_inset VSpace defskip
26726 \begin_layout Standard
26727 \begin_inset Note Greyedout
26730 \begin_layout Plain Layout
26735 : The changed shape only applies to the current paragraph; everything is
26736 reset to normal for the next paragraph.
26737 Therefore the shape definition file must be input into every paragraph
26738 with the desired shape.
26746 \begin_layout Standard
26747 \begin_inset VSpace bigskip
26753 \begin_layout Standard
26754 Here is an example:
26757 \begin_layout Standard
26758 \begin_inset VSpace bigskip
26764 \begin_layout Standard
26765 \begin_inset CommandInset include
26767 filename "SpecialParagraphShape.tex"
26773 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26774 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26776 At vero eos et accusam et justo duo dolores et ea rebum.
26777 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26779 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26780 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26784 \begin_layout Standard
26785 \begin_inset VSpace bigskip
26791 \begin_layout Standard
26796 to draw complexer shapes in
26800 you can draw the shape in a program of your choice and import the resulting
26806 Then you only need to draw a line or spline along the outline of the image.
26809 \begin_layout Standard
26810 \begin_inset VSpace bigskip
26816 \begin_layout Standard
26819 Custom paragraph shapes
26821 also provides the two commands
26829 which can be used to define custom shapes coordinate by coordinate.
26833 \begin_layout Plain Layout
26834 These commands are internally used for all shapes described here.
26839 For information how these styles are used and about further customization
26840 possibilities, have a look at the documentation of the package
26845 \begin_inset CommandInset citation
26855 \begin_layout Bibliography
26856 \begin_inset CommandInset bibitem
26857 LatexCommand bibitem
26863 Documentation of the \SpecialChar LaTeX
26865 \begin_inset CommandInset href
26868 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26876 \begin_layout Bibliography
26877 \begin_inset CommandInset bibitem
26878 LatexCommand bibitem
26884 Documentation of the \SpecialChar LaTeX
26886 \begin_inset CommandInset href
26889 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"