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 1
88 \use_package stackrel 1
89 \use_package stmaryrd 1
90 \use_package undertilde 1
92 \cite_engine_type default
96 \paperorientation portrait
101 \notefontcolor #0000ff
108 \paragraph_separation indent
109 \paragraph_indentation default
111 \math_indentation default
112 \math_numbering_side default
113 \quotes_style english
117 \paperpagestyle headings
118 \tracking_changes false
119 \output_changes false
128 Additional \SpecialChar LyX
132 \begin_layout Subtitle
137 by the \SpecialChar LyX
142 \begin_layout Plain Layout
144 Principal maintainer of this file is
149 If you have comments or error corrections, please send them to the \SpecialChar LyX
152 \begin_inset Flex Code
155 \begin_layout Plain Layout
157 <lyx-docs@lists.lyx.org>
170 \begin_layout Standard
171 \begin_inset CommandInset toc
172 LatexCommand tableofcontents
179 \begin_layout Chapter
183 \begin_layout Standard
184 This manual is essentially Part II of the
186 User's Guide\SpecialChar endofsentence
189 The reason for separating the two documents is simple: the
193 is already quite lengthy, and it contains information on all of the basic
194 features one needs to know in order to prepare most documents.
195 However, the \SpecialChar LyX
196 Team has worked to make \SpecialChar LyX
197 extensible through various configuration
198 files and external packages.
199 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
201 create a layout file (or module) for it without having to alter \SpecialChar LyX
203 We've already had contributions of several new features this way, and some
204 of them are documented here.
205 There are also some more `advanced' features, such as how to control the
206 presentation of bibliographies and how to work with multi-part documents,
207 that are not covered in the
211 and are discussed here.
214 \begin_layout Standard
215 This manual also documents some special features, like fax support, version
216 control, and SGML support, which require additional software to work properly.
217 There is also a chapter on \SpecialChar LyX
219 And lastly, there's a chapter of \SpecialChar LaTeX
220 tools and tips, things you can use to
221 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
223 After all, \SpecialChar LyX
228 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
232 \begin_layout Standard
233 If you haven't read the
237 yet, you are definitely in the wrong manual.
242 is the first place to go, since it describes the notation and format of
244 You should also be thoroughly familiar with the
248 and all of the basic features of \SpecialChar LyX
249 before attempting to read this one.
252 \begin_layout Standard
253 Since many of the topics in this manual depend heavily on \SpecialChar LyX
255 with \SpecialChar LaTeX
256 , this first chapter covers the inner workings of \SpecialChar LyX
259 to generate exactly the \SpecialChar LaTeX
261 It is obviously for more seasoned \SpecialChar LyX
265 \begin_layout Chapter
267 and \SpecialChar LaTeX
271 \begin_layout Section
273 Uses \SpecialChar LaTeX
277 \begin_layout Standard
278 This chapter is for both \SpecialChar TeX
279 -nicians and the \SpecialChar LaTeX
281 In it, we'll explain how \SpecialChar LyX
282 and \SpecialChar LaTeX
283 work together to produce printable output.
284 This is the only place in any of the manuals where we assume you know something
285 about \SpecialChar LaTeX
289 \begin_layout Standard
290 At one time, \SpecialChar LyX
292 \begin_inset Quotes eld
295 WYSIWYM frontend to \SpecialChar LaTeX
297 \begin_inset Quotes erd
300 but that's no longer true.
301 There are frontends to \SpecialChar LaTeX
306 \begin_layout Plain Layout
307 Some familar ones are \SpecialChar TeX
308 maker and kile, on Linux, and \SpecialChar TeX
310 There are also the \SpecialChar LaTeX
311 modes for vi and emacs, of course.
316 These are basically text editors with the ability to run \SpecialChar LaTeX
318 errors in the file you're editing.
319 Although \SpecialChar LyX
328 run \SpecialChar LaTeX
329 , and it also indicates errors in the file, it also does much, much
331 For one thing, you don't need to know \SpecialChar LaTeX
332 to use \SpecialChar LyX
335 has added its own extensions to \SpecialChar LaTeX
337 Try the following sometime: select
338 \begin_inset Flex Noun
341 \begin_layout Plain Layout
342 Export\SpecialChar menuseparator
349 \begin_inset Flex Noun
352 \begin_layout Plain Layout
359 \begin_inset Flex Noun
362 \begin_layout Plain Layout
363 View\SpecialChar menuseparator
373 ), then look at the preamble of the resulting
374 \begin_inset Flex Code
377 \begin_layout Plain Layout
384 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
386 These macros are defined automatically, according to the features you use
390 \begin_layout Standard
391 There are several commands that automatically invoke \SpecialChar LaTeX
396 \begin_layout Itemize
397 \begin_inset Flex Noun
400 \begin_layout Plain Layout
401 Document\SpecialChar menuseparator
410 \begin_layout Itemize
411 \begin_inset Flex Noun
414 \begin_layout Plain Layout
415 Document\SpecialChar menuseparator
424 \begin_layout Standard
425 They will only invoke \SpecialChar LaTeX
426 if the file has changed since the last time \SpecialChar LaTeX
432 \begin_layout Standard
433 When \SpecialChar LyX
434 runs \SpecialChar LaTeX
435 on the file you're editing, it performs these steps:
438 \begin_layout Enumerate
439 Convert the document to \SpecialChar LaTeX
440 and save to a file with the extension
441 \begin_inset Flex Code
444 \begin_layout Plain Layout
451 \begin_inset Flex Code
454 \begin_layout Plain Layout
463 \begin_layout Enumerate
464 Run \SpecialChar LaTeX
466 \begin_inset Flex Code
469 \begin_layout Plain Layout
475 file (maybe several times), and run any other commands (such as
476 \begin_inset Flex Code
479 \begin_layout Plain Layout
486 \begin_inset Flex Code
489 \begin_layout Plain Layout
495 ) needed to compile the \SpecialChar LaTeX
499 \begin_layout Enumerate
500 If there are any errors, show the error log.
503 \begin_layout Standard
504 If you have run \SpecialChar LaTeX
506 \begin_inset Flex Noun
509 \begin_layout Plain Layout
510 View\SpecialChar menuseparator
517 then runs a DVI viewer to display the DVI-file.
519 \begin_inset Flex Noun
522 \begin_layout Plain Layout
523 View\SpecialChar menuseparator
530 performs further steps:
533 \begin_layout Itemize
535 \begin_inset Flex Code
538 \begin_layout Plain Layout
544 to convert the DVI file to PostScript.
547 \begin_layout Itemize
548 Run a PostScript viewer, such as
549 \begin_inset Flex Code
552 \begin_layout Plain Layout
558 , to display the PostScript file.
561 \begin_layout Standard
563 does similar things when viewing, or exporting, other formats.
566 \begin_layout Section
567 Translating \SpecialChar LaTeX
568 files into \SpecialChar LyX
572 \begin_layout Standard
573 You can import a \SpecialChar LaTeX
574 file into \SpecialChar LyX
576 \begin_inset Flex Noun
579 \begin_layout Plain Layout
580 File\SpecialChar menuseparator
581 Import\SpecialChar menuseparator
587 command in \SpecialChar LyX
589 This will call a program named
590 \begin_inset Flex Code
593 \begin_layout Plain Layout
599 which will create a file
600 \begin_inset Flex Code
603 \begin_layout Plain Layout
610 \begin_inset Flex Code
613 \begin_layout Plain Layout
621 will then open that file.
625 \begin_layout Plain Layout
626 \begin_inset Flex Code
629 \begin_layout Plain Layout
635 can also be run from the command line, of course.
643 \begin_layout Standard
644 \begin_inset Flex Code
647 \begin_layout Plain Layout
653 will translate most legal \SpecialChar LaTeX
654 , but not everything.
655 It will put things it doesn't understand into \SpecialChar TeX
656 code, so after translating
658 \begin_inset Flex Code
661 \begin_layout Plain Layout
667 , you can look for \SpecialChar TeX
668 code and hand-edit it until it looks right.
671 \begin_layout Standard
672 If you don't know what \SpecialChar TeX
673 code is, read the next section.
676 \begin_layout Section
677 \begin_inset CommandInset label
679 name "sec:Inserting-TeX-Code"
683 Inserting \SpecialChar TeX
684 Code into \SpecialChar LyX
688 \begin_layout Standard
689 Anything you can do in \SpecialChar LaTeX
690 you can do in \SpecialChar LyX
691 , for a very simple reason: You can
692 always insert \SpecialChar TeX
693 code into any \SpecialChar LyX
696 cannot, and will never be able to, display every possible \SpecialChar LaTeX
698 If ever you need to insert \SpecialChar LaTeX
699 commands into your \SpecialChar LyX
700 document, you can use the
702 \begin_inset Flex Code
705 \begin_layout Plain Layout
712 box, which you can insert into your document with
713 \begin_inset Flex Noun
716 \begin_layout Plain Layout
717 Insert\SpecialChar menuseparator
727 or the keyboard shortcut
736 \begin_layout Standard
737 Here's an example of inserting \SpecialChar LaTeX
738 commands in a \SpecialChar LyX
740 The code looks like this:
743 \begin_layout LyX-Code
747 \begin_inset Newline newline
753 \begin_inset Newline newline
756 This is an example of a minipage environment.
758 \begin_inset Newline newline
761 can put nearly everything in it, even (non-floating)
762 \begin_inset Newline newline
767 \begin_inset Newline newline
773 \begin_inset Newline newline
777 \begin_inset Newline newline
783 \begin_inset Newline newline
789 \begin_inset Newline newline
795 \begin_inset Newline newline
800 \begin_inset Newline newline
806 \begin_inset Newline newline
812 \begin_inset Newline newline
818 \begin_inset Newline newline
826 \begin_layout LyX-Code
830 \begin_layout Standard
832 \begin_inset Flex Code
835 \begin_layout Plain Layout
842 box containing this text is directly after this paragraph.
843 Those of you reading the manual in \SpecialChar LyX
844 will only see the \SpecialChar TeX
846 Those reading a printed version of the manuals will see the actual results:
847 \begin_inset VSpace bigskip
853 \begin_layout Standard
857 \begin_layout Plain Layout
864 \begin_layout Plain Layout
871 \begin_layout Plain Layout
873 This is an example of a minipage environment.
874 You can put nearly everything in it, even (non-floating) figures and tables.
878 \begin_layout Plain Layout
885 \begin_layout Plain Layout
890 \begin_layout Plain Layout
897 \begin_layout Plain Layout
904 \begin_layout Plain Layout
911 \begin_layout Plain Layout
917 \begin_layout Plain Layout
924 \begin_layout Plain Layout
931 \begin_layout Plain Layout
938 \begin_layout Plain Layout
948 \begin_inset VSpace bigskip
954 \begin_layout Standard
955 In addition to using \SpecialChar TeX
956 code, you can also create a separate file containing
957 some complex \SpecialChar LaTeX
958 structure and then use
959 \begin_inset Flex Noun
962 \begin_layout Plain Layout
963 Insert\SpecialChar menuseparator
973 to include your file (you should select the type
974 \begin_inset Flex Code
977 \begin_layout Plain Layout
984 We recommend that you only do this if you have a
985 \begin_inset Flex Code
988 \begin_layout Plain Layout
999 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1003 \begin_layout Standard
1004 There are a few last points to emphasize:
1007 \begin_layout Itemize
1013 check if your \SpecialChar LaTeX
1017 \begin_layout Itemize
1018 Beware of reinventing the wheel.
1021 \begin_layout Standard
1022 On that last point, \SpecialChar LyX
1023 does have quite a few features tucked into it, and
1025 Be sure to check the manuals to make sure that \SpecialChar LyX
1026 doesn't have such-and-such
1027 feature before you decide you have to do it by hand.
1028 Moreover, there are numerous \SpecialChar LaTeX
1029 packages out there to do all sorts of things,
1030 from labels to envelopes to fancy multipage tables.
1032 \begin_inset CommandInset href
1035 target "http://www.ctan.org/"
1043 \begin_layout Standard
1044 If you do need to do some wild and fancy things within your document, be
1045 sure to check out a good \SpecialChar LaTeX
1046 book for assistance.
1047 There are a number of them listed in the bibliography of the
1054 \begin_layout Section
1056 and the \SpecialChar LaTeX
1060 \begin_layout Subsection
1061 About the \SpecialChar LaTeX
1065 \begin_layout Standard
1066 If you already know \SpecialChar LaTeX
1067 , there is no need to explain here what the preamble
1069 If you don't, the following will give you some ideas—we recommend again
1070 that you consult a \SpecialChar LaTeX
1071 book for further information.
1072 In any case, you should read the points below, because they explain what
1073 you can do and what you don't need to do in the \SpecialChar LaTeX
1074 preamble of a \SpecialChar LyX
1078 \begin_layout Standard
1079 The \SpecialChar LaTeX
1080 preamble comes at the very beginning of a document,
1088 \begin_layout Itemize
1089 Declare the document class.
1091 \begin_inset Newline newline
1095 already does this for you.
1096 If you're a seasoned \SpecialChar LaTeX
1097 -nician, and you have a custom document class you
1098 want to use, check out the
1100 Customization Manual
1102 for information on how to make \SpecialChar LyX
1106 \begin_layout Itemize
1107 Declare the usage of packages.
1109 \begin_inset Newline newline
1113 packages provide special commands, which are only available within a document
1114 when the package has been declared in the preamble.
1115 In addition to providing special commands, the inclusion of a package can
1116 change the document.
1117 For example, the package
1118 \begin_inset Flex Code
1121 \begin_layout Plain Layout
1127 forces all paragraphs to be indented.
1128 There are other packages for labels, envelopes, margins, etc.
1132 \begin_layout Itemize
1133 Set counters, variables, lengths and widths.
1135 \begin_inset Newline newline
1138 There are several \SpecialChar LaTeX
1139 counters and variables that
1143 be set globally from within the preamble in order to have the desired effect.
1144 (There are variables that you can set and reset inside the document, too.)
1145 Margins are a good example of something that must be set in the preamble.
1146 Another example is the label format for lists.
1147 You can actually set these just about anywhere, but it's best to do it
1148 just once, inside the preamble.
1151 \begin_layout Itemize
1152 Declare user defined commands (with
1153 \begin_inset Flex Code
1156 \begin_layout Plain Layout
1165 \begin_inset Flex Code
1168 \begin_layout Plain Layout
1177 \begin_inset Newline newline
1180 These are abbreviations for \SpecialChar LaTeX
1181 commands which appear very often inside a document.
1182 Although the preamble is a good place to declare such commands, they
1186 be declared anywhere (before they are used for the first time, of course).
1187 This can be useful if there is a lot of raw \SpecialChar LaTeX
1188 code in your document, which
1189 normally should not be the case.
1192 \begin_layout Standard
1194 adds its own set of definitions to the preamble of the
1195 \begin_inset Flex Code
1198 \begin_layout Plain Layout
1205 This makes \SpecialChar LaTeX
1206 files generated by \SpecialChar LyX
1210 \begin_layout Subsection
1211 Changing the Preamble
1214 \begin_layout Standard
1215 The commands which \SpecialChar LyX
1216 adds to the preamble of a \SpecialChar LaTeX
1217 file are fixed; you can't
1218 change them without patching \SpecialChar LyX
1220 You can, however, add your own stuff to the preamble by selecting
1221 \begin_inset Flex Noun
1224 \begin_layout Plain Layout
1227 \begin_inset space ~
1236 \begin_inset Flex Noun
1239 \begin_layout Plain Layout
1240 Document\SpecialChar menuseparator
1248 adds anything in the
1249 \begin_inset Flex Noun
1252 \begin_layout Plain Layout
1258 dialog to its own built-in preamble.
1259 Before adding your own declarations in the preamble, you should make sure
1260 that \SpecialChar LyX
1261 doesn't already support what you want to do.
1262 (Remember what we said about reinventing the wheel?) Also,
1264 make sure your preamble code is correct
1268 doesn't check it for you.
1269 If there is an error, you're likely to get an error like
1270 \begin_inset Quotes eld
1274 \begin_inset Flex Code
1277 \begin_layout Plain Layout
1286 \begin_inset Quotes erd
1290 If you see this error, check your preamble.
1293 \begin_layout Subsection
1297 \begin_layout Standard
1298 Here are some examples of what you can add to a preamble, and what they
1302 \begin_layout Subsubsection
1306 \begin_layout Standard
1307 There are two variables under \SpecialChar LaTeX
1308 that control page position:
1309 \begin_inset Flex Code
1312 \begin_layout Plain Layout
1321 \begin_inset Flex Code
1324 \begin_layout Plain Layout
1333 Their names should be self-explanatory.
1334 These variables are useful if you think for a moment about computer labels.
1335 Sometimes, the size of a print medium and the area of the medium that you
1336 can actually print on aren't the same.
1338 \begin_inset Flex Code
1341 \begin_layout Plain Layout
1350 \begin_inset Flex Code
1353 \begin_layout Plain Layout
1364 \begin_layout Standard
1365 The default values for
1366 \begin_inset Flex Code
1369 \begin_layout Plain Layout
1378 \begin_inset Flex Code
1381 \begin_layout Plain Layout
1390 \begin_inset space \thinspace{}
1394 \begin_inset space \thinspace{}
1398 \begin_inset space \space{}
1401 the page isn't shifted.
1402 Unfortunately, some DVI drivers always seem to shift the page.
1403 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1404 If you're using \SpecialChar LyX
1405 on a system that you don't personally maintain, and your
1406 sysadmin is a doofus,
1407 \begin_inset Flex Code
1410 \begin_layout Plain Layout
1419 \begin_inset Flex Code
1422 \begin_layout Plain Layout
1431 Suppose your left and top margins are always 0.5
1432 \begin_inset space \thinspace{}
1436 You can add this to the preamble:
1439 \begin_layout LyX-Code
1447 \begin_layout LyX-Code
1455 \begin_layout Standard
1456 and your margins should now be correct.
1459 \begin_layout Subsubsection
1463 \begin_layout Standard
1464 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1465 There's a rather nice package, available at your nearest CTAN archive,
1466 for printing sheets of labels:
1467 \begin_inset Flex Code
1470 \begin_layout Plain Layout
1477 Now, your system may not have this package installed by default.
1478 We leave that up to you to check.
1479 You'll also want to read the documentation for it; we're not going to do
1481 Since this is an example, however, we'll give you an example of how you
1485 \begin_layout Standard
1486 First, make sure you're using the
1487 \begin_inset Flex Code
1490 \begin_layout Plain Layout
1497 Next, you need to put the following in your preamble:
1500 \begin_layout LyX-Code
1506 \begin_layout LyX-Code
1512 \begin_layout LyX-Code
1518 \begin_layout LyX-Code
1524 \begin_layout LyX-Code
1530 \begin_layout LyX-Code
1536 \begin_layout LyX-Code
1542 \begin_layout Standard
1543 This sets things up for Avery label sheets, stock #5360.
1544 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1547 \begin_inset Flex Code
1550 \begin_layout Plain Layout
1559 \begin_inset Flex Code
1562 \begin_layout Plain Layout
1570 around each label text.
1571 This and other special features of
1572 \begin_inset Flex Code
1575 \begin_layout Plain Layout
1581 are explained in its documentation.
1584 \begin_layout Standard
1585 Someday, someone may write a \SpecialChar LyX
1586 layout file to support this package directly.
1587 Maybe that someone is you.
1590 \begin_layout Subsubsection
1591 Example #3: Paragraph Indentation
1594 \begin_layout Standard
1595 Americans are trained to indent the first line of
1600 As with all of their other weird quirks, most Americans will whine and
1601 moan until they can have their way and indent the first line of all paragraphs.
1610 \begin_layout Standard
1611 Of course, this behavior isn't standard typography.
1612 In books, you typically only indent the first line of a paragraph
1616 it follows another one.
1617 The idea behind indenting the first line of a paragraph is to distinguish
1618 neighboring paragraphs from one another.
1619 If there is no previous paragraph—for example, if it follows a figure or
1620 is the first paragraph in a section—then there is no need for indentation.
1624 \begin_layout Standard
1625 If you're a typical American (we're still joking!), though, you don't care
1626 about such esoteric things; you want your indentation! Add this to the
1630 \begin_layout LyX-Code
1633 usepackage{indentfirst}
1636 \begin_layout Standard
1637 If your \SpecialChar TeX
1638 distribution isn't braindead, you'll have this package, and all
1639 of your paragraphs will get the indentation the Founding Fathers intended
1643 \begin_layout Subsubsection
1644 Example #4: This Document
1647 \begin_layout Standard
1648 You can also check out the preamble of this document to get an idea of some
1649 of the advanced things you can do.
1652 \begin_layout Section
1654 and \SpecialChar LaTeX
1658 \begin_layout Standard
1659 When \SpecialChar LyX
1660 calls \SpecialChar LaTeX
1661 , it tells \SpecialChar LaTeX
1662 to blithely ignore any errors and keep going.
1663 It then uses the logfile from the \SpecialChar LaTeX
1664 run to do a post-mortem.
1665 After analyzing the logfile, \SpecialChar LyX
1666 displays a dialog listing the errors.
1667 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1669 where the error occurred.
1673 \begin_layout Plain Layout
1675 Analyzing the logfile is a tough job, and \SpecialChar LyX
1676 doesn't always go to the right
1678 There are also cases where \SpecialChar LaTeX
1679 reports the error on one line, but the actual
1681 This is not unlike forgetting a closing brace in a program: You'll get
1682 an error, but only later.
1690 \begin_layout Standard
1691 Some folks also like to look at the log file directly: It is available from
1693 \begin_inset Flex Noun
1696 \begin_layout Plain Layout
1697 Document\SpecialChar menuseparator
1699 \begin_inset space ~
1708 There are some fairly common error messages and warnings.
1709 We'll cover those here.
1710 You should look at a good \SpecialChar LaTeX
1711 book for a complete listing.
1714 \begin_layout Itemize
1715 \begin_inset Flex Code
1718 \begin_layout Plain Layout
1725 \begin_inset Newline newline
1728 Anything beginning with these words is a warning message for the purpose
1730 \begin_inset Quotes eld
1734 \begin_inset Quotes erd
1737 the \SpecialChar LaTeX
1739 You'll get messages like this if you added or changed cross-references
1740 or bibliography entries, in which case, \SpecialChar LaTeX
1741 is trying to tell you that you
1742 need to make another run.
1743 You can by-and-large ignore these.
1746 \begin_layout Itemize
1747 \begin_inset Flex Code
1750 \begin_layout Plain Layout
1757 \begin_inset Newline newline
1760 Another warning message, this time about fonts which \SpecialChar LaTeX
1762 The rest of the message will often say something about a replacement font
1763 that \SpecialChar LaTeX
1765 You can safely ignore these, too.
1768 \begin_layout Itemize
1769 \begin_inset Flex Code
1772 \begin_layout Plain Layout
1781 \begin_inset Newline newline
1790 It seems to generate at least one of these messages for just about any
1792 They are warnings about lines that were too long and run past the right
1794 This happens if \SpecialChar LaTeX
1795 does not find a reasonable way to break the lines (notoriously
1796 often with typewriter font, since this does not allow for automatic break
1798 In many cases, this is unnoticeable in the final output.
1799 (It can be just a point or two.) Sometimes, however, the lines run rather
1800 visibly into the margin; something you will not want to have in your final
1803 \begin_inset Newline newline
1806 There are several global ways to try to minimize the overfull lines.
1809 Enable micro-typographic extensions
1813 Document\SpecialChar menuseparator
1814 Settings\SpecialChar menuseparator
1817 might already improve things a lot.
1818 Furthermore, \SpecialChar LaTeX
1819 code such as the following in
1821 Document\SpecialChar menuseparator
1822 Settings\SpecialChar menuseparator
1825 usually reduces the overfull lines drastically (we use this in the preamble
1830 \begin_layout LyX-Code
1834 \begin_inset Newline newline
1840 \begin_inset Newline newline
1845 emergencystretch 1.5em
1846 \begin_inset Newline newline
1854 \begin_layout Standard
1855 In some cases, however, you eventually have to rewrite the text to get the
1856 line breaking right.
1860 \begin_layout Plain Layout
1861 For more information, see
1862 \begin_inset Flex URL
1865 \begin_layout Plain Layout
1867 http://www.tex.ac.uk/FAQ-overfull.html
1880 \begin_layout Standard
1881 In any case, you should check the respective lines, at least for the final
1882 version of your document.
1883 Your eyes will tell you if there's a problem with something that's too
1888 \begin_layout Plain Layout
1889 You can also enable the `draft' option in
1890 \begin_inset Flex Noun
1893 \begin_layout Plain Layout
1894 Document\SpecialChar menuseparator
1900 , and then \SpecialChar LaTeX
1901 will draw a black box in the margin of lines that are overfull.
1910 \begin_layout Itemize
1911 \begin_inset Flex Code
1914 \begin_layout Plain Layout
1923 \begin_inset Newline newline
1926 Not quite as common as its cousin.
1927 This happens again if \SpecialChar LaTeX
1928 does not find a reasonable break point and consequently
1929 generates too loose lines.
1930 As with the overfull lines, you should check if this is a visible problem.
1933 \begin_layout Itemize
1934 \begin_inset Flex Code
1937 \begin_layout Plain Layout
1946 \begin_inset Flex Code
1949 \begin_layout Plain Layout
1958 \begin_inset Newline newline
1961 Warnings about troubles breaking the page.
1962 Once again, just look at the output.
1963 Your eyes will tell you where something has gone wrong.
1966 \begin_layout Itemize
1967 \begin_inset Flex Code
1970 \begin_layout Plain Layout
1972 \begin_inset Quotes els
1976 \begin_inset Quotes ers
1985 \begin_inset Newline newline
1989 \begin_inset Quotes eld
1993 \begin_inset Quotes erd
1996 isn't installed on this system.
1997 This usually appears because some package your document needs isn't installed.
1998 If you didn't touch the preamble or didn't use the
1999 \begin_inset Flex Code
2002 \begin_layout Plain Layout
2010 command, then one of the packages \SpecialChar LyX
2011 tried to load is missing.
2013 \begin_inset Flex Noun
2016 \begin_layout Plain Layout
2017 Help\SpecialChar menuseparator
2024 to get a list of packages that \SpecialChar LyX
2026 This file is updated whenever you reconfigure \SpecialChar LyX
2028 \begin_inset Flex Noun
2031 \begin_layout Plain Layout
2032 Tools\SpecialChar menuseparator
2038 ) and tells you which packages have been detected and what they do.
2039 \begin_inset Newline newline
2043 \begin_inset Flex Code
2046 \begin_layout Plain Layout
2054 command and the package in question isn't installed, then you'll need to
2055 install it yourself.
2058 \begin_layout Itemize
2059 \begin_inset Flex Code
2062 \begin_layout Plain Layout
2063 LaTeX Error: Unknown option
2069 \begin_inset Newline newline
2072 Error messages beginning with this are trying to tell you that you specified
2073 a bad or undefined option to a package.
2074 Check the package's documentation.
2077 \begin_layout Itemize
2078 \begin_inset Flex Code
2081 \begin_layout Plain Layout
2082 Undefined control sequence
2088 \begin_inset Newline newline
2091 If you've inserted \SpecialChar LaTeX
2092 code into your document, but made a typo, you'll get
2094 You may have forgotten to load a package.
2095 In any case, this error message usually means that you used an undefined
2100 \begin_layout Standard
2101 There are other error and warning messages.
2102 Some are self-explanatory.
2103 These are usually \SpecialChar LaTeX
2105 Others are downright cryptic.
2106 These are usually \SpecialChar TeX
2107 error messages, and we really have
2111 what they mean or how to decipher them.
2115 \begin_layout Standard
2116 There's a general sequence you should follow if you get error messages:
2119 \begin_layout Enumerate
2120 Look at the \SpecialChar LaTeX
2121 code you inserted for typos.
2124 \begin_layout Enumerate
2125 If there are no typos, check that you used the command(s) correctly.
2128 \begin_layout Enumerate
2129 If you get a bunch of error boxes piled up at the very top of the document—and
2130 especially if you see a
2131 \begin_inset Quotes eld
2135 \begin_inset Flex Code
2138 \begin_layout Plain Layout
2147 \begin_inset Quotes erd
2150 error—it means that there are errors in the preamble.
2151 Start debugging your preamble.
2154 \begin_layout Enumerate
2155 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2157 document, the first suspect is your \SpecialChar LaTeX
2158 distribution itself.
2159 Check for missing packages and install them.
2162 \begin_layout Enumerate
2163 Okay, so there are no missing packages.
2164 Did you use any of the fine-tuning options in \SpecialChar LyX
2165 ? Specifically, did you
2169 any of them, like trying to manually insert lots of
2170 \begin_inset Flex Code
2173 \begin_layout Plain Layout
2175 \begin_inset space ~
2184 \begin_inset Flex Code
2187 \begin_layout Plain Layout
2194 \begin_inset Flex Code
2197 \begin_layout Plain Layout
2203 ? Did you try to kludge something together with these instead of using the
2204 appropriate paragraph environment?
2207 \begin_layout Enumerate
2208 All right, you didn't use any of the fine-tuning options, you played by
2210 Did you try to pull a fancy maneuver? Did you do something funky inside
2211 a table or an equation, like inserting a graphic into a table cell?
2214 \begin_layout Enumerate
2215 Do you have long sections of text where \SpecialChar LaTeX
2216 cannot find a place to break a
2217 line? By default, \SpecialChar LaTeX
2218 is rather strict about how much extra inter-word spacing
2219 it will add in order to break a line.
2220 Preferably, you should rework the paragraph to avoid the problem.
2223 \begin_layout Enumerate
2224 Did you go overboard with the nesting? \SpecialChar LyX
2225 (currently) doesn't check to make
2226 sure you're in the limits for nesting environments.
2227 If you nested a bunch of environments to the
2228 \begin_inset Formula $17^{\mathrm{th}}$
2231 level, that's the problem.
2232 (The limit in \SpecialChar LaTeX
2236 \begin_layout Enumerate
2237 Okay, you didn't get any error messages, but your output looks awful.
2238 If you have a table or figure that's too wide or long for the page, you
2243 \begin_layout Enumerate
2244 rescale the figure so it fits.
2247 \begin_layout Enumerate
2248 trim down the table so it fits.
2252 \begin_layout Enumerate
2253 If something else is wrong with the output, and you didn't try to pull anything
2254 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2257 \begin_layout Standard
2258 If all this doesn't help—well, then
2262 you might have found a bug in \SpecialChar LyX
2267 \begin_layout Chapter
2271 \begin_layout Section
2272 Customizing Bibliographies with Bib\SpecialChar TeX
2276 \begin_layout Standard
2277 The most basic information about how to use Bib\SpecialChar TeX
2282 with \SpecialChar LyX
2283 is contained in the section
2285 Bibliography databases
2292 The following subsections explain special bibliography features supported
2297 \begin_layout Subsection
2298 Alternative Citation Styles
2301 \begin_layout Standard
2302 Standard Bib\SpecialChar TeX
2304 \begin_inset space \thinspace{}
2308 \begin_inset space \space{}
2312 \begin_inset Quotes eld
2316 \begin_inset Quotes erd
2319 ) to refer to a cited work.
2320 However, in many scientific disciplines, other citation styles are in use.
2321 The most common one is the author-year style (e.
2322 \begin_inset space \thinspace{}
2326 \begin_inset space \space{}
2330 \begin_inset Quotes eld
2334 \begin_inset Quotes erd
2339 supports three packages that provide this style,
2340 \begin_inset Flex Code
2343 \begin_layout Plain Layout
2350 \begin_inset Flex Code
2353 \begin_layout Plain Layout
2360 \begin_inset Flex Code
2363 \begin_layout Plain Layout
2370 Each of these packages has their pros and cons, which cannot be listed
2372 If you only want to have simple author-year (or author-numerical) style,
2373 or if you want to use one of the countless style files for
2374 \begin_inset Flex Code
2377 \begin_layout Plain Layout
2383 , then the established
2384 \begin_inset Flex Code
2387 \begin_layout Plain Layout
2393 package is probably your choice.
2394 If you look for specific citation styles common in law studies, you might
2396 \begin_inset Flex Code
2399 \begin_layout Plain Layout
2406 If you want to have full control over the formatting or look for advanced
2407 features such as ibidem, footnote citations, full title citations, advanced
2408 date formats (such as 400 BC) or full localization to other languages than
2409 English, you should definitely consider
2410 \begin_inset Flex Code
2413 \begin_layout Plain Layout
2419 , which exceeds all other packages in terms of features, but is also quite
2420 heavy and more resource-hungry.
2423 \begin_layout Standard
2424 The handling of these packages in \SpecialChar LyX
2425 is basically the same.
2427 \begin_inset Flex Noun
2430 \begin_layout Plain Layout
2431 Document\SpecialChar menuseparator
2438 \begin_inset Flex Noun
2441 \begin_layout Plain Layout
2448 \begin_inset Flex Noun
2451 \begin_layout Plain Layout
2458 \begin_inset Flex Noun
2461 \begin_layout Plain Layout
2468 \begin_inset Flex Noun
2471 \begin_layout Plain Layout
2478 \begin_inset Flex Noun
2481 \begin_layout Plain Layout
2482 Biblatex (Natbib mode)
2488 \begin_inset Flex Noun
2491 \begin_layout Plain Layout
2498 \begin_inset Flex Noun
2501 \begin_layout Plain Layout
2508 \begin_inset space ~
2511 6.5.3 in the User's Guide for more information on these choices).
2512 With all these packages, you will get some extra features in the citation
2513 dialog and you can select the style of the reference (
2514 \begin_inset Quotes eld
2518 \begin_inset Quotes erd
2522 \begin_inset Quotes eld
2526 \begin_inset Quotes erd
2530 \begin_inset Quotes eld
2534 \begin_inset Quotes erd
2538 \begin_inset Quotes eld
2542 \begin_inset Quotes erd
2546 Note that either package needs specifically designed style files.
2547 They all ship their own, but there are lots of additional style files,
2548 and there is even an interactive style file builder
2552 \begin_layout Plain Layout
2554 \begin_inset Flex URL
2557 \begin_layout Plain Layout
2559 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2570 \begin_inset Flex Code
2573 \begin_layout Plain Layout
2582 \begin_layout Subsection
2583 Subdivided Bibliographies
2586 \begin_layout Standard
2587 Sometimes you might need to divide your bibliography into several sections.
2588 If you are for instance a historian, the possibility to separate sources
2589 and scientific works is most likely a
2590 \begin_inset Quotes eld
2594 \begin_inset Quotes erd
2598 Unfortunately, Bib\SpecialChar TeX
2599 itself does not allow you to do this.
2600 But with the help of some \SpecialChar LaTeX
2601 packages, Bib\SpecialChar TeX
2602 can be extended to fit your needs.
2605 \begin_layout Standard
2607 provides native support for one of these packages,
2615 \begin_layout Plain Layout
2617 \begin_inset Flex URL
2620 \begin_layout Plain Layout
2622 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2632 The advantage of this package (compared to other packages such as
2636 ) is that you don't need to define new citation commands.
2637 Instead, you need to prepare different bibliographic databases which include
2638 the entries for the different sections of the bibliography.
2639 For example: If you want to divide your bibliography into the sections
2641 \begin_inset Quotes eld
2645 \begin_inset Quotes erd
2649 \begin_inset Quotes eld
2653 \begin_inset Quotes erd
2656 , you first need to create two bibliographic databases, e.
2657 \begin_inset space \thinspace{}
2661 \begin_inset space \space{}
2665 \begin_inset Flex Code
2668 \begin_layout Plain Layout
2675 \begin_inset Flex Code
2678 \begin_layout Plain Layout
2688 \begin_layout Standard
2690 \begin_inset Flex Noun
2693 \begin_layout Plain Layout
2694 Document\SpecialChar menuseparator
2701 \begin_inset Flex Noun
2704 \begin_layout Plain Layout
2711 \begin_inset Flex Noun
2714 \begin_layout Plain Layout
2715 Subdivided bibliography
2721 Now you can insert multiple Bib\SpecialChar TeX
2722 bibliographies, one for each section of
2724 Returning to our example: Insert the Bib\SpecialChar TeX
2726 \begin_inset Flex Code
2729 \begin_layout Plain Layout
2735 and a second one for the database
2736 \begin_inset Flex Code
2739 \begin_layout Plain Layout
2746 You are free to use the same or different styles for each section.
2747 Additionally, you can choose if the bibliography section should contain
2749 \begin_inset Quotes eld
2752 all cited references
2753 \begin_inset Quotes erd
2756 of the specified database(s) (which is the default),
2757 \begin_inset Quotes eld
2760 all uncited references
2761 \begin_inset Quotes erd
2765 \begin_inset Quotes eld
2769 \begin_inset Quotes erd
2773 This might be useful if you would like to separate your bibliography into
2775 \begin_inset Quotes eld
2779 \begin_inset Quotes erd
2783 \begin_inset Quotes eld
2787 \begin_inset Quotes erd
2791 \begin_inset Quotes eld
2795 \begin_inset Quotes erd
2799 The titles for the sections can be added as ordinary sections or subsections.
2801 \begin_inset Flex Code
2804 \begin_layout Plain Layout
2810 removes the bibliography title, you have to manually re-add that, too (as
2811 a chapter* or section*, for instance).
2814 \begin_layout Standard
2819 , the procedure is a bit different.
2828 , the aforementioned
2829 \begin_inset Flex Noun
2832 \begin_layout Plain Layout
2833 Subdivided bibliography
2838 option is disabled if you use
2847 provides its own means to generate subdivided bibliographies.
2848 You can either add keywords to bibliography entries via the
2849 \begin_inset Flex Code
2852 \begin_layout Plain Layout
2858 entry option and then filter bibliography sections by keyword (by adding
2860 \begin_inset Flex Code
2863 \begin_layout Plain Layout
2870 \begin_inset Flex Noun
2873 \begin_layout Plain Layout
2879 field of the dialog that opens if you left-click on the
2880 \begin_inset Flex Noun
2883 \begin_layout Plain Layout
2884 Biblatex Generated Bibliography
2889 button), or you can filter by entry types (such as
2898 \begin_inset space \thinspace{}
2903 \begin_inset Flex Code
2906 \begin_layout Plain Layout
2913 \begin_inset Flex Code
2916 \begin_layout Plain Layout
2923 \begin_inset Flex Noun
2926 \begin_layout Plain Layout
2932 field, or you can create so-called
2933 \begin_inset Quotes eld
2936 Bibliography Categories
2937 \begin_inset Quotes erd
2940 to which you can assign individual entries.
2941 Please refer to the Biblatex manual, section
2943 Subdivided Bibliographies
2948 \begin_layout Subsection
2949 Multiple Bibliographies
2950 \begin_inset CommandInset label
2952 name "subsec:Multiple-Bibliographies"
2959 \begin_layout Standard
2960 Multiple bibliographies, e.
2961 \begin_inset space \thinspace{}
2965 \begin_inset space \space{}
2968 a bibliography for each part, chapter, section, subsection or child (sub-documen
2969 t) of the document, are also supported by \SpecialChar LyX
2971 In order to enable it, go to
2972 \begin_inset Flex Noun
2975 \begin_layout Plain Layout
2976 Document\SpecialChar menuseparator
2977 Settings\SpecialChar menuseparator
2983 and select the relevant unit (e.
2984 \begin_inset space \thinspace{}
2988 \begin_inset Quotes eld
2992 \begin_inset Quotes erd
2996 \begin_inset Flex Noun
2999 \begin_layout Plain Layout
3000 Multiple Bibliographies
3006 Then add a Bib(la)\SpecialChar TeX
3007 bibliography to each unit (e.
3008 \begin_inset space \thinspace{}
3011 g., section) of your document.
3012 In the output, a separate bibliography, containing only the references
3013 done in the current unit is generated.
3016 \begin_layout Standard
3017 If you use Bib\SpecialChar TeX
3019 \begin_inset Flex Code
3022 \begin_layout Plain Layout
3029 \begin_inset Flex Code
3032 \begin_layout Plain Layout
3038 package is used to create multiple bibliographies.
3039 The former package is used if you select
3040 \begin_inset Quotes eld
3044 \begin_inset Quotes erd
3052 \begin_inset Flex Noun
3055 \begin_layout Plain Layout
3056 Sectioned Bibliography
3063 \begin_inset Flex Code
3066 \begin_layout Plain Layout
3076 \begin_layout Plain Layout
3077 An alternative approach, if you are willing to use some
3078 \begin_inset Flex Noun
3081 \begin_layout Plain Layout
3089 \begin_inset space ~
3093 \begin_inset CommandInset ref
3095 reference "sec:Inserting-TeX-Code"
3100 \begin_inset Flex Code
3103 \begin_layout Plain Layout
3115 \begin_inset Flex Code
3118 \begin_layout Plain Layout
3124 is used, \SpecialChar LyX
3125 encloses the specified units in
3126 \begin_inset Flex Code
3129 \begin_layout Plain Layout
3136 \begin_inset Flex Code
3139 \begin_layout Plain Layout
3148 \begin_inset Flex Code
3151 \begin_layout Plain Layout
3159 in order to create the units.
3160 Note that this approach has some limitations.
3161 First, every citation reference has to be inside some
3162 \begin_inset Flex Code
3165 \begin_layout Plain Layout
3172 So citations outside a defined unit (e.
3173 \begin_inset space \thinspace{}
3176 g., before the first section if you use
3177 \begin_inset Quotes eld
3181 \begin_inset Quotes erd
3185 \begin_inset Quotes eld
3189 \begin_inset Quotes erd
3193 You can also create your own units by entering
3194 \begin_inset Flex Code
3197 \begin_layout Plain Layout
3206 \begin_inset Flex Code
3209 \begin_layout Plain Layout
3218 code (for instance to work around the mentioned limitation).
3220 \begin_inset Flex Code
3223 \begin_layout Plain Layout
3230 A second limitation is that
3231 \begin_inset Flex Code
3234 \begin_layout Plain Layout
3240 always processes all references of a bibliography database, even if they
3242 This can result in odd labels (e.
3243 \begin_inset space \thinspace{}
3248 \begin_inset Quotes eld
3252 \begin_inset Quotes erd
3255 if two works of this author from 2014 are in the database, even if only
3259 \begin_layout Standard
3265 \begin_inset Flex Code
3268 \begin_layout Plain Layout
3274 option is used instead.
3275 If you need specific units, you can start them with the \SpecialChar TeX
3277 \begin_inset Flex Code
3280 \begin_layout Plain Layout
3289 \begin_inset Flex Code
3292 \begin_layout Plain Layout
3301 If you also want to control the end of the unit, use the environment
3302 \begin_inset Flex Code
3305 \begin_layout Plain Layout
3315 \begin_inset Flex Code
3318 \begin_layout Plain Layout
3328 \begin_inset Flex Code
3331 \begin_layout Plain Layout
3338 In addition to the individual bibliography of the current unit,
3342 also provides an easy way to output all bibliographies, subsequently, at
3344 \begin_inset space \thinspace{}
3347 g., at the end of the document).
3349 \begin_inset Quotes eld
3353 \begin_inset Quotes erd
3356 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3362 manual for more information on this topic.
3365 \begin_layout Section
3369 \begin_layout Subsection
3373 \begin_layout Standard
3374 When you are working on a large file with many sections, it is often convenient
3375 to break up the document into several files, or perhaps you have something
3376 where a table may change from time to time, but the preceding text does
3378 In these cases, you should seriously consider using multipart documents.
3379 For example, scientific papers often have five major sections: the introduction
3380 , observations, results, discussion, and conclusion.
3381 Each of these could be its own separate \SpecialChar LyX
3383 \begin_inset Quotes eld
3387 \begin_inset Quotes erd
3390 file which contains the title, authors, abstract, references, etc., plus
3391 the five included files.
3392 It is important to note that each of these files is a full \SpecialChar LyX
3394 can be formatted and printed on its own, as well as included in a master
3396 Each of these files must have the same document class, however—don't attempt
3397 to mix book classes with article classes.
3398 You may also include \SpecialChar LaTeX
3399 files; however, these files must not have their own
3401 \begin_inset space \thinspace{}
3405 \begin_inset space \space{}
3408 everything up to and including the
3409 \begin_inset Flex Code
3412 \begin_layout Plain Layout
3421 \begin_inset Flex Code
3424 \begin_layout Plain Layout
3432 line must be deleted) or else errors will be generated when you try to
3436 \begin_layout Standard
3438 allows you to include files quite easily with
3439 \begin_inset Flex Noun
3442 \begin_layout Plain Layout
3443 Insert\SpecialChar menuseparator
3445 \begin_inset space ~
3454 When you click on this selection a small box is inserted into the file
3455 at the current cursor location.
3456 Clicking on the box raises a dialog which allows you to select the file
3457 to be included, and the method of its inclusion.
3461 \begin_layout Standard
3462 The file selection box should by now be obvious.
3463 The three inclusion methods are
3464 \begin_inset Quotes eld
3468 \begin_inset Quotes erd
3472 \begin_inset Quotes eld
3476 \begin_inset Quotes erd
3480 \begin_inset Quotes eld
3484 \begin_inset Quotes erd
3489 \begin_inset Quotes eld
3493 \begin_inset Quotes erd
3497 \begin_inset Quotes eld
3501 \begin_inset Quotes erd
3504 are similar in many ways, but there are also some notable differences:
3507 \begin_layout Enumerate
3509 \begin_inset Quotes eld
3513 \begin_inset Quotes erd
3516 are typeset beginning on a new page, while files that are
3517 \begin_inset Quotes eld
3521 \begin_inset Quotes erd
3524 are typeset starting on the current page.
3527 \begin_layout Enumerate
3528 \begin_inset Quotes eld
3532 \begin_inset Quotes erd
3535 files cannot themselves
3536 \begin_inset Quotes eld
3540 \begin_inset Quotes erd
3544 \begin_inset Quotes eld
3548 \begin_inset Quotes erd
3553 \begin_inset Quotes eld
3557 \begin_inset Quotes erd
3560 , on the other hand, infinite sub-inputting is possible.
3563 \begin_layout Enumerate
3564 \begin_inset Quotes eld
3568 \begin_inset Quotes erd
3571 allow for the output of only selected
3572 \begin_inset Quotes eld
3576 \begin_inset Quotes erd
3579 files, while maintaining the actual counters (pagination etc.) and references
3580 (please refer to the section
3583 \begin_inset space ~
3591 \begin_inset space ~
3596 manual for details).
3599 \begin_layout Standard
3601 \begin_inset Quotes eld
3605 \begin_inset Quotes erd
3608 is the preferred method for chapters that are outsourced to child documents,
3610 \begin_inset Quotes eld
3614 \begin_inset Quotes erd
3617 is more suitable for arbitrary file inheritance.
3620 \begin_layout Standard
3622 \begin_inset Quotes eld
3626 \begin_inset Quotes erd
3629 included file allows you to include a file typeset exactly as it appears
3631 \begin_inset space \thinspace{}
3635 \begin_inset space \space{}
3639 \begin_inset Flex Code
3642 \begin_layout Plain Layout
3648 mode, with the characters set in a fixed-width typewriter font.
3649 Normally, spaces in this file are invisible, though two consecutive spaces
3650 are conserved, unlike \SpecialChar LyX
3651 's normal treatment of spaces.
3652 However, setting the
3653 \begin_inset Flex Noun
3656 \begin_layout Plain Layout
3658 \begin_inset space ~
3662 \begin_inset space ~
3666 \begin_inset space ~
3674 checkbox typesets a mark to unambiguously define the presence of a space.
3678 \begin_layout Standard
3679 Generally, the master file is converted into a full \SpecialChar LaTeX
3680 file before typesetting,
3681 while the included files are converted to \SpecialChar LaTeX
3682 files that do not have all the
3683 preamble information.
3686 \begin_layout Subsection
3687 Cross-References Between Files
3690 \begin_layout Standard
3691 \begin_inset Box Shadowbox
3701 height_special "totalheight"
3706 backgroundcolor "none"
3709 \begin_layout Plain Layout
3710 This section is somewhat out of date.
3711 Need to describe default master documents and how children are opened when
3721 \begin_layout Standard
3722 It is possible to set up cross-references between the different files.
3723 First, open all the files in question: let's call them A and B in a two
3724 file example, where B is included in A.
3725 Let's say you insert a label in A, then want to reference it in B.
3726 Open the cross-reference dialog whilst in document B, and you can select
3728 \begin_inset Quotes eld
3732 \begin_inset Quotes erd
3738 \begin_layout Subsection
3739 Bibliography Lists in all Subdocuments
3742 \begin_layout Standard
3743 If you work with child documents, you might want to have only one main bibliogra
3744 phy at the end, but still be able to have a selected bibliography for the
3745 child if you output it on its own.
3746 Here is how to achieve this.
3749 \begin_layout Standard
3750 For the main document, you just insert a bibliography inset at the place
3751 where the main bibliography has to appear (within the master file or within
3753 If the bibliography inset is in the master file, the references will be
3754 inherited by all children, so they are available in the citation dialog
3758 \begin_layout Standard
3759 For child-specific bibliographies, insert bibliography insets within the
3760 child documents, at the place where the bibliography should appear when
3761 the child is compiled separately.
3762 However, the trick is to insert them into a branch (
3764 Insert\SpecialChar menuseparator
3765 Branch\SpecialChar menuseparator
3766 Insert New Branch...
3769 \begin_inset space \thinspace{}
3774 \begin_inset Quotes eld
3778 \begin_inset Quotes erd
3782 Within the children, activate the branch (
3784 Document\SpecialChar menuseparator
3785 Settings...\SpecialChar menuseparator
3789 Within the master, deactivate the branch (
3791 Document\SpecialChar menuseparator
3792 Settings...\SpecialChar menuseparator
3796 Now the child's bibliography will be ignored by the master, but considered
3800 \begin_layout Standard
3801 If you need multiple bibliographies (e.
3802 \begin_inset space \thinspace{}
3805 g., one per child in the
3809 ), please refer to sec.
3810 \begin_inset space ~
3814 \begin_inset CommandInset ref
3816 reference "subsec:Multiple-Bibliographies"
3823 \begin_layout Section
3828 \begin_layout Standard
3829 Users sometimes need to be able to
3830 \begin_inset Quotes eld
3834 \begin_inset Quotes erd
3838 file together with all the images (and other files) on which it depends,
3839 either for sending to a publisher or for sharing with a co-author.
3841 includes a Python script (
3842 \begin_inset Flex Code
3845 \begin_layout Plain Layout
3851 ) that automates this process.
3852 To use it, you must have either the
3853 \begin_inset Flex Code
3856 \begin_layout Plain Layout
3863 \begin_inset Flex Code
3866 \begin_layout Plain Layout
3872 python modules installed on your system.
3873 By default, the script prefers the
3874 \begin_inset Flex Code
3877 \begin_layout Plain Layout
3884 \begin_inset Flex Code
3887 \begin_layout Plain Layout
3893 format on Unix-like systems and the
3894 \begin_inset Flex Code
3897 \begin_layout Plain Layout
3906 \begin_layout Standard
3908 's configuration process will set the script up to export a `\SpecialChar LyX
3910 and this format will then be available under
3911 \begin_inset Flex Code
3914 \begin_layout Plain Layout
3915 File\SpecialChar menuseparator
3924 \begin_layout Standard
3925 Independently of the platform, the generation of a particular archive format
3926 can be forced by adding either the
3927 \begin_inset Flex Code
3930 \begin_layout Plain Layout
3937 \begin_inset Flex Code
3940 \begin_layout Plain Layout
3947 \begin_inset Flex Code
3950 \begin_layout Plain Layout
3957 \begin_inset Flex Code
3960 \begin_layout Plain Layout
3966 format) switch to the
3967 \begin_inset Flex Code
3970 \begin_layout Plain Layout
3972 \SpecialChar menuseparator
3980 \begin_inset Flex Code
3983 \begin_layout Plain Layout
3984 Tools\SpecialChar menuseparator
3985 Preferences\SpecialChar menuseparator
3986 File Handling\SpecialChar menuseparator
3993 (Make sure you add the switch after the script name, not before it.)
3996 \begin_layout Section
3997 Fancy Headers and Footers
4000 \begin_layout Standard
4001 The default page layout is rather plain; for an
4002 \begin_inset Flex Code
4005 \begin_layout Plain Layout
4011 document class, all you get is a centered page number at the bottom of
4013 This document uses KOMA-script's book class, so it appears to be a bit
4015 But to really put on a show, you need to set the document page style to
4017 \begin_inset Quotes eld
4021 \begin_inset Quotes erd
4024 , as mentioned in the
4029 This section describes the \SpecialChar LaTeX
4030 code you need to insert in your \SpecialChar LaTeX
4032 order to get the desired effects.
4035 \begin_layout Standard
4036 For more information on fancy headers, see the
4037 \begin_inset Flex Code
4040 \begin_layout Plain Layout
4046 package documentation.
4048 \begin_inset Flex URL
4051 \begin_layout Plain Layout
4053 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4061 \begin_layout Standard
4062 The page header is divided into three fields, not surprisingly labeled
4063 \begin_inset Quotes eld
4067 \begin_inset Quotes erd
4071 \begin_inset Quotes eld
4075 \begin_inset Quotes erd
4079 \begin_inset Quotes eld
4083 \begin_inset Quotes erd
4087 The footer is also divided into these three fields.
4088 The \SpecialChar LaTeX
4089 commands to set these fields in the simplest manner are
4090 \begin_inset Flex Code
4093 \begin_layout Plain Layout
4102 \begin_inset Flex Code
4105 \begin_layout Plain Layout
4114 \begin_inset Flex Code
4117 \begin_layout Plain Layout
4126 \begin_inset Flex Code
4129 \begin_layout Plain Layout
4138 Suppose you wish to put your name in the upper left hand corner of each
4140 Simply insert the following command in the preamble:
4143 \begin_layout Standard
4152 \begin_layout Standard
4153 You will now see your name in the upper left.
4154 If a field has a default entry that you would like to get rid of (often
4155 the page number appears in the central footer) simply include a command
4156 with a blank argument, e.
4157 \begin_inset space \thinspace{}
4163 \begin_layout Standard
4171 \begin_layout Standard
4172 Let's get really fancy: lets put the section number with the word
4173 \begin_inset Quotes eld
4177 \begin_inset Quotes erd
4181 \begin_inset space \thinspace{}
4185 \begin_inset space \space{}
4188 Section 3) in the upper left, the page number (e.
4189 \begin_inset space \thinspace{}
4193 \begin_inset space \space{}
4196 Page 4) in the upper right, your name in the lower left, and the date in
4198 The following commands should now appear in the preamble:
4201 \begin_layout Standard
4211 \begin_layout Standard
4219 \begin_layout Standard
4229 \begin_layout Standard
4238 \begin_layout Standard
4246 \begin_layout Standard
4256 \begin_layout Standard
4258 \begin_inset Flex Code
4261 \begin_layout Plain Layout
4270 \begin_inset Flex Code
4273 \begin_layout Plain Layout
4281 access \SpecialChar LaTeX
4282 's section and page counters, and so print out the current section
4285 \begin_inset Flex Code
4288 \begin_layout Plain Layout
4296 simply prints out today's date.
4299 \begin_layout Standard
4300 The thicknesses of the horizontal rules drawn beneath the header and above
4301 the footer can also be modified.
4302 If you don't want one of the rules, set its thickness to 0.
4303 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4309 \begin_inset Flex Code
4312 \begin_layout Plain Layout
4317 headrulewidth}{0.4pt}
4323 \begin_inset Flex Code
4326 \begin_layout Plain Layout
4331 footrulewidth}{0.4pt}
4336 to set the thicknesses.
4339 \begin_layout Standard
4340 You can switch the header/footer settings on and off for individual pages
4342 \begin_inset Flex Code
4345 \begin_layout Plain Layout
4348 thispagestyle{empty}
4354 \begin_inset Flex Code
4357 \begin_layout Plain Layout
4360 thispagestyle{plain}
4366 \begin_inset Flex Code
4369 \begin_layout Plain Layout
4372 thispagestyle{fancy}
4378 Simply insert them in the text on the page you want changed and mark them
4381 In fact, title pages are marked as plain by default, while following pages
4382 are marked fancy when using the global fancy setting.
4385 \begin_layout Standard
4386 As a final example, it is possible to include an image in the header or
4388 Suppose you want to put a company logo in the upper lefthand corner.
4389 You might try something like
4392 \begin_layout Standard
4401 includegraphics{logo.eps}}}
4404 \begin_layout Standard
4406 (you may need to preface this with
4407 \begin_inset Flex Code
4410 \begin_layout Plain Layout
4414 usepackage{graphics}
4419 if you don't include graphics elsewhere in your document).
4422 \begin_layout Section
4423 Itemize Bullet Selection
4424 \begin_inset CommandInset label
4433 \begin_layout Standard
4439 \begin_layout Subsection
4443 \begin_layout Standard
4445 provides 216 bullet shapes that can be accessed from a simple dialog.
4446 Using this dialog you can easily specify what bullet shape to use at each
4447 level of an itemized list.
4448 These settings are document-wide so you won't be able to specify different
4449 sets of bullets for different paragraphs.
4453 \begin_layout Plain Layout
4454 Well, actually you can but you'll have to do it by hand.
4462 \begin_layout Subsection
4466 \begin_layout Standard
4467 Open the dialog by selecting the
4468 \begin_inset Flex Noun
4471 \begin_layout Plain Layout
4472 Document\SpecialChar menuseparator
4478 menu item and then select the
4479 \begin_inset Flex Noun
4482 \begin_layout Plain Layout
4491 \begin_layout Standard
4492 The dialog provides you with a table of bullet shapes.
4493 A column of buttons on the left of the table provides access to the six
4494 different panels of bullet shapes.
4495 The row of buttons across the top is used to select which bullet depth
4497 A text entry under the table shows the currently selected bullet shape's
4499 equivalent and this can be edited if desired.
4500 If you do modify the text you will also need to specify any needed packages
4501 in the \SpecialChar LaTeX
4505 \begin_layout Standard
4506 The six panels are divided up by the packages they require.
4507 The following table shows the mappings from button name to \SpecialChar LaTeX
4511 \begin_layout Standard
4513 \begin_inset Tabular
4514 <lyxtabular version="3" rows="7" columns="2">
4515 <features tabularvalignment="middle">
4516 <column alignment="center" valignment="top" width="0pt">
4517 <column alignment="center" valignment="top" width="0pt">
4519 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4522 \begin_layout Plain Layout
4537 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4540 \begin_layout Plain Layout
4557 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4560 \begin_layout Plain Layout
4575 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4578 \begin_layout Plain Layout
4587 base \SpecialChar LaTeX
4595 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4598 \begin_layout Plain Layout
4613 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4616 \begin_layout Plain Layout
4633 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4636 \begin_layout Plain Layout
4651 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4654 \begin_layout Plain Layout
4671 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4674 \begin_layout Plain Layout
4689 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4692 \begin_layout Plain Layout
4709 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4712 \begin_layout Plain Layout
4727 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4730 \begin_layout Plain Layout
4747 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4750 \begin_layout Plain Layout
4765 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4768 \begin_layout Plain Layout
4791 \begin_layout Standard
4793 doesn't stop you using bullets from packages you don't have.
4794 If you get errors from \SpecialChar LaTeX
4795 when you try to view or print the file, then it
4796 is likely you are missing a package.
4800 \begin_layout Plain Layout
4802 doesn't restrict your use since you may be editing locally and exporting
4811 \begin_layout Subsection
4815 \begin_layout Standard
4816 Select which bullet depth you want to change then select the bullet shape
4818 Any changes will not be visible in \SpecialChar LyX
4819 , but are visible when viewing the document.
4822 \begin_layout Standard
4823 You can reset a bullet shape to the default simply by clicking your right
4824 mouse button on the appropriate bullet depth button.
4828 \begin_layout Plain Layout
4833 want to have multiple sets of paragraphs with different sets of bullets
4834 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4836 The bullet selection dialog can help though because it provides you with
4837 the \SpecialChar LaTeX
4838 code for a wide range of bullet shapes.
4839 To make your own custom paragraphs you have the following options:
4842 \begin_layout Plain Layout
4846 \begin_layout Plain Layout
4862 \begin_layout Plain Layout
4866 \begin_layout Plain Layout
4888 \begin_layout Itemize
4889 Use the \SpecialChar LaTeX
4891 \begin_inset Flex Code
4894 \begin_layout Plain Layout
4902 to specify a new bullet shape for a given depth.
4903 You'll also need to save the current bullet shape so you can restore it
4905 In this itemized list the following \SpecialChar LaTeX
4906 code was used to change the bullet
4907 used for the first depth.
4911 \begin_layout LyX-Code
4921 \begin_layout LyX-Code
4938 \begin_layout Itemize
4939 Note that the itemize depth is specified in Roman numerals as part of the
4949 \begin_layout Itemize
4950 \begin_inset Argument item:1
4953 \begin_layout Plain Layout
4957 \begin_layout Plain Layout
4975 Specify each individual entry by starting each item with the bullet shape
4977 \begin_inset Quotes eld
4981 \begin_inset Quotes erd
4986 Insert\SpecialChar menuseparator
4990 \begin_inset Flex Noun
4993 \begin_layout Plain Layout
5001 For example, this item was started with
5002 \begin_inset Flex Code
5005 \begin_layout Plain Layout
5020 \begin_layout Plain Layout
5024 \begin_layout Plain Layout
5040 \begin_layout Plain Layout
5041 You'll also need to revert the labelitem back to its previous setting for
5042 the global bullet shape settings to remain in effect.
5043 The way used here was:
5046 \begin_layout LyX-Code
5061 \begin_layout Chapter
5063 and the World Wide Web
5066 \begin_layout Standard
5068 has long supported the export of documents to various web-friendly formats,
5070 Before version 2.0, however, HTML export was always accomplished by the
5071 use of external converters.
5075 \begin_layout Plain Layout
5076 For details on the use of external converters with \SpecialChar LyX
5081 section of the Customization manual.
5086 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5088 intermediate format, such as
5089 \begin_inset Flex Code
5092 \begin_layout Plain Layout
5099 \begin_inset Flex Code
5102 \begin_layout Plain Layout
5109 \begin_inset Flex Code
5112 \begin_layout Plain Layout
5118 , relying upon \SpecialChar LyX
5119 to produce the \SpecialChar LaTeX
5120 ; and there is a converter that works directly
5123 \begin_inset Flex Code
5126 \begin_layout Plain Layout
5134 All of these have different advantages and disadvantages.
5138 \begin_layout Standard
5139 The \SpecialChar LaTeX
5140 -based converters have the advantage that, in principle, they know everythin
5141 g about the exported document that \SpecialChar LaTeX
5143 Such converters do not care, for example, if a certain block of code was
5144 produced by \SpecialChar LyX
5145 or was Evil Red Text.
5146 These converters know about
5147 \begin_inset Flex Code
5150 \begin_layout Plain Layout
5156 files, counters, and references, and can often make use of the
5157 \begin_inset Flex Code
5160 \begin_layout Plain Layout
5166 files generated by Bib\SpecialChar TeX
5168 On the other hand, \SpecialChar LaTeX
5169 is a very hard language to parse—it is sometimes said
5170 that only \SpecialChar TeX
5171 itself understands \SpecialChar TeX
5172 —and \SpecialChar LaTeX
5173 -based converters will often choke on
5174 what seem to be quite simple constructs; complex ones can throw them completely
5175 , and as of this writing, for example, the
5179 manual will not export with
5180 \begin_inset Flex Code
5183 \begin_layout Plain Layout
5189 , though the others will.
5190 The other issue concerns how math is handled.
5191 These converters typically convert the formulae into little pictures that
5192 are then linked from the HTML document.
5193 Since these are actually generated by \SpecialChar LaTeX
5194 , they are accurate.
5195 But they do not scale well, and just getting them to look as if they are
5196 actually meant to be in your document—so that the font sizes seem to be
5197 roughly the same—can be a challenge.
5200 \begin_layout Standard
5202 \begin_inset Flex Code
5205 \begin_layout Plain Layout
5213 \begin_inset CommandInset href
5215 name "http://pinchito.es/elyxer/"
5216 target "http://pinchito.es/elyxer/"
5221 ) solves some of these problems.
5222 In particular, the formulae it produces scale perfectly, since it renders
5223 math using a combination of HTML and CSS rather than converting the formulae
5225 But even moderately complex formula are rendered less well than with
5226 \begin_inset Flex Code
5229 \begin_layout Plain Layout
5235 ; this reflects the limitations of HTML.
5239 \begin_layout Plain Layout
5241 \begin_inset Flex Code
5244 \begin_layout Plain Layout
5251 can also use jsMath and MathJax for equations, but this setting is only
5252 available globally and requires one to have access to a server that runs
5258 More importantly (as of version 1.1.1, at least),
5259 \begin_inset Flex Code
5262 \begin_layout Plain Layout
5269 has limited support for math macros and no support for user-defined paragraph
5270 or character styles.
5271 These limitations make
5272 \begin_inset Flex Code
5275 \begin_layout Plain Layout
5282 unsuitable for many of the documents \SpecialChar LyX
5284 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5286 have decided to follow a different path and have made \SpecialChar LyX
5288 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5289 , DocBook, and plaintext.
5292 \begin_layout Standard
5293 As of this writing, XHTML output remains under development and should probably
5295 \begin_inset Quotes eld
5299 \begin_inset Quotes erd
5306 \begin_layout Plain Layout
5308 \begin_inset Flex Code
5311 \begin_layout Plain Layout
5312 development/HTML/HTML.notes
5317 , which can be found in the \SpecialChar LyX
5319 \begin_inset CommandInset href
5321 name "accessed online"
5322 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5327 , usually contains up-to-date information about the state of XHTML output.
5328 See also the list of XHTML bugs on
5329 \begin_inset CommandInset href
5331 name "the bug tracker"
5332 target "https://www.lyx.org/trac/query?status=reopened&status=assigned&status=new&max=0&component=xhtml+export&order=id&col=id&col=summary&col=reporter&col=keywords&keywords=%21%7Efixedintrunk&desc=1"
5342 Still, the developers have chosen this approach because it has several
5343 potential advantages over the other two.
5346 \begin_layout Standard
5347 These advantages are primarily due to the fact that the XHTML output routines,
5348 since they are part of \SpecialChar LyX
5349 , know everything \SpecialChar LyX
5350 knows about the document being
5355 \begin_layout Plain Layout
5356 Another advantage is that, since these routines are internal to \SpecialChar LyX
5358 immune to changes in \SpecialChar LyX
5359 's file format, or to changes in the semantics of
5365 So they know about the table of contents (as displayed in the outline),
5366 about the counters associated with different paragraph styles, and about
5367 user-defined styles.
5368 The XHTML output routines know what \SpecialChar LyX
5369 knows about internationalization,
5370 too, so they will output
5371 \begin_inset Quotes eld
5375 \begin_inset Quotes erd
5379 \begin_inset Quotes eld
5387 \begin_inset Quotes erd
5390 , depending upon the language in effect at the time.
5394 \begin_layout Standard
5395 Quite generally, the output routines know what \SpecialChar LyX
5396 knows about document layout,
5397 that is, about how the document is to be rendered on screen.
5398 We use this information when we output the document as XHTML.
5399 In particular, \SpecialChar LyX
5404 generates CSS style information corresponding to the layout information
5405 it uses to render the document on screen: if section headings are supposed
5406 to be sans-serif and bold as seen in \SpecialChar LyX
5407 , then (by default) they will be sans-seri
5408 f and bold when viewed in a web browser, too.
5409 And this is true not just for pre-defined styles, like Section, but for
5410 any style, including user-defined styles.
5411 Indeed, the XHTML output routines make no distinction between user-defined
5412 paragraph and character styles and \SpecialChar LyX
5413 's own pre-defined styles: in each case,
5414 everything \SpecialChar LyX
5415 knows about the styles is contained in the layout files.
5416 And much the same is true as regards pre-defined textual insets, such as
5417 footnotes, and various custom insets.
5421 \begin_layout Standard
5422 The result is that XHTML output can be customized and extended in exactly
5423 the same way \SpecialChar LaTeX
5424 output can be customized and extended: through layout files
5426 See chapter five of the
5430 manual for the details.
5433 \begin_layout Standard
5434 The remainder of this chapter contains more detailed information on XHTML
5435 output, its limitations, and ways to work around those limitations.
5438 \begin_layout Section
5439 Math Output in XHTML
5442 \begin_layout Standard
5444 offers four choices for how math is rendered.
5445 These have various advantages and disadvantages:
5448 \begin_layout Itemize
5450 \begin_inset Newline newline
5453 MathML is a dialect of XML designed specifically for mathematics on the
5454 web, and it typically renders very well in browsers that support it.
5455 The disadvantage is that not all browsers support MathML, and support is
5456 not complete even in the Gecko-based browsers, such as Firefox.
5457 \begin_inset Newline newline
5461 is unable to render a formula as MathML—for example, if the formula
5463 \begin_inset Flex Code
5466 \begin_layout Plain Layout
5472 package or ERT—then it will instead output the formula as an image.
5476 \begin_layout Itemize
5478 \begin_inset Newline newline
5482 \begin_inset Flex Code
5485 \begin_layout Plain Layout
5491 outputs math as HTML, styled by CSS.
5495 \begin_layout Plain Layout
5497 has borrowed some of the CSS for its HTML output from
5498 \begin_inset Flex Code
5501 \begin_layout Plain Layout
5512 For simple formulae, this can work quite well, though with more complicated
5513 formulae it tends to break down.
5514 Still, this method has the advantage that it is very widely supported and
5515 so it may be appropriate for documents that contain only a little, fairly
5517 \begin_inset Newline newline
5520 If Lyx is unable to render a formula as HTML—for example, if the formula
5522 \begin_inset Flex Code
5525 \begin_layout Plain Layout
5531 package or ERT—then it will instead output the formula as an image.
5535 \begin_layout Itemize
5537 \begin_inset Newline newline
5541 \begin_inset Flex Code
5544 \begin_layout Plain Layout
5551 will output formulae as images, the very same images, in fact, that are
5552 used for instant preview.
5556 \begin_layout Plain Layout
5557 Instant preview does
5561 have to be on for images to be output, however.
5566 The advantage to this method is that the images are simply generated by
5568 , so they are very accurate.
5569 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5570 so they do not scale terribly well, and one cannot copy them, etc.
5571 \begin_inset Newline newline
5574 The size of the images can be controlled by setting the
5575 \begin_inset Quotes eld
5579 \begin_inset Quotes erd
5583 \begin_inset Flex Noun
5586 \begin_layout Plain Layout
5587 Document\SpecialChar menuseparator
5588 Settings\SpecialChar menuseparator
5598 \begin_layout Plain Layout
5599 For those who want to know, this controls the resolution of the image in
5600 dots per inch and is based upon a default of 75 dpi.
5606 \begin_inset Newline newline
5610 for some reason fails to create an image for a formula (e.g., if a required
5612 package is not installed), then it will fall back to outputing the raw
5617 \begin_layout Itemize
5620 \begin_inset Newline newline
5623 Finally, \SpecialChar LyX
5624 will happily output math as \SpecialChar LaTeX
5626 As well as being the output of last resort, this method can be used with
5628 \begin_inset CommandInset href
5631 target "http://www.math.union.edu/~dpvc/jsMath/"
5636 , which uses JavaScript to render \SpecialChar LaTeX
5637 embedded in HTML documents.
5639 wraps the \SpecialChar LaTeX
5641 \begin_inset Flex Code
5644 \begin_layout Plain Layout
5650 (for inline formulas) or
5651 \begin_inset Flex Code
5654 \begin_layout Plain Layout
5660 (for displayed formulas) with
5661 \begin_inset Flex Code
5664 \begin_layout Plain Layout
5670 , as is required for jsMath.
5673 \begin_layout Standard
5674 One of these output methods must be selected under
5675 \begin_inset Flex Noun
5678 \begin_layout Plain Layout
5679 Document\SpecialChar menuseparator
5680 Settings\SpecialChar menuseparator
5687 By default, \SpecialChar LyX
5689 This is a document-wide setting, therefore.
5692 \begin_layout Standard
5693 Eventually, \SpecialChar LyX
5694 will offer the user the option to select an alternate output
5695 method for a particular inset, say, one that isn't being rendered very
5700 \begin_layout Plain Layout
5701 That said, since \SpecialChar LyX
5702 falls back to images if the inset contains ERT, then one
5703 can force output as an image by putting some harmless ERT into the math,
5705 \begin_inset Formula $a=b\relax$
5716 \begin_layout Section
5717 Bibliography and Citations
5720 \begin_layout Standard
5721 XHTML output fully supports bibliographies and citations.
5725 \begin_layout Standard
5726 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5728 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5731 If you are using numerical citations, then \SpecialChar LyX
5732 will output numerical labels,
5733 such as [1] or [17], rather than simply showing the citation key in square
5734 brackets, as it does on-screen.
5735 If you are using author-year citations, then \SpecialChar LyX
5736 will add lowercase letters
5737 to the years, just as Bib\SpecialChar TeX
5738 does, if it finds more than one citation for
5739 a given author-year combination.
5740 The labels will be printed with the bibliography entries.
5741 Note that there is, at present, no way to customize the appearance of the
5742 labels, for example, to choose between square brackets and parentheses.
5745 \begin_layout Standard
5746 Bibliography output is handled by the same machinery that handles the presentati
5747 on of reference information in the citation dialog, so you will see in the
5748 XHTML output pretty much what you would see if you were to look at a given
5749 entry in the citation dialog.
5750 The formatting can be customized in your layout file or, preferably, in
5756 manual for the details.
5759 \begin_layout Standard
5760 The main defect at present is that cross-referenced information is printed
5761 with every entry with which it is associated.
5762 So you can see things like this:
5767 \begin_inset Quotes eld
5770 Context and Logical Form
5771 \begin_inset Quotes erd
5776 Language in Context: Selected Essays
5778 (Oxford: Oxford University Press, 2007), pp.
5784 \begin_inset Quotes eld
5787 Semantics in Context
5788 \begin_inset Quotes erd
5793 Language in Context: Selected Essays
5795 (Oxford: Oxford University Press, 2007), pp.
5799 \begin_layout Standard
5800 This should be fixed before long.
5803 \begin_layout Standard
5804 There is no support at present for sectioned bibliographies.
5805 If you have multiple bibliographies, then \SpecialChar LyX
5806 will print the same bibliography
5810 \begin_layout Section
5814 \begin_layout Standard
5816 will happily export indexes as XHTML, but with certain limitations at the
5820 \begin_layout Standard
5821 Index export will be most reliable when you do not attempt to use the fancy
5822 constructs that are described in the section on indexes in the
5830 \begin_layout Plain Layout
5831 The main issue here is that \SpecialChar LyX
5832 itself does not really handle these.
5833 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5839 We'll describe how they are handled using the subsection headings from
5843 \begin_layout Itemize
5844 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5845 makes an effort to support these,
5846 but the entries must be separated by
5847 \begin_inset Quotes eld
5851 \begin_inset Quotes erd
5854 , that is, there must be spaces around the exclamation point.
5855 This is because it is otherwise too difficult to check for escaped exclamation
5856 points, ones in math, and so forth.
5859 \begin_layout Itemize
5860 Page Ranges: There is no support at all for page ranges, since these make
5861 no sense with XHMTL.
5862 Instead, you will just get two index entries, one at either end.
5865 \begin_layout Itemize
5866 Cross-referencing: There is no support for cross-referencing.
5868 finds an entry containing the
5869 \begin_inset Quotes eld
5872 |see\SpecialChar ldots
5874 \begin_inset Quotes erd
5877 construct, it is just dropped, and the rest is treated as an ordinary index
5881 \begin_layout Itemize
5882 Index Entry Order: \SpecialChar LyX
5883 does support attempts to fix the sorting order.
5884 It will take what is before the first `@' it finds and use that for sorting,
5885 taking what follows the first `@' to be the actual entry.
5886 At present, \SpecialChar LyX
5887 does not check for escaped `@', so do not try to index email
5891 \begin_layout Itemize
5892 Index Entry Layout: You can format entries by using the text style dialog,
5893 or by using any other method available within \SpecialChar LyX
5895 There is no support for constructs like:
5896 \begin_inset Quotes eld
5900 \begin_inset Quotes erd
5904 Indeed, if \SpecialChar LyX
5905 finds a pipe symbol, `|', in an entry, it will delete it and
5906 everything that follows it.
5909 \begin_layout Itemize
5910 Multiple Indexes: There is no support for multiple indexes.
5911 Rather, all index entries will be printed as one large index.
5912 To avoid our printing several versions of the index, we print only the
5913 main index, so make sure you have one.
5916 \begin_layout Section
5917 Nomenclature and Glossary
5920 \begin_layout Standard
5921 There is at present no support for glossaries.
5922 Adding it would be fairly trivial, and welcome.
5925 \begin_layout Chapter
5926 The \SpecialChar LyX
5930 \begin_layout Section
5934 \begin_layout Standard
5935 The `\SpecialChar LyX
5936 server' allows other programs to talk to \SpecialChar LyX
5937 , invoke \SpecialChar LyX
5938 commands, and retrieve
5939 information about the \SpecialChar LyX
5941 This is only intended for advanced users, but they should find it useful.
5942 It is by writing to the \SpecialChar LyX
5943 server, for example, that bibliography managers,
5944 such as JabRef, are able to
5945 \begin_inset Quotes eld
5949 \begin_inset Quotes erd
5952 citations to \SpecialChar LyX
5956 \begin_layout Section
5957 Starting the \SpecialChar LyX
5959 \begin_inset CommandInset label
5961 name "sec:Starting-the-Server"
5968 \begin_layout Standard
5969 The \SpecialChar LyX
5970 server works through the use of a pair of named pipes.
5971 These are usually located in
5972 \begin_inset Flex Code
5975 \begin_layout Plain Layout
5981 , (except on Windows, where
5985 named pipes are special objects located in
5986 \begin_inset Flex Code
5989 \begin_layout Plain Layout
6001 ) and have the names
6002 \begin_inset Quotes eld
6006 \begin_inset Flex Code
6009 \begin_layout Plain Layout
6016 \begin_inset Quotes erd
6020 \begin_inset Quotes eld
6024 \begin_inset Flex Code
6027 \begin_layout Plain Layout
6034 \begin_inset Quotes erd
6038 External programs write into
6039 \begin_inset Flex Code
6042 \begin_layout Plain Layout
6048 and read back data from
6049 \begin_inset Flex Code
6052 \begin_layout Plain Layout
6059 The stem of the pipe names can be defined in the
6060 \begin_inset Flex Noun
6063 \begin_layout Plain Layout
6064 Tools\SpecialChar menuseparator
6071 \begin_inset Flex Code
6074 \begin_layout Plain Layout
6075 "/home/myhome/lyxpipe"
6081 \begin_inset Flex Code
6084 \begin_layout Plain Layout
6098 on Windows (where any working path instead of lyxpipe can be used, for
6100 \begin_inset Flex Code
6103 \begin_layout Plain Layout
6126 configure this manually in order for the server to start.
6129 \begin_layout Standard
6132 \begin_inset Flex Code
6135 \begin_layout Plain Layout
6142 \begin_inset Flex Code
6145 \begin_layout Plain Layout
6151 ' to create the pipes.
6152 If one of the pipes already exists, \SpecialChar LyX
6153 will assume that another \SpecialChar LyX
6155 is already running and will not start the server.
6156 On POSIX (Unix like) systems, if for some other reason, an unused
6157 \begin_inset Quotes eld
6161 \begin_inset Quotes erd
6164 pipe is left in existence when \SpecialChar LyX
6165 closes, then \SpecialChar LyX
6166 will try to delete it.
6167 If this fails for some reason, you will need to delete the pipes manually
6168 and then restart \SpecialChar LyX
6170 On Windows, pipes are deleted by the OS on program termination or crash,
6172 \begin_inset Quotes eld
6176 \begin_inset Quotes erd
6179 pipes should not be possible.
6182 \begin_layout Standard
6183 To have several \SpecialChar LyX
6184 processes with servers at the same time, you have to use
6185 different configurations, perhaps by using separate user directories, each
6187 \begin_inset Flex Code
6190 \begin_layout Plain Layout
6196 file, for each process.
6199 \begin_layout Standard
6200 If you are developing a client program, you might find it useful to enable
6201 debugging information from the \SpecialChar LyX
6203 Do this by starting \SpecialChar LyX
6205 \begin_inset Flex Code
6208 \begin_layout Plain Layout
6217 \begin_layout Standard
6218 You can find a complete example client written in C++ in the source distribution
6220 \begin_inset Flex Code
6223 \begin_layout Plain Layout
6224 development/lyxserver/server_monitor.cpp
6232 \begin_layout Standard
6233 Another useful tool is the command-line based client found in
6234 \begin_inset Flex Code
6237 \begin_layout Plain Layout
6238 src/client/lyxclient
6246 \begin_layout Section
6247 Normal communication
6250 \begin_layout Standard
6251 To issue a \SpecialChar LyX
6252 call, the client writes a line of ASCII text into the input
6254 This line has the following format:
6271 \begin_layout Description
6272 clientname is a name that the client can choose arbitrarily.
6273 Its only use is that \SpecialChar LyX
6274 will echo it if it sends an answer—so a client can
6275 dispatch results from different requesters.
6278 \begin_layout Description
6279 function is the function you want \SpecialChar LyX
6281 It is the same as the commands you'd use in the minibuffer.
6284 \begin_layout Description
6285 argument is an optional argument which is meaningful only to some functions
6287 \begin_inset Quotes eld
6291 \begin_inset Quotes erd
6294 LFUN will insert the argument as text at the cursor position).
6297 \begin_layout Standard
6298 The answer from \SpecialChar LyX
6299 will arrive in the output pipe and be of the form
6316 \begin_layout Standard
6325 are just echoed from the command request, while
6329 is more or less useful information filled according to how the command
6330 execution worked out.
6331 Some commands, such as
6332 \begin_inset Quotes eld
6336 \begin_inset Quotes erd
6339 , will return information about the internal state of \SpecialChar LyX
6341 return an empty data-response.
6342 This means that the command execution went fine.
6345 \begin_layout Standard
6346 In case of errors, the response from \SpecialChar LyX
6364 \begin_layout Standard
6369 should contain an explanation of why the command failed.
6372 \begin_layout Standard
6376 \begin_layout LyX-Code
6377 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6378 \begin_inset Newline newline
6381 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6382 \begin_inset Newline newline
6385 read a <~/.lyxpipe.out
6386 \begin_inset Newline newline
6392 \begin_layout Subsection
6393 AppleScript (Mac OS X)
6396 \begin_layout Standard
6397 Since \SpecialChar LyX
6398 2.1, \SpecialChar LyX
6399 supports basic interactions with AppleScript for normal communicatio
6400 n through the command run.
6401 This command takes a direct argument (the
6405 to perform) and an optional argument.
6406 It either returns the output of the function or triggers an error with
6407 the error message and code.
6410 \begin_layout Standard
6414 \begin_layout LyX-Code
6415 tell application "\SpecialChar LyX
6419 \begin_layout LyX-Code
6423 \begin_layout LyX-Code
6424 -- Stores the current file name into f
6427 \begin_layout LyX-Code
6428 set f to (run "server-get-filename" with argument "")
6431 \begin_layout LyX-Code
6432 on error the error_message number the error_number
6435 \begin_layout LyX-Code
6436 display dialog "Error: " & the error_number & ".
6440 \begin_layout LyX-Code
6441 & the error_message buttons {"OK"} default button 1
6444 \begin_layout LyX-Code
6448 \begin_layout LyX-Code
6452 \begin_layout Section
6456 \begin_layout Standard
6458 can notify clients of events going on asynchronously.
6459 Currently it will only do this if the user binds a key sequence with the
6461 \begin_inset Quotes eld
6465 \begin_inset Quotes erd
6469 The format of the string \SpecialChar LyX
6470 sends is as follows:
6474 \begin_inset Flex Code
6477 \begin_layout Plain Layout
6488 \begin_layout Standard
6493 is the printed representation of the key sequence that was actually typed
6497 \begin_layout Standard
6498 This mechanism can be used to extend \SpecialChar LyX
6499 's command set and implement macros.
6500 Bind some key sequence to
6501 \begin_inset Quotes eld
6505 \begin_inset Quotes erd
6509 Then start a client that listens on the output pipe, dispatches the command
6510 according to the sequence, and starts a function that may use \SpecialChar LyX
6513 requests to issue a command or a series of commands to \SpecialChar LyX
6517 \begin_layout Section
6518 The simple \SpecialChar LyX
6522 \begin_layout Standard
6524 implements a simple protocol that can be used for session management.
6525 All messages are of the form
6538 \begin_layout Standard
6544 \begin_inset Quotes eld
6548 \begin_inset Quotes erd
6552 \begin_inset Quotes eld
6556 \begin_inset Quotes erd
6561 \begin_inset Quotes eld
6565 \begin_inset Quotes erd
6568 is received from a client, \SpecialChar LyX
6569 will report back to inform the client that
6570 it's listening to it's messages, while
6571 \begin_inset Quotes eld
6575 \begin_inset Quotes erd
6578 sent from \SpecialChar LyX
6579 will inform clients that \SpecialChar LyX
6583 \begin_layout Section
6584 Reverse DVI/PDF search
6587 \begin_layout Standard
6588 Some DVI/PDF viewers
6592 \begin_layout Plain Layout
6593 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6594 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6603 facility (also called
6608 This means that you can tell \SpecialChar LyX
6609 to put the cursor to a specific line in the
6610 document by clicking at the respective position in the DVI/PDF output.
6611 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6613 This is done via the \SpecialChar LyX
6614 server either by using the named pipe (
6618 ), or the UNIX domain socket (
6622 ) that \SpecialChar LyX
6623 creates in its temporary directory (this is the way the
6624 \begin_inset Flex Code
6627 \begin_layout Plain Layout
6633 program communicates with \SpecialChar LyX
6635 In some cases, you need a helper script that mediates between the viewer
6636 and \SpecialChar LyX
6637 , in others, the viewer can communicate with \SpecialChar LyX
6639 This depends on the selected viewer and on your operating system.
6640 The same applies to the way viewers need to be configured and the way the
6641 reverse search is actually performed.
6642 In what follows, we will thus describe how to setup reverse search for
6644 Before we turn to this, though, we will explain what needs to be done generally
6645 to enable reverse search in the DVI/PDF output.
6648 \begin_layout Subsection
6650 \begin_inset CommandInset label
6652 name "subsec:rev-search"
6659 \begin_layout Standard
6660 In most cases \SpecialChar LyX
6661 will do the work for you by pressing the following button
6665 arg "buffer-toggle-output-sync"
6669 Alternatively, you can also enable the feature by checking
6671 Synchronize with Output
6674 \begin_inset Flex Noun
6677 \begin_layout Plain Layout
6678 Document\SpecialChar menuseparator
6679 Settings\SpecialChar menuseparator
6686 In such a case \SpecialChar LyX
6687 will automatically insert the necessary Sync\SpecialChar TeX
6689 PDF) or load the srcltx package (for DVI) respectively.
6690 This option can be easily reached also on
6691 \begin_inset Flex Code
6694 \begin_layout Plain Layout
6703 \begin_layout Standard
6704 If you need a different setting, you can select or input a custom macro
6705 from the drop down box just below
6706 \begin_inset Flex Noun
6709 \begin_layout Plain Layout
6710 Document\SpecialChar menuseparator
6711 Settings\SpecialChar menuseparator
6712 Output\SpecialChar menuseparator
6713 Synchronize with Output
6721 \begin_layout Standard
6722 Note that the method
6723 \begin_inset Flex Code
6726 \begin_layout Plain Layout
6734 enables gzip compression.
6735 If your viewer does not support it, you should instead use
6736 \begin_inset Flex Code
6739 \begin_layout Plain Layout
6750 \begin_layout Standard
6751 Please also note that including the
6752 \begin_inset Flex Code
6755 \begin_layout Plain Layout
6762 \begin_inset Flex Code
6765 \begin_layout Plain Layout
6771 sometimes has an undesired impact on the typesetting.
6772 Thus, you should switch output synchronization off for the final typesetting
6774 \begin_inset Flex Code
6777 \begin_layout Plain Layout
6784 \begin_inset Flex Code
6787 \begin_layout Plain Layout
6797 \begin_layout Standard
6798 In case you need some more special settings that are not covered by the
6799 automatic settings, read the next section about how to set up output synchroniz
6801 If the automatic setup suits your needs, you can readily jump to section
6802 \begin_inset space ~
6806 \begin_inset CommandInset ref
6808 reference "subsec:configuring-viewers"
6812 , where the necessary configuration steps in your viewer – needed both with
6813 the automatic and the manual setup – are described.
6816 \begin_layout Subsection
6820 \begin_layout Standard
6822 provides several different methods for reverse search.
6823 Some are built-in in the
6824 \begin_inset Flex Code
6827 \begin_layout Plain Layout
6833 program, some are provided by external packages.
6834 Your choice depends on whether your \SpecialChar LaTeX
6835 distribution already provides a given
6836 method (the built-in methods are rather new) and whether your viewer can
6838 The available methods are described in the following.
6841 \begin_layout Subsubsection*
6842 Built-in DVI-search via src-specials (DVI only)
6845 \begin_layout Standard
6846 This method provides the DVI file with the necessary information for reverse
6848 It is available in \SpecialChar LaTeX
6849 since quite some time (any somewhat recent \SpecialChar LaTeX
6851 should include it), and it works reliably.
6852 To enable it, change the
6853 \begin_inset Flex Noun
6856 \begin_layout Plain Layout
6867 \begin_inset Flex Noun
6870 \begin_layout Plain Layout
6881 \begin_inset Flex Noun
6884 \begin_layout Plain Layout
6885 Preferences\SpecialChar menuseparator
6886 File Handling\SpecialChar menuseparator
6893 \begin_inset Flex Code
6896 \begin_layout Plain Layout
6897 latex -src-specials $$i
6903 If this doesn't work, check if your \SpecialChar TeX
6904 engine needs different options (the
6905 syntax might differ in some distributions).
6908 \begin_layout Subsubsection*
6909 External Packages (PDFSync and scrltx)
6912 \begin_layout Standard
6921 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6923 In order to enable it, load the packages in the \SpecialChar LyX
6927 \begin_layout Itemize
6928 \begin_inset Flex Code
6931 \begin_layout Plain Layout
6939 for reverse PDF search,
6942 \begin_layout Itemize
6943 \begin_inset Flex Code
6946 \begin_layout Plain Layout
6949 usepackage[active]{srcltx}
6954 for reverse DVI search.
6957 \begin_layout Standard
6958 If you want to be able to perform both DVI and PDF reverse searches, you
6959 can also insert in the preamble the following lines
6962 \begin_layout LyX-Code
6966 \begin_inset Newline newline
6972 \begin_inset Newline newline
6978 \begin_inset Newline newline
6984 \begin_inset Newline newline
6989 usepackage[active]{srcltx}
6990 \begin_inset Newline newline
6998 \begin_layout Standard
6999 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7000 right package will be used.
7003 \begin_layout Standard
7004 Note that PDFSync might affect the output layout of your document.
7005 It is therefore advised to disable PDFsync for final documents.
7008 \begin_layout Subsubsection*
7009 Built-in reverse search via Sync\SpecialChar TeX
7013 \begin_layout Standard
7015 \begin_inset Flex Code
7018 \begin_layout Plain Layout
7024 have built-in support for both PDF and DVI reverse search.
7027 Sync\SpecialChar TeX
7030 facility is basically the result of the integration of the PDFSync package
7031 to the pdftex program and its merge with the
7036 You need at least \SpecialChar TeX
7037 Live 2008 or a recent Mik\SpecialChar TeX
7038 distribution in order to use
7043 \begin_layout Plain Layout
7044 For some reason, Mik\SpecialChar TeX
7045 does not understand/obey the command \SpecialChar LyX
7047 the preamble when you check the "Enable Forward/Reverse Search" button
7048 in the toolbar and does not generate the necessary info.
7051 \begin_layout Plain Layout
7052 The generation of the required info can be forced by changing the converter
7054 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7055 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7056 the -synctex=1 switch).
7061 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
7062 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
7063 already provide Sync\SpecialChar TeX
7067 \begin_layout Standard
7068 To enable Sync\SpecialChar TeX
7069 for DVI output, change the
7070 \begin_inset Flex Noun
7073 \begin_layout Plain Layout
7084 \begin_inset Flex Noun
7087 \begin_layout Plain Layout
7098 \begin_inset Flex Noun
7101 \begin_layout Plain Layout
7102 Preferences\SpecialChar menuseparator
7103 File Handling\SpecialChar menuseparator
7110 \begin_inset Flex Code
7113 \begin_layout Plain Layout
7114 latex -synctex=1 $$i
7119 , and for PDF output, change the
7120 \begin_inset Flex Noun
7123 \begin_layout Plain Layout
7128 (pdflatex) -> PDF (pdflatex)
7134 \begin_inset Flex Code
7137 \begin_layout Plain Layout
7138 pdflatex -synctex=1 $$i
7144 Should your viewer not be considered in the following description, or in
7145 case of missing success, please check the documentation of your viewer
7146 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
7151 \begin_layout Plain Layout
7152 Note that the option
7153 \begin_inset Flex Code
7156 \begin_layout Plain Layout
7162 option enables gzip compression.
7163 If your viewer does not support it, you should instead use
7164 \begin_inset Flex Code
7167 \begin_layout Plain Layout
7181 \begin_layout Subsection
7182 Configuring and using specific viewers
7183 \begin_inset CommandInset label
7185 name "subsec:configuring-viewers"
7192 \begin_layout Subsubsection*
7193 Xdvi (all platforms)
7196 \begin_layout Standard
7198 \begin_inset Flex Code
7201 \begin_layout Plain Layout
7207 , you don't need to do anything else for performing a reverse DVI search,
7209 already provides the necessary hooks for automatically using the
7210 \begin_inset Flex Code
7213 \begin_layout Plain Layout
7220 Just setup your document as described above (reverse search is triggered
7221 by Ctrl-click or Alt-click on Mac OSX, respectively).
7224 \begin_layout Standard
7225 However, if for whatever reason you want to use the named pipe instead of
7226 the socket for communicating with \SpecialChar LyX
7227 , simply change the DVI viewer in
7228 \begin_inset Flex Noun
7231 \begin_layout Plain Layout
7232 Preferences\SpecialChar menuseparator
7233 File Handling\SpecialChar menuseparator
7243 \begin_layout Plain Layout
7244 On Mac OSX you have to use
7245 \begin_inset Flex Code
7248 \begin_layout Plain Layout
7249 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7260 \begin_inset Flex Code
7263 \begin_layout Plain Layout
7264 xdvi -editor "lyxeditor.sh %f %l"
7270 \begin_inset Flex Code
7273 \begin_layout Plain Layout
7279 is a suitable script.
7280 For example, a minimal shell script is the following one:
7283 \begin_layout LyX-Code
7285 \begin_inset Newline newline
7288 LYXPIPE="/path/to/lyxpipe"
7289 \begin_inset Newline newline
7292 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7293 \begin_inset Newline newline
7296 echo "$COMMAND" > "${LYXPIPE}".in || exit
7297 \begin_inset Newline newline
7300 read TMP < "${LYXPIPE}".out || exit
7303 \begin_layout Standard
7305 \begin_inset Flex Code
7308 \begin_layout Plain Layout
7314 is the LyXServer pipe path specified in
7315 \begin_inset Flex Noun
7318 \begin_layout Plain Layout
7319 Preferences\SpecialChar menuseparator
7329 \begin_layout Plain Layout
7331 \begin_inset Flex Code
7334 \begin_layout Plain Layout
7340 folder of a source distribution you can find a
7341 \begin_inset Flex Code
7344 \begin_layout Plain Layout
7350 script which is able to locate the
7354 based on your preferences.
7362 \begin_layout Subsubsection*
7366 \begin_layout Standard
7368 \begin_inset Flex Code
7371 \begin_layout Plain Layout
7372 /Applications/MacDviX_Folder/calleditor.script
7377 , add the following lines:
7380 \begin_layout LyX-Code
7381 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7382 \begin_inset Newline newline
7388 \begin_layout Standard
7389 Modify the lines accordingly if you install \SpecialChar LyX
7390 somewhere else than in the
7391 Applications folder.
7394 \begin_layout Standard
7395 Reverse search is triggered by Alt-click (OPTION-click).
7398 \begin_layout Subsubsection*
7402 \begin_layout Standard
7404 \begin_inset Flex Code
7407 \begin_layout Plain Layout
7408 open -a Skim.app $$i
7413 to the viewer setting in
7414 \begin_inset Flex Noun
7417 \begin_layout Plain Layout
7418 Preferences\SpecialChar menuseparator
7419 File Handling\SpecialChar menuseparator
7420 File formats\SpecialChar menuseparator
7427 \begin_inset Flex Noun
7430 \begin_layout Plain Layout
7431 Skim\SpecialChar menuseparator
7432 Preferences\SpecialChar menuseparator
7439 \begin_inset Flex Noun
7442 \begin_layout Plain Layout
7448 preset and enter command
7449 \begin_inset Flex Noun
7452 \begin_layout Plain Layout
7453 /Applications/\SpecialChar LyX
7454 .app/Contents/MacOS/lyxeditor
7462 \begin_layout Standard
7463 Reverse search is triggered by COMMAND-SHIFT-click
7466 \begin_layout Subsubsection*
7470 \begin_layout Standard
7471 Reverse search with evince does not work out of the box, but it can be achieved
7472 by means of some third party helper scripts.
7474 \begin_inset CommandInset href
7476 target "https://wiki.lyx.org/LyX/SyncTeX"
7484 \begin_layout Subsubsection*
7488 \begin_layout Standard
7490 \begin_inset Flex Noun
7493 \begin_layout Plain Layout
7494 Settings\SpecialChar menuseparator
7495 Configure Okular\SpecialChar menuseparator
7502 \begin_inset Quotes erd
7506 This inserts the appropriate command (
7507 \begin_inset Flex Code
7510 \begin_layout Plain Layout
7519 \begin_layout Standard
7520 Reverse search is triggered by SHIFT-click.
7523 \begin_layout Subsubsection*
7527 \begin_layout Standard
7528 Qpdfview supports Sync\SpecialChar TeX
7529 since version 0.3.5.
7531 \begin_inset Flex Noun
7534 \begin_layout Plain Layout
7535 Edit\SpecialChar menuseparator
7536 Settings\SpecialChar menuseparator
7542 , click on the input field of the
7543 \begin_inset Quotes eld
7547 \begin_inset Quotes erd
7550 item and add the command
7551 \begin_inset Flex Code
7554 \begin_layout Plain Layout
7563 \begin_layout Standard
7564 Reverse search is triggered by double-click or, in more recent versions,
7568 \begin_layout Subsubsection*
7572 \begin_layout Standard
7573 Launch yap, choose its
7574 \begin_inset Flex Noun
7577 \begin_layout Plain Layout
7578 View\SpecialChar menuseparator
7585 \begin_inset Quotes eld
7589 \begin_inset Quotes erd
7594 \begin_inset Quotes eld
7597 New\SpecialChar ldots
7599 \begin_inset Quotes erd
7602 button and, in the window that opens, enter
7603 \begin_inset Quotes eld
7608 \begin_inset Quotes erd
7611 (or any other name you like) in the
7612 \begin_inset Quotes eld
7616 \begin_inset Quotes erd
7620 Now click on the button labeled
7621 \begin_inset Quotes eld
7626 \begin_inset Quotes erd
7629 to open a file dialog and navigate to the directory containing the batch
7631 \begin_inset Flex Code
7634 \begin_layout Plain Layout
7642 \begin_inset Flex Code
7645 \begin_layout Plain Layout
7651 and then specify the program arguments as
7652 \begin_inset Flex Code
7655 \begin_layout Plain Layout
7663 \begin_inset Flex Code
7666 \begin_layout Plain Layout
7672 wrapper is used for communicating with \SpecialChar LyX
7680 \begin_layout LyX-Code
7682 \begin_inset Newline newline
7685 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
7694 \begin_inset Newline newline
7708 \begin_layout Standard
7709 Make sure that the \SpecialChar LyX
7710 Server pipe path you specified in \SpecialChar LyX
7712 \begin_inset Flex Code
7715 \begin_layout Plain Layout
7729 , otherwise change the
7730 \begin_inset Flex Code
7733 \begin_layout Plain Layout
7739 wrapper accordingly.
7742 \begin_layout Standard
7743 In yap, reverse search is triggered by double-click.
7746 \begin_layout Subsubsection*
7747 SumatraPDF (Windows)
7750 \begin_layout Standard
7751 In order to use SumatraPDF for inverse search, enter
7752 \begin_inset Flex Code
7755 \begin_layout Plain Layout
7756 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
7761 in the viewer setting in
7762 \begin_inset Flex Noun
7765 \begin_layout Plain Layout
7766 Preferences\SpecialChar menuseparator
7767 File Handling\SpecialChar menuseparator
7768 File formats\SpecialChar menuseparator
7775 \begin_inset Flex Code
7778 \begin_layout Plain Layout
7784 is the previous wrapper.
7785 If SumatraPDF.exe is not in your command PATH, use its full file name.
7788 \begin_layout Standard
7789 Reverse search is triggered by double-click.
7792 \begin_layout Subsubsection*
7796 \begin_layout Standard
7797 First of all, make sure that yap is your default DVI viewer in the Windows
7798 environment, then launch it, choose its
7799 \begin_inset Flex Noun
7802 \begin_layout Plain Layout
7803 View\SpecialChar menuseparator
7810 \begin_inset Quotes eld
7814 \begin_inset Quotes erd
7819 \begin_inset Quotes eld
7822 New\SpecialChar ldots
7824 \begin_inset Quotes erd
7827 button and, in the window that opens, enter
7828 \begin_inset Quotes eld
7833 \begin_inset Quotes erd
7836 (or any other name you like) in the
7837 \begin_inset Quotes eld
7841 \begin_inset Quotes erd
7845 Now click on the button labeled
7846 \begin_inset Quotes eld
7851 \begin_inset Quotes erd
7854 to open a file dialog and navigate to the directory containing the
7855 \begin_inset Flex Code
7858 \begin_layout Plain Layout
7864 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7867 \begin_inset Flex Code
7870 \begin_layout Plain Layout
7876 and then specify the program arguments as
7877 \begin_inset Flex Code
7880 \begin_layout Plain Layout
7887 In this way, you will be using the
7891 for communicating with \SpecialChar LyX
7893 If, for whatever reason, you want to use the
7898 \begin_inset Flex Code
7901 \begin_layout Plain Layout
7907 option and be sure to specify the \SpecialChar LyX
7908 Server pipe path in the \SpecialChar LyX
7912 \begin_layout Standard
7913 In yap, reverse search is triggered by double-click.
7916 \begin_layout Subsubsection*
7920 \begin_layout Standard
7921 In order to use SumatraPDF for inverse search, enter
7922 \begin_inset Flex Code
7925 \begin_layout Plain Layout
7926 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7931 in the viewer setting in
7932 \begin_inset Flex Noun
7935 \begin_layout Plain Layout
7936 Preferences\SpecialChar menuseparator
7937 File Handling\SpecialChar menuseparator
7938 File formats\SpecialChar menuseparator
7945 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7947 \begin_inset Flex Code
7950 \begin_layout Plain Layout
7956 enables communication via the
7962 \begin_inset Flex Code
7965 \begin_layout Plain Layout
7971 option if you want to use the
7975 , and be sure to specify the \SpecialChar LyX
7976 Server pipe path in the \SpecialChar LyX
7980 \begin_layout Standard
7981 Reverse search is triggered by double-click.
7984 \begin_layout Section
7988 \begin_layout Standard
7989 Forward search is, as the name implies, in a sense the
7990 \begin_inset Quotes eld
7994 \begin_inset Quotes erd
7998 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8000 If forward search is set up (as described in what follows), you can put
8001 the cursor anywhere in your \SpecialChar LyX
8003 \begin_inset Flex Noun
8006 \begin_layout Plain Layout
8007 Navigate\SpecialChar menuseparator
8014 \begin_inset Flex Noun
8017 \begin_layout Plain Layout
8023 in the context menu via right mouse click), and then the viewer will jump
8024 to that position as well.
8025 This implies, of course, that your viewer supports this function.
8028 \begin_layout Standard
8029 To make forward search possible, you first need to provide the generated
8030 output PDF/DVI file with additional information about the \SpecialChar TeX
8032 This can be done via the methods described in the section
8033 \begin_inset CommandInset ref
8035 reference "subsec:rev-search"
8042 \begin_layout Standard
8043 Additionally, you need to configure \SpecialChar LyX
8044 for using your viewers in
8045 \begin_inset Flex Noun
8048 \begin_layout Plain Layout
8049 Tools\SpecialChar menuseparator
8050 Preferences\SpecialChar menuseparator
8051 Output\SpecialChar menuseparator
8058 We provide a range of tested configurations for some viewers, which you
8059 can select from the drop down list.
8060 If none of these configurations suits you, you have to find out and enter
8061 a suitable configuration yourself.
8062 The definition syntax uses the following placeholders:
8065 \begin_layout Itemize
8067 \begin_inset Flex Code
8070 \begin_layout Plain Layout
8079 \begin_layout Itemize
8081 \begin_inset Flex Code
8084 \begin_layout Plain Layout
8090 : name of the (temporary) exported .tex file (without path)
8093 \begin_layout Itemize
8095 \begin_inset Flex Code
8098 \begin_layout Plain Layout
8104 : name of the (temporary) exported .tex file (including path)
8107 \begin_layout Itemize
8109 \begin_inset Flex Code
8112 \begin_layout Plain Layout
8118 : name of the exported output file (either dvi or pdf, depending on which
8119 one exists in the temporary directory)
8122 \begin_layout Standard
8123 Note that only some of the viewers provide full and usable forward search
8124 functionality out of the box, among them yap, xdvi, okular
8128 \begin_layout Plain Layout
8129 You might want to set
8130 \begin_inset Flex Code
8133 \begin_layout Plain Layout
8140 \begin_inset Flex Noun
8143 \begin_layout Plain Layout
8144 Tools\SpecialChar menuseparator
8145 Preferences\SpecialChar menuseparator
8146 File Handling\SpecialChar menuseparator
8148 \begin_inset space ~
8161 , qpdfview, and SumatraPDF
8165 \begin_layout Plain Layout
8166 SumatraPDF can also use DDE commands through the external program CMCDDE
8167 — downloadable from
8168 \begin_inset CommandInset href
8170 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8181 Others, such as evince
8185 \begin_layout Plain Layout
8186 Forward search with evince can be achieved by means of third party helper
8189 \begin_inset CommandInset href
8191 target "https://wiki.lyx.org/LyX/SyncTeX"
8201 , require some extra tools in order to use forward search.
8202 While many of the widespread PDF viewers (most notably Adobe Reader) do
8203 not support forward search at all, some other viewers – e.
8204 \begin_inset space \thinspace{}
8208 xpdf – allow at least to reload the document and jump to a specific page
8209 of the file, so you can at least navigate
8210 \begin_inset Quotes eld
8214 \begin_inset Quotes erd
8218 This latter functionality is provided by an external call of synctex (see
8219 the predefined example configurations).
8223 \begin_layout Standard
8224 Forward search works both with DVI and PDF output.
8226 simply checks which preview format you have used before (i.
8227 \begin_inset space \thinspace{}
8230 e., which format is already there in the temporary directory) and chooses
8231 the appropriate configuration for the respective format.
8234 \begin_layout Chapter
8235 Special Document Classes
8238 \begin_layout Section
8242 \begin_layout Standard
8248 \begin_layout Subsection
8252 \begin_layout Standard
8253 This section describes how \SpecialChar LyX
8254 can be used to write articles for submission
8255 to the scientific journal
8257 Astronomy and Astrophysics
8260 \begin_inset Flex URL
8263 \begin_layout Plain Layout
8265 https://www.aanda.org/
8270 ) using Version 5.01 of the document class
8275 This package can be downloaded from the ftp site
8278 \begin_layout Standard
8279 \begin_inset VSpace medskip
8285 \begin_layout Standard
8287 \begin_inset Flex URL
8290 \begin_layout Plain Layout
8292 ftp://ftp.edpsciences.org/pub/aa/readme.html
8300 \begin_layout Standard
8301 \begin_inset VSpace medskip
8307 \begin_layout Standard
8308 A manual comes together with that package, and this text is not meant to
8309 replace the original manual but is merely a short guide in how to realize
8310 the correct form of your paper.
8314 \begin_layout Standard
8315 Please note that the publisher of the journal was changed from Springer
8316 to EDP Sciences starting January 1, 2001.
8317 That change involved also some slight changes to the style files, namely
8318 the removal of the thesaurus command.
8319 The \SpecialChar LyX
8320 class aa supports the newest version of these style files, V 5.01.
8321 If you have an older version installed, please upgrade.
8322 For compatibility, the old (version 4) layout has been kept as
8327 Please refer to the comments in
8330 Dir/layouts/aapaper.layout
8335 \begin_layout Subsection
8339 \begin_layout Standard
8340 It is recommended you start from the example template distributed with \SpecialChar LyX
8342 If you are not using a template, note the following settings:
8345 \begin_layout Itemize
8352 Document\SpecialChar menuseparator
8355 dialog (OK, that one was obvious).
8358 \begin_layout Itemize
8359 Don't change the option
8362 \begin_inset space ~
8372 The whole layout is done by the macros, you shouldn't change anything.
8375 \begin_layout Subsection
8379 \begin_layout Standard
8380 First thing to enter is the header information.
8381 It consists of seven entries, of which some are optional.
8385 \begin_layout Itemize
8393 \begin_layout Itemize
8401 \begin_layout Itemize
8409 \begin_layout Itemize
8417 \begin_layout Itemize
8422 : [optional] if more than one author: whom to contact for offprint requests.
8425 \begin_layout Itemize
8430 : [optional] mail address for contacts.
8433 \begin_layout Itemize
8441 Received: <date>; Accepted <date>
8444 \begin_layout Standard
8445 There is no need to issue the
8451 command, this is done automatically by \SpecialChar LyX
8452 when the header is finished.
8453 Although the order of the single header entries doesn't matter it is advised
8454 to keep the above sequence, just to get the best optics and meets the layout
8455 of the real document.
8458 \begin_layout Standard
8459 If you want to place footnotes in the header block, e.
8460 \begin_inset space \thinspace{}
8464 \begin_inset space \space{}
8467 to state your present address, just use the standard footnote via the menu
8470 Insert\SpecialChar menuseparator
8475 will automagically use the term
8484 \begin_layout Standard
8487 Edit\SpecialChar menuseparator
8490 , you'll find two insets which are relevant for the titling:
8493 \begin_layout Itemize
8500 to mark corresponding author\SpecialChar breakableslash
8502 The institutes are numbered sequentially as they appear in the
8506 field, so you have to put a marker to each author.
8509 \begin_layout Itemize
8514 to supply an email address for fast contact.
8517 \begin_layout Standard
8518 In addition to these topics, the macros use one additional \SpecialChar LaTeX
8520 has no counterpart in \SpecialChar LyX
8524 \begin_layout Itemize
8531 to separate different names for more than one author and institute, respectivel
8535 \begin_layout Standard
8536 The appropriate command has to be entered in \SpecialChar LyX
8537 and marked as \SpecialChar LaTeX
8543 \begin_layout Subsection
8547 \begin_layout Standard
8548 The abstract should immediately follow the header block.
8549 With version 5 the abstract environment was changed to a command, and there
8550 is now a restriction to only one paragraph.
8551 In addition, it should contain an entry with the keywords.
8552 This is done via the paragraph style
8557 Refer to the example paper.
8560 \begin_layout Subsection
8561 Supported environments
8564 \begin_layout Standard
8565 The A&A paper layout supports the following environments for structuring
8569 \begin_layout Itemize
8575 \begin_layout Itemize
8581 \begin_layout Itemize
8587 \begin_layout Itemize
8593 \begin_layout Itemize
8599 \begin_layout Itemize
8605 \begin_layout Itemize
8611 \begin_layout Itemize
8617 \begin_layout Itemize
8623 \begin_layout Itemize
8629 \begin_layout Itemize
8635 \begin_layout Itemize
8642 \begin_layout Subsection
8643 Commands not supported by \SpecialChar LyX
8647 \begin_layout Standard
8648 Some commands are not yet supported by the
8652 layout for \SpecialChar LyX
8654 Some have already been mentioned.
8655 For the sake of completeness, they are listed all together here:
8658 \begin_layout Itemize
8666 \begin_layout Itemize
8674 \begin_layout Itemize
8682 \begin_layout Itemize
8690 \begin_layout Standard
8691 If you want to use any of these commands, you have to enter them yourself.
8694 Do not forget to mark them as \SpecialChar LaTeX
8698 \begin_layout Subsection
8699 Figure and Table Floats
8702 \begin_layout Standard
8704 provides support for the necessary float environments
8706 figure, figure*, table
8712 , therefore we won't tell much about it here.
8716 \begin_inset space ~
8722 Just remember that tables should be left-aligned.
8723 For that, select the table and change the alignment in
8725 Edit\SpecialChar menuseparator
8727 \begin_inset space ~
8733 \begin_layout Standard
8734 There is only one special thing: the figures with caption besides the figure.
8735 To create such a figure, you have to do the following:
8738 \begin_layout Enumerate
8739 Create a wide figure float:
8741 Insert\SpecialChar menuseparator
8742 Float\SpecialChar menuseparator
8745 , then right click in the figure and select
8748 \begin_inset space ~
8756 \begin_layout Enumerate
8757 Enter your caption text.
8760 \begin_layout Enumerate
8765 to move the cursor above the caption.
8768 \begin_layout Enumerate
8772 \begin_layout Enumerate
8773 Position the cursor behind the figure and insert a horizontal fill:
8775 Insert\SpecialChar menuseparator
8777 \begin_inset space ~
8780 Character\SpecialChar menuseparator
8782 \begin_inset space ~
8790 \begin_layout Enumerate
8791 Switch to \SpecialChar LaTeX
8795 \begin_inset space ~
8803 \begin_layout Enumerate
8813 Do not close the brace!
8816 \begin_layout Enumerate
8817 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8822 \begin_inset space ~
8834 \begin_layout Standard
8835 Also, refer to the figures in the example paper.
8838 \begin_layout Subsection
8842 \begin_layout Standard
8843 For submission, the paper has to be formated in a special double-spacing
8845 For this purpose, you have to give the option
8849 to the document class.
8850 This must be done using the custom class options field in the
8852 Document\SpecialChar menuseparator
8856 Just enter the string
8863 \begin_layout Subsection
8867 \begin_layout Standard
8872 directory contains an example paper written with \SpecialChar LyX
8874 It is the example paper from the original macro package, translated to
8877 Use it for inspiration, and compare the original \SpecialChar LaTeX
8878 code with \SpecialChar LyX
8882 \begin_layout Section
8887 \begin_layout Standard
8893 \begin_layout Subsection
8897 \begin_layout Standard
8899 is a set of macros produced by the American Astronomical Society to
8900 facilitate electronic manuscript submission to the three journals they
8901 publish: the Astrophysical Journal (including the Letters and Supplement),
8902 the Astronomical Journal, and the Publications of the Astronomical Society
8905 has proven to be an excellent tool for generating these documents, especially
8906 given its equation, citation, and figure handling capabilities.
8908 requires version 5.0 (or higher) of these macros; preferably 6.0, which
8909 is the version described here, or higher.
8910 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8911 2.09 and are fundamentally
8912 incompatible with \SpecialChar LyX
8914 The AAS\SpecialChar TeX
8915 package may be downloaded from the AAS\SpecialChar TeX
8919 \begin_layout Standard
8920 \begin_inset VSpace medskip
8926 \begin_layout Standard
8928 \begin_inset Flex URL
8931 \begin_layout Plain Layout
8933 https://aas.org/aastex/aastex-downloads
8941 \begin_layout Standard
8942 \begin_inset VSpace medskip
8948 \begin_layout Standard
8949 A complete user guide is contained in that package and you should familiarize
8950 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8953 will not reduce the need to figure out all the AAS\SpecialChar TeX
8954 commands, it will only
8955 reduce the drudgery of typing everything in.
8956 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8958 completely to the requirements of the journal to which you are submitting
8962 \begin_layout Subsection
8963 Starting a New Paper
8966 \begin_layout Standard
8967 I strongly suggest that you start with the AAS\SpecialChar TeX
8971 File\SpecialChar menuseparator
8978 , enter the new file name, then choose the
8983 This will show the most common fields found in a manuscript.
8984 Simply overwrite the existing text (including the brackets,
8988 ) with the correct information.
8989 Many of the AAS\SpecialChar TeX
8990 commands and environments can be implemented directly in
8993 For commands such as these, the \SpecialChar LaTeX
8994 code must be entered directly and marked
8996 Such commands are referred to as \SpecialChar TeX
8997 code, or Evil Red Text.
8998 I tried to minimize the amount of \SpecialChar TeX
8999 code needed in an AAS\SpecialChar TeX
9003 \begin_layout Subsection
9004 Finishing Your Paper
9007 \begin_layout Standard
9008 When the paper is finished to your satisfaction and previews/prints correctly,
9010 \begin_inset Quotes eld
9014 \begin_inset Quotes erd
9017 actions which need to be done before you submit it to the journals.
9021 \begin_layout Enumerate
9022 Export your paper as a \SpecialChar LaTeX
9025 File\SpecialChar menuseparator
9026 Export\SpecialChar menuseparator
9034 \begin_layout Enumerate
9039 file with your favorite text editor
9043 \begin_layout Enumerate
9044 remove the comment lines before the
9053 \begin_layout Enumerate
9058 usepackage...{fontenc}
9060 line if it appears (usually just after
9075 \begin_layout Enumerate
9076 remove everything between (and including) the
9088 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9090 (which should appear immediately after the
9091 \begin_inset Quotes eld
9094 User specified \SpecialChar LaTeX
9096 \begin_inset Quotes erd
9107 \begin_layout Enumerate
9108 Run the resulting file through \SpecialChar LaTeX
9109 to make sure it still processes correctly.
9112 \begin_layout Enumerate
9113 Reread the journal requirements to make sure your filenames and formats
9117 \begin_layout Enumerate
9121 \begin_layout Subsection
9122 Comments On Specific Commands
9125 \begin_layout Standard
9126 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9133 ) gives a good description of each.
9134 Thus it's probably easiest for me to go down the list as found in the guide
9135 and offer comments where necessary.
9136 So let's begin \SpecialChar ldots
9140 \begin_layout Subsubsection
9141 Things that work as expected
9144 \begin_layout Standard
9145 Because they work as you might expect, I simply list them and the section
9246 begin{thebibliography}
9254 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9255 graphicx figure commands (2.14.1),
9279 (2.15.4, amongst other places),
9306 \begin_layout Standard
9307 The following style options also work correctly:
9328 Simply put them in the
9334 Layout\SpecialChar menuseparator
9340 \begin_layout Subsubsection
9341 Things that work, but require more comment
9344 \begin_layout Standard
9345 The following items work, but require a little more discussion:
9348 \begin_layout Itemize
9349 These items are reserved for use by the journal editors, but you can put
9350 them into the \SpecialChar LaTeX
9351 preamble if you feel compelled to do so:
9384 \begin_layout Itemize
9385 These items may be placed in the \SpecialChar LaTeX
9386 preamble, and are included as blanks in
9408 \begin_layout Itemize
9415 (2.3) – can only be used
9416 \begin_inset Quotes eld
9420 \begin_inset Quotes erd
9423 , not in the middle of a paragraph.
9424 Use \SpecialChar TeX
9425 code if you need to embed it.
9428 \begin_layout Itemize
9435 (2.3) – will have extra {} after it.
9436 This should not cause an error.
9439 \begin_layout Itemize
9446 (2.6) – can only be used
9447 \begin_inset Quotes eld
9451 \begin_inset Quotes erd
9454 , not in the middle of a paragraph.
9455 Use \SpecialChar TeX
9456 code if you need to embed it.
9459 \begin_layout Itemize
9466 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9470 \begin_layout Itemize
9477 (2.8) – same as for
9484 \begin_layout Itemize
9491 (2.9) – will have extra {} after it.
9492 This should not cause an error.
9495 \begin_layout Itemize
9502 (2.11) – will have extra {} after it.
9503 This should not cause an error.
9506 \begin_layout Itemize
9513 (2.14.2) – you can insert an optional filename argument by placing the cursor
9514 at the beginning of the text and selecting
9516 Insert\SpecialChar menuseparator
9521 \begin_inset Quotes eld
9525 \begin_inset Quotes erd
9528 inserts an optional argument of the type needed by
9535 Hopefully it will be renamed someday.
9538 \begin_layout Itemize
9545 (2.17.1) – same as
9551 for the catalog ID optional parameter
9554 \begin_layout Itemize
9561 (2.17.1) – same as
9567 for the catalog ID optional parameter
9570 \begin_layout Subsubsection
9571 Things not implemented, use \SpecialChar TeX
9575 \begin_layout Standard
9586 setcounter{equation}
9588 (2.12), Journal name abbreviations (2.13.4),
9624 (2.15.4, insert it as the first element in the lefthand cell after where
9626 Don't use any of \SpecialChar LyX
9627 's rules in the table),
9639 (2.15.5), much of Misc (2.17, except
9690 \begin_layout Subsubsection
9691 Things that cannot be implemented
9694 \begin_layout Standard
9696 at least in any meaningful sort of way, so I suggest ignoring them.
9697 They are the references environment (2.13.3), and the deluxetable environment
9699 If you really, really need to use deluxetable, I suggest editing it in
9700 a separate file with a text editor, then using
9702 Insert\SpecialChar menuseparator
9704 \begin_inset space ~
9709 to include it in your \SpecialChar LyX
9715 file to see an example of this.
9718 \begin_layout Subsection
9719 FAQs, Tips, Tricks, and Other Ruminations
9722 \begin_layout Subsubsection
9723 Getting \SpecialChar LyX
9724 and AAS\SpecialChar TeX
9728 \begin_layout Standard
9729 It can be a bit tricky to get \SpecialChar LyX
9730 to recognize a new layout and document class.
9731 When all else fails, do this:
9734 \begin_layout Enumerate
9735 Make certain that \SpecialChar LaTeX
9736 can find AAS\SpecialChar TeX
9738 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9740 directory completely unrelated to \SpecialChar LaTeX
9741 or AAS\SpecialChar TeX
9742 and run \SpecialChar LaTeX
9750 \begin_layout Enumerate
9755 appears in \SpecialChar LyX
9763 \begin_layout Enumerate
9766 Tools\SpecialChar menuseparator
9770 , then restart \SpecialChar LyX
9774 \begin_layout Enumerate
9775 Open a regular new file, not from a template.
9776 Does AAS\SpecialChar TeX
9777 appear in the class list in
9779 Document\SpecialChar menuseparator
9785 \begin_layout Standard
9786 If you get a warning from an existing AAS\SpecialChar TeX
9787 document about not being able
9788 to find the AAS\SpecialChar TeX
9789 layout or a message about
9790 \begin_inset Quotes eld
9793 You should not mix title layouts with normal ones
9794 \begin_inset Quotes erd
9797 , things haven't been installed correctly.
9800 \begin_layout Subsubsection
9802 error processing a table
9805 \begin_layout Standard
9807 , by default, attempts to center the table caption/title.
9808 This seems to produce a bad interaction in AAS\SpecialChar TeX
9809 so you should click somewhere
9810 in the caption/title, then select
9812 Edit\SpecialChar menuseparator
9814 \begin_inset space ~
9828 This took care of it for me.
9831 \begin_layout Subsubsection
9835 \begin_layout Standard
9836 A couple of things: 1) I have noticed some funny spacing in the reference
9837 entries in the text.
9838 When you enter the bibliography item data, make sure their is
9842 space between the last author and the parenthesis setting off the year;
9846 \begin_inset space \thinspace{}
9850 \begin_inset space \space{}
9864 2) Entering the references at all is not obvious.
9865 The easiest thing is to start typing your first reference at the end of
9866 the document, then mark it as type
9871 That will put a small gray box in front of what you just typed.
9872 Click on the box to fill in the rest of the information.
9873 For new references, go to the end of an existing reference and press return.
9874 That will create a new line with its own box, etc.
9877 \begin_layout Subsubsection
9881 \begin_layout Standard
9882 Even though AAS\SpecialChar TeX
9883 provides its own figure commands (
9889 , for example), I much prefer \SpecialChar LaTeX
9890 's standard figure commands (with the default
9899 \begin_inset space ~
9902 commands as \SpecialChar TeX
9903 code into a Figure Float box if you desire, but I never have
9904 much luck getting the layout right.
9905 With the standard graphics, \SpecialChar LyX
9910 usepackage{graphicx}
9912 command into the \SpecialChar LaTeX
9913 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9915 interspersing the figures in the text.
9916 I believe ApJ accepts figures exactly this way now; AJ might still use
9918 \begin_inset Quotes eld
9921 stack everything at the end
9922 \begin_inset Quotes erd
9928 \begin_layout Subsubsection
9929 Things I could have done, but didn't
9932 \begin_layout Standard
9934 \begin_inset Quotes eld
9938 \begin_inset Quotes erd
9941 things I could have implemented, but chose not to.
9942 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9944 even though it is double-spaced in the paper manuscript.
9945 Also, I chose not to make separate layouts for the preprint and preprint2
9947 Since I assume you will spend most of your time in the plain manuscript
9948 mode anyway, I decided not to chew up more disk space with this.
9952 \begin_layout Subsection
9956 \begin_layout Standard
9957 Your mileage may vary.
9958 I've now had papers published by both ApJ and AJ that have had 98% of the
9959 effort done in \SpecialChar LyX
9960 ; the last 2% was the \SpecialChar LaTeX
9961 post-processing and a few cleanups.
9962 I have had no trouble with the submission process, and I'm sure the journals
9963 were never aware that there might be a difference.
9964 So, go forth and publish!
9967 \begin_layout Section
9968 AMS \SpecialChar LaTeX
9972 \begin_layout Standard
9982 \begin_layout Standard
9983 \begin_inset VSpace bigskip
9989 \begin_layout Standard
9991 The AMS \SpecialChar LaTeX
9992 layouts are set up to conform to suggested styles for mathematical
9993 papers to be submitted to American Mathematical Society publications.
9994 The layouts are not tailored to a specific journal, but easily can be.
9995 You should refer to the AMS documentation for specific instructions for
9996 each journal (usually it will entail only changing a single line in the
9999 That documentation is available on the Web at
10000 \begin_inset Flex URL
10003 \begin_layout Plain Layout
10011 \begin_inset Flex URL
10014 \begin_layout Plain Layout
10016 ftp://ftp.ams.org/pub/tex/amslatex/
10022 These layouts are appropriate, and useful, for any mathematical writing.
10026 \begin_layout Standard
10027 There are two basic AMS \SpecialChar LaTeX
10031 \begin_layout Itemize
10032 amsart: The standard AMS article format.
10035 \begin_layout Itemize
10036 amsbook: the standard AMS book (really, monograph) format.
10040 \begin_layout Standard
10041 The layouts themselves contain only the minimum necessary to use the AMS
10043 They do not, in particular, contain any of the `theorem' environments used
10044 for setting theorems, lemmas, and the like.
10045 These are contained, instead, in the
10046 \begin_inset Flex Code
10049 \begin_layout Plain Layout
10055 module, which is loaded by default when you select one of the AMS classes.
10056 (It can also be used with other classes and can be removed, if you would
10057 rather use something else.) Less commonly used environments are in the
10058 \begin_inset Flex Code
10061 \begin_layout Plain Layout
10062 Theorems (AMS-Extended)
10067 module, which must be loaded manually.
10070 \begin_layout Standard
10071 By default, theorems and the like are numbered consecutively throughout
10072 the document, but this may be modified by loading the module
10073 \begin_inset Flex Code
10076 \begin_layout Plain Layout
10077 Theorems (Order by Section)
10082 or, if you are using
10083 \begin_inset Flex Code
10086 \begin_layout Plain Layout
10093 \begin_inset Flex Code
10096 \begin_layout Plain Layout
10097 Theorems (Order by Chapter)
10103 These will number the results as
10104 \begin_inset Formula $n.m$
10107 , where the first number refers to the section (or chapter) and the second
10108 refers to the total number of results so far in that section (or chapter).
10109 Many environments are also available unnumbered.
10110 These are indicated by an asterisk at the end.
10111 If you happen to want
10115 unnumbered results, the module
10116 \begin_inset Flex Code
10119 \begin_layout Plain Layout
10125 provides that option.
10128 \begin_layout Standard
10129 Note that these modules do not
10133 to be used with the AMS classes.
10134 It is perfectly possible to use the
10135 \begin_inset Flex Code
10138 \begin_layout Plain Layout
10144 module, and the others mentioned, with other classes, such as
10145 \begin_inset Flex Code
10148 \begin_layout Plain Layout
10155 \begin_inset Flex Code
10158 \begin_layout Plain Layout
10165 \begin_inset Flex Code
10168 \begin_layout Plain Layout
10177 \begin_layout Subsection
10178 What these layouts provide
10181 \begin_layout Standard
10182 There is a long list of included environments provided by these layouts.
10183 In AMS-\SpecialChar LaTeX
10184 , there is, in fact, an opportunity to define an unlimited variety
10185 of `theorem' environments.
10186 However, the AMS recommends the environments that are available in \SpecialChar LyX
10191 \begin_layout Standard
10192 The following environments—as well as the standard environments, such as
10194 \begin_inset Flex Noun
10197 \begin_layout Plain Layout
10204 \begin_inset Flex Noun
10207 \begin_layout Plain Layout
10214 \begin_inset Flex Noun
10217 \begin_layout Plain Layout
10224 \begin_inset Flex Noun
10227 \begin_layout Plain Layout
10234 \begin_inset Flex Noun
10237 \begin_layout Plain Layout
10244 \begin_inset Flex Code
10247 \begin_layout Plain Layout
10254 \begin_inset Flex Code
10257 \begin_layout Plain Layout
10266 \begin_layout Description
10267 Address This should be the author's permanent address.
10270 \begin_layout Description
10272 \begin_inset space ~
10275 Address This should be the author's temporary address at the time of submission,
10276 if different from the Address.
10279 \begin_layout Description
10280 Email Author's e-mail address
10283 \begin_layout Description
10284 URL Author's Web address, if desired.
10287 \begin_layout Description
10288 Keywords Key words or phrases used to identify specific topics discussed
10292 \begin_layout Description
10293 Subjectclass These refer to the AMS Subject Classifications, published and
10296 Mathematical Reviews
10299 These are also available online at the AMS cites listed above.
10302 \begin_layout Description
10306 \begin_layout Description
10310 \begin_layout Description
10314 \begin_layout Standard
10315 The following environments are provided by both the
10316 \begin_inset Flex Code
10319 \begin_layout Plain Layout
10326 \begin_inset Flex Code
10329 \begin_layout Plain Layout
10335 modules, in the latter case in both starred (unnumbered) and unstarred
10336 (numbered) versions.
10337 These same environments are provided only in the starred versions by the
10339 \begin_inset Flex Code
10342 \begin_layout Plain Layout
10351 \begin_layout Theorem
10352 This is typically used for the statements of major results.
10356 \begin_layout Corollary*
10357 This is used for statements which follow fairly directly from previous statement
10359 Again, these can be major results.
10363 \begin_layout Lemma
10364 These are smaller results needed to prove other statements.
10367 \begin_layout Proposition
10368 These are less major results which (hopefully) add to the general theory
10372 \begin_layout Conjecture
10373 These are statements provided without justification, which the author does
10374 not know how to prove, but which seem to be true (to the author, at least).
10377 \begin_layout Definition*
10378 Guess what this is for.
10379 The font is different for this environment than for the previous ones.
10383 \begin_layout Example*
10384 Used for examples illustrating proven results.
10387 \begin_layout Problem
10388 It's not really known what this is for.
10389 You should figure it out.
10392 \begin_layout Exercise*
10393 Write a description for this one.
10396 \begin_layout Remark
10397 This environment is also a type of theorem, usually a lesser sort of observation.
10400 \begin_layout Claim*
10401 Often used in the course of giving a proof of a larger result.
10405 Generally, these are used to break up long arguments, using specific instances
10411 The numbering scheme for cases is on its own, not together with other numbered
10416 \begin_layout Proof
10417 At the end of this environment, a QED symbol (usually a square, but it can
10418 vary with different styles) is placed.
10419 If you want to have other environments within this one—for example, Case
10420 environments—and have the QED symbol appear only after them, then the other
10421 environments need to be nested within the proof environment.
10424 Nesting Environments
10430 for information on nesting.
10433 \begin_layout Standard
10434 And these environments are provided by
10435 \begin_inset Flex Code
10438 \begin_layout Plain Layout
10439 Theorems (AMS-Extended)
10447 \begin_layout Criterion*
10448 A required condition.
10451 \begin_layout Algorithm*
10452 A general procedure to be used.
10455 \begin_layout Axiom*
10456 This is a property or statement taken as true within the system being discussed.
10459 \begin_layout Condition*
10460 Sometimes used to state a condition assumed within the present context of
10464 \begin_layout Note*
10465 Similar to a Remark.
10468 \begin_layout Notation*
10469 Used for the explanation of, yes, notation.
10472 \begin_layout Summary
10473 Do we really need to tell you?
10476 \begin_layout Acknowledgement*
10480 \begin_layout Conclusion*
10481 Sometimes used at the end of a long train of argument.
10485 Used in a way similar to Proposition, though perhaps lower on the scale.
10488 \begin_layout Standard
10489 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10492 They need to be available on your system in order to use these environments.
10495 \begin_layout Section
10503 \begin_layout Standard
10509 \begin_layout Subsection
10513 \begin_layout Standard
10514 These are the layout files for some of the journals of the American Geophysical
10516 It is assumed that you have both the AGU's own class files and AGUplus
10517 installed (everything to be found at
10518 \begin_inset Flex URL
10521 \begin_layout Plain Layout
10523 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10531 \begin_layout Subsection
10535 \begin_layout Standard
10545 They are still called this in the \SpecialChar LyX
10546 GUI, though their \SpecialChar LaTeX
10559 \begin_layout Standard
10560 Newly defined styles are
10597 These are mostly manuscript attributes and defined in the AGU class documentati
10601 \begin_layout Standard
10602 I suspect this is still badly incomplete.
10605 \begin_layout Subsection
10609 \begin_layout Standard
10626 \begin_layout Subsection
10630 \begin_layout Itemize
10633 Journal of Geophysical Research
10642 \begin_layout Standard
10643 Add your own, it isn't so hard! Look at the
10654 \begin_layout Subsection
10655 Bugs and things to remember
10658 \begin_layout Standard
10659 In order to use the new layouts, you must remember to do the following for
10663 \begin_layout Enumerate
10669 This can be done in the
10671 Layout\SpecialChar menuseparator
10676 Document\SpecialChar menuseparator
10680 (AGU articles are always in English, right? So
10684 choose a language.)
10687 \begin_layout Enumerate
10692 into the document's
10697 (Yes, this is a bug.)
10700 \begin_layout Enumerate
10701 Make sure you use the
10705 bibliography style, by entering
10709 into the second field of the Bib\SpecialChar TeX
10711 None of the standard styles will do.
10714 \begin_layout Section
10718 \begin_layout Standard
10724 \begin_layout Subsection
10728 \begin_layout Standard
10729 Broadway is for writing plays.
10730 The format is more decorative than Hollywood, and much less standardized.
10731 This format should be suitable for workshops.
10734 \begin_layout Subsection
10738 \begin_layout Standard
10739 The same as in Hollywood.
10742 \begin_layout Subsection
10746 \begin_layout Standard
10751 names as labels then cross-reference the label to insert the name.
10752 The cross-reference dialog will show the current cast of characters.
10755 \begin_layout Subsection
10756 Paper size and Margins
10759 \begin_layout Standard
10760 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10763 \begin_layout Subsection
10767 \begin_layout Standard
10768 The following environments are available.
10769 You can use broadway.bind to get the bind keys shown at the right.
10772 \begin_layout Itemize
10776 \begin_inset Newline newline
10781 You should not have to use this, but it is here for anything that does not
10785 \begin_layout Itemize
10789 \begin_inset space \hfill{}
10793 \begin_inset Newline newline
10798 Used to describe stage setting and the action.
10799 First use of speaker names in all CAPs.
10802 \begin_layout Itemize
10806 \begin_inset space \hfill{}
10810 \begin_inset Newline newline
10815 Automatically numbered.
10816 On screen it will be arabic, but will print as Roman.
10819 \begin_layout Itemize
10823 \begin_inset space \hfill{}
10827 \begin_inset Newline newline
10837 It is just centered text.
10840 \begin_layout Itemize
10844 \begin_inset space \hfill{}
10848 \begin_inset Newline newline
10853 Not automatically numbered.
10854 You supply the number.
10855 This is because I couldn't figure out how.
10858 \begin_layout Itemize
10862 \begin_inset space \hfill{}
10866 \begin_inset Newline newline
10871 A special case of Narrative to describe the setting and action as the curtain
10875 \begin_layout Itemize
10879 \begin_inset space \hfill{}
10883 \begin_inset Newline newline
10888 The speaker's (actor's) title, centered in all CAPS.
10891 \begin_layout Itemize
10895 \begin_inset space \hfill{}
10899 \begin_inset Newline newline
10904 Instructions to the speaker.
10905 The parentheses are automatically inserted.
10906 The ( will appear on screen, but both will be in the printed play.
10907 This environment is only used within
10914 \begin_layout Itemize
10918 \begin_inset space \hfill{}
10922 \begin_inset Newline newline
10927 What the Speaker says.
10930 \begin_layout Itemize
10934 \begin_inset space \hfill{}
10938 \begin_inset Newline newline
10943 The curtain comes down.
10946 \begin_layout Itemize
10950 \begin_inset space \hfill{}
10956 \begin_layout Itemize
10960 \begin_inset space \hfill{}
10966 \begin_layout Itemize
10970 \begin_inset space \hfill{}
10976 \begin_layout Standard
10980 \begin_layout Section
10984 \begin_layout Standard
10989 can be used to type letters according to German conventions.
10990 A template file is included in
10992 .../lyx/share/templates
10994 for you to use as a starting point.
10997 \begin_layout Section
11005 \begin_layout Standard
11011 \begin_layout Subsection
11015 \begin_layout Standard
11016 This is the layout file for the European Geophysical Society journals.
11021 can be downloaded from the web site of the EGS under
11022 \begin_inset Flex URL
11025 \begin_layout Plain Layout
11035 \begin_layout Subsection
11039 \begin_layout Standard
11042 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
11050 The current layout file is unfortunately very unmodular and would benefit
11051 from using the various
11058 \begin_layout Section
11062 \begin_layout Standard
11063 See the \SpecialChar LyX
11069 It contains all infos you need.
11072 \begin_layout Section
11075 Foil\SpecialChar TeX
11079 \begin_inset CommandInset label
11088 \begin_layout Standard
11094 \begin_layout Subsection
11098 \begin_layout Standard
11099 This section describes how to use \SpecialChar LyX
11100 to make slides for overhead projectors.
11101 There are two document classes that can do this: the default slides class
11104 Foil\SpecialChar TeX
11108 This section documents the latter.
11111 \begin_layout Standard
11112 I'm going to say this again, nice and clear, so that there's no misunderstanding
11116 \begin_layout Standard
11117 \begin_inset VSpace bigskip
11123 \begin_layout Standard
11127 This section documents the class
11128 \begin_inset Quotes eld
11136 \begin_inset Quotes erd
11144 \begin_layout Standard
11145 \begin_inset VSpace bigskip
11151 \begin_layout Standard
11152 If you're looking for the documentation for
11153 \begin_inset Quotes eld
11161 \begin_inset Quotes erd
11164 , check out section
11165 \begin_inset space ~
11169 \begin_inset CommandInset ref
11171 reference "sec:slitex"
11176 If your machine doesn't have the
11184 installed, you'll probably have to use the default
11188 class, which isn't quite as good as
11193 \begin_layout Standard
11198 class is designed for use with version
11199 \begin_inset space ~
11207 class file which is now an integral part of \SpecialChar LaTeX2e
11211 \begin_layout Subsection
11215 \begin_layout Standard
11216 Obviously, to use this document class, you need to select
11227 \begin_inset space ~
11233 There are some settings in the
11236 \begin_inset space ~
11241 dialog that you should know about that are specific to this class:
11244 \begin_layout Itemize
11245 Don't change the options
11256 \begin_inset space ~
11262 They're ignored by the
11269 \begin_layout Itemize
11270 The default font size is 20
11271 \begin_inset space \thinspace{}
11274 pt with the other options being 17
11275 \begin_inset space \thinspace{}
11279 \begin_inset space \thinspace{}
11283 \begin_inset space \thinspace{}
11289 \begin_layout Itemize
11290 The default font is
11298 but all math equations are still typeset in the usual roman font.
11301 \begin_layout Itemize
11304 Foil\SpecialChar TeX
11307 supports A4 and Letter paper sizes as well as a special size for working
11309 \begin_inset space \thinspace{}
11313 It doesn't support A5, B5, legal or executive paper sizes.
11316 \begin_layout Itemize
11317 Don't bother changing the
11321 settings because they are ignored anyway.
11322 All floats appear where they are defined in the text.
11325 \begin_layout Itemize
11330 setting behaves a bit differently for this class.
11333 Foil\SpecialChar TeX
11336 provides extensive footer and header capabilities including a user-defined
11339 \begin_inset space ~
11343 \begin_inset CommandInset ref
11345 reference "sec:foilfoot"
11350 The title page is treated differently to all other pages in the document
11359 has the logo centered at the bottom of the page (if one is defined).
11360 The possible page style choices and what they do are as follows:
11364 \begin_layout Labeling
11365 \labelwidthstring MMMMMMM
11372 The final output contains no page numbers, or other headers or footers
11373 (except footnotes of course).
11377 \begin_layout Labeling
11378 \labelwidthstring MMMMMMM
11385 The final output contains page numbers centered at the bottom of the page.
11386 No other headings or footers (other than footnotes).
11389 \begin_layout Labeling
11390 \labelwidthstring MMMMMMM
11395 Page numbers in lower right corner.
11396 Additional headers and footers are also shown.
11397 This is also the default.
11400 \begin_layout Labeling
11401 \labelwidthstring MMMMMMM
11406 Gives you access to the
11410 package although its use with
11412 Foil\SpecialChar TeX
11415 is discouraged by the writer of the
11417 Foil\SpecialChar TeX
11420 package because of some potential page layout clashes.
11424 \begin_layout Subsubsection
11428 \begin_layout Standard
11429 The following options may be used in the extra class options in the
11431 Document\SpecialChar menuseparator
11437 \begin_layout Labeling
11438 \labelwidthstring MMMMMMx
11443 This sets up the page layout for 7.33
11444 \begin_inset space \thinspace{}
11448 \begin_inset space \thinspace{}
11451 in paper, which is about the same aspect ratio as a 35
11452 \begin_inset space \thinspace{}
11455 mm slide, making it a bit easier to work with this medium.
11458 \begin_layout Labeling
11459 \labelwidthstring MMMMMMx
11464 Places a rule across the page below the header on every page except the
11468 \begin_layout Labeling
11469 \labelwidthstring MMMMMMx
11474 Places a rule across the page above the footer on every page except the
11478 \begin_layout Labeling
11479 \labelwidthstring MMMMMMx
11484 This is automatically set each time you create a new
11491 Foil\SpecialChar TeX
11494 to use the dvips driver to rotate those pages that are set as landscape
11498 \begin_layout Labeling
11499 \labelwidthstring MMMMMMx
11504 Simply changes the page dimensions to those of a landscape page but doesn't
11506 Thus if you use this option you need to use an external program to rotate
11507 each page or feed your paper through your printer as landscape.
11508 Note that this option effectively reverses the roles of the
11516 environments (don't worry these are described in the next section).
11519 \begin_layout Labeling
11520 \labelwidthstring MMMMMMx
11525 Equation numbers on the left.
11528 \begin_layout Labeling
11529 \labelwidthstring MMMMMMx
11534 Flush-left equations.
11537 \begin_layout Subsection
11538 Supported Environments
11541 \begin_layout Standard
11542 Most of the environments commonly supported in other classes are also supported
11548 There are several additional environments provided by
11550 Foil\SpecialChar TeX
11553 as well as a couple added by \SpecialChar LyX
11555 The following environments are shared with other classes:
11558 \begin_layout Standard
11559 \begin_inset Flex Multiple Columns
11562 \begin_layout Itemize
11568 \begin_layout Itemize
11574 \begin_layout Itemize
11580 \begin_layout Itemize
11586 \begin_layout Itemize
11592 \begin_layout Itemize
11599 \begin_layout Itemize
11605 \begin_layout Itemize
11611 \begin_layout Itemize
11617 \begin_layout Itemize
11623 \begin_layout Itemize
11629 \begin_layout Itemize
11635 \begin_layout Itemize
11641 \begin_layout Itemize
11647 \begin_layout Itemize
11658 \begin_layout Standard
11659 That is, all the major environments apart from the sectioning environments.
11660 Since foils are essentially self-contained sections, with a title and body,
11663 Foil\SpecialChar TeX
11666 provides specific commands for starting new foils and these are:
11669 \begin_layout Itemize
11675 \begin_layout Itemize
11681 \begin_layout Standard
11683 also provides slightly modified versions of these two environments called:
11686 \begin_layout Itemize
11692 \begin_layout Itemize
11695 ShortRotatefoilhead
11698 \begin_layout Standard
11699 and the differences will be explained in the next section.
11702 \begin_layout Standard
11703 Since foils are often used in presenting ideas or new theorems and such
11706 Foil\SpecialChar TeX
11709 also provides a comprehensive box of goodies for presenting them:
11712 \begin_layout Standard
11713 \begin_inset Flex Multiple Columns
11716 \begin_layout Itemize
11722 \begin_layout Itemize
11728 \begin_layout Itemize
11734 \begin_layout Itemize
11740 \begin_layout Itemize
11746 \begin_layout Itemize
11752 \begin_layout Itemize
11758 \begin_layout Itemize
11764 \begin_layout Itemize
11770 \begin_layout Itemize
11776 \begin_layout Itemize
11787 \begin_layout Standard
11788 The starred versions are unnumbered while the unstarred versions are numbered.
11789 There are also two list environments added by \SpecialChar LyX
11793 \begin_layout Itemize
11799 \begin_layout Itemize
11805 \begin_layout Standard
11808 Foil\SpecialChar TeX
11811 provides some powerful header and footer capabilities that are best set
11812 in the preamble although they may be set at any point in a document.
11813 If you want to change these settings in your document the best place to
11814 do so is at the very top of a foil, i.
11815 \begin_inset space \thinspace{}
11821 \begin_inset space \space{}
11826 straight after the foilhead.
11829 \begin_layout Standard
11830 For this purpose, the following command styles are provided [
11837 \begin_layout Standard
11838 \begin_inset Flex Multiple Columns
11841 \begin_layout Itemize
11845 \begin_inset space ~
11851 \begin_layout Itemize
11857 \begin_layout Itemize
11861 \begin_inset space ~
11867 \begin_layout Itemize
11871 \begin_inset space ~
11877 \begin_layout Itemize
11881 \begin_inset space ~
11888 \begin_layout Plain Layout
11889 \begin_inset space ~
11901 \begin_layout Standard
11902 There are also a few commands provided by
11904 Foil\SpecialChar TeX
11907 that aren't directly supported by \SpecialChar LyX
11908 but I'll tell you what they do and how
11909 to use them in section
11910 \begin_inset space ~
11914 \begin_inset CommandInset ref
11916 reference "sec:unsuppfoils"
11923 \begin_layout Subsection
11924 Building a Set of Foils
11927 \begin_layout Standard
11928 This section will give a simple introduction to using the different environments
11929 to build a set of foils.
11930 If you want to see an example set of foils, take a look at the
11934 file you find in \SpecialChar LyX
11942 \begin_layout Subsubsection
11943 Give It a Title Page
11946 \begin_layout Standard
11947 Unlike other classes that provide
11967 creates the title on a page of its own.
11968 If you leave out the
11972 environment \SpecialChar LaTeX
11973 will substitute the current date (every time you regenerate
11977 \begin_layout Subsubsection
11981 \begin_layout Standard
11982 As I mentioned earlier, there are four ways of starting a new foil.
11983 For portrait foils you should use
11992 The difference between these two environments is the amount of space between
11993 the title of the foil (the foilhead) and the body of the foil.
11996 \begin_layout Standard
11997 Landscape foils are generated using the
12003 ShortRotatefoilhead
12006 Again the only difference is the spacing between foilhead and body.
12007 Both of the short versions have 0.5
12008 \begin_inset space ~
12011 inches less separation between the foilhead and the body.
12015 \begin_layout Standard
12016 One problem with the support for landscape foils is the requirement that
12017 you have to use the
12021 driver to generate the PostScript output otherwise the foils won't be rotated.
12022 It is possible to get landscape foils even if you haven't got the
12026 driver provided you can feed your foils sideways through your printer ;-)
12029 \begin_layout Subsubsection
12030 Theorems, Lemmas, Proofs and more
12033 \begin_layout Standard
12034 You can't have two of the same type of these environments directly following
12036 If you use a normal paragraph break, , you will just be extending the previous
12037 environment as if you had merged the two environments together.
12038 Rather than that, you need to insert a so-called separator.
12039 Please refer to the section entitled
12050 \begin_layout Subsubsection
12054 \begin_layout Standard
12055 You get all the commonly supported list styles found in other classes as
12056 well as two new ones.
12057 I'll only describe the new ones here.
12058 If you want to find out more about the other list environments check out
12064 If you intend to use itemized lists you might also want to read about the
12068 \begin_inset space ~
12072 \begin_inset space ~
12077 dialog described above in section
12078 \begin_inset space ~
12082 \begin_inset CommandInset ref
12084 reference "sec:bullet"
12091 \begin_layout Standard
12092 The two new list styles,
12100 , are designed to make it easier for you to create lists of do's and don'ts
12101 or right and wrong by providing dedicated environments that use a tick
12102 or a cross as the label of the list.
12103 These lists are in fact dedicated variants of the
12108 They do however require that you have the
12112 packages installed.
12115 \begin_layout Subsubsection
12119 \begin_layout Standard
12122 Foil\SpecialChar TeX
12125 redefines the floating tables and figures so that they appear exactly where
12126 they are in the text rather than pushing them to the top of the page or
12127 to some user specified location.
12128 In fact if you change the float placement settings they are simply ignored.
12131 \begin_layout Subsubsection
12132 Page Headers and Footers
12133 \begin_inset CommandInset label
12135 name "sec:foilfoot"
12142 \begin_layout Standard
12146 \begin_inset space ~
12155 are two commands used to control the left-footer text string.
12156 The first is meant to allow you to include a graphic logo on your foils
12158 \begin_inset Quotes eld
12163 Foil\SpecialChar TeX
12167 \begin_inset Quotes erd
12171 While the second is meant to provide a classification for the audience,
12175 \begin_inset space \thinspace{}
12181 \begin_inset space \space{}
12185 It is empty by default.
12188 \begin_layout Standard
12189 The remaining page corners can be filled by
12192 \begin_inset space ~
12197 (which defaults to page numbers),
12200 \begin_inset space ~
12208 \begin_inset space ~
12216 \begin_layout Subsection
12219 Foil\SpecialChar TeX
12223 \begin_inset CommandInset label
12225 name "sec:unsuppfoils"
12232 \begin_layout Standard
12233 All the commands mentioned below need to be set in a
12243 within another environment.
12246 \begin_layout Subsubsection
12250 \begin_layout Standard
12251 All lengths are adjusted using the
12274 should be replaced by the name given to the length you want to change and
12279 is the length value.
12280 All lengths should be specified in units of length such as inches (
12292 ) or relative to some document or font-based length such as
12302 \begin_layout Standard
12303 It's possible to change the spacing between a foilhead and the body of the
12304 foil by adjusting the length specified by
12311 For example, to make
12316 \begin_inset space \space{}
12319 in closer to their bodies put the following in the preamble:
12325 foilheadskip}{-0.5in}
12328 \begin_layout Standard
12329 The spacings around floats can be adjusted by setting these lengths:
12332 \begin_layout Labeling
12333 \labelwidthstring MMMMMMMMMMM
12340 Separation between the text and the top of the float
12343 \begin_layout Labeling
12344 \labelwidthstring MMMMMMMMMMM
12351 Separation between the float and the caption
12354 \begin_layout Labeling
12355 \labelwidthstring MMMMMMMMMMM
12362 Separation between the caption and the following text
12365 \begin_layout Labeling
12366 \labelwidthstring MMMMMMMMMMM
12373 You can make the captions narrower than the surrounding text by adjusting
12375 Best done relative to
12384 \begin_layout Standard
12385 There are also several title page related lengths that you may find useful
12386 if you have a long title or several authors:
12389 \begin_layout Labeling
12390 \labelwidthstring MMMMMMMMMMM
12397 Separation from headers to
12402 \begin_layout Labeling
12403 \labelwidthstring MMMMMMMMMMM
12421 \begin_layout Labeling
12422 \labelwidthstring MMMMMMMMMMM
12436 \begin_layout Labeling
12437 \labelwidthstring MMMMMMMMMMM
12453 \begin_layout Labeling
12454 \labelwidthstring MMMMMMMMMMM
12470 \begin_layout Standard
12471 The last length related command affects all the list environments.
12482 a list environment then all the vertical spacing between the list items
12484 Note that this is a command not a length so it doesn't require
12490 like the stuff mentioned above.
12493 \begin_layout Subsubsection
12494 Headers and Footers
12497 \begin_layout Standard
12510 commands control whether the logo in the
12514 definition appear on a given page.
12521 in the preamble then none of the foils will have the logo on them.
12522 If you don't want the logo on a particular page place the
12528 directly after the foilhead of that page and the
12534 directly after the next foilhead.
12537 \begin_layout Standard
12538 If you decide to use the
12542 page style setting in the
12545 \begin_inset space ~
12550 dialog you should probably add
12560 to your preamble so headers and footers on landscape pages are correctly
12561 placed when rotated.
12562 This is due to some clashes between the page layouts provided by the
12573 \begin_layout Section
12574 Hollywood (Hollywood spec scripts)
12577 \begin_layout Standard
12583 \begin_layout Subsection
12587 \begin_layout Standard
12588 Getting the format of a Hollywood script right is a
12589 \begin_inset Quotes eld
12593 \begin_inset Quotes erd
12596 It is designed to make the readers focus on content and to be easy and
12597 familiar for the actors to read.
12598 Each page of a script should be one minute of film.
12599 Nothing goes in a script that you cannot see or hear on screen.
12600 The courier 12 pt font should be used throughout.
12604 \begin_layout Subsection
12608 \begin_layout Standard
12609 Speakers' lines should NEVER break in mid-sentence.
12610 If a speaker's lines continue over a page break, repeat the
12614 title followed by (Cont'd).
12617 \begin_layout Subsection
12621 \begin_layout Standard
12626 names as labels then cross-reference the label to insert the name.
12627 The cross-reference dialog will show the current cast of characters.
12628 You can use this to insert the speaker name in narratives also.
12631 \begin_layout Subsection
12632 Paper size and Margins
12635 \begin_layout Standard
12636 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12639 \begin_layout Subsection
12643 \begin_layout Standard
12644 The following environments are available.
12645 You can use hollywood.bind to get the bind keys shown at the right.
12648 \begin_layout Itemize
12652 \begin_inset Newline newline
12657 Used where nothing else works.
12661 \begin_layout Itemize
12667 \begin_inset space \hfill{}
12675 \begin_inset Newline newline
12678 Usually followed by something like
12679 \begin_inset Quotes eld
12682 on Sally waking up.
12683 \begin_inset Quotes erd
12689 \begin_layout Itemize
12693 \begin_inset space \hfill{}
12697 \begin_inset Newline newline
12702 Introduces a new INTERIOR camera set-up.
12703 Always followed by DAY or NIGHT, or something similar to define the lighting
12705 Everthing on this line in CAPS.
12708 \begin_layout Itemize
12712 \begin_inset space \hfill{}
12716 \begin_inset Newline newline
12721 Introduces a new EXTERIOR camera set-up.
12722 Everthing on this line in CAPS.
12725 \begin_layout Itemize
12729 \begin_inset space \hfill{}
12733 \begin_inset Newline newline
12738 The character speaking.
12741 \begin_layout Itemize
12745 \begin_inset space \hfill{}
12749 \begin_inset Newline newline
12754 Instructions to the speaker.
12755 The () are automatically inserted.
12758 \begin_layout Itemize
12762 \begin_inset space \hfill{}
12766 \begin_inset Newline newline
12778 \begin_layout Itemize
12782 \begin_inset space \hfill{}
12786 \begin_inset Newline newline
12791 Camera movement instruction.
12793 \begin_inset space \thinspace{}
12797 \begin_inset space \space{}
12803 \begin_layout Itemize
12807 \begin_inset space \hfill{}
12813 \begin_layout Itemize
12817 \begin_inset space \hfill{}
12823 \begin_layout Itemize
12827 \begin_inset space \hfill{}
12833 \begin_layout Itemize
12837 \begin_inset space \hfill{}
12843 \begin_layout Subsection
12847 \begin_layout Itemize
12848 (O.S) — off screen
12851 \begin_layout Itemize
12852 (V.0) — voice over
12855 \begin_layout Itemize
12857 \begin_inset space \thinspace{}
12864 \begin_layout Itemize
12869 \begin_layout Itemize
12870 PAN — camera movement
12873 \begin_layout Itemize
12874 INSERT — cut to close-up of
12877 \begin_layout Section
12881 \begin_layout Standard
12884 Panayotis Papasotiriou
12887 \begin_layout Subsection
12891 \begin_layout Standard
12892 The ijmpc package is a set of macros that facilitates electronic manuscript
12895 International Journal of Modern Physics C
12898 Similarly, the ijmpd package is for creating manuscripts to be submitted
12901 International Journal of Modern Physics D
12904 Both journals are published by World Scientific.
12905 The corresponding document classes are named
12914 These files, together with instructions for the authors, can be downloaded
12916 \begin_inset Flex URL
12919 \begin_layout Plain Layout
12921 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12927 \begin_inset Flex URL
12930 \begin_layout Plain Layout
12932 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12938 Both packages are modified versions of the standard
12939 \begin_inset Quotes eld
12943 \begin_inset Quotes erd
12946 package, and they are almost (but not exactly) identical.
12947 Most of their features are supported by \SpecialChar LyX
12949 I have used \SpecialChar LyX
12950 successfully to write articles submitted to both journals
12951 without any problem.
12954 \begin_layout Subsection
12958 \begin_layout Standard
12959 As usual, the easiest way to write a paper is to start with a template.
12962 File\SpecialChar menuseparator
12978 This will give an (almost) empty document that includes the most common
12979 fields found in a manuscript.
12980 Simply overwrite the existing text (including the brackets,
12985 You should keep in mind the following remarks.
12988 \begin_layout Enumerate
12990 won't let you change the font size and the page style of the document,
12991 because such modifications are not allowed by both packages.
12994 \begin_layout Enumerate
12995 The language of the document should not be changed.
12996 Before previewing your paper, be sure that the babel package is not used.
12997 To do this, click on
13000 arg "dialog-show document"
13005 \SpecialChar menuseparator
13009 \begin_inset Quotes eld
13013 \begin_inset Quotes erd
13023 \begin_layout Enumerate
13025 \begin_inset Quotes eld
13029 \begin_inset Quotes erd
13032 style must be used to define keywords.
13035 \begin_layout Enumerate
13036 The ijmpc package provides a style named
13037 \begin_inset Quotes eld
13040 Classification Codes
13041 \begin_inset Quotes erd
13044 , which can be used to define classification codes, such as PACS numbers.
13045 Note that this facility is not supported by the ijmpd package.
13048 \begin_layout Enumerate
13049 Several new environments are available:
13050 \begin_inset Quotes eld
13054 \begin_inset Quotes erd
13058 \begin_inset Quotes eld
13062 \begin_inset Quotes erd
13066 \begin_inset Quotes eld
13070 \begin_inset Quotes erd
13074 \begin_inset Quotes eld
13078 \begin_inset Quotes erd
13082 \begin_inset Quotes eld
13086 \begin_inset Quotes erd
13090 \begin_inset Quotes eld
13094 \begin_inset Quotes erd
13098 \begin_inset Quotes eld
13102 \begin_inset Quotes erd
13106 \begin_inset Quotes eld
13110 \begin_inset Quotes erd
13114 \begin_inset Quotes eld
13118 \begin_inset Quotes erd
13122 \begin_inset Quotes eld
13126 \begin_inset Quotes erd
13130 \begin_inset Quotes eld
13134 \begin_inset Quotes erd
13138 \begin_inset Quotes eld
13142 \begin_inset Quotes erd
13146 \begin_inset Quotes eld
13150 \begin_inset Quotes erd
13154 \begin_inset Quotes eld
13158 \begin_inset Quotes erd
13162 Their use is more or less obvious.
13164 supports all these environments; it will use the proper label, text style,
13165 and numbering scheme for each of them.
13168 \begin_layout Enumerate
13169 Both packages use basic citations; the natbib package should not be used.
13170 In \SpecialChar LyX
13171 , citation references are shown as usual; in the output, citations are
13172 shown as superscripts.
13173 If you want to use a citation as normal text, you should use the
13178 \begin_inset space \thinspace{}
13182 \begin_inset space \space{}
13186 \begin_inset Quotes eld
13190 \begin_inset space \space{}
13200 \begin_inset Quotes erd
13206 \begin_layout Enumerate
13208 \begin_inset Quotes eld
13212 \begin_inset Quotes erd
13215 section in both packages.
13216 To put acknowledgments, just use the
13217 \begin_inset Quotes eld
13221 \begin_inset Quotes erd
13227 \begin_layout Enumerate
13228 Appendices may be added to the paper,
13232 the Acknowledgments and
13238 provides a special environment, called
13239 \begin_inset Quotes eld
13243 \begin_inset Quotes erd
13246 which marks the beginning of the appendices.
13247 This environment should be left blank; it just sends a \SpecialChar LaTeX
13248 command, but nothing
13250 In \SpecialChar LyX
13252 \begin_inset Quotes eld
13256 \begin_inset Quotes erd
13259 is printed with blue letters, as a signal that all sections after that
13260 point are appendices.
13261 To write an appendix, use the
13262 \begin_inset Quotes eld
13266 \begin_inset Quotes erd
13271 will number each appendix with capital letters, as required by both journals.
13273 \begin_inset Quotes eld
13277 \begin_inset Quotes erd
13284 be present before the first appendix; if not, all appendices will be numbered
13285 as normal sections in the output.
13288 \begin_layout Enumerate
13289 The ijmpc and the ijmpd packages use the
13293 command to implement table captions.
13294 As a result, a table created by \SpecialChar LyX
13295 is printed correctly, but its caption
13297 However, you can use some \SpecialChar TeX
13298 code to overcome this problem, so that captions
13299 are printed as expected.
13300 To do so, create a float table as usual, remove the caption, and replace
13301 it with the \SpecialChar TeX
13312 (sic); you must also the \SpecialChar TeX
13317 immediately after the tabular material.
13318 Study the example table included in the template files to see how this
13319 trick is implemented.
13320 Alternatively, If you need table captions, you should implement the whole
13325 file, then include this file to the \SpecialChar LyX
13328 Insert\SpecialChar menuseparator
13329 File\SpecialChar menuseparator
13331 \begin_inset space ~
13337 Details on how to create a table float can be found in the files
13345 , included in the corresponding packages.
13348 \begin_layout Subsection
13349 Preparing a paper for submission
13352 \begin_layout Standard
13353 Before you submit your paper you must export the \SpecialChar LyX
13354 document as a \SpecialChar LaTeX
13357 File\SpecialChar menuseparator
13358 Export\SpecialChar menuseparator
13366 \begin_layout Plain Layout
13367 Actually you have the choice between \SpecialChar LaTeX
13368 (plain) and pdflatex.
13369 If you intend to use pdflatex to prepare the paper, you should use the
13370 pdflatex option so that included graphics are converted to PDF format,
13371 ready for use by pdflatex.
13376 , then make the following changes to the resulting
13383 \begin_layout Enumerate
13384 Remove the comment lines before the
13393 \begin_layout Enumerate
13394 Remove everything between (and including) the
13406 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13410 \begin_layout Standard
13415 file should be saved and processed through \SpecialChar LaTeX
13416 as many times as necessary.
13417 You may also want to check the resulting
13424 \begin_layout Section
13428 \begin_layout Standard
13434 \begin_layout Subsection
13438 \begin_layout Standard
13439 The iopart package provides a document class to create electronic manuscript
13440 submission to the journals published by the Institute of Physics.
13441 Instructions for the authors how to create a paper using the iopart class
13442 can be downloaded together with the iopart package from the site
13443 \begin_inset Flex URL
13446 \begin_layout Plain Layout
13448 ftp://ftp.iop.org/pub/journals/latex2e
13456 \begin_layout Subsection
13460 \begin_layout Standard
13461 The easiest way to write a paper is to start with the template
13465 that is available via
13467 File\SpecialChar menuseparator
13470 The template explains how to use the special text environments.
13471 Here are the most important advices:
13474 \begin_layout Itemize
13475 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13476 no AMS packages are loaded in
13478 Document\SpecialChar menuseparator
13479 Settings\SpecialChar menuseparator
13485 \begin_layout Itemize
13488 The title environment defines the kind of your paper.
13489 So use one of the following environments for the title:
13493 \begin_layout Itemize
13502 \begin_layout Itemize
13511 \begin_layout Itemize
13517 for a Topical review
13520 \begin_layout Itemize
13529 \begin_layout Itemize
13538 \begin_layout Itemize
13544 for a Paper (same as Title)
13547 \begin_layout Itemize
13553 for a Preliminary communication
13556 \begin_layout Itemize
13562 for a Rapid communication
13565 \begin_layout Itemize
13571 for a Letter to the editor
13575 \begin_layout Itemize
13578 All title environments except of
13582 can have an optional short title.
13585 \begin_layout Itemize
13586 There is a general title environment
13590 which is not directly supported by \SpecialChar LyX
13592 This can be used as \SpecialChar TeX
13593 code when your document doesn't fit into one of the
13597 \begin_layout Standard
13598 For more informations like hints for special table and formula formatting,
13599 look at the IOP author guidelines.
13602 \begin_layout Section
13606 \begin_layout Standard
13609 Panayotis Papasotiriou
13612 \begin_layout Subsection
13616 \begin_layout Standard
13617 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13618 that facilitates electronic manuscript submission to the journals they
13620 Most known of them (at least in my domain of interest) are
13622 Astrophysics and Space Science
13628 , but there are many others (see a complete list at
13629 \begin_inset Flex URL
13632 \begin_layout Plain Layout
13634 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13640 The Kluwer package may be downloaded from the site
13641 \begin_inset Flex URL
13644 \begin_layout Plain Layout
13646 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13652 A complete user guide is contained in that package (but it can also be
13653 downloaded separately).
13656 \begin_layout Standard
13658 supports many features of the package but not everything.
13659 However, the \SpecialChar TeX
13660 code needed is reduced to some
13661 \begin_inset Quotes eld
13665 \begin_inset Quotes erd
13668 commands of the package (see
13669 \begin_inset space ~
13673 \begin_inset CommandInset ref
13675 reference "subsec:kluwer_peculiarities"
13680 I have recently used \SpecialChar LyX
13681 to write an article submitted to the
13683 Astrophysics and Space Science
13685 without any problem.
13688 \begin_layout Subsection
13692 \begin_layout Standard
13693 The easiest way to write a paper is to start with the Kluwer template file.
13696 File\SpecialChar menuseparator
13708 This will give an (almost) empty document that includes the most common
13709 fields found in a manuscript and a short description of their use.
13710 As in most templates, simply overwrite the existing text (including the
13715 ) with the correct information.
13718 \begin_layout Subsection
13719 Preparing a paper for submission
13722 \begin_layout Standard
13723 As in the AAS\SpecialChar TeX
13724 package, before you submit your paper to a journal you must
13726 \begin_inset Quotes eld
13730 \begin_inset Quotes erd
13736 \begin_layout Enumerate
13737 Export your paper as a \SpecialChar LaTeX
13739 To do this, click on
13741 File\SpecialChar menuseparator
13742 Export\SpecialChar menuseparator
13750 \begin_layout Enumerate
13755 file with a text editor and make the following changes
13759 \begin_layout Enumerate
13760 remove the comment lines before the
13769 \begin_layout Enumerate
13770 remove everything between (and including) the
13782 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13786 \begin_layout Standard
13795 \begin_layout Enumerate
13800 file through \SpecialChar LaTeX
13801 as many times as necessary (usually up to three).
13804 \begin_layout Enumerate
13810 \begin_inset space \thinspace{}
13814 \begin_inset space \space{}
13821 , and check if everything is OK (it should, if you didn't make any mistake).
13824 \begin_layout Subsection
13825 \begin_inset Quotes eld
13829 \begin_inset Quotes erd
13832 of the Kluwer package
13833 \begin_inset CommandInset label
13835 name "subsec:kluwer_peculiarities"
13842 \begin_layout Standard
13843 The Kluwer package has the following
13844 \begin_inset Quotes eld
13848 \begin_inset Quotes erd
13854 \begin_layout Enumerate
13855 It is possible to write multiple articles in the same \SpecialChar LaTeX
13860 \begin_layout Plain Layout
13861 I can't imagine any good reason to do this.
13867 Each article must be included in the environment
13868 \begin_inset Quotes eld
13872 \begin_inset Quotes erd
13876 Unfortunately, this environment cannot be omitted, even if you write just
13878 Therefore, each article starts with the command
13884 and, obviously, ends with the command
13891 Although this can be implemented in \SpecialChar LyX
13892 , I didn't included it, since it looks
13893 ugly and can confuse the novice user.
13894 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13897 \begin_inset Quotes eld
13902 \begin_inset Quotes erd
13908 \begin_layout Enumerate
13909 Information given at the beginning of the article (i.
13910 \begin_inset space \thinspace{}
13914 \begin_inset space \space{}
13917 title, subtitle, author, institution, running title, running author, abstract
13918 and keywords) must be included in an environment called
13919 \begin_inset Quotes eld
13923 \begin_inset Quotes erd
13927 This is not implemented in \SpecialChar LyX
13928 , so you must enter title, subtitle etc.
13929 \begin_inset space ~
13932 between two \SpecialChar TeX
13948 \begin_layout Enumerate
13949 According to the user manual, the label of each bibliography item must be
13973 \begin_layout Standard
13978 template takes care of all these
13979 \begin_inset Quotes eld
13983 \begin_inset Quotes erd
13987 If you start a new paper using this template you don't need to do anything
13992 \begin_layout Enumerate
13993 don't delete the \SpecialChar TeX
13994 code included in the template, and
13997 \begin_layout Enumerate
13998 copy the example bibliography item included in the template and modify it
13999 as necessary to enter new bibliography items.
14002 \begin_layout Section
14006 \begin_layout Standard
14012 \begin_layout Subsection
14016 \begin_layout Standard
14017 The \SpecialChar LyX
14020 article (koma-script)
14024 report (koma-script)
14042 correspond to the \SpecialChar LaTeX
14060 \begin_inset space ~
14063 of the Koma-Script family.
14064 They are replacements for the standard document classes
14080 , resp., and fit better to European typography conventions in a number of
14084 \begin_layout Itemize
14085 Standard character size is 11pt in
14087 article (koma-script)
14091 report (koma-script)
14099 letter (koma-script)
14104 \begin_layout Itemize
14105 Headings, labels of the description environment, and a number of elements
14108 letter (koma-script)
14110 document class are set in a bold sans serif font.
14114 \begin_layout Plain Layout
14115 There is a big difference between the bold sans serif old cm fonts and new
14116 ec fonts, especially in the appearance of headings.
14117 In comparison, the ec bold sans serif fonts look a bit thin.
14118 Here the \SpecialChar LaTeX
14127 helps to produce the
14128 \begin_inset Quotes eld
14132 \begin_inset Quotes erd
14135 appearance when using the ec fonts.
14140 The numbering of chapter headings is made in the same way as the numbering
14141 of section headings, that is without the extra line
14142 \begin_inset Quotes eld
14145 Chapter\SpecialChar ldots
14147 \begin_inset Quotes erd
14151 In addition, the appearance of the headings can be modified by using a
14152 number of options (in \SpecialChar LyX
14153 to be entered in the field
14156 \begin_inset space ~
14163 Layout\SpecialChar menuseparator
14170 \begin_layout Itemize
14171 The main means in the Koma-Script document classes to design the type area
14180 (in \SpecialChar LyX
14181 to be entered in the extra class options field in the dialog
14183 Document\SpecialChar menuseparator
14187 They make a clearer modification of page margins possible as do the options
14190 Document\SpecialChar menuseparator
14197 \begin_layout Itemize
14198 The \SpecialChar LaTeX
14199 document classes of the Koma-Script family define a number of additional
14201 Those part of it which makes sense in \SpecialChar LyX
14202 is implemented in corresponding
14206 \begin_layout Standard
14207 Detailed descriptions of the \SpecialChar LaTeX
14208 document classes of the Koma-Script family
14209 can be found in the Koma-Script documentation
14220 \begin_layout Subsection
14221 article (koma-script), report (koma-script), and book (koma-script)
14224 \begin_layout Standard
14225 The document classes
14227 article (koma-script)
14231 report (koma-script)
14241 are implemented in the layout files
14254 They contain all the paragraph types of the corresponding standard document
14267 , resp., partly modified, with the exception of the \SpecialChar LyX
14272 -type, which is replaced by the new
14276 -type having the same functionality.
14281 -Type there is a number of new paragraph types added.
14288 letter (koma-script)
14293 \begin_layout Itemize
14302 : are equivalents to
14310 , resp., additionally inserting an entry in the table of contents.
14319 are not contained in
14321 article (koma-script)
14326 \begin_layout Itemize
14335 : behave exactly as
14343 , resp., additionally clearing running heads.
14348 is not contained in
14350 article (koma-script)
14356 \begin_layout Plain Layout
14369 report (koma-script)
14371 , but since this is identical to
14375 , is has not been implemented in \SpecialChar LyX
14384 \begin_layout Itemize
14389 : generates a heading directly above the following paragraph in the standard
14390 character size without affecting the structure of the document.
14393 \begin_layout Itemize
14402 are special captions which respect the different space settings needed
14403 for captions placed above or below an element (if you follow strict typographic
14404 rules, you might want to place table captions always above the table).
14405 You can also use the class option
14409 , which will switch
14422 You need at least Koma-Script version 2.8q to use this.
14425 \begin_layout Itemize
14430 : can be used to set a bonmot, e.
14431 \begin_inset space \thinspace{}
14435 \begin_inset space \space{}
14438 at the beginning of a chapter.
14439 If you use the optional argument (
14441 Insert\SpecialChar menuseparator
14443 \begin_inset space ~
14448 ), you can insert the dictum's author there.
14449 Dictum and author are separated by a line.
14450 You need at least Koma-Script version 2.8q to use this.
14455 is not contained in
14457 article (koma-script)
14462 \begin_layout Standard
14463 The following types, together with the standard types
14475 , form the title area of the document.
14476 They must be entered ahead of the first
14477 \begin_inset Quotes eld
14481 \begin_inset Quotes erd
14488 \begin_layout Plain Layout
14489 The corresponding \SpecialChar LaTeX
14490 commands must appear before the
14501 When such a type is used more than once, the latter usage overwrites the
14502 former one, that means, for every type only the latest usage is valid.
14503 The order of the different types however has, like
14515 , no effect on the appearance of the produced document.
14518 \begin_layout Itemize
14523 : produces a centered paragraph above the ordinary title (
14535 ) for the subject of the document.
14538 \begin_layout Itemize
14543 : produces a centered paragraph below the ordinary title (
14555 ) for the publishers' name.
14558 \begin_layout Itemize
14565 report (koma-script)
14571 produces a centered paragraph on its own page behind the title page, or
14574 article (koma-script)
14576 produces a centered paragraph below the ordinary title (
14592 ) for a dedication.
14595 \begin_layout Itemize
14600 : produces a left aligned paragraph above the ordinary title (
14616 ) for a document`s head.
14619 \begin_layout Itemize
14624 : produces in a double-sided print in
14626 report (koma-script)
14632 a left-aligned paragraph at the top of the title page`s back or has no
14633 effect in a single-sided print or in
14635 article (koma-script)
14640 \begin_layout Itemize
14645 : produces in a double-sided print in
14647 report (koma-script)
14653 a left-aligned paragraph at the bottom of the title page`s back or has
14654 no effect in a single-sided print or in
14656 article (koma-script)
14661 \begin_layout Itemize
14666 : produces a special
14667 \begin_inset Quotes eld
14671 \begin_inset Quotes erd
14674 page ahead of the actual document containing a paragraph without special
14678 \begin_layout Standard
14679 The layout files for the document classes
14681 article (koma-script)
14685 report (koma-script)
14691 do include the file
14696 This is thought of as a place to define your own types.
14701 in your personal layout directory and edit the file!
14704 \begin_layout Subsection
14705 letter (koma-script)
14708 \begin_layout Description
14709 Note: This section discusses the obsolete
14711 KOMA-Script-Letter (v.
14712 \begin_inset space ~
14717 , which is not even included anymore in recent KOMA releases.
14718 Please refer to the next section for the current KOMA-Script-Letter class
14720 \begin_inset space ~
14726 \begin_layout Standard
14730 letter (koma-script)
14732 is implemented in the layout file
14737 It contains all the paragraph types of the corresponding standard document
14742 , partly modified, with the exception of the \SpecialChar LyX
14756 type, which is replaced by the new
14761 In addition, it contains, in contrast to the standard document class, the
14780 Furthermore, there are a number of new letter specific types.
14783 \begin_layout Standard
14784 The appearance of the letter produced by this document class can be controlled
14785 by a number of \SpecialChar LaTeX
14786 commands, which you can put in the \SpecialChar LaTeX
14791 \begin_layout Plain Layout
14792 For example, the standard appearance of the letter`s heading, consisting
14793 of name and address, is quite self-willed.
14795 \begin_inset Quotes eld
14799 \begin_inset Quotes erd
14802 heading is produced by the following \SpecialChar LaTeX
14803 commands in the preamble:
14806 \begin_layout LyX-Code
14816 \begin_layout LyX-Code
14832 \begin_layout LyX-Code
14842 \begin_layout LyX-Code
14862 A detailed German description of such \SpecialChar LaTeX
14863 commands can be found in the Koma-Script
14869 With it, the letter's author can produce his personal letter layout.
14872 \begin_layout Standard
14881 define the beginning of the letter and must be used in every letter.
14882 To emphasize them in the \SpecialChar LyX
14883 document class, they are marked with the letter
14893 \begin_inset space ~
14896 in the left margin.
14897 It is possible to write any number of letters in one file.
14902 type produces a new letter using the same addressee and a
14906 type produces a new addressee.
14923 are ordinary paragraph types and can also be used several times in one
14924 and the same letter.
14927 \begin_layout Itemize
14932 : produces a paragraph for the addressee and implicitly defines the beginning
14936 \begin_layout Itemize
14941 : produces a paragraph for the form of address and implicitly produces a
14945 \begin_layout Itemize
14950 : produces a paragraph for a close.
14953 \begin_layout Itemize
14958 : produces a paragraph for a postscript.
14961 \begin_layout Itemize
14966 : produces a paragraph for a distribution list.
14969 \begin_layout Itemize
14974 : produces a paragraph for enclosures.
14977 \begin_layout Standard
15018 are input types provided with a label to enter information, which will
15019 be processed by the document class.
15023 \begin_layout Plain Layout
15024 It could be seen as a matter of inconsequence, that the types
15032 described above are not such input types as well.
15033 Because of the special meaning of those types, however, I have implemented
15034 them as ordinary paragraph types with a one letter mark in the left margin.
15035 Moreover, it would affect my feeling of symmetry, if the
15043 type had such a serious different appearance.
15048 The types must be used ahead of the corresponding
15055 \begin_layout Standard
15056 An implementation of these types in a WYSIWYG fashion does not seem to make
15057 sense, because the real appearance of the produced letter does not only
15058 depend on the usage of the particular type, but also on other factors.
15059 For example, a signature entered in the
15063 type will in the standard behavior appear in the produced letter only,
15064 when in the same letter also a
15069 The entered value of the
15073 type will in the standard behavior not appear in the produced letter at
15075 The possibility to design the letter`s heading freely is already indicated
15076 in a footnote above.
15079 \begin_layout Standard
15080 The input types can also be used as empty paragraphs.
15081 This makes sense e.
15082 \begin_inset space \thinspace{}
15086 \begin_inset space \space{}
15098 type is not used at all, in the standard behavior the value of the
15102 type is used as signature, whereas if an empty
15106 type is used, no signature value is defined.
15109 \begin_layout Standard
15110 By using the input types it is possible to write a letter template, containing
15111 filled input types with your personal dates (name, address, etc.) and empty
15112 input types for other dates you want to enter.
15115 \begin_layout Itemize
15120 : sender's name, in the standard behavior appears as a centered paragraph
15121 in small caps in the letter`s heading.
15124 \begin_layout Itemize
15129 : sender's signature, in the standard behavior appears below the
15138 type is used, the value of the
15142 type appears instead.
15145 \begin_layout Itemize
15150 : sender's address, in the standard behavior appears in a centered paragraph
15151 in the letter`s heading below the sender's name.
15154 \begin_layout Itemize
15159 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15170 \begin_layout Itemize
15175 : place of the letter`s making.
15178 \begin_layout Itemize
15183 : date of the letter`s making.
15192 , in the standard behavior, produce the place and the date in a right-aligned
15193 line below the addressee's field.
15198 type is used, neither place nor date appear, independent of the value of
15208 type is used, the date of the letter `s production is used.
15211 \begin_layout Itemize
15216 : sender`s back address, in the standard behavior appears above the addressee's
15217 field in a small sans serif font.
15220 \begin_layout Itemize
15225 : special mail information, in the standard behavior appears underlined
15226 above the addressee's field below the back address.
15229 \begin_layout Itemize
15234 : additional information, in the standard behavior appears on right side
15235 below the addressee`s field.
15238 \begin_layout Itemize
15243 : the letter's title, in the standard behavior appears in a big, bold, sans
15244 serif font above the subject.
15247 \begin_layout Itemize
15252 : the letter's subject, in the standard behavior appears in a bold font
15260 \begin_layout Standard
15281 produce a business letter like line above the
15285 line containing the fields
15286 \begin_inset Quotes eld
15290 \begin_inset Quotes erd
15294 \begin_inset Quotes eld
15298 \begin_inset Quotes erd
15302 \begin_inset Quotes eld
15306 \begin_inset Quotes erd
15310 \begin_inset Quotes eld
15314 \begin_inset Quotes erd
15318 \begin_inset Quotes eld
15322 \begin_inset Quotes erd
15326 \begin_inset Quotes eld
15330 \begin_inset Quotes erd
15334 For the date field, the value of the
15340 \begin_inset Quotes eld
15343 business letter types
15344 \begin_inset Quotes erd
15347 is used, the value of the
15351 type however does not appear, but only the \SpecialChar LaTeX
15359 The ordinary output of place and date in a right-aligned line below the
15360 addressee`s field is suppressed.
15361 The types are implemented as input types provided with a label and must
15362 be used ahead of the corresponding
15369 \begin_layout Itemize
15377 \begin_layout Itemize
15385 \begin_layout Itemize
15393 \begin_layout Itemize
15401 \begin_layout Itemize
15409 \begin_layout Subsection
15410 The new letter class: letter (koma-script v.2)
15413 \begin_layout Standard
15416 Jürgen Spitzmüller
15419 \begin_layout Standard
15420 \begin_inset VSpace medskip
15426 \begin_layout Standard
15428 Koma-Script version 2.8 has introduced a new letter class
15432 which supersedes the now unsupported
15437 It has — on the \SpecialChar LaTeX
15438 side — a completely new interface and is not compatible
15439 with the old class.
15440 Therefore, \SpecialChar LyX
15441 supports both, though it is recommended you use the new class.
15444 \begin_layout Standard
15445 This class covers the same functionality as
15447 letter (koma-script),
15450 The basic items are
15454 (receiver's address, same as
15458 in the old layout),
15471 will start a new letter (i.
15472 \begin_inset space \thinspace{}
15476 \begin_inset space \space{}
15479 you can write several letters per document).
15480 New elements are sender's
15496 and the possibility to use a
15502 Insert\SpecialChar menuseparator
15508 \begin_layout Standard
15509 The biggest improvement is, though, that the letter's layout is configurable
15510 to meet almost any needs.
15511 This can be done via the preamble or with a special style file (Letter
15512 Class Option, extension
15516 ), that will be read in as a class option.
15520 \begin_layout Plain Layout
15521 The KOMA package comes with some default
15526 There is, for instance, a
15530 file that follows german typesetting rules, or a
15534 that provides the default layout of the old
15539 The latter can be loaded with the class option
15545 Layout\SpecialChar menuseparator
15546 Document\SpecialChar menuseparator
15558 template that is included in \SpecialChar LyX
15560 A detailed description is to be found in the Koma-Script documentation
15568 \begin_layout Subsection
15572 \begin_layout Standard
15573 Visualizing the Koma-Script document classes in \SpecialChar LyX
15574 , the \SpecialChar LyX
15575 internals cause some
15579 \begin_layout Itemize
15580 The chapter number of a
15584 type appears on a line of its own above the chapter heading instead of
15585 appearing in the same line ahead of it.
15586 The cause for that is the \SpecialChar LyX
15587 internal behavior for the labeltype
15591 in the layout file.
15594 \begin_layout Itemize
15595 The headings of the types
15603 are only put in the
15604 \begin_inset Quotes eld
15608 \begin_inset Quotes erd
15612 table of contents, but not in the \SpecialChar LyX
15613 table of contents (
15615 Document\SpecialChar menuseparator
15617 \begin_inset space ~
15621 \begin_inset space ~
15629 \begin_layout Itemize
15630 The paragraphs in a
15634 document class appear in a skip separation mode, not indented.
15635 This is the standard behavior, no special \SpecialChar LaTeX
15636 commands are needed for that.
15639 Document\SpecialChar menuseparator
15642 dialog the corresponding radio button indicates
15651 value always has the effect that extra \SpecialChar LaTeX
15652 commands are inserted in the document
15653 to produce the gap, which is not what is wanted in this case.
15656 \begin_layout Section
15660 \begin_layout Standard
15663 Jürgen Spitzmüller
15666 \begin_layout Subsection
15670 \begin_layout Standard
15671 Memoir is a very powerful and constantly evolving class.
15672 It has been designed with regard to fictional and non-fictional literature.
15673 Its aim is to let the user have maximum control over the typesetting of
15675 Memoir is based on the standard book class, but it can also emulate the
15676 article class (see below).
15679 \begin_layout Standard
15680 Peter Wilson, the developer of Memoir, is known as the author of lots of
15681 useful packages in the \SpecialChar LaTeX
15683 Most of them have been merged with Memoir.
15684 Therefore, it is much easier to layout the table of contents, appendices,
15685 chapter designs and such.
15687 , though, does not support all of these goodies natively.
15688 Some of them might be added to forthcoming releases
15692 \begin_layout Plain Layout
15693 You are invited to send suggestions to
15694 \begin_inset Flex URL
15697 \begin_layout Plain Layout
15699 lyx-devel@lists.lyx.org
15709 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15711 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15713 commands (\SpecialChar TeX
15718 \begin_layout Plain Layout
15723 \begin_layout Plain Layout
15733 \begin_inset space ~
15737 \begin_inset CommandInset ref
15739 reference "sec:Inserting-TeX-Code"
15749 In this section, we can only list those features that are natively supported
15750 by \SpecialChar LyX
15752 For detailed descriptions (and for the rest of features) we recommend you
15753 have a look at the detailed manual of the Memoir class
15757 \begin_layout Plain Layout
15762 \begin_layout Plain Layout
15772 \begin_inset Flex URL
15775 \begin_layout Plain Layout
15777 CTAN:/macros/latex/memoir/memman.pdf
15787 , which is not only a user guide for the class, but also both a comprehensive
15788 description on good typesetting and a superb example for good typesetting
15792 \begin_layout Subsection
15793 Basic features and restrictions
15796 \begin_layout Standard
15797 Memoir supports basically all features of the standard book classes.
15798 There are, however, some differences, as follows:
15801 \begin_layout Description
15803 \begin_inset space ~
15806 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15809 \begin_layout Description
15811 \begin_inset space ~
15814 style: The fancy page style is not supported, due to a command clash between
15815 Memoir and the fancyhdr package (they both define a command with the same
15816 name, which confuses \SpecialChar LaTeX
15818 Instead, Memoir comes with a number of its own page styles (see
15820 Document\SpecialChar menuseparator
15821 Settings\SpecialChar menuseparator
15823 \begin_inset space ~
15829 If you want to use these for the chapter pages, you have to use the command
15836 in the main text or in preamble (e.
15837 \begin_inset space \thinspace{}
15841 \begin_inset space \space{}
15848 chapterstyle{companion}
15853 \begin_layout Description
15854 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15855 optional argument in the standard classes.
15856 With this, you can specify an alternative version of the title for the
15857 table of contents and the headers (for instance, if the title is too long).
15858 In \SpecialChar LyX
15859 , you can do this via
15861 Insert\SpecialChar menuseparator
15863 \begin_inset space ~
15868 at the beginning of a chapter/section.
15869 Memoir features a second optional argument and thus separates the table
15870 of contents from the header.
15871 You can define three variants of a title with this: one for the main text,
15872 one for the table of contents, and one for the headers.
15874 makes these available in form of specific
15885 \begin_layout Description
15886 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15887 of contents, the list of figures and the list of table start a new page
15889 Memoir does not follow this route.
15890 You have to insert a page break yourself, if you want to have one.
15893 \begin_layout Description
15894 Titlepage: For some unknown reason, Memoir uses pagination on the title
15895 page (in the standard classes, title pages are
15896 \begin_inset Quotes eld
15900 \begin_inset Quotes erd
15904 If you want an empty title page, type
15908 aliaspagestyle{title}{empty}
15913 \begin_layout Description
15914 Article: With the class option
15920 Document\SpecialChar menuseparator
15921 Settings\SpecialChar menuseparator
15922 Class Settings\SpecialChar menuseparator
15924 \begin_inset space ~
15929 ), you can emulate article style.
15930 That is, counters (footnotes, figures, tables etc.) will not be reset on
15931 new chapters, chapters don't start a new page (but are—in contrary to
15932 \begin_inset Quotes eld
15936 \begin_inset Quotes erd
15939 article classes—still allowed), parts, though, use their own page, as in
15943 \begin_layout Description
15944 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15945 font commands, which have been used in the old \SpecialChar LaTeX
15947 \begin_inset space \thinspace{}
15951 \begin_inset space \space{}
15967 It produces an error and stops \SpecialChar LaTeX
15968 whenever such a command appears.
15973 reallows the commands and spits out warnings instead (which does at least
15974 not stop \SpecialChar LaTeX
15976 Since a lot of packages and particularly Bib\SpecialChar TeX
15977 style files are still using
15978 those commands, we have decided to use this option by default.
15981 \begin_layout Subsection
15985 \begin_layout Standard
15986 We will only describe the features supported by \SpecialChar LyX
15987 (which is not much currently).
15988 Please consult the Memoir manual
15992 \begin_layout Plain Layout
15997 \begin_layout Plain Layout
16007 \begin_inset Flex URL
16010 \begin_layout Plain Layout
16012 CTAN:/macros/latex/memoir/memman.pdf
16025 \begin_layout Description
16026 Abstract: You may wonder why an abstract is an extra feature.
16027 Well, it is in book class.
16028 Usually books don't have abstracts.
16029 Memoir, however, has.
16030 You can use it wherever and how often you like.
16033 \begin_layout Description
16034 Chapterprecis: You may know this older typesetting style: The contents of
16035 a chapter are summarized below the title and also in the table of contents
16037 \begin_inset space \thinspace{}
16041 \begin_inset space \space{}
16046 Our hero arrives in Troia; he loses some friends; he finds others
16049 Chapterprecis does exactly this.
16050 It is therefore only sensible below a chapter.
16053 \begin_layout Description
16054 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16055 The epigraph environment provides an elegant way of typesetting such a
16057 The motto itself (text) and its (optional) author (source) are divided
16059 The author (source) can be inserted via
16061 Insert\SpecialChar menuseparator
16068 \begin_layout Description
16069 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16070 complex figurative poems).
16072 can only support a few of them.
16073 One is poemtitle, which is a centered title for poems, which will also
16074 be added to the table of contents (verse is the standard environment for
16076 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16078 because they have to be nested inside regular verse environments, which
16079 is not possible with \SpecialChar LyX
16083 \begin_layout Description
16084 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16087 \begin_layout Section
16088 Article (mwart), book (mwbk) and report (mwrep)
16089 \begin_inset Argument status
16092 \begin_layout Plain Layout
16105 \begin_layout Standard
16111 \begin_layout Standard
16112 The \SpecialChar LyX
16129 correspond to the \SpecialChar LaTeX
16143 They are replacements for the standard document classes
16155 , resp., and fit better to Polish typography conventions in a number of points.
16159 \begin_layout Standard
16163 \begin_layout Itemize
16164 Unnumbered titles (with star, e.
16165 \begin_inset space \thinspace{}
16169 \begin_inset space \space{}
16176 ) are added into table of contents,
16179 \begin_layout Itemize
16180 Additional page styles:
16184 \begin_layout Description
16185 uheadings header with separated lines,
16188 \begin_layout Description
16189 myheadings custom header, contents headers via commands:
16204 \begin_layout Description
16205 myuheadings custom header with separated lines,
16208 \begin_layout Description
16209 outer page number is placed on outer side of page
16213 \begin_layout Itemize
16218 \begin_layout Description
16219 rmheadings serif titles — default,
16222 \begin_layout Description
16223 sfheadings sansserif titles,
16226 \begin_layout Description
16227 authortitle on title page first placed is author next title — default,
16230 \begin_layout Description
16231 titleauthor on title page first placed is title next author,
16234 \begin_layout Description
16235 withmarginpar reserve place on page for margins.
16239 \begin_layout Section
16243 \begin_layout Standard
16248 provides an alternative to the standard
16253 It provides similar functionality, but you might prefer this layout with
16254 sans serif sections, headings, and more.
16257 \begin_layout Section
16258 Rev\SpecialChar TeX
16262 \begin_layout Standard
16268 \begin_layout Standard
16269 \begin_inset VSpace bigskip
16275 \begin_layout Standard
16280 \begin_inset space ~
16285 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16287 \begin_inset Formula $\beta$
16290 release of May, 1999) class.
16293 \begin_layout Standard
16299 textclass, which works with Rev\SpecialChar TeX
16301 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16303 That means that it doesn't interact very well with \SpecialChar LyX
16304 , which requires \SpecialChar LaTeX2e
16306 it has been kludged to work.
16307 Since Rev\SpecialChar TeX
16308 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16313 Rev\SpecialChar TeX
16315 \begin_inset space ~
16320 textclass should also be pretty easy to use.
16323 \begin_layout Standard
16324 These documents are supposed to be used in
16328 to the Rev\SpecialChar TeX
16329 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16331 and assume you'll know what to put in the preamble if necessary.
16334 \begin_layout Subsection
16338 \begin_layout Standard
16339 All you need to do is install Rev\SpecialChar TeX
16340 4, as described in the package's README
16342 The package can be found at The Rev\SpecialChar TeX
16344 \begin_inset Flex URL
16347 \begin_layout Plain Layout
16349 http://publish.aps.org/revtex4/
16355 Install it somewhere that \SpecialChar LaTeX
16357 Test it by trying to \SpecialChar LaTeX
16358 a short Rev\SpecialChar TeX
16359 4 document in some random directory (i.
16360 \begin_inset space \thinspace{}
16364 \begin_inset space \space{}
16367 not the directory where you installed the class file.) Then, if you reconfigure
16369 , it will find the class file and let you use the Rev\SpecialChar TeX
16373 \begin_layout Standard
16374 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16383 \begin_inset space ~
16388 template, found in the templates directory.
16391 \begin_layout Subsection
16395 \begin_layout Standard
16396 Optional arguments to
16403 \begin_inset Quotes eld
16407 \begin_inset Quotes erd
16411 \begin_inset Quotes eld
16415 \begin_inset Quotes erd
16421 \begin_inset space ~
16429 \begin_inset space ~
16435 Remember that in Rev\SpecialChar TeX
16436 , at least one optional argument is required!
16439 \begin_layout Standard
16440 Other preamble matter, like
16447 \begin_inset space ~
16454 \begin_inset space ~
16459 dialog, also as usual.
16462 \begin_layout Subsection
16466 \begin_layout Standard
16467 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16469 For example, the Email layout corresponds to
16476 Note that (at least as of Rev\SpecialChar TeX
16485 layouts are exactly equivalent, so you shouldn't need to use both.
16489 \begin_layout Plain Layout
16490 In case you're curious, both were included so that
16494 would be able to translate both
16514 \begin_layout Subsection
16518 \begin_layout Standard
16519 There are a couple of important unique aspects of Rev\SpecialChar TeX
16520 4 which might cause
16521 bugs that will be even more confusing in \SpecialChar LyX
16525 \begin_layout Standard
16526 In Rev\SpecialChar TeX
16544 The \SpecialChar LyX
16545 equivalent is that there is a separate Thanks layout.
16550 write footnotes in the
16554 layout, or weird things may happen.
16555 See the Rev\SpecialChar TeX
16556 4 documentation for more details.
16559 \begin_layout Standard
16563 \begin_inset space ~
16571 \begin_inset space ~
16580 layouts must be placed
16588 layout and the corresponding
16605 , the \SpecialChar LaTeX
16609 \begin_layout Section
16610 Springer Journals (
16617 \begin_layout Standard
16623 \begin_layout Subsection
16627 \begin_layout Standard
16628 These are the layout files for some of the journal formats used by Springer
16629 Verlag and listed on
16630 \begin_inset Flex URL
16633 \begin_layout Plain Layout
16635 http://www.springer.de/author/tex/help-journals.html
16640 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16642 It is a modular system: the things common to all journals are implemented
16647 , which journal-specific layout files (such as, e.
16648 \begin_inset space \thinspace{}
16652 \begin_inset space \space{}
16659 for Journal of Geodesy) can include.
16662 \begin_layout Standard
16663 This means that implementing support for any other Springer journal on this
16664 list is as simple as writing your own
16672 file following the outline given in
16680 \begin_layout Standard
16681 It is reasonably well tested only for the Journal of Geodesy.
16690 come with the standard \SpecialChar LyX
16692 Install the relevant class file (downloaded from Springer) in a proper
16693 directory, reconfigure \SpecialChar LaTeX
16694 (in the te\SpecialChar TeX
16699 , as root if necessary — doesn't \SpecialChar LyX
16700 take care of this?), reconfigure \SpecialChar LyX
16705 \begin_layout Subsection
16709 \begin_layout Standard
16710 A large number of theorem-like styles —
16722 \begin_layout Standard
16725 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16726 _Title, Author_Running, Institute,
16727 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16730 See the Springer class file documentation for details.
16733 \begin_layout Subsection
16737 \begin_layout Itemize
16749 \begin_layout Itemize
16752 Probability Theory and Related Fields
16758 — Jean-Marc Lasgouttes
16761 \begin_layout Standard
16762 Add your own, it isn't so hard!
16765 \begin_layout Subsection
16769 \begin_layout Standard
16770 These files are partly based on the older
16774 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16776 file from Springer.
16781 layout, are now defunct.
16782 Jean-Marc Lasgouttes helped out big in making me find my way around the
16784 layout file mechanism.
16787 \begin_layout Subsection
16791 \begin_layout Standard
16793 But probably less than in the old hacked-\SpecialChar LaTeX
16801 \begin_layout Section
16804 Sli\SpecialChar TeX
16808 \begin_inset CommandInset label
16817 \begin_layout Standard
16825 \begin_layout Subsection
16829 \begin_layout Standard
16830 This section describes how to use \SpecialChar LyX
16831 to make slides for overhead projectors.
16832 There are two document classes that can do this: the default slides class
16835 Foil\SpecialChar TeX
16839 This section documents the former.
16842 \begin_layout Standard
16843 I'm going to say this again, nice and clear, so that there's no misunderstanding
16847 \begin_layout Standard
16848 \begin_inset VSpace bigskip
16854 \begin_layout Standard
16858 This section documents the class
16859 \begin_inset Quotes eld
16867 \begin_inset Quotes erd
16875 \begin_layout Standard
16876 \begin_inset VSpace bigskip
16882 \begin_layout Standard
16883 If you're looking for the documentation for
16884 \begin_inset Quotes eld
16889 slides (Foil\SpecialChar TeX
16893 \begin_inset Quotes erd
16896 , check out section
16897 \begin_inset space ~
16901 \begin_inset CommandInset ref
16903 reference "sec:foiltex"
16913 \begin_inset Quotes eld
16918 slides (Foil\SpecialChar TeX
16922 \begin_inset Quotes erd
16925 ] is actually somewhat better than the default
16933 \begin_layout Plain Layout
16935 or so I've been told repeatedly by its advocates.
16936 Having never used it, I have no idea if this claim is true or not.
16941 which this section documents.
16944 \begin_layout Standard
16945 This class is the \SpecialChar LaTeX2e
16946 improvement of the old
16948 Sli\SpecialChar TeX
16952 Every \SpecialChar LaTeX2e
16953 distribution includes this class [which I'll just refer to as
16954 \begin_inset Quotes eld
16962 \begin_inset Quotes erd
16965 from now on], so you're bound to have it.
16966 As I noted earlier, there are other classes, such as
16970 , which also produce slides for overhead projectors and do a better job
16972 However, there are some things which
16976 can do which the others can't, such as generate overlays.
16977 Read on to learn more!
16980 \begin_layout Subsection
16982 \begin_inset CommandInset label
16984 name "sec:slidesetup"
16991 \begin_layout Standard
16992 Obviously, to use this document class, you need to select
16993 \begin_inset Quotes eld
17001 \begin_inset Quotes erd
17004 from the class list in the
17006 Document\SpecialChar menuseparator
17010 There are some other special things you should know about this class:
17013 \begin_layout Itemize
17014 Don't bother changing the options
17019 They're not supported by the
17026 \begin_layout Itemize
17030 \begin_inset space ~
17035 behaves a bit differently for this class.
17036 The possible choices and what they do are as follows:
17040 \begin_layout Description
17045 The final output contains page numbers in the lower right corner.
17048 \begin_layout Description
17057 , but also prints out any time markers you've put in.
17058 This is the default.
17061 \begin_layout Description
17066 The final output contains no page numbers, time markers, or alignment markers.
17070 \begin_layout Itemize
17075 class has an extra option:
17081 \begin_inset Quotes eld
17089 \begin_inset Quotes erd
17092 in the extra class options.
17096 \begin_layout Standard
17097 Using this options allows you to add time markers to
17103 \begin_inset space ~
17107 \begin_inset CommandInset ref
17109 reference "sec:slideNote"
17117 \begin_layout Standard
17118 You can also use the template file
17119 \begin_inset Quotes eld
17127 \begin_inset Quotes erd
17130 to automatically set up a document to use the
17136 File\SpecialChar menuseparator
17138 \begin_inset space ~
17142 \begin_inset space ~
17147 to open your new document].
17148 The template file also contains some examples of the special paragraph
17149 environments used by this class.
17150 I'll describe those next.
17153 \begin_layout Subsection
17154 Paragraph Environments
17157 \begin_layout Subsubsection
17158 Supported Environments
17161 \begin_layout Standard
17162 The first thing you'll notice when you start up a new
17166 document is the font size and type: it's the equivalent of the size
17167 \begin_inset Quotes eld
17175 \begin_inset Quotes erd
17181 \begin_inset space ~
17187 This is also what's used in the output.
17189 \begin_inset Quotes eld
17193 \begin_inset Quotes erd
17196 to remind you that this is a slide.
17197 Your final slides will use a larger font; ergo, you'll have less space.
17198 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17201 \begin_layout Standard
17202 The next thing that becomes obvious is the changes to the paragraph environment
17203 pull-down box [at the far-left end of the toolbar].
17204 Most of the paragraph environments you're used to seeing are missing.
17205 There are also five new ones.
17210 class itself only supports certain paragraph environments:
17213 \begin_layout Itemize
17219 \begin_layout Itemize
17225 \begin_layout Itemize
17231 \begin_layout Itemize
17237 \begin_layout Itemize
17243 \begin_layout Itemize
17249 \begin_layout Itemize
17255 \begin_layout Itemize
17261 \begin_layout Itemize
17267 \begin_layout Itemize
17274 \begin_layout Standard
17275 All of the other standard environments, including the section-heading environmen
17276 ts, aren't used in the
17283 \begin_layout Standard
17284 On the other hand, you'll notice the following new environments:
17287 \begin_layout Itemize
17293 \begin_layout Itemize
17299 \begin_layout Itemize
17305 \begin_layout Itemize
17311 \begin_layout Itemize
17317 \begin_layout Standard
17318 These five are kind of quirky, due to a
17319 \begin_inset Quotes eld
17323 \begin_inset Quotes erd
17326 in \SpecialChar LyX
17328 You see, \SpecialChar LyX
17329 doesn't permit you to nest any other paragraph environment into
17330 an empty environment.
17331 Now, that's fine and dandy, but it means that you wouldn't be able to start
17332 a slide with anything except plain text.
17333 To deal with this, I've performed a little
17334 \begin_inset Quotes eld
17339 \begin_inset Quotes erd
17345 \begin_layout Subsubsection
17346 Quirks of the New Environments
17347 \begin_inset CommandInset label
17349 name "sec:slideQuirk"
17356 \begin_layout Standard
17357 All five of the new paragraph environments are somewhat quirky due to inherent
17358 limitiations in the current version of \SpecialChar LyX
17360 As I just mentioned, \SpecialChar LyX
17361 forbids environments that begin with another environment.
17362 To get around this, the
17366 environment isn't a paragraph environment as described in the
17374 \begin_layout Standard
17375 You should consider
17388 \begin_inset Quotes eld
17391 pseudo-environments.
17392 \begin_inset Quotes erd
17395 They look like a section heading or a
17396 \begin_inset Quotes eld
17404 \begin_inset Quotes erd
17407 but really begin a [and, if necessary, end the previous] paragraph environment.
17417 \begin_inset Quotes eld
17421 \begin_inset Quotes erd
17424 These two perform some action.
17427 \begin_layout Standard
17428 A common feature of all five environments,
17448 , is a rather long-ish label.
17449 The text following this label — ordinarily the contents of the paragraph
17450 environment — is utterly irrelevant for
17472 completely ignores it.
17473 In fact, you can leave these five environments completely empty.
17477 \begin_layout Standard
17482 to put any text after the rather long-ish label, you might want to.
17483 This could be a short description of the contents of the
17488 In that case, enter your descriptive comment and hit
17492 as you normally would.
17495 \begin_layout Standard
17496 If, on the other hand, you don't want to enter any descriptive text, you'll
17497 hit another \SpecialChar LyX
17500 , like nature, abhors a vacuum, and will not let you start a new paragraph
17501 environment until you put something in the old one.
17505 \begin_layout Itemize
17506 Start entering the text that will
17534 \begin_layout Itemize
17535 Now move to the beginning of that paragraph.
17539 \begin_layout Itemize
17548 \begin_layout Itemize
17549 Finally, change this new, empty paragraph to a
17573 \begin_layout Standard
17574 Some future version of \SpecialChar LyX
17575 will, hopefully, resolve this quirkiness\SpecialChar ldots
17579 \begin_layout Subsection
17580 Making a Presentation with
17593 \begin_layout Subsubsection
17601 \begin_layout Standard
17602 If you're expecting this section to teach you how to actually make a presentatio
17603 n, you'll be sorely disappointed.
17604 Naturally, I'll describe all of the ways the
17608 class can assist you in preparing the materials for a presentation.
17609 Filling in the contents, however, is up to you.
17614 the \SpecialChar LyX
17618 \begin_layout Standard
17623 environment [in the manner described in section
17624 \begin_inset space ~
17628 \begin_inset CommandInset ref
17630 reference "sec:slideQuirk"
17634 ] tells \SpecialChar LyX
17635 to begin a new slide [duh].
17636 The label for this environment/
17637 \begin_inset Quotes erd
17641 \begin_inset Quotes erd
17645 \begin_inset Quotes eld
17649 \begin_inset Quotes erd
17652 in cool blue, followed by the label,
17653 \begin_inset Quotes eld
17657 \begin_inset Quotes erd
17661 Any text or paragraph environments that follow this one go on the new slide.
17665 \begin_layout Standard
17666 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17668 (this can be specified in the
17673 In fact, you'll want to, once you finish entering the contents of one slide.
17674 If you've entered more text than can physically fit on a slide, the extra
17675 overflows onto a new slide.
17676 I don't recommend doing this, however, since the overflow slide won't have
17677 any page number on it.
17678 Furthermore, it may interfere with any
17682 you've made to accompany the oversized
17689 \begin_layout Standard
17698 environments work the same way as the
17703 They both create an
17704 \begin_inset Quotes eld
17708 \begin_inset Quotes erd
17711 followed by a label [
17712 \begin_inset Quotes eld
17716 \begin_inset Quotes erd
17720 \begin_inset Quotes eld
17724 \begin_inset Quotes erd
17728 The color is a stunning magenta instead of blue, and the
17729 \begin_inset Quotes eld
17733 \begin_inset Quotes erd
17736 will look different, in style and in length.
17737 The label fonts of all three also differ from one another.
17740 \begin_layout Standard
17745 , if the contents of a
17753 exceed the physical size of a slide or sheet of paper, the extra will overflow
17755 Again, you should avoid this.
17756 It defeats the whole purpose of
17767 \begin_layout Subsubsection
17777 \begin_layout Standard
17782 is a slide that sits atop another slide.
17783 Perhaps you wish to discuss a figure on the main
17787 before displaying the text associated with it.
17788 One way to accomplish this is tape a flap of dark paper over the part of
17793 you want to display later.
17794 This method fails, however, if you wish to overlap one graph with another,
17796 You would then have to fumble while speaking to align the two separate,
17801 s to align the two graphs.
17806 environment in both cases makes life much easier.
17809 \begin_layout Standard
17814 receives the page number of its
17815 \begin_inset Quotes eld
17819 \begin_inset Quotes erd
17827 \begin_inset Quotes eld
17835 \begin_inset Quotes erd
17842 \begin_layout Plain Layout
17843 Presumably, mutliple
17848 \begin_inset Quotes eld
17856 \begin_inset Quotes erd
17860 \begin_inset Quotes eld
17868 \begin_inset Quotes erd
17872 \begin_inset Quotes eld
17880 \begin_inset Quotes erd
17884 \begin_inset space ~
17887 appended to the page number of the parent
17897 Clearly, you want the contents of both the
17905 to each fit on a single physical slide! You should probably consider an
17911 \begin_inset Quotes eld
17915 \begin_inset Quotes erd
17923 Indeed, the \SpecialChar LyX
17928 class provides a visual cue for this: the label at the start of an
17932 is shorter than that at the start of a
17937 Lastly, when you generate printable output, you'll find alignment markers
17938 in all four corners of both the
17942 page and its parent
17947 These will assist you in lining up the two physical slides.
17950 \begin_layout Standard
17951 The major problem in overlaying two slides is aligning the contents of the
17952 two transparencies.
17953 How much space should you leave for that graph on the second slide? Worse
17954 still, what if you want a graph and a sentence on second slide, but there
17955 is text on the main transparency that goes in between them? You could try
17956 and insert vertical space of the right size.
17957 The better way is to use
17968 \begin_layout Standard
17969 As their names imply,
17977 are two command-like paragraph environments that make all subsequent text
17978 invisible and visible, respectively.
17980 \begin_inset space ~
17984 \begin_inset CommandInset ref
17986 reference "sec:slideQuirk"
17990 that you don't place anything
17994 these two environments, however.
17999 , it inserts a centered, sky-blue label into the page reading
18000 \begin_inset Quotes eld
18003 <Invisible Text Follows>
18004 \begin_inset Quotes erd
18008 For paragraphs following this label, the parts of the
18016 ; it doesn't matter which] where they would be contain instead blank space.
18020 \begin_layout Standard
18025 , the corresponding centered label is
18026 \begin_inset Quotes eld
18029 <Visible Text Follows>
18030 \begin_inset Quotes erd
18034 Paragraphs following this label behave normally.
18035 Note that the beginning of a new
18047 automatically shuts off an
18052 It's therefore not necessary to use
18063 \begin_layout Standard
18064 By now, it should be obvious how to create overlay transparencies using
18065 the proper combination of
18084 \begin_layout Enumerate
18089 , including everything that will appear on it, whether on the main slide
18097 \begin_layout Enumerate
18098 Before each figure or paragraph that will appear only on the
18107 If necessary, insert a
18111 environment after the
18118 \begin_layout Enumerate
18123 immediately following the
18130 \begin_layout Enumerate
18131 Copy the contents of this
18142 \begin_layout Enumerate
18147 , change all of the
18158 \begin_layout Standard
18160 You've just made an
18167 \begin_layout Standard
18168 There's one problem with the way I've designed the \SpecialChar LyX
18173 class: you can't make text in the middle of a paragraph invisible, nor
18174 make text in the middle of an invisible paragraph visible again.
18175 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18180 \begin_layout Plain Layout
18181 The commands of interest are:
18184 \begin_layout Itemize
18189 invisible \SpecialChar ldots
18193 \begin_layout Itemize
18198 visible \SpecialChar ldots
18202 \begin_layout Plain Layout
18204 and need to be marked as \SpecialChar TeX
18207 \begin_inset Quotes eld
18211 \begin_inset Quotes erd
18214 you wish to change goes in between the brackets [and after the
18227 If you don't know how to mark text as \SpecialChar TeX
18228 , see the appropriate section of
18241 \begin_layout Subsubsection
18251 \begin_inset CommandInset label
18253 name "sec:slideNote"
18260 \begin_layout Standard
18269 is associated with a
18270 \begin_inset Quotes eld
18274 \begin_inset Quotes erd
18282 Here, too, the \SpecialChar LyX
18287 class provides visual cues.
18292 is shorter than that of a
18296 [yet longer than that of an
18300 ] and, like the label of an
18304 is shockingly magenta.
18305 Additionally, the printed
18309 has the page number of its
18310 \begin_inset Quotes eld
18314 \begin_inset Quotes erd
18322 \begin_inset Quotes eld
18330 \begin_inset Quotes erd
18334 \begin_inset Quotes eld
18342 \begin_inset Quotes erd
18346 \begin_inset Quotes eld
18354 \begin_inset Quotes erd
18358 You can have multiple
18362 s associated with a single
18374 , you'll probably want to break up long
18378 s so that they fit on a single sheet of paper.
18381 \begin_layout Standard
18386 is obvious: it contains anything additional you might want to say about
18392 It could also be used as a sheet of reminders for a particular
18397 In the case of the latter, you might want to make use of time markers.
18398 Currently, the \SpecialChar LyX
18404 \begin_inset Quotes eld
18408 \begin_inset Quotes erd
18411 support for time markers, a
18413 Sli\SpecialChar TeX
18417 So, you'll have to resort to using the \SpecialChar LaTeX
18421 \begin_layout Standard
18422 To use time markers, you'll need to specify the extra class option
18423 \begin_inset Quotes eld
18431 \begin_inset Quotes erd
18435 \begin_inset space ~
18439 \begin_inset CommandInset ref
18441 reference "sec:slidesetup"
18446 This option turns on timing marks, which will appear in the lower-left-hand
18452 To set what appears in the time marker, you use the \SpecialChar LaTeX
18454 \begin_inset Quotes eld
18464 \begin_inset Quotes erd
18468 \begin_inset Quotes eld
18478 \begin_inset Quotes erd
18482 The arguments of both commands are time measured in seconds.
18484 \begin_inset Quotes eld
18494 \begin_inset Quotes erd
18497 sets the time marker to a given time.
18499 \begin_inset Quotes eld
18509 \begin_inset Quotes erd
18512 increments the time marker by the specified amount.
18513 Using time markers and
18517 s in this fashion, you can remind yourself how much time to spend on a particula
18525 \begin_layout Standard
18526 There's one last feature to describe.
18527 Clearly, you'd like to print out all of your
18535 s on transparencies while printing all of your
18552 with which it is associated.
18553 What's a person to do?
18556 \begin_layout Standard
18557 Luckily, there are two \SpecialChar LaTeX
18558 commands that allow you to select what to print
18560 Both must be placed into the preamble of your document.
18562 \begin_inset Quotes eld
18574 \begin_inset Quotes erd
18577 will cause the output to contain only the
18586 Correspondingly, the command
18587 \begin_inset Quotes eld
18599 \begin_inset Quotes erd
18602 prevents the output of anything but
18607 I'd advise placing both commands in the preamble and initially comment
18609 You can then preview your entire presentation as you write.
18610 When you're done writing, you can then uncomment one of the two to select
18611 what you want to print.
18612 I like to uncomment
18613 \begin_inset Quotes eld
18625 \begin_inset Quotes erd
18628 , print to a file with
18629 \begin_inset Quotes eld
18637 \begin_inset Quotes erd
18640 in its name, comment it back out, then uncomment
18641 \begin_inset Quotes eld
18653 \begin_inset Quotes erd
18657 \begin_inset Quotes eld
18665 \begin_inset Quotes erd
18669 I can then send either file to a printer, loading transparencies or plain
18670 paper as appropriate.
18673 \begin_layout Standard
18674 You can also provide other arguments to the
18675 \begin_inset Quotes eld
18685 \begin_inset Quotes erd
18689 \begin_inset Quotes eld
18699 \begin_inset Quotes erd
18703 See a good \SpecialChar LaTeX
18707 \begin_layout Subsection
18712 Class Template File
18715 \begin_layout Standard
18716 I have also provided a template file,
18717 \begin_inset Quotes eld
18725 \begin_inset Quotes erd
18733 To use it, begin your new presentation with
18735 File\SpecialChar menuseparator
18737 \begin_inset space ~
18741 \begin_inset space ~
18747 Your new \SpecialChar LyX
18748 presentation file will contain an example
18769 additionally contain an example of the use of
18778 Lastly, the preamble will contain:
18781 \begin_layout LyX-Code
18782 % Uncomment to print out only slides and overlays
18785 \begin_layout LyX-Code
18789 \begin_layout LyX-Code
18795 \begin_inset Newline newline
18801 \begin_layout LyX-Code
18802 % Uncomment to print out only notes
18805 \begin_layout LyX-Code
18809 \begin_layout LyX-Code
18817 \begin_layout Standard
18818 One final thing: I created this class to support the \SpecialChar LaTeX2e
18820 \begin_inset Quotes eld
18825 Sli\SpecialChar TeX
18829 \begin_inset Quotes erd
18832 class, one of the built-in \SpecialChar LaTeX2e
18834 Neither I nor the rest of the \SpecialChar LyX
18835 Team endorse or oppose the use of this built-in
18837 It's here if you want it or need it.
18838 There exist other \SpecialChar LaTeX2e
18839 classes for creating presentations, such as the
18844 \begin_inset space ~
18848 \begin_inset CommandInset ref
18850 reference "sec:foiltex"
18855 \begin_inset Quotes eld
18863 \begin_inset Quotes erd
18866 package [present on some \SpecialChar TeX
18868 The latter is not yet supported under \SpecialChar LyX
18873 \begin_layout Plain Layout
18874 Perhaps you can take on the task\SpecialChar ldots
18880 I know nothing about these other classes.
18881 Try them out to see what sort of alternative they provide.
18884 \begin_layout Chapter
18886 Features needing Extra Software
18889 \begin_layout Section
18890 Checking \SpecialChar TeX
18894 \begin_layout Standard
18900 \begin_layout Subsection
18904 \begin_layout Standard
18913 \begin_layout Plain Layout
18918 is not yet available when you are using the \SpecialChar LaTeX
18919 distribution MiK\SpecialChar TeX
18925 , you'll find in the
18932 \begin_inset space ~
18943 \begin_inset Newline newline
18947 \begin_inset CommandInset href
18949 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18957 \begin_layout Standard
18960 Chk\SpecialChar TeX
18963 package is a program that was written by
18964 \begin_inset Flex Noun
18967 \begin_layout Plain Layout
18969 \begin_inset space ~
18977 in frustration because some constructs in \SpecialChar LaTeX
18978 are sometimes non-intuitive,
18979 and easy to forget.
18980 The program runs over your \SpecialChar LaTeX
18981 file, checks the integrity of the file, and
18982 flags some common errors.
18983 In other technical words, it is
18987 for \SpecialChar LaTeX
18991 \begin_layout Standard
18992 Well, what is a syntax checker doing in \SpecialChar LyX
18993 which is supposed to produce correct
18995 anyways? The answer is simple: Just as
18999 not only checks the
19003 of C programs, but also does
19007 checks for type-errors,
19009 Chk\SpecialChar TeX
19012 catches some common
19016 errors, in addition to the syntactical ones.
19019 Chk\SpecialChar TeX
19022 is capable of detecting several common errors, such as
19025 \begin_layout Itemize
19026 Ellipsis detection:
19027 \begin_inset Newline newline
19030 Use \SpecialChar ldots
19034 \begin_layout Itemize
19035 No space in front of/after parenthesis:
19036 \begin_inset Newline newline
19042 \begin_layout Itemize
19043 Enforcement of normal space after common abbreviations:
19044 \begin_inset Newline newline
19048 \begin_inset space \thinspace{}
19052 \begin_inset space \space{}
19055 is too wide spacing.
19058 \begin_layout Itemize
19059 Enforcement of end-of-sentence space when the last sentence ends with a
19061 \begin_inset Newline newline
19065 And this is wrong spacing.
19068 \begin_layout Itemize
19069 Space in front of labels and similar commands:
19070 \begin_inset Newline newline
19073 The label should stick right up to the text to avoid falling to a wrong
19076 \begin_inset CommandInset label
19086 \begin_layout Plain Layout
19087 This footnote is in danger of falling off to a wrong page
19092 The label is separated too much.
19095 \begin_layout Itemize
19096 Space in front of references, instead of hard spaces:
19097 \begin_inset Newline newline
19100 If you have bad luck, the text will break right between the referenced text
19101 and reference number, and that's a pity.
19103 \begin_inset CommandInset ref
19105 reference "sec:chktex"
19112 \begin_layout Itemize
19114 \begin_inset Quotes eld
19118 \begin_inset Quotes erd
19122 \begin_inset Formula $\times$
19126 \begin_inset Newline newline
19129 2x2 looks cheap compared to
19130 \begin_inset Formula $2\times2$
19136 \begin_layout Standard
19137 and more \SpecialChar ldots
19138 It is an invaluable tool when you are
19139 \begin_inset Quotes eld
19143 \begin_inset Quotes erd
19146 your document before printing, and you should run it right after the obligatory
19147 spelling check, and before you go fine tuning the typesetting.
19150 \begin_layout Subsection
19154 \begin_layout Standard
19155 If you have the program installed, usage is as simple as choosing
19157 Tools\SpecialChar menuseparator
19159 \begin_inset space ~
19165 This will make \SpecialChar LyX
19166 generate a \SpecialChar LaTeX
19167 file of your document, start
19169 Chk\SpecialChar TeX
19172 to check it, and then make \SpecialChar LyX
19174 \begin_inset Quotes eld
19178 \begin_inset Quotes erd
19181 with the warnings from
19183 Chk\SpecialChar TeX
19186 , if there were any.
19187 The warnings will be placed close to the point of the mistake, and you
19188 can quickly find them by using the
19190 Navigate\SpecialChar menuseparator
19193 menu item, or the shortcut key
19202 Open the error boxes by clicking on them with the mouse, or use the shortcut
19211 bindings, or the corresponding
19220 Read the warning and correct the mistake, if it is a mistake.
19221 If you have trouble understanding what the warning is about, you can safely
19223 Remember that there is a hidden layer between the document on screen and
19224 the technical details in invoking
19226 Chk\SpecialChar TeX
19229 , and this gap can make some warnings seem arcane or just plain silly.
19232 \begin_layout Standard
19233 This document is an excellent testing bed for the feature, and it should
19234 provide quite a few warnings for you to fiddle with.
19235 Since computers are only so smart, expect most of the warnings to be false
19239 \begin_layout Subsection
19240 How to fine tune it
19243 \begin_layout Standard
19244 Sometimes, you'll find that
19246 Chk\SpecialChar TeX
19249 makes more noise than suits your mood.
19250 Then you can choose not to use it, wait until your mood changes, or try
19253 Chk\SpecialChar TeX
19256 to get better along with you.
19259 \begin_layout Standard
19262 Chk\SpecialChar TeX
19269 very configurable and extensible, you should not expect to solve all problems
19272 Chk\SpecialChar TeX
19275 in \SpecialChar LyX
19277 Since \SpecialChar LyX
19278 has to generate a somewhat special \SpecialChar LaTeX
19279 file to be able to match the
19280 line numbers from the
19282 Chk\SpecialChar TeX
19289 \begin_layout Plain Layout
19290 You can inspect the specific output from
19296 Document\SpecialChar menuseparator
19299 \begin_inset space ~
19313 to the internal document structure, some of the warnings will not appear
19315 There are two things you can do about this:
19318 \begin_layout Itemize
19321 Chk\SpecialChar TeX
19324 invocation command line in
19325 \begin_inset Flex Noun
19328 \begin_layout Plain Layout
19329 Tools\SpecialChar menuseparator
19330 Preferences\SpecialChar menuseparator
19331 Output\SpecialChar menuseparator
19332 LaTeX\SpecialChar menuseparator
19340 Chk\SpecialChar TeX
19343 installation configuration file (usually with the file
19348 See below to learn what warnings can be enabled and disabled on the command
19352 \begin_layout Itemize
19353 Export your document as a raw \SpecialChar LaTeX
19356 File\SpecialChar menuseparator
19357 Export\SpecialChar menuseparator
19366 Invoked in this way, it can be a hassle to find the corresponding place
19367 in the document inside \SpecialChar LyX
19368 , but with a little patience, you should be able
19372 \begin_layout Standard
19373 Here follows the warning messages that can be enabled and disabled in
19382 to disable a warning, and
19386 to enable a warning.
19387 The emphasized entries are disabled by default, because the default is
19390 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19395 \begin_layout Standard
19396 Notice that you should only use the options that enable and disable warnings,
19397 because \SpecialChar LyX
19398 relies on some of the other command line parameters to be set
19399 in a specific way to have a chance to communicate with
19406 \begin_layout Enumerate
19410 Command terminated with space.
19413 \begin_layout Enumerate
19416 Non-breaking space (
19417 \begin_inset Quotes eld
19425 \begin_inset Quotes erd
19428 ) should have been used.
19431 \begin_layout Enumerate
19435 You should enclose the previous parenthesis with
19436 \begin_inset Quotes eld
19444 \begin_inset Quotes erd
19450 \begin_layout Enumerate
19453 Italic correction (
19454 \begin_inset Quotes eld
19464 \begin_inset Quotes erd
19467 ) found in non-italic buffer.
19470 \begin_layout Enumerate
19473 Italic correction (
19474 \begin_inset Quotes eld
19484 \begin_inset Quotes erd
19487 ) found more than once.
19490 \begin_layout Enumerate
19494 No italic correction (
19495 \begin_inset Quotes eld
19505 \begin_inset Quotes erd
19511 \begin_layout Enumerate
19515 \begin_inset Quotes eld
19523 \begin_inset Quotes erd
19527 \begin_inset Quotes eld
19535 \begin_inset Quotes erd
19541 \begin_layout Enumerate
19544 Wrong length of dash may have been used.
19547 \begin_layout Enumerate
19551 \begin_inset Quotes eld
19559 \begin_inset Quotes erd
19563 \begin_inset Quotes eld
19571 \begin_inset Quotes erd
19577 \begin_layout Enumerate
19581 \begin_inset Quotes eld
19589 \begin_inset Quotes erd
19595 \begin_layout Enumerate
19599 \begin_inset Quotes eld
19607 \begin_inset Quotes erd
19610 to achieve an ellipsis.
19613 \begin_layout Enumerate
19616 Inter-word spacing (
19617 \begin_inset Quotes eld
19627 \begin_inset Quotes eld
19630 ) should perhaps be used.
19633 \begin_layout Enumerate
19636 Inter-sentence spacing (
19637 \begin_inset Quotes eld
19647 \begin_inset Quotes erd
19650 ) should perhaps be used.
19653 \begin_layout Enumerate
19656 Could not find argument for command.
19659 \begin_layout Enumerate
19663 \begin_inset Quotes eld
19671 \begin_inset Quotes erd
19677 \begin_layout Enumerate
19680 Math mode still on at end of \SpecialChar LaTeX
19684 \begin_layout Enumerate
19688 \begin_inset Quotes eld
19696 \begin_inset Quotes erd
19699 doesn't match the number of
19700 \begin_inset Quotes eld
19708 \begin_inset Quotes erd
19714 \begin_layout Enumerate
19717 You should use either
19720 \begin_inset Quotes eld
19728 \begin_inset Quotes erd
19733 as an alternative to
19734 \begin_inset Quotes eld
19742 \begin_inset Quotes erd
19748 \begin_layout Enumerate
19755 " (ASCII 39) instead of "
19762 \begin_layout Enumerate
19765 User-specified pattern found.
19768 \begin_layout Enumerate
19771 This command might not be intended.
19774 \begin_layout Enumerate
19781 \begin_layout Enumerate
19799 \begin_layout Enumerate
19802 Delete this space to maintain correct page references.
19805 \begin_layout Enumerate
19809 You might wish to put this between a pair of
19810 \begin_inset Quotes eld
19818 \begin_inset Quotes erd
19824 \begin_layout Enumerate
19827 You ought to remove spaces in front of punctuation.
19830 \begin_layout Enumerate
19833 Could not execute \SpecialChar LaTeX
19837 \begin_layout Enumerate
19846 in front of small punctuation.
19849 \begin_layout Enumerate
19857 may look prettier here.
19860 \begin_layout Enumerate
19864 Multiple spaces detected in output.
19867 \begin_layout Enumerate
19870 This text may be ignored.
19873 \begin_layout Enumerate
19879 \begin_inset Quotes eld
19884 to begin quotation, not
19891 \begin_layout Enumerate
19898 to end quotation, not
19901 \begin_inset Quotes eld
19909 \begin_layout Enumerate
19915 \begin_layout Enumerate
19918 You should perhaps use
19919 \begin_inset Quotes eld
19927 \begin_inset Quotes erd
19933 \begin_layout Enumerate
19936 You should put a space in front of/after parenthesis.
19939 \begin_layout Enumerate
19942 You should avoid spaces in front of/after parenthesis.
19945 \begin_layout Enumerate
19949 You should not use punctuation in front of/after quotes.
19952 \begin_layout Enumerate
19955 Double space found.
19958 \begin_layout Enumerate
19961 You should put punctuation outside inner/inside display math mode.
19964 \begin_layout Enumerate
19967 You ought to not use primitive \SpecialChar TeX
19968 in \SpecialChar LaTeX
19972 \begin_layout Enumerate
19975 You should remove spaces in front of
19976 \begin_inset Quotes eld
19984 \begin_inset Quotes erd
19990 \begin_layout Enumerate
19993 \begin_inset Quotes eld
20001 \begin_inset Quotes erd
20004 is normally not followed by
20005 \begin_inset Quotes eld
20013 \begin_inset Quotes erd
20019 \begin_layout Standard
20020 In later versions of \SpecialChar LyX
20021 , we hope to provide a more complete interface to this
20022 tool (and it's smaller cousin
20026 ) to exploit the full power of it.
20027 But it's not exactly useless as it is now: go try it on one of your existing
20028 documents of a certain length and be surprised.
20031 \begin_layout Section
20032 Version Control in \SpecialChar LyX
20036 \begin_layout Standard
20039 Lars Gullik Bjønnes
20046 \begin_layout Subsection
20050 \begin_layout Standard
20052 supports some of the most basic RCS/CVS/SVN/GIT commands.
20053 If you need something a bit more sophisticated you will have to do that
20054 manually in a terminal.
20057 \begin_layout Standard
20058 Also note that CVS support is not as good as subversion support, so we advise
20060 A good place to start learning Subversion is the SVN Book
20064 \begin_layout Plain Layout
20065 \begin_inset CommandInset href
20067 target "http://svnbook.red-bean.com/"
20078 In the case of RCS you should read
20079 \begin_inset Quotes eld
20083 \begin_inset Quotes erd
20086 (a man file, read it with
20091 This file describes all the basic features of RCS.
20092 You should especially notice the comment about a RCS directory, and the
20093 notion of a master RCS file (the file ending in
20100 \begin_layout Standard
20101 Before you begin to use the version control features in \SpecialChar LyX
20103 familiar with RCS/CVS/SVN/GIT usage.
20104 The implementation in \SpecialChar LyX
20105 assumes a recent version of the GNU RCS or CVS/SVN
20106 package — no guarantees are made for older versions.
20107 Most of the log messages are not currently displayed after operations —
20108 you can check them in the Messages pane if you are unsure.
20109 Regular users of version control will appreciate the VC toolbar, which
20112 View\SpecialChar menuseparator
20113 Toolbars\SpecialChar menuseparator
20115 \begin_inset space ~
20123 \begin_layout Standard
20124 For introducing your own external commands consult
20125 \begin_inset Flex Code
20128 \begin_layout Plain Layout
20142 \begin_layout Standard
20143 It is strongly recommended to store documents in uncompressed format if
20144 using version control (uncheck
20146 Document\SpecialChar menuseparator
20149 if it is checked): Uncompressed LyX documents are text files and therefore
20150 for merging two different versions by version control systems.
20151 Compressed LyX documents are binary files, which cannot be merged by version
20155 \begin_layout Subsection
20156 RCS commands in \SpecialChar LyX
20160 \begin_layout Standard
20161 The following sections describe the RCS commands supported by \SpecialChar LyX
20163 You can find them in the
20165 File\SpecialChar menuseparator
20167 \begin_inset space ~
20174 was tested against RCS 5.7/5.8.
20177 \begin_layout Subsubsection
20183 \begin_layout Standard
20184 If your document is not under revision control, this is the only item shown
20186 And if it is under revision control, the
20190 item is not visible.
20194 \begin_layout Standard
20195 This command registers your document with RCS (unless you are under the
20196 directory managed by CVS)\SpecialChar endofsentence
20197 You are asked interactively to supply an initial
20198 description of the document.
20199 The document is now set in Read-Only mode and you have to
20202 \begin_inset space ~
20206 \begin_inset space ~
20210 \begin_inset space ~
20215 , before making any changes to it.
20216 A document under revision control has a
20217 \begin_inset Quotes eld
20220 [RCS:<version> <locker>]
20221 \begin_inset Quotes erd
20224 item tagged to the filename in the minibuffer.
20227 \begin_layout Standard
20228 RCS command that is run:
20231 \begin_layout LyX-Code
20234 ci -q -u -i -t-"<initial description>" <file-name>
20237 \begin_layout Standard
20242 to understand the switches.
20246 \begin_layout Subsubsection
20252 \begin_layout Standard
20253 When you are finished editing a file, you check in your changes.
20254 When you do this, you are asked for a description of the changes.
20255 This is stored in the history log.
20256 The version number is bumped, your changes are applied to the master RCS
20257 file, the document is unlocked and set to Read-Only mode.
20260 \begin_layout Itemize
20263 ci -q -u -m"<description>" <file-name>
20266 \begin_layout Subsubsection
20272 \begin_layout Standard
20273 By doing this you lock the document so that only you can edit it.
20274 This will also make the document Read-Write only for you.
20275 You will usually continue editing for a while and when you are finished
20276 you check in your changes.
20277 The status line is changed to reflect that you have locked the file.
20280 \begin_layout Itemize
20283 co -q -l <file-name>
20286 \begin_layout Subsubsection
20289 Revert To Repository Version
20292 \begin_layout Standard
20293 This will discard all changes made to the document since the last check
20295 You get a warning before changes are discarded.
20298 \begin_layout Itemize
20301 co -f -u<version> <file-name>
20304 \begin_layout Subsubsection
20310 \begin_layout Standard
20311 This will create a copy of the current document.
20312 Since RCS does not support copy operations natively, the version history
20313 is not preserved, and the copy is added as a new file.
20314 It requires a clean document without any changes since the last checkin.
20315 You are asked for a file name and a description of the copy operation.
20316 After that the copy is created, both locally and in the repository.
20317 If the parent directories of the copied and original document differ, all
20318 relative paths of included files of the copy are adjusted (like in
20320 File\SpecialChar menuseparator
20325 Finally, the copy is loaded instead of the original document.
20328 \begin_layout Labeling
20329 \labelwidthstring 00.00.0000
20331 \begin_inset space ~
20335 \begin_inset space ~
20339 \begin_inset Newline newline
20343 \begin_inset Flex Code
20346 \begin_layout Plain Layout
20349 \begin_inset Quotes qld
20353 \begin_inset Quotes qld
20362 \begin_inset Flex Code
20365 \begin_layout Plain Layout
20368 \begin_inset Quotes qld
20372 \begin_inset Quotes qld
20381 \begin_inset Newline newline
20385 \begin_inset Flex Code
20388 \begin_layout Plain Layout
20392 \begin_inset Quotes qld
20396 \begin_inset Quotes qld
20407 \begin_layout Subsubsection
20413 \begin_layout Standard
20414 This makes as if the last check in never happened.
20415 No changes are made to the document loaded into \SpecialChar LyX
20416 , but the last version
20417 is removed from the master RCS file.
20420 \begin_layout Itemize
20423 rcs -o<version> <file-name>
20426 \begin_layout Subsubsection
20432 \begin_layout Standard
20433 This shows the complete history of the RCS document.
20438 is shown in a browser.
20446 \begin_layout Subsubsection
20450 \begin_layout Standard
20452 supports RCS version number, author name, date and time of last commit.
20453 All those are extracted from
20455 rlog -r <file-name>
20459 \begin_inset CommandInset ref
20461 reference "subsec:VCS-Revision-Information"
20468 \begin_layout Subsection
20469 CVS commands in \SpecialChar LyX
20473 \begin_layout Standard
20474 A subset of CVS operations is supported by \SpecialChar LyX
20476 You can find the commands in the
20478 File\SpecialChar menuseparator
20480 \begin_inset space ~
20486 The version control system SVN is more powerful, so please use it instead
20487 of CVS if possible.
20490 \begin_layout Subsubsection
20496 \begin_layout Standard
20497 If you start from scratch with CVS you have to create your repository and
20498 checkout the working copy with external tools.
20499 If you're using a client-server setup you may need to login before doing
20500 the first repository checkout.
20503 \begin_layout Standard
20504 If your documents are under revision control and others are using the same
20505 repository problems arise when different changes to the same document at
20506 the same location happen.
20507 Standard CVS repositories don't operate with a file locking mechanism.
20508 This may be surprising, but conflicts only occur if people disagree on
20509 the proper content of the same part of a document.
20510 So, if co-workers are used to communicate regularly, these conflicts occur
20512 If they don't communicate they have a fundamental problem anyway.
20513 Nevertheless some people like to work with so called
20514 \begin_inset Quotes eld
20518 \begin_inset Quotes erd
20522 If they do so the working copy of all files is readonly when checked out
20523 first and the user starts editing after using a special command to make
20524 the working copy writable.
20525 When the changes are checked in the working copy returns to readonly state.
20526 With \SpecialChar LyX
20527 one has to edit the
20528 \begin_inset Flex Code
20531 \begin_layout Plain Layout
20537 file and add the line
20538 \begin_inset Flex Code
20541 \begin_layout Plain Layout
20547 to work with reserved checkouts.
20548 The benefit is the possibility to see who is using a writable copy of some
20550 It's not guaranteed only one user makes a copy writable.
20553 \begin_layout Standard
20555 tries to guess if you're using reserved or non-reserved checkouts.
20556 If your working copy is readonly or it is writable and an additional copy
20557 of your document exists in the CVS/Base sub-directory a reserved otherwise
20558 a non-reserved checkout is assumed.
20559 When a reserved checkout is detected you have to use
20560 \begin_inset Flex Noun
20563 \begin_layout Plain Layout
20569 to make your working copy writable if it's readonly.
20571 \begin_inset Flex Noun
20574 \begin_layout Plain Layout
20580 operation is possible and that makes your working copy readonly again after
20581 transferring your changes to the repository.
20584 \begin_layout Standard
20585 More information about CVS can be found here
20586 \begin_inset Flex URL
20589 \begin_layout Plain Layout
20591 http://www.nongnu.org/cvs
20597 \begin_inset Flex URL
20600 \begin_layout Plain Layout
20602 http://ximbiot.com/cvs
20610 \begin_layout Standard
20615 to understand the sub-commands and the switches mentioned below.
20618 \begin_layout Subsubsection
20624 \begin_layout Standard
20625 If your document is not under revision control, this is the only item shown
20627 And if it is under revision control, the
20631 item is not visible.
20635 \begin_layout Standard
20636 This command registers in CVS your document
20637 \begin_inset Flex Strong
20640 \begin_layout Plain Layout
20648 in the case you have already the documents directory under CVS control
20654 This means you have to create or checkout the archive by yourself using
20656 (In case you forget that step \SpecialChar LyX
20657 registers the document with RCS.)
20660 \begin_layout Standard
20661 Then you are asked interactively to supply an initial description of the
20663 Don't forget that registered file is not yet checked in.
20666 \begin_layout Standard
20667 CVS command that is run:
20669 cvs -q add -m"<entered message>" "<file-name>"
20672 \begin_layout Standard
20677 above and for all other CVS commands is an abbreviation for
20678 \begin_inset Quotes eld
20681 change the current working directory to file location and use the file name
20682 without path component as argument
20683 \begin_inset Quotes erd
20689 \begin_layout Subsubsection
20695 \begin_layout Standard
20696 When you are finished editing a file, you commit your changes.
20697 When you do this and you had changed the document, you are asked for a
20698 description of the changes.
20699 After that changes are written to the repository.
20700 In case you didn't change the document and a reserved checkout is detected
20701 the reservation made on
20702 \begin_inset Flex Noun
20705 \begin_layout Plain Layout
20714 \begin_layout Labeling
20715 \labelwidthstring 00.00.0000
20717 \begin_inset space ~
20721 \begin_inset space ~
20725 \begin_inset Newline newline
20729 \begin_inset Flex Code
20732 \begin_layout Plain Layout
20735 -q commit -m"<description>" "<file-name>"
20741 \begin_inset Newline newline
20745 \begin_inset Flex Code
20748 \begin_layout Plain Layout
20759 \begin_layout Subsubsection
20765 \begin_layout Standard
20766 When you are sharing a repository with others, you may have to incorporate
20767 their changes into your working copy.
20770 \begin_layout Standard
20773 cvs -q update "<file-name>"
20776 \begin_layout Standard
20777 If a readonly checkout is detected the working copy is made writable and
20781 \begin_layout Standard
20784 cvs -q edit "<file-name>"
20787 \begin_layout Subsubsection
20790 Revert To Repository Version
20793 \begin_layout Standard
20794 This will discard all changes made to the document since the last check
20796 You get a warning before changes are discarded.
20797 Firstly the file is deleted, secondly CVS update command is run.
20800 \begin_layout Standard
20803 cvs -q update "<file-name>"
20806 \begin_layout Standard
20807 If a reserved checkout is detected and the working copy has no changes only
20808 the reservation is undone.
20811 \begin_layout Standard
20814 cvs -q unedit "<file-name>"
20817 \begin_layout Subsubsection
20823 \begin_layout Standard
20824 This will create a copy of the current document.
20825 Since CVS does not support copy operations natively, the version history
20826 is not preserved, and the copy is added as a new file.
20827 It requires a clean document without any changes since the last checkin.
20828 You are asked for a file name and a description of the copy operation.
20829 After that the copy is created, both locally and in the repository.
20830 If the parent directories of the copied and original document differ, all
20831 relative paths of included files of the copy are adjusted (like in
20833 File\SpecialChar menuseparator
20838 Finally, the copy is loaded instead of the original document.
20841 \begin_layout Labeling
20842 \labelwidthstring 00.00.0000
20844 \begin_inset space ~
20848 \begin_inset space ~
20852 \begin_inset Newline newline
20856 \begin_inset Flex Code
20859 \begin_layout Plain Layout
20873 \begin_inset Flex Code
20876 \begin_layout Plain Layout
20890 \begin_inset Newline newline
20894 \begin_inset Flex Code
20897 \begin_layout Plain Layout
20913 \begin_layout Subsubsection
20919 \begin_layout Standard
20920 This will rename the current document.
20921 Since CVS does not support rename operations natively, the version history
20922 is not preserved, the renamed document is added as a new file, and the
20923 original document is deleted.
20924 It requires a clean document without any changes since the last checkin.
20925 You are asked for a file name and a description of the rename operation.
20926 After that the document is renamed, both locally and in the repository.
20927 If the parent directories of the new and old file names differ, all relative
20928 paths of included files are adjusted (like in
20930 File\SpecialChar menuseparator
20935 Finally, the document is reloaded using the new name.
20938 \begin_layout Labeling
20939 \labelwidthstring 00.00.0000
20941 \begin_inset space ~
20945 \begin_inset space ~
20949 \begin_inset Newline newline
20953 \begin_inset Flex Code
20956 \begin_layout Plain Layout
20970 \begin_inset Flex Code
20973 \begin_layout Plain Layout
20987 \begin_inset Newline newline
20991 \begin_inset Flex Code
20994 \begin_layout Plain Layout
21008 \begin_inset Newline newline
21012 \begin_inset Flex Code
21015 \begin_layout Plain Layout
21031 \begin_layout Subsubsection
21032 Update of the local directory checkout from repository
21035 \begin_layout Standard
21036 Once your documents gets more complex, containing sub-documents and pictures,
21038 \begin_inset Flex Code
21041 \begin_layout Plain Layout
21047 files and so on using version control becomes more complicated.
21049 supports updating the whole tree in which resides the document.
21050 This become especially useful once you cooperate with people which neither
21051 have detailed knowledge about CVS usage nor they have ambition to commit
21052 additional material to the repository.
21053 You have to organize the files structure so that all external files are
21054 in the same directory or subdirectories of the document.
21055 It's good practice anyway to store multipart documents in an extra directory.
21058 \begin_layout Standard
21060 \begin_inset Flex Code
21063 \begin_layout Plain Layout
21064 Update local directory from repository
21069 command updates the whole directory.
21070 If local changes are detected user is warned before update starts.
21071 In case of merge conflicts both versions of the conflicting document parts
21072 are placed in the final document.
21073 You have to review and correct the result of the merge.
21074 You'll find the conflicts enclosed in pairs of
21075 \begin_inset Flex Code
21078 \begin_layout Plain Layout
21085 \begin_inset Flex Code
21088 \begin_layout Plain Layout
21095 \begin_inset Flex Code
21098 \begin_layout Plain Layout
21105 The first part is your version as before the update operation with the
21106 document name prepended.
21107 The second one is the repository version with the version number after
21109 \begin_inset Flex Code
21112 \begin_layout Plain Layout
21121 \begin_layout Labeling
21122 \labelwidthstring 00.00.0000
21124 \begin_inset space ~
21128 \begin_inset space ~
21132 \begin_inset Newline newline
21136 \begin_inset Flex Code
21139 \begin_layout Plain Layout
21147 (Ask if changes are detected.)
21148 \begin_inset Newline newline
21152 \begin_inset Flex Code
21155 \begin_layout Plain Layout
21156 cd $path; cvs -q update
21166 \begin_layout Standard
21168 \begin_inset Flex Code
21171 \begin_layout Plain Layout
21177 stands for the path to the document.
21180 \begin_layout Subsubsection
21186 \begin_layout Standard
21187 This shows the complete history of the CVS document.
21190 cvs log "<file-name>"
21192 is shown in a browser.
21195 \begin_layout Subsubsection
21199 \begin_layout Standard
21201 supports CVS version number, author name, date and time of last commit.
21202 All those are extracted from
21204 cvs log -r <file-name>
21208 \begin_inset CommandInset ref
21210 reference "subsec:VCS-Revision-Information"
21217 \begin_layout Subsection
21218 SVN commands in \SpecialChar LyX
21222 \begin_layout Standard
21223 SVN is now partially supported by \SpecialChar LyX
21225 You can find the commands in the
21227 File\SpecialChar menuseparator
21229 \begin_inset space ~
21235 Please note that if you use password protected access to repository via
21236 ssh, you will be asked in terminal window.
21238 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21242 \begin_layout Plain Layout
21243 Most of the commands will work with 1.4 too, see
21244 \begin_inset CommandInset ref
21246 reference "subsec:SVN-Repo-Update"
21251 There seems to be currently unresolved permissions problem under SVN 1.8
21252 with reverting changes when file is locked.
21260 \begin_layout Subsubsection
21266 \begin_layout Standard
21267 If your document is not under revision control, this is the only item shown
21269 And if it is under revision control, the
21273 item is not visible.
21276 \begin_layout Standard
21277 This command registers in SVN your document ONLY in case you have already
21278 the documents directory under SVN control (in particular
21283 This means you have to checkout the archive by yourself.
21286 \begin_layout Standard
21287 Then you are asked interactively to supply an initial description of the
21289 Don't forget that registered file is not yet commited.
21292 \begin_layout Standard
21293 SVN command that is run:
21296 \begin_inset Quotes qld
21300 \begin_inset Quotes qld
21306 \begin_layout Standard
21311 to understand the switches.
21314 \begin_layout Subsubsection
21320 \begin_layout Standard
21321 When you are finished editing a file, you commit your changes.
21322 When you do this, you are asked for a description of the changes.
21323 After that changes are commited.
21326 \begin_layout Standard
21331 \begin_layout Plain Layout
21332 In case locking is not enabled.
21334 \begin_inset CommandInset ref
21336 reference "subsec:SVN-File-Locking"
21347 svn commit -q -m"<description>" <file-name>
21350 \begin_layout Subsubsection
21356 \begin_layout Standard
21357 Updates the changes of this file from the repository.
21358 Be sure you understand SVN merging and conflicts resolving before using
21359 this function, because all conflicts has to be resolved manually by you!
21362 \begin_layout Standard
21367 \begin_layout Plain Layout
21375 svn update --non-interactive
21376 \begin_inset Quotes qld
21380 \begin_inset Quotes qld
21386 \begin_layout Subsubsection
21389 Revert To Repository Version
21392 \begin_layout Standard
21393 This will discard all changes made to the document since the last check
21395 You get a warning before changes are discarded.
21398 \begin_layout Standard
21402 \begin_inset Quotes qld
21406 \begin_inset Quotes qld
21412 \begin_layout Subsubsection
21418 \begin_layout Standard
21419 This will create a copy of the current document including the version history.
21420 It requires a clean document without any changes since the last checkin.
21421 You are asked for a file name and a description of the copy operation.
21422 After that the copy is created, both locally and in the repository.
21423 If the parent directories of the copied and original document differ, all
21424 relative paths of included files of the copy are adjusted (like in
21426 File\SpecialChar menuseparator
21431 Finally, the copy is loaded instead of the original document.
21434 \begin_layout Labeling
21435 \labelwidthstring 00.00.0000
21437 \begin_inset space ~
21441 \begin_inset space ~
21445 \begin_inset Newline newline
21449 \begin_inset Flex Code
21452 \begin_layout Plain Layout
21456 \begin_inset Quotes qld
21460 \begin_inset Quotes qld
21464 \begin_inset Quotes qld
21468 \begin_inset Quotes qld
21477 \begin_inset Newline newline
21481 \begin_inset Flex Code
21484 \begin_layout Plain Layout
21493 \begin_layout Subsubsection
21499 \begin_layout Standard
21500 This will rename the current document including the version history.
21501 It requires a clean document without any changes since the last checkin.
21502 You are asked for a file name and a description of the rename operation.
21503 After that the document is renamed, both locally and in the repository.
21504 If the parent directories of the new and old file names differ, all relative
21505 paths of included files are adjusted (like in
21507 File\SpecialChar menuseparator
21512 Finally, the document is reloaded using the new name.
21515 \begin_layout Labeling
21516 \labelwidthstring 00.00.0000
21518 \begin_inset space ~
21522 \begin_inset space ~
21526 \begin_inset Newline newline
21530 \begin_inset Flex Code
21533 \begin_layout Plain Layout
21537 \begin_inset Quotes qld
21541 \begin_inset Quotes qld
21545 \begin_inset Quotes qld
21549 \begin_inset Quotes qld
21558 \begin_inset Newline newline
21562 \begin_inset Flex Code
21565 \begin_layout Plain Layout
21574 \begin_layout Subsubsection
21575 \begin_inset CommandInset label
21577 name "subsec:SVN-Repo-Update"
21581 Update of the local directory checkout from repository
21585 \begin_layout Plain Layout
21586 Note that this command will work only with subversion
21587 \begin_inset Formula $\geqq1.5$
21598 \begin_layout Standard
21599 All the commands above have one shortcoming – they deal with the current
21601 Once your document contains pictures, includes external
21602 \begin_inset Flex Code
21605 \begin_layout Plain Layout
21611 files and so on administration becomes more complicated.
21613 now supports updating the whole tree in which resides the document
21617 \begin_layout Plain Layout
21618 One need to organize the files structure so that all external files are
21619 in the same directory or subdirectories of the document.
21626 This become especially useful once you cooperate with people which neither
21627 know about subversion management nor they have ambition to commit additional
21628 material to the repository.
21632 \begin_layout Standard
21633 \begin_inset Flex Code
21636 \begin_layout Plain Layout
21637 Update local directory from repository
21642 command updates the whole directory and in case of merge conflicts local
21643 version of the files are left, so no unintended data loss occurs.
21644 If local changes are detected user is warned before update starts.
21647 \begin_layout Labeling
21648 \labelwidthstring 00.00.0000
21650 \begin_inset space ~
21654 \begin_inset space ~
21658 \begin_inset Newline newline
21662 \begin_inset Flex Code
21665 \begin_layout Plain Layout
21671 (Ask if changes are detected.)
21672 \begin_inset Newline newline
21676 \begin_inset Flex Code
21679 \begin_layout Plain Layout
21680 svn update --accept mine-full $path
21688 \begin_layout Standard
21690 \begin_inset Flex Code
21693 \begin_layout Plain Layout
21699 stands for the path to the document.
21702 \begin_layout Subsubsection
21708 \begin_layout Standard
21709 This shows the complete history of the SVN document.
21713 \begin_inset Quotes qld
21717 \begin_inset Quotes qld
21722 is shown in a browser.
21725 \begin_layout Subsubsection
21727 \begin_inset CommandInset label
21729 name "subsec:SVN-File-Locking"
21736 \begin_layout Standard
21737 The file exchange through various revision control systems brings the problem
21738 of merge conflicts in case two different users try to edit the same (parts
21740 When such a conflict happens it needs manual resolving and one reasonable
21741 alternative is to provide some kind of locking mechanism, which guarantees
21742 that only one user is allowed to edit file at the given time.
21745 \begin_layout Standard
21746 SVN has two such mechanisms to provide mutual exclusivity for file access
21747 – locks and automatic setting of write permissions (see sec.
21749 \begin_inset CommandInset ref
21751 reference "subsec:Automatical-Locking-Property"
21756 \begin_inset Flex Code
21759 \begin_layout Plain Layout
21769 \begin_layout Plain Layout
21770 \begin_inset Flex URL
21773 \begin_layout Plain Layout
21775 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21786 If this property is detected for a given document \SpecialChar LyX
21787 starts to use SVN locks
21788 for document editing automatically and the whole check-in/out mechanism
21789 switches to the same regimen as for RCS.
21790 This in particular means there are two different modes of file use in \SpecialChar LyX
21794 \begin_layout Itemize
21796 The loaded file is in the read-only mode.
21797 For editing on needs to check-out.
21802 consists of updating from the repository and gaining write lock.
21803 If the lock is not possible to obtain, we remain in unlocked state.
21806 \begin_layout Itemize
21808 The loaded file is in the
21809 \begin_inset Quotes els
21813 \begin_inset Quotes ers
21817 No other user is allowed to edit the file.
21822 consists of commiting changes and releasing write-lock.
21823 If no changes have been made to the document, no commit will be produced
21827 \begin_layout Plain Layout
21828 Don't be puzzled by the fact that you will be asked for commit message anyway.
21833 and only the write-lock will be released.
21836 \begin_layout Standard
21840 \begin_layout Labeling
21841 \labelwidthstring 00.00.0000
21844 svn commit -q -m"<description>" "<file-name>"
21845 \begin_inset Newline newline
21848 svn unlock "<file-name>"
21851 \begin_layout Labeling
21852 \labelwidthstring 00.00.0000
21855 svn update "<file-name>"
21856 \begin_inset Newline newline
21859 svn lock "<file-name>"
21862 \begin_layout Subsubsection
21865 \begin_inset CommandInset label
21867 name "subsec:Automatical-Locking-Property"
21873 Automatic Locking Property
21876 \begin_layout Standard
21877 The above mentioned automatic setting of write permissions of the .lyx file
21880 File\SpecialChar menuseparator
21882 \begin_inset space ~
21885 Control\SpecialChar menuseparator
21886 Use Locking Property
21889 This command is active only when the file is not locked on the svn server
21891 you need to check-out before proceeding).
21894 \begin_layout Labeling
21895 \labelwidthstring 00.00.0000
21897 \begin_inset space ~
21903 \begin_layout Labeling
21904 \labelwidthstring 00.00.0000
21907 svn propset svn:needs-lock ON "<file-name>"
21910 \begin_layout Labeling
21911 \labelwidthstring 00.00.0000
21914 svn propdel svn:needs-lock "<file-name>"
21917 \begin_layout Subsubsection
21918 \begin_inset CommandInset label
21920 name "subsec:VCS-Revision-Information"
21924 Revision Information in Documents
21927 \begin_layout Standard
21928 There are more possibilities how to activate revision information in our
21932 \begin_layout Itemize
21938 \begin_layout Itemize
21939 tree revision information (
21940 \begin_inset Flex Code
21943 \begin_layout Plain Layout
21950 The result is the output of the
21951 \begin_inset Flex Code
21954 \begin_layout Plain Layout
21960 command, the following table gives you an idea, how to read the results.
21963 \begin_layout Standard
21965 \begin_inset Tabular
21966 <lyxtabular version="3" rows="6" columns="2">
21967 <features tabularvalignment="middle">
21968 <column alignment="left" valignment="top">
21969 <column alignment="left" valignment="top">
21971 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21974 \begin_layout Plain Layout
21982 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21985 \begin_layout Plain Layout
21995 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21998 \begin_layout Plain Layout
22004 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22007 \begin_layout Plain Layout
22008 mixed revision working copy
22015 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
22018 \begin_layout Plain Layout
22024 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22027 \begin_layout Plain Layout
22028 modified working copy
22035 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
22038 \begin_layout Plain Layout
22044 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22047 \begin_layout Plain Layout
22048 switched working copy
22055 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
22058 \begin_layout Plain Layout
22064 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22067 \begin_layout Plain Layout
22068 partial working copy, from a sparse checkout
22075 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22078 \begin_layout Plain Layout
22084 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22087 \begin_layout Plain Layout
22088 mixed revision, modified, switched working copy
22101 \begin_layout Itemize
22102 file revision information.
22103 The result comes from parsing the output of
22104 \begin_inset Flex Code
22107 \begin_layout Plain Layout
22109 \begin_inset space ~
22113 \begin_inset space ~
22117 \begin_inset space ~
22126 Supported flags are:
22130 \begin_layout Itemize
22131 version number of the last commit (
22132 \begin_inset Flex Code
22135 \begin_layout Plain Layout
22144 \begin_layout Itemize
22145 author of the last commit (
22146 \begin_inset Flex Code
22149 \begin_layout Plain Layout
22158 \begin_layout Itemize
22159 date of the last commit (
22160 \begin_inset Flex Code
22163 \begin_layout Plain Layout
22172 \begin_layout Itemize
22173 time of the last commit (
22174 \begin_inset Flex Code
22177 \begin_layout Plain Layout
22187 \begin_layout Standard
22188 You can obtain this info via InsetInfo (e.g.
22190 \begin_inset Flex Code
22193 \begin_layout Plain Layout
22194 info-insert buffer vcs-date
22200 The information will be available only when you have the file stored under
22201 svn managment (i.e.
22203 \begin_inset Flex Code
22206 \begin_layout Plain Layout
22212 directory is available with your document).
22216 \begin_layout Itemize
22217 Another—a hacking one—possibility is to use svn keywords
22221 \begin_layout Plain Layout
22222 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22228 In short – you set file keywords property (e.g.
22231 svn propset svn:keywords 'Rev' file.lyx
22233 ) and then paste keyword \SpecialChar TeX
22238 \begin_layout Plain Layout
22239 This is an easy way how to ensure that \SpecialChar LyX
22240 won't break the line in the middle
22246 tag in your document (e.g.
22248 \begin_inset Flex Code
22251 \begin_layout Plain Layout
22258 This way svn client will automatically substitute revision number (e.g.
22260 \begin_inset Flex Code
22263 \begin_layout Plain Layout
22269 ) after each update and commit.
22270 There are more problems with this approach.
22271 Firstly, the '$' character is used in \SpecialChar TeX
22272 world for math equations, so any
22273 occurence of math formula
22274 \begin_inset Formula $Rev$
22278 \begin_inset Formula $Rev:59$
22281 in your \SpecialChar LyX
22283 Similarly for other keywords like Id, Date, Author, etc.
22284 Secondly svn output is dependent on your locales, so its very easy that
22285 svn would produce some problematic strings once Date is used.
22286 Thirdly you get the whole 'Rev: 59' string in your document instead of
22288 Until subversion implements user's custom keywords it will be hard to use
22289 this approach reliably or let \SpecialChar LyX
22290 to support it directly.
22293 \begin_layout Subsection
22294 SVN and Windows Environment
22297 \begin_layout Quote
22298 My inclination is to say that if the user cannot figure out the command
22299 line operations on their own fairly quickly, they would be well advised
22300 to use TortoiseSVN.
22306 \begin_layout Subsubsection
22310 \begin_layout Standard
22311 In addition to installing \SpecialChar LyX
22312 , and having access to a Subversion repository,
22313 the user will need to install the Subversion client program.
22314 A Windows installer for the client program is available from
22315 \begin_inset CommandInset href
22318 target "http://www.collab.net/nonav/downloads/subversion/"
22324 The user may also want to install
22325 \begin_inset CommandInset href
22328 target "http://tortoisesvn.tigris.org/"
22333 , which integrates Subversion operations into the context (rightclick) menu
22334 of Windows Explorer.
22335 Operations done outside \SpecialChar LyX
22336 will typically be more convenient using the Explorer
22338 Note that TortoiseSVN is not a replacement for the client program, which
22339 is what \SpecialChar LyX
22343 \begin_layout Subsubsection
22344 Bringing a document under Subversion control
22347 \begin_layout Standard
22348 Before a \SpecialChar LyX
22349 document can be brought under version control in Subversion, its
22350 parent directory needs to be under version control.
22351 If the document is being added to a project already in the repository,
22352 this is accomplished by checking the project out to the directory where
22353 the new document will be placed.
22354 If the project itself is not yet under version control (for instance, if
22355 this document starts a new project), the directory must be imported into
22357 This is done outside \SpecialChar LyX
22359 Both import and checkout are easily accomplished from the Explorer context
22360 menu using TortoiseSVN, or alternatively can be done using the command
22361 line client at a DOS prompt.
22362 The procedure for importing the project using TortoiseSVN is described
22363 below, assuming an existing repository and a new project being started
22371 For information on using the Subversion client program, run
22378 \begin_layout Enumerate
22385 in Windows Explorer, right click it, and select
22387 TortoiseSVN\SpecialChar menuseparator
22391 If necessary, adjust the URL for the repository, then click OK.
22394 \begin_layout Enumerate
22395 Right click the level of the repository under which you want to place the
22396 new project folder (typically the top level) and click
22400 Supply a name for the project folder and click OK.
22401 Add a message for the log file if desired, then click OK again.
22402 The new project folder should appear in the repository.
22403 Finally, click OK again to exit the repository browser.
22406 \begin_layout Enumerate
22407 Once again right click
22413 , this time selecting SVN Checkout\SpecialChar ldots
22414 Select the URL of the project folder
22415 you just created in the repository, and set the checkout directory to
22423 You will be warned about a non-empty folder; click OK to proceed.
22424 You should now have a
22435 \begin_layout Enumerate
22436 Create or open your document in \SpecialChar LyX
22439 File\SpecialChar menuseparator
22441 \begin_inset space ~
22444 Control\SpecialChar menuseparator
22448 Add a log message and click OK to commit the document to version control.
22451 \begin_layout Standard
22452 From this point onward, you should have full functionality in the
22454 File\SpecialChar menuseparator
22456 \begin_inset space ~
22462 You also have the option of checking the document in and out, viewing its
22464 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22465 client program from a command prompt.
22468 \begin_layout Subsubsection
22469 SSH tunnel used with SVN under Windows
22472 \begin_layout Standard
22473 Compared with Linux setting up an svn client to communicate over ssh under
22474 Windows is a rather troublesome task.
22475 We will at least offer some hints how to setup the client side but prior
22476 knowledge about ssh and the Windows command line is needed, also be prepared
22477 for a great deal of frustration\SpecialChar ldots
22481 \begin_layout Enumerate
22482 Get an svn client for windows, as described in the previous sections.
22483 When it is a fresh install run some svn command (e.g.
22485 \begin_inset Flex Code
22488 \begin_layout Plain Layout
22494 ) to create config files, which you will need to change later on.
22497 \begin_layout Enumerate
22498 Choose an ssh client for Windows.
22499 There are several possibilities, we will use the one from Putty tools
22503 \begin_layout Plain Layout
22504 \begin_inset Flex URL
22507 \begin_layout Plain Layout
22509 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22520 You will need to set the connection up so that the client doesn't ask for
22521 any password from you.
22522 To keep things easy we will use only keys without any additional password
22527 \begin_layout Enumerate
22529 \begin_inset Flex Code
22532 \begin_layout Plain Layout
22539 Save your private .ppk key file and put the public one on the server side.
22540 If the SVN server runs on Linux, note that the format of the public key
22541 is not compatible with Linux openssh and you will need to direcly copy-paste
22543 \begin_inset Quotes eld
22548 Public key for pasting into OpenSSH authorized_keys file
22551 \begin_inset Quotes erd
22554 edit field into the server's
22555 \begin_inset Flex Code
22558 \begin_layout Plain Layout
22559 ~/.ssh/authorized_keys
22565 \begin_inset Flex Code
22568 \begin_layout Plain Layout
22577 \begin_layout Enumerate
22579 \begin_inset Flex Code
22582 \begin_layout Plain Layout
22589 In the SVN config file
22593 \begin_layout Plain Layout
22594 Exact path depends on Windows version, usually somewhere around
22595 \begin_inset Flex Code
22598 \begin_layout Plain Layout
22601 Documents and Settings
22615 \begin_inset Flex Code
22618 \begin_layout Plain Layout
22633 , section [tunnels], setup ssh command, e.g.
22635 \begin_inset Flex Code
22638 \begin_layout Plain Layout
22639 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22648 \begin_layout Plain Layout
22649 It will usually take a lot of time to get exact command right and it depends
22651 For example do not have some remote server saved as a default session in
22653 If things fail, try to connect via plink without SVN first.
22662 \begin_layout Enumerate
22663 Checkout the SVN archive, e.
22664 \begin_inset space \thinspace{}
22668 \begin_inset Newline newline
22672 \begin_inset Flex Code
22675 \begin_layout Plain Layout
22676 svn co svn+ssh://user@server/repository_path
22684 \begin_layout Subsubsection
22685 End-of-Line Conversions
22688 \begin_layout Standard
22689 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22691 use different line endings inside the .lyx files.
22692 This is not a problem as far as \SpecialChar LyX
22693 functionality is concerned, but the commit
22694 diffs will be huge and merge-conflicts prone.
22695 Fortunately SVN itself knows
22699 \begin_layout Plain Layout
22700 \begin_inset Flex URL
22703 \begin_layout Plain Layout
22705 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22715 how to deal with CR/LF problems when switching .lyx files to the
22716 \begin_inset Flex Code
22719 \begin_layout Plain Layout
22729 \begin_layout Plain Layout
22731 \begin_inset Flex Code
22734 \begin_layout Plain Layout
22735 svn propset svn:eol-style native FILE_NAME
22748 \begin_layout Subsection
22749 GIT commands in \SpecialChar LyX
22753 \begin_layout Standard
22754 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22756 You can find the commands in the
22758 File\SpecialChar menuseparator
22760 \begin_inset space ~
22766 Please note that if you use password protected access to repository via
22767 ssh, you will be asked in terminal window.
22769 was tested against GIT 1.7.
22773 \begin_layout Plain Layout
22774 Windows users please note that you need to ensure that git is on the path.
22775 This can be set from within \SpecialChar LyX
22778 Tools\SpecialChar menuseparator
22779 Preferences\SpecialChar menuseparator
22780 Paths\SpecialChar menuseparator
22791 \begin_layout Standard
22792 One big difference of GIT and the other supported version control systems
22793 is the distributed nature of GIT: With traditional version control systems
22794 there is one central server which hosts the repository.
22795 Users commit their changes to the server, and get updates made by other
22797 With GIT, users commit to a local repository.
22798 The local repository can be synchronized with one or more remote repositories
22800 \begin_inset Flex Code
22803 \begin_layout Plain Layout
22810 \begin_inset Flex Code
22813 \begin_layout Plain Layout
22821 does not interact in any way with remote GIT repositories.
22822 It works exclusively with the local repository in a very similar way as
22823 with a central CVS or SVN repository.
22824 If you use remote GIT repositories you need to do the
22825 \begin_inset Flex Code
22828 \begin_layout Plain Layout
22835 \begin_inset Flex Code
22838 \begin_layout Plain Layout
22844 operations with your favourite GIT client.
22847 \begin_layout Subsubsection
22853 \begin_layout Standard
22854 If your document is not under revision control, this is the only item shown
22856 And if it is under revision control, the
22860 item is not visible.
22863 \begin_layout Standard
22864 This command registers in GIT your document ONLY in case you have already
22865 the documents directory under GIT control (in particular
22870 This means you have to checkout the archive by yourself.
22873 \begin_layout Standard
22874 Then you are asked interactively to supply an initial description of the
22876 Don't forget that registered file is not yet committed.
22879 \begin_layout Standard
22880 GIT command that is run:
22883 \begin_inset Quotes qld
22887 \begin_inset Quotes qld
22893 \begin_layout Standard
22898 to understand the switches.
22901 \begin_layout Subsubsection
22907 \begin_layout Standard
22908 When you are finished editing a file, you commit your changes.
22909 When you do this, you are asked for a description of the changes.
22910 After that changes are committed.
22913 \begin_layout Standard
22916 git commit -q -m"<description>" <file-name>
22919 \begin_layout Subsubsection
22922 Revert To Repository Version
22925 \begin_layout Standard
22926 This will discard all changes made to the document since the last check
22928 You get a warning before changes are discarded.
22931 \begin_layout Standard
22935 \begin_inset Quotes qld
22939 \begin_inset Quotes qld
22945 \begin_layout Subsubsection
22951 \begin_layout Standard
22952 This will rename the current document including the version history.
22953 It requires a clean document without any changes since the last checkin.
22954 You are asked for a file name and a description of the rename operation.
22955 After that the document is renamed, both locally and in the repository.
22956 If the parent directories of the new and old file names differ, all relative
22957 paths of included files are adjusted (like in
22959 File\SpecialChar menuseparator
22964 Finally, the document is reloaded using the new name.
22967 \begin_layout Labeling
22968 \labelwidthstring 00.00.0000
22970 \begin_inset space ~
22974 \begin_inset space ~
22978 \begin_inset Newline newline
22982 \begin_inset Flex Code
22985 \begin_layout Plain Layout
22989 \begin_inset Quotes qld
22993 \begin_inset Quotes qld
22997 \begin_inset Quotes qld
23001 \begin_inset Quotes qld
23010 \begin_inset Newline newline
23014 \begin_inset Flex Code
23017 \begin_layout Plain Layout
23026 \begin_layout Subsubsection
23032 \begin_layout Standard
23033 This shows the complete history of the GIT document.
23037 \begin_inset Quotes qld
23041 \begin_inset Quotes qld
23046 is shown in a browser.
23049 \begin_layout Subsubsection
23053 \begin_layout Standard
23055 supports GIT hash number of the last commit to the file, author name, date
23056 and time of last commit.
23057 All those are extracted from
23059 git log -n 1 --pretty=format:%H%n%an%n%ai
23062 Tree version information is obtained via
23064 git describe --abbrev --dirty --long
23068 \begin_inset CommandInset ref
23070 reference "subsec:VCS-Revision-Information"
23077 \begin_layout Subsection
23081 \begin_layout Standard
23082 With the recent addition of the
23083 \begin_inset Flex Code
23086 \begin_layout Plain Layout
23092 function \SpecialChar LyX
23093 power users are allowed to create their own commands for revision
23097 \begin_layout Standard
23098 As an example you can see how two TortoiseSVN commands could be integrated
23102 \begin_layout Description
23104 \begin_inset Flex Code
23107 \begin_layout Plain Layout
23108 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23116 \begin_layout Description
23118 \begin_inset Flex Code
23121 \begin_layout Plain Layout
23122 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23130 \begin_layout Subsection
23131 Version control and Document comparison
23134 \begin_layout Standard
23135 One of the typical uses of version control is to inspect the changes between
23136 revisions, usually by creating
23137 \begin_inset Flex Code
23140 \begin_layout Plain Layout
23147 While this is useful for plain text files, it is much less useful in the
23148 case of \SpecialChar LyX
23149 files, which have more a complicated structure.
23150 Hence we provide binding to the Document comparison feature.
23151 There are two ways of calling this feature – either by direct call of
23152 \begin_inset Flex Code
23155 \begin_layout Plain Layout
23162 function (for details see \SpecialChar LyX
23163 functions manual) or by the toolbar icon
23176 One can either compare two chosen revisions of the document or he can simply
23177 compare the current version of edited text with older revisions (where
23179 \begin_inset Flex Noun
23182 \begin_layout Plain Layout
23188 ' revisions back means comparison of the edited file with last commited
23193 \begin_layout Standard
23194 This feature is supported for SVN and RCS though due to the more complicated
23195 versioning scheme of RCS there is a constraint – when addressing the revisions
23196 in dialog, numbers always point to the last number in RCS revision number,
23199 We don't currently support GIT addressing of revisions, one can just compare
23200 edited document with its revision X steps backs, where X is addressed as
23202 \begin_inset Flex Code
23205 \begin_layout Plain Layout
23214 \begin_layout Section
23215 Literate Programming
23218 \begin_layout Standard
23223 (kayvan@sylvan.com)
23227 original documentation written by
23229 Edmar Wienskoski Jr.
23232 (edmar-w-jr@technologist.com)
23235 \begin_layout Subsection
23239 \begin_layout Standard
23240 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23242 programming, where it is assumed that you are familiar with this programming
23243 technique, and know what
23244 \begin_inset Quotes eld
23248 \begin_inset Quotes erd
23252 \begin_inset Quotes eld
23256 \begin_inset Quotes erd
23260 If that is not the case, please follow the web links provided in the following
23262 There is a lot of good documentation out there covering old development
23263 history to the latest tools tips.
23266 \begin_layout Standard
23267 It is also assumed that you are familiar with \SpecialChar LyX
23268 itself to a point that you
23269 are comfortable changing your \SpecialChar LyX
23270 preferences, and X resources file.
23271 If that is not the case please refer to other \SpecialChar LyX
23272 documentation to cover your
23276 \begin_layout Subsection
23277 Literate Programming
23280 \begin_layout Standard
23281 From the Literate Programming FAQ:
23284 \begin_layout Quotation
23285 Literate programming is the combination of documentation and source together
23286 in a fashion suited for reading by human beings.
23287 In fact, literate programs should be enjoyable reading, even inviting!
23288 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23289 and documentation in a single file.
23290 Literate programming tools then parse the file to produce either readable
23291 documentation or compilable source.
23292 The WEB style of literate programming was created by D.
23293 \begin_inset space \thinspace{}
23297 Knuth during the development of his \SpecialChar TeX
23298 typesetting software.
23302 \begin_layout Standard
23303 Another excerpt says:
23306 \begin_layout Quotation
23309 How is literate programming different from verbose commenting?
23312 \begin_layout Quotation
23313 There are three distinguishing characteristics.
23314 In order of importance, they are:
23318 \begin_layout Itemize
23319 flexible order of elaboration
23322 \begin_layout Itemize
23323 automatic support for browsing
23326 \begin_layout Itemize
23327 typeset documentation, especially diagrams and mathematics
23331 \begin_layout Standard
23332 Now that I sparked your curiosity, take a look in the references.
23335 \begin_layout Subsubsection
23339 \begin_layout Standard
23340 The complete Literate Programming FAQ can be found at:
23343 \begin_layout Quote
23344 Literate Programming FAQ
23345 \begin_inset Flex URL
23348 \begin_layout Plain Layout
23350 http://www.literateprogramming.com/lpfaq.pdf
23358 \begin_layout Standard
23359 The FAQ lists 23 (twenty three!) different literate programming tools.
23360 Where some are specialized or
23361 \begin_inset Quotes eld
23365 \begin_inset Quotes erd
23368 for particular programming languages, while other have general scope.
23373 for my own use for several reasons:
23376 \begin_layout Itemize
23377 It can generate the documentation either in \SpecialChar LaTeX
23381 \begin_layout Itemize
23382 It has a open architecture, i.
23383 \begin_inset space \thinspace{}
23387 \begin_inset space \space{}
23390 it is easy to plug in new filters
23394 \begin_layout Plain Layout
23399 are programs that read a given data stream and output a manipulated data
23401 That way, a WEB file (consisting of literate code) can be turned into a
23402 file consisting only of C program code or \SpecialChar LaTeX
23408 and to perform special processing that you may need.
23412 \begin_layout Itemize
23413 There is a good selection of filters available already (the HTML is one
23417 \begin_layout Itemize
23421 \begin_layout Standard
23422 The Noweb web page can be found at:
23425 \begin_layout Quote
23427 \begin_inset Flex URL
23430 \begin_layout Plain Layout
23432 https://www.cs.tufts.edu/~nr/noweb/
23440 \begin_layout Standard
23441 Starting from there you can reach many other interesting links and even
23442 some literate program examples.
23445 \begin_layout Subsection
23447 and Literate Programming with Noweb
23450 \begin_layout Standard
23451 The \SpecialChar LyX
23452 support for Literate Programming is provided by using the generic \SpecialChar LyX
23454 converters mechanism.
23455 This support is provided in a
23456 \begin_inset Quotes eld
23460 \begin_inset Quotes erd
23464 \begin_inset space \thinspace{}
23468 \begin_inset space \space{}
23471 you will be able to use this new \SpecialChar LyX
23472 feature with some other literate programming
23473 tool of your choice by just changing your \SpecialChar LyX
23477 \begin_layout Subsubsection
23478 Generating documents and code (weaving and tangling)
23481 \begin_layout Paragraph
23482 Using the noweb module
23485 \begin_layout Standard
23486 If you have installed Noweb and \SpecialChar LyX
23487 successfully, whenever you open a new document,
23488 after you have chosen its document class, use the
23490 Document\SpecialChar menuseparator
23494 \begin_inset Quotes eld
23498 \begin_inset Quotes erd
23502 If Noweb is correctly installed, when you click on the
23503 \begin_inset Quotes eld
23507 \begin_inset Quotes erd
23510 link, you will see the
23511 \begin_inset Quotes eld
23515 \begin_inset Quotes erd
23518 module in the available list and you can add it to your document.
23521 \begin_layout Paragraph
23525 \begin_layout Standard
23527 enables you to write code with a custom inset named
23528 \begin_inset Flex Noun
23531 \begin_layout Plain Layout
23538 Noweb delimits chunks like this:
23541 \begin_layout LyX-Code
23545 \begin_layout LyX-Code
23549 \begin_layout LyX-Code
23553 \begin_layout LyX-Code
23557 \begin_layout LyX-Code
23561 \begin_layout Standard
23562 The problem is that whatever is written in between the << and the
23566 must be taken literally, i.
23567 \begin_inset space \thinspace{}
23571 \begin_inset space \space{}
23575 should be prevented from making any special interpretation of what has
23577 This is also handled by
23578 \begin_inset Flex Noun
23581 \begin_layout Plain Layout
23587 , that works like a normal text inset but has a free spacing capability.
23590 \begin_layout Standard
23591 As a special note, you can also use the
23592 \begin_inset Quotes eld
23596 \begin_inset Quotes erd
23599 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23603 \begin_layout LyX-Code
23607 \begin_layout LyX-Code
23608 def some_function(args):
23611 \begin_layout LyX-Code
23612 "This is the doc string for this function."
23615 \begin_layout LyX-Code
23616 print "My args: ", args
23619 \begin_layout LyX-Code
23620 @ %def some_function
23623 \begin_layout Standard
23624 For an example of this usage and the resulting cross-reference output, look
23625 at the Literate python program in
23627 LIBDIR/examples/listerrors.lyx
23629 which should make this all clear.
23632 \begin_layout Paragraph
23633 Generating the documentation
23636 \begin_layout Standard
23637 At this point you already have a new document file with a proper document
23638 class, and with some code and text on it.
23639 How do I print it? The answer is simple, you select
23641 View\SpecialChar menuseparator
23645 Just like you would do for a plain document.
23646 No special procedure is required.
23649 \begin_layout Standard
23650 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23654 \begin_layout Enumerate
23657 Update\SpecialChar menuseparator
23660 menu option is chosen, a \SpecialChar LaTeX
23666 \begin_layout Standard
23667 If the document is of any literate class the generated file will be named
23668 with an extension name defined by the
23669 \begin_inset Quotes eld
23673 \begin_inset Quotes erd
23676 format (defined in the Preferences panel), otherwise the file will have
23685 \begin_layout Enumerate
23686 Note that the only difference so far is in the name of the file, no special
23687 processing is required by \SpecialChar LyX
23689 Given that you formatted the code using the
23690 \begin_inset Flex Noun
23693 \begin_layout Plain Layout
23699 inset that, by itself, takes care of the business.
23702 \begin_layout Enumerate
23703 If the document is of any literate class \SpecialChar LyX
23704 will then use the internal \SpecialChar LyX
23706 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23711 \begin_layout Plain Layout
23712 The converters are defined in the
23714 Tools\SpecialChar menuseparator
23718 \begin_inset Quotes eld
23722 \begin_inset Quotes erd
23734 manual for general information about converters.
23739 to generate the \SpecialChar LaTeX
23744 \begin_layout Standard
23745 Otherwise it will just skip this step.
23749 \begin_layout Enumerate
23750 Finally, \SpecialChar LaTeX
23751 is invoked and the regular post processing continues as in a plain
23755 \begin_layout Standard
23756 Independence from a particular
23757 \begin_inset Quotes eld
23761 \begin_inset Quotes erd
23764 is easily achieved by changing the commands that are run by the various
23768 \begin_layout Paragraph
23769 Generating the code
23772 \begin_layout Standard
23773 When the build menu option is chosen or the corresponding button in the
23774 toolbar is pressed, a \SpecialChar LaTeX
23775 file is generated just like step 1 above.
23776 Next, \SpecialChar LyX
23782 This converter needs to be defined by the user and is not installed by
23783 default, though the Program format is.
23784 This converter (like any other converter) will have two parts:
23787 \begin_layout Enumerate
23788 The converter program itself.
23789 This program performs the conversion from the one format to the other (in
23790 this case, from the Noweb format to the Program pseudo-format).
23793 \begin_layout Enumerate
23794 The error log parser.
23795 This is a program whose sole purpose is to rewrite error messages in a
23796 format that \SpecialChar LyX
23798 This makes it possible for \SpecialChar LyX
23799 to place error boxes in the right places in
23803 \begin_layout Standard
23804 The first part, the
23805 \begin_inset Quotes eld
23809 \begin_inset Quotes erd
23812 setting, should be set to
23815 \begin_layout LyX-Code
23823 \begin_layout Standard
23824 This basically means that \SpecialChar LyX
23826 \begin_inset Quotes eld
23830 \begin_inset Quotes erd
23833 (a program or script) with the name of the Noweb file (normally a file
23834 in the \SpecialChar LyX
23835 temp directory) and the directory path of the original \SpecialChar LyX
23840 \begin_layout Standard
23841 This is an implementation of
23842 \begin_inset Quotes eld
23846 \begin_inset Quotes erd
23849 that you can place in a directory on your path:
23852 \begin_layout LyX-Code
23858 \begin_layout LyX-Code
23864 \begin_layout LyX-Code
23867 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23870 \begin_layout Standard
23871 The next part of the converter setting is the
23872 \begin_inset Quotes eld
23876 \begin_inset Quotes erd
23879 which is to be set to
23882 \begin_layout LyX-Code
23885 parselog=$$s/scripts/listerrors
23888 \begin_layout Standard
23889 This will run any errors that are generated by the
23890 \begin_inset Quotes eld
23894 \begin_inset Quotes erd
23897 process through the
23898 \begin_inset Quotes eld
23902 \begin_inset Quotes erd
23908 \begin_layout Standard
23909 The build will normally take place in \SpecialChar LyX
23910 's temporary directory, so the files
23911 produced by the conversion will be in that directory.
23913 will copy out what it regards as the `main' file, but the
23917 conversion may produce several files, and so most of these would then be
23918 deleted when \SpecialChar LyX
23920 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23921 the build-script chunk can place the generated files in that location.
23924 \begin_layout Paragraph
23925 Build instructions in the document
23928 \begin_layout Standard
23929 The last piece of the integration between \SpecialChar LyX
23931 \begin_inset Quotes eld
23935 \begin_inset Quotes erd
23939 Generally, the instructions for building your program should be embedded
23940 in a chunk of its own.
23942 \begin_inset Quotes eld
23946 \begin_inset Quotes erd
23949 above uses the notangle command to look for this chunk (called
23950 \begin_inset Quotes eld
23954 \begin_inset Quotes erd
23957 ) and runs its contents through
23958 \begin_inset Quotes eld
23962 \begin_inset Quotes erd
23968 \begin_layout Standard
23969 Typically, such a chunk would look something like this:
23972 \begin_layout LyX-Code
23976 \begin_layout LyX-Code
23978 \begin_inset Newline newline
23981 if [ -z "${NOWEB_SOURCE}" ]
23982 \begin_inset Newline newline
23988 \begin_layout LyX-Code
23989 NOWEB_SOURCE=myfile.nw
23990 \begin_inset Newline newline
23994 \begin_inset Newline newline
23998 code to extract files ...
23999 use NOWEB_OUTPUT_DIR here ...]
24000 \begin_inset Newline newline
24004 code to compile files ...]
24005 \begin_inset Newline newline
24011 \begin_layout Standard
24014 LIBDIR/examples/listerrors.lyx
24018 LIBDIR/examples/Literate.lyx
24020 which implement two versions of the
24021 \begin_inset Quotes eld
24025 \begin_inset Quotes erd
24028 program for some illustrations of how all of these pieces go together or
24031 LIBDIR/examples/noweb2lyx.lyx.
24034 Interestingly, these three files show off the language-indepence of the
24036 literate programming support since they are written in Python, C and Perl
24040 \begin_layout Subsubsection
24041 Configuring \SpecialChar LyX
24045 \begin_layout Standard
24046 All the Literate Programming support is configured by the
24048 Tools\SpecialChar menuseparator
24052 \begin_inset Quotes eld
24056 \begin_inset Quotes erd
24060 The important parts are:
24063 \begin_layout Description
24065 \begin_inset space ~
24069 \begin_inset Quotes eld
24073 \begin_inset Quotes erd
24077 \begin_inset space ~
24080 format Set up via the File Formats tab, this is where the Noweb-specific
24090 , the file extension is set to
24095 This tells \SpecialChar LyX
24096 to create a file with a
24100 extension in the first step of the conversion process.
24103 \begin_layout Description
24105 \begin_inset space ~
24113 \begin_inset space ~
24116 format This is an empty format whose sole purpose is to be the endpoint
24117 of a conversion (which then allows us to set up a converter for it).
24120 \begin_layout Description
24130 This converter performs the
24131 \begin_inset Quotes eld
24135 \begin_inset Quotes erd
24138 of the literate document.
24139 For Noweb, it is set to
24140 \begin_inset Quotes eld
24145 noweave -delay -index $$i > $$o
24148 \begin_inset Quotes erd
24154 \begin_layout Description
24164 \begin_inset Quotes eld
24168 \begin_inset Quotes erd
24172 As stated above, the Converter is set to
24173 \begin_inset Quotes eld
24181 \begin_inset Quotes erd
24184 , with Flags set to
24185 \begin_inset Newline newline
24189 \begin_inset Quotes eld
24194 parselog=$$s/scripts/listerrors
24197 \begin_inset Quotes erd
24203 \begin_layout Subsubsection
24207 \begin_layout Standard
24208 There is also a new function implemented in the \SpecialChar LyX
24210 \begin_inset Quotes eld
24213 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24217 \begin_layout Standard
24218 When debugging code with ddd/gdb, it is possible to invoke a text editor
24219 at the current execution position with a single key stroke.
24220 The default ddd configuration for that is shift-ctrl-V.
24221 It happens that you can define the editor command line invocation in ddd
24224 Edit\SpecialChar menuseparator
24225 Preferences\SpecialChar menuseparator
24228 dialog and changing the "Edit Sources" entry.
24231 \begin_layout Standard
24232 I take advantage of the newly created \SpecialChar LyX
24233 server function and this ddd feature,
24235 \begin_inset Quotes eld
24239 \begin_inset Quotes erd
24245 \begin_layout LyX-Code
24246 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24249 \begin_layout Standard
24250 With this, whenever you are using ddd and find a point in the program that
24251 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24252 ddd will forward this information to \SpecialChar LyX
24253 through the \SpecialChar LyX
24254 server and then the
24256 window will show the same file with the cursor at the same position ddd
24258 No more guessing or long scrolling to locate a point in the program back
24262 \begin_layout Standard
24263 Note however that you must enable the \SpecialChar LyX
24264 server to get this feature working
24265 (it is disabled by default).
24267 \begin_inset space ~
24271 \begin_inset CommandInset ref
24273 reference "sec:Starting-the-Server"
24277 explains how to do that.
24280 \begin_layout Subsubsection
24284 \begin_layout Standard
24285 There are six new buttons that can be added to your \SpecialChar LyX
24287 Four of these buttons are short cuts to layout styles:
24305 , one for the custom inset
24310 The last one is a short cut to the
24311 \begin_inset Quotes eld
24315 \begin_inset Quotes erd
24322 \begin_layout Standard
24324 has a range of buttons that are available for tool bar customization.
24325 In my toolbar I like to combine the six short cuts above with two more:
24330 \SpecialChar menuseparator
24335 \SpecialChar menuseparator
24342 Document\SpecialChar menuseparator
24343 View\SpecialChar menuseparator
24347 Here is how it looks like:
24350 \begin_layout LyX-Code
24354 \begin_layout LyX-Code
24358 \begin_layout LyX-Code
24359 Icon "layout Standard"
24362 \begin_layout LyX-Code
24363 Icon "layout Section"
24366 \begin_layout LyX-Code
24367 Icon "layout \SpecialChar LaTeX
24371 \begin_layout LyX-Code
24372 Icon "layout \SpecialChar LyX
24376 \begin_layout LyX-Code
24377 Icon "flex.insert Chunk"
24380 \begin_layout LyX-Code
24384 \begin_layout LyX-Code
24388 \begin_layout LyX-Code
24389 Icon "buffer-typeset"
24392 \begin_layout LyX-Code
24393 Icon "build-program"
24396 \begin_layout LyX-Code
24400 \begin_layout LyX-Code
24404 \begin_layout LyX-Code
24408 \begin_layout LyX-Code
24412 \begin_layout LyX-Code
24416 \begin_layout Subsubsection
24417 Colors customization
24420 \begin_layout Standard
24421 There are a number of colors in \SpecialChar LyX
24422 that can be customized in
24427 One of the things that bothers people is the \SpecialChar LaTeX
24429 The default color is red, since the chunks uses \SpecialChar LaTeX
24430 font, and there is a lot
24431 of chunks in literate documents, you may get tired of seeing everything
24433 You can change it by going to the tabs
24442 \begin_layout Standard
24443 The next thing is the visible presence of the newline character in the screen.
24444 You can choose the color of this particular character and make it blend
24446 I recommend you choosing a color that is close to the background but not
24447 equal, that way you still can see it is there, but it is not bothering
24451 \begin_layout Subsection
24456 \begin_layout Standard
24465 is documented in the
24469 example file and in the Sweave manual (menu
24471 Help\SpecialChar menuseparator
24477 \begin_layout Chapter
24481 \begin_layout Standard
24482 You can do everything with \SpecialChar LyX
24483 that you can do with \SpecialChar LaTeX
24485 However, \SpecialChar LyX
24486 cannot support every \SpecialChar LaTeX
24488 But you can always use \SpecialChar TeX
24490 This chapter shows you some more special things you might want to use.
24491 For other special things you can do with figures, tables, floats, boxes
24492 and notes, have a look at the
24495 \begin_inset space ~
24503 \begin_layout Section
24504 Multiple Text Columns
24507 \begin_layout Standard
24508 This feature is independent of the option
24510 Two-column document
24512 in the document settings under
24517 If you want to have 2
24518 \begin_inset space ~
24521 columns for the whole document, it is recommended to use the
24523 Two-column document
24526 For all other cases use this feature.
24529 \begin_layout Standard
24530 To use multiple text columns in your document, you have to load the module
24537 Document\SpecialChar menuseparator
24538 Settings\SpecialChar menuseparator
24541 ) and must have the \SpecialChar LaTeX
24543 \begin_inset Flex Code
24546 \begin_layout Plain Layout
24555 \begin_layout Standard
24556 Footnotes within multiple columns will be placed at the bottom of the page
24557 and not under each column.
24558 Within the different columns you can use everything, with the limitation
24559 that for floats you need to use the float option
24566 \begin_layout Subsection
24570 \begin_layout Standard
24571 If you want to have 2
24572 \begin_inset space ~
24575 columns in your text, insert a multicolumn inset via the menu
24577 Insert\SpecialChar menuseparator
24579 \begin_inset space ~
24582 Insets\SpecialChar menuseparator
24584 \begin_inset space ~
24589 where the columns should start.
24590 Write all text that should be printed in 2
24591 \begin_inset space ~
24594 columns into this inset.
24597 \begin_layout Standard
24598 Here is an example:
24601 \begin_layout Standard
24603 \begin_inset Flex Multiple Columns
24606 \begin_layout Plain Layout
24611 The Adventure of the Empty House
24614 \begin_inset Newline newline
24617 by Sir Arthur Conan Doyle
24620 \begin_layout Plain Layout
24623 It was in the spring of the year 1894 that all London was interested, and
24624 the fashionable world dismayed, by the murder of the Honourable Ronald
24625 Adair under most unusual and inexplicable circumstances.
24626 The public has already learned those particulars of the crime which came
24627 out in the police investigation, but a good deal was suppressed upon that
24628 occasion, since the case for the prosecution was so overwhelmingly strong
24629 that it was not necessary to bring forward all the facts.
24630 Only now, at the end of nearly ten years, am I allowed to supply those
24631 missing links which make up the whole of that remarkable chain.
24632 The crime was of interest in itself, but that interest was as nothing to
24633 me compared to the inconceivable sequel, which afforded me the greatest
24634 shock and surprise of any event in my adventurous life.
24635 Even now, after this long interval, I find myself thrilling as I think
24636 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24637 ty which utterly submerged my mind.
24638 Let me say to that public, which has shown some interest in those glimpses
24639 which I have occasionally given them of the thoughts and actions of a very
24640 remarkable man, that they are not to blame me if I have not shared my knowledge
24641 with them, for I should have considered it my first duty to do so, had
24642 I not been barred by a positive prohibition from his own lips, which was
24643 only withdrawn upon the third of last month.
24651 \begin_layout Standard
24652 To get 3 or more columns, set the cursor into the multicolumn inset and
24655 Insert\SpecialChar menuseparator
24657 \begin_inset space ~
24661 \begin_inset space ~
24667 The number of the desired columns is written into that inset (for 3
24668 \begin_inset space ~
24672 \begin_inset Quotes eld
24676 \begin_inset Quotes erd
24680 \begin_inset Newline newline
24683 Here is an example with 3
24684 \begin_inset space ~
24690 \begin_layout Standard
24691 \begin_inset Flex Multiple Columns
24694 \begin_layout Plain Layout
24697 \begin_inset Argument 1
24700 \begin_layout Plain Layout
24707 It can be imagined that my close intimacy with Sherlock Holmes had interested
24708 me deeply in crime, and that after his disappearance I never failed to
24709 read with care the various problems which came before the public.
24710 And I even attempted, more than once, for my own private satisfaction,
24711 to employ his methods in their solution, though with indifferent success.
24712 There was none, however, which appealed to me like this tragedy of Ronald
24714 As I read the evidence at the inquest, which led up to a verdict of willful
24715 murder against some person or persons unknown, I realized more clearly
24716 than I had ever done the loss which the community had sustained by the
24717 death of Sherlock Holmes.
24718 There were points about this strange business which would, I was sure,
24719 have specially appealed to him, and the efforts of the police would have
24720 been supplemented, or more probably anticipated, by the trained observation
24721 and the alert mind of the first criminal agent in Europe.
24722 All day, as I drove upon my round, I turned over the case in my mind and
24723 found no explanation which appeared to me to be adequate.
24724 At the risk of telling a twice-told tale, I will recapitulate the facts
24725 as they were known to the public at the conclusion of the inquest.
24733 \begin_layout Standard
24734 You can have up to 10
24735 \begin_inset space ~
24738 columns if you want to, but that might not be very pleasant for the readers
24742 \begin_layout Standard
24743 \begin_inset Newpage newpage
24749 \begin_layout Subsection
24750 Columns inside Columns
24753 \begin_layout Standard
24754 You can also have columns inside columns:
24757 \begin_layout Standard
24758 \begin_inset Flex Multiple Columns
24761 \begin_layout Plain Layout
24764 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24765 at that time governor of one of the Australian colonies.
24766 Adair's mother had returned from Australia to undergo the operation for
24767 cataract, and she, her son Ronald, and her daughter Hilda were living together
24771 \begin_layout Plain Layout
24772 \begin_inset Flex Multiple Columns
24775 \begin_layout Plain Layout
24778 The youth moved in the best society
24779 \begin_inset space ~
24782 – had, so far as was known, no enemies and no particular vices.
24783 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24784 had been broken off by mutual consent some months before, and there was
24785 no sign that it had left any very profound feeling behind it.
24786 For the rest {sic} the man's life moved in a narrow and conventional circle,
24787 for his habits were quiet and his nature unemotional.
24788 Yet it was upon this easy-going young aristocrat that death came, in most
24789 strange and unexpected form, between the hours of ten and eleven-twenty
24790 on the night of March 30, 1894.
24798 \begin_layout Plain Layout
24801 Ronald Adair was fond of cards
24802 \begin_inset space ~
24805 – playing continually, but never for such stakes as would hurt him.
24806 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24807 It was shown that, after dinner on the day of his death, he had played
24808 a rubber of whist at the latter club.
24809 He had also played there in the afternoon.
24814 The evidence of those who had played with him
24815 \begin_inset space ~
24819 Murray, Sir John Hardy, and Colonel Moran
24820 \begin_inset space ~
24823 – showed that the game was whist, and that there was a fairly equal fall
24825 Adair might have lost five pounds, but not more.
24826 His fortune was a considerable one, and such a loss could not in any way
24828 He had played nearly every day at one club or other, but he was a cautious
24829 player, and usually rose a winner.
24830 It came out in evidence that, in partnership with Colonel Moran, he had
24831 actually won as much as four hundred and twenty pounds in a sitting, some
24832 weeks before, from Godfrey Milner and Lord Balmoral.
24833 So much for his recent history as it came out at the inquest.
24841 \begin_layout Subsection
24845 \begin_layout Standard
24846 The examples in this section show some more special features of multiple
24850 \begin_layout Standard
24851 For more features of multiple columns, have a look at the
24852 \begin_inset CommandInset href
24854 name "documentation"
24855 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
24860 of the \SpecialChar LaTeX
24862 \begin_inset Flex Code
24865 \begin_layout Plain Layout
24874 \begin_layout Subsubsection
24878 \begin_layout Standard
24879 To add a preface text for multiple columns, set the cursor into the multicolumn
24880 inset and use the menu
24882 Insert\SpecialChar menuseparator
24886 Write your preface text into that inset.
24887 \begin_inset Newline newline
24890 This is an example with some preface text:
24893 \begin_layout Standard
24894 \begin_inset VSpace bigskip
24900 \begin_layout Standard
24901 \begin_inset Flex Multiple Columns
24904 \begin_layout Plain Layout
24905 \begin_inset Argument 2
24908 \begin_layout Plain Layout
24909 And the story continues and continues and continues and continues\SpecialChar ldots
24917 On the evening of the crime, he returned from the club exactly at ten.
24918 His mother and sister were out spending the evening with a relation.
24919 The servant deposed that she heard him enter the front room on the second
24920 floor, generally used as his sitting-room.
24921 She had lit a fire there, and as it smoked she had opened the window.
24922 No sound was heard from the room until eleven-twenty, the hour of the return
24923 of Lady Maynooth and her daughter.
24924 Desiring to say good-night, she attempted to enter her son's room.
24925 The door was locked on the inside, and no answer could be got to their
24926 cries and knocking.
24927 Help was obtained, and the door forced.
24928 The unfortunate young man was found lying near the table.
24929 His head had been horribly mutilated by an expanding revolver bullet, but
24930 no weapon of any sort was to be found in the room.
24938 \begin_layout Standard
24939 You can also use a section heading as the preface if you use a section command
24940 as \SpecialChar TeX
24942 For example the command
24945 \begin_layout LyX-Code
24948 subsection{subsection title}
24951 \begin_layout Standard
24952 creates a subsection.
24953 In this example the preface is a subsubsection:
24956 \begin_layout Standard
24957 \begin_inset Flex Multiple Columns
24960 \begin_layout Plain Layout
24961 \begin_inset Argument 2
24964 \begin_layout Plain Layout
24968 \begin_layout Plain Layout
24977 This is a subsubsection heading as a preface
24981 \begin_layout Plain Layout
24995 A minute examination of the circumstances served only to make the case more
24997 In the first place, no reason could be given why the young man should have
24998 fastened the door upon the inside.
24999 There was the possibility that the murderer had done this, and had afterwards
25000 escaped by the window.
25001 The drop was at least twenty feet, however, and a bed of crocuses in full
25003 Neither the flowers nor the earth showed any sign of having been disturbed,
25004 nor were there any marks upon the narrow strip of grass which separated
25005 the house from the road.
25006 Apparently, therefore, it was the young man himself who had fastened the
25008 But how did he come by his death? No one could have climbed up to the window
25009 without leaving traces.
25010 Suppose a man had fired through the window, he would indeed be a remarkable
25011 shot who could with a revolver inflict so deadly a wound.
25012 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
25013 a hundred yards of the house.
25014 No one had heard a shot.
25022 \begin_layout Standard
25023 If there is less vertical space than 6
25024 \begin_inset space ~
25027 text lines is left on the page at the beginning of the multiple columns,
25028 a page break will be inserted before the multiple columns.
25029 Depending on the number of lines of the preface text, you might want to
25031 This is done by setting the cursor into the mulitcolumn inset behind the
25032 preface (if there is any) and using the menu
25034 Insert\SpecialChar menuseparator
25036 \begin_inset space ~
25040 \begin_inset space ~
25044 \begin_inset space ~
25050 Insert into that inset the amount of space like e.
25051 \begin_inset space \thinspace{}
25055 \begin_inset space \space{}
25059 \begin_inset Quotes eld
25063 \begin_inset Quotes erd
25067 \begin_inset Newline newline
25070 In this example the space is set to 7
25071 \begin_inset space ~
25074 text lines by using
25075 \begin_inset Flex Code
25078 \begin_layout Plain Layout
25087 \begin_inset Flex Code
25090 \begin_layout Plain Layout
25098 needs to be inserted as \SpecialChar TeX
25102 \begin_layout Standard
25103 \begin_inset Flex Multiple Columns
25106 \begin_layout Plain Layout
25107 \begin_inset Argument 3
25110 \begin_layout Plain Layout
25115 \begin_layout Plain Layout
25131 On the evening of the crime, he returned from the club exactly at ten.
25132 His mother and sister were out spending the evening with a relation.
25133 The servant deposed that she heard him enter the front room on the second
25134 floor, generally used as his sitting-room.
25135 She had lit a fire there, and as it smoked she had opened the window.
25136 No sound was heard from the room until eleven-twenty, the hour of the return
25137 of Lady Maynooth and her daughter.
25138 Desiring to say good-night, she attempted to enter her son's room.
25139 The door was locked on the inside, and no answer could be got to their
25140 cries and knocking.
25141 Help was obtained, and the door forced.
25142 The unfortunate young man was found lying near the table.
25143 His head had been horribly mutilated by an expanding revolver bullet, but
25144 no weapon of any sort was to be found in the room.
25152 \begin_layout Subsubsection
25156 \begin_layout Standard
25157 The amount of space before and after multiple columns can be changed by
25158 changing the length
25159 \begin_inset Flex Code
25162 \begin_layout Plain Layout
25171 For example the command
25174 \begin_layout LyX-Code
25182 \begin_layout Standard
25183 in \SpecialChar TeX
25184 Code changes its value to 3
25185 \begin_inset space \thinspace{}
25189 The change must be made before the multiple columns' start.
25190 The predefined value is 13
25191 \begin_inset space \thinspace{}
25197 \begin_layout Standard
25199 \begin_inset Flex Code
25202 \begin_layout Plain Layout
25211 \begin_inset space \thinspace{}
25217 \begin_layout Standard
25221 \begin_layout Plain Layout
25227 multicolsep}{2.5cm}
25235 \begin_layout Standard
25236 \begin_inset Flex Multiple Columns
25239 \begin_layout Plain Layout
25242 All day I turned these facts over in my mind, endeavouring to hit upon some
25243 theory which could reconcile them all, and to find that line of least resistanc
25244 e which my poor friend had declared to be the starting-point of every investigat
25246 I confess that I made little progress.
25247 In the evening I strolled across the Park, and found myself about six o'clock
25248 at the Oxford Street end of Park Lane.
25249 A group of loafers upon the pavements, all staring up at a particular window,
25250 directed me to the house which I had come to see.
25251 A tall, thin man with coloured glasses, whom I strongly suspected of being
25252 a plain-clothes detective, was pointing out some theory of his own, while
25253 the others crowded round to listen to what he said.
25254 I got as near him as I could, but his observations seemed to me to be absurd,
25255 so I withdrew again in some disgust.
25256 As I did so I struck against an elderly, deformed man, who had been behind
25257 me, and I knocked down several books which he was carrying.
25265 \begin_layout Standard
25266 \begin_inset Note Greyedout
25269 \begin_layout Plain Layout
25274 The values you set with
25275 \begin_inset Flex Code
25278 \begin_layout Plain Layout
25286 will be used for all following multiple columns until you change them again.
25294 \begin_layout Standard
25298 \begin_layout Plain Layout
25310 \begin_inset Note Note
25313 \begin_layout Plain Layout
25314 go back to the default
25322 \begin_layout Standard
25323 \begin_inset Newpage newpage
25329 \begin_layout Subsubsection
25333 \begin_layout Standard
25334 A column break can be forced by inserting the command
25335 \begin_inset Flex Code
25338 \begin_layout Plain Layout
25346 as \SpecialChar TeX
25347 Code to that position in the text where the column should be broken.
25348 Note that this leads in most cases to whitespace in the text.
25349 \begin_inset Newline newline
25352 Here is an example:
25355 \begin_layout Standard
25356 \begin_inset Flex Multiple Columns
25359 \begin_layout Plain Layout
25362 \begin_inset Quotes eld
25365 You're surprised to see me, sir,
25366 \begin_inset Quotes erd
25369 said he, in a strange, croaking voice.
25372 \begin_layout Plain Layout
25375 I acknowledged that I was.
25378 \begin_layout Plain Layout
25381 \begin_inset Quotes eld
25384 Well, I've a conscience, sir, and when I chanced to see you go into this
25385 house, as I came hobbling after you, I thought to myself, I'll just step
25386 in and see that kind gentleman, and tell him that if I was a bit gruff
25387 in my manner there was not any harm meant, and that I am much obliged to
25388 him for picking up my books.
25389 \begin_inset Quotes erd
25395 \begin_layout Plain Layout
25398 \begin_inset Quotes eld
25401 You make too much of a trifle,
25402 \begin_inset Quotes erd
25407 \begin_inset Quotes eld
25410 May I ask how you knew who I was?
25411 \begin_inset Quotes erd
25414 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25418 \begin_layout Plain Layout
25430 \begin_layout Plain Layout
25433 \begin_inset Quotes eld
25436 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25437 you'll find my little bookshop at the corner of Church Street, and very
25438 happy to see you, I am sure.
25439 Maybe you collect yourself, sir.
25443 \begin_inset space ~
25457 \begin_inset space ~
25460 – a bargain, every one of them.
25461 With five volumes you could just fill that gap on that second shelf.
25462 It looks untidy, does it not, sir?
25463 \begin_inset Quotes erd
25474 \begin_layout Subsubsection
25478 \begin_layout Standard
25479 The width of the columns is automatically calculated, but you can modify
25480 the space between the columns.
25481 This is done by changing the length
25482 \begin_inset Flex Code
25485 \begin_layout Plain Layout
25494 Its predefined value is 10
25495 \begin_inset space \thinspace{}
25499 Here is an example where
25500 \begin_inset Flex Code
25503 \begin_layout Plain Layout
25512 \begin_inset space \thinspace{}
25518 \begin_layout Standard
25522 \begin_layout Plain Layout
25536 \begin_layout Standard
25537 \begin_inset Flex Multiple Columns
25540 \begin_layout Plain Layout
25543 My observations of No.
25544 \begin_inset space \space{}
25547 427 Park Lane did little to clear up the problem in which I was interested.
25548 The house was separated from the street by a low wall and railing, the
25549 whole not more than five feet high.
25550 It was perfectly easy, therefore, for anyone to get into the garden, but
25551 the window was entirely inaccessible, since there was no water pipe or
25552 anything which could help the most active man to climb it.
25553 More puzzled than ever, I retraced my steps to Kensington.
25554 I had not been in my study five minutes when the maid entered to say that
25555 a person desired to see me.
25556 To my astonishment it was none other than my strange old book collector,
25557 his sharp, wizened face peering out from a frame of white hair, and his
25558 precious volumes, a dozen of them at least, wedged under his right arm.
25566 \begin_layout Standard
25570 \begin_layout Plain Layout
25582 \begin_inset Note Note
25585 \begin_layout Plain Layout
25586 go back to the default
25594 \begin_layout Subsubsection
25598 \begin_layout Standard
25599 Between the columns a rule with a width of the length
25600 \begin_inset Flex Code
25603 \begin_layout Plain Layout
25612 If this rule width is set to 0
25613 \begin_inset space \thinspace{}
25616 pt (this is the default), the rule is suppressed.
25617 In the following example the rule is 2
25618 \begin_inset space \thinspace{}
25624 \begin_layout Standard
25628 \begin_layout Plain Layout
25634 columnseprule}{2pt}
25642 \begin_layout Standard
25643 \begin_inset Flex Multiple Columns
25646 \begin_layout Plain Layout
25649 \begin_inset Quotes eld
25652 You're surprised to see me, sir,
25653 \begin_inset Quotes erd
25656 said he, in a strange, croaking voice.
25659 \begin_layout Plain Layout
25662 I acknowledged that I was.
25665 \begin_layout Plain Layout
25668 \begin_inset Quotes eld
25671 Well, I've a conscience, sir, and when I chanced to see you go into this
25672 house, as I came hobbling after you, I thought to myself, I'll just step
25673 in and see that kind gentleman, and tell him that if I was a bit gruff
25674 in my manner there was not any harm meant, and that I am much obliged to
25675 him for picking up my books.
25676 \begin_inset Quotes erd
25682 \begin_layout Plain Layout
25685 \begin_inset Quotes eld
25688 You make too much of a trifle,
25689 \begin_inset Quotes erd
25694 \begin_inset Quotes eld
25697 May I ask how you knew who I was?
25698 \begin_inset Quotes erd
25704 \begin_layout Plain Layout
25707 \begin_inset Quotes eld
25710 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25711 you'll find my little bookshop at the corner of Church Street, and very
25712 happy to see you, I am sure.
25713 Maybe you collect yourself, sir.
25717 \begin_inset space ~
25731 \begin_inset space ~
25734 – a bargain, every one of them.
25735 With five volumes you could just fill that gap on that second shelf.
25736 It looks untidy, does it not, sir?
25737 \begin_inset Quotes erd
25748 \begin_layout Standard
25749 \begin_inset VSpace defskip
25755 \begin_layout Standard
25756 The rule can be colored by redefining the command
25757 \begin_inset Flex Code
25760 \begin_layout Plain Layout
25769 This is done by inserting the command
25772 \begin_layout LyX-Code
25777 columnseprulecolor}{
25782 \begin_layout Standard
25783 as \SpecialChar TeX
25784 Code before the multicolumn inset.
25786 \begin_inset Flex Code
25789 \begin_layout Plain Layout
25795 in this command by a color of your choice.
25796 You can use all pre- and self-defined colors.
25804 \begin_inset space ~
25809 for more information about pre- and self-defined colors.
25810 To go back to the default color insert the command
25813 \begin_layout LyX-Code
25818 columnseprulecolor}{
25823 \begin_layout Standard
25824 Here is the example with a cyan rule and 1
25825 \begin_inset space \thinspace{}
25828 cm column separation:
25831 \begin_layout Standard
25835 \begin_layout Plain Layout
25844 \begin_layout Plain Layout
25850 columnseprulecolor}{
25860 \begin_layout Standard
25861 \begin_inset Flex Multiple Columns
25864 \begin_layout Plain Layout
25867 \begin_inset Quotes eld
25870 You're surprised to see me, sir,
25871 \begin_inset Quotes erd
25874 said he, in a strange, croaking voice.
25877 \begin_layout Plain Layout
25880 I acknowledged that I was.
25883 \begin_layout Plain Layout
25886 \begin_inset Quotes eld
25889 Well, I've a conscience, sir, and when I chanced to see you go into this
25890 house, as I came hobbling after you, I thought to myself, I'll just step
25891 in and see that kind gentleman, and tell him that if I was a bit gruff
25892 in my manner there was not any harm meant, and that I am much obliged to
25893 him for picking up my books.
25894 \begin_inset Quotes erd
25900 \begin_layout Plain Layout
25903 \begin_inset Quotes eld
25906 You make too much of a trifle,
25907 \begin_inset Quotes erd
25912 \begin_inset Quotes eld
25915 May I ask how you knew who I was?
25916 \begin_inset Quotes erd
25922 \begin_layout Plain Layout
25925 \begin_inset Quotes eld
25928 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25929 you'll find my little bookshop at the corner of Church Street, and very
25930 happy to see you, I am sure.
25931 Maybe you collect yourself, sir.
25935 \begin_inset space ~
25949 \begin_inset space ~
25952 – a bargain, every one of them.
25953 With five volumes you could just fill that gap on that second shelf.
25954 It looks untidy, does it not, sir?
25955 \begin_inset Quotes erd
25966 \begin_layout Standard
25970 \begin_layout Plain Layout
25976 columnseprule}{0pt}
25979 \begin_layout Plain Layout
25985 columnseprulecolor}{
25993 \begin_inset Note Note
25996 \begin_layout Plain Layout
25997 go back to the default
26005 \begin_layout Section
26006 Non-standard Paragraph Shapes
26009 \begin_layout Standard
26012 as well as any other text processor uses by default rectangular paragraphs.
26013 For special cases like for example posters, invitation cards or poems you
26014 can modify the paragraph shape to one of your choice.
26015 This can be done by using the \SpecialChar LaTeX
26017 \begin_inset Flex Code
26020 \begin_layout Plain Layout
26027 which is loaded by using in the document settings the module
26029 Custom paragraph shapes
26034 \begin_layout Subsection
26038 \begin_layout Standard
26043 provides the following shapes:
26046 \begin_layout Standard
26047 \begin_inset Tabular
26048 <lyxtabular version="3" rows="13" columns="3">
26049 <features booktabs="true" islongtable="true" longtabularalignment="center">
26050 <column alignment="left" valignment="middle" width="16col%">
26051 <column alignment="left" valignment="middle" width="40col%">
26052 <column alignment="left" valignment="middle" width="35col%">
26053 <row endhead="true">
26054 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26057 \begin_layout Plain Layout
26066 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26069 \begin_layout Plain Layout
26078 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26081 \begin_layout Plain Layout
26091 <row interlinespace="default">
26092 <cell alignment="left" valignment="top" usebox="none">
26095 \begin_layout Plain Layout
26103 <cell alignment="left" valignment="top" usebox="none">
26106 \begin_layout Plain Layout
26109 Circle with circular hole (in the size of a CD/DVD)
26114 <cell alignment="left" valignment="top" usebox="none">
26117 \begin_layout Plain Layout
26120 Cannot be scaled, take care there is not too much text
26126 <row interlinespace="default">
26127 <cell alignment="left" valignment="top" usebox="none">
26130 \begin_layout Plain Layout
26138 <cell alignment="left" valignment="top" usebox="none">
26141 \begin_layout Plain Layout
26149 <cell alignment="left" valignment="top" usebox="none">
26152 \begin_layout Plain Layout
26155 Fragile, calculation might fail
26161 <row interlinespace="default">
26162 <cell alignment="left" valignment="top" usebox="none">
26165 \begin_layout Plain Layout
26173 <cell alignment="left" valignment="top" usebox="none">
26176 \begin_layout Plain Layout
26179 Rhomboid (symbolizing a
26180 \begin_inset Quotes eld
26184 \begin_inset Quotes erd
26192 <cell alignment="left" valignment="top" usebox="none">
26195 \begin_layout Plain Layout
26204 <row interlinespace="default">
26205 <cell alignment="left" valignment="top" usebox="none">
26208 \begin_layout Plain Layout
26216 <cell alignment="left" valignment="top" usebox="none">
26219 \begin_layout Plain Layout
26227 <cell alignment="left" valignment="top" usebox="none">
26230 \begin_layout Plain Layout
26239 <row interlinespace="default">
26240 <cell alignment="left" valignment="top" usebox="none">
26243 \begin_layout Plain Layout
26251 <cell alignment="left" valignment="top" usebox="none">
26254 \begin_layout Plain Layout
26262 <cell alignment="left" valignment="top" usebox="none">
26265 \begin_layout Plain Layout
26274 <row interlinespace="default">
26275 <cell alignment="left" valignment="top" usebox="none">
26278 \begin_layout Plain Layout
26286 <cell alignment="left" valignment="top" usebox="none">
26289 \begin_layout Plain Layout
26292 Nut for bolt (hexagon with circular hole)
26297 <cell alignment="left" valignment="top" usebox="none">
26300 \begin_layout Plain Layout
26309 <row interlinespace="default">
26310 <cell alignment="left" valignment="top" usebox="none">
26313 \begin_layout Plain Layout
26321 <cell alignment="left" valignment="top" usebox="none">
26324 \begin_layout Plain Layout
26332 <cell alignment="left" valignment="top" usebox="none">
26335 \begin_layout Plain Layout
26344 <row interlinespace="default">
26345 <cell alignment="left" valignment="top" usebox="none">
26348 \begin_layout Plain Layout
26356 <cell alignment="left" valignment="top" usebox="none">
26359 \begin_layout Plain Layout
26367 <cell alignment="left" valignment="top" usebox="none">
26370 \begin_layout Plain Layout
26379 <row interlinespace="default">
26380 <cell alignment="left" valignment="top" usebox="none">
26383 \begin_layout Plain Layout
26391 <cell alignment="left" valignment="top" usebox="none">
26394 \begin_layout Plain Layout
26402 <cell alignment="left" valignment="top" usebox="none">
26405 \begin_layout Plain Layout
26414 <row interlinespace="default">
26415 <cell alignment="left" valignment="top" usebox="none">
26418 \begin_layout Plain Layout
26426 <cell alignment="left" valignment="top" usebox="none">
26429 \begin_layout Plain Layout
26432 Normal/reversed rain drop
26437 <cell alignment="left" valignment="top" usebox="none">
26440 \begin_layout Plain Layout
26443 Fragile, calculation might fail
26449 <row interlinespace="default">
26450 <cell alignment="left" valignment="top" usebox="none">
26453 \begin_layout Plain Layout
26462 <cell alignment="left" valignment="top" usebox="none">
26465 \begin_layout Plain Layout
26468 The \SpecialChar TeX
26474 <cell alignment="left" valignment="top" usebox="none">
26477 \begin_layout Plain Layout
26486 <row interlinespace="default">
26487 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26490 \begin_layout Plain Layout
26494 \begin_inset Newline newline
26502 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26505 \begin_layout Plain Layout
26508 Triangles in different orientations
26513 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26516 \begin_layout Plain Layout
26532 \begin_layout Standard
26533 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26535 for environments in the toolbar.
26538 \begin_layout Standard
26539 \begin_inset Newpage newpage
26545 \begin_layout Standard
26546 Here is an example paragraph in the shape of a nut:
26549 \begin_layout Standard
26550 \begin_inset VSpace bigskip
26559 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26560 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26562 At vero eos et accusam et justo duo dolores et ea rebum.
26563 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26565 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26566 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26570 \begin_layout Standard
26571 \begin_inset VSpace bigskip
26577 \begin_layout Standard
26578 \begin_inset Note Greyedout
26581 \begin_layout Plain Layout
26590 paragraphs cannot run over a page break.
26598 \begin_layout Standard
26599 \begin_inset VSpace bigskip
26605 \begin_layout Standard
26607 \begin_inset Flex Code
26610 \begin_layout Plain Layout
26616 takes care that the shape will always be preserved, no matter how much
26617 text is in the paragraph.
26618 Therefore the paragraph size changes with the amount of contained text.
26619 This can lead to paragraph sizes exceeding the page margins.
26620 To demonstrate the size scaling, here is the same example paragraph but
26621 with twice as much text:
26624 \begin_layout Standard
26625 \begin_inset Newpage newpage
26634 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26635 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26637 At vero eos et accusam et justo duo dolores et ea rebum.
26638 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26640 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26641 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26643 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26644 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26646 At vero eos et accusam et justo duo dolores et ea rebum.
26647 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26649 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26650 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26654 \begin_layout Standard
26655 \begin_inset VSpace bigskip
26661 \begin_layout Standard
26662 An exception is the shape
26667 It cannot be scaled because it must fit the size of a CD/DVD.
26668 Therefore the amount of text that fits into the shape is limited.
26669 \begin_inset Newline newline
26680 shape are fragile, meaning that the calculation of their size can fail,
26681 depending on the amount of text.
26682 You will then get the \SpecialChar LaTeX
26684 \begin_inset Quotes eld
26687 Arithmetic overflow
26688 \begin_inset Quotes erd
26692 In this case one can try to remove or add some text; if nothing works one
26693 has to use another shape.
26696 \begin_layout Standard
26697 \begin_inset VSpace bigskip
26703 \begin_layout Standard
26704 For shapes with tips you will maybe see that \SpecialChar LaTeX
26705 's hyphenation routine fails
26706 for text in the tips.
26707 Therefore it is often necessary to add hyphenation points
26712 arg "specialchar-insert hyphenation"
26717 ) to the corresponding text parts.
26720 \begin_layout Standard
26721 \begin_inset VSpace bigskip
26727 \begin_layout Standard
26728 Shapepar paragraphs are either always centered or placed on the page so
26729 that their left border touches the left page margin.
26730 You can therefore not use the paragraph dialog to align such paragraphs.
26731 A solution is to put the paragraph into a minipage or parbox and align
26733 The problem is hereby to find the right width for the box.
26734 Because if it is too wide and you center the box, the paragraph is not
26735 centered too because it sticks at the left side of the box.
26736 So you might have to play a bit with the width until it fits.
26737 Here are two heart-shaped paragraphs, the first one is not aligned, the
26738 second one is right-aligned:
26741 \begin_layout Standard
26742 \begin_inset Newpage newpage
26748 \begin_layout Heart
26752 Lo\SpecialChar softhyphen
26753 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26754 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26756 At vero eos et accusam et justo duo dolores et ea rebum.
26757 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26761 \begin_layout Standard
26762 \begin_inset VSpace bigskip
26768 \begin_layout Standard
26771 \begin_inset Box Frameless
26781 height_special "totalheight"
26786 backgroundcolor "none"
26789 \begin_layout Heart
26793 Lo\SpecialChar softhyphen
26794 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26795 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26797 At vero eos et accusam et justo duo dolores et ea rebum.
26798 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26807 \begin_layout Subsection
26811 \begin_layout Standard
26812 You can define any shape you want.
26813 Doing this manually is a lot of work because every coordinate must be specified.
26814 But there is a way to let the computer calculate the coordinates:
26817 \begin_layout Enumerate
26818 Install the program
26819 \begin_inset CommandInset href
26822 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
26830 \begin_layout Enumerate
26837 TeX/LaTeX\SpecialChar menuseparator
26838 Settings\SpecialChar menuseparator
26841 and select the font size you are using in your document.
26842 For example this document uses the size 12
26843 \begin_inset space \thinspace{}
26849 \begin_layout Enumerate
26853 \begin_layout Enumerate
26856 TeX/LaTeX\SpecialChar menuseparator
26859 to export the shape to coordinates.
26860 In the appearing dialog use either the outline of your shape for the coordinate
26861 s or the path itself.
26865 \begin_layout Plain Layout
26866 For more information see
26867 \begin_inset CommandInset href
26869 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26882 \begin_layout Standard
26883 The coordinates are written into a \SpecialChar TeX
26885 To use it for your \SpecialChar LyX
26889 \begin_layout Enumerate
26890 Place the cursor before the first character of your paragraph (or into a
26894 \begin_layout Enumerate
26895 Open in \SpecialChar LyX
26898 Insert\SpecialChar menuseparator
26899 File\SpecialChar menuseparator
26901 \begin_inset space ~
26906 , select the file and use
26915 \begin_layout Standard
26916 \begin_inset VSpace defskip
26922 \begin_layout Standard
26923 \begin_inset Note Greyedout
26926 \begin_layout Plain Layout
26931 : The changed shape only applies to the current paragraph; everything is
26932 reset to normal for the next paragraph.
26933 Therefore the shape definition file must be input into every paragraph
26934 with the desired shape.
26942 \begin_layout Standard
26943 \begin_inset VSpace bigskip
26949 \begin_layout Standard
26950 Here is an example:
26953 \begin_layout Standard
26954 \begin_inset VSpace bigskip
26960 \begin_layout Standard
26961 \begin_inset CommandInset include
26963 filename "SpecialParagraphShape.tex"
26969 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26970 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26972 At vero eos et accusam et justo duo dolores et ea rebum.
26973 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26975 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26976 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26980 \begin_layout Standard
26981 \begin_inset VSpace bigskip
26987 \begin_layout Standard
26992 to draw complexer shapes in
26996 you can draw the shape in a program of your choice and import the resulting
27002 Then you only need to draw a line or spline along the outline of the image.
27005 \begin_layout Standard
27006 \begin_inset VSpace bigskip
27012 \begin_layout Standard
27015 Custom paragraph shapes
27017 also provides the two commands
27025 which can be used to define custom shapes coordinate by coordinate.
27029 \begin_layout Plain Layout
27030 These commands are internally used for all shapes described here.
27035 For information how these styles are used and about further customization
27036 possibilities, have a look at the
27037 \begin_inset CommandInset href
27039 name "documentation"
27040 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
27046 \begin_inset Flex Code
27049 \begin_layout Plain Layout