1 #LyX 2.3 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
40 \maintain_unincluded_children false
42 \language_package default
45 \font_roman "lmodern" "default"
46 \font_sans "lmss" "default"
47 \font_typewriter "lmtt" "default"
48 \font_math "auto" "auto"
49 \font_default_family default
50 \use_non_tex_fonts false
53 \font_sf_scale 100 100
54 \font_tt_scale 100 100
56 \use_dash_ligatures true
58 \default_output_format pdf2
60 \bibtex_command default
61 \index_command default
65 \pdf_title "LyX's Additional Features manual"
66 \pdf_author "LyX Team"
67 \pdf_subject "LyX's additional features documentation"
68 \pdf_keywords "LyX, Documentation, Additional"
70 \pdf_bookmarksnumbered true
71 \pdf_bookmarksopen false
72 \pdf_bookmarksopenlevel 1
77 \pdf_pdfusetitle false
78 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
81 \use_package amsmath 1
82 \use_package amssymb 1
85 \use_package mathdots 1
86 \use_package mathtools 0
88 \use_package stackrel 0
89 \use_package stmaryrd 0
90 \use_package undertilde 0
92 \cite_engine_type default
96 \paperorientation portrait
101 \notefontcolor #0000ff
108 \paragraph_separation indent
109 \paragraph_indentation default
111 \math_indentation default
112 \math_numbering_side default
113 \quotes_style english
117 \paperpagestyle headings
118 \tracking_changes 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 They are warnings about lines that were too long and run past the right
1792 Almost always, this is unnoticeable in the final output.
1793 (It can be just a point or two.) Or, only one or two characters extend past
1796 seems to generate at least one of these messages for just about any document
1798 \begin_inset Newline newline
1801 You can ignore these messages.
1802 Your eyes will tell you if there's a problem with something that's too
1803 wide; just look at the output.
1807 \begin_layout Plain Layout
1808 You can also enable the `draft' option in
1809 \begin_inset Flex Noun
1812 \begin_layout Plain Layout
1813 Document\SpecialChar menuseparator
1819 , and then \SpecialChar LaTeX
1820 will draw a black box in the margin of lines that are overfull.
1828 \begin_layout Itemize
1829 \begin_inset Flex Code
1832 \begin_layout Plain Layout
1841 \begin_inset Newline newline
1844 Not quite as common as its cousin.
1846 seems to like to print lines that are a bit too wide as opposed to ones
1847 that are a bit too narrow.
1848 We have no idea why.
1851 \begin_layout Itemize
1852 \begin_inset Flex Code
1855 \begin_layout Plain Layout
1864 \begin_inset Flex Code
1867 \begin_layout Plain Layout
1876 \begin_inset Newline newline
1879 Warnings about troubles breaking the page.
1880 Once again, just look at the output.
1881 Your eyes will tell you where something has gone wrong.
1884 \begin_layout Itemize
1885 \begin_inset Flex Code
1888 \begin_layout Plain Layout
1890 \begin_inset Quotes els
1894 \begin_inset Quotes ers
1903 \begin_inset Newline newline
1907 \begin_inset Quotes eld
1911 \begin_inset Quotes erd
1914 isn't installed on this system.
1915 This usually appears because some package your document needs isn't installed.
1916 If you didn't touch the preamble or didn't use the
1917 \begin_inset Flex Code
1920 \begin_layout Plain Layout
1928 command, then one of the packages \SpecialChar LyX
1929 tried to load is missing.
1931 \begin_inset Flex Noun
1934 \begin_layout Plain Layout
1935 Help\SpecialChar menuseparator
1942 to get a list of packages that \SpecialChar LyX
1944 This file is updated whenever you reconfigure \SpecialChar LyX
1946 \begin_inset Flex Noun
1949 \begin_layout Plain Layout
1950 Tools\SpecialChar menuseparator
1956 ) and tells you which packages have been detected and what they do.
1957 \begin_inset Newline newline
1961 \begin_inset Flex Code
1964 \begin_layout Plain Layout
1972 command and the package in question isn't installed, then you'll need to
1973 install it yourself.
1976 \begin_layout Itemize
1977 \begin_inset Flex Code
1980 \begin_layout Plain Layout
1981 LaTeX Error: Unknown option
1987 \begin_inset Newline newline
1990 Error messages beginning with this are trying to tell you that you specified
1991 a bad or undefined option to a package.
1992 Check the package's documentation.
1995 \begin_layout Itemize
1996 \begin_inset Flex Code
1999 \begin_layout Plain Layout
2000 Undefined control sequence
2006 \begin_inset Newline newline
2009 If you've inserted \SpecialChar LaTeX
2010 code into your document, but made a typo, you'll get
2012 You may have forgotten to load a package.
2013 In any case, this error message usually means that you used an undefined
2018 \begin_layout Standard
2019 There are other error and warning messages.
2020 Some are self-explanatory.
2021 These are usually \SpecialChar LaTeX
2023 Others are downright cryptic.
2024 These are usually \SpecialChar TeX
2025 error messages, and we really have
2029 what they mean or how to decipher them.
2033 \begin_layout Standard
2034 There's a general sequence you should follow if you get error messages:
2037 \begin_layout Enumerate
2038 Look at the \SpecialChar LaTeX
2039 code you inserted for typos.
2042 \begin_layout Enumerate
2043 If there are no typos, check that you used the command(s) correctly.
2046 \begin_layout Enumerate
2047 If you get a bunch of error boxes piled up at the very top of the document—and
2048 especially if you see a
2049 \begin_inset Quotes eld
2053 \begin_inset Flex Code
2056 \begin_layout Plain Layout
2065 \begin_inset Quotes erd
2068 error—it means that there are errors in the preamble.
2069 Start debugging your preamble.
2072 \begin_layout Enumerate
2073 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2075 document, the first suspect is your \SpecialChar LaTeX
2076 distribution itself.
2077 Check for missing packages and install them.
2080 \begin_layout Enumerate
2081 Okay, so there are no missing packages.
2082 Did you use any of the fine-tuning options in \SpecialChar LyX
2083 ? Specifically, did you
2087 any of them, like trying to manually insert lots of
2088 \begin_inset Flex Code
2091 \begin_layout Plain Layout
2093 \begin_inset space ~
2102 \begin_inset Flex Code
2105 \begin_layout Plain Layout
2112 \begin_inset Flex Code
2115 \begin_layout Plain Layout
2121 ? Did you try to kludge something together with these instead of using the
2122 appropriate paragraph environment?
2125 \begin_layout Enumerate
2126 All right, you didn't use any of the fine-tuning options, you played by
2128 Did you try to pull a fancy maneuver? Did you do something funky inside
2129 a table or an equation, like inserting a graphic into a table cell?
2132 \begin_layout Enumerate
2133 Do you have long sections of text where \SpecialChar LaTeX
2134 cannot find a place to break a
2135 line? By default, \SpecialChar LaTeX
2136 is rather strict about how much extra inter-word spacing
2137 it will add in order to break a line.
2138 Preferably, you should rework the paragraph to avoid the problem.
2141 \begin_layout Enumerate
2142 Did you go overboard with the nesting? \SpecialChar LyX
2143 (currently) doesn't check to make
2144 sure you're in the limits for nesting environments.
2145 If you nested a bunch of environments to the
2146 \begin_inset Formula $17^{\mathrm{th}}$
2149 level, that's the problem.
2150 (The limit in \SpecialChar LaTeX
2154 \begin_layout Enumerate
2155 Okay, you didn't get any error messages, but your output looks awful.
2156 If you have a table or figure that's too wide or long for the page, you
2161 \begin_layout Enumerate
2162 rescale the figure so it fits.
2165 \begin_layout Enumerate
2166 trim down the table so it fits.
2170 \begin_layout Enumerate
2171 If something else is wrong with the output, and you didn't try to pull anything
2172 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2175 \begin_layout Standard
2176 If all this doesn't help—well, then
2180 you might have found a bug in \SpecialChar LyX
2185 \begin_layout Chapter
2189 \begin_layout Section
2190 Customizing Bibliographies with Bib\SpecialChar TeX
2194 \begin_layout Standard
2195 The most basic information about how to use Bib\SpecialChar TeX
2200 with \SpecialChar LyX
2201 is contained in the section
2203 Bibliography databases
2210 The following subsections explain special bibliography features supported
2215 \begin_layout Subsection
2216 Alternative Citation Styles
2219 \begin_layout Standard
2220 Standard Bib\SpecialChar TeX
2222 \begin_inset space \thinspace{}
2226 \begin_inset space \space{}
2230 \begin_inset Quotes eld
2234 \begin_inset Quotes erd
2237 ) to refer to a cited work.
2238 However, in many scientific disciplines, other citation styles are in use.
2239 The most common one is the author-year style (e.
2240 \begin_inset space \thinspace{}
2244 \begin_inset space \space{}
2248 \begin_inset Quotes eld
2252 \begin_inset Quotes erd
2257 supports three packages that provide this style,
2258 \begin_inset Flex Code
2261 \begin_layout Plain Layout
2268 \begin_inset Flex Code
2271 \begin_layout Plain Layout
2278 \begin_inset Flex Code
2281 \begin_layout Plain Layout
2288 Each of these packages has their pros and cons, which cannot be listed
2290 If you only want to have simple author-year (or author-numerical) style,
2291 or if you want to use one of the countless style files for
2292 \begin_inset Flex Code
2295 \begin_layout Plain Layout
2301 , then the established
2302 \begin_inset Flex Code
2305 \begin_layout Plain Layout
2311 package is probably your choice.
2312 If you look for specific citation styles common in law studies, you might
2314 \begin_inset Flex Code
2317 \begin_layout Plain Layout
2324 If you want to have full control over the formatting or look for advanced
2325 features such as ibidem, footnote citations, full title citations, advanced
2326 date formats (such as 400 BC) or full localization to other languages than
2327 English, you should definitely consider
2328 \begin_inset Flex Code
2331 \begin_layout Plain Layout
2337 , which exceeds all other packages in terms of features, but is also quite
2338 heavy and more resource-hungry.
2341 \begin_layout Standard
2342 The handling of these packages in \SpecialChar LyX
2343 is basically the same.
2345 \begin_inset Flex Noun
2348 \begin_layout Plain Layout
2349 Document\SpecialChar menuseparator
2356 \begin_inset Flex Noun
2359 \begin_layout Plain Layout
2366 \begin_inset Flex Noun
2369 \begin_layout Plain Layout
2376 \begin_inset Flex Noun
2379 \begin_layout Plain Layout
2386 \begin_inset Flex Noun
2389 \begin_layout Plain Layout
2390 Biblatex (Natbib mode)
2396 \begin_inset Flex Noun
2399 \begin_layout Plain Layout
2406 \begin_inset Flex Noun
2409 \begin_layout Plain Layout
2416 \begin_inset space ~
2419 6.5.3 in the User's Guide for more information on these choices).
2420 With all these packages, you will get some extra features in the citation
2421 dialog and you can select the style of the reference (
2422 \begin_inset Quotes eld
2426 \begin_inset Quotes erd
2430 \begin_inset Quotes eld
2434 \begin_inset Quotes erd
2438 \begin_inset Quotes eld
2442 \begin_inset Quotes erd
2446 \begin_inset Quotes eld
2450 \begin_inset Quotes erd
2454 Note that either package needs specifically designed style files.
2455 They all ship their own, but there are lots of additional style files,
2456 and there is even an interactive style file builder
2460 \begin_layout Plain Layout
2462 \begin_inset Flex URL
2465 \begin_layout Plain Layout
2467 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2478 \begin_inset Flex Code
2481 \begin_layout Plain Layout
2490 \begin_layout Subsection
2491 Subdivided Bibliographies
2494 \begin_layout Standard
2495 Sometimes you might need to divide your bibliography into several sections.
2496 If you are for instance a historian, the possibility to separate sources
2497 and scientific works is most likely a
2498 \begin_inset Quotes eld
2502 \begin_inset Quotes erd
2506 Unfortunately, Bib\SpecialChar TeX
2507 itself does not allow you to do this.
2508 But with the help of some \SpecialChar LaTeX
2509 packages, Bib\SpecialChar TeX
2510 can be extended to fit your needs.
2513 \begin_layout Standard
2515 provides native support for one of these packages,
2523 \begin_layout Plain Layout
2525 \begin_inset Flex URL
2528 \begin_layout Plain Layout
2530 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2540 The advantage of this package (compared to other packages such as
2544 ) is that you don't need to define new citation commands.
2545 Instead, you need to prepare different bibliographic databases which include
2546 the entries for the different sections of the bibliography.
2547 For example: If you want to divide your bibliography into the sections
2549 \begin_inset Quotes eld
2553 \begin_inset Quotes erd
2557 \begin_inset Quotes eld
2561 \begin_inset Quotes erd
2564 , you first need to create two bibliographic databases, e.
2565 \begin_inset space \thinspace{}
2569 \begin_inset space \space{}
2573 \begin_inset Flex Code
2576 \begin_layout Plain Layout
2583 \begin_inset Flex Code
2586 \begin_layout Plain Layout
2596 \begin_layout Standard
2598 \begin_inset Flex Noun
2601 \begin_layout Plain Layout
2602 Document\SpecialChar menuseparator
2609 \begin_inset Flex Noun
2612 \begin_layout Plain Layout
2619 \begin_inset Flex Noun
2622 \begin_layout Plain Layout
2623 Subdivided bibliography
2629 Now you can insert multiple Bib\SpecialChar TeX
2630 bibliographies, one for each section of
2632 Returning to our example: Insert the Bib\SpecialChar TeX
2634 \begin_inset Flex Code
2637 \begin_layout Plain Layout
2643 and a second one for the database
2644 \begin_inset Flex Code
2647 \begin_layout Plain Layout
2654 You are free to use the same or different styles for each section.
2655 Additionally, you can choose if the bibliography section should contain
2657 \begin_inset Quotes eld
2660 all cited references
2661 \begin_inset Quotes erd
2664 of the specified database(s) (which is the default),
2665 \begin_inset Quotes eld
2668 all uncited references
2669 \begin_inset Quotes erd
2673 \begin_inset Quotes eld
2677 \begin_inset Quotes erd
2681 This might be useful if you would like to separate your bibliography into
2683 \begin_inset Quotes eld
2687 \begin_inset Quotes erd
2691 \begin_inset Quotes eld
2695 \begin_inset Quotes erd
2699 \begin_inset Quotes eld
2703 \begin_inset Quotes erd
2707 The titles for the sections can be added as ordinary sections or subsections.
2709 \begin_inset Flex Code
2712 \begin_layout Plain Layout
2718 removes the bibliography title, you have to manually re-add that, too (as
2719 a chapter* or section*, for instance).
2722 \begin_layout Standard
2727 , the procedure is a bit different.
2736 , the aforementioned
2737 \begin_inset Flex Noun
2740 \begin_layout Plain Layout
2741 Subdivided bibliography
2746 option is disabled if you use
2755 provides its own means to generate subdivided bibliographies.
2756 You can either add keywords to bibliography entries via the
2757 \begin_inset Flex Code
2760 \begin_layout Plain Layout
2766 entry option and then filter bibliography sections by keyword (by adding
2768 \begin_inset Flex Code
2771 \begin_layout Plain Layout
2778 \begin_inset Flex Noun
2781 \begin_layout Plain Layout
2787 field of the dialog that opens if you right-click on the
2788 \begin_inset Flex Noun
2791 \begin_layout Plain Layout
2792 Biblatex Generated Bibliography
2797 button), or you can filter by entry types (such as
2806 \begin_inset space \thinspace{}
2811 \begin_inset Flex Code
2814 \begin_layout Plain Layout
2821 \begin_inset Flex Code
2824 \begin_layout Plain Layout
2831 \begin_inset Flex Noun
2834 \begin_layout Plain Layout
2840 field, or you can create so-called
2841 \begin_inset Quotes eld
2844 Bibliography Categories
2845 \begin_inset Quotes erd
2848 to which you can assign individual entries.
2849 Please refer to the Biblatex manual, section
2851 Subdivided Bibliographies
2856 \begin_layout Subsection
2857 Multiple Bibliographies
2860 \begin_layout Standard
2861 Multiple bibliographies, e.
2862 \begin_inset space \thinspace{}
2866 \begin_inset space \space{}
2869 a bibliography for each part, chapter, section, subsection or child (sub-documen
2870 t) of the document, are also supported by \SpecialChar LyX
2872 In order to enable it, go to
2873 \begin_inset Flex Noun
2876 \begin_layout Plain Layout
2877 Document\SpecialChar menuseparator
2878 Settings\SpecialChar menuseparator
2884 and select the relevant unit (e.
2885 \begin_inset space \thinspace{}
2889 \begin_inset Quotes eld
2893 \begin_inset Quotes erd
2897 \begin_inset Flex Noun
2900 \begin_layout Plain Layout
2901 Multiple Bibliographies
2907 Then add a Bib(la)\SpecialChar TeX
2908 bibliography to each unit (e.
2909 \begin_inset space \thinspace{}
2912 g., section) of your document.
2913 In the output, a separate bibliography, containing only the references
2914 done in the current unit is generated.
2917 \begin_layout Standard
2918 If you use Bib\SpecialChar TeX
2920 \begin_inset Flex Code
2923 \begin_layout Plain Layout
2930 \begin_inset Flex Code
2933 \begin_layout Plain Layout
2939 package is used to create multiple bibliographies.
2940 The former package is used if you select
2941 \begin_inset Quotes eld
2945 \begin_inset Quotes erd
2953 \begin_inset Flex Noun
2956 \begin_layout Plain Layout
2957 Sectioned Bibliography
2964 \begin_inset Flex Code
2967 \begin_layout Plain Layout
2977 \begin_layout Plain Layout
2978 An alternative approach, if you are willing to use some
2979 \begin_inset Flex Noun
2982 \begin_layout Plain Layout
2990 \begin_inset space ~
2994 \begin_inset CommandInset ref
2996 reference "sec:Inserting-TeX-Code"
3001 \begin_inset Flex Code
3004 \begin_layout Plain Layout
3016 \begin_inset Flex Code
3019 \begin_layout Plain Layout
3025 is used, \SpecialChar LyX
3026 encloses the specified units in
3027 \begin_inset Flex Code
3030 \begin_layout Plain Layout
3037 \begin_inset Flex Code
3040 \begin_layout Plain Layout
3049 \begin_inset Flex Code
3052 \begin_layout Plain Layout
3060 in order to create the units.
3061 Note that this approach has some limitations.
3062 First, every citation reference has to be inside some
3063 \begin_inset Flex Code
3066 \begin_layout Plain Layout
3073 So citations outside a defined unit (e.
3074 \begin_inset space \thinspace{}
3077 g., before the first section if you use
3078 \begin_inset Quotes eld
3082 \begin_inset Quotes erd
3086 \begin_inset Quotes eld
3090 \begin_inset Quotes erd
3094 You can also create your own units by entering
3095 \begin_inset Flex Code
3098 \begin_layout Plain Layout
3107 \begin_inset Flex Code
3110 \begin_layout Plain Layout
3119 code (for instance to work around the mentioned limitation).
3121 \begin_inset Flex Code
3124 \begin_layout Plain Layout
3131 A second limitation is that
3132 \begin_inset Flex Code
3135 \begin_layout Plain Layout
3141 always processes all references of a bibliography database, even if they
3143 This can result in odd labels (e.
3144 \begin_inset space \thinspace{}
3149 \begin_inset Quotes eld
3153 \begin_inset Quotes erd
3156 if two works of this author from 2014 are in the database, even if only
3160 \begin_layout Standard
3166 \begin_inset Flex Code
3169 \begin_layout Plain Layout
3175 option is used instead.
3176 If you need specific units, you can start them with the \SpecialChar TeX
3178 \begin_inset Flex Code
3181 \begin_layout Plain Layout
3190 \begin_inset Flex Code
3193 \begin_layout Plain Layout
3202 If you also want to control the end of the unit, use the environment
3203 \begin_inset Flex Code
3206 \begin_layout Plain Layout
3216 \begin_inset Flex Code
3219 \begin_layout Plain Layout
3229 \begin_inset Flex Code
3232 \begin_layout Plain Layout
3239 In addition to the individual bibliography of the current unit,
3243 also provides an easy way to output all bibliographies, subsequently, at
3245 \begin_inset space \thinspace{}
3248 g., at the end of the document).
3250 \begin_inset Quotes eld
3254 \begin_inset Quotes erd
3257 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3263 manual for more information on this topic.
3266 \begin_layout Section
3270 \begin_layout Subsection
3274 \begin_layout Standard
3275 When you are working on a large file with many sections, it is often convenient
3276 to break up the document into several files, or perhaps you have something
3277 where a table may change from time to time, but the preceding text does
3279 In these cases, you should seriously consider using multipart documents.
3280 For example, scientific papers often have five major sections: the introduction
3281 , observations, results, discussion, and conclusion.
3282 Each of these could be its own separate \SpecialChar LyX
3284 \begin_inset Quotes eld
3288 \begin_inset Quotes erd
3291 file which contains the title, authors, abstract, references, etc., plus
3292 the five included files.
3293 It is important to note that each of these files is a full \SpecialChar LyX
3295 can be formatted and printed on its own, as well as included in a master
3297 Each of these files must have the same document class, however—don't attempt
3298 to mix book classes with article classes.
3299 You may also include \SpecialChar LaTeX
3300 files; however, these files must not have their own
3302 \begin_inset space \thinspace{}
3306 \begin_inset space \space{}
3309 everything up to and including the
3310 \begin_inset Flex Code
3313 \begin_layout Plain Layout
3322 \begin_inset Flex Code
3325 \begin_layout Plain Layout
3333 line must be deleted) or else errors will be generated when you try to
3337 \begin_layout Standard
3339 allows you to include files quite easily with
3340 \begin_inset Flex Noun
3343 \begin_layout Plain Layout
3344 Insert\SpecialChar menuseparator
3346 \begin_inset space ~
3355 When you click on this selection a small box is inserted into the file
3356 at the current cursor location.
3357 Clicking on the box raises a dialog which allows you to select the file
3358 to be included, and the method of its inclusion.
3362 \begin_layout Standard
3363 The file selection box should by now be obvious.
3364 The three inclusion methods are
3365 \begin_inset Quotes eld
3369 \begin_inset Quotes erd
3373 \begin_inset Quotes eld
3377 \begin_inset Quotes erd
3381 \begin_inset Quotes eld
3385 \begin_inset Quotes erd
3389 The difference between
3390 \begin_inset Quotes eld
3394 \begin_inset Quotes erd
3398 \begin_inset Quotes eld
3402 \begin_inset Quotes erd
3405 is really only meaningful to \SpecialChar LaTeX
3406 perts, but the practical difference is that
3408 \begin_inset Quotes eld
3412 \begin_inset Quotes erd
3415 are typeset beginning on a new page, while files that are
3416 \begin_inset Quotes eld
3420 \begin_inset Quotes erd
3423 are typeset starting on the current page.
3426 \begin_layout Standard
3427 Generally, the master file is converted into a full \SpecialChar LaTeX
3428 file before typesetting,
3429 while the included files are converted to \SpecialChar LaTeX
3430 files that do not have all the
3431 preamble information.
3434 \begin_layout Standard
3436 \begin_inset Quotes eld
3440 \begin_inset Quotes erd
3443 included file allows you to include a file typeset exactly as it appears
3445 \begin_inset space \thinspace{}
3449 \begin_inset space \space{}
3453 \begin_inset Flex Code
3456 \begin_layout Plain Layout
3462 mode, with the characters set in a fixed-width typewriter font.
3463 Normally, spaces in this file are invisible, though two consecutive spaces
3464 are conserved, unlike \SpecialChar LyX
3465 's normal treatment of spaces.
3466 However, setting the
3467 \begin_inset Flex Noun
3470 \begin_layout Plain Layout
3472 \begin_inset space ~
3476 \begin_inset space ~
3480 \begin_inset space ~
3488 checkbox typesets a mark to unambiguously define the presence of a space.
3492 \begin_layout Subsection
3493 Cross-References Between Files
3496 \begin_layout Standard
3497 \begin_inset Box Shadowbox
3507 height_special "totalheight"
3512 backgroundcolor "none"
3515 \begin_layout Plain Layout
3516 This section is somewhat out of date.
3517 Need to describe default master documents and how children are opened when
3527 \begin_layout Standard
3528 It is possible to set up cross-references between the different files.
3529 First, open all the files in question: let's call them A and B in a two
3530 file example, where B is included in A.
3531 Let's say you insert a label in A, then want to reference it in B.
3532 Open the cross-reference dialog whilst in document B, and you can select
3534 \begin_inset Quotes eld
3538 \begin_inset Quotes erd
3544 \begin_layout Subsection
3545 Bibliography Lists in all Subdocuments
3548 \begin_layout Standard
3549 \begin_inset Box Frameless
3559 height_special "totalheight"
3564 backgroundcolor "none"
3567 \begin_layout Plain Layout
3568 This section also needs updating.
3569 There is now material about this on the wiki, and it could be copied here.
3577 \begin_layout Standard
3578 Copy the bibliography list with all entries to all subdocuments and transform
3580 This way \SpecialChar LyX
3582 \begin_inset Flex Code
3585 \begin_layout Plain Layout
3591 -files and you can easily insert references without making the bibliography
3595 \begin_layout Standard
3596 As the bibliography list is in a comment, \SpecialChar LaTeX
3597 won't use it and the references
3598 will look like this: [?], instead of like this: [1].
3599 One solution is to use the \SpecialChar LaTeX
3601 \begin_inset Flex Code
3604 \begin_layout Plain Layout
3610 that will only include comments by processing the files separately.
3611 To do this, add in the \SpecialChar LaTeX
3612 preamble of every subdocument the following:
3615 \begin_layout LyX-Code
3621 \begin_layout LyX-Code
3624 includecomment{comment}
3627 \begin_layout Standard
3629 \begin_inset Flex URL
3632 \begin_layout Plain Layout
3634 http://wiki.lyx.org/FAQ/Unsorted#toc31
3642 \begin_layout Section
3647 \begin_layout Standard
3648 Users sometimes need to be able to
3649 \begin_inset Quotes eld
3653 \begin_inset Quotes erd
3657 file together with all the images (and other files) on which it depends,
3658 either for sending to a publisher or for sharing with a co-author.
3660 2.0 includes a Python script (
3661 \begin_inset Flex Code
3664 \begin_layout Plain Layout
3670 ) that automates this process.
3671 To use it, you must have either the
3672 \begin_inset Flex Code
3675 \begin_layout Plain Layout
3682 \begin_inset Flex Code
3685 \begin_layout Plain Layout
3691 python modules installed on your system.
3692 By default, the script prefers the
3693 \begin_inset Flex Code
3696 \begin_layout Plain Layout
3703 \begin_inset Flex Code
3706 \begin_layout Plain Layout
3712 format on Unix-like systems and the
3713 \begin_inset Flex Code
3716 \begin_layout Plain Layout
3725 \begin_layout Standard
3727 's configuration process will set the script up to export a `\SpecialChar LyX
3729 and this format will then be available under
3730 \begin_inset Flex Code
3733 \begin_layout Plain Layout
3734 File\SpecialChar menuseparator
3743 \begin_layout Standard
3744 Independently of the platform, the generation of a particular archive format
3745 can be forced by adding either the
3746 \begin_inset Flex Code
3749 \begin_layout Plain Layout
3756 \begin_inset Flex Code
3759 \begin_layout Plain Layout
3766 \begin_inset Flex Code
3769 \begin_layout Plain Layout
3776 \begin_inset Flex Code
3779 \begin_layout Plain Layout
3785 format) switch to the
3786 \begin_inset Flex Code
3789 \begin_layout Plain Layout
3791 \SpecialChar menuseparator
3799 \begin_inset Flex Code
3802 \begin_layout Plain Layout
3803 Tools\SpecialChar menuseparator
3804 Preferences\SpecialChar menuseparator
3805 File Handling\SpecialChar menuseparator
3812 (Make sure you add the switch after the script name, not before it.)
3815 \begin_layout Section
3816 Fancy Headers and Footers
3819 \begin_layout Standard
3820 The default page layout is rather plain; for an
3821 \begin_inset Flex Code
3824 \begin_layout Plain Layout
3830 document class, all you get is a centered page number at the bottom of
3832 This document uses KOMA-script's book class, so it appears to be a bit
3834 But to really put on a show, you need to set the document page style to
3836 \begin_inset Quotes eld
3840 \begin_inset Quotes erd
3843 , as mentioned in the
3848 This section describes the \SpecialChar LaTeX
3849 code you need to insert in your \SpecialChar LaTeX
3851 order to get the desired effects.
3854 \begin_layout Standard
3855 For more information on fancy headers, see the
3856 \begin_inset Flex Code
3859 \begin_layout Plain Layout
3865 package documentation.
3867 \begin_inset Flex URL
3870 \begin_layout Plain Layout
3872 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3880 \begin_layout Standard
3881 The page header is divided into three fields, not surprisingly labeled
3882 \begin_inset Quotes eld
3886 \begin_inset Quotes erd
3890 \begin_inset Quotes eld
3894 \begin_inset Quotes erd
3898 \begin_inset Quotes eld
3902 \begin_inset Quotes erd
3906 The footer is also divided into these three fields.
3907 The \SpecialChar LaTeX
3908 commands to set these fields in the simplest manner are
3909 \begin_inset Flex Code
3912 \begin_layout Plain Layout
3921 \begin_inset Flex Code
3924 \begin_layout Plain Layout
3933 \begin_inset Flex Code
3936 \begin_layout Plain Layout
3945 \begin_inset Flex Code
3948 \begin_layout Plain Layout
3957 Suppose you wish to put your name in the upper left hand corner of each
3959 Simply insert the following command in the preamble:
3962 \begin_layout Standard
3971 \begin_layout Standard
3972 You will now see your name in the upper left.
3973 If a field has a default entry that you would like to get rid of (often
3974 the page number appears in the central footer) simply include a command
3975 with a blank argument, e.
3976 \begin_inset space \thinspace{}
3982 \begin_layout Standard
3990 \begin_layout Standard
3991 Let's get really fancy: lets put the section number with the word
3992 \begin_inset Quotes eld
3996 \begin_inset Quotes erd
4000 \begin_inset space \thinspace{}
4004 \begin_inset space \space{}
4007 Section 3) in the upper left, the page number (e.
4008 \begin_inset space \thinspace{}
4012 \begin_inset space \space{}
4015 Page 4) in the upper right, your name in the lower left, and the date in
4017 The following commands should now appear in the preamble:
4020 \begin_layout Standard
4030 \begin_layout Standard
4038 \begin_layout Standard
4048 \begin_layout Standard
4057 \begin_layout Standard
4065 \begin_layout Standard
4075 \begin_layout Standard
4077 \begin_inset Flex Code
4080 \begin_layout Plain Layout
4089 \begin_inset Flex Code
4092 \begin_layout Plain Layout
4100 access \SpecialChar LaTeX
4101 's section and page counters, and so print out the current section
4104 \begin_inset Flex Code
4107 \begin_layout Plain Layout
4115 simply prints out today's date.
4118 \begin_layout Standard
4119 The thicknesses of the horizontal rules drawn beneath the header and above
4120 the footer can also be modified.
4121 If you don't want one of the rules, set its thickness to 0.
4122 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4128 \begin_inset Flex Code
4131 \begin_layout Plain Layout
4136 headrulewidth}{0.4pt}
4142 \begin_inset Flex Code
4145 \begin_layout Plain Layout
4150 footrulewidth}{0.4pt}
4155 to set the thicknesses.
4158 \begin_layout Standard
4159 You can switch the header/footer settings on and off for individual pages
4161 \begin_inset Flex Code
4164 \begin_layout Plain Layout
4167 thispagestyle{empty}
4173 \begin_inset Flex Code
4176 \begin_layout Plain Layout
4179 thispagestyle{plain}
4185 \begin_inset Flex Code
4188 \begin_layout Plain Layout
4191 thispagestyle{fancy}
4197 Simply insert them in the text on the page you want changed and mark them
4200 In fact, title pages are marked as plain by default, while following pages
4201 are marked fancy when using the global fancy setting.
4204 \begin_layout Standard
4205 As a final example, it is possible to include an image in the header or
4207 Suppose you want to put a company logo in the upper lefthand corner.
4208 You might try something like
4211 \begin_layout Standard
4220 includegraphics{logo.eps}}}
4223 \begin_layout Standard
4225 (you may need to preface this with
4226 \begin_inset Flex Code
4229 \begin_layout Plain Layout
4233 usepackage{graphics}
4238 if you don't include graphics elsewhere in your document).
4241 \begin_layout Section
4242 Itemize Bullet Selection
4243 \begin_inset CommandInset label
4252 \begin_layout Standard
4258 \begin_layout Subsection
4262 \begin_layout Standard
4264 provides 216 bullet shapes that can be accessed from a simple dialog.
4265 Using this dialog you can easily specify what bullet shape to use at each
4266 level of an itemized list.
4267 These settings are document-wide so you won't be able to specify different
4268 sets of bullets for different paragraphs.
4272 \begin_layout Plain Layout
4273 Well, actually you can but you'll have to do it by hand.
4281 \begin_layout Subsection
4285 \begin_layout Standard
4286 Open the dialog by selecting the
4287 \begin_inset Flex Noun
4290 \begin_layout Plain Layout
4291 Document\SpecialChar menuseparator
4297 menu item and then select the
4298 \begin_inset Flex Noun
4301 \begin_layout Plain Layout
4310 \begin_layout Standard
4311 The dialog provides you with a table of bullet shapes.
4312 A column of buttons on the left of the table provides access to the six
4313 different panels of bullet shapes.
4314 The row of buttons across the top is used to select which bullet depth
4316 A text entry under the table shows the currently selected bullet shape's
4318 equivalent and this can be edited if desired.
4319 If you do modify the text you will also need to specify any needed packages
4320 in the \SpecialChar LaTeX
4324 \begin_layout Standard
4325 The six panels are divided up by the packages they require.
4326 The following table shows the mappings from button name to \SpecialChar LaTeX
4330 \begin_layout Standard
4332 \begin_inset Tabular
4333 <lyxtabular version="3" rows="7" columns="2">
4334 <features tabularvalignment="middle">
4335 <column alignment="center" valignment="top" width="0pt">
4336 <column alignment="center" valignment="top" width="0pt">
4338 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4341 \begin_layout Plain Layout
4356 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4359 \begin_layout Plain Layout
4376 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4379 \begin_layout Plain Layout
4394 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4397 \begin_layout Plain Layout
4406 base \SpecialChar LaTeX
4414 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4417 \begin_layout Plain Layout
4432 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4435 \begin_layout Plain Layout
4452 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4455 \begin_layout Plain Layout
4470 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4473 \begin_layout Plain Layout
4490 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4493 \begin_layout Plain Layout
4508 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4511 \begin_layout Plain Layout
4528 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4531 \begin_layout Plain Layout
4546 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4549 \begin_layout Plain Layout
4566 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4569 \begin_layout Plain Layout
4584 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4587 \begin_layout Plain Layout
4610 \begin_layout Standard
4612 doesn't stop you using bullets from packages you don't have.
4613 If you get errors from \SpecialChar LaTeX
4614 when you try to view or print the file, then it
4615 is likely you are missing a package.
4619 \begin_layout Plain Layout
4621 doesn't restrict your use since you may be editing locally and exporting
4630 \begin_layout Subsection
4634 \begin_layout Standard
4635 Select which bullet depth you want to change then select the bullet shape
4637 Any changes will not be visible in \SpecialChar LyX
4638 , but are visible when viewing the document.
4641 \begin_layout Standard
4642 You can reset a bullet shape to the default simply by clicking your right
4643 mouse button on the appropriate bullet depth button.
4647 \begin_layout Plain Layout
4652 want to have multiple sets of paragraphs with different sets of bullets
4653 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4655 The bullet selection dialog can help though because it provides you with
4656 the \SpecialChar LaTeX
4657 code for a wide range of bullet shapes.
4658 To make your own custom paragraphs you have the following options:
4661 \begin_layout Plain Layout
4665 \begin_layout Plain Layout
4681 \begin_layout Plain Layout
4685 \begin_layout Plain Layout
4707 \begin_layout Itemize
4708 Use the \SpecialChar LaTeX
4710 \begin_inset Flex Code
4713 \begin_layout Plain Layout
4721 to specify a new bullet shape for a given depth.
4722 You'll also need to save the current bullet shape so you can restore it
4724 In this itemized list the following \SpecialChar LaTeX
4725 code was used to change the bullet
4726 used for the first depth.
4730 \begin_layout LyX-Code
4740 \begin_layout LyX-Code
4757 \begin_layout Itemize
4758 Note that the itemize depth is specified in Roman numerals as part of the
4768 \begin_layout Itemize
4772 \begin_layout Plain Layout
4785 Specify each individual entry by starting each item with the bullet shape
4786 enclosed in square brackets and set as
4787 \begin_inset Flex Noun
4790 \begin_layout Plain Layout
4798 For example, this item was started with
4799 \begin_inset Flex Code
4802 \begin_layout Plain Layout
4817 \begin_layout Plain Layout
4821 \begin_layout Plain Layout
4837 \begin_layout Plain Layout
4838 You'll also need to revert the labelitem back to its previous setting for
4839 the global bullet shape settings to remain in effect.
4840 The way used here was:
4843 \begin_layout LyX-Code
4858 \begin_layout Chapter
4860 and the World Wide Web
4863 \begin_layout Standard
4865 has long supported the export of documents to various web-friendly formats,
4867 Before verson 2.0, however, HTML export was always accomplished by the use
4868 of external converters.
4872 \begin_layout Plain Layout
4873 For details on the use of external converters with \SpecialChar LyX
4878 section of the Customization manual.
4883 These fall into two large groups: there are converters that use \SpecialChar LaTeX
4885 intermediate format, such as
4886 \begin_inset Flex Code
4889 \begin_layout Plain Layout
4896 \begin_inset Flex Code
4899 \begin_layout Plain Layout
4906 \begin_inset Flex Code
4909 \begin_layout Plain Layout
4915 , relying upon \SpecialChar LyX
4916 to produce the \SpecialChar LaTeX
4917 ; and there is a converter that works directly
4920 \begin_inset Flex Code
4923 \begin_layout Plain Layout
4931 All of these have different advantages and disadvantages.
4935 \begin_layout Standard
4936 The \SpecialChar LaTeX
4937 -based converters have the advantage that, in principle, they know everythin
4938 g about the exported document that \SpecialChar LaTeX
4940 Such converters do not care, for example, if a certain block of code was
4941 produced by \SpecialChar LyX
4942 or was Evil Red Text.
4943 These converters know about
4944 \begin_inset Flex Code
4947 \begin_layout Plain Layout
4953 files, counters, and references, and can often make use of the
4954 \begin_inset Flex Code
4957 \begin_layout Plain Layout
4963 files generated by Bib\SpecialChar TeX
4965 On the other hand, \SpecialChar LaTeX
4966 is a very hard language to parse—it is sometimes said
4967 that only \SpecialChar TeX
4968 itself understands \SpecialChar TeX
4969 —and \SpecialChar LaTeX
4970 -based converters will often choke on
4971 what seem to be quite simple constructs; complex ones can throw them completely
4972 , and as of this writing, for example, the
4976 manual will not export with
4977 \begin_inset Flex Code
4980 \begin_layout Plain Layout
4986 , though the others will.
4987 The other issue concerns how math is handled.
4988 These converters typically convert the formulae into little pictures that
4989 are then linked from the HTML document.
4990 Since these are actually generated by \SpecialChar LaTeX
4991 , they are accurate.
4992 But they do not scale well, and just getting them to look as if they are
4993 actually meant to be in your document—so that the font sizes seem to be
4994 roughly the same—can be a challenge.
4997 \begin_layout Standard
4999 \begin_inset Flex Code
5002 \begin_layout Plain Layout
5010 \begin_inset CommandInset href
5012 name "http://elyxer.nongnu.org/"
5013 target "http://elyxer.nongnu.org/"
5018 ) solves some of these problems.
5019 In particular, the formulae it produces scale perfectly, since it renders
5020 math using a combination of HTML and CSS rather than converting the formulae
5022 But even moderately complex formula are rendered less well than with
5023 \begin_inset Flex Code
5026 \begin_layout Plain Layout
5032 ; this reflects the limitations of HTML.
5036 \begin_layout Plain Layout
5038 \begin_inset Flex Code
5041 \begin_layout Plain Layout
5048 can also use jsMath and MathJax for equations, but this setting is only
5049 available globally and requires one to have access to a server that runs
5055 More importantly (as of version 1.1.1, at least),
5056 \begin_inset Flex Code
5059 \begin_layout Plain Layout
5066 has limited support for math macros and no support for user-defined paragraph
5067 or character styles.
5068 These limitations make
5069 \begin_inset Flex Code
5072 \begin_layout Plain Layout
5079 unsuitable for many of the documents \SpecialChar LyX
5081 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5083 have decided to follow a different path and have made \SpecialChar LyX
5085 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5086 , DocBook, and plaintext.
5089 \begin_layout Standard
5090 As of this writing, XHTML output remains under development and should probably
5092 \begin_inset Quotes eld
5096 \begin_inset Quotes erd
5103 \begin_layout Plain Layout
5105 \begin_inset Flex Code
5108 \begin_layout Plain Layout
5109 development/HTML.notes
5114 , which can be found in the \SpecialChar LyX
5116 \begin_inset CommandInset href
5118 name "accessed online"
5119 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5124 , usually contains up-to-date information about the state of XHTML output.
5125 See also the list of XHTML bugs on
5126 \begin_inset CommandInset href
5128 name "the bug tracker"
5129 target "http://www.lyx.org/trac/query?status=reopened&status=assigned&status=new&max=0&component=xhtml+export&order=id&col=id&col=summary&col=reporter&col=keywords&keywords=%21%7Efixedintrunk&desc=1"
5139 Still, the developers have chosen this approach because it has several
5140 potential advantages over the other two.
5143 \begin_layout Standard
5144 These advantages are primarily due to the fact that the XHTML output routines,
5145 since they are part of \SpecialChar LyX
5146 , know everything \SpecialChar LyX
5147 knows about the document being
5152 \begin_layout Plain Layout
5153 Another advantage is that, since these routines are internal to \SpecialChar LyX
5155 immune to changes in \SpecialChar LyX
5156 's file format, or to changes in the semantics of
5162 So they know about the table of contents (as displayed in the outline),
5163 about the counters associated with different paragraph styles, and about
5164 user-defined styles.
5165 The XHTML output routines know what \SpecialChar LyX
5166 knows about internationalization,
5167 too, so they will output
5168 \begin_inset Quotes eld
5172 \begin_inset Quotes erd
5176 \begin_inset Quotes eld
5184 \begin_inset Quotes erd
5187 , depending upon the language in effect at the time.
5191 \begin_layout Standard
5192 Quite generally, the output routines know what \SpecialChar LyX
5193 knows about document layout,
5194 that is, about how the document is to be rendered on screen.
5195 We use this information when we output the document as XHTML.
5196 In particular, \SpecialChar LyX
5201 generates CSS style information corresponding to the layout information
5202 it uses to render the document on screen: if section headings are supposed
5203 to be sans-serif and bold as seen in \SpecialChar LyX
5204 , then (by default) they will be sans-seri
5205 f and bold when viewed in a web browser, too.
5206 And this is true not just for pre-defined styles, like Section, but for
5207 any style, including user-defined styles.
5208 Indeed, the XHTML output routines make no distinction between user-defined
5209 paragraph and character styles and \SpecialChar LyX
5210 's own pre-defined styles: in each case,
5211 everything \SpecialChar LyX
5212 knows about the styles is contained in the layout files.
5213 And much the same is true as regards pre-defined textual insets, such as
5214 footnotes, and various custom insets.
5218 \begin_layout Standard
5219 The result is that XHTML output can be customized and extended in exactly
5220 the same way \SpecialChar LaTeX
5221 output can be customized and extended: through layout files
5223 See chapter five of the
5227 manual for the details.
5230 \begin_layout Standard
5231 The remainder of this chapter contains more detailed information on XHTML
5232 output, its limitations, and ways to work around those limitations.
5235 \begin_layout Section
5236 Math Output in XHTML
5239 \begin_layout Standard
5241 offers four choices for how math is rendered.
5242 These have various advantages and disadvantages:
5245 \begin_layout Itemize
5247 \begin_inset Newline newline
5250 MathML is a dialect of XML designed specifically for mathematics on the
5251 web, and it typically renders very well in browsers that support it.
5252 The disadvantage is that not all browsers support MathML, and support is
5253 not complete even in the Gecko-based browsers, such as Firefox.
5254 \begin_inset Newline newline
5258 is unable to render a formula as MathML—for example, if the formula
5260 \begin_inset Flex Code
5263 \begin_layout Plain Layout
5269 package or ERT—then it will instead output the formula as an image.
5273 \begin_layout Itemize
5275 \begin_inset Newline newline
5279 \begin_inset Flex Code
5282 \begin_layout Plain Layout
5288 outputs math as HTML, styled by CSS.
5292 \begin_layout Plain Layout
5294 has borrowed some of the CSS for its HTML output from
5295 \begin_inset Flex Code
5298 \begin_layout Plain Layout
5309 For simple formulae, this can work quite well, though with more complicated
5310 formulae it tends to break down.
5311 Still, this method has the advantage that it is very widely supported and
5312 so it may be appropriate for documents that contain only a little, fairly
5314 \begin_inset Newline newline
5317 If Lyx is unable to render a formula as HTML—for example, if the formula
5319 \begin_inset Flex Code
5322 \begin_layout Plain Layout
5328 package or ERT—then it will instead output the formula as an image.
5332 \begin_layout Itemize
5334 \begin_inset Newline newline
5338 \begin_inset Flex Code
5341 \begin_layout Plain Layout
5348 will output formulae as images, the very same images, in fact, that are
5349 used for instant preview.
5353 \begin_layout Plain Layout
5354 Instant preview does
5358 have to be on for images to be output, however.
5363 The advantage to this method is that the images are simply generated by
5365 , so they are very accurate.
5366 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5367 so they do not scale terribly well, and one cannot copy them, etc.
5368 (As of this writing, there are also problems about equation numbering.
5370 \begin_inset CommandInset href
5373 target "http://www.lyx.org/trac/ticket/6894"
5379 \begin_inset Newline newline
5382 The size of the images can be controlled by setting the
5383 \begin_inset Quotes eld
5387 \begin_inset Quotes erd
5391 \begin_inset Flex Noun
5394 \begin_layout Plain Layout
5395 Document\SpecialChar menuseparator
5396 Settings\SpecialChar menuseparator
5406 \begin_layout Plain Layout
5407 For those who want to know, this controls the resolution of the image in
5408 dots per inch and is based upon a default of 75 dpi.
5414 \begin_inset Newline newline
5418 for some reason fails to create an image for a formula (e.g., if a required
5420 package is not installed), then it will fall back to outputing the raw
5425 \begin_layout Itemize
5428 \begin_inset Newline newline
5431 Finally, \SpecialChar LyX
5432 will happily output math as \SpecialChar LaTeX
5434 As well as being the output of last resort, this method can be used with
5436 \begin_inset CommandInset href
5439 target "http://www.math.union.edu/~dpvc/jsMath/"
5444 , which uses JavaScript to render \SpecialChar LaTeX
5445 embedded in HTML documents.
5447 wraps the \SpecialChar LaTeX
5449 \begin_inset Flex Code
5452 \begin_layout Plain Layout
5458 (for inline formulas) or
5459 \begin_inset Flex Code
5462 \begin_layout Plain Layout
5468 (for displayed formulas) with
5469 \begin_inset Flex Code
5472 \begin_layout Plain Layout
5478 , as is required for jsMath.
5481 \begin_layout Standard
5482 One of these output methods must be selected under
5483 \begin_inset Flex Noun
5486 \begin_layout Plain Layout
5487 Document\SpecialChar menuseparator
5488 Settings\SpecialChar menuseparator
5495 By default, \SpecialChar LyX
5497 This is a document-wide setting, therefore.
5500 \begin_layout Standard
5501 Eventually, \SpecialChar LyX
5502 will offer the user the option to select an alternate output
5503 method for a particular inset, say, one that isn't being rendered very
5508 \begin_layout Plain Layout
5509 That said, since \SpecialChar LyX
5510 falls back to images if the inset contains ERT, then one
5511 can force output as an image by putting some harmless ERT into the math,
5513 \begin_inset Formula $a=b\relax$
5524 \begin_layout Section
5525 Bibliography and Citations
5528 \begin_layout Standard
5529 XHTML output fully supports bibliographies and citations.
5533 \begin_layout Standard
5534 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5536 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5539 If you are using numerical citations, then \SpecialChar LyX
5540 will output numerical labels,
5541 such as [1] or [17], rather than simply showing the citation key in square
5542 brackets, as it does on-screen.
5543 If you are using author-year citations, then \SpecialChar LyX
5544 will add lowercase letters
5545 to the years, just as Bib\SpecialChar TeX
5546 does, if it finds more than one citation for
5547 a given author-year combination.
5548 The labels will be printed with the bibliography entries.
5549 Note that there is, at present, no way to customize the appearance of the
5550 labels, for example, to choose between square brackets and parentheses.
5553 \begin_layout Standard
5554 Bibliography output is handled by the same machinery that handles the presentati
5555 on of reference information in the citation dialog, so you will see in the
5556 XHTML output pretty much what you would see if you were to look at a given
5557 entry in the citation dialog.
5558 The formatting can be customized in your layout file or, preferably, in
5564 manual for the details.
5567 \begin_layout Standard
5568 The main defect at present is that cross-referenced information is printed
5569 with every entry with which it is associated.
5570 So you can see things like this:
5575 \begin_inset Quotes eld
5578 Context and Logical Form
5579 \begin_inset Quotes erd
5584 Language in Context: Selected Essays
5586 (Oxford: Oxford University Press, 2007), pp.
5592 \begin_inset Quotes eld
5595 Semantics in Context
5596 \begin_inset Quotes erd
5601 Language in Context: Selected Essays
5603 (Oxford: Oxford University Press, 2007), pp.
5607 \begin_layout Standard
5608 This should be fixed before long.
5611 \begin_layout Standard
5612 There is no support at present for sectioned bibliographies.
5613 If you have multiple bibliographies, then \SpecialChar LyX
5614 will print the same bibliography
5618 \begin_layout Section
5622 \begin_layout Standard
5624 will happily export indexes as XHTML, but with certain limitations at the
5628 \begin_layout Standard
5629 Index export will be most reliable when you do not attempt to use the fancy
5630 constructs that are described in the section on indexes in the
5638 \begin_layout Plain Layout
5639 The main issue here is that \SpecialChar LyX
5640 itself does not really handle these.
5641 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5647 We'll describe how they are handled using the subsection headings from
5651 \begin_layout Itemize
5652 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5653 makes an effort to support these,
5654 but the entries must be separated by
5655 \begin_inset Quotes eld
5659 \begin_inset Quotes erd
5662 , that is, there must be spaces around the exclamation point.
5663 This is because it is otherwise too difficult to check for escaped exclamation
5664 points, ones in math, and so forth.
5667 \begin_layout Itemize
5668 Page Ranges: There is no support at all for page ranges, since these make
5669 no sense with XHMTL.
5670 Instead, you will just get two index entries, one at either end.
5673 \begin_layout Itemize
5674 Cross-referencing: There is no support for cross-referencing.
5676 finds an entry containing the
5677 \begin_inset Quotes eld
5680 |see\SpecialChar ldots
5682 \begin_inset Quotes erd
5685 construct, it is just dropped, and the rest is treated as an ordinary index
5689 \begin_layout Itemize
5690 Index Entry Order: \SpecialChar LyX
5691 does support attempts to fix the sorting order.
5692 It will take what is before the first `@' it finds and use that for sorting,
5693 taking what follows the first `@' to be the actual entry.
5694 At present, \SpecialChar LyX
5695 does not check for escaped `@', so do not try to index email
5699 \begin_layout Itemize
5700 Index Entry Layout: You can format entries by using the text style dialog,
5701 or by using any other method available within \SpecialChar LyX
5703 There is no support for constructs like:
5704 \begin_inset Quotes eld
5708 \begin_inset Quotes erd
5712 Indeed, if \SpecialChar LyX
5713 finds a pipe symbol, `|', in an entry, it will delete it and
5714 everything that follows it.
5717 \begin_layout Itemize
5718 Multiple Indexes: There is no support for multiple indexes.
5719 Rather, all index entries will be printed as one large index.
5720 To avoid our printing several versions of the index, we print only the
5721 main index, so make sure you have one.
5724 \begin_layout Section
5725 Nomenclature and Glossary
5728 \begin_layout Standard
5729 There is at present no support for glossaries.
5730 Adding it would be fairly trivial, and welcome.
5733 \begin_layout Chapter
5734 The \SpecialChar LyX
5738 \begin_layout Section
5742 \begin_layout Standard
5743 The `\SpecialChar LyX
5744 server' allows other programs to talk to \SpecialChar LyX
5745 , invoke \SpecialChar LyX
5746 commands, and retrieve
5747 information about the \SpecialChar LyX
5749 This is only intended for advanced users, but they should find it useful.
5750 It is by writing to the \SpecialChar LyX
5751 server, for example, that bibliography managers,
5752 such as JabRef, are able to
5753 \begin_inset Quotes eld
5757 \begin_inset Quotes erd
5760 citations to \SpecialChar LyX
5764 \begin_layout Section
5765 Starting the \SpecialChar LyX
5769 \begin_layout Standard
5770 The \SpecialChar LyX
5771 server works through the use of a pair of named pipes.
5772 These are usually located in
5773 \begin_inset Flex Code
5776 \begin_layout Plain Layout
5782 , (except on Windows, where
5786 named pipes are special objects located in
5787 \begin_inset Flex Code
5790 \begin_layout Plain Layout
5802 ) and have the names
5803 \begin_inset Quotes eld
5807 \begin_inset Flex Code
5810 \begin_layout Plain Layout
5817 \begin_inset Quotes erd
5821 \begin_inset Quotes eld
5825 \begin_inset Flex Code
5828 \begin_layout Plain Layout
5835 \begin_inset Quotes erd
5839 External programs write into
5840 \begin_inset Flex Code
5843 \begin_layout Plain Layout
5849 and read back data from
5850 \begin_inset Flex Code
5853 \begin_layout Plain Layout
5860 The stem of the pipe names can be defined in the
5861 \begin_inset Flex Noun
5864 \begin_layout Plain Layout
5865 Tools\SpecialChar menuseparator
5872 \begin_inset Flex Code
5875 \begin_layout Plain Layout
5876 "/home/myhome/lyxpipe"
5882 \begin_inset Flex Code
5885 \begin_layout Plain Layout
5899 on Windows (where any working path instead of lyxpipe can be used, for
5901 \begin_inset Flex Code
5904 \begin_layout Plain Layout
5927 configure this manually in order for the server to start.
5930 \begin_layout Standard
5933 \begin_inset Flex Code
5936 \begin_layout Plain Layout
5943 \begin_inset Flex Code
5946 \begin_layout Plain Layout
5952 ' to create the pipes.
5953 If one of the pipes already exists, \SpecialChar LyX
5954 will assume that another \SpecialChar LyX
5956 is already running and will not start the server.
5957 On POSIX (Unix like) systems, if for some other reason, an unused
5958 \begin_inset Quotes eld
5962 \begin_inset Quotes erd
5965 pipe is left in existence when \SpecialChar LyX
5966 closes, then \SpecialChar LyX
5967 will try to delete it.
5968 If this fails for some reason, you will need to delete the pipes manually
5969 and then restart \SpecialChar LyX
5971 On Windows, pipes are deleted by the OS on program termination or crash,
5973 \begin_inset Quotes eld
5977 \begin_inset Quotes erd
5980 pipes should not be possible.
5983 \begin_layout Standard
5984 To have several \SpecialChar LyX
5985 processes with servers at the same time, you have to use
5986 different configurations, perhaps by using separate user directories, each
5988 \begin_inset Flex Code
5991 \begin_layout Plain Layout
5997 file, for each process.
6000 \begin_layout Standard
6001 If you are developing a client program, you might find it useful to enable
6002 debugging information from the \SpecialChar LyX
6004 Do this by starting \SpecialChar LyX
6006 \begin_inset Flex Code
6009 \begin_layout Plain Layout
6018 \begin_layout Standard
6019 You can find a complete example client written in C++ in the source distribution
6021 \begin_inset Flex Code
6024 \begin_layout Plain Layout
6025 development/lyxserver/server_monitor.cpp
6033 \begin_layout Standard
6034 Another useful tool is the command-line based client found in
6035 \begin_inset Flex Code
6038 \begin_layout Plain Layout
6039 src/client/lyxclient
6047 \begin_layout Section
6048 Normal communication
6051 \begin_layout Standard
6052 To issue a \SpecialChar LyX
6053 call, the client writes a line of ASCII text into the input
6055 This line has the following format:
6072 \begin_layout Description
6073 clientname is a name that the client can choose arbitrarily.
6074 Its only use is that \SpecialChar LyX
6075 will echo it if it sends an answer—so a client can
6076 dispatch results from different requesters.
6079 \begin_layout Description
6080 function is the function you want \SpecialChar LyX
6082 It is the same as the commands you'd use in the minibuffer.
6085 \begin_layout Description
6086 argument is an optional argument which is meaningful only to some functions
6088 \begin_inset Quotes eld
6092 \begin_inset Quotes erd
6095 LFUN will insert the argument as text at the cursor position).
6098 \begin_layout Standard
6099 The answer from \SpecialChar LyX
6100 will arrive in the output pipe and be of the form
6117 \begin_layout Standard
6126 are just echoed from the command request, while
6130 is more or less useful information filled according to how the command
6131 execution worked out.
6132 Some commands, such as
6133 \begin_inset Quotes eld
6137 \begin_inset Quotes erd
6140 , will return information about the internal state of \SpecialChar LyX
6142 return an empty data-response.
6143 This means that the command execution went fine.
6146 \begin_layout Standard
6147 In case of errors, the response from \SpecialChar LyX
6165 \begin_layout Standard
6170 should contain an explanation of why the command failed.
6173 \begin_layout Standard
6177 \begin_layout LyX-Code
6178 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6179 \begin_inset Newline newline
6182 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6183 \begin_inset Newline newline
6186 read a <~/.lyxpipe.out
6187 \begin_inset Newline newline
6193 \begin_layout Subsection
6194 AppleScript (Mac OS X)
6197 \begin_layout Standard
6198 Since \SpecialChar LyX
6199 2.1, \SpecialChar LyX
6200 supports basic interactions with AppleScript for normal communicatio
6201 n through the command run.
6202 This command takes a direct argument (the
6206 to perform) and an optional argument.
6207 It either returns the output of the function or triggers an error with
6208 the error message and code.
6211 \begin_layout Standard
6215 \begin_layout LyX-Code
6216 tell application "\SpecialChar LyX
6220 \begin_layout LyX-Code
6224 \begin_layout LyX-Code
6225 -- Stores the current file name into f
6228 \begin_layout LyX-Code
6229 set f to (run "server-get-filename" with argument "")
6232 \begin_layout LyX-Code
6233 on error the error_message number the error_number
6236 \begin_layout LyX-Code
6237 display dialog "Error: " & the error_number & ".
6241 \begin_layout LyX-Code
6242 & the error_message buttons {"OK"} default button 1
6245 \begin_layout LyX-Code
6249 \begin_layout LyX-Code
6253 \begin_layout Section
6257 \begin_layout Standard
6259 can notify clients of events going on asynchronously.
6260 Currently it will only do this if the user binds a key sequence with the
6262 \begin_inset Quotes eld
6266 \begin_inset Quotes erd
6270 The format of the string \SpecialChar LyX
6271 sends is as follows:
6275 \begin_inset Flex Code
6278 \begin_layout Plain Layout
6289 \begin_layout Standard
6294 is the printed representation of the key sequence that was actually typed
6298 \begin_layout Standard
6299 This mechanism can be used to extend \SpecialChar LyX
6300 's command set and implement macros.
6301 Bind some key sequence to
6302 \begin_inset Quotes eld
6306 \begin_inset Quotes erd
6310 Then start a client that listens on the output pipe, dispatches the command
6311 according to the sequence, and starts a function that may use \SpecialChar LyX
6314 requests to issue a command or a series of commands to \SpecialChar LyX
6318 \begin_layout Section
6319 The simple \SpecialChar LyX
6323 \begin_layout Standard
6325 implements a simple protocol that can be used for session management.
6326 All messages are of the form
6339 \begin_layout Standard
6345 \begin_inset Quotes eld
6349 \begin_inset Quotes erd
6353 \begin_inset Quotes eld
6357 \begin_inset Quotes erd
6362 \begin_inset Quotes eld
6366 \begin_inset Quotes erd
6369 is received from a client, \SpecialChar LyX
6370 will report back to inform the client that
6371 it's listening to it's messages, while
6372 \begin_inset Quotes eld
6376 \begin_inset Quotes erd
6379 sent from \SpecialChar LyX
6380 will inform clients that \SpecialChar LyX
6384 \begin_layout Section
6385 Reverse DVI/PDF search
6388 \begin_layout Standard
6389 Some DVI/PDF viewers
6393 \begin_layout Plain Layout
6394 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6395 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6404 facility (also called
6409 This means that you can tell \SpecialChar LyX
6410 to put the cursor to a specific line in the
6411 document by clicking at the respective position in the DVI/PDF output.
6412 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6414 This is done via the \SpecialChar LyX
6415 server either by using the named pipe (
6419 ), or the UNIX domain socket (
6423 ) that \SpecialChar LyX
6424 creates in its temporary directory (this is the way the
6425 \begin_inset Flex Code
6428 \begin_layout Plain Layout
6434 program communicates with \SpecialChar LyX
6436 In some cases, you need a helper script that mediates between the viewer
6437 and \SpecialChar LyX
6438 , in others, the viewer can communicate with \SpecialChar LyX
6440 This depends on the selected viewer and on your operating system.
6441 The same applies to the way viewers need to be configured and the way the
6442 reverse search is actually performed.
6443 In what follows, we will thus describe how to setup reverse search for
6445 Before we turn to this, though, we will explain what needs to be done generally
6446 to enable reverse search in the DVI/PDF output.
6449 \begin_layout Subsection
6451 \begin_inset CommandInset label
6453 name "subsec:rev-search"
6460 \begin_layout Standard
6461 In most cases \SpecialChar LyX
6462 will do the work for you by enabling the option
6463 \begin_inset Flex Noun
6466 \begin_layout Plain Layout
6467 Synchronize with Output
6473 \begin_inset Flex Noun
6476 \begin_layout Plain Layout
6477 Document\SpecialChar menuseparator
6478 Settings\SpecialChar menuseparator
6485 In such a case \SpecialChar LyX
6486 will automatically insert the necessary Sync\SpecialChar TeX
6488 PDF) or load the srcltx package (for DVI) respectively.
6489 This option can be easily reached also on
6490 \begin_inset Flex Code
6493 \begin_layout Plain Layout
6502 \begin_layout Standard
6503 If you need a different setting, you can select or input a custom macro
6504 from the drop down box just below
6505 \begin_inset Flex Noun
6508 \begin_layout Plain Layout
6509 Document\SpecialChar menuseparator
6510 Settings\SpecialChar menuseparator
6511 Output\SpecialChar menuseparator
6512 Synchronize with Output
6520 \begin_layout Standard
6521 Note that the method
6522 \begin_inset Flex Code
6525 \begin_layout Plain Layout
6533 enables gzip compression.
6534 If your viewer does not support it, you should instead use
6535 \begin_inset Flex Code
6538 \begin_layout Plain Layout
6549 \begin_layout Standard
6550 Please also note that including the
6551 \begin_inset Flex Code
6554 \begin_layout Plain Layout
6561 \begin_inset Flex Code
6564 \begin_layout Plain Layout
6570 sometimes has an undesired impact on the typesetting.
6571 Thus, you should switch output synchronization off for the final typesetting
6573 \begin_inset Flex Code
6576 \begin_layout Plain Layout
6583 \begin_inset Flex Code
6586 \begin_layout Plain Layout
6596 \begin_layout Standard
6597 In case you need some more special settings that are not covered by the
6598 automatic settings, read the next section about how to set up output synchroniz
6600 If the automatic setup suits your needs, you can readily jump to section
6601 \begin_inset space ~
6605 \begin_inset CommandInset ref
6607 reference "subsec:configuring-viewers"
6611 , where the necessary configuration steps in your viewer – needed both with
6612 the automatic and the manual setup – are described.
6615 \begin_layout Subsection
6619 \begin_layout Standard
6621 provides several different methods for reverse search.
6622 Some are built-in in the
6623 \begin_inset Flex Code
6626 \begin_layout Plain Layout
6632 program, some are provided by external packages.
6633 Your choice depends on whether your \SpecialChar LaTeX
6634 distribution already provides a given
6635 method (the built-in methods are rather new) and whether your viewer can
6637 The available methods are described in the following.
6640 \begin_layout Subsubsection*
6641 Built-in DVI-search via src-specials (DVI only)
6644 \begin_layout Standard
6645 This method provides the DVI file with the necessary information for reverse
6647 It is available in \SpecialChar LaTeX
6648 since quite some time (any somewhat recent \SpecialChar LaTeX
6650 should include it), and it works reliably.
6651 To enable it, change the
6652 \begin_inset Flex Noun
6655 \begin_layout Plain Layout
6666 \begin_inset Flex Noun
6669 \begin_layout Plain Layout
6680 \begin_inset Flex Noun
6683 \begin_layout Plain Layout
6684 Preferences\SpecialChar menuseparator
6685 File Handling\SpecialChar menuseparator
6692 \begin_inset Flex Code
6695 \begin_layout Plain Layout
6696 latex -src-specials $$i
6702 If this doesn't work, check if your \SpecialChar TeX
6703 engine needs different options (the
6704 syntax might differ in some distributions).
6707 \begin_layout Subsubsection*
6708 External Packages (PDFSync and scrltx)
6711 \begin_layout Standard
6720 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6722 In order to enable it, load the packages in the \SpecialChar LyX
6726 \begin_layout Itemize
6727 \begin_inset Flex Code
6730 \begin_layout Plain Layout
6738 for reverse PDF search,
6741 \begin_layout Itemize
6742 \begin_inset Flex Code
6745 \begin_layout Plain Layout
6748 usepackage[active]{srcltx}
6753 for reverse DVI search.
6756 \begin_layout Standard
6757 If you want to be able to perform both DVI and PDF reverse searches, you
6758 can also insert in the preamble the following lines
6761 \begin_layout LyX-Code
6765 \begin_inset Newline newline
6771 \begin_inset Newline newline
6777 \begin_inset Newline newline
6783 \begin_inset Newline newline
6788 usepackage[active]{srcltx}
6789 \begin_inset Newline newline
6797 \begin_layout Standard
6798 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6799 right package will be used.
6802 \begin_layout Standard
6803 Note that PDFSync might affect the output layout of your document.
6804 It is therefore advised to disable PDFsync for final documents.
6807 \begin_layout Subsubsection*
6808 Built-in reverse search via Sync\SpecialChar TeX
6812 \begin_layout Standard
6814 \begin_inset Flex Code
6817 \begin_layout Plain Layout
6823 have built-in support for both PDF and DVI reverse search.
6826 Sync\SpecialChar TeX
6829 facility is basically the result of the integration of the PDFSync package
6830 to the pdftex program and its merge with the
6835 You need at least \SpecialChar TeX
6836 Live 2008 or a recent Mik\SpecialChar TeX
6837 distribution in order to use
6842 \begin_layout Plain Layout
6843 For some reason, Mik\SpecialChar TeX
6844 does not understand/obey the command \SpecialChar LyX
6846 the preamble when you check the "Enable Forward/Reverse Search" button
6847 in the toolbar and does not generate the necessary info.
6850 \begin_layout Plain Layout
6851 The generation of the required info can be forced by changing the converter
6853 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
6854 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
6855 the -synctex=1 switch).
6860 Also note that only a few PDF viewers (Okular and Qpdfview on Unix, Skim
6861 on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
6865 \begin_layout Standard
6866 To enable Sync\SpecialChar TeX
6867 for DVI output, change the
6868 \begin_inset Flex Noun
6871 \begin_layout Plain Layout
6882 \begin_inset Flex Noun
6885 \begin_layout Plain Layout
6896 \begin_inset Flex Noun
6899 \begin_layout Plain Layout
6900 Preferences\SpecialChar menuseparator
6901 File Handling\SpecialChar menuseparator
6908 \begin_inset Flex Code
6911 \begin_layout Plain Layout
6912 latex -synctex=1 $$i
6917 , and for PDF output, change the
6918 \begin_inset Flex Noun
6921 \begin_layout Plain Layout
6926 (pdflatex) -> PDF (pdflatex)
6932 \begin_inset Flex Code
6935 \begin_layout Plain Layout
6936 pdflatex -synctex=1 $$i
6942 Check the documentation of your viewer whether the viewer needs to be configure
6943 d for the use with Sync\SpecialChar TeX
6948 \begin_layout Plain Layout
6949 Note that the option
6950 \begin_inset Flex Code
6953 \begin_layout Plain Layout
6959 option enables gzip compression.
6960 If your viewer does not support it, you should instead use
6961 \begin_inset Flex Code
6964 \begin_layout Plain Layout
6978 \begin_layout Subsection
6979 Configuring and using specific viewers
6980 \begin_inset CommandInset label
6982 name "subsec:configuring-viewers"
6989 \begin_layout Subsubsection*
6990 Xdvi (all platforms)
6993 \begin_layout Standard
6995 \begin_inset Flex Code
6998 \begin_layout Plain Layout
7004 , you don't need to do anything else for performing a reverse DVI search,
7006 already provides the necessary hooks for automatically using the
7007 \begin_inset Flex Code
7010 \begin_layout Plain Layout
7017 Just setup your document as described above (reverse search is triggered
7018 by Ctrl-click or Alt-click on Mac OSX, respectively).
7021 \begin_layout Standard
7022 However, if for whatever reason you want to use the named pipe instead of
7023 the socket for communicating with \SpecialChar LyX
7024 , simply change the DVI viewer in
7025 \begin_inset Flex Noun
7028 \begin_layout Plain Layout
7029 Preferences\SpecialChar menuseparator
7030 File Handling\SpecialChar menuseparator
7040 \begin_layout Plain Layout
7041 On Mac OSX you have to use
7042 \begin_inset Flex Code
7045 \begin_layout Plain Layout
7046 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7057 \begin_inset Flex Code
7060 \begin_layout Plain Layout
7061 xdvi -editor "lyxeditor.sh %f %l"
7067 \begin_inset Flex Code
7070 \begin_layout Plain Layout
7076 is a suitable script.
7077 For example, a minimal shell script is the following one:
7080 \begin_layout LyX-Code
7082 \begin_inset Newline newline
7085 LYXPIPE="/path/to/lyxpipe"
7086 \begin_inset Newline newline
7089 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7090 \begin_inset Newline newline
7093 echo "$COMMAND" > "${LYXPIPE}".in || exit
7094 \begin_inset Newline newline
7097 read TMP < "${LYXPIPE}".out || exit
7100 \begin_layout Standard
7102 \begin_inset Flex Code
7105 \begin_layout Plain Layout
7111 is the LyXServer pipe path specified in
7112 \begin_inset Flex Noun
7115 \begin_layout Plain Layout
7116 Preferences\SpecialChar menuseparator
7126 \begin_layout Plain Layout
7128 \begin_inset Flex Code
7131 \begin_layout Plain Layout
7137 folder of a source distribution you can find a
7138 \begin_inset Flex Code
7141 \begin_layout Plain Layout
7147 script which is able to locate the
7151 based on your preferences.
7159 \begin_layout Subsubsection*
7163 \begin_layout Standard
7165 \begin_inset Flex Code
7168 \begin_layout Plain Layout
7169 /Applications/MacDviX_Folder/calleditor.script
7174 , add the following lines:
7177 \begin_layout LyX-Code
7178 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7179 \begin_inset Newline newline
7185 \begin_layout Standard
7186 Modify the lines accordingly if you install \SpecialChar LyX
7187 somewhere else than in the
7188 Applications folder.
7191 \begin_layout Standard
7192 Reverse search is triggered by Alt-click (OPTION-click).
7195 \begin_layout Subsubsection*
7199 \begin_layout Standard
7201 \begin_inset Flex Code
7204 \begin_layout Plain Layout
7205 open -a Skim.app $$i
7210 to the viewer setting in
7211 \begin_inset Flex Noun
7214 \begin_layout Plain Layout
7215 Preferences\SpecialChar menuseparator
7216 File Handling\SpecialChar menuseparator
7217 File formats\SpecialChar menuseparator
7224 \begin_inset Flex Noun
7227 \begin_layout Plain Layout
7228 Skim\SpecialChar menuseparator
7229 Preferences\SpecialChar menuseparator
7236 \begin_inset Flex Noun
7239 \begin_layout Plain Layout
7245 preset and enter command
7246 \begin_inset Flex Noun
7249 \begin_layout Plain Layout
7250 /Applications/\SpecialChar LyX
7251 .app/Contents/MacOS/lyxeditor
7259 \begin_layout Standard
7260 Reverse search is triggered by COMMAND-SHIFT-click
7263 \begin_layout Subsubsection*
7267 \begin_layout Standard
7269 \begin_inset Flex Noun
7272 \begin_layout Plain Layout
7273 Settings\SpecialChar menuseparator
7274 Configure Okular\SpecialChar menuseparator
7281 \begin_inset Quotes eld
7285 \begin_inset Quotes erd
7289 \begin_inset Flex Code
7292 \begin_layout Plain Layout
7301 \begin_layout Standard
7302 Reverse search is triggered by SHIFT-click.
7305 \begin_layout Subsubsection*
7309 \begin_layout Standard
7310 Qpdfview supports Sync\SpecialChar TeX
7311 since version 0.3.5.
7313 \begin_inset Flex Noun
7316 \begin_layout Plain Layout
7317 Edit\SpecialChar menuseparator
7318 Settings\SpecialChar menuseparator
7324 , click on the input field of the
7325 \begin_inset Quotes eld
7329 \begin_inset Quotes erd
7332 item and add the command
7333 \begin_inset Flex Code
7336 \begin_layout Plain Layout
7345 \begin_layout Standard
7346 Reverse search is triggered by double-click or, in more recent versions,
7350 \begin_layout Subsubsection*
7354 \begin_layout Standard
7355 Launch yap, choose its
7356 \begin_inset Flex Noun
7359 \begin_layout Plain Layout
7360 View\SpecialChar menuseparator
7367 \begin_inset Quotes eld
7371 \begin_inset Quotes erd
7376 \begin_inset Quotes eld
7379 New\SpecialChar ldots
7381 \begin_inset Quotes erd
7384 button and, in the window that opens, enter
7385 \begin_inset Quotes eld
7390 \begin_inset Quotes erd
7393 (or any other name you like) in the
7394 \begin_inset Quotes eld
7398 \begin_inset Quotes erd
7402 Now click on the button labeled
7403 \begin_inset Quotes eld
7408 \begin_inset Quotes erd
7411 to open a file dialog and navigate to the directory containing the batch
7413 \begin_inset Flex Code
7416 \begin_layout Plain Layout
7424 \begin_inset Flex Code
7427 \begin_layout Plain Layout
7433 and then specify the program arguments as
7434 \begin_inset Flex Code
7437 \begin_layout Plain Layout
7445 \begin_inset Flex Code
7448 \begin_layout Plain Layout
7454 wrapper is used for communicating with \SpecialChar LyX
7462 \begin_layout LyX-Code
7464 \begin_inset Newline newline
7467 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
7476 \begin_inset Newline newline
7490 \begin_layout Standard
7491 Make sure that the \SpecialChar LyX
7492 Server pipe path you specified in \SpecialChar LyX
7494 \begin_inset Flex Code
7497 \begin_layout Plain Layout
7511 , otherwise change the
7512 \begin_inset Flex Code
7515 \begin_layout Plain Layout
7521 wrapper accordingly.
7524 \begin_layout Standard
7525 In yap, reverse search is triggered by double-click.
7528 \begin_layout Subsubsection*
7529 SumatraPDF (Windows)
7532 \begin_layout Standard
7533 In order to use SumatraPDF for inverse search, enter
7534 \begin_inset Flex Code
7537 \begin_layout Plain Layout
7538 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
7543 in the viewer setting in
7544 \begin_inset Flex Noun
7547 \begin_layout Plain Layout
7548 Preferences\SpecialChar menuseparator
7549 File Handling\SpecialChar menuseparator
7550 File formats\SpecialChar menuseparator
7557 \begin_inset Flex Code
7560 \begin_layout Plain Layout
7566 is the previous wrapper.
7567 If SumatraPDF.exe is not in your command PATH, use its full file name.
7570 \begin_layout Standard
7571 Reverse search is triggered by double-click.
7574 \begin_layout Subsubsection*
7578 \begin_layout Standard
7579 First of all, make sure that yap is your default DVI viewer in the Windows
7580 environment, then launch it, choose its
7581 \begin_inset Flex Noun
7584 \begin_layout Plain Layout
7585 View\SpecialChar menuseparator
7592 \begin_inset Quotes eld
7596 \begin_inset Quotes erd
7601 \begin_inset Quotes eld
7604 New\SpecialChar ldots
7606 \begin_inset Quotes erd
7609 button and, in the window that opens, enter
7610 \begin_inset Quotes eld
7615 \begin_inset Quotes erd
7618 (or any other name you like) in the
7619 \begin_inset Quotes eld
7623 \begin_inset Quotes erd
7627 Now click on the button labeled
7628 \begin_inset Quotes eld
7633 \begin_inset Quotes erd
7636 to open a file dialog and navigate to the directory containing the
7637 \begin_inset Flex Code
7640 \begin_layout Plain Layout
7646 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7649 \begin_inset Flex Code
7652 \begin_layout Plain Layout
7658 and then specify the program arguments as
7659 \begin_inset Flex Code
7662 \begin_layout Plain Layout
7669 In this way, you will be using the
7673 for communicating with \SpecialChar LyX
7675 If, for whatever reason, you want to use the
7680 \begin_inset Flex Code
7683 \begin_layout Plain Layout
7689 option and be sure to specify the \SpecialChar LyX
7690 Server pipe path in the \SpecialChar LyX
7694 \begin_layout Standard
7695 In yap, reverse search is triggered by double-click.
7698 \begin_layout Subsubsection*
7702 \begin_layout Standard
7703 In order to use SumatraPDF for inverse search, enter
7704 \begin_inset Flex Code
7707 \begin_layout Plain Layout
7708 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7713 in the viewer setting in
7714 \begin_inset Flex Noun
7717 \begin_layout Plain Layout
7718 Preferences\SpecialChar menuseparator
7719 File Handling\SpecialChar menuseparator
7720 File formats\SpecialChar menuseparator
7727 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7729 \begin_inset Flex Code
7732 \begin_layout Plain Layout
7738 enables communication via the
7744 \begin_inset Flex Code
7747 \begin_layout Plain Layout
7753 option if you want to use the
7757 , and be sure to specify the \SpecialChar LyX
7758 Server pipe path in the \SpecialChar LyX
7762 \begin_layout Standard
7763 Reverse search is triggered by double-click.
7766 \begin_layout Section
7770 \begin_layout Standard
7771 Forward search is, as the name implies, in a sense the
7772 \begin_inset Quotes eld
7776 \begin_inset Quotes erd
7780 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7782 If forward search is set up (as described in what follows), you can put
7783 the cursor anywhere in your \SpecialChar LyX
7785 \begin_inset Flex Noun
7788 \begin_layout Plain Layout
7789 Navigate\SpecialChar menuseparator
7796 \begin_inset Flex Noun
7799 \begin_layout Plain Layout
7805 in the context menu via right mouse click), and then the viewer will jump
7806 to that position as well.
7807 This implies, of course, that your viewer supports this function.
7810 \begin_layout Standard
7811 To make forward search possible, you first need to provide the generated
7812 output PDF/DVI file with additional information about the \SpecialChar TeX
7814 This can be done via the methods described in the section
7815 \begin_inset CommandInset ref
7817 reference "subsec:rev-search"
7824 \begin_layout Standard
7825 Additionally, you need to configure \SpecialChar LyX
7826 for using your viewers in
7827 \begin_inset Flex Noun
7830 \begin_layout Plain Layout
7831 Tools\SpecialChar menuseparator
7832 Preferences\SpecialChar menuseparator
7833 Output\SpecialChar menuseparator
7840 We provide a range of tested configurations for some viewers, which you
7841 can select from the drop down list.
7842 If none of these configurations suits you, you have to find out and enter
7843 a suitable configuration yourself.
7844 The definition syntax uses the following placeholders:
7847 \begin_layout Itemize
7849 \begin_inset Flex Code
7852 \begin_layout Plain Layout
7861 \begin_layout Itemize
7863 \begin_inset Flex Code
7866 \begin_layout Plain Layout
7872 : name of the (temporary) exported .tex file (without path)
7875 \begin_layout Itemize
7877 \begin_inset Flex Code
7880 \begin_layout Plain Layout
7886 : name of the (temporary) exported .tex file (including path)
7889 \begin_layout Itemize
7891 \begin_inset Flex Code
7894 \begin_layout Plain Layout
7900 : name of the exported output file (either dvi or pdf, depending on which
7901 one exists in the temporary directory)
7904 \begin_layout Standard
7905 Note that only some of the viewers provide full forward search functionality,
7906 among them yap, xdvi, okular
7910 \begin_layout Plain Layout
7911 You might want to set
7912 \begin_inset Flex Code
7915 \begin_layout Plain Layout
7922 \begin_inset Flex Noun
7925 \begin_layout Plain Layout
7926 Tools\SpecialChar menuseparator
7927 Preferences\SpecialChar menuseparator
7928 File Handling\SpecialChar menuseparator
7930 \begin_inset space ~
7943 , qpdfview and SumatraPDF
7947 \begin_layout Plain Layout
7948 SumatraPDF can also use DDE commands through the external program CMCDDE
7950 \begin_inset CommandInset href
7952 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
7963 While many of the widespread PDF viewers (most notably Adobe Reader) do
7964 not support forward search at all, some other viewers – e.
7965 \begin_inset space \thinspace{}
7969 evince and xpdf – allow at least to reload the document and jump to a specific
7970 page of the file, so you can at least navigate
7971 \begin_inset Quotes eld
7975 \begin_inset Quotes erd
7979 This latter functionality is provided by an external call of synctex (see
7980 the predefined example configurations).
7984 \begin_layout Standard
7985 Forward search works both with DVI and PDF output.
7987 simply checks which preview format you have used before (i.
7988 \begin_inset space \thinspace{}
7991 e., which format is already there in the temporary directory) and chooses
7992 the appropriate configuration for the respective format.
7995 \begin_layout Chapter
7996 Special Document Classes
7999 \begin_layout Section
8003 \begin_layout Standard
8009 \begin_layout Subsection
8013 \begin_layout Standard
8014 This section describes how \SpecialChar LyX
8015 can be used to write articles for submission
8016 to the scientific journal
8018 Astronomy and Astrophysics
8021 \begin_inset Flex URL
8024 \begin_layout Plain Layout
8026 http://www.edpsciences.fr/aa/
8031 ) using Version 5.01 of the document class
8036 This package can be downloaded from the ftp site
8039 \begin_layout Standard
8040 \begin_inset VSpace medskip
8046 \begin_layout Standard
8048 \begin_inset Flex URL
8051 \begin_layout Plain Layout
8053 ftp://ftp.edpsciences.org/pub/aa/readme.html
8061 \begin_layout Standard
8062 \begin_inset VSpace medskip
8068 \begin_layout Standard
8069 A manual comes together with that package, and this text is not meant to
8070 replace the original manual but is merely a short guide in how to realize
8071 the correct form of your paper.
8075 \begin_layout Standard
8076 Please note that the publisher of the journal was changed from Springer
8077 to EDP Sciences starting January 1, 2001.
8078 That change involved also some slight changes to the style files, namely
8079 the removal of the thesaurus command.
8080 The \SpecialChar LyX
8081 class aa supports the newest version of these style files, V 5.01.
8082 If you have an older version installed, please upgrade.
8083 For compatibility, the old (version 4) layout has been kept as
8088 Please refer to the comments in
8091 Dir/layouts/aapaper.layout
8096 \begin_layout Subsection
8100 \begin_layout Standard
8101 It is recommended you start from the example template distributed with \SpecialChar LyX
8103 If you are not using a template, note the following settings:
8106 \begin_layout Itemize
8113 Document\SpecialChar menuseparator
8116 dialog (OK, that one was obvious).
8119 \begin_layout Itemize
8120 Don't change the option
8123 \begin_inset space ~
8133 The whole layout is done by the macros, you shouldn't change anything.
8136 \begin_layout Subsection
8140 \begin_layout Standard
8141 First thing to enter is the header information.
8142 It consists of seven entries, of which some are optional.
8146 \begin_layout Itemize
8154 \begin_layout Itemize
8162 \begin_layout Itemize
8170 \begin_layout Itemize
8178 \begin_layout Itemize
8183 : [optional] if more than one author: whom to contact for offprint requests.
8186 \begin_layout Itemize
8191 : [optional] mail address for contacts.
8194 \begin_layout Itemize
8202 Received: <date>; Accepted <date>
8205 \begin_layout Standard
8206 There is no need to issue the
8212 command, this is done automatically by \SpecialChar LyX
8213 when the header is finished.
8214 Although the order of the single header entries doesn't matter it is advised
8215 to keep the above sequence, just to get the best optics and meets the layout
8216 of the real document.
8219 \begin_layout Standard
8220 If you want to place footnotes in the header block, e.
8221 \begin_inset space \thinspace{}
8225 \begin_inset space \space{}
8228 to state your present address, just use the standard footnote via the menu
8231 Insert\SpecialChar menuseparator
8236 will automagically use the term
8245 \begin_layout Standard
8246 In addition to these topics, the macros use three additional \SpecialChar LaTeX
8248 have no counterpart in \SpecialChar LyX
8252 \begin_layout Itemize
8259 to separate different names for more than one author and institute, respectivel
8263 \begin_layout Itemize
8270 to mark corresponding author/institute pairs.
8271 The institutes are numbered sequentially as they appear in the
8275 field, so you have to put a marker to each author.
8278 \begin_layout Itemize
8285 to supply an email address for fast contact.
8288 \begin_layout Standard
8289 In all cases, the appropriate command has to be entered in \SpecialChar LyX
8297 \begin_layout Subsection
8301 \begin_layout Standard
8302 The abstract should immediately follow the header block.
8303 With version 5 the abstract environment was changed to a command, and there
8304 is now a resctriction to only one paragraph.
8305 In addition, it should contain an entry with the keywords.
8306 This is not yet implemented for \SpecialChar LyX
8307 , therefore you have to enter the \SpecialChar LaTeX
8315 by hand and mark it as \SpecialChar LaTeX
8317 Refer to the example paper.
8320 \begin_layout Subsection
8321 Supported environments
8324 \begin_layout Standard
8325 The A&A paper layout supports the following environments for structuring
8329 \begin_layout Itemize
8335 \begin_layout Itemize
8341 \begin_layout Itemize
8347 \begin_layout Itemize
8353 \begin_layout Itemize
8359 \begin_layout Itemize
8365 \begin_layout Itemize
8371 \begin_layout Itemize
8377 \begin_layout Itemize
8383 \begin_layout Itemize
8389 \begin_layout Itemize
8395 \begin_layout Itemize
8402 \begin_layout Subsection
8403 Commands not supported by \SpecialChar LyX
8407 \begin_layout Standard
8408 Some commands are not yet supported by the
8412 layout for \SpecialChar LyX
8414 Some have already been mentioned.
8415 For the sake of completeness, they are listed all together here:
8418 \begin_layout Itemize
8426 \begin_layout Itemize
8434 \begin_layout Itemize
8442 \begin_layout Itemize
8450 \begin_layout Itemize
8458 \begin_layout Itemize
8466 \begin_layout Itemize
8474 \begin_layout Itemize
8482 \begin_layout Standard
8483 If you want to use any of these commands, you have to enter them yourself.
8486 Do not forget to mark them as \SpecialChar LaTeX
8490 \begin_layout Subsection
8491 Figure and Table Floats
8494 \begin_layout Standard
8496 provides support for the necessary float environments
8498 figure, figure*, table
8504 , therefore we won't tell much about it here.
8508 \begin_inset space ~
8514 Just remember that tables should be left-aligned.
8515 For that, select the table and change the alignment in
8517 Edit\SpecialChar menuseparator
8519 \begin_inset space ~
8525 \begin_layout Standard
8526 There is only one special thing: the figures with caption besides the figure.
8527 To create such a figure, you have to do the following:
8530 \begin_layout Enumerate
8531 Create a wide figure float:
8533 Insert\SpecialChar menuseparator
8534 Float\SpecialChar menuseparator
8537 , then right click in the figure and select
8540 \begin_inset space ~
8548 \begin_layout Enumerate
8549 Enter your caption text.
8552 \begin_layout Enumerate
8557 to move the cursor above the caption.
8560 \begin_layout Enumerate
8564 \begin_layout Enumerate
8565 Position the cursor behind the figure and insert a horizontal fill:
8567 Insert\SpecialChar menuseparator
8569 \begin_inset space ~
8572 Character\SpecialChar menuseparator
8574 \begin_inset space ~
8582 \begin_layout Enumerate
8583 Switch to \SpecialChar LaTeX
8587 \begin_inset space ~
8595 \begin_layout Enumerate
8605 Do not close the brace!
8608 \begin_layout Enumerate
8609 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8614 \begin_inset space ~
8626 \begin_layout Standard
8627 Also, refer to the figures in the example paper.
8630 \begin_layout Subsection
8634 \begin_layout Standard
8635 For submission, the paper has to be formated in a special double-spacing
8637 For this purpose, you have to give the option
8641 to the documentclass.
8642 This must be done using the extra class options field in the
8644 Document\SpecialChar menuseparator
8648 Just enter the string
8655 \begin_layout Subsection
8659 \begin_layout Standard
8664 directory contains an example paper written with \SpecialChar LyX
8666 It is the example paper from the original macro package, translated to
8669 Use it for inspiration, and compare the original \SpecialChar LaTeX
8670 code with \SpecialChar LyX
8674 \begin_layout Section
8679 \begin_layout Standard
8685 \begin_layout Subsection
8689 \begin_layout Standard
8691 is a set of macros produced by the American Astronomical Society to
8692 facilitate electronic manuscript submission to the three journals they
8693 publish: the Astrophysical Journal (including the Letters and Supplement),
8694 the Astronomical Journal, and the Publications of the Astronomical Society
8697 has proven to be an excellent tool for generating these documents, especially
8698 given its equation, citation, and figure handling capabilities.
8700 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8701 is the version described here, or higher.
8702 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8703 2.09 and are fundamentally
8704 incompatible with \SpecialChar LyX
8706 The AAS\SpecialChar TeX
8707 package may be downloaded from the AAS\SpecialChar TeX
8711 \begin_layout Standard
8712 \begin_inset VSpace medskip
8718 \begin_layout Standard
8720 \begin_inset Flex URL
8723 \begin_layout Plain Layout
8725 https://aas.org/aastex/aastex-downloads
8733 \begin_layout Standard
8734 \begin_inset VSpace medskip
8740 \begin_layout Standard
8741 A complete user guide is contained in that package and you should familiarize
8742 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8745 will not reduce the need to figure out all the AAS\SpecialChar TeX
8746 commands, it will only
8747 reduce the drudgery of typing everything in.
8748 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8750 completely to the requirements of the journal to which you are submitting
8754 \begin_layout Subsection
8755 Starting a New Paper
8758 \begin_layout Standard
8759 I strongly suggest that you start with the AAS\SpecialChar TeX
8763 File\SpecialChar menuseparator
8770 , enter the new file name, then choose the
8775 This will show the most common fields found in a manuscript.
8776 Simply overwrite the existing text (including the brackets,
8780 ) with the correct information.
8781 Many of the AAS\SpecialChar TeX
8782 commands and environments can be implemented directly in
8784 , but some cannot: most noticeably
8796 , which should stick out like a sore thumb if you actually just opened the
8798 For commands such as these, the \SpecialChar LaTeX
8799 code must be entered directly and marked
8801 Such commands are referred to as \SpecialChar TeX
8802 code, or Evil Red Text.
8803 I tried to minimize the amount of \SpecialChar TeX
8804 code needed in an AAS\SpecialChar TeX
8806 there is still a bit more required than any of us would like.
8809 \begin_layout Subsection
8810 Finishing Your Paper
8813 \begin_layout Standard
8814 When the paper is finished to your satisfaction and previews/prints correctly,
8816 \begin_inset Quotes eld
8820 \begin_inset Quotes erd
8823 actions which need to be done before you submit it to the journals.
8827 \begin_layout Enumerate
8828 Export your paper as a \SpecialChar LaTeX
8831 File\SpecialChar menuseparator
8832 Export\SpecialChar menuseparator
8840 \begin_layout Enumerate
8845 file with your favorite text editor
8849 \begin_layout Enumerate
8850 remove the comment lines before the
8859 \begin_layout Enumerate
8864 usepackage...{fontenc}
8866 line if it appears (usually just after
8881 \begin_layout Enumerate
8882 remove everything between (and including) the
8894 commands, except for any commands you specifically put into the \SpecialChar LaTeX
8896 (which should appear immediately after the
8897 \begin_inset Quotes eld
8900 User specified \SpecialChar LaTeX
8902 \begin_inset Quotes erd
8913 \begin_layout Enumerate
8914 Run the resulting file through \SpecialChar LaTeX
8915 to make sure it still processes correctly.
8918 \begin_layout Enumerate
8919 Reread the journal requirements to make sure your filenames and formats
8923 \begin_layout Enumerate
8927 \begin_layout Subsection
8928 Comments On Specific Commands
8931 \begin_layout Standard
8932 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8939 ) gives a good description of each.
8940 Thus it's probably easiest for me to go down the list as found in the guide
8941 and offer comments where necessary.
8942 So let's begin \SpecialChar ldots
8946 \begin_layout Subsubsection
8947 Things that work as expected
8950 \begin_layout Standard
8951 Because they work as you might expect, I simply list them and the section
9052 begin{thebibliography}
9060 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9061 graphicx figure commands (2.14.1),
9085 (2.15.4, amongst other places),
9112 \begin_layout Standard
9113 The following style options also work correctly:
9134 Simply put them in the
9140 Layout\SpecialChar menuseparator
9146 \begin_layout Subsubsection
9147 Things that work, but require more comment
9150 \begin_layout Standard
9151 The following items work, but require a little more discussion:
9154 \begin_layout Itemize
9155 These items are reserved for use by the journal editors, but you can put
9156 them into the \SpecialChar LaTeX
9157 preamble if you feel compelled to do so:
9190 \begin_layout Itemize
9191 These items may be placed in the \SpecialChar LaTeX
9192 preamble, and are included as blanks in
9214 \begin_layout Itemize
9221 (2.3) – can only be used
9222 \begin_inset Quotes eld
9226 \begin_inset Quotes erd
9229 , not in the middle of a paragraph.
9230 Use \SpecialChar TeX
9231 code if you need to embed it.
9234 \begin_layout Itemize
9241 (2.3) – will have extra {} after it.
9242 This should not cause an error.
9245 \begin_layout Itemize
9252 (2.6) – can only be used
9253 \begin_inset Quotes eld
9257 \begin_inset Quotes erd
9260 , not in the middle of a paragraph.
9261 Use \SpecialChar TeX
9262 code if you need to embed it.
9265 \begin_layout Itemize
9272 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9276 \begin_layout Itemize
9290 \begin_layout Itemize
9297 (2.9) – will have extra {} after it.
9298 This should not cause an error.
9301 \begin_layout Itemize
9308 (2.11) – will have extra {} after it.
9309 This should not cause an error.
9312 \begin_layout Itemize
9319 (2.14.2) – you can insert an optional filename argument by placing the cursor
9320 at the beginning of the text and selecting
9322 Insert\SpecialChar menuseparator
9327 \begin_inset Quotes eld
9331 \begin_inset Quotes erd
9334 inserts an optional argument of the type needed by
9341 Hopefully it will be renamed someday.
9344 \begin_layout Itemize
9357 for the catalog ID optional parameter
9360 \begin_layout Itemize
9373 for the catalog ID optional parameter
9376 \begin_layout Subsubsection
9377 Things not implemented, use \SpecialChar TeX
9381 \begin_layout Standard
9404 setcounter{equation}
9406 (2.12), Journal name abbreviations (2.13.4),
9442 (2.15.4, insert it as the first element in the lefthand cell after where
9444 Don't use any of \SpecialChar LyX
9445 's rules in the table),
9457 (2.15.5), much of Misc (2.17, except
9508 \begin_layout Subsubsection
9509 Things that cannot be implemented
9512 \begin_layout Standard
9514 at least in any meaningful sort of way, so I suggest ignoring them.
9515 They are the references environment (2.13.3), and the deluxetable environment
9517 If you really, really need to use deluxetable, I suggest editing it in
9518 a separate file with a text editor, then using
9520 Insert\SpecialChar menuseparator
9522 \begin_inset space ~
9527 to include it in your \SpecialChar LyX
9533 file to see an example of this.
9536 \begin_layout Subsection
9537 FAQs, Tips, Tricks, and Other Ruminations
9540 \begin_layout Subsubsection
9541 Getting \SpecialChar LyX
9542 and AAS\SpecialChar TeX
9546 \begin_layout Standard
9547 It can be a bit tricky to get \SpecialChar LyX
9548 to recognize a new layout and document class.
9549 When all else fails, do this:
9552 \begin_layout Enumerate
9553 Make certain that \SpecialChar LaTeX
9554 can find AAS\SpecialChar TeX
9556 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9558 directory completely unrelated to \SpecialChar LaTeX
9559 or AAS\SpecialChar TeX
9560 and run \SpecialChar LaTeX
9568 \begin_layout Enumerate
9573 appears in \SpecialChar LyX
9581 \begin_layout Enumerate
9584 Tools\SpecialChar menuseparator
9588 , then restart \SpecialChar LyX
9592 \begin_layout Enumerate
9593 Open a regular new file, not from a template.
9594 Does AAS\SpecialChar TeX
9595 appear in the class list in
9597 Document\SpecialChar menuseparator
9603 \begin_layout Standard
9604 If you get a warning from an existing AAS\SpecialChar TeX
9605 document about not being able
9606 to find the AAS\SpecialChar TeX
9607 layout or a message about
9608 \begin_inset Quotes eld
9611 You should not mix title layouts with normal ones
9612 \begin_inset Quotes erd
9615 , things haven't been installed correctly.
9618 \begin_layout Subsubsection
9620 error processing a table
9623 \begin_layout Standard
9625 , by default, attempts to center the table caption/title.
9626 This seems to produce a bad interaction in AAS\SpecialChar TeX
9627 so you should click somewhere
9628 in the caption/title, then select
9630 Edit\SpecialChar menuseparator
9632 \begin_inset space ~
9646 This took care of it for me.
9649 \begin_layout Subsubsection
9653 \begin_layout Standard
9654 A couple of things: 1) I have noticed some funny spacing in the reference
9655 entries in the text.
9656 When you enter the bibliography item data, make sure their is
9660 space between the last author and the parenthesis setting off the year;
9664 \begin_inset space \thinspace{}
9668 \begin_inset space \space{}
9682 2) Entering the references at all is not obvious.
9683 The easiest thing is to start typing your first reference at the end of
9684 the document, then mark it as type
9689 That will put a small gray box in front of what you just typed.
9690 Click on the box to fill in the rest of the information.
9691 For new references, go to the end of an existing reference and press return.
9692 That will create a new line with its own box, etc.
9695 \begin_layout Subsubsection
9699 \begin_layout Standard
9700 Even though AAS\SpecialChar TeX
9701 provides its own figure commands (
9707 , for example), I much prefer \SpecialChar LaTeX
9708 's standard figure commands (with the default
9717 \begin_inset space ~
9720 commands as \SpecialChar TeX
9721 code into a Figure Float box if you desire, but I never have
9722 much luck getting the layout right.
9723 With the standard graphics, \SpecialChar LyX
9728 usepackage{graphicx}
9730 command into the \SpecialChar LaTeX
9731 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9733 interspersing the figures in the text.
9734 I believe ApJ accepts figures exactly this way now; AJ might still use
9736 \begin_inset Quotes eld
9739 stack everything at the end
9740 \begin_inset Quotes erd
9746 \begin_layout Subsubsection
9747 Things I could have done, but didn't
9750 \begin_layout Standard
9752 \begin_inset Quotes eld
9756 \begin_inset Quotes erd
9759 things I could have implemented, but chose not to.
9760 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9762 even though it is double-spaced in the paper manuscript.
9763 Also, I chose not to make separate layouts for the preprint and preprint2
9765 Since I assume you will spend most of your time in the plain manuscript
9766 mode anyway, I decided not to chew up more disk space with this.
9770 \begin_layout Subsection
9774 \begin_layout Standard
9775 Your mileage may vary.
9776 I've now had papers published by both ApJ and AJ that have had 98% of the
9777 effort done in \SpecialChar LyX
9778 ; the last 2% was the \SpecialChar LaTeX
9779 post-processing and a few cleanups.
9780 I have had no trouble with the submission process, and I'm sure the journals
9781 were never aware that there might be a difference.
9782 So, go forth and publish!
9785 \begin_layout Section
9786 AMS \SpecialChar LaTeX
9790 \begin_layout Standard
9800 \begin_layout Standard
9801 \begin_inset VSpace bigskip
9807 \begin_layout Standard
9809 The AMS \SpecialChar LaTeX
9810 layouts are set up to conform to suggested styles for mathematical
9811 papers to be submitted to American Mathematical Society publications.
9812 The layouts are not tailored to a specific journal, but easily can be.
9813 You should refer to the AMS documentation for specific instructions for
9814 each journal (usually it will entail only changing a single line in the
9817 That documentation is available on the Web at
9818 \begin_inset Flex URL
9821 \begin_layout Plain Layout
9829 \begin_inset Flex URL
9832 \begin_layout Plain Layout
9834 ftp://ftp.ams.org/pub/tex/amslatex/
9840 These layouts are appropriate, and useful, for any mathematical writing.
9844 \begin_layout Standard
9845 There are two basic AMS \SpecialChar LaTeX
9849 \begin_layout Itemize
9850 amsart: The standard AMS article format.
9853 \begin_layout Itemize
9854 amsbook: the standard AMS book (really, monograph) format.
9858 \begin_layout Standard
9859 The layouts themselves contain only the minimum necessary to use the AMS
9861 They do not, in particular, contain any of the `theorem' environments used
9862 for setting theorems, lemmas, and the like.
9863 These are contained, instead, in the
9864 \begin_inset Flex Code
9867 \begin_layout Plain Layout
9873 module, which is loaded by default when you select one of the AMS classes.
9874 (It can also be used with other classes and can be removed, if you would
9875 rather use something else.) Less commonly used environments are in the
9876 \begin_inset Flex Code
9879 \begin_layout Plain Layout
9880 Theorems (AMS-Extended)
9885 module, which must be loaded manually.
9888 \begin_layout Standard
9889 By default, theorems and the like are numbered consecutively throughout
9890 the document, but this may be modified by loading the module
9891 \begin_inset Flex Code
9894 \begin_layout Plain Layout
9895 Theorems (Order by Section)
9900 or, if you are using
9901 \begin_inset Flex Code
9904 \begin_layout Plain Layout
9911 \begin_inset Flex Code
9914 \begin_layout Plain Layout
9915 Theorems (Order by Chapter)
9921 These will number the results as
9922 \begin_inset Formula $n.m$
9925 , where the first number refers to the section (or chapter) and the second
9926 refers to the total number of results so far in that section (or chapter).
9927 Many environments are also available unnumbered.
9928 These are indicated by an asterisk at the end.
9929 If you happen to want
9933 unnumbered results, the module
9934 \begin_inset Flex Code
9937 \begin_layout Plain Layout
9943 provides that option.
9946 \begin_layout Standard
9947 Note that these modules do not
9951 to be used with the AMS classes.
9952 It is perfectly possible to use the
9953 \begin_inset Flex Code
9956 \begin_layout Plain Layout
9962 module, and the others mentioned, with other classes, such as
9963 \begin_inset Flex Code
9966 \begin_layout Plain Layout
9973 \begin_inset Flex Code
9976 \begin_layout Plain Layout
9983 \begin_inset Flex Code
9986 \begin_layout Plain Layout
9995 \begin_layout Subsection
9996 What these layouts provide
9999 \begin_layout Standard
10000 There is a long list of included environments provided by these layouts.
10001 In AMS-\SpecialChar LaTeX
10002 , there is, in fact, an opportunity to define an unlimited variety
10003 of `theorem' environments.
10004 However, the AMS recommends the environments that are available in \SpecialChar LyX
10009 \begin_layout Standard
10010 The following environments—as well as the standard environments, such as
10012 \begin_inset Flex Noun
10015 \begin_layout Plain Layout
10022 \begin_inset Flex Noun
10025 \begin_layout Plain Layout
10032 \begin_inset Flex Noun
10035 \begin_layout Plain Layout
10042 \begin_inset Flex Noun
10045 \begin_layout Plain Layout
10052 \begin_inset Flex Noun
10055 \begin_layout Plain Layout
10062 \begin_inset Flex Code
10065 \begin_layout Plain Layout
10072 \begin_inset Flex Code
10075 \begin_layout Plain Layout
10084 \begin_layout Description
10085 Address This should be the author's permanent address.
10088 \begin_layout Description
10090 \begin_inset space ~
10093 Address This should be the author's temporary address at the time of submission,
10094 if different from the Address.
10097 \begin_layout Description
10098 Email Author's e-mail address
10101 \begin_layout Description
10102 URL Author's Web address, if desired.
10105 \begin_layout Description
10106 Keywords Key words or phrases used to identify specific topics discussed
10110 \begin_layout Description
10111 Subjectclass These refer to the AMS Subject Classifications, published and
10114 Mathematical Reviews
10117 These are also available online at the AMS cites listed above.
10120 \begin_layout Description
10124 \begin_layout Description
10128 \begin_layout Description
10132 \begin_layout Standard
10133 The following environments are provided by both the
10134 \begin_inset Flex Code
10137 \begin_layout Plain Layout
10144 \begin_inset Flex Code
10147 \begin_layout Plain Layout
10153 modules, in the latter case in both starred (unnumbered) and unstarred
10154 (numbered) versions.
10155 These same environments are provided only in the starred versions by the
10157 \begin_inset Flex Code
10160 \begin_layout Plain Layout
10169 \begin_layout Theorem
10170 This is typically used for the statements of major results.
10174 \begin_layout Corollary*
10175 This is used for statements which follow fairly directly from previous statement
10177 Again, these can be major results.
10181 \begin_layout Lemma
10182 These are smaller results needed to prove other statements.
10185 \begin_layout Proposition
10186 These are less major results which (hopefully) add to the general theory
10190 \begin_layout Conjecture
10191 These are statements provided without justification, which the author does
10192 not know how to prove, but which seem to be true (to the author, at least).
10195 \begin_layout Definition*
10196 Guess what this is for.
10197 The font is different for this environment than for the previous ones.
10201 \begin_layout Example*
10202 Used for examples illustrating proven results.
10205 \begin_layout Problem
10206 It's not really known what this is for.
10207 You should figure it out.
10210 \begin_layout Exercise*
10211 Write a description for this one.
10214 \begin_layout Remark
10215 This environment is also a type of theorem, usually a lesser sort of observation.
10218 \begin_layout Claim*
10219 Often used in the course of giving a proof of a larger result.
10223 Generally, these are used to break up long arguments, using specific instances
10229 The numbering scheme for cases is on its own, not together with other numbered
10234 \begin_layout Proof
10235 At the end of this environment, a QED symbol (usually a square, but it can
10236 vary with different styles) is placed.
10237 If you want to have other environments within this one—for example, Case
10238 environments—and have the QED symbol appear only after them, then the other
10239 environments need to be nested within the proof environment.
10242 Nesting Environments
10248 for information on nesting.
10251 \begin_layout Standard
10252 And these environments are provided by
10253 \begin_inset Flex Code
10256 \begin_layout Plain Layout
10257 Theorems (AMS-Extended)
10265 \begin_layout Criterion*
10266 A required condition.
10269 \begin_layout Algorithm*
10270 A general procedure to be used.
10273 \begin_layout Axiom*
10274 This is a property or statement taken as true within the system being discussed.
10277 \begin_layout Condition*
10278 Sometimes used to state a condition assumed within the present context of
10282 \begin_layout Note*
10283 Similar to a Remark.
10286 \begin_layout Notation*
10287 Used for the explanation of, yes, notation.
10290 \begin_layout Summary
10291 Do we really need to tell you?
10294 \begin_layout Acknowledgement*
10298 \begin_layout Conclusion*
10299 Sometimes used at the end of a long train of argument.
10303 Used in a way similar to Proposition, though perhaps lower on the scale.
10306 \begin_layout Standard
10307 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10310 They need to be available on your system in order to use these environments.
10313 \begin_layout Section
10321 \begin_layout Standard
10327 \begin_layout Subsection
10331 \begin_layout Standard
10332 These are the layout files for some of the journals of the American Geophysical
10334 It is assumed that you have both the AGU's own class files and AGUplus
10335 installed (everything to be found at
10336 \begin_inset Flex URL
10339 \begin_layout Plain Layout
10341 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10349 \begin_layout Subsection
10353 \begin_layout Standard
10363 They are still called this in the \SpecialChar LyX
10364 GUI, though their \SpecialChar LaTeX
10377 \begin_layout Standard
10378 Newly defined styles are
10415 These are mostly manuscript attributes and defined in the AGU class documentati
10419 \begin_layout Standard
10420 I suspect this is still badly incomplete.
10423 \begin_layout Subsection
10427 \begin_layout Standard
10444 \begin_layout Subsection
10448 \begin_layout Itemize
10451 Journal of Geophysical Research
10460 \begin_layout Standard
10461 Add your own, it isn't so hard! Look at the
10472 \begin_layout Subsection
10473 Bugs and things to remember
10476 \begin_layout Standard
10477 In order to use the new layouts, you must remember to do the following for
10481 \begin_layout Enumerate
10487 This can be done in the
10489 Layout\SpecialChar menuseparator
10494 Document\SpecialChar menuseparator
10498 (AGU articles are always in English, right? So
10502 choose a language.)
10505 \begin_layout Enumerate
10510 into the document's
10515 (Yes, this is a bug.)
10518 \begin_layout Enumerate
10519 Make sure you use the
10523 bibliography style, by entering
10527 into the second field of the Bib\SpecialChar TeX
10529 None of the standard styles will do.
10532 \begin_layout Section
10536 \begin_layout Standard
10542 \begin_layout Subsection
10546 \begin_layout Standard
10547 Broadway is for writing plays.
10548 The format is more decorative than Hollywood, and much less standardized.
10549 This format should be suitable for workshops.
10552 \begin_layout Subsection
10556 \begin_layout Standard
10557 The same as in Hollywood.
10560 \begin_layout Subsection
10564 \begin_layout Standard
10569 names as labels then cross-reference the label to insert the name.
10570 The cross-reference dialog will show the current cast of characters.
10573 \begin_layout Subsection
10574 Paper size and Margins
10577 \begin_layout Standard
10578 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10581 \begin_layout Subsection
10585 \begin_layout Standard
10586 The following environments are available.
10587 You can use broadway.bind to get the bind keys shown at the right.
10590 \begin_layout Itemize
10594 \begin_inset Newline newline
10599 You should not have to use this, but it is here for anything that does not
10603 \begin_layout Itemize
10607 \begin_inset space \hfill{}
10611 \begin_inset Newline newline
10616 Used to describe stage setting and the action.
10617 First use of speaker names in all CAPs.
10620 \begin_layout Itemize
10624 \begin_inset space \hfill{}
10628 \begin_inset Newline newline
10633 Automatically numbered.
10634 On screen it will be arabic, but will print as Roman.
10637 \begin_layout Itemize
10641 \begin_inset space \hfill{}
10645 \begin_inset Newline newline
10655 It is just centered text.
10658 \begin_layout Itemize
10662 \begin_inset space \hfill{}
10666 \begin_inset Newline newline
10671 Not automatically numbered.
10672 You supply the number.
10673 This is because I couldn't figure out how.
10676 \begin_layout Itemize
10680 \begin_inset space \hfill{}
10684 \begin_inset Newline newline
10689 A special case of Narrative to describe the setting and action as the curtain
10693 \begin_layout Itemize
10697 \begin_inset space \hfill{}
10701 \begin_inset Newline newline
10706 The speaker's (actor's) title, centered in all CAPS.
10709 \begin_layout Itemize
10713 \begin_inset space \hfill{}
10717 \begin_inset Newline newline
10722 Instructions to the speaker.
10723 The parentheses are automatically inserted.
10724 The ( will appear on screen, but both will be in the printed play.
10725 This environment is only used within
10732 \begin_layout Itemize
10736 \begin_inset space \hfill{}
10740 \begin_inset Newline newline
10745 What the Speaker says.
10748 \begin_layout Itemize
10752 \begin_inset space \hfill{}
10756 \begin_inset Newline newline
10761 The curtain comes down.
10764 \begin_layout Itemize
10768 \begin_inset space \hfill{}
10774 \begin_layout Itemize
10778 \begin_inset space \hfill{}
10784 \begin_layout Itemize
10788 \begin_inset space \hfill{}
10794 \begin_layout Standard
10798 \begin_layout Section
10802 \begin_layout Standard
10807 can be used to type letters according to German conventions.
10808 A template file is included in
10810 .../lyx/share/templates
10812 for you to use as a starting point.
10815 \begin_layout Section
10823 \begin_layout Standard
10829 \begin_layout Subsection
10833 \begin_layout Standard
10834 This is the layout file for the European Geophysical Society journals.
10839 can be downloaded from the web site of the EGS under
10840 \begin_inset Flex URL
10843 \begin_layout Plain Layout
10853 \begin_layout Subsection
10857 \begin_layout Standard
10860 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10868 The current layout file is unfortunately very unmodular and would benefit
10869 from using the various
10876 \begin_layout Section
10880 \begin_layout Standard
10881 See the \SpecialChar LyX
10887 It contains all infos you need.
10890 \begin_layout Section
10893 Foil\SpecialChar TeX
10897 \begin_inset CommandInset label
10906 \begin_layout Standard
10912 \begin_layout Subsection
10916 \begin_layout Standard
10917 This section describes how to use \SpecialChar LyX
10918 to make slides for overhead projectors.
10919 There are two document classes that can do this: the default slides class
10922 Foil\SpecialChar TeX
10926 This section documents the latter.
10929 \begin_layout Standard
10930 I'm going to say this again, nice and clear, so that there's no misunderstanding
10934 \begin_layout Standard
10935 \begin_inset VSpace bigskip
10941 \begin_layout Standard
10945 This section documents the class
10946 \begin_inset Quotes eld
10954 \begin_inset Quotes erd
10962 \begin_layout Standard
10963 \begin_inset VSpace bigskip
10969 \begin_layout Standard
10970 If you're looking for the documentation for
10971 \begin_inset Quotes eld
10979 \begin_inset Quotes erd
10982 , check out section
10983 \begin_inset space ~
10987 \begin_inset CommandInset ref
10989 reference "sec:slitex"
10994 If your machine doesn't have the
11002 installed, you'll probably have to use the default
11006 class, which isn't quite as good as
11011 \begin_layout Standard
11016 class is designed for use with version
11017 \begin_inset space ~
11025 class file which is now an integral part of \SpecialChar LaTeX2e
11029 \begin_layout Subsection
11033 \begin_layout Standard
11034 Obviously, to use this document class, you need to select
11045 \begin_inset space ~
11051 There are some settings in the
11054 \begin_inset space ~
11059 dialog that you should know about that are specific to this class:
11062 \begin_layout Itemize
11063 Don't change the options
11074 \begin_inset space ~
11080 They're ignored by the
11087 \begin_layout Itemize
11088 The default font size is 20
11089 \begin_inset space \thinspace{}
11092 pt with the other options being 17
11093 \begin_inset space \thinspace{}
11097 \begin_inset space \thinspace{}
11101 \begin_inset space \thinspace{}
11107 \begin_layout Itemize
11108 The default font is
11116 but all math equations are still typeset in the usual roman font.
11119 \begin_layout Itemize
11122 Foil\SpecialChar TeX
11125 supports A4 and Letter paper sizes as well as a special size for working
11127 \begin_inset space \thinspace{}
11131 It doesn't support A5, B5, legal or executive paper sizes.
11134 \begin_layout Itemize
11135 Don't bother changing the
11139 settings because they are ignored anyway.
11140 All floats appear where they are defined in the text.
11143 \begin_layout Itemize
11148 setting behaves a bit differently for this class.
11151 Foil\SpecialChar TeX
11154 provides extensive footer and header capabilities including a user-defined
11157 \begin_inset space ~
11161 \begin_inset CommandInset ref
11163 reference "sec:foilfoot"
11168 The title page is treated differently to all other pages in the document
11177 has the logo centered at the bottom of the page (if one is defined).
11178 The possible page style choices and what they do are as follows:
11182 \begin_layout Labeling
11183 \labelwidthstring MMMMMMM
11190 The final output contains no page numbers, or other headers or footers
11191 (except footnotes of course).
11195 \begin_layout Labeling
11196 \labelwidthstring MMMMMMM
11203 The final output contains page numbers centered at the bottom of the page.
11204 No other headings or footers (other than footnotes).
11207 \begin_layout Labeling
11208 \labelwidthstring MMMMMMM
11213 Page numbers in lower right corner.
11214 Additional headers and footers are also shown.
11215 This is also the default.
11218 \begin_layout Labeling
11219 \labelwidthstring MMMMMMM
11224 Gives you access to the
11228 package although its use with
11230 Foil\SpecialChar TeX
11233 is discouraged by the writer of the
11235 Foil\SpecialChar TeX
11238 package because of some potential page layout clashes.
11242 \begin_layout Subsubsection
11246 \begin_layout Standard
11247 The following options may be used in the extra class options in the
11249 Document\SpecialChar menuseparator
11255 \begin_layout Labeling
11256 \labelwidthstring MMMMMMx
11261 This sets up the page layout for 7.33
11262 \begin_inset space \thinspace{}
11266 \begin_inset space \thinspace{}
11269 in paper, which is about the same aspect ratio as a 35
11270 \begin_inset space \thinspace{}
11273 mm slide, making it a bit easier to work with this medium.
11276 \begin_layout Labeling
11277 \labelwidthstring MMMMMMx
11282 Places a rule across the page below the header on every page except the
11286 \begin_layout Labeling
11287 \labelwidthstring MMMMMMx
11292 Places a rule across the page above the footer on every page except the
11296 \begin_layout Labeling
11297 \labelwidthstring MMMMMMx
11302 This is automatically set each time you create a new
11309 Foil\SpecialChar TeX
11312 to use the dvips driver to rotate those pages that are set as landscape
11316 \begin_layout Labeling
11317 \labelwidthstring MMMMMMx
11322 Simply changes the page dimensions to those of a landscape page but doesn't
11324 Thus if you use this option you need to use an external program to rotate
11325 each page or feed your paper through your printer as landscape.
11326 Note that this option effectively reverses the roles of the
11334 environments (don't worry these are described in the next section).
11337 \begin_layout Labeling
11338 \labelwidthstring MMMMMMx
11343 Equation numbers on the left.
11346 \begin_layout Labeling
11347 \labelwidthstring MMMMMMx
11352 Flush-left equations.
11355 \begin_layout Subsection
11356 Supported Environments
11359 \begin_layout Standard
11360 Most of the environments commonly supported in other classes are also supported
11366 There are several additional environments provided by
11368 Foil\SpecialChar TeX
11371 as well as a couple added by \SpecialChar LyX
11373 The following environments are shared with other classes:
11376 \begin_layout Standard
11377 \begin_inset Flex Multiple Columns
11380 \begin_layout Itemize
11386 \begin_layout Itemize
11392 \begin_layout Itemize
11398 \begin_layout Itemize
11404 \begin_layout Itemize
11410 \begin_layout Itemize
11417 \begin_layout Itemize
11423 \begin_layout Itemize
11429 \begin_layout Itemize
11435 \begin_layout Itemize
11441 \begin_layout Itemize
11447 \begin_layout Itemize
11453 \begin_layout Itemize
11459 \begin_layout Itemize
11465 \begin_layout Itemize
11471 \begin_layout Itemize
11477 \begin_layout Itemize
11483 \begin_layout Itemize
11494 \begin_layout Standard
11495 That is, all the major environments apart from the sectioning environments.
11496 Since foils are essentially self-contained sections, with a title and body,
11499 Foil\SpecialChar TeX
11502 provides specific commands for starting new foils and these are:
11505 \begin_layout Itemize
11511 \begin_layout Itemize
11517 \begin_layout Standard
11519 also provides slightly modified versions of these two environments called:
11522 \begin_layout Itemize
11528 \begin_layout Itemize
11531 ShortRotatefoilhead
11534 \begin_layout Standard
11535 and the differences will be explained in the next section.
11538 \begin_layout Standard
11539 Since foils are often used in presenting ideas or new theorems and such
11542 Foil\SpecialChar TeX
11545 also provides a comprehensive box of goodies for presenting them:
11548 \begin_layout Standard
11549 \begin_inset Flex Multiple Columns
11552 \begin_layout Itemize
11558 \begin_layout Itemize
11564 \begin_layout Itemize
11570 \begin_layout Itemize
11576 \begin_layout Itemize
11582 \begin_layout Itemize
11588 \begin_layout Itemize
11594 \begin_layout Itemize
11600 \begin_layout Itemize
11606 \begin_layout Itemize
11612 \begin_layout Itemize
11623 \begin_layout Standard
11624 The starred versions are unnumbered while the unstarred versions are numbered.
11625 There are also two list environments added by \SpecialChar LyX
11629 \begin_layout Itemize
11635 \begin_layout Itemize
11641 \begin_layout Standard
11644 Foil\SpecialChar TeX
11647 provides some powerful header and footer capabilities that are best set
11648 in the preamble although they may be set at any point in a document.
11649 If you want to change these settings in your document the best place to
11650 do so is at the very top of a foil, i.
11651 \begin_inset space \thinspace{}
11657 \begin_inset space \space{}
11662 straight after the foilhead.
11665 \begin_layout Standard
11666 For this purpose, the following command styles are provided [
11673 \begin_layout Standard
11674 \begin_inset Flex Multiple Columns
11677 \begin_layout Itemize
11681 \begin_inset space ~
11687 \begin_layout Itemize
11693 \begin_layout Itemize
11697 \begin_inset space ~
11703 \begin_layout Itemize
11707 \begin_inset space ~
11713 \begin_layout Itemize
11717 \begin_inset space ~
11724 \begin_layout Plain Layout
11725 \begin_inset space ~
11737 \begin_layout Standard
11738 There are also a few commands provided by
11740 Foil\SpecialChar TeX
11743 that aren't directly supported by \SpecialChar LyX
11744 but I'll tell you what they do and how
11745 to use them in section
11746 \begin_inset space ~
11750 \begin_inset CommandInset ref
11752 reference "sec:unsuppfoils"
11759 \begin_layout Subsection
11760 Building a Set of Foils
11763 \begin_layout Standard
11764 This section will give a simple introduction to using the different environments
11765 to build a set of foils.
11766 If you want to see an example set of foils, take a look at the
11770 file you find in \SpecialChar LyX
11778 \begin_layout Subsubsection
11779 Give It a Title Page
11782 \begin_layout Standard
11783 Unlike other classes that provide
11803 creates the title on a page of its own.
11804 If you leave out the
11808 environment \SpecialChar LaTeX
11809 will substitute the current date (every time you regenerate
11813 \begin_layout Subsubsection
11817 \begin_layout Standard
11818 As I mentioned earlier, there are four ways of starting a new foil.
11819 For portrait foils you should use
11828 The difference between these two environments is the amount of space between
11829 the title of the foil (the foilhead) and the body of the foil.
11832 \begin_layout Standard
11833 Landscape foils are generated using the
11839 ShortRotatefoilhead
11842 Again the only difference is the spacing between foilhead and body.
11843 Both of the short versions have 0.5
11844 \begin_inset space ~
11847 inches less separation between the foilhead and the body.
11851 \begin_layout Standard
11852 One problem with the support for landscape foils is the requirement that
11853 you have to use the
11857 driver to generate the PostScript output otherwise the foils won't be rotated.
11858 It is possible to get landscape foils even if you haven't got the
11862 driver provided you can feed your foils sideways through your printer ;-)
11865 \begin_layout Subsubsection
11866 Theorems, Lemmas, Proofs and more
11869 \begin_layout Standard
11870 Due to a small bug in \SpecialChar LyX
11871 you can't have two of the same type of these environments
11872 directly following each other.
11873 They must be separated by something.
11874 If you try, you will just be extending the previous environment as if you
11875 had merged the two environments together.
11876 So, how do you get around this problem? The simplest option is to insert
11877 some text between the two environments or add a
11882 environment between the two with just a
11883 \begin_inset Quotes eld
11891 \begin_inset Quotes erd
11895 This will force \SpecialChar LyX
11896 to produce two separate environments and hence the correct
11899 An example is provided in the example file included with the \SpecialChar LyX
11901 Remember, this problem only occurs if you are trying to place two of the
11902 same type of theorem-like environments one directly after the other.
11905 \begin_layout Subsubsection
11909 \begin_layout Standard
11910 You get all the commonly supported list styles found in other classes as
11911 well as two new ones.
11912 I'll only describe the new ones here.
11913 If you want to find out more about the other list environments check out
11919 If you intend to use itemized lists you might also want to read about the
11923 \begin_inset space ~
11927 \begin_inset space ~
11932 dialog described above in section
11933 \begin_inset space ~
11937 \begin_inset CommandInset ref
11939 reference "sec:bullet"
11946 \begin_layout Standard
11947 The two new list styles,
11955 , are designed to make it easier for you to create lists of do's and don'ts
11956 or right and wrong by providing dedicated environments that use a tick
11957 or a cross as the label of the list.
11958 These lists are in fact dedicated variants of the
11963 They do however require that you have the
11967 packages installed.
11970 \begin_layout Subsubsection
11974 \begin_layout Standard
11977 Foil\SpecialChar TeX
11980 redefines the floating tables and figures so that they appear exactly where
11981 they are in the text rather than pushing them to the top of the page or
11982 to some user specified location.
11983 In fact if you change the float placement settings they are simply ignored.
11986 \begin_layout Subsubsection
11987 Page Headers and Footers
11988 \begin_inset CommandInset label
11990 name "sec:foilfoot"
11997 \begin_layout Standard
12001 \begin_inset space ~
12010 are two commands used to control the left-footer text string.
12011 The first is meant to allow you to include a graphic logo on your foils
12013 \begin_inset Quotes eld
12018 Foil\SpecialChar TeX
12022 \begin_inset Quotes erd
12026 While the second is meant to provide a classification for the audience,
12030 \begin_inset space \thinspace{}
12036 \begin_inset space \space{}
12040 It is empty by default.
12043 \begin_layout Standard
12044 The remaining page corners can be filled by
12047 \begin_inset space ~
12052 (which defaults to page numbers),
12055 \begin_inset space ~
12063 \begin_inset space ~
12071 \begin_layout Subsection
12074 Foil\SpecialChar TeX
12078 \begin_inset CommandInset label
12080 name "sec:unsuppfoils"
12087 \begin_layout Standard
12088 All the commands mentioned below need to be set in a
12098 within another environment.
12101 \begin_layout Subsubsection
12105 \begin_layout Standard
12106 All lengths are adjusted using the
12129 should be replaced by the name given to the length you want to change and
12134 is the length value.
12135 All lengths should be specified in units of length such as inches (
12147 ) or relative to some document or font-based length such as
12157 \begin_layout Standard
12158 It's possible to change the spacing between a foilhead and the body of the
12159 foil by adjusting the length specified by
12166 For example, to make
12171 \begin_inset space \space{}
12174 in closer to their bodies put the following in the preamble:
12180 foilheadskip}{-0.5in}
12183 \begin_layout Standard
12184 The spacings around floats can be adjusted by setting these lengths:
12187 \begin_layout Labeling
12188 \labelwidthstring MMMMMMMMMMM
12195 Separation between the text and the top of the float
12198 \begin_layout Labeling
12199 \labelwidthstring MMMMMMMMMMM
12206 Separation between the float and the caption
12209 \begin_layout Labeling
12210 \labelwidthstring MMMMMMMMMMM
12217 Separation between the caption and the following text
12220 \begin_layout Labeling
12221 \labelwidthstring MMMMMMMMMMM
12228 You can make the captions narrower than the surrounding text by adjusting
12230 Best done relative to
12239 \begin_layout Standard
12240 There are also several title page related lengths that you may find useful
12241 if you have a long title or several authors:
12244 \begin_layout Labeling
12245 \labelwidthstring MMMMMMMMMMM
12252 Separation from headers to
12257 \begin_layout Labeling
12258 \labelwidthstring MMMMMMMMMMM
12276 \begin_layout Labeling
12277 \labelwidthstring MMMMMMMMMMM
12291 \begin_layout Labeling
12292 \labelwidthstring MMMMMMMMMMM
12308 \begin_layout Labeling
12309 \labelwidthstring MMMMMMMMMMM
12325 \begin_layout Standard
12326 The last length related command affects all the list environments.
12337 a list environment then all the vertical spacing between the list items
12339 Note that this is a command not a length so it doesn't require
12345 like the stuff mentioned above.
12348 \begin_layout Subsubsection
12349 Headers and Footers
12352 \begin_layout Standard
12365 commands control whether the logo in the
12369 definition appear on a given page.
12376 in the preamble then none of the foils will have the logo on them.
12377 If you don't want the logo on a particular page place the
12383 directly after the foilhead of that page and the
12389 directly after the next foilhead.
12392 \begin_layout Standard
12393 If you decide to use the
12397 page style setting in the
12400 \begin_inset space ~
12405 dialog you should probably add
12415 to your preamble so headers and footers on landscape pages are correctly
12416 placed when rotated.
12417 This is due to some clashes between the page layouts provided by the
12428 \begin_layout Section
12429 Hollywood (Hollywood spec scripts)
12432 \begin_layout Standard
12438 \begin_layout Subsection
12442 \begin_layout Standard
12443 Getting the format of a Hollywood script right is a
12444 \begin_inset Quotes eld
12448 \begin_inset Quotes erd
12451 It is designed to make the readers focus on content and to be easy and
12452 familiar for the actors to read.
12453 Each page of a script should be one minute of film.
12454 Nothing goes in a script that you cannot see or hear on screen.
12455 The courier 12 pt font should be used throughout.
12459 \begin_layout Subsection
12463 \begin_layout Standard
12464 Speakers' lines should NEVER break in mid-sentence.
12465 If a speaker's lines continue over a page break, repeat the
12469 title followed by (Cont'd).
12472 \begin_layout Subsection
12476 \begin_layout Standard
12481 names as labels then cross-reference the label to insert the name.
12482 The cross-reference dialog will show the current cast of characters.
12483 You can use this to insert the speaker name in narratives also.
12486 \begin_layout Subsection
12487 Paper size and Margins
12490 \begin_layout Standard
12491 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12494 \begin_layout Subsection
12498 \begin_layout Standard
12499 The following environments are available.
12500 You can use hollywood.bind to get the bind keys shown at the right.
12503 \begin_layout Itemize
12507 \begin_inset Newline newline
12512 Used where nothing else works.
12516 \begin_layout Itemize
12522 \begin_inset space \hfill{}
12530 \begin_inset Newline newline
12533 Usually followed by something like
12534 \begin_inset Quotes eld
12537 on Sally waking up.
12538 \begin_inset Quotes erd
12544 \begin_layout Itemize
12548 \begin_inset space \hfill{}
12552 \begin_inset Newline newline
12557 Introduces a new INTERIOR camera set-up.
12558 Always followed by DAY or NIGHT, or something similar to define the lighting
12560 Everthing on this line in CAPS.
12563 \begin_layout Itemize
12567 \begin_inset space \hfill{}
12571 \begin_inset Newline newline
12576 Introduces a new EXTERIOR camera set-up.
12577 Everthing on this line in CAPS.
12580 \begin_layout Itemize
12584 \begin_inset space \hfill{}
12588 \begin_inset Newline newline
12593 The character speaking.
12596 \begin_layout Itemize
12600 \begin_inset space \hfill{}
12604 \begin_inset Newline newline
12609 Instructions to the speaker.
12610 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12612 Both will be printed.
12615 \begin_layout Itemize
12619 \begin_inset space \hfill{}
12623 \begin_inset Newline newline
12635 \begin_layout Itemize
12639 \begin_inset space \hfill{}
12643 \begin_inset Newline newline
12648 Camera movement instruction.
12650 \begin_inset space \thinspace{}
12654 \begin_inset space \space{}
12660 \begin_layout Itemize
12664 \begin_inset space \hfill{}
12670 \begin_layout Itemize
12674 \begin_inset space \hfill{}
12680 \begin_layout Itemize
12684 \begin_inset space \hfill{}
12690 \begin_layout Itemize
12694 \begin_inset space \hfill{}
12700 \begin_layout Subsection
12704 \begin_layout Itemize
12708 \begin_layout Itemize
12712 \begin_layout Itemize
12714 \begin_inset space \thinspace{}
12721 \begin_layout Itemize
12726 \begin_layout Itemize
12727 PAN — camera movement
12730 \begin_layout Itemize
12731 INSERT — cut to close-up of
12734 \begin_layout Section
12738 \begin_layout Standard
12741 Panayotis Papasotiriou
12744 \begin_layout Subsection
12748 \begin_layout Standard
12749 The ijmpc package is a set of macros that facilitates electronic manuscript
12752 International Journal of Modern Physics C
12755 Similarly, the ijmpd package is for creating manuscripts to be submitted
12758 International Journal of Modern Physics D
12761 Both journals are published by World Scientific.
12762 The corresponding document classes are named
12771 These files, together with instructions for the authors, can be downloaded
12773 \begin_inset Flex URL
12776 \begin_layout Plain Layout
12778 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12784 \begin_inset Flex URL
12787 \begin_layout Plain Layout
12789 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12795 Both packages are modified versions of the standard
12796 \begin_inset Quotes eld
12800 \begin_inset Quotes erd
12803 package, and they are almost (but not exactly) identical.
12804 Most of their features are supported by \SpecialChar LyX
12806 I have used \SpecialChar LyX
12807 successfully to write articles submitted to both journals
12808 without any problem.
12811 \begin_layout Subsection
12815 \begin_layout Standard
12816 As usual, the easiest way to write a paper is to start with a template.
12819 File\SpecialChar menuseparator
12835 This will give an (almost) empty document that includes the most common
12836 fields found in a manuscript.
12837 Simply overwrite the existing text (including the brackets,
12842 You should keep in mind the following remarks.
12845 \begin_layout Enumerate
12847 won't let you change the font size and the page style of the document,
12848 because such modifications are not allowed by both packages.
12851 \begin_layout Enumerate
12852 The language of the document should not be changed.
12853 Before previewing your paper, be sure that the babel package is not used.
12854 To do this, click on
12856 Tools\SpecialChar menuseparator
12867 checkbox in the language settings, and click on
12875 , if you wish to make this change permanent).
12878 \begin_layout Enumerate
12880 \begin_inset Quotes eld
12884 \begin_inset Quotes erd
12887 style must be used to define keywords.
12890 \begin_layout Enumerate
12891 The ijmpc package provides a style named
12892 \begin_inset Quotes eld
12895 Classification Codes
12896 \begin_inset Quotes erd
12899 , which can be used to define classification codes, such as PACS numbers.
12900 Note that this facility is not supported by the ijmpd package.
12903 \begin_layout Enumerate
12904 Several new environments are available:
12905 \begin_inset Quotes eld
12909 \begin_inset Quotes erd
12913 \begin_inset Quotes eld
12917 \begin_inset Quotes erd
12921 \begin_inset Quotes eld
12925 \begin_inset Quotes erd
12929 \begin_inset Quotes eld
12933 \begin_inset Quotes erd
12937 \begin_inset Quotes eld
12941 \begin_inset Quotes erd
12945 \begin_inset Quotes eld
12949 \begin_inset Quotes erd
12953 \begin_inset Quotes eld
12957 \begin_inset Quotes erd
12961 \begin_inset Quotes eld
12965 \begin_inset Quotes erd
12969 \begin_inset Quotes eld
12973 \begin_inset Quotes erd
12977 \begin_inset Quotes eld
12981 \begin_inset Quotes erd
12985 \begin_inset Quotes eld
12989 \begin_inset Quotes erd
12993 \begin_inset Quotes eld
12997 \begin_inset Quotes erd
13001 \begin_inset Quotes eld
13005 \begin_inset Quotes erd
13009 \begin_inset Quotes eld
13013 \begin_inset Quotes erd
13017 Their use is more or less obvious.
13019 supports all these environments; it will use the proper label, text style,
13020 and numbering scheme for each of them.
13023 \begin_layout Enumerate
13024 Both packages use basic citations; the natbib package should not be used.
13025 In \SpecialChar LyX
13026 , citation references are shown as usual; in the output, citations are
13027 shown as superscripts.
13028 If you want to use a citation as normal text, you should use the
13033 \begin_inset space \thinspace{}
13037 \begin_inset space \space{}
13041 \begin_inset Quotes eld
13045 \begin_inset space \space{}
13055 \begin_inset Quotes erd
13061 \begin_layout Enumerate
13063 \begin_inset Quotes eld
13067 \begin_inset Quotes erd
13070 section in both packages.
13071 To put acknowledgments, just use the
13072 \begin_inset Quotes eld
13076 \begin_inset Quotes erd
13082 \begin_layout Enumerate
13083 Appendices may be added to the paper,
13087 the Acknowledgments and
13093 provides a special environment, called
13094 \begin_inset Quotes eld
13098 \begin_inset Quotes erd
13101 which marks the beginning of the appendices.
13102 This environment should be left blank; it just sends a \SpecialChar LaTeX
13103 command, but nothing
13105 In \SpecialChar LyX
13107 \begin_inset Quotes eld
13111 \begin_inset Quotes erd
13114 is printed with blue letters, as a signal that all sections after that
13115 point are appendices.
13116 To write an appendix, use the
13117 \begin_inset Quotes eld
13121 \begin_inset Quotes erd
13126 will number each appendix with capital letters, as required by both journals.
13128 \begin_inset Quotes eld
13132 \begin_inset Quotes erd
13139 be present before the first appendix; if not, all appendices will be numbered
13140 as normal sections in the output.
13143 \begin_layout Enumerate
13144 The ijmpc and the ijmpd packages use the
13148 command to implement table captions.
13149 As a result, a table created by \SpecialChar LyX
13150 is printed correctly, but its caption
13152 However, you can use some \SpecialChar TeX
13153 code to overcome this problem, so that captions
13154 are printed as expected.
13155 To do so, create a float table as usual, remove the caption, and replace
13156 it with the \SpecialChar TeX
13167 (sic); you must also the \SpecialChar TeX
13172 immediately after the tabular material.
13173 Study the example table included in the template files to see how this
13174 trick is implemented.
13175 Alternatively, If you need table captions, you should implement the whole
13180 file, then include this file to the \SpecialChar LyX
13183 Insert\SpecialChar menuseparator
13184 File\SpecialChar menuseparator
13186 \begin_inset space ~
13192 Details on how to create a table float can be found in the files
13200 , included in the corresponding packages.
13203 \begin_layout Subsection
13204 Preparing a paper for submission
13207 \begin_layout Standard
13208 Before you submit your paper you must export the \SpecialChar LyX
13209 document as a \SpecialChar LaTeX
13212 File\SpecialChar menuseparator
13213 Export\SpecialChar menuseparator
13221 \begin_layout Plain Layout
13222 Actually you have the choice between \SpecialChar LaTeX
13223 (plain) and pdflatex.
13224 If you intend to use pdflatex to prepare the paper, you should use the
13225 pdflatex option so that included graphics are converted to PDF format,
13226 ready for use by pdflatex.
13231 , then make the following changes to the resulting
13238 \begin_layout Enumerate
13239 Remove the comment lines before the
13248 \begin_layout Enumerate
13249 Remove everything between (and including) the
13261 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13265 \begin_layout Standard
13270 file should be saved and processed through \SpecialChar LaTeX
13271 as many times as necessary.
13272 You may also want to check the resulting
13279 \begin_layout Subsection
13280 Use of \SpecialChar TeX
13284 \begin_layout Standard
13285 The use of \SpecialChar TeX
13286 code is reduced to two commands, which must be placed at the
13287 top of the document.
13288 If you started writing your paper by using the
13296 template, the \SpecialChar TeX
13297 code needed is already in its place; you usually don't need
13299 You may only modify the first \SpecialChar TeX
13300 code to specify the information printed
13301 to the top of odd and even pages (authors' names and short paper's title,
13303 This \SpecialChar TeX
13304 code must have the form
13308 markboth{Authors' Names}{Short Paper's Title}
13313 \begin_layout Section
13317 \begin_layout Standard
13323 \begin_layout Subsection
13327 \begin_layout Standard
13328 The iopart package provides a document class to create electronic manuscript
13329 submission to the journals published by the Institute of Physics.
13330 Instructions for the authors how to create a paper using the iopart class
13331 can be downloaded together with the iopart package from the site
13332 \begin_inset Flex URL
13335 \begin_layout Plain Layout
13337 ftp://ftp.iop.org/pub/journals/latex2e
13345 \begin_layout Subsection
13349 \begin_layout Standard
13350 The easiest way to write a paper is to start with the file
13354 that is available in \SpecialChar LyX
13355 's examples files folder.
13356 Open this file, save it under a new name, and start writing.
13357 The example file explains how to use the special text environments.
13358 Here are the most important advices:
13361 \begin_layout Itemize
13362 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13365 Use AMS math package
13367 in the document settings under
13374 \begin_layout Itemize
13377 The title environment defines the kind of your paper.
13378 So use one of the following environments for the title:
13382 \begin_layout Itemize
13391 \begin_layout Itemize
13400 \begin_layout Itemize
13406 for a Topical review
13409 \begin_layout Itemize
13418 \begin_layout Itemize
13427 \begin_layout Itemize
13433 for a Paper (same as Title)
13436 \begin_layout Itemize
13442 for a Preliminary communication
13445 \begin_layout Itemize
13451 for a Rapid communication
13454 \begin_layout Itemize
13460 for a Letter to the editor
13464 \begin_layout Itemize
13467 All title environments except of
13471 can have an optional short title.
13474 \begin_layout Itemize
13475 There is a general title environment
13479 which is not directly supported by the \SpecialChar LyX
13481 This can be used as \SpecialChar TeX
13482 code when your document doesn't fit into one of the
13486 \begin_layout Standard
13487 For more informations like hints for special table and formula formatting,
13488 look at the IOP author guidelines.
13491 \begin_layout Section
13495 \begin_layout Standard
13498 Panayotis Papasotiriou
13501 \begin_layout Subsection
13505 \begin_layout Standard
13506 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13507 that facilitates electronic manuscript submission to the journals they
13509 Most known of them (at least in my domain of interest) are
13511 Astrophysics and Space Science
13517 , but there are many others (see a complete list at
13518 \begin_inset Flex URL
13521 \begin_layout Plain Layout
13523 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13529 The Kluwer package may be downloaded from the site
13530 \begin_inset Flex URL
13533 \begin_layout Plain Layout
13535 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13541 A complete user guide is contained in that package (but it can also be
13542 downloaded separately).
13545 \begin_layout Standard
13547 supports many features of the package but not everything.
13548 However, the \SpecialChar TeX
13549 code needed is reduced to some
13550 \begin_inset Quotes eld
13554 \begin_inset Quotes erd
13557 commands of the package (see
13558 \begin_inset space ~
13562 \begin_inset CommandInset ref
13564 reference "subsec:kluwer_peculiarities"
13569 I have recently used \SpecialChar LyX
13570 to write an article submitted to the
13572 Astrophysics and Space Science
13574 without any problem.
13577 \begin_layout Subsection
13581 \begin_layout Standard
13582 The easiest way to write a paper is to start with the Kluwer template file.
13585 File\SpecialChar menuseparator
13597 This will give an (almost) empty document that includes the most common
13598 fields found in a manuscript and a short description of their use.
13599 As in most templates, simply overwrite the existing text (including the
13604 ) with the correct information.
13607 \begin_layout Subsection
13608 Preparing a paper for submission
13611 \begin_layout Standard
13612 As in the AAS\SpecialChar TeX
13613 package, before you submit your paper to a journal you must
13615 \begin_inset Quotes eld
13619 \begin_inset Quotes erd
13625 \begin_layout Enumerate
13626 Export your paper as a \SpecialChar LaTeX
13628 To do this, click on
13630 File\SpecialChar menuseparator
13631 Export\SpecialChar menuseparator
13639 \begin_layout Enumerate
13644 file with a text editor and make the following changes
13648 \begin_layout Enumerate
13649 remove the comment lines before the
13658 \begin_layout Enumerate
13659 remove everything between (and including) the
13671 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13675 \begin_layout Standard
13684 \begin_layout Enumerate
13689 file through \SpecialChar LaTeX
13690 as many times as necessary (usually up to three).
13693 \begin_layout Enumerate
13699 \begin_inset space \thinspace{}
13703 \begin_inset space \space{}
13710 , and check if everything is OK (it should, if you didn't make any mistake).
13713 \begin_layout Subsection
13714 \begin_inset Quotes eld
13718 \begin_inset Quotes erd
13721 of the Kluwer package
13722 \begin_inset CommandInset label
13724 name "subsec:kluwer_peculiarities"
13731 \begin_layout Standard
13732 The Kluwer package has the following
13733 \begin_inset Quotes eld
13737 \begin_inset Quotes erd
13743 \begin_layout Enumerate
13744 It is possible to write multiple articles in the same \SpecialChar LaTeX
13749 \begin_layout Plain Layout
13750 I can't imagine any good reason to do this.
13756 Each article must be included in the environment
13757 \begin_inset Quotes eld
13761 \begin_inset Quotes erd
13765 Unfortunately, this environment cannot be omitted, even if you write just
13767 Therefore, each article starts with the command
13773 and, obviously, ends with the command
13780 Although this can be implemented in \SpecialChar LyX
13781 , I didn't included it, since it looks
13782 ugly and can confuse the novice user.
13783 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13786 \begin_inset Quotes eld
13791 \begin_inset Quotes erd
13797 \begin_layout Enumerate
13798 Information given at the beginning of the article (i.
13799 \begin_inset space \thinspace{}
13803 \begin_inset space \space{}
13806 title, subtitle, author, institution, running title, running author, abstract
13807 and keywords) must be included in an environment called
13808 \begin_inset Quotes eld
13812 \begin_inset Quotes erd
13816 This is not implemented in \SpecialChar LyX
13817 , so you must enter title, subtitle etc.
13818 \begin_inset space ~
13821 between two \SpecialChar TeX
13837 \begin_layout Enumerate
13838 According to the user manual, the label of each bibliography item must be
13862 \begin_layout Standard
13867 template takes care of all these
13868 \begin_inset Quotes eld
13872 \begin_inset Quotes erd
13876 If you start a new paper using this template you don't need to do anything
13881 \begin_layout Enumerate
13882 don't delete the \SpecialChar TeX
13883 code included in the template, and
13886 \begin_layout Enumerate
13887 copy the example bibliography item included in the template and modify it
13888 as necessary to enter new bibliography items.
13891 \begin_layout Section
13895 \begin_layout Standard
13901 \begin_layout Subsection
13905 \begin_layout Standard
13906 The \SpecialChar LyX
13909 article (koma-script)
13913 report (koma-script)
13931 correspond to the \SpecialChar LaTeX
13949 \begin_inset space ~
13952 of the Koma-Script family.
13953 They are replacements for the standard document classes
13969 , resp., and fit better to European typography conventions in a number of
13973 \begin_layout Itemize
13974 Standard character size is 11pt in
13976 article (koma-script)
13980 report (koma-script)
13988 letter (koma-script)
13993 \begin_layout Itemize
13994 Headings, labels of the description environment, and a number of elements
13997 letter (koma-script)
13999 document class are set in a bold sans serif font.
14003 \begin_layout Plain Layout
14004 There is a big difference between the bold sans serif old cm fonts and new
14005 ec fonts, especially in the appearance of headings.
14006 In comparison, the ec bold sans serif fonts look a bit thin.
14007 Here the \SpecialChar LaTeX
14016 helps to produce the
14017 \begin_inset Quotes eld
14021 \begin_inset Quotes erd
14024 appearance when using the ec fonts.
14029 The numbering of chapter headings is made in the same way as the numbering
14030 of section headings, that is without the extra line
14031 \begin_inset Quotes eld
14034 Chapter\SpecialChar ldots
14036 \begin_inset Quotes erd
14040 In addition, the appearance of the headings can be modified by using a
14041 number of options (in \SpecialChar LyX
14042 to be entered in the field
14045 \begin_inset space ~
14052 Layout\SpecialChar menuseparator
14059 \begin_layout Itemize
14060 The main means in the Koma-Script document classes to design the type area
14069 (in \SpecialChar LyX
14070 to be entered in the extra class options field in the dialog
14072 Document\SpecialChar menuseparator
14076 They make a clearer modification of page margins possible as do the options
14079 Document\SpecialChar menuseparator
14086 \begin_layout Itemize
14087 The \SpecialChar LaTeX
14088 document classes of the Koma-Script family define a number of additional
14090 Those part of it which makes sense in \SpecialChar LyX
14091 is implemented in corresponding
14095 \begin_layout Standard
14096 Detailed descriptions of the \SpecialChar LaTeX
14097 document classes of the Koma-Script family
14098 can be found in the Koma-Script documentation
14109 \begin_layout Subsection
14110 article (koma-script), report (koma-script), and book (koma-script)
14113 \begin_layout Standard
14114 The document classes
14116 article (koma-script)
14120 report (koma-script)
14130 are implemented in the layout files
14143 They contain all the paragraph types of the corresponding standard document
14156 , resp., partly modified, with the exception of the \SpecialChar LyX
14161 -type, which is replaced by the new
14165 -type having the same functionality.
14170 -Type there is a number of new paragraph types added.
14177 letter (koma-script)
14182 \begin_layout Itemize
14191 : are equivalents to
14199 , resp., additionally inserting an entry in the table of contents.
14208 are not contained in
14210 article (koma-script)
14215 \begin_layout Itemize
14224 : behave exactly as
14232 , resp., additionally clearing running heads.
14237 is not contained in
14239 article (koma-script)
14245 \begin_layout Plain Layout
14258 report (koma-script)
14260 , but since this is identical to
14264 , is has not been implemented in \SpecialChar LyX
14273 \begin_layout Itemize
14278 : generates a heading directly above the following paragraph in the standard
14279 character size without affecting the structure of the document.
14282 \begin_layout Itemize
14291 are special captions which respect the different space settings needed
14292 for captions placed above or below an element (if you follow strict typographic
14293 rules, you might want to place table captions always above the table).
14294 You can also use the class option
14298 , which will switch
14311 You need at least Koma-Script version 2.8q to use this.
14314 \begin_layout Itemize
14319 : can be used to set a bonmot, e.
14320 \begin_inset space \thinspace{}
14324 \begin_inset space \space{}
14327 at the beginning of a chapter.
14328 If you use the optional argument (
14330 Insert\SpecialChar menuseparator
14332 \begin_inset space ~
14337 ), you can insert the dictum's author there.
14338 Dictum and author are separated by a line.
14339 You need at least Koma-Script version 2.8q to use this.
14344 is not contained in
14346 article (koma-script)
14351 \begin_layout Standard
14352 The following types, together with the standard types
14364 , form the title area of the document.
14365 They must be entered ahead of the first
14366 \begin_inset Quotes eld
14370 \begin_inset Quotes erd
14377 \begin_layout Plain Layout
14378 The corresponding \SpecialChar LaTeX
14379 commands must appear before the
14390 When such a type is used more than once, the latter usage overwrites the
14391 former one, that means, for every type only the latest usage is valid.
14392 The order of the different types however has, like
14404 , no effect on the appearance of the produced document.
14407 \begin_layout Itemize
14412 : produces a centered paragraph above the ordinary title (
14424 ) for the subject of the document.
14427 \begin_layout Itemize
14432 : produces a centered paragraph below the ordinary title (
14444 ) for the publishers' name.
14447 \begin_layout Itemize
14454 report (koma-script)
14460 produces a centered paragraph on its own page behind the title page, or
14463 article (koma-script)
14465 produces a centered paragraph below the ordinary title (
14481 ) for a dedication.
14484 \begin_layout Itemize
14489 : produces a left aligned paragraph above the ordinary title (
14505 ) for a document`s head.
14508 \begin_layout Itemize
14513 : produces in a double-sided print in
14515 report (koma-script)
14521 a left-aligned paragraph at the top of the title page`s back or has no
14522 effect in a single-sided print or in
14524 article (koma-script)
14529 \begin_layout Itemize
14534 : produces in a double-sided print in
14536 report (koma-script)
14542 a left-aligned paragraph at the bottom of the title page`s back or has
14543 no effect in a single-sided print or in
14545 article (koma-script)
14550 \begin_layout Itemize
14555 : produces a special
14556 \begin_inset Quotes eld
14560 \begin_inset Quotes erd
14563 page ahead of the actual document containing a paragraph without special
14567 \begin_layout Standard
14568 The layout files for the document classes
14570 article (koma-script)
14574 report (koma-script)
14580 do include the file
14585 This is thought of as a place to define your own types.
14590 in your personal layout directory and edit the file!
14593 \begin_layout Subsection
14594 letter (koma-script)
14597 \begin_layout Standard
14601 letter (koma-script)
14603 is implemented in the layout file
14608 It contains all the paragraph types of the corresponding standard document
14613 , partly modified, with the exception of the \SpecialChar LyX
14627 type, which is replaced by the new
14632 In addition, it contains, in contrast to the standard document class, the
14651 Furthermore, there are a number of new letter specific types.
14654 \begin_layout Standard
14655 The appearance of the letter produced by this document class can be controlled
14656 by a number of \SpecialChar LaTeX
14657 commands, which you can put in the \SpecialChar LaTeX
14662 \begin_layout Plain Layout
14663 For example, the standard appearance of the letter`s heading, consisting
14664 of name and address, is quite self-willed.
14666 \begin_inset Quotes eld
14670 \begin_inset Quotes erd
14673 heading is produced by the following \SpecialChar LaTeX
14674 commands in the preamble:
14677 \begin_layout LyX-Code
14687 \begin_layout LyX-Code
14703 \begin_layout LyX-Code
14713 \begin_layout LyX-Code
14733 A detailed German description of such \SpecialChar LaTeX
14734 commands can be found in the Koma-Script
14740 With it, the letter's author can produce his personal letter layout.
14743 \begin_layout Standard
14752 define the beginning of the letter and must be used in every letter.
14753 To emphasize them in the \SpecialChar LyX
14754 document class, they are marked with the letter
14764 \begin_inset space ~
14767 in the left margin.
14768 It is possible to write any number of letters in one file.
14773 type produces a new letter using the same addressee and a
14777 type produces a new addressee.
14794 are ordinary paragraph types and can also be used several times in one
14795 and the same letter.
14798 \begin_layout Itemize
14803 : produces a paragraph for the addressee and implicitly defines the beginning
14807 \begin_layout Itemize
14812 : produces a paragraph for the form of address and implicitly produces a
14816 \begin_layout Itemize
14821 : produces a paragraph for a close.
14824 \begin_layout Itemize
14829 : produces a paragraph for a postscript.
14832 \begin_layout Itemize
14837 : produces a paragraph for a distribution list.
14840 \begin_layout Itemize
14845 : produces a paragraph for enclosures.
14848 \begin_layout Standard
14889 are input types provided with a label to enter information, which will
14890 be processed by the document class.
14894 \begin_layout Plain Layout
14895 It could be seen as a matter of inconsequence, that the types
14903 described above are not such input types as well.
14904 Because of the special meaning of those types, however, I have implemented
14905 them as ordinary paragraph types with a one letter mark in the left margin.
14906 Moreover, it would affect my feeling of symmetry, if the
14914 type had such a serious different appearance.
14919 The types must be used ahead of the corresponding
14926 \begin_layout Standard
14927 An implementation of these types in a WYSIWYG fashion does not seem to make
14928 sense, because the real appearance of the produced letter does not only
14929 depend on the usage of the particular type, but also on other factors.
14930 For example, a signature entered in the
14934 type will in the standard behavior appear in the produced letter only,
14935 when in the same letter also a
14940 The entered value of the
14944 type will in the standard behavior not appear in the produced letter at
14946 The possibility to design the letter`s heading freely is already indicated
14947 in a footnote above.
14950 \begin_layout Standard
14951 The input types can also be used as empty paragraphs.
14952 This makes sense e.
14953 \begin_inset space \thinspace{}
14957 \begin_inset space \space{}
14969 type is not used at all, in the standard behavior the value of the
14973 type is used as signature, whereas if an empty
14977 type is used, no signature value is defined.
14980 \begin_layout Standard
14981 By using the input types it is possible to write a letter template, containing
14982 filled input types with your personal dates (name, address, etc.) and empty
14983 input types for other dates you want to enter.
14986 \begin_layout Itemize
14991 : sender's name, in the standard behavior appears as a centered paragraph
14992 in small caps in the letter`s heading.
14995 \begin_layout Itemize
15000 : sender's signature, in the standard behavior appears below the
15009 type is used, the value of the
15013 type appears instead.
15016 \begin_layout Itemize
15021 : sender's address, in the standard behavior appears in a centered paragraph
15022 in the letter`s heading below the sender's name.
15025 \begin_layout Itemize
15030 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15041 \begin_layout Itemize
15046 : place of the letter`s making.
15049 \begin_layout Itemize
15054 : date of the letter`s making.
15063 , in the standard behavior, produce the place and the date in a right-aligned
15064 line below the addressee's field.
15069 type is used, neither place nor date appear, independent of the value of
15079 type is used, the date of the letter `s production is used.
15082 \begin_layout Itemize
15087 : sender`s back address, in the standard behavior appears above the addressee's
15088 field in a small sans serif font.
15091 \begin_layout Itemize
15096 : special mail information, in the standard behavior appears underlined
15097 above the addressee's field below the back address.
15100 \begin_layout Itemize
15105 : additional information, in the standard behavior appears on right side
15106 below the addressee`s field.
15109 \begin_layout Itemize
15114 : the letter's title, in the standard behavior appears in a big, bold, sans
15115 serif font above the subject.
15118 \begin_layout Itemize
15123 : the letter's subject, in the standard behavior appears in a bold font
15131 \begin_layout Standard
15152 produce a business letter like line above the
15156 line containing the fields
15157 \begin_inset Quotes eld
15161 \begin_inset Quotes erd
15165 \begin_inset Quotes eld
15169 \begin_inset Quotes erd
15173 \begin_inset Quotes eld
15177 \begin_inset Quotes erd
15181 \begin_inset Quotes eld
15185 \begin_inset Quotes erd
15189 \begin_inset Quotes eld
15193 \begin_inset Quotes erd
15197 \begin_inset Quotes eld
15201 \begin_inset Quotes erd
15205 For the date field, the value of the
15211 \begin_inset Quotes eld
15214 business letter types
15215 \begin_inset Quotes erd
15218 is used, the value of the
15222 type however does not appear, but only the \SpecialChar LaTeX
15230 The ordinary output of place and date in a right-aligned line below the
15231 addressee`s field is suppressed.
15232 The types are implemented as input types provided with a label and must
15233 be used ahead of the corresponding
15240 \begin_layout Itemize
15248 \begin_layout Itemize
15256 \begin_layout Itemize
15264 \begin_layout Itemize
15272 \begin_layout Itemize
15280 \begin_layout Subsection
15281 The new letter class: letter (koma-script v.2)
15284 \begin_layout Standard
15290 \begin_layout Standard
15291 \begin_inset VSpace medskip
15297 \begin_layout Standard
15299 Koma-Script version 2.8 has introduced a new letter class
15303 which supersedes the now unsupported
15308 It has — on the \SpecialChar LaTeX
15309 side — a completely new interface and is not compatible
15310 with the old class.
15311 Therefore, \SpecialChar LyX
15312 supports both, though it is recommended you use the new class.
15315 \begin_layout Standard
15316 This class covers the same functionality as
15318 letter (koma-script),
15321 The basic items are
15325 (receiver's address, same as
15329 in the old layout),
15342 will start a new letter (i.
15343 \begin_inset space \thinspace{}
15347 \begin_inset space \space{}
15350 you can write several letters per document).
15351 New elements are sender's
15367 and the possibility to use a
15373 Insert\SpecialChar menuseparator
15379 \begin_layout Standard
15380 The biggest improvement is, though, that the letter's layout is configurable
15381 to meet almost any needs.
15382 This can be done via the preamble or with a special style file (Letter
15383 Class Option, extension
15387 ), that will be read in as a class option.
15391 \begin_layout Plain Layout
15392 The KOMA package comes with some default
15397 There is, for instance, a
15401 file that follows german typesetting rules, or a
15405 that provides the default layout of the old
15410 The latter can be loaded with the class option
15416 Layout\SpecialChar menuseparator
15417 Document\SpecialChar menuseparator
15429 template that is included in \SpecialChar LyX
15431 A detailed description is to be found in the Koma-Script documentation
15439 \begin_layout Subsection
15443 \begin_layout Standard
15444 Visualizing the Koma-Script document classes in \SpecialChar LyX
15445 , the \SpecialChar LyX
15446 internals cause some
15450 \begin_layout Itemize
15451 The chapter number of a
15455 type appears on a line of its own above the chapter heading instead of
15456 appearing in the same line ahead of it.
15457 The cause for that is the \SpecialChar LyX
15458 internal behavior for the labeltype
15462 in the layout file.
15465 \begin_layout Itemize
15466 The headings of the types
15474 are only put in the
15475 \begin_inset Quotes eld
15479 \begin_inset Quotes erd
15483 table of contents, but not in the \SpecialChar LyX
15484 table of contents (
15486 Document\SpecialChar menuseparator
15488 \begin_inset space ~
15492 \begin_inset space ~
15500 \begin_layout Itemize
15501 The paragraphs in a
15505 document class appear in a skip separation mode, not indented.
15506 This is the standard behavior, no special \SpecialChar LaTeX
15507 commands are needed for that.
15510 Document\SpecialChar menuseparator
15513 dialog the corresponding radio button indicates
15522 value always has the effect that extra \SpecialChar LaTeX
15523 commands are inserted in the document
15524 to produce the gap, which is not what is wanted in this case.
15527 \begin_layout Section
15531 \begin_layout Standard
15537 \begin_layout Subsection
15541 \begin_layout Standard
15542 Memoir is a very powerful and constantly evolving class.
15543 It has been designed with regard to fictional and non-fictional literature.
15544 Its aim is to let the user have maximum control over the typesetting of
15546 Memoir is based on the standard book class, but it can also emulate the
15547 article class (see below).
15550 \begin_layout Standard
15551 Peter Wilson, the developer of Memoir, is known as the author of lots of
15552 useful packages in the \SpecialChar LaTeX
15554 Most of them have been merged with Memoir.
15555 Therefore, it is much easier to layout the table of contents, appendices,
15556 chapter designs and such.
15558 , though, does not support all of these goodies natively.
15559 Some of them might be added to forthcoming releases
15563 \begin_layout Plain Layout
15564 You are invited to send suggestions to
15565 \begin_inset Flex URL
15568 \begin_layout Plain Layout
15570 lyx-devel@lists.lyx.org
15580 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15582 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15584 commands (\SpecialChar TeX
15589 \begin_layout Plain Layout
15594 \begin_layout Plain Layout
15604 \begin_inset space ~
15608 \begin_inset CommandInset ref
15610 reference "sec:Inserting-TeX-Code"
15620 In this section, we can only list those features that are natively supported
15621 by \SpecialChar LyX
15623 For detailed descriptions (and for the rest of features) we recommend you
15624 have a look at the detailed manual of the Memoir class
15628 \begin_layout Plain Layout
15633 \begin_layout Plain Layout
15643 \begin_inset Flex URL
15646 \begin_layout Plain Layout
15648 CTAN:/macros/latex/memoir/memman.pdf
15658 , which is not only a user guide for the class, but also both a comprehensive
15659 description on good typesetting and a superb example for good typesetting
15663 \begin_layout Subsection
15664 Basic features and restrictions
15667 \begin_layout Standard
15668 Memoir supports basically all features of the standard book classes.
15669 There are, however, some differences, as follows:
15672 \begin_layout Description
15674 \begin_inset space ~
15677 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15680 \begin_layout Description
15682 \begin_inset space ~
15685 style: The fancy page style is not supported, due to a command clash between
15686 Memoir and the fancyhdr package (they both define a command with the same
15687 name, which confuses \SpecialChar LaTeX
15689 Instead, Memoir comes with a number of its own page styles (see
15691 Layout\SpecialChar menuseparator
15692 Document\SpecialChar menuseparator
15694 \begin_inset space ~
15700 If you want to use these for the chapter pages, you have to use the command
15707 in the main text or in preamble (e.
15708 \begin_inset space \thinspace{}
15712 \begin_inset space \space{}
15719 chapterstyle{companion}
15724 \begin_layout Description
15725 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15726 optional argument in the standard classes.
15727 With this, you can specify an alternative version of the title for the
15728 table of contents and the headers (for instance, if the title is too long).
15729 In \SpecialChar LyX
15730 , you can do this via
15732 Insert\SpecialChar menuseparator
15734 \begin_inset space ~
15739 at the beginning of a chapter/section.
15740 Memoir features a second optional argument and thus separates the table
15741 of contents from the header.
15742 You can define three variants of a title with this: one for the main text,
15743 one for the table of contents, and one for the headers.
15744 Simply insert two optional arguments if you need this feature, the first
15745 one containing the short title for the Table of Contents, the second one
15746 containing an alternative short title for the headers.
15749 \begin_layout Description
15750 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15751 of contents, the list of figures and the list of table start a new page
15753 Memoir does not follow this route.
15754 You have to insert a page break yourself, if you want to have one.
15757 \begin_layout Description
15758 Titlepage: For some unknown reason, Memoir uses pagination on the title
15759 page (in the standard classes, title pages are
15760 \begin_inset Quotes eld
15764 \begin_inset Quotes erd
15768 If you want an empty title page, type
15772 aliaspagestyle{title}{empty}
15777 \begin_layout Description
15778 Article: With the class option
15784 Layout\SpecialChar menuseparator
15785 Document\SpecialChar menuseparator
15787 \begin_inset space ~
15792 ), you can emulate article style.
15793 That is, counters (footnotes, figures, tables etc.) will not be reset on
15794 new chapters, chapters don't start a new page (but are—in contrary to
15795 \begin_inset Quotes eld
15799 \begin_inset Quotes erd
15802 article classes—still allowed), parts, though, use their own page, as in
15806 \begin_layout Description
15807 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15808 font commands, which have been used in the old \SpecialChar LaTeX
15810 \begin_inset space \thinspace{}
15814 \begin_inset space \space{}
15830 It produces an error and stops \SpecialChar LaTeX
15831 whenever such a command appears.
15836 reallows the commands and spits out warnings instead (which does at least
15837 not stop \SpecialChar LaTeX
15839 Since a lot of packages and particularly Bib\SpecialChar TeX
15840 style files are still using
15841 those commands, we have decided to use this option by default.
15844 \begin_layout Subsection
15848 \begin_layout Standard
15849 We will only describe the features supported by \SpecialChar LyX
15850 (which is not much currently).
15851 Please consult the Memoir manual
15855 \begin_layout Plain Layout
15860 \begin_layout Plain Layout
15870 \begin_inset Flex URL
15873 \begin_layout Plain Layout
15875 CTAN:/macros/latex/memoir/memman.pdf
15888 \begin_layout Description
15889 Abstract: You may wonder why an abstract is an extra feature.
15890 Well, it is in book class.
15891 Usually books don't have abstracts.
15892 Memoir, however, has.
15893 You can use it wherever and how often you like.
15896 \begin_layout Description
15897 Chapterprecis: You may know this older typesetting style: The contents of
15898 a chapter are summarized below the title and also in the table of contents
15900 \begin_inset space \thinspace{}
15904 \begin_inset space \space{}
15909 Our hero arrives in Troia; he loses some friends; he finds others
15912 Chapterprecis does exactly this.
15913 It is therefore only sensible below a chapter.
15916 \begin_layout Description
15917 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15918 The epigraph environment provides an elegant way of typesetting such a
15920 The motto itself (text) and its author (source) are divided by a short
15922 Unfortunately, we have to fool \SpecialChar LyX
15923 a bit here again, since the environment
15924 needs two arguments (text and source).
15925 In this case, we have to use curly brackets (in \SpecialChar TeX
15926 mode) between the two
15937 <author of the slogan>.
15940 \begin_layout Description
15941 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15942 complex figurative poems).
15944 can only support a few of them.
15945 One is poemtitle, which is a centered title for poems, which will also
15946 be added to the table of contents (verse is the standard environment for
15948 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
15950 because they have to be nested inside regular verse environments, which
15951 is not possible with \SpecialChar LyX
15955 \begin_layout Description
15956 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15959 \begin_layout Section
15960 Article (mwart), book (mwbk) and report (mwrep)
15961 \begin_inset Argument status
15964 \begin_layout Plain Layout
15977 \begin_layout Standard
15983 \begin_layout Standard
15984 The \SpecialChar LyX
16001 correspond to the \SpecialChar LaTeX
16015 They are replacements for the standard document classes
16027 , resp., and fit better to Polish typography conventions in a number of points.
16031 \begin_layout Standard
16035 \begin_layout Itemize
16036 Unnumbered titles (with star, e.
16037 \begin_inset space \thinspace{}
16041 \begin_inset space \space{}
16048 ) are added into table of contents,
16051 \begin_layout Itemize
16052 Additional page styles:
16056 \begin_layout Description
16057 uheadings header with separated lines,
16060 \begin_layout Description
16061 myheadings custom header, contents headers via commands:
16076 \begin_layout Description
16077 myuheadings custom header with separated lines,
16080 \begin_layout Description
16081 outer page number is placed on outer side of page
16085 \begin_layout Itemize
16090 \begin_layout Description
16091 rmheadings serif titles — default,
16094 \begin_layout Description
16095 sfheadings sansserif titles,
16098 \begin_layout Description
16099 authortitle on title page first placed is author next title — default,
16102 \begin_layout Description
16103 titleauthor on title page first placed is title next author,
16106 \begin_layout Description
16107 withmarginpar reserve place on page for margins.
16111 \begin_layout Section
16115 \begin_layout Standard
16120 provides an alternative to the standard
16125 It provides similar functionality, but you might prefer this layout with
16126 sans serif sections, headings, and more.
16129 \begin_layout Section
16130 Rev\SpecialChar TeX
16134 \begin_layout Standard
16140 \begin_layout Standard
16141 \begin_inset VSpace bigskip
16147 \begin_layout Standard
16152 \begin_inset space ~
16157 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16159 \begin_inset Formula $\beta$
16162 release of May, 1999) class.
16165 \begin_layout Standard
16171 textclass, which works with Rev\SpecialChar TeX
16173 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16175 That means that it doesn't interact very well with \SpecialChar LyX
16176 , which requires \SpecialChar LaTeX2e
16178 it has been kludged to work.
16179 Since Rev\SpecialChar TeX
16180 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16185 Rev\SpecialChar TeX
16187 \begin_inset space ~
16192 textclass should also be pretty easy to use.
16195 \begin_layout Standard
16196 These documents are supposed to be used in
16200 to the Rev\SpecialChar TeX
16201 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16203 and assume you'll know what to put in the preamble if necessary.
16206 \begin_layout Subsection
16210 \begin_layout Standard
16211 All you need to do is install Rev\SpecialChar TeX
16212 4, as described in the package's README
16214 The package can be found at The Rev\SpecialChar TeX
16216 \begin_inset Flex URL
16219 \begin_layout Plain Layout
16221 http://publish.aps.org/revtex4/
16227 Install it somewhere that \SpecialChar LaTeX
16229 Test it by trying to \SpecialChar LaTeX
16230 a short Rev\SpecialChar TeX
16231 4 document in some random directory (i.
16232 \begin_inset space \thinspace{}
16236 \begin_inset space \space{}
16239 not the directory where you installed the class file.) Then, if you reconfigure
16241 , it will find the class file and let you use the Rev\SpecialChar TeX
16245 \begin_layout Standard
16246 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16255 \begin_inset space ~
16260 template, found in the templates directory.
16263 \begin_layout Subsection
16267 \begin_layout Standard
16268 Optional arguments to
16275 \begin_inset Quotes eld
16279 \begin_inset Quotes erd
16283 \begin_inset Quotes eld
16287 \begin_inset Quotes erd
16293 \begin_inset space ~
16301 \begin_inset space ~
16307 Remember that in Rev\SpecialChar TeX
16308 , at least one optional argument is required!
16311 \begin_layout Standard
16312 Other preamble matter, like
16319 \begin_inset space ~
16326 \begin_inset space ~
16331 dialog, also as usual.
16334 \begin_layout Subsection
16338 \begin_layout Standard
16339 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16341 For example, the Email layout corresponds to
16348 Note that (at least as of Rev\SpecialChar TeX
16357 layouts are exactly equivalent, so you shouldn't need to use both.
16361 \begin_layout Plain Layout
16362 In case you're curious, both were included so that
16366 would be able to translate both
16386 \begin_layout Subsection
16390 \begin_layout Standard
16391 There are a couple of important unique aspects of Rev\SpecialChar TeX
16392 4 which might cause
16393 bugs that will be even more confusing in \SpecialChar LyX
16397 \begin_layout Standard
16398 In Rev\SpecialChar TeX
16416 The \SpecialChar LyX
16417 equivalent is that there is a separate Thanks layout.
16422 write footnotes in the
16426 layout, or weird things may happen.
16427 See the Rev\SpecialChar TeX
16428 4 documentation for more details.
16431 \begin_layout Standard
16435 \begin_inset space ~
16443 \begin_inset space ~
16452 layouts must be placed
16460 layout and the corresponding
16477 , the \SpecialChar LaTeX
16481 \begin_layout Subsection
16485 \begin_layout Standard
16486 The main problem with this layout is that you can't use the optional arguments
16487 to layouts like Email and Title.
16488 (The problem is not unique to this layout; you can't use optional arguments
16489 to the Section layouts either.) This means that after you export that file
16490 to \SpecialChar LaTeX
16491 (which you'll need to do eventually to send it in to APS), you'll need
16492 to edit the \SpecialChar LaTeX
16493 file with a text editor to add the optional arguments to set,
16495 \begin_inset space \thinspace{}
16499 \begin_inset space \space{}
16502 the running title for the page headers.
16503 Lacking these layouts makes the
16509 (and the equivalent
16515 ) useless, so the corresponding layouts don't exist, and will have to be
16520 \begin_layout Plain Layout
16525 actually, \SpecialChar LyX
16526 1.3.0 supports some forms of optional arguments, but this layout
16527 has not been updated yet to take advantage of it.
16535 \begin_layout Section
16536 Springer Journals (
16543 \begin_layout Standard
16549 \begin_layout Subsection
16553 \begin_layout Standard
16554 These are the layout files for some of the journal formats used by Springer
16555 Verlag and listed on
16556 \begin_inset Flex URL
16559 \begin_layout Plain Layout
16561 http://www.springer.de/author/tex/help-journals.html
16566 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16568 It is a modular system: the things common to all journals are implemented
16573 , which journal-specific layout files (such as, e.
16574 \begin_inset space \thinspace{}
16578 \begin_inset space \space{}
16585 for Journal of Geodesy) can include.
16588 \begin_layout Standard
16589 This means that implementing support for any other Springer journal on this
16590 list is as simple as writing your own
16598 file following the outline given in
16606 \begin_layout Standard
16607 It is reasonably well tested only for the Journal of Geodesy.
16616 come with the standard \SpecialChar LyX
16618 Install the relevant class file (downloaded from Springer) in a proper
16619 directory, reconfigure \SpecialChar LaTeX
16620 (in the te\SpecialChar TeX
16625 , as root if necessary — doesn't \SpecialChar LyX
16626 take care of this?), reconfigure \SpecialChar LyX
16631 \begin_layout Subsection
16635 \begin_layout Standard
16636 A large number of theorem-like styles —
16648 \begin_layout Standard
16651 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16652 _Title, Author_Running, Institute,
16653 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16656 See the Springer class file documentation for details.
16659 \begin_layout Subsection
16663 \begin_layout Itemize
16675 \begin_layout Itemize
16678 Probability Theory and Related Fields
16684 — Jean-Marc Lasgouttes
16687 \begin_layout Standard
16688 Add your own, it isn't so hard!
16691 \begin_layout Subsection
16695 \begin_layout Standard
16696 These files are partly based on the older
16700 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16702 file from Springer.
16707 layout, are now defunct.
16708 Jean-Marc Lasgouttes helped out big in making me find my way around the
16710 layout file mechanism.
16713 \begin_layout Subsection
16717 \begin_layout Standard
16719 But probably less than in the old hacked-\SpecialChar LaTeX
16727 \begin_layout Standard
16729 \begin_inset space \thinspace{}
16732 g.: does not display the number for theorem-like layouts, just #.
16735 \begin_layout Section
16738 Sli\SpecialChar TeX
16742 \begin_inset CommandInset label
16751 \begin_layout Standard
16759 \begin_layout Subsection
16763 \begin_layout Standard
16764 This section describes how to use \SpecialChar LyX
16765 to make slides for overhead projectors.
16766 There are two document classes that can do this: the default slides class
16769 Foil\SpecialChar TeX
16773 This section documents the former.
16776 \begin_layout Standard
16777 I'm going to say this again, nice and clear, so that there's no misunderstanding
16781 \begin_layout Standard
16782 \begin_inset VSpace bigskip
16788 \begin_layout Standard
16792 This section documents the class
16793 \begin_inset Quotes eld
16801 \begin_inset Quotes erd
16809 \begin_layout Standard
16810 \begin_inset VSpace bigskip
16816 \begin_layout Standard
16817 If you're looking for the documentation for
16818 \begin_inset Quotes eld
16823 slides (Foil\SpecialChar TeX
16827 \begin_inset Quotes erd
16830 , check out section
16831 \begin_inset space ~
16835 \begin_inset CommandInset ref
16837 reference "sec:foiltex"
16847 \begin_inset Quotes eld
16852 slides (Foil\SpecialChar TeX
16856 \begin_inset Quotes erd
16859 ] is actually somewhat better than the default
16867 \begin_layout Plain Layout
16869 or so I've been told repeatedly by its advocates.
16870 Having never used it, I have no idea if this claim is true or not.
16875 which this section documents.
16878 \begin_layout Standard
16879 This class is the \SpecialChar LaTeX2e
16880 improvement of the old
16882 Sli\SpecialChar TeX
16886 Every \SpecialChar LaTeX2e
16887 distribution includes this class [which I'll just refer to as
16888 \begin_inset Quotes eld
16896 \begin_inset Quotes erd
16899 from now on], so you're bound to have it.
16900 As I noted earlier, there are other classes, such as
16904 , which also produce slides for overhead projectors and do a better job
16906 However, there are some things which
16910 can do which the others can't, such as generate overlays.
16911 Read on to learn more!
16914 \begin_layout Subsection
16916 \begin_inset CommandInset label
16918 name "sec:slidesetup"
16925 \begin_layout Standard
16926 Obviously, to use this document class, you need to select
16927 \begin_inset Quotes eld
16935 \begin_inset Quotes erd
16938 from the class list in the
16940 Document\SpecialChar menuseparator
16944 There are some other special things you should know about this class:
16947 \begin_layout Itemize
16948 Don't bother changing the options
16953 They're not supported by the
16960 \begin_layout Itemize
16964 \begin_inset space ~
16969 behaves a bit differently for this class.
16970 The possible choices and what they do are as follows:
16974 \begin_layout Description
16979 The final output contains page numbers in the lower right corner.
16982 \begin_layout Description
16991 , but also prints out any time markers you've put in.
16992 This is the default.
16995 \begin_layout Description
17000 The final output contains no page numbers, time markers, or alignment markers.
17004 \begin_layout Itemize
17009 class has an extra option:
17015 \begin_inset Quotes eld
17023 \begin_inset Quotes erd
17026 in the extra class options.
17030 \begin_layout Standard
17031 Using this options allows you to add time markers to
17037 \begin_inset space ~
17041 \begin_inset CommandInset ref
17043 reference "sec:slideNote"
17051 \begin_layout Standard
17052 You can also use the template file
17053 \begin_inset Quotes eld
17061 \begin_inset Quotes erd
17064 to automatically set up a document to use the
17070 File\SpecialChar menuseparator
17072 \begin_inset space ~
17076 \begin_inset space ~
17081 to open your new document].
17082 The template file also contains some examples of the special paragraph
17083 environments used by this class.
17084 I'll describe those next.
17087 \begin_layout Subsection
17088 Paragraph Environments
17091 \begin_layout Subsubsection
17092 Supported Environments
17095 \begin_layout Standard
17096 The first thing you'll notice when you start up a new
17100 document is the font size and type: it's the equivalent of the size
17101 \begin_inset Quotes eld
17109 \begin_inset Quotes erd
17115 \begin_inset space ~
17121 This is also what's used in the output.
17123 \begin_inset Quotes eld
17127 \begin_inset Quotes erd
17130 to remind you that this is a slide.
17131 Your final slides will use a larger font; ergo, you'll have less space.
17132 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17135 \begin_layout Standard
17136 The next thing that becomes obvious is the changes to the paragraph environment
17137 pull-down box [at the far-left end of the toolbar].
17138 Most of the paragraph environments you're used to seeing are missing.
17139 There are also five new ones.
17144 class itself only supports certain paragraph environments:
17147 \begin_layout Itemize
17153 \begin_layout Itemize
17159 \begin_layout Itemize
17165 \begin_layout Itemize
17171 \begin_layout Itemize
17177 \begin_layout Itemize
17183 \begin_layout Itemize
17189 \begin_layout Itemize
17195 \begin_layout Itemize
17201 \begin_layout Itemize
17208 \begin_layout Itemize
17214 \begin_layout Standard
17215 All of the other standard environments, including the section-heading environmen
17216 ts, aren't used in the
17223 \begin_layout Standard
17224 On the other hand, you'll notice the following new environments:
17227 \begin_layout Itemize
17233 \begin_layout Itemize
17239 \begin_layout Itemize
17245 \begin_layout Itemize
17251 \begin_layout Itemize
17257 \begin_layout Standard
17258 These five are kind of quirky, due to a
17259 \begin_inset Quotes eld
17263 \begin_inset Quotes erd
17266 in \SpecialChar LyX
17268 You see, \SpecialChar LyX
17269 doesn't permit you to nest any other paragraph environment into
17270 an empty environment.
17271 Now, that's fine and dandy, but it means that you wouldn't be able to start
17272 a slide with anything except plain text.
17273 To deal with this, I've performed a little
17274 \begin_inset Quotes eld
17279 \begin_inset Quotes erd
17285 \begin_layout Subsubsection
17286 Quirks of the New Environments
17287 \begin_inset CommandInset label
17289 name "sec:slideQuirk"
17296 \begin_layout Standard
17297 All five of the new paragraph environments are somewhat quirky due to inherent
17298 limitiations in the current version of \SpecialChar LyX
17300 As I just mentioned, \SpecialChar LyX
17301 forbids environments that begin with another environment.
17302 To get around this, the
17306 environment isn't a paragraph environment as described in the
17314 \begin_layout Standard
17315 You should consider
17328 \begin_inset Quotes eld
17331 pseudo-environments.
17332 \begin_inset Quotes erd
17335 They look like a section heading or a
17336 \begin_inset Quotes eld
17344 \begin_inset Quotes erd
17347 but really begin a [and, if necessary, end the previous] paragraph environment.
17357 \begin_inset Quotes eld
17361 \begin_inset Quotes erd
17364 These two perform some action.
17367 \begin_layout Standard
17368 A common feature of all five environments,
17388 , is a rather long-ish label.
17389 The text following this label — ordinarily the contents of the paragraph
17390 environment — is utterly irrelevant for
17412 completely ignores it.
17413 In fact, you can leave these five environments completely empty.
17417 \begin_layout Standard
17422 to put any text after the rather long-ish label, you might want to.
17423 This could be a short description of the contents of the
17428 In that case, enter your descriptive comment and hit
17432 as you normally would.
17435 \begin_layout Standard
17436 If, on the other hand, you don't want to enter any descriptive text, you'll
17437 hit another \SpecialChar LyX
17440 , like nature, abhors a vacuum, and will not let you start a new paragraph
17441 environment until you put something in the old one.
17445 \begin_layout Itemize
17446 Start entering the text that will
17474 \begin_layout Itemize
17475 Now move to the beginning of that paragraph.
17479 \begin_layout Itemize
17488 \begin_layout Itemize
17489 Finally, change this new, empty paragraph to a
17513 \begin_layout Standard
17514 Some future version of \SpecialChar LyX
17515 will, hopefully, resolve this quirkiness\SpecialChar ldots
17519 \begin_layout Subsection
17520 Making a Presentation with
17533 \begin_layout Subsubsection
17541 \begin_layout Standard
17542 If you're expecting this section to teach you how to actually make a presentatio
17543 n, you'll be sorely disappointed.
17544 Naturally, I'll describe all of the ways the
17548 class can assist you in preparing the materials for a presentation.
17549 Filling in the contents, however, is up to you.
17554 the \SpecialChar LyX
17558 \begin_layout Standard
17563 environment [in the manner described in section
17564 \begin_inset space ~
17568 \begin_inset CommandInset ref
17570 reference "sec:slideQuirk"
17574 ] tells \SpecialChar LyX
17575 to begin a new slide [duh].
17576 The label for this environment/
17577 \begin_inset Quotes erd
17581 \begin_inset Quotes erd
17585 \begin_inset Quotes eld
17589 \begin_inset Quotes erd
17592 in cool blue, followed by the label,
17593 \begin_inset Quotes eld
17597 \begin_inset Quotes erd
17601 Any text or paragraph environments that follow this one go on the new slide.
17605 \begin_layout Standard
17606 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17608 (this can be specified in the
17613 In fact, you'll want to, once you finish entering the contents of one slide.
17614 If you've entered more text than can physically fit on a slide, the extra
17615 overflows onto a new slide.
17616 I don't recommend doing this, however, since the overflow slide won't have
17617 any page number on it.
17618 Furthermore, it may interfere with any
17622 you've made to accompany the oversized
17629 \begin_layout Standard
17638 environments work the same way as the
17643 They both create an
17644 \begin_inset Quotes eld
17648 \begin_inset Quotes erd
17651 followed by a label [
17652 \begin_inset Quotes eld
17656 \begin_inset Quotes erd
17660 \begin_inset Quotes eld
17664 \begin_inset Quotes erd
17668 The color is a stunning magenta instead of blue, and the
17669 \begin_inset Quotes eld
17673 \begin_inset Quotes erd
17676 will look different, in style and in length.
17677 The label fonts of all three also differ from one another.
17680 \begin_layout Standard
17685 , if the contents of a
17693 exceed the physical size of a slide or sheet of paper, the extra will overflow
17695 Again, you should avoid this.
17696 It defeats the whole purpose of
17707 \begin_layout Subsubsection
17717 \begin_layout Standard
17722 is a slide that sits atop another slide.
17723 Perhaps you wish to discuss a figure on the main
17727 before displaying the text associated with it.
17728 One way to accomplish this is tape a flap of dark paper over the part of
17733 you want to display later.
17734 This method fails, however, if you wish to overlap one graph with another,
17736 You would then have to fumble while speaking to align the two separate,
17741 s to align the two graphs.
17746 environment in both cases makes life much easier.
17749 \begin_layout Standard
17754 receives the page number of its
17755 \begin_inset Quotes eld
17759 \begin_inset Quotes erd
17767 \begin_inset Quotes eld
17775 \begin_inset Quotes erd
17782 \begin_layout Plain Layout
17783 Presumably, mutliple
17788 \begin_inset Quotes eld
17796 \begin_inset Quotes erd
17800 \begin_inset Quotes eld
17808 \begin_inset Quotes erd
17812 \begin_inset Quotes eld
17820 \begin_inset Quotes erd
17824 \begin_inset space ~
17827 appended to the page number of the parent
17837 Clearly, you want the contents of both the
17845 to each fit on a single physical slide! You should probably consider an
17851 \begin_inset Quotes eld
17855 \begin_inset Quotes erd
17863 Indeed, the \SpecialChar LyX
17868 class provides a visual cue for this: the label at the start of an
17872 is shorter than that at the start of a
17877 Lastly, when you generate printable output, you'll find alignment markers
17878 in all four corners of both the
17882 page and its parent
17887 These will assist you in lining up the two physical slides.
17890 \begin_layout Standard
17891 The major problem in overlaying two slides is aligning the contents of the
17892 two transparencies.
17893 How much space should you leave for that graph on the second slide? Worse
17894 still, what if you want a graph and a sentence on second slide, but there
17895 is text on the main transparency that goes in between them? You could try
17896 and insert vertical space of the right size.
17897 The better way is to use
17908 \begin_layout Standard
17909 As their names imply,
17917 are two command-like paragraph environments that make all subsequent text
17918 invisible and visible, respectively.
17920 \begin_inset space ~
17924 \begin_inset CommandInset ref
17926 reference "sec:slideQuirk"
17930 that you don't place anything
17934 these two environments, however.
17939 , it inserts a centered, sky-blue label into the page reading
17940 \begin_inset Quotes eld
17943 <Invisible Text Follows>
17944 \begin_inset Quotes erd
17948 For paragraphs following this label, the parts of the
17956 ; it doesn't matter which] where they would be contain instead blank space.
17960 \begin_layout Standard
17965 , the corresponding centered label is
17966 \begin_inset Quotes eld
17969 <Visible Text Follows>
17970 \begin_inset Quotes erd
17974 Paragraphs following this label behave normally.
17975 Note that the beginning of a new
17987 automatically shuts off an
17992 It's therefore not necessary to use
18003 \begin_layout Standard
18004 By now, it should be obvious how to create overlay transparencies using
18005 the proper combination of
18024 \begin_layout Enumerate
18029 , including everything that will appear on it, whether on the main slide
18037 \begin_layout Enumerate
18038 Before each figure or paragraph that will appear only on the
18047 If necessary, insert a
18051 environment after the
18058 \begin_layout Enumerate
18063 immediately following the
18070 \begin_layout Enumerate
18071 Copy the contents of this
18082 \begin_layout Enumerate
18087 , change all of the
18098 \begin_layout Standard
18100 You've just made an
18107 \begin_layout Standard
18108 There's one problem with the way I've designed the \SpecialChar LyX
18113 class: you can't make text in the middle of a paragraph invisible, nor
18114 make text in the middle of an invisible paragraph visible again.
18115 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18120 \begin_layout Plain Layout
18121 The commands of interest are:
18124 \begin_layout Itemize
18129 invisible \SpecialChar ldots
18133 \begin_layout Itemize
18138 visible \SpecialChar ldots
18142 \begin_layout Plain Layout
18144 and need to be marked as \SpecialChar TeX
18147 \begin_inset Quotes eld
18151 \begin_inset Quotes erd
18154 you wish to change goes in between the brackets [and after the
18167 If you don't know how to mark text as \SpecialChar TeX
18168 , see the appropriate section of
18181 \begin_layout Subsubsection
18191 \begin_inset CommandInset label
18193 name "sec:slideNote"
18200 \begin_layout Standard
18209 is associated with a
18210 \begin_inset Quotes eld
18214 \begin_inset Quotes erd
18222 Here, too, the \SpecialChar LyX
18227 class provides visual cues.
18232 is shorter than that of a
18236 [yet longer than that of an
18240 ] and, like the label of an
18244 is shockingly magenta.
18245 Additionally, the printed
18249 has the page number of its
18250 \begin_inset Quotes eld
18254 \begin_inset Quotes erd
18262 \begin_inset Quotes eld
18270 \begin_inset Quotes erd
18274 \begin_inset Quotes eld
18282 \begin_inset Quotes erd
18286 \begin_inset Quotes eld
18294 \begin_inset Quotes erd
18298 You can have multiple
18302 s associated with a single
18314 , you'll probably want to break up long
18318 s so that they fit on a single sheet of paper.
18321 \begin_layout Standard
18326 is obvious: it contains anything additional you might want to say about
18332 It could also be used as a sheet of reminders for a particular
18337 In the case of the latter, you might want to make use of time markers.
18338 Currently, the \SpecialChar LyX
18344 \begin_inset Quotes eld
18348 \begin_inset Quotes erd
18351 support for time markers, a
18353 Sli\SpecialChar TeX
18357 So, you'll have to resort to using the \SpecialChar LaTeX
18361 \begin_layout Standard
18362 To use time markers, you'll need to specify the extra class option
18363 \begin_inset Quotes eld
18371 \begin_inset Quotes erd
18375 \begin_inset space ~
18379 \begin_inset CommandInset ref
18381 reference "sec:slidesetup"
18386 This option turns on timing marks, which will appear in the lower-left-hand
18392 To set what appears in the time marker, you use the \SpecialChar LaTeX
18394 \begin_inset Quotes eld
18404 \begin_inset Quotes erd
18408 \begin_inset Quotes eld
18418 \begin_inset Quotes erd
18422 The arguments of both commands are time measured in seconds.
18424 \begin_inset Quotes eld
18434 \begin_inset Quotes erd
18437 sets the time marker to a given time.
18439 \begin_inset Quotes eld
18449 \begin_inset Quotes erd
18452 increments the time marker by the specified amount.
18453 Using time markers and
18457 s in this fashion, you can remind yourself how much time to spend on a particula
18465 \begin_layout Standard
18466 There's one last feature to describe.
18467 Clearly, you'd like to print out all of your
18475 s on transparencies while printing all of your
18492 with which it is associated.
18493 What's a person to do?
18496 \begin_layout Standard
18497 Luckily, there are two \SpecialChar LaTeX
18498 commands that allow you to select what to print
18500 Both must be placed into the preamble of your document.
18502 \begin_inset Quotes eld
18514 \begin_inset Quotes erd
18517 will cause the output to contain only the
18526 Correspondingly, the command
18527 \begin_inset Quotes eld
18539 \begin_inset Quotes erd
18542 prevents the output of anything but
18547 I'd advise placing both commands in the preamble and initially comment
18549 You can then preview your entire presentation as you write.
18550 When you're done writing, you can then uncomment one of the two to select
18551 what you want to print.
18552 I like to uncomment
18553 \begin_inset Quotes eld
18565 \begin_inset Quotes erd
18568 , print to a file with
18569 \begin_inset Quotes eld
18577 \begin_inset Quotes erd
18580 in its name, comment it back out, then uncomment
18581 \begin_inset Quotes eld
18593 \begin_inset Quotes erd
18597 \begin_inset Quotes eld
18605 \begin_inset Quotes erd
18609 I can then send either file to a printer, loading transparencies or plain
18610 paper as appropriate.
18613 \begin_layout Standard
18614 You can also provide other arguments to the
18615 \begin_inset Quotes eld
18625 \begin_inset Quotes erd
18629 \begin_inset Quotes eld
18639 \begin_inset Quotes erd
18643 See a good \SpecialChar LaTeX
18647 \begin_layout Subsection
18652 Class Template File
18655 \begin_layout Standard
18656 I have also provided a template file,
18657 \begin_inset Quotes eld
18665 \begin_inset Quotes erd
18673 To use it, begin your new presentation with
18675 File\SpecialChar menuseparator
18677 \begin_inset space ~
18681 \begin_inset space ~
18687 Your new \SpecialChar LyX
18688 presentation file will contain an example
18709 additionally contain an example of the use of
18718 Lastly, the preamble will contain:
18721 \begin_layout LyX-Code
18722 % Uncomment to print out only slides and overlays
18725 \begin_layout LyX-Code
18729 \begin_layout LyX-Code
18735 \begin_inset Newline newline
18741 \begin_layout LyX-Code
18742 % Uncomment to print out only notes
18745 \begin_layout LyX-Code
18749 \begin_layout LyX-Code
18757 \begin_layout Standard
18758 One final thing: I created this class to support the \SpecialChar LaTeX2e
18760 \begin_inset Quotes eld
18765 Sli\SpecialChar TeX
18769 \begin_inset Quotes erd
18772 class, one of the built-in \SpecialChar LaTeX2e
18774 Neither I nor the rest of the \SpecialChar LyX
18775 Team endorse or oppose the use of this built-in
18777 It's here if you want it or need it.
18778 There exist other \SpecialChar LaTeX2e
18779 classes for creating presentations, such as the
18784 \begin_inset space ~
18788 \begin_inset CommandInset ref
18790 reference "sec:foiltex"
18795 \begin_inset Quotes eld
18803 \begin_inset Quotes erd
18806 package [present on some \SpecialChar TeX
18808 The latter is not yet supported under \SpecialChar LyX
18813 \begin_layout Plain Layout
18814 Perhaps you can take on the task\SpecialChar ldots
18820 I know nothing about these other classes.
18821 Try them out to see what sort of alternative they provide.
18824 \begin_layout Chapter
18826 Features needing Extra Software
18829 \begin_layout Section
18830 Checking \SpecialChar TeX
18834 \begin_layout Standard
18840 \begin_layout Subsection
18844 \begin_layout Standard
18853 \begin_layout Plain Layout
18858 is not yet available when you are using the \SpecialChar LaTeX
18859 distribution MiK\SpecialChar TeX
18865 , you'll find in the
18872 \begin_inset space ~
18883 \begin_inset Newline newline
18887 \begin_inset CommandInset href
18889 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18897 \begin_layout Standard
18900 Chk\SpecialChar TeX
18903 package is a program that was written by
18904 \begin_inset Flex Noun
18907 \begin_layout Plain Layout
18909 \begin_inset space ~
18917 in frustration because some constructs in \SpecialChar LaTeX
18918 are sometimes non-intuitive,
18919 and easy to forget.
18920 The program runs over your \SpecialChar LaTeX
18921 file, checks the integrity of the file, and
18922 flags some common errors.
18923 In other technical words, it is
18927 for \SpecialChar LaTeX
18931 \begin_layout Standard
18932 Well, what is a syntax checker doing in \SpecialChar LyX
18933 which is supposed to produce correct
18935 anyways? The answer is simple: Just as
18939 not only checks the
18943 of C programs, but also does
18947 checks for type-errors,
18949 Chk\SpecialChar TeX
18952 catches some common
18956 errors, in addition to the syntactical ones.
18959 Chk\SpecialChar TeX
18962 is capable of detecting several common errors, such as
18965 \begin_layout Itemize
18966 Ellipsis detection:
18967 \begin_inset Newline newline
18970 Use \SpecialChar ldots
18974 \begin_layout Itemize
18975 No space in front of/after parenthesis:
18976 \begin_inset Newline newline
18982 \begin_layout Itemize
18983 Enforcement of normal space after common abbreviations:
18984 \begin_inset Newline newline
18988 \begin_inset space \thinspace{}
18992 \begin_inset space \space{}
18995 is too wide spacing.
18998 \begin_layout Itemize
18999 Enforcement of end-of-sentence space when the last sentence ends with a
19001 \begin_inset Newline newline
19005 And this is wrong spacing.
19008 \begin_layout Itemize
19009 Space in front of labels and similar commands:
19010 \begin_inset Newline newline
19013 The label should stick right up to the text to avoid falling to a wrong
19016 \begin_inset CommandInset label
19026 \begin_layout Plain Layout
19027 This footnote is in danger of falling off to a wrong page
19032 The label is separated too much.
19035 \begin_layout Itemize
19036 Space in front of references, instead of hard spaces:
19037 \begin_inset Newline newline
19040 If you have bad luck, the text will break right between the referenced text
19041 and reference number, and that's a pity.
19043 \begin_inset CommandInset ref
19045 reference "sec:chktex"
19052 \begin_layout Itemize
19054 \begin_inset Quotes eld
19058 \begin_inset Quotes erd
19062 \begin_inset Formula $\times$
19066 \begin_inset Newline newline
19069 2x2 looks cheap compared to
19070 \begin_inset Formula $2\times2$
19076 \begin_layout Standard
19077 and more \SpecialChar ldots
19078 It is an invaluable tool when you are
19079 \begin_inset Quotes eld
19083 \begin_inset Quotes erd
19086 your document before printing, and you should run it right after the obligatory
19087 spelling check, and before you go fine tuning the typesetting.
19090 \begin_layout Subsection
19094 \begin_layout Standard
19095 If you have the program installed, usage is as simple as choosing
19097 Tools\SpecialChar menuseparator
19099 \begin_inset space ~
19105 This will make \SpecialChar LyX
19106 generate a \SpecialChar LaTeX
19107 file of your document, start
19109 Chk\SpecialChar TeX
19112 to check it, and then make \SpecialChar LyX
19114 \begin_inset Quotes eld
19118 \begin_inset Quotes erd
19121 with the warnings from
19123 Chk\SpecialChar TeX
19126 , if there were any.
19127 The warnings will be placed close to the point of the mistake, and you
19128 can quickly find them by using the
19130 Navigate\SpecialChar menuseparator
19133 menu item, or the shortcut key
19142 Open the error boxes by clicking on them with the mouse, or use the shortcut
19151 bindings, or the corresponding
19160 Read the warning and correct the mistake, if it is a mistake.
19161 If you have trouble understanding what the warning is about, you can safely
19163 Remember that there is a hidden layer between the document on screen and
19164 the technical details in invoking
19166 Chk\SpecialChar TeX
19169 , and this gap can make some warnings seem arcane or just plain silly.
19172 \begin_layout Standard
19173 This document is an excellent testing bed for the feature, and it should
19174 provide quite a few warnings for you to fiddle with.
19175 Since computers are only so smart, expect most of the warnings to be false
19179 \begin_layout Subsection
19180 How to fine tune it
19183 \begin_layout Standard
19184 Sometimes, you'll find that
19186 Chk\SpecialChar TeX
19189 makes more noise than suits your mood.
19190 Then you can choose not to use it, wait until your mood changes, or try
19193 Chk\SpecialChar TeX
19196 to get better along with you.
19199 \begin_layout Standard
19202 Chk\SpecialChar TeX
19209 very configurable and extensible, you should not expect to solve all problems
19212 Chk\SpecialChar TeX
19215 in \SpecialChar LyX
19217 Since \SpecialChar LyX
19218 has to generate a somewhat special \SpecialChar LaTeX
19219 file to be able to match the
19220 line numbers from the
19222 Chk\SpecialChar TeX
19229 \begin_layout Plain Layout
19230 You can inspect the specific output from
19236 Document\SpecialChar menuseparator
19239 \begin_inset space ~
19253 to the internal document structure, some of the warnings will not appear
19255 There are two things you can do about this:
19258 \begin_layout Itemize
19261 Chk\SpecialChar TeX
19264 invocation command line in
19265 \begin_inset Flex Noun
19268 \begin_layout Plain Layout
19269 Tools\SpecialChar menuseparator
19270 Preferences\SpecialChar menuseparator
19271 Output\SpecialChar menuseparator
19272 LaTeX\SpecialChar menuseparator
19280 Chk\SpecialChar TeX
19283 installation configuration file (usually with the file
19288 See below to learn what warnings can be enabled and disabled on the command
19292 \begin_layout Itemize
19293 Export your document as a raw \SpecialChar LaTeX
19296 File\SpecialChar menuseparator
19297 Export\SpecialChar menuseparator
19306 Invoked in this way, it can be a hassle to find the corresponding place
19307 in the document inside \SpecialChar LyX
19308 , but with a little patience, you should be able
19312 \begin_layout Standard
19313 Here follows the warning messages that can be enabled and disabled in
19322 to disable a warning, and
19326 to enable a warning.
19327 The emphasized entries are disabled by default, because the default is
19330 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19335 \begin_layout Standard
19336 Notice that you should only use the options that enable and disable warnings,
19337 because \SpecialChar LyX
19338 relies on some of the other command line parameters to be set
19339 in a specific way to have a chance to communicate with
19346 \begin_layout Enumerate
19350 Command terminated with space.
19353 \begin_layout Enumerate
19356 Non-breaking space (
19357 \begin_inset Quotes eld
19365 \begin_inset Quotes erd
19368 ) should have been used.
19371 \begin_layout Enumerate
19375 You should enclose the previous parenthesis with
19376 \begin_inset Quotes eld
19384 \begin_inset Quotes erd
19390 \begin_layout Enumerate
19393 Italic correction (
19394 \begin_inset Quotes eld
19404 \begin_inset Quotes erd
19407 ) found in non-italic buffer.
19410 \begin_layout Enumerate
19413 Italic correction (
19414 \begin_inset Quotes eld
19424 \begin_inset Quotes erd
19427 ) found more than once.
19430 \begin_layout Enumerate
19434 No italic correction (
19435 \begin_inset Quotes eld
19445 \begin_inset Quotes erd
19451 \begin_layout Enumerate
19455 \begin_inset Quotes eld
19463 \begin_inset Quotes erd
19467 \begin_inset Quotes eld
19475 \begin_inset Quotes erd
19481 \begin_layout Enumerate
19484 Wrong length of dash may have been used.
19487 \begin_layout Enumerate
19491 \begin_inset Quotes eld
19499 \begin_inset Quotes erd
19503 \begin_inset Quotes eld
19511 \begin_inset Quotes erd
19517 \begin_layout Enumerate
19521 \begin_inset Quotes eld
19529 \begin_inset Quotes erd
19535 \begin_layout Enumerate
19539 \begin_inset Quotes eld
19547 \begin_inset Quotes erd
19550 to achieve an ellipsis.
19553 \begin_layout Enumerate
19556 Inter-word spacing (
19557 \begin_inset Quotes eld
19567 \begin_inset Quotes eld
19570 ) should perhaps be used.
19573 \begin_layout Enumerate
19576 Inter-sentence spacing (
19577 \begin_inset Quotes eld
19587 \begin_inset Quotes erd
19590 ) should perhaps be used.
19593 \begin_layout Enumerate
19596 Could not find argument for command.
19599 \begin_layout Enumerate
19603 \begin_inset Quotes eld
19611 \begin_inset Quotes erd
19617 \begin_layout Enumerate
19620 Math mode still on at end of \SpecialChar LaTeX
19624 \begin_layout Enumerate
19628 \begin_inset Quotes eld
19636 \begin_inset Quotes erd
19639 doesn't match the number of
19640 \begin_inset Quotes eld
19648 \begin_inset Quotes erd
19654 \begin_layout Enumerate
19657 You should use either
19660 \begin_inset Quotes eld
19668 \begin_inset Quotes erd
19673 as an alternative to
19674 \begin_inset Quotes eld
19682 \begin_inset Quotes erd
19688 \begin_layout Enumerate
19695 " (ASCII 39) instead of "
19702 \begin_layout Enumerate
19705 User-specified pattern found.
19708 \begin_layout Enumerate
19711 This command might not be intended.
19714 \begin_layout Enumerate
19721 \begin_layout Enumerate
19739 \begin_layout Enumerate
19742 Delete this space to maintain correct page references.
19745 \begin_layout Enumerate
19749 You might wish to put this between a pair of
19750 \begin_inset Quotes eld
19758 \begin_inset Quotes erd
19764 \begin_layout Enumerate
19767 You ought to remove spaces in front of punctuation.
19770 \begin_layout Enumerate
19773 Could not execute \SpecialChar LaTeX
19777 \begin_layout Enumerate
19786 in front of small punctuation.
19789 \begin_layout Enumerate
19797 may look prettier here.
19800 \begin_layout Enumerate
19804 Multiple spaces detected in output.
19807 \begin_layout Enumerate
19810 This text may be ignored.
19813 \begin_layout Enumerate
19819 \begin_inset Quotes eld
19824 to begin quotation, not
19831 \begin_layout Enumerate
19838 to end quotation, not
19841 \begin_inset Quotes eld
19849 \begin_layout Enumerate
19855 \begin_layout Enumerate
19858 You should perhaps use
19859 \begin_inset Quotes eld
19867 \begin_inset Quotes erd
19873 \begin_layout Enumerate
19876 You should put a space in front of/after parenthesis.
19879 \begin_layout Enumerate
19882 You should avoid spaces in front of/after parenthesis.
19885 \begin_layout Enumerate
19889 You should not use punctuation in front of/after quotes.
19892 \begin_layout Enumerate
19895 Double space found.
19898 \begin_layout Enumerate
19901 You should put punctuation outside inner/inside display math mode.
19904 \begin_layout Enumerate
19907 You ought to not use primitive \SpecialChar TeX
19908 in \SpecialChar LaTeX
19912 \begin_layout Enumerate
19915 You should remove spaces in front of
19916 \begin_inset Quotes eld
19924 \begin_inset Quotes erd
19930 \begin_layout Enumerate
19933 \begin_inset Quotes eld
19941 \begin_inset Quotes erd
19944 is normally not followed by
19945 \begin_inset Quotes eld
19953 \begin_inset Quotes erd
19959 \begin_layout Standard
19960 In later versions of \SpecialChar LyX
19961 , we hope to provide a more complete interface to this
19962 tool (and it's smaller cousin
19966 ) to exploit the full power of it.
19967 But it's not exactly useless as it is now: go try it on one of your existing
19968 documents of a certain length and be surprised.
19971 \begin_layout Section
19972 Version Control in \SpecialChar LyX
19976 \begin_layout Standard
19979 Lars Gullik Bjønnes
19986 \begin_layout Subsection
19990 \begin_layout Standard
19992 supports some of the most basic RCS/CVS/SVN/GIT commands.
19993 If you need something a bit more sophisticated you will have to do that
19994 manually in a terminal.
19997 \begin_layout Standard
19998 Also note that CVS support is not as good as subversion support so we advise
20000 A good place to start learning Subversion is SVN Book
20004 \begin_layout Plain Layout
20005 \begin_inset CommandInset href
20007 target "http://svnbook.red-bean.com/"
20018 In the case of RCS you should read
20019 \begin_inset Quotes eld
20023 \begin_inset Quotes erd
20026 (a man file, read it with
20031 This file describes all the basic features of RCS.
20032 You should especially notice the comment about a RCS directory, and the
20033 notion of a master RCS file (the file ending in
20040 \begin_layout Standard
20041 Before you begin to use the version control features in \SpecialChar LyX
20043 familiar with RCS/CVS/SVN/GIT usage.
20044 The implementation in \SpecialChar LyX
20045 assumes a recent version of the GNU RCS or CVS/SVN
20046 package — no guarantees are made for older versions.
20047 Most of the log messages are not currently displayed after operations —
20048 you can check them in the Messages pane if unsure.
20049 Regular users of version control will appreciate VC toolbar, which can
20052 View\SpecialChar menuseparator
20053 Toolbars\SpecialChar menuseparator
20055 \begin_inset space ~
20063 \begin_layout Standard
20064 For introducing your own external commands consult vc-command in the manual
20065 of \SpecialChar LyX
20069 \begin_layout Standard
20070 It is strongly recommended to store documents in uncompressed format if
20071 using version control (uncheck
20073 Document\SpecialChar menuseparator
20076 if it is checked): Uncompressed LyX documents are text files and therefore
20077 for merging two different versions by version control systems.
20078 Compressed LyX documents are binary files, which cannot be merged by version
20082 \begin_layout Subsection
20083 RCS commands in \SpecialChar LyX
20087 \begin_layout Standard
20088 The following sections describe the RCS commands supported by \SpecialChar LyX
20090 You can find them in the
20092 File\SpecialChar menuseparator
20094 \begin_inset space ~
20101 was tested against RCS 5.7/5.8.
20104 \begin_layout Subsubsection
20110 \begin_layout Standard
20111 If your document is not under revision control, this is the only item shown
20113 And if it is under revision control, the
20117 item is not visible.
20121 \begin_layout Standard
20122 This command registers your document with RCS (unless you are under the
20123 directory managed by CVS)\SpecialChar endofsentence
20124 You are asked interactively to supply an initial
20125 description of the document.
20126 The document is now set in Read-Only mode and you have to
20129 \begin_inset space ~
20133 \begin_inset space ~
20137 \begin_inset space ~
20142 , before making any changes to it.
20143 A document under revision control has a
20144 \begin_inset Quotes eld
20147 [RCS:<version> <locker>]
20148 \begin_inset Quotes erd
20151 item tagged to the filename in the minibuffer.
20154 \begin_layout Standard
20155 RCS command that is run:
20157 ci -q -u -i -t-"<initial description>" <file-name>
20160 \begin_layout Standard
20165 to understand the switches.
20169 \begin_layout Subsubsection
20175 \begin_layout Standard
20176 When you are finished editing a file, you check in your changes.
20177 When you do this, you are asked for a description of the changes.
20178 This is stored in the history log.
20179 The version number is bumped, your changes are applied to the master RCS
20180 file, the document is unlocked and set to Read-Only mode.
20183 \begin_layout Standard
20186 ci -q -u -m"<description>" <file-name>
20189 \begin_layout Subsubsection
20195 \begin_layout Standard
20196 By doing this you lock the document so that only you can edit it.
20197 This will also make the document Read-Write only for you.
20198 You will usually continue editing for a while and when you are finished
20199 you check in your changes.
20200 The status line is changed to reflect that you have locked the file.
20203 \begin_layout Standard
20206 co -q -l <file-name>
20209 \begin_layout Subsubsection
20212 Revert To Repository Version
20215 \begin_layout Standard
20216 This will discard all changes made to the document since the last check
20218 You get a warning before changes are discarded.
20221 \begin_layout Standard
20224 co -f -u<version> <file-name>
20227 \begin_layout Subsubsection
20233 \begin_layout Standard
20234 This will create a copy of the current document.
20235 Since RCS does not support copy operations natively, the version history
20236 is not preserved, and the copy is added as a new file.
20237 It requires a clean document without any changes since the last checkin.
20238 You are asked for a file name and a description of the copy operation.
20239 After that the copy is created, both locally and in the repository.
20240 If the parent directories of the copied and original document differ, all
20241 relative paths of included files of the copy are adjusted (like in
20243 File\SpecialChar menuseparator
20248 Finally, the copy is loaded instead of the original document.
20251 \begin_layout Labeling
20252 \labelwidthstring 00.00.0000
20254 \begin_inset space ~
20258 \begin_inset space ~
20262 \begin_inset Newline newline
20266 \begin_inset Flex Code
20269 \begin_layout Plain Layout
20272 \begin_inset Quotes eld
20276 \begin_inset Quotes erd
20285 \begin_inset Flex Code
20288 \begin_layout Plain Layout
20291 \begin_inset Quotes eld
20295 \begin_inset Quotes erd
20304 \begin_inset Newline newline
20308 \begin_inset Flex Code
20311 \begin_layout Plain Layout
20315 \begin_inset Quotes eld
20319 \begin_inset Quotes erd
20330 \begin_layout Subsubsection
20336 \begin_layout Standard
20337 This makes as if the last check in never happened.
20338 No changes are made to the document loaded into \SpecialChar LyX
20339 , but the last version
20340 is removed from the master RCS file.
20343 \begin_layout Standard
20346 rcs -o<version> <file-name>
20349 \begin_layout Subsubsection
20355 \begin_layout Standard
20356 This shows the complete history of the RCS document.
20361 is shown in a browser.
20369 \begin_layout Subsubsection
20373 \begin_layout Standard
20375 supports RCS version number, author name, date and time of last commit.
20376 All those are extracted from
20378 rlog -r <file-name>
20382 \begin_inset CommandInset ref
20384 reference "subsec:VCS-Revision-Information"
20391 \begin_layout Subsection
20392 CVS commands in \SpecialChar LyX
20396 \begin_layout Standard
20397 A subset of CVS operations is supported by \SpecialChar LyX
20399 You can find the commands in the
20401 File\SpecialChar menuseparator
20403 \begin_inset space ~
20409 The version control system SVN is more powerful, so please use it instead
20410 of CVS if possible.
20413 \begin_layout Subsubsection
20419 \begin_layout Standard
20420 If you start from scratch with CVS you have to create your repository and
20421 checkout the working copy with external tools.
20422 If you're using a client-server setup you may need to login before doing
20423 the first repository checkout.
20426 \begin_layout Standard
20427 If your documents are under revision control and others are using the same
20428 repository problems arise when different changes to the same document at
20429 the same location happen.
20430 Standard CVS repositories don't operate with a file locking mechanism.
20431 This may be surprising, but conflicts only occur if people disagree on
20432 the proper content of the same part of a document.
20433 So, if co-workers are used to communicate regularly, these conflicts occur
20435 If they don't communicate they have a fundamental problem anyway.
20436 Nevertheless some people like to work with so called
20437 \begin_inset Quotes eld
20441 \begin_inset Quotes erd
20445 If they do so the working copy of all files is readonly when checked out
20446 first and the user starts editing after using a special command to make
20447 the working copy writable.
20448 When the changes are checked in the working copy returns to readonly state.
20449 With \SpecialChar LyX
20450 one has to edit the
20451 \begin_inset Flex Code
20454 \begin_layout Plain Layout
20460 file and add the line
20461 \begin_inset Flex Code
20464 \begin_layout Plain Layout
20470 to work with reserved checkouts.
20471 The benefit is the possibility to see who is using a writable copy of some
20473 It's not guaranteed only one user makes a copy writable.
20476 \begin_layout Standard
20478 tries to guess if you're using reserved or non-reserved checkouts.
20479 If your working copy is readonly or it is writable and an additional copy
20480 of your document exists in the CVS/Base sub-directory a reserved otherwise
20481 a non-reserved checkout is assumed.
20482 When a reserved checkout is detected you have to use
20483 \begin_inset Flex Noun
20486 \begin_layout Plain Layout
20492 to make your working copy writable if it's readonly.
20494 \begin_inset Flex Noun
20497 \begin_layout Plain Layout
20503 operation is possible and that makes your working copy readonly again after
20504 transferring your changes to the repository.
20507 \begin_layout Standard
20508 More information about CVS can be found here
20509 \begin_inset Flex URL
20512 \begin_layout Plain Layout
20514 http://www.nongnu.org/cvs
20520 \begin_inset Flex URL
20523 \begin_layout Plain Layout
20525 http://ximbiot.com/cvs
20533 \begin_layout Standard
20538 to understand the sub-commands and the switches mentioned below.
20541 \begin_layout Subsubsection
20547 \begin_layout Standard
20548 If your document is not under revision control, this is the only item shown
20550 And if it is under revision control, the
20554 item is not visible.
20558 \begin_layout Standard
20559 This command registers in CVS your document
20560 \begin_inset Flex Strong
20563 \begin_layout Plain Layout
20571 in the case you have already the documents directory under CVS control
20577 This means you have to create or checkout the archive by yourself using
20579 (In case you forget that step \SpecialChar LyX
20580 registers the document with RCS.)
20583 \begin_layout Standard
20584 Then you are asked interactively to supply an initial description of the
20586 Don't forget that registered file is not yet checked in.
20589 \begin_layout Standard
20590 CVS command that is run:
20592 cvs -q add -m"<entered message>" "<file-name>"
20595 \begin_layout Standard
20600 above and for all other CVS commands is an abbreviation for
20601 \begin_inset Quotes eld
20604 change the current working directory to file location and use the file name
20605 without path component as argument
20606 \begin_inset Quotes erd
20612 \begin_layout Subsubsection
20618 \begin_layout Standard
20619 When you are finished editing a file, you commit your changes.
20620 When you do this and you had changed the document, you are asked for a
20621 description of the changes.
20622 After that changes are written to the repository.
20623 In case you didn't change the document and a reserved checkout is detected
20624 the reservation made on
20625 \begin_inset Flex Noun
20628 \begin_layout Plain Layout
20637 \begin_layout Labeling
20638 \labelwidthstring 00.00.0000
20640 \begin_inset space ~
20644 \begin_inset space ~
20648 \begin_inset Newline newline
20652 \begin_inset Flex Code
20655 \begin_layout Plain Layout
20658 -q commit -m"<description>" "<file-name>"
20664 \begin_inset Newline newline
20668 \begin_inset Flex Code
20671 \begin_layout Plain Layout
20682 \begin_layout Subsubsection
20688 \begin_layout Standard
20689 When you are sharing a repository with others, you may have to incorporate
20690 their changes into your working copy.
20693 \begin_layout Standard
20696 cvs -q update "<file-name>"
20699 \begin_layout Standard
20700 If a readonly checkout is detected the working copy is made writable and
20704 \begin_layout Standard
20707 cvs -q edit "<file-name>"
20710 \begin_layout Subsubsection
20713 Revert To Repository Version
20716 \begin_layout Standard
20717 This will discard all changes made to the document since the last check
20719 You get a warning before changes are discarded.
20720 Firstly the file is deleted, secondly CVS update command is run.
20723 \begin_layout Standard
20726 cvs -q update "<file-name>"
20729 \begin_layout Standard
20730 If a reserved checkout is detected and the working copy has no changes only
20731 the reservation is undone.
20734 \begin_layout Standard
20737 cvs -q unedit "<file-name>"
20740 \begin_layout Subsubsection
20746 \begin_layout Standard
20747 This will create a copy of the current document.
20748 Since CVS does not support copy operations natively, the version history
20749 is not preserved, and the copy is added as a new file.
20750 It requires a clean document without any changes since the last checkin.
20751 You are asked for a file name and a description of the copy operation.
20752 After that the copy is created, both locally and in the repository.
20753 If the parent directories of the copied and original document differ, all
20754 relative paths of included files of the copy are adjusted (like in
20756 File\SpecialChar menuseparator
20761 Finally, the copy is loaded instead of the original document.
20764 \begin_layout Labeling
20765 \labelwidthstring 00.00.0000
20767 \begin_inset space ~
20771 \begin_inset space ~
20775 \begin_inset Newline newline
20779 \begin_inset Flex Code
20782 \begin_layout Plain Layout
20785 \begin_inset Quotes eld
20789 \begin_inset Quotes erd
20798 \begin_inset Flex Code
20801 \begin_layout Plain Layout
20804 \begin_inset Quotes eld
20808 \begin_inset Quotes erd
20817 \begin_inset Newline newline
20821 \begin_inset Flex Code
20824 \begin_layout Plain Layout
20828 \begin_inset Quotes eld
20832 \begin_inset Quotes erd
20843 \begin_layout Subsubsection
20849 \begin_layout Standard
20850 This will rename the current document.
20851 Since CVS does not support rename operations natively, the version history
20852 is not preserved, the renamed document is added as a new file, and the
20853 original document is deleted.
20854 It requires a clean document without any changes since the last checkin.
20855 You are asked for a file name and a description of the rename operation.
20856 After that the document is renamed, both locally and in the repository.
20857 If the parent directories of the new and old file names differ, all relative
20858 paths of included files are adjusted (like in
20860 File\SpecialChar menuseparator
20865 Finally, the document is reloaded using the new name.
20868 \begin_layout Labeling
20869 \labelwidthstring 00.00.0000
20871 \begin_inset space ~
20875 \begin_inset space ~
20879 \begin_inset Newline newline
20883 \begin_inset Flex Code
20886 \begin_layout Plain Layout
20889 \begin_inset Quotes eld
20893 \begin_inset Quotes erd
20902 \begin_inset Flex Code
20905 \begin_layout Plain Layout
20908 \begin_inset Quotes eld
20912 \begin_inset Quotes erd
20921 \begin_inset Newline newline
20925 \begin_inset Flex Code
20928 \begin_layout Plain Layout
20932 \begin_inset Quotes eld
20936 \begin_inset Quotes erd
20945 \begin_inset Newline newline
20949 \begin_inset Flex Code
20952 \begin_layout Plain Layout
20956 \begin_inset Quotes eld
20960 \begin_inset Quotes erd
20971 \begin_layout Subsubsection
20972 Update of the local directory checkout from repository
20975 \begin_layout Standard
20976 Once your documents gets more complex, containing sub-documents and pictures,
20978 \begin_inset Flex Code
20981 \begin_layout Plain Layout
20987 files and so on using version control becomes more complicated.
20989 supports updating the whole tree in which resides the document.
20990 This become especially useful once you cooperate with people which neither
20991 have detailed knowledge about CVS usage nor they have ambition to commit
20992 additional material to the repository.
20993 You have to organize the files structure so that all external files are
20994 in the same directory or subdirectories of the document.
20995 It's good practice anyway to store multipart documents in an extra directory.
20998 \begin_layout Standard
21000 \begin_inset Flex Code
21003 \begin_layout Plain Layout
21004 Update local directory from repository
21009 command updates the whole directory.
21010 If local changes are detected user is warned before update starts.
21011 In case of merge conflicts both versions of the conflicting document parts
21012 are placed in the final document.
21013 You have to review and correct the result of the merge.
21014 You'll find the conflicts enclosed in pairs of
21015 \begin_inset Flex Code
21018 \begin_layout Plain Layout
21025 \begin_inset Flex Code
21028 \begin_layout Plain Layout
21035 \begin_inset Flex Code
21038 \begin_layout Plain Layout
21045 The first part is your version as before the update operation with the
21046 document name prepended.
21047 The second one is the repository version with the version number after
21049 \begin_inset Flex Code
21052 \begin_layout Plain Layout
21061 \begin_layout Labeling
21062 \labelwidthstring 00.00.0000
21064 \begin_inset space ~
21068 \begin_inset space ~
21072 \begin_inset Newline newline
21076 \begin_inset Flex Code
21079 \begin_layout Plain Layout
21087 (Ask if changes are detected.)
21088 \begin_inset Newline newline
21092 \begin_inset Flex Code
21095 \begin_layout Plain Layout
21096 cd $path; cvs -q update
21106 \begin_layout Standard
21108 \begin_inset Flex Code
21111 \begin_layout Plain Layout
21117 stands for the path to the document.
21120 \begin_layout Subsubsection
21126 \begin_layout Standard
21127 This shows the complete history of the CVS document.
21130 cvs log "<file-name>"
21132 is shown in a browser.
21135 \begin_layout Subsubsection
21139 \begin_layout Standard
21141 supports CVS version number, author name, date and time of last commit.
21142 All those are extracted from
21144 cvs log -r <file-name>
21148 \begin_inset CommandInset ref
21150 reference "subsec:VCS-Revision-Information"
21157 \begin_layout Subsection
21158 SVN commands in \SpecialChar LyX
21162 \begin_layout Standard
21163 SVN is now partially supported by \SpecialChar LyX
21165 You can find the commands in the
21167 File\SpecialChar menuseparator
21169 \begin_inset space ~
21175 Please note that if you use password protected access to repository via
21176 ssh, you will be asked in terminal window.
21178 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21182 \begin_layout Plain Layout
21183 Most of the commands will work with 1.4 too, see
21184 \begin_inset CommandInset ref
21186 reference "subsec:SVN-Repo-Update"
21191 There seems to be currently unresolved permissions problem under SVN 1.8
21192 with reverting changes when file is locked.
21200 \begin_layout Subsubsection
21206 \begin_layout Standard
21207 If your document is not under revision control, this is the only item shown
21209 And if it is under revision control, the
21213 item is not visible.
21216 \begin_layout Standard
21217 This command registers in SVN your document ONLY in case you have already
21218 the documents directory under SVN control (in particular
21223 This means you have to checkout the archive by yourself.
21226 \begin_layout Standard
21227 Then you are asked interactively to supply an initial description of the
21229 Don't forget that registered file is not yet commited.
21232 \begin_layout Standard
21233 SVN command that is run:
21236 \begin_inset Quotes eld
21240 \begin_inset Quotes erd
21246 \begin_layout Standard
21251 to understand the switches.
21254 \begin_layout Subsubsection
21260 \begin_layout Standard
21261 When you are finished editing a file, you commit your changes.
21262 When you do this, you are asked for a description of the changes.
21263 After that changes are commited.
21266 \begin_layout Standard
21271 \begin_layout Plain Layout
21272 In case locking is not enabled.
21274 \begin_inset CommandInset ref
21276 reference "subsec:SVN-File-Locking"
21287 svn commit -q -m"<description>" <file-name>
21290 \begin_layout Subsubsection
21296 \begin_layout Standard
21297 Updates the changes of this file from the repository.
21298 Be sure you understand SVN merging and conflicts resolving before using
21299 this function, because all conflicts has to be resolved manually by you!
21302 \begin_layout Standard
21307 \begin_layout Plain Layout
21315 svn update --non-interactive
21316 \begin_inset Quotes eld
21320 \begin_inset Quotes erd
21326 \begin_layout Subsubsection
21329 Revert To Repository Version
21332 \begin_layout Standard
21333 This will discard all changes made to the document since the last check
21335 You get a warning before changes are discarded.
21338 \begin_layout Standard
21342 \begin_inset Quotes eld
21346 \begin_inset Quotes erd
21352 \begin_layout Subsubsection
21358 \begin_layout Standard
21359 This will create a copy of the current document including the version history.
21360 It requires a clean document without any changes since the last checkin.
21361 You are asked for a file name and a description of the copy operation.
21362 After that the copy is created, both locally and in the repository.
21363 If the parent directories of the copied and original document differ, all
21364 relative paths of included files of the copy are adjusted (like in
21366 File\SpecialChar menuseparator
21371 Finally, the copy is loaded instead of the original document.
21374 \begin_layout Labeling
21375 \labelwidthstring 00.00.0000
21377 \begin_inset space ~
21381 \begin_inset space ~
21385 \begin_inset Newline newline
21389 \begin_inset Flex Code
21392 \begin_layout Plain Layout
21396 \begin_inset Quotes eld
21400 \begin_inset Quotes erd
21404 \begin_inset Quotes eld
21408 \begin_inset Quotes erd
21417 \begin_inset Newline newline
21421 \begin_inset Flex Code
21424 \begin_layout Plain Layout
21433 \begin_layout Subsubsection
21439 \begin_layout Standard
21440 This will rename the current document including the version history.
21441 It requires a clean document without any changes since the last checkin.
21442 You are asked for a file name and a description of the rename operation.
21443 After that the document is renamed, both locally and in the repository.
21444 If the parent directories of the new and old file names differ, all relative
21445 paths of included files are adjusted (like in
21447 File\SpecialChar menuseparator
21452 Finally, the document is reloaded using the new name.
21455 \begin_layout Labeling
21456 \labelwidthstring 00.00.0000
21458 \begin_inset space ~
21462 \begin_inset space ~
21466 \begin_inset Newline newline
21470 \begin_inset Flex Code
21473 \begin_layout Plain Layout
21477 \begin_inset Quotes eld
21481 \begin_inset Quotes erd
21485 \begin_inset Quotes eld
21489 \begin_inset Quotes erd
21498 \begin_inset Newline newline
21502 \begin_inset Flex Code
21505 \begin_layout Plain Layout
21514 \begin_layout Subsubsection
21515 \begin_inset CommandInset label
21517 name "subsec:SVN-Repo-Update"
21521 Update of the local directory checkout from repository
21525 \begin_layout Plain Layout
21526 Note that this command will work only with subversion
21527 \begin_inset Formula $\geqq1.5$
21538 \begin_layout Standard
21539 All the commands above have one shortcomming - they deal with the current
21541 Once your document contains pictures, includes external
21542 \begin_inset Flex Code
21545 \begin_layout Plain Layout
21551 files and so on administration becomes more complicated.
21553 now supports updating the whole tree in which resides the document
21557 \begin_layout Plain Layout
21558 One need to organize the files structure so that all external files are
21559 in the same directory or subdirectories of the document.
21566 This become especially useful once you cooperate with people which neither
21567 know about subversion management nor they have ambition to commit additional
21568 material to the repository.
21572 \begin_layout Standard
21573 \begin_inset Flex Code
21576 \begin_layout Plain Layout
21577 Update local directory from repository
21582 command updates the whole directory and in case of merge conflicts local
21583 version of the files are left, so no unintended data loss occurs.
21584 If local changes are detected user is warned before update starts.
21587 \begin_layout Labeling
21588 \labelwidthstring 00.00.0000
21590 \begin_inset space ~
21594 \begin_inset space ~
21598 \begin_inset Newline newline
21602 \begin_inset Flex Code
21605 \begin_layout Plain Layout
21611 (Ask if changes are detected.)
21612 \begin_inset Newline newline
21616 \begin_inset Flex Code
21619 \begin_layout Plain Layout
21620 svn update –accept mine-full $path
21628 \begin_layout Standard
21630 \begin_inset Flex Code
21633 \begin_layout Plain Layout
21639 stands for the path to the document.
21642 \begin_layout Subsubsection
21648 \begin_layout Standard
21649 This shows the complete history of the SVN document.
21653 \begin_inset Quotes eld
21657 \begin_inset Quotes erd
21662 is shown in a browser.
21665 \begin_layout Subsubsection
21667 \begin_inset CommandInset label
21669 name "subsec:SVN-File-Locking"
21676 \begin_layout Standard
21677 The file exchange through various revision control systems brings the problem
21678 of merge conflicts in case two different users try to edit the same (parts
21680 When such a conflict happens it needs manual resolving and one reasonable
21681 alternative is to provide some kind of locking mechanism, which guarantees
21682 that only one user is allowed to edit file at the given time.
21685 \begin_layout Standard
21686 SVN has two such mechanisms to provide mutual exclusivity for file access
21687 - locks and automatic setting of write permissions (see sec.
21689 \begin_inset CommandInset ref
21691 reference "subsec:Automatical-Locking-Property"
21696 \begin_inset Flex Code
21699 \begin_layout Plain Layout
21709 \begin_layout Plain Layout
21710 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21716 If this property is detected for a given document \SpecialChar LyX
21717 starts to use SVN locks
21718 for document editing automatically and the whole check-in/out mechanism
21719 switches to the same regimen as for RCS.
21720 This in particular means there are two different modes of file use in \SpecialChar LyX
21724 \begin_layout Itemize
21726 The loaded file is in the read-only mode.
21727 For editing on needs to check-out.
21732 consists of updating from the repository and gaining write lock.
21733 If the lock is not possible to obtain, we remain in unlocked state.
21736 \begin_layout Itemize
21738 The loaded file is in the 'normal' edit mode.
21739 No other user is allowed to edit the file.
21744 consists of commiting changes and releasing write-lock.
21745 If no changes have been made to the document, no commit will be produced
21749 \begin_layout Plain Layout
21750 Don't be puzzled by the fact that you will be asked for commit message anyway.
21755 and only the write-lock will be released.
21758 \begin_layout Standard
21762 \begin_layout Labeling
21763 \labelwidthstring 00.00.0000
21766 svn commit -q -m"<description>" "<file-name>"
21767 \begin_inset Newline newline
21770 svn unlock "<file-name>"
21773 \begin_layout Labeling
21774 \labelwidthstring 00.00.0000
21777 svn update "<file-name>"
21778 \begin_inset Newline newline
21781 svn lock "<file-name>"
21784 \begin_layout Subsubsection
21787 \begin_inset CommandInset label
21789 name "subsec:Automatical-Locking-Property"
21795 Automatic Locking Property
21798 \begin_layout Standard
21799 The above mentioned automatic setting of write permissions of the .lyx file
21802 File\SpecialChar menuseparator
21804 \begin_inset space ~
21807 Control\SpecialChar menuseparator
21808 Toggle locking property
21811 This command is active only when the file is not locked on the svn server
21813 you need to check-out before proceeding).
21816 \begin_layout Labeling
21817 \labelwidthstring 00.00.0000
21819 \begin_inset space ~
21825 \begin_layout Labeling
21826 \labelwidthstring 00.00.0000
21829 svn propset svn:needs-lock ON "<file-name>"
21832 \begin_layout Labeling
21833 \labelwidthstring 00.00.0000
21836 svn propdel svn:needs-lock "<file-name>"
21839 \begin_layout Subsubsection
21840 \begin_inset CommandInset label
21842 name "subsec:VCS-Revision-Information"
21846 Revision Information in Documents
21849 \begin_layout Standard
21850 There are more possibilities how to activate revision information in our
21854 \begin_layout Itemize
21860 \begin_layout Itemize
21861 tree revision information (
21862 \begin_inset Flex Code
21865 \begin_layout Plain Layout
21872 The result is the output of the
21873 \begin_inset Flex Code
21876 \begin_layout Plain Layout
21882 command, the following table gives you an idea, how to read the results.
21885 \begin_layout Standard
21887 \begin_inset Tabular
21888 <lyxtabular version="3" rows="6" columns="2">
21889 <features tabularvalignment="middle">
21890 <column alignment="center" valignment="top">
21891 <column alignment="center" valignment="top">
21893 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21896 \begin_layout Plain Layout
21902 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21905 \begin_layout Plain Layout
21913 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21916 \begin_layout Plain Layout
21922 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21925 \begin_layout Plain Layout
21926 mixed revision working copy
21933 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21936 \begin_layout Plain Layout
21942 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21945 \begin_layout Plain Layout
21946 modified working copy
21953 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21956 \begin_layout Plain Layout
21962 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21965 \begin_layout Plain Layout
21966 switched working copy
21973 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21976 \begin_layout Plain Layout
21982 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21985 \begin_layout Plain Layout
21986 partial working copy, from a sparse checkout
21993 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21996 \begin_layout Plain Layout
22002 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22005 \begin_layout Plain Layout
22006 mixed revision, modified, switched working copy
22019 \begin_layout Itemize
22020 file revision information.
22021 The result comes from parsing the output of
22022 \begin_inset Flex Code
22025 \begin_layout Plain Layout
22027 \begin_inset space ~
22031 \begin_inset space ~
22035 \begin_inset space ~
22044 Supported flags are:
22048 \begin_layout Itemize
22049 version number of the last commit (
22050 \begin_inset Flex Code
22053 \begin_layout Plain Layout
22062 \begin_layout Itemize
22063 author of the last commit (
22064 \begin_inset Flex Code
22067 \begin_layout Plain Layout
22076 \begin_layout Itemize
22077 date of the last commit (
22078 \begin_inset Flex Code
22081 \begin_layout Plain Layout
22090 \begin_layout Itemize
22091 time of the last commit (
22092 \begin_inset Flex Code
22095 \begin_layout Plain Layout
22105 \begin_layout Standard
22106 You can obtain this info via InsetInfo (e.g.
22108 \begin_inset Flex Code
22111 \begin_layout Plain Layout
22112 info-insert buffer vcs-date
22118 The information will be available only when you have the file stored under
22119 svn managment (i.e.
22121 \begin_inset Flex Code
22124 \begin_layout Plain Layout
22130 directory is available with your document).
22134 \begin_layout Itemize
22135 Another—a hacking one—possibility is to use svn keywords
22139 \begin_layout Plain Layout
22140 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22146 In short – you set file keywords property (e.g.
22149 svn propset svn:keywords 'Rev' file.lyx
22151 ) and then paste keyword \SpecialChar TeX
22156 \begin_layout Plain Layout
22157 This is an easy way how to ensure that \SpecialChar LyX
22158 won't break the line in the middle
22164 tag in your document (e.g.
22169 \begin_layout Plain Layout
22177 This way svn client will automatically substitute revision number (e.g.
22182 \begin_layout Plain Layout
22189 ) after each update and commit.
22190 There are more problems with this approach.
22191 Firstly, the '$' character is used in \SpecialChar TeX
22192 world for math equations, so any
22193 occurence of math formula
22194 \begin_inset Formula $Rev$
22198 \begin_inset Formula $Rev:59$
22201 in your \SpecialChar LyX
22203 Similarly for other keywords like Id, Date, Author, etc.
22204 Secondly svn output is dependent on your locales, so its very easy that
22205 svn would produce some problematic strings once Date is used.
22206 Thirdly you get the whole 'Rev: 59' string in your document instead of
22208 Until subversion implements user's custom keywords it will be hard to use
22209 this approach reliably or let \SpecialChar LyX
22210 to support it directly.
22213 \begin_layout Subsection
22214 SVN and Windows Environment
22217 \begin_layout Quote
22218 My inclination is to say that if the user cannot figure out the command
22219 line operations on their own fairly quickly, they would be well advised
22220 to use TortoiseSVN.
22226 \begin_layout Subsubsection
22230 \begin_layout Standard
22231 In addition to installing \SpecialChar LyX
22232 , and having access to a Subversion repository,
22233 the user will need to install the Subversion client program.
22234 A Windows installer for the client program is available from
22235 \begin_inset CommandInset href
22238 target "http://www.collab.net/nonav/downloads/subversion/"
22244 The user may also want to install
22245 \begin_inset CommandInset href
22248 target "http://tortoisesvn.tigris.org/"
22253 , which integrates Subversion operations into the context (rightclick) menu
22254 of Windows Explorer.
22255 Operations done outside \SpecialChar LyX
22256 will typically be more convenient using the Explorer
22258 Note that TortoiseSVN is not a replacement for the client program, which
22259 is what \SpecialChar LyX
22263 \begin_layout Subsubsection
22264 Bringing a document under Subversion control
22267 \begin_layout Standard
22268 Before a \SpecialChar LyX
22269 document can be brought under version control in Subversion, its
22270 parent directory needs to be under version control.
22271 If the document is being added to a project already in the repository,
22272 this is accomplished by checking the project out to the directory where
22273 the new document will be placed.
22274 If the project itself is not yet under version control (for instance, if
22275 this document starts a new project), the directory must be imported into
22277 This is done outside \SpecialChar LyX
22279 Both import and checkout are easily accomplished from the Explorer context
22280 menu using TortoiseSVN, or alternatively can be done using the command
22281 line client at a DOS prompt.
22282 The procedure for importing the project using TortoiseSVN is described
22283 below, assuming an existing repository and a new project being started
22291 For information on using the Subversion client program, run
22298 \begin_layout Enumerate
22305 in Windows Explorer, right click it, and select
22307 TortoiseSVN\SpecialChar menuseparator
22311 If necessary, adjust the URL for the repository, then click OK.
22314 \begin_layout Enumerate
22315 Right click the level of the repository under which you want to place the
22316 new project folder (typically the top level) and click
22320 Supply a name for the project folder and click OK.
22321 Add a message for the log file if desired, then click OK again.
22322 The new project folder should appear in the repository.
22323 Finally, click OK again to exit the repository browser.
22326 \begin_layout Enumerate
22327 Once again right click
22333 , this time selecting SVN Checkout\SpecialChar ldots
22334 Select the URL of the project folder
22335 you just created in the repository, and set the checkout directory to
22343 You will be warned about a non-empty folder; click OK to proceed.
22344 You should now have a
22355 \begin_layout Enumerate
22356 Create or open your document in \SpecialChar LyX
22359 File\SpecialChar menuseparator
22361 \begin_inset space ~
22364 Control\SpecialChar menuseparator
22368 Add a log message and click OK to commit the document to version control.
22371 \begin_layout Standard
22372 From this point onward, you should have full functionality in the
22374 File\SpecialChar menuseparator
22376 \begin_inset space ~
22382 You also have the option of checking the document in and out, viewing its
22384 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22385 client program from a command prompt.
22388 \begin_layout Subsubsection
22389 SSH tunnel used with SVN under Windows
22392 \begin_layout Standard
22393 Compared with Linux setting up an svn client to communicate over ssh under
22394 Windows is a rather troublesome task.
22395 We will at least offer some hints how to setup the client side but prior
22396 knowledge about ssh and the Windows command line is needed, also be prepared
22397 for a great deal of frustration\SpecialChar ldots
22401 \begin_layout Enumerate
22402 Get an svn client for windows, as described in the previous sections.
22403 When it is a fresh install run some svn command (e.g.
22405 \begin_inset Flex Code
22408 \begin_layout Plain Layout
22414 ) to create config files, which you will need to change later on.
22417 \begin_layout Enumerate
22418 Choose an ssh client for Windows.
22419 There are several possibilities, we will use the one from Putty tools
22423 \begin_layout Plain Layout
22424 \begin_inset Flex URL
22427 \begin_layout Plain Layout
22429 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22440 You will need to set the connection up so that the client doesn't ask for
22441 any password from you.
22442 To keep things easy we will use only keys without any additional password
22447 \begin_layout Enumerate
22449 \begin_inset Flex Code
22452 \begin_layout Plain Layout
22459 Save your private .ppk key file and put the public one on the server side.
22460 If the SVN server runs on Linux, note that the format of the public key
22461 is not compatible with Linux openssh and you will need to direcly copy-paste
22464 Public key for pasting into OpenSSH authorized_keys file
22466 :” edit field into the server's
22467 \begin_inset Flex Code
22470 \begin_layout Plain Layout
22471 ~/.ssh/authorized_keys
22477 \begin_inset Flex Code
22480 \begin_layout Plain Layout
22489 \begin_layout Enumerate
22491 \begin_inset Flex Code
22494 \begin_layout Plain Layout
22501 In the SVN config file
22505 \begin_layout Plain Layout
22506 Exact path depends on Windows version, usually somewhere around
22507 \begin_inset Flex Code
22510 \begin_layout Plain Layout
22513 Documents and Settings
22527 \begin_inset Flex Code
22530 \begin_layout Plain Layout
22545 , section [tunnels], setup ssh command, e.g.
22547 \begin_inset Flex Code
22550 \begin_layout Plain Layout
22551 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22560 \begin_layout Plain Layout
22561 It will usually take a lot of time to get exact command right and it depends
22563 For example do not have some remote server saved as a default session in
22565 If things fail, try to connect via plink without SVN first.
22574 \begin_layout Enumerate
22575 Checkout the SVN archive, e.
22576 \begin_inset space \thinspace{}
22580 \begin_inset Newline newline
22584 \begin_inset Flex Code
22587 \begin_layout Plain Layout
22588 svn co svn+ssh://user@server/repository_path
22596 \begin_layout Subsubsection
22597 End-of-Line Conversions
22600 \begin_layout Standard
22601 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22603 use different line endings inside the .lyx files.
22604 This is not a problem as far as \SpecialChar LyX
22605 functionality is concerned, but the commit
22606 diffs will be huge and merge-conflicts prone.
22607 Fortunately SVN itself knows
22611 \begin_layout Plain Layout
22612 \begin_inset Flex URL
22615 \begin_layout Plain Layout
22617 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22627 how to deal with CR/LF problems when switching .lyx files to the
22628 \begin_inset Flex Code
22631 \begin_layout Plain Layout
22641 \begin_layout Plain Layout
22643 \begin_inset Flex Code
22646 \begin_layout Plain Layout
22647 svn propset svn:eol-style native FILE_NAME
22660 \begin_layout Subsection
22661 GIT commands in \SpecialChar LyX
22665 \begin_layout Standard
22666 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22668 You can find the commands in the
22670 File\SpecialChar menuseparator
22672 \begin_inset space ~
22678 Please note that if you use password protected access to repository via
22679 ssh, you will be asked in terminal window.
22681 was tested against GIT 1.7.
22685 \begin_layout Plain Layout
22686 Windows users please note that you need to ensure that git is on the path.
22687 This can be set from within \SpecialChar LyX
22690 Tools\SpecialChar menuseparator
22691 Preferences\SpecialChar menuseparator
22692 Paths\SpecialChar menuseparator
22703 \begin_layout Standard
22704 One big difference of GIT and the other supported version control systems
22705 is the distributed nature of GIT: With traditional version control systems
22706 there is one central server which hosts the repository.
22707 Users commit their changes to the server, and get updates made by other
22709 With GIT, users commit to a local repository.
22710 The local repository can be synchronized with one or more remote repositories
22712 \begin_inset Flex Code
22715 \begin_layout Plain Layout
22722 \begin_inset Flex Code
22725 \begin_layout Plain Layout
22733 does not interact in any way with remote GIT repositories.
22734 It works exclusively with the local repository in a very similar way as
22735 with a central CVS or SVN repository.
22736 If you use remote GIT repositories you need to do the
22737 \begin_inset Flex Code
22740 \begin_layout Plain Layout
22747 \begin_inset Flex Code
22750 \begin_layout Plain Layout
22756 operations with your favourite GIT client.
22759 \begin_layout Subsubsection
22765 \begin_layout Standard
22766 If your document is not under revision control, this is the only item shown
22768 And if it is under revision control, the
22772 item is not visible.
22775 \begin_layout Standard
22776 This command registers in GIT your document ONLY in case you have already
22777 the documents directory under GIT control (in particular
22782 This means you have to checkout the archive by yourself.
22785 \begin_layout Standard
22786 Then you are asked interactively to supply an initial description of the
22788 Don't forget that registered file is not yet commited.
22791 \begin_layout Standard
22792 GIT command that is run:
22795 \begin_inset Quotes eld
22799 \begin_inset Quotes erd
22805 \begin_layout Standard
22810 to understand the switches.
22813 \begin_layout Subsubsection
22819 \begin_layout Standard
22820 When you are finished editing a file, you commit your changes.
22821 When you do this, you are asked for a description of the changes.
22822 After that changes are commited.
22825 \begin_layout Standard
22828 git commit -q -m"<description>" <file-name>
22831 \begin_layout Subsubsection
22834 Revert To Repository Version
22837 \begin_layout Standard
22838 This will discard all changes made to the document since the last check
22840 You get a warning before changes are discarded.
22843 \begin_layout Standard
22847 \begin_inset Quotes eld
22851 \begin_inset Quotes erd
22857 \begin_layout Subsubsection
22863 \begin_layout Standard
22864 This will rename the current document including the version history.
22865 It requires a clean document without any changes since the last checkin.
22866 You are asked for a file name and a description of the rename operation.
22867 After that the document is renamed, both locally and in the repository.
22868 If the parent directories of the new and old file names differ, all relative
22869 paths of included files are adjusted (like in
22871 File\SpecialChar menuseparator
22876 Finally, the document is reloaded using the new name.
22879 \begin_layout Labeling
22880 \labelwidthstring 00.00.0000
22882 \begin_inset space ~
22886 \begin_inset space ~
22890 \begin_inset Newline newline
22894 \begin_inset Flex Code
22897 \begin_layout Plain Layout
22901 \begin_inset Quotes eld
22905 \begin_inset Quotes erd
22909 \begin_inset Quotes eld
22913 \begin_inset Quotes erd
22922 \begin_inset Newline newline
22926 \begin_inset Flex Code
22929 \begin_layout Plain Layout
22938 \begin_layout Subsubsection
22944 \begin_layout Standard
22945 This shows the complete history of the GIT document.
22949 \begin_inset Quotes eld
22953 \begin_inset Quotes erd
22958 is shown in a browser.
22961 \begin_layout Subsubsection
22965 \begin_layout Standard
22967 supports GIT hash number of the last commit to the file, author name, date
22968 and time of last commit.
22969 All those are extracted from
22971 git log -n 1 --pretty=format:%H%n%an%n%ai
22974 Tree version information is obtained via
22976 git describe --abbrev --dirty --long
22980 \begin_inset CommandInset ref
22982 reference "subsec:VCS-Revision-Information"
22989 \begin_layout Subsection
22993 \begin_layout Standard
22994 With the recent addition of the vc-command function \SpecialChar LyX
22995 power users are allowed
22996 to create their own commands for revision control.
22999 \begin_layout Standard
23000 As an example you can see how two TortoiseSVN commands could be integrated
23004 \begin_layout Description
23006 \begin_inset Flex Code
23009 \begin_layout Plain Layout
23010 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23018 \begin_layout Description
23020 \begin_inset Flex Code
23023 \begin_layout Plain Layout
23024 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23032 \begin_layout Subsection
23033 Version control and Document comparison
23036 \begin_layout Standard
23037 One of the typical uses of version control is to inspect the changes between
23038 revisions, usually by creating
23039 \begin_inset Flex Code
23042 \begin_layout Plain Layout
23049 While this is useful for plain text files, it is much less useful in the
23050 case of \SpecialChar LyX
23051 files, which have more a complicated structure.
23052 Hence we provide binding to the Document comparison feature.
23053 There are two ways of calling this feature - either by direct call of
23054 \begin_inset Flex Code
23057 \begin_layout Plain Layout
23064 function (for details see \SpecialChar LyX
23065 functions manual) or by icon/menu item
23066 \begin_inset Flex Noun
23069 \begin_layout Plain Layout
23070 Compare with older revision...
23076 One can either compare two chosen revisions of the document or he can simply
23077 compare the current version of edited text with older revisions (where
23079 \begin_inset Flex Noun
23082 \begin_layout Plain Layout
23088 ' revisions back means comparison of the edited file with last commited
23093 \begin_layout Standard
23094 This feature is supported for SVN and RCS though due to the more complicated
23095 versioning scheme of RCS there is a constraint – when addressing the revisions
23096 in dialog, numbers always point to the last number in RCS revision number,
23099 We don't currently support GIT addressing of revisions, one can just compare
23100 edited document with its revision X steps backs, where X is addressed as
23104 \begin_layout Section
23105 Literate Programming
23108 \begin_layout Standard
23113 (kayvan@sylvan.com)
23117 original documentation written by
23119 Edmar Wienskoski Jr.
23122 (edmar-w-jr@technologist.com)
23125 \begin_layout Subsection
23129 \begin_layout Standard
23130 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23132 programming, where it is assumed that you are familiar with this programming
23133 technique, and know what
23134 \begin_inset Quotes eld
23138 \begin_inset Quotes erd
23142 \begin_inset Quotes eld
23146 \begin_inset Quotes erd
23150 If that is not the case, please follow the web links provided in the following
23152 There is a lot of good documentation out there covering old development
23153 history to the latest tools tips.
23156 \begin_layout Standard
23157 It is also assumed that you are familiar with \SpecialChar LyX
23158 itself to a point that you
23159 are comfortable changing your \SpecialChar LyX
23160 preferences, and X resources file.
23161 If that is not the case please refer to other \SpecialChar LyX
23162 documentation to cover your
23166 \begin_layout Subsection
23167 Literate Programming
23170 \begin_layout Standard
23171 From the Literate Programming FAQ:
23174 \begin_layout Quotation
23175 Literate programming is the combination of documentation and source together
23176 in a fashion suited for reading by human beings.
23177 In fact, literate programs should be enjoyable reading, even inviting!
23178 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23179 and documentation in a single file.
23180 Literate programming tools then parse the file to produce either readable
23181 documentation or compilable source.
23182 The WEB style of literate programming was created by D.
23183 \begin_inset space \thinspace{}
23187 Knuth during the development of his \SpecialChar TeX
23188 typesetting software.
23192 \begin_layout Standard
23193 Another excerpt says:
23196 \begin_layout Quotation
23199 How is literate programming different from verbose commenting?
23202 \begin_layout Quotation
23203 There are three distinguishing characteristics.
23204 In order of importance, they are:
23208 \begin_layout Itemize
23209 flexible order of elaboration
23212 \begin_layout Itemize
23213 automatic support for browsing
23216 \begin_layout Itemize
23217 typeset documentation, especially diagrams and mathematics
23221 \begin_layout Standard
23222 Now that I sparked your curiosity, take a look in the references.
23225 \begin_layout Subsubsection
23229 \begin_layout Standard
23230 The complete Literate Programming FAQ can be found at:
23233 \begin_layout Quote
23234 Literate Programming FAQ
23235 \begin_inset Flex URL
23238 \begin_layout Plain Layout
23240 http://www.literateprogramming.com/lpfaq.pdf
23248 \begin_layout Standard
23249 The FAQ lists 23 (twenty three!) different literate programming tools.
23250 Where some are specialized or
23251 \begin_inset Quotes eld
23255 \begin_inset Quotes erd
23258 for particular programming languages, while other have general scope.
23263 for my own use for several reasons:
23266 \begin_layout Itemize
23267 It can generate the documentation either in \SpecialChar LaTeX
23271 \begin_layout Itemize
23272 It has a open architecture, i.
23273 \begin_inset space \thinspace{}
23277 \begin_inset space \space{}
23280 it is easy to plug in new filters and to perform special processing that
23285 \begin_layout Itemize
23286 There is a good selection of filters available already (the HTML is one
23290 \begin_layout Itemize
23294 \begin_layout Standard
23295 The Noweb web page can be found at:
23298 \begin_layout Quote
23300 \begin_inset Flex URL
23303 \begin_layout Plain Layout
23305 http://www.cs.virginia.edu/~nr/noweb/
23313 \begin_layout Standard
23314 Starting from there you can reach many other interesting links and even
23315 some literate program examples.
23318 \begin_layout Subsection
23320 and Literate Programming with Noweb
23323 \begin_layout Standard
23324 The \SpecialChar LyX
23325 support for Literate Programming is provided by using the generic \SpecialChar LyX
23327 converters mechanism.
23328 This support is provided in a
23329 \begin_inset Quotes eld
23333 \begin_inset Quotes erd
23337 \begin_inset space \thinspace{}
23341 \begin_inset space \space{}
23344 you will be able to use this new \SpecialChar LyX
23345 feature with some other literate programming
23346 tool of your choice by just changing your \SpecialChar LyX
23350 \begin_layout Subsubsection
23351 Generating documents and code (weaving and tangling)
23354 \begin_layout Paragraph
23355 Using the noweb module
23358 \begin_layout Standard
23359 If you have installed Noweb and \SpecialChar LyX
23360 successfully, whenever you open a new document,
23361 after you have chosen its document class, use the Document->Settings menu
23363 \begin_inset Quotes eld
23367 \begin_inset Quotes erd
23371 If Noweb is correctly installed, when you click on the
23372 \begin_inset Quotes eld
23376 \begin_inset Quotes erd
23379 link, you will see the
23380 \begin_inset Quotes eld
23384 \begin_inset Quotes erd
23387 module in the available list and you can add it to your document.
23390 \begin_layout Paragraph
23394 \begin_layout Standard
23396 enables you to write code with a layout named
23397 \begin_inset Flex Noun
23400 \begin_layout Plain Layout
23407 Noweb delimits chunks like this:
23410 \begin_layout LyX-Code
23414 \begin_layout LyX-Code
23418 \begin_layout LyX-Code
23422 \begin_layout LyX-Code
23426 \begin_layout LyX-Code
23430 \begin_layout Standard
23431 The problem is that whatever is written in between the << and the
23435 must be taken literally, i.
23436 \begin_inset space \thinspace{}
23440 \begin_inset space \space{}
23444 should be prevented from making any special interpretation of what has
23446 This is also handled by
23447 \begin_inset Flex Noun
23450 \begin_layout Plain Layout
23456 , that works like a normal paragraph but has a free spacing capability.
23459 \begin_layout Standard
23460 As a special note, you can also use the
23461 \begin_inset Quotes eld
23465 \begin_inset Quotes erd
23468 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23472 \begin_layout LyX-Code
23476 \begin_layout LyX-Code
23477 def some_function(args):
23480 \begin_layout LyX-Code
23481 "This is the doc string for this function."
23484 \begin_layout LyX-Code
23485 print "My args: ", args
23488 \begin_layout LyX-Code
23489 @ %def some_function
23492 \begin_layout Standard
23493 For an example of this usage and the resulting cross-reference output, look
23494 at the Literate python program in
23496 LIBDIR/examples/listerrors.lyx
23498 which should make this all clear.
23501 \begin_layout Paragraph
23502 Generating the documentation
23505 \begin_layout Standard
23506 At this point you already have a new document file with a proper document
23507 class, and with some code and text on it.
23508 How do I print it? The answer is simple, you select
23510 View\SpecialChar menuseparator
23514 Just like you would do for a plain document.
23515 No special procedure is required.
23518 \begin_layout Standard
23519 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23523 \begin_layout Enumerate
23526 Update\SpecialChar menuseparator
23529 menu option is chosen, a \SpecialChar LaTeX
23535 \begin_layout Standard
23536 If the document is of any literate class the generated file will be named
23537 with an extension name defined by the
23538 \begin_inset Quotes eld
23542 \begin_inset Quotes erd
23545 format (defined in the Preferences panel), otherwise the file will have
23554 \begin_layout Enumerate
23555 Note that the only difference so far is in the name of the file, no special
23556 processing is required by \SpecialChar LyX
23558 Given that you formatted the code using the
23559 \begin_inset Flex Noun
23562 \begin_layout Plain Layout
23568 layout that, by itself, takes care of the business.
23571 \begin_layout Enumerate
23572 If the document is of any literate class \SpecialChar LyX
23573 will then use the internal \SpecialChar LyX
23575 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23580 \begin_layout Plain Layout
23581 The converters are defined in the
23583 Tools\SpecialChar menuseparator
23587 \begin_inset Quotes eld
23591 \begin_inset Quotes erd
23603 manual for general information about converters.
23608 to generate the \SpecialChar LaTeX
23613 \begin_layout Standard
23614 Otherwise it will just skip this step.
23618 \begin_layout Enumerate
23619 Finally, \SpecialChar LaTeX
23620 is invoked and the regular post processing continues as in a plain
23624 \begin_layout Standard
23625 Independence from a particular
23626 \begin_inset Quotes eld
23630 \begin_inset Quotes erd
23633 is easily achieved by changing the commands that are run by the various
23637 \begin_layout Paragraph
23638 Generating the code
23641 \begin_layout Standard
23642 When the build menu option is chosen or the corresponding button in the
23643 toolbar is pressed, a \SpecialChar LaTeX
23644 file is generated just like step 1 above.
23645 Next, \SpecialChar LyX
23651 This converter needs to be defined by the user and is not installed by
23652 default, though the Program format is.
23653 This converter (like any other converter) will have two parts:
23656 \begin_layout Enumerate
23657 The converter program itself.
23658 This program performs the conversion from the one format to the other (in
23659 this case, from the Noweb format to the Program pseudo-format).
23662 \begin_layout Enumerate
23663 The error log parser.
23664 This is a program whose sole purpose is to rewrite error messages in a
23665 format that \SpecialChar LyX
23667 This makes it possible for \SpecialChar LyX
23668 to place error boxes in the right places in
23672 \begin_layout Standard
23673 The first part, the
23674 \begin_inset Quotes eld
23678 \begin_inset Quotes erd
23681 setting, should be set to
23682 \begin_inset Newline newline
23686 \begin_inset Quotes eld
23694 \begin_inset Quotes erd
23698 \begin_inset Newline newline
23701 This basically means that \SpecialChar LyX
23703 \begin_inset Quotes eld
23707 \begin_inset Quotes erd
23710 (a program or script) with the name of the Noweb file (normally a file
23711 in the \SpecialChar LyX
23712 temp directory) and the directory path of the original \SpecialChar LyX
23717 \begin_layout Standard
23718 This is an implementation of
23719 \begin_inset Quotes eld
23723 \begin_inset Quotes erd
23726 that you can place in a directory on your path:
23729 \begin_layout Standard
23730 \begin_inset VSpace defskip
23736 \begin_layout Standard
23737 \begin_inset Newpage pagebreak
23743 \begin_layout Standard
23749 \begin_layout Standard
23755 \begin_layout Standard
23758 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23761 \begin_layout Standard
23762 \begin_inset VSpace defskip
23768 \begin_layout Standard
23769 The next part of the converter setting is the
23770 \begin_inset Quotes eld
23774 \begin_inset Quotes erd
23777 which is to be set to
23778 \begin_inset Newline newline
23782 \begin_inset Quotes eld
23787 parselog=$$s/scripts/listerrors
23790 \begin_inset Quotes erd
23794 \begin_inset Newline newline
23797 This will run any errors that are generated by the
23798 \begin_inset Quotes eld
23802 \begin_inset Quotes erd
23805 process through the
23806 \begin_inset Quotes eld
23810 \begin_inset Quotes erd
23816 \begin_layout Standard
23817 The build will normally take place in \SpecialChar LyX
23818 's temporary directory, so the files
23819 produced by the conversion will be in that directory.
23821 will copy out what it regards as the `main' file, but the
23825 conversion may produce several files, and so most of these would then be
23826 deleted when \SpecialChar LyX
23828 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23829 the build-script chunk can place the generated files in that location.
23832 \begin_layout Paragraph
23833 Build instructions in the document
23836 \begin_layout Standard
23837 The last piece of the integration between \SpecialChar LyX
23839 \begin_inset Quotes eld
23843 \begin_inset Quotes erd
23847 Generally, the instructions for building your program should be embedded
23848 in a chunk of its own.
23850 \begin_inset Quotes eld
23854 \begin_inset Quotes erd
23857 above uses the notangle command to look for this chunk (called
23858 \begin_inset Quotes eld
23862 \begin_inset Quotes erd
23865 ) and runs its contents through
23866 \begin_inset Quotes eld
23870 \begin_inset Quotes erd
23876 \begin_layout Standard
23877 Typically, such a chunk would look something like this:
23880 \begin_layout LyX-Code
23884 \begin_layout LyX-Code
23886 \begin_inset Newline newline
23889 if [ -z "${NOWEB_SOURCE}" ]
23890 \begin_inset Newline newline
23896 \begin_layout LyX-Code
23897 NOWEB_SOURCE=myfile.nw
23898 \begin_inset Newline newline
23902 \begin_inset Newline newline
23906 code to extract files ...
23907 use NOWEB_OUTPUT_DIR here ...]
23908 \begin_inset Newline newline
23912 code to compile files ...]
23913 \begin_inset Newline newline
23919 \begin_layout Standard
23922 LIBDIR/examples/listerrors.lyx
23926 LIBDIR/examples/Literate.lyx
23928 which implement two versions of the
23929 \begin_inset Quotes eld
23933 \begin_inset Quotes erd
23936 program for some illustrations of how all of these pieces go together or
23939 LIBDIR/examples/noweb2lyx.lyx.
23942 Interestingly, these three files show off the language-indepence of the
23944 literate programming support since they are written in Python, C and Perl
23948 \begin_layout Subsubsection
23949 Configuring \SpecialChar LyX
23953 \begin_layout Standard
23954 All the Literate Programming support is configured by the
23956 Tools\SpecialChar menuseparator
23960 \begin_inset Quotes eld
23964 \begin_inset Quotes erd
23968 The important parts are:
23971 \begin_layout Description
23973 \begin_inset space ~
23977 \begin_inset Quotes eld
23981 \begin_inset Quotes erd
23985 \begin_inset space ~
23988 format Set up via the File Formats tab, this is where the Noweb-specific
23998 , the file extension is set to
24003 This tells \SpecialChar LyX
24004 to create a file with a
24008 extension in the first step of the conversion process.
24011 \begin_layout Description
24013 \begin_inset space ~
24021 \begin_inset space ~
24024 format This is an empty format whose sole purpose is to be the endpoint
24025 of a conversion (which then allows us to set up a converter for it).
24028 \begin_layout Description
24038 This converter performs the
24039 \begin_inset Quotes eld
24043 \begin_inset Quotes erd
24046 of the literate document.
24047 For Noweb, it is set to
24048 \begin_inset Quotes eld
24053 noweave -delay -index $$i > $$o
24056 \begin_inset Quotes erd
24062 \begin_layout Description
24072 \begin_inset Quotes eld
24076 \begin_inset Quotes erd
24080 As stated above, the Converter is set to
24081 \begin_inset Quotes eld
24089 \begin_inset Quotes erd
24092 , with Flags set to
24093 \begin_inset Newline newline
24097 \begin_inset Quotes eld
24102 parselog=$$s/scripts/listerrors
24105 \begin_inset Quotes erd
24111 \begin_layout Subsubsection
24115 \begin_layout Standard
24116 There is also a new function implemented in the \SpecialChar LyX
24118 \begin_inset Quotes eld
24121 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24125 \begin_layout Standard
24126 When debugging code with ddd/gdb, it is possible to invoke a text editor
24127 at the current execution position with a single key stroke.
24128 The default ddd configuration for that is shift-ctrl-V.
24129 It happens that you can define the editor command line invocation in ddd
24132 Edit\SpecialChar menuseparator
24133 Preferences\SpecialChar menuseparator
24136 dialog and changing the "Edit Sources" entry.
24139 \begin_layout Standard
24140 I take advantage of the newly created \SpecialChar LyX
24141 server function and this ddd feature,
24143 \begin_inset Quotes eld
24147 \begin_inset Quotes erd
24153 \begin_layout Standard
24154 \begin_inset VSpace defskip
24160 \begin_layout Standard
24163 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24166 \begin_layout Standard
24167 \begin_inset VSpace defskip
24173 \begin_layout Standard
24174 With this, whenever you are using ddd and find a point in the program that
24175 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24176 ddd will forward this information to \SpecialChar LyX
24177 through the \SpecialChar LyX
24178 server and then the
24180 window will show the same file with the cursor at the same position ddd
24182 No more guessing or long scrolling to locate a point in the program back
24186 \begin_layout Standard
24187 Note however that you must enable the \SpecialChar LyX
24188 server to get this feature working
24189 (it is disabled by default).
24190 You can enable it in
24202 ) by entering in the
24208 \begin_inset Quotes eld
24213 /home/<your-home-directory>/.lyx/lyxpipe
24216 \begin_inset Quotes erd
24222 \begin_layout Standard
24223 Read the \SpecialChar LyX
24224 server documentation in the
24226 Customization Manual
24228 for further information.
24231 \begin_layout Subsubsection
24235 \begin_layout Standard
24236 There are six new buttons that can be added to your \SpecialChar LyX
24238 Five of these buttons are short cuts to layout styles:
24261 The last one is a short cut to the
24262 \begin_inset Quotes eld
24266 \begin_inset Quotes erd
24273 \begin_layout Standard
24275 has a range of buttons that are available for tool bar customization.
24276 In my toolbar I like to combine the six short cuts above with two more:
24281 \SpecialChar menuseparator
24286 \SpecialChar menuseparator
24293 Document\SpecialChar menuseparator
24294 View\SpecialChar menuseparator
24298 Here is how it looks like:
24301 \begin_layout LyX-Code
24305 \begin_layout LyX-Code
24309 \begin_layout LyX-Code
24310 Icon "layout Standard"
24313 \begin_layout LyX-Code
24314 Icon "layout Section"
24317 \begin_layout LyX-Code
24318 Icon "layout \SpecialChar LaTeX
24322 \begin_layout LyX-Code
24323 Icon "layout \SpecialChar LyX
24327 \begin_layout LyX-Code
24328 Icon "layout Chunk"
24331 \begin_layout LyX-Code
24335 \begin_layout LyX-Code
24339 \begin_layout LyX-Code
24340 Icon "buffer-typeset"
24343 \begin_layout LyX-Code
24344 Icon "build-program"
24347 \begin_layout LyX-Code
24351 \begin_layout LyX-Code
24355 \begin_layout LyX-Code
24359 \begin_layout LyX-Code
24363 \begin_layout LyX-Code
24367 \begin_layout Subsubsection
24368 Colors customization
24371 \begin_layout Standard
24372 There are a number of colors in \SpecialChar LyX
24373 that can be customized in
24378 One of the things that bothers people is the \SpecialChar LaTeX
24380 The default color is red, since the chunks uses \SpecialChar LaTeX
24381 font, and there is a lot
24382 of chunks in literate documents, you may get tired of seeing everything
24384 You can change it by going to the tabs
24393 \begin_layout Standard
24394 The next thing is the visible presence of the newline character in the screen.
24395 You can choose the color of this particular character and make it blend
24397 I recommend you choosing a color that is close to the background but not
24398 equal, that way you still can see it is there, but it is not bothering
24402 \begin_layout Subsection
24407 \begin_layout Standard
24416 is documented in the
24420 example file and in the Sweave manual (menu
24422 Help\SpecialChar menuseparator
24428 \begin_layout Chapter
24432 \begin_layout Standard
24433 You can do everything with \SpecialChar LyX
24434 that you can do with \SpecialChar LaTeX
24436 However, \SpecialChar LyX
24437 cannot support every \SpecialChar LaTeX
24439 But you can always use \SpecialChar TeX
24441 This chapter shows you some more special things you might want to use.
24442 For other special things you can do with figures, tables, floats, boxes
24443 and notes, have a look at the
24446 \begin_inset space ~
24454 \begin_layout Section
24455 Multiple Text Columns
24458 \begin_layout Standard
24459 This feature is independent of the option
24461 Two-column document
24463 in the document settings under
24468 If you want to have 2
24469 \begin_inset space ~
24472 columns for the whole document, it is recommended to use the
24474 Two-column document
24477 For all other cases use this feature.
24480 \begin_layout Standard
24481 To use multiple text columns in your document, you have to load the module
24488 Document\SpecialChar menuseparator
24489 Settings\SpecialChar menuseparator
24492 ) and must have the \SpecialChar LaTeX
24500 \begin_layout Standard
24501 Footnotes within multiple columns will be placed at the bottom of the page
24502 and not under each column.
24503 Within the different columns you can use everything, with the limitation
24504 that for floats you need to use the float option
24511 \begin_layout Subsection
24515 \begin_layout Standard
24516 If you want to have 2
24517 \begin_inset space ~
24520 columns in your text, insert a multicolumn inset via the menu
24522 Insert\SpecialChar menuseparator
24524 \begin_inset space ~
24527 Insets\SpecialChar menuseparator
24529 \begin_inset space ~
24534 where the columns should start.
24535 Write all text that should be printed in 2
24536 \begin_inset space ~
24539 columns into this inset.
24542 \begin_layout Standard
24543 Here is an example:
24546 \begin_layout Standard
24548 \begin_inset Flex Multiple Columns
24551 \begin_layout Plain Layout
24556 The Adventure of the Empty House
24559 \begin_inset Newline newline
24562 by Sir Arthur Conan Doyle
24565 \begin_layout Plain Layout
24568 It was in the spring of the year 1894 that all London was interested, and
24569 the fashionable world dismayed, by the murder of the Honourable Ronald
24570 Adair under most unusual and inexplicable circumstances.
24571 The public has already learned those particulars of the crime which came
24572 out in the police investigation, but a good deal was suppressed upon that
24573 occasion, since the case for the prosecution was so overwhelmingly strong
24574 that it was not necessary to bring forward all the facts.
24575 Only now, at the end of nearly ten years, am I allowed to supply those
24576 missing links which make up the whole of that remarkable chain.
24577 The crime was of interest in itself, but that interest was as nothing to
24578 me compared to the inconceivable sequel, which afforded me the greatest
24579 shock and surprise of any event in my adventurous life.
24580 Even now, after this long interval, I find myself thrilling as I think
24581 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24582 ty which utterly submerged my mind.
24583 Let me say to that public, which has shown some interest in those glimpses
24584 which I have occasionally given them of the thoughts and actions of a very
24585 remarkable man, that they are not to blame me if I have not shared my knowledge
24586 with them, for I should have considered it my first duty to do so, had
24587 I not been barred by a positive prohibition from his own lips, which was
24588 only withdrawn upon the third of last month.
24596 \begin_layout Standard
24597 To get 3 or more columns, set the cursor into the multicolumn inset and
24600 Insert\SpecialChar menuseparator
24602 \begin_inset space ~
24606 \begin_inset space ~
24612 The number of the desired columns is written into that inset (for 3
24613 \begin_inset space ~
24617 \begin_inset Quotes eld
24621 \begin_inset Quotes erd
24625 \begin_inset Newline newline
24628 Here is an example with 3
24629 \begin_inset space ~
24635 \begin_layout Standard
24636 \begin_inset Flex Multiple Columns
24639 \begin_layout Plain Layout
24642 \begin_inset Argument 1
24645 \begin_layout Plain Layout
24651 It can be imagined that my close intimacy with Sherlock Holmes had interested
24652 me deeply in crime, and that after his disappearance I never failed to
24653 read with care the various problems which came before the public.
24654 And I even attempted, more than once, for my own private satisfaction,
24655 to employ his methods in their solution, though with indifferent success.
24656 There was none, however, which appealed to me like this tragedy of Ronald
24658 As I read the evidence at the inquest, which led up to a verdict of willful
24659 murder against some person or persons unknown, I realized more clearly
24660 than I had ever done the loss which the community had sustained by the
24661 death of Sherlock Holmes.
24662 There were points about this strange business which would, I was sure,
24663 have specially appealed to him, and the efforts of the police would have
24664 been supplemented, or more probably anticipated, by the trained observation
24665 and the alert mind of the first criminal agent in Europe.
24666 All day, as I drove upon my round, I turned over the case in my mind and
24667 found no explanation which appeared to me to be adequate.
24668 At the risk of telling a twice-told tale, I will recapitulate the facts
24669 as they were known to the public at the conclusion of the inquest.
24677 \begin_layout Standard
24678 You can have up to 10
24679 \begin_inset space ~
24682 columns if you want to, but that might not be very pleasant for the readers
24686 \begin_layout Standard
24687 \begin_inset Newpage newpage
24693 \begin_layout Subsection
24694 Columns inside Columns
24697 \begin_layout Standard
24698 You can also have columns inside columns:
24701 \begin_layout Standard
24702 \begin_inset Flex Multiple Columns
24705 \begin_layout Plain Layout
24708 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24709 at that time governor of one of the Australian colonies.
24710 Adair's mother had returned from Australia to undergo the operation for
24711 cataract, and she, her son Ronald, and her daughter Hilda were living together
24715 \begin_layout Plain Layout
24716 \begin_inset Flex Multiple Columns
24719 \begin_layout Plain Layout
24722 The youth moved in the best society–had, so far as was known, no enemies
24723 and no particular vices.
24724 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24725 had been broken off by mutual consent some months before, and there was
24726 no sign that it had left any very profound feeling behind it.
24727 For the rest {sic} the man's life moved in a narrow and conventional circle,
24728 for his habits were quiet and his nature unemotional.
24729 Yet it was upon this easy-going young aristocrat that death came, in most
24730 strange and unexpected form, between the hours of ten and eleven-twenty
24731 on the night of March 30, 1894.
24739 \begin_layout Plain Layout
24742 Ronald Adair was fond of cards–playing continually, but never for such stakes
24744 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24745 It was shown that, after dinner on the day of his death, he had played
24746 a rubber of whist at the latter club.
24747 He had also played there in the afternoon.
24752 The evidence of those who had played with him– Mr.
24753 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24754 and that there was a fairly equal fall of the cards.
24755 Adair might have lost five pounds, but not more.
24756 His fortune was a considerable one, and such a loss could not in any way
24758 He had played nearly every day at one club or other, but he was a cautious
24759 player, and usually rose a winner.
24760 It came out in evidence that, in partnership with Colonel Moran, he had
24761 actually won as much as four hundred and twenty pounds in a sitting, some
24762 weeks before, from Godfrey Milner and Lord Balmoral.
24763 So much for his recent history as it came out at the inquest.
24771 \begin_layout Subsection
24775 \begin_layout Standard
24776 The examples in this section show some more special features of multiple
24780 \begin_layout Standard
24781 For more features of multiple columns, have a look at the documentation
24782 of the \SpecialChar LaTeX
24788 \begin_inset CommandInset citation
24798 \begin_layout Subsubsection
24802 \begin_layout Standard
24803 To add a preface text for multiple columns, set the cursor into the multicolumn
24804 inset and use the menu
24806 Insert\SpecialChar menuseparator
24810 Write your preface text into that inset.
24811 \begin_inset Newline newline
24814 This is an example with some preface text:
24817 \begin_layout Standard
24818 \begin_inset VSpace bigskip
24824 \begin_layout Standard
24825 \begin_inset Flex Multiple Columns
24828 \begin_layout Plain Layout
24829 \begin_inset Argument 2
24832 \begin_layout Plain Layout
24833 And the story continues and continues and continues and continues\SpecialChar ldots
24841 On the evening of the crime, he returned from the club exactly at ten.
24842 His mother and sister were out spending the evening with a relation.
24843 The servant deposed that she heard him enter the front room on the second
24844 floor, generally used as his sitting-room.
24845 She had lit a fire there, and as it smoked she had opened the window.
24846 No sound was heard from the room until eleven-twenty, the hour of the return
24847 of Lady Maynooth and her daughter.
24848 Desiring to say good-night, she attempted to enter her son's room.
24849 The door was locked on the inside, and no answer could be got to their
24850 cries and knocking.
24851 Help was obtained, and the door forced.
24852 The unfortunate young man was found lying near the table.
24853 His head had been horribly mutilated by an expanding revolver bullet, but
24854 no weapon of any sort was to be found in the room.
24862 \begin_layout Standard
24863 You can also use a section heading as the preface if you use a section command
24864 as \SpecialChar TeX
24866 For example the command
24869 \begin_layout Standard
24874 subsection{subsection title}
24877 \begin_layout Standard
24878 creates a subsection.
24879 In this example the preface is a subsubsection:
24882 \begin_layout Standard
24883 \begin_inset Flex Multiple Columns
24886 \begin_layout Plain Layout
24887 \begin_inset Argument 2
24890 \begin_layout Plain Layout
24894 \begin_layout Plain Layout
24903 This is a subsubsection heading as a preface
24907 \begin_layout Plain Layout
24921 A minute examination of the circumstances served only to make the case more
24923 In the first place, no reason could be given why the young man should have
24924 fastened the door upon the inside.
24925 There was the possibility that the murderer had done this, and had afterwards
24926 escaped by the window.
24927 The drop was at least twenty feet, however, and a bed of crocuses in full
24929 Neither the flowers nor the earth showed any sign of having been disturbed,
24930 nor were there any marks upon the narrow strip of grass which separated
24931 the house from the road.
24932 Apparently, therefore, it was the young man himself who had fastened the
24934 But how did he come by his death? No one could have climbed up to the window
24935 without leaving traces.
24936 Suppose a man had fired through the window, he would indeed be a remarkable
24937 shot who could with a revolver inflict so deadly a wound.
24938 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24939 a hundred yards of the house.
24940 No one had heard a shot.
24948 \begin_layout Standard
24949 If there is less vertical space than 6
24950 \begin_inset space ~
24953 text lines is left on the page at the beginning of the multiple columns,
24954 a page break will be inserted before the multiple columns.
24955 Depending on the number of lines of the preface text, you might want to
24957 This is done by setting the cursor into the mulitcolumn inset behind the
24958 preface (if there is any) and using the menu
24960 Insert\SpecialChar menuseparator
24962 \begin_inset space ~
24966 \begin_inset space ~
24970 \begin_inset space ~
24976 Insert into that inset the amount of space like e.
24977 \begin_inset space \thinspace{}
24981 \begin_inset space \space{}
24985 \begin_inset Quotes eld
24989 \begin_inset Quotes erd
24993 \begin_inset Newline newline
24996 In this example the space is set to 7
24997 \begin_inset space ~
25000 text lines by using
25001 \begin_inset Quotes eld
25007 \begin_inset Quotes erd
25016 needs to be inserted as \SpecialChar TeX
25020 \begin_layout Standard
25021 \begin_inset Flex Multiple Columns
25024 \begin_layout Plain Layout
25025 \begin_inset Argument 3
25028 \begin_layout Plain Layout
25033 \begin_layout Plain Layout
25049 On the evening of the crime, he returned from the club exactly at ten.
25050 His mother and sister were out spending the evening with a relation.
25051 The servant deposed that she heard him enter the front room on the second
25052 floor, generally used as his sitting-room.
25053 She had lit a fire there, and as it smoked she had opened the window.
25054 No sound was heard from the room until eleven-twenty, the hour of the return
25055 of Lady Maynooth and her daughter.
25056 Desiring to say good-night, she attempted to enter her son's room.
25057 The door was locked on the inside, and no answer could be got to their
25058 cries and knocking.
25059 Help was obtained, and the door forced.
25060 The unfortunate young man was found lying near the table.
25061 His head had been horribly mutilated by an expanding revolver bullet, but
25062 no weapon of any sort was to be found in the room.
25070 \begin_layout Subsubsection
25074 \begin_layout Standard
25075 The amount of space before and after multiple columns can be changed by
25076 changing the length
25083 For example the command
25086 \begin_layout Standard
25096 \begin_layout Standard
25097 in \SpecialChar TeX
25098 Code changes its value to 3
25099 \begin_inset space \thinspace{}
25103 The change must be made before the multiple columns' start.
25104 The predefined value is 13
25105 \begin_inset space \thinspace{}
25111 \begin_layout Standard
25119 \begin_inset space \thinspace{}
25125 \begin_layout Standard
25129 \begin_layout Plain Layout
25135 multicolsep}{2.5cm}
25143 \begin_layout Standard
25144 \begin_inset Flex Multiple Columns
25147 \begin_layout Plain Layout
25150 All day I turned these facts over in my mind, endeavouring to hit upon some
25151 theory which could reconcile them all, and to find that line of least resistanc
25152 e which my poor friend had declared to be the starting-point of every investigat
25154 I confess that I made little progress.
25155 In the evening I strolled across the Park, and found myself about six o'clock
25156 at the Oxford Street end of Park Lane.
25157 A group of loafers upon the pavements, all staring up at a particular window,
25158 directed me to the house which I had come to see.
25159 A tall, thin man with coloured glasses, whom I strongly suspected of being
25160 a plain-clothes detective, was pointing out some theory of his own, while
25161 the others crowded round to listen to what he said.
25162 I got as near him as I could, but his observations seemed to me to be absurd,
25163 so I withdrew again in some disgust.
25164 As I did so I struck against an elderly, deformed man, who had been behind
25165 me, and I knocked down several books which he was carrying.
25173 \begin_layout Standard
25174 \begin_inset Note Greyedout
25177 \begin_layout Plain Layout
25182 The values you set with
25188 will be used for all following multiple columns until you change them again.
25196 \begin_layout Standard
25200 \begin_layout Plain Layout
25212 \begin_inset Note Note
25215 \begin_layout Plain Layout
25216 go back to the default
25224 \begin_layout Standard
25225 \begin_inset Newpage newpage
25231 \begin_layout Subsubsection
25235 \begin_layout Standard
25236 A column break can be forced by inserting the command
25242 as \SpecialChar TeX
25243 Code to that position in the text where the column should be broken.
25244 Note that this leads in most cases to whitespace in the text.
25245 \begin_inset Newline newline
25248 Here is an example:
25251 \begin_layout Standard
25252 \begin_inset Flex Multiple Columns
25255 \begin_layout Plain Layout
25258 \begin_inset Quotes eld
25261 You're surprised to see me, sir,
25262 \begin_inset Quotes erd
25265 said he, in a strange, croaking voice.
25268 \begin_layout Plain Layout
25271 I acknowledged that I was.
25274 \begin_layout Plain Layout
25277 \begin_inset Quotes eld
25280 Well, I've a conscience, sir, and when I chanced to see you go into this
25281 house, as I came hobbling after you, I thought to myself, I'll just step
25282 in and see that kind gentleman, and tell him that if I was a bit gruff
25283 in my manner there was not any harm meant, and that I am much obliged to
25284 him for picking up my books.
25285 \begin_inset Quotes erd
25291 \begin_layout Plain Layout
25294 \begin_inset Quotes eld
25297 You make too much of a trifle,
25298 \begin_inset Quotes erd
25303 \begin_inset Quotes eld
25306 May I ask how you knew who I was?
25307 \begin_inset Quotes erd
25310 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25314 \begin_layout Plain Layout
25326 \begin_layout Plain Layout
25329 \begin_inset Quotes eld
25332 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25333 you'll find my little bookshop at the corner of Church Street, and very
25334 happy to see you, I am sure.
25335 Maybe you collect yourself, sir.
25339 \begin_inset space ~
25352 –a bargain, every one of them.
25353 With five volumes you could just fill that gap on that second shelf.
25354 It looks untidy, does it not, sir?
25355 \begin_inset Quotes erd
25366 \begin_layout Subsubsection
25370 \begin_layout Standard
25371 The width of the columns is automatically calculated, but you can modify
25372 the space between the columns.
25373 This is done by changing the length
25380 Its predefined value is 10
25381 \begin_inset space \thinspace{}
25385 Here is an example where
25392 \begin_inset space \thinspace{}
25398 \begin_layout Standard
25402 \begin_layout Plain Layout
25416 \begin_layout Standard
25417 \begin_inset Flex Multiple Columns
25420 \begin_layout Plain Layout
25423 My observations of No.
25424 \begin_inset space \space{}
25427 427 Park Lane did little to clear up the problem in which I was interested.
25428 The house was separated from the street by a low wall and railing, the
25429 whole not more than five feet high.
25430 It was perfectly easy, therefore, for anyone to get into the garden, but
25431 the window was entirely inaccessible, since there was no water pipe or
25432 anything which could help the most active man to climb it.
25433 More puzzled than ever, I retraced my steps to Kensington.
25434 I had not been in my study five minutes when the maid entered to say that
25435 a person desired to see me.
25436 To my astonishment it was none other than my strange old book collector,
25437 his sharp, wizened face peering out from a frame of white hair, and his
25438 precious volumes, a dozen of them at least, wedged under his right arm.
25446 \begin_layout Standard
25450 \begin_layout Plain Layout
25462 \begin_inset Note Note
25465 \begin_layout Plain Layout
25466 go back to the default
25474 \begin_layout Subsubsection
25478 \begin_layout Standard
25479 Between the columns a rule with a width of the length
25486 If this rule width is set to 0
25487 \begin_inset space \thinspace{}
25490 pt (this is the default), the rule is suppressed.
25491 In the following example the rule is 2
25492 \begin_inset space \thinspace{}
25498 \begin_layout Standard
25502 \begin_layout Plain Layout
25508 columnseprule}{2pt}
25516 \begin_layout Standard
25517 \begin_inset Flex Multiple Columns
25520 \begin_layout Plain Layout
25523 \begin_inset Quotes eld
25526 You're surprised to see me, sir,
25527 \begin_inset Quotes erd
25530 said he, in a strange, croaking voice.
25533 \begin_layout Plain Layout
25536 I acknowledged that I was.
25539 \begin_layout Plain Layout
25542 \begin_inset Quotes eld
25545 Well, I've a conscience, sir, and when I chanced to see you go into this
25546 house, as I came hobbling after you, I thought to myself, I'll just step
25547 in and see that kind gentleman, and tell him that if I was a bit gruff
25548 in my manner there was not any harm meant, and that I am much obliged to
25549 him for picking up my books.
25550 \begin_inset Quotes erd
25556 \begin_layout Plain Layout
25559 \begin_inset Quotes eld
25562 You make too much of a trifle,
25563 \begin_inset Quotes erd
25568 \begin_inset Quotes eld
25571 May I ask how you knew who I was?
25572 \begin_inset Quotes erd
25578 \begin_layout Plain Layout
25581 \begin_inset Quotes eld
25584 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25585 you'll find my little bookshop at the corner of Church Street, and very
25586 happy to see you, I am sure.
25587 Maybe you collect yourself, sir.
25591 \begin_inset space ~
25604 –a bargain, every one of them.
25605 With five volumes you could just fill that gap on that second shelf.
25606 It looks untidy, does it not, sir?
25607 \begin_inset Quotes erd
25618 \begin_layout Standard
25619 \begin_inset VSpace defskip
25625 \begin_layout Standard
25626 The rule can be colored by redefining the command
25633 This is done by inserting the command
25634 \begin_inset Newline newline
25643 columnseprulecolor}{
25648 \begin_inset Newline newline
25651 as \SpecialChar TeX
25652 Code before the multicolumn inset.
25657 in this command by a color of your choice.
25658 You can use all pre- and self-defined colors.
25666 \begin_inset space ~
25671 for more information about pre- and self-defined colors.
25672 To go back to the default color insert the command
25673 \begin_inset Newline newline
25682 columnseprulecolor}{
25687 \begin_inset Newline newline
25690 Here is the example with a cyan rule and 1
25691 \begin_inset space \thinspace{}
25694 cm column separation:
25697 \begin_layout Standard
25701 \begin_layout Plain Layout
25710 \begin_layout Plain Layout
25716 columnseprulecolor}{
25726 \begin_layout Standard
25727 \begin_inset Flex Multiple Columns
25730 \begin_layout Plain Layout
25733 \begin_inset Quotes eld
25736 You're surprised to see me, sir,
25737 \begin_inset Quotes erd
25740 said he, in a strange, croaking voice.
25743 \begin_layout Plain Layout
25746 I acknowledged that I was.
25749 \begin_layout Plain Layout
25752 \begin_inset Quotes eld
25755 Well, I've a conscience, sir, and when I chanced to see you go into this
25756 house, as I came hobbling after you, I thought to myself, I'll just step
25757 in and see that kind gentleman, and tell him that if I was a bit gruff
25758 in my manner there was not any harm meant, and that I am much obliged to
25759 him for picking up my books.
25760 \begin_inset Quotes erd
25766 \begin_layout Plain Layout
25769 \begin_inset Quotes eld
25772 You make too much of a trifle,
25773 \begin_inset Quotes erd
25778 \begin_inset Quotes eld
25781 May I ask how you knew who I was?
25782 \begin_inset Quotes erd
25788 \begin_layout Plain Layout
25791 \begin_inset Quotes eld
25794 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25795 you'll find my little bookshop at the corner of Church Street, and very
25796 happy to see you, I am sure.
25797 Maybe you collect yourself, sir.
25801 \begin_inset space ~
25814 –a bargain, every one of them.
25815 With five volumes you could just fill that gap on that second shelf.
25816 It looks untidy, does it not, sir?
25817 \begin_inset Quotes erd
25828 \begin_layout Standard
25832 \begin_layout Plain Layout
25838 columnseprule}{0pt}
25841 \begin_layout Plain Layout
25847 columnseprulecolor}{
25855 \begin_inset Note Note
25858 \begin_layout Plain Layout
25859 go back to the default
25867 \begin_layout Section
25868 Non-standard Paragraph Shapes
25871 \begin_layout Standard
25874 as well as any other text processor uses by default rectangular paragraphs.
25875 For special cases like for example posters, invitation cards or poems you
25876 can modify the paragraph shape to one of your choice.
25877 This can be done by using the \SpecialChar LaTeX
25882 which is loaded by using in the document settings the module
25884 Custom paragraph shapes
25889 \begin_layout Subsection
25893 \begin_layout Standard
25898 provides the following shapes:
25901 \begin_layout Standard
25902 \begin_inset Tabular
25903 <lyxtabular version="3" rows="13" columns="3">
25904 <features booktabs="true" islongtable="true" longtabularalignment="center">
25905 <column alignment="center" valignment="middle" width="16col%">
25906 <column alignment="center" valignment="middle" width="40col%">
25907 <column alignment="center" valignment="middle" width="35col%">
25908 <row endhead="true">
25909 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25912 \begin_layout Plain Layout
25918 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25921 \begin_layout Plain Layout
25927 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25930 \begin_layout Plain Layout
25938 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25941 \begin_layout Plain Layout
25947 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25950 \begin_layout Plain Layout
25951 Circle with circular hole (in the size of a CD/DVD)
25956 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25959 \begin_layout Plain Layout
25960 Cannot be scaled, take care there is not too much text
25967 <cell alignment="center" valignment="top" topline="true" usebox="none">
25970 \begin_layout Plain Layout
25976 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25979 \begin_layout Plain Layout
25985 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25988 \begin_layout Plain Layout
25989 Fragile, calculation might fail
25996 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25999 \begin_layout Plain Layout
26005 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26008 \begin_layout Plain Layout
26009 Rhomboid (symbolizing a
26010 \begin_inset Quotes eld
26014 \begin_inset Quotes erd
26022 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26025 \begin_layout Plain Layout
26033 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26036 \begin_layout Plain Layout
26042 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26045 \begin_layout Plain Layout
26051 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26054 \begin_layout Plain Layout
26062 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26065 \begin_layout Plain Layout
26071 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26074 \begin_layout Plain Layout
26080 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26083 \begin_layout Plain Layout
26091 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26094 \begin_layout Plain Layout
26100 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26103 \begin_layout Plain Layout
26104 Nut for bolt (hexagon with circular hole)
26109 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26112 \begin_layout Plain Layout
26120 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26123 \begin_layout Plain Layout
26129 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26132 \begin_layout Plain Layout
26138 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26141 \begin_layout Plain Layout
26149 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26152 \begin_layout Plain Layout
26158 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26161 \begin_layout Plain Layout
26167 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26170 \begin_layout Plain Layout
26178 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26181 \begin_layout Plain Layout
26187 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26190 \begin_layout Plain Layout
26196 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26199 \begin_layout Plain Layout
26207 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26210 \begin_layout Plain Layout
26216 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26219 \begin_layout Plain Layout
26220 Normal/reversed rain drop
26225 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26228 \begin_layout Plain Layout
26229 Fragile, calculation might fail
26236 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26239 \begin_layout Plain Layout
26246 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26249 \begin_layout Plain Layout
26250 The \SpecialChar TeX
26256 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26259 \begin_layout Plain Layout
26267 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26270 \begin_layout Plain Layout
26272 \begin_inset Newline newline
26280 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26283 \begin_layout Plain Layout
26284 Triangles in different orientations
26289 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26292 \begin_layout Plain Layout
26306 \begin_layout Standard
26307 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26309 for environments in the toolbar.
26312 \begin_layout Standard
26313 \begin_inset Newpage newpage
26319 \begin_layout Standard
26320 Here is an example paragraph in the shape of a nut:
26323 \begin_layout Standard
26324 \begin_inset VSpace bigskip
26333 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26334 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26336 At vero eos et accusam et justo duo dolores et ea rebum.
26337 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26339 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26340 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26344 \begin_layout Standard
26345 \begin_inset VSpace bigskip
26351 \begin_layout Standard
26352 \begin_inset Note Greyedout
26355 \begin_layout Plain Layout
26360 : shapepar paragraphs cannot run over a page break.
26368 \begin_layout Standard
26369 \begin_inset VSpace bigskip
26375 \begin_layout Standard
26380 takes care that the shape will always be preserved, no matter how much
26381 text is in the paragraph.
26382 Therefore the paragraph size changes with the amount of contained text.
26383 This can lead to paragraph sizes exceeding the page margins.
26384 To demonstrate the size scaling, here is the same example paragraph but
26385 with twice as much text:
26388 \begin_layout Standard
26389 \begin_inset Newpage newpage
26398 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26399 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26401 At vero eos et accusam et justo duo dolores et ea rebum.
26402 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26404 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26405 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26407 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26408 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26410 At vero eos et accusam et justo duo dolores et ea rebum.
26411 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26413 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26414 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26418 \begin_layout Standard
26419 \begin_inset VSpace bigskip
26425 \begin_layout Standard
26426 An exception is the shape
26431 It cannot be scaled because it must fit the size of a CD/DVD.
26432 Therefore the amount of text that fits into the shape is limited.
26433 \begin_inset Newline newline
26444 shape are fragile, meaning that the calculation of their size can fail,
26445 depending on the amount of text.
26446 You will then get the \SpecialChar LaTeX
26448 \begin_inset Quotes eld
26451 Arithmetic overflow
26452 \begin_inset Quotes erd
26456 In this case one can try to remove or add some text; if nothing works one
26457 has to use another shape.
26460 \begin_layout Standard
26461 \begin_inset VSpace bigskip
26467 \begin_layout Standard
26468 For shapes with tips you will maybe see that \SpecialChar LaTeX
26469 's hyphenation routine fails
26470 for text in the tips.
26471 Therefore it is often necessary to add hyphenation points
26476 arg "specialchar-insert hyphenation"
26481 ) to the corresponding text parts.
26484 \begin_layout Standard
26485 \begin_inset VSpace bigskip
26491 \begin_layout Standard
26492 Shapepar paragraphs are either always centered or placed on the page so
26493 that their left border touches the left page margin.
26494 You can therefore not use the paragraph dialog to align such paragraphs.
26495 A solution is to put the paragraph into a minipage or parbox and align
26497 The problem is hereby to find the right width for the box.
26498 Because if it is too wide and you center the box, the paragraph is not
26499 centered too because it sticks at the left side of the box.
26500 So you might have to play a bit with the width until it fits.
26501 Here are two heart-shaped paragraphs, the first one is not aligned, the
26502 second one is right-aligned:
26505 \begin_layout Standard
26506 \begin_inset Newpage newpage
26512 \begin_layout Heart
26516 Lo\SpecialChar softhyphen
26517 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26518 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26520 At vero eos et accusam et justo duo dolores et ea rebum.
26521 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26525 \begin_layout Standard
26526 \begin_inset VSpace bigskip
26532 \begin_layout Standard
26535 \begin_inset Box Frameless
26545 height_special "totalheight"
26550 backgroundcolor "none"
26553 \begin_layout Heart
26557 Lo\SpecialChar softhyphen
26558 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26559 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26561 At vero eos et accusam et justo duo dolores et ea rebum.
26562 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26571 \begin_layout Subsection
26575 \begin_layout Standard
26576 You can define any shape you want.
26577 Doing this manually is a lot of work because every coordinate must be specified.
26578 But there is a way to let the computer calculate the coordinates:
26581 \begin_layout Enumerate
26582 Install the program
26583 \begin_inset CommandInset href
26586 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26594 \begin_layout Enumerate
26601 TeX/LaTeX\SpecialChar menuseparator
26602 Settings\SpecialChar menuseparator
26605 and select the font size you are using in your document.
26606 For example this document uses the size 12
26607 \begin_inset space \thinspace{}
26613 \begin_layout Enumerate
26617 \begin_layout Enumerate
26620 TeX/LaTeX\SpecialChar menuseparator
26623 to export the shape to coordinates.
26624 In the appearing dialog use either the outline of your shape for the coordinate
26625 s or the path itself.
26629 \begin_layout Plain Layout
26630 For more information see
26631 \begin_inset CommandInset href
26633 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26646 \begin_layout Standard
26647 The coordinates are written into a \SpecialChar TeX
26649 To use it for your \SpecialChar LyX
26653 \begin_layout Enumerate
26654 Place the cursor before the first character of your paragraph (or into a
26658 \begin_layout Enumerate
26659 Open in \SpecialChar LyX
26662 Insert\SpecialChar menuseparator
26663 File\SpecialChar menuseparator
26665 \begin_inset space ~
26670 , select the file and use
26679 \begin_layout Standard
26680 \begin_inset VSpace defskip
26686 \begin_layout Standard
26687 \begin_inset Note Greyedout
26690 \begin_layout Plain Layout
26695 : The changed shape only applies to the current paragraph; everything is
26696 reset to normal for the next paragraph.
26697 Therefore the shape definition file must be input into every paragraph
26698 with the desired shape.
26706 \begin_layout Standard
26707 \begin_inset VSpace bigskip
26713 \begin_layout Standard
26714 Here is an example:
26717 \begin_layout Standard
26718 \begin_inset VSpace bigskip
26724 \begin_layout Standard
26725 \begin_inset CommandInset include
26727 filename "SpecialParagraphShape.tex"
26733 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26734 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26736 At vero eos et accusam et justo duo dolores et ea rebum.
26737 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26739 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26740 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26744 \begin_layout Standard
26745 \begin_inset VSpace bigskip
26751 \begin_layout Standard
26756 to draw complexer shapes in
26760 you can draw the shape in a program of your choice and import the resulting
26766 Then you only need to draw a line or spline along the outline of the image.
26769 \begin_layout Standard
26770 \begin_inset VSpace bigskip
26776 \begin_layout Standard
26779 Custom paragraph shapes
26781 also provides the two commands
26789 which can be used to define custom shapes coordinate by coordinate.
26793 \begin_layout Plain Layout
26794 These commands are internally used for all shapes described here.
26799 For information how these styles are used and about further customization
26800 possibilities, have a look at the documentation of the package
26805 \begin_inset CommandInset citation
26815 \begin_layout Bibliography
26816 \begin_inset CommandInset bibitem
26817 LatexCommand bibitem
26823 Documentation of the \SpecialChar LaTeX
26825 \begin_inset CommandInset href
26828 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26836 \begin_layout Bibliography
26837 \begin_inset CommandInset bibitem
26838 LatexCommand bibitem
26844 Documentation of the \SpecialChar LaTeX
26846 \begin_inset CommandInset href
26849 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"