1 #LyX 2.3 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /buildlyxdir/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 1
88 \use_package stackrel 1
89 \use_package stmaryrd 1
90 \use_package undertilde 1
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 false
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 It seems to generate at least one of these messages for just about any
1792 They are warnings about lines that were too long and run past the right
1794 This happens if \SpecialChar LaTeX
1795 does not find a reasonable way to break the lines (notoriously
1796 often with typewriter font, since this does not allow for automatic break
1798 In many cases, this is unnoticeable in the final output.
1799 (It can be just a point or two.) Sometimes, however, the lines run rather
1800 visibly into the margin; something you will not want to have in your final
1803 \begin_inset Newline newline
1806 There are several global ways to try to minimize the overfull lines.
1809 Enable micro-typographic extensions
1813 Document\SpecialChar menuseparator
1814 Settings\SpecialChar menuseparator
1817 might already improve things a lot.
1818 Furthermore, \SpecialChar LaTeX
1819 code such as the following in
1821 Document\SpecialChar menuseparator
1822 Settings\SpecialChar menuseparator
1825 usually reduces the overfull lines drastically (we use this in the preamble
1830 \begin_layout LyX-Code
1834 \begin_inset Newline newline
1840 \begin_inset Newline newline
1845 emergencystretch 1.5em
1846 \begin_inset Newline newline
1854 \begin_layout Standard
1855 In some cases, however, you eventually have to rewrite the text to get the
1856 line breaking right.
1860 \begin_layout Plain Layout
1861 For more information, see
1862 \begin_inset Flex URL
1865 \begin_layout Plain Layout
1867 http://www.tex.ac.uk/FAQ-overfull.html
1880 \begin_layout Standard
1881 In any case, you should check the respective lines, at least for the final
1882 version of your document.
1883 Your eyes will tell you if there's a problem with something that's too
1888 \begin_layout Plain Layout
1889 You can also enable the `draft' option in
1890 \begin_inset Flex Noun
1893 \begin_layout Plain Layout
1894 Document\SpecialChar menuseparator
1900 , and then \SpecialChar LaTeX
1901 will draw a black box in the margin of lines that are overfull.
1910 \begin_layout Itemize
1911 \begin_inset Flex Code
1914 \begin_layout Plain Layout
1923 \begin_inset Newline newline
1926 Not quite as common as its cousin.
1927 This happens again if \SpecialChar LaTeX
1928 does not find a reasonable break point and consequently
1929 generates too loose lines.
1930 As with the overfull lines, you should check if this is a visible problem.
1933 \begin_layout Itemize
1934 \begin_inset Flex Code
1937 \begin_layout Plain Layout
1946 \begin_inset Flex Code
1949 \begin_layout Plain Layout
1958 \begin_inset Newline newline
1961 Warnings about troubles breaking the page.
1962 Once again, just look at the output.
1963 Your eyes will tell you where something has gone wrong.
1966 \begin_layout Itemize
1967 \begin_inset Flex Code
1970 \begin_layout Plain Layout
1972 \begin_inset Quotes els
1976 \begin_inset Quotes ers
1985 \begin_inset Newline newline
1989 \begin_inset Quotes eld
1993 \begin_inset Quotes erd
1996 isn't installed on this system.
1997 This usually appears because some package your document needs isn't installed.
1998 If you didn't touch the preamble or didn't use the
1999 \begin_inset Flex Code
2002 \begin_layout Plain Layout
2010 command, then one of the packages \SpecialChar LyX
2011 tried to load is missing.
2013 \begin_inset Flex Noun
2016 \begin_layout Plain Layout
2017 Help\SpecialChar menuseparator
2024 to get a list of packages that \SpecialChar LyX
2026 This file is updated whenever you reconfigure \SpecialChar LyX
2028 \begin_inset Flex Noun
2031 \begin_layout Plain Layout
2032 Tools\SpecialChar menuseparator
2038 ) and tells you which packages have been detected and what they do.
2039 \begin_inset Newline newline
2043 \begin_inset Flex Code
2046 \begin_layout Plain Layout
2054 command and the package in question isn't installed, then you'll need to
2055 install it yourself.
2058 \begin_layout Itemize
2059 \begin_inset Flex Code
2062 \begin_layout Plain Layout
2063 LaTeX Error: Unknown option
2069 \begin_inset Newline newline
2072 Error messages beginning with this are trying to tell you that you specified
2073 a bad or undefined option to a package.
2074 Check the package's documentation.
2077 \begin_layout Itemize
2078 \begin_inset Flex Code
2081 \begin_layout Plain Layout
2082 Undefined control sequence
2088 \begin_inset Newline newline
2091 If you've inserted \SpecialChar LaTeX
2092 code into your document, but made a typo, you'll get
2094 You may have forgotten to load a package.
2095 In any case, this error message usually means that you used an undefined
2100 \begin_layout Standard
2101 There are other error and warning messages.
2102 Some are self-explanatory.
2103 These are usually \SpecialChar LaTeX
2105 Others are downright cryptic.
2106 These are usually \SpecialChar TeX
2107 error messages, and we really have
2111 what they mean or how to decipher them.
2115 \begin_layout Standard
2116 There's a general sequence you should follow if you get error messages:
2119 \begin_layout Enumerate
2120 Look at the \SpecialChar LaTeX
2121 code you inserted for typos.
2124 \begin_layout Enumerate
2125 If there are no typos, check that you used the command(s) correctly.
2128 \begin_layout Enumerate
2129 If you get a bunch of error boxes piled up at the very top of the document—and
2130 especially if you see a
2131 \begin_inset Quotes eld
2135 \begin_inset Flex Code
2138 \begin_layout Plain Layout
2147 \begin_inset Quotes erd
2150 error—it means that there are errors in the preamble.
2151 Start debugging your preamble.
2154 \begin_layout Enumerate
2155 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2157 document, the first suspect is your \SpecialChar LaTeX
2158 distribution itself.
2159 Check for missing packages and install them.
2162 \begin_layout Enumerate
2163 Okay, so there are no missing packages.
2164 Did you use any of the fine-tuning options in \SpecialChar LyX
2165 ? Specifically, did you
2169 any of them, like trying to manually insert lots of
2170 \begin_inset Flex Code
2173 \begin_layout Plain Layout
2175 \begin_inset space ~
2184 \begin_inset Flex Code
2187 \begin_layout Plain Layout
2194 \begin_inset Flex Code
2197 \begin_layout Plain Layout
2203 ? Did you try to kludge something together with these instead of using the
2204 appropriate paragraph environment?
2207 \begin_layout Enumerate
2208 All right, you didn't use any of the fine-tuning options, you played by
2210 Did you try to pull a fancy maneuver? Did you do something funky inside
2211 a table or an equation, like inserting a graphic into a table cell?
2214 \begin_layout Enumerate
2215 Do you have long sections of text where \SpecialChar LaTeX
2216 cannot find a place to break a
2217 line? By default, \SpecialChar LaTeX
2218 is rather strict about how much extra inter-word spacing
2219 it will add in order to break a line.
2220 Preferably, you should rework the paragraph to avoid the problem.
2223 \begin_layout Enumerate
2224 Did you go overboard with the nesting? \SpecialChar LyX
2225 (currently) doesn't check to make
2226 sure you're in the limits for nesting environments.
2227 If you nested a bunch of environments to the
2228 \begin_inset Formula $17^{\mathrm{th}}$
2231 level, that's the problem.
2232 (The limit in \SpecialChar LaTeX
2236 \begin_layout Enumerate
2237 Okay, you didn't get any error messages, but your output looks awful.
2238 If you have a table or figure that's too wide or long for the page, you
2243 \begin_layout Enumerate
2244 rescale the figure so it fits.
2247 \begin_layout Enumerate
2248 trim down the table so it fits.
2252 \begin_layout Enumerate
2253 If something else is wrong with the output, and you didn't try to pull anything
2254 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2257 \begin_layout Standard
2258 If all this doesn't help—well, then
2262 you might have found a bug in \SpecialChar LyX
2267 \begin_layout Chapter
2271 \begin_layout Section
2272 Customizing Bibliographies with Bib\SpecialChar TeX
2276 \begin_layout Standard
2277 The most basic information about how to use Bib\SpecialChar TeX
2282 with \SpecialChar LyX
2283 is contained in the section
2285 Bibliography databases
2292 The following subsections explain special bibliography features supported
2297 \begin_layout Subsection
2298 Alternative Citation Styles
2301 \begin_layout Standard
2302 Standard Bib\SpecialChar TeX
2304 \begin_inset space \thinspace{}
2308 \begin_inset space \space{}
2312 \begin_inset Quotes eld
2316 \begin_inset Quotes erd
2319 ) to refer to a cited work.
2320 However, in many scientific disciplines, other citation styles are in use.
2321 The most common one is the author-year style (e.
2322 \begin_inset space \thinspace{}
2326 \begin_inset space \space{}
2330 \begin_inset Quotes eld
2334 \begin_inset Quotes erd
2339 supports three packages that provide this style,
2340 \begin_inset Flex Code
2343 \begin_layout Plain Layout
2350 \begin_inset Flex Code
2353 \begin_layout Plain Layout
2360 \begin_inset Flex Code
2363 \begin_layout Plain Layout
2370 Each of these packages has their pros and cons, which cannot be listed
2372 If you only want to have simple author-year (or author-numerical) style,
2373 or if you want to use one of the countless style files for
2374 \begin_inset Flex Code
2377 \begin_layout Plain Layout
2383 , then the established
2384 \begin_inset Flex Code
2387 \begin_layout Plain Layout
2393 package is probably your choice.
2394 If you look for specific citation styles common in law studies, you might
2396 \begin_inset Flex Code
2399 \begin_layout Plain Layout
2406 If you want to have full control over the formatting or look for advanced
2407 features such as ibidem, footnote citations, full title citations, advanced
2408 date formats (such as 400 BC) or full localization to other languages than
2409 English, you should definitely consider
2410 \begin_inset Flex Code
2413 \begin_layout Plain Layout
2419 , which exceeds all other packages in terms of features, but is also quite
2420 heavy and more resource-hungry.
2423 \begin_layout Standard
2424 The handling of these packages in \SpecialChar LyX
2425 is basically the same.
2427 \begin_inset Flex Noun
2430 \begin_layout Plain Layout
2431 Document\SpecialChar menuseparator
2438 \begin_inset Flex Noun
2441 \begin_layout Plain Layout
2448 \begin_inset Flex Noun
2451 \begin_layout Plain Layout
2458 \begin_inset Flex Noun
2461 \begin_layout Plain Layout
2468 \begin_inset Flex Noun
2471 \begin_layout Plain Layout
2478 \begin_inset Flex Noun
2481 \begin_layout Plain Layout
2482 Biblatex (Natbib mode)
2488 \begin_inset Flex Noun
2491 \begin_layout Plain Layout
2498 \begin_inset Flex Noun
2501 \begin_layout Plain Layout
2508 \begin_inset space ~
2511 6.5.3 in the User's Guide for more information on these choices).
2512 With all these packages, you will get some extra features in the citation
2513 dialog and you can select the style of the reference (
2514 \begin_inset Quotes eld
2518 \begin_inset Quotes erd
2522 \begin_inset Quotes eld
2526 \begin_inset Quotes erd
2530 \begin_inset Quotes eld
2534 \begin_inset Quotes erd
2538 \begin_inset Quotes eld
2542 \begin_inset Quotes erd
2546 Note that either package needs specifically designed style files.
2547 They all ship their own, but there are lots of additional style files,
2548 and there is even an interactive style file builder
2552 \begin_layout Plain Layout
2554 \begin_inset Flex URL
2557 \begin_layout Plain Layout
2559 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2570 \begin_inset Flex Code
2573 \begin_layout Plain Layout
2582 \begin_layout Subsection
2583 Subdivided Bibliographies
2586 \begin_layout Standard
2587 Sometimes you might need to divide your bibliography into several sections.
2588 If you are for instance a historian, the possibility to separate sources
2589 and scientific works is most likely a
2590 \begin_inset Quotes eld
2594 \begin_inset Quotes erd
2598 Unfortunately, Bib\SpecialChar TeX
2599 itself does not allow you to do this.
2600 But with the help of some \SpecialChar LaTeX
2601 packages, Bib\SpecialChar TeX
2602 can be extended to fit your needs.
2605 \begin_layout Standard
2607 provides native support for one of these packages,
2615 \begin_layout Plain Layout
2617 \begin_inset Flex URL
2620 \begin_layout Plain Layout
2622 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2632 The advantage of this package (compared to other packages such as
2636 ) is that you don't need to define new citation commands.
2637 Instead, you need to prepare different bibliographic databases which include
2638 the entries for the different sections of the bibliography.
2639 For example: If you want to divide your bibliography into the sections
2641 \begin_inset Quotes eld
2645 \begin_inset Quotes erd
2649 \begin_inset Quotes eld
2653 \begin_inset Quotes erd
2656 , you first need to create two bibliographic databases, e.
2657 \begin_inset space \thinspace{}
2661 \begin_inset space \space{}
2665 \begin_inset Flex Code
2668 \begin_layout Plain Layout
2675 \begin_inset Flex Code
2678 \begin_layout Plain Layout
2688 \begin_layout Standard
2690 \begin_inset Flex Noun
2693 \begin_layout Plain Layout
2694 Document\SpecialChar menuseparator
2701 \begin_inset Flex Noun
2704 \begin_layout Plain Layout
2711 \begin_inset Flex Noun
2714 \begin_layout Plain Layout
2715 Subdivided bibliography
2721 Now you can insert multiple Bib\SpecialChar TeX
2722 bibliographies, one for each section of
2724 Returning to our example: Insert the Bib\SpecialChar TeX
2726 \begin_inset Flex Code
2729 \begin_layout Plain Layout
2735 and a second one for the database
2736 \begin_inset Flex Code
2739 \begin_layout Plain Layout
2746 You are free to use the same or different styles for each section.
2747 Additionally, you can choose if the bibliography section should contain
2749 \begin_inset Quotes eld
2752 all cited references
2753 \begin_inset Quotes erd
2756 of the specified database(s) (which is the default),
2757 \begin_inset Quotes eld
2760 all uncited references
2761 \begin_inset Quotes erd
2765 \begin_inset Quotes eld
2769 \begin_inset Quotes erd
2773 This might be useful if you would like to separate your bibliography into
2775 \begin_inset Quotes eld
2779 \begin_inset Quotes erd
2783 \begin_inset Quotes eld
2787 \begin_inset Quotes erd
2791 \begin_inset Quotes eld
2795 \begin_inset Quotes erd
2799 The titles for the sections can be added as ordinary sections or subsections.
2801 \begin_inset Flex Code
2804 \begin_layout Plain Layout
2810 removes the bibliography title, you have to manually re-add that, too (as
2811 a chapter* or section*, for instance).
2814 \begin_layout Standard
2819 , the procedure is a bit different.
2828 , the aforementioned
2829 \begin_inset Flex Noun
2832 \begin_layout Plain Layout
2833 Subdivided bibliography
2838 option is disabled if you use
2847 provides its own means to generate subdivided bibliographies.
2848 You can either add keywords to bibliography entries via the
2849 \begin_inset Flex Code
2852 \begin_layout Plain Layout
2858 entry option and then filter bibliography sections by keyword (by adding
2860 \begin_inset Flex Code
2863 \begin_layout Plain Layout
2870 \begin_inset Flex Noun
2873 \begin_layout Plain Layout
2879 field of the dialog that opens if you left-click on the
2880 \begin_inset Flex Noun
2883 \begin_layout Plain Layout
2884 Biblatex Generated Bibliography
2889 button), or you can filter by entry types (such as
2898 \begin_inset space \thinspace{}
2903 \begin_inset Flex Code
2906 \begin_layout Plain Layout
2913 \begin_inset Flex Code
2916 \begin_layout Plain Layout
2923 \begin_inset Flex Noun
2926 \begin_layout Plain Layout
2932 field, or you can create so-called
2933 \begin_inset Quotes eld
2936 Bibliography Categories
2937 \begin_inset Quotes erd
2940 to which you can assign individual entries.
2941 Please refer to the Biblatex manual, section
2943 Subdivided Bibliographies
2948 \begin_layout Subsection
2949 Multiple Bibliographies
2950 \begin_inset CommandInset label
2952 name "subsec:Multiple-Bibliographies"
2959 \begin_layout Standard
2960 Multiple bibliographies, e.
2961 \begin_inset space \thinspace{}
2965 \begin_inset space \space{}
2968 a bibliography for each part, chapter, section, subsection or child (sub-documen
2969 t) of the document, are also supported by \SpecialChar LyX
2971 In order to enable it, go to
2972 \begin_inset Flex Noun
2975 \begin_layout Plain Layout
2976 Document\SpecialChar menuseparator
2977 Settings\SpecialChar menuseparator
2983 and select the relevant unit (e.
2984 \begin_inset space \thinspace{}
2988 \begin_inset Quotes eld
2992 \begin_inset Quotes erd
2996 \begin_inset Flex Noun
2999 \begin_layout Plain Layout
3000 Multiple Bibliographies
3006 Then add a Bib(la)\SpecialChar TeX
3007 bibliography to each unit (e.
3008 \begin_inset space \thinspace{}
3011 g., section) of your document.
3012 In the output, a separate bibliography, containing only the references
3013 done in the current unit is generated.
3016 \begin_layout Standard
3017 If you use Bib\SpecialChar TeX
3019 \begin_inset Flex Code
3022 \begin_layout Plain Layout
3029 \begin_inset Flex Code
3032 \begin_layout Plain Layout
3038 package is used to create multiple bibliographies.
3039 The former package is used if you select
3040 \begin_inset Quotes eld
3044 \begin_inset Quotes erd
3052 \begin_inset Flex Noun
3055 \begin_layout Plain Layout
3056 Sectioned Bibliography
3063 \begin_inset Flex Code
3066 \begin_layout Plain Layout
3076 \begin_layout Plain Layout
3077 An alternative approach, if you are willing to use some
3078 \begin_inset Flex Noun
3081 \begin_layout Plain Layout
3089 \begin_inset space ~
3093 \begin_inset CommandInset ref
3095 reference "sec:Inserting-TeX-Code"
3100 \begin_inset Flex Code
3103 \begin_layout Plain Layout
3115 \begin_inset Flex Code
3118 \begin_layout Plain Layout
3124 is used, \SpecialChar LyX
3125 encloses the specified units in
3126 \begin_inset Flex Code
3129 \begin_layout Plain Layout
3136 \begin_inset Flex Code
3139 \begin_layout Plain Layout
3148 \begin_inset Flex Code
3151 \begin_layout Plain Layout
3159 in order to create the units.
3160 Note that this approach has some limitations.
3161 First, every citation reference has to be inside some
3162 \begin_inset Flex Code
3165 \begin_layout Plain Layout
3172 So citations outside a defined unit (e.
3173 \begin_inset space \thinspace{}
3176 g., before the first section if you use
3177 \begin_inset Quotes eld
3181 \begin_inset Quotes erd
3185 \begin_inset Quotes eld
3189 \begin_inset Quotes erd
3193 You can also create your own units by entering
3194 \begin_inset Flex Code
3197 \begin_layout Plain Layout
3206 \begin_inset Flex Code
3209 \begin_layout Plain Layout
3218 code (for instance to work around the mentioned limitation).
3220 \begin_inset Flex Code
3223 \begin_layout Plain Layout
3230 A second limitation is that
3231 \begin_inset Flex Code
3234 \begin_layout Plain Layout
3240 always processes all references of a bibliography database, even if they
3242 This can result in odd labels (e.
3243 \begin_inset space \thinspace{}
3248 \begin_inset Quotes eld
3252 \begin_inset Quotes erd
3255 if two works of this author from 2014 are in the database, even if only
3259 \begin_layout Standard
3265 \begin_inset Flex Code
3268 \begin_layout Plain Layout
3274 option is used instead.
3275 If you need specific units, you can start them with the \SpecialChar TeX
3277 \begin_inset Flex Code
3280 \begin_layout Plain Layout
3289 \begin_inset Flex Code
3292 \begin_layout Plain Layout
3301 If you also want to control the end of the unit, use the environment
3302 \begin_inset Flex Code
3305 \begin_layout Plain Layout
3315 \begin_inset Flex Code
3318 \begin_layout Plain Layout
3328 \begin_inset Flex Code
3331 \begin_layout Plain Layout
3338 In addition to the individual bibliography of the current unit,
3342 also provides an easy way to output all bibliographies, subsequently, at
3344 \begin_inset space \thinspace{}
3347 g., at the end of the document).
3349 \begin_inset Quotes eld
3353 \begin_inset Quotes erd
3356 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3362 manual for more information on this topic.
3365 \begin_layout Section
3369 \begin_layout Subsection
3373 \begin_layout Standard
3374 When you are working on a large file with many sections, it is often convenient
3375 to break up the document into several files, or perhaps you have something
3376 where a table may change from time to time, but the preceding text does
3378 In these cases, you should seriously consider using multipart documents.
3379 For example, scientific papers often have five major sections: the introduction
3380 , observations, results, discussion, and conclusion.
3381 Each of these could be its own separate \SpecialChar LyX
3383 \begin_inset Quotes eld
3387 \begin_inset Quotes erd
3390 file which contains the title, authors, abstract, references, etc., plus
3391 the five included files.
3392 It is important to note that each of these files is a full \SpecialChar LyX
3394 can be formatted and printed on its own, as well as included in a master
3396 Each of these files must have the same document class, however—don't attempt
3397 to mix book classes with article classes.
3398 You may also include \SpecialChar LaTeX
3399 files; however, these files must not have their own
3401 \begin_inset space \thinspace{}
3405 \begin_inset space \space{}
3408 everything up to and including the
3409 \begin_inset Flex Code
3412 \begin_layout Plain Layout
3421 \begin_inset Flex Code
3424 \begin_layout Plain Layout
3432 line must be deleted) or else errors will be generated when you try to
3436 \begin_layout Standard
3438 allows you to include files quite easily with
3439 \begin_inset Flex Noun
3442 \begin_layout Plain Layout
3443 Insert\SpecialChar menuseparator
3445 \begin_inset space ~
3454 When you click on this selection a small box is inserted into the file
3455 at the current cursor location.
3456 Clicking on the box raises a dialog which allows you to select the file
3457 to be included, and the method of its inclusion.
3461 \begin_layout Standard
3462 The file selection box should by now be obvious.
3463 The three inclusion methods are
3464 \begin_inset Quotes eld
3468 \begin_inset Quotes erd
3472 \begin_inset Quotes eld
3476 \begin_inset Quotes erd
3480 \begin_inset Quotes eld
3484 \begin_inset Quotes erd
3489 \begin_inset Quotes eld
3493 \begin_inset Quotes erd
3497 \begin_inset Quotes eld
3501 \begin_inset Quotes erd
3504 are similar in many ways, but there are also some notable differences:
3507 \begin_layout Enumerate
3509 \begin_inset Quotes eld
3513 \begin_inset Quotes erd
3516 are typeset beginning on a new page, while files that are
3517 \begin_inset Quotes eld
3521 \begin_inset Quotes erd
3524 are typeset starting on the current page.
3527 \begin_layout Enumerate
3528 \begin_inset Quotes eld
3532 \begin_inset Quotes erd
3535 files cannot themselves
3536 \begin_inset Quotes eld
3540 \begin_inset Quotes erd
3544 \begin_inset Quotes eld
3548 \begin_inset Quotes erd
3553 \begin_inset Quotes eld
3557 \begin_inset Quotes erd
3560 , on the other hand, infinite sub-inputting is possible.
3563 \begin_layout Enumerate
3564 \begin_inset Quotes eld
3568 \begin_inset Quotes erd
3571 allow for the output of only selected
3572 \begin_inset Quotes eld
3576 \begin_inset Quotes erd
3579 files, while maintaining the actual counters (pagination etc.) and references
3580 (please refer to the section
3583 \begin_inset space ~
3591 \begin_inset space ~
3596 manual for details).
3599 \begin_layout Standard
3601 \begin_inset Quotes eld
3605 \begin_inset Quotes erd
3608 is the preferred method for chapters that are outsourced to child documents,
3610 \begin_inset Quotes eld
3614 \begin_inset Quotes erd
3617 is more suitable for arbitrary file inheritance.
3620 \begin_layout Standard
3622 \begin_inset Quotes eld
3626 \begin_inset Quotes erd
3629 included file allows you to include a file typeset exactly as it appears
3631 \begin_inset space \thinspace{}
3635 \begin_inset space \space{}
3639 \begin_inset Flex Code
3642 \begin_layout Plain Layout
3648 mode, with the characters set in a fixed-width typewriter font.
3649 Normally, spaces in this file are invisible, though two consecutive spaces
3650 are conserved, unlike \SpecialChar LyX
3651 's normal treatment of spaces.
3652 However, setting the
3653 \begin_inset Flex Noun
3656 \begin_layout Plain Layout
3658 \begin_inset space ~
3662 \begin_inset space ~
3666 \begin_inset space ~
3674 checkbox typesets a mark to unambiguously define the presence of a space.
3678 \begin_layout Standard
3679 Generally, the master file is converted into a full \SpecialChar LaTeX
3680 file before typesetting,
3681 while the included files are converted to \SpecialChar LaTeX
3682 files that do not have all the
3683 preamble information.
3686 \begin_layout Subsection
3687 Cross-References Between Files
3690 \begin_layout Standard
3691 \begin_inset Box Shadowbox
3701 height_special "totalheight"
3706 backgroundcolor "none"
3709 \begin_layout Plain Layout
3710 This section is somewhat out of date.
3711 Need to describe default master documents and how children are opened when
3721 \begin_layout Standard
3722 It is possible to set up cross-references between the different files.
3723 First, open all the files in question: let's call them A and B in a two
3724 file example, where B is included in A.
3725 Let's say you insert a label in A, then want to reference it in B.
3726 Open the cross-reference dialog whilst in document B, and you can select
3728 \begin_inset Quotes eld
3732 \begin_inset Quotes erd
3738 \begin_layout Subsection
3739 Bibliography Lists in all Subdocuments
3742 \begin_layout Standard
3743 If you work with child documents, you might want to have only one main bibliogra
3744 phy at the end, but still be able to have a selected bibliography for the
3745 child if you output it on its own.
3746 Here is how to achieve this.
3749 \begin_layout Standard
3750 For the main document, you just insert a bibliography inset at the place
3751 where the main bibliography has to appear (within the master file or within
3753 If the bibliography inset is in the master file, the references will be
3754 inherited by all children, so they are available in the citation dialog
3758 \begin_layout Standard
3759 For child-specific bibliographies, insert bibliography insets within the
3760 child documents, at the place where the bibliography should appear when
3761 the child is compiled separately.
3762 However, the trick is to insert them into a branch (
3764 Insert\SpecialChar menuseparator
3765 Branch\SpecialChar menuseparator
3766 Insert New Branch...
3769 \begin_inset space \thinspace{}
3774 \begin_inset Quotes eld
3778 \begin_inset Quotes erd
3782 Within the children, activate the branch (
3784 Document\SpecialChar menuseparator
3785 Settings...\SpecialChar menuseparator
3789 Within the master, deactivate the branch (
3791 Document\SpecialChar menuseparator
3792 Settings...\SpecialChar menuseparator
3796 Now the child's bibliography will be ignored by the master, but considered
3800 \begin_layout Standard
3801 If you need multiple bibliographies (e.
3802 \begin_inset space \thinspace{}
3805 g., one per child in the
3809 ), please refer to sec.
3810 \begin_inset space ~
3814 \begin_inset CommandInset ref
3816 reference "subsec:Multiple-Bibliographies"
3823 \begin_layout Section
3828 \begin_layout Standard
3829 Users sometimes need to be able to
3830 \begin_inset Quotes eld
3834 \begin_inset Quotes erd
3838 file together with all the images (and other files) on which it depends,
3839 either for sending to a publisher or for sharing with a co-author.
3841 includes a Python script (
3842 \begin_inset Flex Code
3845 \begin_layout Plain Layout
3851 ) that automates this process.
3852 To use it, you must have either the
3853 \begin_inset Flex Code
3856 \begin_layout Plain Layout
3863 \begin_inset Flex Code
3866 \begin_layout Plain Layout
3872 python modules installed on your system.
3873 By default, the script prefers the
3874 \begin_inset Flex Code
3877 \begin_layout Plain Layout
3884 \begin_inset Flex Code
3887 \begin_layout Plain Layout
3893 format on Unix-like systems and the
3894 \begin_inset Flex Code
3897 \begin_layout Plain Layout
3906 \begin_layout Standard
3908 's configuration process will set the script up to export a `\SpecialChar LyX
3910 and this format will then be available under
3911 \begin_inset Flex Code
3914 \begin_layout Plain Layout
3915 File\SpecialChar menuseparator
3924 \begin_layout Standard
3925 Independently of the platform, the generation of a particular archive format
3926 can be forced by adding either the
3927 \begin_inset Flex Code
3930 \begin_layout Plain Layout
3937 \begin_inset Flex Code
3940 \begin_layout Plain Layout
3947 \begin_inset Flex Code
3950 \begin_layout Plain Layout
3957 \begin_inset Flex Code
3960 \begin_layout Plain Layout
3966 format) switch to the
3967 \begin_inset Flex Code
3970 \begin_layout Plain Layout
3972 \SpecialChar menuseparator
3980 \begin_inset Flex Code
3983 \begin_layout Plain Layout
3984 Tools\SpecialChar menuseparator
3985 Preferences\SpecialChar menuseparator
3986 File Handling\SpecialChar menuseparator
3993 (Make sure you add the switch after the script name, not before it.)
3996 \begin_layout Section
3997 Fancy Headers and Footers
4000 \begin_layout Standard
4001 The default page layout is rather plain; for an
4002 \begin_inset Flex Code
4005 \begin_layout Plain Layout
4011 document class, all you get is a centered page number at the bottom of
4013 This document uses KOMA-script's book class, so it appears to be a bit
4015 But to really put on a show, you need to set the document page style to
4017 \begin_inset Quotes eld
4021 \begin_inset Quotes erd
4024 , as mentioned in the
4029 This section describes the \SpecialChar LaTeX
4030 code you need to insert in your \SpecialChar LaTeX
4032 order to get the desired effects.
4035 \begin_layout Standard
4036 For more information on fancy headers, see the
4037 \begin_inset Flex Code
4040 \begin_layout Plain Layout
4046 package documentation.
4048 \begin_inset Flex URL
4051 \begin_layout Plain Layout
4053 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4061 \begin_layout Standard
4062 The page header is divided into three fields, not surprisingly labeled
4063 \begin_inset Quotes eld
4067 \begin_inset Quotes erd
4071 \begin_inset Quotes eld
4075 \begin_inset Quotes erd
4079 \begin_inset Quotes eld
4083 \begin_inset Quotes erd
4087 The footer is also divided into these three fields.
4088 The \SpecialChar LaTeX
4089 commands to set these fields in the simplest manner are
4090 \begin_inset Flex Code
4093 \begin_layout Plain Layout
4102 \begin_inset Flex Code
4105 \begin_layout Plain Layout
4114 \begin_inset Flex Code
4117 \begin_layout Plain Layout
4126 \begin_inset Flex Code
4129 \begin_layout Plain Layout
4138 Suppose you wish to put your name in the upper left hand corner of each
4140 Simply insert the following command in the preamble:
4143 \begin_layout Standard
4152 \begin_layout Standard
4153 You will now see your name in the upper left.
4154 If a field has a default entry that you would like to get rid of (often
4155 the page number appears in the central footer) simply include a command
4156 with a blank argument, e.
4157 \begin_inset space \thinspace{}
4163 \begin_layout Standard
4171 \begin_layout Standard
4172 Let's get really fancy: lets put the section number with the word
4173 \begin_inset Quotes eld
4177 \begin_inset Quotes erd
4181 \begin_inset space \thinspace{}
4185 \begin_inset space \space{}
4188 Section 3) in the upper left, the page number (e.
4189 \begin_inset space \thinspace{}
4193 \begin_inset space \space{}
4196 Page 4) in the upper right, your name in the lower left, and the date in
4198 The following commands should now appear in the preamble:
4201 \begin_layout Standard
4211 \begin_layout Standard
4219 \begin_layout Standard
4229 \begin_layout Standard
4238 \begin_layout Standard
4246 \begin_layout Standard
4256 \begin_layout Standard
4258 \begin_inset Flex Code
4261 \begin_layout Plain Layout
4270 \begin_inset Flex Code
4273 \begin_layout Plain Layout
4281 access \SpecialChar LaTeX
4282 's section and page counters, and so print out the current section
4285 \begin_inset Flex Code
4288 \begin_layout Plain Layout
4296 simply prints out today's date.
4299 \begin_layout Standard
4300 The thicknesses of the horizontal rules drawn beneath the header and above
4301 the footer can also be modified.
4302 If you don't want one of the rules, set its thickness to 0.
4303 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4309 \begin_inset Flex Code
4312 \begin_layout Plain Layout
4317 headrulewidth}{0.4pt}
4323 \begin_inset Flex Code
4326 \begin_layout Plain Layout
4331 footrulewidth}{0.4pt}
4336 to set the thicknesses.
4339 \begin_layout Standard
4340 You can switch the header/footer settings on and off for individual pages
4342 \begin_inset Flex Code
4345 \begin_layout Plain Layout
4348 thispagestyle{empty}
4354 \begin_inset Flex Code
4357 \begin_layout Plain Layout
4360 thispagestyle{plain}
4366 \begin_inset Flex Code
4369 \begin_layout Plain Layout
4372 thispagestyle{fancy}
4378 Simply insert them in the text on the page you want changed and mark them
4381 In fact, title pages are marked as plain by default, while following pages
4382 are marked fancy when using the global fancy setting.
4385 \begin_layout Standard
4386 As a final example, it is possible to include an image in the header or
4388 Suppose you want to put a company logo in the upper lefthand corner.
4389 You might try something like
4392 \begin_layout Standard
4401 includegraphics{logo.eps}}}
4404 \begin_layout Standard
4406 (you may need to preface this with
4407 \begin_inset Flex Code
4410 \begin_layout Plain Layout
4414 usepackage{graphics}
4419 if you don't include graphics elsewhere in your document).
4422 \begin_layout Section
4423 Itemize Bullet Selection
4424 \begin_inset CommandInset label
4433 \begin_layout Standard
4439 \begin_layout Subsection
4443 \begin_layout Standard
4445 provides 216 bullet shapes that can be accessed from a simple dialog.
4446 Using this dialog you can easily specify what bullet shape to use at each
4447 level of an itemized list.
4448 These settings are document-wide so you won't be able to specify different
4449 sets of bullets for different paragraphs.
4453 \begin_layout Plain Layout
4454 Well, actually you can but you'll have to do it by hand.
4462 \begin_layout Subsection
4466 \begin_layout Standard
4467 Open the dialog by selecting the
4468 \begin_inset Flex Noun
4471 \begin_layout Plain Layout
4472 Document\SpecialChar menuseparator
4478 menu item and then select the
4479 \begin_inset Flex Noun
4482 \begin_layout Plain Layout
4491 \begin_layout Standard
4492 The dialog provides you with a table of bullet shapes.
4493 A column of buttons on the left of the table provides access to the six
4494 different panels of bullet shapes.
4495 The row of buttons across the top is used to select which bullet depth
4497 A text entry under the table shows the currently selected bullet shape's
4499 equivalent and this can be edited if desired.
4500 If you do modify the text you will also need to specify any needed packages
4501 in the \SpecialChar LaTeX
4505 \begin_layout Standard
4506 The six panels are divided up by the packages they require.
4507 The following table shows the mappings from button name to \SpecialChar LaTeX
4511 \begin_layout Standard
4513 \begin_inset Tabular
4514 <lyxtabular version="3" rows="7" columns="2">
4515 <features tabularvalignment="middle">
4516 <column alignment="center" valignment="top" width="0pt">
4517 <column alignment="center" valignment="top" width="0pt">
4519 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4522 \begin_layout Plain Layout
4537 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4540 \begin_layout Plain Layout
4557 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4560 \begin_layout Plain Layout
4575 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4578 \begin_layout Plain Layout
4587 base \SpecialChar LaTeX
4595 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4598 \begin_layout Plain Layout
4613 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4616 \begin_layout Plain Layout
4633 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4636 \begin_layout Plain Layout
4651 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4654 \begin_layout Plain Layout
4671 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4674 \begin_layout Plain Layout
4689 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4692 \begin_layout Plain Layout
4709 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4712 \begin_layout Plain Layout
4727 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4730 \begin_layout Plain Layout
4747 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4750 \begin_layout Plain Layout
4765 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4768 \begin_layout Plain Layout
4791 \begin_layout Standard
4793 doesn't stop you using bullets from packages you don't have.
4794 If you get errors from \SpecialChar LaTeX
4795 when you try to view or print the file, then it
4796 is likely you are missing a package.
4800 \begin_layout Plain Layout
4802 doesn't restrict your use since you may be editing locally and exporting
4811 \begin_layout Subsection
4815 \begin_layout Standard
4816 Select which bullet depth you want to change then select the bullet shape
4818 Any changes will not be visible in \SpecialChar LyX
4819 , but are visible when viewing the document.
4822 \begin_layout Standard
4823 You can reset a bullet shape to the default simply by clicking your right
4824 mouse button on the appropriate bullet depth button.
4828 \begin_layout Plain Layout
4833 want to have multiple sets of paragraphs with different sets of bullets
4834 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4836 The bullet selection dialog can help though because it provides you with
4837 the \SpecialChar LaTeX
4838 code for a wide range of bullet shapes.
4839 To make your own custom paragraphs you have the following options:
4842 \begin_layout Plain Layout
4846 \begin_layout Plain Layout
4862 \begin_layout Plain Layout
4866 \begin_layout Plain Layout
4888 \begin_layout Itemize
4889 Use the \SpecialChar LaTeX
4891 \begin_inset Flex Code
4894 \begin_layout Plain Layout
4902 to specify a new bullet shape for a given depth.
4903 You'll also need to save the current bullet shape so you can restore it
4905 In this itemized list the following \SpecialChar LaTeX
4906 code was used to change the bullet
4907 used for the first depth.
4911 \begin_layout LyX-Code
4921 \begin_layout LyX-Code
4938 \begin_layout Itemize
4939 Note that the itemize depth is specified in Roman numerals as part of the
4949 \begin_layout Itemize
4950 \begin_inset Argument item:1
4953 \begin_layout Plain Layout
4957 \begin_layout Plain Layout
4975 Specify each individual entry by starting each item with the bullet shape
4977 \begin_inset Quotes eld
4981 \begin_inset Quotes erd
4986 Insert\SpecialChar menuseparator
4990 \begin_inset Flex Noun
4993 \begin_layout Plain Layout
5001 For example, this item was started with
5002 \begin_inset Flex Code
5005 \begin_layout Plain Layout
5020 \begin_layout Plain Layout
5024 \begin_layout Plain Layout
5040 \begin_layout Plain Layout
5041 You'll also need to revert the labelitem back to its previous setting for
5042 the global bullet shape settings to remain in effect.
5043 The way used here was:
5046 \begin_layout LyX-Code
5061 \begin_layout Chapter
5063 and the World Wide Web
5066 \begin_layout Standard
5068 has long supported the export of documents to various web-friendly formats,
5070 Before version 2.0, however, HTML export was always accomplished by the
5071 use of external converters.
5075 \begin_layout Plain Layout
5076 For details on the use of external converters with \SpecialChar LyX
5081 section of the Customization manual.
5086 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5088 intermediate format, such as
5089 \begin_inset Flex Code
5092 \begin_layout Plain Layout
5099 \begin_inset Flex Code
5102 \begin_layout Plain Layout
5109 \begin_inset Flex Code
5112 \begin_layout Plain Layout
5118 , relying upon \SpecialChar LyX
5119 to produce the \SpecialChar LaTeX
5120 ; and there is a converter that works directly
5123 \begin_inset Flex Code
5126 \begin_layout Plain Layout
5134 All of these have different advantages and disadvantages.
5138 \begin_layout Standard
5139 The \SpecialChar LaTeX
5140 -based converters have the advantage that, in principle, they know everythin
5141 g about the exported document that \SpecialChar LaTeX
5143 Such converters do not care, for example, if a certain block of code was
5144 produced by \SpecialChar LyX
5145 or was Evil Red Text.
5146 These converters know about
5147 \begin_inset Flex Code
5150 \begin_layout Plain Layout
5156 files, counters, and references, and can often make use of the
5157 \begin_inset Flex Code
5160 \begin_layout Plain Layout
5166 files generated by Bib\SpecialChar TeX
5168 On the other hand, \SpecialChar LaTeX
5169 is a very hard language to parse—it is sometimes said
5170 that only \SpecialChar TeX
5171 itself understands \SpecialChar TeX
5172 —and \SpecialChar LaTeX
5173 -based converters will often choke on
5174 what seem to be quite simple constructs; complex ones can throw them completely
5175 , and as of this writing, for example, the
5179 manual will not export with
5180 \begin_inset Flex Code
5183 \begin_layout Plain Layout
5189 , though the others will.
5190 The other issue concerns how math is handled.
5191 These converters typically convert the formulae into little pictures that
5192 are then linked from the HTML document.
5193 Since these are actually generated by \SpecialChar LaTeX
5194 , they are accurate.
5195 But they do not scale well, and just getting them to look as if they are
5196 actually meant to be in your document—so that the font sizes seem to be
5197 roughly the same—can be a challenge.
5200 \begin_layout Standard
5202 \begin_inset Flex Code
5205 \begin_layout Plain Layout
5213 \begin_inset CommandInset href
5215 name "http://pinchito.es/elyxer/"
5216 target "http://pinchito.es/elyxer/"
5221 ) solves some of these problems.
5222 In particular, the formulae it produces scale perfectly, since it renders
5223 math using a combination of HTML and CSS rather than converting the formulae
5225 But even moderately complex formula are rendered less well than with
5226 \begin_inset Flex Code
5229 \begin_layout Plain Layout
5235 ; this reflects the limitations of HTML.
5239 \begin_layout Plain Layout
5241 \begin_inset Flex Code
5244 \begin_layout Plain Layout
5251 can also use jsMath and MathJax for equations, but this setting is only
5252 available globally and requires one to have access to a server that runs
5258 More importantly (as of version 1.1.1, at least),
5259 \begin_inset Flex Code
5262 \begin_layout Plain Layout
5269 has limited support for math macros and no support for user-defined paragraph
5270 or character styles.
5271 These limitations make
5272 \begin_inset Flex Code
5275 \begin_layout Plain Layout
5282 unsuitable for many of the documents \SpecialChar LyX
5284 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5286 have decided to follow a different path and have made \SpecialChar LyX
5288 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5289 , DocBook, and plaintext.
5292 \begin_layout Standard
5293 As of this writing, XHTML output remains under development and should probably
5295 \begin_inset Quotes eld
5299 \begin_inset Quotes erd
5306 \begin_layout Plain Layout
5308 \begin_inset Flex Code
5311 \begin_layout Plain Layout
5312 development/HTML/HTML.notes
5317 , which can be found in the \SpecialChar LyX
5319 \begin_inset CommandInset href
5321 name "accessed online"
5322 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5327 , usually contains up-to-date information about the state of XHTML output.
5328 See also the list of XHTML bugs on
5329 \begin_inset CommandInset href
5331 name "the bug tracker"
5332 target "https://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"
5342 Still, the developers have chosen this approach because it has several
5343 potential advantages over the other two.
5346 \begin_layout Standard
5347 These advantages are primarily due to the fact that the XHTML output routines,
5348 since they are part of \SpecialChar LyX
5349 , know everything \SpecialChar LyX
5350 knows about the document being
5355 \begin_layout Plain Layout
5356 Another advantage is that, since these routines are internal to \SpecialChar LyX
5358 immune to changes in \SpecialChar LyX
5359 's file format, or to changes in the semantics of
5365 So they know about the table of contents (as displayed in the outline),
5366 about the counters associated with different paragraph styles, and about
5367 user-defined styles.
5368 The XHTML output routines know what \SpecialChar LyX
5369 knows about internationalization,
5370 too, so they will output
5371 \begin_inset Quotes eld
5375 \begin_inset Quotes erd
5379 \begin_inset Quotes eld
5387 \begin_inset Quotes erd
5390 , depending upon the language in effect at the time.
5394 \begin_layout Standard
5395 Quite generally, the output routines know what \SpecialChar LyX
5396 knows about document layout,
5397 that is, about how the document is to be rendered on screen.
5398 We use this information when we output the document as XHTML.
5399 In particular, \SpecialChar LyX
5404 generates CSS style information corresponding to the layout information
5405 it uses to render the document on screen: if section headings are supposed
5406 to be sans-serif and bold as seen in \SpecialChar LyX
5407 , then (by default) they will be sans-seri
5408 f and bold when viewed in a web browser, too.
5409 And this is true not just for pre-defined styles, like Section, but for
5410 any style, including user-defined styles.
5411 Indeed, the XHTML output routines make no distinction between user-defined
5412 paragraph and character styles and \SpecialChar LyX
5413 's own pre-defined styles: in each case,
5414 everything \SpecialChar LyX
5415 knows about the styles is contained in the layout files.
5416 And much the same is true as regards pre-defined textual insets, such as
5417 footnotes, and various custom insets.
5421 \begin_layout Standard
5422 The result is that XHTML output can be customized and extended in exactly
5423 the same way \SpecialChar LaTeX
5424 output can be customized and extended: through layout files
5426 See chapter five of the
5430 manual for the details.
5433 \begin_layout Standard
5434 The remainder of this chapter contains more detailed information on XHTML
5435 output, its limitations, and ways to work around those limitations.
5438 \begin_layout Section
5439 Math Output in XHTML
5442 \begin_layout Standard
5444 offers four choices for how math is rendered.
5445 These have various advantages and disadvantages:
5448 \begin_layout Itemize
5450 \begin_inset Newline newline
5453 MathML is a dialect of XML designed specifically for mathematics on the
5454 web, and it typically renders very well in browsers that support it.
5455 The disadvantage is that not all browsers support MathML, and support is
5456 not complete even in the Gecko-based browsers, such as Firefox.
5457 \begin_inset Newline newline
5461 is unable to render a formula as MathML—for example, if the formula
5463 \begin_inset Flex Code
5466 \begin_layout Plain Layout
5472 package or ERT—then it will instead output the formula as an image.
5476 \begin_layout Itemize
5478 \begin_inset Newline newline
5482 \begin_inset Flex Code
5485 \begin_layout Plain Layout
5491 outputs math as HTML, styled by CSS.
5495 \begin_layout Plain Layout
5497 has borrowed some of the CSS for its HTML output from
5498 \begin_inset Flex Code
5501 \begin_layout Plain Layout
5512 For simple formulae, this can work quite well, though with more complicated
5513 formulae it tends to break down.
5514 Still, this method has the advantage that it is very widely supported and
5515 so it may be appropriate for documents that contain only a little, fairly
5517 \begin_inset Newline newline
5520 If Lyx is unable to render a formula as HTML—for example, if the formula
5522 \begin_inset Flex Code
5525 \begin_layout Plain Layout
5531 package or ERT—then it will instead output the formula as an image.
5535 \begin_layout Itemize
5537 \begin_inset Newline newline
5541 \begin_inset Flex Code
5544 \begin_layout Plain Layout
5551 will output formulae as images, the very same images, in fact, that are
5552 used for instant preview.
5556 \begin_layout Plain Layout
5557 Instant preview does
5561 have to be on for images to be output, however.
5566 The advantage to this method is that the images are simply generated by
5568 , so they are very accurate.
5569 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5570 so they do not scale terribly well, and one cannot copy them, etc.
5571 \begin_inset Newline newline
5574 The size of the images can be controlled by setting the
5575 \begin_inset Quotes eld
5579 \begin_inset Quotes erd
5583 \begin_inset Flex Noun
5586 \begin_layout Plain Layout
5587 Document\SpecialChar menuseparator
5588 Settings\SpecialChar menuseparator
5598 \begin_layout Plain Layout
5599 For those who want to know, this controls the resolution of the image in
5600 dots per inch and is based upon a default of 75 dpi.
5606 \begin_inset Newline newline
5610 for some reason fails to create an image for a formula (e.g., if a required
5612 package is not installed), then it will fall back to outputing the raw
5617 \begin_layout Itemize
5620 \begin_inset Newline newline
5623 Finally, \SpecialChar LyX
5624 will happily output math as \SpecialChar LaTeX
5626 As well as being the output of last resort, this method can be used with
5628 \begin_inset CommandInset href
5631 target "http://www.math.union.edu/~dpvc/jsMath/"
5636 , which uses JavaScript to render \SpecialChar LaTeX
5637 embedded in HTML documents.
5639 wraps the \SpecialChar LaTeX
5641 \begin_inset Flex Code
5644 \begin_layout Plain Layout
5650 (for inline formulas) or
5651 \begin_inset Flex Code
5654 \begin_layout Plain Layout
5660 (for displayed formulas) with
5661 \begin_inset Flex Code
5664 \begin_layout Plain Layout
5670 , as is required for jsMath.
5673 \begin_layout Standard
5674 One of these output methods must be selected under
5675 \begin_inset Flex Noun
5678 \begin_layout Plain Layout
5679 Document\SpecialChar menuseparator
5680 Settings\SpecialChar menuseparator
5687 By default, \SpecialChar LyX
5689 This is a document-wide setting, therefore.
5692 \begin_layout Standard
5693 Eventually, \SpecialChar LyX
5694 will offer the user the option to select an alternate output
5695 method for a particular inset, say, one that isn't being rendered very
5700 \begin_layout Plain Layout
5701 That said, since \SpecialChar LyX
5702 falls back to images if the inset contains ERT, then one
5703 can force output as an image by putting some harmless ERT into the math,
5705 \begin_inset Formula $a=b\relax$
5716 \begin_layout Section
5717 Bibliography and Citations
5720 \begin_layout Standard
5721 XHTML output fully supports bibliographies and citations.
5725 \begin_layout Standard
5726 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5728 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5731 If you are using numerical citations, then \SpecialChar LyX
5732 will output numerical labels,
5733 such as [1] or [17], rather than simply showing the citation key in square
5734 brackets, as it does on-screen.
5735 If you are using author-year citations, then \SpecialChar LyX
5736 will add lowercase letters
5737 to the years, just as Bib\SpecialChar TeX
5738 does, if it finds more than one citation for
5739 a given author-year combination.
5740 The labels will be printed with the bibliography entries.
5741 Note that there is, at present, no way to customize the appearance of the
5742 labels, for example, to choose between square brackets and parentheses.
5745 \begin_layout Standard
5746 Bibliography output is handled by the same machinery that handles the presentati
5747 on of reference information in the citation dialog, so you will see in the
5748 XHTML output pretty much what you would see if you were to look at a given
5749 entry in the citation dialog.
5750 The formatting can be customized in your layout file or, preferably, in
5756 manual for the details.
5759 \begin_layout Standard
5760 The main defect at present is that cross-referenced information is printed
5761 with every entry with which it is associated.
5762 So you can see things like this:
5767 \begin_inset Quotes eld
5770 Context and Logical Form
5771 \begin_inset Quotes erd
5776 Language in Context: Selected Essays
5778 (Oxford: Oxford University Press, 2007), pp.
5784 \begin_inset Quotes eld
5787 Semantics in Context
5788 \begin_inset Quotes erd
5793 Language in Context: Selected Essays
5795 (Oxford: Oxford University Press, 2007), pp.
5799 \begin_layout Standard
5800 This should be fixed before long.
5803 \begin_layout Standard
5804 There is no support at present for sectioned bibliographies.
5805 If you have multiple bibliographies, then \SpecialChar LyX
5806 will print the same bibliography
5810 \begin_layout Section
5814 \begin_layout Standard
5816 will happily export indexes as XHTML, but with certain limitations at the
5820 \begin_layout Standard
5821 Index export will be most reliable when you do not attempt to use the fancy
5822 constructs that are described in the section on indexes in the
5830 \begin_layout Plain Layout
5831 The main issue here is that \SpecialChar LyX
5832 itself does not really handle these.
5833 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5839 We'll describe how they are handled using the subsection headings from
5843 \begin_layout Itemize
5844 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5845 makes an effort to support these,
5846 but the entries must be separated by
5847 \begin_inset Quotes eld
5851 \begin_inset Quotes erd
5854 , that is, there must be spaces around the exclamation point.
5855 This is because it is otherwise too difficult to check for escaped exclamation
5856 points, ones in math, and so forth.
5859 \begin_layout Itemize
5860 Page Ranges: There is no support at all for page ranges, since these make
5861 no sense with XHMTL.
5862 Instead, you will just get two index entries, one at either end.
5865 \begin_layout Itemize
5866 Cross-referencing: There is no support for cross-referencing.
5868 finds an entry containing the
5869 \begin_inset Quotes eld
5872 |see\SpecialChar ldots
5874 \begin_inset Quotes erd
5877 construct, it is just dropped, and the rest is treated as an ordinary index
5881 \begin_layout Itemize
5882 Index Entry Order: \SpecialChar LyX
5883 does support attempts to fix the sorting order.
5884 It will take what is before the first `@' it finds and use that for sorting,
5885 taking what follows the first `@' to be the actual entry.
5886 At present, \SpecialChar LyX
5887 does not check for escaped `@', so do not try to index email
5891 \begin_layout Itemize
5892 Index Entry Layout: You can format entries by using the text style dialog,
5893 or by using any other method available within \SpecialChar LyX
5895 There is no support for constructs like:
5896 \begin_inset Quotes eld
5900 \begin_inset Quotes erd
5904 Indeed, if \SpecialChar LyX
5905 finds a pipe symbol, `|', in an entry, it will delete it and
5906 everything that follows it.
5909 \begin_layout Itemize
5910 Multiple Indexes: There is no support for multiple indexes.
5911 Rather, all index entries will be printed as one large index.
5912 To avoid our printing several versions of the index, we print only the
5913 main index, so make sure you have one.
5916 \begin_layout Section
5917 Nomenclature and Glossary
5920 \begin_layout Standard
5921 There is at present no support for glossaries.
5922 Adding it would be fairly trivial, and welcome.
5925 \begin_layout Chapter
5926 The \SpecialChar LyX
5930 \begin_layout Section
5934 \begin_layout Standard
5935 The `\SpecialChar LyX
5936 server' allows other programs to talk to \SpecialChar LyX
5937 , invoke \SpecialChar LyX
5938 commands, and retrieve
5939 information about the \SpecialChar LyX
5941 This is only intended for advanced users, but they should find it useful.
5942 It is by writing to the \SpecialChar LyX
5943 server, for example, that bibliography managers,
5944 such as JabRef, are able to
5945 \begin_inset Quotes eld
5949 \begin_inset Quotes erd
5952 citations to \SpecialChar LyX
5956 \begin_layout Section
5957 Starting the \SpecialChar LyX
5959 \begin_inset CommandInset label
5961 name "sec:Starting-the-Server"
5968 \begin_layout Standard
5969 The \SpecialChar LyX
5970 server works through the use of a pair of named pipes.
5971 These are usually located in
5972 \begin_inset Flex Code
5975 \begin_layout Plain Layout
5981 , (except on Windows, where
5985 named pipes are special objects located in
5986 \begin_inset Flex Code
5989 \begin_layout Plain Layout
6001 ) and have the names
6002 \begin_inset Quotes eld
6006 \begin_inset Flex Code
6009 \begin_layout Plain Layout
6016 \begin_inset Quotes erd
6020 \begin_inset Quotes eld
6024 \begin_inset Flex Code
6027 \begin_layout Plain Layout
6034 \begin_inset Quotes erd
6038 External programs write into
6039 \begin_inset Flex Code
6042 \begin_layout Plain Layout
6048 and read back data from
6049 \begin_inset Flex Code
6052 \begin_layout Plain Layout
6059 The stem of the pipe names can be defined in the
6060 \begin_inset Flex Noun
6063 \begin_layout Plain Layout
6064 Tools\SpecialChar menuseparator
6071 \begin_inset Flex Code
6074 \begin_layout Plain Layout
6075 "/home/myhome/lyxpipe"
6081 \begin_inset Flex Code
6084 \begin_layout Plain Layout
6098 on Windows (where any working path instead of lyxpipe can be used, for
6100 \begin_inset Flex Code
6103 \begin_layout Plain Layout
6126 configure this manually in order for the server to start.
6129 \begin_layout Standard
6132 \begin_inset Flex Code
6135 \begin_layout Plain Layout
6142 \begin_inset Flex Code
6145 \begin_layout Plain Layout
6151 ' to create the pipes.
6152 If one of the pipes already exists, \SpecialChar LyX
6153 will assume that another \SpecialChar LyX
6155 is already running and will not start the server.
6156 On POSIX (Unix like) systems, if for some other reason, an unused
6157 \begin_inset Quotes eld
6161 \begin_inset Quotes erd
6164 pipe is left in existence when \SpecialChar LyX
6165 closes, then \SpecialChar LyX
6166 will try to delete it.
6167 If this fails for some reason, you will need to delete the pipes manually
6168 and then restart \SpecialChar LyX
6170 On Windows, pipes are deleted by the OS on program termination or crash,
6172 \begin_inset Quotes eld
6176 \begin_inset Quotes erd
6179 pipes should not be possible.
6182 \begin_layout Standard
6183 To have several \SpecialChar LyX
6184 processes with servers at the same time, you have to use
6185 different configurations, perhaps by using separate user directories, each
6187 \begin_inset Flex Code
6190 \begin_layout Plain Layout
6196 file, for each process.
6199 \begin_layout Standard
6200 If you are developing a client program, you might find it useful to enable
6201 debugging information from the \SpecialChar LyX
6203 Do this by starting \SpecialChar LyX
6205 \begin_inset Flex Code
6208 \begin_layout Plain Layout
6217 \begin_layout Standard
6218 You can find a complete example client written in C++ in the source distribution
6220 \begin_inset Flex Code
6223 \begin_layout Plain Layout
6224 development/lyxserver/server_monitor.cpp
6232 \begin_layout Standard
6233 Another useful tool is the command-line based client found in
6234 \begin_inset Flex Code
6237 \begin_layout Plain Layout
6238 src/client/lyxclient
6246 \begin_layout Section
6247 Normal communication
6250 \begin_layout Standard
6251 To issue a \SpecialChar LyX
6252 call, the client writes a line of ASCII text into the input
6254 This line has the following format:
6271 \begin_layout Description
6272 clientname is a name that the client can choose arbitrarily.
6273 Its only use is that \SpecialChar LyX
6274 will echo it if it sends an answer—so a client can
6275 dispatch results from different requesters.
6278 \begin_layout Description
6279 function is the function you want \SpecialChar LyX
6281 It is the same as the commands you'd use in the minibuffer.
6284 \begin_layout Description
6285 argument is an optional argument which is meaningful only to some functions
6287 \begin_inset Quotes eld
6291 \begin_inset Quotes erd
6294 LFUN will insert the argument as text at the cursor position).
6297 \begin_layout Standard
6298 The answer from \SpecialChar LyX
6299 will arrive in the output pipe and be of the form
6316 \begin_layout Standard
6325 are just echoed from the command request, while
6329 is more or less useful information filled according to how the command
6330 execution worked out.
6331 Some commands, such as
6332 \begin_inset Quotes eld
6336 \begin_inset Quotes erd
6339 , will return information about the internal state of \SpecialChar LyX
6341 return an empty data-response.
6342 This means that the command execution went fine.
6345 \begin_layout Standard
6346 In case of errors, the response from \SpecialChar LyX
6364 \begin_layout Standard
6369 should contain an explanation of why the command failed.
6372 \begin_layout Standard
6376 \begin_layout LyX-Code
6377 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6378 \begin_inset Newline newline
6381 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6382 \begin_inset Newline newline
6385 read a <~/.lyxpipe.out
6386 \begin_inset Newline newline
6392 \begin_layout Subsection
6393 AppleScript (Mac OS X)
6396 \begin_layout Standard
6397 Since \SpecialChar LyX
6398 2.1, \SpecialChar LyX
6399 supports basic interactions with AppleScript for normal communicatio
6400 n through the command run.
6401 This command takes a direct argument (the
6405 to perform) and an optional argument.
6406 It either returns the output of the function or triggers an error with
6407 the error message and code.
6410 \begin_layout Standard
6414 \begin_layout LyX-Code
6415 tell application "\SpecialChar LyX
6419 \begin_layout LyX-Code
6423 \begin_layout LyX-Code
6424 -- Stores the current file name into f
6427 \begin_layout LyX-Code
6428 set f to (run "server-get-filename" with argument "")
6431 \begin_layout LyX-Code
6432 on error the error_message number the error_number
6435 \begin_layout LyX-Code
6436 display dialog "Error: " & the error_number & ".
6440 \begin_layout LyX-Code
6441 & the error_message buttons {"OK"} default button 1
6444 \begin_layout LyX-Code
6448 \begin_layout LyX-Code
6452 \begin_layout Section
6456 \begin_layout Standard
6458 can notify clients of events going on asynchronously.
6459 Currently it will only do this if the user binds a key sequence with the
6461 \begin_inset Quotes eld
6465 \begin_inset Quotes erd
6469 The format of the string \SpecialChar LyX
6470 sends is as follows:
6474 \begin_inset Flex Code
6477 \begin_layout Plain Layout
6488 \begin_layout Standard
6493 is the printed representation of the key sequence that was actually typed
6497 \begin_layout Standard
6498 This mechanism can be used to extend \SpecialChar LyX
6499 's command set and implement macros.
6500 Bind some key sequence to
6501 \begin_inset Quotes eld
6505 \begin_inset Quotes erd
6509 Then start a client that listens on the output pipe, dispatches the command
6510 according to the sequence, and starts a function that may use \SpecialChar LyX
6513 requests to issue a command or a series of commands to \SpecialChar LyX
6517 \begin_layout Section
6518 The simple \SpecialChar LyX
6522 \begin_layout Standard
6524 implements a simple protocol that can be used for session management.
6525 All messages are of the form
6538 \begin_layout Standard
6544 \begin_inset Quotes eld
6548 \begin_inset Quotes erd
6552 \begin_inset Quotes eld
6556 \begin_inset Quotes erd
6561 \begin_inset Quotes eld
6565 \begin_inset Quotes erd
6568 is received from a client, \SpecialChar LyX
6569 will report back to inform the client that
6570 it's listening to it's messages, while
6571 \begin_inset Quotes eld
6575 \begin_inset Quotes erd
6578 sent from \SpecialChar LyX
6579 will inform clients that \SpecialChar LyX
6583 \begin_layout Section
6584 Reverse DVI/PDF search
6587 \begin_layout Standard
6588 Some DVI/PDF viewers
6592 \begin_layout Plain Layout
6593 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6594 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6603 facility (also called
6608 This means that you can tell \SpecialChar LyX
6609 to put the cursor to a specific line in the
6610 document by clicking at the respective position in the DVI/PDF output.
6611 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6613 This is done via the \SpecialChar LyX
6614 server either by using the named pipe (
6618 ), or the UNIX domain socket (
6622 ) that \SpecialChar LyX
6623 creates in its temporary directory (this is the way the
6624 \begin_inset Flex Code
6627 \begin_layout Plain Layout
6633 program communicates with \SpecialChar LyX
6635 In some cases, you need a helper script that mediates between the viewer
6636 and \SpecialChar LyX
6637 , in others, the viewer can communicate with \SpecialChar LyX
6639 This depends on the selected viewer and on your operating system.
6640 The same applies to the way viewers need to be configured and the way the
6641 reverse search is actually performed.
6642 In what follows, we will thus describe how to setup reverse search for
6644 Before we turn to this, though, we will explain what needs to be done generally
6645 to enable reverse search in the DVI/PDF output.
6648 \begin_layout Subsection
6650 \begin_inset CommandInset label
6652 name "subsec:rev-search"
6659 \begin_layout Standard
6660 In most cases \SpecialChar LyX
6661 will do the work for you by pressing the following button
6665 arg "buffer-toggle-output-sync"
6669 Alternatively, you can also enable the feature by checking
6671 Synchronize with Output
6674 \begin_inset Flex Noun
6677 \begin_layout Plain Layout
6678 Document\SpecialChar menuseparator
6679 Settings\SpecialChar menuseparator
6686 In such a case \SpecialChar LyX
6687 will automatically insert the necessary Sync\SpecialChar TeX
6689 PDF) or load the srcltx package (for DVI) respectively.
6690 This option can be easily reached also on
6691 \begin_inset Flex Code
6694 \begin_layout Plain Layout
6703 \begin_layout Standard
6704 If you need a different setting, you can select or input a custom macro
6705 from the drop down box just below
6706 \begin_inset Flex Noun
6709 \begin_layout Plain Layout
6710 Document\SpecialChar menuseparator
6711 Settings\SpecialChar menuseparator
6712 Output\SpecialChar menuseparator
6713 Synchronize with Output
6721 \begin_layout Standard
6722 Note that the method
6723 \begin_inset Flex Code
6726 \begin_layout Plain Layout
6734 enables gzip compression.
6735 If your viewer does not support it, you should instead use
6736 \begin_inset Flex Code
6739 \begin_layout Plain Layout
6750 \begin_layout Standard
6751 Please also note that including the
6752 \begin_inset Flex Code
6755 \begin_layout Plain Layout
6762 \begin_inset Flex Code
6765 \begin_layout Plain Layout
6771 sometimes has an undesired impact on the typesetting.
6772 Thus, you should switch output synchronization off for the final typesetting
6774 \begin_inset Flex Code
6777 \begin_layout Plain Layout
6784 \begin_inset Flex Code
6787 \begin_layout Plain Layout
6797 \begin_layout Standard
6798 In case you need some more special settings that are not covered by the
6799 automatic settings, read the next section about how to set up output synchroniz
6801 If the automatic setup suits your needs, you can readily jump to section
6802 \begin_inset space ~
6806 \begin_inset CommandInset ref
6808 reference "subsec:configuring-viewers"
6812 , where the necessary configuration steps in your viewer – needed both with
6813 the automatic and the manual setup – are described.
6816 \begin_layout Subsection
6820 \begin_layout Standard
6822 provides several different methods for reverse search.
6823 Some are built-in in the
6824 \begin_inset Flex Code
6827 \begin_layout Plain Layout
6833 program, some are provided by external packages.
6834 Your choice depends on whether your \SpecialChar LaTeX
6835 distribution already provides a given
6836 method (the built-in methods are rather new) and whether your viewer can
6838 The available methods are described in the following.
6841 \begin_layout Subsubsection*
6842 Built-in DVI-search via src-specials (DVI only)
6845 \begin_layout Standard
6846 This method provides the DVI file with the necessary information for reverse
6848 It is available in \SpecialChar LaTeX
6849 since quite some time (any somewhat recent \SpecialChar LaTeX
6851 should include it), and it works reliably.
6852 To enable it, change the
6853 \begin_inset Flex Noun
6856 \begin_layout Plain Layout
6867 \begin_inset Flex Noun
6870 \begin_layout Plain Layout
6881 \begin_inset Flex Noun
6884 \begin_layout Plain Layout
6885 Preferences\SpecialChar menuseparator
6886 File Handling\SpecialChar menuseparator
6893 \begin_inset Flex Code
6896 \begin_layout Plain Layout
6897 latex -src-specials $$i
6903 If this doesn't work, check if your \SpecialChar TeX
6904 engine needs different options (the
6905 syntax might differ in some distributions).
6908 \begin_layout Subsubsection*
6909 External Packages (PDFSync and scrltx)
6912 \begin_layout Standard
6921 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6923 In order to enable it, load the packages in the \SpecialChar LyX
6927 \begin_layout Itemize
6928 \begin_inset Flex Code
6931 \begin_layout Plain Layout
6939 for reverse PDF search,
6942 \begin_layout Itemize
6943 \begin_inset Flex Code
6946 \begin_layout Plain Layout
6949 usepackage[active]{srcltx}
6954 for reverse DVI search.
6957 \begin_layout Standard
6958 If you want to be able to perform both DVI and PDF reverse searches, you
6959 can also insert in the preamble the following lines
6962 \begin_layout LyX-Code
6966 \begin_inset Newline newline
6972 \begin_inset Newline newline
6978 \begin_inset Newline newline
6984 \begin_inset Newline newline
6989 usepackage[active]{srcltx}
6990 \begin_inset Newline newline
6998 \begin_layout Standard
6999 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7000 right package will be used.
7003 \begin_layout Standard
7004 Note that PDFSync might affect the output layout of your document.
7005 It is therefore advised to disable PDFsync for final documents.
7008 \begin_layout Subsubsection*
7009 Built-in reverse search via Sync\SpecialChar TeX
7013 \begin_layout Standard
7015 \begin_inset Flex Code
7018 \begin_layout Plain Layout
7024 have built-in support for both PDF and DVI reverse search.
7027 Sync\SpecialChar TeX
7030 facility is basically the result of the integration of the PDFSync package
7031 to the pdftex program and its merge with the
7036 You need at least \SpecialChar TeX
7037 Live 2008 or a recent Mik\SpecialChar TeX
7038 distribution in order to use
7043 \begin_layout Plain Layout
7044 For some reason, Mik\SpecialChar TeX
7045 does not understand/obey the command \SpecialChar LyX
7047 the preamble when you check the "Enable Forward/Reverse Search" button
7048 in the toolbar and does not generate the necessary info.
7051 \begin_layout Plain Layout
7052 The generation of the required info can be forced by changing the converter
7054 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7055 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7056 the -synctex=1 switch).
7061 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
7062 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
7063 already provide Sync\SpecialChar TeX
7067 \begin_layout Standard
7068 To enable Sync\SpecialChar TeX
7069 for DVI output, change the
7070 \begin_inset Flex Noun
7073 \begin_layout Plain Layout
7084 \begin_inset Flex Noun
7087 \begin_layout Plain Layout
7098 \begin_inset Flex Noun
7101 \begin_layout Plain Layout
7102 Preferences\SpecialChar menuseparator
7103 File Handling\SpecialChar menuseparator
7110 \begin_inset Flex Code
7113 \begin_layout Plain Layout
7114 latex -synctex=1 $$i
7119 , and for PDF output, change the
7120 \begin_inset Flex Noun
7123 \begin_layout Plain Layout
7128 (pdflatex) -> PDF (pdflatex)
7134 \begin_inset Flex Code
7137 \begin_layout Plain Layout
7138 pdflatex -synctex=1 $$i
7144 Should your viewer not be considered in the following description, or in
7145 case of missing success, please check the documentation of your viewer
7146 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
7151 \begin_layout Plain Layout
7152 Note that the option
7153 \begin_inset Flex Code
7156 \begin_layout Plain Layout
7162 option enables gzip compression.
7163 If your viewer does not support it, you should instead use
7164 \begin_inset Flex Code
7167 \begin_layout Plain Layout
7181 \begin_layout Subsection
7182 Configuring and using specific viewers
7183 \begin_inset CommandInset label
7185 name "subsec:configuring-viewers"
7192 \begin_layout Subsubsection*
7193 Xdvi (all platforms)
7196 \begin_layout Standard
7198 \begin_inset Flex Code
7201 \begin_layout Plain Layout
7207 , you don't need to do anything else for performing a reverse DVI search,
7209 already provides the necessary hooks for automatically using the
7210 \begin_inset Flex Code
7213 \begin_layout Plain Layout
7220 Just setup your document as described above (reverse search is triggered
7221 by Ctrl-click or Alt-click on Mac OSX, respectively).
7224 \begin_layout Standard
7225 However, if for whatever reason you want to use the named pipe instead of
7226 the socket for communicating with \SpecialChar LyX
7227 , simply change the DVI viewer in
7228 \begin_inset Flex Noun
7231 \begin_layout Plain Layout
7232 Preferences\SpecialChar menuseparator
7233 File Handling\SpecialChar menuseparator
7243 \begin_layout Plain Layout
7244 On Mac OSX you have to use
7245 \begin_inset Flex Code
7248 \begin_layout Plain Layout
7249 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7260 \begin_inset Flex Code
7263 \begin_layout Plain Layout
7264 xdvi -editor "lyxeditor.sh %f %l"
7270 \begin_inset Flex Code
7273 \begin_layout Plain Layout
7279 is a suitable script.
7280 For example, a minimal shell script is the following one:
7283 \begin_layout LyX-Code
7285 \begin_inset Newline newline
7288 LYXPIPE="/path/to/lyxpipe"
7289 \begin_inset Newline newline
7292 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7293 \begin_inset Newline newline
7296 echo "$COMMAND" > "${LYXPIPE}".in || exit
7297 \begin_inset Newline newline
7300 read TMP < "${LYXPIPE}".out || exit
7303 \begin_layout Standard
7305 \begin_inset Flex Code
7308 \begin_layout Plain Layout
7314 is the LyXServer pipe path specified in
7315 \begin_inset Flex Noun
7318 \begin_layout Plain Layout
7319 Preferences\SpecialChar menuseparator
7329 \begin_layout Plain Layout
7331 \begin_inset Flex Code
7334 \begin_layout Plain Layout
7340 folder of a source distribution you can find a
7341 \begin_inset Flex Code
7344 \begin_layout Plain Layout
7350 script which is able to locate the
7354 based on your preferences.
7362 \begin_layout Subsubsection*
7366 \begin_layout Standard
7368 \begin_inset Flex Code
7371 \begin_layout Plain Layout
7372 /Applications/MacDviX_Folder/calleditor.script
7377 , add the following lines:
7380 \begin_layout LyX-Code
7381 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7382 \begin_inset Newline newline
7388 \begin_layout Standard
7389 Modify the lines accordingly if you install \SpecialChar LyX
7390 somewhere else than in the
7391 Applications folder.
7394 \begin_layout Standard
7395 Reverse search is triggered by Alt-click (OPTION-click).
7398 \begin_layout Subsubsection*
7402 \begin_layout Standard
7404 \begin_inset Flex Code
7407 \begin_layout Plain Layout
7408 open -a Skim.app $$i
7413 to the viewer setting in
7414 \begin_inset Flex Noun
7417 \begin_layout Plain Layout
7418 Preferences\SpecialChar menuseparator
7419 File Handling\SpecialChar menuseparator
7420 File formats\SpecialChar menuseparator
7427 \begin_inset Flex Noun
7430 \begin_layout Plain Layout
7431 Skim\SpecialChar menuseparator
7432 Preferences\SpecialChar menuseparator
7439 \begin_inset Flex Noun
7442 \begin_layout Plain Layout
7448 preset and enter command
7449 \begin_inset Flex Noun
7452 \begin_layout Plain Layout
7453 /Applications/\SpecialChar LyX
7454 .app/Contents/MacOS/lyxeditor
7462 \begin_layout Standard
7463 Reverse search is triggered by COMMAND-SHIFT-click
7466 \begin_layout Subsubsection*
7470 \begin_layout Standard
7471 Reverse search with evince does not work out of the box, but it can be achieved
7472 by means of some third party helper scripts.
7474 \begin_inset CommandInset href
7476 target "https://wiki.lyx.org/LyX/SyncTeX"
7484 \begin_layout Subsubsection*
7488 \begin_layout Standard
7490 \begin_inset Flex Noun
7493 \begin_layout Plain Layout
7494 Settings\SpecialChar menuseparator
7495 Configure Okular\SpecialChar menuseparator
7502 \begin_inset Quotes erd
7506 This inserts the appropriate command (
7507 \begin_inset Flex Code
7510 \begin_layout Plain Layout
7519 \begin_layout Standard
7520 Reverse search is triggered by SHIFT-click.
7523 \begin_layout Subsubsection*
7527 \begin_layout Standard
7528 Qpdfview supports Sync\SpecialChar TeX
7529 since version 0.3.5.
7531 \begin_inset Flex Noun
7534 \begin_layout Plain Layout
7535 Edit\SpecialChar menuseparator
7536 Settings\SpecialChar menuseparator
7542 , click on the input field of the
7543 \begin_inset Quotes eld
7547 \begin_inset Quotes erd
7550 item and add the command
7551 \begin_inset Flex Code
7554 \begin_layout Plain Layout
7563 \begin_layout Standard
7564 Reverse search is triggered by double-click or, in more recent versions,
7568 \begin_layout Subsubsection*
7572 \begin_layout Standard
7573 Launch yap, choose its
7574 \begin_inset Flex Noun
7577 \begin_layout Plain Layout
7578 View\SpecialChar menuseparator
7585 \begin_inset Quotes eld
7589 \begin_inset Quotes erd
7594 \begin_inset Quotes eld
7597 New\SpecialChar ldots
7599 \begin_inset Quotes erd
7602 button and, in the window that opens, enter
7603 \begin_inset Quotes eld
7608 \begin_inset Quotes erd
7611 (or any other name you like) in the
7612 \begin_inset Quotes eld
7616 \begin_inset Quotes erd
7620 Now click on the button labeled
7621 \begin_inset Quotes eld
7626 \begin_inset Quotes erd
7629 to open a file dialog and navigate to the directory containing the batch
7631 \begin_inset Flex Code
7634 \begin_layout Plain Layout
7642 \begin_inset Flex Code
7645 \begin_layout Plain Layout
7651 and then specify the program arguments as
7652 \begin_inset Flex Code
7655 \begin_layout Plain Layout
7663 \begin_inset Flex Code
7666 \begin_layout Plain Layout
7672 wrapper is used for communicating with \SpecialChar LyX
7680 \begin_layout LyX-Code
7682 \begin_inset Newline newline
7685 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
7694 \begin_inset Newline newline
7708 \begin_layout Standard
7709 Make sure that the \SpecialChar LyX
7710 Server pipe path you specified in \SpecialChar LyX
7712 \begin_inset Flex Code
7715 \begin_layout Plain Layout
7729 , otherwise change the
7730 \begin_inset Flex Code
7733 \begin_layout Plain Layout
7739 wrapper accordingly.
7742 \begin_layout Standard
7743 In yap, reverse search is triggered by double-click.
7746 \begin_layout Subsubsection*
7747 SumatraPDF (Windows)
7750 \begin_layout Standard
7751 In order to use SumatraPDF for inverse search, enter
7752 \begin_inset Flex Code
7755 \begin_layout Plain Layout
7756 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
7761 in the viewer setting in
7762 \begin_inset Flex Noun
7765 \begin_layout Plain Layout
7766 Preferences\SpecialChar menuseparator
7767 File Handling\SpecialChar menuseparator
7768 File formats\SpecialChar menuseparator
7775 \begin_inset Flex Code
7778 \begin_layout Plain Layout
7784 is the previous wrapper.
7785 If SumatraPDF.exe is not in your command PATH, use its full file name.
7788 \begin_layout Standard
7789 Reverse search is triggered by double-click.
7792 \begin_layout Subsubsection*
7796 \begin_layout Standard
7797 First of all, make sure that yap is your default DVI viewer in the Windows
7798 environment, then launch it, choose its
7799 \begin_inset Flex Noun
7802 \begin_layout Plain Layout
7803 View\SpecialChar menuseparator
7810 \begin_inset Quotes eld
7814 \begin_inset Quotes erd
7819 \begin_inset Quotes eld
7822 New\SpecialChar ldots
7824 \begin_inset Quotes erd
7827 button and, in the window that opens, enter
7828 \begin_inset Quotes eld
7833 \begin_inset Quotes erd
7836 (or any other name you like) in the
7837 \begin_inset Quotes eld
7841 \begin_inset Quotes erd
7845 Now click on the button labeled
7846 \begin_inset Quotes eld
7851 \begin_inset Quotes erd
7854 to open a file dialog and navigate to the directory containing the
7855 \begin_inset Flex Code
7858 \begin_layout Plain Layout
7864 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7867 \begin_inset Flex Code
7870 \begin_layout Plain Layout
7876 and then specify the program arguments as
7877 \begin_inset Flex Code
7880 \begin_layout Plain Layout
7887 In this way, you will be using the
7891 for communicating with \SpecialChar LyX
7893 If, for whatever reason, you want to use the
7898 \begin_inset Flex Code
7901 \begin_layout Plain Layout
7907 option and be sure to specify the \SpecialChar LyX
7908 Server pipe path in the \SpecialChar LyX
7912 \begin_layout Standard
7913 In yap, reverse search is triggered by double-click.
7916 \begin_layout Subsubsection*
7920 \begin_layout Standard
7921 In order to use SumatraPDF for inverse search, enter
7922 \begin_inset Flex Code
7925 \begin_layout Plain Layout
7926 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7931 in the viewer setting in
7932 \begin_inset Flex Noun
7935 \begin_layout Plain Layout
7936 Preferences\SpecialChar menuseparator
7937 File Handling\SpecialChar menuseparator
7938 File formats\SpecialChar menuseparator
7945 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7947 \begin_inset Flex Code
7950 \begin_layout Plain Layout
7956 enables communication via the
7962 \begin_inset Flex Code
7965 \begin_layout Plain Layout
7971 option if you want to use the
7975 , and be sure to specify the \SpecialChar LyX
7976 Server pipe path in the \SpecialChar LyX
7980 \begin_layout Standard
7981 Reverse search is triggered by double-click.
7984 \begin_layout Section
7988 \begin_layout Standard
7989 Forward search is, as the name implies, in a sense the
7990 \begin_inset Quotes eld
7994 \begin_inset Quotes erd
7998 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8000 If forward search is set up (as described in what follows), you can put
8001 the cursor anywhere in your \SpecialChar LyX
8003 \begin_inset Flex Noun
8006 \begin_layout Plain Layout
8007 Navigate\SpecialChar menuseparator
8014 \begin_inset Flex Noun
8017 \begin_layout Plain Layout
8023 in the context menu via right mouse click), and then the viewer will jump
8024 to that position as well.
8025 This implies, of course, that your viewer supports this function.
8028 \begin_layout Standard
8029 To make forward search possible, you first need to provide the generated
8030 output PDF/DVI file with additional information about the \SpecialChar TeX
8032 This can be done via the methods described in the section
8033 \begin_inset CommandInset ref
8035 reference "subsec:rev-search"
8042 \begin_layout Standard
8043 Additionally, you need to configure \SpecialChar LyX
8044 for using your viewers in
8045 \begin_inset Flex Noun
8048 \begin_layout Plain Layout
8049 Tools\SpecialChar menuseparator
8050 Preferences\SpecialChar menuseparator
8051 Output\SpecialChar menuseparator
8058 We provide a range of tested configurations for some viewers, which you
8059 can select from the drop down list.
8060 If none of these configurations suits you, you have to find out and enter
8061 a suitable configuration yourself.
8062 The definition syntax uses the following placeholders:
8065 \begin_layout Itemize
8067 \begin_inset Flex Code
8070 \begin_layout Plain Layout
8079 \begin_layout Itemize
8081 \begin_inset Flex Code
8084 \begin_layout Plain Layout
8090 : name of the (temporary) exported .tex file (without path)
8093 \begin_layout Itemize
8095 \begin_inset Flex Code
8098 \begin_layout Plain Layout
8104 : name of the (temporary) exported .tex file (including path)
8107 \begin_layout Itemize
8109 \begin_inset Flex Code
8112 \begin_layout Plain Layout
8118 : name of the exported output file (either dvi or pdf, depending on which
8119 one exists in the temporary directory)
8122 \begin_layout Standard
8123 Note that only some of the viewers provide full and usable forward search
8124 functionality out of the box, among them yap, xdvi, okular
8128 \begin_layout Plain Layout
8129 You might want to set
8130 \begin_inset Flex Code
8133 \begin_layout Plain Layout
8140 \begin_inset Flex Noun
8143 \begin_layout Plain Layout
8144 Tools\SpecialChar menuseparator
8145 Preferences\SpecialChar menuseparator
8146 File Handling\SpecialChar menuseparator
8148 \begin_inset space ~
8161 , qpdfview, and SumatraPDF
8165 \begin_layout Plain Layout
8166 SumatraPDF can also use DDE commands through the external program CMCDDE
8167 — downloadable from
8168 \begin_inset CommandInset href
8170 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8181 Others, such as evince
8185 \begin_layout Plain Layout
8186 Forward search with evince can be achieved by means of third party helper
8189 \begin_inset CommandInset href
8191 target "https://wiki.lyx.org/LyX/SyncTeX"
8201 , require some extra tools in order to use forward search.
8202 While many of the widespread PDF viewers (most notably Adobe Reader) do
8203 not support forward search at all, some other viewers – e.
8204 \begin_inset space \thinspace{}
8208 xpdf – allow at least to reload the document and jump to a specific page
8209 of the file, so you can at least navigate
8210 \begin_inset Quotes eld
8214 \begin_inset Quotes erd
8218 This latter functionality is provided by an external call of synctex (see
8219 the predefined example configurations).
8223 \begin_layout Standard
8224 Forward search works both with DVI and PDF output.
8226 simply checks which preview format you have used before (i.
8227 \begin_inset space \thinspace{}
8230 e., which format is already there in the temporary directory) and chooses
8231 the appropriate configuration for the respective format.
8234 \begin_layout Chapter
8235 Special Document Classes
8238 \begin_layout Section
8242 \begin_layout Standard
8248 \begin_layout Subsection
8252 \begin_layout Standard
8253 This section describes how \SpecialChar LyX
8254 can be used to write articles for submission
8255 to the scientific journal
8257 Astronomy and Astrophysics
8260 \begin_inset Flex URL
8263 \begin_layout Plain Layout
8265 https://www.aanda.org/
8270 ) using Version 5.01 of the document class
8275 This package can be downloaded from the ftp site
8278 \begin_layout Standard
8279 \begin_inset VSpace medskip
8285 \begin_layout Standard
8287 \begin_inset Flex URL
8290 \begin_layout Plain Layout
8292 ftp://ftp.edpsciences.org/pub/aa/readme.html
8300 \begin_layout Standard
8301 \begin_inset VSpace medskip
8307 \begin_layout Standard
8308 A manual comes together with that package, and this text is not meant to
8309 replace the original manual but is merely a short guide in how to realize
8310 the correct form of your paper.
8314 \begin_layout Standard
8315 Please note that the publisher of the journal was changed from Springer
8316 to EDP Sciences starting January 1, 2001.
8317 That change involved also some slight changes to the style files, namely
8318 the removal of the thesaurus command.
8319 The \SpecialChar LyX
8320 class aa supports the newest version of these style files, V 5.01.
8321 If you have an older version installed, please upgrade.
8322 For compatibility, the old (version 4) layout has been kept as
8327 Please refer to the comments in
8330 Dir/layouts/aapaper.layout
8335 \begin_layout Subsection
8339 \begin_layout Standard
8340 It is recommended you start from the example template distributed with \SpecialChar LyX
8342 If you are not using a template, note the following settings:
8345 \begin_layout Itemize
8352 Document\SpecialChar menuseparator
8355 dialog (OK, that one was obvious).
8358 \begin_layout Itemize
8359 Don't change the option
8362 \begin_inset space ~
8372 The whole layout is done by the macros, you shouldn't change anything.
8375 \begin_layout Subsection
8379 \begin_layout Standard
8380 First thing to enter is the header information.
8381 It consists of seven entries, of which some are optional.
8385 \begin_layout Itemize
8393 \begin_layout Itemize
8401 \begin_layout Itemize
8409 \begin_layout Itemize
8417 \begin_layout Itemize
8422 : [optional] if more than one author: whom to contact for offprint requests.
8425 \begin_layout Itemize
8430 : [optional] mail address for contacts.
8433 \begin_layout Itemize
8441 Received: <date>; Accepted <date>
8444 \begin_layout Standard
8445 There is no need to issue the
8451 command, this is done automatically by \SpecialChar LyX
8452 when the header is finished.
8453 Although the order of the single header entries doesn't matter it is advised
8454 to keep the above sequence, just to get the best optics and meets the layout
8455 of the real document.
8458 \begin_layout Standard
8459 If you want to place footnotes in the header block, e.
8460 \begin_inset space \thinspace{}
8464 \begin_inset space \space{}
8467 to state your present address, just use the standard footnote via the menu
8470 Insert\SpecialChar menuseparator
8475 will automagically use the term
8484 \begin_layout Standard
8487 Edit\SpecialChar menuseparator
8490 , you'll find two insets which are relevant for the titling:
8493 \begin_layout Itemize
8500 to mark corresponding author\SpecialChar breakableslash
8502 The institutes are numbered sequentially as they appear in the
8506 field, so you have to put a marker to each author.
8509 \begin_layout Itemize
8514 to supply an email address for fast contact.
8517 \begin_layout Standard
8518 In addition to these topics, the macros use one additional \SpecialChar LaTeX
8520 has no counterpart in \SpecialChar LyX
8524 \begin_layout Itemize
8531 to separate different names for more than one author and institute, respectivel
8535 \begin_layout Standard
8536 The appropriate command has to be entered in \SpecialChar LyX
8537 and marked as \SpecialChar LaTeX
8543 \begin_layout Subsection
8547 \begin_layout Standard
8548 The abstract should immediately follow the header block.
8549 With version 5 the abstract environment was changed to a command, and there
8550 is now a restriction to only one paragraph.
8551 In addition, it should contain an entry with the keywords.
8552 This is done via the paragraph style
8557 Refer to the example paper.
8560 \begin_layout Subsection
8561 Supported environments
8564 \begin_layout Standard
8565 The A&A paper layout supports the following environments for structuring
8569 \begin_layout Itemize
8575 \begin_layout Itemize
8581 \begin_layout Itemize
8587 \begin_layout Itemize
8593 \begin_layout Itemize
8599 \begin_layout Itemize
8605 \begin_layout Itemize
8611 \begin_layout Itemize
8617 \begin_layout Itemize
8623 \begin_layout Itemize
8629 \begin_layout Itemize
8635 \begin_layout Itemize
8642 \begin_layout Subsection
8643 Commands not supported by \SpecialChar LyX
8647 \begin_layout Standard
8648 Some commands are not yet supported by the
8652 layout for \SpecialChar LyX
8654 Some have already been mentioned.
8655 For the sake of completeness, they are listed all together here:
8658 \begin_layout Itemize
8666 \begin_layout Itemize
8674 \begin_layout Itemize
8682 \begin_layout Itemize
8690 \begin_layout Standard
8691 If you want to use any of these commands, you have to enter them yourself.
8694 Do not forget to mark them as \SpecialChar LaTeX
8698 \begin_layout Subsection
8699 Figure and Table Floats
8702 \begin_layout Standard
8704 provides support for the necessary float environments
8706 figure, figure*, table
8712 , therefore we won't tell much about it here.
8716 \begin_inset space ~
8722 Just remember that tables should be left-aligned.
8723 For that, select the table and change the alignment in
8725 Edit\SpecialChar menuseparator
8727 \begin_inset space ~
8733 \begin_layout Standard
8734 There is only one special thing: the figures with caption besides the figure.
8735 To create such a figure, you have to do the following:
8738 \begin_layout Enumerate
8739 Create a wide figure float:
8741 Insert\SpecialChar menuseparator
8742 Float\SpecialChar menuseparator
8745 , then right click in the figure and select
8748 \begin_inset space ~
8756 \begin_layout Enumerate
8757 Enter your caption text.
8760 \begin_layout Enumerate
8765 to move the cursor above the caption.
8768 \begin_layout Enumerate
8772 \begin_layout Enumerate
8773 Position the cursor behind the figure and insert a horizontal fill:
8775 Insert\SpecialChar menuseparator
8777 \begin_inset space ~
8780 Character\SpecialChar menuseparator
8782 \begin_inset space ~
8790 \begin_layout Enumerate
8791 Switch to \SpecialChar LaTeX
8795 \begin_inset space ~
8803 \begin_layout Enumerate
8813 Do not close the brace!
8816 \begin_layout Enumerate
8817 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8822 \begin_inset space ~
8834 \begin_layout Standard
8835 Also, refer to the figures in the example paper.
8838 \begin_layout Subsection
8842 \begin_layout Standard
8843 For submission, the paper has to be formated in a special double-spacing
8845 For this purpose, you have to give the option
8849 to the document class.
8850 This must be done using the custom class options field in the
8852 Document\SpecialChar menuseparator
8856 Just enter the string
8863 \begin_layout Subsection
8867 \begin_layout Standard
8872 directory contains an example paper written with \SpecialChar LyX
8874 It is the example paper from the original macro package, translated to
8877 Use it for inspiration, and compare the original \SpecialChar LaTeX
8878 code with \SpecialChar LyX
8882 \begin_layout Section
8887 \begin_layout Standard
8893 \begin_layout Subsection
8897 \begin_layout Standard
8899 is a set of macros produced by the American Astronomical Society to
8900 facilitate electronic manuscript submission to the three journals they
8901 publish: the Astrophysical Journal (including the Letters and Supplement),
8902 the Astronomical Journal, and the Publications of the Astronomical Society
8905 has proven to be an excellent tool for generating these documents, especially
8906 given its equation, citation, and figure handling capabilities.
8908 requires version 5.0 (or higher) of these macros; preferably 6.0, which
8909 is the version described here, or higher.
8910 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8911 2.09 and are fundamentally
8912 incompatible with \SpecialChar LyX
8914 The AAS\SpecialChar TeX
8915 package may be downloaded from the AAS\SpecialChar TeX
8919 \begin_layout Standard
8920 \begin_inset VSpace medskip
8926 \begin_layout Standard
8928 \begin_inset Flex URL
8931 \begin_layout Plain Layout
8933 https://aas.org/aastex/aastex-downloads
8941 \begin_layout Standard
8942 \begin_inset VSpace medskip
8948 \begin_layout Standard
8949 A complete user guide is contained in that package and you should familiarize
8950 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8953 will not reduce the need to figure out all the AAS\SpecialChar TeX
8954 commands, it will only
8955 reduce the drudgery of typing everything in.
8956 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8958 completely to the requirements of the journal to which you are submitting
8962 \begin_layout Subsection
8963 Starting a New Paper
8966 \begin_layout Standard
8967 I strongly suggest that you start with the AAS\SpecialChar TeX
8971 File\SpecialChar menuseparator
8978 , enter the new file name, then choose the
8983 This will show the most common fields found in a manuscript.
8984 Simply overwrite the existing text (including the brackets,
8988 ) with the correct information.
8989 Many of the AAS\SpecialChar TeX
8990 commands and environments can be implemented directly in
8993 For commands such as these, the \SpecialChar LaTeX
8994 code must be entered directly and marked
8996 Such commands are referred to as \SpecialChar TeX
8997 code, or Evil Red Text.
8998 I tried to minimize the amount of \SpecialChar TeX
8999 code needed in an AAS\SpecialChar TeX
9003 \begin_layout Subsection
9004 Finishing Your Paper
9007 \begin_layout Standard
9008 When the paper is finished to your satisfaction and previews/prints correctly,
9010 \begin_inset Quotes eld
9014 \begin_inset Quotes erd
9017 actions which need to be done before you submit it to the journals.
9021 \begin_layout Enumerate
9022 Export your paper as a \SpecialChar LaTeX
9025 File\SpecialChar menuseparator
9026 Export\SpecialChar menuseparator
9034 \begin_layout Enumerate
9039 file with your favorite text editor
9043 \begin_layout Enumerate
9044 remove the comment lines before the
9053 \begin_layout Enumerate
9058 usepackage...{fontenc}
9060 line if it appears (usually just after
9075 \begin_layout Enumerate
9076 remove everything between (and including) the
9088 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9090 (which should appear immediately after the
9091 \begin_inset Quotes eld
9094 User specified \SpecialChar LaTeX
9096 \begin_inset Quotes erd
9107 \begin_layout Enumerate
9108 Run the resulting file through \SpecialChar LaTeX
9109 to make sure it still processes correctly.
9112 \begin_layout Enumerate
9113 Reread the journal requirements to make sure your filenames and formats
9117 \begin_layout Enumerate
9121 \begin_layout Subsection
9122 Comments On Specific Commands
9125 \begin_layout Standard
9126 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9133 ) gives a good description of each.
9134 Thus it's probably easiest for me to go down the list as found in the guide
9135 and offer comments where necessary.
9136 So let's begin \SpecialChar ldots
9140 \begin_layout Subsubsection
9141 Things that work as expected
9144 \begin_layout Standard
9145 Because they work as you might expect, I simply list them and the section
9246 begin{thebibliography}
9254 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9255 graphicx figure commands (2.14.1),
9279 (2.15.4, amongst other places),
9306 \begin_layout Standard
9307 The following style options also work correctly:
9328 Simply put them in the
9334 Layout\SpecialChar menuseparator
9340 \begin_layout Subsubsection
9341 Things that work, but require more comment
9344 \begin_layout Standard
9345 The following items work, but require a little more discussion:
9348 \begin_layout Itemize
9349 These items are reserved for use by the journal editors, but you can put
9350 them into the \SpecialChar LaTeX
9351 preamble if you feel compelled to do so:
9384 \begin_layout Itemize
9385 These items may be placed in the \SpecialChar LaTeX
9386 preamble, and are included as blanks in
9408 \begin_layout Itemize
9415 (2.3) – can only be used
9416 \begin_inset Quotes eld
9420 \begin_inset Quotes erd
9423 , not in the middle of a paragraph.
9424 Use \SpecialChar TeX
9425 code if you need to embed it.
9428 \begin_layout Itemize
9435 (2.3) – will have extra {} after it.
9436 This should not cause an error.
9439 \begin_layout Itemize
9446 (2.6) – can only be used
9447 \begin_inset Quotes eld
9451 \begin_inset Quotes erd
9454 , not in the middle of a paragraph.
9455 Use \SpecialChar TeX
9456 code if you need to embed it.
9459 \begin_layout Itemize
9466 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9470 \begin_layout Itemize
9477 (2.8) – same as for
9484 \begin_layout Itemize
9491 (2.9) – will have extra {} after it.
9492 This should not cause an error.
9495 \begin_layout Itemize
9502 (2.11) – will have extra {} after it.
9503 This should not cause an error.
9506 \begin_layout Itemize
9513 (2.14.2) – you can insert an optional filename argument by placing the cursor
9514 at the beginning of the text and selecting
9516 Insert\SpecialChar menuseparator
9521 \begin_inset Quotes eld
9525 \begin_inset Quotes erd
9528 inserts an optional argument of the type needed by
9535 Hopefully it will be renamed someday.
9538 \begin_layout Itemize
9545 (2.17.1) – same as
9551 for the catalog ID optional parameter
9554 \begin_layout Itemize
9561 (2.17.1) – same as
9567 for the catalog ID optional parameter
9570 \begin_layout Subsubsection
9571 Things not implemented, use \SpecialChar TeX
9575 \begin_layout Standard
9586 setcounter{equation}
9588 (2.12), Journal name abbreviations (2.13.4),
9624 (2.15.4, insert it as the first element in the lefthand cell after where
9626 Don't use any of \SpecialChar LyX
9627 's rules in the table),
9639 (2.15.5), much of Misc (2.17, except
9690 \begin_layout Subsubsection
9691 Things that cannot be implemented
9694 \begin_layout Standard
9696 at least in any meaningful sort of way, so I suggest ignoring them.
9697 They are the references environment (2.13.3), and the deluxetable environment
9699 If you really, really need to use deluxetable, I suggest editing it in
9700 a separate file with a text editor, then using
9702 Insert\SpecialChar menuseparator
9704 \begin_inset space ~
9709 to include it in your \SpecialChar LyX
9715 file to see an example of this.
9718 \begin_layout Subsection
9719 FAQs, Tips, Tricks, and Other Ruminations
9722 \begin_layout Subsubsection
9723 Getting \SpecialChar LyX
9724 and AAS\SpecialChar TeX
9728 \begin_layout Standard
9729 It can be a bit tricky to get \SpecialChar LyX
9730 to recognize a new layout and document class.
9731 When all else fails, do this:
9734 \begin_layout Enumerate
9735 Make certain that \SpecialChar LaTeX
9736 can find AAS\SpecialChar TeX
9738 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9740 directory completely unrelated to \SpecialChar LaTeX
9741 or AAS\SpecialChar TeX
9742 and run \SpecialChar LaTeX
9750 \begin_layout Enumerate
9755 appears in \SpecialChar LyX
9763 \begin_layout Enumerate
9766 Tools\SpecialChar menuseparator
9770 , then restart \SpecialChar LyX
9774 \begin_layout Enumerate
9775 Open a regular new file, not from a template.
9776 Does AAS\SpecialChar TeX
9777 appear in the class list in
9779 Document\SpecialChar menuseparator
9785 \begin_layout Standard
9786 If you get a warning from an existing AAS\SpecialChar TeX
9787 document about not being able
9788 to find the AAS\SpecialChar TeX
9789 layout or a message about
9790 \begin_inset Quotes eld
9793 You should not mix title layouts with normal ones
9794 \begin_inset Quotes erd
9797 , things haven't been installed correctly.
9800 \begin_layout Subsubsection
9802 error processing a table
9805 \begin_layout Standard
9807 , by default, attempts to center the table caption/title.
9808 This seems to produce a bad interaction in AAS\SpecialChar TeX
9809 so you should click somewhere
9810 in the caption/title, then select
9812 Edit\SpecialChar menuseparator
9814 \begin_inset space ~
9828 This took care of it for me.
9831 \begin_layout Subsubsection
9835 \begin_layout Standard
9836 A couple of things: 1) I have noticed some funny spacing in the reference
9837 entries in the text.
9838 When you enter the bibliography item data, make sure their is
9842 space between the last author and the parenthesis setting off the year;
9846 \begin_inset space \thinspace{}
9850 \begin_inset space \space{}
9864 2) Entering the references at all is not obvious.
9865 The easiest thing is to start typing your first reference at the end of
9866 the document, then mark it as type
9871 That will put a small gray box in front of what you just typed.
9872 Click on the box to fill in the rest of the information.
9873 For new references, go to the end of an existing reference and press return.
9874 That will create a new line with its own box, etc.
9877 \begin_layout Subsubsection
9881 \begin_layout Standard
9882 Even though AAS\SpecialChar TeX
9883 provides its own figure commands (
9889 , for example), I much prefer \SpecialChar LaTeX
9890 's standard figure commands (with the default
9899 \begin_inset space ~
9902 commands as \SpecialChar TeX
9903 code into a Figure Float box if you desire, but I never have
9904 much luck getting the layout right.
9905 With the standard graphics, \SpecialChar LyX
9910 usepackage{graphicx}
9912 command into the \SpecialChar LaTeX
9913 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9915 interspersing the figures in the text.
9916 I believe ApJ accepts figures exactly this way now; AJ might still use
9918 \begin_inset Quotes eld
9921 stack everything at the end
9922 \begin_inset Quotes erd
9928 \begin_layout Subsubsection
9929 Things I could have done, but didn't
9932 \begin_layout Standard
9934 \begin_inset Quotes eld
9938 \begin_inset Quotes erd
9941 things I could have implemented, but chose not to.
9942 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9944 even though it is double-spaced in the paper manuscript.
9945 Also, I chose not to make separate layouts for the preprint and preprint2
9947 Since I assume you will spend most of your time in the plain manuscript
9948 mode anyway, I decided not to chew up more disk space with this.
9952 \begin_layout Subsection
9956 \begin_layout Standard
9957 Your mileage may vary.
9958 I've now had papers published by both ApJ and AJ that have had 98% of the
9959 effort done in \SpecialChar LyX
9960 ; the last 2% was the \SpecialChar LaTeX
9961 post-processing and a few cleanups.
9962 I have had no trouble with the submission process, and I'm sure the journals
9963 were never aware that there might be a difference.
9964 So, go forth and publish!
9967 \begin_layout Section
9968 AMS \SpecialChar LaTeX
9972 \begin_layout Standard
9982 \begin_layout Standard
9983 \begin_inset VSpace bigskip
9989 \begin_layout Standard
9991 The AMS \SpecialChar LaTeX
9992 layouts are set up to conform to suggested styles for mathematical
9993 papers to be submitted to American Mathematical Society publications.
9994 The layouts are not tailored to a specific journal, but easily can be.
9995 You should refer to the AMS documentation for specific instructions for
9996 each journal (usually it will entail only changing a single line in the
9999 That documentation is available on the Web at
10000 \begin_inset Flex URL
10003 \begin_layout Plain Layout
10011 \begin_inset Flex URL
10014 \begin_layout Plain Layout
10016 ftp://ftp.ams.org/pub/tex/amslatex/
10022 These layouts are appropriate, and useful, for any mathematical writing.
10026 \begin_layout Standard
10027 There are two basic AMS \SpecialChar LaTeX
10031 \begin_layout Itemize
10032 amsart: The standard AMS article format.
10035 \begin_layout Itemize
10036 amsbook: the standard AMS book (really, monograph) format.
10040 \begin_layout Standard
10041 The layouts themselves contain only the minimum necessary to use the AMS
10043 They do not, in particular, contain any of the `theorem' environments used
10044 for setting theorems, lemmas, and the like.
10045 These are contained, instead, in the
10046 \begin_inset Flex Code
10049 \begin_layout Plain Layout
10055 module, which is loaded by default when you select one of the AMS classes.
10056 (It can also be used with other classes and can be removed, if you would
10057 rather use something else.) Less commonly used environments are in the
10058 \begin_inset Flex Code
10061 \begin_layout Plain Layout
10062 Theorems (AMS-Extended)
10067 module, which must be loaded manually.
10070 \begin_layout Standard
10071 By default, theorems and the like are numbered consecutively throughout
10072 the document, but this may be modified by loading the module
10073 \begin_inset Flex Code
10076 \begin_layout Plain Layout
10077 Theorems (Order by Section)
10082 or, if you are using
10083 \begin_inset Flex Code
10086 \begin_layout Plain Layout
10093 \begin_inset Flex Code
10096 \begin_layout Plain Layout
10097 Theorems (Order by Chapter)
10103 These will number the results as
10104 \begin_inset Formula $n.m$
10107 , where the first number refers to the section (or chapter) and the second
10108 refers to the total number of results so far in that section (or chapter).
10109 Many environments are also available unnumbered.
10110 These are indicated by an asterisk at the end.
10111 If you happen to want
10115 unnumbered results, the module
10116 \begin_inset Flex Code
10119 \begin_layout Plain Layout
10125 provides that option.
10128 \begin_layout Standard
10129 Note that these modules do not
10133 to be used with the AMS classes.
10134 It is perfectly possible to use the
10135 \begin_inset Flex Code
10138 \begin_layout Plain Layout
10144 module, and the others mentioned, with other classes, such as
10145 \begin_inset Flex Code
10148 \begin_layout Plain Layout
10155 \begin_inset Flex Code
10158 \begin_layout Plain Layout
10165 \begin_inset Flex Code
10168 \begin_layout Plain Layout
10177 \begin_layout Subsection
10178 What these layouts provide
10181 \begin_layout Standard
10182 There is a long list of included environments provided by these layouts.
10183 In AMS-\SpecialChar LaTeX
10184 , there is, in fact, an opportunity to define an unlimited variety
10185 of `theorem' environments.
10186 However, the AMS recommends the environments that are available in \SpecialChar LyX
10191 \begin_layout Standard
10192 The following environments—as well as the standard environments, such as
10194 \begin_inset Flex Noun
10197 \begin_layout Plain Layout
10204 \begin_inset Flex Noun
10207 \begin_layout Plain Layout
10214 \begin_inset Flex Noun
10217 \begin_layout Plain Layout
10224 \begin_inset Flex Noun
10227 \begin_layout Plain Layout
10234 \begin_inset Flex Noun
10237 \begin_layout Plain Layout
10244 \begin_inset Flex Code
10247 \begin_layout Plain Layout
10254 \begin_inset Flex Code
10257 \begin_layout Plain Layout
10266 \begin_layout Description
10267 Address This should be the author's permanent address.
10270 \begin_layout Description
10272 \begin_inset space ~
10275 Address This should be the author's temporary address at the time of submission,
10276 if different from the Address.
10279 \begin_layout Description
10280 Email Author's e-mail address
10283 \begin_layout Description
10284 URL Author's Web address, if desired.
10287 \begin_layout Description
10288 Keywords Key words or phrases used to identify specific topics discussed
10292 \begin_layout Description
10293 Subjectclass These refer to the AMS Subject Classifications, published and
10296 Mathematical Reviews
10299 These are also available online at the AMS cites listed above.
10302 \begin_layout Description
10306 \begin_layout Description
10310 \begin_layout Description
10314 \begin_layout Standard
10315 The following environments are provided by both the
10316 \begin_inset Flex Code
10319 \begin_layout Plain Layout
10326 \begin_inset Flex Code
10329 \begin_layout Plain Layout
10335 modules, in the latter case in both starred (unnumbered) and unstarred
10336 (numbered) versions.
10337 These same environments are provided only in the starred versions by the
10339 \begin_inset Flex Code
10342 \begin_layout Plain Layout
10351 \begin_layout Theorem
10352 This is typically used for the statements of major results.
10356 \begin_layout Corollary*
10357 This is used for statements which follow fairly directly from previous statement
10359 Again, these can be major results.
10363 \begin_layout Lemma
10364 These are smaller results needed to prove other statements.
10367 \begin_layout Proposition
10368 These are less major results which (hopefully) add to the general theory
10372 \begin_layout Conjecture
10373 These are statements provided without justification, which the author does
10374 not know how to prove, but which seem to be true (to the author, at least).
10377 \begin_layout Definition*
10378 Guess what this is for.
10379 The font is different for this environment than for the previous ones.
10383 \begin_layout Example*
10384 Used for examples illustrating proven results.
10387 \begin_layout Problem
10388 It's not really known what this is for.
10389 You should figure it out.
10392 \begin_layout Exercise*
10393 Write a description for this one.
10396 \begin_layout Remark
10397 This environment is also a type of theorem, usually a lesser sort of observation.
10400 \begin_layout Claim*
10401 Often used in the course of giving a proof of a larger result.
10405 Generally, these are used to break up long arguments, using specific instances
10411 The numbering scheme for cases is on its own, not together with other numbered
10416 \begin_layout Proof
10417 At the end of this environment, a QED symbol (usually a square, but it can
10418 vary with different styles) is placed.
10419 If you want to have other environments within this one—for example, Case
10420 environments—and have the QED symbol appear only after them, then the other
10421 environments need to be nested within the proof environment.
10424 Nesting Environments
10430 for information on nesting.
10433 \begin_layout Standard
10434 And these environments are provided by
10435 \begin_inset Flex Code
10438 \begin_layout Plain Layout
10439 Theorems (AMS-Extended)
10447 \begin_layout Criterion*
10448 A required condition.
10451 \begin_layout Algorithm*
10452 A general procedure to be used.
10455 \begin_layout Axiom*
10456 This is a property or statement taken as true within the system being discussed.
10459 \begin_layout Condition*
10460 Sometimes used to state a condition assumed within the present context of
10464 \begin_layout Note*
10465 Similar to a Remark.
10468 \begin_layout Notation*
10469 Used for the explanation of, yes, notation.
10472 \begin_layout Summary
10473 Do we really need to tell you?
10476 \begin_layout Acknowledgement*
10480 \begin_layout Conclusion*
10481 Sometimes used at the end of a long train of argument.
10485 Used in a way similar to Proposition, though perhaps lower on the scale.
10488 \begin_layout Standard
10489 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10492 They need to be available on your system in order to use these environments.
10495 \begin_layout Section
10499 \begin_layout Standard
10505 \begin_layout Subsection
10509 \begin_layout Standard
10510 Broadway is for writing plays.
10511 The format is more decorative than Hollywood, and much less standardized.
10512 This format should be suitable for workshops.
10515 \begin_layout Subsection
10519 \begin_layout Standard
10520 The same as in Hollywood.
10523 \begin_layout Subsection
10527 \begin_layout Standard
10532 names as labels then cross-reference the label to insert the name.
10533 The cross-reference dialog will show the current cast of characters.
10536 \begin_layout Subsection
10537 Paper size and Margins
10540 \begin_layout Standard
10541 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10544 \begin_layout Subsection
10548 \begin_layout Standard
10549 The following environments are available.
10550 You can use broadway.bind to get the bind keys shown at the right.
10553 \begin_layout Itemize
10557 \begin_inset Newline newline
10562 You should not have to use this, but it is here for anything that does not
10566 \begin_layout Itemize
10570 \begin_inset space \hfill{}
10574 \begin_inset Newline newline
10579 Used to describe stage setting and the action.
10580 First use of speaker names in all CAPs.
10583 \begin_layout Itemize
10587 \begin_inset space \hfill{}
10591 \begin_inset Newline newline
10596 Automatically numbered.
10597 On screen it will be arabic, but will print as Roman.
10600 \begin_layout Itemize
10604 \begin_inset space \hfill{}
10608 \begin_inset Newline newline
10618 It is just centered text.
10621 \begin_layout Itemize
10625 \begin_inset space \hfill{}
10629 \begin_inset Newline newline
10634 Not automatically numbered.
10635 You supply the number.
10636 This is because I couldn't figure out how.
10639 \begin_layout Itemize
10643 \begin_inset space \hfill{}
10647 \begin_inset Newline newline
10652 A special case of Narrative to describe the setting and action as the curtain
10656 \begin_layout Itemize
10660 \begin_inset space \hfill{}
10664 \begin_inset Newline newline
10669 The speaker's (actor's) title, centered in all CAPS.
10672 \begin_layout Itemize
10676 \begin_inset space \hfill{}
10680 \begin_inset Newline newline
10685 Instructions to the speaker.
10686 The parentheses are automatically inserted.
10687 The ( will appear on screen, but both will be in the printed play.
10688 This environment is only used within
10695 \begin_layout Itemize
10699 \begin_inset space \hfill{}
10703 \begin_inset Newline newline
10708 What the Speaker says.
10711 \begin_layout Itemize
10715 \begin_inset space \hfill{}
10719 \begin_inset Newline newline
10724 The curtain comes down.
10727 \begin_layout Itemize
10731 \begin_inset space \hfill{}
10737 \begin_layout Itemize
10741 \begin_inset space \hfill{}
10747 \begin_layout Itemize
10751 \begin_inset space \hfill{}
10757 \begin_layout Standard
10761 \begin_layout Section
10765 \begin_layout Standard
10770 can be used to type letters according to German conventions.
10771 A template file is included in
10773 .../lyx/share/templates
10775 for you to use as a starting point.
10778 \begin_layout Section
10782 \begin_layout Standard
10783 See the \SpecialChar LyX
10789 It contains all infos you need.
10792 \begin_layout Section
10795 Foil\SpecialChar TeX
10799 \begin_inset CommandInset label
10808 \begin_layout Standard
10814 \begin_layout Subsection
10818 \begin_layout Standard
10819 This section describes how to use \SpecialChar LyX
10820 to make slides for overhead projectors.
10821 There are two document classes that can do this: the default slides class
10824 Foil\SpecialChar TeX
10828 This section documents the latter.
10831 \begin_layout Standard
10832 I'm going to say this again, nice and clear, so that there's no misunderstanding
10836 \begin_layout Standard
10837 \begin_inset VSpace bigskip
10843 \begin_layout Standard
10847 This section documents the class
10848 \begin_inset Quotes eld
10856 \begin_inset Quotes erd
10864 \begin_layout Standard
10865 \begin_inset VSpace bigskip
10871 \begin_layout Standard
10872 If you're looking for the documentation for
10873 \begin_inset Quotes eld
10881 \begin_inset Quotes erd
10884 , check out section
10885 \begin_inset space ~
10889 \begin_inset CommandInset ref
10891 reference "sec:slitex"
10896 If your machine doesn't have the
10904 installed, you'll probably have to use the default
10908 class, which isn't quite as good as
10913 \begin_layout Standard
10918 class is designed for use with version
10919 \begin_inset space ~
10927 class file which is now an integral part of \SpecialChar LaTeX2e
10931 \begin_layout Subsection
10935 \begin_layout Standard
10936 Obviously, to use this document class, you need to select
10947 \begin_inset space ~
10953 There are some settings in the
10956 \begin_inset space ~
10961 dialog that you should know about that are specific to this class:
10964 \begin_layout Itemize
10965 Don't change the options
10976 \begin_inset space ~
10982 They're ignored by the
10989 \begin_layout Itemize
10990 The default font size is 20
10991 \begin_inset space \thinspace{}
10994 pt with the other options being 17
10995 \begin_inset space \thinspace{}
10999 \begin_inset space \thinspace{}
11003 \begin_inset space \thinspace{}
11009 \begin_layout Itemize
11010 The default font is
11018 but all math equations are still typeset in the usual roman font.
11021 \begin_layout Itemize
11024 Foil\SpecialChar TeX
11027 supports A4 and Letter paper sizes as well as a special size for working
11029 \begin_inset space \thinspace{}
11033 It doesn't support A5, B5, legal or executive paper sizes.
11036 \begin_layout Itemize
11037 Don't bother changing the
11041 settings because they are ignored anyway.
11042 All floats appear where they are defined in the text.
11045 \begin_layout Itemize
11050 setting behaves a bit differently for this class.
11053 Foil\SpecialChar TeX
11056 provides extensive footer and header capabilities including a user-defined
11059 \begin_inset space ~
11063 \begin_inset CommandInset ref
11065 reference "sec:foilfoot"
11070 The title page is treated differently to all other pages in the document
11079 has the logo centered at the bottom of the page (if one is defined).
11080 The possible page style choices and what they do are as follows:
11084 \begin_layout Labeling
11085 \labelwidthstring MMMMMMM
11092 The final output contains no page numbers, or other headers or footers
11093 (except footnotes of course).
11097 \begin_layout Labeling
11098 \labelwidthstring MMMMMMM
11105 The final output contains page numbers centered at the bottom of the page.
11106 No other headings or footers (other than footnotes).
11109 \begin_layout Labeling
11110 \labelwidthstring MMMMMMM
11115 Page numbers in lower right corner.
11116 Additional headers and footers are also shown.
11117 This is also the default.
11120 \begin_layout Labeling
11121 \labelwidthstring MMMMMMM
11126 Gives you access to the
11130 package although its use with
11132 Foil\SpecialChar TeX
11135 is discouraged by the writer of the
11137 Foil\SpecialChar TeX
11140 package because of some potential page layout clashes.
11144 \begin_layout Subsubsection
11148 \begin_layout Standard
11149 The following options may be used in the extra class options in the
11151 Document\SpecialChar menuseparator
11157 \begin_layout Labeling
11158 \labelwidthstring MMMMMMx
11163 This sets up the page layout for 7.33
11164 \begin_inset space \thinspace{}
11168 \begin_inset space \thinspace{}
11171 in paper, which is about the same aspect ratio as a 35
11172 \begin_inset space \thinspace{}
11175 mm slide, making it a bit easier to work with this medium.
11178 \begin_layout Labeling
11179 \labelwidthstring MMMMMMx
11184 Places a rule across the page below the header on every page except the
11188 \begin_layout Labeling
11189 \labelwidthstring MMMMMMx
11194 Places a rule across the page above the footer on every page except the
11198 \begin_layout Labeling
11199 \labelwidthstring MMMMMMx
11204 This is automatically set each time you create a new
11211 Foil\SpecialChar TeX
11214 to use the dvips driver to rotate those pages that are set as landscape
11218 \begin_layout Labeling
11219 \labelwidthstring MMMMMMx
11224 Simply changes the page dimensions to those of a landscape page but doesn't
11226 Thus if you use this option you need to use an external program to rotate
11227 each page or feed your paper through your printer as landscape.
11228 Note that this option effectively reverses the roles of the
11236 environments (don't worry these are described in the next section).
11239 \begin_layout Labeling
11240 \labelwidthstring MMMMMMx
11245 Equation numbers on the left.
11248 \begin_layout Labeling
11249 \labelwidthstring MMMMMMx
11254 Flush-left equations.
11257 \begin_layout Subsection
11258 Supported Environments
11261 \begin_layout Standard
11262 Most of the environments commonly supported in other classes are also supported
11268 There are several additional environments provided by
11270 Foil\SpecialChar TeX
11273 as well as a couple added by \SpecialChar LyX
11275 The following environments are shared with other classes:
11278 \begin_layout Standard
11279 \begin_inset Flex Multiple Columns
11282 \begin_layout Itemize
11288 \begin_layout Itemize
11294 \begin_layout Itemize
11300 \begin_layout Itemize
11306 \begin_layout Itemize
11312 \begin_layout Itemize
11319 \begin_layout Itemize
11325 \begin_layout Itemize
11331 \begin_layout Itemize
11337 \begin_layout Itemize
11343 \begin_layout Itemize
11349 \begin_layout Itemize
11355 \begin_layout Itemize
11361 \begin_layout Itemize
11367 \begin_layout Itemize
11378 \begin_layout Standard
11379 That is, all the major environments apart from the sectioning environments.
11380 Since foils are essentially self-contained sections, with a title and body,
11383 Foil\SpecialChar TeX
11386 provides specific commands for starting new foils and these are:
11389 \begin_layout Itemize
11395 \begin_layout Itemize
11401 \begin_layout Standard
11403 also provides slightly modified versions of these two environments called:
11406 \begin_layout Itemize
11412 \begin_layout Itemize
11415 ShortRotatefoilhead
11418 \begin_layout Standard
11419 and the differences will be explained in the next section.
11422 \begin_layout Standard
11423 Since foils are often used in presenting ideas or new theorems and such
11426 Foil\SpecialChar TeX
11429 also provides a comprehensive box of goodies for presenting them:
11432 \begin_layout Standard
11433 \begin_inset Flex Multiple Columns
11436 \begin_layout Itemize
11442 \begin_layout Itemize
11448 \begin_layout Itemize
11454 \begin_layout Itemize
11460 \begin_layout Itemize
11466 \begin_layout Itemize
11472 \begin_layout Itemize
11478 \begin_layout Itemize
11484 \begin_layout Itemize
11490 \begin_layout Itemize
11496 \begin_layout Itemize
11507 \begin_layout Standard
11508 The starred versions are unnumbered while the unstarred versions are numbered.
11509 There are also two list environments added by \SpecialChar LyX
11513 \begin_layout Itemize
11519 \begin_layout Itemize
11525 \begin_layout Standard
11528 Foil\SpecialChar TeX
11531 provides some powerful header and footer capabilities that are best set
11532 in the preamble although they may be set at any point in a document.
11533 If you want to change these settings in your document the best place to
11534 do so is at the very top of a foil, i.
11535 \begin_inset space \thinspace{}
11541 \begin_inset space \space{}
11546 straight after the foilhead.
11549 \begin_layout Standard
11550 For this purpose, the following command styles are provided [
11557 \begin_layout Standard
11558 \begin_inset Flex Multiple Columns
11561 \begin_layout Itemize
11565 \begin_inset space ~
11571 \begin_layout Itemize
11577 \begin_layout Itemize
11581 \begin_inset space ~
11587 \begin_layout Itemize
11591 \begin_inset space ~
11597 \begin_layout Itemize
11601 \begin_inset space ~
11608 \begin_layout Plain Layout
11609 \begin_inset space ~
11621 \begin_layout Standard
11622 There are also a few commands provided by
11624 Foil\SpecialChar TeX
11627 that aren't directly supported by \SpecialChar LyX
11628 but I'll tell you what they do and how
11629 to use them in section
11630 \begin_inset space ~
11634 \begin_inset CommandInset ref
11636 reference "sec:unsuppfoils"
11643 \begin_layout Subsection
11644 Building a Set of Foils
11647 \begin_layout Standard
11648 This section will give a simple introduction to using the different environments
11649 to build a set of foils.
11650 If you want to see an example set of foils, take a look at the
11654 file you find in \SpecialChar LyX
11662 \begin_layout Subsubsection
11663 Give It a Title Page
11666 \begin_layout Standard
11667 Unlike other classes that provide
11687 creates the title on a page of its own.
11688 If you leave out the
11692 environment \SpecialChar LaTeX
11693 will substitute the current date (every time you regenerate
11697 \begin_layout Subsubsection
11701 \begin_layout Standard
11702 As I mentioned earlier, there are four ways of starting a new foil.
11703 For portrait foils you should use
11712 The difference between these two environments is the amount of space between
11713 the title of the foil (the foilhead) and the body of the foil.
11716 \begin_layout Standard
11717 Landscape foils are generated using the
11723 ShortRotatefoilhead
11726 Again the only difference is the spacing between foilhead and body.
11727 Both of the short versions have 0.5
11728 \begin_inset space ~
11731 inches less separation between the foilhead and the body.
11735 \begin_layout Standard
11736 One problem with the support for landscape foils is the requirement that
11737 you have to use the
11741 driver to generate the PostScript output otherwise the foils won't be rotated.
11742 It is possible to get landscape foils even if you haven't got the
11746 driver provided you can feed your foils sideways through your printer ;-)
11749 \begin_layout Subsubsection
11750 Theorems, Lemmas, Proofs and more
11753 \begin_layout Standard
11754 You can't have two of the same type of these environments directly following
11756 If you use a normal paragraph break, , you will just be extending the previous
11757 environment as if you had merged the two environments together.
11758 Rather than that, you need to insert a so-called separator.
11759 Please refer to the section entitled
11770 \begin_layout Subsubsection
11774 \begin_layout Standard
11775 You get all the commonly supported list styles found in other classes as
11776 well as two new ones.
11777 I'll only describe the new ones here.
11778 If you want to find out more about the other list environments check out
11784 If you intend to use itemized lists you might also want to read about the
11788 \begin_inset space ~
11792 \begin_inset space ~
11797 dialog described above in section
11798 \begin_inset space ~
11802 \begin_inset CommandInset ref
11804 reference "sec:bullet"
11811 \begin_layout Standard
11812 The two new list styles,
11820 , are designed to make it easier for you to create lists of do's and don'ts
11821 or right and wrong by providing dedicated environments that use a tick
11822 or a cross as the label of the list.
11823 These lists are in fact dedicated variants of the
11828 They do however require that you have the
11832 packages installed.
11835 \begin_layout Subsubsection
11839 \begin_layout Standard
11842 Foil\SpecialChar TeX
11845 redefines the floating tables and figures so that they appear exactly where
11846 they are in the text rather than pushing them to the top of the page or
11847 to some user specified location.
11848 In fact if you change the float placement settings they are simply ignored.
11851 \begin_layout Subsubsection
11852 Page Headers and Footers
11853 \begin_inset CommandInset label
11855 name "sec:foilfoot"
11862 \begin_layout Standard
11866 \begin_inset space ~
11875 are two commands used to control the left-footer text string.
11876 The first is meant to allow you to include a graphic logo on your foils
11878 \begin_inset Quotes eld
11883 Foil\SpecialChar TeX
11887 \begin_inset Quotes erd
11891 While the second is meant to provide a classification for the audience,
11895 \begin_inset space \thinspace{}
11901 \begin_inset space \space{}
11905 It is empty by default.
11908 \begin_layout Standard
11909 The remaining page corners can be filled by
11912 \begin_inset space ~
11917 (which defaults to page numbers),
11920 \begin_inset space ~
11928 \begin_inset space ~
11936 \begin_layout Subsection
11939 Foil\SpecialChar TeX
11943 \begin_inset CommandInset label
11945 name "sec:unsuppfoils"
11952 \begin_layout Standard
11953 All the commands mentioned below need to be set in a
11963 within another environment.
11966 \begin_layout Subsubsection
11970 \begin_layout Standard
11971 All lengths are adjusted using the
11994 should be replaced by the name given to the length you want to change and
11999 is the length value.
12000 All lengths should be specified in units of length such as inches (
12012 ) or relative to some document or font-based length such as
12022 \begin_layout Standard
12023 It's possible to change the spacing between a foilhead and the body of the
12024 foil by adjusting the length specified by
12031 For example, to make
12036 \begin_inset space \space{}
12039 in closer to their bodies put the following in the preamble:
12045 foilheadskip}{-0.5in}
12048 \begin_layout Standard
12049 The spacings around floats can be adjusted by setting these lengths:
12052 \begin_layout Labeling
12053 \labelwidthstring MMMMMMMMMMM
12060 Separation between the text and the top of the float
12063 \begin_layout Labeling
12064 \labelwidthstring MMMMMMMMMMM
12071 Separation between the float and the caption
12074 \begin_layout Labeling
12075 \labelwidthstring MMMMMMMMMMM
12082 Separation between the caption and the following text
12085 \begin_layout Labeling
12086 \labelwidthstring MMMMMMMMMMM
12093 You can make the captions narrower than the surrounding text by adjusting
12095 Best done relative to
12104 \begin_layout Standard
12105 There are also several title page related lengths that you may find useful
12106 if you have a long title or several authors:
12109 \begin_layout Labeling
12110 \labelwidthstring MMMMMMMMMMM
12117 Separation from headers to
12122 \begin_layout Labeling
12123 \labelwidthstring MMMMMMMMMMM
12141 \begin_layout Labeling
12142 \labelwidthstring MMMMMMMMMMM
12156 \begin_layout Labeling
12157 \labelwidthstring MMMMMMMMMMM
12173 \begin_layout Labeling
12174 \labelwidthstring MMMMMMMMMMM
12190 \begin_layout Standard
12191 The last length related command affects all the list environments.
12202 a list environment then all the vertical spacing between the list items
12204 Note that this is a command not a length so it doesn't require
12210 like the stuff mentioned above.
12213 \begin_layout Subsubsection
12214 Headers and Footers
12217 \begin_layout Standard
12230 commands control whether the logo in the
12234 definition appear on a given page.
12241 in the preamble then none of the foils will have the logo on them.
12242 If you don't want the logo on a particular page place the
12248 directly after the foilhead of that page and the
12254 directly after the next foilhead.
12257 \begin_layout Standard
12258 If you decide to use the
12262 page style setting in the
12265 \begin_inset space ~
12270 dialog you should probably add
12280 to your preamble so headers and footers on landscape pages are correctly
12281 placed when rotated.
12282 This is due to some clashes between the page layouts provided by the
12293 \begin_layout Section
12294 Hollywood (Hollywood spec scripts)
12297 \begin_layout Standard
12303 \begin_layout Subsection
12307 \begin_layout Standard
12308 Getting the format of a Hollywood script right is a
12309 \begin_inset Quotes eld
12313 \begin_inset Quotes erd
12316 It is designed to make the readers focus on content and to be easy and
12317 familiar for the actors to read.
12318 Each page of a script should be one minute of film.
12319 Nothing goes in a script that you cannot see or hear on screen.
12320 The courier 12 pt font should be used throughout.
12324 \begin_layout Subsection
12328 \begin_layout Standard
12329 Speakers' lines should NEVER break in mid-sentence.
12330 If a speaker's lines continue over a page break, repeat the
12334 title followed by (Cont'd).
12337 \begin_layout Subsection
12341 \begin_layout Standard
12346 names as labels then cross-reference the label to insert the name.
12347 The cross-reference dialog will show the current cast of characters.
12348 You can use this to insert the speaker name in narratives also.
12351 \begin_layout Subsection
12352 Paper size and Margins
12355 \begin_layout Standard
12356 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12359 \begin_layout Subsection
12363 \begin_layout Standard
12364 The following environments are available.
12365 You can use hollywood.bind to get the bind keys shown at the right.
12368 \begin_layout Itemize
12372 \begin_inset Newline newline
12377 Used where nothing else works.
12381 \begin_layout Itemize
12387 \begin_inset space \hfill{}
12395 \begin_inset Newline newline
12398 Usually followed by something like
12399 \begin_inset Quotes eld
12402 on Sally waking up.
12403 \begin_inset Quotes erd
12409 \begin_layout Itemize
12413 \begin_inset space \hfill{}
12417 \begin_inset Newline newline
12422 Introduces a new INTERIOR camera set-up.
12423 Always followed by DAY or NIGHT, or something similar to define the lighting
12425 Everthing on this line in CAPS.
12428 \begin_layout Itemize
12432 \begin_inset space \hfill{}
12436 \begin_inset Newline newline
12441 Introduces a new EXTERIOR camera set-up.
12442 Everthing on this line in CAPS.
12445 \begin_layout Itemize
12449 \begin_inset space \hfill{}
12453 \begin_inset Newline newline
12458 The character speaking.
12461 \begin_layout Itemize
12465 \begin_inset space \hfill{}
12469 \begin_inset Newline newline
12474 Instructions to the speaker.
12475 The () are automatically inserted.
12478 \begin_layout Itemize
12482 \begin_inset space \hfill{}
12486 \begin_inset Newline newline
12498 \begin_layout Itemize
12502 \begin_inset space \hfill{}
12506 \begin_inset Newline newline
12511 Camera movement instruction.
12513 \begin_inset space \thinspace{}
12517 \begin_inset space \space{}
12523 \begin_layout Itemize
12527 \begin_inset space \hfill{}
12533 \begin_layout Itemize
12537 \begin_inset space \hfill{}
12543 \begin_layout Itemize
12547 \begin_inset space \hfill{}
12553 \begin_layout Itemize
12557 \begin_inset space \hfill{}
12563 \begin_layout Subsection
12567 \begin_layout Itemize
12568 (O.S) — off screen
12571 \begin_layout Itemize
12572 (V.0) — voice over
12575 \begin_layout Itemize
12577 \begin_inset space \thinspace{}
12584 \begin_layout Itemize
12589 \begin_layout Itemize
12590 PAN — camera movement
12593 \begin_layout Itemize
12594 INSERT — cut to close-up of
12597 \begin_layout Section
12601 \begin_layout Standard
12604 Panayotis Papasotiriou
12607 \begin_layout Subsection
12611 \begin_layout Standard
12612 The ijmpc package is a set of macros that facilitates electronic manuscript
12615 International Journal of Modern Physics C
12618 Similarly, the ijmpd package is for creating manuscripts to be submitted
12621 International Journal of Modern Physics D
12624 Both journals are published by World Scientific.
12625 The corresponding document classes are named
12634 These files, together with instructions for the authors, can be downloaded
12636 \begin_inset Flex URL
12639 \begin_layout Plain Layout
12641 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12647 \begin_inset Flex URL
12650 \begin_layout Plain Layout
12652 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12658 Both packages are modified versions of the standard
12659 \begin_inset Quotes eld
12663 \begin_inset Quotes erd
12666 package, and they are almost (but not exactly) identical.
12667 Most of their features are supported by \SpecialChar LyX
12669 I have used \SpecialChar LyX
12670 successfully to write articles submitted to both journals
12671 without any problem.
12674 \begin_layout Subsection
12678 \begin_layout Standard
12679 As usual, the easiest way to write a paper is to start with a template.
12682 File\SpecialChar menuseparator
12698 This will give an (almost) empty document that includes the most common
12699 fields found in a manuscript.
12700 Simply overwrite the existing text (including the brackets,
12705 You should keep in mind the following remarks.
12708 \begin_layout Enumerate
12710 won't let you change the font size and the page style of the document,
12711 because such modifications are not allowed by both packages.
12714 \begin_layout Enumerate
12715 The language of the document should not be changed.
12716 Before previewing your paper, be sure that the babel package is not used.
12717 To do this, click on
12720 arg "dialog-show document"
12725 \SpecialChar menuseparator
12729 \begin_inset Quotes eld
12733 \begin_inset Quotes erd
12743 \begin_layout Enumerate
12745 \begin_inset Quotes eld
12749 \begin_inset Quotes erd
12752 style must be used to define keywords.
12755 \begin_layout Enumerate
12756 The ijmpc package provides a style named
12757 \begin_inset Quotes eld
12760 Classification Codes
12761 \begin_inset Quotes erd
12764 , which can be used to define classification codes, such as PACS numbers.
12765 Note that this facility is not supported by the ijmpd package.
12768 \begin_layout Enumerate
12769 Several new environments are available:
12770 \begin_inset Quotes eld
12774 \begin_inset Quotes erd
12778 \begin_inset Quotes eld
12782 \begin_inset Quotes erd
12786 \begin_inset Quotes eld
12790 \begin_inset Quotes erd
12794 \begin_inset Quotes eld
12798 \begin_inset Quotes erd
12802 \begin_inset Quotes eld
12806 \begin_inset Quotes erd
12810 \begin_inset Quotes eld
12814 \begin_inset Quotes erd
12818 \begin_inset Quotes eld
12822 \begin_inset Quotes erd
12826 \begin_inset Quotes eld
12830 \begin_inset Quotes erd
12834 \begin_inset Quotes eld
12838 \begin_inset Quotes erd
12842 \begin_inset Quotes eld
12846 \begin_inset Quotes erd
12850 \begin_inset Quotes eld
12854 \begin_inset Quotes erd
12858 \begin_inset Quotes eld
12862 \begin_inset Quotes erd
12866 \begin_inset Quotes eld
12870 \begin_inset Quotes erd
12874 \begin_inset Quotes eld
12878 \begin_inset Quotes erd
12882 Their use is more or less obvious.
12884 supports all these environments; it will use the proper label, text style,
12885 and numbering scheme for each of them.
12888 \begin_layout Enumerate
12889 Both packages use basic citations; the natbib package should not be used.
12890 In \SpecialChar LyX
12891 , citation references are shown as usual; in the output, citations are
12892 shown as superscripts.
12893 If you want to use a citation as normal text, you should use the
12898 \begin_inset space \thinspace{}
12902 \begin_inset space \space{}
12906 \begin_inset Quotes eld
12910 \begin_inset space \space{}
12920 \begin_inset Quotes erd
12926 \begin_layout Enumerate
12928 \begin_inset Quotes eld
12932 \begin_inset Quotes erd
12935 section in both packages.
12936 To put acknowledgments, just use the
12937 \begin_inset Quotes eld
12941 \begin_inset Quotes erd
12947 \begin_layout Enumerate
12948 Appendices may be added to the paper,
12952 the Acknowledgments and
12958 provides a special environment, called
12959 \begin_inset Quotes eld
12963 \begin_inset Quotes erd
12966 which marks the beginning of the appendices.
12967 This environment should be left blank; it just sends a \SpecialChar LaTeX
12968 command, but nothing
12970 In \SpecialChar LyX
12972 \begin_inset Quotes eld
12976 \begin_inset Quotes erd
12979 is printed with blue letters, as a signal that all sections after that
12980 point are appendices.
12981 To write an appendix, use the
12982 \begin_inset Quotes eld
12986 \begin_inset Quotes erd
12991 will number each appendix with capital letters, as required by both journals.
12993 \begin_inset Quotes eld
12997 \begin_inset Quotes erd
13004 be present before the first appendix; if not, all appendices will be numbered
13005 as normal sections in the output.
13008 \begin_layout Enumerate
13009 The ijmpc and the ijmpd packages use the
13013 command to implement table captions.
13014 As a result, a table created by \SpecialChar LyX
13015 is printed correctly, but its caption
13017 However, you can use some \SpecialChar TeX
13018 code to overcome this problem, so that captions
13019 are printed as expected.
13020 To do so, create a float table as usual, remove the caption, and replace
13021 it with the \SpecialChar TeX
13032 (sic); you must also the \SpecialChar TeX
13037 immediately after the tabular material.
13038 Study the example table included in the template files to see how this
13039 trick is implemented.
13040 Alternatively, If you need table captions, you should implement the whole
13045 file, then include this file to the \SpecialChar LyX
13048 Insert\SpecialChar menuseparator
13049 File\SpecialChar menuseparator
13051 \begin_inset space ~
13057 Details on how to create a table float can be found in the files
13065 , included in the corresponding packages.
13068 \begin_layout Subsection
13069 Preparing a paper for submission
13072 \begin_layout Standard
13073 Before you submit your paper you must export the \SpecialChar LyX
13074 document as a \SpecialChar LaTeX
13077 File\SpecialChar menuseparator
13078 Export\SpecialChar menuseparator
13086 \begin_layout Plain Layout
13087 Actually you have the choice between \SpecialChar LaTeX
13088 (plain) and pdflatex.
13089 If you intend to use pdflatex to prepare the paper, you should use the
13090 pdflatex option so that included graphics are converted to PDF format,
13091 ready for use by pdflatex.
13096 , then make the following changes to the resulting
13103 \begin_layout Enumerate
13104 Remove the comment lines before the
13113 \begin_layout Enumerate
13114 Remove everything between (and including) the
13126 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13130 \begin_layout Standard
13135 file should be saved and processed through \SpecialChar LaTeX
13136 as many times as necessary.
13137 You may also want to check the resulting
13144 \begin_layout Section
13148 \begin_layout Standard
13154 \begin_layout Subsection
13158 \begin_layout Standard
13159 The iopart package provides a document class to create electronic manuscript
13160 submission to the journals published by the Institute of Physics.
13161 Instructions for the authors how to create a paper using the iopart class
13162 can be downloaded together with the iopart package from the site
13163 \begin_inset Flex URL
13166 \begin_layout Plain Layout
13168 ftp://ftp.iop.org/pub/journals/latex2e
13176 \begin_layout Subsection
13180 \begin_layout Standard
13181 The easiest way to write a paper is to start with the template
13185 that is available via
13187 File\SpecialChar menuseparator
13190 The template explains how to use the special text environments.
13191 Here are the most important advices:
13194 \begin_layout Itemize
13195 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13196 no AMS packages are loaded in
13198 Document\SpecialChar menuseparator
13199 Settings\SpecialChar menuseparator
13205 \begin_layout Itemize
13208 The title environment defines the kind of your paper.
13209 So use one of the following environments for the title:
13213 \begin_layout Itemize
13222 \begin_layout Itemize
13231 \begin_layout Itemize
13237 for a Topical review
13240 \begin_layout Itemize
13249 \begin_layout Itemize
13258 \begin_layout Itemize
13264 for a Paper (same as Title)
13267 \begin_layout Itemize
13273 for a Preliminary communication
13276 \begin_layout Itemize
13282 for a Rapid communication
13285 \begin_layout Itemize
13291 for a Letter to the editor
13295 \begin_layout Itemize
13298 All title environments except of
13302 can have an optional short title.
13305 \begin_layout Itemize
13306 There is a general title environment
13310 which is not directly supported by \SpecialChar LyX
13312 This can be used as \SpecialChar TeX
13313 code when your document doesn't fit into one of the
13317 \begin_layout Standard
13318 For more informations like hints for special table and formula formatting,
13319 look at the IOP author guidelines.
13322 \begin_layout Section
13326 \begin_layout Standard
13329 Panayotis Papasotiriou
13332 \begin_layout Subsection
13336 \begin_layout Standard
13337 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13338 that facilitates electronic manuscript submission to the journals they
13340 Most known of them (at least in my domain of interest) are
13342 Astrophysics and Space Science
13348 , but there are many others (see a complete list at
13349 \begin_inset Flex URL
13352 \begin_layout Plain Layout
13354 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13360 The Kluwer package may be downloaded from the site
13361 \begin_inset Flex URL
13364 \begin_layout Plain Layout
13366 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13372 A complete user guide is contained in that package (but it can also be
13373 downloaded separately).
13376 \begin_layout Standard
13378 supports many features of the package but not everything.
13379 However, the \SpecialChar TeX
13380 code needed is reduced to some
13381 \begin_inset Quotes eld
13385 \begin_inset Quotes erd
13388 commands of the package (see
13389 \begin_inset space ~
13393 \begin_inset CommandInset ref
13395 reference "subsec:kluwer_peculiarities"
13400 I have recently used \SpecialChar LyX
13401 to write an article submitted to the
13403 Astrophysics and Space Science
13405 without any problem.
13408 \begin_layout Subsection
13412 \begin_layout Standard
13413 The easiest way to write a paper is to start with the Kluwer template file.
13416 File\SpecialChar menuseparator
13428 This will give an (almost) empty document that includes the most common
13429 fields found in a manuscript and a short description of their use.
13430 As in most templates, simply overwrite the existing text (including the
13435 ) with the correct information.
13438 \begin_layout Subsection
13439 Preparing a paper for submission
13442 \begin_layout Standard
13443 As in the AAS\SpecialChar TeX
13444 package, before you submit your paper to a journal you must
13446 \begin_inset Quotes eld
13450 \begin_inset Quotes erd
13456 \begin_layout Enumerate
13457 Export your paper as a \SpecialChar LaTeX
13459 To do this, click on
13461 File\SpecialChar menuseparator
13462 Export\SpecialChar menuseparator
13470 \begin_layout Enumerate
13475 file with a text editor and make the following changes
13479 \begin_layout Enumerate
13480 remove the comment lines before the
13489 \begin_layout Enumerate
13490 remove everything between (and including) the
13502 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13506 \begin_layout Standard
13515 \begin_layout Enumerate
13520 file through \SpecialChar LaTeX
13521 as many times as necessary (usually up to three).
13524 \begin_layout Enumerate
13530 \begin_inset space \thinspace{}
13534 \begin_inset space \space{}
13541 , and check if everything is OK (it should, if you didn't make any mistake).
13544 \begin_layout Subsection
13545 \begin_inset Quotes eld
13549 \begin_inset Quotes erd
13552 of the Kluwer package
13553 \begin_inset CommandInset label
13555 name "subsec:kluwer_peculiarities"
13562 \begin_layout Standard
13563 The Kluwer package has the following
13564 \begin_inset Quotes eld
13568 \begin_inset Quotes erd
13574 \begin_layout Enumerate
13575 It is possible to write multiple articles in the same \SpecialChar LaTeX
13580 \begin_layout Plain Layout
13581 I can't imagine any good reason to do this.
13587 Each article must be included in the environment
13588 \begin_inset Quotes eld
13592 \begin_inset Quotes erd
13596 Unfortunately, this environment cannot be omitted, even if you write just
13598 Therefore, each article starts with the command
13604 and, obviously, ends with the command
13611 Although this can be implemented in \SpecialChar LyX
13612 , I didn't included it, since it looks
13613 ugly and can confuse the novice user.
13614 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13617 \begin_inset Quotes eld
13622 \begin_inset Quotes erd
13628 \begin_layout Enumerate
13629 Information given at the beginning of the article (i.
13630 \begin_inset space \thinspace{}
13634 \begin_inset space \space{}
13637 title, subtitle, author, institution, running title, running author, abstract
13638 and keywords) must be included in an environment called
13639 \begin_inset Quotes eld
13643 \begin_inset Quotes erd
13647 This is not implemented in \SpecialChar LyX
13648 , so you must enter title, subtitle etc.
13649 \begin_inset space ~
13652 between two \SpecialChar TeX
13668 \begin_layout Enumerate
13669 According to the user manual, the label of each bibliography item must be
13693 \begin_layout Standard
13698 template takes care of all these
13699 \begin_inset Quotes eld
13703 \begin_inset Quotes erd
13707 If you start a new paper using this template you don't need to do anything
13712 \begin_layout Enumerate
13713 don't delete the \SpecialChar TeX
13714 code included in the template, and
13717 \begin_layout Enumerate
13718 copy the example bibliography item included in the template and modify it
13719 as necessary to enter new bibliography items.
13722 \begin_layout Section
13726 \begin_layout Standard
13732 \begin_layout Subsection
13736 \begin_layout Standard
13737 The \SpecialChar LyX
13740 article (koma-script)
13744 report (koma-script)
13762 correspond to the \SpecialChar LaTeX
13780 \begin_inset space ~
13783 of the Koma-Script family.
13784 They are replacements for the standard document classes
13800 , resp., and fit better to European typography conventions in a number of
13804 \begin_layout Itemize
13805 Standard character size is 11pt in
13807 article (koma-script)
13811 report (koma-script)
13819 letter (koma-script)
13824 \begin_layout Itemize
13825 Headings, labels of the description environment, and a number of elements
13828 letter (koma-script)
13830 document class are set in a bold sans serif font.
13834 \begin_layout Plain Layout
13835 There is a big difference between the bold sans serif old cm fonts and new
13836 ec fonts, especially in the appearance of headings.
13837 In comparison, the ec bold sans serif fonts look a bit thin.
13838 Here the \SpecialChar LaTeX
13847 helps to produce the
13848 \begin_inset Quotes eld
13852 \begin_inset Quotes erd
13855 appearance when using the ec fonts.
13860 The numbering of chapter headings is made in the same way as the numbering
13861 of section headings, that is without the extra line
13862 \begin_inset Quotes eld
13865 Chapter\SpecialChar ldots
13867 \begin_inset Quotes erd
13871 In addition, the appearance of the headings can be modified by using a
13872 number of options (in \SpecialChar LyX
13873 to be entered in the field
13876 \begin_inset space ~
13883 Layout\SpecialChar menuseparator
13890 \begin_layout Itemize
13891 The main means in the Koma-Script document classes to design the type area
13900 (in \SpecialChar LyX
13901 to be entered in the extra class options field in the dialog
13903 Document\SpecialChar menuseparator
13907 They make a clearer modification of page margins possible as do the options
13910 Document\SpecialChar menuseparator
13917 \begin_layout Itemize
13918 The \SpecialChar LaTeX
13919 document classes of the Koma-Script family define a number of additional
13921 Those part of it which makes sense in \SpecialChar LyX
13922 is implemented in corresponding
13926 \begin_layout Standard
13927 Detailed descriptions of the \SpecialChar LaTeX
13928 document classes of the Koma-Script family
13929 can be found in the Koma-Script documentation
13940 \begin_layout Subsection
13941 article (koma-script), report (koma-script), and book (koma-script)
13944 \begin_layout Standard
13945 The document classes
13947 article (koma-script)
13951 report (koma-script)
13961 are implemented in the layout files
13974 They contain all the paragraph types of the corresponding standard document
13987 , resp., partly modified, with the exception of the \SpecialChar LyX
13992 -type, which is replaced by the new
13996 -type having the same functionality.
14001 -Type there is a number of new paragraph types added.
14008 letter (koma-script)
14013 \begin_layout Itemize
14022 : are equivalents to
14030 , resp., additionally inserting an entry in the table of contents.
14039 are not contained in
14041 article (koma-script)
14046 \begin_layout Itemize
14055 : behave exactly as
14063 , resp., additionally clearing running heads.
14068 is not contained in
14070 article (koma-script)
14076 \begin_layout Plain Layout
14089 report (koma-script)
14091 , but since this is identical to
14095 , is has not been implemented in \SpecialChar LyX
14104 \begin_layout Itemize
14109 : generates a heading directly above the following paragraph in the standard
14110 character size without affecting the structure of the document.
14113 \begin_layout Itemize
14122 are special captions which respect the different space settings needed
14123 for captions placed above or below an element (if you follow strict typographic
14124 rules, you might want to place table captions always above the table).
14125 You can also use the class option
14129 , which will switch
14142 You need at least Koma-Script version 2.8q to use this.
14145 \begin_layout Itemize
14150 : can be used to set a bonmot, e.
14151 \begin_inset space \thinspace{}
14155 \begin_inset space \space{}
14158 at the beginning of a chapter.
14159 If you use the optional argument (
14161 Insert\SpecialChar menuseparator
14163 \begin_inset space ~
14168 ), you can insert the dictum's author there.
14169 Dictum and author are separated by a line.
14170 You need at least Koma-Script version 2.8q to use this.
14175 is not contained in
14177 article (koma-script)
14182 \begin_layout Standard
14183 The following types, together with the standard types
14195 , form the title area of the document.
14196 They must be entered ahead of the first
14197 \begin_inset Quotes eld
14201 \begin_inset Quotes erd
14208 \begin_layout Plain Layout
14209 The corresponding \SpecialChar LaTeX
14210 commands must appear before the
14221 When such a type is used more than once, the latter usage overwrites the
14222 former one, that means, for every type only the latest usage is valid.
14223 The order of the different types however has, like
14235 , no effect on the appearance of the produced document.
14238 \begin_layout Itemize
14243 : produces a centered paragraph above the ordinary title (
14255 ) for the subject of the document.
14258 \begin_layout Itemize
14263 : produces a centered paragraph below the ordinary title (
14275 ) for the publishers' name.
14278 \begin_layout Itemize
14285 report (koma-script)
14291 produces a centered paragraph on its own page behind the title page, or
14294 article (koma-script)
14296 produces a centered paragraph below the ordinary title (
14312 ) for a dedication.
14315 \begin_layout Itemize
14320 : produces a left aligned paragraph above the ordinary title (
14336 ) for a document`s head.
14339 \begin_layout Itemize
14344 : produces in a double-sided print in
14346 report (koma-script)
14352 a left-aligned paragraph at the top of the title page`s back or has no
14353 effect in a single-sided print or in
14355 article (koma-script)
14360 \begin_layout Itemize
14365 : produces in a double-sided print in
14367 report (koma-script)
14373 a left-aligned paragraph at the bottom of the title page`s back or has
14374 no effect in a single-sided print or in
14376 article (koma-script)
14381 \begin_layout Itemize
14386 : produces a special
14387 \begin_inset Quotes eld
14391 \begin_inset Quotes erd
14394 page ahead of the actual document containing a paragraph without special
14398 \begin_layout Standard
14399 The layout files for the document classes
14401 article (koma-script)
14405 report (koma-script)
14411 do include the file
14416 This is thought of as a place to define your own types.
14421 in your personal layout directory and edit the file!
14424 \begin_layout Subsection
14425 letter (koma-script)
14428 \begin_layout Description
14429 Note: This section discusses the obsolete
14431 KOMA-Script-Letter (v.
14432 \begin_inset space ~
14437 , which is not even included anymore in recent KOMA releases.
14438 Please refer to the next section for the current KOMA-Script-Letter class
14440 \begin_inset space ~
14446 \begin_layout Standard
14450 letter (koma-script)
14452 is implemented in the layout file
14457 It contains all the paragraph types of the corresponding standard document
14462 , partly modified, with the exception of the \SpecialChar LyX
14476 type, which is replaced by the new
14481 In addition, it contains, in contrast to the standard document class, the
14500 Furthermore, there are a number of new letter specific types.
14503 \begin_layout Standard
14504 The appearance of the letter produced by this document class can be controlled
14505 by a number of \SpecialChar LaTeX
14506 commands, which you can put in the \SpecialChar LaTeX
14511 \begin_layout Plain Layout
14512 For example, the standard appearance of the letter`s heading, consisting
14513 of name and address, is quite self-willed.
14515 \begin_inset Quotes eld
14519 \begin_inset Quotes erd
14522 heading is produced by the following \SpecialChar LaTeX
14523 commands in the preamble:
14526 \begin_layout LyX-Code
14536 \begin_layout LyX-Code
14552 \begin_layout LyX-Code
14562 \begin_layout LyX-Code
14582 A detailed German description of such \SpecialChar LaTeX
14583 commands can be found in the Koma-Script
14589 With it, the letter's author can produce his personal letter layout.
14592 \begin_layout Standard
14601 define the beginning of the letter and must be used in every letter.
14602 To emphasize them in the \SpecialChar LyX
14603 document class, they are marked with the letter
14613 \begin_inset space ~
14616 in the left margin.
14617 It is possible to write any number of letters in one file.
14622 type produces a new letter using the same addressee and a
14626 type produces a new addressee.
14643 are ordinary paragraph types and can also be used several times in one
14644 and the same letter.
14647 \begin_layout Itemize
14652 : produces a paragraph for the addressee and implicitly defines the beginning
14656 \begin_layout Itemize
14661 : produces a paragraph for the form of address and implicitly produces a
14665 \begin_layout Itemize
14670 : produces a paragraph for a close.
14673 \begin_layout Itemize
14678 : produces a paragraph for a postscript.
14681 \begin_layout Itemize
14686 : produces a paragraph for a distribution list.
14689 \begin_layout Itemize
14694 : produces a paragraph for enclosures.
14697 \begin_layout Standard
14738 are input types provided with a label to enter information, which will
14739 be processed by the document class.
14743 \begin_layout Plain Layout
14744 It could be seen as a matter of inconsequence, that the types
14752 described above are not such input types as well.
14753 Because of the special meaning of those types, however, I have implemented
14754 them as ordinary paragraph types with a one letter mark in the left margin.
14755 Moreover, it would affect my feeling of symmetry, if the
14763 type had such a serious different appearance.
14768 The types must be used ahead of the corresponding
14775 \begin_layout Standard
14776 An implementation of these types in a WYSIWYG fashion does not seem to make
14777 sense, because the real appearance of the produced letter does not only
14778 depend on the usage of the particular type, but also on other factors.
14779 For example, a signature entered in the
14783 type will in the standard behavior appear in the produced letter only,
14784 when in the same letter also a
14789 The entered value of the
14793 type will in the standard behavior not appear in the produced letter at
14795 The possibility to design the letter`s heading freely is already indicated
14796 in a footnote above.
14799 \begin_layout Standard
14800 The input types can also be used as empty paragraphs.
14801 This makes sense e.
14802 \begin_inset space \thinspace{}
14806 \begin_inset space \space{}
14818 type is not used at all, in the standard behavior the value of the
14822 type is used as signature, whereas if an empty
14826 type is used, no signature value is defined.
14829 \begin_layout Standard
14830 By using the input types it is possible to write a letter template, containing
14831 filled input types with your personal dates (name, address, etc.) and empty
14832 input types for other dates you want to enter.
14835 \begin_layout Itemize
14840 : sender's name, in the standard behavior appears as a centered paragraph
14841 in small caps in the letter`s heading.
14844 \begin_layout Itemize
14849 : sender's signature, in the standard behavior appears below the
14858 type is used, the value of the
14862 type appears instead.
14865 \begin_layout Itemize
14870 : sender's address, in the standard behavior appears in a centered paragraph
14871 in the letter`s heading below the sender's name.
14874 \begin_layout Itemize
14879 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
14890 \begin_layout Itemize
14895 : place of the letter`s making.
14898 \begin_layout Itemize
14903 : date of the letter`s making.
14912 , in the standard behavior, produce the place and the date in a right-aligned
14913 line below the addressee's field.
14918 type is used, neither place nor date appear, independent of the value of
14928 type is used, the date of the letter `s production is used.
14931 \begin_layout Itemize
14936 : sender`s back address, in the standard behavior appears above the addressee's
14937 field in a small sans serif font.
14940 \begin_layout Itemize
14945 : special mail information, in the standard behavior appears underlined
14946 above the addressee's field below the back address.
14949 \begin_layout Itemize
14954 : additional information, in the standard behavior appears on right side
14955 below the addressee`s field.
14958 \begin_layout Itemize
14963 : the letter's title, in the standard behavior appears in a big, bold, sans
14964 serif font above the subject.
14967 \begin_layout Itemize
14972 : the letter's subject, in the standard behavior appears in a bold font
14980 \begin_layout Standard
15001 produce a business letter like line above the
15005 line containing the fields
15006 \begin_inset Quotes eld
15010 \begin_inset Quotes erd
15014 \begin_inset Quotes eld
15018 \begin_inset Quotes erd
15022 \begin_inset Quotes eld
15026 \begin_inset Quotes erd
15030 \begin_inset Quotes eld
15034 \begin_inset Quotes erd
15038 \begin_inset Quotes eld
15042 \begin_inset Quotes erd
15046 \begin_inset Quotes eld
15050 \begin_inset Quotes erd
15054 For the date field, the value of the
15060 \begin_inset Quotes eld
15063 business letter types
15064 \begin_inset Quotes erd
15067 is used, the value of the
15071 type however does not appear, but only the \SpecialChar LaTeX
15079 The ordinary output of place and date in a right-aligned line below the
15080 addressee`s field is suppressed.
15081 The types are implemented as input types provided with a label and must
15082 be used ahead of the corresponding
15089 \begin_layout Itemize
15097 \begin_layout Itemize
15105 \begin_layout Itemize
15113 \begin_layout Itemize
15121 \begin_layout Itemize
15129 \begin_layout Subsection
15130 The new letter class: letter (koma-script v.2)
15133 \begin_layout Standard
15136 Jürgen Spitzmüller
15139 \begin_layout Standard
15140 \begin_inset VSpace medskip
15146 \begin_layout Standard
15148 Koma-Script version 2.8 has introduced a new letter class
15152 which supersedes the now unsupported
15157 It has — on the \SpecialChar LaTeX
15158 side — a completely new interface and is not compatible
15159 with the old class.
15160 Therefore, \SpecialChar LyX
15161 supports both, though it is recommended you use the new class.
15164 \begin_layout Standard
15165 This class covers the same functionality as
15167 letter (koma-script),
15170 The basic items are
15174 (receiver's address, same as
15178 in the old layout),
15191 will start a new letter (i.
15192 \begin_inset space \thinspace{}
15196 \begin_inset space \space{}
15199 you can write several letters per document).
15200 New elements are sender's
15216 and the possibility to use a
15222 Insert\SpecialChar menuseparator
15228 \begin_layout Standard
15229 The biggest improvement is, though, that the letter's layout is configurable
15230 to meet almost any needs.
15231 This can be done via the preamble or with a special style file (Letter
15232 Class Option, extension
15236 ), that will be read in as a class option.
15240 \begin_layout Plain Layout
15241 The KOMA package comes with some default
15246 There is, for instance, a
15250 file that follows german typesetting rules, or a
15254 that provides the default layout of the old
15259 The latter can be loaded with the class option
15265 Layout\SpecialChar menuseparator
15266 Document\SpecialChar menuseparator
15278 template that is included in \SpecialChar LyX
15280 A detailed description is to be found in the Koma-Script documentation
15288 \begin_layout Subsection
15292 \begin_layout Standard
15293 Visualizing the Koma-Script document classes in \SpecialChar LyX
15294 , the \SpecialChar LyX
15295 internals cause some
15299 \begin_layout Itemize
15300 The chapter number of a
15304 type appears on a line of its own above the chapter heading instead of
15305 appearing in the same line ahead of it.
15306 The cause for that is the \SpecialChar LyX
15307 internal behavior for the labeltype
15311 in the layout file.
15314 \begin_layout Itemize
15315 The headings of the types
15323 are only put in the
15324 \begin_inset Quotes eld
15328 \begin_inset Quotes erd
15332 table of contents, but not in the \SpecialChar LyX
15333 table of contents (
15335 Document\SpecialChar menuseparator
15337 \begin_inset space ~
15341 \begin_inset space ~
15349 \begin_layout Itemize
15350 The paragraphs in a
15354 document class appear in a skip separation mode, not indented.
15355 This is the standard behavior, no special \SpecialChar LaTeX
15356 commands are needed for that.
15359 Document\SpecialChar menuseparator
15362 dialog the corresponding radio button indicates
15371 value always has the effect that extra \SpecialChar LaTeX
15372 commands are inserted in the document
15373 to produce the gap, which is not what is wanted in this case.
15376 \begin_layout Section
15380 \begin_layout Standard
15383 Jürgen Spitzmüller
15386 \begin_layout Subsection
15390 \begin_layout Standard
15391 Memoir is a very powerful and constantly evolving class.
15392 It has been designed with regard to fictional and non-fictional literature.
15393 Its aim is to let the user have maximum control over the typesetting of
15395 Memoir is based on the standard book class, but it can also emulate the
15396 article class (see below).
15399 \begin_layout Standard
15400 Peter Wilson, the developer of Memoir, is known as the author of lots of
15401 useful packages in the \SpecialChar LaTeX
15403 Most of them have been merged with Memoir.
15404 Therefore, it is much easier to layout the table of contents, appendices,
15405 chapter designs and such.
15407 , though, does not support all of these goodies natively.
15408 Some of them might be added to forthcoming releases
15412 \begin_layout Plain Layout
15413 You are invited to send suggestions to
15414 \begin_inset Flex URL
15417 \begin_layout Plain Layout
15419 lyx-devel@lists.lyx.org
15429 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15431 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15433 commands (\SpecialChar TeX
15438 \begin_layout Plain Layout
15443 \begin_layout Plain Layout
15453 \begin_inset space ~
15457 \begin_inset CommandInset ref
15459 reference "sec:Inserting-TeX-Code"
15469 In this section, we can only list those features that are natively supported
15470 by \SpecialChar LyX
15472 For detailed descriptions (and for the rest of features) we recommend you
15473 have a look at the detailed manual of the Memoir class
15477 \begin_layout Plain Layout
15482 \begin_layout Plain Layout
15492 \begin_inset Flex URL
15495 \begin_layout Plain Layout
15497 CTAN:/macros/latex/memoir/memman.pdf
15507 , which is not only a user guide for the class, but also both a comprehensive
15508 description on good typesetting and a superb example for good typesetting
15512 \begin_layout Subsection
15513 Basic features and restrictions
15516 \begin_layout Standard
15517 Memoir supports basically all features of the standard book classes.
15518 There are, however, some differences, as follows:
15521 \begin_layout Description
15523 \begin_inset space ~
15526 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15529 \begin_layout Description
15531 \begin_inset space ~
15534 style: The fancy page style is not supported, due to a command clash between
15535 Memoir and the fancyhdr package (they both define a command with the same
15536 name, which confuses \SpecialChar LaTeX
15538 Instead, Memoir comes with a number of its own page styles (see
15540 Document\SpecialChar menuseparator
15541 Settings\SpecialChar menuseparator
15543 \begin_inset space ~
15549 If you want to use these for the chapter pages, you have to use the command
15556 in the main text or in preamble (e.
15557 \begin_inset space \thinspace{}
15561 \begin_inset space \space{}
15568 chapterstyle{companion}
15573 \begin_layout Description
15574 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15575 optional argument in the standard classes.
15576 With this, you can specify an alternative version of the title for the
15577 table of contents and the headers (for instance, if the title is too long).
15578 In \SpecialChar LyX
15579 , you can do this via
15581 Insert\SpecialChar menuseparator
15583 \begin_inset space ~
15588 at the beginning of a chapter/section.
15589 Memoir features a second optional argument and thus separates the table
15590 of contents from the header.
15591 You can define three variants of a title with this: one for the main text,
15592 one for the table of contents, and one for the headers.
15594 makes these available in form of specific
15605 \begin_layout Description
15606 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15607 of contents, the list of figures and the list of table start a new page
15609 Memoir does not follow this route.
15610 You have to insert a page break yourself, if you want to have one.
15613 \begin_layout Description
15614 Titlepage: For some unknown reason, Memoir uses pagination on the title
15615 page (in the standard classes, title pages are
15616 \begin_inset Quotes eld
15620 \begin_inset Quotes erd
15624 If you want an empty title page, type
15628 aliaspagestyle{title}{empty}
15633 \begin_layout Description
15634 Article: With the class option
15640 Document\SpecialChar menuseparator
15641 Settings\SpecialChar menuseparator
15642 Class Settings\SpecialChar menuseparator
15644 \begin_inset space ~
15649 ), you can emulate article style.
15650 That is, counters (footnotes, figures, tables etc.) will not be reset on
15651 new chapters, chapters don't start a new page (but are—in contrary to
15652 \begin_inset Quotes eld
15656 \begin_inset Quotes erd
15659 article classes—still allowed), parts, though, use their own page, as in
15663 \begin_layout Description
15664 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15665 font commands, which have been used in the old \SpecialChar LaTeX
15667 \begin_inset space \thinspace{}
15671 \begin_inset space \space{}
15687 It produces an error and stops \SpecialChar LaTeX
15688 whenever such a command appears.
15693 reallows the commands and spits out warnings instead (which does at least
15694 not stop \SpecialChar LaTeX
15696 Since a lot of packages and particularly Bib\SpecialChar TeX
15697 style files are still using
15698 those commands, we have decided to use this option by default.
15701 \begin_layout Subsection
15705 \begin_layout Standard
15706 We will only describe the features supported by \SpecialChar LyX
15707 (which is not much currently).
15708 Please consult the Memoir manual
15712 \begin_layout Plain Layout
15717 \begin_layout Plain Layout
15727 \begin_inset Flex URL
15730 \begin_layout Plain Layout
15732 CTAN:/macros/latex/memoir/memman.pdf
15745 \begin_layout Description
15746 Abstract: You may wonder why an abstract is an extra feature.
15747 Well, it is in book class.
15748 Usually books don't have abstracts.
15749 Memoir, however, has.
15750 You can use it wherever and how often you like.
15753 \begin_layout Description
15754 Chapterprecis: You may know this older typesetting style: The contents of
15755 a chapter are summarized below the title and also in the table of contents
15757 \begin_inset space \thinspace{}
15761 \begin_inset space \space{}
15766 Our hero arrives in Troia; he loses some friends; he finds others
15769 Chapterprecis does exactly this.
15770 It is therefore only sensible below a chapter.
15773 \begin_layout Description
15774 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15775 The epigraph environment provides an elegant way of typesetting such a
15777 The motto itself (text) and its (optional) author (source) are divided
15779 The author (source) can be inserted via
15781 Insert\SpecialChar menuseparator
15788 \begin_layout Description
15789 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15790 complex figurative poems).
15792 can only support a few of them.
15793 One is poemtitle, which is a centered title for poems, which will also
15794 be added to the table of contents (verse is the standard environment for
15796 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
15798 because they have to be nested inside regular verse environments, which
15799 is not possible with \SpecialChar LyX
15803 \begin_layout Description
15804 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15807 \begin_layout Section
15808 Article (mwart), book (mwbk) and report (mwrep)
15809 \begin_inset Argument status
15812 \begin_layout Plain Layout
15825 \begin_layout Standard
15831 \begin_layout Standard
15832 The \SpecialChar LyX
15849 correspond to the \SpecialChar LaTeX
15863 They are replacements for the standard document classes
15875 , resp., and fit better to Polish typography conventions in a number of points.
15879 \begin_layout Standard
15883 \begin_layout Itemize
15884 Unnumbered titles (with star, e.
15885 \begin_inset space \thinspace{}
15889 \begin_inset space \space{}
15896 ) are added into table of contents,
15899 \begin_layout Itemize
15900 Additional page styles:
15904 \begin_layout Description
15905 uheadings header with separated lines,
15908 \begin_layout Description
15909 myheadings custom header, contents headers via commands:
15924 \begin_layout Description
15925 myuheadings custom header with separated lines,
15928 \begin_layout Description
15929 outer page number is placed on outer side of page
15933 \begin_layout Itemize
15938 \begin_layout Description
15939 rmheadings serif titles — default,
15942 \begin_layout Description
15943 sfheadings sansserif titles,
15946 \begin_layout Description
15947 authortitle on title page first placed is author next title — default,
15950 \begin_layout Description
15951 titleauthor on title page first placed is title next author,
15954 \begin_layout Description
15955 withmarginpar reserve place on page for margins.
15959 \begin_layout Section
15963 \begin_layout Standard
15968 provides an alternative to the standard
15973 It provides similar functionality, but you might prefer this layout with
15974 sans serif sections, headings, and more.
15977 \begin_layout Section
15978 Rev\SpecialChar TeX
15982 \begin_layout Standard
15988 \begin_layout Standard
15989 \begin_inset VSpace bigskip
15995 \begin_layout Standard
16000 \begin_inset space ~
16005 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16007 \begin_inset Formula $\beta$
16010 release of May, 1999) class.
16013 \begin_layout Standard
16019 textclass, which works with Rev\SpecialChar TeX
16021 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16023 That means that it doesn't interact very well with \SpecialChar LyX
16024 , which requires \SpecialChar LaTeX2e
16026 it has been kludged to work.
16027 Since Rev\SpecialChar TeX
16028 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16033 Rev\SpecialChar TeX
16035 \begin_inset space ~
16040 textclass should also be pretty easy to use.
16043 \begin_layout Standard
16044 These documents are supposed to be used in
16048 to the Rev\SpecialChar TeX
16049 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16051 and assume you'll know what to put in the preamble if necessary.
16054 \begin_layout Subsection
16058 \begin_layout Standard
16059 All you need to do is install Rev\SpecialChar TeX
16060 4, as described in the package's README
16062 The package can be found at The Rev\SpecialChar TeX
16064 \begin_inset Flex URL
16067 \begin_layout Plain Layout
16069 http://publish.aps.org/revtex4/
16075 Install it somewhere that \SpecialChar LaTeX
16077 Test it by trying to \SpecialChar LaTeX
16078 a short Rev\SpecialChar TeX
16079 4 document in some random directory (i.
16080 \begin_inset space \thinspace{}
16084 \begin_inset space \space{}
16087 not the directory where you installed the class file.) Then, if you reconfigure
16089 , it will find the class file and let you use the Rev\SpecialChar TeX
16093 \begin_layout Standard
16094 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16103 \begin_inset space ~
16108 template, found in the templates directory.
16111 \begin_layout Subsection
16115 \begin_layout Standard
16116 Optional arguments to
16123 \begin_inset Quotes eld
16127 \begin_inset Quotes erd
16131 \begin_inset Quotes eld
16135 \begin_inset Quotes erd
16141 \begin_inset space ~
16149 \begin_inset space ~
16155 Remember that in Rev\SpecialChar TeX
16156 , at least one optional argument is required!
16159 \begin_layout Standard
16160 Other preamble matter, like
16167 \begin_inset space ~
16174 \begin_inset space ~
16179 dialog, also as usual.
16182 \begin_layout Subsection
16186 \begin_layout Standard
16187 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16189 For example, the Email layout corresponds to
16196 Note that (at least as of Rev\SpecialChar TeX
16205 layouts are exactly equivalent, so you shouldn't need to use both.
16209 \begin_layout Plain Layout
16210 In case you're curious, both were included so that
16214 would be able to translate both
16234 \begin_layout Subsection
16238 \begin_layout Standard
16239 There are a couple of important unique aspects of Rev\SpecialChar TeX
16240 4 which might cause
16241 bugs that will be even more confusing in \SpecialChar LyX
16245 \begin_layout Standard
16246 In Rev\SpecialChar TeX
16264 The \SpecialChar LyX
16265 equivalent is that there is a separate Thanks layout.
16270 write footnotes in the
16274 layout, or weird things may happen.
16275 See the Rev\SpecialChar TeX
16276 4 documentation for more details.
16279 \begin_layout Standard
16283 \begin_inset space ~
16291 \begin_inset space ~
16300 layouts must be placed
16308 layout and the corresponding
16325 , the \SpecialChar LaTeX
16329 \begin_layout Section
16330 Springer Journals (
16337 \begin_layout Standard
16343 \begin_layout Subsection
16347 \begin_layout Standard
16348 These are the layout files for some of the journal formats used by Springer
16349 Verlag and listed on
16350 \begin_inset Flex URL
16353 \begin_layout Plain Layout
16355 http://www.springer.de/author/tex/help-journals.html
16360 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16362 It is a modular system: the things common to all journals are implemented
16367 , which journal-specific layout files (such as, e.
16368 \begin_inset space \thinspace{}
16372 \begin_inset space \space{}
16379 for Journal of Geodesy) can include.
16382 \begin_layout Standard
16383 This means that implementing support for any other Springer journal on this
16384 list is as simple as writing your own
16392 file following the outline given in
16400 \begin_layout Standard
16401 It is reasonably well tested only for the Journal of Geodesy.
16410 come with the standard \SpecialChar LyX
16412 Install the relevant class file (downloaded from Springer) in a proper
16413 directory, reconfigure \SpecialChar LaTeX
16414 (in the te\SpecialChar TeX
16419 , as root if necessary — doesn't \SpecialChar LyX
16420 take care of this?), reconfigure \SpecialChar LyX
16425 \begin_layout Subsection
16429 \begin_layout Standard
16430 A large number of theorem-like styles —
16442 \begin_layout Standard
16445 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16446 _Title, Author_Running, Institute,
16447 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16450 See the Springer class file documentation for details.
16453 \begin_layout Subsection
16457 \begin_layout Itemize
16469 \begin_layout Itemize
16472 Probability Theory and Related Fields
16478 — Jean-Marc Lasgouttes
16481 \begin_layout Standard
16482 Add your own, it isn't so hard!
16485 \begin_layout Subsection
16489 \begin_layout Standard
16490 These files are partly based on the older
16494 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16496 file from Springer.
16501 layout, are now defunct.
16502 Jean-Marc Lasgouttes helped out big in making me find my way around the
16504 layout file mechanism.
16507 \begin_layout Subsection
16511 \begin_layout Standard
16513 But probably less than in the old hacked-\SpecialChar LaTeX
16521 \begin_layout Section
16524 Sli\SpecialChar TeX
16528 \begin_inset CommandInset label
16537 \begin_layout Standard
16545 \begin_layout Subsection
16549 \begin_layout Standard
16550 This section describes how to use \SpecialChar LyX
16551 to make slides for overhead projectors.
16552 There are two document classes that can do this: the default slides class
16555 Foil\SpecialChar TeX
16559 This section documents the former.
16562 \begin_layout Standard
16563 I'm going to say this again, nice and clear, so that there's no misunderstanding
16567 \begin_layout Standard
16568 \begin_inset VSpace bigskip
16574 \begin_layout Standard
16578 This section documents the class
16579 \begin_inset Quotes eld
16587 \begin_inset Quotes erd
16595 \begin_layout Standard
16596 \begin_inset VSpace bigskip
16602 \begin_layout Standard
16603 If you're looking for the documentation for
16604 \begin_inset Quotes eld
16609 slides (Foil\SpecialChar TeX
16613 \begin_inset Quotes erd
16616 , check out section
16617 \begin_inset space ~
16621 \begin_inset CommandInset ref
16623 reference "sec:foiltex"
16633 \begin_inset Quotes eld
16638 slides (Foil\SpecialChar TeX
16642 \begin_inset Quotes erd
16645 ] is actually somewhat better than the default
16653 \begin_layout Plain Layout
16655 or so I've been told repeatedly by its advocates.
16656 Having never used it, I have no idea if this claim is true or not.
16661 which this section documents.
16664 \begin_layout Standard
16665 This class is the \SpecialChar LaTeX2e
16666 improvement of the old
16668 Sli\SpecialChar TeX
16672 Every \SpecialChar LaTeX2e
16673 distribution includes this class [which I'll just refer to as
16674 \begin_inset Quotes eld
16682 \begin_inset Quotes erd
16685 from now on], so you're bound to have it.
16686 As I noted earlier, there are other classes, such as
16690 , which also produce slides for overhead projectors and do a better job
16692 However, there are some things which
16696 can do which the others can't, such as generate overlays.
16697 Read on to learn more!
16700 \begin_layout Subsection
16702 \begin_inset CommandInset label
16704 name "sec:slidesetup"
16711 \begin_layout Standard
16712 Obviously, to use this document class, you need to select
16713 \begin_inset Quotes eld
16721 \begin_inset Quotes erd
16724 from the class list in the
16726 Document\SpecialChar menuseparator
16730 There are some other special things you should know about this class:
16733 \begin_layout Itemize
16734 Don't bother changing the options
16739 They're not supported by the
16746 \begin_layout Itemize
16750 \begin_inset space ~
16755 behaves a bit differently for this class.
16756 The possible choices and what they do are as follows:
16760 \begin_layout Description
16765 The final output contains page numbers in the lower right corner.
16768 \begin_layout Description
16777 , but also prints out any time markers you've put in.
16778 This is the default.
16781 \begin_layout Description
16786 The final output contains no page numbers, time markers, or alignment markers.
16790 \begin_layout Itemize
16795 class has an extra option:
16801 \begin_inset Quotes eld
16809 \begin_inset Quotes erd
16812 in the extra class options.
16816 \begin_layout Standard
16817 Using this options allows you to add time markers to
16823 \begin_inset space ~
16827 \begin_inset CommandInset ref
16829 reference "sec:slideNote"
16837 \begin_layout Standard
16838 You can also use the template file
16839 \begin_inset Quotes eld
16847 \begin_inset Quotes erd
16850 to automatically set up a document to use the
16856 File\SpecialChar menuseparator
16858 \begin_inset space ~
16862 \begin_inset space ~
16867 to open your new document].
16868 The template file also contains some examples of the special paragraph
16869 environments used by this class.
16870 I'll describe those next.
16873 \begin_layout Subsection
16874 Paragraph Environments
16877 \begin_layout Subsubsection
16878 Supported Environments
16881 \begin_layout Standard
16882 The first thing you'll notice when you start up a new
16886 document is the font size and type: it's the equivalent of the size
16887 \begin_inset Quotes eld
16895 \begin_inset Quotes erd
16901 \begin_inset space ~
16907 This is also what's used in the output.
16909 \begin_inset Quotes eld
16913 \begin_inset Quotes erd
16916 to remind you that this is a slide.
16917 Your final slides will use a larger font; ergo, you'll have less space.
16918 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
16921 \begin_layout Standard
16922 The next thing that becomes obvious is the changes to the paragraph environment
16923 pull-down box [at the far-left end of the toolbar].
16924 Most of the paragraph environments you're used to seeing are missing.
16925 There are also five new ones.
16930 class itself only supports certain paragraph environments:
16933 \begin_layout Itemize
16939 \begin_layout Itemize
16945 \begin_layout Itemize
16951 \begin_layout Itemize
16957 \begin_layout Itemize
16963 \begin_layout Itemize
16969 \begin_layout Itemize
16975 \begin_layout Itemize
16981 \begin_layout Itemize
16987 \begin_layout Itemize
16994 \begin_layout Standard
16995 All of the other standard environments, including the section-heading environmen
16996 ts, aren't used in the
17003 \begin_layout Standard
17004 On the other hand, you'll notice the following new environments:
17007 \begin_layout Itemize
17013 \begin_layout Itemize
17019 \begin_layout Itemize
17025 \begin_layout Itemize
17031 \begin_layout Itemize
17037 \begin_layout Standard
17038 These five are kind of quirky, due to a
17039 \begin_inset Quotes eld
17043 \begin_inset Quotes erd
17046 in \SpecialChar LyX
17048 You see, \SpecialChar LyX
17049 doesn't permit you to nest any other paragraph environment into
17050 an empty environment.
17051 Now, that's fine and dandy, but it means that you wouldn't be able to start
17052 a slide with anything except plain text.
17053 To deal with this, I've performed a little
17054 \begin_inset Quotes eld
17059 \begin_inset Quotes erd
17065 \begin_layout Subsubsection
17066 Quirks of the New Environments
17067 \begin_inset CommandInset label
17069 name "sec:slideQuirk"
17076 \begin_layout Standard
17077 All five of the new paragraph environments are somewhat quirky due to inherent
17078 limitiations in the current version of \SpecialChar LyX
17080 As I just mentioned, \SpecialChar LyX
17081 forbids environments that begin with another environment.
17082 To get around this, the
17086 environment isn't a paragraph environment as described in the
17094 \begin_layout Standard
17095 You should consider
17108 \begin_inset Quotes eld
17111 pseudo-environments.
17112 \begin_inset Quotes erd
17115 They look like a section heading or a
17116 \begin_inset Quotes eld
17124 \begin_inset Quotes erd
17127 but really begin a [and, if necessary, end the previous] paragraph environment.
17137 \begin_inset Quotes eld
17141 \begin_inset Quotes erd
17144 These two perform some action.
17147 \begin_layout Standard
17148 A common feature of all five environments,
17168 , is a rather long-ish label.
17169 The text following this label — ordinarily the contents of the paragraph
17170 environment — is utterly irrelevant for
17192 completely ignores it.
17193 In fact, you can leave these five environments completely empty.
17197 \begin_layout Standard
17202 to put any text after the rather long-ish label, you might want to.
17203 This could be a short description of the contents of the
17208 In that case, enter your descriptive comment and hit
17212 as you normally would.
17215 \begin_layout Standard
17216 If, on the other hand, you don't want to enter any descriptive text, you'll
17217 hit another \SpecialChar LyX
17220 , like nature, abhors a vacuum, and will not let you start a new paragraph
17221 environment until you put something in the old one.
17225 \begin_layout Itemize
17226 Start entering the text that will
17254 \begin_layout Itemize
17255 Now move to the beginning of that paragraph.
17259 \begin_layout Itemize
17268 \begin_layout Itemize
17269 Finally, change this new, empty paragraph to a
17293 \begin_layout Standard
17294 Some future version of \SpecialChar LyX
17295 will, hopefully, resolve this quirkiness\SpecialChar ldots
17299 \begin_layout Subsection
17300 Making a Presentation with
17313 \begin_layout Subsubsection
17321 \begin_layout Standard
17322 If you're expecting this section to teach you how to actually make a presentatio
17323 n, you'll be sorely disappointed.
17324 Naturally, I'll describe all of the ways the
17328 class can assist you in preparing the materials for a presentation.
17329 Filling in the contents, however, is up to you.
17334 the \SpecialChar LyX
17338 \begin_layout Standard
17343 environment [in the manner described in section
17344 \begin_inset space ~
17348 \begin_inset CommandInset ref
17350 reference "sec:slideQuirk"
17354 ] tells \SpecialChar LyX
17355 to begin a new slide [duh].
17356 The label for this environment/
17357 \begin_inset Quotes erd
17361 \begin_inset Quotes erd
17365 \begin_inset Quotes eld
17369 \begin_inset Quotes erd
17372 in cool blue, followed by the label,
17373 \begin_inset Quotes eld
17377 \begin_inset Quotes erd
17381 Any text or paragraph environments that follow this one go on the new slide.
17385 \begin_layout Standard
17386 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17388 (this can be specified in the
17393 In fact, you'll want to, once you finish entering the contents of one slide.
17394 If you've entered more text than can physically fit on a slide, the extra
17395 overflows onto a new slide.
17396 I don't recommend doing this, however, since the overflow slide won't have
17397 any page number on it.
17398 Furthermore, it may interfere with any
17402 you've made to accompany the oversized
17409 \begin_layout Standard
17418 environments work the same way as the
17423 They both create an
17424 \begin_inset Quotes eld
17428 \begin_inset Quotes erd
17431 followed by a label [
17432 \begin_inset Quotes eld
17436 \begin_inset Quotes erd
17440 \begin_inset Quotes eld
17444 \begin_inset Quotes erd
17448 The color is a stunning magenta instead of blue, and the
17449 \begin_inset Quotes eld
17453 \begin_inset Quotes erd
17456 will look different, in style and in length.
17457 The label fonts of all three also differ from one another.
17460 \begin_layout Standard
17465 , if the contents of a
17473 exceed the physical size of a slide or sheet of paper, the extra will overflow
17475 Again, you should avoid this.
17476 It defeats the whole purpose of
17487 \begin_layout Subsubsection
17497 \begin_layout Standard
17502 is a slide that sits atop another slide.
17503 Perhaps you wish to discuss a figure on the main
17507 before displaying the text associated with it.
17508 One way to accomplish this is tape a flap of dark paper over the part of
17513 you want to display later.
17514 This method fails, however, if you wish to overlap one graph with another,
17516 You would then have to fumble while speaking to align the two separate,
17521 s to align the two graphs.
17526 environment in both cases makes life much easier.
17529 \begin_layout Standard
17534 receives the page number of its
17535 \begin_inset Quotes eld
17539 \begin_inset Quotes erd
17547 \begin_inset Quotes eld
17555 \begin_inset Quotes erd
17562 \begin_layout Plain Layout
17563 Presumably, mutliple
17568 \begin_inset Quotes eld
17576 \begin_inset Quotes erd
17580 \begin_inset Quotes eld
17588 \begin_inset Quotes erd
17592 \begin_inset Quotes eld
17600 \begin_inset Quotes erd
17604 \begin_inset space ~
17607 appended to the page number of the parent
17617 Clearly, you want the contents of both the
17625 to each fit on a single physical slide! You should probably consider an
17631 \begin_inset Quotes eld
17635 \begin_inset Quotes erd
17643 Indeed, the \SpecialChar LyX
17648 class provides a visual cue for this: the label at the start of an
17652 is shorter than that at the start of a
17657 Lastly, when you generate printable output, you'll find alignment markers
17658 in all four corners of both the
17662 page and its parent
17667 These will assist you in lining up the two physical slides.
17670 \begin_layout Standard
17671 The major problem in overlaying two slides is aligning the contents of the
17672 two transparencies.
17673 How much space should you leave for that graph on the second slide? Worse
17674 still, what if you want a graph and a sentence on second slide, but there
17675 is text on the main transparency that goes in between them? You could try
17676 and insert vertical space of the right size.
17677 The better way is to use
17688 \begin_layout Standard
17689 As their names imply,
17697 are two command-like paragraph environments that make all subsequent text
17698 invisible and visible, respectively.
17700 \begin_inset space ~
17704 \begin_inset CommandInset ref
17706 reference "sec:slideQuirk"
17710 that you don't place anything
17714 these two environments, however.
17719 , it inserts a centered, sky-blue label into the page reading
17720 \begin_inset Quotes eld
17723 <Invisible Text Follows>
17724 \begin_inset Quotes erd
17728 For paragraphs following this label, the parts of the
17736 ; it doesn't matter which] where they would be contain instead blank space.
17740 \begin_layout Standard
17745 , the corresponding centered label is
17746 \begin_inset Quotes eld
17749 <Visible Text Follows>
17750 \begin_inset Quotes erd
17754 Paragraphs following this label behave normally.
17755 Note that the beginning of a new
17767 automatically shuts off an
17772 It's therefore not necessary to use
17783 \begin_layout Standard
17784 By now, it should be obvious how to create overlay transparencies using
17785 the proper combination of
17804 \begin_layout Enumerate
17809 , including everything that will appear on it, whether on the main slide
17817 \begin_layout Enumerate
17818 Before each figure or paragraph that will appear only on the
17827 If necessary, insert a
17831 environment after the
17838 \begin_layout Enumerate
17843 immediately following the
17850 \begin_layout Enumerate
17851 Copy the contents of this
17862 \begin_layout Enumerate
17867 , change all of the
17878 \begin_layout Standard
17880 You've just made an
17887 \begin_layout Standard
17888 There's one problem with the way I've designed the \SpecialChar LyX
17893 class: you can't make text in the middle of a paragraph invisible, nor
17894 make text in the middle of an invisible paragraph visible again.
17895 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
17900 \begin_layout Plain Layout
17901 The commands of interest are:
17904 \begin_layout Itemize
17909 invisible \SpecialChar ldots
17913 \begin_layout Itemize
17918 visible \SpecialChar ldots
17922 \begin_layout Plain Layout
17924 and need to be marked as \SpecialChar TeX
17927 \begin_inset Quotes eld
17931 \begin_inset Quotes erd
17934 you wish to change goes in between the brackets [and after the
17947 If you don't know how to mark text as \SpecialChar TeX
17948 , see the appropriate section of
17961 \begin_layout Subsubsection
17971 \begin_inset CommandInset label
17973 name "sec:slideNote"
17980 \begin_layout Standard
17989 is associated with a
17990 \begin_inset Quotes eld
17994 \begin_inset Quotes erd
18002 Here, too, the \SpecialChar LyX
18007 class provides visual cues.
18012 is shorter than that of a
18016 [yet longer than that of an
18020 ] and, like the label of an
18024 is shockingly magenta.
18025 Additionally, the printed
18029 has the page number of its
18030 \begin_inset Quotes eld
18034 \begin_inset Quotes erd
18042 \begin_inset Quotes eld
18050 \begin_inset Quotes erd
18054 \begin_inset Quotes eld
18062 \begin_inset Quotes erd
18066 \begin_inset Quotes eld
18074 \begin_inset Quotes erd
18078 You can have multiple
18082 s associated with a single
18094 , you'll probably want to break up long
18098 s so that they fit on a single sheet of paper.
18101 \begin_layout Standard
18106 is obvious: it contains anything additional you might want to say about
18112 It could also be used as a sheet of reminders for a particular
18117 In the case of the latter, you might want to make use of time markers.
18118 Currently, the \SpecialChar LyX
18124 \begin_inset Quotes eld
18128 \begin_inset Quotes erd
18131 support for time markers, a
18133 Sli\SpecialChar TeX
18137 So, you'll have to resort to using the \SpecialChar LaTeX
18141 \begin_layout Standard
18142 To use time markers, you'll need to specify the extra class option
18143 \begin_inset Quotes eld
18151 \begin_inset Quotes erd
18155 \begin_inset space ~
18159 \begin_inset CommandInset ref
18161 reference "sec:slidesetup"
18166 This option turns on timing marks, which will appear in the lower-left-hand
18172 To set what appears in the time marker, you use the \SpecialChar LaTeX
18174 \begin_inset Quotes eld
18184 \begin_inset Quotes erd
18188 \begin_inset Quotes eld
18198 \begin_inset Quotes erd
18202 The arguments of both commands are time measured in seconds.
18204 \begin_inset Quotes eld
18214 \begin_inset Quotes erd
18217 sets the time marker to a given time.
18219 \begin_inset Quotes eld
18229 \begin_inset Quotes erd
18232 increments the time marker by the specified amount.
18233 Using time markers and
18237 s in this fashion, you can remind yourself how much time to spend on a particula
18245 \begin_layout Standard
18246 There's one last feature to describe.
18247 Clearly, you'd like to print out all of your
18255 s on transparencies while printing all of your
18272 with which it is associated.
18273 What's a person to do?
18276 \begin_layout Standard
18277 Luckily, there are two \SpecialChar LaTeX
18278 commands that allow you to select what to print
18280 Both must be placed into the preamble of your document.
18282 \begin_inset Quotes eld
18294 \begin_inset Quotes erd
18297 will cause the output to contain only the
18306 Correspondingly, the command
18307 \begin_inset Quotes eld
18319 \begin_inset Quotes erd
18322 prevents the output of anything but
18327 I'd advise placing both commands in the preamble and initially comment
18329 You can then preview your entire presentation as you write.
18330 When you're done writing, you can then uncomment one of the two to select
18331 what you want to print.
18332 I like to uncomment
18333 \begin_inset Quotes eld
18345 \begin_inset Quotes erd
18348 , print to a file with
18349 \begin_inset Quotes eld
18357 \begin_inset Quotes erd
18360 in its name, comment it back out, then uncomment
18361 \begin_inset Quotes eld
18373 \begin_inset Quotes erd
18377 \begin_inset Quotes eld
18385 \begin_inset Quotes erd
18389 I can then send either file to a printer, loading transparencies or plain
18390 paper as appropriate.
18393 \begin_layout Standard
18394 You can also provide other arguments to the
18395 \begin_inset Quotes eld
18405 \begin_inset Quotes erd
18409 \begin_inset Quotes eld
18419 \begin_inset Quotes erd
18423 See a good \SpecialChar LaTeX
18427 \begin_layout Subsection
18432 Class Template File
18435 \begin_layout Standard
18436 I have also provided a template file,
18437 \begin_inset Quotes eld
18445 \begin_inset Quotes erd
18453 To use it, begin your new presentation with
18455 File\SpecialChar menuseparator
18457 \begin_inset space ~
18461 \begin_inset space ~
18467 Your new \SpecialChar LyX
18468 presentation file will contain an example
18489 additionally contain an example of the use of
18498 Lastly, the preamble will contain:
18501 \begin_layout LyX-Code
18502 % Uncomment to print out only slides and overlays
18505 \begin_layout LyX-Code
18509 \begin_layout LyX-Code
18515 \begin_inset Newline newline
18521 \begin_layout LyX-Code
18522 % Uncomment to print out only notes
18525 \begin_layout LyX-Code
18529 \begin_layout LyX-Code
18537 \begin_layout Standard
18538 One final thing: I created this class to support the \SpecialChar LaTeX2e
18540 \begin_inset Quotes eld
18545 Sli\SpecialChar TeX
18549 \begin_inset Quotes erd
18552 class, one of the built-in \SpecialChar LaTeX2e
18554 Neither I nor the rest of the \SpecialChar LyX
18555 Team endorse or oppose the use of this built-in
18557 It's here if you want it or need it.
18558 There exist other \SpecialChar LaTeX2e
18559 classes for creating presentations, such as the
18564 \begin_inset space ~
18568 \begin_inset CommandInset ref
18570 reference "sec:foiltex"
18575 \begin_inset Quotes eld
18583 \begin_inset Quotes erd
18586 package [present on some \SpecialChar TeX
18588 The latter is not yet supported under \SpecialChar LyX
18593 \begin_layout Plain Layout
18594 Perhaps you can take on the task\SpecialChar ldots
18600 I know nothing about these other classes.
18601 Try them out to see what sort of alternative they provide.
18604 \begin_layout Chapter
18606 Features needing Extra Software
18609 \begin_layout Section
18610 Checking \SpecialChar TeX
18614 \begin_layout Standard
18620 \begin_layout Subsection
18624 \begin_layout Standard
18633 \begin_layout Plain Layout
18638 is not yet available when you are using the \SpecialChar LaTeX
18639 distribution MiK\SpecialChar TeX
18645 , you'll find in the
18652 \begin_inset space ~
18663 \begin_inset Newline newline
18667 \begin_inset CommandInset href
18669 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18677 \begin_layout Standard
18680 Chk\SpecialChar TeX
18683 package is a program that was written by
18684 \begin_inset Flex Noun
18687 \begin_layout Plain Layout
18689 \begin_inset space ~
18697 in frustration because some constructs in \SpecialChar LaTeX
18698 are sometimes non-intuitive,
18699 and easy to forget.
18700 The program runs over your \SpecialChar LaTeX
18701 file, checks the integrity of the file, and
18702 flags some common errors.
18703 In other technical words, it is
18707 for \SpecialChar LaTeX
18711 \begin_layout Standard
18712 Well, what is a syntax checker doing in \SpecialChar LyX
18713 which is supposed to produce correct
18715 anyways? The answer is simple: Just as
18719 not only checks the
18723 of C programs, but also does
18727 checks for type-errors,
18729 Chk\SpecialChar TeX
18732 catches some common
18736 errors, in addition to the syntactical ones.
18739 Chk\SpecialChar TeX
18742 is capable of detecting several common errors, such as
18745 \begin_layout Itemize
18746 Ellipsis detection:
18747 \begin_inset Newline newline
18750 Use \SpecialChar ldots
18754 \begin_layout Itemize
18755 No space in front of/after parenthesis:
18756 \begin_inset Newline newline
18762 \begin_layout Itemize
18763 Enforcement of normal space after common abbreviations:
18764 \begin_inset Newline newline
18768 \begin_inset space \thinspace{}
18772 \begin_inset space \space{}
18775 is too wide spacing.
18778 \begin_layout Itemize
18779 Enforcement of end-of-sentence space when the last sentence ends with a
18781 \begin_inset Newline newline
18785 And this is wrong spacing.
18788 \begin_layout Itemize
18789 Space in front of labels and similar commands:
18790 \begin_inset Newline newline
18793 The label should stick right up to the text to avoid falling to a wrong
18796 \begin_inset CommandInset label
18806 \begin_layout Plain Layout
18807 This footnote is in danger of falling off to a wrong page
18812 The label is separated too much.
18815 \begin_layout Itemize
18816 Space in front of references, instead of hard spaces:
18817 \begin_inset Newline newline
18820 If you have bad luck, the text will break right between the referenced text
18821 and reference number, and that's a pity.
18823 \begin_inset CommandInset ref
18825 reference "sec:chktex"
18832 \begin_layout Itemize
18834 \begin_inset Quotes eld
18838 \begin_inset Quotes erd
18842 \begin_inset Formula $\times$
18846 \begin_inset Newline newline
18849 2x2 looks cheap compared to
18850 \begin_inset Formula $2\times2$
18856 \begin_layout Standard
18857 and more \SpecialChar ldots
18858 It is an invaluable tool when you are
18859 \begin_inset Quotes eld
18863 \begin_inset Quotes erd
18866 your document before printing, and you should run it right after the obligatory
18867 spelling check, and before you go fine tuning the typesetting.
18870 \begin_layout Subsection
18874 \begin_layout Standard
18875 If you have the program installed, usage is as simple as choosing
18877 Tools\SpecialChar menuseparator
18879 \begin_inset space ~
18885 This will make \SpecialChar LyX
18886 generate a \SpecialChar LaTeX
18887 file of your document, start
18889 Chk\SpecialChar TeX
18892 to check it, and then make \SpecialChar LyX
18894 \begin_inset Quotes eld
18898 \begin_inset Quotes erd
18901 with the warnings from
18903 Chk\SpecialChar TeX
18906 , if there were any.
18907 The warnings will be placed close to the point of the mistake, and you
18908 can quickly find them by using the
18910 Navigate\SpecialChar menuseparator
18913 menu item, or the shortcut key
18922 Open the error boxes by clicking on them with the mouse, or use the shortcut
18931 bindings, or the corresponding
18940 Read the warning and correct the mistake, if it is a mistake.
18941 If you have trouble understanding what the warning is about, you can safely
18943 Remember that there is a hidden layer between the document on screen and
18944 the technical details in invoking
18946 Chk\SpecialChar TeX
18949 , and this gap can make some warnings seem arcane or just plain silly.
18952 \begin_layout Standard
18953 This document is an excellent testing bed for the feature, and it should
18954 provide quite a few warnings for you to fiddle with.
18955 Since computers are only so smart, expect most of the warnings to be false
18959 \begin_layout Subsection
18960 How to fine tune it
18963 \begin_layout Standard
18964 Sometimes, you'll find that
18966 Chk\SpecialChar TeX
18969 makes more noise than suits your mood.
18970 Then you can choose not to use it, wait until your mood changes, or try
18973 Chk\SpecialChar TeX
18976 to get better along with you.
18979 \begin_layout Standard
18982 Chk\SpecialChar TeX
18989 very configurable and extensible, you should not expect to solve all problems
18992 Chk\SpecialChar TeX
18995 in \SpecialChar LyX
18997 Since \SpecialChar LyX
18998 has to generate a somewhat special \SpecialChar LaTeX
18999 file to be able to match the
19000 line numbers from the
19002 Chk\SpecialChar TeX
19009 \begin_layout Plain Layout
19010 You can inspect the specific output from
19016 Document\SpecialChar menuseparator
19019 \begin_inset space ~
19033 to the internal document structure, some of the warnings will not appear
19035 There are two things you can do about this:
19038 \begin_layout Itemize
19041 Chk\SpecialChar TeX
19044 invocation command line in
19045 \begin_inset Flex Noun
19048 \begin_layout Plain Layout
19049 Tools\SpecialChar menuseparator
19050 Preferences\SpecialChar menuseparator
19051 Output\SpecialChar menuseparator
19052 LaTeX\SpecialChar menuseparator
19060 Chk\SpecialChar TeX
19063 installation configuration file (usually with the file
19068 See below to learn what warnings can be enabled and disabled on the command
19072 \begin_layout Itemize
19073 Export your document as a raw \SpecialChar LaTeX
19076 File\SpecialChar menuseparator
19077 Export\SpecialChar menuseparator
19086 Invoked in this way, it can be a hassle to find the corresponding place
19087 in the document inside \SpecialChar LyX
19088 , but with a little patience, you should be able
19092 \begin_layout Standard
19093 Here follows the warning messages that can be enabled and disabled in
19102 to disable a warning, and
19106 to enable a warning.
19107 The emphasized entries are disabled by default, because the default is
19110 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19115 \begin_layout Standard
19116 Notice that you should only use the options that enable and disable warnings,
19117 because \SpecialChar LyX
19118 relies on some of the other command line parameters to be set
19119 in a specific way to have a chance to communicate with
19126 \begin_layout Enumerate
19130 Command terminated with space.
19133 \begin_layout Enumerate
19136 Non-breaking space (
19137 \begin_inset Quotes eld
19145 \begin_inset Quotes erd
19148 ) should have been used.
19151 \begin_layout Enumerate
19155 You should enclose the previous parenthesis with
19156 \begin_inset Quotes eld
19164 \begin_inset Quotes erd
19170 \begin_layout Enumerate
19173 Italic correction (
19174 \begin_inset Quotes eld
19184 \begin_inset Quotes erd
19187 ) found in non-italic buffer.
19190 \begin_layout Enumerate
19193 Italic correction (
19194 \begin_inset Quotes eld
19204 \begin_inset Quotes erd
19207 ) found more than once.
19210 \begin_layout Enumerate
19214 No italic correction (
19215 \begin_inset Quotes eld
19225 \begin_inset Quotes erd
19231 \begin_layout Enumerate
19235 \begin_inset Quotes eld
19243 \begin_inset Quotes erd
19247 \begin_inset Quotes eld
19255 \begin_inset Quotes erd
19261 \begin_layout Enumerate
19264 Wrong length of dash may have been used.
19267 \begin_layout Enumerate
19271 \begin_inset Quotes eld
19279 \begin_inset Quotes erd
19283 \begin_inset Quotes eld
19291 \begin_inset Quotes erd
19297 \begin_layout Enumerate
19301 \begin_inset Quotes eld
19309 \begin_inset Quotes erd
19315 \begin_layout Enumerate
19319 \begin_inset Quotes eld
19327 \begin_inset Quotes erd
19330 to achieve an ellipsis.
19333 \begin_layout Enumerate
19336 Inter-word spacing (
19337 \begin_inset Quotes eld
19347 \begin_inset Quotes eld
19350 ) should perhaps be used.
19353 \begin_layout Enumerate
19356 Inter-sentence spacing (
19357 \begin_inset Quotes eld
19367 \begin_inset Quotes erd
19370 ) should perhaps be used.
19373 \begin_layout Enumerate
19376 Could not find argument for command.
19379 \begin_layout Enumerate
19383 \begin_inset Quotes eld
19391 \begin_inset Quotes erd
19397 \begin_layout Enumerate
19400 Math mode still on at end of \SpecialChar LaTeX
19404 \begin_layout Enumerate
19408 \begin_inset Quotes eld
19416 \begin_inset Quotes erd
19419 doesn't match the number of
19420 \begin_inset Quotes eld
19428 \begin_inset Quotes erd
19434 \begin_layout Enumerate
19437 You should use either
19440 \begin_inset Quotes eld
19448 \begin_inset Quotes erd
19453 as an alternative to
19454 \begin_inset Quotes eld
19462 \begin_inset Quotes erd
19468 \begin_layout Enumerate
19475 " (ASCII 39) instead of "
19482 \begin_layout Enumerate
19485 User-specified pattern found.
19488 \begin_layout Enumerate
19491 This command might not be intended.
19494 \begin_layout Enumerate
19501 \begin_layout Enumerate
19519 \begin_layout Enumerate
19522 Delete this space to maintain correct page references.
19525 \begin_layout Enumerate
19529 You might wish to put this between a pair of
19530 \begin_inset Quotes eld
19538 \begin_inset Quotes erd
19544 \begin_layout Enumerate
19547 You ought to remove spaces in front of punctuation.
19550 \begin_layout Enumerate
19553 Could not execute \SpecialChar LaTeX
19557 \begin_layout Enumerate
19566 in front of small punctuation.
19569 \begin_layout Enumerate
19577 may look prettier here.
19580 \begin_layout Enumerate
19584 Multiple spaces detected in output.
19587 \begin_layout Enumerate
19590 This text may be ignored.
19593 \begin_layout Enumerate
19599 \begin_inset Quotes eld
19604 to begin quotation, not
19611 \begin_layout Enumerate
19618 to end quotation, not
19621 \begin_inset Quotes eld
19629 \begin_layout Enumerate
19635 \begin_layout Enumerate
19638 You should perhaps use
19639 \begin_inset Quotes eld
19647 \begin_inset Quotes erd
19653 \begin_layout Enumerate
19656 You should put a space in front of/after parenthesis.
19659 \begin_layout Enumerate
19662 You should avoid spaces in front of/after parenthesis.
19665 \begin_layout Enumerate
19669 You should not use punctuation in front of/after quotes.
19672 \begin_layout Enumerate
19675 Double space found.
19678 \begin_layout Enumerate
19681 You should put punctuation outside inner/inside display math mode.
19684 \begin_layout Enumerate
19687 You ought to not use primitive \SpecialChar TeX
19688 in \SpecialChar LaTeX
19692 \begin_layout Enumerate
19695 You should remove spaces in front of
19696 \begin_inset Quotes eld
19704 \begin_inset Quotes erd
19710 \begin_layout Enumerate
19713 \begin_inset Quotes eld
19721 \begin_inset Quotes erd
19724 is normally not followed by
19725 \begin_inset Quotes eld
19733 \begin_inset Quotes erd
19739 \begin_layout Standard
19740 In later versions of \SpecialChar LyX
19741 , we hope to provide a more complete interface to this
19742 tool (and it's smaller cousin
19746 ) to exploit the full power of it.
19747 But it's not exactly useless as it is now: go try it on one of your existing
19748 documents of a certain length and be surprised.
19751 \begin_layout Section
19752 Version Control in \SpecialChar LyX
19756 \begin_layout Standard
19759 Lars Gullik Bjønnes
19766 \begin_layout Subsection
19770 \begin_layout Standard
19772 supports some of the most basic RCS/CVS/SVN/GIT commands.
19773 If you need something a bit more sophisticated you will have to do that
19774 manually in a terminal.
19777 \begin_layout Standard
19778 Also note that CVS support is not as good as subversion support, so we advise
19780 A good place to start learning Subversion is the SVN Book
19784 \begin_layout Plain Layout
19785 \begin_inset CommandInset href
19787 target "http://svnbook.red-bean.com/"
19798 In the case of RCS you should read
19799 \begin_inset Quotes eld
19803 \begin_inset Quotes erd
19806 (a man file, read it with
19811 This file describes all the basic features of RCS.
19812 You should especially notice the comment about a RCS directory, and the
19813 notion of a master RCS file (the file ending in
19820 \begin_layout Standard
19821 Before you begin to use the version control features in \SpecialChar LyX
19823 familiar with RCS/CVS/SVN/GIT usage.
19824 The implementation in \SpecialChar LyX
19825 assumes a recent version of the GNU RCS or CVS/SVN
19826 package — no guarantees are made for older versions.
19827 Most of the log messages are not currently displayed after operations —
19828 you can check them in the Messages pane if you are unsure.
19829 Regular users of version control will appreciate the VC toolbar, which
19832 View\SpecialChar menuseparator
19833 Toolbars\SpecialChar menuseparator
19835 \begin_inset space ~
19843 \begin_layout Standard
19844 For introducing your own external commands consult
19845 \begin_inset Flex Code
19848 \begin_layout Plain Layout
19862 \begin_layout Standard
19863 It is strongly recommended to store documents in uncompressed format if
19864 using version control (uncheck
19866 Document\SpecialChar menuseparator
19869 if it is checked): Uncompressed LyX documents are text files and therefore
19870 for merging two different versions by version control systems.
19871 Compressed LyX documents are binary files, which cannot be merged by version
19875 \begin_layout Subsection
19876 RCS commands in \SpecialChar LyX
19880 \begin_layout Standard
19881 The following sections describe the RCS commands supported by \SpecialChar LyX
19883 You can find them in the
19885 File\SpecialChar menuseparator
19887 \begin_inset space ~
19894 was tested against RCS 5.7/5.8.
19897 \begin_layout Subsubsection
19903 \begin_layout Standard
19904 If your document is not under revision control, this is the only item shown
19906 And if it is under revision control, the
19910 item is not visible.
19914 \begin_layout Standard
19915 This command registers your document with RCS (unless you are under the
19916 directory managed by CVS)\SpecialChar endofsentence
19917 You are asked interactively to supply an initial
19918 description of the document.
19919 The document is now set in Read-Only mode and you have to
19922 \begin_inset space ~
19926 \begin_inset space ~
19930 \begin_inset space ~
19935 , before making any changes to it.
19936 A document under revision control has a
19937 \begin_inset Quotes eld
19940 [RCS:<version> <locker>]
19941 \begin_inset Quotes erd
19944 item tagged to the filename in the minibuffer.
19947 \begin_layout Standard
19948 RCS command that is run:
19951 \begin_layout LyX-Code
19954 ci -q -u -i -t-"<initial description>" <file-name>
19957 \begin_layout Standard
19962 to understand the switches.
19966 \begin_layout Subsubsection
19972 \begin_layout Standard
19973 When you are finished editing a file, you check in your changes.
19974 When you do this, you are asked for a description of the changes.
19975 This is stored in the history log.
19976 The version number is bumped, your changes are applied to the master RCS
19977 file, the document is unlocked and set to Read-Only mode.
19980 \begin_layout Itemize
19983 ci -q -u -m"<description>" <file-name>
19986 \begin_layout Subsubsection
19992 \begin_layout Standard
19993 By doing this you lock the document so that only you can edit it.
19994 This will also make the document Read-Write only for you.
19995 You will usually continue editing for a while and when you are finished
19996 you check in your changes.
19997 The status line is changed to reflect that you have locked the file.
20000 \begin_layout Itemize
20003 co -q -l <file-name>
20006 \begin_layout Subsubsection
20009 Revert To Repository Version
20012 \begin_layout Standard
20013 This will discard all changes made to the document since the last check
20015 You get a warning before changes are discarded.
20018 \begin_layout Itemize
20021 co -f -u<version> <file-name>
20024 \begin_layout Subsubsection
20030 \begin_layout Standard
20031 This will create a copy of the current document.
20032 Since RCS does not support copy operations natively, the version history
20033 is not preserved, and the copy is added as a new file.
20034 It requires a clean document without any changes since the last checkin.
20035 You are asked for a file name and a description of the copy operation.
20036 After that the copy is created, both locally and in the repository.
20037 If the parent directories of the copied and original document differ, all
20038 relative paths of included files of the copy are adjusted (like in
20040 File\SpecialChar menuseparator
20045 Finally, the copy is loaded instead of the original document.
20048 \begin_layout Labeling
20049 \labelwidthstring 00.00.0000
20051 \begin_inset space ~
20055 \begin_inset space ~
20059 \begin_inset Newline newline
20063 \begin_inset Flex Code
20066 \begin_layout Plain Layout
20069 \begin_inset Quotes qld
20073 \begin_inset Quotes qld
20082 \begin_inset Flex Code
20085 \begin_layout Plain Layout
20088 \begin_inset Quotes qld
20092 \begin_inset Quotes qld
20101 \begin_inset Newline newline
20105 \begin_inset Flex Code
20108 \begin_layout Plain Layout
20112 \begin_inset Quotes qld
20116 \begin_inset Quotes qld
20127 \begin_layout Subsubsection
20133 \begin_layout Standard
20134 This makes as if the last check in never happened.
20135 No changes are made to the document loaded into \SpecialChar LyX
20136 , but the last version
20137 is removed from the master RCS file.
20140 \begin_layout Itemize
20143 rcs -o<version> <file-name>
20146 \begin_layout Subsubsection
20152 \begin_layout Standard
20153 This shows the complete history of the RCS document.
20158 is shown in a browser.
20166 \begin_layout Subsubsection
20170 \begin_layout Standard
20172 supports RCS version number, author name, date and time of last commit.
20173 All those are extracted from
20175 rlog -r <file-name>
20179 \begin_inset CommandInset ref
20181 reference "subsec:VCS-Revision-Information"
20188 \begin_layout Subsection
20189 CVS commands in \SpecialChar LyX
20193 \begin_layout Standard
20194 A subset of CVS operations is supported by \SpecialChar LyX
20196 You can find the commands in the
20198 File\SpecialChar menuseparator
20200 \begin_inset space ~
20206 The version control system SVN is more powerful, so please use it instead
20207 of CVS if possible.
20210 \begin_layout Subsubsection
20216 \begin_layout Standard
20217 If you start from scratch with CVS you have to create your repository and
20218 checkout the working copy with external tools.
20219 If you're using a client-server setup you may need to login before doing
20220 the first repository checkout.
20223 \begin_layout Standard
20224 If your documents are under revision control and others are using the same
20225 repository problems arise when different changes to the same document at
20226 the same location happen.
20227 Standard CVS repositories don't operate with a file locking mechanism.
20228 This may be surprising, but conflicts only occur if people disagree on
20229 the proper content of the same part of a document.
20230 So, if co-workers are used to communicate regularly, these conflicts occur
20232 If they don't communicate they have a fundamental problem anyway.
20233 Nevertheless some people like to work with so called
20234 \begin_inset Quotes eld
20238 \begin_inset Quotes erd
20242 If they do so the working copy of all files is readonly when checked out
20243 first and the user starts editing after using a special command to make
20244 the working copy writable.
20245 When the changes are checked in the working copy returns to readonly state.
20246 With \SpecialChar LyX
20247 one has to edit the
20248 \begin_inset Flex Code
20251 \begin_layout Plain Layout
20257 file and add the line
20258 \begin_inset Flex Code
20261 \begin_layout Plain Layout
20267 to work with reserved checkouts.
20268 The benefit is the possibility to see who is using a writable copy of some
20270 It's not guaranteed only one user makes a copy writable.
20273 \begin_layout Standard
20275 tries to guess if you're using reserved or non-reserved checkouts.
20276 If your working copy is readonly or it is writable and an additional copy
20277 of your document exists in the CVS/Base sub-directory a reserved otherwise
20278 a non-reserved checkout is assumed.
20279 When a reserved checkout is detected you have to use
20280 \begin_inset Flex Noun
20283 \begin_layout Plain Layout
20289 to make your working copy writable if it's readonly.
20291 \begin_inset Flex Noun
20294 \begin_layout Plain Layout
20300 operation is possible and that makes your working copy readonly again after
20301 transferring your changes to the repository.
20304 \begin_layout Standard
20305 More information about CVS can be found here
20306 \begin_inset Flex URL
20309 \begin_layout Plain Layout
20311 http://www.nongnu.org/cvs
20317 \begin_inset Flex URL
20320 \begin_layout Plain Layout
20322 http://ximbiot.com/cvs
20330 \begin_layout Standard
20335 to understand the sub-commands and the switches mentioned below.
20338 \begin_layout Subsubsection
20344 \begin_layout Standard
20345 If your document is not under revision control, this is the only item shown
20347 And if it is under revision control, the
20351 item is not visible.
20355 \begin_layout Standard
20356 This command registers in CVS your document
20357 \begin_inset Flex Strong
20360 \begin_layout Plain Layout
20368 in the case you have already the documents directory under CVS control
20374 This means you have to create or checkout the archive by yourself using
20376 (In case you forget that step \SpecialChar LyX
20377 registers the document with RCS.)
20380 \begin_layout Standard
20381 Then you are asked interactively to supply an initial description of the
20383 Don't forget that registered file is not yet checked in.
20386 \begin_layout Standard
20387 CVS command that is run:
20389 cvs -q add -m"<entered message>" "<file-name>"
20392 \begin_layout Standard
20397 above and for all other CVS commands is an abbreviation for
20398 \begin_inset Quotes eld
20401 change the current working directory to file location and use the file name
20402 without path component as argument
20403 \begin_inset Quotes erd
20409 \begin_layout Subsubsection
20415 \begin_layout Standard
20416 When you are finished editing a file, you commit your changes.
20417 When you do this and you had changed the document, you are asked for a
20418 description of the changes.
20419 After that changes are written to the repository.
20420 In case you didn't change the document and a reserved checkout is detected
20421 the reservation made on
20422 \begin_inset Flex Noun
20425 \begin_layout Plain Layout
20434 \begin_layout Labeling
20435 \labelwidthstring 00.00.0000
20437 \begin_inset space ~
20441 \begin_inset space ~
20445 \begin_inset Newline newline
20449 \begin_inset Flex Code
20452 \begin_layout Plain Layout
20455 -q commit -m"<description>" "<file-name>"
20461 \begin_inset Newline newline
20465 \begin_inset Flex Code
20468 \begin_layout Plain Layout
20479 \begin_layout Subsubsection
20485 \begin_layout Standard
20486 When you are sharing a repository with others, you may have to incorporate
20487 their changes into your working copy.
20490 \begin_layout Standard
20493 cvs -q update "<file-name>"
20496 \begin_layout Standard
20497 If a readonly checkout is detected the working copy is made writable and
20501 \begin_layout Standard
20504 cvs -q edit "<file-name>"
20507 \begin_layout Subsubsection
20510 Revert To Repository Version
20513 \begin_layout Standard
20514 This will discard all changes made to the document since the last check
20516 You get a warning before changes are discarded.
20517 Firstly the file is deleted, secondly CVS update command is run.
20520 \begin_layout Standard
20523 cvs -q update "<file-name>"
20526 \begin_layout Standard
20527 If a reserved checkout is detected and the working copy has no changes only
20528 the reservation is undone.
20531 \begin_layout Standard
20534 cvs -q unedit "<file-name>"
20537 \begin_layout Subsubsection
20543 \begin_layout Standard
20544 This will create a copy of the current document.
20545 Since CVS does not support copy operations natively, the version history
20546 is not preserved, and the copy is added as a new file.
20547 It requires a clean document without any changes since the last checkin.
20548 You are asked for a file name and a description of the copy operation.
20549 After that the copy is created, both locally and in the repository.
20550 If the parent directories of the copied and original document differ, all
20551 relative paths of included files of the copy are adjusted (like in
20553 File\SpecialChar menuseparator
20558 Finally, the copy is loaded instead of the original document.
20561 \begin_layout Labeling
20562 \labelwidthstring 00.00.0000
20564 \begin_inset space ~
20568 \begin_inset space ~
20572 \begin_inset Newline newline
20576 \begin_inset Flex Code
20579 \begin_layout Plain Layout
20593 \begin_inset Flex Code
20596 \begin_layout Plain Layout
20610 \begin_inset Newline newline
20614 \begin_inset Flex Code
20617 \begin_layout Plain Layout
20633 \begin_layout Subsubsection
20639 \begin_layout Standard
20640 This will rename the current document.
20641 Since CVS does not support rename operations natively, the version history
20642 is not preserved, the renamed document is added as a new file, and the
20643 original document is deleted.
20644 It requires a clean document without any changes since the last checkin.
20645 You are asked for a file name and a description of the rename operation.
20646 After that the document is renamed, both locally and in the repository.
20647 If the parent directories of the new and old file names differ, all relative
20648 paths of included files are adjusted (like in
20650 File\SpecialChar menuseparator
20655 Finally, the document is reloaded using the new name.
20658 \begin_layout Labeling
20659 \labelwidthstring 00.00.0000
20661 \begin_inset space ~
20665 \begin_inset space ~
20669 \begin_inset Newline newline
20673 \begin_inset Flex Code
20676 \begin_layout Plain Layout
20690 \begin_inset Flex Code
20693 \begin_layout Plain Layout
20707 \begin_inset Newline newline
20711 \begin_inset Flex Code
20714 \begin_layout Plain Layout
20728 \begin_inset Newline newline
20732 \begin_inset Flex Code
20735 \begin_layout Plain Layout
20751 \begin_layout Subsubsection
20752 Update of the local directory checkout from repository
20755 \begin_layout Standard
20756 Once your documents gets more complex, containing sub-documents and pictures,
20758 \begin_inset Flex Code
20761 \begin_layout Plain Layout
20767 files and so on using version control becomes more complicated.
20769 supports updating the whole tree in which resides the document.
20770 This become especially useful once you cooperate with people which neither
20771 have detailed knowledge about CVS usage nor they have ambition to commit
20772 additional material to the repository.
20773 You have to organize the files structure so that all external files are
20774 in the same directory or subdirectories of the document.
20775 It's good practice anyway to store multipart documents in an extra directory.
20778 \begin_layout Standard
20780 \begin_inset Flex Code
20783 \begin_layout Plain Layout
20784 Update local directory from repository
20789 command updates the whole directory.
20790 If local changes are detected user is warned before update starts.
20791 In case of merge conflicts both versions of the conflicting document parts
20792 are placed in the final document.
20793 You have to review and correct the result of the merge.
20794 You'll find the conflicts enclosed in pairs of
20795 \begin_inset Flex Code
20798 \begin_layout Plain Layout
20805 \begin_inset Flex Code
20808 \begin_layout Plain Layout
20815 \begin_inset Flex Code
20818 \begin_layout Plain Layout
20825 The first part is your version as before the update operation with the
20826 document name prepended.
20827 The second one is the repository version with the version number after
20829 \begin_inset Flex Code
20832 \begin_layout Plain Layout
20841 \begin_layout Labeling
20842 \labelwidthstring 00.00.0000
20844 \begin_inset space ~
20848 \begin_inset space ~
20852 \begin_inset Newline newline
20856 \begin_inset Flex Code
20859 \begin_layout Plain Layout
20867 (Ask if changes are detected.)
20868 \begin_inset Newline newline
20872 \begin_inset Flex Code
20875 \begin_layout Plain Layout
20876 cd $path; cvs -q update
20886 \begin_layout Standard
20888 \begin_inset Flex Code
20891 \begin_layout Plain Layout
20897 stands for the path to the document.
20900 \begin_layout Subsubsection
20906 \begin_layout Standard
20907 This shows the complete history of the CVS document.
20910 cvs log "<file-name>"
20912 is shown in a browser.
20915 \begin_layout Subsubsection
20919 \begin_layout Standard
20921 supports CVS version number, author name, date and time of last commit.
20922 All those are extracted from
20924 cvs log -r <file-name>
20928 \begin_inset CommandInset ref
20930 reference "subsec:VCS-Revision-Information"
20937 \begin_layout Subsection
20938 SVN commands in \SpecialChar LyX
20942 \begin_layout Standard
20943 SVN is now partially supported by \SpecialChar LyX
20945 You can find the commands in the
20947 File\SpecialChar menuseparator
20949 \begin_inset space ~
20955 Please note that if you use password protected access to repository via
20956 ssh, you will be asked in terminal window.
20958 was tested against SVN 1.5, 1.6, 1.7 and 1.8
20962 \begin_layout Plain Layout
20963 Most of the commands will work with 1.4 too, see
20964 \begin_inset CommandInset ref
20966 reference "subsec:SVN-Repo-Update"
20971 There seems to be currently unresolved permissions problem under SVN 1.8
20972 with reverting changes when file is locked.
20980 \begin_layout Subsubsection
20986 \begin_layout Standard
20987 If your document is not under revision control, this is the only item shown
20989 And if it is under revision control, the
20993 item is not visible.
20996 \begin_layout Standard
20997 This command registers in SVN your document ONLY in case you have already
20998 the documents directory under SVN control (in particular
21003 This means you have to checkout the archive by yourself.
21006 \begin_layout Standard
21007 Then you are asked interactively to supply an initial description of the
21009 Don't forget that registered file is not yet commited.
21012 \begin_layout Standard
21013 SVN command that is run:
21016 \begin_inset Quotes qld
21020 \begin_inset Quotes qld
21026 \begin_layout Standard
21031 to understand the switches.
21034 \begin_layout Subsubsection
21040 \begin_layout Standard
21041 When you are finished editing a file, you commit your changes.
21042 When you do this, you are asked for a description of the changes.
21043 After that changes are commited.
21046 \begin_layout Standard
21051 \begin_layout Plain Layout
21052 In case locking is not enabled.
21054 \begin_inset CommandInset ref
21056 reference "subsec:SVN-File-Locking"
21067 svn commit -q -m"<description>" <file-name>
21070 \begin_layout Subsubsection
21076 \begin_layout Standard
21077 Updates the changes of this file from the repository.
21078 Be sure you understand SVN merging and conflicts resolving before using
21079 this function, because all conflicts has to be resolved manually by you!
21082 \begin_layout Standard
21087 \begin_layout Plain Layout
21095 svn update --non-interactive
21096 \begin_inset Quotes qld
21100 \begin_inset Quotes qld
21106 \begin_layout Subsubsection
21109 Revert To Repository Version
21112 \begin_layout Standard
21113 This will discard all changes made to the document since the last check
21115 You get a warning before changes are discarded.
21118 \begin_layout Standard
21122 \begin_inset Quotes qld
21126 \begin_inset Quotes qld
21132 \begin_layout Subsubsection
21138 \begin_layout Standard
21139 This will create a copy of the current document including the version history.
21140 It requires a clean document without any changes since the last checkin.
21141 You are asked for a file name and a description of the copy operation.
21142 After that the copy is created, both locally and in the repository.
21143 If the parent directories of the copied and original document differ, all
21144 relative paths of included files of the copy are adjusted (like in
21146 File\SpecialChar menuseparator
21151 Finally, the copy is loaded instead of the original document.
21154 \begin_layout Labeling
21155 \labelwidthstring 00.00.0000
21157 \begin_inset space ~
21161 \begin_inset space ~
21165 \begin_inset Newline newline
21169 \begin_inset Flex Code
21172 \begin_layout Plain Layout
21176 \begin_inset Quotes qld
21180 \begin_inset Quotes qld
21184 \begin_inset Quotes qld
21188 \begin_inset Quotes qld
21197 \begin_inset Newline newline
21201 \begin_inset Flex Code
21204 \begin_layout Plain Layout
21213 \begin_layout Subsubsection
21219 \begin_layout Standard
21220 This will rename the current document including the version history.
21221 It requires a clean document without any changes since the last checkin.
21222 You are asked for a file name and a description of the rename operation.
21223 After that the document is renamed, both locally and in the repository.
21224 If the parent directories of the new and old file names differ, all relative
21225 paths of included files are adjusted (like in
21227 File\SpecialChar menuseparator
21232 Finally, the document is reloaded using the new name.
21235 \begin_layout Labeling
21236 \labelwidthstring 00.00.0000
21238 \begin_inset space ~
21242 \begin_inset space ~
21246 \begin_inset Newline newline
21250 \begin_inset Flex Code
21253 \begin_layout Plain Layout
21257 \begin_inset Quotes qld
21261 \begin_inset Quotes qld
21265 \begin_inset Quotes qld
21269 \begin_inset Quotes qld
21278 \begin_inset Newline newline
21282 \begin_inset Flex Code
21285 \begin_layout Plain Layout
21294 \begin_layout Subsubsection
21295 \begin_inset CommandInset label
21297 name "subsec:SVN-Repo-Update"
21301 Update of the local directory checkout from repository
21305 \begin_layout Plain Layout
21306 Note that this command will work only with subversion
21307 \begin_inset Formula $\geqq1.5$
21318 \begin_layout Standard
21319 All the commands above have one shortcoming – they deal with the current
21321 Once your document contains pictures, includes external
21322 \begin_inset Flex Code
21325 \begin_layout Plain Layout
21331 files and so on administration becomes more complicated.
21333 now supports updating the whole tree in which resides the document
21337 \begin_layout Plain Layout
21338 One need to organize the files structure so that all external files are
21339 in the same directory or subdirectories of the document.
21346 This become especially useful once you cooperate with people which neither
21347 know about subversion management nor they have ambition to commit additional
21348 material to the repository.
21352 \begin_layout Standard
21353 \begin_inset Flex Code
21356 \begin_layout Plain Layout
21357 Update local directory from repository
21362 command updates the whole directory and in case of merge conflicts local
21363 version of the files are left, so no unintended data loss occurs.
21364 If local changes are detected user is warned before update starts.
21367 \begin_layout Labeling
21368 \labelwidthstring 00.00.0000
21370 \begin_inset space ~
21374 \begin_inset space ~
21378 \begin_inset Newline newline
21382 \begin_inset Flex Code
21385 \begin_layout Plain Layout
21391 (Ask if changes are detected.)
21392 \begin_inset Newline newline
21396 \begin_inset Flex Code
21399 \begin_layout Plain Layout
21400 svn update --accept mine-full $path
21408 \begin_layout Standard
21410 \begin_inset Flex Code
21413 \begin_layout Plain Layout
21419 stands for the path to the document.
21422 \begin_layout Subsubsection
21428 \begin_layout Standard
21429 This shows the complete history of the SVN document.
21433 \begin_inset Quotes qld
21437 \begin_inset Quotes qld
21442 is shown in a browser.
21445 \begin_layout Subsubsection
21447 \begin_inset CommandInset label
21449 name "subsec:SVN-File-Locking"
21456 \begin_layout Standard
21457 The file exchange through various revision control systems brings the problem
21458 of merge conflicts in case two different users try to edit the same (parts
21460 When such a conflict happens it needs manual resolving and one reasonable
21461 alternative is to provide some kind of locking mechanism, which guarantees
21462 that only one user is allowed to edit file at the given time.
21465 \begin_layout Standard
21466 SVN has two such mechanisms to provide mutual exclusivity for file access
21467 – locks and automatic setting of write permissions (see sec.
21469 \begin_inset CommandInset ref
21471 reference "subsec:Automatical-Locking-Property"
21476 \begin_inset Flex Code
21479 \begin_layout Plain Layout
21489 \begin_layout Plain Layout
21490 \begin_inset Flex URL
21493 \begin_layout Plain Layout
21495 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21506 If this property is detected for a given document \SpecialChar LyX
21507 starts to use SVN locks
21508 for document editing automatically and the whole check-in/out mechanism
21509 switches to the same regimen as for RCS.
21510 This in particular means there are two different modes of file use in \SpecialChar LyX
21514 \begin_layout Itemize
21516 The loaded file is in the read-only mode.
21517 For editing on needs to check-out.
21522 consists of updating from the repository and gaining write lock.
21523 If the lock is not possible to obtain, we remain in unlocked state.
21526 \begin_layout Itemize
21528 The loaded file is in the
21529 \begin_inset Quotes els
21533 \begin_inset Quotes ers
21537 No other user is allowed to edit the file.
21542 consists of commiting changes and releasing write-lock.
21543 If no changes have been made to the document, no commit will be produced
21547 \begin_layout Plain Layout
21548 Don't be puzzled by the fact that you will be asked for commit message anyway.
21553 and only the write-lock will be released.
21556 \begin_layout Standard
21560 \begin_layout Labeling
21561 \labelwidthstring 00.00.0000
21564 svn commit -q -m"<description>" "<file-name>"
21565 \begin_inset Newline newline
21568 svn unlock "<file-name>"
21571 \begin_layout Labeling
21572 \labelwidthstring 00.00.0000
21575 svn update "<file-name>"
21576 \begin_inset Newline newline
21579 svn lock "<file-name>"
21582 \begin_layout Subsubsection
21585 \begin_inset CommandInset label
21587 name "subsec:Automatical-Locking-Property"
21593 Automatic Locking Property
21596 \begin_layout Standard
21597 The above mentioned automatic setting of write permissions of the .lyx file
21600 File\SpecialChar menuseparator
21602 \begin_inset space ~
21605 Control\SpecialChar menuseparator
21606 Use Locking Property
21609 This command is active only when the file is not locked on the svn server
21611 you need to check-out before proceeding).
21614 \begin_layout Labeling
21615 \labelwidthstring 00.00.0000
21617 \begin_inset space ~
21623 \begin_layout Labeling
21624 \labelwidthstring 00.00.0000
21627 svn propset svn:needs-lock ON "<file-name>"
21630 \begin_layout Labeling
21631 \labelwidthstring 00.00.0000
21634 svn propdel svn:needs-lock "<file-name>"
21637 \begin_layout Subsubsection
21638 \begin_inset CommandInset label
21640 name "subsec:VCS-Revision-Information"
21644 Revision Information in Documents
21647 \begin_layout Standard
21648 There are more possibilities how to activate revision information in our
21652 \begin_layout Itemize
21658 \begin_layout Itemize
21659 tree revision information (
21660 \begin_inset Flex Code
21663 \begin_layout Plain Layout
21670 The result is the output of the
21671 \begin_inset Flex Code
21674 \begin_layout Plain Layout
21680 command, the following table gives you an idea, how to read the results.
21683 \begin_layout Standard
21685 \begin_inset Tabular
21686 <lyxtabular version="3" rows="6" columns="2">
21687 <features tabularvalignment="middle">
21688 <column alignment="left" valignment="top">
21689 <column alignment="left" valignment="top">
21691 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21694 \begin_layout Plain Layout
21702 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21705 \begin_layout Plain Layout
21715 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21718 \begin_layout Plain Layout
21724 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21727 \begin_layout Plain Layout
21728 mixed revision working copy
21735 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21738 \begin_layout Plain Layout
21744 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21747 \begin_layout Plain Layout
21748 modified working copy
21755 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21758 \begin_layout Plain Layout
21764 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21767 \begin_layout Plain Layout
21768 switched working copy
21775 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21778 \begin_layout Plain Layout
21784 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21787 \begin_layout Plain Layout
21788 partial working copy, from a sparse checkout
21795 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21798 \begin_layout Plain Layout
21804 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21807 \begin_layout Plain Layout
21808 mixed revision, modified, switched working copy
21821 \begin_layout Itemize
21822 file revision information.
21823 The result comes from parsing the output of
21824 \begin_inset Flex Code
21827 \begin_layout Plain Layout
21829 \begin_inset space ~
21833 \begin_inset space ~
21837 \begin_inset space ~
21846 Supported flags are:
21850 \begin_layout Itemize
21851 version number of the last commit (
21852 \begin_inset Flex Code
21855 \begin_layout Plain Layout
21864 \begin_layout Itemize
21865 author of the last commit (
21866 \begin_inset Flex Code
21869 \begin_layout Plain Layout
21878 \begin_layout Itemize
21879 date of the last commit (
21880 \begin_inset Flex Code
21883 \begin_layout Plain Layout
21892 \begin_layout Itemize
21893 time of the last commit (
21894 \begin_inset Flex Code
21897 \begin_layout Plain Layout
21907 \begin_layout Standard
21908 You can obtain this info via InsetInfo (e.g.
21910 \begin_inset Flex Code
21913 \begin_layout Plain Layout
21914 info-insert buffer vcs-date
21920 The information will be available only when you have the file stored under
21921 svn managment (i.e.
21923 \begin_inset Flex Code
21926 \begin_layout Plain Layout
21932 directory is available with your document).
21936 \begin_layout Itemize
21937 Another—a hacking one—possibility is to use svn keywords
21941 \begin_layout Plain Layout
21942 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
21948 In short – you set file keywords property (e.g.
21951 svn propset svn:keywords 'Rev' file.lyx
21953 ) and then paste keyword \SpecialChar TeX
21958 \begin_layout Plain Layout
21959 This is an easy way how to ensure that \SpecialChar LyX
21960 won't break the line in the middle
21966 tag in your document (e.g.
21968 \begin_inset Flex Code
21971 \begin_layout Plain Layout
21978 This way svn client will automatically substitute revision number (e.g.
21980 \begin_inset Flex Code
21983 \begin_layout Plain Layout
21989 ) after each update and commit.
21990 There are more problems with this approach.
21991 Firstly, the '$' character is used in \SpecialChar TeX
21992 world for math equations, so any
21993 occurence of math formula
21994 \begin_inset Formula $Rev$
21998 \begin_inset Formula $Rev:59$
22001 in your \SpecialChar LyX
22003 Similarly for other keywords like Id, Date, Author, etc.
22004 Secondly svn output is dependent on your locales, so its very easy that
22005 svn would produce some problematic strings once Date is used.
22006 Thirdly you get the whole 'Rev: 59' string in your document instead of
22008 Until subversion implements user's custom keywords it will be hard to use
22009 this approach reliably or let \SpecialChar LyX
22010 to support it directly.
22013 \begin_layout Subsection
22014 SVN and Windows Environment
22017 \begin_layout Quote
22018 My inclination is to say that if the user cannot figure out the command
22019 line operations on their own fairly quickly, they would be well advised
22020 to use TortoiseSVN.
22026 \begin_layout Subsubsection
22030 \begin_layout Standard
22031 In addition to installing \SpecialChar LyX
22032 , and having access to a Subversion repository,
22033 the user will need to install the Subversion client program.
22034 A Windows installer for the client program is available from
22035 \begin_inset CommandInset href
22038 target "http://www.collab.net/nonav/downloads/subversion/"
22044 The user may also want to install
22045 \begin_inset CommandInset href
22048 target "http://tortoisesvn.tigris.org/"
22053 , which integrates Subversion operations into the context (rightclick) menu
22054 of Windows Explorer.
22055 Operations done outside \SpecialChar LyX
22056 will typically be more convenient using the Explorer
22058 Note that TortoiseSVN is not a replacement for the client program, which
22059 is what \SpecialChar LyX
22063 \begin_layout Subsubsection
22064 Bringing a document under Subversion control
22067 \begin_layout Standard
22068 Before a \SpecialChar LyX
22069 document can be brought under version control in Subversion, its
22070 parent directory needs to be under version control.
22071 If the document is being added to a project already in the repository,
22072 this is accomplished by checking the project out to the directory where
22073 the new document will be placed.
22074 If the project itself is not yet under version control (for instance, if
22075 this document starts a new project), the directory must be imported into
22077 This is done outside \SpecialChar LyX
22079 Both import and checkout are easily accomplished from the Explorer context
22080 menu using TortoiseSVN, or alternatively can be done using the command
22081 line client at a DOS prompt.
22082 The procedure for importing the project using TortoiseSVN is described
22083 below, assuming an existing repository and a new project being started
22091 For information on using the Subversion client program, run
22098 \begin_layout Enumerate
22105 in Windows Explorer, right click it, and select
22107 TortoiseSVN\SpecialChar menuseparator
22111 If necessary, adjust the URL for the repository, then click OK.
22114 \begin_layout Enumerate
22115 Right click the level of the repository under which you want to place the
22116 new project folder (typically the top level) and click
22120 Supply a name for the project folder and click OK.
22121 Add a message for the log file if desired, then click OK again.
22122 The new project folder should appear in the repository.
22123 Finally, click OK again to exit the repository browser.
22126 \begin_layout Enumerate
22127 Once again right click
22133 , this time selecting SVN Checkout\SpecialChar ldots
22134 Select the URL of the project folder
22135 you just created in the repository, and set the checkout directory to
22143 You will be warned about a non-empty folder; click OK to proceed.
22144 You should now have a
22155 \begin_layout Enumerate
22156 Create or open your document in \SpecialChar LyX
22159 File\SpecialChar menuseparator
22161 \begin_inset space ~
22164 Control\SpecialChar menuseparator
22168 Add a log message and click OK to commit the document to version control.
22171 \begin_layout Standard
22172 From this point onward, you should have full functionality in the
22174 File\SpecialChar menuseparator
22176 \begin_inset space ~
22182 You also have the option of checking the document in and out, viewing its
22184 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22185 client program from a command prompt.
22188 \begin_layout Subsubsection
22189 SSH tunnel used with SVN under Windows
22192 \begin_layout Standard
22193 Compared with Linux setting up an svn client to communicate over ssh under
22194 Windows is a rather troublesome task.
22195 We will at least offer some hints how to setup the client side but prior
22196 knowledge about ssh and the Windows command line is needed, also be prepared
22197 for a great deal of frustration\SpecialChar ldots
22201 \begin_layout Enumerate
22202 Get an svn client for windows, as described in the previous sections.
22203 When it is a fresh install run some svn command (e.g.
22205 \begin_inset Flex Code
22208 \begin_layout Plain Layout
22214 ) to create config files, which you will need to change later on.
22217 \begin_layout Enumerate
22218 Choose an ssh client for Windows.
22219 There are several possibilities, we will use the one from Putty tools
22223 \begin_layout Plain Layout
22224 \begin_inset Flex URL
22227 \begin_layout Plain Layout
22229 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22240 You will need to set the connection up so that the client doesn't ask for
22241 any password from you.
22242 To keep things easy we will use only keys without any additional password
22247 \begin_layout Enumerate
22249 \begin_inset Flex Code
22252 \begin_layout Plain Layout
22259 Save your private .ppk key file and put the public one on the server side.
22260 If the SVN server runs on Linux, note that the format of the public key
22261 is not compatible with Linux openssh and you will need to direcly copy-paste
22263 \begin_inset Quotes eld
22268 Public key for pasting into OpenSSH authorized_keys file
22271 \begin_inset Quotes erd
22274 edit field into the server's
22275 \begin_inset Flex Code
22278 \begin_layout Plain Layout
22279 ~/.ssh/authorized_keys
22285 \begin_inset Flex Code
22288 \begin_layout Plain Layout
22297 \begin_layout Enumerate
22299 \begin_inset Flex Code
22302 \begin_layout Plain Layout
22309 In the SVN config file
22313 \begin_layout Plain Layout
22314 Exact path depends on Windows version, usually somewhere around
22315 \begin_inset Flex Code
22318 \begin_layout Plain Layout
22321 Documents and Settings
22335 \begin_inset Flex Code
22338 \begin_layout Plain Layout
22353 , section [tunnels], setup ssh command, e.g.
22355 \begin_inset Flex Code
22358 \begin_layout Plain Layout
22359 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22368 \begin_layout Plain Layout
22369 It will usually take a lot of time to get exact command right and it depends
22371 For example do not have some remote server saved as a default session in
22373 If things fail, try to connect via plink without SVN first.
22382 \begin_layout Enumerate
22383 Checkout the SVN archive, e.
22384 \begin_inset space \thinspace{}
22388 \begin_inset Newline newline
22392 \begin_inset Flex Code
22395 \begin_layout Plain Layout
22396 svn co svn+ssh://user@server/repository_path
22404 \begin_layout Subsubsection
22405 End-of-Line Conversions
22408 \begin_layout Standard
22409 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22411 use different line endings inside the .lyx files.
22412 This is not a problem as far as \SpecialChar LyX
22413 functionality is concerned, but the commit
22414 diffs will be huge and merge-conflicts prone.
22415 Fortunately SVN itself knows
22419 \begin_layout Plain Layout
22420 \begin_inset Flex URL
22423 \begin_layout Plain Layout
22425 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22435 how to deal with CR/LF problems when switching .lyx files to the
22436 \begin_inset Flex Code
22439 \begin_layout Plain Layout
22449 \begin_layout Plain Layout
22451 \begin_inset Flex Code
22454 \begin_layout Plain Layout
22455 svn propset svn:eol-style native FILE_NAME
22468 \begin_layout Subsection
22469 GIT commands in \SpecialChar LyX
22473 \begin_layout Standard
22474 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22476 You can find the commands in the
22478 File\SpecialChar menuseparator
22480 \begin_inset space ~
22486 Please note that if you use password protected access to repository via
22487 ssh, you will be asked in terminal window.
22489 was tested against GIT 1.7.
22493 \begin_layout Plain Layout
22494 Windows users please note that you need to ensure that git is on the path.
22495 This can be set from within \SpecialChar LyX
22498 Tools\SpecialChar menuseparator
22499 Preferences\SpecialChar menuseparator
22500 Paths\SpecialChar menuseparator
22511 \begin_layout Standard
22512 One big difference of GIT and the other supported version control systems
22513 is the distributed nature of GIT: With traditional version control systems
22514 there is one central server which hosts the repository.
22515 Users commit their changes to the server, and get updates made by other
22517 With GIT, users commit to a local repository.
22518 The local repository can be synchronized with one or more remote repositories
22520 \begin_inset Flex Code
22523 \begin_layout Plain Layout
22530 \begin_inset Flex Code
22533 \begin_layout Plain Layout
22541 does not interact in any way with remote GIT repositories.
22542 It works exclusively with the local repository in a very similar way as
22543 with a central CVS or SVN repository.
22544 If you use remote GIT repositories you need to do the
22545 \begin_inset Flex Code
22548 \begin_layout Plain Layout
22555 \begin_inset Flex Code
22558 \begin_layout Plain Layout
22564 operations with your favourite GIT client.
22567 \begin_layout Subsubsection
22573 \begin_layout Standard
22574 If your document is not under revision control, this is the only item shown
22576 And if it is under revision control, the
22580 item is not visible.
22583 \begin_layout Standard
22584 This command registers in GIT your document ONLY in case you have already
22585 the documents directory under GIT control (in particular
22590 This means you have to checkout the archive by yourself.
22593 \begin_layout Standard
22594 Then you are asked interactively to supply an initial description of the
22596 Don't forget that registered file is not yet committed.
22599 \begin_layout Standard
22600 GIT command that is run:
22603 \begin_inset Quotes qld
22607 \begin_inset Quotes qld
22613 \begin_layout Standard
22618 to understand the switches.
22621 \begin_layout Subsubsection
22627 \begin_layout Standard
22628 When you are finished editing a file, you commit your changes.
22629 When you do this, you are asked for a description of the changes.
22630 After that changes are committed.
22633 \begin_layout Standard
22636 git commit -q -m"<description>" <file-name>
22639 \begin_layout Subsubsection
22642 Revert To Repository Version
22645 \begin_layout Standard
22646 This will discard all changes made to the document since the last check
22648 You get a warning before changes are discarded.
22651 \begin_layout Standard
22655 \begin_inset Quotes qld
22659 \begin_inset Quotes qld
22665 \begin_layout Subsubsection
22671 \begin_layout Standard
22672 This will rename the current document including the version history.
22673 It requires a clean document without any changes since the last checkin.
22674 You are asked for a file name and a description of the rename operation.
22675 After that the document is renamed, both locally and in the repository.
22676 If the parent directories of the new and old file names differ, all relative
22677 paths of included files are adjusted (like in
22679 File\SpecialChar menuseparator
22684 Finally, the document is reloaded using the new name.
22687 \begin_layout Labeling
22688 \labelwidthstring 00.00.0000
22690 \begin_inset space ~
22694 \begin_inset space ~
22698 \begin_inset Newline newline
22702 \begin_inset Flex Code
22705 \begin_layout Plain Layout
22709 \begin_inset Quotes qld
22713 \begin_inset Quotes qld
22717 \begin_inset Quotes qld
22721 \begin_inset Quotes qld
22730 \begin_inset Newline newline
22734 \begin_inset Flex Code
22737 \begin_layout Plain Layout
22746 \begin_layout Subsubsection
22752 \begin_layout Standard
22753 This shows the complete history of the GIT document.
22757 \begin_inset Quotes qld
22761 \begin_inset Quotes qld
22766 is shown in a browser.
22769 \begin_layout Subsubsection
22773 \begin_layout Standard
22775 supports GIT hash number of the last commit to the file, author name, date
22776 and time of last commit.
22777 All those are extracted from
22779 git log -n 1 --pretty=format:%H%n%an%n%ai
22782 Tree version information is obtained via
22784 git describe --abbrev --dirty --long
22788 \begin_inset CommandInset ref
22790 reference "subsec:VCS-Revision-Information"
22797 \begin_layout Subsection
22801 \begin_layout Standard
22802 With the recent addition of the
22803 \begin_inset Flex Code
22806 \begin_layout Plain Layout
22812 function \SpecialChar LyX
22813 power users are allowed to create their own commands for revision
22817 \begin_layout Standard
22818 As an example you can see how two TortoiseSVN commands could be integrated
22822 \begin_layout Description
22824 \begin_inset Flex Code
22827 \begin_layout Plain Layout
22828 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
22836 \begin_layout Description
22838 \begin_inset Flex Code
22841 \begin_layout Plain Layout
22842 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
22850 \begin_layout Subsection
22851 Version control and Document comparison
22854 \begin_layout Standard
22855 One of the typical uses of version control is to inspect the changes between
22856 revisions, usually by creating
22857 \begin_inset Flex Code
22860 \begin_layout Plain Layout
22867 While this is useful for plain text files, it is much less useful in the
22868 case of \SpecialChar LyX
22869 files, which have more a complicated structure.
22870 Hence we provide binding to the Document comparison feature.
22871 There are two ways of calling this feature – either by direct call of
22872 \begin_inset Flex Code
22875 \begin_layout Plain Layout
22882 function (for details see \SpecialChar LyX
22883 functions manual) or by the toolbar icon
22896 One can either compare two chosen revisions of the document or he can simply
22897 compare the current version of edited text with older revisions (where
22899 \begin_inset Flex Noun
22902 \begin_layout Plain Layout
22908 ' revisions back means comparison of the edited file with last commited
22913 \begin_layout Standard
22914 This feature is supported for SVN and RCS though due to the more complicated
22915 versioning scheme of RCS there is a constraint – when addressing the revisions
22916 in dialog, numbers always point to the last number in RCS revision number,
22919 We don't currently support GIT addressing of revisions, one can just compare
22920 edited document with its revision X steps backs, where X is addressed as
22922 \begin_inset Flex Code
22925 \begin_layout Plain Layout
22934 \begin_layout Section
22935 Literate Programming
22938 \begin_layout Standard
22943 (kayvan@sylvan.com)
22947 original documentation written by
22949 Edmar Wienskoski Jr.
22952 (edmar-w-jr@technologist.com)
22955 \begin_layout Subsection
22959 \begin_layout Standard
22960 The main purpose of this documentation is to show you how to use \SpecialChar LyX
22962 programming, where it is assumed that you are familiar with this programming
22963 technique, and know what
22964 \begin_inset Quotes eld
22968 \begin_inset Quotes erd
22972 \begin_inset Quotes eld
22976 \begin_inset Quotes erd
22980 If that is not the case, please follow the web links provided in the following
22982 There is a lot of good documentation out there covering old development
22983 history to the latest tools tips.
22986 \begin_layout Standard
22987 It is also assumed that you are familiar with \SpecialChar LyX
22988 itself to a point that you
22989 are comfortable changing your \SpecialChar LyX
22990 preferences, and X resources file.
22991 If that is not the case please refer to other \SpecialChar LyX
22992 documentation to cover your
22996 \begin_layout Subsection
22997 Literate Programming
23000 \begin_layout Standard
23001 From the Literate Programming FAQ:
23004 \begin_layout Quotation
23005 Literate programming is the combination of documentation and source together
23006 in a fashion suited for reading by human beings.
23007 In fact, literate programs should be enjoyable reading, even inviting!
23008 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23009 and documentation in a single file.
23010 Literate programming tools then parse the file to produce either readable
23011 documentation or compilable source.
23012 The WEB style of literate programming was created by D.
23013 \begin_inset space \thinspace{}
23017 Knuth during the development of his \SpecialChar TeX
23018 typesetting software.
23022 \begin_layout Standard
23023 Another excerpt says:
23026 \begin_layout Quotation
23029 How is literate programming different from verbose commenting?
23032 \begin_layout Quotation
23033 There are three distinguishing characteristics.
23034 In order of importance, they are:
23038 \begin_layout Itemize
23039 flexible order of elaboration
23042 \begin_layout Itemize
23043 automatic support for browsing
23046 \begin_layout Itemize
23047 typeset documentation, especially diagrams and mathematics
23051 \begin_layout Standard
23052 Now that I sparked your curiosity, take a look in the references.
23055 \begin_layout Subsubsection
23059 \begin_layout Standard
23060 The complete Literate Programming FAQ can be found at:
23063 \begin_layout Quote
23064 Literate Programming FAQ
23065 \begin_inset Flex URL
23068 \begin_layout Plain Layout
23070 http://www.literateprogramming.com/lpfaq.pdf
23078 \begin_layout Standard
23079 The FAQ lists 23 (twenty three!) different literate programming tools.
23080 Where some are specialized or
23081 \begin_inset Quotes eld
23085 \begin_inset Quotes erd
23088 for particular programming languages, while other have general scope.
23093 for my own use for several reasons:
23096 \begin_layout Itemize
23097 It can generate the documentation either in \SpecialChar LaTeX
23101 \begin_layout Itemize
23102 It has a open architecture, i.
23103 \begin_inset space \thinspace{}
23107 \begin_inset space \space{}
23110 it is easy to plug in new filters
23114 \begin_layout Plain Layout
23119 are programs that read a given data stream and output a manipulated data
23121 That way, a WEB file (consisting of literate code) can be turned into a
23122 file consisting only of C program code or \SpecialChar LaTeX
23128 and to perform special processing that you may need.
23132 \begin_layout Itemize
23133 There is a good selection of filters available already (the HTML is one
23137 \begin_layout Itemize
23141 \begin_layout Standard
23142 The Noweb web page can be found at:
23145 \begin_layout Quote
23147 \begin_inset Flex URL
23150 \begin_layout Plain Layout
23152 https://www.cs.tufts.edu/~nr/noweb/
23160 \begin_layout Standard
23161 Starting from there you can reach many other interesting links and even
23162 some literate program examples.
23165 \begin_layout Subsection
23167 and Literate Programming with Noweb
23170 \begin_layout Standard
23171 The \SpecialChar LyX
23172 support for Literate Programming is provided by using the generic \SpecialChar LyX
23174 converters mechanism.
23175 This support is provided in a
23176 \begin_inset Quotes eld
23180 \begin_inset Quotes erd
23184 \begin_inset space \thinspace{}
23188 \begin_inset space \space{}
23191 you will be able to use this new \SpecialChar LyX
23192 feature with some other literate programming
23193 tool of your choice by just changing your \SpecialChar LyX
23197 \begin_layout Subsubsection
23198 Generating documents and code (weaving and tangling)
23201 \begin_layout Paragraph
23202 Using the noweb module
23205 \begin_layout Standard
23206 If you have installed Noweb and \SpecialChar LyX
23207 successfully, whenever you open a new document,
23208 after you have chosen its document class, use the
23210 Document\SpecialChar menuseparator
23214 \begin_inset Quotes eld
23218 \begin_inset Quotes erd
23222 If Noweb is correctly installed, when you click on the
23223 \begin_inset Quotes eld
23227 \begin_inset Quotes erd
23230 link, you will see the
23231 \begin_inset Quotes eld
23235 \begin_inset Quotes erd
23238 module in the available list and you can add it to your document.
23241 \begin_layout Paragraph
23245 \begin_layout Standard
23247 enables you to write code with a custom inset named
23248 \begin_inset Flex Noun
23251 \begin_layout Plain Layout
23258 Noweb delimits chunks like this:
23261 \begin_layout LyX-Code
23265 \begin_layout LyX-Code
23269 \begin_layout LyX-Code
23273 \begin_layout LyX-Code
23277 \begin_layout LyX-Code
23281 \begin_layout Standard
23282 The problem is that whatever is written in between the << and the
23286 must be taken literally, i.
23287 \begin_inset space \thinspace{}
23291 \begin_inset space \space{}
23295 should be prevented from making any special interpretation of what has
23297 This is also handled by
23298 \begin_inset Flex Noun
23301 \begin_layout Plain Layout
23307 , that works like a normal text inset but has a free spacing capability.
23310 \begin_layout Standard
23311 As a special note, you can also use the
23312 \begin_inset Quotes eld
23316 \begin_inset Quotes erd
23319 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23323 \begin_layout LyX-Code
23327 \begin_layout LyX-Code
23328 def some_function(args):
23331 \begin_layout LyX-Code
23332 "This is the doc string for this function."
23335 \begin_layout LyX-Code
23336 print "My args: ", args
23339 \begin_layout LyX-Code
23340 @ %def some_function
23343 \begin_layout Standard
23344 For an example of this usage and the resulting cross-reference output, look
23345 at the Literate python program in
23347 LIBDIR/examples/listerrors.lyx
23349 which should make this all clear.
23352 \begin_layout Paragraph
23353 Generating the documentation
23356 \begin_layout Standard
23357 At this point you already have a new document file with a proper document
23358 class, and with some code and text on it.
23359 How do I print it? The answer is simple, you select
23361 View\SpecialChar menuseparator
23365 Just like you would do for a plain document.
23366 No special procedure is required.
23369 \begin_layout Standard
23370 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23374 \begin_layout Enumerate
23377 Update\SpecialChar menuseparator
23380 menu option is chosen, a \SpecialChar LaTeX
23386 \begin_layout Standard
23387 If the document is of any literate class the generated file will be named
23388 with an extension name defined by the
23389 \begin_inset Quotes eld
23393 \begin_inset Quotes erd
23396 format (defined in the Preferences panel), otherwise the file will have
23405 \begin_layout Enumerate
23406 Note that the only difference so far is in the name of the file, no special
23407 processing is required by \SpecialChar LyX
23409 Given that you formatted the code using the
23410 \begin_inset Flex Noun
23413 \begin_layout Plain Layout
23419 inset that, by itself, takes care of the business.
23422 \begin_layout Enumerate
23423 If the document is of any literate class \SpecialChar LyX
23424 will then use the internal \SpecialChar LyX
23426 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23431 \begin_layout Plain Layout
23432 The converters are defined in the
23434 Tools\SpecialChar menuseparator
23438 \begin_inset Quotes eld
23442 \begin_inset Quotes erd
23454 manual for general information about converters.
23459 to generate the \SpecialChar LaTeX
23464 \begin_layout Standard
23465 Otherwise it will just skip this step.
23469 \begin_layout Enumerate
23470 Finally, \SpecialChar LaTeX
23471 is invoked and the regular post processing continues as in a plain
23475 \begin_layout Standard
23476 Independence from a particular
23477 \begin_inset Quotes eld
23481 \begin_inset Quotes erd
23484 is easily achieved by changing the commands that are run by the various
23488 \begin_layout Paragraph
23489 Generating the code
23492 \begin_layout Standard
23493 When the build menu option is chosen or the corresponding button in the
23494 toolbar is pressed, a \SpecialChar LaTeX
23495 file is generated just like step 1 above.
23496 Next, \SpecialChar LyX
23502 This converter needs to be defined by the user and is not installed by
23503 default, though the Program format is.
23504 This converter (like any other converter) will have two parts:
23507 \begin_layout Enumerate
23508 The converter program itself.
23509 This program performs the conversion from the one format to the other (in
23510 this case, from the Noweb format to the Program pseudo-format).
23513 \begin_layout Enumerate
23514 The error log parser.
23515 This is a program whose sole purpose is to rewrite error messages in a
23516 format that \SpecialChar LyX
23518 This makes it possible for \SpecialChar LyX
23519 to place error boxes in the right places in
23523 \begin_layout Standard
23524 The first part, the
23525 \begin_inset Quotes eld
23529 \begin_inset Quotes erd
23532 setting, should be set to
23535 \begin_layout LyX-Code
23543 \begin_layout Standard
23544 This basically means that \SpecialChar LyX
23546 \begin_inset Quotes eld
23550 \begin_inset Quotes erd
23553 (a program or script) with the name of the Noweb file (normally a file
23554 in the \SpecialChar LyX
23555 temp directory) and the directory path of the original \SpecialChar LyX
23560 \begin_layout Standard
23561 This is an implementation of
23562 \begin_inset Quotes eld
23566 \begin_inset Quotes erd
23569 that you can place in a directory on your path:
23572 \begin_layout LyX-Code
23578 \begin_layout LyX-Code
23584 \begin_layout LyX-Code
23587 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23590 \begin_layout Standard
23591 The next part of the converter setting is the
23592 \begin_inset Quotes eld
23596 \begin_inset Quotes erd
23599 which is to be set to
23602 \begin_layout LyX-Code
23605 parselog=$$s/scripts/listerrors
23608 \begin_layout Standard
23609 This will run any errors that are generated by the
23610 \begin_inset Quotes eld
23614 \begin_inset Quotes erd
23617 process through the
23618 \begin_inset Quotes eld
23622 \begin_inset Quotes erd
23628 \begin_layout Standard
23629 The build will normally take place in \SpecialChar LyX
23630 's temporary directory, so the files
23631 produced by the conversion will be in that directory.
23633 will copy out what it regards as the `main' file, but the
23637 conversion may produce several files, and so most of these would then be
23638 deleted when \SpecialChar LyX
23640 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23641 the build-script chunk can place the generated files in that location.
23644 \begin_layout Paragraph
23645 Build instructions in the document
23648 \begin_layout Standard
23649 The last piece of the integration between \SpecialChar LyX
23651 \begin_inset Quotes eld
23655 \begin_inset Quotes erd
23659 Generally, the instructions for building your program should be embedded
23660 in a chunk of its own.
23662 \begin_inset Quotes eld
23666 \begin_inset Quotes erd
23669 above uses the notangle command to look for this chunk (called
23670 \begin_inset Quotes eld
23674 \begin_inset Quotes erd
23677 ) and runs its contents through
23678 \begin_inset Quotes eld
23682 \begin_inset Quotes erd
23688 \begin_layout Standard
23689 Typically, such a chunk would look something like this:
23692 \begin_layout LyX-Code
23696 \begin_layout LyX-Code
23698 \begin_inset Newline newline
23701 if [ -z "${NOWEB_SOURCE}" ]
23702 \begin_inset Newline newline
23708 \begin_layout LyX-Code
23709 NOWEB_SOURCE=myfile.nw
23710 \begin_inset Newline newline
23714 \begin_inset Newline newline
23718 code to extract files ...
23719 use NOWEB_OUTPUT_DIR here ...]
23720 \begin_inset Newline newline
23724 code to compile files ...]
23725 \begin_inset Newline newline
23731 \begin_layout Standard
23734 LIBDIR/examples/listerrors.lyx
23738 LIBDIR/examples/Literate.lyx
23740 which implement two versions of the
23741 \begin_inset Quotes eld
23745 \begin_inset Quotes erd
23748 program for some illustrations of how all of these pieces go together or
23751 LIBDIR/examples/noweb2lyx.lyx.
23754 Interestingly, these three files show off the language-indepence of the
23756 literate programming support since they are written in Python, C and Perl
23760 \begin_layout Subsubsection
23761 Configuring \SpecialChar LyX
23765 \begin_layout Standard
23766 All the Literate Programming support is configured by the
23768 Tools\SpecialChar menuseparator
23772 \begin_inset Quotes eld
23776 \begin_inset Quotes erd
23780 The important parts are:
23783 \begin_layout Description
23785 \begin_inset space ~
23789 \begin_inset Quotes eld
23793 \begin_inset Quotes erd
23797 \begin_inset space ~
23800 format Set up via the File Formats tab, this is where the Noweb-specific
23810 , the file extension is set to
23815 This tells \SpecialChar LyX
23816 to create a file with a
23820 extension in the first step of the conversion process.
23823 \begin_layout Description
23825 \begin_inset space ~
23833 \begin_inset space ~
23836 format This is an empty format whose sole purpose is to be the endpoint
23837 of a conversion (which then allows us to set up a converter for it).
23840 \begin_layout Description
23850 This converter performs the
23851 \begin_inset Quotes eld
23855 \begin_inset Quotes erd
23858 of the literate document.
23859 For Noweb, it is set to
23860 \begin_inset Quotes eld
23865 noweave -delay -index $$i > $$o
23868 \begin_inset Quotes erd
23874 \begin_layout Description
23884 \begin_inset Quotes eld
23888 \begin_inset Quotes erd
23892 As stated above, the Converter is set to
23893 \begin_inset Quotes eld
23901 \begin_inset Quotes erd
23904 , with Flags set to
23905 \begin_inset Newline newline
23909 \begin_inset Quotes eld
23914 parselog=$$s/scripts/listerrors
23917 \begin_inset Quotes erd
23923 \begin_layout Subsubsection
23927 \begin_layout Standard
23928 There is also a new function implemented in the \SpecialChar LyX
23930 \begin_inset Quotes eld
23933 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
23937 \begin_layout Standard
23938 When debugging code with ddd/gdb, it is possible to invoke a text editor
23939 at the current execution position with a single key stroke.
23940 The default ddd configuration for that is shift-ctrl-V.
23941 It happens that you can define the editor command line invocation in ddd
23944 Edit\SpecialChar menuseparator
23945 Preferences\SpecialChar menuseparator
23948 dialog and changing the "Edit Sources" entry.
23951 \begin_layout Standard
23952 I take advantage of the newly created \SpecialChar LyX
23953 server function and this ddd feature,
23955 \begin_inset Quotes eld
23959 \begin_inset Quotes erd
23965 \begin_layout LyX-Code
23966 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
23969 \begin_layout Standard
23970 With this, whenever you are using ddd and find a point in the program that
23971 you want to edit, you just press shift-ctrl-V (in the ddd window), and
23972 ddd will forward this information to \SpecialChar LyX
23973 through the \SpecialChar LyX
23974 server and then the
23976 window will show the same file with the cursor at the same position ddd
23978 No more guessing or long scrolling to locate a point in the program back
23982 \begin_layout Standard
23983 Note however that you must enable the \SpecialChar LyX
23984 server to get this feature working
23985 (it is disabled by default).
23987 \begin_inset space ~
23991 \begin_inset CommandInset ref
23993 reference "sec:Starting-the-Server"
23997 explains how to do that.
24000 \begin_layout Subsubsection
24004 \begin_layout Standard
24005 There are six new buttons that can be added to your \SpecialChar LyX
24007 Four of these buttons are short cuts to layout styles:
24025 , one for the custom inset
24030 The last one is a short cut to the
24031 \begin_inset Quotes eld
24035 \begin_inset Quotes erd
24042 \begin_layout Standard
24044 has a range of buttons that are available for tool bar customization.
24045 In my toolbar I like to combine the six short cuts above with two more:
24050 \SpecialChar menuseparator
24055 \SpecialChar menuseparator
24062 Document\SpecialChar menuseparator
24063 View\SpecialChar menuseparator
24067 Here is how it looks like:
24070 \begin_layout LyX-Code
24074 \begin_layout LyX-Code
24078 \begin_layout LyX-Code
24079 Icon "layout Standard"
24082 \begin_layout LyX-Code
24083 Icon "layout Section"
24086 \begin_layout LyX-Code
24087 Icon "layout \SpecialChar LaTeX
24091 \begin_layout LyX-Code
24092 Icon "layout \SpecialChar LyX
24096 \begin_layout LyX-Code
24097 Icon "flex.insert Chunk"
24100 \begin_layout LyX-Code
24104 \begin_layout LyX-Code
24108 \begin_layout LyX-Code
24109 Icon "buffer-typeset"
24112 \begin_layout LyX-Code
24113 Icon "build-program"
24116 \begin_layout LyX-Code
24120 \begin_layout LyX-Code
24124 \begin_layout LyX-Code
24128 \begin_layout LyX-Code
24132 \begin_layout LyX-Code
24136 \begin_layout Subsubsection
24137 Colors customization
24140 \begin_layout Standard
24141 There are a number of colors in \SpecialChar LyX
24142 that can be customized in
24147 One of the things that bothers people is the \SpecialChar LaTeX
24149 The default color is red, since the chunks uses \SpecialChar LaTeX
24150 font, and there is a lot
24151 of chunks in literate documents, you may get tired of seeing everything
24153 You can change it by going to the tabs
24162 \begin_layout Standard
24163 The next thing is the visible presence of the newline character in the screen.
24164 You can choose the color of this particular character and make it blend
24166 I recommend you choosing a color that is close to the background but not
24167 equal, that way you still can see it is there, but it is not bothering
24171 \begin_layout Subsection
24176 \begin_layout Standard
24185 is documented in the
24189 example file and in the Sweave manual (menu
24191 Help\SpecialChar menuseparator
24197 \begin_layout Chapter
24201 \begin_layout Standard
24202 You can do everything with \SpecialChar LyX
24203 that you can do with \SpecialChar LaTeX
24205 However, \SpecialChar LyX
24206 cannot support every \SpecialChar LaTeX
24208 But you can always use \SpecialChar TeX
24210 This chapter shows you some more special things you might want to use.
24211 For other special things you can do with figures, tables, floats, boxes
24212 and notes, have a look at the
24215 \begin_inset space ~
24223 \begin_layout Section
24224 Multiple Text Columns
24227 \begin_layout Standard
24228 This feature is independent of the option
24230 Two-column document
24232 in the document settings under
24237 If you want to have 2
24238 \begin_inset space ~
24241 columns for the whole document, it is recommended to use the
24243 Two-column document
24246 For all other cases use this feature.
24249 \begin_layout Standard
24250 To use multiple text columns in your document, you have to load the module
24257 Document\SpecialChar menuseparator
24258 Settings\SpecialChar menuseparator
24261 ) and must have the \SpecialChar LaTeX
24263 \begin_inset Flex Code
24266 \begin_layout Plain Layout
24275 \begin_layout Standard
24276 Footnotes within multiple columns will be placed at the bottom of the page
24277 and not under each column.
24278 Within the different columns you can use everything, with the limitation
24279 that for floats you need to use the float option
24286 \begin_layout Subsection
24290 \begin_layout Standard
24291 If you want to have 2
24292 \begin_inset space ~
24295 columns in your text, insert a multicolumn inset via the menu
24297 Insert\SpecialChar menuseparator
24299 \begin_inset space ~
24302 Insets\SpecialChar menuseparator
24304 \begin_inset space ~
24309 where the columns should start.
24310 Write all text that should be printed in 2
24311 \begin_inset space ~
24314 columns into this inset.
24317 \begin_layout Standard
24318 Here is an example:
24321 \begin_layout Standard
24323 \begin_inset Flex Multiple Columns
24326 \begin_layout Plain Layout
24331 The Adventure of the Empty House
24334 \begin_inset Newline newline
24337 by Sir Arthur Conan Doyle
24340 \begin_layout Plain Layout
24343 It was in the spring of the year 1894 that all London was interested, and
24344 the fashionable world dismayed, by the murder of the Honourable Ronald
24345 Adair under most unusual and inexplicable circumstances.
24346 The public has already learned those particulars of the crime which came
24347 out in the police investigation, but a good deal was suppressed upon that
24348 occasion, since the case for the prosecution was so overwhelmingly strong
24349 that it was not necessary to bring forward all the facts.
24350 Only now, at the end of nearly ten years, am I allowed to supply those
24351 missing links which make up the whole of that remarkable chain.
24352 The crime was of interest in itself, but that interest was as nothing to
24353 me compared to the inconceivable sequel, which afforded me the greatest
24354 shock and surprise of any event in my adventurous life.
24355 Even now, after this long interval, I find myself thrilling as I think
24356 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24357 ty which utterly submerged my mind.
24358 Let me say to that public, which has shown some interest in those glimpses
24359 which I have occasionally given them of the thoughts and actions of a very
24360 remarkable man, that they are not to blame me if I have not shared my knowledge
24361 with them, for I should have considered it my first duty to do so, had
24362 I not been barred by a positive prohibition from his own lips, which was
24363 only withdrawn upon the third of last month.
24371 \begin_layout Standard
24372 To get 3 or more columns, set the cursor into the multicolumn inset and
24375 Insert\SpecialChar menuseparator
24377 \begin_inset space ~
24381 \begin_inset space ~
24387 The number of the desired columns is written into that inset (for 3
24388 \begin_inset space ~
24392 \begin_inset Quotes eld
24396 \begin_inset Quotes erd
24400 \begin_inset Newline newline
24403 Here is an example with 3
24404 \begin_inset space ~
24410 \begin_layout Standard
24411 \begin_inset Flex Multiple Columns
24414 \begin_layout Plain Layout
24417 \begin_inset Argument 1
24420 \begin_layout Plain Layout
24427 It can be imagined that my close intimacy with Sherlock Holmes had interested
24428 me deeply in crime, and that after his disappearance I never failed to
24429 read with care the various problems which came before the public.
24430 And I even attempted, more than once, for my own private satisfaction,
24431 to employ his methods in their solution, though with indifferent success.
24432 There was none, however, which appealed to me like this tragedy of Ronald
24434 As I read the evidence at the inquest, which led up to a verdict of willful
24435 murder against some person or persons unknown, I realized more clearly
24436 than I had ever done the loss which the community had sustained by the
24437 death of Sherlock Holmes.
24438 There were points about this strange business which would, I was sure,
24439 have specially appealed to him, and the efforts of the police would have
24440 been supplemented, or more probably anticipated, by the trained observation
24441 and the alert mind of the first criminal agent in Europe.
24442 All day, as I drove upon my round, I turned over the case in my mind and
24443 found no explanation which appeared to me to be adequate.
24444 At the risk of telling a twice-told tale, I will recapitulate the facts
24445 as they were known to the public at the conclusion of the inquest.
24453 \begin_layout Standard
24454 You can have up to 10
24455 \begin_inset space ~
24458 columns if you want to, but that might not be very pleasant for the readers
24462 \begin_layout Standard
24463 \begin_inset Newpage newpage
24469 \begin_layout Subsection
24470 Columns inside Columns
24473 \begin_layout Standard
24474 You can also have columns inside columns:
24477 \begin_layout Standard
24478 \begin_inset Flex Multiple Columns
24481 \begin_layout Plain Layout
24484 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24485 at that time governor of one of the Australian colonies.
24486 Adair's mother had returned from Australia to undergo the operation for
24487 cataract, and she, her son Ronald, and her daughter Hilda were living together
24491 \begin_layout Plain Layout
24492 \begin_inset Flex Multiple Columns
24495 \begin_layout Plain Layout
24498 The youth moved in the best society
24499 \begin_inset space ~
24502 – had, so far as was known, no enemies and no particular vices.
24503 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24504 had been broken off by mutual consent some months before, and there was
24505 no sign that it had left any very profound feeling behind it.
24506 For the rest {sic} the man's life moved in a narrow and conventional circle,
24507 for his habits were quiet and his nature unemotional.
24508 Yet it was upon this easy-going young aristocrat that death came, in most
24509 strange and unexpected form, between the hours of ten and eleven-twenty
24510 on the night of March 30, 1894.
24518 \begin_layout Plain Layout
24521 Ronald Adair was fond of cards
24522 \begin_inset space ~
24525 – playing continually, but never for such stakes as would hurt him.
24526 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24527 It was shown that, after dinner on the day of his death, he had played
24528 a rubber of whist at the latter club.
24529 He had also played there in the afternoon.
24534 The evidence of those who had played with him
24535 \begin_inset space ~
24539 Murray, Sir John Hardy, and Colonel Moran
24540 \begin_inset space ~
24543 – showed that the game was whist, and that there was a fairly equal fall
24545 Adair might have lost five pounds, but not more.
24546 His fortune was a considerable one, and such a loss could not in any way
24548 He had played nearly every day at one club or other, but he was a cautious
24549 player, and usually rose a winner.
24550 It came out in evidence that, in partnership with Colonel Moran, he had
24551 actually won as much as four hundred and twenty pounds in a sitting, some
24552 weeks before, from Godfrey Milner and Lord Balmoral.
24553 So much for his recent history as it came out at the inquest.
24561 \begin_layout Subsection
24565 \begin_layout Standard
24566 The examples in this section show some more special features of multiple
24570 \begin_layout Standard
24571 For more features of multiple columns, have a look at the
24572 \begin_inset CommandInset href
24574 name "documentation"
24575 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
24580 of the \SpecialChar LaTeX
24582 \begin_inset Flex Code
24585 \begin_layout Plain Layout
24594 \begin_layout Subsubsection
24598 \begin_layout Standard
24599 To add a preface text for multiple columns, set the cursor into the multicolumn
24600 inset and use the menu
24602 Insert\SpecialChar menuseparator
24606 Write your preface text into that inset.
24607 \begin_inset Newline newline
24610 This is an example with some preface text:
24613 \begin_layout Standard
24614 \begin_inset VSpace bigskip
24620 \begin_layout Standard
24621 \begin_inset Flex Multiple Columns
24624 \begin_layout Plain Layout
24625 \begin_inset Argument 2
24628 \begin_layout Plain Layout
24629 And the story continues and continues and continues and continues\SpecialChar ldots
24637 On the evening of the crime, he returned from the club exactly at ten.
24638 His mother and sister were out spending the evening with a relation.
24639 The servant deposed that she heard him enter the front room on the second
24640 floor, generally used as his sitting-room.
24641 She had lit a fire there, and as it smoked she had opened the window.
24642 No sound was heard from the room until eleven-twenty, the hour of the return
24643 of Lady Maynooth and her daughter.
24644 Desiring to say good-night, she attempted to enter her son's room.
24645 The door was locked on the inside, and no answer could be got to their
24646 cries and knocking.
24647 Help was obtained, and the door forced.
24648 The unfortunate young man was found lying near the table.
24649 His head had been horribly mutilated by an expanding revolver bullet, but
24650 no weapon of any sort was to be found in the room.
24658 \begin_layout Standard
24659 You can also use a section heading as the preface if you use a section command
24660 as \SpecialChar TeX
24662 For example the command
24665 \begin_layout LyX-Code
24668 subsection{subsection title}
24671 \begin_layout Standard
24672 creates a subsection.
24673 In this example the preface is a subsubsection:
24676 \begin_layout Standard
24677 \begin_inset Flex Multiple Columns
24680 \begin_layout Plain Layout
24681 \begin_inset Argument 2
24684 \begin_layout Plain Layout
24688 \begin_layout Plain Layout
24697 This is a subsubsection heading as a preface
24701 \begin_layout Plain Layout
24715 A minute examination of the circumstances served only to make the case more
24717 In the first place, no reason could be given why the young man should have
24718 fastened the door upon the inside.
24719 There was the possibility that the murderer had done this, and had afterwards
24720 escaped by the window.
24721 The drop was at least twenty feet, however, and a bed of crocuses in full
24723 Neither the flowers nor the earth showed any sign of having been disturbed,
24724 nor were there any marks upon the narrow strip of grass which separated
24725 the house from the road.
24726 Apparently, therefore, it was the young man himself who had fastened the
24728 But how did he come by his death? No one could have climbed up to the window
24729 without leaving traces.
24730 Suppose a man had fired through the window, he would indeed be a remarkable
24731 shot who could with a revolver inflict so deadly a wound.
24732 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24733 a hundred yards of the house.
24734 No one had heard a shot.
24742 \begin_layout Standard
24743 If there is less vertical space than 6
24744 \begin_inset space ~
24747 text lines is left on the page at the beginning of the multiple columns,
24748 a page break will be inserted before the multiple columns.
24749 Depending on the number of lines of the preface text, you might want to
24751 This is done by setting the cursor into the mulitcolumn inset behind the
24752 preface (if there is any) and using the menu
24754 Insert\SpecialChar menuseparator
24756 \begin_inset space ~
24760 \begin_inset space ~
24764 \begin_inset space ~
24770 Insert into that inset the amount of space like e.
24771 \begin_inset space \thinspace{}
24775 \begin_inset space \space{}
24779 \begin_inset Quotes eld
24783 \begin_inset Quotes erd
24787 \begin_inset Newline newline
24790 In this example the space is set to 7
24791 \begin_inset space ~
24794 text lines by using
24795 \begin_inset Flex Code
24798 \begin_layout Plain Layout
24807 \begin_inset Flex Code
24810 \begin_layout Plain Layout
24818 needs to be inserted as \SpecialChar TeX
24822 \begin_layout Standard
24823 \begin_inset Flex Multiple Columns
24826 \begin_layout Plain Layout
24827 \begin_inset Argument 3
24830 \begin_layout Plain Layout
24835 \begin_layout Plain Layout
24851 On the evening of the crime, he returned from the club exactly at ten.
24852 His mother and sister were out spending the evening with a relation.
24853 The servant deposed that she heard him enter the front room on the second
24854 floor, generally used as his sitting-room.
24855 She had lit a fire there, and as it smoked she had opened the window.
24856 No sound was heard from the room until eleven-twenty, the hour of the return
24857 of Lady Maynooth and her daughter.
24858 Desiring to say good-night, she attempted to enter her son's room.
24859 The door was locked on the inside, and no answer could be got to their
24860 cries and knocking.
24861 Help was obtained, and the door forced.
24862 The unfortunate young man was found lying near the table.
24863 His head had been horribly mutilated by an expanding revolver bullet, but
24864 no weapon of any sort was to be found in the room.
24872 \begin_layout Subsubsection
24876 \begin_layout Standard
24877 The amount of space before and after multiple columns can be changed by
24878 changing the length
24879 \begin_inset Flex Code
24882 \begin_layout Plain Layout
24891 For example the command
24894 \begin_layout LyX-Code
24902 \begin_layout Standard
24903 in \SpecialChar TeX
24904 Code changes its value to 3
24905 \begin_inset space \thinspace{}
24909 The change must be made before the multiple columns' start.
24910 The predefined value is 13
24911 \begin_inset space \thinspace{}
24917 \begin_layout Standard
24919 \begin_inset Flex Code
24922 \begin_layout Plain Layout
24931 \begin_inset space \thinspace{}
24937 \begin_layout Standard
24941 \begin_layout Plain Layout
24947 multicolsep}{2.5cm}
24955 \begin_layout Standard
24956 \begin_inset Flex Multiple Columns
24959 \begin_layout Plain Layout
24962 All day I turned these facts over in my mind, endeavouring to hit upon some
24963 theory which could reconcile them all, and to find that line of least resistanc
24964 e which my poor friend had declared to be the starting-point of every investigat
24966 I confess that I made little progress.
24967 In the evening I strolled across the Park, and found myself about six o'clock
24968 at the Oxford Street end of Park Lane.
24969 A group of loafers upon the pavements, all staring up at a particular window,
24970 directed me to the house which I had come to see.
24971 A tall, thin man with coloured glasses, whom I strongly suspected of being
24972 a plain-clothes detective, was pointing out some theory of his own, while
24973 the others crowded round to listen to what he said.
24974 I got as near him as I could, but his observations seemed to me to be absurd,
24975 so I withdrew again in some disgust.
24976 As I did so I struck against an elderly, deformed man, who had been behind
24977 me, and I knocked down several books which he was carrying.
24985 \begin_layout Standard
24986 \begin_inset Note Greyedout
24989 \begin_layout Plain Layout
24994 The values you set with
24995 \begin_inset Flex Code
24998 \begin_layout Plain Layout
25006 will be used for all following multiple columns until you change them again.
25014 \begin_layout Standard
25018 \begin_layout Plain Layout
25030 \begin_inset Note Note
25033 \begin_layout Plain Layout
25034 go back to the default
25042 \begin_layout Standard
25043 \begin_inset Newpage newpage
25049 \begin_layout Subsubsection
25053 \begin_layout Standard
25054 A column break can be forced by inserting the command
25055 \begin_inset Flex Code
25058 \begin_layout Plain Layout
25066 as \SpecialChar TeX
25067 Code to that position in the text where the column should be broken.
25068 Note that this leads in most cases to whitespace in the text.
25069 \begin_inset Newline newline
25072 Here is an example:
25075 \begin_layout Standard
25076 \begin_inset Flex Multiple Columns
25079 \begin_layout Plain Layout
25082 \begin_inset Quotes eld
25085 You're surprised to see me, sir,
25086 \begin_inset Quotes erd
25089 said he, in a strange, croaking voice.
25092 \begin_layout Plain Layout
25095 I acknowledged that I was.
25098 \begin_layout Plain Layout
25101 \begin_inset Quotes eld
25104 Well, I've a conscience, sir, and when I chanced to see you go into this
25105 house, as I came hobbling after you, I thought to myself, I'll just step
25106 in and see that kind gentleman, and tell him that if I was a bit gruff
25107 in my manner there was not any harm meant, and that I am much obliged to
25108 him for picking up my books.
25109 \begin_inset Quotes erd
25115 \begin_layout Plain Layout
25118 \begin_inset Quotes eld
25121 You make too much of a trifle,
25122 \begin_inset Quotes erd
25127 \begin_inset Quotes eld
25130 May I ask how you knew who I was?
25131 \begin_inset Quotes erd
25134 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25138 \begin_layout Plain Layout
25150 \begin_layout Plain Layout
25153 \begin_inset Quotes eld
25156 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25157 you'll find my little bookshop at the corner of Church Street, and very
25158 happy to see you, I am sure.
25159 Maybe you collect yourself, sir.
25163 \begin_inset space ~
25177 \begin_inset space ~
25180 – a bargain, every one of them.
25181 With five volumes you could just fill that gap on that second shelf.
25182 It looks untidy, does it not, sir?
25183 \begin_inset Quotes erd
25194 \begin_layout Subsubsection
25198 \begin_layout Standard
25199 The width of the columns is automatically calculated, but you can modify
25200 the space between the columns.
25201 This is done by changing the length
25202 \begin_inset Flex Code
25205 \begin_layout Plain Layout
25214 Its predefined value is 10
25215 \begin_inset space \thinspace{}
25219 Here is an example where
25220 \begin_inset Flex Code
25223 \begin_layout Plain Layout
25232 \begin_inset space \thinspace{}
25238 \begin_layout Standard
25242 \begin_layout Plain Layout
25256 \begin_layout Standard
25257 \begin_inset Flex Multiple Columns
25260 \begin_layout Plain Layout
25263 My observations of No.
25264 \begin_inset space \space{}
25267 427 Park Lane did little to clear up the problem in which I was interested.
25268 The house was separated from the street by a low wall and railing, the
25269 whole not more than five feet high.
25270 It was perfectly easy, therefore, for anyone to get into the garden, but
25271 the window was entirely inaccessible, since there was no water pipe or
25272 anything which could help the most active man to climb it.
25273 More puzzled than ever, I retraced my steps to Kensington.
25274 I had not been in my study five minutes when the maid entered to say that
25275 a person desired to see me.
25276 To my astonishment it was none other than my strange old book collector,
25277 his sharp, wizened face peering out from a frame of white hair, and his
25278 precious volumes, a dozen of them at least, wedged under his right arm.
25286 \begin_layout Standard
25290 \begin_layout Plain Layout
25302 \begin_inset Note Note
25305 \begin_layout Plain Layout
25306 go back to the default
25314 \begin_layout Subsubsection
25318 \begin_layout Standard
25319 Between the columns a rule with a width of the length
25320 \begin_inset Flex Code
25323 \begin_layout Plain Layout
25332 If this rule width is set to 0
25333 \begin_inset space \thinspace{}
25336 pt (this is the default), the rule is suppressed.
25337 In the following example the rule is 2
25338 \begin_inset space \thinspace{}
25344 \begin_layout Standard
25348 \begin_layout Plain Layout
25354 columnseprule}{2pt}
25362 \begin_layout Standard
25363 \begin_inset Flex Multiple Columns
25366 \begin_layout Plain Layout
25369 \begin_inset Quotes eld
25372 You're surprised to see me, sir,
25373 \begin_inset Quotes erd
25376 said he, in a strange, croaking voice.
25379 \begin_layout Plain Layout
25382 I acknowledged that I was.
25385 \begin_layout Plain Layout
25388 \begin_inset Quotes eld
25391 Well, I've a conscience, sir, and when I chanced to see you go into this
25392 house, as I came hobbling after you, I thought to myself, I'll just step
25393 in and see that kind gentleman, and tell him that if I was a bit gruff
25394 in my manner there was not any harm meant, and that I am much obliged to
25395 him for picking up my books.
25396 \begin_inset Quotes erd
25402 \begin_layout Plain Layout
25405 \begin_inset Quotes eld
25408 You make too much of a trifle,
25409 \begin_inset Quotes erd
25414 \begin_inset Quotes eld
25417 May I ask how you knew who I was?
25418 \begin_inset Quotes erd
25424 \begin_layout Plain Layout
25427 \begin_inset Quotes eld
25430 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25431 you'll find my little bookshop at the corner of Church Street, and very
25432 happy to see you, I am sure.
25433 Maybe you collect yourself, sir.
25437 \begin_inset space ~
25451 \begin_inset space ~
25454 – a bargain, every one of them.
25455 With five volumes you could just fill that gap on that second shelf.
25456 It looks untidy, does it not, sir?
25457 \begin_inset Quotes erd
25468 \begin_layout Standard
25469 \begin_inset VSpace defskip
25475 \begin_layout Standard
25476 The rule can be colored by redefining the command
25477 \begin_inset Flex Code
25480 \begin_layout Plain Layout
25489 This is done by inserting the command
25492 \begin_layout LyX-Code
25497 columnseprulecolor}{
25502 \begin_layout Standard
25503 as \SpecialChar TeX
25504 Code before the multicolumn inset.
25506 \begin_inset Flex Code
25509 \begin_layout Plain Layout
25515 in this command by a color of your choice.
25516 You can use all pre- and self-defined colors.
25524 \begin_inset space ~
25529 for more information about pre- and self-defined colors.
25530 To go back to the default color insert the command
25533 \begin_layout LyX-Code
25538 columnseprulecolor}{
25543 \begin_layout Standard
25544 Here is the example with a cyan rule and 1
25545 \begin_inset space \thinspace{}
25548 cm column separation:
25551 \begin_layout Standard
25555 \begin_layout Plain Layout
25564 \begin_layout Plain Layout
25570 columnseprulecolor}{
25580 \begin_layout Standard
25581 \begin_inset Flex Multiple Columns
25584 \begin_layout Plain Layout
25587 \begin_inset Quotes eld
25590 You're surprised to see me, sir,
25591 \begin_inset Quotes erd
25594 said he, in a strange, croaking voice.
25597 \begin_layout Plain Layout
25600 I acknowledged that I was.
25603 \begin_layout Plain Layout
25606 \begin_inset Quotes eld
25609 Well, I've a conscience, sir, and when I chanced to see you go into this
25610 house, as I came hobbling after you, I thought to myself, I'll just step
25611 in and see that kind gentleman, and tell him that if I was a bit gruff
25612 in my manner there was not any harm meant, and that I am much obliged to
25613 him for picking up my books.
25614 \begin_inset Quotes erd
25620 \begin_layout Plain Layout
25623 \begin_inset Quotes eld
25626 You make too much of a trifle,
25627 \begin_inset Quotes erd
25632 \begin_inset Quotes eld
25635 May I ask how you knew who I was?
25636 \begin_inset Quotes erd
25642 \begin_layout Plain Layout
25645 \begin_inset Quotes eld
25648 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25649 you'll find my little bookshop at the corner of Church Street, and very
25650 happy to see you, I am sure.
25651 Maybe you collect yourself, sir.
25655 \begin_inset space ~
25669 \begin_inset space ~
25672 – a bargain, every one of them.
25673 With five volumes you could just fill that gap on that second shelf.
25674 It looks untidy, does it not, sir?
25675 \begin_inset Quotes erd
25686 \begin_layout Standard
25690 \begin_layout Plain Layout
25696 columnseprule}{0pt}
25699 \begin_layout Plain Layout
25705 columnseprulecolor}{
25713 \begin_inset Note Note
25716 \begin_layout Plain Layout
25717 go back to the default
25725 \begin_layout Section
25726 Non-standard Paragraph Shapes
25729 \begin_layout Standard
25732 as well as any other text processor uses by default rectangular paragraphs.
25733 For special cases like for example posters, invitation cards or poems you
25734 can modify the paragraph shape to one of your choice.
25735 This can be done by using the \SpecialChar LaTeX
25737 \begin_inset Flex Code
25740 \begin_layout Plain Layout
25747 which is loaded by using in the document settings the module
25749 Custom paragraph shapes
25754 \begin_layout Subsection
25758 \begin_layout Standard
25763 provides the following shapes:
25766 \begin_layout Standard
25767 \begin_inset Tabular
25768 <lyxtabular version="3" rows="13" columns="3">
25769 <features booktabs="true" islongtable="true" longtabularalignment="center">
25770 <column alignment="left" valignment="middle" width="16col%">
25771 <column alignment="left" valignment="middle" width="40col%">
25772 <column alignment="left" valignment="middle" width="35col%">
25773 <row endhead="true">
25774 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25777 \begin_layout Plain Layout
25786 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25789 \begin_layout Plain Layout
25798 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25801 \begin_layout Plain Layout
25811 <row interlinespace="default">
25812 <cell alignment="left" valignment="top" usebox="none">
25815 \begin_layout Plain Layout
25823 <cell alignment="left" valignment="top" usebox="none">
25826 \begin_layout Plain Layout
25829 Circle with circular hole (in the size of a CD/DVD)
25834 <cell alignment="left" valignment="top" usebox="none">
25837 \begin_layout Plain Layout
25840 Cannot be scaled, take care there is not too much text
25846 <row interlinespace="default">
25847 <cell alignment="left" valignment="top" usebox="none">
25850 \begin_layout Plain Layout
25858 <cell alignment="left" valignment="top" usebox="none">
25861 \begin_layout Plain Layout
25869 <cell alignment="left" valignment="top" usebox="none">
25872 \begin_layout Plain Layout
25875 Fragile, calculation might fail
25881 <row interlinespace="default">
25882 <cell alignment="left" valignment="top" usebox="none">
25885 \begin_layout Plain Layout
25893 <cell alignment="left" valignment="top" usebox="none">
25896 \begin_layout Plain Layout
25899 Rhomboid (symbolizing a
25900 \begin_inset Quotes eld
25904 \begin_inset Quotes erd
25912 <cell alignment="left" valignment="top" usebox="none">
25915 \begin_layout Plain Layout
25924 <row interlinespace="default">
25925 <cell alignment="left" valignment="top" usebox="none">
25928 \begin_layout Plain Layout
25936 <cell alignment="left" valignment="top" usebox="none">
25939 \begin_layout Plain Layout
25947 <cell alignment="left" valignment="top" usebox="none">
25950 \begin_layout Plain Layout
25959 <row interlinespace="default">
25960 <cell alignment="left" valignment="top" usebox="none">
25963 \begin_layout Plain Layout
25971 <cell alignment="left" valignment="top" usebox="none">
25974 \begin_layout Plain Layout
25982 <cell alignment="left" valignment="top" usebox="none">
25985 \begin_layout Plain Layout
25994 <row interlinespace="default">
25995 <cell alignment="left" valignment="top" usebox="none">
25998 \begin_layout Plain Layout
26006 <cell alignment="left" valignment="top" usebox="none">
26009 \begin_layout Plain Layout
26012 Nut for bolt (hexagon with circular hole)
26017 <cell alignment="left" valignment="top" usebox="none">
26020 \begin_layout Plain Layout
26029 <row interlinespace="default">
26030 <cell alignment="left" valignment="top" usebox="none">
26033 \begin_layout Plain Layout
26041 <cell alignment="left" valignment="top" usebox="none">
26044 \begin_layout Plain Layout
26052 <cell alignment="left" valignment="top" usebox="none">
26055 \begin_layout Plain Layout
26064 <row interlinespace="default">
26065 <cell alignment="left" valignment="top" usebox="none">
26068 \begin_layout Plain Layout
26076 <cell alignment="left" valignment="top" usebox="none">
26079 \begin_layout Plain Layout
26087 <cell alignment="left" valignment="top" usebox="none">
26090 \begin_layout Plain Layout
26099 <row interlinespace="default">
26100 <cell alignment="left" valignment="top" usebox="none">
26103 \begin_layout Plain Layout
26111 <cell alignment="left" valignment="top" usebox="none">
26114 \begin_layout Plain Layout
26122 <cell alignment="left" valignment="top" usebox="none">
26125 \begin_layout Plain Layout
26134 <row interlinespace="default">
26135 <cell alignment="left" valignment="top" usebox="none">
26138 \begin_layout Plain Layout
26146 <cell alignment="left" valignment="top" usebox="none">
26149 \begin_layout Plain Layout
26152 Normal/reversed rain drop
26157 <cell alignment="left" valignment="top" usebox="none">
26160 \begin_layout Plain Layout
26163 Fragile, calculation might fail
26169 <row interlinespace="default">
26170 <cell alignment="left" valignment="top" usebox="none">
26173 \begin_layout Plain Layout
26182 <cell alignment="left" valignment="top" usebox="none">
26185 \begin_layout Plain Layout
26188 The \SpecialChar TeX
26194 <cell alignment="left" valignment="top" usebox="none">
26197 \begin_layout Plain Layout
26206 <row interlinespace="default">
26207 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26210 \begin_layout Plain Layout
26214 \begin_inset Newline newline
26222 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26225 \begin_layout Plain Layout
26228 Triangles in different orientations
26233 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26236 \begin_layout Plain Layout
26252 \begin_layout Standard
26253 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26255 for environments in the toolbar.
26258 \begin_layout Standard
26259 \begin_inset Newpage newpage
26265 \begin_layout Standard
26266 Here is an example paragraph in the shape of a nut:
26269 \begin_layout Standard
26270 \begin_inset VSpace bigskip
26279 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26280 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26282 At vero eos et accusam et justo duo dolores et ea rebum.
26283 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26285 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26286 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26290 \begin_layout Standard
26291 \begin_inset VSpace bigskip
26297 \begin_layout Standard
26298 \begin_inset Note Greyedout
26301 \begin_layout Plain Layout
26310 paragraphs cannot run over a page break.
26318 \begin_layout Standard
26319 \begin_inset VSpace bigskip
26325 \begin_layout Standard
26327 \begin_inset Flex Code
26330 \begin_layout Plain Layout
26336 takes care that the shape will always be preserved, no matter how much
26337 text is in the paragraph.
26338 Therefore the paragraph size changes with the amount of contained text.
26339 This can lead to paragraph sizes exceeding the page margins.
26340 To demonstrate the size scaling, here is the same example paragraph but
26341 with twice as much text:
26344 \begin_layout Standard
26345 \begin_inset Newpage newpage
26354 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26355 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26357 At vero eos et accusam et justo duo dolores et ea rebum.
26358 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26360 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26361 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26363 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26364 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26366 At vero eos et accusam et justo duo dolores et ea rebum.
26367 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26369 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26370 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26374 \begin_layout Standard
26375 \begin_inset VSpace bigskip
26381 \begin_layout Standard
26382 An exception is the shape
26387 It cannot be scaled because it must fit the size of a CD/DVD.
26388 Therefore the amount of text that fits into the shape is limited.
26389 \begin_inset Newline newline
26400 shape are fragile, meaning that the calculation of their size can fail,
26401 depending on the amount of text.
26402 You will then get the \SpecialChar LaTeX
26404 \begin_inset Quotes eld
26407 Arithmetic overflow
26408 \begin_inset Quotes erd
26412 In this case one can try to remove or add some text; if nothing works one
26413 has to use another shape.
26416 \begin_layout Standard
26417 \begin_inset VSpace bigskip
26423 \begin_layout Standard
26424 For shapes with tips you will maybe see that \SpecialChar LaTeX
26425 's hyphenation routine fails
26426 for text in the tips.
26427 Therefore it is often necessary to add hyphenation points
26432 arg "specialchar-insert hyphenation"
26437 ) to the corresponding text parts.
26440 \begin_layout Standard
26441 \begin_inset VSpace bigskip
26447 \begin_layout Standard
26448 Shapepar paragraphs are either always centered or placed on the page so
26449 that their left border touches the left page margin.
26450 You can therefore not use the paragraph dialog to align such paragraphs.
26451 A solution is to put the paragraph into a minipage or parbox and align
26453 The problem is hereby to find the right width for the box.
26454 Because if it is too wide and you center the box, the paragraph is not
26455 centered too because it sticks at the left side of the box.
26456 So you might have to play a bit with the width until it fits.
26457 Here are two heart-shaped paragraphs, the first one is not aligned, the
26458 second one is right-aligned:
26461 \begin_layout Standard
26462 \begin_inset Newpage newpage
26468 \begin_layout Heart
26472 Lo\SpecialChar softhyphen
26473 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26474 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26476 At vero eos et accusam et justo duo dolores et ea rebum.
26477 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26481 \begin_layout Standard
26482 \begin_inset VSpace bigskip
26488 \begin_layout Standard
26491 \begin_inset Box Frameless
26501 height_special "totalheight"
26506 backgroundcolor "none"
26509 \begin_layout Heart
26513 Lo\SpecialChar softhyphen
26514 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26515 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26517 At vero eos et accusam et justo duo dolores et ea rebum.
26518 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26527 \begin_layout Subsection
26531 \begin_layout Standard
26532 You can define any shape you want.
26533 Doing this manually is a lot of work because every coordinate must be specified.
26534 But there is a way to let the computer calculate the coordinates:
26537 \begin_layout Enumerate
26538 Install the program
26539 \begin_inset CommandInset href
26542 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
26550 \begin_layout Enumerate
26557 TeX/LaTeX\SpecialChar menuseparator
26558 Settings\SpecialChar menuseparator
26561 and select the font size you are using in your document.
26562 For example this document uses the size 12
26563 \begin_inset space \thinspace{}
26569 \begin_layout Enumerate
26573 \begin_layout Enumerate
26576 TeX/LaTeX\SpecialChar menuseparator
26579 to export the shape to coordinates.
26580 In the appearing dialog use either the outline of your shape for the coordinate
26581 s or the path itself.
26585 \begin_layout Plain Layout
26586 For more information see
26587 \begin_inset CommandInset href
26589 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26602 \begin_layout Standard
26603 The coordinates are written into a \SpecialChar TeX
26605 To use it for your \SpecialChar LyX
26609 \begin_layout Enumerate
26610 Place the cursor before the first character of your paragraph (or into a
26614 \begin_layout Enumerate
26615 Open in \SpecialChar LyX
26618 Insert\SpecialChar menuseparator
26619 File\SpecialChar menuseparator
26621 \begin_inset space ~
26626 , select the file and use
26635 \begin_layout Standard
26636 \begin_inset VSpace defskip
26642 \begin_layout Standard
26643 \begin_inset Note Greyedout
26646 \begin_layout Plain Layout
26651 : The changed shape only applies to the current paragraph; everything is
26652 reset to normal for the next paragraph.
26653 Therefore the shape definition file must be input into every paragraph
26654 with the desired shape.
26662 \begin_layout Standard
26663 \begin_inset VSpace bigskip
26669 \begin_layout Standard
26670 Here is an example:
26673 \begin_layout Standard
26674 \begin_inset VSpace bigskip
26680 \begin_layout Standard
26681 \begin_inset CommandInset include
26683 filename "SpecialParagraphShape.tex"
26689 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26690 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26692 At vero eos et accusam et justo duo dolores et ea rebum.
26693 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26695 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26696 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26700 \begin_layout Standard
26701 \begin_inset VSpace bigskip
26707 \begin_layout Standard
26712 to draw complexer shapes in
26716 you can draw the shape in a program of your choice and import the resulting
26722 Then you only need to draw a line or spline along the outline of the image.
26725 \begin_layout Standard
26726 \begin_inset VSpace bigskip
26732 \begin_layout Standard
26735 Custom paragraph shapes
26737 also provides the two commands
26745 which can be used to define custom shapes coordinate by coordinate.
26749 \begin_layout Plain Layout
26750 These commands are internally used for all shapes described here.
26755 For information how these styles are used and about further customization
26756 possibilities, have a look at the
26757 \begin_inset CommandInset href
26759 name "documentation"
26760 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
26766 \begin_inset Flex Code
26769 \begin_layout Plain Layout