1 #LyX 2.4 created this file. For more info see https://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
54 \font_typewriter_osf false
55 \font_sf_scale 100 100
56 \font_tt_scale 100 100
58 \use_dash_ligatures true
60 \default_output_format pdf2
62 \bibtex_command default
63 \index_command default
67 \pdf_title "LyX's Additional Features manual"
68 \pdf_author "LyX Team"
69 \pdf_subject "LyX's additional features documentation"
70 \pdf_keywords "LyX, Documentation, Additional"
72 \pdf_bookmarksnumbered true
73 \pdf_bookmarksopen false
74 \pdf_bookmarksopenlevel 1
79 \pdf_pdfusetitle false
80 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
83 \use_package amsmath 1
84 \use_package amssymb 1
87 \use_package mathdots 1
88 \use_package mathtools 1
90 \use_package stackrel 1
91 \use_package stmaryrd 1
92 \use_package undertilde 1
94 \cite_engine_type default
98 \paperorientation portrait
104 \notefontcolor #0000ff
111 \paragraph_separation indent
112 \paragraph_indentation default
114 \math_indentation default
115 \math_numbering_side default
116 \quotes_style english
120 \paperpagestyle headings
122 \tracking_changes true
123 \output_changes false
128 \author 1119979965 "Joel A. Kulesza"
134 Additional \SpecialChar LyX
138 \begin_layout Subtitle
143 by the \SpecialChar LyX
148 \begin_layout Plain Layout
150 Principal maintainer of this file is
155 If you have comments or error corrections, please send them to the \SpecialChar LyX
158 \begin_inset Flex Code
161 \begin_layout Plain Layout
162 <lyx-docs@lists.lyx.org>
175 \begin_layout Standard
176 \begin_inset CommandInset toc
177 LatexCommand tableofcontents
184 \begin_layout Chapter
188 \begin_layout Standard
189 This manual is essentially Part II of the
191 User's Guide\SpecialChar endofsentence
194 The reason for separating the two documents is simple: the
198 is already quite lengthy, and it contains information on all of the basic
199 features one needs to know in order to prepare most documents.
200 However, the \SpecialChar LyX
201 Team has worked to make \SpecialChar LyX
202 extensible through various configuration
203 files and external packages.
204 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
206 create a layout file (or module) for it without having to alter \SpecialChar LyX
208 We've already had contributions of several new features this way, and some
209 of them are documented here.
210 There are also some more `advanced' features, such as how to control the
211 presentation of bibliographies and how to work with multi-part documents,
212 that are not covered in the
216 and are discussed here.
219 \begin_layout Standard
220 This manual also documents some special features, like fax support, version
221 control, and SGML support, which require additional software to work properly.
222 There is also a chapter on \SpecialChar LyX
224 And lastly, there's a chapter of \SpecialChar LaTeX
225 tools and tips, things you can use to
226 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
228 After all, \SpecialChar LyX
233 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
237 \begin_layout Standard
238 If you haven't read the
242 yet, you are definitely in the wrong manual.
247 is the first place to go, since it describes the notation and format of
249 You should also be thoroughly familiar with the
253 and all of the basic features of \SpecialChar LyX
254 before attempting to read this one.
257 \begin_layout Standard
258 Since many of the topics in this manual depend heavily on \SpecialChar LyX
260 with \SpecialChar LaTeX
261 , this first chapter covers the inner workings of \SpecialChar LyX
264 to generate exactly the \SpecialChar LaTeX
266 It is obviously for more seasoned \SpecialChar LyX
270 \begin_layout Chapter
272 and \SpecialChar LaTeX
276 \begin_layout Section
278 Uses \SpecialChar LaTeX
282 \begin_layout Standard
283 This chapter is for both \SpecialChar TeX
284 -nicians and the \SpecialChar LaTeX
286 In it, we'll explain how \SpecialChar LyX
287 and \SpecialChar LaTeX
288 work together to produce printable output.
289 This is the only place in any of the manuals where we assume you know something
290 about \SpecialChar LaTeX
294 \begin_layout Standard
295 At one time, \SpecialChar LyX
297 \begin_inset Quotes eld
300 WYSIWYM frontend to \SpecialChar LaTeX
302 \begin_inset Quotes erd
305 but that's no longer true.
306 There are frontends to \SpecialChar LaTeX
311 \begin_layout Plain Layout
312 Some familar ones are \SpecialChar TeX
313 maker and kile, on Linux, and \SpecialChar TeX
315 There are also the \SpecialChar LaTeX
316 modes for vi and emacs, of course.
321 These are basically text editors with the ability to run \SpecialChar LaTeX
323 errors in the file you're editing.
324 Although \SpecialChar LyX
333 run \SpecialChar LaTeX
334 , and it also indicates errors in the file, it also does much, much
336 For one thing, you don't need to know \SpecialChar LaTeX
337 to use \SpecialChar LyX
340 has added its own extensions to \SpecialChar LaTeX
342 Try the following sometime: select
343 \begin_inset Flex Noun
346 \begin_layout Plain Layout
347 Export\SpecialChar menuseparator
354 \begin_inset Flex Noun
357 \begin_layout Plain Layout
364 \begin_inset Flex Noun
367 \begin_layout Plain Layout
368 View\SpecialChar menuseparator
378 ), then look at the preamble of the resulting
379 \begin_inset Flex Code
382 \begin_layout Plain Layout
389 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
391 These macros are defined automatically, according to the features you use
395 \begin_layout Standard
396 There are several commands that automatically invoke \SpecialChar LaTeX
401 \begin_layout Itemize
402 \begin_inset Flex Noun
405 \begin_layout Plain Layout
406 Document\SpecialChar menuseparator
415 \begin_layout Itemize
416 \begin_inset Flex Noun
419 \begin_layout Plain Layout
420 Document\SpecialChar menuseparator
429 \begin_layout Standard
430 They will only invoke \SpecialChar LaTeX
431 if the file has changed since the last time \SpecialChar LaTeX
437 \begin_layout Standard
438 When \SpecialChar LyX
439 runs \SpecialChar LaTeX
440 on the file you're editing, it performs these steps:
443 \begin_layout Enumerate
444 Convert the document to \SpecialChar LaTeX
445 and save to a file with the extension
446 \begin_inset Flex Code
449 \begin_layout Plain Layout
456 \begin_inset Flex Code
459 \begin_layout Plain Layout
468 \begin_layout Enumerate
469 Run \SpecialChar LaTeX
471 \begin_inset Flex Code
474 \begin_layout Plain Layout
480 file (maybe several times), and run any other commands (such as
481 \begin_inset Flex Code
484 \begin_layout Plain Layout
491 \begin_inset Flex Code
494 \begin_layout Plain Layout
500 ) needed to compile the \SpecialChar LaTeX
504 \begin_layout Enumerate
505 If there are any errors, show the error log.
508 \begin_layout Standard
509 If you have run \SpecialChar LaTeX
511 \begin_inset Flex Noun
514 \begin_layout Plain Layout
515 View\SpecialChar menuseparator
522 then runs a DVI viewer to display the DVI-file.
524 \begin_inset Flex Noun
527 \begin_layout Plain Layout
528 View\SpecialChar menuseparator
535 performs further steps:
538 \begin_layout Itemize
540 \begin_inset Flex Code
543 \begin_layout Plain Layout
549 to convert the DVI file to PostScript.
552 \begin_layout Itemize
553 Run a PostScript viewer, such as
554 \begin_inset Flex Code
557 \begin_layout Plain Layout
563 , to display the PostScript file.
566 \begin_layout Standard
568 does similar things when viewing, or exporting, other formats.
571 \begin_layout Section
572 Translating \SpecialChar LaTeX
573 files into \SpecialChar LyX
577 \begin_layout Standard
578 You can import a \SpecialChar LaTeX
579 file into \SpecialChar LyX
581 \begin_inset Flex Noun
584 \begin_layout Plain Layout
585 File\SpecialChar menuseparator
586 Import\SpecialChar menuseparator
592 command in \SpecialChar LyX
594 This will call a program named
595 \begin_inset Flex Code
598 \begin_layout Plain Layout
604 which will create a file
605 \begin_inset Flex Code
608 \begin_layout Plain Layout
615 \begin_inset Flex Code
618 \begin_layout Plain Layout
626 will then open that file.
630 \begin_layout Plain Layout
631 \begin_inset Flex Code
634 \begin_layout Plain Layout
640 can also be run from the command line, of course.
648 \begin_layout Standard
649 \begin_inset Flex Code
652 \begin_layout Plain Layout
658 will translate most legal \SpecialChar LaTeX
659 , but not everything.
660 It will put things it doesn't understand into \SpecialChar TeX
661 code, so after translating
663 \begin_inset Flex Code
666 \begin_layout Plain Layout
672 , you can look for \SpecialChar TeX
673 code and hand-edit it until it looks right.
676 \begin_layout Standard
677 If you don't know what \SpecialChar TeX
678 code is, read the next section.
681 \begin_layout Section
682 \begin_inset CommandInset label
684 name "sec:Inserting-TeX-Code"
688 Inserting \SpecialChar TeX
689 Code into \SpecialChar LyX
693 \begin_layout Standard
694 Anything you can do in \SpecialChar LaTeX
695 you can do in \SpecialChar LyX
696 , for a very simple reason: You can
697 always insert \SpecialChar TeX
698 code into any \SpecialChar LyX
701 cannot, and will never be able to, display every possible \SpecialChar LaTeX
703 If ever you need to insert \SpecialChar LaTeX
704 commands into your \SpecialChar LyX
705 document, you can use the
707 \begin_inset Flex Code
710 \begin_layout Plain Layout
717 box, which you can insert into your document with
718 \begin_inset Flex Noun
721 \begin_layout Plain Layout
722 Insert\SpecialChar menuseparator
732 or the keyboard shortcut
741 \begin_layout Standard
742 Here's an example of inserting \SpecialChar LaTeX
743 commands in a \SpecialChar LyX
745 The code looks like this:
748 \begin_layout LyX-Code
752 \begin_inset Newline newline
758 \begin_inset Newline newline
761 This is an example of a minipage environment.
763 \begin_inset Newline newline
766 can put nearly everything in it, even (non-floating)
767 \begin_inset Newline newline
772 \begin_inset Newline newline
778 \begin_inset Newline newline
782 \begin_inset Newline newline
788 \begin_inset Newline newline
794 \begin_inset Newline newline
800 \begin_inset Newline newline
805 \begin_inset Newline newline
811 \begin_inset Newline newline
817 \begin_inset Newline newline
823 \begin_inset Newline newline
831 \begin_layout LyX-Code
835 \begin_layout Standard
837 \begin_inset Flex Code
840 \begin_layout Plain Layout
847 box containing this text is directly after this paragraph.
848 Those of you reading the manual in \SpecialChar LyX
849 will only see the \SpecialChar TeX
851 Those reading a printed version of the manuals will see the actual results:
852 \begin_inset VSpace bigskip
858 \begin_layout Standard
862 \begin_layout Plain Layout
869 \begin_layout Plain Layout
876 \begin_layout Plain Layout
878 This is an example of a minipage environment.
879 You can put nearly everything in it, even (non-floating) figures and tables.
883 \begin_layout Plain Layout
890 \begin_layout Plain Layout
895 \begin_layout Plain Layout
902 \begin_layout Plain Layout
909 \begin_layout Plain Layout
916 \begin_layout Plain Layout
922 \begin_layout Plain Layout
929 \begin_layout Plain Layout
936 \begin_layout Plain Layout
943 \begin_layout Plain Layout
953 \begin_inset VSpace bigskip
959 \begin_layout Standard
960 In addition to using \SpecialChar TeX
961 code, you can also create a separate file containing
962 some complex \SpecialChar LaTeX
963 structure and then use
964 \begin_inset Flex Noun
967 \begin_layout Plain Layout
968 Insert\SpecialChar menuseparator
978 to include your file (you should select the type
979 \begin_inset Flex Code
982 \begin_layout Plain Layout
989 We recommend that you only do this if you have a
990 \begin_inset Flex Code
993 \begin_layout Plain Layout
1004 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1008 \begin_layout Standard
1009 There are a few last points to emphasize:
1012 \begin_layout Itemize
1018 check if your \SpecialChar LaTeX
1022 \begin_layout Itemize
1023 Beware of reinventing the wheel.
1026 \begin_layout Standard
1027 On that last point, \SpecialChar LyX
1028 does have quite a few features tucked into it, and
1030 Be sure to check the manuals to make sure that \SpecialChar LyX
1031 doesn't have such-and-such
1032 feature before you decide you have to do it by hand.
1033 Moreover, there are numerous \SpecialChar LaTeX
1034 packages out there to do all sorts of things,
1035 from labels to envelopes to fancy multipage tables.
1037 \begin_inset CommandInset href
1040 target "http://www.ctan.org/"
1048 \begin_layout Standard
1049 If you do need to do some wild and fancy things within your document, be
1050 sure to check out a good \SpecialChar LaTeX
1051 book for assistance.
1052 There are a number of them listed in the bibliography of the
1059 \begin_layout Section
1061 and the \SpecialChar LaTeX
1065 \begin_layout Subsection
1066 About the \SpecialChar LaTeX
1070 \begin_layout Standard
1071 If you already know \SpecialChar LaTeX
1072 , there is no need to explain here what the preamble
1074 If you don't, the following will give you some ideas—we recommend again
1075 that you consult a \SpecialChar LaTeX
1076 book for further information.
1077 In any case, you should read the points below, because they explain what
1078 you can do and what you don't need to do in the \SpecialChar LaTeX
1079 preamble of a \SpecialChar LyX
1083 \begin_layout Standard
1084 The \SpecialChar LaTeX
1085 preamble comes at the very beginning of a document,
1093 \begin_layout Itemize
1094 Declare the document class.
1096 \begin_inset Newline newline
1100 already does this for you.
1101 If you're a seasoned \SpecialChar LaTeX
1102 -nician, and you have a custom document class you
1103 want to use, check out the
1105 Customization Manual
1107 for information on how to make \SpecialChar LyX
1111 \begin_layout Itemize
1112 Declare the usage of packages.
1114 \begin_inset Newline newline
1118 packages provide special commands, which are only available within a document
1119 when the package has been declared in the preamble.
1120 In addition to providing special commands, the inclusion of a package can
1121 change the document.
1122 For example, the package
1123 \begin_inset Flex Code
1126 \begin_layout Plain Layout
1132 forces all paragraphs to be indented.
1133 There are other packages for labels, envelopes, margins, etc.
1137 \begin_layout Itemize
1138 Set counters, variables, lengths and widths.
1140 \begin_inset Newline newline
1143 There are several \SpecialChar LaTeX
1144 counters and variables that
1148 be set globally from within the preamble in order to have the desired effect.
1149 (There are variables that you can set and reset inside the document, too.)
1150 Margins are a good example of something that must be set in the preamble.
1151 Another example is the label format for lists.
1152 You can actually set these just about anywhere, but it's best to do it
1153 just once, inside the preamble.
1156 \begin_layout Itemize
1157 Declare user defined commands (with
1158 \begin_inset Flex Code
1161 \begin_layout Plain Layout
1170 \begin_inset Flex Code
1173 \begin_layout Plain Layout
1182 \begin_inset Newline newline
1185 These are abbreviations for \SpecialChar LaTeX
1186 commands which appear very often inside a document.
1187 Although the preamble is a good place to declare such commands, they
1191 be declared anywhere (before they are used for the first time, of course).
1192 This can be useful if there is a lot of raw \SpecialChar LaTeX
1193 code in your document, which
1194 normally should not be the case.
1197 \begin_layout Standard
1199 adds its own set of definitions to the preamble of the
1200 \begin_inset Flex Code
1203 \begin_layout Plain Layout
1210 This makes \SpecialChar LaTeX
1211 files generated by \SpecialChar LyX
1215 \begin_layout Subsection
1216 Changing the Preamble
1219 \begin_layout Standard
1220 The commands which \SpecialChar LyX
1221 adds to the preamble of a \SpecialChar LaTeX
1222 file are fixed; you can't
1223 change them without patching \SpecialChar LyX
1225 You can, however, add your own stuff to the preamble by selecting
1226 \begin_inset Flex Noun
1229 \begin_layout Plain Layout
1232 \begin_inset space ~
1241 \begin_inset Flex Noun
1244 \begin_layout Plain Layout
1245 Document\SpecialChar menuseparator
1253 adds anything in the
1254 \begin_inset Flex Noun
1257 \begin_layout Plain Layout
1263 dialog to its own built-in preamble.
1264 Before adding your own declarations in the preamble, you should make sure
1265 that \SpecialChar LyX
1266 doesn't already support what you want to do.
1267 (Remember what we said about reinventing the wheel?) Also,
1269 make sure your preamble code is correct
1273 doesn't check it for you.
1274 If there is an error, you're likely to get an error like
1275 \begin_inset Quotes eld
1279 \begin_inset Flex Code
1282 \begin_layout Plain Layout
1291 \begin_inset Quotes erd
1295 If you see this error, check your preamble.
1298 \begin_layout Subsection
1302 \begin_layout Standard
1303 Here are some examples of what you can add to a preamble, and what they
1307 \begin_layout Subsubsection
1311 \begin_layout Standard
1312 There are two variables under \SpecialChar LaTeX
1313 that control page position:
1314 \begin_inset Flex Code
1317 \begin_layout Plain Layout
1326 \begin_inset Flex Code
1329 \begin_layout Plain Layout
1338 Their names should be self-explanatory.
1339 These variables are useful if you think for a moment about computer labels.
1340 Sometimes, the size of a print medium and the area of the medium that you
1341 can actually print on aren't the same.
1343 \begin_inset Flex Code
1346 \begin_layout Plain Layout
1355 \begin_inset Flex Code
1358 \begin_layout Plain Layout
1369 \begin_layout Standard
1370 The default values for
1371 \begin_inset Flex Code
1374 \begin_layout Plain Layout
1383 \begin_inset Flex Code
1386 \begin_layout Plain Layout
1395 \begin_inset space \thinspace{}
1399 \begin_inset space \thinspace{}
1403 \begin_inset space \space{}
1406 the page isn't shifted.
1407 Unfortunately, some DVI drivers always seem to shift the page.
1408 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1409 If you're using \SpecialChar LyX
1410 on a system that you don't personally maintain, and your
1411 sysadmin is a doofus,
1412 \begin_inset Flex Code
1415 \begin_layout Plain Layout
1424 \begin_inset Flex Code
1427 \begin_layout Plain Layout
1436 Suppose your left and top margins are always 0.5
1437 \begin_inset space \thinspace{}
1441 You can add this to the preamble:
1444 \begin_layout LyX-Code
1452 \begin_layout LyX-Code
1460 \begin_layout Standard
1461 and your margins should now be correct.
1464 \begin_layout Subsubsection
1468 \begin_layout Standard
1469 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1470 There's a rather nice package, available at your nearest CTAN archive,
1471 for printing sheets of labels:
1472 \begin_inset Flex Code
1475 \begin_layout Plain Layout
1482 Now, your system may not have this package installed by default.
1483 We leave that up to you to check.
1484 You'll also want to read the documentation for it; we're not going to do
1486 Since this is an example, however, we'll give you an example of how you
1490 \begin_layout Standard
1491 First, make sure you're using the
1492 \begin_inset Flex Code
1495 \begin_layout Plain Layout
1502 Next, you need to put the following in your preamble:
1505 \begin_layout LyX-Code
1511 \begin_layout LyX-Code
1517 \begin_layout LyX-Code
1523 \begin_layout LyX-Code
1529 \begin_layout LyX-Code
1535 \begin_layout LyX-Code
1541 \begin_layout LyX-Code
1547 \begin_layout Standard
1548 This sets things up for Avery label sheets, stock #5360.
1549 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1552 \begin_inset Flex Code
1555 \begin_layout Plain Layout
1564 \begin_inset Flex Code
1567 \begin_layout Plain Layout
1575 around each label text.
1576 This and other special features of
1577 \begin_inset Flex Code
1580 \begin_layout Plain Layout
1586 are explained in its documentation.
1589 \begin_layout Standard
1590 Someday, someone may write a \SpecialChar LyX
1591 layout file to support this package directly.
1592 Maybe that someone is you.
1595 \begin_layout Subsubsection
1596 Example #3: Paragraph Indentation
1599 \begin_layout Standard
1600 Americans are trained to indent the first line of
1605 As with all of their other weird quirks, most Americans will whine and
1606 moan until they can have their way and indent the first line of all paragraphs.
1615 \begin_layout Standard
1616 Of course, this behavior isn't standard typography.
1617 In books, you typically only indent the first line of a paragraph
1621 it follows another one.
1622 The idea behind indenting the first line of a paragraph is to distinguish
1623 neighboring paragraphs from one another.
1624 If there is no previous paragraph—for example, if it follows a figure or
1625 is the first paragraph in a section—then there is no need for indentation.
1629 \begin_layout Standard
1630 If you're a typical American (we're still joking!), though, you don't care
1631 about such esoteric things; you want your indentation! Add this to the
1635 \begin_layout LyX-Code
1638 usepackage{indentfirst}
1641 \begin_layout Standard
1642 If your \SpecialChar TeX
1643 distribution isn't braindead, you'll have this package, and all
1644 of your paragraphs will get the indentation the Founding Fathers intended
1648 \begin_layout Subsubsection
1649 Example #4: This Document
1652 \begin_layout Standard
1653 You can also check out the preamble of this document to get an idea of some
1654 of the advanced things you can do.
1657 \begin_layout Section
1659 and \SpecialChar LaTeX
1663 \begin_layout Standard
1664 When \SpecialChar LyX
1665 calls \SpecialChar LaTeX
1666 , it tells \SpecialChar LaTeX
1667 to blithely ignore any errors and keep going.
1668 It then uses the logfile from the \SpecialChar LaTeX
1669 run to do a post-mortem.
1670 After analyzing the logfile, \SpecialChar LyX
1671 displays a dialog listing the errors.
1672 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1674 where the error occurred.
1678 \begin_layout Plain Layout
1680 Analyzing the logfile is a tough job, and \SpecialChar LyX
1681 doesn't always go to the right
1683 There are also cases where \SpecialChar LaTeX
1684 reports the error on one line, but the actual
1686 This is not unlike forgetting a closing brace in a program: You'll get
1687 an error, but only later.
1695 \begin_layout Standard
1696 Some folks also like to look at the log file directly: It is available from
1698 \begin_inset Flex Noun
1701 \begin_layout Plain Layout
1702 Document\SpecialChar menuseparator
1704 \begin_inset space ~
1713 There are some fairly common error messages and warnings.
1714 We'll cover those here.
1715 You should look at a good \SpecialChar LaTeX
1716 book for a complete listing.
1719 \begin_layout Itemize
1720 \begin_inset Flex Code
1723 \begin_layout Plain Layout
1730 \begin_inset Newline newline
1733 Anything beginning with these words is a warning message for the purpose
1735 \begin_inset Quotes eld
1739 \begin_inset Quotes erd
1742 the \SpecialChar LaTeX
1744 You'll get messages like this if you added or changed cross-references
1745 or bibliography entries, in which case, \SpecialChar LaTeX
1746 is trying to tell you that you
1747 need to make another run.
1748 You can by-and-large ignore these.
1751 \begin_layout Itemize
1752 \begin_inset Flex Code
1755 \begin_layout Plain Layout
1762 \begin_inset Newline newline
1765 Another warning message, this time about fonts which \SpecialChar LaTeX
1767 The rest of the message will often say something about a replacement font
1768 that \SpecialChar LaTeX
1770 You can safely ignore these, too.
1773 \begin_layout Itemize
1774 \begin_inset Flex Code
1777 \begin_layout Plain Layout
1786 \begin_inset Newline newline
1795 It seems to generate at least one of these messages for just about any
1797 They are warnings about lines that were too long and run past the right
1799 This happens if \SpecialChar LaTeX
1800 does not find a reasonable way to break the lines (notoriously
1801 often with typewriter font, since this does not allow for automatic break
1803 In many cases, this is unnoticeable in the final output.
1804 (It can be just a point or two.) Sometimes, however, the lines run rather
1805 visibly into the margin; something you will not want to have in your final
1808 \begin_inset Newline newline
1811 There are several global ways to try to minimize the overfull lines.
1814 Enable micro-typographic extensions
1818 Document\SpecialChar menuseparator
1819 Settings\SpecialChar menuseparator
1822 might already improve things a lot.
1823 Furthermore, \SpecialChar LaTeX
1824 code such as the following in
1826 Document\SpecialChar menuseparator
1827 Settings\SpecialChar menuseparator
1830 usually reduces the overfull lines drastically (we use this in the preamble
1835 \begin_layout LyX-Code
1839 \begin_inset Newline newline
1845 \begin_inset Newline newline
1850 emergencystretch 1.5em
1851 \begin_inset Newline newline
1859 \begin_layout Standard
1860 In some cases, however, you eventually have to rewrite the text to get the
1861 line breaking right.
1865 \begin_layout Plain Layout
1866 For more information, see
1867 \begin_inset Flex URL
1870 \begin_layout Plain Layout
1872 http://www.tex.ac.uk/FAQ-overfull.html
1885 \begin_layout Standard
1886 In any case, you should check the respective lines, at least for the final
1887 version of your document.
1888 Your eyes will tell you if there's a problem with something that's too
1893 \begin_layout Plain Layout
1894 You can also enable the `draft' option in
1895 \begin_inset Flex Noun
1898 \begin_layout Plain Layout
1899 Document\SpecialChar menuseparator
1905 , and then \SpecialChar LaTeX
1906 will draw a black box in the margin of lines that are overfull.
1915 \begin_layout Itemize
1916 \begin_inset Flex Code
1919 \begin_layout Plain Layout
1928 \begin_inset Newline newline
1931 Not quite as common as its cousin.
1932 This happens again if \SpecialChar LaTeX
1933 does not find a reasonable break point and consequently
1934 generates too loose lines.
1935 As with the overfull lines, you should check if this is a visible problem.
1938 \begin_layout Itemize
1939 \begin_inset Flex Code
1942 \begin_layout Plain Layout
1951 \begin_inset Flex Code
1954 \begin_layout Plain Layout
1963 \begin_inset Newline newline
1966 Warnings about troubles breaking the page.
1967 Once again, just look at the output.
1968 Your eyes will tell you where something has gone wrong.
1971 \begin_layout Itemize
1972 \begin_inset Flex Code
1975 \begin_layout Plain Layout
1977 \begin_inset Quotes els
1981 \begin_inset Quotes ers
1990 \begin_inset Newline newline
1994 \begin_inset Quotes eld
1998 \begin_inset Quotes erd
2001 isn't installed on this system.
2002 This usually appears because some package your document needs isn't installed.
2003 If you didn't touch the preamble or didn't use the
2004 \begin_inset Flex Code
2007 \begin_layout Plain Layout
2015 command, then one of the packages \SpecialChar LyX
2016 tried to load is missing.
2018 \begin_inset Flex Noun
2021 \begin_layout Plain Layout
2022 Help\SpecialChar menuseparator
2029 to get a list of packages that \SpecialChar LyX
2031 This file is updated whenever you reconfigure \SpecialChar LyX
2033 \begin_inset Flex Noun
2036 \begin_layout Plain Layout
2037 Tools\SpecialChar menuseparator
2043 ) and tells you which packages have been detected and what they do.
2044 \begin_inset Newline newline
2048 \begin_inset Flex Code
2051 \begin_layout Plain Layout
2059 command and the package in question isn't installed, then you'll need to
2060 install it yourself.
2063 \begin_layout Itemize
2064 \begin_inset Flex Code
2067 \begin_layout Plain Layout
2068 LaTeX Error: Unknown option
2074 \begin_inset Newline newline
2077 Error messages beginning with this are trying to tell you that you specified
2078 a bad or undefined option to a package.
2079 Check the package's documentation.
2082 \begin_layout Itemize
2083 \begin_inset Flex Code
2086 \begin_layout Plain Layout
2087 Undefined control sequence
2093 \begin_inset Newline newline
2096 If you've inserted \SpecialChar LaTeX
2097 code into your document, but made a typo, you'll get
2099 You may have forgotten to load a package.
2100 In any case, this error message usually means that you used an undefined
2105 \begin_layout Standard
2106 There are other error and warning messages.
2107 Some are self-explanatory.
2108 These are usually \SpecialChar LaTeX
2110 Others are downright cryptic.
2111 These are usually \SpecialChar TeX
2112 error messages, and we really have
2116 what they mean or how to decipher them.
2120 \begin_layout Standard
2121 There's a general sequence you should follow if you get error messages:
2124 \begin_layout Enumerate
2125 Look at the \SpecialChar LaTeX
2126 code you inserted for typos.
2129 \begin_layout Enumerate
2130 If there are no typos, check that you used the command(s) correctly.
2133 \begin_layout Enumerate
2134 If you get a bunch of error boxes piled up at the very top of the document—and
2135 especially if you see a
2136 \begin_inset Quotes eld
2140 \begin_inset Flex Code
2143 \begin_layout Plain Layout
2152 \begin_inset Quotes erd
2155 error—it means that there are errors in the preamble.
2156 Start debugging your preamble.
2159 \begin_layout Enumerate
2160 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2162 document, the first suspect is your \SpecialChar LaTeX
2163 distribution itself.
2164 Check for missing packages and install them.
2167 \begin_layout Enumerate
2168 Okay, so there are no missing packages.
2169 Did you use any of the fine-tuning options in \SpecialChar LyX
2170 ? Specifically, did you
2174 any of them, like trying to manually insert lots of
2175 \begin_inset Flex Code
2178 \begin_layout Plain Layout
2180 \begin_inset space ~
2189 \begin_inset Flex Code
2192 \begin_layout Plain Layout
2199 \begin_inset Flex Code
2202 \begin_layout Plain Layout
2208 ? Did you try to kludge something together with these instead of using the
2209 appropriate paragraph environment?
2212 \begin_layout Enumerate
2213 All right, you didn't use any of the fine-tuning options, you played by
2215 Did you try to pull a fancy maneuver? Did you do something funky inside
2216 a table or an equation, like inserting a graphic into a table cell?
2219 \begin_layout Enumerate
2220 Do you have long sections of text where \SpecialChar LaTeX
2221 cannot find a place to break a
2222 line? By default, \SpecialChar LaTeX
2223 is rather strict about how much extra inter-word spacing
2224 it will add in order to break a line.
2225 Preferably, you should rework the paragraph to avoid the problem.
2228 \begin_layout Enumerate
2229 Did you go overboard with the nesting? \SpecialChar LyX
2230 (currently) doesn't check to make
2231 sure you're in the limits for nesting environments.
2232 If you nested a bunch of environments to the
2233 \begin_inset Formula $17^{\mathrm{th}}$
2236 level, that's the problem.
2237 (The limit in \SpecialChar LaTeX
2241 \begin_layout Enumerate
2242 Okay, you didn't get any error messages, but your output looks awful.
2243 If you have a table or figure that's too wide or long for the page, you
2248 \begin_layout Enumerate
2249 rescale the figure so it fits.
2252 \begin_layout Enumerate
2253 trim down the table so it fits.
2257 \begin_layout Enumerate
2258 If something else is wrong with the output, and you didn't try to pull anything
2259 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2262 \begin_layout Standard
2263 If all this doesn't help—well, then
2267 you might have found a bug in \SpecialChar LyX
2272 \begin_layout Chapter
2276 \begin_layout Section
2277 Customizing Bibliographies with Bib\SpecialChar TeX
2281 \begin_layout Standard
2282 The most basic information about how to use Bib\SpecialChar TeX
2287 with \SpecialChar LyX
2288 is contained in the section
2290 Bibliography databases
2297 The following subsections explain special bibliography features supported
2302 \begin_layout Subsection
2303 Alternative Citation Styles
2306 \begin_layout Standard
2307 Standard Bib\SpecialChar TeX
2309 \begin_inset space \thinspace{}
2313 \begin_inset space \space{}
2317 \begin_inset Quotes eld
2321 \begin_inset Quotes erd
2324 ) to refer to a cited work.
2325 However, in many scientific disciplines, other citation styles are in use.
2326 The most common one is the author-year style (e.
2327 \begin_inset space \thinspace{}
2331 \begin_inset space \space{}
2335 \begin_inset Quotes eld
2339 \begin_inset Quotes erd
2344 supports three packages that provide this style,
2345 \begin_inset Flex Code
2348 \begin_layout Plain Layout
2355 \begin_inset Flex Code
2358 \begin_layout Plain Layout
2365 \begin_inset Flex Code
2368 \begin_layout Plain Layout
2375 Each of these packages has their pros and cons, which cannot be listed
2377 If you only want to have simple author-year (or author-numerical) style,
2378 or if you want to use one of the countless style files for
2379 \begin_inset Flex Code
2382 \begin_layout Plain Layout
2388 , then the established
2389 \begin_inset Flex Code
2392 \begin_layout Plain Layout
2398 package is probably your choice.
2399 If you look for specific citation styles common in law studies, you might
2401 \begin_inset Flex Code
2404 \begin_layout Plain Layout
2411 If you want to have full control over the formatting or look for advanced
2412 features such as ibidem, footnote citations, full title citations, advanced
2413 date formats (such as 400 BC) or full localization to other languages than
2414 English, you should definitely consider
2415 \begin_inset Flex Code
2418 \begin_layout Plain Layout
2424 , which exceeds all other packages in terms of features, but is also quite
2425 heavy and more resource-hungry.
2428 \begin_layout Standard
2429 The handling of these packages in \SpecialChar LyX
2430 is basically the same.
2432 \begin_inset Flex Noun
2435 \begin_layout Plain Layout
2436 Document\SpecialChar menuseparator
2443 \begin_inset Flex Noun
2446 \begin_layout Plain Layout
2453 \begin_inset Flex Noun
2456 \begin_layout Plain Layout
2463 \begin_inset Flex Noun
2466 \begin_layout Plain Layout
2473 \begin_inset Flex Noun
2476 \begin_layout Plain Layout
2483 \begin_inset Flex Noun
2486 \begin_layout Plain Layout
2487 Biblatex (Natbib mode)
2493 \begin_inset Flex Noun
2496 \begin_layout Plain Layout
2503 \begin_inset Flex Noun
2506 \begin_layout Plain Layout
2513 \begin_inset space ~
2516 6.5.3 in the User's Guide for more information on these choices).
2517 With all these packages, you will get some extra features in the citation
2518 dialog and you can select the style of the reference (
2519 \begin_inset Quotes eld
2523 \begin_inset Quotes erd
2527 \begin_inset Quotes eld
2531 \begin_inset Quotes erd
2535 \begin_inset Quotes eld
2539 \begin_inset Quotes erd
2543 \begin_inset Quotes eld
2547 \begin_inset Quotes erd
2551 Note that either package needs specifically designed style files.
2552 They all ship their own, but there are lots of additional style files,
2553 and there is even an interactive style file builder
2557 \begin_layout Plain Layout
2559 \begin_inset Flex URL
2562 \begin_layout Plain Layout
2564 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2575 \begin_inset Flex Code
2578 \begin_layout Plain Layout
2587 \begin_layout Subsection
2588 Subdivided Bibliographies
2591 \begin_layout Standard
2592 Sometimes you might need to divide your bibliography into several sections.
2593 If you are for instance a historian, the possibility to separate sources
2594 and scientific works is most likely a
2595 \begin_inset Quotes eld
2599 \begin_inset Quotes erd
2603 Unfortunately, Bib\SpecialChar TeX
2604 itself does not allow you to do this.
2605 But with the help of some \SpecialChar LaTeX
2606 packages, Bib\SpecialChar TeX
2607 can be extended to fit your needs.
2610 \begin_layout Standard
2612 provides native support for one of these packages,
2620 \begin_layout Plain Layout
2622 \begin_inset Flex URL
2625 \begin_layout Plain Layout
2627 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2637 The advantage of this package (compared to other packages such as
2641 ) is that you don't need to define new citation commands.
2642 Instead, you need to prepare different bibliographic databases which include
2643 the entries for the different sections of the bibliography.
2644 For example: If you want to divide your bibliography into the sections
2646 \begin_inset Quotes eld
2650 \begin_inset Quotes erd
2654 \begin_inset Quotes eld
2658 \begin_inset Quotes erd
2661 , you first need to create two bibliographic databases, e.
2662 \begin_inset space \thinspace{}
2666 \begin_inset space \space{}
2670 \begin_inset Flex Code
2673 \begin_layout Plain Layout
2680 \begin_inset Flex Code
2683 \begin_layout Plain Layout
2693 \begin_layout Standard
2695 \begin_inset Flex Noun
2698 \begin_layout Plain Layout
2699 Document\SpecialChar menuseparator
2706 \begin_inset Flex Noun
2709 \begin_layout Plain Layout
2716 \begin_inset Flex Noun
2719 \begin_layout Plain Layout
2720 Subdivided bibliography
2726 Now you can insert multiple Bib\SpecialChar TeX
2727 bibliographies, one for each section of
2729 Returning to our example: Insert the Bib\SpecialChar TeX
2731 \begin_inset Flex Code
2734 \begin_layout Plain Layout
2740 and a second one for the database
2741 \begin_inset Flex Code
2744 \begin_layout Plain Layout
2751 You are free to use the same or different styles for each section.
2752 Additionally, you can choose if the bibliography section should contain
2754 \begin_inset Quotes eld
2757 all cited references
2758 \begin_inset Quotes erd
2761 of the specified database(s) (which is the default),
2762 \begin_inset Quotes eld
2765 all uncited references
2766 \begin_inset Quotes erd
2770 \begin_inset Quotes eld
2774 \begin_inset Quotes erd
2778 This might be useful if you would like to separate your bibliography into
2780 \begin_inset Quotes eld
2784 \begin_inset Quotes erd
2788 \begin_inset Quotes eld
2792 \begin_inset Quotes erd
2796 \begin_inset Quotes eld
2800 \begin_inset Quotes erd
2804 The titles for the sections can be added as ordinary sections or subsections.
2806 \begin_inset Flex Code
2809 \begin_layout Plain Layout
2815 removes the bibliography title, you have to manually re-add that, too (as
2816 a chapter* or section*, for instance).
2819 \begin_layout Standard
2824 , the procedure is a bit different.
2833 , the aforementioned
2834 \begin_inset Flex Noun
2837 \begin_layout Plain Layout
2838 Subdivided bibliography
2843 option is disabled if you use
2852 provides its own means to generate subdivided bibliographies.
2853 You can either add keywords to bibliography entries via the
2854 \begin_inset Flex Code
2857 \begin_layout Plain Layout
2863 entry option and then filter bibliography sections by keyword (by adding
2865 \begin_inset Flex Code
2868 \begin_layout Plain Layout
2875 \begin_inset Flex Noun
2878 \begin_layout Plain Layout
2884 field of the dialog that opens if you left-click on the
2885 \begin_inset Flex Noun
2888 \begin_layout Plain Layout
2889 Biblatex Generated Bibliography
2894 button), or you can filter by entry types (such as
2903 \begin_inset space \thinspace{}
2908 \begin_inset Flex Code
2911 \begin_layout Plain Layout
2918 \begin_inset Flex Code
2921 \begin_layout Plain Layout
2928 \begin_inset Flex Noun
2931 \begin_layout Plain Layout
2937 field, or you can create so-called
2938 \begin_inset Quotes eld
2941 Bibliography Categories
2942 \begin_inset Quotes erd
2945 to which you can assign individual entries.
2946 Please refer to the Biblatex manual, section
2948 Subdivided Bibliographies
2953 \begin_layout Subsection
2954 Multiple Bibliographies
2955 \begin_inset CommandInset label
2957 name "subsec:Multiple-Bibliographies"
2964 \begin_layout Standard
2965 Multiple bibliographies, e.
2966 \begin_inset space \thinspace{}
2970 \begin_inset space \space{}
2973 a bibliography for each part, chapter, section, subsection or child (sub-documen
2974 t) of the document, are also supported by \SpecialChar LyX
2976 In order to enable it, go to
2977 \begin_inset Flex Noun
2980 \begin_layout Plain Layout
2981 Document\SpecialChar menuseparator
2982 Settings\SpecialChar menuseparator
2988 and select the relevant unit (e.
2989 \begin_inset space \thinspace{}
2993 \begin_inset Quotes eld
2997 \begin_inset Quotes erd
3001 \begin_inset Flex Noun
3004 \begin_layout Plain Layout
3005 Multiple Bibliographies
3011 Then add a Bib(la)\SpecialChar TeX
3012 bibliography to each unit (e.
3013 \begin_inset space \thinspace{}
3016 g., section) of your document.
3017 In the output, a separate bibliography, containing only the references
3018 done in the current unit is generated.
3021 \begin_layout Standard
3022 If you use Bib\SpecialChar TeX
3024 \begin_inset Flex Code
3027 \begin_layout Plain Layout
3034 \begin_inset Flex Code
3037 \begin_layout Plain Layout
3043 package is used to create multiple bibliographies.
3044 The former package is used if you select
3045 \begin_inset Quotes eld
3049 \begin_inset Quotes erd
3057 \begin_inset Flex Noun
3060 \begin_layout Plain Layout
3061 Sectioned Bibliography
3068 \begin_inset Flex Code
3071 \begin_layout Plain Layout
3081 \begin_layout Plain Layout
3082 An alternative approach, if you are willing to use some
3083 \begin_inset Flex Noun
3086 \begin_layout Plain Layout
3094 \begin_inset space ~
3098 \begin_inset CommandInset ref
3100 reference "sec:Inserting-TeX-Code"
3105 \begin_inset Flex Code
3108 \begin_layout Plain Layout
3120 \begin_inset Flex Code
3123 \begin_layout Plain Layout
3129 is used, \SpecialChar LyX
3130 encloses the specified units in
3131 \begin_inset Flex Code
3134 \begin_layout Plain Layout
3141 \begin_inset Flex Code
3144 \begin_layout Plain Layout
3153 \begin_inset Flex Code
3156 \begin_layout Plain Layout
3164 in order to create the units.
3165 Note that this approach has some limitations.
3166 First, every citation reference has to be inside some
3167 \begin_inset Flex Code
3170 \begin_layout Plain Layout
3177 So citations outside a defined unit (e.
3178 \begin_inset space \thinspace{}
3181 g., before the first section if you use
3182 \begin_inset Quotes eld
3186 \begin_inset Quotes erd
3190 \begin_inset Quotes eld
3194 \begin_inset Quotes erd
3198 You can also create your own units by entering
3199 \begin_inset Flex Code
3202 \begin_layout Plain Layout
3211 \begin_inset Flex Code
3214 \begin_layout Plain Layout
3223 code (for instance to work around the mentioned limitation).
3225 \begin_inset Flex Code
3228 \begin_layout Plain Layout
3235 A second limitation is that
3236 \begin_inset Flex Code
3239 \begin_layout Plain Layout
3245 always processes all references of a bibliography database, even if they
3247 This can result in odd labels (e.
3248 \begin_inset space \thinspace{}
3253 \begin_inset Quotes eld
3257 \begin_inset Quotes erd
3260 if two works of this author from 2014 are in the database, even if only
3264 \begin_layout Standard
3270 \begin_inset Flex Code
3273 \begin_layout Plain Layout
3279 option is used instead.
3280 If you need specific units, you can start them with the \SpecialChar TeX
3282 \begin_inset Flex Code
3285 \begin_layout Plain Layout
3294 \begin_inset Flex Code
3297 \begin_layout Plain Layout
3306 If you also want to control the end of the unit, use the environment
3307 \begin_inset Flex Code
3310 \begin_layout Plain Layout
3320 \begin_inset Flex Code
3323 \begin_layout Plain Layout
3333 \begin_inset Flex Code
3336 \begin_layout Plain Layout
3343 In addition to the individual bibliography of the current unit,
3347 also provides an easy way to output all bibliographies, subsequently, at
3349 \begin_inset space \thinspace{}
3352 g., at the end of the document).
3354 \begin_inset Quotes eld
3358 \begin_inset Quotes erd
3361 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3367 manual for more information on this topic.
3370 \begin_layout Section
3374 \begin_layout Subsection
3378 \begin_layout Standard
3379 When you are working on a large file with many sections, it is often convenient
3380 to break up the document into several files, or perhaps you have something
3381 where a table may change from time to time, but the preceding text does
3383 In these cases, you should seriously consider using multipart documents.
3384 For example, scientific papers often have five major sections: the introduction
3385 , observations, results, discussion, and conclusion.
3386 Each of these could be its own separate \SpecialChar LyX
3388 \begin_inset Quotes eld
3392 \begin_inset Quotes erd
3395 file which contains the title, authors, abstract, references, etc., plus
3396 the five included files.
3397 It is important to note that each of these files is a full \SpecialChar LyX
3399 can be formatted and printed on its own, as well as included in a master
3401 Each of these files must have the same document class, however—don't attempt
3402 to mix book classes with article classes.
3403 You may also include \SpecialChar LaTeX
3404 files; however, these files must not have their own
3406 \begin_inset space \thinspace{}
3410 \begin_inset space \space{}
3413 everything up to and including the
3414 \begin_inset Flex Code
3417 \begin_layout Plain Layout
3426 \begin_inset Flex Code
3429 \begin_layout Plain Layout
3437 line must be deleted) or else errors will be generated when you try to
3441 \begin_layout Standard
3443 allows you to include files quite easily with
3444 \begin_inset Flex Noun
3447 \begin_layout Plain Layout
3448 Insert\SpecialChar menuseparator
3450 \begin_inset space ~
3459 When you click on this selection a small box is inserted into the file
3460 at the current cursor location.
3461 Clicking on the box raises a dialog which allows you to select the file
3462 to be included, and the method of its inclusion.
3466 \begin_layout Standard
3467 The file selection box should by now be obvious.
3468 The three inclusion methods are
3469 \begin_inset Quotes eld
3473 \begin_inset Quotes erd
3477 \begin_inset Quotes eld
3481 \begin_inset Quotes erd
3485 \begin_inset Quotes eld
3489 \begin_inset Quotes erd
3494 \begin_inset Quotes eld
3498 \begin_inset Quotes erd
3502 \begin_inset Quotes eld
3506 \begin_inset Quotes erd
3509 are similar in many ways, but there are also some notable differences:
3512 \begin_layout Enumerate
3514 \begin_inset Quotes eld
3518 \begin_inset Quotes erd
3521 are typeset beginning on a new page, while files that are
3522 \begin_inset Quotes eld
3526 \begin_inset Quotes erd
3529 are typeset starting on the current page.
3532 \begin_layout Enumerate
3533 \begin_inset Quotes eld
3537 \begin_inset Quotes erd
3540 files cannot themselves
3541 \begin_inset Quotes eld
3545 \begin_inset Quotes erd
3549 \begin_inset Quotes eld
3553 \begin_inset Quotes erd
3558 \begin_inset Quotes eld
3562 \begin_inset Quotes erd
3565 , on the other hand, infinite sub-inputting is possible.
3568 \begin_layout Enumerate
3569 \begin_inset Quotes eld
3573 \begin_inset Quotes erd
3576 allow for the output of only selected
3577 \begin_inset Quotes eld
3581 \begin_inset Quotes erd
3584 files, while maintaining the actual counters (pagination etc.) and references
3585 (please refer to the section
3588 \begin_inset space ~
3596 \begin_inset space ~
3601 manual for details).
3604 \begin_layout Standard
3606 \begin_inset Quotes eld
3610 \begin_inset Quotes erd
3613 is the preferred method for chapters that are outsourced to child documents,
3615 \begin_inset Quotes eld
3619 \begin_inset Quotes erd
3622 is more suitable for arbitrary file inheritance.
3625 \begin_layout Standard
3627 \begin_inset Quotes eld
3631 \begin_inset Quotes erd
3634 included file allows you to include a file typeset exactly as it appears
3636 \begin_inset space \thinspace{}
3640 \begin_inset space \space{}
3644 \begin_inset Flex Code
3647 \begin_layout Plain Layout
3653 mode, with the characters set in a fixed-width typewriter font.
3654 Normally, spaces in this file are invisible, though two consecutive spaces
3655 are conserved, unlike \SpecialChar LyX
3656 's normal treatment of spaces.
3657 However, setting the
3658 \begin_inset Flex Noun
3661 \begin_layout Plain Layout
3663 \begin_inset space ~
3667 \begin_inset space ~
3671 \begin_inset space ~
3679 checkbox typesets a mark to unambiguously define the presence of a space.
3683 \begin_layout Standard
3684 Generally, the master file is converted into a full \SpecialChar LaTeX
3685 file before typesetting,
3686 while the included files are converted to \SpecialChar LaTeX
3687 files that do not have all the
3688 preamble information.
3691 \begin_layout Subsection
3692 Cross-References Between Files
3695 \begin_layout Standard
3696 \begin_inset Box Shadowbox
3706 height_special "totalheight"
3711 backgroundcolor "none"
3714 \begin_layout Plain Layout
3715 This section is somewhat out of date.
3716 Need to describe default master documents and how children are opened when
3726 \begin_layout Standard
3727 It is possible to set up cross-references between the different files.
3728 First, open all the files in question: let's call them A and B in a two
3729 file example, where B is included in A.
3730 Let's say you insert a label in A, then want to reference it in B.
3731 Open the cross-reference dialog whilst in document B, and you can select
3733 \begin_inset Quotes eld
3737 \begin_inset Quotes erd
3743 \begin_layout Subsection
3744 Bibliography Lists in all Subdocuments
3747 \begin_layout Standard
3748 If you work with child documents, you might want to have only one main bibliogra
3749 phy at the end, but still be able to have a selected bibliography for the
3750 child if you output it on its own.
3751 Here is how to achieve this.
3754 \begin_layout Standard
3755 For the main document, you just insert a bibliography inset at the place
3756 where the main bibliography has to appear (within the master file or within
3758 If the bibliography inset is in the master file, the references will be
3759 inherited by all children, so they are available in the citation dialog
3763 \begin_layout Standard
3764 For child-specific bibliographies, insert bibliography insets within the
3765 child documents, at the place where the bibliography should appear when
3766 the child is compiled separately.
3767 However, the trick is to insert them into a branch (
3769 Insert\SpecialChar menuseparator
3770 Branch\SpecialChar menuseparator
3771 Insert New Branch...
3774 \begin_inset space \thinspace{}
3779 \begin_inset Quotes eld
3783 \begin_inset Quotes erd
3787 Within the children, activate the branch (
3789 Document\SpecialChar menuseparator
3790 Settings...\SpecialChar menuseparator
3794 Within the master, deactivate the branch (
3796 Document\SpecialChar menuseparator
3797 Settings...\SpecialChar menuseparator
3801 Now the child's bibliography will be ignored by the master, but considered
3805 \begin_layout Standard
3806 If you need multiple bibliographies (e.
3807 \begin_inset space \thinspace{}
3810 g., one per child in the
3814 ), please refer to sec.
3815 \begin_inset space ~
3819 \begin_inset CommandInset ref
3821 reference "subsec:Multiple-Bibliographies"
3828 \begin_layout Section
3833 \begin_layout Standard
3834 Users sometimes need to be able to
3835 \begin_inset Quotes eld
3839 \begin_inset Quotes erd
3843 file together with all the images (and other files) on which it depends,
3844 either for sending to a publisher or for sharing with a co-author.
3846 includes a Python script (
3847 \begin_inset Flex Code
3850 \begin_layout Plain Layout
3856 ) that automates this process.
3857 To use it, you must have either the
3858 \begin_inset Flex Code
3861 \begin_layout Plain Layout
3868 \begin_inset Flex Code
3871 \begin_layout Plain Layout
3877 python modules installed on your system.
3878 By default, the script prefers the
3879 \begin_inset Flex Code
3882 \begin_layout Plain Layout
3889 \begin_inset Flex Code
3892 \begin_layout Plain Layout
3898 format on Unix-like systems and the
3899 \begin_inset Flex Code
3902 \begin_layout Plain Layout
3911 \begin_layout Standard
3913 's configuration process will set the script up to export a `\SpecialChar LyX
3915 and this format will then be available under
3916 \begin_inset Flex Code
3919 \begin_layout Plain Layout
3920 File\SpecialChar menuseparator
3929 \begin_layout Standard
3930 Independently of the platform, the generation of a particular archive format
3931 can be forced by adding either the
3932 \begin_inset Flex Code
3935 \begin_layout Plain Layout
3942 \begin_inset Flex Code
3945 \begin_layout Plain Layout
3952 \begin_inset Flex Code
3955 \begin_layout Plain Layout
3962 \begin_inset Flex Code
3965 \begin_layout Plain Layout
3971 format) switch to the
3972 \begin_inset Flex Code
3975 \begin_layout Plain Layout
3977 \SpecialChar menuseparator
3985 \begin_inset Flex Code
3988 \begin_layout Plain Layout
3989 Tools\SpecialChar menuseparator
3990 Preferences\SpecialChar menuseparator
3991 File Handling\SpecialChar menuseparator
3998 (Make sure you add the switch after the script name, not before it.)
4001 \begin_layout Section
4002 Fancy Headers and Footers
4005 \begin_layout Standard
4006 The default page layout is rather plain; for an
4007 \begin_inset Flex Code
4010 \begin_layout Plain Layout
4016 document class, all you get is a centered page number at the bottom of
4018 This document uses KOMA-script's book class, so it appears to be a bit
4020 But to really put on a show, you need to set the document page style to
4022 \begin_inset Quotes eld
4026 \begin_inset Quotes erd
4029 , as mentioned in the
4034 This section describes the \SpecialChar LaTeX
4035 code you need to insert in your \SpecialChar LaTeX
4037 order to get the desired effects.
4040 \begin_layout Standard
4041 For more information on fancy headers, see the
4042 \begin_inset Flex Code
4045 \begin_layout Plain Layout
4051 package documentation.
4053 \begin_inset Flex URL
4056 \begin_layout Plain Layout
4058 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4066 \begin_layout Standard
4067 The page header is divided into three fields, not surprisingly labeled
4068 \begin_inset Quotes eld
4072 \begin_inset Quotes erd
4076 \begin_inset Quotes eld
4080 \begin_inset Quotes erd
4084 \begin_inset Quotes eld
4088 \begin_inset Quotes erd
4092 The footer is also divided into these three fields.
4093 The \SpecialChar LaTeX
4094 commands to set these fields in the simplest manner are
4095 \begin_inset Flex Code
4098 \begin_layout Plain Layout
4107 \begin_inset Flex Code
4110 \begin_layout Plain Layout
4119 \begin_inset Flex Code
4122 \begin_layout Plain Layout
4131 \begin_inset Flex Code
4134 \begin_layout Plain Layout
4143 Suppose you wish to put your name in the upper left hand corner of each
4145 Simply insert the following command in the preamble:
4148 \begin_layout Standard
4157 \begin_layout Standard
4158 You will now see your name in the upper left.
4159 If a field has a default entry that you would like to get rid of (often
4160 the page number appears in the central footer) simply include a command
4161 with a blank argument, e.
4162 \begin_inset space \thinspace{}
4168 \begin_layout Standard
4176 \begin_layout Standard
4177 Let's get really fancy: lets put the section number with the word
4178 \begin_inset Quotes eld
4182 \begin_inset Quotes erd
4186 \begin_inset space \thinspace{}
4190 \begin_inset space \space{}
4193 Section 3) in the upper left, the page number (e.
4194 \begin_inset space \thinspace{}
4198 \begin_inset space \space{}
4201 Page 4) in the upper right, your name in the lower left, and the date in
4203 The following commands should now appear in the preamble:
4206 \begin_layout Standard
4216 \begin_layout Standard
4224 \begin_layout Standard
4234 \begin_layout Standard
4243 \begin_layout Standard
4251 \begin_layout Standard
4261 \begin_layout Standard
4263 \begin_inset Flex Code
4266 \begin_layout Plain Layout
4275 \begin_inset Flex Code
4278 \begin_layout Plain Layout
4286 access \SpecialChar LaTeX
4287 's section and page counters, and so print out the current section
4290 \begin_inset Flex Code
4293 \begin_layout Plain Layout
4301 simply prints out today's date.
4304 \begin_layout Standard
4305 The thicknesses of the horizontal rules drawn beneath the header and above
4306 the footer can also be modified.
4307 If you don't want one of the rules, set its thickness to 0.
4308 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4314 \begin_inset Flex Code
4317 \begin_layout Plain Layout
4322 headrulewidth}{0.4pt}
4328 \begin_inset Flex Code
4331 \begin_layout Plain Layout
4336 footrulewidth}{0.4pt}
4341 to set the thicknesses.
4344 \begin_layout Standard
4345 You can switch the header/footer settings on and off for individual pages
4347 \begin_inset Flex Code
4350 \begin_layout Plain Layout
4353 thispagestyle{empty}
4359 \begin_inset Flex Code
4362 \begin_layout Plain Layout
4365 thispagestyle{plain}
4371 \begin_inset Flex Code
4374 \begin_layout Plain Layout
4377 thispagestyle{fancy}
4383 Simply insert them in the text on the page you want changed and mark them
4386 In fact, title pages are marked as plain by default, while following pages
4387 are marked fancy when using the global fancy setting.
4390 \begin_layout Standard
4391 As a final example, it is possible to include an image in the header or
4393 Suppose you want to put a company logo in the upper lefthand corner.
4394 You might try something like
4397 \begin_layout Standard
4406 includegraphics{logo.eps}}}
4409 \begin_layout Standard
4411 (you may need to preface this with
4412 \begin_inset Flex Code
4415 \begin_layout Plain Layout
4418 usepackage{graphics}
4423 if you don't include graphics elsewhere in your document).
4426 \begin_layout Section
4427 Itemize Bullet Selection
4428 \begin_inset CommandInset label
4437 \begin_layout Standard
4443 \begin_layout Subsection
4447 \begin_layout Standard
4449 provides 216 bullet shapes that can be accessed from a simple dialog.
4450 Using this dialog you can easily specify what bullet shape to use at each
4451 level of an itemized list.
4452 These settings are document-wide so you won't be able to specify different
4453 sets of bullets for different paragraphs.
4457 \begin_layout Plain Layout
4458 Well, actually you can but you'll have to do it by hand.
4466 \begin_layout Subsection
4470 \begin_layout Standard
4471 Open the dialog by selecting the
4472 \begin_inset Flex Noun
4475 \begin_layout Plain Layout
4476 Document\SpecialChar menuseparator
4482 menu item and then select the
4483 \begin_inset Flex Noun
4486 \begin_layout Plain Layout
4495 \begin_layout Standard
4496 The dialog provides you with a table of bullet shapes.
4497 A column of buttons on the left of the table provides access to the six
4498 different panels of bullet shapes.
4499 The row of buttons across the top is used to select which bullet depth
4501 A text entry under the table shows the currently selected bullet shape's
4503 equivalent and this can be edited if desired.
4504 If you do modify the text you will also need to specify any needed packages
4505 in the \SpecialChar LaTeX
4509 \begin_layout Standard
4510 The six panels are divided up by the packages they require.
4511 The following table shows the mappings from button name to \SpecialChar LaTeX
4515 \begin_layout Standard
4517 \begin_inset Tabular
4518 <lyxtabular version="3" rows="7" columns="2">
4519 <features tabularvalignment="middle">
4520 <column alignment="center" valignment="top" width="0pt">
4521 <column alignment="center" valignment="top" width="0pt">
4523 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4526 \begin_layout Plain Layout
4541 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4544 \begin_layout Plain Layout
4561 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4564 \begin_layout Plain Layout
4579 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4582 \begin_layout Plain Layout
4591 base \SpecialChar LaTeX
4599 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4602 \begin_layout Plain Layout
4617 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4620 \begin_layout Plain Layout
4637 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4640 \begin_layout Plain Layout
4655 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4658 \begin_layout Plain Layout
4675 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4678 \begin_layout Plain Layout
4693 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4696 \begin_layout Plain Layout
4713 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4716 \begin_layout Plain Layout
4731 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4734 \begin_layout Plain Layout
4751 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4754 \begin_layout Plain Layout
4769 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4772 \begin_layout Plain Layout
4795 \begin_layout Standard
4797 doesn't stop you using bullets from packages you don't have.
4798 If you get errors from \SpecialChar LaTeX
4799 when you try to view or print the file, then it
4800 is likely you are missing a package.
4804 \begin_layout Plain Layout
4806 doesn't restrict your use since you may be editing locally and exporting
4815 \begin_layout Subsection
4819 \begin_layout Standard
4820 Select which bullet depth you want to change then select the bullet shape
4822 Any changes will not be visible in \SpecialChar LyX
4823 , but are visible when viewing the document.
4826 \begin_layout Standard
4827 You can reset a bullet shape to the default simply by clicking your right
4828 mouse button on the appropriate bullet depth button.
4832 \begin_layout Plain Layout
4837 want to have multiple sets of paragraphs with different sets of bullets
4838 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4840 The bullet selection dialog can help though because it provides you with
4841 the \SpecialChar LaTeX
4842 code for a wide range of bullet shapes.
4843 To make your own custom paragraphs you have the following options:
4846 \begin_layout Plain Layout
4850 \begin_layout Plain Layout
4866 \begin_layout Plain Layout
4870 \begin_layout Plain Layout
4892 \begin_layout Itemize
4893 Use the \SpecialChar LaTeX
4895 \begin_inset Flex Code
4898 \begin_layout Plain Layout
4906 to specify a new bullet shape for a given depth.
4907 You'll also need to save the current bullet shape so you can restore it
4909 In this itemized list the following \SpecialChar LaTeX
4910 code was used to change the bullet
4911 used for the first depth.
4915 \begin_layout LyX-Code
4925 \begin_layout LyX-Code
4942 \begin_layout Itemize
4943 Note that the itemize depth is specified in Roman numerals as part of the
4953 \begin_layout Itemize
4954 \begin_inset Argument item:1
4957 \begin_layout Plain Layout
4961 \begin_layout Plain Layout
4979 Specify each individual entry by starting each item with the bullet shape
4981 \begin_inset Quotes eld
4985 \begin_inset Quotes erd
4990 Insert\SpecialChar menuseparator
4994 \begin_inset Flex Noun
4997 \begin_layout Plain Layout
5005 For example, this item was started with
5006 \begin_inset Flex Code
5009 \begin_layout Plain Layout
5024 \begin_layout Plain Layout
5028 \begin_layout Plain Layout
5044 \begin_layout Plain Layout
5045 You'll also need to revert the labelitem back to its previous setting for
5046 the global bullet shape settings to remain in effect.
5047 The way used here was:
5050 \begin_layout LyX-Code
5065 \begin_layout Chapter
5067 and the World Wide Web
5070 \begin_layout Standard
5072 has long supported the export of documents to various web-friendly formats,
5074 Before version 2.0, however, HTML export was always accomplished by the
5075 use of external converters.
5079 \begin_layout Plain Layout
5080 For details on the use of external converters with \SpecialChar LyX
5085 section of the Customization manual.
5090 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5092 intermediate format, such as
5093 \begin_inset Flex Code
5096 \begin_layout Plain Layout
5103 \begin_inset Flex Code
5106 \begin_layout Plain Layout
5113 \begin_inset Flex Code
5116 \begin_layout Plain Layout
5122 , relying upon \SpecialChar LyX
5123 to produce the \SpecialChar LaTeX
5124 ; and there is a converter that works directly
5127 \begin_inset Flex Code
5130 \begin_layout Plain Layout
5138 All of these have different advantages and disadvantages.
5142 \begin_layout Standard
5143 The \SpecialChar LaTeX
5144 -based converters have the advantage that, in principle, they know everythin
5145 g about the exported document that \SpecialChar LaTeX
5147 Such converters do not care, for example, if a certain block of code was
5148 produced by \SpecialChar LyX
5149 or was Evil Red Text.
5150 These converters know about
5151 \begin_inset Flex Code
5154 \begin_layout Plain Layout
5160 files, counters, and references, and can often make use of the
5161 \begin_inset Flex Code
5164 \begin_layout Plain Layout
5170 files generated by Bib\SpecialChar TeX
5172 On the other hand, \SpecialChar LaTeX
5173 is a very hard language to parse—it is sometimes said
5174 that only \SpecialChar TeX
5175 itself understands \SpecialChar TeX
5176 —and \SpecialChar LaTeX
5177 -based converters will often choke on
5178 what seem to be quite simple constructs; complex ones can throw them completely
5179 , and as of this writing, for example, the
5183 manual will not export with
5184 \begin_inset Flex Code
5187 \begin_layout Plain Layout
5193 , though the others will.
5194 The other issue concerns how math is handled.
5195 These converters typically convert the formulae into little pictures that
5196 are then linked from the HTML document.
5197 Since these are actually generated by \SpecialChar LaTeX
5198 , they are accurate.
5199 But they do not scale well, and just getting them to look as if they are
5200 actually meant to be in your document—so that the font sizes seem to be
5201 roughly the same—can be a challenge.
5204 \begin_layout Standard
5206 \begin_inset Flex Code
5209 \begin_layout Plain Layout
5217 \begin_inset CommandInset href
5219 name "http://pinchito.es/elyxer/"
5220 target "http://pinchito.es/elyxer/"
5225 ) solves some of these problems.
5226 In particular, the formulae it produces scale perfectly, since it renders
5227 math using a combination of HTML and CSS rather than converting the formulae
5229 But even moderately complex formula are rendered less well than with
5230 \begin_inset Flex Code
5233 \begin_layout Plain Layout
5239 ; this reflects the limitations of HTML.
5243 \begin_layout Plain Layout
5245 \begin_inset Flex Code
5248 \begin_layout Plain Layout
5255 can also use jsMath and MathJax for equations, but this setting is only
5256 available globally and requires one to have access to a server that runs
5262 More importantly (as of version 1.1.1, at least),
5263 \begin_inset Flex Code
5266 \begin_layout Plain Layout
5273 has limited support for math macros and no support for user-defined paragraph
5274 or character styles.
5275 These limitations make
5276 \begin_inset Flex Code
5279 \begin_layout Plain Layout
5286 unsuitable for many of the documents \SpecialChar LyX
5288 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5290 have decided to follow a different path and have made \SpecialChar LyX
5292 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5293 , DocBook, and plaintext.
5296 \begin_layout Standard
5297 As of this writing, XHTML output remains under development and should probably
5299 \begin_inset Quotes eld
5303 \begin_inset Quotes erd
5310 \begin_layout Plain Layout
5312 \begin_inset Flex Code
5315 \begin_layout Plain Layout
5316 development/HTML/HTML.notes
5321 , which can be found in the \SpecialChar LyX
5323 \begin_inset CommandInset href
5325 name "accessed online"
5326 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5331 , usually contains up-to-date information about the state of XHTML output.
5332 See also the list of XHTML bugs on
5333 \begin_inset CommandInset href
5335 name "the bug tracker"
5336 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"
5346 Still, the developers have chosen this approach because it has several
5347 potential advantages over the other two.
5350 \begin_layout Standard
5351 These advantages are primarily due to the fact that the XHTML output routines,
5352 since they are part of \SpecialChar LyX
5353 , know everything \SpecialChar LyX
5354 knows about the document being
5359 \begin_layout Plain Layout
5360 Another advantage is that, since these routines are internal to \SpecialChar LyX
5362 immune to changes in \SpecialChar LyX
5363 's file format, or to changes in the semantics of
5369 So they know about the table of contents (as displayed in the outline),
5370 about the counters associated with different paragraph styles, and about
5371 user-defined styles.
5372 The XHTML output routines know what \SpecialChar LyX
5373 knows about internationalization,
5374 too, so they will output
5375 \begin_inset Quotes eld
5379 \begin_inset Quotes erd
5383 \begin_inset Quotes eld
5391 \begin_inset Quotes erd
5394 , depending upon the language in effect at the time.
5398 \begin_layout Standard
5399 Quite generally, the output routines know what \SpecialChar LyX
5400 knows about document layout,
5401 that is, about how the document is to be rendered on screen.
5402 We use this information when we output the document as XHTML.
5403 In particular, \SpecialChar LyX
5408 generates CSS style information corresponding to the layout information
5409 it uses to render the document on screen: if section headings are supposed
5410 to be sans-serif and bold as seen in \SpecialChar LyX
5411 , then (by default) they will be sans-seri
5412 f and bold when viewed in a web browser, too.
5413 And this is true not just for pre-defined styles, like Section, but for
5414 any style, including user-defined styles.
5415 Indeed, the XHTML output routines make no distinction between user-defined
5416 paragraph and character styles and \SpecialChar LyX
5417 's own pre-defined styles: in each case,
5418 everything \SpecialChar LyX
5419 knows about the styles is contained in the layout files.
5420 And much the same is true as regards pre-defined textual insets, such as
5421 footnotes, and various custom insets.
5425 \begin_layout Standard
5426 The result is that XHTML output can be customized and extended in exactly
5427 the same way \SpecialChar LaTeX
5428 output can be customized and extended: through layout files
5430 See chapter five of the
5434 manual for the details.
5437 \begin_layout Standard
5438 The remainder of this chapter contains more detailed information on XHTML
5439 output, its limitations, and ways to work around those limitations.
5442 \begin_layout Section
5443 Math Output in XHTML
5446 \begin_layout Standard
5448 offers four choices for how math is rendered.
5449 These have various advantages and disadvantages:
5452 \begin_layout Itemize
5454 \begin_inset Newline newline
5457 MathML is a dialect of XML designed specifically for mathematics on the
5458 web, and it typically renders very well in browsers that support it.
5459 The disadvantage is that not all browsers support MathML, and support is
5460 not complete even in the Gecko-based browsers, such as Firefox.
5461 \begin_inset Newline newline
5465 is unable to render a formula as MathML—for example, if the formula
5467 \begin_inset Flex Code
5470 \begin_layout Plain Layout
5476 package or ERT—then it will instead output the formula as an image.
5480 \begin_layout Itemize
5482 \begin_inset Newline newline
5486 \begin_inset Flex Code
5489 \begin_layout Plain Layout
5495 outputs math as HTML, styled by CSS.
5499 \begin_layout Plain Layout
5501 has borrowed some of the CSS for its HTML output from
5502 \begin_inset Flex Code
5505 \begin_layout Plain Layout
5516 For simple formulae, this can work quite well, though with more complicated
5517 formulae it tends to break down.
5518 Still, this method has the advantage that it is very widely supported and
5519 so it may be appropriate for documents that contain only a little, fairly
5521 \begin_inset Newline newline
5524 If Lyx is unable to render a formula as HTML—for example, if the formula
5526 \begin_inset Flex Code
5529 \begin_layout Plain Layout
5535 package or ERT—then it will instead output the formula as an image.
5539 \begin_layout Itemize
5541 \begin_inset Newline newline
5545 \begin_inset Flex Code
5548 \begin_layout Plain Layout
5555 will output formulae as images, the very same images, in fact, that are
5556 used for instant preview.
5560 \begin_layout Plain Layout
5561 Instant preview does
5565 have to be on for images to be output, however.
5570 The advantage to this method is that the images are simply generated by
5572 , so they are very accurate.
5573 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5574 so they do not scale terribly well, and one cannot copy them, etc.
5575 \begin_inset Newline newline
5578 The size of the images can be controlled by setting the
5579 \begin_inset Quotes eld
5583 \begin_inset Quotes erd
5587 \begin_inset Flex Noun
5590 \begin_layout Plain Layout
5591 Document\SpecialChar menuseparator
5592 Settings\SpecialChar menuseparator
5602 \begin_layout Plain Layout
5603 For those who want to know, this controls the resolution of the image in
5604 dots per inch and is based upon a default of 75 dpi.
5610 \begin_inset Newline newline
5614 for some reason fails to create an image for a formula (e.g., if a required
5616 package is not installed), then it will fall back to outputing the raw
5621 \begin_layout Itemize
5624 \begin_inset Newline newline
5627 Finally, \SpecialChar LyX
5628 will happily output math as \SpecialChar LaTeX
5630 As well as being the output of last resort, this method can be used with
5632 \begin_inset CommandInset href
5635 target "http://www.math.union.edu/~dpvc/jsMath/"
5640 , which uses JavaScript to render \SpecialChar LaTeX
5641 embedded in HTML documents.
5643 wraps the \SpecialChar LaTeX
5645 \begin_inset Flex Code
5648 \begin_layout Plain Layout
5654 (for inline formulas) or
5655 \begin_inset Flex Code
5658 \begin_layout Plain Layout
5664 (for displayed formulas) with
5665 \begin_inset Flex Code
5668 \begin_layout Plain Layout
5674 , as is required for jsMath.
5677 \begin_layout Standard
5678 One of these output methods must be selected under
5679 \begin_inset Flex Noun
5682 \begin_layout Plain Layout
5683 Document\SpecialChar menuseparator
5684 Settings\SpecialChar menuseparator
5691 By default, \SpecialChar LyX
5693 This is a document-wide setting, therefore.
5696 \begin_layout Standard
5697 Eventually, \SpecialChar LyX
5698 will offer the user the option to select an alternate output
5699 method for a particular inset, say, one that isn't being rendered very
5704 \begin_layout Plain Layout
5705 That said, since \SpecialChar LyX
5706 falls back to images if the inset contains ERT, then one
5707 can force output as an image by putting some harmless ERT into the math,
5709 \begin_inset Formula $a=b\relax$
5720 \begin_layout Section
5721 Bibliography and Citations
5724 \begin_layout Standard
5725 XHTML output fully supports bibliographies and citations.
5729 \begin_layout Standard
5730 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5732 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5735 If you are using numerical citations, then \SpecialChar LyX
5736 will output numerical labels,
5737 such as [1] or [17], rather than simply showing the citation key in square
5738 brackets, as it does on-screen.
5739 If you are using author-year citations, then \SpecialChar LyX
5740 will add lowercase letters
5741 to the years, just as Bib\SpecialChar TeX
5742 does, if it finds more than one citation for
5743 a given author-year combination.
5744 The labels will be printed with the bibliography entries.
5745 Note that there is, at present, no way to customize the appearance of the
5746 labels, for example, to choose between square brackets and parentheses.
5749 \begin_layout Standard
5750 Bibliography output is handled by the same machinery that handles the presentati
5751 on of reference information in the citation dialog, so you will see in the
5752 XHTML output pretty much what you would see if you were to look at a given
5753 entry in the citation dialog.
5754 The formatting can be customized in your layout file or, preferably, in
5760 manual for the details.
5763 \begin_layout Standard
5764 The main defect at present is that cross-referenced information is printed
5765 with every entry with which it is associated.
5766 So you can see things like this:
5771 \begin_inset Quotes eld
5774 Context and Logical Form
5775 \begin_inset Quotes erd
5780 Language in Context: Selected Essays
5782 (Oxford: Oxford University Press, 2007), pp.
5788 \begin_inset Quotes eld
5791 Semantics in Context
5792 \begin_inset Quotes erd
5797 Language in Context: Selected Essays
5799 (Oxford: Oxford University Press, 2007), pp.
5803 \begin_layout Standard
5804 This should be fixed before long.
5807 \begin_layout Standard
5808 There is no support at present for sectioned bibliographies.
5809 If you have multiple bibliographies, then \SpecialChar LyX
5810 will print the same bibliography
5814 \begin_layout Section
5818 \begin_layout Standard
5820 will happily export indexes as XHTML, but with certain limitations at the
5824 \begin_layout Standard
5825 Index export will be most reliable when you do not attempt to use the fancy
5826 constructs that are described in the section on indexes in the
5834 \begin_layout Plain Layout
5835 The main issue here is that \SpecialChar LyX
5836 itself does not really handle these.
5837 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5843 We'll describe how they are handled using the subsection headings from
5847 \begin_layout Itemize
5848 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5849 makes an effort to support these,
5850 but the entries must be separated by
5851 \begin_inset Quotes eld
5855 \begin_inset Quotes erd
5858 , that is, there must be spaces around the exclamation point.
5859 This is because it is otherwise too difficult to check for escaped exclamation
5860 points, ones in math, and so forth.
5863 \begin_layout Itemize
5864 Page Ranges: There is no support at all for page ranges, since these make
5865 no sense with XHMTL.
5866 Instead, you will just get two index entries, one at either end.
5869 \begin_layout Itemize
5870 Cross-referencing: There is no support for cross-referencing.
5872 finds an entry containing the
5873 \begin_inset Quotes eld
5876 |see\SpecialChar ldots
5878 \begin_inset Quotes erd
5881 construct, it is just dropped, and the rest is treated as an ordinary index
5885 \begin_layout Itemize
5886 Index Entry Order: \SpecialChar LyX
5887 does support attempts to fix the sorting order.
5888 It will take what is before the first `@' it finds and use that for sorting,
5889 taking what follows the first `@' to be the actual entry.
5890 At present, \SpecialChar LyX
5891 does not check for escaped `@', so do not try to index email
5895 \begin_layout Itemize
5896 Index Entry Layout: You can format entries by using the text style dialog,
5897 or by using any other method available within \SpecialChar LyX
5899 There is no support for constructs like:
5900 \begin_inset Quotes eld
5904 \begin_inset Quotes erd
5908 Indeed, if \SpecialChar LyX
5909 finds a pipe symbol, `|', in an entry, it will delete it and
5910 everything that follows it.
5913 \begin_layout Itemize
5914 Multiple Indexes: There is no support for multiple indexes.
5915 Rather, all index entries will be printed as one large index.
5916 To avoid our printing several versions of the index, we print only the
5917 main index, so make sure you have one.
5920 \begin_layout Section
5921 Nomenclature and Glossary
5924 \begin_layout Standard
5925 There is at present no support for glossaries.
5926 Adding it would be fairly trivial, and welcome.
5929 \begin_layout Chapter
5930 The \SpecialChar LyX
5934 \begin_layout Section
5938 \begin_layout Standard
5939 The `\SpecialChar LyX
5940 server' allows other programs to talk to \SpecialChar LyX
5941 , invoke \SpecialChar LyX
5942 commands, and retrieve
5943 information about the \SpecialChar LyX
5945 This is only intended for advanced users, but they should find it useful.
5946 It is by writing to the \SpecialChar LyX
5947 server, for example, that bibliography managers,
5948 such as JabRef, are able to
5949 \begin_inset Quotes eld
5953 \begin_inset Quotes erd
5956 citations to \SpecialChar LyX
5960 \begin_layout Section
5961 Starting the \SpecialChar LyX
5963 \begin_inset CommandInset label
5965 name "sec:Starting-the-Server"
5972 \begin_layout Standard
5973 The \SpecialChar LyX
5974 server works through the use of a pair of named pipes.
5975 These are usually located in
5976 \begin_inset Flex Code
5979 \begin_layout Plain Layout
5985 , (except on Windows, where
5989 named pipes are special objects located in
5990 \begin_inset Flex Code
5993 \begin_layout Plain Layout
6005 ) and have the names
6006 \begin_inset Quotes eld
6010 \begin_inset Flex Code
6013 \begin_layout Plain Layout
6020 \begin_inset Quotes erd
6024 \begin_inset Quotes eld
6028 \begin_inset Flex Code
6031 \begin_layout Plain Layout
6038 \begin_inset Quotes erd
6042 External programs write into
6043 \begin_inset Flex Code
6046 \begin_layout Plain Layout
6052 and read back data from
6053 \begin_inset Flex Code
6056 \begin_layout Plain Layout
6063 The stem of the pipe names can be defined in the
6064 \begin_inset Flex Noun
6067 \begin_layout Plain Layout
6068 Tools\SpecialChar menuseparator
6075 \begin_inset Flex Code
6078 \begin_layout Plain Layout
6079 "/home/myhome/lyxpipe"
6085 \begin_inset Flex Code
6088 \begin_layout Plain Layout
6102 on Windows (where any working path instead of lyxpipe can be used, for
6104 \begin_inset Flex Code
6107 \begin_layout Plain Layout
6130 configure this manually in order for the server to start.
6133 \begin_layout Standard
6136 \begin_inset Flex Code
6139 \begin_layout Plain Layout
6146 \begin_inset Flex Code
6149 \begin_layout Plain Layout
6155 ' to create the pipes.
6156 If one of the pipes already exists, \SpecialChar LyX
6157 will assume that another \SpecialChar LyX
6159 is already running and will not start the server.
6160 On POSIX (Unix like) systems, if for some other reason, an unused
6161 \begin_inset Quotes eld
6165 \begin_inset Quotes erd
6168 pipe is left in existence when \SpecialChar LyX
6169 closes, then \SpecialChar LyX
6170 will try to delete it.
6171 If this fails for some reason, you will need to delete the pipes manually
6172 and then restart \SpecialChar LyX
6174 On Windows, pipes are deleted by the OS on program termination or crash,
6176 \begin_inset Quotes eld
6180 \begin_inset Quotes erd
6183 pipes should not be possible.
6186 \begin_layout Standard
6187 To have several \SpecialChar LyX
6188 processes with servers at the same time, you have to use
6189 different configurations, perhaps by using separate user directories, each
6191 \begin_inset Flex Code
6194 \begin_layout Plain Layout
6200 file, for each process.
6203 \begin_layout Standard
6204 If you are developing a client program, you might find it useful to enable
6205 debugging information from the \SpecialChar LyX
6207 Do this by starting \SpecialChar LyX
6209 \begin_inset Flex Code
6212 \begin_layout Plain Layout
6221 \begin_layout Standard
6222 You can find a complete example client written in C++ in the source distribution
6224 \begin_inset Flex Code
6227 \begin_layout Plain Layout
6228 development/lyxserver/server_monitor.cpp
6236 \begin_layout Standard
6237 Another useful tool is the command-line based client found in
6238 \begin_inset Flex Code
6241 \begin_layout Plain Layout
6242 src/client/lyxclient
6250 \begin_layout Section
6251 Normal communication
6254 \begin_layout Standard
6255 To issue a \SpecialChar LyX
6256 call, the client writes a line of ASCII text into the input
6258 This line has the following format:
6275 \begin_layout Description
6276 clientname is a name that the client can choose arbitrarily.
6277 Its only use is that \SpecialChar LyX
6278 will echo it if it sends an answer—so a client can
6279 dispatch results from different requesters.
6282 \begin_layout Description
6283 function is the function you want \SpecialChar LyX
6285 It is the same as the commands you'd use in the minibuffer.
6288 \begin_layout Description
6289 argument is an optional argument which is meaningful only to some functions
6291 \begin_inset Quotes eld
6295 \begin_inset Quotes erd
6298 LFUN will insert the argument as text at the cursor position).
6301 \begin_layout Standard
6302 The answer from \SpecialChar LyX
6303 will arrive in the output pipe and be of the form
6320 \begin_layout Standard
6329 are just echoed from the command request, while
6333 is more or less useful information filled according to how the command
6334 execution worked out.
6335 Some commands, such as
6336 \begin_inset Quotes eld
6340 \begin_inset Quotes erd
6343 , will return information about the internal state of \SpecialChar LyX
6345 return an empty data-response.
6346 This means that the command execution went fine.
6349 \begin_layout Standard
6350 In case of errors, the response from \SpecialChar LyX
6368 \begin_layout Standard
6373 should contain an explanation of why the command failed.
6376 \begin_layout Standard
6380 \begin_layout LyX-Code
6381 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6382 \begin_inset Newline newline
6385 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6386 \begin_inset Newline newline
6389 read a <~/.lyxpipe.out
6390 \begin_inset Newline newline
6396 \begin_layout Subsection
6397 AppleScript (Mac OS X)
6400 \begin_layout Standard
6401 Since \SpecialChar LyX
6402 2.1, \SpecialChar LyX
6403 supports basic interactions with AppleScript for normal communicatio
6404 n through the command run.
6405 This command takes a direct argument (the
6409 to perform) and an optional argument.
6410 It either returns the output of the function or triggers an error with
6411 the error message and code.
6414 \begin_layout Standard
6418 \begin_layout LyX-Code
6419 tell application "\SpecialChar LyX
6423 \begin_layout LyX-Code
6427 \begin_layout LyX-Code
6428 -- Stores the current file name into f
6431 \begin_layout LyX-Code
6432 set f to (run "server-get-filename" with argument "")
6435 \begin_layout LyX-Code
6436 on error the error_message number the error_number
6439 \begin_layout LyX-Code
6440 display dialog "Error: " & the error_number & ".
6444 \begin_layout LyX-Code
6445 & the error_message buttons {"OK"} default button 1
6448 \begin_layout LyX-Code
6452 \begin_layout LyX-Code
6456 \begin_layout Section
6460 \begin_layout Standard
6462 can notify clients of events going on asynchronously.
6463 Currently it will only do this if the user binds a key sequence with the
6465 \begin_inset Quotes eld
6469 \begin_inset Quotes erd
6473 The format of the string \SpecialChar LyX
6474 sends is as follows:
6478 \begin_inset Flex Code
6481 \begin_layout Plain Layout
6492 \begin_layout Standard
6497 is the printed representation of the key sequence that was actually typed
6501 \begin_layout Standard
6502 This mechanism can be used to extend \SpecialChar LyX
6503 's command set and implement macros.
6504 Bind some key sequence to
6505 \begin_inset Quotes eld
6509 \begin_inset Quotes erd
6513 Then start a client that listens on the output pipe, dispatches the command
6514 according to the sequence, and starts a function that may use \SpecialChar LyX
6517 requests to issue a command or a series of commands to \SpecialChar LyX
6521 \begin_layout Section
6522 The simple \SpecialChar LyX
6526 \begin_layout Standard
6528 implements a simple protocol that can be used for session management.
6529 All messages are of the form
6542 \begin_layout Standard
6548 \begin_inset Quotes eld
6552 \begin_inset Quotes erd
6556 \begin_inset Quotes eld
6560 \begin_inset Quotes erd
6565 \begin_inset Quotes eld
6569 \begin_inset Quotes erd
6572 is received from a client, \SpecialChar LyX
6573 will report back to inform the client that
6574 it's listening to it's messages, while
6575 \begin_inset Quotes eld
6579 \begin_inset Quotes erd
6582 sent from \SpecialChar LyX
6583 will inform clients that \SpecialChar LyX
6587 \begin_layout Section
6588 Reverse DVI/PDF search
6591 \begin_layout Standard
6592 Some DVI/PDF viewers
6596 \begin_layout Plain Layout
6597 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6598 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6607 facility (also called
6612 This means that you can tell \SpecialChar LyX
6613 to put the cursor to a specific line in the
6614 document by clicking at the respective position in the DVI/PDF output.
6615 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6617 This is done via the \SpecialChar LyX
6618 server either by using the named pipe (
6622 ), or the UNIX domain socket (
6626 ) that \SpecialChar LyX
6627 creates in its temporary directory (this is the way the
6628 \begin_inset Flex Code
6631 \begin_layout Plain Layout
6637 program communicates with \SpecialChar LyX
6639 In some cases, you need a helper script that mediates between the viewer
6640 and \SpecialChar LyX
6641 , in others, the viewer can communicate with \SpecialChar LyX
6643 This depends on the selected viewer and on your operating system.
6644 The same applies to the way viewers need to be configured and the way the
6645 reverse search is actually performed.
6646 In what follows, we will thus describe how to setup reverse search for
6648 Before we turn to this, though, we will explain what needs to be done generally
6649 to enable reverse search in the DVI/PDF output.
6652 \begin_layout Subsection
6654 \begin_inset CommandInset label
6656 name "subsec:rev-search"
6663 \begin_layout Standard
6664 In most cases \SpecialChar LyX
6665 will do the work for you by pressing the following button
6669 arg "buffer-toggle-output-sync"
6673 Alternatively, you can also enable the feature by checking
6675 Synchronize with Output
6678 \begin_inset Flex Noun
6681 \begin_layout Plain Layout
6682 Document\SpecialChar menuseparator
6683 Settings\SpecialChar menuseparator
6690 In such a case \SpecialChar LyX
6691 will automatically insert the necessary Sync\SpecialChar TeX
6693 PDF) or load the srcltx package (for DVI) respectively.
6694 This option can be easily reached also on
6695 \begin_inset Flex Code
6698 \begin_layout Plain Layout
6707 \begin_layout Standard
6708 If you need a different setting, you can select or input a custom macro
6709 from the drop down box just below
6710 \begin_inset Flex Noun
6713 \begin_layout Plain Layout
6714 Document\SpecialChar menuseparator
6715 Settings\SpecialChar menuseparator
6716 Output\SpecialChar menuseparator
6717 Synchronize with Output
6725 \begin_layout Standard
6726 Note that the method
6727 \begin_inset Flex Code
6730 \begin_layout Plain Layout
6738 enables gzip compression.
6739 If your viewer does not support it, you should instead use
6740 \begin_inset Flex Code
6743 \begin_layout Plain Layout
6754 \begin_layout Standard
6755 Please also note that including the
6756 \begin_inset Flex Code
6759 \begin_layout Plain Layout
6766 \begin_inset Flex Code
6769 \begin_layout Plain Layout
6775 sometimes has an undesired impact on the typesetting.
6776 Thus, you should switch output synchronization off for the final typesetting
6778 \begin_inset Flex Code
6781 \begin_layout Plain Layout
6788 \begin_inset Flex Code
6791 \begin_layout Plain Layout
6801 \begin_layout Standard
6802 In case you need some more special settings that are not covered by the
6803 automatic settings, read the next section about how to set up output synchroniz
6805 If the automatic setup suits your needs, you can readily jump to section
6806 \begin_inset space ~
6810 \begin_inset CommandInset ref
6812 reference "subsec:configuring-viewers"
6816 , where the necessary configuration steps in your viewer – needed both with
6817 the automatic and the manual setup – are described.
6820 \begin_layout Subsection
6824 \begin_layout Standard
6826 provides several different methods for reverse search.
6827 Some are built-in in the
6828 \begin_inset Flex Code
6831 \begin_layout Plain Layout
6837 program, some are provided by external packages.
6838 Your choice depends on whether your \SpecialChar LaTeX
6839 distribution already provides a given
6840 method (the built-in methods are rather new) and whether your viewer can
6842 The available methods are described in the following.
6845 \begin_layout Subsubsection*
6846 Built-in DVI-search via src-specials (DVI only)
6849 \begin_layout Standard
6850 This method provides the DVI file with the necessary information for reverse
6852 It is available in \SpecialChar LaTeX
6853 since quite some time (any somewhat recent \SpecialChar LaTeX
6855 should include it), and it works reliably.
6856 To enable it, change the
6857 \begin_inset Flex Noun
6860 \begin_layout Plain Layout
6871 \begin_inset Flex Noun
6874 \begin_layout Plain Layout
6885 \begin_inset Flex Noun
6888 \begin_layout Plain Layout
6889 Preferences\SpecialChar menuseparator
6890 File Handling\SpecialChar menuseparator
6897 \begin_inset Flex Code
6900 \begin_layout Plain Layout
6901 latex -src-specials $$i
6907 If this doesn't work, check if your \SpecialChar TeX
6908 engine needs different options (the
6909 syntax might differ in some distributions).
6912 \begin_layout Subsubsection*
6913 External Packages (PDFSync and scrltx)
6916 \begin_layout Standard
6925 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6927 In order to enable it, load the packages in the \SpecialChar LyX
6931 \begin_layout Itemize
6932 \begin_inset Flex Code
6935 \begin_layout Plain Layout
6943 for reverse PDF search,
6946 \begin_layout Itemize
6947 \begin_inset Flex Code
6950 \begin_layout Plain Layout
6953 usepackage[active]{srcltx}
6958 for reverse DVI search.
6961 \begin_layout Standard
6962 If you want to be able to perform both DVI and PDF reverse searches, you
6963 can also insert in the preamble the following lines
6966 \begin_layout LyX-Code
6970 \begin_inset Newline newline
6976 \begin_inset Newline newline
6982 \begin_inset Newline newline
6988 \begin_inset Newline newline
6993 usepackage[active]{srcltx}
6994 \begin_inset Newline newline
7002 \begin_layout Standard
7003 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7004 right package will be used.
7007 \begin_layout Standard
7008 Note that PDFSync might affect the output layout of your document.
7009 It is therefore advised to disable PDFsync for final documents.
7012 \begin_layout Subsubsection*
7013 Built-in reverse search via Sync\SpecialChar TeX
7017 \begin_layout Standard
7019 \begin_inset Flex Code
7022 \begin_layout Plain Layout
7028 have built-in support for both PDF and DVI reverse search.
7031 Sync\SpecialChar TeX
7034 facility is basically the result of the integration of the PDFSync package
7035 to the pdftex program and its merge with the
7040 You need at least \SpecialChar TeX
7041 Live 2008 or a recent Mik\SpecialChar TeX
7042 distribution in order to use
7047 \begin_layout Plain Layout
7048 For some reason, Mik\SpecialChar TeX
7049 does not understand/obey the command \SpecialChar LyX
7051 the preamble when you check the "Enable Forward/Reverse Search" button
7052 in the toolbar and does not generate the necessary info.
7055 \begin_layout Plain Layout
7056 The generation of the required info can be forced by changing the converter
7058 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7059 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7060 the -synctex=1 switch).
7065 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
7066 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
7067 already provide Sync\SpecialChar TeX
7071 \begin_layout Standard
7072 To enable Sync\SpecialChar TeX
7073 for DVI output, change the
7074 \begin_inset Flex Noun
7077 \begin_layout Plain Layout
7088 \begin_inset Flex Noun
7091 \begin_layout Plain Layout
7102 \begin_inset Flex Noun
7105 \begin_layout Plain Layout
7106 Preferences\SpecialChar menuseparator
7107 File Handling\SpecialChar menuseparator
7114 \begin_inset Flex Code
7117 \begin_layout Plain Layout
7118 latex -synctex=1 $$i
7123 , and for PDF output, change the
7124 \begin_inset Flex Noun
7127 \begin_layout Plain Layout
7132 (pdflatex) -> PDF (pdflatex)
7138 \begin_inset Flex Code
7141 \begin_layout Plain Layout
7142 pdflatex -synctex=1 $$i
7148 Should your viewer not be considered in the following description, or in
7149 case of missing success, please check the documentation of your viewer
7150 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
7155 \begin_layout Plain Layout
7156 Note that the option
7157 \begin_inset Flex Code
7160 \begin_layout Plain Layout
7166 option enables gzip compression.
7167 If your viewer does not support it, you should instead use
7168 \begin_inset Flex Code
7171 \begin_layout Plain Layout
7185 \begin_layout Subsection
7186 Configuring and using specific viewers
7187 \begin_inset CommandInset label
7189 name "subsec:configuring-viewers"
7196 \begin_layout Subsubsection*
7197 Xdvi (all platforms)
7200 \begin_layout Standard
7202 \begin_inset Flex Code
7205 \begin_layout Plain Layout
7211 , you don't need to do anything else for performing a reverse DVI search,
7213 already provides the necessary hooks for automatically using the
7214 \begin_inset Flex Code
7217 \begin_layout Plain Layout
7224 Just setup your document as described above (reverse search is triggered
7225 by Ctrl-click or Alt-click on Mac OSX, respectively).
7228 \begin_layout Standard
7229 However, if for whatever reason you want to use the named pipe instead of
7230 the socket for communicating with \SpecialChar LyX
7231 , simply change the DVI viewer in
7232 \begin_inset Flex Noun
7235 \begin_layout Plain Layout
7236 Preferences\SpecialChar menuseparator
7237 File Handling\SpecialChar menuseparator
7247 \begin_layout Plain Layout
7248 On Mac OSX you have to use
7249 \begin_inset Flex Code
7252 \begin_layout Plain Layout
7253 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7264 \begin_inset Flex Code
7267 \begin_layout Plain Layout
7268 xdvi -editor "lyxeditor.sh %f %l"
7274 \begin_inset Flex Code
7277 \begin_layout Plain Layout
7283 is a suitable script.
7284 For example, a minimal shell script is the following one:
7287 \begin_layout LyX-Code
7289 \begin_inset Newline newline
7292 LYXPIPE="/path/to/lyxpipe"
7293 \begin_inset Newline newline
7296 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7297 \begin_inset Newline newline
7300 echo "$COMMAND" > "${LYXPIPE}".in || exit
7301 \begin_inset Newline newline
7304 read TMP < "${LYXPIPE}".out || exit
7307 \begin_layout Standard
7309 \begin_inset Flex Code
7312 \begin_layout Plain Layout
7318 is the LyXServer pipe path specified in
7319 \begin_inset Flex Noun
7322 \begin_layout Plain Layout
7323 Preferences\SpecialChar menuseparator
7333 \begin_layout Plain Layout
7335 \begin_inset Flex Code
7338 \begin_layout Plain Layout
7344 folder of a source distribution you can find a
7345 \begin_inset Flex Code
7348 \begin_layout Plain Layout
7354 script which is able to locate the
7358 based on your preferences.
7366 \begin_layout Subsubsection*
7370 \begin_layout Standard
7372 \begin_inset Flex Code
7375 \begin_layout Plain Layout
7376 /Applications/MacDviX_Folder/calleditor.script
7381 , add the following lines:
7384 \begin_layout LyX-Code
7385 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7386 \begin_inset Newline newline
7392 \begin_layout Standard
7393 Modify the lines accordingly if you install \SpecialChar LyX
7394 somewhere else than in the
7395 Applications folder.
7398 \begin_layout Standard
7399 Reverse search is triggered by Alt-click (OPTION-click).
7402 \begin_layout Subsubsection*
7406 \begin_layout Standard
7408 \begin_inset Flex Code
7411 \begin_layout Plain Layout
7412 open -a Skim.app $$i
7417 to the viewer setting in
7418 \begin_inset Flex Noun
7421 \begin_layout Plain Layout
7422 Preferences\SpecialChar menuseparator
7423 File Handling\SpecialChar menuseparator
7424 File formats\SpecialChar menuseparator
7431 \begin_inset Flex Noun
7434 \begin_layout Plain Layout
7435 Skim\SpecialChar menuseparator
7436 Preferences\SpecialChar menuseparator
7443 \begin_inset Flex Noun
7446 \begin_layout Plain Layout
7452 preset and enter command
7453 \begin_inset Flex Noun
7456 \begin_layout Plain Layout
7457 /Applications/\SpecialChar LyX
7458 .app/Contents/MacOS/lyxeditor
7466 \begin_layout Standard
7467 Reverse search is triggered by COMMAND-SHIFT-click
7470 \begin_layout Subsubsection*
7474 \begin_layout Standard
7475 Reverse search with evince does not work out of the box, but it can be achieved
7476 by means of some third party helper scripts.
7478 \begin_inset CommandInset href
7480 target "https://wiki.lyx.org/LyX/SyncTeX"
7488 \begin_layout Subsubsection*
7492 \begin_layout Standard
7494 \begin_inset Flex Noun
7497 \begin_layout Plain Layout
7498 Settings\SpecialChar menuseparator
7499 Configure Okular\SpecialChar menuseparator
7506 \begin_inset Quotes erd
7510 This inserts the appropriate command (
7511 \begin_inset Flex Code
7514 \begin_layout Plain Layout
7523 \begin_layout Standard
7524 Reverse search is triggered by SHIFT-click.
7527 \begin_layout Subsubsection*
7531 \begin_layout Standard
7532 Qpdfview supports Sync\SpecialChar TeX
7533 since version 0.3.5.
7535 \begin_inset Flex Noun
7538 \begin_layout Plain Layout
7539 Edit\SpecialChar menuseparator
7540 Settings\SpecialChar menuseparator
7546 , click on the input field of the
7547 \begin_inset Quotes eld
7551 \begin_inset Quotes erd
7554 item and add the command
7555 \begin_inset Flex Code
7558 \begin_layout Plain Layout
7567 \begin_layout Standard
7568 Reverse search is triggered by double-click or, in more recent versions,
7572 \begin_layout Subsubsection*
7576 \begin_layout Standard
7577 Launch yap, choose its
7578 \begin_inset Flex Noun
7581 \begin_layout Plain Layout
7582 View\SpecialChar menuseparator
7589 \begin_inset Quotes eld
7593 \begin_inset Quotes erd
7598 \begin_inset Quotes eld
7601 New\SpecialChar ldots
7603 \begin_inset Quotes erd
7606 button and, in the window that opens, enter
7607 \begin_inset Quotes eld
7612 \begin_inset Quotes erd
7615 (or any other name you like) in the
7616 \begin_inset Quotes eld
7620 \begin_inset Quotes erd
7624 Now click on the button labeled
7625 \begin_inset Quotes eld
7630 \begin_inset Quotes erd
7633 to open a file dialog and navigate to the directory containing the batch
7635 \begin_inset Flex Code
7638 \begin_layout Plain Layout
7646 \begin_inset Flex Code
7649 \begin_layout Plain Layout
7655 and then specify the program arguments as
7656 \begin_inset Flex Code
7659 \begin_layout Plain Layout
7667 \begin_inset Flex Code
7670 \begin_layout Plain Layout
7676 wrapper is used for communicating with \SpecialChar LyX
7684 \begin_layout LyX-Code
7686 \begin_inset Newline newline
7689 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
7698 \begin_inset Newline newline
7712 \begin_layout Standard
7713 Make sure that the \SpecialChar LyX
7714 Server pipe path you specified in \SpecialChar LyX
7716 \begin_inset Flex Code
7719 \begin_layout Plain Layout
7733 , otherwise change the
7734 \begin_inset Flex Code
7737 \begin_layout Plain Layout
7743 wrapper accordingly.
7746 \begin_layout Standard
7747 In yap, reverse search is triggered by double-click.
7750 \begin_layout Subsubsection*
7751 SumatraPDF (Windows)
7754 \begin_layout Standard
7755 In order to use SumatraPDF for inverse search, enter
7756 \begin_inset Flex Code
7759 \begin_layout Plain Layout
7760 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
7765 in the viewer setting in
7766 \begin_inset Flex Noun
7769 \begin_layout Plain Layout
7770 Preferences\SpecialChar menuseparator
7771 File Handling\SpecialChar menuseparator
7772 File formats\SpecialChar menuseparator
7779 \begin_inset Flex Code
7782 \begin_layout Plain Layout
7788 is the previous wrapper.
7789 If SumatraPDF.exe is not in your command PATH, use its full file name.
7792 \begin_layout Standard
7793 Reverse search is triggered by double-click.
7796 \begin_layout Subsubsection*
7800 \begin_layout Standard
7801 First of all, make sure that yap is your default DVI viewer in the Windows
7802 environment, then launch it, choose its
7803 \begin_inset Flex Noun
7806 \begin_layout Plain Layout
7807 View\SpecialChar menuseparator
7814 \begin_inset Quotes eld
7818 \begin_inset Quotes erd
7823 \begin_inset Quotes eld
7826 New\SpecialChar ldots
7828 \begin_inset Quotes erd
7831 button and, in the window that opens, enter
7832 \begin_inset Quotes eld
7837 \begin_inset Quotes erd
7840 (or any other name you like) in the
7841 \begin_inset Quotes eld
7845 \begin_inset Quotes erd
7849 Now click on the button labeled
7850 \begin_inset Quotes eld
7855 \begin_inset Quotes erd
7858 to open a file dialog and navigate to the directory containing the
7859 \begin_inset Flex Code
7862 \begin_layout Plain Layout
7868 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7871 \begin_inset Flex Code
7874 \begin_layout Plain Layout
7880 and then specify the program arguments as
7881 \begin_inset Flex Code
7884 \begin_layout Plain Layout
7891 In this way, you will be using the
7895 for communicating with \SpecialChar LyX
7897 If, for whatever reason, you want to use the
7902 \begin_inset Flex Code
7905 \begin_layout Plain Layout
7911 option and be sure to specify the \SpecialChar LyX
7912 Server pipe path in the \SpecialChar LyX
7916 \begin_layout Standard
7917 In yap, reverse search is triggered by double-click.
7920 \begin_layout Subsubsection*
7924 \begin_layout Standard
7925 In order to use SumatraPDF for inverse search, enter
7926 \begin_inset Flex Code
7929 \begin_layout Plain Layout
7930 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7935 in the viewer setting in
7936 \begin_inset Flex Noun
7939 \begin_layout Plain Layout
7940 Preferences\SpecialChar menuseparator
7941 File Handling\SpecialChar menuseparator
7942 File formats\SpecialChar menuseparator
7949 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7951 \begin_inset Flex Code
7954 \begin_layout Plain Layout
7960 enables communication via the
7966 \begin_inset Flex Code
7969 \begin_layout Plain Layout
7975 option if you want to use the
7979 , and be sure to specify the \SpecialChar LyX
7980 Server pipe path in the \SpecialChar LyX
7984 \begin_layout Standard
7985 Reverse search is triggered by double-click.
7988 \begin_layout Section
7992 \begin_layout Standard
7993 Forward search is, as the name implies, in a sense the
7994 \begin_inset Quotes eld
7998 \begin_inset Quotes erd
8002 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8004 If forward search is set up (as described in what follows), you can put
8005 the cursor anywhere in your \SpecialChar LyX
8007 \begin_inset Flex Noun
8010 \begin_layout Plain Layout
8011 Navigate\SpecialChar menuseparator
8018 \begin_inset Flex Noun
8021 \begin_layout Plain Layout
8027 in the context menu via right mouse click), and then the viewer will jump
8028 to that position as well.
8029 This implies, of course, that your viewer supports this function.
8032 \begin_layout Standard
8033 To make forward search possible, you first need to provide the generated
8034 output PDF/DVI file with additional information about the \SpecialChar TeX
8036 This can be done via the methods described in the section
8037 \begin_inset CommandInset ref
8039 reference "subsec:rev-search"
8046 \begin_layout Standard
8047 Additionally, you need to configure \SpecialChar LyX
8048 for using your viewers in
8049 \begin_inset Flex Noun
8052 \begin_layout Plain Layout
8053 Tools\SpecialChar menuseparator
8054 Preferences\SpecialChar menuseparator
8055 Output\SpecialChar menuseparator
8062 We provide a range of tested configurations for some viewers, which you
8063 can select from the drop down list.
8064 If none of these configurations suits you, you have to find out and enter
8065 a suitable configuration yourself.
8066 The definition syntax uses the following placeholders:
8069 \begin_layout Itemize
8071 \begin_inset Flex Code
8074 \begin_layout Plain Layout
8083 \begin_layout Itemize
8085 \begin_inset Flex Code
8088 \begin_layout Plain Layout
8094 : name of the (temporary) exported .tex file (without path)
8097 \begin_layout Itemize
8099 \begin_inset Flex Code
8102 \begin_layout Plain Layout
8108 : name of the (temporary) exported .tex file (including path)
8111 \begin_layout Itemize
8113 \begin_inset Flex Code
8116 \begin_layout Plain Layout
8122 : name of the exported output file (either dvi or pdf, depending on which
8123 one exists in the temporary directory)
8126 \begin_layout Standard
8127 Note that only some of the viewers provide full and usable forward search
8128 functionality out of the box, among them yap, xdvi, okular
8132 \begin_layout Plain Layout
8133 You might want to set
8134 \begin_inset Flex Code
8137 \begin_layout Plain Layout
8144 \begin_inset Flex Noun
8147 \begin_layout Plain Layout
8148 Tools\SpecialChar menuseparator
8149 Preferences\SpecialChar menuseparator
8150 File Handling\SpecialChar menuseparator
8152 \begin_inset space ~
8165 , qpdfview, and SumatraPDF
8169 \begin_layout Plain Layout
8170 SumatraPDF can also use DDE commands through the external program CMCDDE
8171 — downloadable from
8172 \begin_inset CommandInset href
8174 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8185 Others, such as evince
8189 \begin_layout Plain Layout
8190 Forward search with evince can be achieved by means of third party helper
8193 \begin_inset CommandInset href
8195 target "https://wiki.lyx.org/LyX/SyncTeX"
8205 , require some extra tools in order to use forward search.
8206 While many of the widespread PDF viewers (most notably Adobe Reader) do
8207 not support forward search at all, some other viewers – e.
8208 \begin_inset space \thinspace{}
8212 xpdf – allow at least to reload the document and jump to a specific page
8213 of the file, so you can at least navigate
8214 \begin_inset Quotes eld
8218 \begin_inset Quotes erd
8222 This latter functionality is provided by an external call of synctex (see
8223 the predefined example configurations).
8227 \begin_layout Standard
8228 Forward search works both with DVI and PDF output.
8230 simply checks which preview format you have used before (i.
8231 \begin_inset space \thinspace{}
8234 e., which format is already there in the temporary directory) and chooses
8235 the appropriate configuration for the respective format.
8238 \begin_layout Chapter
8239 Special Document Classes
8242 \begin_layout Section
8246 \begin_layout Standard
8252 \begin_layout Subsection
8256 \begin_layout Standard
8257 This section describes how \SpecialChar LyX
8258 can be used to write articles for submission
8259 to the scientific journal
8261 Astronomy and Astrophysics
8264 \begin_inset Flex URL
8267 \begin_layout Plain Layout
8269 https://www.aanda.org/
8274 ) using Version 5.01 of the document class
8279 This package can be downloaded from the ftp site
8282 \begin_layout Standard
8283 \begin_inset VSpace medskip
8289 \begin_layout Standard
8291 \begin_inset Flex URL
8294 \begin_layout Plain Layout
8296 ftp://ftp.edpsciences.org/pub/aa/readme.html
8304 \begin_layout Standard
8305 \begin_inset VSpace medskip
8311 \begin_layout Standard
8312 A manual comes together with that package, and this text is not meant to
8313 replace the original manual but is merely a short guide in how to realize
8314 the correct form of your paper.
8318 \begin_layout Standard
8319 Please note that the publisher of the journal was changed from Springer
8320 to EDP Sciences starting January 1, 2001.
8321 That change involved also some slight changes to the style files, namely
8322 the removal of the thesaurus command.
8323 The \SpecialChar LyX
8324 class aa supports the newest version of these style files, V 5.01.
8325 If you have an older version installed, please upgrade.
8326 For compatibility, the old (version 4) layout has been kept as
8331 Please refer to the comments in
8334 Dir/layouts/aapaper.layout
8339 \begin_layout Subsection
8343 \begin_layout Standard
8344 It is recommended you start from the example template distributed with \SpecialChar LyX
8346 If you are not using a template, note the following settings:
8349 \begin_layout Itemize
8356 Document\SpecialChar menuseparator
8359 dialog (OK, that one was obvious).
8362 \begin_layout Itemize
8363 Don't change the option
8366 \begin_inset space ~
8376 The whole layout is done by the macros, you shouldn't change anything.
8379 \begin_layout Subsection
8383 \begin_layout Standard
8384 First thing to enter is the header information.
8385 It consists of seven entries, of which some are optional.
8389 \begin_layout Itemize
8397 \begin_layout Itemize
8405 \begin_layout Itemize
8413 \begin_layout Itemize
8421 \begin_layout Itemize
8426 : [optional] if more than one author: whom to contact for offprint requests.
8429 \begin_layout Itemize
8434 : [optional] mail address for contacts.
8437 \begin_layout Itemize
8445 Received: <date>; Accepted <date>
8448 \begin_layout Standard
8449 There is no need to issue the
8455 command, this is done automatically by \SpecialChar LyX
8456 when the header is finished.
8457 Although the order of the single header entries doesn't matter it is advised
8458 to keep the above sequence, just to get the best optics and meets the layout
8459 of the real document.
8462 \begin_layout Standard
8463 If you want to place footnotes in the header block, e.
8464 \begin_inset space \thinspace{}
8468 \begin_inset space \space{}
8471 to state your present address, just use the standard footnote via the menu
8474 Insert\SpecialChar menuseparator
8479 will automagically use the term
8488 \begin_layout Standard
8491 Edit\SpecialChar menuseparator
8494 , you'll find two insets which are relevant for the titling:
8497 \begin_layout Itemize
8504 to mark corresponding author\SpecialChar breakableslash
8506 The institutes are numbered sequentially as they appear in the
8510 field, so you have to put a marker to each author.
8513 \begin_layout Itemize
8518 to supply an email address for fast contact.
8521 \begin_layout Standard
8522 In addition to these topics, the macros use one additional \SpecialChar LaTeX
8524 has no counterpart in \SpecialChar LyX
8528 \begin_layout Itemize
8535 to separate different names for more than one author and institute, respectivel
8539 \begin_layout Standard
8540 The appropriate command has to be entered in \SpecialChar LyX
8541 and marked as \SpecialChar LaTeX
8547 \begin_layout Subsection
8551 \begin_layout Standard
8552 The abstract should immediately follow the header block.
8553 With version 5 the abstract environment was changed to a command, and there
8554 is now a restriction to only one paragraph.
8555 In addition, it should contain an entry with the keywords.
8556 This is done via the paragraph style
8561 Refer to the example paper.
8564 \begin_layout Subsection
8565 Supported environments
8568 \begin_layout Standard
8569 The A&A paper layout supports the following environments for structuring
8573 \begin_layout Itemize
8579 \begin_layout Itemize
8585 \begin_layout Itemize
8591 \begin_layout Itemize
8597 \begin_layout Itemize
8603 \begin_layout Itemize
8609 \begin_layout Itemize
8615 \begin_layout Itemize
8621 \begin_layout Itemize
8627 \begin_layout Itemize
8633 \begin_layout Itemize
8639 \begin_layout Itemize
8646 \begin_layout Subsection
8647 Commands not supported by \SpecialChar LyX
8651 \begin_layout Standard
8652 Some commands are not yet supported by the
8656 layout for \SpecialChar LyX
8658 Some have already been mentioned.
8659 For the sake of completeness, they are listed all together here:
8662 \begin_layout Itemize
8670 \begin_layout Itemize
8678 \begin_layout Itemize
8686 \begin_layout Itemize
8694 \begin_layout Standard
8695 If you want to use any of these commands, you have to enter them yourself.
8698 Do not forget to mark them as \SpecialChar LaTeX
8702 \begin_layout Subsection
8703 Figure and Table Floats
8706 \begin_layout Standard
8708 provides support for the necessary float environments
8710 figure, figure*, table
8716 , therefore we won't tell much about it here.
8720 \begin_inset space ~
8726 Just remember that tables should be left-aligned.
8727 For that, select the table and change the alignment in
8729 Edit\SpecialChar menuseparator
8731 \begin_inset space ~
8737 \begin_layout Standard
8738 There is only one special thing: the figures with caption besides the figure.
8739 To create such a figure, you have to do the following:
8742 \begin_layout Enumerate
8743 Create a wide figure float:
8745 Insert\SpecialChar menuseparator
8746 Float\SpecialChar menuseparator
8749 , then right click in the figure and select
8752 \begin_inset space ~
8760 \begin_layout Enumerate
8761 Enter your caption text.
8764 \begin_layout Enumerate
8769 to move the cursor above the caption.
8772 \begin_layout Enumerate
8776 \begin_layout Enumerate
8777 Position the cursor behind the figure and insert a horizontal fill:
8779 Insert\SpecialChar menuseparator
8781 \begin_inset space ~
8784 Character\SpecialChar menuseparator
8786 \begin_inset space ~
8794 \begin_layout Enumerate
8795 Switch to \SpecialChar LaTeX
8799 \begin_inset space ~
8807 \begin_layout Enumerate
8817 Do not close the brace!
8820 \begin_layout Enumerate
8821 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8826 \begin_inset space ~
8838 \begin_layout Standard
8839 Also, refer to the figures in the example paper.
8842 \begin_layout Subsection
8846 \begin_layout Standard
8847 For submission, the paper has to be formated in a special double-spacing
8849 For this purpose, you have to give the option
8853 to the document class.
8854 This must be done using the custom class options field in the
8856 Document\SpecialChar menuseparator
8860 Just enter the string
8867 \begin_layout Subsection
8871 \begin_layout Standard
8876 directory contains an example paper written with \SpecialChar LyX
8878 It is the example paper from the original macro package, translated to
8881 Use it for inspiration, and compare the original \SpecialChar LaTeX
8882 code with \SpecialChar LyX
8886 \begin_layout Section
8891 \begin_layout Standard
8897 \begin_layout Subsection
8901 \begin_layout Standard
8903 is a set of macros produced by the American Astronomical Society to
8904 facilitate electronic manuscript submission to the three journals they
8905 publish: the Astrophysical Journal (including the Letters and Supplement),
8906 the Astronomical Journal, and the Publications of the Astronomical Society
8909 has proven to be an excellent tool for generating these documents, especially
8910 given its equation, citation, and figure handling capabilities.
8912 requires version 5.0 (or higher) of these macros; preferably 6.0, which
8913 is the version described here, or higher.
8914 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8915 2.09 and are fundamentally
8916 incompatible with \SpecialChar LyX
8918 The AAS\SpecialChar TeX
8919 package may be downloaded from the AAS\SpecialChar TeX
8923 \begin_layout Standard
8924 \begin_inset VSpace medskip
8930 \begin_layout Standard
8932 \begin_inset Flex URL
8935 \begin_layout Plain Layout
8937 https://aas.org/aastex/aastex-downloads
8945 \begin_layout Standard
8946 \begin_inset VSpace medskip
8952 \begin_layout Standard
8953 A complete user guide is contained in that package and you should familiarize
8954 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8957 will not reduce the need to figure out all the AAS\SpecialChar TeX
8958 commands, it will only
8959 reduce the drudgery of typing everything in.
8960 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8962 completely to the requirements of the journal to which you are submitting
8966 \begin_layout Subsection
8967 Starting a New Paper
8970 \begin_layout Standard
8971 I strongly suggest that you start with the AAS\SpecialChar TeX
8975 File\SpecialChar menuseparator
8982 , enter the new file name, then choose the
8987 This will show the most common fields found in a manuscript.
8988 Simply overwrite the existing text (including the brackets,
8992 ) with the correct information.
8993 Many of the AAS\SpecialChar TeX
8994 commands and environments can be implemented directly in
8997 For commands such as these, the \SpecialChar LaTeX
8998 code must be entered directly and marked
9000 Such commands are referred to as \SpecialChar TeX
9001 code, or Evil Red Text.
9002 I tried to minimize the amount of \SpecialChar TeX
9003 code needed in an AAS\SpecialChar TeX
9007 \begin_layout Subsection
9008 Finishing Your Paper
9011 \begin_layout Standard
9012 When the paper is finished to your satisfaction and previews/prints correctly,
9014 \begin_inset Quotes eld
9018 \begin_inset Quotes erd
9021 actions which need to be done before you submit it to the journals.
9025 \begin_layout Enumerate
9026 Export your paper as a \SpecialChar LaTeX
9029 File\SpecialChar menuseparator
9030 Export\SpecialChar menuseparator
9038 \begin_layout Enumerate
9043 file with your favorite text editor
9047 \begin_layout Enumerate
9048 remove the comment lines before the
9057 \begin_layout Enumerate
9062 usepackage...{fontenc}
9064 line if it appears (usually just after
9079 \begin_layout Enumerate
9080 remove everything between (and including) the
9092 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9094 (which should appear immediately after the
9095 \begin_inset Quotes eld
9098 User specified \SpecialChar LaTeX
9100 \begin_inset Quotes erd
9111 \begin_layout Enumerate
9112 Run the resulting file through \SpecialChar LaTeX
9113 to make sure it still processes correctly.
9116 \begin_layout Enumerate
9117 Reread the journal requirements to make sure your filenames and formats
9121 \begin_layout Enumerate
9125 \begin_layout Subsection
9126 Comments On Specific Commands
9129 \begin_layout Standard
9130 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9137 ) gives a good description of each.
9138 Thus it's probably easiest for me to go down the list as found in the guide
9139 and offer comments where necessary.
9140 So let's begin \SpecialChar ldots
9144 \begin_layout Subsubsection
9145 Things that work as expected
9148 \begin_layout Standard
9149 Because they work as you might expect, I simply list them and the section
9250 begin{thebibliography}
9258 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9259 graphicx figure commands (2.14.1),
9283 (2.15.4, amongst other places),
9310 \begin_layout Standard
9311 The following style options also work correctly:
9332 Simply put them in the
9338 Layout\SpecialChar menuseparator
9344 \begin_layout Subsubsection
9345 Things that work, but require more comment
9348 \begin_layout Standard
9349 The following items work, but require a little more discussion:
9352 \begin_layout Itemize
9353 These items are reserved for use by the journal editors, but you can put
9354 them into the \SpecialChar LaTeX
9355 preamble if you feel compelled to do so:
9388 \begin_layout Itemize
9389 These items may be placed in the \SpecialChar LaTeX
9390 preamble, and are included as blanks in
9412 \begin_layout Itemize
9419 (2.3) – can only be used
9420 \begin_inset Quotes eld
9424 \begin_inset Quotes erd
9427 , not in the middle of a paragraph.
9428 Use \SpecialChar TeX
9429 code if you need to embed it.
9432 \begin_layout Itemize
9439 (2.3) – will have extra {} after it.
9440 This should not cause an error.
9443 \begin_layout Itemize
9450 (2.6) – can only be used
9451 \begin_inset Quotes eld
9455 \begin_inset Quotes erd
9458 , not in the middle of a paragraph.
9459 Use \SpecialChar TeX
9460 code if you need to embed it.
9463 \begin_layout Itemize
9470 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9474 \begin_layout Itemize
9481 (2.8) – same as for
9488 \begin_layout Itemize
9495 (2.9) – will have extra {} after it.
9496 This should not cause an error.
9499 \begin_layout Itemize
9506 (2.11) – will have extra {} after it.
9507 This should not cause an error.
9510 \begin_layout Itemize
9517 (2.14.2) – you can insert an optional filename argument by placing the cursor
9518 at the beginning of the text and selecting
9520 Insert\SpecialChar menuseparator
9525 \begin_inset Quotes eld
9529 \begin_inset Quotes erd
9532 inserts an optional argument of the type needed by
9539 Hopefully it will be renamed someday.
9542 \begin_layout Itemize
9549 (2.17.1) – same as
9555 for the catalog ID optional parameter
9558 \begin_layout Itemize
9565 (2.17.1) – same as
9571 for the catalog ID optional parameter
9574 \begin_layout Subsubsection
9575 Things not implemented, use \SpecialChar TeX
9579 \begin_layout Standard
9590 setcounter{equation}
9592 (2.12), Journal name abbreviations (2.13.4),
9628 (2.15.4, insert it as the first element in the lefthand cell after where
9630 Don't use any of \SpecialChar LyX
9631 's rules in the table),
9643 (2.15.5), much of Misc (2.17, except
9694 \begin_layout Subsubsection
9695 Things that cannot be implemented
9698 \begin_layout Standard
9700 at least in any meaningful sort of way, so I suggest ignoring them.
9701 They are the references environment (2.13.3), and the deluxetable environment
9703 If you really, really need to use deluxetable, I suggest editing it in
9704 a separate file with a text editor, then using
9706 Insert\SpecialChar menuseparator
9708 \begin_inset space ~
9713 to include it in your \SpecialChar LyX
9719 file to see an example of this.
9722 \begin_layout Subsection
9723 FAQs, Tips, Tricks, and Other Ruminations
9726 \begin_layout Subsubsection
9727 Getting \SpecialChar LyX
9728 and AAS\SpecialChar TeX
9732 \begin_layout Standard
9733 It can be a bit tricky to get \SpecialChar LyX
9734 to recognize a new layout and document class.
9735 When all else fails, do this:
9738 \begin_layout Enumerate
9739 Make certain that \SpecialChar LaTeX
9740 can find AAS\SpecialChar TeX
9742 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9744 directory completely unrelated to \SpecialChar LaTeX
9745 or AAS\SpecialChar TeX
9746 and run \SpecialChar LaTeX
9754 \begin_layout Enumerate
9759 appears in \SpecialChar LyX
9767 \begin_layout Enumerate
9770 Tools\SpecialChar menuseparator
9774 , then restart \SpecialChar LyX
9778 \begin_layout Enumerate
9779 Open a regular new file, not from a template.
9780 Does AAS\SpecialChar TeX
9781 appear in the class list in
9783 Document\SpecialChar menuseparator
9789 \begin_layout Standard
9790 If you get a warning from an existing AAS\SpecialChar TeX
9791 document about not being able
9792 to find the AAS\SpecialChar TeX
9793 layout or a message about
9794 \begin_inset Quotes eld
9797 You should not mix title layouts with normal ones
9798 \begin_inset Quotes erd
9801 , things haven't been installed correctly.
9804 \begin_layout Subsubsection
9806 error processing a table
9809 \begin_layout Standard
9811 , by default, attempts to center the table caption/title.
9812 This seems to produce a bad interaction in AAS\SpecialChar TeX
9813 so you should click somewhere
9814 in the caption/title, then select
9816 Edit\SpecialChar menuseparator
9818 \begin_inset space ~
9832 This took care of it for me.
9835 \begin_layout Subsubsection
9839 \begin_layout Standard
9840 A couple of things: 1) I have noticed some funny spacing in the reference
9841 entries in the text.
9842 When you enter the bibliography item data, make sure their is
9846 space between the last author and the parenthesis setting off the year;
9850 \begin_inset space \thinspace{}
9854 \begin_inset space \space{}
9868 2) Entering the references at all is not obvious.
9869 The easiest thing is to start typing your first reference at the end of
9870 the document, then mark it as type
9875 That will put a small gray box in front of what you just typed.
9876 Click on the box to fill in the rest of the information.
9877 For new references, go to the end of an existing reference and press return.
9878 That will create a new line with its own box, etc.
9881 \begin_layout Subsubsection
9885 \begin_layout Standard
9886 Even though AAS\SpecialChar TeX
9887 provides its own figure commands (
9893 , for example), I much prefer \SpecialChar LaTeX
9894 's standard figure commands (with the default
9903 \begin_inset space ~
9906 commands as \SpecialChar TeX
9907 code into a Figure Float box if you desire, but I never have
9908 much luck getting the layout right.
9909 With the standard graphics, \SpecialChar LyX
9914 usepackage{graphicx}
9916 command into the \SpecialChar LaTeX
9917 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9919 interspersing the figures in the text.
9920 I believe ApJ accepts figures exactly this way now; AJ might still use
9922 \begin_inset Quotes eld
9925 stack everything at the end
9926 \begin_inset Quotes erd
9932 \begin_layout Subsubsection
9933 Things I could have done, but didn't
9936 \begin_layout Standard
9938 \begin_inset Quotes eld
9942 \begin_inset Quotes erd
9945 things I could have implemented, but chose not to.
9946 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9948 even though it is double-spaced in the paper manuscript.
9949 Also, I chose not to make separate layouts for the preprint and preprint2
9951 Since I assume you will spend most of your time in the plain manuscript
9952 mode anyway, I decided not to chew up more disk space with this.
9956 \begin_layout Subsection
9960 \begin_layout Standard
9961 Your mileage may vary.
9962 I've now had papers published by both ApJ and AJ that have had 98% of the
9963 effort done in \SpecialChar LyX
9964 ; the last 2% was the \SpecialChar LaTeX
9965 post-processing and a few cleanups.
9966 I have had no trouble with the submission process, and I'm sure the journals
9967 were never aware that there might be a difference.
9968 So, go forth and publish!
9971 \begin_layout Section
9972 AMS \SpecialChar LaTeX
9976 \begin_layout Standard
9986 \begin_layout Standard
9987 \begin_inset VSpace bigskip
9993 \begin_layout Standard
9995 The AMS \SpecialChar LaTeX
9996 layouts are set up to conform to suggested styles for mathematical
9997 papers to be submitted to American Mathematical Society publications.
9998 The layouts are not tailored to a specific journal, but easily can be.
9999 You should refer to the AMS documentation for specific instructions for
10000 each journal (usually it will entail only changing a single line in the
10003 That documentation is available on the Web at
10004 \begin_inset Flex URL
10007 \begin_layout Plain Layout
10015 \begin_inset Flex URL
10018 \begin_layout Plain Layout
10020 ftp://ftp.ams.org/pub/tex/amslatex/
10026 These layouts are appropriate, and useful, for any mathematical writing.
10030 \begin_layout Standard
10031 There are two basic AMS \SpecialChar LaTeX
10035 \begin_layout Itemize
10036 amsart: The standard AMS article format.
10039 \begin_layout Itemize
10040 amsbook: the standard AMS book (really, monograph) format.
10044 \begin_layout Standard
10045 The layouts themselves contain only the minimum necessary to use the AMS
10047 They do not, in particular, contain any of the `theorem' environments used
10048 for setting theorems, lemmas, and the like.
10049 These are contained, instead, in the
10050 \begin_inset Flex Code
10053 \begin_layout Plain Layout
10059 module, which is loaded by default when you select one of the AMS classes.
10060 (It can also be used with other classes and can be removed, if you would
10061 rather use something else.) Less commonly used environments are in the
10062 \begin_inset Flex Code
10065 \begin_layout Plain Layout
10066 Theorems (AMS-Extended)
10071 module, which must be loaded manually.
10074 \begin_layout Standard
10075 By default, theorems and the like are numbered consecutively throughout
10076 the document, but this may be modified by loading the module
10077 \begin_inset Flex Code
10080 \begin_layout Plain Layout
10081 Theorems (Order by Section)
10086 or, if you are using
10087 \begin_inset Flex Code
10090 \begin_layout Plain Layout
10097 \begin_inset Flex Code
10100 \begin_layout Plain Layout
10101 Theorems (Order by Chapter)
10107 These will number the results as
10108 \begin_inset Formula $n.m$
10111 , where the first number refers to the section (or chapter) and the second
10112 refers to the total number of results so far in that section (or chapter).
10113 Many environments are also available unnumbered.
10114 These are indicated by an asterisk at the end.
10115 If you happen to want
10119 unnumbered results, the module
10120 \begin_inset Flex Code
10123 \begin_layout Plain Layout
10129 provides that option.
10132 \begin_layout Standard
10133 Note that these modules do not
10137 to be used with the AMS classes.
10138 It is perfectly possible to use the
10139 \begin_inset Flex Code
10142 \begin_layout Plain Layout
10148 module, and the others mentioned, with other classes, such as
10149 \begin_inset Flex Code
10152 \begin_layout Plain Layout
10159 \begin_inset Flex Code
10162 \begin_layout Plain Layout
10169 \begin_inset Flex Code
10172 \begin_layout Plain Layout
10181 \begin_layout Subsection
10182 What these layouts provide
10185 \begin_layout Standard
10186 There is a long list of included environments provided by these layouts.
10187 In AMS-\SpecialChar LaTeX
10188 , there is, in fact, an opportunity to define an unlimited variety
10189 of `theorem' environments.
10190 However, the AMS recommends the environments that are available in \SpecialChar LyX
10195 \begin_layout Standard
10196 The following environments—as well as the standard environments, such as
10198 \begin_inset Flex Noun
10201 \begin_layout Plain Layout
10208 \begin_inset Flex Noun
10211 \begin_layout Plain Layout
10218 \begin_inset Flex Noun
10221 \begin_layout Plain Layout
10228 \begin_inset Flex Noun
10231 \begin_layout Plain Layout
10238 \begin_inset Flex Noun
10241 \begin_layout Plain Layout
10248 \begin_inset Flex Code
10251 \begin_layout Plain Layout
10258 \begin_inset Flex Code
10261 \begin_layout Plain Layout
10270 \begin_layout Description
10271 Address This should be the author's permanent address.
10274 \begin_layout Description
10276 \begin_inset space ~
10279 Address This should be the author's temporary address at the time of submission,
10280 if different from the Address.
10283 \begin_layout Description
10284 Email Author's e-mail address
10287 \begin_layout Description
10288 URL Author's Web address, if desired.
10291 \begin_layout Description
10292 Keywords Key words or phrases used to identify specific topics discussed
10296 \begin_layout Description
10297 Subjectclass These refer to the AMS Subject Classifications, published and
10300 Mathematical Reviews
10303 These are also available online at the AMS cites listed above.
10306 \begin_layout Description
10310 \begin_layout Description
10314 \begin_layout Description
10318 \begin_layout Standard
10319 The following environments are provided by both the
10320 \begin_inset Flex Code
10323 \begin_layout Plain Layout
10330 \begin_inset Flex Code
10333 \begin_layout Plain Layout
10339 modules, in the latter case in both starred (unnumbered) and unstarred
10340 (numbered) versions.
10341 These same environments are provided only in the starred versions by the
10343 \begin_inset Flex Code
10346 \begin_layout Plain Layout
10355 \begin_layout Theorem
10356 This is typically used for the statements of major results.
10360 \begin_layout Corollary*
10361 This is used for statements which follow fairly directly from previous statement
10363 Again, these can be major results.
10367 \begin_layout Lemma
10368 These are smaller results needed to prove other statements.
10371 \begin_layout Proposition
10372 These are less major results which (hopefully) add to the general theory
10376 \begin_layout Conjecture
10377 These are statements provided without justification, which the author does
10378 not know how to prove, but which seem to be true (to the author, at least).
10381 \begin_layout Definition*
10382 Guess what this is for.
10383 The font is different for this environment than for the previous ones.
10387 \begin_layout Example*
10388 Used for examples illustrating proven results.
10391 \begin_layout Problem
10392 It's not really known what this is for.
10393 You should figure it out.
10396 \begin_layout Exercise*
10397 Write a description for this one.
10400 \begin_layout Remark
10401 This environment is also a type of theorem, usually a lesser sort of observation.
10404 \begin_layout Claim*
10405 Often used in the course of giving a proof of a larger result.
10409 Generally, these are used to break up long arguments, using specific instances
10415 The numbering scheme for cases is on its own, not together with other numbered
10420 \begin_layout Proof
10421 At the end of this environment, a QED symbol (usually a square, but it can
10422 vary with different styles) is placed.
10423 If you want to have other environments within this one—for example, Case
10424 environments—and have the QED symbol appear only after them, then the other
10425 environments need to be nested within the proof environment.
10428 Nesting Environments
10434 for information on nesting.
10437 \begin_layout Standard
10438 And these environments are provided by
10439 \begin_inset Flex Code
10442 \begin_layout Plain Layout
10443 Theorems (AMS-Extended)
10451 \begin_layout Criterion*
10452 A required condition.
10455 \begin_layout Algorithm*
10456 A general procedure to be used.
10459 \begin_layout Axiom*
10460 This is a property or statement taken as true within the system being discussed.
10463 \begin_layout Condition*
10464 Sometimes used to state a condition assumed within the present context of
10468 \begin_layout Note*
10469 Similar to a Remark.
10472 \begin_layout Notation*
10473 Used for the explanation of, yes, notation.
10476 \begin_layout Summary
10477 Do we really need to tell you?
10480 \begin_layout Acknowledgement*
10484 \begin_layout Conclusion*
10485 Sometimes used at the end of a long train of argument.
10489 Used in a way similar to Proposition, though perhaps lower on the scale.
10492 \begin_layout Standard
10493 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10496 They need to be available on your system in order to use these environments.
10499 \begin_layout Section
10503 \begin_layout Standard
10509 \begin_layout Subsection
10513 \begin_layout Standard
10514 Broadway is for writing plays.
10515 The format is more decorative than Hollywood, and much less standardized.
10516 This format should be suitable for workshops.
10519 \begin_layout Subsection
10523 \begin_layout Standard
10524 The same as in Hollywood.
10527 \begin_layout Subsection
10531 \begin_layout Standard
10536 names as labels then cross-reference the label to insert the name.
10537 The cross-reference dialog will show the current cast of characters.
10540 \begin_layout Subsection
10541 Paper size and Margins
10544 \begin_layout Standard
10545 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10548 \begin_layout Subsection
10552 \begin_layout Standard
10553 The following environments are available.
10554 You can use broadway.bind to get the bind keys shown at the right.
10557 \begin_layout Itemize
10561 \begin_inset Newline newline
10566 You should not have to use this, but it is here for anything that does not
10570 \begin_layout Itemize
10574 \begin_inset space \hfill{}
10578 \begin_inset Newline newline
10583 Used to describe stage setting and the action.
10584 First use of speaker names in all CAPs.
10587 \begin_layout Itemize
10591 \begin_inset space \hfill{}
10595 \begin_inset Newline newline
10600 Automatically numbered.
10601 On screen it will be arabic, but will print as Roman.
10604 \begin_layout Itemize
10608 \begin_inset space \hfill{}
10612 \begin_inset Newline newline
10622 It is just centered text.
10625 \begin_layout Itemize
10629 \begin_inset space \hfill{}
10633 \begin_inset Newline newline
10638 Not automatically numbered.
10639 You supply the number.
10640 This is because I couldn't figure out how.
10643 \begin_layout Itemize
10647 \begin_inset space \hfill{}
10651 \begin_inset Newline newline
10656 A special case of Narrative to describe the setting and action as the curtain
10660 \begin_layout Itemize
10664 \begin_inset space \hfill{}
10668 \begin_inset Newline newline
10673 The speaker's (actor's) title, centered in all CAPS.
10676 \begin_layout Itemize
10680 \begin_inset space \hfill{}
10684 \begin_inset Newline newline
10689 Instructions to the speaker.
10690 The parentheses are automatically inserted.
10691 The ( will appear on screen, but both will be in the printed play.
10692 This environment is only used within
10699 \begin_layout Itemize
10703 \begin_inset space \hfill{}
10707 \begin_inset Newline newline
10712 What the Speaker says.
10715 \begin_layout Itemize
10719 \begin_inset space \hfill{}
10723 \begin_inset Newline newline
10728 The curtain comes down.
10731 \begin_layout Itemize
10735 \begin_inset space \hfill{}
10741 \begin_layout Itemize
10745 \begin_inset space \hfill{}
10751 \begin_layout Itemize
10755 \begin_inset space \hfill{}
10761 \begin_layout Standard
10765 \begin_layout Section
10769 \begin_layout Standard
10774 can be used to type letters according to German conventions.
10775 A template file is included in
10777 .../lyx/share/templates
10779 for you to use as a starting point.
10782 \begin_layout Section
10786 \begin_layout Standard
10787 See the \SpecialChar LyX
10793 It contains all infos you need.
10796 \begin_layout Section
10799 Foil\SpecialChar TeX
10803 \begin_inset CommandInset label
10812 \begin_layout Standard
10818 \begin_layout Subsection
10822 \begin_layout Standard
10823 This section describes how to use \SpecialChar LyX
10824 to make slides for overhead projectors.
10825 There are two document classes that can do this: the default slides class
10828 Foil\SpecialChar TeX
10832 This section documents the latter.
10835 \begin_layout Standard
10836 I'm going to say this again, nice and clear, so that there's no misunderstanding
10840 \begin_layout Standard
10841 \begin_inset VSpace bigskip
10847 \begin_layout Standard
10851 This section documents the class
10852 \begin_inset Quotes eld
10860 \begin_inset Quotes erd
10868 \begin_layout Standard
10869 \begin_inset VSpace bigskip
10875 \begin_layout Standard
10876 If you're looking for the documentation for
10877 \begin_inset Quotes eld
10885 \begin_inset Quotes erd
10888 , check out section
10889 \begin_inset space ~
10893 \begin_inset CommandInset ref
10895 reference "sec:slitex"
10900 If your machine doesn't have the
10908 installed, you'll probably have to use the default
10912 class, which isn't quite as good as
10917 \begin_layout Standard
10922 class is designed for use with version
10923 \begin_inset space ~
10931 class file which is now an integral part of \SpecialChar LaTeX2e
10935 \begin_layout Subsection
10939 \begin_layout Standard
10940 Obviously, to use this document class, you need to select
10951 \begin_inset space ~
10957 There are some settings in the
10960 \begin_inset space ~
10965 dialog that you should know about that are specific to this class:
10968 \begin_layout Itemize
10969 Don't change the options
10980 \begin_inset space ~
10986 They're ignored by the
10993 \begin_layout Itemize
10994 The default font size is 20
10995 \begin_inset space \thinspace{}
10998 pt with the other options being 17
10999 \begin_inset space \thinspace{}
11003 \begin_inset space \thinspace{}
11007 \begin_inset space \thinspace{}
11013 \begin_layout Itemize
11014 The default font is
11022 but all math equations are still typeset in the usual roman font.
11025 \begin_layout Itemize
11028 Foil\SpecialChar TeX
11031 supports A4 and Letter paper sizes as well as a special size for working
11033 \begin_inset space \thinspace{}
11037 It doesn't support A5, B5, legal or executive paper sizes.
11040 \begin_layout Itemize
11041 Don't bother changing the
11045 settings because they are ignored anyway.
11046 All floats appear where they are defined in the text.
11049 \begin_layout Itemize
11054 setting behaves a bit differently for this class.
11057 Foil\SpecialChar TeX
11060 provides extensive footer and header capabilities including a user-defined
11063 \begin_inset space ~
11067 \begin_inset CommandInset ref
11069 reference "sec:foilfoot"
11074 The title page is treated differently to all other pages in the document
11083 has the logo centered at the bottom of the page (if one is defined).
11084 The possible page style choices and what they do are as follows:
11088 \begin_layout Labeling
11089 \labelwidthstring MMMMMMM
11096 The final output contains no page numbers, or other headers or footers
11097 (except footnotes of course).
11101 \begin_layout Labeling
11102 \labelwidthstring MMMMMMM
11109 The final output contains page numbers centered at the bottom of the page.
11110 No other headings or footers (other than footnotes).
11113 \begin_layout Labeling
11114 \labelwidthstring MMMMMMM
11119 Page numbers in lower right corner.
11120 Additional headers and footers are also shown.
11121 This is also the default.
11124 \begin_layout Labeling
11125 \labelwidthstring MMMMMMM
11130 Gives you access to the
11134 package although its use with
11136 Foil\SpecialChar TeX
11139 is discouraged by the writer of the
11141 Foil\SpecialChar TeX
11144 package because of some potential page layout clashes.
11148 \begin_layout Subsubsection
11152 \begin_layout Standard
11153 The following options may be used in the extra class options in the
11155 Document\SpecialChar menuseparator
11161 \begin_layout Labeling
11162 \labelwidthstring MMMMMMx
11167 This sets up the page layout for 7.33
11168 \begin_inset space \thinspace{}
11172 \begin_inset space \thinspace{}
11175 in paper, which is about the same aspect ratio as a 35
11176 \begin_inset space \thinspace{}
11179 mm slide, making it a bit easier to work with this medium.
11182 \begin_layout Labeling
11183 \labelwidthstring MMMMMMx
11188 Places a rule across the page below the header on every page except the
11192 \begin_layout Labeling
11193 \labelwidthstring MMMMMMx
11198 Places a rule across the page above the footer on every page except the
11202 \begin_layout Labeling
11203 \labelwidthstring MMMMMMx
11208 This is automatically set each time you create a new
11215 Foil\SpecialChar TeX
11218 to use the dvips driver to rotate those pages that are set as landscape
11222 \begin_layout Labeling
11223 \labelwidthstring MMMMMMx
11228 Simply changes the page dimensions to those of a landscape page but doesn't
11230 Thus if you use this option you need to use an external program to rotate
11231 each page or feed your paper through your printer as landscape.
11232 Note that this option effectively reverses the roles of the
11240 environments (don't worry these are described in the next section).
11243 \begin_layout Labeling
11244 \labelwidthstring MMMMMMx
11249 Equation numbers on the left.
11252 \begin_layout Labeling
11253 \labelwidthstring MMMMMMx
11258 Flush-left equations.
11261 \begin_layout Subsection
11262 Supported Environments
11265 \begin_layout Standard
11266 Most of the environments commonly supported in other classes are also supported
11272 There are several additional environments provided by
11274 Foil\SpecialChar TeX
11277 as well as a couple added by \SpecialChar LyX
11279 The following environments are shared with other classes:
11282 \begin_layout Standard
11283 \begin_inset Flex Multiple Columns
11286 \begin_layout Itemize
11292 \begin_layout Itemize
11298 \begin_layout Itemize
11304 \begin_layout Itemize
11310 \begin_layout Itemize
11316 \begin_layout Itemize
11323 \begin_layout Itemize
11329 \begin_layout Itemize
11335 \begin_layout Itemize
11341 \begin_layout Itemize
11347 \begin_layout Itemize
11353 \begin_layout Itemize
11359 \begin_layout Itemize
11365 \begin_layout Itemize
11371 \begin_layout Itemize
11382 \begin_layout Standard
11383 That is, all the major environments apart from the sectioning environments.
11384 Since foils are essentially self-contained sections, with a title and body,
11387 Foil\SpecialChar TeX
11390 provides specific commands for starting new foils and these are:
11393 \begin_layout Itemize
11399 \begin_layout Itemize
11405 \begin_layout Standard
11407 also provides slightly modified versions of these two environments called:
11410 \begin_layout Itemize
11416 \begin_layout Itemize
11419 ShortRotatefoilhead
11422 \begin_layout Standard
11423 and the differences will be explained in the next section.
11426 \begin_layout Standard
11427 Since foils are often used in presenting ideas or new theorems and such
11430 Foil\SpecialChar TeX
11433 also provides a comprehensive box of goodies for presenting them:
11436 \begin_layout Standard
11437 \begin_inset Flex Multiple Columns
11440 \begin_layout Itemize
11446 \begin_layout Itemize
11452 \begin_layout Itemize
11458 \begin_layout Itemize
11464 \begin_layout Itemize
11470 \begin_layout Itemize
11476 \begin_layout Itemize
11482 \begin_layout Itemize
11488 \begin_layout Itemize
11494 \begin_layout Itemize
11500 \begin_layout Itemize
11511 \begin_layout Standard
11512 The starred versions are unnumbered while the unstarred versions are numbered.
11513 There are also two list environments added by \SpecialChar LyX
11517 \begin_layout Itemize
11523 \begin_layout Itemize
11529 \begin_layout Standard
11532 Foil\SpecialChar TeX
11535 provides some powerful header and footer capabilities that are best set
11536 in the preamble although they may be set at any point in a document.
11537 If you want to change these settings in your document the best place to
11538 do so is at the very top of a foil, i.
11539 \begin_inset space \thinspace{}
11545 \begin_inset space \space{}
11550 straight after the foilhead.
11553 \begin_layout Standard
11554 For this purpose, the following command styles are provided [
11561 \begin_layout Standard
11562 \begin_inset Flex Multiple Columns
11565 \begin_layout Itemize
11569 \begin_inset space ~
11575 \begin_layout Itemize
11581 \begin_layout Itemize
11585 \begin_inset space ~
11591 \begin_layout Itemize
11595 \begin_inset space ~
11601 \begin_layout Itemize
11605 \begin_inset space ~
11612 \begin_layout Plain Layout
11613 \begin_inset space ~
11625 \begin_layout Standard
11626 There are also a few commands provided by
11628 Foil\SpecialChar TeX
11631 that aren't directly supported by \SpecialChar LyX
11632 but I'll tell you what they do and how
11633 to use them in section
11634 \begin_inset space ~
11638 \begin_inset CommandInset ref
11640 reference "sec:unsuppfoils"
11647 \begin_layout Subsection
11648 Building a Set of Foils
11651 \begin_layout Standard
11652 This section will give a simple introduction to using the different environments
11653 to build a set of foils.
11654 If you want to see an example set of foils, take a look at the
11658 file you find in \SpecialChar LyX
11666 \begin_layout Subsubsection
11667 Give It a Title Page
11670 \begin_layout Standard
11671 Unlike other classes that provide
11691 creates the title on a page of its own.
11692 If you leave out the
11696 environment \SpecialChar LaTeX
11697 will substitute the current date (every time you regenerate
11701 \begin_layout Subsubsection
11705 \begin_layout Standard
11706 As I mentioned earlier, there are four ways of starting a new foil.
11707 For portrait foils you should use
11716 The difference between these two environments is the amount of space between
11717 the title of the foil (the foilhead) and the body of the foil.
11720 \begin_layout Standard
11721 Landscape foils are generated using the
11727 ShortRotatefoilhead
11730 Again the only difference is the spacing between foilhead and body.
11731 Both of the short versions have 0.5
11732 \begin_inset space ~
11735 inches less separation between the foilhead and the body.
11739 \begin_layout Standard
11740 One problem with the support for landscape foils is the requirement that
11741 you have to use the
11745 driver to generate the PostScript output otherwise the foils won't be rotated.
11746 It is possible to get landscape foils even if you haven't got the
11750 driver provided you can feed your foils sideways through your printer ;-)
11753 \begin_layout Subsubsection
11754 Theorems, Lemmas, Proofs and more
11757 \begin_layout Standard
11758 You can't have two of the same type of these environments directly following
11760 If you use a normal paragraph break, , you will just be extending the previous
11761 environment as if you had merged the two environments together.
11762 Rather than that, you need to insert a so-called separator.
11763 Please refer to the section entitled
11774 \begin_layout Subsubsection
11778 \begin_layout Standard
11779 You get all the commonly supported list styles found in other classes as
11780 well as two new ones.
11781 I'll only describe the new ones here.
11782 If you want to find out more about the other list environments check out
11788 If you intend to use itemized lists you might also want to read about the
11792 \begin_inset space ~
11796 \begin_inset space ~
11801 dialog described above in section
11802 \begin_inset space ~
11806 \begin_inset CommandInset ref
11808 reference "sec:bullet"
11815 \begin_layout Standard
11816 The two new list styles,
11824 , are designed to make it easier for you to create lists of do's and don'ts
11825 or right and wrong by providing dedicated environments that use a tick
11826 or a cross as the label of the list.
11827 These lists are in fact dedicated variants of the
11832 They do however require that you have the
11836 packages installed.
11839 \begin_layout Subsubsection
11843 \begin_layout Standard
11846 Foil\SpecialChar TeX
11849 redefines the floating tables and figures so that they appear exactly where
11850 they are in the text rather than pushing them to the top of the page or
11851 to some user specified location.
11852 In fact if you change the float placement settings they are simply ignored.
11855 \begin_layout Subsubsection
11856 Page Headers and Footers
11857 \begin_inset CommandInset label
11859 name "sec:foilfoot"
11866 \begin_layout Standard
11870 \begin_inset space ~
11879 are two commands used to control the left-footer text string.
11880 The first is meant to allow you to include a graphic logo on your foils
11882 \begin_inset Quotes eld
11887 Foil\SpecialChar TeX
11891 \begin_inset Quotes erd
11895 While the second is meant to provide a classification for the audience,
11899 \begin_inset space \thinspace{}
11905 \begin_inset space \space{}
11909 It is empty by default.
11912 \begin_layout Standard
11913 The remaining page corners can be filled by
11916 \begin_inset space ~
11921 (which defaults to page numbers),
11924 \begin_inset space ~
11932 \begin_inset space ~
11940 \begin_layout Subsection
11943 Foil\SpecialChar TeX
11947 \begin_inset CommandInset label
11949 name "sec:unsuppfoils"
11956 \begin_layout Standard
11957 All the commands mentioned below need to be set in a
11967 within another environment.
11970 \begin_layout Subsubsection
11974 \begin_layout Standard
11975 All lengths are adjusted using the
11998 should be replaced by the name given to the length you want to change and
12003 is the length value.
12004 All lengths should be specified in units of length such as inches (
12016 ) or relative to some document or font-based length such as
12026 \begin_layout Standard
12027 It's possible to change the spacing between a foilhead and the body of the
12028 foil by adjusting the length specified by
12035 For example, to make
12040 \begin_inset space \space{}
12043 in closer to their bodies put the following in the preamble:
12049 foilheadskip}{-0.5in}
12052 \begin_layout Standard
12053 The spacings around floats can be adjusted by setting these lengths:
12056 \begin_layout Labeling
12057 \labelwidthstring MMMMMMMMMMM
12064 Separation between the text and the top of the float
12067 \begin_layout Labeling
12068 \labelwidthstring MMMMMMMMMMM
12075 Separation between the float and the caption
12078 \begin_layout Labeling
12079 \labelwidthstring MMMMMMMMMMM
12086 Separation between the caption and the following text
12089 \begin_layout Labeling
12090 \labelwidthstring MMMMMMMMMMM
12097 You can make the captions narrower than the surrounding text by adjusting
12099 Best done relative to
12108 \begin_layout Standard
12109 There are also several title page related lengths that you may find useful
12110 if you have a long title or several authors:
12113 \begin_layout Labeling
12114 \labelwidthstring MMMMMMMMMMM
12121 Separation from headers to
12126 \begin_layout Labeling
12127 \labelwidthstring MMMMMMMMMMM
12145 \begin_layout Labeling
12146 \labelwidthstring MMMMMMMMMMM
12160 \begin_layout Labeling
12161 \labelwidthstring MMMMMMMMMMM
12177 \begin_layout Labeling
12178 \labelwidthstring MMMMMMMMMMM
12194 \begin_layout Standard
12195 The last length related command affects all the list environments.
12206 a list environment then all the vertical spacing between the list items
12208 Note that this is a command not a length so it doesn't require
12214 like the stuff mentioned above.
12217 \begin_layout Subsubsection
12218 Headers and Footers
12221 \begin_layout Standard
12234 commands control whether the logo in the
12238 definition appear on a given page.
12245 in the preamble then none of the foils will have the logo on them.
12246 If you don't want the logo on a particular page place the
12252 directly after the foilhead of that page and the
12258 directly after the next foilhead.
12261 \begin_layout Standard
12262 If you decide to use the
12266 page style setting in the
12269 \begin_inset space ~
12274 dialog you should probably add
12284 to your preamble so headers and footers on landscape pages are correctly
12285 placed when rotated.
12286 This is due to some clashes between the page layouts provided by the
12297 \begin_layout Section
12298 Hollywood (Hollywood spec scripts)
12301 \begin_layout Standard
12307 \begin_layout Subsection
12311 \begin_layout Standard
12312 Getting the format of a Hollywood script right is a
12313 \begin_inset Quotes eld
12317 \begin_inset Quotes erd
12320 It is designed to make the readers focus on content and to be easy and
12321 familiar for the actors to read.
12322 Each page of a script should be one minute of film.
12323 Nothing goes in a script that you cannot see or hear on screen.
12324 The courier 12 pt font should be used throughout.
12328 \begin_layout Subsection
12332 \begin_layout Standard
12333 Speakers' lines should NEVER break in mid-sentence.
12334 If a speaker's lines continue over a page break, repeat the
12338 title followed by (Cont'd).
12341 \begin_layout Subsection
12345 \begin_layout Standard
12350 names as labels then cross-reference the label to insert the name.
12351 The cross-reference dialog will show the current cast of characters.
12352 You can use this to insert the speaker name in narratives also.
12355 \begin_layout Subsection
12356 Paper size and Margins
12359 \begin_layout Standard
12360 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12363 \begin_layout Subsection
12367 \begin_layout Standard
12368 The following environments are available.
12369 You can use hollywood.bind to get the bind keys shown at the right.
12372 \begin_layout Itemize
12376 \begin_inset Newline newline
12381 Used where nothing else works.
12385 \begin_layout Itemize
12391 \begin_inset space \hfill{}
12399 \begin_inset Newline newline
12402 Usually followed by something like
12403 \begin_inset Quotes eld
12406 on Sally waking up.
12407 \begin_inset Quotes erd
12413 \begin_layout Itemize
12417 \begin_inset space \hfill{}
12421 \begin_inset Newline newline
12426 Introduces a new INTERIOR camera set-up.
12427 Always followed by DAY or NIGHT, or something similar to define the lighting
12429 Everthing on this line in CAPS.
12432 \begin_layout Itemize
12436 \begin_inset space \hfill{}
12440 \begin_inset Newline newline
12445 Introduces a new EXTERIOR camera set-up.
12446 Everthing on this line in CAPS.
12449 \begin_layout Itemize
12453 \begin_inset space \hfill{}
12457 \begin_inset Newline newline
12462 The character speaking.
12465 \begin_layout Itemize
12469 \begin_inset space \hfill{}
12473 \begin_inset Newline newline
12478 Instructions to the speaker.
12479 The () are automatically inserted.
12482 \begin_layout Itemize
12486 \begin_inset space \hfill{}
12490 \begin_inset Newline newline
12502 \begin_layout Itemize
12506 \begin_inset space \hfill{}
12510 \begin_inset Newline newline
12515 Camera movement instruction.
12517 \begin_inset space \thinspace{}
12521 \begin_inset space \space{}
12527 \begin_layout Itemize
12531 \begin_inset space \hfill{}
12537 \begin_layout Itemize
12541 \begin_inset space \hfill{}
12547 \begin_layout Itemize
12551 \begin_inset space \hfill{}
12557 \begin_layout Itemize
12561 \begin_inset space \hfill{}
12567 \begin_layout Subsection
12571 \begin_layout Itemize
12572 (O.S) — off screen
12575 \begin_layout Itemize
12576 (V.0) — voice over
12579 \begin_layout Itemize
12581 \begin_inset space \thinspace{}
12588 \begin_layout Itemize
12593 \begin_layout Itemize
12594 PAN — camera movement
12597 \begin_layout Itemize
12598 INSERT — cut to close-up of
12601 \begin_layout Section
12605 \begin_layout Standard
12608 Panayotis Papasotiriou
12611 \begin_layout Subsection
12615 \begin_layout Standard
12616 The ijmpc package is a set of macros that facilitates electronic manuscript
12619 International Journal of Modern Physics C
12622 Similarly, the ijmpd package is for creating manuscripts to be submitted
12625 International Journal of Modern Physics D
12628 Both journals are published by World Scientific.
12629 The corresponding document classes are named
12638 These files, together with instructions for the authors, can be downloaded
12640 \begin_inset Flex URL
12643 \begin_layout Plain Layout
12645 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12651 \begin_inset Flex URL
12654 \begin_layout Plain Layout
12656 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12662 Both packages are modified versions of the standard
12663 \begin_inset Quotes eld
12667 \begin_inset Quotes erd
12670 package, and they are almost (but not exactly) identical.
12671 Most of their features are supported by \SpecialChar LyX
12673 I have used \SpecialChar LyX
12674 successfully to write articles submitted to both journals
12675 without any problem.
12678 \begin_layout Subsection
12682 \begin_layout Standard
12683 As usual, the easiest way to write a paper is to start with a template.
12686 File\SpecialChar menuseparator
12702 This will give an (almost) empty document that includes the most common
12703 fields found in a manuscript.
12704 Simply overwrite the existing text (including the brackets,
12709 You should keep in mind the following remarks.
12712 \begin_layout Enumerate
12714 won't let you change the font size and the page style of the document,
12715 because such modifications are not allowed by both packages.
12718 \begin_layout Enumerate
12719 The language of the document should not be changed.
12720 Before previewing your paper, be sure that the babel package is not used.
12721 To do this, click on
12724 arg "dialog-show document"
12729 \SpecialChar menuseparator
12733 \begin_inset Quotes eld
12737 \begin_inset Quotes erd
12747 \begin_layout Enumerate
12749 \begin_inset Quotes eld
12753 \begin_inset Quotes erd
12756 style must be used to define keywords.
12759 \begin_layout Enumerate
12760 The ijmpc package provides a style named
12761 \begin_inset Quotes eld
12764 Classification Codes
12765 \begin_inset Quotes erd
12768 , which can be used to define classification codes, such as PACS numbers.
12769 Note that this facility is not supported by the ijmpd package.
12772 \begin_layout Enumerate
12773 Several new environments are available:
12774 \begin_inset Quotes eld
12778 \begin_inset Quotes erd
12782 \begin_inset Quotes eld
12786 \begin_inset Quotes erd
12790 \begin_inset Quotes eld
12794 \begin_inset Quotes erd
12798 \begin_inset Quotes eld
12802 \begin_inset Quotes erd
12806 \begin_inset Quotes eld
12810 \begin_inset Quotes erd
12814 \begin_inset Quotes eld
12818 \begin_inset Quotes erd
12822 \begin_inset Quotes eld
12826 \begin_inset Quotes erd
12830 \begin_inset Quotes eld
12834 \begin_inset Quotes erd
12838 \begin_inset Quotes eld
12842 \begin_inset Quotes erd
12846 \begin_inset Quotes eld
12850 \begin_inset Quotes erd
12854 \begin_inset Quotes eld
12858 \begin_inset Quotes erd
12862 \begin_inset Quotes eld
12866 \begin_inset Quotes erd
12870 \begin_inset Quotes eld
12874 \begin_inset Quotes erd
12878 \begin_inset Quotes eld
12882 \begin_inset Quotes erd
12886 Their use is more or less obvious.
12888 supports all these environments; it will use the proper label, text style,
12889 and numbering scheme for each of them.
12892 \begin_layout Enumerate
12893 Both packages use basic citations; the natbib package should not be used.
12894 In \SpecialChar LyX
12895 , citation references are shown as usual; in the output, citations are
12896 shown as superscripts.
12897 If you want to use a citation as normal text, you should use the
12902 \begin_inset space \thinspace{}
12906 \begin_inset space \space{}
12910 \begin_inset Quotes eld
12914 \begin_inset space \space{}
12924 \begin_inset Quotes erd
12930 \begin_layout Enumerate
12932 \begin_inset Quotes eld
12936 \begin_inset Quotes erd
12939 section in both packages.
12940 To put acknowledgments, just use the
12941 \begin_inset Quotes eld
12945 \begin_inset Quotes erd
12951 \begin_layout Enumerate
12952 Appendices may be added to the paper,
12956 the Acknowledgments and
12962 provides a special environment, called
12963 \begin_inset Quotes eld
12967 \begin_inset Quotes erd
12970 which marks the beginning of the appendices.
12971 This environment should be left blank; it just sends a \SpecialChar LaTeX
12972 command, but nothing
12974 In \SpecialChar LyX
12976 \begin_inset Quotes eld
12980 \begin_inset Quotes erd
12983 is printed with blue letters, as a signal that all sections after that
12984 point are appendices.
12985 To write an appendix, use the
12986 \begin_inset Quotes eld
12990 \begin_inset Quotes erd
12995 will number each appendix with capital letters, as required by both journals.
12997 \begin_inset Quotes eld
13001 \begin_inset Quotes erd
13008 be present before the first appendix; if not, all appendices will be numbered
13009 as normal sections in the output.
13012 \begin_layout Enumerate
13013 The ijmpc and the ijmpd packages use the
13017 command to implement table captions.
13018 As a result, a table created by \SpecialChar LyX
13019 is printed correctly, but its caption
13021 However, you can use some \SpecialChar TeX
13022 code to overcome this problem, so that captions
13023 are printed as expected.
13024 To do so, create a float table as usual, remove the caption, and replace
13025 it with the \SpecialChar TeX
13036 (sic); you must also the \SpecialChar TeX
13041 immediately after the tabular material.
13042 Study the example table included in the template files to see how this
13043 trick is implemented.
13044 Alternatively, If you need table captions, you should implement the whole
13049 file, then include this file to the \SpecialChar LyX
13052 Insert\SpecialChar menuseparator
13053 File\SpecialChar menuseparator
13055 \begin_inset space ~
13061 Details on how to create a table float can be found in the files
13069 , included in the corresponding packages.
13072 \begin_layout Subsection
13073 Preparing a paper for submission
13076 \begin_layout Standard
13077 Before you submit your paper you must export the \SpecialChar LyX
13078 document as a \SpecialChar LaTeX
13081 File\SpecialChar menuseparator
13082 Export\SpecialChar menuseparator
13090 \begin_layout Plain Layout
13091 Actually you have the choice between \SpecialChar LaTeX
13092 (plain) and pdflatex.
13093 If you intend to use pdflatex to prepare the paper, you should use the
13094 pdflatex option so that included graphics are converted to PDF format,
13095 ready for use by pdflatex.
13100 , then make the following changes to the resulting
13107 \begin_layout Enumerate
13108 Remove the comment lines before the
13117 \begin_layout Enumerate
13118 Remove everything between (and including) the
13130 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13134 \begin_layout Standard
13139 file should be saved and processed through \SpecialChar LaTeX
13140 as many times as necessary.
13141 You may also want to check the resulting
13148 \begin_layout Section
13152 \begin_layout Standard
13158 \begin_layout Subsection
13162 \begin_layout Standard
13163 The iopart package provides a document class to create electronic manuscript
13164 submission to the journals published by the Institute of Physics.
13165 Instructions for the authors how to create a paper using the iopart class
13166 can be downloaded together with the iopart package from the site
13167 \begin_inset Flex URL
13170 \begin_layout Plain Layout
13172 ftp://ftp.iop.org/pub/journals/latex2e
13180 \begin_layout Subsection
13184 \begin_layout Standard
13185 The easiest way to write a paper is to start with the template
13189 that is available via
13191 File\SpecialChar menuseparator
13194 The template explains how to use the special text environments.
13195 Here are the most important advices:
13198 \begin_layout Itemize
13199 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13200 no AMS packages are loaded in
13202 Document\SpecialChar menuseparator
13203 Settings\SpecialChar menuseparator
13209 \begin_layout Itemize
13212 The title environment defines the kind of your paper.
13213 So use one of the following environments for the title:
13217 \begin_layout Itemize
13226 \begin_layout Itemize
13235 \begin_layout Itemize
13241 for a Topical review
13244 \begin_layout Itemize
13253 \begin_layout Itemize
13262 \begin_layout Itemize
13268 for a Paper (same as Title)
13271 \begin_layout Itemize
13277 for a Preliminary communication
13280 \begin_layout Itemize
13286 for a Rapid communication
13289 \begin_layout Itemize
13295 for a Letter to the editor
13299 \begin_layout Itemize
13302 All title environments except of
13306 can have an optional short title.
13309 \begin_layout Itemize
13310 There is a general title environment
13314 which is not directly supported by \SpecialChar LyX
13316 This can be used as \SpecialChar TeX
13317 code when your document doesn't fit into one of the
13321 \begin_layout Standard
13322 For more informations like hints for special table and formula formatting,
13323 look at the IOP author guidelines.
13326 \begin_layout Section
13330 \begin_layout Standard
13333 Panayotis Papasotiriou
13336 \begin_layout Subsection
13340 \begin_layout Standard
13341 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13342 that facilitates electronic manuscript submission to the journals they
13344 Most known of them (at least in my domain of interest) are
13346 Astrophysics and Space Science
13352 , but there are many others (see a complete list at
13353 \begin_inset Flex URL
13356 \begin_layout Plain Layout
13358 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13364 The Kluwer package may be downloaded from the site
13365 \begin_inset Flex URL
13368 \begin_layout Plain Layout
13370 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13376 A complete user guide is contained in that package (but it can also be
13377 downloaded separately).
13380 \begin_layout Standard
13382 supports many features of the package but not everything.
13383 However, the \SpecialChar TeX
13384 code needed is reduced to some
13385 \begin_inset Quotes eld
13389 \begin_inset Quotes erd
13392 commands of the package (see
13393 \begin_inset space ~
13397 \begin_inset CommandInset ref
13399 reference "subsec:kluwer_peculiarities"
13404 I have recently used \SpecialChar LyX
13405 to write an article submitted to the
13407 Astrophysics and Space Science
13409 without any problem.
13412 \begin_layout Subsection
13416 \begin_layout Standard
13417 The easiest way to write a paper is to start with the Kluwer template file.
13420 File\SpecialChar menuseparator
13432 This will give an (almost) empty document that includes the most common
13433 fields found in a manuscript and a short description of their use.
13434 As in most templates, simply overwrite the existing text (including the
13439 ) with the correct information.
13442 \begin_layout Subsection
13443 Preparing a paper for submission
13446 \begin_layout Standard
13447 As in the AAS\SpecialChar TeX
13448 package, before you submit your paper to a journal you must
13450 \begin_inset Quotes eld
13454 \begin_inset Quotes erd
13460 \begin_layout Enumerate
13461 Export your paper as a \SpecialChar LaTeX
13463 To do this, click on
13465 File\SpecialChar menuseparator
13466 Export\SpecialChar menuseparator
13474 \begin_layout Enumerate
13479 file with a text editor and make the following changes
13483 \begin_layout Enumerate
13484 remove the comment lines before the
13493 \begin_layout Enumerate
13494 remove everything between (and including) the
13506 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13510 \begin_layout Standard
13519 \begin_layout Enumerate
13524 file through \SpecialChar LaTeX
13525 as many times as necessary (usually up to three).
13528 \begin_layout Enumerate
13534 \begin_inset space \thinspace{}
13538 \begin_inset space \space{}
13545 , and check if everything is OK (it should, if you didn't make any mistake).
13548 \begin_layout Subsection
13549 \begin_inset Quotes eld
13553 \begin_inset Quotes erd
13556 of the Kluwer package
13557 \begin_inset CommandInset label
13559 name "subsec:kluwer_peculiarities"
13566 \begin_layout Standard
13567 The Kluwer package has the following
13568 \begin_inset Quotes eld
13572 \begin_inset Quotes erd
13578 \begin_layout Enumerate
13579 It is possible to write multiple articles in the same \SpecialChar LaTeX
13584 \begin_layout Plain Layout
13585 I can't imagine any good reason to do this.
13591 Each article must be included in the environment
13592 \begin_inset Quotes eld
13596 \begin_inset Quotes erd
13600 Unfortunately, this environment cannot be omitted, even if you write just
13602 Therefore, each article starts with the command
13608 and, obviously, ends with the command
13615 Although this can be implemented in \SpecialChar LyX
13616 , I didn't included it, since it looks
13617 ugly and can confuse the novice user.
13618 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13621 \begin_inset Quotes eld
13626 \begin_inset Quotes erd
13632 \begin_layout Enumerate
13633 Information given at the beginning of the article (i.
13634 \begin_inset space \thinspace{}
13638 \begin_inset space \space{}
13641 title, subtitle, author, institution, running title, running author, abstract
13642 and keywords) must be included in an environment called
13643 \begin_inset Quotes eld
13647 \begin_inset Quotes erd
13651 This is not implemented in \SpecialChar LyX
13652 , so you must enter title, subtitle etc.
13653 \begin_inset space ~
13656 between two \SpecialChar TeX
13672 \begin_layout Enumerate
13673 According to the user manual, the label of each bibliography item must be
13697 \begin_layout Standard
13702 template takes care of all these
13703 \begin_inset Quotes eld
13707 \begin_inset Quotes erd
13711 If you start a new paper using this template you don't need to do anything
13716 \begin_layout Enumerate
13717 don't delete the \SpecialChar TeX
13718 code included in the template, and
13721 \begin_layout Enumerate
13722 copy the example bibliography item included in the template and modify it
13723 as necessary to enter new bibliography items.
13726 \begin_layout Section
13730 \begin_layout Standard
13736 \begin_layout Subsection
13740 \begin_layout Standard
13741 The \SpecialChar LyX
13744 article (koma-script)
13748 report (koma-script)
13766 correspond to the \SpecialChar LaTeX
13784 \begin_inset space ~
13787 of the Koma-Script family.
13788 They are replacements for the standard document classes
13804 , resp., and fit better to European typography conventions in a number of
13808 \begin_layout Itemize
13809 Standard character size is 11pt in
13811 article (koma-script)
13815 report (koma-script)
13823 letter (koma-script)
13828 \begin_layout Itemize
13829 Headings, labels of the description environment, and a number of elements
13832 letter (koma-script)
13834 document class are set in a bold sans serif font.
13838 \begin_layout Plain Layout
13839 There is a big difference between the bold sans serif old cm fonts and new
13840 ec fonts, especially in the appearance of headings.
13841 In comparison, the ec bold sans serif fonts look a bit thin.
13842 Here the \SpecialChar LaTeX
13851 helps to produce the
13852 \begin_inset Quotes eld
13856 \begin_inset Quotes erd
13859 appearance when using the ec fonts.
13864 The numbering of chapter headings is made in the same way as the numbering
13865 of section headings, that is without the extra line
13866 \begin_inset Quotes eld
13869 Chapter\SpecialChar ldots
13871 \begin_inset Quotes erd
13875 In addition, the appearance of the headings can be modified by using a
13876 number of options (in \SpecialChar LyX
13877 to be entered in the field
13880 \begin_inset space ~
13887 Layout\SpecialChar menuseparator
13894 \begin_layout Itemize
13895 The main means in the Koma-Script document classes to design the type area
13904 (in \SpecialChar LyX
13905 to be entered in the extra class options field in the dialog
13907 Document\SpecialChar menuseparator
13911 They make a clearer modification of page margins possible as do the options
13914 Document\SpecialChar menuseparator
13921 \begin_layout Itemize
13922 The \SpecialChar LaTeX
13923 document classes of the Koma-Script family define a number of additional
13925 Those part of it which makes sense in \SpecialChar LyX
13926 is implemented in corresponding
13930 \begin_layout Standard
13931 Detailed descriptions of the \SpecialChar LaTeX
13932 document classes of the Koma-Script family
13933 can be found in the Koma-Script documentation
13944 \begin_layout Subsection
13945 article (koma-script), report (koma-script), and book (koma-script)
13948 \begin_layout Standard
13949 The document classes
13951 article (koma-script)
13955 report (koma-script)
13965 are implemented in the layout files
13978 They contain all the paragraph types of the corresponding standard document
13991 , resp., partly modified, with the exception of the \SpecialChar LyX
13996 -type, which is replaced by the new
14000 -type having the same functionality.
14005 -Type there is a number of new paragraph types added.
14012 letter (koma-script)
14017 \begin_layout Itemize
14026 : are equivalents to
14034 , resp., additionally inserting an entry in the table of contents.
14043 are not contained in
14045 article (koma-script)
14050 \begin_layout Itemize
14059 : behave exactly as
14067 , resp., additionally clearing running heads.
14072 is not contained in
14074 article (koma-script)
14080 \begin_layout Plain Layout
14093 report (koma-script)
14095 , but since this is identical to
14099 , is has not been implemented in \SpecialChar LyX
14108 \begin_layout Itemize
14113 : generates a heading directly above the following paragraph in the standard
14114 character size without affecting the structure of the document.
14117 \begin_layout Itemize
14126 are special captions which respect the different space settings needed
14127 for captions placed above or below an element (if you follow strict typographic
14128 rules, you might want to place table captions always above the table).
14129 You can also use the class option
14133 , which will switch
14146 You need at least Koma-Script version 2.8q to use this.
14149 \begin_layout Itemize
14154 : can be used to set a bonmot, e.
14155 \begin_inset space \thinspace{}
14159 \begin_inset space \space{}
14162 at the beginning of a chapter.
14163 If you use the optional argument (
14165 Insert\SpecialChar menuseparator
14167 \begin_inset space ~
14172 ), you can insert the dictum's author there.
14173 Dictum and author are separated by a line.
14174 You need at least Koma-Script version 2.8q to use this.
14179 is not contained in
14181 article (koma-script)
14186 \begin_layout Standard
14187 The following types, together with the standard types
14199 , form the title area of the document.
14200 They must be entered ahead of the first
14201 \begin_inset Quotes eld
14205 \begin_inset Quotes erd
14212 \begin_layout Plain Layout
14213 The corresponding \SpecialChar LaTeX
14214 commands must appear before the
14225 When such a type is used more than once, the latter usage overwrites the
14226 former one, that means, for every type only the latest usage is valid.
14227 The order of the different types however has, like
14239 , no effect on the appearance of the produced document.
14242 \begin_layout Itemize
14247 : produces a centered paragraph above the ordinary title (
14259 ) for the subject of the document.
14262 \begin_layout Itemize
14267 : produces a centered paragraph below the ordinary title (
14279 ) for the publishers' name.
14282 \begin_layout Itemize
14289 report (koma-script)
14295 produces a centered paragraph on its own page behind the title page, or
14298 article (koma-script)
14300 produces a centered paragraph below the ordinary title (
14316 ) for a dedication.
14319 \begin_layout Itemize
14324 : produces a left aligned paragraph above the ordinary title (
14340 ) for a document`s head.
14343 \begin_layout Itemize
14348 : produces in a double-sided print in
14350 report (koma-script)
14356 a left-aligned paragraph at the top of the title page`s back or has no
14357 effect in a single-sided print or in
14359 article (koma-script)
14364 \begin_layout Itemize
14369 : produces in a double-sided print in
14371 report (koma-script)
14377 a left-aligned paragraph at the bottom of the title page`s back or has
14378 no effect in a single-sided print or in
14380 article (koma-script)
14385 \begin_layout Itemize
14390 : produces a special
14391 \begin_inset Quotes eld
14395 \begin_inset Quotes erd
14398 page ahead of the actual document containing a paragraph without special
14402 \begin_layout Standard
14403 The layout files for the document classes
14405 article (koma-script)
14409 report (koma-script)
14415 do include the file
14420 This is thought of as a place to define your own types.
14425 in your personal layout directory and edit the file!
14428 \begin_layout Subsection
14429 letter (koma-script)
14432 \begin_layout Description
14433 Note: This section discusses the obsolete
14435 KOMA-Script-Letter (v.
14436 \begin_inset space ~
14441 , which is not even included anymore in recent KOMA releases.
14442 Please refer to the next section for the current KOMA-Script-Letter class
14444 \begin_inset space ~
14450 \begin_layout Standard
14454 letter (koma-script)
14456 is implemented in the layout file
14461 It contains all the paragraph types of the corresponding standard document
14466 , partly modified, with the exception of the \SpecialChar LyX
14480 type, which is replaced by the new
14485 In addition, it contains, in contrast to the standard document class, the
14504 Furthermore, there are a number of new letter specific types.
14507 \begin_layout Standard
14508 The appearance of the letter produced by this document class can be controlled
14509 by a number of \SpecialChar LaTeX
14510 commands, which you can put in the \SpecialChar LaTeX
14515 \begin_layout Plain Layout
14516 For example, the standard appearance of the letter`s heading, consisting
14517 of name and address, is quite self-willed.
14519 \begin_inset Quotes eld
14523 \begin_inset Quotes erd
14526 heading is produced by the following \SpecialChar LaTeX
14527 commands in the preamble:
14530 \begin_layout LyX-Code
14540 \begin_layout LyX-Code
14556 \begin_layout LyX-Code
14566 \begin_layout LyX-Code
14586 A detailed German description of such \SpecialChar LaTeX
14587 commands can be found in the Koma-Script
14593 With it, the letter's author can produce his personal letter layout.
14596 \begin_layout Standard
14605 define the beginning of the letter and must be used in every letter.
14606 To emphasize them in the \SpecialChar LyX
14607 document class, they are marked with the letter
14617 \begin_inset space ~
14620 in the left margin.
14621 It is possible to write any number of letters in one file.
14626 type produces a new letter using the same addressee and a
14630 type produces a new addressee.
14647 are ordinary paragraph types and can also be used several times in one
14648 and the same letter.
14651 \begin_layout Itemize
14656 : produces a paragraph for the addressee and implicitly defines the beginning
14660 \begin_layout Itemize
14665 : produces a paragraph for the form of address and implicitly produces a
14669 \begin_layout Itemize
14674 : produces a paragraph for a close.
14677 \begin_layout Itemize
14682 : produces a paragraph for a postscript.
14685 \begin_layout Itemize
14690 : produces a paragraph for a distribution list.
14693 \begin_layout Itemize
14698 : produces a paragraph for enclosures.
14701 \begin_layout Standard
14742 are input types provided with a label to enter information, which will
14743 be processed by the document class.
14747 \begin_layout Plain Layout
14748 It could be seen as a matter of inconsequence, that the types
14756 described above are not such input types as well.
14757 Because of the special meaning of those types, however, I have implemented
14758 them as ordinary paragraph types with a one letter mark in the left margin.
14759 Moreover, it would affect my feeling of symmetry, if the
14767 type had such a serious different appearance.
14772 The types must be used ahead of the corresponding
14779 \begin_layout Standard
14780 An implementation of these types in a WYSIWYG fashion does not seem to make
14781 sense, because the real appearance of the produced letter does not only
14782 depend on the usage of the particular type, but also on other factors.
14783 For example, a signature entered in the
14787 type will in the standard behavior appear in the produced letter only,
14788 when in the same letter also a
14793 The entered value of the
14797 type will in the standard behavior not appear in the produced letter at
14799 The possibility to design the letter`s heading freely is already indicated
14800 in a footnote above.
14803 \begin_layout Standard
14804 The input types can also be used as empty paragraphs.
14805 This makes sense e.
14806 \begin_inset space \thinspace{}
14810 \begin_inset space \space{}
14822 type is not used at all, in the standard behavior the value of the
14826 type is used as signature, whereas if an empty
14830 type is used, no signature value is defined.
14833 \begin_layout Standard
14834 By using the input types it is possible to write a letter template, containing
14835 filled input types with your personal dates (name, address, etc.) and empty
14836 input types for other dates you want to enter.
14839 \begin_layout Itemize
14844 : sender's name, in the standard behavior appears as a centered paragraph
14845 in small caps in the letter`s heading.
14848 \begin_layout Itemize
14853 : sender's signature, in the standard behavior appears below the
14862 type is used, the value of the
14866 type appears instead.
14869 \begin_layout Itemize
14874 : sender's address, in the standard behavior appears in a centered paragraph
14875 in the letter`s heading below the sender's name.
14878 \begin_layout Itemize
14883 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
14894 \begin_layout Itemize
14899 : place of the letter`s making.
14902 \begin_layout Itemize
14907 : date of the letter`s making.
14916 , in the standard behavior, produce the place and the date in a right-aligned
14917 line below the addressee's field.
14922 type is used, neither place nor date appear, independent of the value of
14932 type is used, the date of the letter `s production is used.
14935 \begin_layout Itemize
14940 : sender`s back address, in the standard behavior appears above the addressee's
14941 field in a small sans serif font.
14944 \begin_layout Itemize
14949 : special mail information, in the standard behavior appears underlined
14950 above the addressee's field below the back address.
14953 \begin_layout Itemize
14958 : additional information, in the standard behavior appears on right side
14959 below the addressee`s field.
14962 \begin_layout Itemize
14967 : the letter's title, in the standard behavior appears in a big, bold, sans
14968 serif font above the subject.
14971 \begin_layout Itemize
14976 : the letter's subject, in the standard behavior appears in a bold font
14984 \begin_layout Standard
15005 produce a business letter like line above the
15009 line containing the fields
15010 \begin_inset Quotes eld
15014 \begin_inset Quotes erd
15018 \begin_inset Quotes eld
15022 \begin_inset Quotes erd
15026 \begin_inset Quotes eld
15030 \begin_inset Quotes erd
15034 \begin_inset Quotes eld
15038 \begin_inset Quotes erd
15042 \begin_inset Quotes eld
15046 \begin_inset Quotes erd
15050 \begin_inset Quotes eld
15054 \begin_inset Quotes erd
15058 For the date field, the value of the
15064 \begin_inset Quotes eld
15067 business letter types
15068 \begin_inset Quotes erd
15071 is used, the value of the
15075 type however does not appear, but only the \SpecialChar LaTeX
15083 The ordinary output of place and date in a right-aligned line below the
15084 addressee`s field is suppressed.
15085 The types are implemented as input types provided with a label and must
15086 be used ahead of the corresponding
15093 \begin_layout Itemize
15101 \begin_layout Itemize
15109 \begin_layout Itemize
15117 \begin_layout Itemize
15125 \begin_layout Itemize
15133 \begin_layout Subsection
15134 The new letter class: letter (koma-script v.2)
15137 \begin_layout Standard
15140 Jürgen Spitzmüller
15143 \begin_layout Standard
15144 \begin_inset VSpace medskip
15150 \begin_layout Standard
15152 Koma-Script version 2.8 has introduced a new letter class
15156 which supersedes the now unsupported
15161 It has — on the \SpecialChar LaTeX
15162 side — a completely new interface and is not compatible
15163 with the old class.
15164 Therefore, \SpecialChar LyX
15165 supports both, though it is recommended you use the new class.
15168 \begin_layout Standard
15169 This class covers the same functionality as
15171 letter (koma-script),
15174 The basic items are
15178 (receiver's address, same as
15182 in the old layout),
15195 will start a new letter (i.
15196 \begin_inset space \thinspace{}
15200 \begin_inset space \space{}
15203 you can write several letters per document).
15204 New elements are sender's
15220 and the possibility to use a
15226 Insert\SpecialChar menuseparator
15232 \begin_layout Standard
15233 The biggest improvement is, though, that the letter's layout is configurable
15234 to meet almost any needs.
15235 This can be done via the preamble or with a special style file (Letter
15236 Class Option, extension
15240 ), that will be read in as a class option.
15244 \begin_layout Plain Layout
15245 The KOMA package comes with some default
15250 There is, for instance, a
15254 file that follows german typesetting rules, or a
15258 that provides the default layout of the old
15263 The latter can be loaded with the class option
15269 Layout\SpecialChar menuseparator
15270 Document\SpecialChar menuseparator
15282 template that is included in \SpecialChar LyX
15284 A detailed description is to be found in the Koma-Script documentation
15292 \begin_layout Subsection
15296 \begin_layout Standard
15297 Visualizing the Koma-Script document classes in \SpecialChar LyX
15298 , the \SpecialChar LyX
15299 internals cause some
15303 \begin_layout Itemize
15304 The chapter number of a
15308 type appears on a line of its own above the chapter heading instead of
15309 appearing in the same line ahead of it.
15310 The cause for that is the \SpecialChar LyX
15311 internal behavior for the labeltype
15315 in the layout file.
15318 \begin_layout Itemize
15319 The headings of the types
15327 are only put in the
15328 \begin_inset Quotes eld
15332 \begin_inset Quotes erd
15336 table of contents, but not in the \SpecialChar LyX
15337 table of contents (
15339 Document\SpecialChar menuseparator
15341 \begin_inset space ~
15345 \begin_inset space ~
15353 \begin_layout Itemize
15354 The paragraphs in a
15358 document class appear in a skip separation mode, not indented.
15359 This is the standard behavior, no special \SpecialChar LaTeX
15360 commands are needed for that.
15363 Document\SpecialChar menuseparator
15366 dialog the corresponding radio button indicates
15375 value always has the effect that extra \SpecialChar LaTeX
15376 commands are inserted in the document
15377 to produce the gap, which is not what is wanted in this case.
15380 \begin_layout Section
15384 \begin_layout Standard
15387 Jürgen Spitzmüller
15390 \begin_layout Subsection
15394 \begin_layout Standard
15395 Memoir is a very powerful and constantly evolving class.
15396 It has been designed with regard to fictional and non-fictional literature.
15397 Its aim is to let the user have maximum control over the typesetting of
15399 Memoir is based on the standard book class, but it can also emulate the
15400 article class (see below).
15403 \begin_layout Standard
15404 Peter Wilson, the developer of Memoir, is known as the author of lots of
15405 useful packages in the \SpecialChar LaTeX
15407 Most of them have been merged with Memoir.
15408 Therefore, it is much easier to layout the table of contents, appendices,
15409 chapter designs and such.
15411 , though, does not support all of these goodies natively.
15412 Some of them might be added to forthcoming releases
15416 \begin_layout Plain Layout
15417 You are invited to send suggestions to
15418 \begin_inset Flex URL
15421 \begin_layout Plain Layout
15423 lyx-devel@lists.lyx.org
15433 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15435 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15437 commands (\SpecialChar TeX
15442 \begin_layout Plain Layout
15447 \begin_layout Plain Layout
15457 \begin_inset space ~
15461 \begin_inset CommandInset ref
15463 reference "sec:Inserting-TeX-Code"
15473 In this section, we can only list those features that are natively supported
15474 by \SpecialChar LyX
15476 For detailed descriptions (and for the rest of features) we recommend you
15477 have a look at the detailed manual of the Memoir class
15481 \begin_layout Plain Layout
15486 \begin_layout Plain Layout
15496 \begin_inset Flex URL
15499 \begin_layout Plain Layout
15501 CTAN:/macros/latex/memoir/memman.pdf
15511 , which is not only a user guide for the class, but also both a comprehensive
15512 description on good typesetting and a superb example for good typesetting
15516 \begin_layout Subsection
15517 Basic features and restrictions
15520 \begin_layout Standard
15521 Memoir supports basically all features of the standard book classes.
15522 There are, however, some differences, as follows:
15525 \begin_layout Description
15527 \begin_inset space ~
15530 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15533 \begin_layout Description
15535 \begin_inset space ~
15538 style: The fancy page style is not supported, due to a command clash between
15539 Memoir and the fancyhdr package (they both define a command with the same
15540 name, which confuses \SpecialChar LaTeX
15542 Instead, Memoir comes with a number of its own page styles (see
15544 Document\SpecialChar menuseparator
15545 Settings\SpecialChar menuseparator
15547 \begin_inset space ~
15553 If you want to use these for the chapter pages, you have to use the command
15560 in the main text or in preamble (e.
15561 \begin_inset space \thinspace{}
15565 \begin_inset space \space{}
15572 chapterstyle{companion}
15577 \begin_layout Description
15578 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15579 optional argument in the standard classes.
15580 With this, you can specify an alternative version of the title for the
15581 table of contents and the headers (for instance, if the title is too long).
15582 In \SpecialChar LyX
15583 , you can do this via
15585 Insert\SpecialChar menuseparator
15587 \begin_inset space ~
15592 at the beginning of a chapter/section.
15593 Memoir features a second optional argument and thus separates the table
15594 of contents from the header.
15595 You can define three variants of a title with this: one for the main text,
15596 one for the table of contents, and one for the headers.
15598 makes these available in form of specific
15609 \begin_layout Description
15610 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15611 of contents, the list of figures and the list of table start a new page
15613 Memoir does not follow this route.
15614 You have to insert a page break yourself, if you want to have one.
15617 \begin_layout Description
15618 Titlepage: For some unknown reason, Memoir uses pagination on the title
15619 page (in the standard classes, title pages are
15620 \begin_inset Quotes eld
15624 \begin_inset Quotes erd
15628 If you want an empty title page, type
15632 aliaspagestyle{title}{empty}
15637 \begin_layout Description
15638 Article: With the class option
15644 Document\SpecialChar menuseparator
15645 Settings\SpecialChar menuseparator
15646 Class Settings\SpecialChar menuseparator
15648 \begin_inset space ~
15653 ), you can emulate article style.
15654 That is, counters (footnotes, figures, tables etc.) will not be reset on
15655 new chapters, chapters don't start a new page (but are—in contrary to
15656 \begin_inset Quotes eld
15660 \begin_inset Quotes erd
15663 article classes—still allowed), parts, though, use their own page, as in
15667 \begin_layout Description
15668 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15669 font commands, which have been used in the old \SpecialChar LaTeX
15671 \begin_inset space \thinspace{}
15675 \begin_inset space \space{}
15691 It produces an error and stops \SpecialChar LaTeX
15692 whenever such a command appears.
15697 reallows the commands and spits out warnings instead (which does at least
15698 not stop \SpecialChar LaTeX
15700 Since a lot of packages and particularly Bib\SpecialChar TeX
15701 style files are still using
15702 those commands, we have decided to use this option by default.
15705 \begin_layout Subsection
15709 \begin_layout Standard
15710 We will only describe the features supported by \SpecialChar LyX
15711 (which is not much currently).
15712 Please consult the Memoir manual
15716 \begin_layout Plain Layout
15721 \begin_layout Plain Layout
15731 \begin_inset Flex URL
15734 \begin_layout Plain Layout
15736 CTAN:/macros/latex/memoir/memman.pdf
15749 \begin_layout Description
15750 Abstract: You may wonder why an abstract is an extra feature.
15751 Well, it is in book class.
15752 Usually books don't have abstracts.
15753 Memoir, however, has.
15754 You can use it wherever and how often you like.
15757 \begin_layout Description
15758 Chapterprecis: You may know this older typesetting style: The contents of
15759 a chapter are summarized below the title and also in the table of contents
15761 \begin_inset space \thinspace{}
15765 \begin_inset space \space{}
15770 Our hero arrives in Troia; he loses some friends; he finds others
15773 Chapterprecis does exactly this.
15774 It is therefore only sensible below a chapter.
15777 \begin_layout Description
15778 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15779 The epigraph environment provides an elegant way of typesetting such a
15781 The motto itself (text) and its (optional) author (source) are divided
15783 The author (source) can be inserted via
15785 Insert\SpecialChar menuseparator
15792 \begin_layout Description
15793 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15794 complex figurative poems).
15796 can only support a few of them.
15797 One is poemtitle, which is a centered title for poems, which will also
15798 be added to the table of contents (verse is the standard environment for
15800 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
15802 because they have to be nested inside regular verse environments, which
15803 is not possible with \SpecialChar LyX
15807 \begin_layout Description
15808 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15811 \begin_layout Section
15812 Article (mwart), book (mwbk) and report (mwrep)
15813 \begin_inset Argument status
15816 \begin_layout Plain Layout
15829 \begin_layout Standard
15835 \begin_layout Standard
15836 The \SpecialChar LyX
15853 correspond to the \SpecialChar LaTeX
15867 They are replacements for the standard document classes
15879 , resp., and fit better to Polish typography conventions in a number of points.
15883 \begin_layout Standard
15887 \begin_layout Itemize
15888 Unnumbered titles (with star, e.
15889 \begin_inset space \thinspace{}
15893 \begin_inset space \space{}
15900 ) are added into table of contents,
15903 \begin_layout Itemize
15904 Additional page styles:
15908 \begin_layout Description
15909 uheadings header with separated lines,
15912 \begin_layout Description
15913 myheadings custom header, contents headers via commands:
15928 \begin_layout Description
15929 myuheadings custom header with separated lines,
15932 \begin_layout Description
15933 outer page number is placed on outer side of page
15937 \begin_layout Itemize
15942 \begin_layout Description
15943 rmheadings serif titles — default,
15946 \begin_layout Description
15947 sfheadings sansserif titles,
15950 \begin_layout Description
15951 authortitle on title page first placed is author next title — default,
15954 \begin_layout Description
15955 titleauthor on title page first placed is title next author,
15958 \begin_layout Description
15959 withmarginpar reserve place on page for margins.
15963 \begin_layout Section
15967 \begin_layout Standard
15972 provides an alternative to the standard
15977 It provides similar functionality, but you might prefer this layout with
15978 sans serif sections, headings, and more.
15981 \begin_layout Section
15982 Rev\SpecialChar TeX
15986 \begin_layout Standard
15992 \begin_layout Standard
15993 \begin_inset VSpace bigskip
15999 \begin_layout Standard
16004 \begin_inset space ~
16009 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16011 \begin_inset Formula $\beta$
16014 release of May, 1999) class.
16017 \begin_layout Standard
16023 textclass, which works with Rev\SpecialChar TeX
16025 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16027 That means that it doesn't interact very well with \SpecialChar LyX
16028 , which requires \SpecialChar LaTeX2e
16030 it has been kludged to work.
16031 Since Rev\SpecialChar TeX
16032 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16037 Rev\SpecialChar TeX
16039 \begin_inset space ~
16044 textclass should also be pretty easy to use.
16047 \begin_layout Standard
16048 These documents are supposed to be used in
16052 to the Rev\SpecialChar TeX
16053 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16055 and assume you'll know what to put in the preamble if necessary.
16058 \begin_layout Subsection
16062 \begin_layout Standard
16063 All you need to do is install Rev\SpecialChar TeX
16064 4, as described in the package's README
16066 The package can be found at The Rev\SpecialChar TeX
16068 \begin_inset Flex URL
16071 \begin_layout Plain Layout
16073 http://publish.aps.org/revtex4/
16079 Install it somewhere that \SpecialChar LaTeX
16081 Test it by trying to \SpecialChar LaTeX
16082 a short Rev\SpecialChar TeX
16083 4 document in some random directory (i.
16084 \begin_inset space \thinspace{}
16088 \begin_inset space \space{}
16091 not the directory where you installed the class file.) Then, if you reconfigure
16093 , it will find the class file and let you use the Rev\SpecialChar TeX
16097 \begin_layout Standard
16098 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16107 \begin_inset space ~
16112 template, found in the templates directory.
16115 \begin_layout Subsection
16119 \begin_layout Standard
16120 Optional arguments to
16127 \begin_inset Quotes eld
16131 \begin_inset Quotes erd
16135 \begin_inset Quotes eld
16139 \begin_inset Quotes erd
16145 \begin_inset space ~
16153 \begin_inset space ~
16159 Remember that in Rev\SpecialChar TeX
16160 , at least one optional argument is required!
16163 \begin_layout Standard
16164 Other preamble matter, like
16171 \begin_inset space ~
16178 \begin_inset space ~
16183 dialog, also as usual.
16186 \begin_layout Subsection
16190 \begin_layout Standard
16191 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16193 For example, the Email layout corresponds to
16200 Note that (at least as of Rev\SpecialChar TeX
16209 layouts are exactly equivalent, so you shouldn't need to use both.
16213 \begin_layout Plain Layout
16214 In case you're curious, both were included so that
16218 would be able to translate both
16238 \begin_layout Subsection
16242 \begin_layout Standard
16243 There are a couple of important unique aspects of Rev\SpecialChar TeX
16244 4 which might cause
16245 bugs that will be even more confusing in \SpecialChar LyX
16249 \begin_layout Standard
16250 In Rev\SpecialChar TeX
16268 The \SpecialChar LyX
16269 equivalent is that there is a separate Thanks layout.
16274 write footnotes in the
16278 layout, or weird things may happen.
16279 See the Rev\SpecialChar TeX
16280 4 documentation for more details.
16283 \begin_layout Standard
16287 \begin_inset space ~
16295 \begin_inset space ~
16304 layouts must be placed
16312 layout and the corresponding
16329 , the \SpecialChar LaTeX
16333 \begin_layout Section
16334 Springer Journals (
16341 \begin_layout Standard
16347 \begin_layout Subsection
16351 \begin_layout Standard
16352 These are the layout files for some of the journal formats used by Springer
16353 Verlag and listed on
16354 \begin_inset Flex URL
16357 \begin_layout Plain Layout
16359 http://www.springer.de/author/tex/help-journals.html
16364 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16366 It is a modular system: the things common to all journals are implemented
16371 , which journal-specific layout files (such as, e.
16372 \begin_inset space \thinspace{}
16376 \begin_inset space \space{}
16383 for Journal of Geodesy) can include.
16386 \begin_layout Standard
16387 This means that implementing support for any other Springer journal on this
16388 list is as simple as writing your own
16396 file following the outline given in
16404 \begin_layout Standard
16405 It is reasonably well tested only for the Journal of Geodesy.
16414 come with the standard \SpecialChar LyX
16416 Install the relevant class file (downloaded from Springer) in a proper
16417 directory, reconfigure \SpecialChar LaTeX
16418 (in the te\SpecialChar TeX
16423 , as root if necessary — doesn't \SpecialChar LyX
16424 take care of this?), reconfigure \SpecialChar LyX
16429 \begin_layout Subsection
16433 \begin_layout Standard
16434 A large number of theorem-like styles —
16446 \begin_layout Standard
16449 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16450 _Title, Author_Running, Institute,
16451 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16454 See the Springer class file documentation for details.
16457 \begin_layout Subsection
16461 \begin_layout Itemize
16473 \begin_layout Itemize
16476 Probability Theory and Related Fields
16482 — Jean-Marc Lasgouttes
16485 \begin_layout Standard
16486 Add your own, it isn't so hard!
16489 \begin_layout Subsection
16493 \begin_layout Standard
16494 These files are partly based on the older
16498 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16500 file from Springer.
16505 layout, are now defunct.
16506 Jean-Marc Lasgouttes helped out big in making me find my way around the
16508 layout file mechanism.
16511 \begin_layout Subsection
16515 \begin_layout Standard
16517 But probably less than in the old hacked-\SpecialChar LaTeX
16525 \begin_layout Section
16528 Sli\SpecialChar TeX
16532 \begin_inset CommandInset label
16541 \begin_layout Standard
16549 \begin_layout Subsection
16553 \begin_layout Standard
16554 This section describes how to use \SpecialChar LyX
16555 to make slides for overhead projectors.
16556 There are two document classes that can do this: the default slides class
16559 Foil\SpecialChar TeX
16563 This section documents the former.
16566 \begin_layout Standard
16567 I'm going to say this again, nice and clear, so that there's no misunderstanding
16571 \begin_layout Standard
16572 \begin_inset VSpace bigskip
16578 \begin_layout Standard
16582 This section documents the class
16583 \begin_inset Quotes eld
16591 \begin_inset Quotes erd
16599 \begin_layout Standard
16600 \begin_inset VSpace bigskip
16606 \begin_layout Standard
16607 If you're looking for the documentation for
16608 \begin_inset Quotes eld
16613 slides (Foil\SpecialChar TeX
16617 \begin_inset Quotes erd
16620 , check out section
16621 \begin_inset space ~
16625 \begin_inset CommandInset ref
16627 reference "sec:foiltex"
16637 \begin_inset Quotes eld
16642 slides (Foil\SpecialChar TeX
16646 \begin_inset Quotes erd
16649 ] is actually somewhat better than the default
16657 \begin_layout Plain Layout
16659 or so I've been told repeatedly by its advocates.
16660 Having never used it, I have no idea if this claim is true or not.
16665 which this section documents.
16668 \begin_layout Standard
16669 This class is the \SpecialChar LaTeX2e
16670 improvement of the old
16672 Sli\SpecialChar TeX
16676 Every \SpecialChar LaTeX2e
16677 distribution includes this class [which I'll just refer to as
16678 \begin_inset Quotes eld
16686 \begin_inset Quotes erd
16689 from now on], so you're bound to have it.
16690 As I noted earlier, there are other classes, such as
16694 , which also produce slides for overhead projectors and do a better job
16696 However, there are some things which
16700 can do which the others can't, such as generate overlays.
16701 Read on to learn more!
16704 \begin_layout Subsection
16706 \begin_inset CommandInset label
16708 name "sec:slidesetup"
16715 \begin_layout Standard
16716 Obviously, to use this document class, you need to select
16717 \begin_inset Quotes eld
16725 \begin_inset Quotes erd
16728 from the class list in the
16730 Document\SpecialChar menuseparator
16734 There are some other special things you should know about this class:
16737 \begin_layout Itemize
16738 Don't bother changing the options
16743 They're not supported by the
16750 \begin_layout Itemize
16754 \begin_inset space ~
16759 behaves a bit differently for this class.
16760 The possible choices and what they do are as follows:
16764 \begin_layout Description
16769 The final output contains page numbers in the lower right corner.
16772 \begin_layout Description
16781 , but also prints out any time markers you've put in.
16782 This is the default.
16785 \begin_layout Description
16790 The final output contains no page numbers, time markers, or alignment markers.
16794 \begin_layout Itemize
16799 class has an extra option:
16805 \begin_inset Quotes eld
16813 \begin_inset Quotes erd
16816 in the extra class options.
16820 \begin_layout Standard
16821 Using this options allows you to add time markers to
16827 \begin_inset space ~
16831 \begin_inset CommandInset ref
16833 reference "sec:slideNote"
16841 \begin_layout Standard
16842 You can also use the template file
16843 \begin_inset Quotes eld
16851 \begin_inset Quotes erd
16854 to automatically set up a document to use the
16860 File\SpecialChar menuseparator
16862 \begin_inset space ~
16866 \begin_inset space ~
16871 to open your new document].
16872 The template file also contains some examples of the special paragraph
16873 environments used by this class.
16874 I'll describe those next.
16877 \begin_layout Subsection
16878 Paragraph Environments
16881 \begin_layout Subsubsection
16882 Supported Environments
16885 \begin_layout Standard
16886 The first thing you'll notice when you start up a new
16890 document is the font size and type: it's the equivalent of the size
16891 \begin_inset Quotes eld
16899 \begin_inset Quotes erd
16905 \begin_inset space ~
16911 This is also what's used in the output.
16913 \begin_inset Quotes eld
16917 \begin_inset Quotes erd
16920 to remind you that this is a slide.
16921 Your final slides will use a larger font; ergo, you'll have less space.
16922 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
16925 \begin_layout Standard
16926 The next thing that becomes obvious is the changes to the paragraph environment
16927 pull-down box [at the far-left end of the toolbar].
16928 Most of the paragraph environments you're used to seeing are missing.
16929 There are also five new ones.
16934 class itself only supports certain paragraph environments:
16937 \begin_layout Itemize
16943 \begin_layout Itemize
16949 \begin_layout Itemize
16955 \begin_layout Itemize
16961 \begin_layout Itemize
16967 \begin_layout Itemize
16973 \begin_layout Itemize
16979 \begin_layout Itemize
16985 \begin_layout Itemize
16991 \begin_layout Itemize
16998 \begin_layout Standard
16999 All of the other standard environments, including the section-heading environmen
17000 ts, aren't used in the
17007 \begin_layout Standard
17008 On the other hand, you'll notice the following new environments:
17011 \begin_layout Itemize
17017 \begin_layout Itemize
17023 \begin_layout Itemize
17029 \begin_layout Itemize
17035 \begin_layout Itemize
17041 \begin_layout Standard
17042 These five are kind of quirky, due to a
17043 \begin_inset Quotes eld
17047 \begin_inset Quotes erd
17050 in \SpecialChar LyX
17052 You see, \SpecialChar LyX
17053 doesn't permit you to nest any other paragraph environment into
17054 an empty environment.
17055 Now, that's fine and dandy, but it means that you wouldn't be able to start
17056 a slide with anything except plain text.
17057 To deal with this, I've performed a little
17058 \begin_inset Quotes eld
17063 \begin_inset Quotes erd
17069 \begin_layout Subsubsection
17070 Quirks of the New Environments
17071 \begin_inset CommandInset label
17073 name "sec:slideQuirk"
17080 \begin_layout Standard
17081 All five of the new paragraph environments are somewhat quirky due to inherent
17082 limitiations in the current version of \SpecialChar LyX
17084 As I just mentioned, \SpecialChar LyX
17085 forbids environments that begin with another environment.
17086 To get around this, the
17090 environment isn't a paragraph environment as described in the
17098 \begin_layout Standard
17099 You should consider
17112 \begin_inset Quotes eld
17115 pseudo-environments.
17116 \begin_inset Quotes erd
17119 They look like a section heading or a
17120 \begin_inset Quotes eld
17128 \begin_inset Quotes erd
17131 but really begin a [and, if necessary, end the previous] paragraph environment.
17141 \begin_inset Quotes eld
17145 \begin_inset Quotes erd
17148 These two perform some action.
17151 \begin_layout Standard
17152 A common feature of all five environments,
17172 , is a rather long-ish label.
17173 The text following this label — ordinarily the contents of the paragraph
17174 environment — is utterly irrelevant for
17196 completely ignores it.
17197 In fact, you can leave these five environments completely empty.
17201 \begin_layout Standard
17206 to put any text after the rather long-ish label, you might want to.
17207 This could be a short description of the contents of the
17212 In that case, enter your descriptive comment and hit
17216 as you normally would.
17219 \begin_layout Standard
17220 If, on the other hand, you don't want to enter any descriptive text, you'll
17221 hit another \SpecialChar LyX
17224 , like nature, abhors a vacuum, and will not let you start a new paragraph
17225 environment until you put something in the old one.
17229 \begin_layout Itemize
17230 Start entering the text that will
17258 \begin_layout Itemize
17259 Now move to the beginning of that paragraph.
17263 \begin_layout Itemize
17272 \begin_layout Itemize
17273 Finally, change this new, empty paragraph to a
17297 \begin_layout Standard
17298 Some future version of \SpecialChar LyX
17299 will, hopefully, resolve this quirkiness\SpecialChar ldots
17303 \begin_layout Subsection
17304 Making a Presentation with
17317 \begin_layout Subsubsection
17325 \begin_layout Standard
17326 If you're expecting this section to teach you how to actually make a presentatio
17327 n, you'll be sorely disappointed.
17328 Naturally, I'll describe all of the ways the
17332 class can assist you in preparing the materials for a presentation.
17333 Filling in the contents, however, is up to you.
17338 the \SpecialChar LyX
17342 \begin_layout Standard
17347 environment [in the manner described in section
17348 \begin_inset space ~
17352 \begin_inset CommandInset ref
17354 reference "sec:slideQuirk"
17358 ] tells \SpecialChar LyX
17359 to begin a new slide [duh].
17360 The label for this environment/
17361 \begin_inset Quotes erd
17365 \begin_inset Quotes erd
17369 \begin_inset Quotes eld
17373 \begin_inset Quotes erd
17376 in cool blue, followed by the label,
17377 \begin_inset Quotes eld
17381 \begin_inset Quotes erd
17385 Any text or paragraph environments that follow this one go on the new slide.
17389 \begin_layout Standard
17390 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17392 (this can be specified in the
17397 In fact, you'll want to, once you finish entering the contents of one slide.
17398 If you've entered more text than can physically fit on a slide, the extra
17399 overflows onto a new slide.
17400 I don't recommend doing this, however, since the overflow slide won't have
17401 any page number on it.
17402 Furthermore, it may interfere with any
17406 you've made to accompany the oversized
17413 \begin_layout Standard
17422 environments work the same way as the
17427 They both create an
17428 \begin_inset Quotes eld
17432 \begin_inset Quotes erd
17435 followed by a label [
17436 \begin_inset Quotes eld
17440 \begin_inset Quotes erd
17444 \begin_inset Quotes eld
17448 \begin_inset Quotes erd
17452 The color is a stunning magenta instead of blue, and the
17453 \begin_inset Quotes eld
17457 \begin_inset Quotes erd
17460 will look different, in style and in length.
17461 The label fonts of all three also differ from one another.
17464 \begin_layout Standard
17469 , if the contents of a
17477 exceed the physical size of a slide or sheet of paper, the extra will overflow
17479 Again, you should avoid this.
17480 It defeats the whole purpose of
17491 \begin_layout Subsubsection
17501 \begin_layout Standard
17506 is a slide that sits atop another slide.
17507 Perhaps you wish to discuss a figure on the main
17511 before displaying the text associated with it.
17512 One way to accomplish this is tape a flap of dark paper over the part of
17517 you want to display later.
17518 This method fails, however, if you wish to overlap one graph with another,
17520 You would then have to fumble while speaking to align the two separate,
17525 s to align the two graphs.
17530 environment in both cases makes life much easier.
17533 \begin_layout Standard
17538 receives the page number of its
17539 \begin_inset Quotes eld
17543 \begin_inset Quotes erd
17551 \begin_inset Quotes eld
17559 \begin_inset Quotes erd
17566 \begin_layout Plain Layout
17567 Presumably, mutliple
17572 \begin_inset Quotes eld
17580 \begin_inset Quotes erd
17584 \begin_inset Quotes eld
17592 \begin_inset Quotes erd
17596 \begin_inset Quotes eld
17604 \begin_inset Quotes erd
17608 \begin_inset space ~
17611 appended to the page number of the parent
17621 Clearly, you want the contents of both the
17629 to each fit on a single physical slide! You should probably consider an
17635 \begin_inset Quotes eld
17639 \begin_inset Quotes erd
17647 Indeed, the \SpecialChar LyX
17652 class provides a visual cue for this: the label at the start of an
17656 is shorter than that at the start of a
17661 Lastly, when you generate printable output, you'll find alignment markers
17662 in all four corners of both the
17666 page and its parent
17671 These will assist you in lining up the two physical slides.
17674 \begin_layout Standard
17675 The major problem in overlaying two slides is aligning the contents of the
17676 two transparencies.
17677 How much space should you leave for that graph on the second slide? Worse
17678 still, what if you want a graph and a sentence on second slide, but there
17679 is text on the main transparency that goes in between them? You could try
17680 and insert vertical space of the right size.
17681 The better way is to use
17692 \begin_layout Standard
17693 As their names imply,
17701 are two command-like paragraph environments that make all subsequent text
17702 invisible and visible, respectively.
17704 \begin_inset space ~
17708 \begin_inset CommandInset ref
17710 reference "sec:slideQuirk"
17714 that you don't place anything
17718 these two environments, however.
17723 , it inserts a centered, sky-blue label into the page reading
17724 \begin_inset Quotes eld
17727 <Invisible Text Follows>
17728 \begin_inset Quotes erd
17732 For paragraphs following this label, the parts of the
17740 ; it doesn't matter which] where they would be contain instead blank space.
17744 \begin_layout Standard
17749 , the corresponding centered label is
17750 \begin_inset Quotes eld
17753 <Visible Text Follows>
17754 \begin_inset Quotes erd
17758 Paragraphs following this label behave normally.
17759 Note that the beginning of a new
17771 automatically shuts off an
17776 It's therefore not necessary to use
17787 \begin_layout Standard
17788 By now, it should be obvious how to create overlay transparencies using
17789 the proper combination of
17808 \begin_layout Enumerate
17813 , including everything that will appear on it, whether on the main slide
17821 \begin_layout Enumerate
17822 Before each figure or paragraph that will appear only on the
17831 If necessary, insert a
17835 environment after the
17842 \begin_layout Enumerate
17847 immediately following the
17854 \begin_layout Enumerate
17855 Copy the contents of this
17866 \begin_layout Enumerate
17871 , change all of the
17882 \begin_layout Standard
17884 You've just made an
17891 \begin_layout Standard
17892 There's one problem with the way I've designed the \SpecialChar LyX
17897 class: you can't make text in the middle of a paragraph invisible, nor
17898 make text in the middle of an invisible paragraph visible again.
17899 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
17904 \begin_layout Plain Layout
17905 The commands of interest are:
17908 \begin_layout Itemize
17913 invisible \SpecialChar ldots
17917 \begin_layout Itemize
17922 visible \SpecialChar ldots
17926 \begin_layout Plain Layout
17928 and need to be marked as \SpecialChar TeX
17931 \begin_inset Quotes eld
17935 \begin_inset Quotes erd
17938 you wish to change goes in between the brackets [and after the
17951 If you don't know how to mark text as \SpecialChar TeX
17952 , see the appropriate section of
17965 \begin_layout Subsubsection
17975 \begin_inset CommandInset label
17977 name "sec:slideNote"
17984 \begin_layout Standard
17993 is associated with a
17994 \begin_inset Quotes eld
17998 \begin_inset Quotes erd
18006 Here, too, the \SpecialChar LyX
18011 class provides visual cues.
18016 is shorter than that of a
18020 [yet longer than that of an
18024 ] and, like the label of an
18028 is shockingly magenta.
18029 Additionally, the printed
18033 has the page number of its
18034 \begin_inset Quotes eld
18038 \begin_inset Quotes erd
18046 \begin_inset Quotes eld
18054 \begin_inset Quotes erd
18058 \begin_inset Quotes eld
18066 \begin_inset Quotes erd
18070 \begin_inset Quotes eld
18078 \begin_inset Quotes erd
18082 You can have multiple
18086 s associated with a single
18098 , you'll probably want to break up long
18102 s so that they fit on a single sheet of paper.
18105 \begin_layout Standard
18110 is obvious: it contains anything additional you might want to say about
18116 It could also be used as a sheet of reminders for a particular
18121 In the case of the latter, you might want to make use of time markers.
18122 Currently, the \SpecialChar LyX
18128 \begin_inset Quotes eld
18132 \begin_inset Quotes erd
18135 support for time markers, a
18137 Sli\SpecialChar TeX
18141 So, you'll have to resort to using the \SpecialChar LaTeX
18145 \begin_layout Standard
18146 To use time markers, you'll need to specify the extra class option
18147 \begin_inset Quotes eld
18155 \begin_inset Quotes erd
18159 \begin_inset space ~
18163 \begin_inset CommandInset ref
18165 reference "sec:slidesetup"
18170 This option turns on timing marks, which will appear in the lower-left-hand
18176 To set what appears in the time marker, you use the \SpecialChar LaTeX
18178 \begin_inset Quotes eld
18188 \begin_inset Quotes erd
18192 \begin_inset Quotes eld
18202 \begin_inset Quotes erd
18206 The arguments of both commands are time measured in seconds.
18208 \begin_inset Quotes eld
18218 \begin_inset Quotes erd
18221 sets the time marker to a given time.
18223 \begin_inset Quotes eld
18233 \begin_inset Quotes erd
18236 increments the time marker by the specified amount.
18237 Using time markers and
18241 s in this fashion, you can remind yourself how much time to spend on a particula
18249 \begin_layout Standard
18250 There's one last feature to describe.
18251 Clearly, you'd like to print out all of your
18259 s on transparencies while printing all of your
18276 with which it is associated.
18277 What's a person to do?
18280 \begin_layout Standard
18281 Luckily, there are two \SpecialChar LaTeX
18282 commands that allow you to select what to print
18284 Both must be placed into the preamble of your document.
18286 \begin_inset Quotes eld
18298 \begin_inset Quotes erd
18301 will cause the output to contain only the
18310 Correspondingly, the command
18311 \begin_inset Quotes eld
18323 \begin_inset Quotes erd
18326 prevents the output of anything but
18331 I'd advise placing both commands in the preamble and initially comment
18333 You can then preview your entire presentation as you write.
18334 When you're done writing, you can then uncomment one of the two to select
18335 what you want to print.
18336 I like to uncomment
18337 \begin_inset Quotes eld
18349 \begin_inset Quotes erd
18352 , print to a file with
18353 \begin_inset Quotes eld
18361 \begin_inset Quotes erd
18364 in its name, comment it back out, then uncomment
18365 \begin_inset Quotes eld
18377 \begin_inset Quotes erd
18381 \begin_inset Quotes eld
18389 \begin_inset Quotes erd
18393 I can then send either file to a printer, loading transparencies or plain
18394 paper as appropriate.
18397 \begin_layout Standard
18398 You can also provide other arguments to the
18399 \begin_inset Quotes eld
18409 \begin_inset Quotes erd
18413 \begin_inset Quotes eld
18423 \begin_inset Quotes erd
18427 See a good \SpecialChar LaTeX
18431 \begin_layout Subsection
18436 Class Template File
18439 \begin_layout Standard
18440 I have also provided a template file,
18441 \begin_inset Quotes eld
18449 \begin_inset Quotes erd
18457 To use it, begin your new presentation with
18459 File\SpecialChar menuseparator
18461 \begin_inset space ~
18465 \begin_inset space ~
18471 Your new \SpecialChar LyX
18472 presentation file will contain an example
18493 additionally contain an example of the use of
18502 Lastly, the preamble will contain:
18505 \begin_layout LyX-Code
18506 % Uncomment to print out only slides and overlays
18509 \begin_layout LyX-Code
18513 \begin_layout LyX-Code
18519 \begin_inset Newline newline
18525 \begin_layout LyX-Code
18526 % Uncomment to print out only notes
18529 \begin_layout LyX-Code
18533 \begin_layout LyX-Code
18541 \begin_layout Standard
18542 One final thing: I created this class to support the \SpecialChar LaTeX2e
18544 \begin_inset Quotes eld
18549 Sli\SpecialChar TeX
18553 \begin_inset Quotes erd
18556 class, one of the built-in \SpecialChar LaTeX2e
18558 Neither I nor the rest of the \SpecialChar LyX
18559 Team endorse or oppose the use of this built-in
18561 It's here if you want it or need it.
18562 There exist other \SpecialChar LaTeX2e
18563 classes for creating presentations, such as the
18568 \begin_inset space ~
18572 \begin_inset CommandInset ref
18574 reference "sec:foiltex"
18579 \begin_inset Quotes eld
18587 \begin_inset Quotes erd
18590 package [present on some \SpecialChar TeX
18592 The latter is not yet supported under \SpecialChar LyX
18597 \begin_layout Plain Layout
18598 Perhaps you can take on the task\SpecialChar ldots
18604 I know nothing about these other classes.
18605 Try them out to see what sort of alternative they provide.
18608 \begin_layout Chapter
18610 Features needing Extra Software
18613 \begin_layout Section
18614 Checking \SpecialChar TeX
18618 \begin_layout Standard
18624 \begin_layout Subsection
18628 \begin_layout Standard
18637 \begin_layout Plain Layout
18642 is not yet available when you are using the \SpecialChar LaTeX
18643 distribution MiK\SpecialChar TeX
18649 , you'll find in the
18656 \begin_inset space ~
18667 \begin_inset Newline newline
18671 \begin_inset CommandInset href
18673 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18681 \begin_layout Standard
18684 Chk\SpecialChar TeX
18687 package is a program that was written by
18688 \begin_inset Flex Noun
18691 \begin_layout Plain Layout
18693 \begin_inset space ~
18701 in frustration because some constructs in \SpecialChar LaTeX
18702 are sometimes non-intuitive,
18703 and easy to forget.
18704 The program runs over your \SpecialChar LaTeX
18705 file, checks the integrity of the file, and
18706 flags some common errors.
18707 In other technical words, it is
18711 for \SpecialChar LaTeX
18715 \begin_layout Standard
18716 Well, what is a syntax checker doing in \SpecialChar LyX
18717 which is supposed to produce correct
18719 anyways? The answer is simple: Just as
18723 not only checks the
18727 of C programs, but also does
18731 checks for type-errors,
18733 Chk\SpecialChar TeX
18736 catches some common
18740 errors, in addition to the syntactical ones.
18743 Chk\SpecialChar TeX
18746 is capable of detecting several common errors, such as
18749 \begin_layout Itemize
18750 Ellipsis detection:
18751 \begin_inset Newline newline
18754 Use \SpecialChar ldots
18758 \begin_layout Itemize
18759 No space in front of/after parenthesis:
18760 \begin_inset Newline newline
18766 \begin_layout Itemize
18767 Enforcement of normal space after common abbreviations:
18768 \begin_inset Newline newline
18772 \begin_inset space \thinspace{}
18776 \begin_inset space \space{}
18779 is too wide spacing.
18782 \begin_layout Itemize
18783 Enforcement of end-of-sentence space when the last sentence ends with a
18785 \begin_inset Newline newline
18789 And this is wrong spacing.
18792 \begin_layout Itemize
18793 Space in front of labels and similar commands:
18794 \begin_inset Newline newline
18797 The label should stick right up to the text to avoid falling to a wrong
18800 \begin_inset CommandInset label
18810 \begin_layout Plain Layout
18811 This footnote is in danger of falling off to a wrong page
18816 The label is separated too much.
18819 \begin_layout Itemize
18820 Space in front of references, instead of hard spaces:
18821 \begin_inset Newline newline
18824 If you have bad luck, the text will break right between the referenced text
18825 and reference number, and that's a pity.
18827 \begin_inset CommandInset ref
18829 reference "sec:chktex"
18836 \begin_layout Itemize
18838 \begin_inset Quotes eld
18842 \begin_inset Quotes erd
18846 \begin_inset Formula $\times$
18850 \begin_inset Newline newline
18853 2x2 looks cheap compared to
18854 \begin_inset Formula $2\times2$
18860 \begin_layout Standard
18861 and more \SpecialChar ldots
18862 It is an invaluable tool when you are
18863 \begin_inset Quotes eld
18867 \begin_inset Quotes erd
18870 your document before printing, and you should run it right after the obligatory
18871 spelling check, and before you go fine tuning the typesetting.
18874 \begin_layout Subsection
18878 \begin_layout Standard
18879 If you have the program installed, usage is as simple as choosing
18881 Tools\SpecialChar menuseparator
18883 \begin_inset space ~
18889 This will make \SpecialChar LyX
18890 generate a \SpecialChar LaTeX
18891 file of your document, start
18893 Chk\SpecialChar TeX
18896 to check it, and then make \SpecialChar LyX
18898 \begin_inset Quotes eld
18902 \begin_inset Quotes erd
18905 with the warnings from
18907 Chk\SpecialChar TeX
18910 , if there were any.
18911 The warnings will be placed close to the point of the mistake, and you
18912 can quickly find them by using the
18914 Navigate\SpecialChar menuseparator
18917 menu item, or the shortcut key
18926 Open the error boxes by clicking on them with the mouse, or use the shortcut
18935 bindings, or the corresponding
18944 Read the warning and correct the mistake, if it is a mistake.
18945 If you have trouble understanding what the warning is about, you can safely
18947 Remember that there is a hidden layer between the document on screen and
18948 the technical details in invoking
18950 Chk\SpecialChar TeX
18953 , and this gap can make some warnings seem arcane or just plain silly.
18956 \begin_layout Standard
18957 This document is an excellent testing bed for the feature, and it should
18958 provide quite a few warnings for you to fiddle with.
18959 Since computers are only so smart, expect most of the warnings to be false
18963 \begin_layout Subsection
18964 How to fine tune it
18967 \begin_layout Standard
18968 Sometimes, you'll find that
18970 Chk\SpecialChar TeX
18973 makes more noise than suits your mood.
18974 Then you can choose not to use it, wait until your mood changes, or try
18977 Chk\SpecialChar TeX
18980 to get better along with you.
18983 \begin_layout Standard
18986 Chk\SpecialChar TeX
18993 very configurable and extensible, you should not expect to solve all problems
18996 Chk\SpecialChar TeX
18999 in \SpecialChar LyX
19001 Since \SpecialChar LyX
19002 has to generate a somewhat special \SpecialChar LaTeX
19003 file to be able to match the
19004 line numbers from the
19006 Chk\SpecialChar TeX
19013 \begin_layout Plain Layout
19014 You can inspect the specific output from
19020 Document\SpecialChar menuseparator
19023 \begin_inset space ~
19037 to the internal document structure, some of the warnings will not appear
19039 There are two things you can do about this:
19042 \begin_layout Itemize
19045 Chk\SpecialChar TeX
19048 invocation command line in
19049 \begin_inset Flex Noun
19052 \begin_layout Plain Layout
19053 Tools\SpecialChar menuseparator
19054 Preferences\SpecialChar menuseparator
19055 Output\SpecialChar menuseparator
19056 LaTeX\SpecialChar menuseparator
19064 Chk\SpecialChar TeX
19067 installation configuration file (usually with the file
19072 See below to learn what warnings can be enabled and disabled on the command
19076 \begin_layout Itemize
19077 Export your document as a raw \SpecialChar LaTeX
19080 File\SpecialChar menuseparator
19081 Export\SpecialChar menuseparator
19090 Invoked in this way, it can be a hassle to find the corresponding place
19091 in the document inside \SpecialChar LyX
19092 , but with a little patience, you should be able
19096 \begin_layout Standard
19097 Here follows the warning messages that can be enabled and disabled in
19106 to disable a warning, and
19110 to enable a warning.
19111 The emphasized entries are disabled by default, because the default is
19114 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19119 \begin_layout Standard
19120 Notice that you should only use the options that enable and disable warnings,
19121 because \SpecialChar LyX
19122 relies on some of the other command line parameters to be set
19123 in a specific way to have a chance to communicate with
19130 \begin_layout Enumerate
19134 Command terminated with space.
19137 \begin_layout Enumerate
19140 Non-breaking space (
19141 \begin_inset Quotes eld
19149 \begin_inset Quotes erd
19152 ) should have been used.
19155 \begin_layout Enumerate
19159 You should enclose the previous parenthesis with
19160 \begin_inset Quotes eld
19168 \begin_inset Quotes erd
19174 \begin_layout Enumerate
19177 Italic correction (
19178 \begin_inset Quotes eld
19188 \begin_inset Quotes erd
19191 ) found in non-italic buffer.
19194 \begin_layout Enumerate
19197 Italic correction (
19198 \begin_inset Quotes eld
19208 \begin_inset Quotes erd
19211 ) found more than once.
19214 \begin_layout Enumerate
19218 No italic correction (
19219 \begin_inset Quotes eld
19229 \begin_inset Quotes erd
19235 \begin_layout Enumerate
19239 \begin_inset Quotes eld
19247 \begin_inset Quotes erd
19251 \begin_inset Quotes eld
19259 \begin_inset Quotes erd
19265 \begin_layout Enumerate
19268 Wrong length of dash may have been used.
19271 \begin_layout Enumerate
19275 \begin_inset Quotes eld
19283 \begin_inset Quotes erd
19287 \begin_inset Quotes eld
19295 \begin_inset Quotes erd
19301 \begin_layout Enumerate
19305 \begin_inset Quotes eld
19313 \begin_inset Quotes erd
19319 \begin_layout Enumerate
19323 \begin_inset Quotes eld
19331 \begin_inset Quotes erd
19334 to achieve an ellipsis.
19337 \begin_layout Enumerate
19340 Inter-word spacing (
19341 \begin_inset Quotes eld
19351 \begin_inset Quotes eld
19354 ) should perhaps be used.
19357 \begin_layout Enumerate
19360 Inter-sentence spacing (
19361 \begin_inset Quotes eld
19371 \begin_inset Quotes erd
19374 ) should perhaps be used.
19377 \begin_layout Enumerate
19380 Could not find argument for command.
19383 \begin_layout Enumerate
19387 \begin_inset Quotes eld
19395 \begin_inset Quotes erd
19401 \begin_layout Enumerate
19404 Math mode still on at end of \SpecialChar LaTeX
19408 \begin_layout Enumerate
19412 \begin_inset Quotes eld
19420 \begin_inset Quotes erd
19423 doesn't match the number of
19424 \begin_inset Quotes eld
19432 \begin_inset Quotes erd
19438 \begin_layout Enumerate
19441 You should use either
19444 \begin_inset Quotes eld
19452 \begin_inset Quotes erd
19457 as an alternative to
19458 \begin_inset Quotes eld
19466 \begin_inset Quotes erd
19472 \begin_layout Enumerate
19479 " (ASCII 39) instead of "
19486 \begin_layout Enumerate
19489 User-specified pattern found.
19492 \begin_layout Enumerate
19495 This command might not be intended.
19498 \begin_layout Enumerate
19505 \begin_layout Enumerate
19523 \begin_layout Enumerate
19526 Delete this space to maintain correct page references.
19529 \begin_layout Enumerate
19533 You might wish to put this between a pair of
19534 \begin_inset Quotes eld
19542 \begin_inset Quotes erd
19548 \begin_layout Enumerate
19551 You ought to remove spaces in front of punctuation.
19554 \begin_layout Enumerate
19557 Could not execute \SpecialChar LaTeX
19561 \begin_layout Enumerate
19570 in front of small punctuation.
19573 \begin_layout Enumerate
19581 may look prettier here.
19584 \begin_layout Enumerate
19588 Multiple spaces detected in output.
19591 \begin_layout Enumerate
19594 This text may be ignored.
19597 \begin_layout Enumerate
19603 \begin_inset Quotes eld
19608 to begin quotation, not
19615 \begin_layout Enumerate
19622 to end quotation, not
19625 \begin_inset Quotes eld
19633 \begin_layout Enumerate
19639 \begin_layout Enumerate
19642 You should perhaps use
19643 \begin_inset Quotes eld
19651 \begin_inset Quotes erd
19657 \begin_layout Enumerate
19660 You should put a space in front of/after parenthesis.
19663 \begin_layout Enumerate
19666 You should avoid spaces in front of/after parenthesis.
19669 \begin_layout Enumerate
19673 You should not use punctuation in front of/after quotes.
19676 \begin_layout Enumerate
19679 Double space found.
19682 \begin_layout Enumerate
19685 You should put punctuation outside inner/inside display math mode.
19688 \begin_layout Enumerate
19691 You ought to not use primitive \SpecialChar TeX
19692 in \SpecialChar LaTeX
19696 \begin_layout Enumerate
19699 You should remove spaces in front of
19700 \begin_inset Quotes eld
19708 \begin_inset Quotes erd
19714 \begin_layout Enumerate
19717 \begin_inset Quotes eld
19725 \begin_inset Quotes erd
19728 is normally not followed by
19729 \begin_inset Quotes eld
19737 \begin_inset Quotes erd
19743 \begin_layout Standard
19744 In later versions of \SpecialChar LyX
19745 , we hope to provide a more complete interface to this
19746 tool (and it's smaller cousin
19750 ) to exploit the full power of it.
19751 But it's not exactly useless as it is now: go try it on one of your existing
19752 documents of a certain length and be surprised.
19755 \begin_layout Section
19756 Version Control in \SpecialChar LyX
19760 \begin_layout Standard
19763 Lars Gullik Bjønnes
19770 \begin_layout Subsection
19774 \begin_layout Standard
19776 supports some of the most basic RCS/CVS/SVN/GIT commands.
19777 If you need something a bit more sophisticated you will have to do that
19778 manually in a terminal.
19781 \begin_layout Standard
19782 Also note that CVS support is not as good as subversion support, so we advise
19784 A good place to start learning Subversion is the SVN Book
19788 \begin_layout Plain Layout
19789 \begin_inset CommandInset href
19791 target "http://svnbook.red-bean.com/"
19802 In the case of RCS you should read
19803 \begin_inset Quotes eld
19807 \begin_inset Quotes erd
19810 (a man file, read it with
19815 This file describes all the basic features of RCS.
19816 You should especially notice the comment about a RCS directory, and the
19817 notion of a master RCS file (the file ending in
19824 \begin_layout Standard
19825 Before you begin to use the version control features in \SpecialChar LyX
19827 familiar with RCS/CVS/SVN/GIT usage.
19828 The implementation in \SpecialChar LyX
19829 assumes a recent version of the GNU RCS or CVS/SVN
19830 package — no guarantees are made for older versions.
19831 Most of the log messages are not currently displayed after operations —
19832 you can check them in the Messages pane if you are unsure.
19833 Regular users of version control will appreciate the VC toolbar, which
19836 View\SpecialChar menuseparator
19837 Toolbars\SpecialChar menuseparator
19839 \begin_inset space ~
19847 \begin_layout Standard
19848 For introducing your own external commands consult
19849 \begin_inset Flex Code
19852 \begin_layout Plain Layout
19866 \begin_layout Standard
19867 It is strongly recommended to store documents in uncompressed format if
19868 using version control (uncheck
19870 Document\SpecialChar menuseparator
19873 if it is checked): Uncompressed LyX documents are text files and therefore
19874 for merging two different versions by version control systems.
19875 Compressed LyX documents are binary files, which cannot be merged by version
19879 \begin_layout Subsection
19880 RCS commands in \SpecialChar LyX
19884 \begin_layout Standard
19885 The following sections describe the RCS commands supported by \SpecialChar LyX
19887 You can find them in the
19889 File\SpecialChar menuseparator
19891 \begin_inset space ~
19898 was tested against RCS 5.7/5.8.
19901 \begin_layout Subsubsection
19907 \begin_layout Standard
19908 If your document is not under revision control, this is the only item shown
19910 And if it is under revision control, the
19914 item is not visible.
19918 \begin_layout Standard
19919 This command registers your document with RCS (unless you are under the
19920 directory managed by CVS)\SpecialChar endofsentence
19921 You are asked interactively to supply an initial
19922 description of the document.
19923 The document is now set in Read-Only mode and you have to
19926 \begin_inset space ~
19930 \begin_inset space ~
19934 \begin_inset space ~
19939 , before making any changes to it.
19940 A document under revision control has a
19941 \begin_inset Quotes eld
19944 [RCS:<version> <locker>]
19945 \begin_inset Quotes erd
19948 item tagged to the filename in the minibuffer.
19951 \begin_layout Standard
19952 RCS command that is run:
19955 \begin_layout LyX-Code
19958 ci -q -u -i -t-"<initial description>" <file-name>
19961 \begin_layout Standard
19966 to understand the switches.
19970 \begin_layout Subsubsection
19976 \begin_layout Standard
19977 When you are finished editing a file, you check in your changes.
19978 When you do this, you are asked for a description of the changes.
19979 This is stored in the history log.
19980 The version number is bumped, your changes are applied to the master RCS
19981 file, the document is unlocked and set to Read-Only mode.
19984 \begin_layout Itemize
19987 ci -q -u -m"<description>" <file-name>
19990 \begin_layout Subsubsection
19996 \begin_layout Standard
19997 By doing this you lock the document so that only you can edit it.
19998 This will also make the document Read-Write only for you.
19999 You will usually continue editing for a while and when you are finished
20000 you check in your changes.
20001 The status line is changed to reflect that you have locked the file.
20004 \begin_layout Itemize
20007 co -q -l <file-name>
20010 \begin_layout Subsubsection
20013 Revert To Repository Version
20016 \begin_layout Standard
20017 This will discard all changes made to the document since the last check
20019 You get a warning before changes are discarded.
20022 \begin_layout Itemize
20025 co -f -u<version> <file-name>
20028 \begin_layout Subsubsection
20034 \begin_layout Standard
20035 This will create a copy of the current document.
20036 Since RCS does not support copy operations natively, the version history
20037 is not preserved, and the copy is added as a new file.
20038 It requires a clean document without any changes since the last checkin.
20039 You are asked for a file name and a description of the copy operation.
20040 After that the copy is created, both locally and in the repository.
20041 If the parent directories of the copied and original document differ, all
20042 relative paths of included files of the copy are adjusted (like in
20044 File\SpecialChar menuseparator
20049 Finally, the copy is loaded instead of the original document.
20052 \begin_layout Labeling
20053 \labelwidthstring 00.00.0000
20055 \begin_inset space ~
20059 \begin_inset space ~
20063 \begin_inset Newline newline
20067 \begin_inset Flex Code
20070 \begin_layout Plain Layout
20073 \begin_inset Quotes qld
20077 \begin_inset Quotes qld
20086 \begin_inset Flex Code
20089 \begin_layout Plain Layout
20092 \begin_inset Quotes qld
20096 \begin_inset Quotes qld
20105 \begin_inset Newline newline
20109 \begin_inset Flex Code
20112 \begin_layout Plain Layout
20116 \begin_inset Quotes qld
20120 \begin_inset Quotes qld
20131 \begin_layout Subsubsection
20137 \begin_layout Standard
20138 This makes as if the last check in never happened.
20139 No changes are made to the document loaded into \SpecialChar LyX
20140 , but the last version
20141 is removed from the master RCS file.
20144 \begin_layout Itemize
20147 rcs -o<version> <file-name>
20150 \begin_layout Subsubsection
20156 \begin_layout Standard
20157 This shows the complete history of the RCS document.
20162 is shown in a browser.
20170 \begin_layout Subsubsection
20174 \begin_layout Standard
20176 supports RCS version number, author name, date and time of last commit.
20177 All those are extracted from
20179 rlog -r <file-name>
20183 \begin_inset CommandInset ref
20185 reference "subsec:VCS-Revision-Information"
20192 \begin_layout Subsection
20193 CVS commands in \SpecialChar LyX
20197 \begin_layout Standard
20198 A subset of CVS operations is supported by \SpecialChar LyX
20200 You can find the commands in the
20202 File\SpecialChar menuseparator
20204 \begin_inset space ~
20210 The version control system SVN is more powerful, so please use it instead
20211 of CVS if possible.
20214 \begin_layout Subsubsection
20220 \begin_layout Standard
20221 If you start from scratch with CVS you have to create your repository and
20222 checkout the working copy with external tools.
20223 If you're using a client-server setup you may need to login before doing
20224 the first repository checkout.
20227 \begin_layout Standard
20228 If your documents are under revision control and others are using the same
20229 repository problems arise when different changes to the same document at
20230 the same location happen.
20231 Standard CVS repositories don't operate with a file locking mechanism.
20232 This may be surprising, but conflicts only occur if people disagree on
20233 the proper content of the same part of a document.
20234 So, if co-workers are used to communicate regularly, these conflicts occur
20236 If they don't communicate they have a fundamental problem anyway.
20237 Nevertheless some people like to work with so called
20238 \begin_inset Quotes eld
20242 \begin_inset Quotes erd
20246 If they do so the working copy of all files is readonly when checked out
20247 first and the user starts editing after using a special command to make
20248 the working copy writable.
20249 When the changes are checked in the working copy returns to readonly state.
20250 With \SpecialChar LyX
20251 one has to edit the
20252 \begin_inset Flex Code
20255 \begin_layout Plain Layout
20261 file and add the line
20262 \begin_inset Flex Code
20265 \begin_layout Plain Layout
20271 to work with reserved checkouts.
20272 The benefit is the possibility to see who is using a writable copy of some
20274 It's not guaranteed only one user makes a copy writable.
20277 \begin_layout Standard
20279 tries to guess if you're using reserved or non-reserved checkouts.
20280 If your working copy is readonly or it is writable and an additional copy
20281 of your document exists in the CVS/Base sub-directory a reserved otherwise
20282 a non-reserved checkout is assumed.
20283 When a reserved checkout is detected you have to use
20284 \begin_inset Flex Noun
20287 \begin_layout Plain Layout
20293 to make your working copy writable if it's readonly.
20295 \begin_inset Flex Noun
20298 \begin_layout Plain Layout
20304 operation is possible and that makes your working copy readonly again after
20305 transferring your changes to the repository.
20308 \begin_layout Standard
20309 More information about CVS can be found here
20310 \begin_inset Flex URL
20313 \begin_layout Plain Layout
20315 http://www.nongnu.org/cvs
20321 \begin_inset Flex URL
20324 \begin_layout Plain Layout
20326 http://ximbiot.com/cvs
20334 \begin_layout Standard
20339 to understand the sub-commands and the switches mentioned below.
20342 \begin_layout Subsubsection
20348 \begin_layout Standard
20349 If your document is not under revision control, this is the only item shown
20351 And if it is under revision control, the
20355 item is not visible.
20359 \begin_layout Standard
20360 This command registers in CVS your document
20361 \begin_inset Flex Strong
20364 \begin_layout Plain Layout
20372 in the case you have already the documents directory under CVS control
20378 This means you have to create or checkout the archive by yourself using
20380 (In case you forget that step \SpecialChar LyX
20381 registers the document with RCS.)
20384 \begin_layout Standard
20385 Then you are asked interactively to supply an initial description of the
20387 Don't forget that registered file is not yet checked in.
20390 \begin_layout Standard
20391 CVS command that is run:
20393 cvs -q add -m"<entered message>" "<file-name>"
20396 \begin_layout Standard
20401 above and for all other CVS commands is an abbreviation for
20402 \begin_inset Quotes eld
20405 change the current working directory to file location and use the file name
20406 without path component as argument
20407 \begin_inset Quotes erd
20413 \begin_layout Subsubsection
20419 \begin_layout Standard
20420 When you are finished editing a file, you commit your changes.
20421 When you do this and you had changed the document, you are asked for a
20422 description of the changes.
20423 After that changes are written to the repository.
20424 In case you didn't change the document and a reserved checkout is detected
20425 the reservation made on
20426 \begin_inset Flex Noun
20429 \begin_layout Plain Layout
20438 \begin_layout Labeling
20439 \labelwidthstring 00.00.0000
20441 \begin_inset space ~
20445 \begin_inset space ~
20449 \begin_inset Newline newline
20453 \begin_inset Flex Code
20456 \begin_layout Plain Layout
20459 -q commit -m"<description>" "<file-name>"
20465 \begin_inset Newline newline
20469 \begin_inset Flex Code
20472 \begin_layout Plain Layout
20483 \begin_layout Subsubsection
20489 \begin_layout Standard
20490 When you are sharing a repository with others, you may have to incorporate
20491 their changes into your working copy.
20494 \begin_layout Standard
20497 cvs -q update "<file-name>"
20500 \begin_layout Standard
20501 If a readonly checkout is detected the working copy is made writable and
20505 \begin_layout Standard
20508 cvs -q edit "<file-name>"
20511 \begin_layout Subsubsection
20514 Revert To Repository Version
20517 \begin_layout Standard
20518 This will discard all changes made to the document since the last check
20520 You get a warning before changes are discarded.
20521 Firstly the file is deleted, secondly CVS update command is run.
20524 \begin_layout Standard
20527 cvs -q update "<file-name>"
20530 \begin_layout Standard
20531 If a reserved checkout is detected and the working copy has no changes only
20532 the reservation is undone.
20535 \begin_layout Standard
20538 cvs -q unedit "<file-name>"
20541 \begin_layout Subsubsection
20547 \begin_layout Standard
20548 This will create a copy of the current document.
20549 Since CVS does not support copy operations natively, the version history
20550 is not preserved, and the copy is added as a new file.
20551 It requires a clean document without any changes since the last checkin.
20552 You are asked for a file name and a description of the copy operation.
20553 After that the copy is created, both locally and in the repository.
20554 If the parent directories of the copied and original document differ, all
20555 relative paths of included files of the copy are adjusted (like in
20557 File\SpecialChar menuseparator
20562 Finally, the copy is loaded instead of the original document.
20565 \begin_layout Labeling
20566 \labelwidthstring 00.00.0000
20568 \begin_inset space ~
20572 \begin_inset space ~
20576 \begin_inset Newline newline
20580 \begin_inset Flex Code
20583 \begin_layout Plain Layout
20597 \begin_inset Flex Code
20600 \begin_layout Plain Layout
20614 \begin_inset Newline newline
20618 \begin_inset Flex Code
20621 \begin_layout Plain Layout
20637 \begin_layout Subsubsection
20643 \begin_layout Standard
20644 This will rename the current document.
20645 Since CVS does not support rename operations natively, the version history
20646 is not preserved, the renamed document is added as a new file, and the
20647 original document is deleted.
20648 It requires a clean document without any changes since the last checkin.
20649 You are asked for a file name and a description of the rename operation.
20650 After that the document is renamed, both locally and in the repository.
20651 If the parent directories of the new and old file names differ, all relative
20652 paths of included files are adjusted (like in
20654 File\SpecialChar menuseparator
20659 Finally, the document is reloaded using the new name.
20662 \begin_layout Labeling
20663 \labelwidthstring 00.00.0000
20665 \begin_inset space ~
20669 \begin_inset space ~
20673 \begin_inset Newline newline
20677 \begin_inset Flex Code
20680 \begin_layout Plain Layout
20694 \begin_inset Flex Code
20697 \begin_layout Plain Layout
20711 \begin_inset Newline newline
20715 \begin_inset Flex Code
20718 \begin_layout Plain Layout
20732 \begin_inset Newline newline
20736 \begin_inset Flex Code
20739 \begin_layout Plain Layout
20755 \begin_layout Subsubsection
20756 Update of the local directory checkout from repository
20759 \begin_layout Standard
20760 Once your documents gets more complex, containing sub-documents and pictures,
20762 \begin_inset Flex Code
20765 \begin_layout Plain Layout
20771 files and so on using version control becomes more complicated.
20773 supports updating the whole tree in which resides the document.
20774 This become especially useful once you cooperate with people which neither
20775 have detailed knowledge about CVS usage nor they have ambition to commit
20776 additional material to the repository.
20777 You have to organize the files structure so that all external files are
20778 in the same directory or subdirectories of the document.
20779 It's good practice anyway to store multipart documents in an extra directory.
20782 \begin_layout Standard
20784 \begin_inset Flex Code
20787 \begin_layout Plain Layout
20788 Update local directory from repository
20793 command updates the whole directory.
20794 If local changes are detected user is warned before update starts.
20795 In case of merge conflicts both versions of the conflicting document parts
20796 are placed in the final document.
20797 You have to review and correct the result of the merge.
20798 You'll find the conflicts enclosed in pairs of
20799 \begin_inset Flex Code
20802 \begin_layout Plain Layout
20809 \begin_inset Flex Code
20812 \begin_layout Plain Layout
20819 \begin_inset Flex Code
20822 \begin_layout Plain Layout
20829 The first part is your version as before the update operation with the
20830 document name prepended.
20831 The second one is the repository version with the version number after
20833 \begin_inset Flex Code
20836 \begin_layout Plain Layout
20845 \begin_layout Labeling
20846 \labelwidthstring 00.00.0000
20848 \begin_inset space ~
20852 \begin_inset space ~
20856 \begin_inset Newline newline
20860 \begin_inset Flex Code
20863 \begin_layout Plain Layout
20871 (Ask if changes are detected.)
20872 \begin_inset Newline newline
20876 \begin_inset Flex Code
20879 \begin_layout Plain Layout
20880 cd $path; cvs -q update
20890 \begin_layout Standard
20892 \begin_inset Flex Code
20895 \begin_layout Plain Layout
20901 stands for the path to the document.
20904 \begin_layout Subsubsection
20910 \begin_layout Standard
20911 This shows the complete history of the CVS document.
20914 cvs log "<file-name>"
20916 is shown in a browser.
20919 \begin_layout Subsubsection
20923 \begin_layout Standard
20925 supports CVS version number, author name, date and time of last commit.
20926 All those are extracted from
20928 cvs log -r <file-name>
20932 \begin_inset CommandInset ref
20934 reference "subsec:VCS-Revision-Information"
20941 \begin_layout Subsection
20942 SVN commands in \SpecialChar LyX
20946 \begin_layout Standard
20947 SVN is now partially supported by \SpecialChar LyX
20949 You can find the commands in the
20951 File\SpecialChar menuseparator
20953 \begin_inset space ~
20959 Please note that if you use password protected access to repository via
20960 ssh, you will be asked in terminal window.
20962 was tested against SVN 1.5, 1.6, 1.7 and 1.8
20966 \begin_layout Plain Layout
20967 Most of the commands will work with 1.4 too, see
20968 \begin_inset CommandInset ref
20970 reference "subsec:SVN-Repo-Update"
20975 There seems to be currently unresolved permissions problem under SVN 1.8
20976 with reverting changes when file is locked.
20984 \begin_layout Subsubsection
20990 \begin_layout Standard
20991 If your document is not under revision control, this is the only item shown
20993 And if it is under revision control, the
20997 item is not visible.
21000 \begin_layout Standard
21001 This command registers in SVN your document ONLY in case you have already
21002 the documents directory under SVN control (in particular
21007 This means you have to checkout the archive by yourself.
21010 \begin_layout Standard
21011 Then you are asked interactively to supply an initial description of the
21013 Don't forget that registered file is not yet commited.
21016 \begin_layout Standard
21017 SVN command that is run:
21020 \begin_inset Quotes qld
21024 \begin_inset Quotes qld
21030 \begin_layout Standard
21035 to understand the switches.
21038 \begin_layout Subsubsection
21044 \begin_layout Standard
21045 When you are finished editing a file, you commit your changes.
21046 When you do this, you are asked for a description of the changes.
21047 After that changes are commited.
21050 \begin_layout Standard
21055 \begin_layout Plain Layout
21056 In case locking is not enabled.
21058 \begin_inset CommandInset ref
21060 reference "subsec:SVN-File-Locking"
21071 svn commit -q -m"<description>" <file-name>
21074 \begin_layout Subsubsection
21080 \begin_layout Standard
21081 Updates the changes of this file from the repository.
21082 Be sure you understand SVN merging and conflicts resolving before using
21083 this function, because all conflicts has to be resolved manually by you!
21086 \begin_layout Standard
21091 \begin_layout Plain Layout
21099 svn update --non-interactive
21100 \begin_inset Quotes qld
21104 \begin_inset Quotes qld
21110 \begin_layout Subsubsection
21113 Revert To Repository Version
21116 \begin_layout Standard
21117 This will discard all changes made to the document since the last check
21119 You get a warning before changes are discarded.
21122 \begin_layout Standard
21126 \begin_inset Quotes qld
21130 \begin_inset Quotes qld
21136 \begin_layout Subsubsection
21142 \begin_layout Standard
21143 This will create a copy of the current document including the version history.
21144 It requires a clean document without any changes since the last checkin.
21145 You are asked for a file name and a description of the copy operation.
21146 After that the copy is created, both locally and in the repository.
21147 If the parent directories of the copied and original document differ, all
21148 relative paths of included files of the copy are adjusted (like in
21150 File\SpecialChar menuseparator
21155 Finally, the copy is loaded instead of the original document.
21158 \begin_layout Labeling
21159 \labelwidthstring 00.00.0000
21161 \begin_inset space ~
21165 \begin_inset space ~
21169 \begin_inset Newline newline
21173 \begin_inset Flex Code
21176 \begin_layout Plain Layout
21180 \begin_inset Quotes qld
21184 \begin_inset Quotes qld
21188 \begin_inset Quotes qld
21192 \begin_inset Quotes qld
21201 \begin_inset Newline newline
21205 \begin_inset Flex Code
21208 \begin_layout Plain Layout
21217 \begin_layout Subsubsection
21223 \begin_layout Standard
21224 This will rename the current document including the version history.
21225 It requires a clean document without any changes since the last checkin.
21226 You are asked for a file name and a description of the rename operation.
21227 After that the document is renamed, both locally and in the repository.
21228 If the parent directories of the new and old file names differ, all relative
21229 paths of included files are adjusted (like in
21231 File\SpecialChar menuseparator
21236 Finally, the document is reloaded using the new name.
21239 \begin_layout Labeling
21240 \labelwidthstring 00.00.0000
21242 \begin_inset space ~
21246 \begin_inset space ~
21250 \begin_inset Newline newline
21254 \begin_inset Flex Code
21257 \begin_layout Plain Layout
21261 \begin_inset Quotes qld
21265 \begin_inset Quotes qld
21269 \begin_inset Quotes qld
21273 \begin_inset Quotes qld
21282 \begin_inset Newline newline
21286 \begin_inset Flex Code
21289 \begin_layout Plain Layout
21298 \begin_layout Subsubsection
21299 \begin_inset CommandInset label
21301 name "subsec:SVN-Repo-Update"
21305 Update of the local directory checkout from repository
21309 \begin_layout Plain Layout
21310 Note that this command will work only with subversion
21311 \begin_inset Formula $\geqq1.5$
21322 \begin_layout Standard
21323 All the commands above have one shortcoming – they deal with the current
21325 Once your document contains pictures, includes external
21326 \begin_inset Flex Code
21329 \begin_layout Plain Layout
21335 files and so on administration becomes more complicated.
21337 now supports updating the whole tree in which resides the document
21341 \begin_layout Plain Layout
21342 One need to organize the files structure so that all external files are
21343 in the same directory or subdirectories of the document.
21350 This become especially useful once you cooperate with people which neither
21351 know about subversion management nor they have ambition to commit additional
21352 material to the repository.
21356 \begin_layout Standard
21357 \begin_inset Flex Code
21360 \begin_layout Plain Layout
21361 Update local directory from repository
21366 command updates the whole directory and in case of merge conflicts local
21367 version of the files are left, so no unintended data loss occurs.
21368 If local changes are detected user is warned before update starts.
21371 \begin_layout Labeling
21372 \labelwidthstring 00.00.0000
21374 \begin_inset space ~
21378 \begin_inset space ~
21382 \begin_inset Newline newline
21386 \begin_inset Flex Code
21389 \begin_layout Plain Layout
21395 (Ask if changes are detected.)
21396 \begin_inset Newline newline
21400 \begin_inset Flex Code
21403 \begin_layout Plain Layout
21404 svn update --accept mine-full $path
21412 \begin_layout Standard
21414 \begin_inset Flex Code
21417 \begin_layout Plain Layout
21423 stands for the path to the document.
21426 \begin_layout Subsubsection
21432 \begin_layout Standard
21433 This shows the complete history of the SVN document.
21437 \begin_inset Quotes qld
21441 \begin_inset Quotes qld
21446 is shown in a browser.
21449 \begin_layout Subsubsection
21451 \begin_inset CommandInset label
21453 name "subsec:SVN-File-Locking"
21460 \begin_layout Standard
21461 The file exchange through various revision control systems brings the problem
21462 of merge conflicts in case two different users try to edit the same (parts
21464 When such a conflict happens it needs manual resolving and one reasonable
21465 alternative is to provide some kind of locking mechanism, which guarantees
21466 that only one user is allowed to edit file at the given time.
21469 \begin_layout Standard
21470 SVN has two such mechanisms to provide mutual exclusivity for file access
21471 – locks and automatic setting of write permissions (see sec.
21473 \begin_inset CommandInset ref
21475 reference "subsec:Automatical-Locking-Property"
21480 \begin_inset Flex Code
21483 \begin_layout Plain Layout
21493 \begin_layout Plain Layout
21494 \begin_inset Flex URL
21497 \begin_layout Plain Layout
21499 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21510 If this property is detected for a given document \SpecialChar LyX
21511 starts to use SVN locks
21512 for document editing automatically and the whole check-in/out mechanism
21513 switches to the same regimen as for RCS.
21514 This in particular means there are two different modes of file use in \SpecialChar LyX
21518 \begin_layout Itemize
21520 The loaded file is in the read-only mode.
21521 For editing on needs to check-out.
21526 consists of updating from the repository and gaining write lock.
21527 If the lock is not possible to obtain, we remain in unlocked state.
21530 \begin_layout Itemize
21532 The loaded file is in the
21533 \begin_inset Quotes els
21537 \begin_inset Quotes ers
21541 No other user is allowed to edit the file.
21546 consists of commiting changes and releasing write-lock.
21547 If no changes have been made to the document, no commit will be produced
21551 \begin_layout Plain Layout
21552 Don't be puzzled by the fact that you will be asked for commit message anyway.
21557 and only the write-lock will be released.
21560 \begin_layout Standard
21564 \begin_layout Labeling
21565 \labelwidthstring 00.00.0000
21568 svn commit -q -m"<description>" "<file-name>"
21569 \begin_inset Newline newline
21572 svn unlock "<file-name>"
21575 \begin_layout Labeling
21576 \labelwidthstring 00.00.0000
21579 svn update "<file-name>"
21580 \begin_inset Newline newline
21583 svn lock "<file-name>"
21586 \begin_layout Subsubsection
21589 \begin_inset CommandInset label
21591 name "subsec:Automatical-Locking-Property"
21597 Automatic Locking Property
21600 \begin_layout Standard
21601 The above mentioned automatic setting of write permissions of the .lyx file
21604 File\SpecialChar menuseparator
21606 \begin_inset space ~
21609 Control\SpecialChar menuseparator
21610 Use Locking Property
21613 This command is active only when the file is not locked on the svn server
21615 you need to check-out before proceeding).
21618 \begin_layout Labeling
21619 \labelwidthstring 00.00.0000
21621 \begin_inset space ~
21627 \begin_layout Labeling
21628 \labelwidthstring 00.00.0000
21631 svn propset svn:needs-lock ON "<file-name>"
21634 \begin_layout Labeling
21635 \labelwidthstring 00.00.0000
21638 svn propdel svn:needs-lock "<file-name>"
21641 \begin_layout Subsubsection
21642 \begin_inset CommandInset label
21644 name "subsec:VCS-Revision-Information"
21648 Revision Information in Documents
21651 \begin_layout Standard
21652 There are more possibilities how to activate revision information in our
21656 \begin_layout Itemize
21662 \begin_layout Itemize
21663 tree revision information (
21664 \begin_inset Flex Code
21667 \begin_layout Plain Layout
21674 The result is the output of the
21675 \begin_inset Flex Code
21678 \begin_layout Plain Layout
21684 command, the following table gives you an idea, how to read the results.
21687 \begin_layout Standard
21689 \begin_inset Tabular
21690 <lyxtabular version="3" rows="6" columns="2">
21691 <features tabularvalignment="middle">
21692 <column alignment="left" valignment="top">
21693 <column alignment="left" valignment="top">
21695 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21698 \begin_layout Plain Layout
21706 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21709 \begin_layout Plain Layout
21719 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21722 \begin_layout Plain Layout
21728 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21731 \begin_layout Plain Layout
21732 mixed revision working copy
21739 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21742 \begin_layout Plain Layout
21748 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21751 \begin_layout Plain Layout
21752 modified working copy
21759 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21762 \begin_layout Plain Layout
21768 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21771 \begin_layout Plain Layout
21772 switched working copy
21779 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21782 \begin_layout Plain Layout
21788 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21791 \begin_layout Plain Layout
21792 partial working copy, from a sparse checkout
21799 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21802 \begin_layout Plain Layout
21808 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21811 \begin_layout Plain Layout
21812 mixed revision, modified, switched working copy
21825 \begin_layout Itemize
21826 file revision information.
21827 The result comes from parsing the output of
21828 \begin_inset Flex Code
21831 \begin_layout Plain Layout
21833 \begin_inset space ~
21837 \begin_inset space ~
21841 \begin_inset space ~
21850 Supported flags are:
21854 \begin_layout Itemize
21855 version number of the last commit (
21856 \begin_inset Flex Code
21859 \begin_layout Plain Layout
21868 \begin_layout Itemize
21869 author of the last commit (
21870 \begin_inset Flex Code
21873 \begin_layout Plain Layout
21882 \begin_layout Itemize
21883 date of the last commit (
21884 \begin_inset Flex Code
21887 \begin_layout Plain Layout
21896 \begin_layout Itemize
21897 time of the last commit (
21898 \begin_inset Flex Code
21901 \begin_layout Plain Layout
21911 \begin_layout Standard
21912 You can obtain this info via InsetInfo (
21913 \change_inserted 5863208 1564400022
21916 Insert\SpecialChar menuseparator
21917 Field\SpecialChar menuseparator
21918 Version Control Revision
21919 \change_deleted 5863208 1564399852
21924 \begin_inset Flex Code
21927 \begin_layout Plain Layout
21928 info-insert buffer vcs-date
21936 The information will be available only when you have the file stored under
21937 svn managment (i.e.
21939 \begin_inset Flex Code
21942 \begin_layout Plain Layout
21948 directory is available with your document).
21952 \begin_layout Itemize
21953 Another—a hacking one—possibility is to use svn keywords
21957 \begin_layout Plain Layout
21958 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
21964 In short – you set file keywords property (e.g.
21967 svn propset svn:keywords 'Rev' file.lyx
21969 ) and then paste keyword \SpecialChar TeX
21974 \begin_layout Plain Layout
21975 This is an easy way how to ensure that \SpecialChar LyX
21976 won't break the line in the middle
21982 tag in your document (e.g.
21984 \begin_inset Flex Code
21987 \begin_layout Plain Layout
21994 This way svn client will automatically substitute revision number (e.g.
21996 \begin_inset Flex Code
21999 \begin_layout Plain Layout
22005 ) after each update and commit.
22006 There are more problems with this approach.
22007 Firstly, the '$' character is used in \SpecialChar TeX
22008 world for math equations, so any
22009 occurence of math formula
22010 \begin_inset Formula $Rev$
22014 \begin_inset Formula $Rev:59$
22017 in your \SpecialChar LyX
22019 Similarly for other keywords like Id, Date, Author, etc.
22020 Secondly svn output is dependent on your locales, so its very easy that
22021 svn would produce some problematic strings once Date is used.
22022 Thirdly you get the whole 'Rev: 59' string in your document instead of
22024 Until subversion implements user's custom keywords it will be hard to use
22025 this approach reliably or let \SpecialChar LyX
22026 to support it directly.
22029 \begin_layout Subsection
22030 SVN and Windows Environment
22033 \begin_layout Quote
22034 My inclination is to say that if the user cannot figure out the command
22035 line operations on their own fairly quickly, they would be well advised
22036 to use TortoiseSVN.
22042 \begin_layout Subsubsection
22046 \begin_layout Standard
22047 In addition to installing \SpecialChar LyX
22048 , and having access to a Subversion repository,
22049 the user will need to install the Subversion client program.
22050 A Windows installer for the client program is available from
22051 \begin_inset CommandInset href
22054 target "http://www.collab.net/nonav/downloads/subversion/"
22060 The user may also want to install
22061 \begin_inset CommandInset href
22064 target "http://tortoisesvn.tigris.org/"
22069 , which integrates Subversion operations into the context (rightclick) menu
22070 of Windows Explorer.
22071 Operations done outside \SpecialChar LyX
22072 will typically be more convenient using the Explorer
22074 Note that TortoiseSVN is not a replacement for the client program, which
22075 is what \SpecialChar LyX
22079 \begin_layout Subsubsection
22080 Bringing a document under Subversion control
22083 \begin_layout Standard
22084 Before a \SpecialChar LyX
22085 document can be brought under version control in Subversion, its
22086 parent directory needs to be under version control.
22087 If the document is being added to a project already in the repository,
22088 this is accomplished by checking the project out to the directory where
22089 the new document will be placed.
22090 If the project itself is not yet under version control (for instance, if
22091 this document starts a new project), the directory must be imported into
22093 This is done outside \SpecialChar LyX
22095 Both import and checkout are easily accomplished from the Explorer context
22096 menu using TortoiseSVN, or alternatively can be done using the command
22097 line client at a DOS prompt.
22098 The procedure for importing the project using TortoiseSVN is described
22099 below, assuming an existing repository and a new project being started
22107 For information on using the Subversion client program, run
22114 \begin_layout Enumerate
22121 in Windows Explorer, right click it, and select
22123 TortoiseSVN\SpecialChar menuseparator
22127 If necessary, adjust the URL for the repository, then click OK.
22130 \begin_layout Enumerate
22131 Right click the level of the repository under which you want to place the
22132 new project folder (typically the top level) and click
22136 Supply a name for the project folder and click OK.
22137 Add a message for the log file if desired, then click OK again.
22138 The new project folder should appear in the repository.
22139 Finally, click OK again to exit the repository browser.
22142 \begin_layout Enumerate
22143 Once again right click
22149 , this time selecting SVN Checkout\SpecialChar ldots
22150 Select the URL of the project folder
22151 you just created in the repository, and set the checkout directory to
22159 You will be warned about a non-empty folder; click OK to proceed.
22160 You should now have a
22171 \begin_layout Enumerate
22172 Create or open your document in \SpecialChar LyX
22175 File\SpecialChar menuseparator
22177 \begin_inset space ~
22180 Control\SpecialChar menuseparator
22184 Add a log message and click OK to commit the document to version control.
22187 \begin_layout Standard
22188 From this point onward, you should have full functionality in the
22190 File\SpecialChar menuseparator
22192 \begin_inset space ~
22198 You also have the option of checking the document in and out, viewing its
22200 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22201 client program from a command prompt.
22204 \begin_layout Subsubsection
22205 SSH tunnel used with SVN under Windows
22208 \begin_layout Standard
22209 Compared with Linux setting up an svn client to communicate over ssh under
22210 Windows is a rather troublesome task.
22211 We will at least offer some hints how to setup the client side but prior
22212 knowledge about ssh and the Windows command line is needed, also be prepared
22213 for a great deal of frustration\SpecialChar ldots
22217 \begin_layout Enumerate
22218 Get an svn client for windows, as described in the previous sections.
22219 When it is a fresh install run some svn command (e.g.
22221 \begin_inset Flex Code
22224 \begin_layout Plain Layout
22230 ) to create config files, which you will need to change later on.
22233 \begin_layout Enumerate
22234 Choose an ssh client for Windows.
22235 There are several possibilities, we will use the one from Putty tools
22239 \begin_layout Plain Layout
22240 \begin_inset Flex URL
22243 \begin_layout Plain Layout
22245 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22256 You will need to set the connection up so that the client doesn't ask for
22257 any password from you.
22258 To keep things easy we will use only keys without any additional password
22263 \begin_layout Enumerate
22265 \begin_inset Flex Code
22268 \begin_layout Plain Layout
22275 Save your private .ppk key file and put the public one on the server side.
22276 If the SVN server runs on Linux, note that the format of the public key
22277 is not compatible with Linux openssh and you will need to direcly copy-paste
22279 \begin_inset Quotes eld
22284 Public key for pasting into OpenSSH authorized_keys file
22287 \begin_inset Quotes erd
22290 edit field into the server's
22291 \begin_inset Flex Code
22294 \begin_layout Plain Layout
22295 ~/.ssh/authorized_keys
22301 \begin_inset Flex Code
22304 \begin_layout Plain Layout
22313 \begin_layout Enumerate
22315 \begin_inset Flex Code
22318 \begin_layout Plain Layout
22325 In the SVN config file
22329 \begin_layout Plain Layout
22330 Exact path depends on Windows version, usually somewhere around
22331 \begin_inset Flex Code
22334 \begin_layout Plain Layout
22337 Documents and Settings
22351 \begin_inset Flex Code
22354 \begin_layout Plain Layout
22369 , section [tunnels], setup ssh command, e.g.
22371 \begin_inset Flex Code
22374 \begin_layout Plain Layout
22375 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22384 \begin_layout Plain Layout
22385 It will usually take a lot of time to get exact command right and it depends
22387 For example do not have some remote server saved as a default session in
22389 If things fail, try to connect via plink without SVN first.
22398 \begin_layout Enumerate
22399 Checkout the SVN archive, e.
22400 \begin_inset space \thinspace{}
22404 \begin_inset Newline newline
22408 \begin_inset Flex Code
22411 \begin_layout Plain Layout
22412 svn co svn+ssh://user@server/repository_path
22420 \begin_layout Subsubsection
22421 End-of-Line Conversions
22424 \begin_layout Standard
22425 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22427 use different line endings inside the .lyx files.
22428 This is not a problem as far as \SpecialChar LyX
22429 functionality is concerned, but the commit
22430 diffs will be huge and merge-conflicts prone.
22431 Fortunately SVN itself knows
22435 \begin_layout Plain Layout
22436 \begin_inset Flex URL
22439 \begin_layout Plain Layout
22441 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22451 how to deal with CR/LF problems when switching .lyx files to the
22452 \begin_inset Flex Code
22455 \begin_layout Plain Layout
22465 \begin_layout Plain Layout
22467 \begin_inset Flex Code
22470 \begin_layout Plain Layout
22471 svn propset svn:eol-style native FILE_NAME
22484 \begin_layout Subsection
22485 GIT commands in \SpecialChar LyX
22489 \begin_layout Standard
22490 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22492 You can find the commands in the
22494 File\SpecialChar menuseparator
22496 \begin_inset space ~
22502 Please note that if you use password protected access to repository via
22503 ssh, you will be asked in terminal window.
22505 was tested against GIT 1.7.
22509 \begin_layout Plain Layout
22510 Windows users please note that you need to ensure that git is on the path.
22511 This can be set from within \SpecialChar LyX
22514 Tools\SpecialChar menuseparator
22515 Preferences\SpecialChar menuseparator
22516 Paths\SpecialChar menuseparator
22527 \begin_layout Standard
22528 One big difference of GIT and the other supported version control systems
22529 is the distributed nature of GIT: With traditional version control systems
22530 there is one central server which hosts the repository.
22531 Users commit their changes to the server, and get updates made by other
22533 With GIT, users commit to a local repository.
22534 The local repository can be synchronized with one or more remote repositories
22536 \begin_inset Flex Code
22539 \begin_layout Plain Layout
22546 \begin_inset Flex Code
22549 \begin_layout Plain Layout
22557 does not interact in any way with remote GIT repositories.
22558 It works exclusively with the local repository in a very similar way as
22559 with a central CVS or SVN repository.
22560 If you use remote GIT repositories you need to do the
22561 \begin_inset Flex Code
22564 \begin_layout Plain Layout
22571 \begin_inset Flex Code
22574 \begin_layout Plain Layout
22580 operations with your favourite GIT client.
22583 \begin_layout Subsubsection
22589 \begin_layout Standard
22590 If your document is not under revision control, this is the only item shown
22592 And if it is under revision control, the
22596 item is not visible.
22599 \begin_layout Standard
22600 This command registers in GIT your document ONLY in case you have already
22601 the documents directory under GIT control (in particular
22606 This means you have to checkout the archive by yourself.
22609 \begin_layout Standard
22610 Then you are asked interactively to supply an initial description of the
22612 Don't forget that registered file is not yet committed.
22615 \begin_layout Standard
22616 GIT command that is run:
22619 \begin_inset Quotes qld
22623 \begin_inset Quotes qld
22629 \begin_layout Standard
22634 to understand the switches.
22637 \begin_layout Subsubsection
22643 \begin_layout Standard
22644 When you are finished editing a file, you commit your changes.
22645 When you do this, you are asked for a description of the changes.
22646 After that changes are committed.
22649 \begin_layout Standard
22652 git commit -q -m"<description>" <file-name>
22655 \begin_layout Subsubsection
22658 Revert To Repository Version
22661 \begin_layout Standard
22662 This will discard all changes made to the document since the last check
22664 You get a warning before changes are discarded.
22667 \begin_layout Standard
22671 \begin_inset Quotes qld
22675 \begin_inset Quotes qld
22681 \begin_layout Subsubsection
22687 \begin_layout Standard
22688 This will rename the current document including the version history.
22689 It requires a clean document without any changes since the last checkin.
22690 You are asked for a file name and a description of the rename operation.
22691 After that the document is renamed, both locally and in the repository.
22692 If the parent directories of the new and old file names differ, all relative
22693 paths of included files are adjusted (like in
22695 File\SpecialChar menuseparator
22700 Finally, the document is reloaded using the new name.
22703 \begin_layout Labeling
22704 \labelwidthstring 00.00.0000
22706 \begin_inset space ~
22710 \begin_inset space ~
22714 \begin_inset Newline newline
22718 \begin_inset Flex Code
22721 \begin_layout Plain Layout
22725 \begin_inset Quotes qld
22729 \begin_inset Quotes qld
22733 \begin_inset Quotes qld
22737 \begin_inset Quotes qld
22746 \begin_inset Newline newline
22750 \begin_inset Flex Code
22753 \begin_layout Plain Layout
22762 \begin_layout Subsubsection
22768 \begin_layout Standard
22769 This shows the complete history of the GIT document.
22773 \begin_inset Quotes qld
22777 \begin_inset Quotes qld
22782 is shown in a browser.
22785 \begin_layout Subsubsection
22789 \begin_layout Standard
22791 supports GIT hash number of the last commit to the file,
22792 \change_inserted 1119979965 1564297456
22793 its abbreviated form,
22795 author name, date and time of last commit.
22796 All those are extracted from
22798 git log -n 1 --pretty=format:%H%n
22799 \change_inserted 1119979965 1564297427
22805 Tree version information is obtained via
22807 git describe --abbrev --dirty --long
22811 \begin_inset CommandInset ref
22813 reference "subsec:VCS-Revision-Information"
22820 \begin_layout Subsection
22824 \begin_layout Standard
22825 With the recent addition of the
22826 \begin_inset Flex Code
22829 \begin_layout Plain Layout
22835 function \SpecialChar LyX
22836 power users are allowed to create their own commands for revision
22840 \begin_layout Standard
22841 As an example you can see how two TortoiseSVN commands could be integrated
22845 \begin_layout Description
22847 \begin_inset Flex Code
22850 \begin_layout Plain Layout
22851 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
22859 \begin_layout Description
22861 \begin_inset Flex Code
22864 \begin_layout Plain Layout
22865 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
22873 \begin_layout Subsection
22874 Version control and Document comparison
22877 \begin_layout Standard
22878 One of the typical uses of version control is to inspect the changes between
22879 revisions, usually by creating
22880 \begin_inset Flex Code
22883 \begin_layout Plain Layout
22890 While this is useful for plain text files, it is much less useful in the
22891 case of \SpecialChar LyX
22892 files, which have more a complicated structure.
22893 Hence we provide binding to the Document comparison feature.
22894 There are two ways of calling this feature – either by direct call of
22895 \begin_inset Flex Code
22898 \begin_layout Plain Layout
22905 function (for details see \SpecialChar LyX
22906 functions manual) or by the toolbar icon
22919 One can either compare two chosen revisions of the document or he can simply
22920 compare the current version of edited text with older revisions (where
22922 \begin_inset Flex Noun
22925 \begin_layout Plain Layout
22931 ' revisions back means comparison of the edited file with last commited
22936 \begin_layout Standard
22937 This feature is supported for SVN and RCS though due to the more complicated
22938 versioning scheme of RCS there is a constraint – when addressing the revisions
22939 in dialog, numbers always point to the last number in RCS revision number,
22942 We don't currently support GIT addressing of revisions, one can just compare
22943 edited document with its revision X steps backs, where X is addressed as
22945 \begin_inset Flex Code
22948 \begin_layout Plain Layout
22957 \begin_layout Section
22958 Literate Programming
22961 \begin_layout Standard
22966 (kayvan@sylvan.com)
22970 original documentation written by
22972 Edmar Wienskoski Jr.
22975 (edmar-w-jr@technologist.com)
22978 \begin_layout Subsection
22982 \begin_layout Standard
22983 The main purpose of this documentation is to show you how to use \SpecialChar LyX
22985 programming, where it is assumed that you are familiar with this programming
22986 technique, and know what
22987 \begin_inset Quotes eld
22991 \begin_inset Quotes erd
22995 \begin_inset Quotes eld
22999 \begin_inset Quotes erd
23003 If that is not the case, please follow the web links provided in the following
23005 There is a lot of good documentation out there covering old development
23006 history to the latest tools tips.
23009 \begin_layout Standard
23010 It is also assumed that you are familiar with \SpecialChar LyX
23011 itself to a point that you
23012 are comfortable changing your \SpecialChar LyX
23013 preferences, and X resources file.
23014 If that is not the case please refer to other \SpecialChar LyX
23015 documentation to cover your
23019 \begin_layout Subsection
23020 Literate Programming
23023 \begin_layout Standard
23024 From the Literate Programming FAQ:
23027 \begin_layout Quotation
23028 Literate programming is the combination of documentation and source together
23029 in a fashion suited for reading by human beings.
23030 In fact, literate programs should be enjoyable reading, even inviting!
23031 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23032 and documentation in a single file.
23033 Literate programming tools then parse the file to produce either readable
23034 documentation or compilable source.
23035 The WEB style of literate programming was created by D.
23036 \begin_inset space \thinspace{}
23040 Knuth during the development of his \SpecialChar TeX
23041 typesetting software.
23045 \begin_layout Standard
23046 Another excerpt says:
23049 \begin_layout Quotation
23052 How is literate programming different from verbose commenting?
23055 \begin_layout Quotation
23056 There are three distinguishing characteristics.
23057 In order of importance, they are:
23061 \begin_layout Itemize
23062 flexible order of elaboration
23065 \begin_layout Itemize
23066 automatic support for browsing
23069 \begin_layout Itemize
23070 typeset documentation, especially diagrams and mathematics
23074 \begin_layout Standard
23075 Now that I sparked your curiosity, take a look in the references.
23078 \begin_layout Subsubsection
23082 \begin_layout Standard
23083 The complete Literate Programming FAQ can be found at:
23086 \begin_layout Quote
23087 Literate Programming FAQ
23088 \begin_inset Flex URL
23091 \begin_layout Plain Layout
23093 http://www.literateprogramming.com/lpfaq.pdf
23101 \begin_layout Standard
23102 The FAQ lists 23 (twenty three!) different literate programming tools.
23103 Where some are specialized or
23104 \begin_inset Quotes eld
23108 \begin_inset Quotes erd
23111 for particular programming languages, while other have general scope.
23116 for my own use for several reasons:
23119 \begin_layout Itemize
23120 It can generate the documentation either in \SpecialChar LaTeX
23124 \begin_layout Itemize
23125 It has a open architecture, i.
23126 \begin_inset space \thinspace{}
23130 \begin_inset space \space{}
23133 it is easy to plug in new filters
23137 \begin_layout Plain Layout
23142 are programs that read a given data stream and output a manipulated data
23144 That way, a WEB file (consisting of literate code) can be turned into a
23145 file consisting only of C program code or \SpecialChar LaTeX
23151 and to perform special processing that you may need.
23155 \begin_layout Itemize
23156 There is a good selection of filters available already (the HTML is one
23160 \begin_layout Itemize
23164 \begin_layout Standard
23165 The Noweb web page can be found at:
23168 \begin_layout Quote
23170 \begin_inset Flex URL
23173 \begin_layout Plain Layout
23175 https://www.cs.tufts.edu/~nr/noweb/
23183 \begin_layout Standard
23184 Starting from there you can reach many other interesting links and even
23185 some literate program examples.
23188 \begin_layout Subsection
23190 and Literate Programming with Noweb
23193 \begin_layout Standard
23194 The \SpecialChar LyX
23195 support for Literate Programming is provided by using the generic \SpecialChar LyX
23197 converters mechanism.
23198 This support is provided in a
23199 \begin_inset Quotes eld
23203 \begin_inset Quotes erd
23207 \begin_inset space \thinspace{}
23211 \begin_inset space \space{}
23214 you will be able to use this new \SpecialChar LyX
23215 feature with some other literate programming
23216 tool of your choice by just changing your \SpecialChar LyX
23220 \begin_layout Subsubsection
23221 Generating documents and code (weaving and tangling)
23224 \begin_layout Paragraph
23225 Using the noweb module
23228 \begin_layout Standard
23229 If you have installed Noweb and \SpecialChar LyX
23230 successfully, whenever you open a new document,
23231 after you have chosen its document class, use the
23233 Document\SpecialChar menuseparator
23237 \begin_inset Quotes eld
23241 \begin_inset Quotes erd
23245 If Noweb is correctly installed, when you click on the
23246 \begin_inset Quotes eld
23250 \begin_inset Quotes erd
23253 link, you will see the
23254 \begin_inset Quotes eld
23258 \begin_inset Quotes erd
23261 module in the available list and you can add it to your document.
23264 \begin_layout Paragraph
23268 \begin_layout Standard
23270 enables you to write code with a custom inset named
23271 \begin_inset Flex Noun
23274 \begin_layout Plain Layout
23281 Noweb delimits chunks like this:
23284 \begin_layout LyX-Code
23288 \begin_layout LyX-Code
23292 \begin_layout LyX-Code
23296 \begin_layout LyX-Code
23300 \begin_layout LyX-Code
23304 \begin_layout Standard
23305 The problem is that whatever is written in between the << and the
23309 must be taken literally, i.
23310 \begin_inset space \thinspace{}
23314 \begin_inset space \space{}
23318 should be prevented from making any special interpretation of what has
23320 This is also handled by
23321 \begin_inset Flex Noun
23324 \begin_layout Plain Layout
23330 , that works like a normal text inset but has a free spacing capability.
23333 \begin_layout Standard
23334 As a special note, you can also use the
23335 \begin_inset Quotes eld
23339 \begin_inset Quotes erd
23342 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23346 \begin_layout LyX-Code
23350 \begin_layout LyX-Code
23351 def some_function(args):
23354 \begin_layout LyX-Code
23355 "This is the doc string for this function."
23358 \begin_layout LyX-Code
23359 print "My args: ", args
23362 \begin_layout LyX-Code
23363 @ %def some_function
23366 \begin_layout Standard
23367 For an example of this usage and the resulting cross-reference output, look
23368 at the Literate python program in
23370 LIBDIR/examples/listerrors.lyx
23372 which should make this all clear.
23375 \begin_layout Paragraph
23376 Generating the documentation
23379 \begin_layout Standard
23380 At this point you already have a new document file with a proper document
23381 class, and with some code and text on it.
23382 How do I print it? The answer is simple, you select
23384 View\SpecialChar menuseparator
23388 Just like you would do for a plain document.
23389 No special procedure is required.
23392 \begin_layout Standard
23393 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23397 \begin_layout Enumerate
23400 Update\SpecialChar menuseparator
23403 menu option is chosen, a \SpecialChar LaTeX
23409 \begin_layout Standard
23410 If the document is of any literate class the generated file will be named
23411 with an extension name defined by the
23412 \begin_inset Quotes eld
23416 \begin_inset Quotes erd
23419 format (defined in the Preferences panel), otherwise the file will have
23428 \begin_layout Enumerate
23429 Note that the only difference so far is in the name of the file, no special
23430 processing is required by \SpecialChar LyX
23432 Given that you formatted the code using the
23433 \begin_inset Flex Noun
23436 \begin_layout Plain Layout
23442 inset that, by itself, takes care of the business.
23445 \begin_layout Enumerate
23446 If the document is of any literate class \SpecialChar LyX
23447 will then use the internal \SpecialChar LyX
23449 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23454 \begin_layout Plain Layout
23455 The converters are defined in the
23457 Tools\SpecialChar menuseparator
23461 \begin_inset Quotes eld
23465 \begin_inset Quotes erd
23477 manual for general information about converters.
23482 to generate the \SpecialChar LaTeX
23487 \begin_layout Standard
23488 Otherwise it will just skip this step.
23492 \begin_layout Enumerate
23493 Finally, \SpecialChar LaTeX
23494 is invoked and the regular post processing continues as in a plain
23498 \begin_layout Standard
23499 Independence from a particular
23500 \begin_inset Quotes eld
23504 \begin_inset Quotes erd
23507 is easily achieved by changing the commands that are run by the various
23511 \begin_layout Paragraph
23512 Generating the code
23515 \begin_layout Standard
23516 When the build menu option is chosen or the corresponding button in the
23517 toolbar is pressed, a \SpecialChar LaTeX
23518 file is generated just like step 1 above.
23519 Next, \SpecialChar LyX
23525 This converter needs to be defined by the user and is not installed by
23526 default, though the Program format is.
23527 This converter (like any other converter) will have two parts:
23530 \begin_layout Enumerate
23531 The converter program itself.
23532 This program performs the conversion from the one format to the other (in
23533 this case, from the Noweb format to the Program pseudo-format).
23536 \begin_layout Enumerate
23537 The error log parser.
23538 This is a program whose sole purpose is to rewrite error messages in a
23539 format that \SpecialChar LyX
23541 This makes it possible for \SpecialChar LyX
23542 to place error boxes in the right places in
23546 \begin_layout Standard
23547 The first part, the
23548 \begin_inset Quotes eld
23552 \begin_inset Quotes erd
23555 setting, should be set to
23558 \begin_layout LyX-Code
23566 \begin_layout Standard
23567 This basically means that \SpecialChar LyX
23569 \begin_inset Quotes eld
23573 \begin_inset Quotes erd
23576 (a program or script) with the name of the Noweb file (normally a file
23577 in the \SpecialChar LyX
23578 temp directory) and the directory path of the original \SpecialChar LyX
23583 \begin_layout Standard
23584 This is an implementation of
23585 \begin_inset Quotes eld
23589 \begin_inset Quotes erd
23592 that you can place in a directory on your path:
23595 \begin_layout LyX-Code
23601 \begin_layout LyX-Code
23607 \begin_layout LyX-Code
23610 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23613 \begin_layout Standard
23614 The next part of the converter setting is the
23615 \begin_inset Quotes eld
23619 \begin_inset Quotes erd
23622 which is to be set to
23625 \begin_layout LyX-Code
23628 parselog=$$s/scripts/listerrors
23631 \begin_layout Standard
23632 This will run any errors that are generated by the
23633 \begin_inset Quotes eld
23637 \begin_inset Quotes erd
23640 process through the
23641 \begin_inset Quotes eld
23645 \begin_inset Quotes erd
23651 \begin_layout Standard
23652 The build will normally take place in \SpecialChar LyX
23653 's temporary directory, so the files
23654 produced by the conversion will be in that directory.
23656 will copy out what it regards as the `main' file, but the
23660 conversion may produce several files, and so most of these would then be
23661 deleted when \SpecialChar LyX
23663 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23664 the build-script chunk can place the generated files in that location.
23667 \begin_layout Paragraph
23668 Build instructions in the document
23671 \begin_layout Standard
23672 The last piece of the integration between \SpecialChar LyX
23674 \begin_inset Quotes eld
23678 \begin_inset Quotes erd
23682 Generally, the instructions for building your program should be embedded
23683 in a chunk of its own.
23685 \begin_inset Quotes eld
23689 \begin_inset Quotes erd
23692 above uses the notangle command to look for this chunk (called
23693 \begin_inset Quotes eld
23697 \begin_inset Quotes erd
23700 ) and runs its contents through
23701 \begin_inset Quotes eld
23705 \begin_inset Quotes erd
23711 \begin_layout Standard
23712 Typically, such a chunk would look something like this:
23715 \begin_layout LyX-Code
23719 \begin_layout LyX-Code
23721 \begin_inset Newline newline
23724 if [ -z "${NOWEB_SOURCE}" ]
23725 \begin_inset Newline newline
23731 \begin_layout LyX-Code
23732 NOWEB_SOURCE=myfile.nw
23733 \begin_inset Newline newline
23737 \begin_inset Newline newline
23741 code to extract files ...
23742 use NOWEB_OUTPUT_DIR here ...]
23743 \begin_inset Newline newline
23747 code to compile files ...]
23748 \begin_inset Newline newline
23754 \begin_layout Standard
23757 LIBDIR/examples/listerrors.lyx
23761 LIBDIR/examples/Literate.lyx
23763 which implement two versions of the
23764 \begin_inset Quotes eld
23768 \begin_inset Quotes erd
23771 program for some illustrations of how all of these pieces go together or
23774 LIBDIR/examples/noweb2lyx.lyx.
23777 Interestingly, these three files show off the language-indepence of the
23779 literate programming support since they are written in Python, C and Perl
23783 \begin_layout Subsubsection
23784 Configuring \SpecialChar LyX
23788 \begin_layout Standard
23789 All the Literate Programming support is configured by the
23791 Tools\SpecialChar menuseparator
23795 \begin_inset Quotes eld
23799 \begin_inset Quotes erd
23803 The important parts are:
23806 \begin_layout Description
23808 \begin_inset space ~
23812 \begin_inset Quotes eld
23816 \begin_inset Quotes erd
23820 \begin_inset space ~
23823 format Set up via the File Formats tab, this is where the Noweb-specific
23833 , the file extension is set to
23838 This tells \SpecialChar LyX
23839 to create a file with a
23843 extension in the first step of the conversion process.
23846 \begin_layout Description
23848 \begin_inset space ~
23856 \begin_inset space ~
23859 format This is an empty format whose sole purpose is to be the endpoint
23860 of a conversion (which then allows us to set up a converter for it).
23863 \begin_layout Description
23873 This converter performs the
23874 \begin_inset Quotes eld
23878 \begin_inset Quotes erd
23881 of the literate document.
23882 For Noweb, it is set to
23883 \begin_inset Quotes eld
23888 noweave -delay -index $$i > $$o
23891 \begin_inset Quotes erd
23897 \begin_layout Description
23907 \begin_inset Quotes eld
23911 \begin_inset Quotes erd
23915 As stated above, the Converter is set to
23916 \begin_inset Quotes eld
23924 \begin_inset Quotes erd
23927 , with Flags set to
23928 \begin_inset Newline newline
23932 \begin_inset Quotes eld
23937 parselog=$$s/scripts/listerrors
23940 \begin_inset Quotes erd
23946 \begin_layout Subsubsection
23950 \begin_layout Standard
23951 There is also a new function implemented in the \SpecialChar LyX
23953 \begin_inset Quotes eld
23956 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
23960 \begin_layout Standard
23961 When debugging code with ddd/gdb, it is possible to invoke a text editor
23962 at the current execution position with a single key stroke.
23963 The default ddd configuration for that is shift-ctrl-V.
23964 It happens that you can define the editor command line invocation in ddd
23967 Edit\SpecialChar menuseparator
23968 Preferences\SpecialChar menuseparator
23971 dialog and changing the "Edit Sources" entry.
23974 \begin_layout Standard
23975 I take advantage of the newly created \SpecialChar LyX
23976 server function and this ddd feature,
23978 \begin_inset Quotes eld
23982 \begin_inset Quotes erd
23988 \begin_layout LyX-Code
23989 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
23992 \begin_layout Standard
23993 With this, whenever you are using ddd and find a point in the program that
23994 you want to edit, you just press shift-ctrl-V (in the ddd window), and
23995 ddd will forward this information to \SpecialChar LyX
23996 through the \SpecialChar LyX
23997 server and then the
23999 window will show the same file with the cursor at the same position ddd
24001 No more guessing or long scrolling to locate a point in the program back
24005 \begin_layout Standard
24006 Note however that you must enable the \SpecialChar LyX
24007 server to get this feature working
24008 (it is disabled by default).
24010 \begin_inset space ~
24014 \begin_inset CommandInset ref
24016 reference "sec:Starting-the-Server"
24020 explains how to do that.
24023 \begin_layout Subsubsection
24027 \begin_layout Standard
24028 There are six new buttons that can be added to your \SpecialChar LyX
24030 Four of these buttons are short cuts to layout styles:
24048 , one for the custom inset
24053 The last one is a short cut to the
24054 \begin_inset Quotes eld
24058 \begin_inset Quotes erd
24065 \begin_layout Standard
24067 has a range of buttons that are available for tool bar customization.
24068 In my toolbar I like to combine the six short cuts above with two more:
24073 \SpecialChar menuseparator
24078 \SpecialChar menuseparator
24085 Document\SpecialChar menuseparator
24086 View\SpecialChar menuseparator
24090 Here is how it looks like:
24093 \begin_layout LyX-Code
24097 \begin_layout LyX-Code
24101 \begin_layout LyX-Code
24102 Icon "layout Standard"
24105 \begin_layout LyX-Code
24106 Icon "layout Section"
24109 \begin_layout LyX-Code
24110 Icon "layout \SpecialChar LaTeX
24114 \begin_layout LyX-Code
24115 Icon "layout \SpecialChar LyX
24119 \begin_layout LyX-Code
24120 Icon "flex.insert Chunk"
24123 \begin_layout LyX-Code
24127 \begin_layout LyX-Code
24131 \begin_layout LyX-Code
24132 Icon "buffer-typeset"
24135 \begin_layout LyX-Code
24136 Icon "build-program"
24139 \begin_layout LyX-Code
24143 \begin_layout LyX-Code
24147 \begin_layout LyX-Code
24151 \begin_layout LyX-Code
24155 \begin_layout LyX-Code
24159 \begin_layout Subsubsection
24160 Colors customization
24163 \begin_layout Standard
24164 There are a number of colors in \SpecialChar LyX
24165 that can be customized in
24170 One of the things that bothers people is the \SpecialChar LaTeX
24172 The default color is red, since the chunks uses \SpecialChar LaTeX
24173 font, and there is a lot
24174 of chunks in literate documents, you may get tired of seeing everything
24176 You can change it by going to the tabs
24185 \begin_layout Standard
24186 The next thing is the visible presence of the newline character in the screen.
24187 You can choose the color of this particular character and make it blend
24189 I recommend you choosing a color that is close to the background but not
24190 equal, that way you still can see it is there, but it is not bothering
24194 \begin_layout Subsection
24199 \begin_layout Standard
24208 is documented in the
24212 example file and in the Sweave manual (menu
24214 Help\SpecialChar menuseparator
24220 \begin_layout Chapter
24224 \begin_layout Standard
24225 You can do everything with \SpecialChar LyX
24226 that you can do with \SpecialChar LaTeX
24228 However, \SpecialChar LyX
24229 cannot support every \SpecialChar LaTeX
24231 But you can always use \SpecialChar TeX
24233 This chapter shows you some more special things you might want to use.
24234 For other special things you can do with figures, tables, floats, boxes
24235 and notes, have a look at the
24238 \begin_inset space ~
24246 \begin_layout Section
24247 Multiple Text Columns
24250 \begin_layout Standard
24251 This feature is independent of the option
24253 Two-column document
24255 in the document settings under
24260 If you want to have 2
24261 \begin_inset space ~
24264 columns for the whole document, it is recommended to use the
24266 Two-column document
24269 For all other cases use this feature.
24272 \begin_layout Standard
24273 To use multiple text columns in your document, you have to load the module
24280 Document\SpecialChar menuseparator
24281 Settings\SpecialChar menuseparator
24284 ) and must have the \SpecialChar LaTeX
24286 \begin_inset Flex Code
24289 \begin_layout Plain Layout
24298 \begin_layout Standard
24299 Footnotes within multiple columns will be placed at the bottom of the page
24300 and not under each column.
24301 Within the different columns you can use everything, with the limitation
24302 that for floats you need to use the float option
24309 \begin_layout Subsection
24313 \begin_layout Standard
24314 If you want to have 2
24315 \begin_inset space ~
24318 columns in your text, insert a multicolumn inset via the menu
24320 Insert\SpecialChar menuseparator
24322 \begin_inset space ~
24325 Insets\SpecialChar menuseparator
24327 \begin_inset space ~
24332 where the columns should start.
24333 Write all text that should be printed in 2
24334 \begin_inset space ~
24337 columns into this inset.
24340 \begin_layout Standard
24341 Here is an example:
24344 \begin_layout Standard
24346 \begin_inset Flex Multiple Columns
24349 \begin_layout Plain Layout
24354 The Adventure of the Empty House
24357 \begin_inset Newline newline
24360 by Sir Arthur Conan Doyle
24363 \begin_layout Plain Layout
24366 It was in the spring of the year 1894 that all London was interested, and
24367 the fashionable world dismayed, by the murder of the Honourable Ronald
24368 Adair under most unusual and inexplicable circumstances.
24369 The public has already learned those particulars of the crime which came
24370 out in the police investigation, but a good deal was suppressed upon that
24371 occasion, since the case for the prosecution was so overwhelmingly strong
24372 that it was not necessary to bring forward all the facts.
24373 Only now, at the end of nearly ten years, am I allowed to supply those
24374 missing links which make up the whole of that remarkable chain.
24375 The crime was of interest in itself, but that interest was as nothing to
24376 me compared to the inconceivable sequel, which afforded me the greatest
24377 shock and surprise of any event in my adventurous life.
24378 Even now, after this long interval, I find myself thrilling as I think
24379 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24380 ty which utterly submerged my mind.
24381 Let me say to that public, which has shown some interest in those glimpses
24382 which I have occasionally given them of the thoughts and actions of a very
24383 remarkable man, that they are not to blame me if I have not shared my knowledge
24384 with them, for I should have considered it my first duty to do so, had
24385 I not been barred by a positive prohibition from his own lips, which was
24386 only withdrawn upon the third of last month.
24394 \begin_layout Standard
24395 To get 3 or more columns, set the cursor into the multicolumn inset and
24398 Insert\SpecialChar menuseparator
24400 \begin_inset space ~
24404 \begin_inset space ~
24410 The number of the desired columns is written into that inset (for 3
24411 \begin_inset space ~
24415 \begin_inset Quotes eld
24419 \begin_inset Quotes erd
24423 \begin_inset Newline newline
24426 Here is an example with 3
24427 \begin_inset space ~
24433 \begin_layout Standard
24434 \begin_inset Flex Multiple Columns
24437 \begin_layout Plain Layout
24440 \begin_inset Argument 1
24443 \begin_layout Plain Layout
24450 It can be imagined that my close intimacy with Sherlock Holmes had interested
24451 me deeply in crime, and that after his disappearance I never failed to
24452 read with care the various problems which came before the public.
24453 And I even attempted, more than once, for my own private satisfaction,
24454 to employ his methods in their solution, though with indifferent success.
24455 There was none, however, which appealed to me like this tragedy of Ronald
24457 As I read the evidence at the inquest, which led up to a verdict of willful
24458 murder against some person or persons unknown, I realized more clearly
24459 than I had ever done the loss which the community had sustained by the
24460 death of Sherlock Holmes.
24461 There were points about this strange business which would, I was sure,
24462 have specially appealed to him, and the efforts of the police would have
24463 been supplemented, or more probably anticipated, by the trained observation
24464 and the alert mind of the first criminal agent in Europe.
24465 All day, as I drove upon my round, I turned over the case in my mind and
24466 found no explanation which appeared to me to be adequate.
24467 At the risk of telling a twice-told tale, I will recapitulate the facts
24468 as they were known to the public at the conclusion of the inquest.
24476 \begin_layout Standard
24477 You can have up to 10
24478 \begin_inset space ~
24481 columns if you want to, but that might not be very pleasant for the readers
24485 \begin_layout Standard
24486 \begin_inset Newpage newpage
24492 \begin_layout Subsection
24493 Columns inside Columns
24496 \begin_layout Standard
24497 You can also have columns inside columns:
24500 \begin_layout Standard
24501 \begin_inset Flex Multiple Columns
24504 \begin_layout Plain Layout
24507 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24508 at that time governor of one of the Australian colonies.
24509 Adair's mother had returned from Australia to undergo the operation for
24510 cataract, and she, her son Ronald, and her daughter Hilda were living together
24514 \begin_layout Plain Layout
24515 \begin_inset Flex Multiple Columns
24518 \begin_layout Plain Layout
24521 The youth moved in the best society
24522 \begin_inset space ~
24525 – had, so far as was known, no enemies and no particular vices.
24526 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24527 had been broken off by mutual consent some months before, and there was
24528 no sign that it had left any very profound feeling behind it.
24529 For the rest {sic} the man's life moved in a narrow and conventional circle,
24530 for his habits were quiet and his nature unemotional.
24531 Yet it was upon this easy-going young aristocrat that death came, in most
24532 strange and unexpected form, between the hours of ten and eleven-twenty
24533 on the night of March 30, 1894.
24541 \begin_layout Plain Layout
24544 Ronald Adair was fond of cards
24545 \begin_inset space ~
24548 – playing continually, but never for such stakes as would hurt him.
24549 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24550 It was shown that, after dinner on the day of his death, he had played
24551 a rubber of whist at the latter club.
24552 He had also played there in the afternoon.
24557 The evidence of those who had played with him
24558 \begin_inset space ~
24562 Murray, Sir John Hardy, and Colonel Moran
24563 \begin_inset space ~
24566 – showed that the game was whist, and that there was a fairly equal fall
24568 Adair might have lost five pounds, but not more.
24569 His fortune was a considerable one, and such a loss could not in any way
24571 He had played nearly every day at one club or other, but he was a cautious
24572 player, and usually rose a winner.
24573 It came out in evidence that, in partnership with Colonel Moran, he had
24574 actually won as much as four hundred and twenty pounds in a sitting, some
24575 weeks before, from Godfrey Milner and Lord Balmoral.
24576 So much for his recent history as it came out at the inquest.
24584 \begin_layout Subsection
24588 \begin_layout Standard
24589 The examples in this section show some more special features of multiple
24593 \begin_layout Standard
24594 For more features of multiple columns, have a look at the
24595 \begin_inset CommandInset href
24597 name "documentation"
24598 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
24603 of the \SpecialChar LaTeX
24605 \begin_inset Flex Code
24608 \begin_layout Plain Layout
24617 \begin_layout Subsubsection
24621 \begin_layout Standard
24622 To add a preface text for multiple columns, set the cursor into the multicolumn
24623 inset and use the menu
24625 Insert\SpecialChar menuseparator
24629 Write your preface text into that inset.
24630 \begin_inset Newline newline
24633 This is an example with some preface text:
24636 \begin_layout Standard
24637 \begin_inset VSpace bigskip
24643 \begin_layout Standard
24644 \begin_inset Flex Multiple Columns
24647 \begin_layout Plain Layout
24648 \begin_inset Argument 2
24651 \begin_layout Plain Layout
24652 And the story continues and continues and continues and continues\SpecialChar ldots
24660 On the evening of the crime, he returned from the club exactly at ten.
24661 His mother and sister were out spending the evening with a relation.
24662 The servant deposed that she heard him enter the front room on the second
24663 floor, generally used as his sitting-room.
24664 She had lit a fire there, and as it smoked she had opened the window.
24665 No sound was heard from the room until eleven-twenty, the hour of the return
24666 of Lady Maynooth and her daughter.
24667 Desiring to say good-night, she attempted to enter her son's room.
24668 The door was locked on the inside, and no answer could be got to their
24669 cries and knocking.
24670 Help was obtained, and the door forced.
24671 The unfortunate young man was found lying near the table.
24672 His head had been horribly mutilated by an expanding revolver bullet, but
24673 no weapon of any sort was to be found in the room.
24681 \begin_layout Standard
24682 You can also use a section heading as the preface if you use a section command
24683 as \SpecialChar TeX
24685 For example the command
24688 \begin_layout LyX-Code
24691 subsection{subsection title}
24694 \begin_layout Standard
24695 creates a subsection.
24696 In this example the preface is a subsubsection:
24699 \begin_layout Standard
24700 \begin_inset Flex Multiple Columns
24703 \begin_layout Plain Layout
24704 \begin_inset Argument 2
24707 \begin_layout Plain Layout
24711 \begin_layout Plain Layout
24720 This is a subsubsection heading as a preface
24724 \begin_layout Plain Layout
24738 A minute examination of the circumstances served only to make the case more
24740 In the first place, no reason could be given why the young man should have
24741 fastened the door upon the inside.
24742 There was the possibility that the murderer had done this, and had afterwards
24743 escaped by the window.
24744 The drop was at least twenty feet, however, and a bed of crocuses in full
24746 Neither the flowers nor the earth showed any sign of having been disturbed,
24747 nor were there any marks upon the narrow strip of grass which separated
24748 the house from the road.
24749 Apparently, therefore, it was the young man himself who had fastened the
24751 But how did he come by his death? No one could have climbed up to the window
24752 without leaving traces.
24753 Suppose a man had fired through the window, he would indeed be a remarkable
24754 shot who could with a revolver inflict so deadly a wound.
24755 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24756 a hundred yards of the house.
24757 No one had heard a shot.
24765 \begin_layout Standard
24766 If there is less vertical space than 6
24767 \begin_inset space ~
24770 text lines is left on the page at the beginning of the multiple columns,
24771 a page break will be inserted before the multiple columns.
24772 Depending on the number of lines of the preface text, you might want to
24774 This is done by setting the cursor into the mulitcolumn inset behind the
24775 preface (if there is any) and using the menu
24777 Insert\SpecialChar menuseparator
24779 \begin_inset space ~
24783 \begin_inset space ~
24787 \begin_inset space ~
24793 Insert into that inset the amount of space like e.
24794 \begin_inset space \thinspace{}
24798 \begin_inset space \space{}
24802 \begin_inset Quotes eld
24806 \begin_inset Quotes erd
24810 \begin_inset Newline newline
24813 In this example the space is set to 7
24814 \begin_inset space ~
24817 text lines by using
24818 \begin_inset Flex Code
24821 \begin_layout Plain Layout
24830 \begin_inset Flex Code
24833 \begin_layout Plain Layout
24841 needs to be inserted as \SpecialChar TeX
24845 \begin_layout Standard
24846 \begin_inset Flex Multiple Columns
24849 \begin_layout Plain Layout
24850 \begin_inset Argument 3
24853 \begin_layout Plain Layout
24858 \begin_layout Plain Layout
24874 On the evening of the crime, he returned from the club exactly at ten.
24875 His mother and sister were out spending the evening with a relation.
24876 The servant deposed that she heard him enter the front room on the second
24877 floor, generally used as his sitting-room.
24878 She had lit a fire there, and as it smoked she had opened the window.
24879 No sound was heard from the room until eleven-twenty, the hour of the return
24880 of Lady Maynooth and her daughter.
24881 Desiring to say good-night, she attempted to enter her son's room.
24882 The door was locked on the inside, and no answer could be got to their
24883 cries and knocking.
24884 Help was obtained, and the door forced.
24885 The unfortunate young man was found lying near the table.
24886 His head had been horribly mutilated by an expanding revolver bullet, but
24887 no weapon of any sort was to be found in the room.
24895 \begin_layout Subsubsection
24899 \begin_layout Standard
24900 The amount of space before and after multiple columns can be changed by
24901 changing the length
24902 \begin_inset Flex Code
24905 \begin_layout Plain Layout
24914 For example the command
24917 \begin_layout LyX-Code
24925 \begin_layout Standard
24926 in \SpecialChar TeX
24927 Code changes its value to 3
24928 \begin_inset space \thinspace{}
24932 The change must be made before the multiple columns' start.
24933 The predefined value is 13
24934 \begin_inset space \thinspace{}
24940 \begin_layout Standard
24942 \begin_inset Flex Code
24945 \begin_layout Plain Layout
24954 \begin_inset space \thinspace{}
24960 \begin_layout Standard
24964 \begin_layout Plain Layout
24970 multicolsep}{2.5cm}
24978 \begin_layout Standard
24979 \begin_inset Flex Multiple Columns
24982 \begin_layout Plain Layout
24985 All day I turned these facts over in my mind, endeavouring to hit upon some
24986 theory which could reconcile them all, and to find that line of least resistanc
24987 e which my poor friend had declared to be the starting-point of every investigat
24989 I confess that I made little progress.
24990 In the evening I strolled across the Park, and found myself about six o'clock
24991 at the Oxford Street end of Park Lane.
24992 A group of loafers upon the pavements, all staring up at a particular window,
24993 directed me to the house which I had come to see.
24994 A tall, thin man with coloured glasses, whom I strongly suspected of being
24995 a plain-clothes detective, was pointing out some theory of his own, while
24996 the others crowded round to listen to what he said.
24997 I got as near him as I could, but his observations seemed to me to be absurd,
24998 so I withdrew again in some disgust.
24999 As I did so I struck against an elderly, deformed man, who had been behind
25000 me, and I knocked down several books which he was carrying.
25008 \begin_layout Standard
25009 \begin_inset Note Greyedout
25012 \begin_layout Plain Layout
25017 The values you set with
25018 \begin_inset Flex Code
25021 \begin_layout Plain Layout
25029 will be used for all following multiple columns until you change them again.
25037 \begin_layout Standard
25041 \begin_layout Plain Layout
25053 \begin_inset Note Note
25056 \begin_layout Plain Layout
25057 go back to the default
25065 \begin_layout Standard
25066 \begin_inset Newpage newpage
25072 \begin_layout Subsubsection
25076 \begin_layout Standard
25077 A column break can be forced by inserting the command
25078 \begin_inset Flex Code
25081 \begin_layout Plain Layout
25089 as \SpecialChar TeX
25090 Code to that position in the text where the column should be broken.
25091 Note that this leads in most cases to whitespace in the text.
25092 \begin_inset Newline newline
25095 Here is an example:
25098 \begin_layout Standard
25099 \begin_inset Flex Multiple Columns
25102 \begin_layout Plain Layout
25105 \begin_inset Quotes eld
25108 You're surprised to see me, sir,
25109 \begin_inset Quotes erd
25112 said he, in a strange, croaking voice.
25115 \begin_layout Plain Layout
25118 I acknowledged that I was.
25121 \begin_layout Plain Layout
25124 \begin_inset Quotes eld
25127 Well, I've a conscience, sir, and when I chanced to see you go into this
25128 house, as I came hobbling after you, I thought to myself, I'll just step
25129 in and see that kind gentleman, and tell him that if I was a bit gruff
25130 in my manner there was not any harm meant, and that I am much obliged to
25131 him for picking up my books.
25132 \begin_inset Quotes erd
25138 \begin_layout Plain Layout
25141 \begin_inset Quotes eld
25144 You make too much of a trifle,
25145 \begin_inset Quotes erd
25150 \begin_inset Quotes eld
25153 May I ask how you knew who I was?
25154 \begin_inset Quotes erd
25157 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25161 \begin_layout Plain Layout
25173 \begin_layout Plain Layout
25176 \begin_inset Quotes eld
25179 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25180 you'll find my little bookshop at the corner of Church Street, and very
25181 happy to see you, I am sure.
25182 Maybe you collect yourself, sir.
25186 \begin_inset space ~
25200 \begin_inset space ~
25203 – a bargain, every one of them.
25204 With five volumes you could just fill that gap on that second shelf.
25205 It looks untidy, does it not, sir?
25206 \begin_inset Quotes erd
25217 \begin_layout Subsubsection
25221 \begin_layout Standard
25222 The width of the columns is automatically calculated, but you can modify
25223 the space between the columns.
25224 This is done by changing the length
25225 \begin_inset Flex Code
25228 \begin_layout Plain Layout
25237 Its predefined value is 10
25238 \begin_inset space \thinspace{}
25242 Here is an example where
25243 \begin_inset Flex Code
25246 \begin_layout Plain Layout
25255 \begin_inset space \thinspace{}
25261 \begin_layout Standard
25265 \begin_layout Plain Layout
25279 \begin_layout Standard
25280 \begin_inset Flex Multiple Columns
25283 \begin_layout Plain Layout
25286 My observations of No.
25287 \begin_inset space \space{}
25290 427 Park Lane did little to clear up the problem in which I was interested.
25291 The house was separated from the street by a low wall and railing, the
25292 whole not more than five feet high.
25293 It was perfectly easy, therefore, for anyone to get into the garden, but
25294 the window was entirely inaccessible, since there was no water pipe or
25295 anything which could help the most active man to climb it.
25296 More puzzled than ever, I retraced my steps to Kensington.
25297 I had not been in my study five minutes when the maid entered to say that
25298 a person desired to see me.
25299 To my astonishment it was none other than my strange old book collector,
25300 his sharp, wizened face peering out from a frame of white hair, and his
25301 precious volumes, a dozen of them at least, wedged under his right arm.
25309 \begin_layout Standard
25313 \begin_layout Plain Layout
25325 \begin_inset Note Note
25328 \begin_layout Plain Layout
25329 go back to the default
25337 \begin_layout Subsubsection
25341 \begin_layout Standard
25342 Between the columns a rule with a width of the length
25343 \begin_inset Flex Code
25346 \begin_layout Plain Layout
25355 If this rule width is set to 0
25356 \begin_inset space \thinspace{}
25359 pt (this is the default), the rule is suppressed.
25360 In the following example the rule is 2
25361 \begin_inset space \thinspace{}
25367 \begin_layout Standard
25371 \begin_layout Plain Layout
25377 columnseprule}{2pt}
25385 \begin_layout Standard
25386 \begin_inset Flex Multiple Columns
25389 \begin_layout Plain Layout
25392 \begin_inset Quotes eld
25395 You're surprised to see me, sir,
25396 \begin_inset Quotes erd
25399 said he, in a strange, croaking voice.
25402 \begin_layout Plain Layout
25405 I acknowledged that I was.
25408 \begin_layout Plain Layout
25411 \begin_inset Quotes eld
25414 Well, I've a conscience, sir, and when I chanced to see you go into this
25415 house, as I came hobbling after you, I thought to myself, I'll just step
25416 in and see that kind gentleman, and tell him that if I was a bit gruff
25417 in my manner there was not any harm meant, and that I am much obliged to
25418 him for picking up my books.
25419 \begin_inset Quotes erd
25425 \begin_layout Plain Layout
25428 \begin_inset Quotes eld
25431 You make too much of a trifle,
25432 \begin_inset Quotes erd
25437 \begin_inset Quotes eld
25440 May I ask how you knew who I was?
25441 \begin_inset Quotes erd
25447 \begin_layout Plain Layout
25450 \begin_inset Quotes eld
25453 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25454 you'll find my little bookshop at the corner of Church Street, and very
25455 happy to see you, I am sure.
25456 Maybe you collect yourself, sir.
25460 \begin_inset space ~
25474 \begin_inset space ~
25477 – a bargain, every one of them.
25478 With five volumes you could just fill that gap on that second shelf.
25479 It looks untidy, does it not, sir?
25480 \begin_inset Quotes erd
25491 \begin_layout Standard
25492 \begin_inset VSpace defskip
25498 \begin_layout Standard
25499 The rule can be colored by redefining the command
25500 \begin_inset Flex Code
25503 \begin_layout Plain Layout
25512 This is done by inserting the command
25515 \begin_layout LyX-Code
25520 columnseprulecolor}{
25525 \begin_layout Standard
25526 as \SpecialChar TeX
25527 Code before the multicolumn inset.
25529 \begin_inset Flex Code
25532 \begin_layout Plain Layout
25538 in this command by a color of your choice.
25539 You can use all pre- and self-defined colors.
25547 \begin_inset space ~
25552 for more information about pre- and self-defined colors.
25553 To go back to the default color insert the command
25556 \begin_layout LyX-Code
25561 columnseprulecolor}{
25566 \begin_layout Standard
25567 Here is the example with a cyan rule and 1
25568 \begin_inset space \thinspace{}
25571 cm column separation:
25574 \begin_layout Standard
25578 \begin_layout Plain Layout
25587 \begin_layout Plain Layout
25593 columnseprulecolor}{
25603 \begin_layout Standard
25604 \begin_inset Flex Multiple Columns
25607 \begin_layout Plain Layout
25610 \begin_inset Quotes eld
25613 You're surprised to see me, sir,
25614 \begin_inset Quotes erd
25617 said he, in a strange, croaking voice.
25620 \begin_layout Plain Layout
25623 I acknowledged that I was.
25626 \begin_layout Plain Layout
25629 \begin_inset Quotes eld
25632 Well, I've a conscience, sir, and when I chanced to see you go into this
25633 house, as I came hobbling after you, I thought to myself, I'll just step
25634 in and see that kind gentleman, and tell him that if I was a bit gruff
25635 in my manner there was not any harm meant, and that I am much obliged to
25636 him for picking up my books.
25637 \begin_inset Quotes erd
25643 \begin_layout Plain Layout
25646 \begin_inset Quotes eld
25649 You make too much of a trifle,
25650 \begin_inset Quotes erd
25655 \begin_inset Quotes eld
25658 May I ask how you knew who I was?
25659 \begin_inset Quotes erd
25665 \begin_layout Plain Layout
25668 \begin_inset Quotes eld
25671 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25672 you'll find my little bookshop at the corner of Church Street, and very
25673 happy to see you, I am sure.
25674 Maybe you collect yourself, sir.
25678 \begin_inset space ~
25692 \begin_inset space ~
25695 – a bargain, every one of them.
25696 With five volumes you could just fill that gap on that second shelf.
25697 It looks untidy, does it not, sir?
25698 \begin_inset Quotes erd
25709 \begin_layout Standard
25713 \begin_layout Plain Layout
25719 columnseprule}{0pt}
25722 \begin_layout Plain Layout
25728 columnseprulecolor}{
25736 \begin_inset Note Note
25739 \begin_layout Plain Layout
25740 go back to the default
25748 \begin_layout Section
25749 Non-standard Paragraph Shapes
25752 \begin_layout Standard
25755 as well as any other text processor uses by default rectangular paragraphs.
25756 For special cases like for example posters, invitation cards or poems you
25757 can modify the paragraph shape to one of your choice.
25758 This can be done by using the \SpecialChar LaTeX
25760 \begin_inset Flex Code
25763 \begin_layout Plain Layout
25769 which is loaded by using in the document settings the module
25771 Custom paragraph shapes
25776 \begin_layout Subsection
25780 \begin_layout Standard
25785 provides the following shapes:
25788 \begin_layout Standard
25789 \begin_inset Tabular
25790 <lyxtabular version="3" rows="13" columns="3">
25791 <features booktabs="true" islongtable="true" longtabularalignment="center">
25792 <column alignment="left" valignment="middle" width="16col%">
25793 <column alignment="left" valignment="middle" width="40col%">
25794 <column alignment="left" valignment="middle" width="35col%">
25795 <row endhead="true">
25796 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25799 \begin_layout Plain Layout
25808 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25811 \begin_layout Plain Layout
25820 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25823 \begin_layout Plain Layout
25833 <row interlinespace="default">
25834 <cell alignment="left" valignment="top" usebox="none">
25837 \begin_layout Plain Layout
25845 <cell alignment="left" valignment="top" usebox="none">
25848 \begin_layout Plain Layout
25851 Circle with circular hole (in the size of a CD/DVD)
25856 <cell alignment="left" valignment="top" usebox="none">
25859 \begin_layout Plain Layout
25862 Cannot be scaled, take care there is not too much text
25868 <row interlinespace="default">
25869 <cell alignment="left" valignment="top" usebox="none">
25872 \begin_layout Plain Layout
25880 <cell alignment="left" valignment="top" usebox="none">
25883 \begin_layout Plain Layout
25891 <cell alignment="left" valignment="top" usebox="none">
25894 \begin_layout Plain Layout
25897 Fragile, calculation might fail
25903 <row interlinespace="default">
25904 <cell alignment="left" valignment="top" usebox="none">
25907 \begin_layout Plain Layout
25915 <cell alignment="left" valignment="top" usebox="none">
25918 \begin_layout Plain Layout
25921 Rhomboid (symbolizing a
25922 \begin_inset Quotes eld
25926 \begin_inset Quotes erd
25934 <cell alignment="left" valignment="top" usebox="none">
25937 \begin_layout Plain Layout
25946 <row interlinespace="default">
25947 <cell alignment="left" valignment="top" usebox="none">
25950 \begin_layout Plain Layout
25958 <cell alignment="left" valignment="top" usebox="none">
25961 \begin_layout Plain Layout
25969 <cell alignment="left" valignment="top" usebox="none">
25972 \begin_layout Plain Layout
25981 <row interlinespace="default">
25982 <cell alignment="left" valignment="top" usebox="none">
25985 \begin_layout Plain Layout
25993 <cell alignment="left" valignment="top" usebox="none">
25996 \begin_layout Plain Layout
26004 <cell alignment="left" valignment="top" usebox="none">
26007 \begin_layout Plain Layout
26016 <row interlinespace="default">
26017 <cell alignment="left" valignment="top" usebox="none">
26020 \begin_layout Plain Layout
26028 <cell alignment="left" valignment="top" usebox="none">
26031 \begin_layout Plain Layout
26034 Nut for bolt (hexagon with circular hole)
26039 <cell alignment="left" valignment="top" usebox="none">
26042 \begin_layout Plain Layout
26051 <row interlinespace="default">
26052 <cell alignment="left" valignment="top" usebox="none">
26055 \begin_layout Plain Layout
26063 <cell alignment="left" valignment="top" usebox="none">
26066 \begin_layout Plain Layout
26074 <cell alignment="left" valignment="top" usebox="none">
26077 \begin_layout Plain Layout
26086 <row interlinespace="default">
26087 <cell alignment="left" valignment="top" usebox="none">
26090 \begin_layout Plain Layout
26098 <cell alignment="left" valignment="top" usebox="none">
26101 \begin_layout Plain Layout
26109 <cell alignment="left" valignment="top" usebox="none">
26112 \begin_layout Plain Layout
26121 <row interlinespace="default">
26122 <cell alignment="left" valignment="top" usebox="none">
26125 \begin_layout Plain Layout
26133 <cell alignment="left" valignment="top" usebox="none">
26136 \begin_layout Plain Layout
26144 <cell alignment="left" valignment="top" usebox="none">
26147 \begin_layout Plain Layout
26156 <row interlinespace="default">
26157 <cell alignment="left" valignment="top" usebox="none">
26160 \begin_layout Plain Layout
26168 <cell alignment="left" valignment="top" usebox="none">
26171 \begin_layout Plain Layout
26174 Normal/reversed rain drop
26179 <cell alignment="left" valignment="top" usebox="none">
26182 \begin_layout Plain Layout
26185 Fragile, calculation might fail
26191 <row interlinespace="default">
26192 <cell alignment="left" valignment="top" usebox="none">
26195 \begin_layout Plain Layout
26204 <cell alignment="left" valignment="top" usebox="none">
26207 \begin_layout Plain Layout
26210 The \SpecialChar TeX
26216 <cell alignment="left" valignment="top" usebox="none">
26219 \begin_layout Plain Layout
26228 <row interlinespace="default">
26229 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26232 \begin_layout Plain Layout
26236 \begin_inset Newline newline
26244 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26247 \begin_layout Plain Layout
26250 Triangles in different orientations
26255 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26258 \begin_layout Plain Layout
26274 \begin_layout Standard
26275 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26277 for environments in the toolbar.
26280 \begin_layout Standard
26281 \begin_inset Newpage newpage
26287 \begin_layout Standard
26288 Here is an example paragraph in the shape of a nut:
26291 \begin_layout Standard
26292 \begin_inset VSpace bigskip
26301 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26302 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26304 At vero eos et accusam et justo duo dolores et ea rebum.
26305 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26307 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26308 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26312 \begin_layout Standard
26313 \begin_inset VSpace bigskip
26319 \begin_layout Standard
26320 \begin_inset Note Greyedout
26323 \begin_layout Plain Layout
26332 paragraphs cannot run over a page break.
26340 \begin_layout Standard
26341 \begin_inset VSpace bigskip
26347 \begin_layout Standard
26349 \begin_inset Flex Code
26352 \begin_layout Plain Layout
26358 takes care that the shape will always be preserved, no matter how much
26359 text is in the paragraph.
26360 Therefore the paragraph size changes with the amount of contained text.
26361 This can lead to paragraph sizes exceeding the page margins.
26362 To demonstrate the size scaling, here is the same example paragraph but
26363 with twice as much text:
26366 \begin_layout Standard
26367 \begin_inset Newpage newpage
26376 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26377 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26379 At vero eos et accusam et justo duo dolores et ea rebum.
26380 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26382 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26383 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26385 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26386 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26388 At vero eos et accusam et justo duo dolores et ea rebum.
26389 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26391 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26392 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26396 \begin_layout Standard
26397 \begin_inset VSpace bigskip
26403 \begin_layout Standard
26404 An exception is the shape
26409 It cannot be scaled because it must fit the size of a CD/DVD.
26410 Therefore the amount of text that fits into the shape is limited.
26411 \begin_inset Newline newline
26422 shape are fragile, meaning that the calculation of their size can fail,
26423 depending on the amount of text.
26424 You will then get the \SpecialChar LaTeX
26426 \begin_inset Quotes eld
26429 Arithmetic overflow
26430 \begin_inset Quotes erd
26434 In this case one can try to remove or add some text; if nothing works one
26435 has to use another shape.
26438 \begin_layout Standard
26439 \begin_inset VSpace bigskip
26445 \begin_layout Standard
26446 For shapes with tips you will maybe see that \SpecialChar LaTeX
26447 's hyphenation routine fails
26448 for text in the tips.
26449 Therefore it is often necessary to add hyphenation points
26454 arg "specialchar-insert hyphenation"
26459 ) to the corresponding text parts.
26462 \begin_layout Standard
26463 \begin_inset VSpace bigskip
26469 \begin_layout Standard
26470 Shapepar paragraphs are either always centered or placed on the page so
26471 that their left border touches the left page margin.
26472 You can therefore not use the paragraph dialog to align such paragraphs.
26473 A solution is to put the paragraph into a minipage or parbox and align
26475 The problem is hereby to find the right width for the box.
26476 Because if it is too wide and you center the box, the paragraph is not
26477 centered too because it sticks at the left side of the box.
26478 So you might have to play a bit with the width until it fits.
26479 Here are two heart-shaped paragraphs, the first one is not aligned, the
26480 second one is right-aligned:
26483 \begin_layout Standard
26484 \begin_inset Newpage newpage
26490 \begin_layout Heart
26494 Lo\SpecialChar softhyphen
26495 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26496 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26498 At vero eos et accusam et justo duo dolores et ea rebum.
26499 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26503 \begin_layout Standard
26504 \begin_inset VSpace bigskip
26510 \begin_layout Standard
26513 \begin_inset Box Frameless
26523 height_special "totalheight"
26528 backgroundcolor "none"
26531 \begin_layout Heart
26535 Lo\SpecialChar softhyphen
26536 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26537 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26539 At vero eos et accusam et justo duo dolores et ea rebum.
26540 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26549 \begin_layout Subsection
26553 \begin_layout Standard
26554 You can define any shape you want.
26555 Doing this manually is a lot of work because every coordinate must be specified.
26556 But there is a way to let the computer calculate the coordinates:
26559 \begin_layout Enumerate
26560 Install the program
26561 \begin_inset CommandInset href
26564 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
26572 \begin_layout Enumerate
26579 TeX/LaTeX\SpecialChar menuseparator
26580 Settings\SpecialChar menuseparator
26583 and select the font size you are using in your document.
26584 For example this document uses the size 12
26585 \begin_inset space \thinspace{}
26591 \begin_layout Enumerate
26595 \begin_layout Enumerate
26598 TeX/LaTeX\SpecialChar menuseparator
26601 to export the shape to coordinates.
26602 In the appearing dialog use either the outline of your shape for the coordinate
26603 s or the path itself.
26607 \begin_layout Plain Layout
26608 For more information see
26609 \begin_inset CommandInset href
26611 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26624 \begin_layout Standard
26625 The coordinates are written into a \SpecialChar TeX
26627 To use it for your \SpecialChar LyX
26631 \begin_layout Enumerate
26632 Place the cursor before the first character of your paragraph (or into a
26636 \begin_layout Enumerate
26637 Open in \SpecialChar LyX
26640 Insert\SpecialChar menuseparator
26641 File\SpecialChar menuseparator
26643 \begin_inset space ~
26648 , select the file and use
26657 \begin_layout Standard
26658 \begin_inset VSpace defskip
26664 \begin_layout Standard
26665 \begin_inset Note Greyedout
26668 \begin_layout Plain Layout
26673 : The changed shape only applies to the current paragraph; everything is
26674 reset to normal for the next paragraph.
26675 Therefore the shape definition file must be input into every paragraph
26676 with the desired shape.
26684 \begin_layout Standard
26685 \begin_inset VSpace bigskip
26691 \begin_layout Standard
26692 Here is an example:
26695 \begin_layout Standard
26696 \begin_inset VSpace bigskip
26702 \begin_layout Standard
26703 \begin_inset CommandInset include
26705 filename "SpecialParagraphShape.tex"
26712 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26713 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26715 At vero eos et accusam et justo duo dolores et ea rebum.
26716 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26718 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26719 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26723 \begin_layout Standard
26724 \begin_inset VSpace bigskip
26730 \begin_layout Standard
26735 to draw complexer shapes in
26739 you can draw the shape in a program of your choice and import the resulting
26745 Then you only need to draw a line or spline along the outline of the image.
26748 \begin_layout Standard
26749 \begin_inset VSpace bigskip
26755 \begin_layout Standard
26758 Custom paragraph shapes
26760 also provides the two commands
26768 which can be used to define custom shapes coordinate by coordinate.
26772 \begin_layout Plain Layout
26773 These commands are internally used for all shapes described here.
26778 For information how these styles are used and about further customization
26779 possibilities, have a look at the
26780 \begin_inset CommandInset href
26782 name "documentation"
26783 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
26789 \begin_inset Flex Code
26792 \begin_layout Plain Layout